Class CustomFieldApi

java.lang.Object

com.boldsign.api.CustomFieldApi

public class CustomFieldApi
extends Object

Constructor Summary

Constructors

Constructor	Description
CustomFieldApi()
CustomFieldApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
CustomFieldMessage	createCustomField(BrandCustomFieldDetails brandCustomFieldDetails)	Create the custom field.
okhttp3.Call	createCustomFieldAsync(BrandCustomFieldDetails brandCustomFieldDetails, ApiCallback<CustomFieldMessage> _callback)	Create the custom field.
okhttp3.Call	createCustomFieldCall(BrandCustomFieldDetails brandCustomFieldDetails, ApiCallback _callback)	Build call for createCustomField
ApiResponse<CustomFieldMessage>	createCustomFieldWithHttpInfo(BrandCustomFieldDetails brandCustomFieldDetails)	Create the custom field.
CustomFieldCollection	customFieldsList(String brandId)	List the custom fields respective to the brand id.
okhttp3.Call	customFieldsListAsync(String brandId, ApiCallback<CustomFieldCollection> _callback)	List the custom fields respective to the brand id.
okhttp3.Call	customFieldsListCall(String brandId, ApiCallback _callback)	Build call for customFieldsList
ApiResponse<CustomFieldCollection>	customFieldsListWithHttpInfo(String brandId)	List the custom fields respective to the brand id.
DeleteCustomFieldReply	deleteCustomField(String customFieldId)	Delete the custom field.
okhttp3.Call	deleteCustomFieldAsync(String customFieldId, ApiCallback<DeleteCustomFieldReply> _callback)	Delete the custom field.
okhttp3.Call	deleteCustomFieldCall(String customFieldId, ApiCallback _callback)	Build call for deleteCustomField
ApiResponse<DeleteCustomFieldReply>	deleteCustomFieldWithHttpInfo(String customFieldId)	Delete the custom field.
CustomFieldMessage	editCustomField(String customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)	Edit the custom field.
okhttp3.Call	editCustomFieldAsync(String customFieldId, BrandCustomFieldDetails brandCustomFieldDetails, ApiCallback<CustomFieldMessage> _callback)	Edit the custom field.
okhttp3.Call	editCustomFieldCall(String customFieldId, BrandCustomFieldDetails brandCustomFieldDetails, ApiCallback _callback)	Build call for editCustomField
ApiResponse<CustomFieldMessage>	editCustomFieldWithHttpInfo(String customFieldId, BrandCustomFieldDetails brandCustomFieldDetails)	Edit the custom field.
EmbeddedCustomFieldCreated	embedCustomField(String brandId, OffsetDateTime linkValidTill)	Generates a URL for creating or modifying custom fields within your application's embedded Designer.
okhttp3.Call	embedCustomFieldAsync(String brandId, OffsetDateTime linkValidTill, ApiCallback<EmbeddedCustomFieldCreated> _callback)	Generates a URL for creating or modifying custom fields within your application's embedded Designer.
okhttp3.Call	embedCustomFieldCall(String brandId, OffsetDateTime linkValidTill, ApiCallback _callback)	Build call for embedCustomField
ApiResponse<EmbeddedCustomFieldCreated>	embedCustomFieldWithHttpInfo(String brandId, OffsetDateTime linkValidTill)	Generates a URL for creating or modifying custom fields within your application's embedded Designer.
ApiClient	getApiClient()
String	getCustomBaseUrl()
int	getHostIndex()
void	setApiClient(ApiClient apiClient)
void	setCustomBaseUrl(String customBaseUrl)
void	setHostIndex(int hostIndex)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

CustomFieldApi

public CustomFieldApi()

CustomFieldApi

public CustomFieldApi(ApiClient apiClient)

Method Details

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

getHostIndex

public int getHostIndex()

setHostIndex

public void setHostIndex(int hostIndex)

getCustomBaseUrl

public String getCustomBaseUrl()

setCustomBaseUrl

public void setCustomBaseUrl(String customBaseUrl)

createCustomFieldCall

public okhttp3.Call createCustomFieldCall(BrandCustomFieldDetails brandCustomFieldDetails,
 ApiCallback _callback)
                                   throws ApiException

Build call for createCustomField

Parameters:

brandCustomFieldDetails - The custom field details. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

createCustomField

public CustomFieldMessage createCustomField(BrandCustomFieldDetails brandCustomFieldDetails)
                                     throws ApiException

Create the custom field.

Parameters:

brandCustomFieldDetails - The custom field details. (required)

Returns:

CustomFieldMessage

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

createCustomFieldWithHttpInfo

public ApiResponse<CustomFieldMessage> createCustomFieldWithHttpInfo(BrandCustomFieldDetails brandCustomFieldDetails)
                                                              throws ApiException

Create the custom field.

Parameters:

brandCustomFieldDetails - The custom field details. (required)

Returns:

ApiResponse<CustomFieldMessage>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

createCustomFieldAsync

public okhttp3.Call createCustomFieldAsync(BrandCustomFieldDetails brandCustomFieldDetails,
 ApiCallback<CustomFieldMessage> _callback)
                                    throws ApiException

Create the custom field. (asynchronously)

Parameters:

brandCustomFieldDetails - The custom field details. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

customFieldsListCall

public okhttp3.Call customFieldsListCall(String brandId,
 ApiCallback _callback)
                                  throws ApiException

Build call for customFieldsList

Parameters:

brandId - The brand id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

customFieldsList

public CustomFieldCollection customFieldsList(String brandId)
                                       throws ApiException

List the custom fields respective to the brand id.

Parameters:

brandId - The brand id. (required)

Returns:

