Class: SignWell::DocumentResponse

Inherits:
Object
  • Object
show all
Defined in:
lib/signwell_sdk/models/document_response.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentResponse

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
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/signwell_sdk/models/document_response.rb', line 185

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `SignWell::DocumentResponse` initialize method"
  end

  # check to see if the attribute exists and convert string to symbol for hash key
  acceptable_attribute_map = self.class.acceptable_attribute_map
  attributes = attributes.each_with_object({}) { |(k, v), h|
    if (!acceptable_attribute_map.key?(k.to_sym))
      fail ArgumentError, "`#{k}` is not a valid attribute in `SignWell::DocumentResponse`. Please check the name to make sure it's valid. List of attributes: " + acceptable_attribute_map.keys.inspect
    end
    h[k.to_sym] = v
  }

  if attributes.key?(:'test_mode')
    self.test_mode = attributes[:'test_mode']
  else
    self.test_mode = nil
  end

  if attributes.key?(:'id')
    self.id = attributes[:'id']
  else
    self.id = nil
  end

  if attributes.key?(:'api_application_id')
    self.api_application_id = attributes[:'api_application_id']
  end

  if attributes.key?(:'requester_email_address')
    self.requester_email_address = attributes[:'requester_email_address']
  end

  if attributes.key?(:'custom_requester_name')
    self.custom_requester_name = attributes[:'custom_requester_name']
  end

  if attributes.key?(:'custom_requester_email')
    self.custom_requester_email = attributes[:'custom_requester_email']
  end

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

  if attributes.key?(:'subject')
    self.subject = attributes[:'subject']
  end

  if attributes.key?(:'message')
    self.message = attributes[:'message']
  end

  if attributes.key?(:'metadata')
    if (value = attributes[:'metadata']).is_a?(Hash)
      self.metadata = value
    end
  end

  if attributes.key?(:'created_at')
    self.created_at = attributes[:'created_at']
  end

  if attributes.key?(:'updated_at')
    self.updated_at = attributes[:'updated_at']
  end

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

  if attributes.key?(:'status')
    self.status = attributes[:'status']
  end

  if attributes.key?(:'reminders')
    self.reminders = attributes[:'reminders']
  end

  if attributes.key?(:'archived')
    self.archived = attributes[:'archived']
  end

  if attributes.key?(:'embedded')
    self.embedded = attributes[:'embedded']
  end

  if attributes.key?(:'embedded_edit_url')
    self.embedded_edit_url = attributes[:'embedded_edit_url']
  end

  if attributes.key?(:'embedded_preview_url')
    self.embedded_preview_url = attributes[:'embedded_preview_url']
  end

  if attributes.key?(:'apply_signing_order')
    self.apply_signing_order = attributes[:'apply_signing_order']
  end

  if attributes.key?(:'redirect_url')
    self.redirect_url = attributes[:'redirect_url']
  end

  if attributes.key?(:'decline_redirect_url')
    self.decline_redirect_url = attributes[:'decline_redirect_url']
  end

  if attributes.key?(:'language')
    self.language = attributes[:'language']
  end

  if attributes.key?(:'expires_in')
    self.expires_in = attributes[:'expires_in']
  end

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

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

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

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

  if attributes.key?(:'allow_decline')
    self.allow_decline = attributes[:'allow_decline']
  end

  if attributes.key?(:'allow_reassign')
    self.allow_reassign = attributes[:'allow_reassign']
  end

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

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

Instance Attribute Details

#allow_decline ⇒ Object

Returns the value of attribute allow_decline.



74
75
76
 
# File 'lib/signwell_sdk/models/document_response.rb', line 74

def allow_decline
  @allow_decline
end

#allow_reassign ⇒ Object

Returns the value of attribute allow_reassign.



76
77
78
 
# File 'lib/signwell_sdk/models/document_response.rb', line 76

def allow_reassign
  @allow_reassign
end

#api_application_id ⇒ Object

Returns the value of attribute api_application_id.



22
23
24
 
# File 'lib/signwell_sdk/models/document_response.rb', line 22

def api_application_id
  @api_application_id
end

#apply_signing_order ⇒ Object

Returns the value of attribute apply_signing_order.



56
57
58
 
# File 'lib/signwell_sdk/models/document_response.rb', line 56

def apply_signing_order
  @apply_signing_order
