class Trulioo::PersonInfo

Personal Information

Attributes

additional_fields[RW]
day_of_birth[RW]

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

first_given_name[RW]

First name of the individual to be verified

first_sur_name[RW]

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

gender[RW]

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

iso_latin1_name[RW]

Enter full name in ISO Latin-1 character set

middle_name[RW]

Second given name of the individual to be verified

minimum_age[RW]

Minimum permitted age of the individual

month_of_birth[RW]

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

second_surname[RW]

second family name of the individual to be verified

year_of_birth[RW]

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

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/trulioo_sdk/models/person_info.rb, line 65
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# 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) click to toggle source

:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/trulioo_sdk/models/person_info.rb, line 319
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/trulioo_sdk/models/person_info.rb, line 87
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

:nocov: Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

:nocov: Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

:nocov: Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/trulioo_sdk/models/person_info.rb, line 305
def eql?(o)
  self == o
end
first_given_name=(first_given_name) click to toggle source

Custom attribute writer method with validation @param [Object] first_given_name Value to be assigned

# File lib/trulioo_sdk/models/person_info.rb, line 217
def first_given_name=(first_given_name)
  if !first_given_name.nil? && first_given_name.to_s.length > 200
    fail ArgumentError, '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
    fail ArgumentError, 'invalid value for "first_given_name", the character length must be great than or equal to 0.'
  end

  @first_given_name = first_given_name
end
first_sur_name=(first_sur_name) click to toggle source

Custom attribute writer method with validation @param [Object] first_sur_name Value to be assigned

# File lib/trulioo_sdk/models/person_info.rb, line 245
def first_sur_name=(first_sur_name)
  if !first_sur_name.nil? && first_sur_name.to_s.length > 200
    fail ArgumentError, '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
    fail ArgumentError, 'invalid value for "first_sur_name", the character length must be great than or equal to 0.'
  end

  @first_sur_name = first_sur_name
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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
iso_latin1_name=(iso_latin1_name) click to toggle source

Custom attribute writer method with validation @param [Object] iso_latin1_name Value to be assigned

# File lib/trulioo_sdk/models/person_info.rb, line 273
def iso_latin1_name=(iso_latin1_name)
  if !iso_latin1_name.nil? && iso_latin1_name.to_s.length > 200
    fail ArgumentError, '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
    fail ArgumentError, 'invalid value for "iso_latin1_name", the character length must be great than or equal to 0.'
  end

  @iso_latin1_name = iso_latin1_name
end
list_invalid_properties() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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
middle_name=(middle_name) click to toggle source

Custom attribute writer method with validation @param [Object] middle_name Value to be assigned

# File lib/trulioo_sdk/models/person_info.rb, line 231
def middle_name=(middle_name)
  if !middle_name.nil? && middle_name.to_s.length > 200
    fail ArgumentError, '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
    fail ArgumentError, 'invalid value for "middle_name", the character length must be great than or equal to 0.'
  end

  @middle_name = middle_name
end
second_surname=(second_surname) click to toggle source

Custom attribute writer method with validation @param [Object] second_surname Value to be assigned

# File lib/trulioo_sdk/models/person_info.rb, line 259
def second_surname=(second_surname)
  if !second_surname.nil? && second_surname.to_s.length > 200
    fail ArgumentError, '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
    fail ArgumentError, 'invalid value for "second_surname", the character length must be great than or equal to 0.'
  end

  @second_surname = second_surname
end
to_body() click to toggle source

:nocov: to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/trulioo_sdk/models/person_info.rb, line 404
def to_body
  to_hash
end
to_hash() click to toggle source

:nocov: Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

:nocov: Returns the string representation of the object @return [String] String presentation of the object

# File lib/trulioo_sdk/models/person_info.rb, line 396
def to_s
  to_hash.to_s
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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