Class: DocuSign_eSign::Document

Inherits:
Object
  • Object
show all
Defined in:
lib/docusign_esign/models/document.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Document

Initializes the object

Parameters:

  • attributes (Hash) (defaults to: {}) —

    Model attributes in the form of hash



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
 
# File 'lib/docusign_esign/models/document.rb', line 139

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'applyAnchorTabs')
    self.apply_anchor_tabs = attributes[:'applyAnchorTabs']
  end

  if attributes.has_key?(:'authoritativeCopy')
    self.authoritative_copy = attributes[:'authoritativeCopy']
  end

  if attributes.has_key?(:'display')
    self.display = attributes[:'display']
  end

  if attributes.has_key?(:'documentBase64')
    self.document_base64 = attributes[:'documentBase64']
  end

  if attributes.has_key?(:'documentFields')
    if (value = attributes[:'documentFields']).is_a?(Array)
      self.document_fields = value
    end
  end

  if attributes.has_key?(:'documentId')
    self.document_id = attributes[:'documentId']
  end

  if attributes.has_key?(:'encryptedWithKeyManager')
    self.encrypted_with_key_manager = attributes[:'encryptedWithKeyManager']
  end

  if attributes.has_key?(:'fileExtension')
    self.file_extension = attributes[:'fileExtension']
  end

  if attributes.has_key?(:'fileFormatHint')
    self.file_format_hint = attributes[:'fileFormatHint']
  end

  if attributes.has_key?(:'htmlDefinition')
    self.html_definition = attributes[:'htmlDefinition']
  end

  if attributes.has_key?(:'includeInDownload')
    self.include_in_download = attributes[:'includeInDownload']
  end

  if attributes.has_key?(:'matchBoxes')
    if (value = attributes[:'matchBoxes']).is_a?(Array)
      self.match_boxes = value
    end
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'order')
    self.order = attributes[:'order']
  end

  if attributes.has_key?(:'pages')
    self.pages = attributes[:'pages']
  end

  if attributes.has_key?(:'password')
    self.password = attributes[:'password']
  end

  if attributes.has_key?(:'remoteUrl')
    self.remote_url = attributes[:'remoteUrl']
  end

  if attributes.has_key?(:'signerMustAcknowledge')
    self.signer_must_acknowledge = attributes[:'signerMustAcknowledge']
  end

  if attributes.has_key?(:'templateLocked')
    self.template_locked = attributes[:'templateLocked']
  end

  if attributes.has_key?(:'templateRequired')
    self.template_required = attributes[:'templateRequired']
  end

  if attributes.has_key?(:'transformPdfFields')
    self.transform_pdf_fields = attributes[:'transformPdfFields']
  end

  if attributes.has_key?(:'uri')
    self.uri = attributes[:'uri']
  end
end

Instance Attribute Details

#apply_anchor_tabs ⇒ Object

Reserved: TBD



17
18
19
 
# File 'lib/docusign_esign/models/document.rb', line 17

def apply_anchor_tabs
  @apply_anchor_tabs
end

#authoritative_copy ⇒ Object

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.



20
21
22
 
# File 'lib/docusign_esign/models/document.rb', line 20

def authoritative_copy
  @authoritative_copy
end

#display ⇒ Object

Returns the value of attribute display.



23
24
25
 
# File 'lib/docusign_esign/models/document.rb', line 23

def display
  @display
end

#document_base64 ⇒ Object

The document’s bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.



26
27
28
 
# File 'lib/docusign_esign/models/document.rb', line 26

def document_base64
  @document_base64
end

#document_fields ⇒ Object

Returns the value of attribute document_fields.



29
30
31
 
# File 'lib/docusign_esign/models/document.rb', line 29

def document_fields
  @document_fields
end

#document_id ⇒ Object

Specifies the document ID number that the tab is placed on. This must refer to an existing Document’s ID attribute.



32
33
34
 
# File 'lib/docusign_esign/models/document.rb', line 32

def document_id
  @document_id
end

#encrypted_with_key_manager ⇒ Object

When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.



35
36
37
 
# File 'lib/docusign_esign/models/document.rb', line 35

def encrypted_with_key_manager
  @encrypted_with_key_manager
end

#file_extension ⇒ Object