end

#archived ⇒ Object

Returns the value of attribute archived.



48
49
50
 
# File 'lib/signwell_sdk/models/document_response.rb', line 48

def archived
  @archived
end

#attachment_requests ⇒ Object

Returns the value of attribute attachment_requests.



66
67
68
 
# File 'lib/signwell_sdk/models/document_response.rb', line 66

def attachment_requests
  @attachment_requests
end

#checkbox_groups ⇒ Object

Returns the value of attribute checkbox_groups.



80
81
82
 
# File 'lib/signwell_sdk/models/document_response.rb', line 80

def checkbox_groups
  @checkbox_groups
end

#copied_contacts ⇒ Object

Returns the value of attribute copied_contacts.



70
71
72
 
# File 'lib/signwell_sdk/models/document_response.rb', line 70

def copied_contacts
  @copied_contacts
end

#created_at ⇒ Object

Returns the value of attribute created_at.



38
39
40
 
# File 'lib/signwell_sdk/models/document_response.rb', line 38

def created_at
  @created_at
end

#custom_requester_email ⇒ Object

Returns the value of attribute custom_requester_email.



28
29
30
 
# File 'lib/signwell_sdk/models/document_response.rb', line 28

def custom_requester_email
  @custom_requester_email
end

#custom_requester_name ⇒ Object

Returns the value of attribute custom_requester_name.



26
27
28
 
# File 'lib/signwell_sdk/models/document_response.rb', line 26

def custom_requester_name
  @custom_requester_name
end

#decline_redirect_url ⇒ Object

Returns the value of attribute decline_redirect_url.



60
61
62
 
# File 'lib/signwell_sdk/models/document_response.rb', line 60

def decline_redirect_url
  @decline_redirect_url
end

#embedded ⇒ Object

Returns the value of attribute embedded.



50
51
52
 
# File 'lib/signwell_sdk/models/document_response.rb', line 50

def embedded
  @embedded
end

#embedded_edit_url ⇒ Object

Returns the value of attribute embedded_edit_url.



52
53
54
 
# File 'lib/signwell_sdk/models/document_response.rb', line 52

def embedded_edit_url
  @embedded_edit_url
end

#embedded_preview_url ⇒ Object

Returns the value of attribute embedded_preview_url.



54
55
56
 
# File 'lib/signwell_sdk/models/document_response.rb', line 54

def embedded_preview_url
  @embedded_preview_url
end

#expires_in ⇒ Object

Returns the value of attribute expires_in.



64
65
66
 
# File 'lib/signwell_sdk/models/document_response.rb', line 64

def expires_in
  @expires_in
end

#fields ⇒ Object

Returns the value of attribute fields.



72
73
74
 
# File 'lib/signwell_sdk/models/document_response.rb', line 72

def fields
  @fields
end

#files ⇒ Object

Returns the value of attribute files.



68
69
70
 
# File 'lib/signwell_sdk/models/document_response.rb', line 68

def files
  @files
end

#id ⇒ Object

Returns the value of attribute id.



20
21
22
 
# File 'lib/signwell_sdk/models/document_response.rb', line 20

def id
  @id
end

#labels ⇒ Object

Returns the value of attribute labels.



78
79
80
 
# File 'lib/signwell_sdk/models/document_response.rb', line 78

def labels
  @labels
end

#language ⇒ Object

Returns the value of attribute language.



62
63
64
 
# File 'lib/signwell_sdk/models/document_response.rb', line 62

def language
  @language
end

#message ⇒ Object

Returns the value of attribute message.



34
35
36
 
# File 'lib/signwell_sdk/models/document_response.rb', line 34

def message
  @message
end

#metadata ⇒ Object

Returns the value of attribute metadata.



36
37
38
 
# File 'lib/signwell_sdk/models/document_response.rb', line 36

def metadata
  @metadata
end

#name ⇒ Object

Returns the value of attribute name.



30
31
32
 
# File 'lib/signwell_sdk/models/document_response.rb', line 30

def name
  @name
end

#recipients ⇒ Object

Returns the value of attribute recipients.



42
43
44
 
# File 'lib/signwell_sdk/models/document_response.rb', line 42

def recipients
  @recipients
end

#redirect_url ⇒ Object

Returns the value of attribute redirect_url.



58
59
60
 
