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", // Mandatory for business payouts; "contact_last_name" "Contact", // Mandatory for business payouts; "street": "Main Street", "postal_code": "AB0001", "city": "Cape Town", "email": "[email protected]", "bank_name" ’Bank Zero’, // Optional "bank_code": "334810", "bank_account": "12345678", "phone_number": "+27119785313", "transfer_reason": "personal_account", // New transfer reason field "legal_entity_type": "sole_proprietorship", // Optional; Default value is "person"; Mandatory for business payouts; "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



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
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
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 100

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?(:'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?(:'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
end

Instance Attribute Details

#bank_account ⇒ Object

Returns the value of attribute bank_account.



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

def 
  
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

#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.



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

def contact_first_name
  @contact_first_name
end

#contact_last_name ⇒ Object

Returns the value of attribute contact_last_name.



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

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.



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

def legal_entity_type
  @legal_entity_type
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#nature_of_business ⇒ Object

Returns the value of attribute nature_of_business.



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

def nature_of_business
  @nature_of_business
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



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

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.



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

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.



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

def transfer_reason
  @transfer_reason
end

#transfer_reason_code ⇒ Object

Returns the value of attribute transfer_reason_code.



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

def transfer_reason_code
  @transfer_reason_code
end

Class Method Details

.attribute_map ⇒ Object

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



53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 53

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',
    :'bank_account' => :'bank_account',
    :'phone_number' => :'phone_number',
    :'transfer_reason_code' => :'transfer_reason_code',
    :'transfer_reason' => :'transfer_reason',
    :'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'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 76

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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 237

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 &&
       == o. &&
      phone_number == o.phone_number &&
      transfer_reason_code == o.transfer_reason_code &&
      transfer_reason == o.transfer_reason &&
      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
end

#[](key) ⇒ Object 



359
360
361
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 359

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



297
298
299
300
301
302
303
304
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
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 297

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



371
372
373
374
375
376
377
378
379
380
381
382
383
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 371

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



276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 276

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 



363
364
365
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 363

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


261
262
263
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 261

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



267
268
269
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 267

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



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 184

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

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

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

  if .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



343
344
345
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 343

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



349
350
351
352
353
354
355
356
357
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 349

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



337
338
339
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 337

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



223
224
225
226
227
228
229
230
231
232
233
 
# File 'lib/transferzero-sdk/models/payout_method_details_zar_bank.rb', line 223

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @street.nil?
  return false if @postal_code.nil?
  return false if @city.nil?
  return false if @bank_code.nil?
  return false if .nil?
  return false if @phone_number.nil?
  true
end