Class CustomFieldClient
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.
Inheritance
Namespace: BoldSign.Api
Assembly: BoldSign.Api.dll
Syntax
public class CustomFieldClient : object, ICustomFieldClient, IApiAccessor
Constructors
| Improve this Doc View SourceCustomFieldClient()
Initializes a new instance of the CustomFieldClient class.
Declaration
public CustomFieldClient()
CustomFieldClient(ApiClient)
Initializes a new instance of the CustomFieldClient class using Configuration object.
Declaration
public CustomFieldClient(ApiClient apiClient)
Parameters
Type | Name | Description |
---|---|---|
ApiClient | apiClient | An instance of ApiClient. |
CustomFieldClient(Configuration)
Initializes a new instance of the CustomFieldClient class using Configuration object.
Declaration
public CustomFieldClient(Configuration configuration = null)
Parameters
Type | Name | Description |
---|---|---|
Configuration | configuration | An instance of Configuration. |
CustomFieldClient(String)
Initializes a new instance of the CustomFieldClient class.
Declaration
public CustomFieldClient(string basePath)
Parameters
Type | Name | Description |
---|---|---|
System.String | basePath | Gets or set the basePath. |
Properties
| Improve this Doc View SourceConfiguration
Gets or sets the configuration object.
Declaration
public Configuration Configuration { get; set; }
Property Value
Type | Description |
---|---|
Configuration | An instance of the Configuration. |
ExceptionFactory
Gets or sets provides a factory method hook for the creation of exceptions.
Declaration
public ExceptionFactory ExceptionFactory { get; set; }
Property Value
Type | Description |
---|---|
ExceptionFactory |
Methods
| Improve this Doc View SourceCreateCustomField(BrandCustomFieldDetails)
Creates a custom field for the specified brand.
Declaration
public CustomFieldMessage CreateCustomField(BrandCustomFieldDetails brandCustomFieldDetails)
Parameters
Type | Name | Description |
---|---|---|
BrandCustomFieldDetails | brandCustomFieldDetails | The brand custom fields class. |
Returns
Type | Description |
---|---|
CustomFieldMessage | Return the custom message. |
CreateCustomFieldAsync(BrandCustomFieldDetails)
Creates a custom field for the specified brand.
Declaration
public async 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. |
CreateCustomFieldAsyncWithHttpInfo(BrandCustomFieldDetails)
Creates a custom field for the specified brand.
Declaration
public async 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. |
CreateCustomFieldWithHttpInfo(BrandCustomFieldDetails)
Created a custom field for the specified brand.
Declaration
public 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. |
CreateEmbeddedCustomFieldUrl(EmbeddedCustomFieldDetails)
Generates a URL to embed manipulation of custom field process into your application.
Declaration
public 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. |
CreateEmbeddedCustomFieldUrlAsync(EmbeddedCustomFieldDetails)
Generates a URL to embed manipulation of custom field process into your application.
Declaration
public async 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. |
CreateEmbeddedCustomFieldUrlAsyncWithHttpInfo(EmbeddedCustomFieldDetails)
Generates a URL to embed manipulation of custom field process into your application.
Declaration
public async 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. |
CreateEmbeddedCustomFieldUrlWithHttpInfo(EmbeddedCustomFieldDetails)
Generates a URL to embed manipulation of custom field process into your application.
Declaration
public 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. |
DeleteCustomField(String)
Deletes the custom field for the specified brand.
Declaration
public CustomFieldMessage DeleteCustomField(string customFieldId)
Parameters
Type | Name | Description |
---|---|---|
System.String | customFieldId | The custom field id. |
Returns
Type | Description |
---|---|
CustomFieldMessage | Return the custom field message. |
DeleteCustomFieldAsync(String)
Deletes the custom field for the specified brand.
Declaration
public async 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. |
DeleteCustomFieldAsyncWithHttpInfo(String)
Deletes the custom field for the specified brand.
Declaration
public async 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. |
DeleteCustomFieldWithHttpInfo(String)
Deletes the custom field for the specified brand.
Declaration
public 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. |
EditCustomField(String, BrandCustomFieldDetails)
Edits a custom field for the specified brand.
Declaration
public CustomFieldMessage EditCustomField(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)
Parameters
Type | Name | Description |
---|---|---|
System.String | customFieldId | The custom field identifier. |
BrandCustomFieldDetails | brandCustomFieldDetails | The brand custom fields class. |
Returns
Type | Description |
---|---|
CustomFieldMessage | Return the custom message. |
EditCustomFieldAsync(String, BrandCustomFieldDetails)
Edits a custom field for the specified brand.
Declaration
public async Task<CustomFieldMessage> EditCustomFieldAsync(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)
Parameters
Type | Name | Description |
---|---|---|
System.String | customFieldId | The custom field identifier. |
BrandCustomFieldDetails | brandCustomFieldDetails | The brand custom fields class. |
Returns
Type | Description |
---|---|
Task<CustomFieldMessage> | Return the custom message. |
EditCustomFieldAsyncWithHttpInfo(String, BrandCustomFieldDetails)
Edits a custom field for the specified brand.
Declaration
public async Task<ApiResponse<CustomFieldMessage>> EditCustomFieldAsyncWithHttpInfo(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)
Parameters
Type | Name | Description |
---|---|---|
System.String | customFieldId | The custom field identifier. |
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. |
EditCustomFieldWithHttpInfo(String, BrandCustomFieldDetails)
Edits a custom field for the specified brand.
Declaration
public ApiResponse<CustomFieldMessage> EditCustomFieldWithHttpInfo(string customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)
Parameters
Type | Name | Description |
---|---|---|
System.String | customFieldId | The custom field identifier. |
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. |
GetBasePath()
Custom field paths.
Declaration
public string GetBasePath()
Returns
Type | Description |
---|---|
System.String | The base path. |
GetBrandBasedCustomFields(String)
Gets the collections of custom fields for the specified brand.
Declaration
public CustomFieldCollection GetBrandBasedCustomFields(string brandId)
Parameters
Type | Name | Description |
---|---|---|
System.String | brandId | The brand Id. |
Returns
Type | Description |
---|---|
CustomFieldCollection | Returns the collection of custom fields. |
GetBrandBasedCustomFieldsAsync(String)
Gets the collections of custom fields for the specified brand.
Declaration
public async 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. |
GetBrandBasedCustomFieldsAsyncWithHttpInfo(String)
Gets the collections of custom fields for the specified brand.
Declaration
public async 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. |
GetBrandBasedCustomFieldsWithHttpInfo(String)
Gets the collections of custom fields for the specified brand.
Declaration
public 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. |