# File 'lib/signwell_sdk/models/document_response.rb', line 58

def redirect_url
  @redirect_url
end

#reminders ⇒ Object

Returns the value of attribute reminders.



46
47
48
 
# File 'lib/signwell_sdk/models/document_response.rb', line 46

def reminders
  @reminders
end

#requester_email_address ⇒ Object

Returns the value of attribute requester_email_address.



24
25
26
 
# File 'lib/signwell_sdk/models/document_response.rb', line 24

def requester_email_address
  @requester_email_address
end

#status ⇒ Object

Returns the value of attribute status.



44
45
46
 
# File 'lib/signwell_sdk/models/document_response.rb', line 44

def status
  @status
end

#subject ⇒ Object

Returns the value of attribute subject.



32
33
34
 
# File 'lib/signwell_sdk/models/document_response.rb', line 32

def subject
  @subject
end

#test_mode ⇒ Object

Returns the value of attribute test_mode.



18
19
20
 
# File 'lib/signwell_sdk/models/document_response.rb', line 18

def test_mode
  @test_mode
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



40
41
42
 
# File 'lib/signwell_sdk/models/document_response.rb', line 40

def updated_at
  @updated_at
end

Class Method Details

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



471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/signwell_sdk/models/document_response.rb', line 471

def self._deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = SignWell.const_get(type)
    klass.respond_to?(:openapi_any_of) || klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

.acceptable_attribute_map ⇒ Object

Returns attribute mapping this model knows about



121
122
123
 
# File 'lib/signwell_sdk/models/document_response.rb', line 121

def self.acceptable_attribute_map
  attribute_map
end

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



126
127
128
 
# File 'lib/signwell_sdk/models/document_response.rb', line 126

def self.acceptable_attributes
  acceptable_attribute_map.values
end

.attribute_map ⇒ Object

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



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
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/signwell_sdk/models/document_response.rb', line 83

def self.attribute_map
  {
    :'test_mode' => :'test_mode',
    :'id' => :'id',
    :'api_application_id' => :'api_application_id',
    :'requester_email_address' => :'requester_email_address',
    :'custom_requester_name' => :'custom_requester_name',
    :'custom_requester_email' => :'custom_requester_email',
    :'name' => :'name',
    :'subject' => :'subject',
    :'message' => :'message',
    :'metadata' => :'metadata',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'recipients' => :'recipients',
    :'status' => :'status',
    :'reminders' => :'reminders',
    :'archived' => :'archived',
    :'embedded' => :'embedded',
    :'embedded_edit_url' => :'embedded_edit_url',
    :'embedded_preview_url' => :'embedded_preview_url',
    :'apply_signing_order' => :'apply_signing_order',
    :'redirect_url' => :'redirect_url',
    :'decline_redirect_url' => :'decline_redirect_url',
    :'language' => :'language',
    :'expires_in' => :'expires_in',
    :'attachment_requests' => :'attachment_requests',
    :'files' => :'files',
    :'copied_contacts' => :'copied_contacts',
    :'fields' => :'fields',
    :'allow_decline' => :'allow_decline',
    :'allow_reassign' => :'allow_reassign',
    :'labels' => :'labels',
    :'checkbox_groups' => :'checkbox_groups'
  }
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



447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
 
# File 'lib/signwell_sdk/models/document_response.rb', line 447

def self.build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  transformed_hash = {}
  openapi_types.each_pair do |key, type|
    if attributes.key?(attribute_map[key]) && attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = nil
    elsif 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[attribute_map[key]].is_a?(Array)
        transformed_hash["#{key}"] = attributes[attribute_map[key]].map { |v| _deserialize($1, v) }
      end
    elsif !attributes[attribute_map[key]].nil?
      transformed_hash["#{key}"] = _deserialize(type, attributes[attribute_map[key]])
    end
  end
  new(transformed_hash)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



169
170
171
172
173
174
175
176
177
178
179
180
181
 
# File 'lib/signwell_sdk/models/document_response.rb', line 169

