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
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class PlanClient : object, IPlanClient, IApiAccessor
Constructors
| Improve this Doc View SourcePlanClient()
Initializes a new instance of the PlanClient class.
Declaration
public PlanClient()
PlanClient(ApiClient)
Initializes a new instance of the
Declaration
public PlanClient(ApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
ApiClient | apiClient | An instance of ApiClient |
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 |
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 SourceConfiguration
Gets or sets the configuration object.
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
Configuration | An instance of the Configuration |
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 SourceGetApiCreditsCount()
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 |
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 |
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 |
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 |
GetBasePath()
Gets the base path of the API client.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path |