View Source DocuSign.Api.TemplateDocumentTabs (DocuSign v1.2.0)

API calls for all endpoints tagged TemplateDocumentTabs.

Summary

Functions

tabs_delete_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

Deletes tabs from a template. Deletes tabs from the document specified by documentId in the template specified by templateId.

tabs_get_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

Returns tabs on a template. Returns the tabs on the document specified by documentId in the template specified by templateId.

tabs_get_template_page_tabs(connection, account_id, document_id, page_number, template_id, opts \\ [])

Returns tabs on the specified page. Returns the tabs from the page specified by pageNumber of the document specified by documentId in the template specified by templateId.

tabs_post_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

Adds tabs to a document in a template. Adds tabs to the document specified by documentId in the template specified by templateId. In the request body, you only need to specify the tabs that your are adding. For example, to add a text prefill tab, your request body might look like this: { "prefillTabs": { "textTabs": [ { "value": "a prefill text tab", "pageNumber": "1", "documentId": "1", "xPosition": 316, "yPosition": 97 } ] } }

tabs_put_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

Updates the tabs for a template. Updates tabs in the document specified by documentId in the template specified by templateId.

Functions

tabs_delete_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

@spec tabs_delete_template_document_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.Tabs.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Deletes tabs from a template. Deletes tabs from the document specified by documentId in the template specified by templateId.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
template_id (String.t): The ID of the template.
opts (keyword): Optional parameters
- :body (TemplateTabs):

Returns

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

tabs_get_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

@spec tabs_get_template_document_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.TemplateDocumentTabs.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Returns tabs on a template. Returns the tabs on the document specified by documentId in the template specified by templateId.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
template_id (String.t): The ID of the template.
opts (keyword): Optional parameters
- :page_numbers (String.t): Filters for tabs that occur on the pages that you specify. Enter as a comma-separated list of page Guids. Example: page_numbers=2,6

Returns

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

tabs_get_template_page_tabs(connection, account_id, document_id, page_number, template_id, opts \\ [])

@spec tabs_get_template_page_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.TemplateDocumentTabs.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Returns tabs on the specified page. Returns the tabs from the page specified by pageNumber of the document specified by documentId in the template specified by templateId.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
page_number (String.t): The page number being accessed.
template_id (String.t): The ID of the template.
opts (keyword): Optional parameters

Returns

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

tabs_post_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

@spec tabs_post_template_document_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.Tabs.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
template_id (String.t): The ID of the template.
opts (keyword): Optional parameters
- :body (TemplateTabs):

Returns

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

tabs_put_template_document_tabs(connection, account_id, document_id, template_id, opts \\ [])

@spec tabs_put_template_document_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.Tabs.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Updates the tabs for a template. Updates tabs in the document specified by documentId in the template specified by templateId.

Parameters

connection (DocuSign.Connection): Connection to server
account_id (String.t): The external account number (int) or account ID GUID.
document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
template_id (String.t): The ID of the template.
opts (keyword): Optional parameters
- :body (TemplateTabs):

Returns

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