Class: TransferZero::PayoutMethodDetailsZARBank

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

Overview

“‘JSON "details": { "first_name": "First", // Mandatory for personal payouts; "last_name": "Last", // Mandatory for personal payouts; "name" "First Ltd", // Mandatory for business payouts; "contact_first_name" "Business", "contact_last_name" "Contact", "street": "Main Street", "postal_code": "AB0001", "city": "Cape Town", "email": "[email protected]", "bank_name" ’Bank Zero’, // Optional "bank_code": "334810", // Optional; Required if branch_code is empty "branch_code": "630067", // Optional; Required if bank_code is empty "bank_account": "12345678", "phone_number": "+27119785313", // E.164 international format "transfer_reason": "personal_account", // New transfer reason field "narration": "Birthday Gift", // Optional "legal_entity_type": "sole_proprietorship", // Optional; Default value is "person"; "nature_of_business": "mining", // Optional for business payouts; "registration_number": "17364BGC" // Optional for business payouts; } “‘ See [ZAR Bank](docs.transferzero.com/docs/payout-details/#zarbank) documentation for the bank_code and transfer_reason lists

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PayoutMethodDetailsZARBank

Initializes the object

Parameters:

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

    Model attributes in the form of hash



113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
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
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 113

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#bank_account ⇒ Object

Returns the value of attribute bank_account.



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

def 
  @bank_account
end

#bank_code ⇒ Object

Returns the value of attribute bank_code.



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

def bank_code
  @bank_code
end

#birth_date ⇒ Object

Date of birth of recipient



57
58
59
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 57

def birth_date
  @birth_date
end

#branch_code ⇒ Object

Returns the value of attribute branch_code.



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

def branch_code
  @branch_code
end

#city ⇒ Object

Returns the value of attribute city.



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

def city
  @city
end

#contact_first_name ⇒ Object

Returns the value of attribute contact_first_name.



46
47
48
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 46

def contact_first_name
  @contact_first_name
end

#contact_last_name ⇒ Object

Returns the value of attribute contact_last_name.



48
49
50
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 48

def contact_last_name
  @contact_last_name
end

#email ⇒ Object

Returns the value of attribute email.



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

def email
  @email
end

#first_name ⇒ Object

Returns the value of attribute first_name.



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

def first_name
  @first_name
end

#last_name ⇒ Object

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#legal_entity_type ⇒ Object

Returns the value of attribute legal_entity_type.



54
55
56
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 54

def legal_entity_type
  @legal_entity_type
end

#name ⇒ Object

Returns the value of attribute name.



44
45
46
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 44

def name
  @name
end

#narration ⇒ Object

Returns the value of attribute narration.



42
43
44
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 42

def narration
  @narration
end

#nature_of_business ⇒ Object

Returns the value of attribute nature_of_business.



52
53
54
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 52

def nature_of_business
  @nature_of_business
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



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

def phone_number
  @phone_number
end

#postal_code ⇒ Object

Returns the value of attribute postal_code.



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

def postal_code
  @postal_code
end

#registration_number ⇒ Object

Returns the value of attribute registration_number.



50
51
52
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 50

def registration_number
  @registration_number
end

#street ⇒ Object

Returns the value of attribute street.



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

def street
  @street
end

#transfer_reason ⇒ Object

Returns the value of attribute transfer_reason.



40
41
42
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 40

def transfer_reason
  @transfer_reason
end

#transfer_reason_code ⇒ Object

Returns the value of attribute transfer_reason_code.



38
39
40
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 38

def transfer_reason_code
  @transfer_reason_code
end

Class Method Details

.attribute_map ⇒ Object

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



60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 60

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'street' => :'street',
    :'postal_code' => :'postal_code',
    :'city' => :'city',
    :'email' => :'email',
    :'bank_code' => :'bank_code',
    :'branch_code' => :'branch_code',
    :'bank_account' => :'bank_account',
    :'phone_number' => :'phone_number',
    :'transfer_reason_code' => :'transfer_reason_code',
    :'transfer_reason' => :'transfer_reason',
    :'narration' => :'narration',
    :'name' => :'name',
    :'contact_first_name' => :'contact_first_name',
    :'contact_last_name' => :'contact_last_name',
    :'registration_number' => :'registration_number',
    :'nature_of_business' => :'nature_of_business',
    :'legal_entity_type' => :'legal_entity_type',
    :'birth_date' => :'birth_date'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 86

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'street' => :'String',
    :'postal_code' => :'String',
    :'city' => :'String',
    :'email' => :'String',
    :'bank_code' => :'String',
    :'branch_code' => :'String',
    :'bank_account' => :'String',
    :'phone_number' => :'String',
    :'transfer_reason_code' => :'String',
    :'transfer_reason' => :'PayoutMethodTransferReasonEnum',
    :'narration' => :'String',
    :'name' => :'String',
    :'contact_first_name' => :'String',
    :'contact_last_name' => :'String',
    :'registration_number' => :'String',
    :'nature_of_business' => :'PayoutMethodNatureOfBusinessEnum',
    :'legal_entity_type' => :'PayoutMethodLegalEntityTypeEnum',
    :'birth_date' => :'Date'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 242

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 &&
      postal_code == o.postal_code &&
      city == o.city &&
      email == o.email &&
      bank_code == o.bank_code &&
      branch_code == o.branch_code &&
       == o. &&
      phone_number == o.phone_number &&
      transfer_reason_code == o.transfer_reason_code &&
      transfer_reason == o.transfer_reason &&
      narration == o.narration &&
      name == o.name &&
      contact_first_name == o.contact_first_name &&
      contact_last_name == o.contact_last_name &&
      registration_number == o.registration_number &&
      nature_of_business == o.nature_of_business &&
      legal_entity_type == o.legal_entity_type &&
      birth_date == o.birth_date
end

#[](key) ⇒ Object 



367
368
369
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 367

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



305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 305

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 379

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



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 284

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 



371
372
373
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 371

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


269
270
271
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 269

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



275
276
277
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 275

def hash
  [first_name, last_name, street, postal_code, city, email, bank_code, branch_code, , phone_number, transfer_reason_code, transfer_reason, narration, name, contact_first_name, contact_last_name, registration_number, nature_of_business, legal_entity_type, birth_date].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



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

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 @bank_account.nil?
    invalid_properties.push('invalid value for "bank_account", bank_account cannot be nil.')
  end

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



351
352
353
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 351

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



357
358
359
360
361
362
363
364
365
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 357

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



345
346
347
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 345

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



232
233
234
235
236
237
238
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 232

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @bank_account.nil?
  return false if @phone_number.nil?
  true
end