DocuSign.Api.TemplateRecipients (DocuSign v0.4.2) View Source
API calls for all endpoints tagged TemplateRecipients
.
Link to this section Summary
Functions
Deletes the specified recipient file from a template. Deletes the specified recipient file from the specified template.
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.
Gets recipient information from a template. Retrieves the information for all recipients in the specified template.
Adds tabs for a recipient. Adds one or more recipients to a template.
Updates recipients in a template. Updates recipients in a template. You can edit the following properties: `email`, `userName`, `routingOrder`, `faxNumber`, `deliveryMethod`, `accessCode`, and `requireIdLookup`.
Link to this section Functions
recipients_delete_template_recipient(connection, account_id, recipient_id, template_id, opts \\ [])
View SourceSpecs
recipients_delete_template_recipient( Tesla.Env.client(), String.t(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.TemplateRecipients.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): The `recipientId` used when the envelope or template was created.
- template_id (String.t): The ID of the template being accessed.
- opts (KeywordList): [optional] Optional parameters
- :template_recipients (TemplateRecipients):
Returns
} on success {:error, info} on failure
recipients_delete_template_recipients(connection, account_id, template_id, opts \\ [])
View SourceSpecs
recipients_delete_template_recipients( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.TemplateRecipients.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 being accessed.
- opts (KeywordList): [optional] Optional parameters
- :template_recipients (TemplateRecipients):
Returns
} on success {:error, info} on failure
recipients_get_template_recipients(connection, account_id, template_id, opts \\ [])
View SourceSpecs
recipients_get_template_recipients( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.TemplateRecipients.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 being accessed.
- opts (KeywordList): [optional] Optional parameters
- :include_anchor_tab_locations (String.t): When set to true and `include_tabs` is set to true, all tabs with anchor tab properties are included in the response.
- :include_extended (String.t): When set to true, the extended properties are included in the response.
- :include_tabs (String.t): When set to true, the tab information associated with the recipient is included in the response.
Returns
} on success {:error, info} on failure
recipients_post_template_recipients(connection, account_id, template_id, opts \\ [])
View SourceSpecs
recipients_post_template_recipients( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {:ok, DocuSign.Model.TemplateRecipients.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 being accessed.
- opts (KeywordList): [optional] Optional parameters
- :resend_envelope (String.t): When set to true, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.
- :template_recipients (TemplateRecipients):
Returns
} on success {:error, info} on failure
recipients_put_template_recipients(connection, account_id, template_id, opts \\ [])
View SourceSpecs
recipients_put_template_recipients( Tesla.Env.client(), String.t(), String.t(), keyword() ) :: {: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 being accessed.
- opts (KeywordList): [optional] Optional parameters
- :resend_envelope (String.t): When set to true, resends the envelope if the new recipient's routing order is before or the same as the envelope's next recipient.
- :template_recipients (TemplateRecipients):
Returns
} on success {:error, info} on failure