Class BrandingClient

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.

Inheritance
System.Object
BrandingClient
Implements
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class BrandingClient : object, IBrandingClient, IApiAccessor

Constructors

| Improve this Doc View Source

BrandingClient()

Initializes a new instance of the BrandingClient class.

Declaration
public BrandingClient()
| Improve this Doc View Source

BrandingClient(ApiClient)

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

Declaration
public BrandingClient(ApiClient apiClient)
Parameters
Type Name Description
ApiClient apiClient

An instance of ApiClient.
| Improve this Doc View Source

BrandingClient(Configuration)

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

Declaration
public BrandingClient(Configuration configuration = null)
Parameters
Type Name Description
Configuration configuration

An instance of Configuration.
| Improve this Doc View Source

BrandingClient(String)

Initializes a new instance of the BrandingClient class.

Declaration
public BrandingClient(string basePath)
Parameters
Type Name Description
System.String basePath

Gets or set the 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

Gets or sets 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

CreateBrand(BrandSettings)

create the brand.

Declaration
public 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.
| Improve this Doc View Source

CreateBrandAsync(BrandSettings)

create the brand.

Declaration
public async 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.
| Improve this Doc View Source

CreateBrandAsyncWithHttpInfo(BrandSettings)

create the brand.

Declaration
public async Task<ApiResponse<BrandingData>> CreateBrandAsyncWithHttpInfo(BrandSettings createBrandData)
Parameters
Type Name Description
BrandSettings createBrandData

createBrandData.
Returns
Type Description
Task<ApiResponse<BrandingData>>

Task of ApiResponse(BrandingData).
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

CreateBrandWithHttpInfo(BrandSettings)

create the brand.

Declaration
public 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.
| Improve this Doc View Source

DeleteBrand(String)

Delete the branding when a particular brand’s ID is given as input.

Declaration
public void DeleteBrand(string brandId)
Parameters
Type Name Description
System.String brandId

Brand Id.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

DeleteBrandAsync(String)

Delete the brand when a particular brand’s ID is given as input.

Declaration
public async 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.
| Improve this Doc View Source

DeleteBrandAsyncWithHttpInfo(String)

Delete the brand when a particular brand’s ID is given as input.

Declaration
public async 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.
| Improve this Doc View Source

DeleteBrandWithHttpInfo(String)

Delete the brand when a particular brand’s ID is given as input.

Declaration
public 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.
| Improve this Doc View Source

EditBrand(String, BrandSettings)

edit the brand.

Declaration
public 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.
| Improve this Doc View Source

EditBrandAsync(String, BrandSettings)

edit the brand.

Declaration
public async 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.
| Improve this Doc View Source

EditBrandAsyncWithHttpInfo(String, BrandSettings)

edit the brand.

Declaration
public async 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 ApiResponse (BrandingData).
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

EditBrandWithHttpInfo(String, BrandSettings)

edit the brand.

Declaration
public 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.
| Improve this Doc View Source

GetBasePath()

branding paths.

Declaration
public string GetBasePath()
Returns
Type Description
System.String

The base path.
| Improve this Doc View Source

ListBrand()

list the brand.

Declaration
public BrandingRecords ListBrand()
Returns
Type Description
BrandingRecords

BrandingRecords.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

ListBrandAsync()

list the brand.

Declaration
public async Task<BrandingRecords> ListBrandAsync()
Returns
Type Description
Task<BrandingRecords>

Task of BrandingRecords.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

ListBrandAsyncWithHttpInfo()

list the brand.

Declaration
public async 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.
| Improve this Doc View Source

ListBrandWithHttpInfo()

list the brand.

Declaration
public ApiResponse<BrandingRecords> ListBrandWithHttpInfo()
Returns
Type Description
ApiResponse<BrandingRecords>

ApiResponse of BrandRecords.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

ResetDefaultBrand(String)

Reset the default brand when a particular brand’s ID is given as input.

Declaration
public void ResetDefaultBrand(string brandId)
Parameters
Type Name Description
System.String brandId

Brand Id.
Exceptions
Type Condition
ApiException

Thrown when fails to make API call.
| Improve this Doc View Source

ResetDefaultBrandAsync(String)

Reset the default brand when a particular brand’s ID is given as input.

Declaration
public async 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.
| Improve this Doc View Source

ResetDefaultBrandWithHttpInfo(String)

Reset the default brand when a particular brand’s ID is given as input.

Declaration
public 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.
| Improve this Doc View Source

ResetDefaultBrandWithHttpInfoAsync(String)

Reset the default brand when a particular brand’s ID is given as input.

Declaration
public async 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.

Implements