class Trulioo::Location

Attributes

additional_fields[RW]
building_name[RW]

Name of building of home address

building_number[RW]

House / Civic / Building number of home address

city[RW]

City of home address

country[RW]

Country of physical address (ISO 3166-1 alpha-2)

county[RW]

County / District of home address

po_box[RW]

Post Office Box

postal_code[RW]

ZIP Code or Postal Code of home address

state_province_code[RW]

State of primary residence. US sources expect 2 characters. Australian sources expect 2 or 3 characters.

street_name[RW]

Street name of primary residence

street_type[RW]

Street type of primary residence (e.g. St, Rd etc)

suburb[RW]

Suburb / Subdivision / Municipality of home address

unit_number[RW]

Flat/Unit/Apartment number of home address

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/trulioo_sdk/models/location.rb, line 72
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/location.rb, line 53
def self.attribute_map
  {
    :'building_number' => :'BuildingNumber',
    :'building_name' => :'BuildingName',
    :'unit_number' => :'UnitNumber',
    :'street_name' => :'StreetName',
    :'street_type' => :'StreetType',
    :'city' => :'City',
    :'suburb' => :'Suburb',
    :'county' => :'County',
    :'state_province_code' => :'StateProvinceCode',
    :'country' => :'Country',
    :'postal_code' => :'PostalCode',
    :'po_box' => :'POBox',
    :'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/location.rb, line 218
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/location.rb, line 103
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `Trulioo::Location` 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::Location`. 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?(:'building_number')
    self.building_number = attributes[:'building_number']
  end

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

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'po_box')
    self.po_box = attributes[:'po_box']
  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/location.rb, line 96
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# File lib/trulioo_sdk/models/location.rb, line 77
def self.openapi_types
  {
    :'building_number' => :'String',
    :'building_name' => :'String',
    :'unit_number' => :'String',
    :'street_name' => :'String',
    :'street_type' => :'String',
    :'city' => :'String',
    :'suburb' => :'String',
    :'county' => :'String',
    :'state_province_code' => :'String',
    :'country' => :'String',
    :'postal_code' => :'String',
    :'po_box' => :'String',
    :'additional_fields' => :'LocationAdditionalFields'
  }
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/location.rb, line 184
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      building_number == o.building_number &&
      building_name == o.building_name &&
      unit_number == o.unit_number &&
      street_name == o.street_name &&
      street_type == o.street_type &&
      city == o.city &&
      suburb == o.suburb &&
      county == o.county &&
      state_province_code == o.state_province_code &&
      country == o.country &&
      postal_code == o.postal_code &&
      po_box == o.po_box &&
      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/location.rb, line 252
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/location.rb, line 331
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/location.rb, line 227
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/location.rb, line 204
def eql?(o)
  self == o
end
hash() click to toggle source

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

# File lib/trulioo_sdk/models/location.rb, line 210
def hash
  [building_number, building_name, unit_number, street_name, street_type, city, suburb, county, state_province_code, country, postal_code, po_box, additional_fields].hash
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/location.rb, line 171
def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
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/location.rb, line 303
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/location.rb, line 311
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/location.rb, line 295
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/location.rb, line 178
def valid?
  true
end