Class: BudgeaClient::Transaction

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Transaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
287
288
289
290
291
292
293
294
295
296
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
 
# File 'lib/budgea_client/models/transaction.rb', line 186

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

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

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

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

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

  if attributes.has_key?(:'nature')
    self.nature = attributes[:'nature']
  else
    self.nature = 'inconnu'
  end

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

If false, PFM services will ignore this transaction



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

def active
  @active
end

#application_date ⇒ Object

Date considered by PFM services. It is used to change the month of a transaction, for example.



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

def application_date
  @application_date
end

#bdate ⇒ Object

Date used by the bank for the transaction



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

def bdate
  @bdate
end

#card ⇒ Object

Card number associated to the transaction



108
109
110
 
# File 'lib/budgea_client/models/transaction.rb', line 108

def card
  @card
end

#coming ⇒ Object

If true, this transaction hasn’t been yet debited



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

def coming
  @coming
end

#comment ⇒ Object

User comment



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

def comment
  @comment
end

#commission ⇒ Object

Commission taken on the transaction



96
97
98
 
# File 'lib/budgea_client/models/transaction.rb', line 96

def commission
  @commission
end

#commission_currency ⇒ Object

Commission currency



99
100
101
 
# File 'lib/budgea_client/models/transaction.rb', line 99

def commission_currency
  @commission_currency
end

#counterparty ⇒ Object

Counterparty



105
106
107
 
# File 'lib/budgea_client/models/transaction.rb', line 105

def counterparty
  @counterparty
end

#country ⇒ Object

Original country



102
103
104
 
# File 'lib/budgea_client/models/transaction.rb', line 102

def country
  @country
end

#date ⇒ Object

Debit date



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

def date
  @date
end

#date_scraped ⇒ Object

Date when the transaction has been seen



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

def date_scraped
  @date_scraped
end

#deleted ⇒ Object

If set, this transaction has been removed from the bank



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

def deleted
  @deleted
end

#gross_value ⇒ Object

Gross value of the transaction



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

def gross_value
  @gross_value
end

#id ⇒ Object

ID of the transaction



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

def id
  @id
end

#id_account ⇒ Object

ID of the related account



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

def 
  @id_account
end

#id_category ⇒ Object

ID of the related category



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

def id_category
  @id_category
end

#id_cluster ⇒ Object

If the transaction is part of a cluster



78
79
80
 
# File 'lib/budgea_client/models/transaction.rb', line 78

def id_cluster
  @id_cluster
end

#last_update ⇒ Object

Last update of the transaction



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

def last_update
  @last_update
end

#nature ⇒ Object

Type of transaction



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

def nature
  @nature
end

#original_currency ⇒ Object

Original currency



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

def original_currency
  @original_currency
end

#original_value ⇒ Object

Value in the original currency



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

def original_value
  @original_value
end

#original_wording ⇒ Object

Full label of the transaction



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

def original_wording
  @original_wording
end

#rdate ⇒ Object

Realization of the transaction



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

def rdate
  @rdate
end

#simplified_wording ⇒ Object

Simplified label of the transaction



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

def simplified_wording
  @simplified_wording
end

#state ⇒ Object

Internal state of the transaction



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

def state
  @state
end

#stemmed_wording ⇒ Object

Do not use it



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

def stemmed_wording
  @stemmed_wording
end

#value ⇒ Object

Value of the transaction



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

def value
  @value
end

#vdate ⇒ Object

Value date of the transaction



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

def vdate
  @vdate
end

#webid ⇒ Object

Webid of the transaction



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

def webid
  @webid
end

#wording ⇒ Object

Label set by the user



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

def wording
  @wording
end

Class Method Details

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'id' => :'id',
    :'id_account' => :'id_account',
    :'webid' => :'webid',
    :'application_date' => :'application_date',
    :'date' => :'date',
    :'value' => :'value',
    :'gross_value' => :'gross_value',
    :'nature' => :'nature',
    :'original_wording' => :'original_wording',
    :'simplified_wording' => :'simplified_wording',
    :'stemmed_wording' => :'stemmed_wording',
    :'wording' => :'wording',
    :'id_category' => :'id_category',
    :'state' => :'state',
    :'date_scraped' => :'date_scraped',
    :'rdate' => :'rdate',
    :'vdate' => :'vdate',
    :'bdate' => :'bdate',
    :'coming' => :'coming',
    :'active' => :'active',
    :'id_cluster' => :'id_cluster',
    :'comment' => :'comment',
    :'last_update' => :'last_update',
    :'deleted' => :'deleted',
    :'original_value' => :'original_value',
    :'original_currency' => :'original_currency',
    :'commission' => :'commission',
    :'commission_currency' => :'commission_currency',
    :'country' => :'country',
    :'counterparty' => :'counterparty',
    :'card' => :'card'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



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

