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



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
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
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
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
 
# File 'lib/docusign_esign/models/document.rb', line 185

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?(:'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?(:'isDynamicXfa')
    self.is_dynamic_xfa = attributes[:'isDynamicXfa']
  end

  if attributes.has_key?(:'isStaticXfa')
    self.is_static_xfa = attributes[:'isStaticXfa']
  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?(:'ocrRequests')
    if (value = attributes[:'ocrRequests']).is_a?(Array)
      self.ocr_requests = value
    end
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'pdfWidgetsBase64')
    self.pdf_widgets_base64 = attributes[:'pdfWidgetsBase64']
  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?(:'signerMustAcknowledgeUseAccountDefault')
    self. = attributes[:'signerMustAcknowledgeUseAccountDefault']
  end

  if attributes.has_key?(:'tabs')
    self.tabs = attributes[:'tabs']
  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



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

def apply_anchor_tabs
  @apply_anchor_tabs
end

#display ⇒ Object

Returns the value of attribute display.



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

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.



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

def document_base64
  @document_base64
end

#document_fields ⇒ Object

Returns the value of attribute document_fields.



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

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.



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

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.



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

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.



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

def file_extension
  @file_extension
end

#file_format_hint ⇒ Object

Returns the value of attribute file_format_hint.



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

def file_format_hint
  @file_format_hint
end

#html_definition ⇒ Object

Returns the value of attribute html_definition.



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

def html_definition
  @html_definition
end

#include_in_download ⇒ Object

Returns the value of attribute include_in_download.



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

def include_in_download
  @include_in_download
end

#is_dynamic_xfa ⇒ Object

Returns the value of attribute is_dynamic_xfa.



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

def is_dynamic_xfa
  @is_dynamic_xfa
end

#is_static_xfa ⇒ Object

Returns the value of attribute is_static_xfa.



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

def is_static_xfa
  @is_static_xfa
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.



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

def match_boxes
  @match_boxes
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#ocr_requests ⇒ Object

Returns the value of attribute ocr_requests.



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

def ocr_requests
  @ocr_requests
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#page_count ⇒ Object

Returns the value of attribute page_count.



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

def page_count
  @page_count
end

#page_sizes ⇒ Object

Returns the value of attribute page_sizes.



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

def page_sizes
  @page_sizes
end

#pages ⇒ Object

Returns the value of attribute pages.



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

def pages
  @pages
end

#password ⇒ Object

Returns the value of attribute password.



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

def password
  @password
end

#pdf_fields_data ⇒ Object

Returns the value of attribute pdf_fields_data.



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

def pdf_fields_data
  @pdf_fields_data
end

#pdf_form_field_option ⇒ Object

Returns the value of attribute pdf_form_field_option.



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

def pdf_form_field_option
  @pdf_form_field_option
end

#pdf_widgets_base64 ⇒ Object

Returns the value of attribute pdf_widgets_base64.



83
84
85
 
# File 'lib/docusign_esign/models/document.rb', line 83

def pdf_widgets_base64
  @pdf_widgets_base64
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].



86
87
88
 
# File 'lib/docusign_esign/models/document.rb', line 86

def remote_url
  @remote_url
end

#signer_must_acknowledge ⇒ Object

Returns the value of attribute signer_must_acknowledge.



89
90
91
 
# File 'lib/docusign_esign/models/document.rb', line 89

def signer_must_acknowledge
  @signer_must_acknowledge
end

#signer_must_acknowledge_use_account_default ⇒ Object

Returns the value of attribute signer_must_acknowledge_use_account_default.



92
93
94
 
# File 'lib/docusign_esign/models/document.rb', line 92

def 
  @signer_must_acknowledge_use_account_default
end

#tabs ⇒ Object

Returns the value of attribute tabs.



94
95
96
 
# File 'lib/docusign_esign/models/document.rb', line 94

def tabs
  @tabs
end

#template_locked ⇒ Object

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



97
98
99
 
# File 'lib/docusign_esign/models/document.rb', line 97

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.



100
101
102
 
# File 'lib/docusign_esign/models/document.rb', line 100

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.



103
104
105
 
# File 'lib/docusign_esign/models/document.rb', line 103

def transform_pdf_fields
  @transform_pdf_fields
end

#uri ⇒ Object

Returns the value of attribute uri.



106
107
108
 
# File 'lib/docusign_esign/models/document.rb', line 106

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



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
136
137
138
139
140
141
142
143
144
 