CustomFieldCollection

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

customFieldsListWithHttpInfo

public ApiResponse<CustomFieldCollection> customFieldsListWithHttpInfo(String brandId)
                                                                throws ApiException

List the custom fields respective to the brand id.

Parameters:

brandId - The brand id. (required)

Returns:

ApiResponse<CustomFieldCollection>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

customFieldsListAsync

public okhttp3.Call customFieldsListAsync(String brandId,
 ApiCallback<CustomFieldCollection> _callback)
                                   throws ApiException

List the custom fields respective to the brand id. (asynchronously)

Parameters:

brandId - The brand id. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

deleteCustomFieldCall

public okhttp3.Call deleteCustomFieldCall(String customFieldId,
 ApiCallback _callback)
                                   throws ApiException

Build call for deleteCustomField

Parameters:

customFieldId - The custom field id. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

deleteCustomField

public DeleteCustomFieldReply deleteCustomField(String customFieldId)
                                         throws ApiException

Delete the custom field.

Parameters:

customFieldId - The custom field id. (required)

Returns:

DeleteCustomFieldReply

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

deleteCustomFieldWithHttpInfo

public ApiResponse<DeleteCustomFieldReply> deleteCustomFieldWithHttpInfo(String customFieldId)
                                                                  throws ApiException

Delete the custom field.

Parameters:

customFieldId - The custom field id. (required)

Returns:

ApiResponse<DeleteCustomFieldReply>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

deleteCustomFieldAsync

public okhttp3.Call deleteCustomFieldAsync(String customFieldId,
 ApiCallback<DeleteCustomFieldReply> _callback)
                                    throws ApiException

Delete the custom field. (asynchronously)

Parameters:

customFieldId - The custom field id. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

editCustomFieldCall

public okhttp3.Call editCustomFieldCall(String customFieldId,
 BrandCustomFieldDetails brandCustomFieldDetails,
 ApiCallback _callback)
                                 throws ApiException

Build call for editCustomField

Parameters:

customFieldId - The custom field id. (required)

brandCustomFieldDetails - The custom field details. (required)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

editCustomField

public CustomFieldMessage editCustomField(String customFieldId,
 BrandCustomFieldDetails brandCustomFieldDetails)
                                   throws ApiException

Edit the custom field.

Parameters:

customFieldId - The custom field id. (required)

brandCustomFieldDetails - The custom field details. (required)

Returns:

CustomFieldMessage

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

editCustomFieldWithHttpInfo

public ApiResponse<CustomFieldMessage> editCustomFieldWithHttpInfo(String customFieldId,
 BrandCustomFieldDetails brandCustomFieldDetails)
                                                            throws ApiException

Edit the custom field.

Parameters:

customFieldId - The custom field id. (required)

brandCustomFieldDetails - The custom field details. (required)

Returns:

ApiResponse<CustomFieldMessage>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

editCustomFieldAsync

public okhttp3.Call editCustomFieldAsync(String customFieldId,
 BrandCustomFieldDetails brandCustomFieldDetails,
 ApiCallback<CustomFieldMessage> _callback)
                                  throws ApiException

Edit the custom field. (asynchronously)

Parameters:

customFieldId - The custom field id. (required)

brandCustomFieldDetails - The custom field details. (required)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-
422	Unprocessable Content	-

embedCustomFieldCall

public okhttp3.Call embedCustomFieldCall(String brandId,
 OffsetDateTime linkValidTill,
 ApiCallback _callback)
                                  throws ApiException

Build call for embedCustomField

Parameters:

brandId - The Brand ID for custom fields must be configured (required)

linkValidTill - This property is used to set the validity of the generated URL. Its maximum validity is 30 days (optional)

_callback - Callback for upload/download progress

Returns:

Call to execute

Throws:

ApiException - If fail to serialize the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

embedCustomField

public EmbeddedCustomFieldCreated embedCustomField(String brandId,
 OffsetDateTime linkValidTill)
                                            throws ApiException

Generates a URL for creating or modifying custom fields within your application's embedded Designer.

Parameters:

brandId - The Brand ID for custom fields must be configured (required)

linkValidTill - This property is used to set the validity of the generated URL. Its maximum validity is 30 days (optional)

Returns:

EmbeddedCustomFieldCreated

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

embedCustomFieldWithHttpInfo

public ApiResponse<EmbeddedCustomFieldCreated> embedCustomFieldWithHttpInfo(String brandId,
 OffsetDateTime linkValidTill)
                                                                     throws ApiException

Generates a URL for creating or modifying custom fields within your application's embedded Designer.

Parameters:

brandId - The Brand ID for custom fields must be configured (required)

linkValidTill - This property is used to set the validity of the generated URL. Its maximum validity is 30 days (optional)

Returns:

ApiResponse<EmbeddedCustomFieldCreated>

Throws:

ApiException - If fail to call the API, e.g. server error or cannot deserialize the response body

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-

embedCustomFieldAsync

public okhttp3.Call embedCustomFieldAsync(String brandId,
 OffsetDateTime linkValidTill,
 ApiCallback<EmbeddedCustomFieldCreated> _callback)
                                   throws ApiException

Generates a URL for creating or modifying custom fields within your application's embedded Designer. (asynchronously)

Parameters:

brandId - The Brand ID for custom fields must be configured (required)

linkValidTill - This property is used to set the validity of the generated URL. Its maximum validity is 30 days (optional)

_callback - The callback to be executed when the API call finishes

Returns:

The request call

Throws:

ApiException - If fail to process the API call, e.g. serializing the request body object

Http Response Details:

Status Code	Description	Response Headers
200	OK	-
401	Unauthorized	-
403	Forbidden	-