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

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Namespace: BoldSign.Api

Assembly: BoldSign.Api.dll

Syntax

public interface IBrandingClient : IApiAccessor

Methods

| Improve this Doc View Source

CreateBrand(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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

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.

| Improve this Doc View Source

ListBrand()

list the brand.

Declaration

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

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

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

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

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

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

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

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.