# File 'lib/docusign_esign/models/document.rb', line 110

def self.attribute_map
  {
    :'apply_anchor_tabs' => :'applyAnchorTabs',
    :'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',
    :'is_dynamic_xfa' => :'isDynamicXfa',
    :'is_static_xfa' => :'isStaticXfa',
    :'match_boxes' => :'matchBoxes',
    :'name' => :'name',
    :'ocr_requests' => :'ocrRequests',
    :'order' => :'order',
    :'page_count' => :'pageCount',
    :'pages' => :'pages',
    :'page_sizes' => :'pageSizes',
    :'password' => :'password',
    :'pdf_fields_data' => :'pdfFieldsData',
    :'pdf_form_field_option' => :'pdfFormFieldOption',
    :'pdf_widgets_base64' => :'pdfWidgetsBase64',
    :'remote_url' => :'remoteUrl',
    :'signer_must_acknowledge' => :'signerMustAcknowledge',
    :'signer_must_acknowledge_use_account_default' => :'signerMustAcknowledgeUseAccountDefault',
    :'tabs' => :'tabs',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'transform_pdf_fields' => :'transformPdfFields',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/docusign_esign/models/document.rb', line 147

def self.swagger_types
  {
    :'apply_anchor_tabs' => :'String',
    :'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',
    :'is_dynamic_xfa' => :'BOOLEAN',
    :'is_static_xfa' => :'BOOLEAN',
    :'match_boxes' => :'Array<MatchBox>',
    :'name' => :'String',
    :'ocr_requests' => :'Array<OcrRequest>',
    :'order' => :'String',
    :'page_count' => :'String',
    :'pages' => :'String',
    :'page_sizes' => :'Array<PageSize>',
    :'password' => :'String',
    :'pdf_fields_data' => :'String',
    :'pdf_form_field_option' => :'String',
    :'pdf_widgets_base64' => :'String',
    :'remote_url' => :'String',
    :'signer_must_acknowledge' => :'String',
    :'signer_must_acknowledge_use_account_default' => :'BOOLEAN',
    :'tabs' => :'Tabs',
    :'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



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/docusign_esign/models/document.rb', line 340

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      apply_anchor_tabs == o.apply_anchor_tabs &&
      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 &&
      is_dynamic_xfa == o.is_dynamic_xfa &&
      is_static_xfa == o.is_static_xfa &&
      match_boxes == o.match_boxes &&
      name == o.name &&
      ocr_requests == o.ocr_requests &&
      order == o.order &&
      page_count == o.page_count &&
      pages == o.pages &&
      page_sizes == o.page_sizes &&
      password == o.password &&
      pdf_fields_data == o.pdf_fields_data &&
      pdf_form_field_option == o.pdf_form_field_option &&
      pdf_widgets_base64 == o.pdf_widgets_base64 &&
      remote_url == o.remote_url &&
      signer_must_acknowledge == o.signer_must_acknowledge &&
       == o. &&
      tabs == o.tabs &&
      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



412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
 
# File 'lib/docusign_esign/models/document.rb', line 412

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



478
479
480
481
482
483
484
485
486
487
488
489
490
 
# File 'lib/docusign_esign/models/document.rb', line 478

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



391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
 
# File 'lib/docusign_esign/models/document.rb', line 391

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


378
379
380
 
# File 'lib/docusign_esign/models/document.rb', line 378

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



384
385
386
 
# File 'lib/docusign_esign/models/document.rb', line 384

def hash
  [apply_anchor_tabs, display, document_base64, document_fields, document_id, encrypted_with_key_manager, file_extension, file_format_hint, html_definition, include_in_download, is_dynamic_xfa, is_static_xfa, match_boxes, name, ocr_requests, order, page_count, pages, page_sizes, password, pdf_fields_data, pdf_form_field_option, pdf_widgets_base64, remote_url, signer_must_acknowledge, , tabs, 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 properies with the reasons



327
328
329
330
 
# File 'lib/docusign_esign/models/document.rb', line 327

def list_invalid_properties
  invalid_properties = Array.new
  return 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



458
459
460
 
# File 'lib/docusign_esign/models/document.rb', line 458

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



464
465
466
467
468
469
470
471
472
 
# File 'lib/docusign_esign/models/document.rb', line 464

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



452
453
454
 
# File 'lib/docusign_esign/models/document.rb', line 452

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



334
335
336
 
# File 'lib/docusign_esign/models/document.rb', line 334

def valid?
  return true
end