The file extension type of the document. If the document is not a PDF it is converted to a PDF.



38
39
40
 
# File 'lib/docusign_esign/models/document.rb', line 38

def file_extension
  @file_extension
end

#file_format_hint ⇒ Object

Returns the value of attribute file_format_hint.



41
42
43
 
# File 'lib/docusign_esign/models/document.rb', line 41

def file_format_hint
  @file_format_hint
end

#html_definition ⇒ Object

Returns the value of attribute html_definition.



43
44
45
 
# File 'lib/docusign_esign/models/document.rb', line 43

def html_definition
  @html_definition
end

#include_in_download ⇒ Object

Returns the value of attribute include_in_download.



46
47
48
 
# File 'lib/docusign_esign/models/document.rb', line 46

def include_in_download
  @include_in_download
end

#match_boxes ⇒ Object

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.



49
50
51
 
# File 'lib/docusign_esign/models/document.rb', line 49

def match_boxes
  @match_boxes
end

#name ⇒ Object

Returns the value of attribute name.



52
53
54
 
# File 'lib/docusign_esign/models/document.rb', line 52

def name
  @name
end

#order ⇒ Object

Returns the value of attribute order.



55
56
57
 
# File 'lib/docusign_esign/models/document.rb', line 55

def order
  @order
end

#pages ⇒ Object

Returns the value of attribute pages.



58
59
60
 
# File 'lib/docusign_esign/models/document.rb', line 58

def pages
  @pages
end

#password ⇒ Object

Returns the value of attribute password.



61
62
63
 
# File 'lib/docusign_esign/models/document.rb', line 61

def password
  @password
end

#remote_url ⇒ Object

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/folderid].



64
65
66
 
# File 'lib/docusign_esign/models/document.rb', line 64

def remote_url
  @remote_url
end

#signer_must_acknowledge ⇒ Object

Returns the value of attribute signer_must_acknowledge.



67
68
69
 
# File 'lib/docusign_esign/models/document.rb', line 67

def signer_must_acknowledge
  @signer_must_acknowledge
end

#template_locked ⇒ Object

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.



70
71
72
 
# File 'lib/docusign_esign/models/document.rb', line 70

def template_locked
  @template_locked
end

#template_required ⇒ Object

When set to true, the sender may not remove the recipient. Used only when working with template recipients.



73
74
75
 
# File 'lib/docusign_esign/models/document.rb', line 73

def template_required
  @template_required
end

#transform_pdf_fields ⇒ Object

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.



76
77
78
 
# File 'lib/docusign_esign/models/document.rb', line 76

def transform_pdf_fields
  @transform_pdf_fields
end

#uri ⇒ Object

Returns the value of attribute uri.



79
80
81
 
# File 'lib/docusign_esign/models/document.rb', line 79

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

Attribute mapping from ruby-style variable name to JSON key.



82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'lib/docusign_esign/models/document.rb', line 82

