DocuSign.Api.EnvelopeShares (DocuSign v3.5.0)

Copy Markdown View Source

API calls for all endpoints tagged EnvelopeShares.

Summary

Functions

envelopes_shares_delete_envelopes_share(connection, account_id, envelope_id, share_id, opts \\ [])
envelopes_shares_delete_envelopes_shares(connection, account_id, envelope_id, opts \\ [])
envelopes_shares_get_envelopes_share(connection, account_id, envelope_id, share_id, opts \\ [])
envelopes_shares_get_envelopes_shares(connection, account_id, envelope_id, opts \\ [])
envelopes_shares_post_envelopes_shares(connection, account_id, envelope_id, opts \\ [])
envelopes_shares_put_envelopes_share(connection, account_id, envelope_id, share_id, opts \\ [])
envelopes_shares_put_envelopes_shares(connection, account_id, envelope_id, opts \\ [])
shared_envelopes_list_get_shared_envelopes(connection, account_id, opts \\ [])

Functions

envelopes_shares_delete_envelopes_share(connection, account_id, envelope_id, share_id, opts \\ [])

@spec envelopes_shares_delete_envelopes_share(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Req.Response.t()}

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
  • share_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

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

@spec envelopes_shares_delete_envelopes_shares(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) :: {:ok, nil} | {:error, Req.Response.t()}

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 (EnvelopesSharesRequest):

Returns

  • {:ok, nil} on success
  • {:error, Req.Response.t} on failure

envelopes_shares_get_envelopes_share(connection, account_id, envelope_id, share_id, opts \\ [])

@spec envelopes_shares_get_envelopes_share(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopesShareResponse.t()} | {:error, Req.Response.t()}

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
  • share_id (String.t):
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.EnvelopesShareResponse.t} on success
  • {:error, Req.Response.t} on failure

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

@spec envelopes_shares_get_envelopes_shares(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopesSharesResponse.t()} | {:error, Req.Response.t()}

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.EnvelopesSharesResponse.t} on success
  • {:error, Req.Response.t} on failure

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

@spec envelopes_shares_post_envelopes_shares(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopesSharesResponse.t()} | {:error, Req.Response.t()}

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 (EnvelopesSharesRequest):

Returns

  • {:ok, DocuSign.Model.EnvelopesSharesResponse.t} on success
  • {:error, Req.Response.t} on failure

envelopes_shares_put_envelopes_share(connection, account_id, envelope_id, share_id, opts \\ [])

@spec envelopes_shares_put_envelopes_share(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopesShareResponse.t()} | {:error, Req.Response.t()}

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
  • share_id (String.t):
  • opts (keyword): Optional parameters
    • :body (EnvelopesSharePermissionRequest):

Returns

  • {:ok, DocuSign.Model.EnvelopesShareResponse.t} on success
  • {:error, Req.Response.t} on failure

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

@spec envelopes_shares_put_envelopes_shares(
  DocuSign.Connection.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopesSharesResponse.t()} | {:error, Req.Response.t()}

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 (EnvelopesSharesRequest):

Returns

  • {:ok, DocuSign.Model.EnvelopesSharesResponse.t} on success
  • {:error, Req.Response.t} on failure

shared_envelopes_list_get_shared_envelopes(connection, account_id, opts \\ [])

@spec shared_envelopes_list_get_shared_envelopes(
  DocuSign.Connection.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopesInformation.t()} | {:error, Req.Response.t()}

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :count (String.t): The maximum number of results to return.
    • :from_date (String.t): The start date for a date range in UTC DateTime format. Note: If this property is null, no date filtering is applied.
    • :include (String.t):
    • :order (String.t): The order in which to sort the results. Valid values are: asc: Ascending order. desc: Descending order.
    • :order_by (String.t): The file attribute to use to sort the results. Valid values are: modified name
    • :search_text (String.t): Use this parameter to search for specific text.
    • :start_position (String.t): The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.
    • :status (String.t): The status of the item.
    • :to_date (String.t): The end of a search date range in UTC DateTime format. When you use this parameter, only templates created up to this date and time are returned. Note: If this property is null, the value defaults to the current date.

Returns

  • {:ok, DocuSign.Model.EnvelopesInformation.t} on success
  • {:error, Req.Response.t} on failure