Class: DocuSign_eSign::GetDocumentOptions

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/api/envelopes_api.rb,
lib/docusign_esign/api/templates_api.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Attribute Details

#certificate ⇒ Object

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



84
85
86
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 84

def certificate
  @certificate
end

#documents_by_userid ⇒ Object

Returns the value of attribute documents_by_userid.



87
88
89
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 87

def documents_by_userid
  @documents_by_userid
end

#encoding ⇒ Object

Returns the value of attribute encoding.



90
91
92
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 90

def encoding
  @encoding
end

#encrypt ⇒ Object

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.



93
94
95
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 93

def encrypt
  @encrypt
end

#language ⇒ Object

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).



96
97
98
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 96

def language
  @language
end

#recipient_id ⇒ Object

Returns the value of attribute recipient_id.



99
100
101
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 99

def recipient_id
  @recipient_id
end

#shared_user_id ⇒ Object

Returns the value of attribute shared_user_id.



102
103
104
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 102

def shared_user_id
  @shared_user_id
end

#show_changes ⇒ Object

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



105
106
107
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 105

def show_changes
  @show_changes
end

#watermark ⇒ Object

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.



108
109
110
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 108

def watermark
  @watermark
end

Class Method Details

.default ⇒ Object 



110
111
112
 
# File 'lib/docusign_esign/api/envelopes_api.rb', line 110

def self.default
  @@default ||= GetDocumentOptions.new
end