Class: TransferZero::PayoutMethodDetailsBRLBank

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

Overview

PIX Payment: “‘JSON "details": { "first_name": "First", "last_name": "Last", "city": "Brasilia", "postal_code": "70070", "phone_number": "+552112345678", // E.164 international format "pix_key_type": "email", "pix_key_value": "[email protected]", "identity_card_id": "01234567890", // CPF or CNPJ "transfer_reason": "personal_account" } “` TED Payment: “`JSON "details": { "first_name": "First", "last_name": "Last", "city": "Brasilia", "postal_code": "70070", "phone_number": "+552112345678", // E.164 international format "bank_code": "104", "branch_code": "00001", "bank_account": "0009795493", "bank_account_type": "10", "identity_card_id": "01234567890", // CPF or CNPJ "transfer_reason": "personal_account" } “` See [BRL Bank](docs.transferzero.com/docs/payout-details/#brlbank) 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 = {}) ⇒ PayoutMethodDetailsBRLBank

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 84

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

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

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

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

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

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

  if attributes.key?(:'transfer_reason')
    self.transfer_reason = attributes[:'transfer_reason']
  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_brl_bank.rb', line 32

def 
  
end

#bank_account_type ⇒ Object

Returns the value of attribute bank_account_type.



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

def 
  
end

#bank_code ⇒ Object

Returns the value of attribute bank_code.



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

def bank_code
  @bank_code
end

#branch_code ⇒ Object

Returns the value of attribute branch_code.



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

def branch_code
  @branch_code
end

#city ⇒ Object

Returns the value of attribute city.



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

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_brl_bank.rb', line 18

def first_name
  @first_name
end

#identity_card_id ⇒ Object

Returns the value of attribute identity_card_id.



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

def identity_card_id
  @identity_card_id
end

#last_name ⇒ Object

Returns the value of attribute last_name.



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

def last_name
  @last_name
end

#phone_number ⇒ Object

Returns the value of attribute phone_number.



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

def phone_number
  @phone_number
end

#pix_key_type ⇒ Object

Returns the value of attribute pix_key_type.



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

def pix_key_type
  @pix_key_type
end

#pix_key_value ⇒ Object

Returns the value of attribute pix_key_value.



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

def pix_key_value
  @pix_key_value
end

#postal_code ⇒ Object

Returns the value of attribute postal_code.



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

def postal_code
  @postal_code
end

#transfer_reason ⇒ Object

Returns the value of attribute transfer_reason.



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

def transfer_reason
  @transfer_reason
end

Class Method Details

.attribute_map ⇒ Object

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



45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 45

def self.attribute_map
  {
    :'first_name' => :'first_name',
    :'last_name' => :'last_name',
    :'city' => :'city',
    :'postal_code' => :'postal_code',
    :'phone_number' => :'phone_number',
    :'bank_code' => :'bank_code',
    :'branch_code' => :'branch_code',
    :'bank_account' => :'bank_account',
    :'bank_account_type' => :'bank_account_type',
    :'pix_key_type' => :'pix_key_type',
    :'pix_key_value' => :'pix_key_value',
    :'identity_card_id' => :'identity_card_id',
    :'transfer_reason' => :'transfer_reason'
  }
end

.openapi_types ⇒ Object

Attribute type mapping.



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 64

def self.openapi_types
  {
    :'first_name' => :'String',
    :'last_name' => :'String',
    :'city' => :'String',
    :'postal_code' => :'String',
    :'phone_number' => :'String',
    :'bank_code' => :'String',
    :'branch_code' => :'String',
    :'bank_account' => :'String',
    :'bank_account_type' => :'PayoutMethodBankAccountTypeEnum',
    :'pix_key_type' => :'PayoutMethodPixKeyTypeEnum',
    :'pix_key_value' => :'String',
    :'identity_card_id' => :'String',
    :'transfer_reason' => :'PayoutMethodTransferReasonEnum'
  }
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
206
207
208
209
210
211
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 195

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      first_name == o.first_name &&
      last_name == o.last_name &&
      city == o.city &&
      postal_code == o.postal_code &&
      phone_number == o.phone_number &&
      bank_code == o.bank_code &&
      branch_code == o.branch_code &&
       == o. &&
       == o. &&
      pix_key_type == o.pix_key_type &&
      pix_key_value == o.pix_key_value &&
      identity_card_id == o.identity_card_id &&
      transfer_reason == o.transfer_reason
end

#[](key) ⇒ Object 



313
314
315
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 313

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



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
282
283
284
285
286
287
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 251

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



325
326
327
328
329
330
331
332
333
334
335
336
337
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 325

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



230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 230

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 



317
318
319
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 317

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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


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

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



221
222
223
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 221

def hash
  [first_name, last_name, city, postal_code, phone_number, bank_code, branch_code, , , pix_key_type, pix_key_value, identity_card_id, transfer_reason].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



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

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

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

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



297
298
299
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 297

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



303
304
305
306
307
308
309
310
311
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 303

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



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

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



183
184
185
186
187
188
189
190
191
 
# File 'lib/transferzero-sdk/models/payout_method_details_brl_bank.rb', line 183

def valid?
  return false if @first_name.nil?
  return false if @last_name.nil?
  return false if @city.nil?
  return false if @postal_code.nil?
  return false if @identity_card_id.nil?
  return false if @transfer_reason.nil?
  true
end