def self.attribute_map
  {
    :'apply_anchor_tabs' => :'applyAnchorTabs',
    :'authoritative_copy' => :'authoritativeCopy',
    :'display' => :'display',
    :'document_base64' => :'documentBase64',
    :'document_fields' => :'documentFields',
    :'document_id' => :'documentId',
    :'encrypted_with_key_manager' => :'encryptedWithKeyManager',
    :'file_extension' => :'fileExtension',
    :'file_format_hint' => :'fileFormatHint',
    :'html_definition' => :'htmlDefinition',
    :'include_in_download' => :'includeInDownload',
    :'match_boxes' => :'matchBoxes',
    :'name' => :'name',
    :'order' => :'order',
    :'pages' => :'pages',
    :'password' => :'password',
    :'remote_url' => :'remoteUrl',
    :'signer_must_acknowledge' => :'signerMustAcknowledge',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'transform_pdf_fields' => :'transformPdfFields',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/docusign_esign/models/document.rb', line 110

def self.swagger_types
  {
    :'apply_anchor_tabs' => :'String',
    :'authoritative_copy' => :'BOOLEAN',
    :'display' => :'String',
    :'document_base64' => :'String',
    :'document_fields' => :'Array<NameValue>',
    :'document_id' => :'String',
    :'encrypted_with_key_manager' => :'String',
    :'file_extension' => :'String',
    :'file_format_hint' => :'String',
    :'html_definition' => :'DocumentHtmlDefinition',
    :'include_in_download' => :'String',
    :'match_boxes' => :'Array<MatchBox>',
    :'name' => :'String',
    :'order' => :'String',
    :'pages' => :'String',
    :'password' => :'String',
    :'remote_url' => :'String',
    :'signer_must_acknowledge' => :'String',
    :'template_locked' => :'String',
    :'template_required' => :'String',
    :'transform_pdf_fields' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
 
# File 'lib/docusign_esign/models/document.rb', line 253

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apply_anchor_tabs == o.apply_anchor_tabs &&
      authoritative_copy == o.authoritative_copy &&
      display == o.display &&
      document_base64 == o.document_base64 &&
      document_fields == o.document_fields &&
      document_id == o.document_id &&
      encrypted_with_key_manager == o.encrypted_with_key_manager &&
      file_extension == o.file_extension &&
      file_format_hint == o.file_format_hint &&
      html_definition == o.html_definition &&
      include_in_download == o.include_in_download &&
      match_boxes == o.match_boxes &&
      name == o.name &&
      order == o.order &&
      pages == o.pages &&
      password == o.password &&
      remote_url == o.remote_url &&
      signer_must_acknowledge == o.signer_must_acknowledge &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      transform_pdf_fields == o.transform_pdf_fields &&
      uri == o.uri
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/docusign_esign/models/document.rb', line 316

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.parse(value)
  when :Date
    Date.parse(value)
  when :String
    value.to_s
  when :Integer
    value.to_i
  when :Float
    value.to_f
  when :BOOLEAN
    if value.to_s =~ /\A(true|t|yes|y|1)\z/i
      true
    else
      false
    end
  when :Object
    # generic object (usually a Hash), return directly
    value
  when /\AArray<(?<inner_type>.+)>\z/
    inner_type = Regexp.last_match[:inner_type]
    value.map { |v| _deserialize(inner_type, v) }
  when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
    k_type = Regexp.last_match[:k_type]
    v_type = Regexp.last_match[:v_type]
    {}.tap do |hash|
      value.each do |k, v|
        hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
      end
    end
  else # model
    temp_model = DocuSign_eSign.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value

Parameters:

  • value (Object) —

    Any valid value

Returns:

  • (Hash) —

    Returns the value in the form of hash



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/docusign_esign/models/document.rb', line 382

def _to_hash(value)
  if value.is_a?(Array)
    value.compact.map { |v| _to_hash(v) }
  elsif value.is_a?(Hash)
    {}.tap do |hash|
      value.each { |k, v| hash[k] = _to_hash(v) }
    end
  elsif value.respond_to? :to_hash
    value.to_hash
  else
    value
  end
end

#build_from_hash(attributes) ⇒ Object

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/docusign_esign/models/document.rb', line 295

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the attribute
      # is documented as an array but the input is not
      if attributes[self.class.attribute_map[key]].is_a?(Array)
        self.send("#{key}=", attributes[self.class.attribute_map[key]].map { |v| _deserialize($1, v) })
      end
    elsif !attributes[self.class.attribute_map[key]].nil?
      self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
    end # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


282
283
284
 
# File 'lib/docusign_esign/models/document.rb', line 282

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



288
289
290
 
# File 'lib/docusign_esign/models/document.rb', line 288

def hash
  [apply_anchor_tabs, authoritative_copy, display, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, match_boxes, name, order, pages, password, remote_url, signer_must_acknowledge, template_locked, template_required, transform_pdf_fields, uri].hash
end

#list_invalid_properties ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



240
241
242
243
 
# File 'lib/docusign_esign/models/document.rb', line 240

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



362
363
364
 
# File 'lib/docusign_esign/models/document.rb', line 362

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



368
369
370
371
372
373
374
375
376
 
# File 'lib/docusign_esign/models/document.rb', line 368

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



356
357
358
 
# File 'lib/docusign_esign/models/document.rb', line 356

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

Check to see if the all the properties in the model are valid

Returns:

  • (Boolean) —

    true if the model is valid



247
248
249
 
# File 'lib/docusign_esign/models/document.rb', line 247

def valid?
  true
end