Class PlanClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

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

public class PlanClient : IPlanClient, IApiAccessor

Inheritance

object

PlanClient

Implements

IPlanClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

PlanClient()

Initializes a new instance of the PlanClient class.

public PlanClient()

PlanClient(ApiClient)

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

public PlanClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient

PlanClient(Configuration)

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

public PlanClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration

PlanClient(string)

Initializes a new instance of the PlanClient class.

public PlanClient(string basePath)

Parameters

basePath string

Properties

Configuration

Gets or sets the configuration object.

public Configuration Configuration { get; set; }

Property Value

Configuration

An instance of the Configuration

ExceptionFactory

Provides a factory method hook for the creation of exceptions.

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

ExceptionFactory

Methods

GetApiCreditsCount()

Gets the Api credits details of the user.

public BillingViewModel GetApiCreditsCount()

Returns

BillingViewModel

BillingViewModel

Exceptions

ApiException

Thrown when fails to make API call

GetApiCreditsCountAsync()

Gets the Api credits details of the user.

public Task<BillingViewModel> GetApiCreditsCountAsync()

Returns

Task<BillingViewModel>

Task of ApiResponse (BillingViewModel)

Exceptions

ApiException

Thrown when fails to make API call

GetApiCreditsCountAsyncWithHttpInfo()

Gets the Api credits details of the user.

public Task<ApiResponse<BillingViewModel>> GetApiCreditsCountAsyncWithHttpInfo()

Returns

Task<ApiResponse<BillingViewModel>>

ApiResponse of BillingViewModel

Exceptions

ApiException

Thrown when fails to make API call

GetApiCreditsCountWithHttpInfo()

Gets the Api credits details of the user.

public ApiResponse<BillingViewModel> GetApiCreditsCountWithHttpInfo()

Returns

ApiResponse<BillingViewModel>

ApiResponse of BillingViewModel

Exceptions

ApiException

Thrown when fails to make API call

GetBasePath()

Gets the base path of the API client.

public string GetBasePath()

Returns

string

The base path