Interface ICustomFieldClient

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 interface ICustomFieldClient : IApiAccessor

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Methods

CreateCustomField(BrandCustomFieldDetails)

Creates a custom field for the specified brand.

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.

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.

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.

CreateCustomFieldWithHttpInfo(BrandCustomFieldDetails)

Created a custom field for the specified brand.

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.

CreateEmbeddedCustomFieldUrl(EmbeddedCustomFieldDetails)

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

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.

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.

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.

CreateEmbeddedCustomFieldUrlWithHttpInfo(EmbeddedCustomFieldDetails)

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

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.

DeleteCustomField(string)

Deletes the custom field for the specified brand.

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.

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.

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.

DeleteCustomFieldWithHttpInfo(string)

Deletes the custom field for the specified brand.

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.

EditCustomField(string, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

CustomFieldMessage EditCustomField(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

customFieldId string

The custom field id.

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

CustomFieldMessage

Return the custom message.

EditCustomFieldAsync(string, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

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

Parameters

customFieldId string

The custom field id.

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.

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

Parameters

customFieldId string

The custom field id.

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.

EditCustomFieldWithHttpInfo(string, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

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

Parameters

customFieldId string

The custom field id.

brandCustomFieldDetails BrandCustomFieldDetails

The brand custom fields class.

Returns

ApiResponse<CustomFieldMessage>

Return the custom message.

Exceptions

ApiException

Thrown when fails to make API call.

GetBrandBasedCustomFields(string)

Gets the collections of custom fields for the specified brand.

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.

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.

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.

GetBrandBasedCustomFieldsWithHttpInfo(string)

Gets the collections of custom fields for the specified brand.

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.