Class: BudgeaClient::Transfer

Inherits:
Object
  • Object
show all
Defined in:
lib/budgea_client/models/transfer.rb

Overview

This is a representation of a transfer.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transfer

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'lib/budgea_client/models/transfer.rb', line 141

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  if attributes.has_key?(:'beneficiary_type')
    self.beneficiary_type = attributes[:'beneficiary_type']
  else
    self.beneficiary_type = 'recipient'
  end

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

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

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

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

  if attributes.has_key?(:'fields')
    if (value = attributes[:'fields']).is_a?(Array)
      self.fields = value
    end
  end
end

Instance Attribute Details

#account_balance ⇒ Object

Balance of the account just before the transfer



61
62
63
 
# File 'lib/budgea_client/models/transfer.rb', line 61

def 
  @account_balance
end

#account_iban ⇒ Object

IBAN of the debited account



31
32
33
 
# File 'lib/budgea_client/models/transfer.rb', line 31

def 
  @account_iban
end

#amount ⇒ Object

Amount of the transfer



43
44
45
 
# File 'lib/budgea_client/models/transfer.rb', line 43

def amount
  @amount
end

#beneficiary_label ⇒ Object

Label of the beneficiary (needed for transfer to other beneficiary type than ‘recipient’)



73
74
75
 
# File 'lib/budgea_client/models/transfer.rb', line 73

def beneficiary_label
  @beneficiary_label
end

#beneficiary_number ⇒ Object

Beneficiary bank identifier value like recipient webid, iban: EX6713281847025300290000062 or phone_number: 06XXXXXX



70
71
72
 
# File 'lib/budgea_client/models/transfer.rb', line 70

def beneficiary_number
  @beneficiary_number
end

#beneficiary_type ⇒ Object

Type of beneficiary number, for example: ‘recipient’ (in bank recipient list), ‘iban’ or ‘phone_number’



67
68
69
 
# File 'lib/budgea_client/models/transfer.rb', line 67

def beneficiary_type
  @beneficiary_type
end

#currency ⇒ Object

Currency of the object



79
80
81
 
# File 'lib/budgea_client/models/transfer.rb', line 79

def currency
  @currency
end

#error ⇒ Object

Error message during transfer, if any



55
56
57
 
# File 'lib/budgea_client/models/transfer.rb', line 55

def error
  @error
end

#exec_date ⇒ Object

Date when the transfer will be operated by the bank



37
38
39
 
# File 'lib/budgea_client/models/transfer.rb', line 37

def exec_date
  @exec_date
end

#fees ⇒ Object

Fees taken by the bank



46
47
48
 
# File 'lib/budgea_client/models/transfer.rb', line 46

def fees
  @fees
end

#fields ⇒ Object

Returns the value of attribute fields.



81
82
83
 
# File 'lib/budgea_client/models/transfer.rb', line 81

def fields
  @fields
end

#id ⇒ Object

ID of transfer



19
20
21
 
# File 'lib/budgea_client/models/transfer.rb', line 19

def id
  @id
end

#id_account ⇒ Object

ID of the debited account



22
23
24
 
# File 'lib/budgea_client/models/transfer.rb', line 22

def 
  @id_account
end

#id_recipient ⇒ Object

ID of the recipient



28
29
30
 
# File 'lib/budgea_client/models/transfer.rb', line 28

def id_recipient
  @id_recipient
end

#id_transaction ⇒ Object

If found, ID of the related transaction



64
65
66
 
# File 'lib/budgea_client/models/transfer.rb', line 64

def id_transaction
  @id_transaction
end

#id_user ⇒ Object

ID of the related user



25
26
27
 
# File 'lib/budgea_client/models/transfer.rb', line 25

def id_user
  @id_user
end

#label ⇒ Object

Label of the transfer



58
59
60
 
# File 'lib/budgea_client/models/transfer.rb', line 58

def label
  @label
end

#recipient_iban ⇒ Object

IBAN of the recipient in bank recipient list



34
35
36
 
# File 'lib/budgea_client/models/transfer.rb', line 34

def recipient_iban
  @recipient_iban
end

#register_date ⇒ Object

Date when the transfer has been registered



40
41
42
 
# File 'lib/budgea_client/models/transfer.rb', line 40

def register_date
  @register_date
end

#state ⇒ Object

State of the transfer (created, scheduled, validating, pending, coming, done, canceled, transactionNotFound, deleted, error, bug)



52
53
54
 
# File 'lib/budgea_client/models/transfer.rb', line 52

def state
  @state
end

#validate_mechanism ⇒ Object

Authentication method used to validate transfer (credentials or webauth)



