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

API calls for all endpoints tagged EnvelopeTemplates.

Link to this section Summary

Functions

Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.

Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.

Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an envelope.

Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.

Adds templates to an envelope. Adds templates to the specified envelope.

Link to this section Functions

Link to this function

templates_delete_document_templates(connection, account_id, document_id, envelope_id, template_id, opts \\ [])

View Source

Specs

templates_delete_document_templates(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Tesla.Env.t()}

Deletes a template from a document in an existing envelope. Deletes the specified template from a document in an existing envelope.

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 ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • template_id (String.t): The ID of the template being accessed.
  • opts (KeywordList): [optional] Optional parameters

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Gets the templates associated with a document in an existing envelope. Retrieves the templates associated with a document in the specified envelope.

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 ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :include (String.t): A comma-separated list that limits the results. Valid values: applied matched

Returns

} on success {:error, info} on failure

Link to this function

templates_get_envelope_templates(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

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

Get List of Templates used in an Envelope This returns a list of the server-side templates, their name and ID, used in an 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
  • opts (KeywordList): [optional] Optional parameters
    • :include (String.t): The possible values are: matching_applied - This returns template matching information for the template.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Adds templates to a document in an envelope. Adds templates to a document in the specified envelope.

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 ID of the document being accessed.
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :document_template_list (DocumentTemplateList):

Returns

} on success {:error, info} on failure

Link to this function

templates_post_envelope_templates(connection, account_id, envelope_id, opts \\ [])

View Source

Specs

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

Adds templates to an envelope. Adds templates to the specified 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
  • opts (KeywordList): [optional] Optional parameters
    • :document_template_list (DocumentTemplateList):

Returns

} on success {:error, info} on failure