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

API calls for all endpoints tagged EnvelopeDocuments.

Link to this section Summary

Functions

Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope. <p>Note: Only relevant parts of an object are needed to delete a document.

Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. The `{documentID}` parameter takes two special values: | Value | Description | | :--- | :--- | | `combined` | Retrieve a PDF that contains the combined content of all documents and the certificate. | | `archive` | Retrieve a ZIP archive that contains all of the PDF documents, the certificate, and any .WAV files used for voice authentication. |

Gets a list of envelope documents. Retrieves a list of documents associated with the specified envelope.

Adds a document to an existing draft envelope. Adds a document to an existing draft envelope. <p>Note: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.

Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document. <p>Note: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.

Link to this section Functions

Link to this function

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

View Source

Specs

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

Deletes documents from a draft envelope. Deletes one or more documents from an existing draft envelope. <p>Note: Only relevant parts of an object are needed to delete a document.

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
    • :envelope_definition (EnvelopeDefinition):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Gets a document from an envelope. Retrieves the specified document from the envelope. If the account has the Highlight Data Changes feature enabled, there is an option to request that any changes in the envelope be highlighted. The `{documentID}` parameter takes two special values: | Value | Description | | :--- | :--- | | `combined` | Retrieve a PDF that contains the combined content of all documents and the certificate. | | `archive` | Retrieve a ZIP archive that contains all of the PDF documents, the certificate, and any .WAV files used for voice authentication. |

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
    • :certificate (String.t): When set to false, the envelope signing certificate is removed from the download.
    • :encoding (String.t):
    • :encrypt (String.t): When set to true, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.
    • :language (String.t): Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).
    • :recipient_id (String.t):
    • :show_changes (String.t): When set to true, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.
    • :watermark (String.t): When set to true, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Gets a list of envelope documents. Retrieves a list of documents associated with 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

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Adds a document to an existing draft envelope. Adds a document to an existing draft envelope. <p>Note: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.

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
    • :apply_document_fields (String.t): When true, document fields can be added or modified while adding or modifying envelope documents.

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Adds one or more documents to an existing envelope document. Adds one or more documents to an existing envelope document. <p>Note: When adding or modifying documents for an in-process envelope, DocuSign recommends locking the envelope prior to making any changes.

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
    • :apply_document_fields (String.t): When true, document fields can be added or modified while adding or modifying envelope documents.
    • :persist_tabs (String.t):
    • :envelope_definition (EnvelopeDefinition):

Returns

} on success {:error, info} on failure