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

#certificateObject

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


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

def certificate
  @certificate
end

#documents_by_useridObject

Returns the value of attribute documents_by_userid


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

def documents_by_userid
  @documents_by_userid
end

#encodingObject

Returns the value of attribute encoding


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

def encoding
  @encoding
end

#encryptObject

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.


112
113
114
# File 'lib/docusign_esign/api/envelopes_api.rb', line 112

def encrypt
  @encrypt
end

#languageObject

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


115
116
117
# File 'lib/docusign_esign/api/envelopes_api.rb', line 115

def language
  @language
end

#recipient_idObject

Returns the value of attribute recipient_id


118
119
120
# File 'lib/docusign_esign/api/envelopes_api.rb', line 118

def recipient_id
  @recipient_id
end

#shared_user_idObject

Returns the value of attribute shared_user_id


121
122
123
# File 'lib/docusign_esign/api/envelopes_api.rb', line 121

def shared_user_id
  @shared_user_id
end

#show_changesObject

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


124
125
126
# File 'lib/docusign_esign/api/envelopes_api.rb', line 124

def show_changes
  @show_changes
end

#watermarkObject

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.


127
128
129
# File 'lib/docusign_esign/api/envelopes_api.rb', line 127

def watermark
  @watermark
end

Class Method Details

.defaultObject


129
130
131
# File 'lib/docusign_esign/api/envelopes_api.rb', line 129

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