Package com.boldsign.api

Class BrandingApi

java.lang.Object

com.boldsign.api.BrandingApi

public class BrandingApi
extends Object

Constructor Summary

Constructors

Constructor	Description
BrandingApi()
BrandingApi(ApiClient apiClient)

Method Summary

Modifier and Type	Method	Description
BrandingRecords	brandList()	List all the brands.
okhttp3.Call	brandListAsync(ApiCallback<BrandingRecords> _callback)	List all the brands.
okhttp3.Call	brandListCall(ApiCallback _callback)	Build call for brandList
ApiResponse<BrandingRecords>	brandListWithHttpInfo()	List all the brands.
BrandCreated	createBrand(String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName)	Create the brand.
okhttp3.Call	createBrandAsync(String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName, ApiCallback<BrandCreated> _callback)	Create the brand.
okhttp3.Call	createBrandCall(String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName, ApiCallback _callback)	Build call for createBrand
ApiResponse<BrandCreated>	createBrandWithHttpInfo(String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName)	Create the brand.
BrandingMessage	deleteBrand(String brandId)	Delete the brand.
okhttp3.Call	deleteBrandAsync(String brandId, ApiCallback<BrandingMessage> _callback)	Delete the brand.
okhttp3.Call	deleteBrandCall(String brandId, ApiCallback _callback)	Build call for deleteBrand
ApiResponse<BrandingMessage>	deleteBrandWithHttpInfo(String brandId)	Delete the brand.
BrandCreated	editBrand(String brandId, String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName)	Edit the brand.
okhttp3.Call	editBrandAsync(String brandId, String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName, ApiCallback<BrandCreated> _callback)	Edit the brand.
okhttp3.Call	editBrandCall(String brandId, String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName, ApiCallback _callback)	Build call for editBrand
ApiResponse<BrandCreated>	editBrandWithHttpInfo(String brandId, String brandName, File brandLogo, String backgroundColor, String buttonColor, String buttonTextColor, String emailDisplayName, String disclaimerDescription, String disclaimerTitle, String redirectUrl, Boolean isDefault, Boolean canHideTagLine, Boolean combineAuditTrail, Boolean combineAttachments, Boolean excludeAuditTrailFromEmail, String emailSignedDocument, String documentTimeZone, Boolean showBuiltInFormFields, Boolean allowCustomFieldCreation, Boolean showSharedCustomFields, Boolean hideDecline, Boolean hideSave, String documentExpirySettingsExpiryDateType, Integer documentExpirySettingsExpiryValue, Boolean documentExpirySettingsEnableDefaultExpiryAlert, Boolean documentExpirySettingsEnableAutoReminder, Integer documentExpirySettingsReminderDays, Integer documentExpirySettingsReminderCount, String customDomainSettingsDomainName, String customDomainSettingsFromName)	Edit the brand.
ApiClient	getApiClient()
ViewBrandDetails	getBrand(String brandId)	Get the specific brand details.
okhttp3.Call	getBrandAsync(String brandId, ApiCallback<ViewBrandDetails> _callback)	Get the specific brand details.
okhttp3.Call	getBrandCall(String brandId, ApiCallback _callback)	Build call for getBrand
ApiResponse<ViewBrandDetails>	getBrandWithHttpInfo(String brandId)	Get the specific brand details.
String	getCustomBaseUrl()
int	getHostIndex()
BrandingMessage	resetDefaultBrand(String brandId)	Reset default brand.
okhttp3.Call	resetDefaultBrandAsync(String brandId, ApiCallback<BrandingMessage> _callback)	Reset default brand.
okhttp3.Call	resetDefaultBrandCall(String brandId, ApiCallback _callback)	Build call for resetDefaultBrand
ApiResponse<BrandingMessage>	resetDefaultBrandWithHttpInfo(String brandId)	Reset default brand.
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 Detail

BrandingApi

public BrandingApi()

BrandingApi

public BrandingApi(ApiClient apiClient)

Method Detail

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)

