Class: Onfido::ExtractionExtractedData

Inherits:
Object
  • Object
show all
Defined in:
lib/onfido/models/extraction_extracted_data.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ExtractionExtractedData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 200

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Onfido::ExtractionExtractedData` 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 `Onfido::ExtractionExtractedData`. 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?(:'document_number')
    self.document_number = attributes[:'document_number']
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_1 ⇒ Object

Line 1 of the address.



64
65
66
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 64

def address_1
  @address_1
end

#address_2 ⇒ Object

Line 2 of the address.



67
68
69
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 67

def address_2
  @address_2
end

#address_3 ⇒ Object

Line 3 of the address.



70
71
72
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 70

def address_3
  @address_3
end

#address_4 ⇒ Object

Line 4 of the address.



73
74
75
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 73

def address_4
  @address_4
end

#address_5 ⇒ Object

Line 5 of the address.



76
77
78
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 76

def address_5
  @address_5
end

#alias_name ⇒ Object

Alias name (French documents only).



37
38
39
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 37

def alias_name
  @alias_name
end

#date_of_birth ⇒ Object

Date of birth in YYYY-MM-DD format.



43
44
45
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 43

def date_of_birth
  @date_of_birth
end

#date_of_expiry ⇒ Object

Date of expiry in YYYY-MM-DD format.



46
47
48
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 46

def date_of_expiry
  @date_of_expiry
end

#document_number ⇒ Object

The official document number.



19
20
21
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 19

def document_number
  @document_number
end

#document_type ⇒ Object

Type of document.



85
86
87
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 85

def document_type
  @document_type
end

#expiry_date ⇒ Object

Date of expiry in YYYY-MM-DD format.



49
50
51
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 49

def expiry_date
  @expiry_date
end

#first_name ⇒ Object

First name.



22
23
24
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 22

def first_name
  @first_name
end

#full_name ⇒ Object

Full name.



28
29
30
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 28

def full_name
  @full_name
end

#gender ⇒ Object

Gender (Valid values are Male and Female).



40
41
42
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 40

def gender
  @gender
end

#issuing_authority ⇒ Object

Issuing authority.



79
80
81
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 79

def issuing_authority
  @issuing_authority
end

#issuing_country ⇒ Object

Document country in 3-letter ISO code.



82
83
84
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 82

def issuing_country
  @issuing_country
end

#issuing_date ⇒ Object

Issuing date in YYYY-MM-DD format.



94
95
96
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 94

def issuing_date
  @issuing_date
end

#issuing_state ⇒ Object

The state that issued the document.



91
92
93
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 91

def issuing_state
  @issuing_state
end

#last_name ⇒ Object

Last name.



25
26
27
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 25

def last_name
  @last_name
end

#mrz_line_1 ⇒ Object

Line 1 of the MRZ code.



55
56
57
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 55

def mrz_line_1
  @mrz_line_1
end

#mrz_line_2 ⇒ Object

Line 2 of the MRZ code.



58
59
60
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 58

def mrz_line_2
  @mrz_line_2
end

#mrz_line_3 ⇒ Object

Line 3 of the MRZ code.



61
62
63
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 61

def mrz_line_3
  @mrz_line_3
end

#nationality ⇒ Object

Nationality in 3-letter ISO code.



52
53
54
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 52

def nationality
  @nationality
end

#personal_number ⇒ Object

The owner’s unique identification number.



97
98
99
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 97

def personal_number
  @personal_number
end

#place_of_birth ⇒ Object

Place of birth.



88
89
90
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 88

def place_of_birth
  @place_of_birth
end

#spouse_name ⇒ Object

Spouse name (French documents only).



31
32
33
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 31

def spouse_name
  @spouse_name
end

#widow_name ⇒ Object

Widow name (French documents only).



34
35
36
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 34

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



443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 443

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



155
156
157
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 155

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
148
149
150
151
152
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 122

def self.attribute_map
  {
    :'document_number' => :'document_number',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'full_name' => :'full_name',
    :'spouse_name' => :'spouse_name',
    :'widow_name' => :'widow_name',
    :'alias_name' => :'alias_name',
    :'gender' => :'gender',
    :'date_of_birth' => :'date_of_birth',
    :'date_of_expiry' => :'date_of_expiry',
    :'expiry_date' => :'expiry_date',
    :'nationality' => :'nationality',
    :'mrz_line_1' => :'mrz_line_1',
    :'mrz_line_2' => :'mrz_line_2',
    :'mrz_line_3' => :'mrz_line_3',
    :'address_1' => :'address_1',
    :'address_2' => :'address_2',
    :'address_3' => :'address_3',
    :'address_4' => :'address_4',
    :'address_5' => :'address_5',
    :'issuing_authority' => :'issuing_authority',
    :'issuing_country' => :'issuing_country',
    :'document_type' => :'document_type',
    :'place_of_birth' => :'place_of_birth',
    :'issuing_state' => :'issuing_state',
    :'issuing_date' => :'issuing_date',
    :'personal_number' => :'personal_number'
  }
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



419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 419

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



193
194
195
196
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 193

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 160

def self.openapi_types
  {
    :'document_number' => :'String',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'full_name' => :'String',
    :'spouse_name' => :'String',
    :'widow_name' => :'String',
    :'alias_name' => :'String',
    :'gender' => :'String',
    :'date_of_birth' => :'Date',
    :'date_of_expiry' => :'Date',
    :'expiry_date' => :'Date',
    :'nationality' => :'String',
    :'mrz_line_1' => :'String',
    :'mrz_line_2' => :'String',
    :'mrz_line_3' => :'String',
    :'address_1' => :'String',
    :'address_2' => :'String',
    :'address_3' => :'String',
    :'address_4' => :'String',
    :'address_5' => :'String',
    :'issuing_authority' => :'String',
    :'issuing_country' => :'CountryCodes',
    :'document_type' => :'DocumentTypes',
    :'place_of_birth' => :'String',
    :'issuing_state' => :'String',
    :'issuing_date' => :'Date',
    :'personal_number' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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
399
400
401
402
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 372

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_number == o.document_number &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      full_name == o.full_name &&
      spouse_name == o.spouse_name &&
      widow_name == o.widow_name &&
      alias_name == o.alias_name &&
      gender == o.gender &&
      date_of_birth == o.date_of_birth &&
      date_of_expiry == o.date_of_expiry &&
      expiry_date == o.expiry_date &&
      nationality == o.nationality &&
      mrz_line_1 == o.mrz_line_1 &&
      mrz_line_2 == o.mrz_line_2 &&
      mrz_line_3 == o.mrz_line_3 &&
      address_1 == o.address_1 &&
      address_2 == o.address_2 &&
      address_3 == o.address_3 &&
      address_4 == o.address_4 &&
      address_5 == o.address_5 &&
      issuing_authority == o.issuing_authority &&
      issuing_country == o.issuing_country &&
      document_type == o.document_type &&
      place_of_birth == o.place_of_birth &&
      issuing_state == o.issuing_state &&
      issuing_date == o.issuing_date &&
      personal_number == o.personal_number
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



514
515
516
517
518
519
520
521
522
523
524
525
526
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 514

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


406
407
408
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 406

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



412
413
414
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 412

def hash
  [document_number, first_name, last_name, full_name, spouse_name, widow_name, alias_name, gender, date_of_birth, date_of_expiry, expiry_date, nationality, mrz_line_1, mrz_line_2, mrz_line_3, address_1, address_2, address_3, address_4, address_5, issuing_authority, issuing_country, document_type, place_of_birth, issuing_state, issuing_date, personal_number].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



324
325
326
327
328
329
330
331
332
333
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 324

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  pattern = Regexp.new(/^[A-Z]{3}$/)
  if !@nationality.nil? && @nationality !~ pattern
    invalid_properties.push("invalid value for \"nationality\", must conform to the pattern #{pattern}.")
  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



490
491
492
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 490

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



496
497
498
499
500
501
502
503
504
505
506
507
508
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 496

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



484
485
486
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 484

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



337
338
339
340
341
342
343
 
# File 'lib/onfido/models/extraction_extracted_data.rb', line 337

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  gender_validator = EnumAttributeValidator.new('String', ["Male", "Female", "unknown_default_open_api"])
  return false unless gender_validator.valid?(@gender)
  return false if !@nationality.nil? && @nationality !~ Regexp.new(/^[A-Z]{3}$/)
  true
end