Class: BudgeaClient::Account

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Account

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
 
# File 'lib/budgea_client/models/account.rb', line 163

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_connection')
    self.id_connection = attributes[:'id_connection']
  end

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

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

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

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

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

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

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

  if attributes.has_key?(:'coming')
    self.coming = attributes[:'coming']
  else
    self.coming = 0.0
  end

  if attributes.has_key?(:'display')
    self.display = attributes[:'display']
  else
    self.display = true
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#balance ⇒ Object

Balance of the account



42
43
44
 
# File 'lib/budgea_client/models/account.rb', line 42

def balance
  @balance
end

#bic ⇒ Object

Account BIC/SWIFT



63
64
65
 
# File 'lib/budgea_client/models/account.rb', line 63

def bic
  @bic
end

#bookmarked ⇒ Object

This account has been bookmarked by user



72
73
74
 
# File 'lib/budgea_client/models/account.rb', line 72

def bookmarked
  @bookmarked
end

#coming ⇒ Object

Amount of coming operations not yet debited



45
46
47
 
# File 'lib/budgea_client/models/account.rb', line 45

def coming
  @coming
end

#company_name ⇒ Object

Name of the company holding the employee savings of the account



93
94
95
 
# File 'lib/budgea_client/models/account.rb', line 93

def company_name
  @company_name
end

#currency ⇒ Object

Account currency



66
67
68
 
# File 'lib/budgea_client/models/account.rb', line 66

def currency
  @currency
end

#deleted ⇒ Object

This account is not found on the website anymore



54
55
56
 
# File 'lib/budgea_client/models/account.rb', line 54

def deleted
  @deleted
end

#disabled ⇒ Object

This account has been deleted by user and will not be synchronized anymore



57
58
59
 
# File 'lib/budgea_client/models/account.rb', line 57

def disabled
  @disabled
end

#display ⇒ Object

Display this account in accounts list



48
49
50
 
# File 'lib/budgea_client/models/account.rb', line 48

def display
  @display
end

#error ⇒ Object

If the last update has failed, the error code



84
85
86
 
# File 'lib/budgea_client/models/account.rb', line 84

def error
  @error
end

#iban ⇒ Object

Account IBAN



60
61
62
 
# File 'lib/budgea_client/models/account.rb', line 60

def iban
  @iban
end

#id ⇒ Object

ID of the account



18
19
20
 
# File 'lib/budgea_client/models/account.rb', line 18

def id
  @id
end

#id_connection ⇒ Object

ID of the related connection



21
22
23
 
# File 'lib/budgea_client/models/account.rb', line 21

def id_connection
  @id_connection
end

#id_parent ⇒ Object

Id of the parent account



30
31
32
 
# File 'lib/budgea_client/models/account.rb', line 30

def id_parent
  @id_parent
end

#id_source ⇒ Object

ID of the related connection source



27
28
29
 
# File 'lib/budgea_client/models/account.rb', line 27

def id_source
  @id_source
end

#id_type ⇒ Object

ID of the account type



69
70
71
 
# File 'lib/budgea_client/models/account.rb', line 69

def id_type
  @id_type
end

#id_user ⇒ Object

ID of the related user



24
25
26
 
# File 'lib/budgea_client/models/account.rb', line 24

def id_user
  @id_user
end

#last_update ⇒ Object

Last successful update of the account



51
52
53
 
# File 'lib/budgea_client/models/account.rb', line 51

def last_update
  @last_update
end

#name ⇒ Object

Name of the account



75
76
77
 
# File 'lib/budgea_client/models/account.rb', line 75

def name
  @name
end

#number ⇒ Object

Account number



33
34
35
 
# File 'lib/budgea_client/models/account.rb', line 33

def number
  @number
end

#original_name ⇒ Object

Original name of the account on the bank



39
40
41
 
# File 'lib/budgea_client/models/account.rb', line 39

def original_name
  @original_name
end

#ownership ⇒ Object

Relationship between the credentials owner and the account



90
91
92
 
# File 'lib/budgea_client/models/account.rb', line 90

def ownership
  @ownership
end

#recipients ⇒ Object

Returns the value of attribute recipients.



77
78
79
 
# File 'lib/budgea_client/models/account.rb', line 77

def recipients
  @recipients
end

#transactions ⇒ Object

Returns the value of attribute transactions.



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

def transactions
  @transactions
end

#transfers ⇒ Object

Returns the value of attribute transfers.



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

