Interface IBrandingClient
Represents a collection of functions to interact with the API endpoints. The functions perform actions such as creating brand, deleting brand, listing the brand and so on.
Inherited Members
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public interface IBrandingClient : IApiAccessor
Methods
| Improve this Doc View SourceCreateBrand(BrandSettings)
create the brand.
Declaration
BrandingData CreateBrand(BrandSettings createBrandData)
Parameters
Type | Name | Description |
---|---|---|
BrandSettings | createBrandData | createBrandData. |
Returns
Type | Description |
---|---|
BrandingData | BrandingData. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateBrandAsync(BrandSettings)
create the brand.
Declaration
Task<BrandingData> CreateBrandAsync(BrandSettings createBrandData)
Parameters
Type | Name | Description |
---|---|---|
BrandSettings | createBrandData | createBrandData. |
Returns
Type | Description |
---|---|
Task<BrandingData> | Task of BrandingData. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateBrandAsyncWithHttpInfo(BrandSettings)
create the brand.
Declaration
Task<ApiResponse<BrandingData>> CreateBrandAsyncWithHttpInfo(BrandSettings createBrandData)
Parameters
Type | Name | Description |
---|---|---|
BrandSettings | createBrandData | createBrandData. |
Returns
Type | Description |
---|---|
Task<ApiResponse<BrandingData>> | Task of ApiResponse (BrandingResult). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
CreateBrandWithHttpInfo(BrandSettings)
create the brand.
Declaration
ApiResponse<BrandingData> CreateBrandWithHttpInfo(BrandSettings createBrandData)
Parameters
Type | Name | Description |
---|---|---|
BrandSettings | createBrandData | createBrandData. |
Returns
Type | Description |
---|---|
ApiResponse<BrandingData> | ApiResponse of Object(BrandingData). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteBrand(String)
Delete the brand when a particular brand’s ID is given as input.
Declaration
void DeleteBrand(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteBrandAsync(String)
Delete the brand.
Declaration
Task DeleteBrandAsync(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
Task | Task of void. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteBrandAsyncWithHttpInfo(String)
Delete the brand.
Declaration
Task<ApiResponse<object>> DeleteBrandAsyncWithHttpInfo(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | Task of ApiResponse. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
DeleteBrandWithHttpInfo(String)
Delete the brand when a particular brand’s ID is given as input.
Declaration
ApiResponse<object> DeleteBrandWithHttpInfo(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
EditBrand(String, BrandSettings)
edit the brand.
Declaration
BrandingData EditBrand(string brandId, BrandSettings editBrandData)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | brandId. |
BrandSettings | editBrandData | editBrandData. |
Returns
Type | Description |
---|---|
BrandingData | BrandingData. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
EditBrandAsync(String, BrandSettings)
edit the brand.
Declaration
Task<BrandingData> EditBrandAsync(string brandId, BrandSettings editBrandData)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | brandId. |
BrandSettings | editBrandData | editBrandData. |
Returns
Type | Description |
---|---|
Task<BrandingData> | Task of BrandingData. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
EditBrandAsyncWithHttpInfo(String, BrandSettings)
edit the brand.
Declaration
Task<ApiResponse<BrandingData>> EditBrandAsyncWithHttpInfo(string brandId, BrandSettings editBrandData)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | brandId. |
BrandSettings | editBrandData | editBrandData. |
Returns
Type | Description |
---|---|
Task<ApiResponse<BrandingData>> | Task of BrandingData. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
EditBrandWithHttpInfo(String, BrandSettings)
edit the brand.
Declaration
ApiResponse<BrandingData> EditBrandWithHttpInfo(string brandId, BrandSettings editBrandData)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | brandId. |
BrandSettings | editBrandData | editBrandData. |
Returns
Type | Description |
---|---|
ApiResponse<BrandingData> | ApiResponse of Object(BrandingData). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetBrandDetails(String)
Get the brand.
Declaration
BrandDetails GetBrandDetails(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
BrandDetails | BrandDetails. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetBrandDetailsAsync(String)
Get the brand.
Declaration
Task<BrandDetails> GetBrandDetailsAsync(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | brandId. |
Returns
Type | Description |
---|---|
Task<BrandDetails> | Task of BrandDetails. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetBrandDetailsAsyncWithHttpInfo(String)
Get the brand.
Declaration
Task<ApiResponse<BrandDetails>> GetBrandDetailsAsyncWithHttpInfo(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | brandId. |
Returns
Type | Description |
---|---|
Task<ApiResponse<BrandDetails>> | Task of BrandDetails. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
GetBrandDetailsWithHttpInfo(String)
Get the brand.
Declaration
ApiResponse<BrandDetails> GetBrandDetailsWithHttpInfo(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
ApiResponse<BrandDetails> | ApiResponse of BrandDetails. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListBrand()
list the brand.
Declaration
BrandingRecords ListBrand()
Returns
Type | Description |
---|---|
BrandingRecords | BrandingRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListBrandAsync()
list the brand.
Declaration
Task<BrandingRecords> ListBrandAsync()
Returns
Type | Description |
---|---|
Task<BrandingRecords> | Task of BrandingRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListBrandAsyncWithHttpInfo()
list the brand.
Declaration
Task<ApiResponse<BrandingRecords>> ListBrandAsyncWithHttpInfo()
Returns
Type | Description |
---|---|
Task<ApiResponse<BrandingRecords>> | Task of ApiResponse (BrandingRecords). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ListBrandWithHttpInfo()
list the brand.
Declaration
ApiResponse<BrandingRecords> ListBrandWithHttpInfo()
Returns
Type | Description |
---|---|
ApiResponse<BrandingRecords> | ApiResponse of BrandRecords. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResetDefaultBrand(String)
Reset the default brand when a particular brand’s ID is given as input.
Declaration
void ResetDefaultBrand(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResetDefaultBrandAsync(String)
Reset the default brand when a particular brand’s ID is given as input.
Declaration
Task ResetDefaultBrandAsync(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
Task | Task of void. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResetDefaultBrandWithHttpInfo(String)
Reset the default brand when a particular brand’s ID is given as input.
Declaration
ApiResponse<object> ResetDefaultBrandWithHttpInfo(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
ApiResponse<System.Object> | ApiResponse of Object(void). |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |
ResetDefaultBrandWithHttpInfoAsync(String)
Reset the default brand when a particular brand’s ID is given as input.
Declaration
Task<ApiResponse<object>> ResetDefaultBrandWithHttpInfoAsync(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | Brand Id. |
Returns
Type | Description |
---|---|
Task<ApiResponse<System.Object>> | Task of ApiResponse. |
Exceptions
Type | Condition |
---|---|
ApiException | Thrown when fails to make API call. |