Class: DocSpring::SubmissionPreview

Inherits:
Object
  • Object
show all
Defined in:
lib/docspring/models/submission_preview.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ SubmissionPreview

Initializes the object

Parameters:

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

    Model attributes in the form of hash


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
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
 
# File 'lib/docspring/models/submission_preview.rb', line 173

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#actions ⇒ Object

Returns the value of attribute actions.


62
63
64
 
# File 'lib/docspring/models/submission_preview.rb', line 62

def actions
  @actions
end

#audit_trail_download_url ⇒ Object

Returns the value of attribute audit_trail_download_url.


60
61
62
 
# File 'lib/docspring/models/submission_preview.rb', line 60

def audit_trail_download_url
  @audit_trail_download_url
end

#batch_id ⇒ Object

Returns the value of attribute batch_id.


18
19
20
 
# File 'lib/docspring/models/submission_preview.rb', line 18

def batch_id
  @batch_id
end

#data_requests ⇒ Object

Returns the value of attribute data_requests.


20
21
22
 
# File 'lib/docspring/models/submission_preview.rb', line 20

def data_requests
  @data_requests
end

#download_url ⇒ Object

Returns the value of attribute download_url.


52
53
54
 
# File 'lib/docspring/models/submission_preview.rb', line 52

def download_url
  @download_url
end

#editable ⇒ Object

Returns the value of attribute editable.


22
23
24
 
# File 'lib/docspring/models/submission_preview.rb', line 22

def editable
  @editable
end

#expired ⇒ Object

Returns the value of attribute expired.


24
25
26
 
# File 'lib/docspring/models/submission_preview.rb', line 24

def expired
  @expired
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.


26
27
28
 
# File 'lib/docspring/models/submission_preview.rb', line 26

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.


28
29
30
 
# File 'lib/docspring/models/submission_preview.rb', line 28

def id
  @id
end

#json_schema_errors ⇒ Object

Returns the value of attribute json_schema_errors.


30
31
32
 
# File 'lib/docspring/models/submission_preview.rb', line 30

def json_schema_errors
  @json_schema_errors
end

#metadata ⇒ Object

Returns the value of attribute metadata.


32
33
34
 
# File 'lib/docspring/models/submission_preview.rb', line 32

def metadata
  @metadata
end

#password ⇒ Object

Returns the value of attribute password.


34
35
36
 
# File 'lib/docspring/models/submission_preview.rb', line 34

def password
  @password
end

#pdf_hash ⇒ Object

Returns the value of attribute pdf_hash.


50
51
52
 
# File 'lib/docspring/models/submission_preview.rb', line 50

def pdf_hash
  @pdf_hash
end

#permanent_download_url ⇒ Object

Returns the value of attribute permanent_download_url.


54
55
56
 
# File 'lib/docspring/models/submission_preview.rb', line 54

def permanent_download_url
  @permanent_download_url
end

#preview_download_url ⇒ Object

Returns the value of attribute preview_download_url.


56
57
58
 
# File 'lib/docspring/models/submission_preview.rb', line 56

def preview_download_url
  @preview_download_url
end

#preview_generated_at ⇒ Object

Returns the value of attribute preview_generated_at.


58
59
60
 
# File 'lib/docspring/models/submission_preview.rb', line 58

def preview_generated_at
  @preview_generated_at
end

#processed_at ⇒ Object

Returns the value of attribute processed_at.


36
37
38
 
# File 'lib/docspring/models/submission_preview.rb', line 36

def processed_at
  @processed_at
end

#state ⇒ Object

Returns the value of attribute state.


38
39
40
 
# File 'lib/docspring/models/submission_preview.rb', line 38

def state
  @state
end

#template_id ⇒ Object

Returns the value of attribute template_id.


40
41
42
 
# File 'lib/docspring/models/submission_preview.rb', line 40

def template_id
  @template_id
end

#template_type ⇒ Object

Returns the value of attribute template_type.


42
43
44
 
# File 'lib/docspring/models/submission_preview.rb', line 42

def template_type
  @template_type
end

#template_version ⇒ Object

Returns the value of attribute template_version.


44
45
46
 
# File 'lib/docspring/models/submission_preview.rb', line 44

def template_version
  @template_version
end

#test ⇒ Object

Returns the value of attribute test.


46
47
48
 
# File 'lib/docspring/models/submission_preview.rb', line 46

def test
  @test
end

#truncated_text ⇒ Object

Returns the value of attribute truncated_text.


48
49
50
 
# File 'lib/docspring/models/submission_preview.rb', line 48

def truncated_text
  @truncated_text
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


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
509
510
511
 
# File 'lib/docspring/models/submission_preview.rb', line 474

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 = DocSpring.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_attributes ⇒ Object

Returns all the JSON keys this model knows about


116
117
118
 
# File 'lib/docspring/models/submission_preview.rb', line 116

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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
 
# File 'lib/docspring/models/submission_preview.rb', line 87

def self.attribute_map
  {
    :'batch_id' => :'batch_id',
    :'data_requests' => :'data_requests',
    :'editable' => :'editable',
    :'expired' => :'expired',
    :'expires_at' => :'expires_at',
    :'id' => :'id',
    :'json_schema_errors' => :'json_schema_errors',
    :'metadata' => :'metadata',
    :'password' => :'password',
    :'processed_at' => :'processed_at',
    :'state' => :'state',
    :'template_id' => :'template_id',
    :'template_type' => :'template_type',
    :'template_version' => :'template_version',
    :'test' => :'test',
    :'truncated_text' => :'truncated_text',
    :'pdf_hash' => :'pdf_hash',
    :'download_url' => :'download_url',
    :'permanent_download_url' => :'permanent_download_url',
    :'preview_download_url' => :'preview_download_url',
    :'preview_generated_at' => :'preview_generated_at',
    :'audit_trail_download_url' => :'audit_trail_download_url',
    :'actions' => :'actions'
  }
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


450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/docspring/models/submission_preview.rb', line 450

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


150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
 
# File 'lib/docspring/models/submission_preview.rb', line 150

def self.openapi_nullable
  Set.new([
    :'batch_id',
    :'editable',
    :'expires_at',
    :'id',
    :'json_schema_errors',
    :'password',
    :'processed_at',
    :'template_id',
    :'template_version',
    :'truncated_text',
    :'pdf_hash',
    :'download_url',
    :'permanent_download_url',
    :'preview_download_url',
    :'preview_generated_at',
    :'audit_trail_download_url',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.


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
147
 
# File 'lib/docspring/models/submission_preview.rb', line 121

def self.openapi_types
  {
    :'batch_id' => :'String',
    :'data_requests' => :'Array<SubmissionDataRequest>',
    :'editable' => :'Boolean',
    :'expired' => :'Boolean',
    :'expires_at' => :'String',
    :'id' => :'String',
    :'json_schema_errors' => :'Array<String>',
    :'metadata' => :'Object',
    :'password' => :'String',
    :'processed_at' => :'String',
    :'state' => :'String',
    :'template_id' => :'String',
    :'template_type' => :'String',
    :'template_version' => :'String',
    :'test' => :'Boolean',
    :'truncated_text' => :'Object',
    :'pdf_hash' => :'String',
    :'download_url' => :'String',
    :'permanent_download_url' => :'String',
    :'preview_download_url' => :'String',
    :'preview_generated_at' => :'String',
    :'audit_trail_download_url' => :'String',
    :'actions' => :'Array<SubmissionAction>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared


407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
 
# File 'lib/docspring/models/submission_preview.rb', line 407

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      batch_id == o.batch_id &&
      data_requests == o.data_requests &&
      editable == o.editable &&
      expired == o.expired &&
      expires_at == o.expires_at &&
      id == o.id &&
      json_schema_errors == o.json_schema_errors &&
      metadata == o.metadata &&
      password == o.password &&
      processed_at == o.processed_at &&
      state == o.state &&
      template_id == o.template_id &&
      template_type == o.template_type &&
      template_version == o.template_version &&
      test == o.test &&
      truncated_text == o.truncated_text &&
      pdf_hash == o.pdf_hash &&
      download_url == o.download_url &&
      permanent_download_url == o.permanent_download_url &&
      preview_download_url == o.preview_download_url &&
      preview_generated_at == o.preview_generated_at &&
      audit_trail_download_url == o.audit_trail_download_url &&
      actions == o.actions
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


545
546
547
548
549
550
551
552
553
554
555
556
557
 
# File 'lib/docspring/models/submission_preview.rb', line 545

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

437
438
439
 
# File 'lib/docspring/models/submission_preview.rb', line 437

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code


443
444
445
 
# File 'lib/docspring/models/submission_preview.rb', line 443

def hash
  [batch_id, data_requests, editable, expired, expires_at, id, json_schema_errors, metadata, password, processed_at, state, template_id, template_type, template_version, test, truncated_text, pdf_hash, download_url, permanent_download_url, preview_download_url, preview_generated_at, audit_trail_download_url, actions].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


333
334
335
336
337
338
339
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
 
# File 'lib/docspring/models/submission_preview.rb', line 333

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

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

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

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

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

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

  if @actions.nil?
    invalid_properties.push('invalid value for "actions", actions 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


521
522
523
 
# File 'lib/docspring/models/submission_preview.rb', line 521

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


527
528
529
530
531
532
533
534
535
536
537
538
539
 
# File 'lib/docspring/models/submission_preview.rb', line 527

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


515
516
517
 
# File 'lib/docspring/models/submission_preview.rb', line 515

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


369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/docspring/models/submission_preview.rb', line 369

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  return false if @data_requests.nil?
  return false if @expired.nil?
  return false if @metadata.nil?
  return false if @state.nil?
  state_validator = EnumAttributeValidator.new('String', ["pending", "processed", "invalid_data", "error", "image_download_failed", "image_processing_failed", "waiting_for_data_requests", "syntax_error", "account_suspended", "license_revoked", "accidental"])
  return false unless state_validator.valid?(@state)
  return false if @template_type.nil?
  template_type_validator = EnumAttributeValidator.new('String', ["pdf", "html"])
  return false unless template_type_validator.valid?(@template_type)
  return false if @test.nil?
  return false if @actions.nil?
  true
end