def transfers
  @transfers
end

#usage ⇒ Object

Account usage



87
88
89
 
# File 'lib/budgea_client/models/account.rb', line 87

def usage
  @usage
end

#webid ⇒ Object

Account webid



36
37
38
 
# File 'lib/budgea_client/models/account.rb', line 36

def webid
  @webid
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'id_connection' => :'id_connection',
    :'id_user' => :'id_user',
    :'id_source' => :'id_source',
    :'id_parent' => :'id_parent',
    :'number' => :'number',
    :'webid' => :'webid',
    :'original_name' => :'original_name',
    :'balance' => :'balance',
    :'coming' => :'coming',
    :'display' => :'display',
    :'last_update' => :'last_update',
    :'deleted' => :'deleted',
    :'disabled' => :'disabled',
    :'iban' => :'iban',
    :'bic' => :'bic',
    :'currency' => :'currency',
    :'id_type' => :'id_type',
    :'bookmarked' => :'bookmarked',
    :'name' => :'name',
    :'recipients' => :'recipients',
    :'transactions' => :'transactions',
    :'transfers' => :'transfers',
    :'error' => :'error',
    :'usage' => :'usage',
    :'ownership' => :'ownership',
    :'company_name' => :'company_name'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_connection' => :'Integer',
    :'id_user' => :'Integer',
    :'id_source' => :'Integer',
    :'id_parent' => :'Integer',
    :'number' => :'String',
    :'webid' => :'String',
    :'original_name' => :'String',
    :'balance' => :'Float',
    :'coming' => :'Float',
    :'display' => :'BOOLEAN',
    :'last_update' => :'DateTime',
    :'deleted' => :'DateTime',
    :'disabled' => :'DateTime',
    :'iban' => :'String',
    :'bic' => :'String',
    :'currency' => :'Currency',
    :'id_type' => :'Integer',
    :'bookmarked' => :'Integer',
    :'name' => :'String',
    :'recipients' => :'Array<Recipient>',
    :'transactions' => :'Array<Transaction>',
    :'transfers' => :'Array<Transfer>',
    :'error' => :'String',
    :'usage' => :'String',
    :'ownership' => :'String',
    :'company_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
 
# File 'lib/budgea_client/models/account.rb', line 328

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      id_connection == o.id_connection &&
      id_user == o.id_user &&
      id_source == o.id_source &&
      id_parent == o.id_parent &&
      number == o.number &&
      webid == o.webid &&
      original_name == o.original_name &&
      balance == o.balance &&
      coming == o.coming &&
      display == o.display &&
      last_update == o.last_update &&
      deleted == o.deleted &&
      disabled == o.disabled &&
      iban == o.iban &&
      bic == o.bic &&
      currency == o.currency &&
      id_type == o.id_type &&
      bookmarked == o.bookmarked &&
      name == o.name &&
      recipients == o.recipients &&
      transactions == o.transactions &&
      transfers == o.transfers &&
      error == o.error &&
      usage == o.usage &&
      ownership == o.ownership &&
      company_name == o.company_name
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



396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
 
# File 'lib/budgea_client/models/account.rb', line 396

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



462
463
464
465
466
467
468
469
470
471
472
473
474
 
# File 'lib/budgea_client/models/account.rb', line 462

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



375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
 
# File 'lib/budgea_client/models/account.rb', line 375

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


362
363
364
 
# File 'lib/budgea_client/models/account.rb', line 362

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



368
369
370
 
# File 'lib/budgea_client/models/account.rb', line 368

def hash
  [id, id_connection, id_user, id_source, id_parent, number, webid, original_name, balance, coming, display, last_update, deleted, disabled, iban, bic, currency, id_type, bookmarked, name, recipients, transactions, transfers, error, usage, ownership, company_name].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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
 
# File 'lib/budgea_client/models/account.rb', line 290

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

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

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

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

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



442
443
444
 
# File 'lib/budgea_client/models/account.rb', line 442

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



448
449
450
451
452
453
454
455
456
 
# File 'lib/budgea_client/models/account.rb', line 448

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



436
437
438
 
# File 'lib/budgea_client/models/account.rb', line 436

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



317
318
319
320
321
322
323
324
 
# File 'lib/budgea_client/models/account.rb', line 317

def valid?
  return false if @id.nil?
  return false if @original_name.nil?
  return false if @balance.nil?
  return false if @display.nil?
  return false if @bookmarked.nil?
  true
end