Class: VericredClient::State

Inherits:
Object
  • Object
show all
Defined in:
lib/vericred_client/models/state.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ State

Initializes the object

Parameters:

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

    Model attributes in the form of hash



278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
# File 'lib/vericred_client/models/state.rb', line 278

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'name')
    self.name = attributes[:'name']
  end

  if attributes.has_key?(:'code')
    self.code = attributes[:'code']
  end

  if attributes.has_key?(:'fips_number')
    self.fips_number = attributes[:'fips_number']
  end

  if attributes.has_key?(:'last_date_for_individual')
    self.last_date_for_individual = attributes[:'last_date_for_individual']
  end

  if attributes.has_key?(:'last_date_for_shop')
    self.last_date_for_shop = attributes[:'last_date_for_shop']
  end

  if attributes.has_key?(:'live_for_business')
    self.live_for_business = attributes[:'live_for_business']
  end

  if attributes.has_key?(:'live_for_consumers')
    self.live_for_consumers = attributes[:'live_for_consumers']
  end

end

Instance Attribute Details

#codeObject

2 letter code for state



230
231
232
# File 'lib/vericred_client/models/state.rb', line 230

def code
  @code
end

#fips_numberObject

National FIPs number



233
234
235
# File 'lib/vericred_client/models/state.rb', line 233

def fips_number
  @fips_number
end

#idObject

Primary Key of State



224
225
226
# File 'lib/vericred_client/models/state.rb', line 224

def id
  @id
end

#last_date_for_individualObject

Last date this state is live for individuals



236
237
238
# File 'lib/vericred_client/models/state.rb', line 236

def last_date_for_individual
  @last_date_for_individual
end

#last_date_for_shopObject

Last date this state is live for shop



239
240
241
# File 'lib/vericred_client/models/state.rb', line 239

def last_date_for_shop
  @last_date_for_shop
end

#live_for_businessObject

Is this State available for businesses



242
243
244
# File 'lib/vericred_client/models/state.rb', line 242

def live_for_business
  @live_for_business
end

#live_for_consumersObject

Is this State available for individuals



245
246
247
# File 'lib/vericred_client/models/state.rb', line 245

def live_for_consumers
  @live_for_consumers
end

#nameObject

Name of state



227
228
229
# File 'lib/vericred_client/models/state.rb', line 227

def name
  @name
end

Class Method Details

.attribute_mapObject

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



249
250
251
252
253
254
255
256
257
258
259
260
# File 'lib/vericred_client/models/state.rb', line 249

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'code' => :'code',
    :'fips_number' => :'fips_number',
    :'last_date_for_individual' => :'last_date_for_individual',
    :'last_date_for_shop' => :'last_date_for_shop',
    :'live_for_business' => :'live_for_business',
    :'live_for_consumers' => :'live_for_consumers'
  }
end

.swagger_typesObject

Attribute type mapping.



263
264
265
266
267
268
269
270
271
272
273
274
# File 'lib/vericred_client/models/state.rb', line 263

def self.swagger_types
  {
    :'id' => :'Integer',
    :'name' => :'String',
    :'code' => :'String',
    :'fips_number' => :'String',
    :'last_date_for_individual' => :'Date',
    :'last_date_for_shop' => :'Date',
    :'live_for_business' => :'BOOLEAN',
    :'live_for_consumers' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



333
334
335
336
337
338
339
340
341
342
343
344
# File 'lib/vericred_client/models/state.rb', line 333

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      code == o.code &&
      fips_number == o.fips_number &&
      last_date_for_individual == o.last_date_for_individual &&
      last_date_for_shop == o.last_date_for_shop &&
      live_for_business == o.live_for_business &&
      live_for_consumers == o.live_for_consumers
end

#_deserialize(type, value) ⇒ Object

Deserializes the data based on type

Parameters:

  • string

    type Data type

  • string

    value Value to be deserialized

Returns:

  • (Object)

    Deserialized data



382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
# File 'lib/vericred_client/models/state.rb', line 382

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = VericredClient.const_get(type).new
    temp_model.build_from_hash(value)
  end
end

#_to_hash(value) ⇒ Hash

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



448
449
450
451
452
453
454
455
456
457
458
459
460
# File 'lib/vericred_client/models/state.rb', line 448

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

Builds the object from hash

Parameters:

  • attributes (Hash)

    Model attributes in the form of hash

Returns:

  • (Object)

    Returns the model itself



361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
# File 'lib/vericred_client/models/state.rb', line 361

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


348
349
350
# File 'lib/vericred_client/models/state.rb', line 348

def eql?(o)
  self == o
end

#hashFixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum)

    Hash code



354
355
356
# File 'lib/vericred_client/models/state.rb', line 354

def hash
  [id, name, code, fips_number, last_date_for_individual, last_date_for_shop, live_for_business, live_for_consumers].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properies with the reasons



320
321
322
323
# File 'lib/vericred_client/models/state.rb', line 320

def list_invalid_properties
  invalid_properties = Array.new
  return invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



428
429
430
# File 'lib/vericred_client/models/state.rb', line 428

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



434
435
436
437
438
439
440
441
442
# File 'lib/vericred_client/models/state.rb', line 434

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    hash[param] = _to_hash(value)
  end
  hash
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



422
423
424
# File 'lib/vericred_client/models/state.rb', line 422

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



327
328
329
# File 'lib/vericred_client/models/state.rb', line 327

def valid?
  return true
end