Class: Trulioo::PersonInfo

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

Overview

Personal Information

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PersonInfo

Initializes the object

Parameters:

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

    Model attributes in the form of hash



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
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
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 94

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#additional_fields ⇒ Object

Returns the value of attribute additional_fields.



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

def additional_fields
  @additional_fields
end

#day_of_birth ⇒ Object

Day of birth date (e.g. 23 for a date of birth of 23/11/1975)



31
32
33
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 31

def day_of_birth
  @day_of_birth
end

#first_given_name ⇒ Object

First name of the individual to be verified



16
17
18
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 16

def first_given_name
  @first_given_name
end

#first_sur_name ⇒ Object

First (paternal) family name of the individual to be verified



22
23
24
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 22

def first_sur_name
  @first_sur_name
end

#gender ⇒ Object

Single character M / F (M = Male, F = Female)



43
44
45
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 43

def gender
  @gender
end

#iso_latin1_name ⇒ Object

Enter full name in ISO Latin-1 character set



28
29
30
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 28

def iso_latin1_name
  @iso_latin1_name
end

#middle_name ⇒ Object

Second given name of the individual to be verified



19
20
21
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 19

def middle_name
  @middle_name
end

#minimum_age ⇒ Object

Minimum permitted age of the individual



40
41
42
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 40

def minimum_age
  @minimum_age
end

#month_of_birth ⇒ Object

Month of birth date (e.g. 11 for a date of birth of 23/11/1975)



34
35
36
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 34

def month_of_birth
  @month_of_birth
end

#second_surname ⇒ Object

second family name of the individual to be verified



25
26
27
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 25

def second_surname
  @second_surname
end

#year_of_birth ⇒ Object

Year of birth date (e.g. 1975 for a date of birth of 23/11/1975)



37
38
39
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 37

def year_of_birth
  @year_of_birth
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



65
66
67
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 65

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 48

def self.attribute_map
  {
    :'first_given_name' => :'FirstGivenName',
    :'middle_name' => :'MiddleName',
    :'first_sur_name' => :'FirstSurName',
    :'second_surname' => :'SecondSurname',
    :'iso_latin1_name' => :'ISOLatin1Name',
    :'day_of_birth' => :'DayOfBirth',
    :'month_of_birth' => :'MonthOfBirth',
    :'year_of_birth' => :'YearOfBirth',
    :'minimum_age' => :'MinimumAge',
    :'gender' => :'Gender',
    :'additional_fields' => :'AdditionalFields'
  }
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



319
320
321
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 319

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



87
88
89
90
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 87

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

.openapi_types ⇒ Object

Attribute type mapping.



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 70

def self.openapi_types
  {
    :'first_given_name' => :'String',
    :'middle_name' => :'String',
    :'first_sur_name' => :'String',
    :'second_surname' => :'String',
    :'iso_latin1_name' => :'String',
    :'day_of_birth' => :'Integer',
    :'month_of_birth' => :'Integer',
    :'year_of_birth' => :'Integer',
    :'minimum_age' => :'Integer',
    :'gender' => :'String',
    :'additional_fields' => :'PersonInfoAdditionalFields'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 287

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_given_name == o.first_given_name &&
      middle_name == o.middle_name &&
      first_sur_name == o.first_sur_name &&
      second_surname == o.second_surname &&
      iso_latin1_name == o.iso_latin1_name &&
      day_of_birth == o.day_of_birth &&
      month_of_birth == o.month_of_birth &&
      year_of_birth == o.year_of_birth &&
      minimum_age == o.minimum_age &&
      gender == o.gender &&
      additional_fields == o.additional_fields
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



353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 353

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



432
433
434
435
436
437
438
439
440
441
442
443
444
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 432

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



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 328

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


305
306
307
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 305

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



311
312
313
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 311

def hash
  [first_given_name, middle_name, first_sur_name, second_surname, iso_latin1_name, day_of_birth, month_of_birth, year_of_birth, minimum_age, gender, additional_fields].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



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

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

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

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

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

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

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

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

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

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

  if !@iso_latin1_name.nil? && @iso_latin1_name.to_s.length < 0
    invalid_properties.push('invalid value for "iso_latin1_name", 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



404
405
406
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 404

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



412
413
414
415
416
417
418
419
420
421
422
423
424
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 412

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



396
397
398
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 396

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



201
202
203
204
205
206
207
208
209
210
211
212
213
 
# File 'lib/trulioo_sdk/models/person_info.rb', line 201

def valid?
  return false if !@first_given_name.nil? && @first_given_name.to_s.length > 200
  return false if !@first_given_name.nil? && @first_given_name.to_s.length < 0
  return false if !@middle_name.nil? && @middle_name.to_s.length > 200
  return false if !@middle_name.nil? && @middle_name.to_s.length < 0
  return false if !@first_sur_name.nil? && @first_sur_name.to_s.length > 200
  return false if !@first_sur_name.nil? && @first_sur_name.to_s.length < 0
  return false if !@second_surname.nil? && @second_surname.to_s.length > 200
  return false if !@second_surname.nil? && @second_surname.to_s.length < 0
  return false if !@iso_latin1_name.nil? && @iso_latin1_name.to_s.length > 200
  return false if !@iso_latin1_name.nil? && @iso_latin1_name.to_s.length < 0
  true
end