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

API calls for all endpoints tagged TemplateRecipients.

Summary

Functions

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

Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.

recipients_delete_template_recipients(connection, account_id, template_id, opts \\ [])

Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.

recipients_get_template_recipients(connection, account_id, template_id, opts \\ [])

Gets recipient information from a template. Retrieves the information for all recipients in the specified template.

recipients_post_template_recipients(connection, account_id, template_id, opts \\ [])

Adds tabs for a recipient. Adds one or more recipients to a template.

recipients_put_template_recipients(connection, account_id, template_id, opts \\ [])

Updates recipients in a template. Updates recipients in a template. You can edit the following properties: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode, and requireIdLookup.

views_post_template_recipient_preview(connection, account_id, template_id, opts \\ [])

Creates a template recipient preview. This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.

Functions

Link to this function

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

View Source 
@spec recipients_delete_template_recipient(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.Recipients.t()}
  | {:error, Tesla.Env.t()}

Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified 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 (TemplateRecipients):

Returns

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

recipients_delete_template_recipients(connection, account_id, template_id, opts \\ [])

View Source 
@spec recipients_delete_template_recipients(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.Recipients.t()}
  | {:error, Tesla.Env.t()}

Deletes recipients from a template. Deletes one or more recipients from a template. Recipients to be deleted are listed in the request, with the recipientId being used as the key for deleting recipients.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • template_id (String.t): The ID of the template.
  • opts (keyword): Optional parameters
    • :body (TemplateRecipients):

Returns

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

recipients_get_template_recipients(connection, account_id, template_id, opts \\ [])

View Source 
@spec recipients_get_template_recipients(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.Recipients.t()}
  | {:error, Tesla.Env.t()}

Gets recipient information from a template. Retrieves the information for all recipients in the specified template.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • template_id (String.t): The ID of the template.
  • opts (keyword): Optional parameters
    • :include_anchor_tab_locations (String.t): When true and include_tabs is set to true, all tabs with anchor tab properties are included in the response.
    • :include_extended (String.t): When true, the extended properties are included in the response.
    • :include_tabs (String.t): When true, the tab information associated with the recipient is included in the response.

Returns

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

recipients_post_template_recipients(connection, account_id, template_id, opts \\ [])

View Source 
@spec recipients_post_template_recipients(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.Recipients.t()}
  | {:error, Tesla.Env.t()}

Adds tabs for a recipient. Adds one or more recipients to a template.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • template_id (String.t): The ID of the template.
  • opts (keyword): Optional parameters
    • :resend_envelope (String.t): When true, resends the envelope to the recipients that you specify in the request body. Use this parameter to resend the envelope to a recipient who deleted the original email notification. Note: Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here.
    • :body (TemplateRecipients):

Returns

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

recipients_put_template_recipients(connection, account_id, template_id, opts \\ [])

View Source 
@spec recipients_put_template_recipients(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.RecipientsUpdateSummary.t()}
  | {:error, Tesla.Env.t()}

Updates recipients in a template. Updates recipients in a template. You can edit the following properties: email, userName, routingOrder, faxNumber, deliveryMethod, accessCode, and requireIdLookup.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • template_id (String.t): The ID of the template.
  • opts (keyword): Optional parameters
    • :resend_envelope (String.t): When true, resends the envelope to the recipients that you specify in the request body. Use this parameter to resend the envelope to a recipient who deleted the original email notification. Note: Correcting an envelope is a different process. DocuSign always resends an envelope when you correct it, regardless of the value that you enter here.
    • :body (TemplateRecipients):

Returns

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

views_post_template_recipient_preview(connection, account_id, template_id, opts \\ [])

View Source 
@spec views_post_template_recipient_preview(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.ViewUrl.t()}
  | {:error, Tesla.Env.t()}

Creates a template recipient preview. This method returns a URL for a template recipient preview in the DocuSign UI that you can embed in your application. You use this method to enable the sender to preview the recipients' experience. For more information, see Preview and Send.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • template_id (String.t): The ID of the template.
  • opts (keyword): Optional parameters
    • :body (RecipientPreviewRequest):

Returns

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