com.docusign.esign.api

Class CustomTabsApi

java.lang.Object

com.docusign.esign.api.CustomTabsApi

public class CustomTabsApi
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	CustomTabsApi.ListOptions

Constructor Summary

Constructors

Constructor and Description
CustomTabsApi()
CustomTabsApi(ApiClient apiClient)

Method Summary

Methods

Modifier and Type	Method and Description
TabMetadata	create(String accountId, TabMetadata tabMetadata) Creates a custom tab.
void	delete(String accountId, String customTabId) Deletes custom tab information.
TabMetadata	get(String accountId, String customTabId) Gets custom tab information.
ApiClient	getApiClient()
TabMetadataList	list(String accountId) Gets a list of all account tabs.
TabMetadataList	list(String accountId, CustomTabsApi.ListOptions options) Gets a list of all account tabs.
void	setApiClient(ApiClient apiClient)
TabMetadata	update(String accountId, String customTabId, TabMetadata tabMetadata) Updates custom tab information.

Methods inherited from class java.lang.Object

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

Constructor Detail

CustomTabsApi

public CustomTabsApi()

CustomTabsApi

public CustomTabsApi(ApiClient apiClient)

Method Detail

getApiClient

public ApiClient getApiClient()

setApiClient

public void setApiClient(ApiClient apiClient)

create

public TabMetadata create(String accountId,
                 TabMetadata tabMetadata)
                   throws ApiException

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:

accountId - The external account number (int) or account ID Guid. (required)

tabMetadata - (optional)

Returns:

TabMetadata

Throws:

ApiException - if fails to make API call

delete

public void delete(String accountId,
          String customTabId)
            throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

customTabId - (required)

Throws:

ApiException - if fails to make API call

get

public TabMetadata get(String accountId,
              String customTabId)
                throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

customTabId - (required)

Returns:

TabMetadata

Throws:

ApiException - if fails to make API call

list

public TabMetadataList list(String accountId)
                     throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

Returns:

TabMetadataList

Throws:

ApiException

list

public TabMetadataList list(String accountId,
                   CustomTabsApi.ListOptions options)
                     throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

options - for modifying the method behavior.

Returns:

TabMetadataList

Throws:

ApiException - if fails to make API call

update

public TabMetadata update(String accountId,
                 String customTabId,
                 TabMetadata tabMetadata)
                   throws ApiException

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

Parameters:

accountId - The external account number (int) or account ID Guid. (required)

customTabId - (required)

tabMetadata - (optional)

Returns:

TabMetadata

Throws:

ApiException - if fails to make API call