Class PlanClient

Represents a function to interact with the API endpoints. The function perform action such as getting the Api credit details and so on.

Inheritance

System.Object

PlanClient

Implements

IPlanClient

IApiAccessor

Namespace: BoldSign.Api

Assembly: BoldSign.Api.dll

Syntax

public class PlanClient : object, IPlanClient, IApiAccessor

Constructors

| Improve this Doc View Source

PlanClient()

Initializes a new instance of the PlanClient class.

Declaration

public PlanClient()

| Improve this Doc View Source

PlanClient(ApiClient)

Initializes a new instance of the class using Configuration object.

Declaration

public PlanClient(ApiClient apiClient)

Parameters

Type	Name	Description
ApiClient	apiClient	An instance of ApiClient

| Improve this Doc View Source

PlanClient(Configuration)

Initializes a new instance of the PlanClient class using Configuration object.

Declaration

public PlanClient(Configuration configuration = null)

Parameters

Type	Name	Description
Configuration	configuration	An instance of Configuration

| Improve this Doc View Source

PlanClient(String)

Initializes a new instance of the PlanClient class.

Declaration

public PlanClient(string basePath)

Parameters

Type	Name	Description
System.String	basePath

Properties

| Improve this Doc View Source

Configuration

Gets or sets the configuration object.

Declaration

public Configuration Configuration { get; set; }

Property Value

Type	Description
Configuration	An instance of the Configuration

| Improve this Doc View Source

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

Declaration

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

Type	Description
ExceptionFactory

Methods

| Improve this Doc View Source

GetApiCreditsCount()

Gets the Api credits details of the user.

Declaration

public BillingViewModel GetApiCreditsCount()

Returns

Type	Description
BillingViewModel	BillingViewModel

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetApiCreditsCountAsync()

Gets the Api credits details of the user.

Declaration

public async Task<BillingViewModel> GetApiCreditsCountAsync()

Returns

Type	Description
Task<BillingViewModel>	Task of ApiResponse (BillingViewModel)

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetApiCreditsCountAsyncWithHttpInfo()

Gets the Api credits details of the user.

Declaration

public async Task<ApiResponse<BillingViewModel>> GetApiCreditsCountAsyncWithHttpInfo()

Returns

Type	Description
Task<ApiResponse<BillingViewModel>>	ApiResponse of BillingViewModel

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetApiCreditsCountWithHttpInfo()

Gets the Api credits details of the user.

Declaration

public ApiResponse<BillingViewModel> GetApiCreditsCountWithHttpInfo()

Returns

Type	Description
ApiResponse<BillingViewModel>	ApiResponse of BillingViewModel

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call

| Improve this Doc View Source

GetBasePath()

Gets the base path of the API client.

Declaration

public string GetBasePath()

Returns

Type	Description
System.String	The base path

Implements

IPlanClient

IApiAccessor