Class: CybridApiBank::CustomerAddressBankModel

Inherits:
Object
  • Object
show all
Defined in:
lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb

Overview

The customer’s address. Only available for GET operations when ‘include_pii’ is set.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ CustomerAddressBankModel

Initializes the object

Parameters:

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

    Model attributes in the form of hash



80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 80

def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `CybridApiBank::CustomerAddressBankModel` 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 `CybridApiBank::CustomerAddressBankModel`. 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?(:'street')
    self.street = attributes[:'street']
  end

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

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

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

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

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

Instance Attribute Details

#city ⇒ Object

The city of the address.



26
27
28
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 26

def city
  @city
end

#country_code ⇒ Object

The ISO 3166 country 2-Alpha country code of the address.



35
36
37
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 35

def country_code
  @country_code
end

#postal_code ⇒ Object

The postal/post/zip code of the address; not used by all countries.



32
33
34
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 32

def postal_code
  @postal_code
end

#street ⇒ Object

The first line of the address.



20
21
22
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 20

def street
  @street
end

#street2 ⇒ Object

The optional second line of the address.



23
24
25
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 23

def street2
  @street2
end

#subdivision ⇒ Object

The ISO 3166-2 subdivision code of the address; not used by all countries.



29
30
31
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 29

def subdivision
  @subdivision
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



50
51
52
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 50

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



38
39
40
41
42
43
44
45
46
47
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 38

def self.attribute_map
  {
    :'street' => :'street',
    :'street2' => :'street2',
    :'city' => :'city',
    :'subdivision' => :'subdivision',
    :'postal_code' => :'postal_code',
    :'country_code' => :'country_code'
  }
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



159
160
161
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 159

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



67
68
69
70
71
72
73
74
75
76
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 67

def self.openapi_nullable
  Set.new([
    :'street',
    :'street2',
    :'city',
    :'subdivision',
    :'postal_code',
    :'country_code'
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 55

def self.openapi_types
  {
    :'street' => :'String',
    :'street2' => :'String',
    :'city' => :'String',
    :'subdivision' => :'String',
    :'postal_code' => :'String',
    :'country_code' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



133
134
135
136
137
138
139
140
141
142
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 133

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      street == o.street &&
      street2 == o.street2 &&
      city == o.city &&
      subdivision == o.subdivision &&
      postal_code == o.postal_code &&
      country_code == o.country_code
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



190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 190

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 = CybridApiBank.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



261
262
263
264
265
266
267
268
269
270
271
272
273
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 261

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



166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 166

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


146
147
148
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 146

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



152
153
154
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 152

def hash
  [street, street2, city, subdivision, postal_code, country_code].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



120
121
122
123
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  invalid_properties
end

#to_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



237
238
239
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 237

def to_body
  to_hash
end

#to_hash ⇒ Hash

Returns the object in the form of hash

Returns:

  • (Hash) —

    Returns the object in the form of hash



243
244
245
246
247
248
249
250
251
252
253
254
255
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 243

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

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



231
232
233
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 231

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



127
128
129
 
# File 'lib/cybrid_api_bank_ruby/models/customer_address_bank_model.rb', line 127

def valid?
  true
end