DocuSign
v1.1.1

View Source DocuSign.Api.EnvelopeAttachments (DocuSign v1.1.1)

API calls for all endpoints tagged EnvelopeAttachments.

Summary

Functions

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

Deletes one or more attachments from a draft envelope. Deletes one or more attachments from a draft envelope.

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

Retrieves an attachment from an envelope. Retrieves an attachment from an envelope.

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

Returns a list of attachments associated with a specified envelope Returns a list of attachments associated with a specified envelope.

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

Adds an attachment to a draft or in-process envelope. Adds an attachment to a draft or in-process envelope.

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

Adds one or more attachments to a draft or in-process envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, see Supported File Formats.

Functions

Link to this function

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

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

Deletes one or more attachments from a draft envelope. Deletes 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. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :body (EnvelopeAttachmentsRequest):

Returns

  • {:ok, DocuSign.Model.EnvelopeAttachmentsResult.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Retrieves an attachment from an envelope. Retrieves an attachment from an 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): The unique identifier for the attachment.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Returns a list of attachments associated with a specified envelope Returns a list of attachments associated with a 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. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.EnvelopeAttachmentsResult.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Adds an attachment to a draft or in-process envelope. Adds 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): The unique identifier for the attachment.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :body (Attachment):

Returns

  • {:ok, DocuSign.Model.EnvelopeAttachmentsResult.t} on success
  • {:error, Tesla.Env.t} on failure
Link to this function

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

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

Adds one or more attachments to a draft or in-process envelope. Adds one or more attachments to a draft or in-process envelope. Envelope attachments are files that an application can include in an envelope. They are not converted to PDF. Envelope attachments are available only through the API. There is no user interface in the DocuSign web application for them. For a list of supported file formats, 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. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :body (EnvelopeAttachmentsRequest):

Returns

  • {:ok, DocuSign.Model.EnvelopeAttachmentsResult.t} on success
  • {:error, Tesla.Env.t} on failure