Class: ThePlaidApi::AddressDataNullable

Inherits:
BaseModel
  • Object
show all
Defined in:
lib/the_plaid_api/models/address_data_nullable.rb

Overview

Data about the components comprising an address.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from BaseModel

#check_for_conflict, #process_additional_properties, #process_array, #process_basic_value, #process_hash, #to_hash, #to_json

Constructor Details

#initialize(city:, region:, street:, postal_code:, country:, additional_properties: nil) ⇒ AddressDataNullable

Returns a new instance of AddressDataNullable.



62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 62

def initialize(city:, region:, street:, postal_code:, country:,
               additional_properties: nil)
  # Add additional model properties to the instance
  additional_properties = {} if additional_properties.nil?

  @city = city
  @region = region
  @street = street
  @postal_code = postal_code
  @country = country
  @additional_properties = additional_properties
end

Instance Attribute Details

#city ⇒ String

The full city name

Returns:

  • (String) 


14
15
16
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 14

def city
  @city
end

#country ⇒ String

The ISO 3166-1 alpha-2 country code

Returns:

  • (String) 


34
35
36
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 34

def country
  @country
end

#postal_code ⇒ String

The postal code. In API versions 2018-05-22 and earlier, this field is called ‘zip`.

Returns:

  • (String) 


30
31
32
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 30

def postal_code
  @postal_code
end

#region ⇒ String

The region or state. In API versions 2018-05-22 and earlier, this field is called ‘state`. Example: `“NC”`

Returns:

  • (String) 


20
21
22
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 20

def region
  @region
end

#street ⇒ String

The full street address Example: ‘“564 Main Street, APT 15”`

Returns:

  • (String) 


25
26
27
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 25

def street
  @street
end

Class Method Details

.from_hash(hash) ⇒ Object

Creates an instance of the object from a hash.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 76

def self.from_hash(hash)
  return nil unless hash

  # Extract variables from the hash.
  city = hash.key?('city') ? hash['city'] : nil
  region = hash.key?('region') ? hash['region'] : nil
  street = hash.key?('street') ? hash['street'] : nil
  postal_code = hash.key?('postal_code') ? hash['postal_code'] : nil
  country = hash.key?('country') ? hash['country'] : nil

  # Create a new hash for additional properties, removing known properties.
  new_hash = hash.reject { |k, _| names.value?(k) }

  additional_properties = APIHelper.get_additional_properties(
    new_hash, proc { |value| value }
  )

  # Create object from extracted values.
  AddressDataNullable.new(city: city,
                          region: region,
                          street: street,
                          postal_code: postal_code,
                          country: country,
                          additional_properties: additional_properties)
end

.names ⇒ Object

A mapping from model property names to API property names.



37
38
39
40
41
42
43
44
45
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 37

def self.names
  @_hash = {} if @_hash.nil?
  @_hash['city'] = 'city'
  @_hash['region'] = 'region'
  @_hash['street'] = 'street'
  @_hash['postal_code'] = 'postal_code'
  @_hash['country'] = 'country'
  @_hash
end

.nullables ⇒ Object

An array for nullable fields



53
54
55
56
57
58
59
60
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 53

def self.nullables
  %w[
    city
    region
    postal_code
    country
  ]
end

.optionals ⇒ Object

An array for optional fields



48
49
50
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 48

def self.optionals
  []
end

Instance Method Details

#inspect ⇒ Object

Provides a debugging-friendly string with detailed object information.



110
111
112
113
114
115
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 110

def inspect
  class_name = self.class.name.split('::').last
  "<#{class_name} city: #{@city.inspect}, region: #{@region.inspect}, street:"\
  " #{@street.inspect}, postal_code: #{@postal_code.inspect}, country: #{@country.inspect},"\
  " additional_properties: #{@additional_properties}>"
end

#to_s ⇒ Object

Provides a human-readable string representation of the object.



103
104
105
106
107
 
# File 'lib/the_plaid_api/models/address_data_nullable.rb', line 103

def to_s
  class_name = self.class.name.split('::').last
  "<#{class_name} city: #{@city}, region: #{@region}, street: #{@street}, postal_code:"\
  " #{@postal_code}, country: #{@country}, additional_properties: #{@additional_properties}>"
end