Class: Bitpesa::AccountValidationRequest

Inherits:
Object
  • Object
show all
Defined in:
lib/bitpesa-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



78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 78

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?(:'bank_account')
    self. = attributes[:'bank_account']
  end

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

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

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

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

Instance Attribute Details

#bank_account ⇒ Object

Account Number to query



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

def 
  @bank_account
end

#bank_code ⇒ Object

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



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

def bank_code
  @bank_code
end

#country ⇒ Object

Country of account in 2-character alpha ISO 3166-2 country format (only NG is currently supported)



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

def country
  @country
end

#currency ⇒ Object

The currency the bank account is in



27
28
29
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 27

def currency
  @currency
end

#method ⇒ Object

The method of the payment. Currently only bank is supported



30
31
32
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 30

def method
  @method
end

Class Method Details

.attribute_map ⇒ Object

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



55
56
57
58
59
60
61
62
63
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 55

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

.openapi_types ⇒ Object

Attribute type mapping.



66
67
68
69
70
71
72
73
74
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 66

def self.openapi_types
  {
    :'bank_account' => :'String',
    :'bank_code' => :'String',
    :'country' => :'String',
    :'currency' => :'String',
    :'method' => :'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
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 181

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

#[](key) ⇒ Object 



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

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



229
230
231
232
233
234
235
236
237
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
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 229

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



303
304
305
306
307
308
309
310
311
312
313
314
315
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 303

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



208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 208

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 



295
296
297
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 295

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


193
194
195
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 193

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



199
200
201
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 199

def hash
  [, bank_code, country, currency, method].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



107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 107

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

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

  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_body ⇒ Hash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash) —

    Returns the object in the form of hash



275
276
277
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 275

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



281
282
283
284
285
286
287
288
289
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 281

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_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



269
270
271
 
# File 'lib/bitpesa-sdk/models/account_validation_request.rb', line 269

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



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

def valid?
  return false if @bank_account.nil?
  return false if @bank_code.nil?
  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'])
  return false unless method_validator.valid?(@method)
  true
end