DocuSign.Api.EnvelopeRecipientTabs (DocuSign v0.3.3) View Source

API calls for all endpoints tagged EnvelopeRecipientTabs.

Link to this section Summary

Functions

Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.

Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Updates the tabs for a recipient.
Updates one or more tabs for a recipient in a draft envelope. Note: The Update method can be used if the envelope is not yet complete. To update an existing tab, the request body must include the `tabId`.

Link to this section Functions

Link to this function

recipients_delete_recipient_tabs(connection, account_id, envelope_id, recipient_id, opts \\ [])

View Source

Specs

recipients_delete_recipient_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeRecipientTabs.t()} | {:error, Tesla.Env.t()}

Deletes the tabs associated with a recipient. Deletes one or more tabs associated with a recipient in a draft envelope.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_recipient_tabs (EnvelopeRecipientTabs):

Returns

} on success {:error, info} on failure

Link to this function

recipients_get_recipient_tabs(connection, account_id, envelope_id, recipient_id, opts \\ [])

View Source

Specs

recipients_get_recipient_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeRecipientTabs.t()} | {:error, Tesla.Env.t()}

Gets the tabs information for a signer or sign-in-person recipient in an envelope. Retrieves information about the tabs associated with a recipient in a draft envelope.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • opts (KeywordList): [optional] Optional parameters
    • :include_anchor_tab_locations (String.t): When set to true, all tabs with anchor tab properties are included in the response.
    • :include_metadata (String.t): Reserved for DocuSign.

Returns

} on success {:error, info} on failure

Link to this function

recipients_post_recipient_tabs(connection, account_id, envelope_id, recipient_id, opts \\ [])

View Source

Specs

recipients_post_recipient_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeRecipientTabs.t()} | {:error, Tesla.Env.t()}

Adds tabs for a recipient. Adds one or more tabs for a recipient.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_recipient_tabs (EnvelopeRecipientTabs):

Returns

} on success {:error, info} on failure

Link to this function

recipients_put_recipient_tabs(connection, account_id, envelope_id, recipient_id, opts \\ [])

View Source

Specs

recipients_put_recipient_tabs(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, DocuSign.Model.EnvelopeRecipientTabs.t()} | {:error, Tesla.Env.t()}

Updates the tabs for a recipient.
Updates one or more tabs for a recipient in a draft envelope. Note: The Update method can be used if the envelope is not yet complete. To update an existing tab, the request body must include the `tabId`.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • opts (KeywordList): [optional] Optional parameters
    • :envelope_recipient_tabs (EnvelopeRecipientTabs):

Returns

} on success {:error, info} on failure