View Source DocuSign.Api.CustomTabs (DocuSign v1.1.1)

API calls for all endpoints tagged CustomTabs.

Summary

Functions

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

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

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

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

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.

Functions

Link to this function

tab_delete_custom_tab(connection, account_id, custom_tab_id, opts \\ [])

View Source
@spec tab_delete_custom_tab(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

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

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • custom_tab_id (String.t): The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

tab_get_custom_tab(connection, account_id, custom_tab_id, opts \\ [])

View Source
@spec tab_get_custom_tab(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.TabMetadata.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • custom_tab_id (String.t): The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.TabMetadata.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

tab_put_custom_tab(connection, account_id, custom_tab_id, opts \\ [])

View Source
@spec tab_put_custom_tab(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.TabMetadata.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • custom_tab_id (String.t): The DocuSign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
  • opts (keyword): Optional parameters
    • :body (TabMetadata):

Returns

  • {:ok, DocuSign.Model.TabMetadata.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

tabs_get_tab_definitions(connection, account_id, opts \\ [])

View Source
@spec tabs_get_tab_definitions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.TabMetadataList.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

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

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :custom_tab_only (String.t): When true, only custom tabs are returned in the response.

Returns

  • {:ok, DocuSign.Model.TabMetadataList.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

tabs_post_tab_definitions(connection, account_id, opts \\ [])

View Source
@spec tabs_post_tab_definitions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.TabMetadata.t()}
  | {:error, Tesla.Env.t()}

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

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :body (TabMetadata):

Returns

  • {:ok, DocuSign.Model.TabMetadata.t} on success
  • {:error, Tesla.Env.t} on failure