Class: Trulioo::Passport

Inherits:
Object
  • Object
show all
Defined in:
lib/trulioo_sdk/models/passport.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Passport

Initializes the object

Parameters:

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

    Model attributes in the form of hash



69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/trulioo_sdk/models/passport.rb', line 69

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

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

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

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

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

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

Instance Attribute Details

#day_of_expiry ⇒ Object

Passport’s Licence day of expiry of the individual to be verified



24
25
26
 
# File 'lib/trulioo_sdk/models/passport.rb', line 24

def day_of_expiry
  @day_of_expiry
end

#month_of_expiry ⇒ Object

Passport’s Licence month of expiry of the individual to be verified



27
28
29
 
# File 'lib/trulioo_sdk/models/passport.rb', line 27

def month_of_expiry
  @month_of_expiry
end

#mrz1 ⇒ Object

Line 1 of the passport MRZ



15
16
17
 
# File 'lib/trulioo_sdk/models/passport.rb', line 15

def mrz1
  @mrz1
end

#mrz2 ⇒ Object

line 2 of the passport MRZ



18
19
20
 
# File 'lib/trulioo_sdk/models/passport.rb', line 18

def mrz2
  @mrz2
end

#number ⇒ Object

Passport Number



21
22
23
 
# File 'lib/trulioo_sdk/models/passport.rb', line 21

def number
  @number
end

#year_of_expiry ⇒ Object

Passport’s Licence year of expiry of the individual to be verified



30
31
32
 
# File 'lib/trulioo_sdk/models/passport.rb', line 30

def year_of_expiry
  @year_of_expiry
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



45
46
47
 
# File 'lib/trulioo_sdk/models/passport.rb', line 45

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



33
34
35
36
37
38
39
40
41
42
 
# File 'lib/trulioo_sdk/models/passport.rb', line 33

def self.attribute_map
  {
    :'mrz1' => :'Mrz1',
    :'mrz2' => :'Mrz2',
    :'number' => :'Number',
    :'day_of_expiry' => :'DayOfExpiry',
    :'month_of_expiry' => :'MonthOfExpiry',
    :'year_of_expiry' => :'YearOfExpiry'
  }
end

.build_from_hash(attributes) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



197
198
199
 
# File 'lib/trulioo_sdk/models/passport.rb', line 197

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



62
63
64
65
 
# File 'lib/trulioo_sdk/models/passport.rb', line 62

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

.openapi_types ⇒ Object

Attribute type mapping.



50
51
52
53
54
55
56
57
58
59
 
# File 'lib/trulioo_sdk/models/passport.rb', line 50

def self.openapi_types
  {
    :'mrz1' => :'String',
    :'mrz2' => :'String',
    :'number' => :'String',
    :'day_of_expiry' => :'Integer',
    :'month_of_expiry' => :'Integer',
    :'year_of_expiry' => :'Integer'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



170
171
172
173
174
175
176
177
178
179
 
# File 'lib/trulioo_sdk/models/passport.rb', line 170

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      mrz1 == o.mrz1 &&
      mrz2 == o.mrz2 &&
      number == o.number &&
      day_of_expiry == o.day_of_expiry &&
      month_of_expiry == o.month_of_expiry &&
      year_of_expiry == o.year_of_expiry
end

#_deserialize(type, value) ⇒ Object

:nocov: Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



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
 
# File 'lib/trulioo_sdk/models/passport.rb', line 231

def _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 = Trulioo.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

:nocov: 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



310
311
312
313
314
315
316
317
318
319
320
321
322
 
# File 'lib/trulioo_sdk/models/passport.rb', line 310

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

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/trulioo_sdk/models/passport.rb', line 206

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{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[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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


183
184
185
 
# File 'lib/trulioo_sdk/models/passport.rb', line 183

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



189
190
191
 
# File 'lib/trulioo_sdk/models/passport.rb', line 189

def hash
  [mrz1, mrz2, number, day_of_expiry, month_of_expiry, year_of_expiry].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



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
 
# File 'lib/trulioo_sdk/models/passport.rb', line 109

def list_invalid_properties
  invalid_properties = Array.new
  if !@mrz1.nil? && @mrz1.to_s.length > 200
    invalid_properties.push('invalid value for "mrz1", the character length must be smaller than or equal to 200.')
  end

  if !@mrz1.nil? && @mrz1.to_s.length < 0
    invalid_properties.push('invalid value for "mrz1", the character length must be great than or equal to 0.')
  end

  if !@mrz2.nil? && @mrz2.to_s.length > 200
    invalid_properties.push('invalid value for "mrz2", the character length must be smaller than or equal to 200.')
  end

  if !@mrz2.nil? && @mrz2.to_s.length < 0
    invalid_properties.push('invalid value for "mrz2", the character length must be great than or equal to 0.')
  end

  invalid_properties
end

#to_body ⇒ Hash

:nocov: to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



282
283
284
 
# File 'lib/trulioo_sdk/models/passport.rb', line 282

def to_body
  to_hash
end

#to_hash ⇒ Hash

:nocov: Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/trulioo_sdk/models/passport.rb', line 290

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

:nocov: Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



274
275
276
 
# File 'lib/trulioo_sdk/models/passport.rb', line 274

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



132
133
134
135
136
137
138
 
# File 'lib/trulioo_sdk/models/passport.rb', line 132

def valid?
  return false if !@mrz1.nil? && @mrz1.to_s.length > 200
  return false if !@mrz1.nil? && @mrz1.to_s.length < 0
  return false if !@mrz2.nil? && @mrz2.to_s.length > 200
  return false if !@mrz2.nil? && @mrz2.to_s.length < 0
  true
end