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

API calls for all endpoints tagged EnvelopeConsumerDisclosures.

Link to this section Summary

Functions

Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.

Link to this section Functions

Link to this function

consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id(connection, account_id, envelope_id, recipient_id, opts \\ [])

View Source

Specs

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

Gets the Electronic Record and Signature Disclosure associated with the account. Retrieves the Electronic Record and Signature Disclosure, with html formatting, associated with the account. You can use an optional query string to set the language for the disclosure.

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
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • opts (KeywordList): [optional] Optional parameters
    • :lang_code (String.t):

Returns

} on success {:error, info} on failure

Link to this function

consumer_disclosure_get_consumer_disclosure_envelope_id_recipient_id_lang_code(connection, account_id, envelope_id, lang_code, recipient_id, opts \\ [])

View Source

Specs

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

Reserved: Gets the Electronic Record and Signature Disclosure associated with the account. Reserved: Retrieves the Electronic Record and Signature Disclosure, with HTML formatting, associated with the account.

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
  • lang_code (String.t): The simple type enumeration the language used in the response. The supported languages, with the language value shown in parenthesis, are:Arabic (ar), Bulgarian (bg), Czech (cs), Chinese Simplified (zh_CN), Chinese Traditional (zh_TW), Croatian (hr), Danish (da), Dutch (nl), English US (en), English UK (en_GB), Estonian (et), Farsi (fa), Finnish (fi), French (fr), French Canada (fr_CA), German (de), Greek (el), Hebrew (he), Hindi (hi), Hungarian (hu), Bahasa Indonesia (id), Italian (it), Japanese (ja), Korean (ko), Latvian (lv), Lithuanian (lt), Bahasa Melayu (ms), Norwegian (no), Polish (pl), Portuguese (pt), Portuguese Brazil (pt_BR), Romanian (ro), Russian (ru), Serbian (sr), Slovak (sk), Slovenian (sl), Spanish (es),Spanish Latin America (es_MX), Swedish (sv), Thai (th), Turkish (tr), Ukrainian (uk) and Vietnamese (vi). Additionally, the value can be set to "browser" to automatically detect the browser language being used by the viewer and display the disclosure in that language.
  • recipient_id (String.t): The `recipientId` used when the envelope or template was created.
  • opts (KeywordList): [optional] Optional parameters
    • :lang_code2 (String.t):

Returns

} on success {:error, info} on failure