brandListCall

public okhttp3.Call brandListCall(ApiCallback _callback)
                           throws ApiException

Build call for brandList

Parameters:

_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	-

brandList

public BrandingRecords brandList()
                          throws ApiException

List all the brands.

Returns:

BrandingRecords

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	-

brandListWithHttpInfo

public ApiResponse<BrandingRecords> brandListWithHttpInfo()
                                                   throws ApiException

List all the brands.

Returns:

ApiResponse<BrandingRecords>

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	-

brandListAsync

public okhttp3.Call brandListAsync(ApiCallback<BrandingRecords> _callback)
                            throws ApiException

List all the brands. (asynchronously)

Parameters:

_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	-

createBrandCall

public okhttp3.Call createBrandCall(String brandName,
                                    File brandLogo,
                                    String backgroundColor,
                                    String buttonColor,
                                    String buttonTextColor,
                                    String emailDisplayName,
                                    String disclaimerDescription,
                                    String disclaimerTitle,
                                    String redirectUrl,
                                    Boolean isDefault,
                                    Boolean canHideTagLine,
                                    Boolean combineAuditTrail,
                                    Boolean combineAttachments,
                                    Boolean excludeAuditTrailFromEmail,
                                    String emailSignedDocument,
                                    String documentTimeZone,
                                    Boolean showBuiltInFormFields,
                                    Boolean allowCustomFieldCreation,
                                    Boolean showSharedCustomFields,
                                    Boolean hideDecline,
                                    Boolean hideSave,
                                    String documentExpirySettingsExpiryDateType,
                                    Integer documentExpirySettingsExpiryValue,
                                    Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                                    Boolean documentExpirySettingsEnableAutoReminder,
                                    Integer documentExpirySettingsReminderDays,
                                    Integer documentExpirySettingsReminderCount,
                                    String customDomainSettingsDomainName,
                                    String customDomainSettingsFromName,
                                    ApiCallback _callback)
                             throws ApiException

Build call for createBrand

Parameters:

brandName - (required)

