class DocuSign_eSign::GetDocumentOptions

Attributes

certificate[RW]

When set to *false*, the envelope signing certificate is removed from the download.

documents_by_userid[RW]
encoding[RW]
encrypt[RW]

When set to *true*, the PDF bytes returned in the response are encrypted for all the key managers configured on your DocuSign account. The documents can be decrypted with the KeyManager Decrypt Document API.

file_type[RW]
language[RW]

Specifies the language for the Certificate of Completion in the response. The supported languages, with the language value shown in parenthesis, are: Chinese Simplified (zh_CN), , Chinese Traditional (zh_TW), Dutch (nl), English US (en), French (fr), German (de), Italian (it), Japanese (ja), Korean (ko), Portuguese (pt), Portuguese (Brazil) (pt_BR), Russian (ru), Spanish (es).

recipient_id[RW]
shared_user_id[RW]
show_changes[RW]

When set to *true*, any changed fields for the returned PDF are highlighted in yellow and optional signatures or initials outlined in red.

watermark[RW]

When set to *true*, the account has the watermark feature enabled, and the envelope is not complete, the watermark for the account is added to the PDF documents. This option can remove the watermark.

Public Class Methods

default() click to toggle source
# File lib/docusign_esign/api/envelopes_api.rb, line 137
def self.default
  @@default ||= GetDocumentOptions.new
end