Class: DocuSign_eSign::EnvelopeDocument

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

Overview

This object contains details about the envelope document.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeDocument

Initializes the object

Parameters:

  • (defaults to: {})

    Model attributes in the form of hash



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

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?(:'addedRecipientIds')
    if (value = attributes[:'addedRecipientIds']).is_a?(Array)
      self.added_recipient_ids = value
    end
  end

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

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

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

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

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

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

  if attributes.has_key?(:'displayMetadata')
    self.display_metadata = attributes[:'displayMetadata']
  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?(:'documentIdGuid')
    self.document_id_guid = attributes[:'documentIdGuid']
  end

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#added_recipient_ids ⇒ Object

Returns the value of attribute added_recipient_ids.



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

def added_recipient_ids
  @added_recipient_ids
end

#attachment_tab_id ⇒ Object

Returns the value of attribute attachment_tab_id.



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

def attachment_tab_id
  @attachment_tab_id
end

#authoritative_copy ⇒ Object

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



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

def authoritative_copy
  @authoritative_copy
end

#authoritative_copy_metadata ⇒ Object

Metadata that indicates if the sender can edit the authoritativeCopy property. Not applicable for template documents.



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

def authoritative_copy_metadata
  @authoritative_copy_metadata
end

#available_document_types ⇒ Object

Returns the value of attribute available_document_types.



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

def available_document_types
  @available_document_types
end

#contains_pdf_form_fields ⇒ Object

Returns the value of attribute contains_pdf_form_fields.



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

def contains_pdf_form_fields
  @contains_pdf_form_fields
end

#display ⇒ Object

Returns the value of attribute display.



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

def display
  @display
end

#display_metadata ⇒ Object

Metadata that indicates if the sender can edit the display property. Not applicable for template documents.



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

def display_metadata
  @display_metadata
end

#document_base64 ⇒ Object

Returns the value of attribute document_base64.



42
43
44
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 42

def document_base64
  @document_base64
end

#document_fields ⇒ Object

Returns the value of attribute document_fields.



45
46
47
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 45

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.



48
49
50
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 48

def document_id
  @document_id
end

#document_id_guid ⇒ Object

Returns the value of attribute document_id_guid.



51
52
53
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 51

def document_id_guid
  @document_id_guid
end

#error_details ⇒ Object

This object describes errors that occur. It is only valid for responses and ignored in requests.



54
55
56
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 54

def error_details
  @error_details
end

#include_in_download ⇒ Object

Returns the value of attribute include_in_download.



57
58
59
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 57

def include_in_download
  @include_in_download
end

#include_in_download_metadata ⇒ Object

Metadata that indicates if the sender can edit the includeInDownload property. Not applicable for template documents.



60
61
62
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 60

def include_in_download_metadata
  @include_in_download_metadata
end

#name ⇒ Object

Returns the value of attribute name.



63
64
65
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 63

def name
  @name
end

#name_metadata ⇒ Object

Metadata that indicates if the sender can edit the name property. Not applicable for template documents.



66
67
68
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 66

def name_metadata
  @name_metadata
end

#order ⇒ Object

Returns the value of attribute order.



69
70
71
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 69

def order
  @order
end

#pages ⇒ Object

Returns the value of attribute pages.



72
73
74
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 72

def pages
  @pages
end

#signer_must_acknowledge ⇒ Object

Returns the value of attribute signer_must_acknowledge.



75
76
77
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 75

def signer_must_acknowledge
  @signer_must_acknowledge
end

#signer_must_acknowledge_metadata ⇒ Object

Metadata that indicates if the sender can edit the signerMustAcknowledge property. Not applicable for template documents.



78
79
80
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 78

def signer_must_acknowledge_metadata
  @signer_must_acknowledge_metadata
end

#size_bytes ⇒ Object

Returns the value of attribute size_bytes.



81
82
83
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 81

def size_bytes
  @size_bytes
end

#template_locked ⇒ Object

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



84
85
86
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 84

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.



87
88
89
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 87

def template_required
  @template_required
end

#type ⇒ Object

Returns the value of attribute type.



90
91
92
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 90

def type
  @type
end

#uri ⇒ Object

Returns the value of attribute uri.



93
94
95
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 93

def uri
  @uri
end

Class Method Details

.attribute_map ⇒ Object

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



96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 96

