Class: DocuSign_eSign::EnvelopeDocument

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ EnvelopeDocument

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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

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. = 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. = attributes[:'displayMetadata']
  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. = attributes[:'includeInDownloadMetadata']
  end

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

  if attributes.has_key?(:'nameMetadata')
    self. = 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. = 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_idsObject

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_idObject

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_copyObject

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_metadataObject

Returns the value of attribute authoritative_copy_metadata


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

def 
  @authoritative_copy_metadata
end

#available_document_typesObject

Returns the value of attribute available_document_types


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

def available_document_types
  @available_document_types
end

#contains_pdf_form_fieldsObject

Returns the value of attribute contains_pdf_form_fields


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

def contains_pdf_form_fields
  @contains_pdf_form_fields
end

#displayObject

Returns the value of attribute display


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

def display
  @display
end

#display_metadataObject

Returns the value of attribute display_metadata


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

def 
  @display_metadata
end

#document_fieldsObject

Returns the value of attribute document_fields


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

def document_fields
  @document_fields
end

#document_idObject

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


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

def document_id
  @document_id
end

#document_id_guidObject

Returns the value of attribute document_id_guid


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

def document_id_guid
  @document_id_guid
end

#error_detailsObject

Returns the value of attribute error_details


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

def error_details
  @error_details
end

#include_in_downloadObject

Returns the value of attribute include_in_download


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

def include_in_download
  @include_in_download
end

#include_in_download_metadataObject

Returns the value of attribute include_in_download_metadata


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

def 
  @include_in_download_metadata
end

#nameObject

Returns the value of attribute name


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

def name
  @name
end

#name_metadataObject

Returns the value of attribute name_metadata


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

def 
  @name_metadata
end

#orderObject

Returns the value of attribute order


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

def order
  @order
end

#pagesObject

Returns the value of attribute pages


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

def pages
  @pages
end

#signer_must_acknowledgeObject

Returns the value of attribute signer_must_acknowledge


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

def signer_must_acknowledge
  @signer_must_acknowledge
end

#signer_must_acknowledge_metadataObject

Returns the value of attribute signer_must_acknowledge_metadata


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

def 
  @signer_must_acknowledge_metadata
end

#size_bytesObject

Returns the value of attribute size_bytes


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

def size_bytes
  @size_bytes
end

#template_lockedObject

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


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

def template_locked
  @template_locked
end

#template_requiredObject

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


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

def template_required
  @template_required
end

#typeObject

Returns the value of attribute type


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

def type
  @type
end

#uriObject

Returns the value of attribute uri


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

def uri
  @uri
end

Class Method Details

.attribute_mapObject

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


87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
# File 'lib/docusign_esign/models/envelope_document.rb', line 87

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

Attribute type mapping.


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

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

  • Object (Object)

    to be compared


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

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 &&
       == o. &&
      available_document_types == o.available_document_types &&
      contains_pdf_form_fields == o.contains_pdf_form_fields &&
      display == o.display &&
       == o. &&
      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 &&
       == o. &&
      name == o.name &&
       == o. &&
      order == o.order &&
      pages == o.pages &&
      signer_must_acknowledge == o.signer_must_acknowledge &&
       == o. &&
      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:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data


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
375
376
377
378
379
380
381
382
# File 'lib/docusign_esign/models/envelope_document.rb', line 346

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


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

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


325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
# File 'lib/docusign_esign/models/envelope_document.rb', line 325

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

312
313
314
# File 'lib/docusign_esign/models/envelope_document.rb', line 312

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code


318
319
320
# File 'lib/docusign_esign/models/envelope_document.rb', line 318

def hash
  [added_recipient_ids, attachment_tab_id, authoritative_copy, , available_document_types, contains_pdf_form_fields, display, , document_fields, document_id, document_id_guid, error_details, include_in_download, , name, , order, pages, signer_must_acknowledge, , size_bytes, template_locked, template_required, type, uri].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons


267
268
269
270
# File 'lib/docusign_esign/models/envelope_document.rb', line 267

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash


392
393
394
# File 'lib/docusign_esign/models/envelope_document.rb', line 392

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash


398
399
400
401
402
403
404
405
406
# File 'lib/docusign_esign/models/envelope_document.rb', line 398

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object


386
387
388
# File 'lib/docusign_esign/models/envelope_document.rb', line 386

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


274
275
276
# File 'lib/docusign_esign/models/envelope_document.rb', line 274

def valid?
  true
end