def self.openapi_nullable
  Set.new([
    :'api_application_id',
    :'custom_requester_name',
    :'custom_requester_email',
    :'metadata',
    :'embedded_preview_url',
    :'redirect_url',
    :'decline_redirect_url',
    :'allow_decline',
    :'allow_reassign',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
158
159
160
161
162
163
164
165
166
 
# File 'lib/signwell_sdk/models/document_response.rb', line 131

def self.openapi_types
  {
    :'test_mode' => :'Boolean',
    :'id' => :'String',
    :'api_application_id' => :'String',
    :'requester_email_address' => :'String',
    :'custom_requester_name' => :'String',
    :'custom_requester_email' => :'String',
    :'name' => :'String',
    :'subject' => :'String',
    :'message' => :'String',
    :'metadata' => :'Hash<String, String>',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'recipients' => :'Array<DocumentResponseRecipientsInner>',
    :'status' => :'String',
    :'reminders' => :'Boolean',
    :'archived' => :'Boolean',
    :'embedded' => :'Boolean',
    :'embedded_edit_url' => :'String',
    :'embedded_preview_url' => :'String',
    :'apply_signing_order' => :'Boolean',
    :'redirect_url' => :'String',
    :'decline_redirect_url' => :'String',
    :'language' => :'String',
    :'expires_in' => :'Integer',
    :'attachment_requests' => :'Array<DocumentResponseAttachmentRequestsInner>',
    :'files' => :'Array<FileInfo>',
    :'copied_contacts' => :'Array<CopiedContactInfo>',
    :'fields' => :'Array<Array<DocumentResponseFieldsInnerInner>>',
    :'allow_decline' => :'Boolean',
    :'allow_reassign' => :'Boolean',
    :'labels' => :'Array<LabelInfo>',
    :'checkbox_groups' => :'Array<CheckboxGroupInfo>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
 
# File 'lib/signwell_sdk/models/document_response.rb', line 395

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      test_mode == o.test_mode &&
      id == o.id &&
      api_application_id == o.api_application_id &&
      requester_email_address == o.requester_email_address &&
      custom_requester_name == o.custom_requester_name &&
      custom_requester_email == o.custom_requester_email &&
      name == o.name &&
      subject == o.subject &&
      message == o.message &&
      metadata == o.metadata &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      recipients == o.recipients &&
      status == o.status &&
      reminders == o.reminders &&
      archived == o.archived &&
      embedded == o.embedded &&
      embedded_edit_url == o.embedded_edit_url &&
      embedded_preview_url == o.embedded_preview_url &&
      apply_signing_order == o.apply_signing_order &&
      redirect_url == o.redirect_url &&
      decline_redirect_url == o.decline_redirect_url &&
      language == o.language &&
      expires_in == o.expires_in &&
      attachment_requests == o.attachment_requests &&
      files == o.files &&
      copied_contacts == o.copied_contacts &&
      fields == o.fields &&
      allow_decline == o.allow_decline &&
      allow_reassign == o.allow_reassign &&
      labels == o.labels &&
      checkbox_groups == o.checkbox_groups
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



542
543
544
545
546
547
548
549
550
551
552
553
554
 
# File 'lib/signwell_sdk/models/document_response.rb', line 542

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


434
435
436
 
# File 'lib/signwell_sdk/models/document_response.rb', line 434

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



440
441
442
 
# File 'lib/signwell_sdk/models/document_response.rb', line 440

def hash
  [test_mode, id, api_application_id, requester_email_address, custom_requester_name, custom_requester_email, name, subject, message, metadata, created_at, updated_at, recipients, status, reminders, archived, embedded, embedded_edit_url, embedded_preview_url, apply_signing_order, redirect_url, decline_redirect_url, language, expires_in, attachment_requests, files, copied_contacts, fields, allow_decline, allow_reassign, labels, checkbox_groups].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



350
351
352
353
354
355
356
357
358
359
360
361
362
 
# File 'lib/signwell_sdk/models/document_response.rb', line 350

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  if @test_mode.nil?
    invalid_properties.push('invalid value for "test_mode", test_mode cannot be nil.')
  end

  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

  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



518
519
520
 
# File 'lib/signwell_sdk/models/document_response.rb', line 518

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



524
525
526
527
528
529
530
531
532
533
534
535
536
 
# File 'lib/signwell_sdk/models/document_response.rb', line 524

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



512
513
514
 
# File 'lib/signwell_sdk/models/document_response.rb', line 512

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



366
367
368
369
370
371
 
# File 'lib/signwell_sdk/models/document_response.rb', line 366

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @test_mode.nil?
  return false if @id.nil?
  true
end