Class BrandingClient

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 class BrandingClient : IBrandingClient, IApiAccessor

Inheritance

object

BrandingClient

Implements

IBrandingClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

BrandingClient()

Initializes a new instance of the BrandingClient class.

public BrandingClient()

BrandingClient(ApiClient)

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

public BrandingClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient.

BrandingClient(Configuration)

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

public BrandingClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration.

BrandingClient(string)

Initializes a new instance of the BrandingClient class.

public BrandingClient(string basePath)

Parameters

basePath string

Gets or set the basePath.

Properties

Configuration

Gets or sets the configuration object.

public Configuration Configuration { get; set; }

Property Value

Configuration

An instance of the Configuration.

ExceptionFactory

Gets or sets provides a factory method hook for the creation of exceptions.

public ExceptionFactory ExceptionFactory { get; set; }

Property Value

ExceptionFactory

Methods

CreateBrand(BrandSettings)

create the brand.

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

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

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

Parameters

createBrandData BrandSettings

createBrandData.

Returns

Task<ApiResponse<BrandingData>>

Task of ApiResponse(BrandingData).

Exceptions

ApiException

Thrown when fails to make API call.

CreateBrandWithHttpInfo(BrandSettings)

create the brand.

public 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 branding when a particular brand’s ID is given as input.

public void DeleteBrand(string brandId)

Parameters

brandId string

Brand Id.

Exceptions

ApiException

Thrown when fails to make API call.

DeleteBrandAsync(string)

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

public 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 when a particular brand’s ID is given as input.

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

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

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

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

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

Parameters

brandId string

brandId.

editBrandData BrandSettings

editBrandData.

Returns

Task<ApiResponse<BrandingData>>

Task of ApiResponse (BrandingData).

Exceptions

ApiException

Thrown when fails to make API call.

EditBrandWithHttpInfo(string, BrandSettings)

edit the brand.

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

GetBasePath()

branding paths.

public string GetBasePath()

Returns

string

The base path.

GetBrandDetails(string)

Get the brand.

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

public Task<BrandDetails> GetBrandDetailsAsync(string brandId)

Parameters

brandId string

Brand Id.

Returns

Task<BrandDetails>

Task of BrandDetails.

Exceptions

ApiException

Thrown when fails to make API call.

GetBrandDetailsAsyncWithHttpInfo(string)

Get the brand.

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

Parameters

brandId string

Brand Id.

Returns

Task<ApiResponse<BrandDetails>>

Task of ApiResponse (BrandDetails).

Exceptions

ApiException

Thrown when fails to make API call.

GetBrandDetailsWithHttpInfo(string)

Get the brand.

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

public BrandingRecords ListBrand()

Returns

BrandingRecords

BrandingRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListBrandAsync()

list the brand.

public Task<BrandingRecords> ListBrandAsync()

Returns

Task<BrandingRecords>

Task of BrandingRecords.

Exceptions

ApiException

Thrown when fails to make API call.

ListBrandAsyncWithHttpInfo()

list the brand.

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

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

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

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

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

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