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

API calls for all endpoints tagged TemplateRecipientTabs.

Summary

Functions

recipients_delete_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

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

recipients_get_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.

recipients_post_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

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

recipients_put_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

Updates the tabs for a recipient. Updates one or more tabs for a recipient in a template.

Functions

Link to this function

recipients_delete_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

View Source 
@spec recipients_delete_template_recipient_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 the tabs associated with a recipient in a template. Deletes one or more tabs associated with a recipient in a template.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • recipient_id (String.t): A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.
  • 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
Link to this function

recipients_get_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

View Source 
@spec recipients_get_template_recipient_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()}

Gets the tabs information for a signer or sign-in-person recipient in a template. Gets the tabs information for a signer or sign-in-person recipient in a template.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • recipient_id (String.t): A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.
  • template_id (String.t): The ID of the template.
  • opts (keyword): Optional parameters
    • :include_anchor_tab_locations (String.t): When true, all tabs with anchor tab properties are included in the response. The default value is false.
    • :include_metadata (String.t): When true, the response includes metadata indicating which properties are editable.

Returns

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

recipients_post_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

View Source 
@spec recipients_post_template_recipient_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()}

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.
  • recipient_id (String.t): A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.
  • 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
Link to this function

recipients_put_template_recipient_tabs(connection, account_id, recipient_id, template_id, opts \\ [])

View Source 
@spec recipients_put_template_recipient_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 recipient. Updates one or more tabs for a recipient in a template.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • recipient_id (String.t): A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each recipientId must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a recipientId of 1.
  • 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