DocuSign v0.1.2 DocuSign.Api.CustomTabs View Source

API calls for all endpoints tagged CustomTabs.

Link to this section 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

Link to this section Functions

Link to this function tab_delete_custom_tab(connection, account_id, custom_tab_id, opts \\ []) View Source
tab_delete_custom_tab(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, nil} | {: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):
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %{}} on success {:error, info} on failure

Link to this function tab_get_custom_tab(connection, account_id, custom_tab_id, opts \\ []) View Source
tab_get_custom_tab(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.CustomTabs.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):
  • opts (KeywordList): [optional] Optional parameters

Returns

{:ok, %DocuSign.Model.CustomTabs{}} on success {:error, info} on failure

Link to this function tab_put_custom_tab(connection, account_id, custom_tab_id, opts \\ []) View Source
tab_put_custom_tab(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.CustomTabs.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):
  • opts (KeywordList): [optional] Optional parameters

    • :custom_tabs (CustomTabs):

Returns

{:ok, %DocuSign.Model.CustomTabs{}} on success {:error, info} on failure

Link to this function tabs_get_tab_definitions(connection, account_id, opts \\ []) View Source
tabs_get_tab_definitions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.TabMetadataList.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 (KeywordList): [optional] Optional parameters

    • :custom_tab_only (String.t): When set to true, only custom tabs are returned in the response.

Returns

{:ok, %DocuSign.Model.TabMetadataList{}} on success {:error, info} on failure

Link to this function tabs_post_tab_definitions(connection, account_id, opts \\ []) View Source
tabs_post_tab_definitions(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.CustomTabs.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 (KeywordList): [optional] Optional parameters

    • :custom_tabs (CustomTabs):

Returns

{:ok, %DocuSign.Model.CustomTabs{}} on success {:error, info} on failure