Class CustomFieldClient

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 custom field, deleting custom field, editing custom field and so on.

public class CustomFieldClient : ICustomFieldClient, IApiAccessor

Inheritance

object

CustomFieldClient

Implements

ICustomFieldClient

IApiAccessor

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

CustomFieldClient()

Initializes a new instance of the CustomFieldClient class.

public CustomFieldClient()

CustomFieldClient(ApiClient)

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

public CustomFieldClient(ApiClient apiClient)

Parameters

apiClient ApiClient

An instance of ApiClient.

CustomFieldClient(Configuration)

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

public CustomFieldClient(Configuration configuration = null)

Parameters

configuration Configuration

An instance of Configuration.

CustomFieldClient(string)

Initializes a new instance of the CustomFieldClient class.

public CustomFieldClient(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

CreateCustomField(BrandCustomFieldDetails)

Creates a custom field for the specified brand.

public CustomFieldMessage CreateCustomField(BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

CustomFieldMessage

Return the custom message.

CreateCustomFieldAsync(BrandCustomFieldDetails)

Creates a custom field for the specified brand.

public Task<CustomFieldMessage> CreateCustomFieldAsync(BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

Task<CustomFieldMessage>

Return the custom message.

CreateCustomFieldAsyncWithHttpInfo(BrandCustomFieldDetails)

Creates a custom field for the specified brand.

public Task<ApiResponse<CustomFieldMessage>> CreateCustomFieldAsyncWithHttpInfo(BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

Task<ApiResponse<CustomFieldMessage>>

Return the custom message.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

CreateCustomFieldWithHttpInfo(BrandCustomFieldDetails)

Created a custom field for the specified brand.

public ApiResponse<CustomFieldMessage> CreateCustomFieldWithHttpInfo(BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

ApiResponse<CustomFieldMessage>

Return the custom message.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

CreateEmbeddedCustomFieldUrl(EmbeddedCustomFieldDetails)

Generates a URL to embed manipulation of custom field process into your application.

public EmbeddedCustomFieldCreated CreateEmbeddedCustomFieldUrl(EmbeddedCustomFieldDetails embeddedCustomFieldDetails)

Parameters

embeddedCustomFieldDetails EmbeddedCustomFieldDetails

The embedded custom field details.

Returns

EmbeddedCustomFieldCreated

Returns the embedded custom field url.

CreateEmbeddedCustomFieldUrlAsync(EmbeddedCustomFieldDetails)

Generates a URL to embed manipulation of custom field process into your application.

public Task<EmbeddedCustomFieldCreated> CreateEmbeddedCustomFieldUrlAsync(EmbeddedCustomFieldDetails embeddedCustomFieldDetails)

Parameters

embeddedCustomFieldDetails EmbeddedCustomFieldDetails

The embedded custom field details.

Returns

Task<EmbeddedCustomFieldCreated>

Returns the embedded custom field url.

CreateEmbeddedCustomFieldUrlAsyncWithHttpInfo(EmbeddedCustomFieldDetails)

Generates a URL to embed manipulation of custom field process into your application.

public Task<ApiResponse<EmbeddedCustomFieldCreated>> CreateEmbeddedCustomFieldUrlAsyncWithHttpInfo(EmbeddedCustomFieldDetails embeddedCustomFieldDetails)

Parameters

embeddedCustomFieldDetails EmbeddedCustomFieldDetails

The embedded custom field details.

Returns

Task<ApiResponse<EmbeddedCustomFieldCreated>>

Returns the embedded custom field url.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

CreateEmbeddedCustomFieldUrlWithHttpInfo(EmbeddedCustomFieldDetails)

Generates a URL to embed manipulation of custom field process into your application.

public ApiResponse<EmbeddedCustomFieldCreated> CreateEmbeddedCustomFieldUrlWithHttpInfo(EmbeddedCustomFieldDetails embeddedCustomFieldDetails)

Parameters

embeddedCustomFieldDetails EmbeddedCustomFieldDetails

The embedded custom field details.

Returns

ApiResponse<EmbeddedCustomFieldCreated>

Returns the embedded custom field url.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

DeleteCustomField(string)

Deletes the custom field for the specified brand.

public CustomFieldMessage DeleteCustomField(string customFieldId)

Parameters

customFieldId string

The custom field id.

Returns

CustomFieldMessage

Return the custom field message.

DeleteCustomFieldAsync(string)

Deletes the custom field for the specified brand.

public Task<CustomFieldMessage> DeleteCustomFieldAsync(string customFieldId)

Parameters

customFieldId string

The custom field id.

Returns

Task<CustomFieldMessage>

Return the custom field message.

DeleteCustomFieldAsyncWithHttpInfo(string)

Deletes the custom field for the specified brand.

public Task<ApiResponse<CustomFieldMessage>> DeleteCustomFieldAsyncWithHttpInfo(string customFieldId)

Parameters

customFieldId string

The custom field id.

Returns

Task<ApiResponse<CustomFieldMessage>>

Return the custom field message.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

DeleteCustomFieldWithHttpInfo(string)

Deletes the custom field for the specified brand.

public ApiResponse<CustomFieldMessage> DeleteCustomFieldWithHttpInfo(string customFieldId)

Parameters

customFieldId string

The custom field id.

Returns

ApiResponse<CustomFieldMessage>

Return the custom field message.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

EditCustomField(string, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

public CustomFieldMessage EditCustomField(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

customFieldId string

The custom field identifier.

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

CustomFieldMessage

Return the custom message.

EditCustomFieldAsync(string, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

public Task<CustomFieldMessage> EditCustomFieldAsync(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

customFieldId string

The custom field identifier.

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

Task<CustomFieldMessage>

Return the custom message.

EditCustomFieldAsyncWithHttpInfo(string, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

public Task<ApiResponse<CustomFieldMessage>> EditCustomFieldAsyncWithHttpInfo(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

customFieldId string

The custom field identifier.

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

Task<ApiResponse<CustomFieldMessage>>

Return the custom field message.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

EditCustomFieldWithHttpInfo(string, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

public ApiResponse<CustomFieldMessage> EditCustomFieldWithHttpInfo(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

customFieldId string

The custom field identifier.

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

ApiResponse<CustomFieldMessage>

Return the custom message.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

GetBasePath()

Custom field paths.

public string GetBasePath()

Returns

string

The base path.

GetBrandBasedCustomFields(string)

Gets the collections of custom fields for the specified brand.

public CustomFieldCollection GetBrandBasedCustomFields(string brandId)

Parameters

brandId string

The brand Id.

Returns

CustomFieldCollection

Returns the collection of custom fields.

GetBrandBasedCustomFieldsAsync(string)

Gets the collections of custom fields for the specified brand.

public Task<CustomFieldCollection> GetBrandBasedCustomFieldsAsync(string brandId)

Parameters

brandId string

The brand Id.

Returns

Task<CustomFieldCollection>

Returns the collection of custom fields.

GetBrandBasedCustomFieldsAsyncWithHttpInfo(string)

Gets the collections of custom fields for the specified brand.

public Task<ApiResponse<CustomFieldCollection>> GetBrandBasedCustomFieldsAsyncWithHttpInfo(string brandId)

Parameters

brandId string

The brand Id.

Returns

Task<ApiResponse<CustomFieldCollection>>

Returns the collection of custom fields.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.

GetBrandBasedCustomFieldsWithHttpInfo(string)

Gets the collections of custom fields for the specified brand.

public ApiResponse<CustomFieldCollection> GetBrandBasedCustomFieldsWithHttpInfo(string brandId)

Parameters

brandId string

The brand Id.

Returns

ApiResponse<CustomFieldCollection>

Returns the collection of custom fields.

Exceptions

ApiException

Thrown when fails to make API call.

Exception

Thrown when fails to make call.