Interface IBrandingClient

Namespace

BoldSign.Api

Assembly

BoldSign.Api.dll

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.

public interface IBrandingClient : IApiAccessor

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Methods

CreateBrand(BrandSettings)

create the brand.

BrandingData CreateBrand(BrandSettings createBrandData)

Parameters

createBrandData BrandSettings

createBrandData.

Returns

BrandingData

BrandingData.

Exceptions

ApiException

Thrown when fails to make API call.

CreateBrandAsync(BrandSettings)

create the brand.

Task<BrandingData> CreateBrandAsync(BrandSettings createBrandData)

Parameters

createBrandData BrandSettings

createBrandData.

Returns

Task<BrandingData>

Task of BrandingData.

Exceptions

ApiException

Thrown when fails to make API call.

CreateBrandAsyncWithHttpInfo(BrandSettings)

create the brand.

Task<ApiResponse<BrandingData>> CreateBrandAsyncWithHttpInfo(BrandSettings createBrandData)

Parameters

createBrandData BrandSettings

createBrandData.

Returns

Task<ApiResponse<BrandingData>>

Task of ApiResponse (BrandingResult).

Exceptions

ApiException

Thrown when fails to make API call.

CreateBrandWithHttpInfo(BrandSettings)

create the brand.

ApiResponse<BrandingData> CreateBrandWithHttpInfo(BrandSettings createBrandData)

Parameters

createBrandData BrandSettings

createBrandData.

Returns

ApiResponse<BrandingData>

ApiResponse of Object(BrandingData).

Exceptions

ApiException

Thrown when fails to make API call.

DeleteBrand(string)

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

void DeleteBrand(string brandId)

Parameters

brandId string

Brand Id.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteBrandAsync(string)

Delete the brand.

Task DeleteBrandAsync(string brandId)

Parameters

brandId string

Brand Id.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteBrandAsyncWithHttpInfo(string)

Delete the brand.

Task<ApiResponse<object>> DeleteBrandAsyncWithHttpInfo(string brandId)

Parameters

brandId string

Brand Id.

Returns

Task<ApiResponse<object>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteBrandWithHttpInfo(string)

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

ApiResponse<object> DeleteBrandWithHttpInfo(string brandId)

Parameters

brandId string

Brand Id.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

EditBrand(string, BrandSettings)

edit the brand.

BrandingData EditBrand(string brandId, BrandSettings editBrandData)

Parameters

brandId string

brandId.

editBrandData BrandSettings

editBrandData.

Returns

BrandingData

BrandingData.

Exceptions

ApiException

Thrown when fails to make API call.

EditBrandAsync(string, BrandSettings)

edit the brand.

Task<BrandingData> EditBrandAsync(string brandId, BrandSettings editBrandData)

Parameters

brandId string

brandId.

editBrandData BrandSettings

editBrandData.

Returns

Task<BrandingData>

Task of BrandingData.

Exceptions

ApiException

Thrown when fails to make API call.

EditBrandAsyncWithHttpInfo(string, BrandSettings)

edit the brand.

Task<ApiResponse<BrandingData>> EditBrandAsyncWithHttpInfo(string brandId, BrandSettings editBrandData)

Parameters

brandId string

brandId.

editBrandData BrandSettings

editBrandData.

Returns

Task<ApiResponse<BrandingData>>

Task of BrandingData.

Exceptions

ApiException

Thrown when fails to make API call.

EditBrandWithHttpInfo(string, BrandSettings)

edit the brand.

ApiResponse<BrandingData> EditBrandWithHttpInfo(string brandId, BrandSettings editBrandData)

Parameters

brandId string

brandId.

editBrandData BrandSettings

editBrandData.

Returns

ApiResponse<BrandingData>

ApiResponse of Object(BrandingData).

Exceptions

ApiException

Thrown when fails to make API call.

GetBrandDetails(string)

Get the brand.

BrandDetails GetBrandDetails(string brandId)

Parameters

brandId string

Brand Id.

Returns

BrandDetails

BrandDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetBrandDetailsAsync(string)

Get the brand.

Task<BrandDetails> GetBrandDetailsAsync(string brandId)

Parameters

brandId string

brandId.

Returns

Task<BrandDetails>

Task of BrandDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetBrandDetailsAsyncWithHttpInfo(string)

Get the brand.

Task<ApiResponse<BrandDetails>> GetBrandDetailsAsyncWithHttpInfo(string brandId)

Parameters

brandId string

brandId.

Returns

Task<ApiResponse<BrandDetails>>

Task of BrandDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetBrandDetailsWithHttpInfo(string)

Get the brand.

ApiResponse<BrandDetails> GetBrandDetailsWithHttpInfo(string brandId)

Parameters

brandId string

Brand Id.

Returns

ApiResponse<BrandDetails>

ApiResponse of BrandDetails.

Exceptions

ApiException

Thrown when fails to make API call.

ListBrand()

list the brand.

BrandingRecords ListBrand()

Returns

BrandingRecords

BrandingRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListBrandAsync()

list the brand.

Task<BrandingRecords> ListBrandAsync()

Returns

Task<BrandingRecords>

Task of BrandingRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListBrandAsyncWithHttpInfo()

list the brand.

Task<ApiResponse<BrandingRecords>> ListBrandAsyncWithHttpInfo()

Returns

Task<ApiResponse<BrandingRecords>>

Task of ApiResponse (BrandingRecords).

Exceptions

ApiException

Thrown when fails to make API call.

ListBrandWithHttpInfo()

list the brand.

ApiResponse<BrandingRecords> ListBrandWithHttpInfo()

Returns

ApiResponse<BrandingRecords>

ApiResponse of BrandRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ResetDefaultBrand(string)

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

void ResetDefaultBrand(string brandId)

Parameters

brandId string

Brand Id.

Exceptions

ApiException

Thrown when fails to make API call.

ResetDefaultBrandAsync(string)

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

Task ResetDefaultBrandAsync(string brandId)

Parameters

brandId string

Brand Id.

Returns

Task

Task of void.

Exceptions

ApiException

Thrown when fails to make API call.

ResetDefaultBrandWithHttpInfo(string)

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

ApiResponse<object> ResetDefaultBrandWithHttpInfo(string brandId)

Parameters

brandId string

Brand Id.

Returns

ApiResponse<object>

ApiResponse of Object(void).

Exceptions

ApiException

Thrown when fails to make API call.

ResetDefaultBrandWithHttpInfoAsync(string)

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

Task<ApiResponse<object>> ResetDefaultBrandWithHttpInfoAsync(string brandId)

Parameters

brandId string

Brand Id.

Returns

Task<ApiResponse<object>>

Task of ApiResponse.

Exceptions

ApiException

Thrown when fails to make API call.