Class: CybridApiBank::PostExternalBankAccountCounterpartyAddressBankModel

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

Overview

The counterparty’s address on their checking account. Required when account_kind is raw_routing_details and counterparty_guid is not present.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PostExternalBankAccountCounterpartyAddressBankModel

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/post_external_bank_account_counterparty_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::PostExternalBankAccountCounterpartyAddressBankModel` 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::PostExternalBankAccountCounterpartyAddressBankModel`. 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. Required when account_kind is raw_routing_details and counterparty_guid is not present.



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

def city
  @city
end

#country_code ⇒ Object

The ISO 3166 country 2-Alpha country code of the address. Required when account_kind is raw_routing_details and counterparty_guid is not present.



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

def country_code
  @country_code
end

#postal_code ⇒ Object

The postal, zip or post code of the address. Applicable only for countries that use postal, zip or post codes. Optional when account_kind is raw_routing_details and counterparty_guid is not present.



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

def postal_code
  @postal_code
end

#street ⇒ Object

The first line of the address. Required when account_kind is raw_routing_details and counterparty_guid is not present.



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

def street
  @street
end

#street2 ⇒ Object

The optional second line of the address. Optional when account_kind is raw_routing_details and counterparty_guid is not present.



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

def street2
  @street2
end

#subdivision ⇒ Object

The ISO 3166-2 subdivision code of the address. Applicable only for countries that use subnational states, provinces, lands, oblasts or regions. Optional when account_kind is raw_routing_details and counterparty_guid is not present.



29
30
31
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_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/post_external_bank_account_counterparty_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/post_external_bank_account_counterparty_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



207
208
209
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 207

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/post_external_bank_account_counterparty_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/post_external_bank_account_counterparty_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



181
182
183
184
185
186
187
188
189
190
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 181

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



238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 238

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



309
310
311
312
313
314
315
316
317
318
319
320
321
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 309

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



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 214

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


194
195
196
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 194

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



200
201
202
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 200

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
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 120

def list_invalid_properties
  invalid_properties = Array.new
  if !@subdivision.nil? && @subdivision.to_s.length > 3
    invalid_properties.push('invalid value for "subdivision", the character length must be smaller than or equal to 3.')
  end

  if !@subdivision.nil? && @subdivision.to_s.length < 1
    invalid_properties.push('invalid value for "subdivision", the character length must be great than or equal to 1.')
  end

  if !@country_code.nil? && @country_code.to_s.length > 2
    invalid_properties.push('invalid value for "country_code", the character length must be smaller than or equal to 2.')
  end

  if !@country_code.nil? && @country_code.to_s.length < 2
    invalid_properties.push('invalid value for "country_code", the character length must be great than or equal to 2.')
  end

  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



285
286
287
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 285

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



291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 291

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



279
280
281
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 279

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



143
144
145
146
147
148
149
 
# File 'lib/cybrid_api_bank_ruby/models/post_external_bank_account_counterparty_address_bank_model.rb', line 143

def valid?
  return false if !@subdivision.nil? && @subdivision.to_s.length > 3
  return false if !@subdivision.nil? && @subdivision.to_s.length < 1
  return false if !@country_code.nil? && @country_code.to_s.length > 2
  return false if !@country_code.nil? && @country_code.to_s.length < 2
  true
end