76
77
78
 
# File 'lib/budgea_client/models/transfer.rb', line 76

def validate_mechanism
  @validate_mechanism
end

#webid ⇒ Object

WebID of the transfer



49
50
51
 
# File 'lib/budgea_client/models/transfer.rb', line 49

def webid
  @webid
end

Class Method Details

.attribute_map ⇒ Object

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



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
 
# File 'lib/budgea_client/models/transfer.rb', line 84

def self.attribute_map
  {
    :'id' => :'id',
    :'id_account' => :'id_account',
    :'id_user' => :'id_user',
    :'id_recipient' => :'id_recipient',
    :'account_iban' => :'account_iban',
    :'recipient_iban' => :'recipient_iban',
    :'exec_date' => :'exec_date',
    :'register_date' => :'register_date',
    :'amount' => :'amount',
    :'fees' => :'fees',
    :'webid' => :'webid',
    :'state' => :'state',
    :'error' => :'error',
    :'label' => :'label',
    :'account_balance' => :'account_balance',
    :'id_transaction' => :'id_transaction',
    :'beneficiary_type' => :'beneficiary_type',
    :'beneficiary_number' => :'beneficiary_number',
    :'beneficiary_label' => :'beneficiary_label',
    :'validate_mechanism' => :'validate_mechanism',
    :'currency' => :'currency',
    :'fields' => :'fields'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/budgea_client/models/transfer.rb', line 112

def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_account' => :'Integer',
    :'id_user' => :'Integer',
    :'id_recipient' => :'Integer',
    :'account_iban' => :'String',
    :'recipient_iban' => :'String',
    :'exec_date' => :'Date',
    :'register_date' => :'DateTime',
    :'amount' => :'Float',
    :'fees' => :'Float',
    :'webid' => :'String',
    :'state' => :'String',
    :'error' => :'String',
    :'label' => :'String',
    :'account_balance' => :'Float',
    :'id_transaction' => :'Integer',
    :'beneficiary_type' => :'String',
    :'beneficiary_number' => :'String',
    :'beneficiary_label' => :'String',
    :'validate_mechanism' => :'String',
    :'currency' => :'Object',
    :'fields' => :'Array<Field>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
 
# File 'lib/budgea_client/models/transfer.rb', line 285

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      id_user == o.id_user &&
      id_recipient == o.id_recipient &&
       == o. &&
      recipient_iban == o.recipient_iban &&
      exec_date == o.exec_date &&
      register_date == o.register_date &&
      amount == o.amount &&
      fees == o.fees &&
      webid == o.webid &&
      state == o.state &&
      error == o.error &&
      label == o.label &&
       == o. &&
      id_transaction == o.id_transaction &&
      beneficiary_type == o.beneficiary_type &&
      beneficiary_number == o.beneficiary_number &&
      beneficiary_label == o.beneficiary_label &&
      validate_mechanism == o.validate_mechanism &&
      currency == o.currency &&
      fields == o.fields
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



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/budgea_client/models/transfer.rb', line 348

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



414
415
416
417
418
419
420
421
422
423
424
425
426
 
# File 'lib/budgea_client/models/transfer.rb', line 414

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

Builds the object from hash

Parameters:

  • attributes (Hash) —

    Model attributes in the form of hash

Returns:

  • (Object) —

    Returns the model itself



327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/budgea_client/models/transfer.rb', line 327

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that 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

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


314
315
316
 
# File 'lib/budgea_client/models/transfer.rb', line 314

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



320
321
322
 
# File 'lib/budgea_client/models/transfer.rb', line 320

def hash
  [id, , id_user, id_recipient, , recipient_iban, exec_date, register_date, amount, fees, webid, state, error, label, , id_transaction, beneficiary_type, beneficiary_number, beneficiary_label, validate_mechanism, currency, fields].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



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
 
# File 'lib/budgea_client/models/transfer.rb', line 242

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

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

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

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

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

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



394
395
396
 
# File 'lib/budgea_client/models/transfer.rb', line 394

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



400
401
402
403
404
405
406
407
408
 
# File 'lib/budgea_client/models/transfer.rb', line 400

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
  hash
end

#to_s ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



388
389
390
 
# File 'lib/budgea_client/models/transfer.rb', line 388

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



273
274
275
276
277
278
279
280
281
 
# File 'lib/budgea_client/models/transfer.rb', line 273

def valid?
  return false if @id.nil?
  return false if @exec_date.nil?
  return false if @register_date.nil?
  return false if @amount.nil?
  return false if @state.nil?
  return false if @beneficiary_type.nil?
  true
end