Interface ICustomFieldClient

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.

Inherited Members

IApiAccessor.Configuration

IApiAccessor.ExceptionFactory

IApiAccessor.GetBasePath()

Namespace: BoldSign.Api

Assembly: BoldSign.Api.dll

Syntax

public interface ICustomFieldClient : IApiAccessor

Methods

| Improve this Doc View Source

CreateCustomField(BrandCustomFieldDetails)

Creates a custom field for the specified brand.

Declaration

CustomFieldMessage CreateCustomField(BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

Type	Name	Description
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
CustomFieldMessage	Return the custom message.

| Improve this Doc View Source

CreateCustomFieldAsync(BrandCustomFieldDetails)

Creates a custom field for the specified brand.

Declaration

Task<CustomFieldMessage> CreateCustomFieldAsync(BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

Type	Name	Description
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
Task<CustomFieldMessage>	Return the custom message.

| Improve this Doc View Source

CreateCustomFieldAsyncWithHttpInfo(BrandCustomFieldDetails)

Creates a custom field for the specified brand.

Declaration

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

Parameters

Type	Name	Description
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
Task<ApiResponse<CustomFieldMessage>>	Return the custom message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateCustomFieldWithHttpInfo(BrandCustomFieldDetails)

Created a custom field for the specified brand.

Declaration

ApiResponse<CustomFieldMessage> CreateCustomFieldWithHttpInfo(BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

Type	Name	Description
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
ApiResponse<CustomFieldMessage>	Return the custom message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateEmbeddedCustomFieldUrl(EmbeddedCustomFieldDetails)

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

Declaration

EmbeddedCustomFieldCreated CreateEmbeddedCustomFieldUrl(EmbeddedCustomFieldDetails embeddedCustomFieldDetails)

Parameters

Type	Name	Description
EmbeddedCustomFieldDetails	embeddedCustomFieldDetails	The embedded custom field details.

Returns

Type	Description
EmbeddedCustomFieldCreated	Returns the embedded custom field url.

| Improve this Doc View Source

CreateEmbeddedCustomFieldUrlAsync(EmbeddedCustomFieldDetails)

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

Declaration

Task<EmbeddedCustomFieldCreated> CreateEmbeddedCustomFieldUrlAsync(EmbeddedCustomFieldDetails embeddedCustomFieldDetails)

Parameters

Type	Name	Description
EmbeddedCustomFieldDetails	embeddedCustomFieldDetails	The embedded custom field details.

Returns

Type	Description
Task<EmbeddedCustomFieldCreated>	Returns the embedded custom field url.

| Improve this Doc View Source

CreateEmbeddedCustomFieldUrlAsyncWithHttpInfo(EmbeddedCustomFieldDetails)

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

Declaration

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

Parameters

Type	Name	Description
EmbeddedCustomFieldDetails	embeddedCustomFieldDetails	The embedded custom field details.

Returns

Type	Description
Task<ApiResponse<EmbeddedCustomFieldCreated>>	Returns the embedded custom field url.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

CreateEmbeddedCustomFieldUrlWithHttpInfo(EmbeddedCustomFieldDetails)

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

Declaration

ApiResponse<EmbeddedCustomFieldCreated> CreateEmbeddedCustomFieldUrlWithHttpInfo(EmbeddedCustomFieldDetails embeddedCustomFieldDetails)

Parameters

Type	Name	Description
EmbeddedCustomFieldDetails	embeddedCustomFieldDetails	The embedded custom field details.

Returns

Type	Description
ApiResponse<EmbeddedCustomFieldCreated>	Returns the embedded custom field url.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

DeleteCustomField(String)

Deletes the custom field for the specified brand.

Declaration

CustomFieldMessage DeleteCustomField(string customFieldId)

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.

Returns

Type	Description
CustomFieldMessage	Return the custom field message.

| Improve this Doc View Source

DeleteCustomFieldAsync(String)

Deletes the custom field for the specified brand.

Declaration

Task<CustomFieldMessage> DeleteCustomFieldAsync(string customFieldId)

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.

Returns

Type	Description
Task<CustomFieldMessage>	Return the custom field message.

| Improve this Doc View Source

DeleteCustomFieldAsyncWithHttpInfo(String)

Deletes the custom field for the specified brand.

Declaration

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

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.

Returns

Type	Description
Task<ApiResponse<CustomFieldMessage>>	Return the custom field message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

DeleteCustomFieldWithHttpInfo(String)

Deletes the custom field for the specified brand.

Declaration

ApiResponse<CustomFieldMessage> DeleteCustomFieldWithHttpInfo(string customFieldId)

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.

Returns

Type	Description
ApiResponse<CustomFieldMessage>	Return the custom field message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

EditCustomField(String, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

Declaration

CustomFieldMessage EditCustomField(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
CustomFieldMessage	Return the custom message.

| Improve this Doc View Source

EditCustomFieldAsync(String, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

Declaration

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

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
Task<CustomFieldMessage>	Return the custom message.

| Improve this Doc View Source

EditCustomFieldAsyncWithHttpInfo(String, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

Declaration

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

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
Task<ApiResponse<CustomFieldMessage>>	Return the custom field message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

EditCustomFieldWithHttpInfo(String, BrandCustomFieldDetails)

Edits a custom field for the specified brand.

Declaration

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

Parameters

Type	Name	Description
System.String	customFieldId	The custom field id.
BrandCustomFieldDetails	brandCustomFieldDetails	The brand custom fields class.

Returns

Type	Description
ApiResponse<CustomFieldMessage>	Return the custom message.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetBrandBasedCustomFields(String)

Gets the collections of custom fields for the specified brand.

Declaration

CustomFieldCollection GetBrandBasedCustomFields(string brandId)

Parameters

Type	Name	Description
System.String	brandId	The brand Id.

Returns

Type	Description
CustomFieldCollection	Returns the collection of custom fields.

| Improve this Doc View Source

GetBrandBasedCustomFieldsAsync(String)

Gets the collections of custom fields for the specified brand.

Declaration

Task<CustomFieldCollection> GetBrandBasedCustomFieldsAsync(string brandId)

Parameters

Type	Name	Description
System.String	brandId	The brand Id.

Returns

Type	Description
Task<CustomFieldCollection>	Returns the collection of custom fields.

| Improve this Doc View Source

GetBrandBasedCustomFieldsAsyncWithHttpInfo(String)

Gets the collections of custom fields for the specified brand.

Declaration

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

Parameters

Type	Name	Description
System.String	brandId	The brand Id.

Returns

Type	Description
Task<ApiResponse<CustomFieldCollection>>	Returns the collection of custom fields.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.

| Improve this Doc View Source

GetBrandBasedCustomFieldsWithHttpInfo(String)

Gets the collections of custom fields for the specified brand.

Declaration

ApiResponse<CustomFieldCollection> GetBrandBasedCustomFieldsWithHttpInfo(string brandId)

Parameters

Type	Name	Description
System.String	brandId	The brand Id.

Returns

Type	Description
ApiResponse<CustomFieldCollection>	Returns the collection of custom fields.

Exceptions

Type	Condition
ApiException	Thrown when fails to make API call.