module:api/CustomTabsApi

new module:api/CustomTabsApi(apiClient)

Source:

api/CustomTabsApi.js, line 41

Constructs a new CustomTabsApi.

Parameters:

Name	Type	Description
`apiClient`	module:ApiClient	Optional API client implementation to use, default to `module:ApiClient#instance` if unspecified.

Methods

_delete(accountId, customTabId, callback)

Source:

api/CustomTabsApi.js, line 69

Deletes custom tab information.
Deletes the custom from the specified account.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`customTabId`	String
`callback`	module:api/CustomTabsApi~_deleteCallback	The callback function, accepting three arguments: error, data, response

create(accountId, optsOrCallback, callback)

Source:

api/CustomTabsApi.js, line 131

Creates a custom tab.
Creates a tab with pre-defined properties, such as a text tab with a certain font type and validation pattern. Users can access the custom tabs when sending documents through the DocuSign web application.

Custom tabs can be created for approve, checkbox, company, date, date signed, decline, email, email address, envelope ID, first name, formula, full name, initial here, last name, list, note, number, radio, sign here, signer attachment, SSN, text, title, and zip tabs.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`tabMetadata`	module:model/TabMetadata

callback

module:api/CustomTabsApi~createCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TabMetadata

get(accountId, customTabId, callback)

Source:

api/CustomTabsApi.js, line 191

Gets custom tab information.
Retrieves information about the requested custom tab on the specified account.

Parameters:

Name	Type	Description
`accountId`	String	The external account number (int) or account ID Guid.
`customTabId`	String
`callback`	module:api/CustomTabsApi~getCallback	The callback function, accepting three arguments: error, data, response data is of type: `module:model/TabMetadata`

list(accountId, optsOrCallback, callback)

Source:

api/CustomTabsApi.js, line 251

Gets a list of all account tabs.
Retrieves a list of all tabs associated with the account.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`customTabOnly`	String	When set to true, only custom tabs are returned in the response.

callback

module:api/CustomTabsApi~listCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TabMetadataList

update(accountId, customTabId, optsOrCallback, callback)

Source:

api/CustomTabsApi.js, line 314

Updates custom tab information.
Updates the information in a custom tab for the specified account.

Parameters:

Name Type Description

accountId

String

The external account number (int) or account ID Guid.

customTabId String

optsOrCallback

Object

Optional parameters, if you are passing no optional parameters, you can either pass a null or omit this parameter entirely.

Properties

Name	Type	Description
`tabMetadata`	module:model/TabMetadata

callback

module:api/CustomTabsApi~updateCallback

The callback function, accepting three arguments: error, data, response
data is of type: module:model/TabMetadata

Type Definitions

_deleteCallback(error, data, If)

Source:

api/CustomTabsApi.js, line 54

(Optional) Callback function to receive the result of the _delete operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`		This operation does not return a value.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

createCallback(error, data, If)

Source:

api/CustomTabsApi.js, line 112

(Optional) Callback function to receive the result of the create operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/TabMetadata	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

getCallback(error, data, If)

Source:

api/CustomTabsApi.js, line 175

(Optional) Callback function to receive the result of the get operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/TabMetadata	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

listCallback(error, data, If)

Source:

api/CustomTabsApi.js, line 234

(Optional) Callback function to receive the result of the list operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/TabMetadataList	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.

updateCallback(error, data, If)

Source:

api/CustomTabsApi.js, line 296

(Optional) Callback function to receive the result of the update operation. If none specified a Promise will be returned.

Parameters:

Name	Type	Description
`error`	String	Error message, if any.
`data`	module:model/TabMetadata	The data returned by the service call.
`If`	String	a callback was specified, the response The complete HTTP response, else a Promise resolving the response Data.