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

API calls for all endpoints tagged EnvelopeAttachments.

Link to this section Summary

Functions

Delete one or more attachments from a DRAFT envelope.

Returns a list of attachments associated with the specified envelope

Add one or more attachments to a DRAFT or IN-PROCESS envelope. Supported attachment formats include: .asp, .bmp, .csv, .doc, .docm, .docx, .dot, .dotm, .dotx, .gif, .htm, .html, .jpeg, .jpg, .msg, .pdf, .png, .pot, .potx, .pps, .ppt, .pptm, .pptx, .ps, .rtf, .tif, .tiff, .txt, .wpd, .xls, .xlsm, .xlsx, .xml, and .xps. For more information on supported file formats please see Supported File Formats.

Link to this section Functions

Link to this function

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

View Source

Specs

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

Delete one or more attachments from a DRAFT 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
    • :envelope_attachments_request (EnvelopeAttachmentsRequest):

Returns

} on success {:error, info} on failure

Link to this function

attachments_get_attachment(connection, account_id, attachment_id, envelope_id, opts \\ [])

View Source

Specs

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

Retrieves an attachment from the envelope.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • attachment_id (String.t):
  • 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

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

View Source

Specs

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

Returns a list of attachments 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

attachments_put_attachment(connection, account_id, attachment_id, envelope_id, opts \\ [])

View Source

Specs

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

Add an attachment to a DRAFT or IN-PROCESS envelope.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID Guid.
  • attachment_id (String.t):
  • envelope_id (String.t): The envelope's GUID. Eg 93be49ab-afa0-4adf-933c-f752070d71ec
  • opts (KeywordList): [optional] Optional parameters
    • :attachment (Attachment):

Returns

} on success {:error, info} on failure

Link to this function

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

View Source

Specs

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

Add one or more attachments to a DRAFT or IN-PROCESS envelope. Supported attachment formats include: .asp, .bmp, .csv, .doc, .docm, .docx, .dot, .dotm, .dotx, .gif, .htm, .html, .jpeg, .jpg, .msg, .pdf, .png, .pot, .potx, .pps, .ppt, .pptm, .pptx, .ps, .rtf, .tif, .tiff, .txt, .wpd, .xls, .xlsm, .xlsx, .xml, and .xps. For more information on supported file formats please see Supported File Formats.

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_attachments_request (EnvelopeAttachmentsRequest):

Returns

} on success {:error, info} on failure