Class: TransferZero::PayoutMethodDetailsKESBank

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

Overview

“‘JSON "details": { "first_name": "First", "last_name": "Last", "street": "Main Street", "city": "Nairobi", "bank_code": "68", "bank_account": "12345678", "transfer_reason": "personal_account", // New transfer reason field "identity_card_type": "ID", // refers to the recipient’s ID details; Values: "PP": Passport, "ID": National ID or "O": Other "identity_card_id": "AB12345678", // refers to the recipient’s ID details "relationship_to_sender": "Relative" // Optional } “‘ The valid bank_code values are: - Absa Bank: 03 - African Banking Corporation: 35 - Bank of Africa Kenya: 19 - Citibank: 16 - Co-operative Bank of Kenya: 11 - Consolidated Bank of Kenya: 23 - Credit Bank Ltd: 25 - Diamond Trust Bank: 63 - DIB Bank: 75 - ECO Bank Kenya: 43 - Equity Bank Limited: 68 - Family Bank: 70 - First Community Bank: 74 - Guaranty Trust Bank Kenya: 53 - Guardian Bank: 55 - Gulf African Bank : 72 - Housing Finance Co. Kenya: 61 - I&M Bank: 57 - Kingdom Bank: 51 - Kenya Commercial Bank: 01 - KWFT Bank: 78 - Mayfair Bank: 65 - M-Oriental Commercial Bank Limited: 14 - Middle East Bank: 18 - National Bank of Kenya: 12 - NCBA Bank: 07 - Paramount Universal Bank Limited: 50 - Prime Bank: 10 - Sidian Bank: 66 - Stanbic Bank Kenya: 31 - Standard Chartered Bank: 02 - UBA Kenya Bank Ltd: 76 - Victoria Bank Limited: 54 See [KES Bank](docs.transferzero.com/docs/payout-details/#kesbank) documentation for the transfer_reason list

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayoutMethodDetailsKESBank

Initializes the object

Parameters:

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

    Model attributes in the form of hash



72
73
74
75
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
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 72

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_account ⇒ Object

Returns the value of attribute bank_account.



28
29
30
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 28

def 
  @bank_account
end

#bank_code ⇒ Object

Returns the value of attribute bank_code.



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

def bank_code
  @bank_code
end

#city ⇒ Object

Returns the value of attribute city.



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

def city
  @city
end

#first_name ⇒ Object

Returns the value of attribute first_name.



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

def first_name
  @first_name
end

#identity_card_id ⇒ Object

Returns the value of attribute identity_card_id.



34
35
36
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 34

def identity_card_id
  @identity_card_id
end

#identity_card_type ⇒ Object

Returns the value of attribute identity_card_type.



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

def identity_card_type
  @identity_card_type
end

#last_name ⇒ Object

Returns the value of attribute last_name.



20
21
22
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 20

def last_name
  @last_name
end

#relationship_to_sender ⇒ Object

Returns the value of attribute relationship_to_sender.



36
37
38
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 36

def relationship_to_sender
  @relationship_to_sender
end

#street ⇒ Object

Returns the value of attribute street.



22
23
24
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 22

def street
  @street
end

#transfer_reason ⇒ Object

Returns the value of attribute transfer_reason.



30
31
32
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 30

def transfer_reason
  @transfer_reason
end

Class Method Details

.attribute_map ⇒ Object

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



39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 39

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'street' => :'street',
    :'city' => :'city',
    :'bank_code' => :'bank_code',
    :'bank_account' => :'bank_account',
    :'transfer_reason' => :'transfer_reason',
    :'identity_card_type' => :'identity_card_type',
    :'identity_card_id' => :'identity_card_id',
    :'relationship_to_sender' => :'relationship_to_sender'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 55

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'street' => :'String',
    :'city' => :'String',
    :'bank_code' => :'String',
    :'bank_account' => :'String',
    :'transfer_reason' => :'PayoutMethodTransferReasonEnum',
    :'identity_card_type' => :'PayoutMethodIdentityCardTypeEnum',
    :'identity_card_id' => :'String',
    :'relationship_to_sender' => :'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
191
192
193
194
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 181

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      street == o.street &&
      city == o.city &&
      bank_code == o.bank_code &&
       == o. &&
      transfer_reason == o.transfer_reason &&
      identity_card_type == o.identity_card_type &&
      identity_card_id == o.identity_card_id &&
      relationship_to_sender == o.relationship_to_sender
end

#[](key) ⇒ Object 



296
297
298
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 296

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



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
266
267
268
269
270
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 234

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 308

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



213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 213

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 



300
301
302
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 300

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


198
199
200
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 198

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



204
205
206
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 204

def hash
  [first_name, last_name, street, city, bank_code, , transfer_reason, identity_card_type, identity_card_id, relationship_to_sender].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



128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 128

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

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

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

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

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

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

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

  if @identity_card_id.nil?
    invalid_properties.push('invalid value for "identity_card_id", identity_card_id 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



280
281
282
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 280

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



286
287
288
289
290
291
292
293
294
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 286

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



274
275
276
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 274

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



167
168
169
170
171
172
173
174
175
176
177
 
# File 'lib/transferzero-sdk/models/payout_method_details_kes_bank.rb', line 167

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @street.nil?
  return false if @bank_code.nil?
  return false if @bank_account.nil?
  return false if @transfer_reason.nil?
  return false if @identity_card_type.nil?
  return false if @identity_card_id.nil?
  true
end