def self.swagger_types
  {
    :'id' => :'Integer',
    :'id_account' => :'Integer',
    :'webid' => :'String',
    :'application_date' => :'Date',
    :'date' => :'Date',
    :'value' => :'Float',
    :'gross_value' => :'Float',
    :'nature' => :'String',
    :'original_wording' => :'String',
    :'simplified_wording' => :'String',
    :'stemmed_wording' => :'String',
    :'wording' => :'String',
    :'id_category' => :'Integer',
    :'state' => :'String',
    :'date_scraped' => :'DateTime',
    :'rdate' => :'Date',
    :'vdate' => :'Date',
    :'bdate' => :'Date',
    :'coming' => :'BOOLEAN',
    :'active' => :'BOOLEAN',
    :'id_cluster' => :'Integer',
    :'comment' => :'String',
    :'last_update' => :'DateTime',
    :'deleted' => :'DateTime',
    :'original_value' => :'Float',
    :'original_currency' => :'Object',
    :'commission' => :'Float',
    :'commission_currency' => :'Object',
    :'country' => :'String',
    :'counterparty' => :'String',
    :'card' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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/transaction.rb', line 398

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
       == o. &&
      webid == o.webid &&
      application_date == o.application_date &&
      date == o.date &&
      value == o.value &&
      gross_value == o.gross_value &&
      nature == o.nature &&
      original_wording == o.original_wording &&
      simplified_wording == o.simplified_wording &&
      stemmed_wording == o.stemmed_wording &&
      wording == o.wording &&
      id_category == o.id_category &&
      state == o.state &&
      date_scraped == o.date_scraped &&
      rdate == o.rdate &&
      vdate == o.vdate &&
      bdate == o.bdate &&
      coming == o.coming &&
      active == o.active &&
      id_cluster == o.id_cluster &&
      comment == o.comment &&
      last_update == o.last_update &&
      deleted == o.deleted &&
      original_value == o.original_value &&
      original_currency == o.original_currency &&
      commission == o.commission &&
      commission_currency == o.commission_currency &&
      country == o.country &&
      counterparty == o.counterparty &&
      card == o.card
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



470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
 
# File 'lib/budgea_client/models/transaction.rb', line 470

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



536
537
538
539
540
541
542
543
544
545
546
547
548
 
# File 'lib/budgea_client/models/transaction.rb', line 536

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



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
 
# File 'lib/budgea_client/models/transaction.rb', line 449

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


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

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



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

def hash
  [id, , webid, application_date, date, value, gross_value, nature, original_wording, simplified_wording, stemmed_wording, wording, id_category, state, date_scraped, rdate, vdate, bdate, coming, active, id_cluster, comment, last_update, deleted, original_value, original_currency, commission, commission_currency, country, counterparty, card].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



325
326
327
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/budgea_client/models/transaction.rb', line 325

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

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

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

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

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

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

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

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

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

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

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

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



516
517
518
 
# File 'lib/budgea_client/models/transaction.rb', line 516

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



522
523
524
525
526
527
528
529
530
 
# File 'lib/budgea_client/models/transaction.rb', line 522

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



510
511
512
 
# File 'lib/budgea_client/models/transaction.rb', line 510

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



380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/budgea_client/models/transaction.rb', line 380

def valid?
  return false if @id.nil?
  return false if @id_account.nil?
  return false if @date.nil?
  return false if @nature.nil?
  return false if @original_wording.nil?
  return false if @simplified_wording.nil?
  return false if @stemmed_wording.nil?
  return false if @state.nil?
  return false if @date_scraped.nil?
  return false if @rdate.nil?
  return false if @coming.nil?
  return false if @active.nil?
  true
end