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

API calls for all endpoints tagged EnvelopeDocumentTabs.

Summary

Functions

tabs_delete_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

Deletes tabs from a document in an envelope. Deletes tabs from the document specified by documentId in the envelope specified by envelopeId.

tabs_get_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

Returns the tabs on a document. Returns the tabs on the document specified by documentId in the envelope specified by envelopeId.

tabs_get_page_tabs(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

Returns tabs on the specified page. Returns the tabs from the page specified by pageNumber of the document specified by documentId in the envelope specified by envelopeId.

tabs_post_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

Adds tabs to a document in an envelope. Adds tabs to the document specified by documentId in the envelope specified by envelopeId. 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_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

Updates the tabs for document. Updates tabs in the document specified by documentId in the envelope specified by envelopeId.

Functions

tabs_delete_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

@spec tabs_delete_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 document in an envelope. Deletes tabs from the document specified by documentId in the envelope specified by envelopeId.

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.
envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts (keyword): Optional parameters
- :body (Tabs): A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

Returns

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

tabs_get_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

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

Returns the tabs on a document. Returns the tabs on the document specified by documentId in the envelope specified by envelopeId.

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.
envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts (keyword): Optional parameters
- :include_metadata (String.t): When true, the response includes metadata indicating which properties are editable.
- :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 Note: You can only enter individual page numbers, and not a page range.

Returns

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

tabs_get_page_tabs(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

@spec tabs_get_page_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.EnvelopeDocumentTabs.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 envelope specified by envelopeId.

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.
envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
page_number (String.t): The page number being accessed.
opts (keyword): Optional parameters

Returns

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

tabs_post_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

@spec tabs_post_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.
envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts (keyword): Optional parameters
- :body (Tabs): A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

Returns

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

tabs_put_document_tabs(connection, account_id, document_id, envelope_id, opts \\ [])

@spec tabs_put_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 document. Updates tabs in the document specified by documentId in the envelope specified by envelopeId.

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.
envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
opts (keyword): Optional parameters
- :body (Tabs): A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

Returns

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