View Source DocuSign.Api.Comments (DocuSign v1.1.0)

API calls for all endpoints tagged Comments.

Link to this section Summary

Functions

Gets a PDF transcript of all of the comments in an envelope. Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).

Link to this section Functions

Link to this function

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

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

Gets a PDF transcript of all of the comments in an envelope. Retrieves a PDF file containing all of the comments that senders and recipients have added to the documents in an envelope. The response body of this method is the PDF file as a byte stream. Note: Comments are disabled by default. To use the comments feature, an account administrator must enable comments on the account (in the accountSettingsInformation object, set the enableSigningExtensionComments property to true).

parameters

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. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :encoding (String.t): (Optional) The encoding to use for the file.

returns

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure