Class: DocSpring::Submission

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Submission

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#actions ⇒ Object

Returns the value of attribute actions.



49
50
51
 
# File 'lib/docspring/models/submission.rb', line 49

def actions
  @actions
end

#batch_id ⇒ Object

Returns the value of attribute batch_id.



45
46
47
 
# File 'lib/docspring/models/submission.rb', line 45

def batch_id
  @batch_id
end

#data ⇒ Object

Returns the value of attribute data.



33
34
35
 
# File 'lib/docspring/models/submission.rb', line 33

def data
  @data
end

#data_requests ⇒ Object

Returns the value of attribute data_requests.



47
48
49
 
# File 'lib/docspring/models/submission.rb', line 47

def data_requests
  @data_requests
end

#download_url ⇒ Object

Returns the value of attribute download_url.



41
42
43
 
# File 'lib/docspring/models/submission.rb', line 41

def download_url
  @download_url
end

#editable ⇒ Object

Returns the value of attribute editable.



23
24
25
 
# File 'lib/docspring/models/submission.rb', line 23

def editable
  @editable
end

#expired ⇒ Object

Returns the value of attribute expired.



25
26
27
 
# File 'lib/docspring/models/submission.rb', line 25

def expired
  @expired
end

#expires_at ⇒ Object

Returns the value of attribute expires_at.



27
28
29
 
# File 'lib/docspring/models/submission.rb', line 27

def expires_at
  @expires_at
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/docspring/models/submission.rb', line 17

def id
  @id
end

#metadata ⇒ Object

Returns the value of attribute metadata.



35
36
37
 
# File 'lib/docspring/models/submission.rb', line 35

def metadata
  @metadata
end

#pdf_hash ⇒ Object

Returns the value of attribute pdf_hash.



39
40
41
 
# File 'lib/docspring/models/submission.rb', line 39

def pdf_hash
  @pdf_hash
end

#permanent_download_url ⇒ Object

Returns the value of attribute permanent_download_url.



43
44
45
 
# File 'lib/docspring/models/submission.rb', line 43

def permanent_download_url
  @permanent_download_url
end

#processed_at ⇒ Object

Returns the value of attribute processed_at.



29
30
31
 
# File 'lib/docspring/models/submission.rb', line 29

def processed_at
  @processed_at
end

#referrer ⇒ Object

Returns the value of attribute referrer.



53
54
55
 
# File 'lib/docspring/models/submission.rb', line 53

def referrer
  @referrer
end

#source ⇒ Object

Returns the value of attribute source.



51
52
53
 
# File 'lib/docspring/models/submission.rb', line 51

def source
  @source
end

#state ⇒ Object

Returns the value of attribute state.



31
32
33
 
# File 'lib/docspring/models/submission.rb', line 31

def state
  @state
end

#template_id ⇒ Object

Returns the value of attribute template_id.



19
20
21
 
# File 'lib/docspring/models/submission.rb', line 19

def template_id
  @template_id
end

#test ⇒ Object

Returns the value of attribute test.



21
22
23
 
# File 'lib/docspring/models/submission.rb', line 21

def test
  @test
end

#truncated_text ⇒ Object

Returns the value of attribute truncated_text.



37
38
39
 
# File 'lib/docspring/models/submission.rb', line 37

def truncated_text
  @truncated_text
end

Class Method Details

.attribute_map ⇒ Object

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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/docspring/models/submission.rb', line 78

def self.attribute_map
  {
    :'id' => :'id',
    :'template_id' => :'template_id',
    :'test' => :'test',
    :'editable' => :'editable',
    :'expired' => :'expired',
    :'expires_at' => :'expires_at',
    :'processed_at' => :'processed_at',
    :'state' => :'state',
    :'data' => :'data',
    :'metadata' => :'metadata',
    :'truncated_text' => :'truncated_text',
    :'pdf_hash' => :'pdf_hash',
    :'download_url' => :'download_url',
    :'permanent_download_url' => :'permanent_download_url',
    :'batch_id' => :'batch_id',
    :'data_requests' => :'data_requests',
    :'actions' => :'actions',
    :'source' => :'source',
    :'referrer' => :'referrer'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



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/docspring/models/submission.rb', line 103

def self.openapi_types
  {
    :'id' => :'String',
    :'template_id' => :'String',
    :'test' => :'BOOLEAN',
    :'editable' => :'BOOLEAN',
    :'expired' => :'BOOLEAN',
    :'expires_at' => :'String',
    :'processed_at' => :'String',
    :'state' => :'String',
    :'data' => :'Object',
    :'metadata' => :'Object',
    :'truncated_text' => :'Object',
    :'pdf_hash' => :'String',
    :'download_url' => :'String',
    :'permanent_download_url' => :'String',
    :'batch_id' => :'String',
    :'data_requests' => :'Array<SubmissionDataRequest>',
    :'actions' => :'Array<SubmissionAction>',
    :'source' => :'String',
    :'referrer' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/docspring/models/submission.rb', line 263

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      template_id == o.template_id &&
      test == o.test &&
      editable == o.editable &&
      expired == o.expired &&
      expires_at == o.expires_at &&
      processed_at == o.processed_at &&
      state == o.state &&
      data == o.data &&
      metadata == o.metadata &&
      truncated_text == o.truncated_text &&
      pdf_hash == o.pdf_hash &&
      download_url == o.download_url &&
      permanent_download_url == o.permanent_download_url &&
      batch_id == o.batch_id &&
      data_requests == o.data_requests &&
      actions == o.actions &&
      source == o.source &&
      referrer == o.referrer
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



323
324
325
326
327
328
329
330
331
332
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
 
# File 'lib/docspring/models/submission.rb', line 323

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 = DocSpring.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



389
390
391
392
393
394
395
396
397
398
399
400
401
 
# File 'lib/docspring/models/submission.rb', line 389

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



302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
 
# File 'lib/docspring/models/submission.rb', line 302

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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


289
290
291
 
# File 'lib/docspring/models/submission.rb', line 289

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



295
296
297
 
# File 'lib/docspring/models/submission.rb', line 295

def hash
  [id, template_id, test, editable, expired, expires_at, processed_at, state, data, metadata, truncated_text, pdf_hash, download_url, permanent_download_url, batch_id, data_requests, actions, source, referrer].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



218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
 
# File 'lib/docspring/models/submission.rb', line 218

def list_invalid_properties
  invalid_properties = Array.new
  if @id.nil?
    invalid_properties.push('invalid value for "id", id cannot be nil.')
  end

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

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

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



369
370
371
 
# File 'lib/docspring/models/submission.rb', line 369

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



375
376
377
378
379
380
381
382
383
 
# File 'lib/docspring/models/submission.rb', line 375

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



363
364
365
 
# File 'lib/docspring/models/submission.rb', line 363

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



241
242
243
244
245
246
247
248
249
 
# File 'lib/docspring/models/submission.rb', line 241

def valid?
  return false if @id.nil?
  return false if @test.nil?
  return false if @expired.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)
  true
end