def self.attribute_map
  {
    :'added_recipient_ids' => :'addedRecipientIds',
    :'attachment_tab_id' => :'attachmentTabId',
    :'authoritative_copy' => :'authoritativeCopy',
    :'authoritative_copy_metadata' => :'authoritativeCopyMetadata',
    :'available_document_types' => :'availableDocumentTypes',
    :'contains_pdf_form_fields' => :'containsPdfFormFields',
    :'display' => :'display',
    :'display_metadata' => :'displayMetadata',
    :'document_base64' => :'documentBase64',
    :'document_fields' => :'documentFields',
    :'document_id' => :'documentId',
    :'document_id_guid' => :'documentIdGuid',
    :'error_details' => :'errorDetails',
    :'include_in_download' => :'includeInDownload',
    :'include_in_download_metadata' => :'includeInDownloadMetadata',
    :'name' => :'name',
    :'name_metadata' => :'nameMetadata',
    :'order' => :'order',
    :'pages' => :'pages',
    :'signer_must_acknowledge' => :'signerMustAcknowledge',
    :'signer_must_acknowledge_metadata' => :'signerMustAcknowledgeMetadata',
    :'size_bytes' => :'sizeBytes',
    :'template_locked' => :'templateLocked',
    :'template_required' => :'templateRequired',
    :'type' => :'type',
    :'uri' => :'uri'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 128

def self.swagger_types
  {
    :'added_recipient_ids' => :'Array<String>',
    :'attachment_tab_id' => :'String',
    :'authoritative_copy' => :'String',
    :'authoritative_copy_metadata' => :'PropertyMetadata',
    :'available_document_types' => :'Array<SignatureType>',
    :'contains_pdf_form_fields' => :'String',
    :'display' => :'String',
    :'display_metadata' => :'PropertyMetadata',
    :'document_base64' => :'String',
    :'document_fields' => :'Array<NameValue>',
    :'document_id' => :'String',
    :'document_id_guid' => :'String',
    :'error_details' => :'ErrorDetails',
    :'include_in_download' => :'String',
    :'include_in_download_metadata' => :'PropertyMetadata',
    :'name' => :'String',
    :'name_metadata' => :'PropertyMetadata',
    :'order' => :'String',
    :'pages' => :'Array<Page>',
    :'signer_must_acknowledge' => :'String',
    :'signer_must_acknowledge_metadata' => :'PropertyMetadata',
    :'size_bytes' => :'String',
    :'template_locked' => :'String',
    :'template_required' => :'String',
    :'type' => :'String',
    :'uri' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • to be compared



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
324
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 295

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      added_recipient_ids == o.added_recipient_ids &&
      attachment_tab_id == o.attachment_tab_id &&
      authoritative_copy == o.authoritative_copy &&
      authoritative_copy_metadata == o.authoritative_copy_metadata &&
      available_document_types == o.available_document_types &&
      contains_pdf_form_fields == o.contains_pdf_form_fields &&
      display == o.display &&
      display_metadata == o.display_metadata &&
      document_base64 == o.document_base64 &&
      document_fields == o.document_fields &&
      document_id == o.document_id &&
      document_id_guid == o.document_id_guid &&
      error_details == o.error_details &&
      include_in_download == o.include_in_download &&
      include_in_download_metadata == o.include_in_download_metadata &&
      name == o.name &&
      name_metadata == o.name_metadata &&
      order == o.order &&
      pages == o.pages &&
      signer_must_acknowledge == o.signer_must_acknowledge &&
      signer_must_acknowledge_metadata == o.signer_must_acknowledge_metadata &&
      size_bytes == o.size_bytes &&
      template_locked == o.template_locked &&
      template_required == o.template_required &&
      type == o.type &&
      uri == o.uri
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • type Data type

  • value Value to be deserialized

Returns:

  • Deserialized data



362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 362

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:

  • Any valid value

Returns:

  • Returns the value in the form of hash



428
429
430
431
432
433
434
435
436
437
438
439
440
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 428

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:

  • Model attributes in the form of hash

Returns:

  • Returns the model itself



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 341

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:

  • to be compared

Returns:

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • Hash code



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

def hash
  [added_recipient_ids, attachment_tab_id, authoritative_copy, authoritative_copy_metadata, available_document_types, contains_pdf_form_fields, display, display_metadata, document_base64, document_fields, document_id, document_id_guid, error_details, include_in_download, include_in_download_metadata, name, name_metadata, order, pages, signer_must_acknowledge, signer_must_acknowledge_metadata, size_bytes, template_locked, template_required, type, 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



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

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:

  • Returns the object in the form of hash



408
409
410
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 408

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • Returns the object in the form of hash



414
415
416
417
418
419
420
421
422
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 414

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 presentation of the object



402
403
404
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 402

def to_s
  to_hash.to_s
end

#valid? ⇒ Boolean

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

Returns:

  • true if the model is valid



289
290
291
 
# File 'lib/docusign_esign/models/envelope_document.rb', line 289

def valid?
  true
end