Class: Onfido::DocumentPropertiesBarcode

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ DocumentPropertiesBarcode

Initializes the object

Parameters:

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

    Model attributes in the form of hash



115
116
117
118
119
120
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
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
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 115

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

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

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

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

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

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

  if attributes.key?(:'issuing_date')
    self.issuing_date = attributes[:'issuing_date']
  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_state')
    self.issuing_state = attributes[:'issuing_state']
  end

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

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

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

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

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

Instance Attribute Details

#_class ⇒ Object

Returns the value of attribute _class.



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

def _class
  @_class
end

#address_line_1 ⇒ Object

Returns the value of attribute address_line_1.



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

def address_line_1
  @address_line_1
end

#address_line_2 ⇒ Object

Returns the value of attribute address_line_2.



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

def address_line_2
  @address_line_2
end

#address_line_3 ⇒ Object

Returns the value of attribute address_line_3.



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

def address_line_3
  @address_line_3
end

#address_line_4 ⇒ Object

Returns the value of attribute address_line_4.



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

def address_line_4
  @address_line_4
end

#address_line_5 ⇒ Object

Returns the value of attribute address_line_5.



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

def address_line_5
  @address_line_5
end

#date_of_birth ⇒ Object

Returns the value of attribute date_of_birth.



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

def date_of_birth
  @date_of_birth
end

#date_of_expiry ⇒ Object

Returns the value of attribute date_of_expiry.



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

def date_of_expiry
  @date_of_expiry
end

#document_number ⇒ Object

Returns the value of attribute document_number.



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

def document_number
  @document_number
end

#document_type ⇒ Object

Returns the value of attribute document_type.



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

def document_type
  @document_type
end

#first_name ⇒ Object

Returns the value of attribute first_name.



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

def first_name
  @first_name
end

#gender ⇒ Object

Returns the value of attribute gender.



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

def gender
  @gender
end

#issuing_country ⇒ Object

Returns the value of attribute issuing_country.



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

def issuing_country
  @issuing_country
end

#issuing_date ⇒ Object

Returns the value of attribute issuing_date.



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

def issuing_date
  @issuing_date
end

#issuing_state ⇒ Object

Returns the value of attribute issuing_state.



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

def issuing_state
  @issuing_state
end

#last_name ⇒ Object

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#middle_name ⇒ Object

Returns the value of attribute middle_name.



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

def middle_name
  @middle_name
end

#real_id_classification ⇒ Object

Returns the value of attribute real_id_classification.



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

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



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

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



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 55

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'middle_name' => :'middle_name',
    :'last_name' => :'last_name',
    :'document_type' => :'document_type',
    :'date_of_expiry' => :'date_of_expiry',
    :'date_of_birth' => :'date_of_birth',
    :'issuing_date' => :'issuing_date',
    :'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_state' => :'issuing_state',
    :'_class' => :'class',
    :'gender' => :'gender',
    :'issuing_country' => :'issuing_country',
    :'document_number' => :'document_number',
    :'real_id_classification' => :'real_id_classification'
  }
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



256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 256

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



108
109
110
111
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 108

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

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 84

def self.openapi_types
  {
    :'first_name' => :'String',
    :'middle_name' => :'String',
    :'last_name' => :'String',
    :'document_type' => :'String',
    :'date_of_expiry' => :'Date',
    :'date_of_birth' => :'Date',
    :'issuing_date' => :'Date',
    :'address_line_1' => :'String',
    :'address_line_2' => :'String',
    :'address_line_3' => :'String',
    :'address_line_4' => :'String',
    :'address_line_5' => :'String',
    :'issuing_state' => :'String',
    :'_class' => :'String',
    :'gender' => :'String',
    :'issuing_country' => :'String',
    :'document_number' => :'String',
    :'real_id_classification' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      middle_name == o.middle_name &&
      last_name == o.last_name &&
      document_type == o.document_type &&
      date_of_expiry == o.date_of_expiry &&
      date_of_birth == o.date_of_birth &&
      issuing_date == o.issuing_date &&
      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_state == o.issuing_state &&
      _class == o._class &&
      gender == o.gender &&
      issuing_country == o.issuing_country &&
      document_number == o.document_number &&
      real_id_classification == o.real_id_classification
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



351
352
353
354
355
356
357
358
359
360
361
362
363
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 351

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


243
244
245
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 249

def hash
  [first_name, middle_name, last_name, document_type, date_of_expiry, date_of_birth, issuing_date, address_line_1, address_line_2, address_line_3, address_line_4, address_line_5, issuing_state, _class, gender, issuing_country, document_number, real_id_classification].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



203
204
205
206
207
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 203

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



327
328
329
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 327

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



333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 333

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



321
322
323
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 321

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



211
212
213
214
 
# File 'lib/onfido/models/document_properties_barcode.rb', line 211

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