Class: Onfido::DocumentPropertiesExtractedData

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentPropertiesExtractedData

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

  if attributes.key?(:'middle_name')
    self.middle_name = attributes[:'middle_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?(:'mrz_line1')
    self.mrz_line1 = attributes[:'mrz_line1']
  end

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#address_line_1 ⇒ Object

Returns the value of attribute address_line_1.



48
49
50
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 48

def address_line_1
  @address_line_1
end

#address_line_2 ⇒ Object

Returns the value of attribute address_line_2.



50
51
52
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 50

def address_line_2
  @address_line_2
end

#address_line_3 ⇒ Object

Returns the value of attribute address_line_3.



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

def address_line_3
  @address_line_3
end

#address_line_4 ⇒ Object

Returns the value of attribute address_line_4.



54
55
56
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 54

def address_line_4
  @address_line_4
end

#address_line_5 ⇒ Object

Returns the value of attribute address_line_5.



56
57
58
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 56

def address_line_5
  @address_line_5
end

#alias_name ⇒ Object

Returns the value of attribute alias_name.



36
37
38
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 36

def alias_name
  @alias_name
end

#date_of_birth ⇒ Object

Returns the value of attribute date_of_birth.



20
21
22
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 20

def date_of_birth
  @date_of_birth
end

#date_of_expiry ⇒ Object

Returns the value of attribute date_of_expiry.



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

def date_of_expiry
  @date_of_expiry
end

#document_number ⇒ Object

Returns the value of attribute document_number.



18
19
20
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 18

def document_number
  @document_number
end

#first_name ⇒ Object

Returns the value of attribute first_name.



24
25
26
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 24

def first_name
  @first_name
end

#full_name ⇒ Object

Returns the value of attribute full_name.



30
31
32
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 30

def full_name
  @full_name
end

#gender ⇒ Object

Returns the value of attribute gender.



38
39
40
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 38

def gender
  @gender
end

#issuing_authority ⇒ Object

Returns the value of attribute issuing_authority.



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

def issuing_authority
  @issuing_authority
end

#last_name ⇒ Object

Returns the value of attribute last_name.



26
27
28
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 26

def last_name
  @last_name
end

#middle_name ⇒ Object

Returns the value of attribute middle_name.



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

def middle_name
  @middle_name
end

#mrz_line1 ⇒ Object

Returns the value of attribute mrz_line1.



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

def mrz_line1
  @mrz_line1
end

#mrz_line2 ⇒ Object

Returns the value of attribute mrz_line2.



42
43
44
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 42

def mrz_line2
  @mrz_line2
end

#mrz_line3 ⇒ Object

Returns the value of attribute mrz_line3.



44
45
46
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 44

def mrz_line3
  @mrz_line3
end

#nationality ⇒ Object

Returns the value of attribute nationality.



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

def nationality
  @nationality
end

#spouse_name ⇒ Object

Returns the value of attribute spouse_name.



32
33
34
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 32

def spouse_name
  @spouse_name
end

#widow_name ⇒ Object

Returns the value of attribute widow_name.



34
35
36
 
# File 'lib/onfido/models/document_properties_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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 61

def self.attribute_map
  {
    :'document_number' => :'document_number',
    :'date_of_birth' => :'date_of_birth',
    :'date_of_expiry' => :'date_of_expiry',
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'middle_name' => :'middle_name',
    :'full_name' => :'full_name',
    :'spouse_name' => :'spouse_name',
    :'widow_name' => :'widow_name',
    :'alias_name' => :'alias_name',
    :'gender' => :'gender',
    :'mrz_line1' => :'mrz_line1',
    :'mrz_line2' => :'mrz_line2',
    :'mrz_line3' => :'mrz_line3',
    :'nationality' => :'nationality',
    :'address_line_1' => :'address_line_1',
    :'address_line_2' => :'address_line_2',
    :'address_line_3' => :'address_line_3',
    :'address_line_4' => :'address_line_4',
    :'address_line_5' => :'address_line_5',
    :'issuing_authority' => :'issuing_authority'
  }
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



283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 283

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



120
121
122
123
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 120

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

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'document_number' => :'String',
    :'date_of_birth' => :'Date',
    :'date_of_expiry' => :'Date',
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'middle_name' => :'String',
    :'full_name' => :'String',
    :'spouse_name' => :'String',
    :'widow_name' => :'String',
    :'alias_name' => :'String',
    :'gender' => :'String',
    :'mrz_line1' => :'String',
    :'mrz_line2' => :'String',
    :'mrz_line3' => :'String',
    :'nationality' => :'String',
    :'address_line_1' => :'String',
    :'address_line_2' => :'String',
    :'address_line_3' => :'String',
    :'address_line_4' => :'String',
    :'address_line_5' => :'String',
    :'issuing_authority' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      document_number == o.document_number &&
      date_of_birth == o.date_of_birth &&
      date_of_expiry == o.date_of_expiry &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      middle_name == o.middle_name &&
      full_name == o.full_name &&
      spouse_name == o.spouse_name &&
      widow_name == o.widow_name &&
      alias_name == o.alias_name &&
      gender == o.gender &&
      mrz_line1 == o.mrz_line1 &&
      mrz_line2 == o.mrz_line2 &&
      mrz_line3 == o.mrz_line3 &&
      nationality == o.nationality &&
      address_line_1 == o.address_line_1 &&
      address_line_2 == o.address_line_2 &&
      address_line_3 == o.address_line_3 &&
      address_line_4 == o.address_line_4 &&
      address_line_5 == o.address_line_5 &&
      issuing_authority == o.issuing_authority
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



378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 378

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


270
271
272
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 276

def hash
  [document_number, date_of_birth, date_of_expiry, first_name, last_name, middle_name, full_name, spouse_name, widow_name, alias_name, gender, mrz_line1, mrz_line2, mrz_line3, nationality, address_line_1, address_line_2, address_line_3, address_line_4, address_line_5, issuing_authority].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



227
228
229
230
231
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 227

def list_invalid_properties
  warn '[DEPRECATED] the `list_invalid_properties` method is obsolete'
  invalid_properties = Array.new
  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



354
355
356
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 354

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



360
361
362
363
364
365
366
367
368
369
370
371
372
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 360

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



348
349
350
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 348

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



235
236
237
238
 
# File 'lib/onfido/models/document_properties_extracted_data.rb', line 235

def valid?
  warn '[DEPRECATED] the `valid?` method is obsolete'
  true
end