Class: TransferZero::AccountValidationRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/transferzero-sdk/models/account_validation_request.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ AccountValidationRequest

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
117
118
119
120
121
122
123
124
125
126
127
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 87

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

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

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

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

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

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

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

Instance Attribute Details

#bank_accountObject

Account Number to query



18
19
20
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 18

def 
  @bank_account
end

#bank_codeObject

Bank Code to query - same codes are used as for creating the transactions



21
22
23
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 21

def bank_code
  @bank_code
end

#countryObject

Country of account in 2-character alpha ISO 3166-2 country format



29
30
31
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 29

def country
  @country
end

#currencyObject

The currency the bank account is in



32
33
34
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 32

def currency
  @currency
end

#methodObject

The method of the payment. Currently bank and mobile are supported



35
36
37
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 35

def method
  @method
end

#mobile_providerObject

Returns the value of attribute mobile_provider.



26
27
28
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 26

def mobile_provider
  @mobile_provider
end

#phone_numberObject

Phone number to query



24
25
26
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 24

def phone_number
  @phone_number
end

Class Method Details

.attribute_mapObject

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



60
61
62
63
64
65
66
67
68
69
70
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 60

def self.attribute_map
  {
    :'bank_account' => :'bank_account',
    :'bank_code' => :'bank_code',
    :'phone_number' => :'phone_number',
    :'mobile_provider' => :'mobile_provider',
    :'country' => :'country',
    :'currency' => :'currency',
    :'method' => :'method'
  }
end

.openapi_typesObject

Attribute type mapping.



73
74
75
76
77
78
79
80
81
82
83
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 73

def self.openapi_types
  {
    :'bank_account' => :'String',
    :'bank_code' => :'String',
    :'phone_number' => :'String',
    :'mobile_provider' => :'PayoutMethodMobileProviderEnum',
    :'country' => :'String',
    :'currency' => :'String',
    :'method' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



195
196
197
198
199
200
201
202
203
204
205
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
       == o. &&
      bank_code == o.bank_code &&
      phone_number == o.phone_number &&
      mobile_provider == o.mobile_provider &&
      country == o.country &&
      currency == o.currency &&
      method == o.method
end

#[](key) ⇒ Object



307
308
309
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 307

def [](key)
  to_hash[key]
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



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
276
277
278
279
280
281
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 245

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 = TransferZero.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



319
320
321
322
323
324
325
326
327
328
329
330
331
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 319

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

Returns the model itself

Returns:

  • (Object)

    Returns the model itself



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 224

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_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

#dig(*args) ⇒ Object



311
312
313
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 311

def dig(*args)
  to_hash.dig(*args)
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object)

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


209
210
211
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 209

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



215
216
217
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 215

def hash
  [, bank_code, phone_number, mobile_provider, country, currency, method].hash
end

#list_invalid_propertiesObject

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

Returns:

  • Array for valid properties with the reasons



131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 131

def list_invalid_properties
  invalid_properties = Array.new
  if @country.nil?
    invalid_properties.push('invalid value for "country", country cannot be nil.')
  end

  if @currency.nil?
    invalid_properties.push('invalid value for "currency", currency cannot be nil.')
  end

  if @method.nil?
    invalid_properties.push('invalid value for "method", method cannot be nil.')
  end

  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



291
292
293
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 291

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



297
298
299
300
301
302
303
304
305
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 297

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
  ::ActiveSupport::HashWithIndifferentAccess.new(hash)
end

#to_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



285
286
287
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 285

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



150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/transferzero-sdk/models/account_validation_request.rb', line 150

def valid?
  return false if @country.nil?
  country_validator = EnumAttributeValidator.new('String', ["NG", "GH"])
  return false unless country_validator.valid?(@country)
  return false if @currency.nil?
  currency_validator = EnumAttributeValidator.new('String', ["NGN", "GHS"])
  return false unless currency_validator.valid?(@currency)
  return false if @method.nil?
  method_validator = EnumAttributeValidator.new('String', ["bank", "mobile"])
  return false unless method_validator.valid?(@method)
  true
end