brandLogo - (required)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (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	-
422	Unprocessable Content	-

createBrand

public BrandCreated createBrand(String brandName,
                                File brandLogo,
                                String backgroundColor,
                                String buttonColor,
                                String buttonTextColor,
                                String emailDisplayName,
                                String disclaimerDescription,
                                String disclaimerTitle,
                                String redirectUrl,
                                Boolean isDefault,
                                Boolean canHideTagLine,
                                Boolean combineAuditTrail,
                                Boolean combineAttachments,
                                Boolean excludeAuditTrailFromEmail,
                                String emailSignedDocument,
                                String documentTimeZone,
                                Boolean showBuiltInFormFields,
                                Boolean allowCustomFieldCreation,
                                Boolean showSharedCustomFields,
                                Boolean hideDecline,
                                Boolean hideSave,
                                String documentExpirySettingsExpiryDateType,
                                Integer documentExpirySettingsExpiryValue,
                                Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                                Boolean documentExpirySettingsEnableAutoReminder,
                                Integer documentExpirySettingsReminderDays,
                                Integer documentExpirySettingsReminderCount,
                                String customDomainSettingsDomainName,
                                String customDomainSettingsFromName)
                         throws ApiException

Create the brand.

Parameters:

brandName - (required)

brandLogo - (required)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (optional)

Returns:

BrandCreated

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	-

createBrandWithHttpInfo

public ApiResponse<BrandCreated> createBrandWithHttpInfo(String brandName,
                                                         File brandLogo,
                                                         String backgroundColor,
                                                         String buttonColor,
                                                         String buttonTextColor,
                                                         String emailDisplayName,
                                                         String disclaimerDescription,
                                                         String disclaimerTitle,
                                                         String redirectUrl,
                                                         Boolean isDefault,
                                                         Boolean canHideTagLine,
                                                         Boolean combineAuditTrail,
                                                         Boolean combineAttachments,
                                                         Boolean excludeAuditTrailFromEmail,
                                                         String emailSignedDocument,
                                                         String documentTimeZone,
                                                         Boolean showBuiltInFormFields,
                                                         Boolean allowCustomFieldCreation,
                                                         Boolean showSharedCustomFields,
                                                         Boolean hideDecline,
                                                         Boolean hideSave,
                                                         String documentExpirySettingsExpiryDateType,
                                                         Integer documentExpirySettingsExpiryValue,
                                                         Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                                                         Boolean documentExpirySettingsEnableAutoReminder,
                                                         Integer documentExpirySettingsReminderDays,
                                                         Integer documentExpirySettingsReminderCount,
                                                         String customDomainSettingsDomainName,
                                                         String customDomainSettingsFromName)
                                                  throws ApiException

Create the brand.

Parameters:

brandName - (required)

brandLogo - (required)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (optional)

Returns:

ApiResponse<BrandCreated>

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	-

createBrandAsync

public okhttp3.Call createBrandAsync(String brandName,
                                     File brandLogo,
                                     String backgroundColor,
                                     String buttonColor,
                                     String buttonTextColor,
                                     String emailDisplayName,
                                     String disclaimerDescription,
                                     String disclaimerTitle,
                                     String redirectUrl,
                                     Boolean isDefault,
                                     Boolean canHideTagLine,
                                     Boolean combineAuditTrail,
                                     Boolean combineAttachments,
                                     Boolean excludeAuditTrailFromEmail,
                                     String emailSignedDocument,
                                     String documentTimeZone,
                                     Boolean showBuiltInFormFields,
                                     Boolean allowCustomFieldCreation,
                                     Boolean showSharedCustomFields,
                                     Boolean hideDecline,
                                     Boolean hideSave,
                                     String documentExpirySettingsExpiryDateType,
                                     Integer documentExpirySettingsExpiryValue,
                                     Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                                     Boolean documentExpirySettingsEnableAutoReminder,
                                     Integer documentExpirySettingsReminderDays,
                                     Integer documentExpirySettingsReminderCount,
                                     String customDomainSettingsDomainName,
                                     String customDomainSettingsFromName,
                                     ApiCallback<BrandCreated> _callback)
                              throws ApiException

Create the brand. (asynchronously)

Parameters:

brandName - (required)

brandLogo - (required)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (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	-
422	Unprocessable Content	-

deleteBrandCall

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

Build call for deleteBrand

Parameters:

brandId - 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	-

deleteBrand

public BrandingMessage deleteBrand(String brandId)
                            throws ApiException

Delete the brand.

Parameters:

brandId - brand Id. (required)

Returns:

BrandingMessage

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	-

deleteBrandWithHttpInfo

public ApiResponse<BrandingMessage> deleteBrandWithHttpInfo(String brandId)
                                                     throws ApiException

Delete the brand.

Parameters:

brandId - brand Id. (required)

Returns:

ApiResponse<BrandingMessage>

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	-

deleteBrandAsync

public okhttp3.Call deleteBrandAsync(String brandId,
                                     ApiCallback<BrandingMessage> _callback)
                              throws ApiException

Delete the brand. (asynchronously)

Parameters:

brandId - 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	-

editBrandCall

public okhttp3.Call editBrandCall(String brandId,
                                  String brandName,
                                  File brandLogo,
                                  String backgroundColor,
                                  String buttonColor,
                                  String buttonTextColor,
                                  String emailDisplayName,
                                  String disclaimerDescription,
                                  String disclaimerTitle,
                                  String redirectUrl,
                                  Boolean isDefault,
                                  Boolean canHideTagLine,
                                  Boolean combineAuditTrail,
                                  Boolean combineAttachments,
                                  Boolean excludeAuditTrailFromEmail,
                                  String emailSignedDocument,
                                  String documentTimeZone,
                                  Boolean showBuiltInFormFields,
                                  Boolean allowCustomFieldCreation,
                                  Boolean showSharedCustomFields,
                                  Boolean hideDecline,
                                  Boolean hideSave,
                                  String documentExpirySettingsExpiryDateType,
                                  Integer documentExpirySettingsExpiryValue,
                                  Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                                  Boolean documentExpirySettingsEnableAutoReminder,
                                  Integer documentExpirySettingsReminderDays,
                                  Integer documentExpirySettingsReminderCount,
                                  String customDomainSettingsDomainName,
                                  String customDomainSettingsFromName,
                                  ApiCallback _callback)
                           throws ApiException

Build call for editBrand

Parameters:

brandId - The brand id. (required)

brandName - (optional)

brandLogo - (optional)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (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	-
422	Unprocessable Content	-

editBrand

public BrandCreated editBrand(String brandId,
                              String brandName,
                              File brandLogo,
                              String backgroundColor,
                              String buttonColor,
                              String buttonTextColor,
                              String emailDisplayName,
                              String disclaimerDescription,
                              String disclaimerTitle,
                              String redirectUrl,
                              Boolean isDefault,
                              Boolean canHideTagLine,
                              Boolean combineAuditTrail,
                              Boolean combineAttachments,
                              Boolean excludeAuditTrailFromEmail,
                              String emailSignedDocument,
                              String documentTimeZone,
                              Boolean showBuiltInFormFields,
                              Boolean allowCustomFieldCreation,
                              Boolean showSharedCustomFields,
                              Boolean hideDecline,
                              Boolean hideSave,
                              String documentExpirySettingsExpiryDateType,
                              Integer documentExpirySettingsExpiryValue,
                              Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                              Boolean documentExpirySettingsEnableAutoReminder,
                              Integer documentExpirySettingsReminderDays,
                              Integer documentExpirySettingsReminderCount,
                              String customDomainSettingsDomainName,
                              String customDomainSettingsFromName)
                       throws ApiException

Edit the brand.

Parameters:

brandId - The brand id. (required)

brandName - (optional)

brandLogo - (optional)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (optional)

Returns:

BrandCreated

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	-

editBrandWithHttpInfo

public ApiResponse<BrandCreated> editBrandWithHttpInfo(String brandId,
                                                       String brandName,
                                                       File brandLogo,
                                                       String backgroundColor,
                                                       String buttonColor,
                                                       String buttonTextColor,
                                                       String emailDisplayName,
                                                       String disclaimerDescription,
                                                       String disclaimerTitle,
                                                       String redirectUrl,
                                                       Boolean isDefault,
                                                       Boolean canHideTagLine,
                                                       Boolean combineAuditTrail,
                                                       Boolean combineAttachments,
                                                       Boolean excludeAuditTrailFromEmail,
                                                       String emailSignedDocument,
                                                       String documentTimeZone,
                                                       Boolean showBuiltInFormFields,
                                                       Boolean allowCustomFieldCreation,
                                                       Boolean showSharedCustomFields,
                                                       Boolean hideDecline,
                                                       Boolean hideSave,
                                                       String documentExpirySettingsExpiryDateType,
                                                       Integer documentExpirySettingsExpiryValue,
                                                       Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                                                       Boolean documentExpirySettingsEnableAutoReminder,
                                                       Integer documentExpirySettingsReminderDays,
                                                       Integer documentExpirySettingsReminderCount,
                                                       String customDomainSettingsDomainName,
                                                       String customDomainSettingsFromName)
                                                throws ApiException

Edit the brand.

Parameters:

brandId - The brand id. (required)

brandName - (optional)

brandLogo - (optional)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (optional)

Returns:

ApiResponse<BrandCreated>

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	-

editBrandAsync

public okhttp3.Call editBrandAsync(String brandId,
                                   String brandName,
                                   File brandLogo,
                                   String backgroundColor,
                                   String buttonColor,
                                   String buttonTextColor,
                                   String emailDisplayName,
                                   String disclaimerDescription,
                                   String disclaimerTitle,
                                   String redirectUrl,
                                   Boolean isDefault,
                                   Boolean canHideTagLine,
                                   Boolean combineAuditTrail,
                                   Boolean combineAttachments,
                                   Boolean excludeAuditTrailFromEmail,
                                   String emailSignedDocument,
                                   String documentTimeZone,
                                   Boolean showBuiltInFormFields,
                                   Boolean allowCustomFieldCreation,
                                   Boolean showSharedCustomFields,
                                   Boolean hideDecline,
                                   Boolean hideSave,
                                   String documentExpirySettingsExpiryDateType,
                                   Integer documentExpirySettingsExpiryValue,
                                   Boolean documentExpirySettingsEnableDefaultExpiryAlert,
                                   Boolean documentExpirySettingsEnableAutoReminder,
                                   Integer documentExpirySettingsReminderDays,
                                   Integer documentExpirySettingsReminderCount,
                                   String customDomainSettingsDomainName,
                                   String customDomainSettingsFromName,
                                   ApiCallback<BrandCreated> _callback)
                            throws ApiException

Edit the brand. (asynchronously)

Parameters:

brandId - The brand id. (required)

brandName - (optional)

brandLogo - (optional)

backgroundColor - (optional)

buttonColor - (optional)

buttonTextColor - (optional)

emailDisplayName - (optional)

disclaimerDescription - (optional)

disclaimerTitle - (optional)

redirectUrl - (optional)

isDefault - (optional, default to false)

canHideTagLine - (optional, default to false)

combineAuditTrail - (optional, default to false)

combineAttachments - (optional, default to false)

excludeAuditTrailFromEmail - (optional, default to false)

emailSignedDocument - (optional, default to Attachment)

documentTimeZone - (optional)

showBuiltInFormFields - (optional, default to true)

allowCustomFieldCreation - (optional, default to false)

showSharedCustomFields - (optional, default to false)

hideDecline - (optional)

hideSave - (optional)

documentExpirySettingsExpiryDateType - (optional)

documentExpirySettingsExpiryValue - (optional)

documentExpirySettingsEnableDefaultExpiryAlert - (optional)

documentExpirySettingsEnableAutoReminder - (optional)

documentExpirySettingsReminderDays - (optional)

documentExpirySettingsReminderCount - (optional)

customDomainSettingsDomainName - (optional)

customDomainSettingsFromName - (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	-
422	Unprocessable Content	-

getBrandCall

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

Build call for getBrand

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	-
422	Unprocessable Content	-

getBrand

public ViewBrandDetails getBrand(String brandId)
                          throws ApiException

Get the specific brand details.

Parameters:

brandId - The brand id. (required)

Returns:

ViewBrandDetails

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	-

getBrandWithHttpInfo

public ApiResponse<ViewBrandDetails> getBrandWithHttpInfo(String brandId)
                                                   throws ApiException

Get the specific brand details.

Parameters:

brandId - The brand id. (required)

Returns:

ApiResponse<ViewBrandDetails>

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	-

getBrandAsync

public okhttp3.Call getBrandAsync(String brandId,
                                  ApiCallback<ViewBrandDetails> _callback)
                           throws ApiException

Get the specific brand details. (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	-
422	Unprocessable Content	-

resetDefaultBrandCall

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

Build call for resetDefaultBrand

Parameters:

brandId - 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	-

resetDefaultBrand

public BrandingMessage resetDefaultBrand(String brandId)
                                  throws ApiException

Reset default brand.

Parameters:

brandId - brand Id. (required)

Returns:

BrandingMessage

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	-

resetDefaultBrandWithHttpInfo

public ApiResponse<BrandingMessage> resetDefaultBrandWithHttpInfo(String brandId)
                                                           throws ApiException

Reset default brand.

Parameters:

brandId - brand Id. (required)

Returns:

ApiResponse<BrandingMessage>

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	-

resetDefaultBrandAsync

public okhttp3.Call resetDefaultBrandAsync(String brandId,
                                           ApiCallback<BrandingMessage> _callback)
                                    throws ApiException

Reset default brand. (asynchronously)

Parameters:

brandId - 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	-