Class: Trulioo::Location

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Location

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
 
# 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

Instance Attribute Details

#additional_fields ⇒ Object

Returns the value of attribute additional_fields.



50
51
52
 
# File 'lib/trulioo_sdk/models/location.rb', line 50

def additional_fields
  @additional_fields
end

#building_name ⇒ Object

Name of building of home address



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

def building_name
  @building_name
end

#building_number ⇒ Object

House / Civic / Building number of home address



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

def building_number
  @building_number
end

#city ⇒ Object

City of home address



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

def city
  @city
end

#country ⇒ Object

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



42
43
44
 
# File 'lib/trulioo_sdk/models/location.rb', line 42

def country
  @country
end

#county ⇒ Object

County / District of home address



36
37
38
 
# File 'lib/trulioo_sdk/models/location.rb', line 36

def county
  @county
end

#po_box ⇒ Object

Post Office Box



48
49
50
 
# File 'lib/trulioo_sdk/models/location.rb', line 48

def po_box
  @po_box
end

#postal_code ⇒ Object

ZIP Code or Postal Code of home address



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

def postal_code
  @postal_code
end

#state_province_code ⇒ Object

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



39
40
41
 
# File 'lib/trulioo_sdk/models/location.rb', line 39

def state_province_code
  @state_province_code
end

#street_name ⇒ Object

Street name of primary residence



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

def street_name
  @street_name
end

#street_type ⇒ Object

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



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

def street_type
  @street_type
end

#suburb ⇒ Object

Suburb / Subdivision / Municipality of home address



33
34
35
 
# File 'lib/trulioo_sdk/models/location.rb', line 33

def suburb
  @suburb
end

#unit_number ⇒ Object

Flat/Unit/Apartment number of home address



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

def unit_number
  @unit_number
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



72
73
74
 
# File 'lib/trulioo_sdk/models/location.rb', line 72

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
 
# 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) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



218
219
220
 
# File 'lib/trulioo_sdk/models/location.rb', line 218

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



96
97
98
99
 
# File 'lib/trulioo_sdk/models/location.rb', line 96

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

.openapi_types ⇒ Object

Attribute type mapping.



77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
 
# 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) ⇒ Object

:nocov: Deserializes the data based on type

Parameters:

  • string —

    type Data type

  • string —

    value Value to be deserialized

Returns:

  • (Object) —

    Deserialized data



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
 
# 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) ⇒ 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



331
332
333
334
335
336
337
338
339
340
341
342
343
 
# 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) ⇒ Object

:nocov: Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
 
# 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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


204
205
206
 
# File 'lib/trulioo_sdk/models/location.rb', line 204

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



210
211
212
 
# 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 ⇒ Object

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



171
172
173
174
 
# File 'lib/trulioo_sdk/models/location.rb', line 171

def list_invalid_properties
  invalid_properties = Array.new
  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



303
304
305
 
# File 'lib/trulioo_sdk/models/location.rb', line 303

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



311
312
313
314
315
316
317
318
319
320
321
322
323
 
# 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 ⇒ String

:nocov: Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



295
296
297
 
# File 'lib/trulioo_sdk/models/location.rb', line 295

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



178
179
180
 
# File 'lib/trulioo_sdk/models/location.rb', line 178

def valid?
  true
end