Class: FireflyIIIClient::RecurrenceTransaction

Inherits:
Object
  • Object
show all
Defined in:
lib/firefly_iii_client/models/recurrence_transaction.rb

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecurrenceTransaction

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
287
288
289
290
291
292
293
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 175

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#amount ⇒ Object

Amount of the transaction.



21
22
23
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 21

def amount
  @amount
end

#budget_id ⇒ Object

The budget ID for this transaction.



49
50
51
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 49

def budget_id
  @budget_id
end

#budget_name ⇒ Object

The name of the budget to be used. If the budget name is unknown, the ID will be used or the value will be ignored.



52
53
54
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 52

def budget_name
  @budget_name
end

#category_id ⇒ Object

Category ID for this transaction.



55
56
57
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 55

def category_id
  @category_id
end

#category_name ⇒ Object

Category name for this transaction.



58
59
60
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 58

def category_name
  @category_name
end

#currency_code ⇒ Object

Submit either a currency_id or a currency_code.



30
31
32
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 30

def currency_code
  @currency_code
end

#currency_decimal_places ⇒ Object

Number of decimals in the currency



35
36
37
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 35

def currency_decimal_places
  @currency_decimal_places
end

#currency_id ⇒ Object

Submit either a currency_id or a currency_code.



27
28
29
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 27

def currency_id
  @currency_id
end

#currency_symbol ⇒ Object

Returns the value of attribute currency_symbol.



32
33
34
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 32

def currency_symbol
  @currency_symbol
end

#description ⇒ Object

Returns the value of attribute description.



18
19
20
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 18

def description
  @description
end

#destination_iban ⇒ Object

Returns the value of attribute destination_iban.



76
77
78
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 76

def destination_iban
  @destination_iban
end

#destination_id ⇒ Object

ID of the destination account. Submit either this or destination_name.



71
72
73
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 71

def destination_id
  @destination_id
end

#destination_name ⇒ Object

Name of the destination account. Submit either this or destination_id.



74
75
76
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 74

def destination_name
  @destination_name
end

#destination_type ⇒ Object

Returns the value of attribute destination_type.



78
79
80
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 78

def destination_type
  @destination_type
end

#foreign_amount ⇒ Object

Foreign amount of the transaction.



24
25
26
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 24

def foreign_amount
  @foreign_amount
end

#foreign_currency_code ⇒ Object

Submit either a foreign_currency_id or a foreign_currency_code, or neither.



41
42
43
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 41

def foreign_currency_code
  @foreign_currency_code
end

#foreign_currency_decimal_places ⇒ Object

Number of decimals in the currency



46
47
48
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 46

def foreign_currency_decimal_places
  @foreign_currency_decimal_places
end

#foreign_currency_id ⇒ Object

Submit either a foreign_currency_id or a foreign_currency_code, or neither.



38
39
40
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 38

def foreign_currency_id
  @foreign_currency_id
end

#foreign_currency_symbol ⇒ Object

Returns the value of attribute foreign_currency_symbol.



43
44
45
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 43

def foreign_currency_symbol
  @foreign_currency_symbol
end

#piggy_bank_id ⇒ Object

Optional. Use either this or the piggy_bank_name



84
85
86
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 84

def piggy_bank_id
  @piggy_bank_id
end

#piggy_bank_name ⇒ Object

Optional. Use either this or the piggy_bank_id



87
88
89
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 87

def piggy_bank_name
  @piggy_bank_name
end

#source_iban ⇒ Object

Returns the value of attribute source_iban.



66
67
68
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 66

def source_iban
  @source_iban
end

#source_id ⇒ Object

ID of the source account. Submit either this or source_name.



61
62
63
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 61

def source_id
  @source_id
end

#source_name ⇒ Object

Name of the source account. Submit either this or source_id.



64
65
66
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 64

def source_name
  @source_name
end

#source_type ⇒ Object

Returns the value of attribute source_type.



68
69
70
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 68

def source_type
  @source_type
end

#tags ⇒ Object

Array of tags.



81
82
83
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 81

def tags
  @tags
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



122
123
124
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 122

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 90

def self.attribute_map
  {
    :'description' => :'description',
    :'amount' => :'amount',
    :'foreign_amount' => :'foreign_amount',
    :'currency_id' => :'currency_id',
    :'currency_code' => :'currency_code',
    :'currency_symbol' => :'currency_symbol',
    :'currency_decimal_places' => :'currency_decimal_places',
    :'foreign_currency_id' => :'foreign_currency_id',
    :'foreign_currency_code' => :'foreign_currency_code',
    :'foreign_currency_symbol' => :'foreign_currency_symbol',
    :'foreign_currency_decimal_places' => :'foreign_currency_decimal_places',
    :'budget_id' => :'budget_id',
    :'budget_name' => :'budget_name',
    :'category_id' => :'category_id',
    :'category_name' => :'category_name',
    :'source_id' => :'source_id',
    :'source_name' => :'source_name',
    :'source_iban' => :'source_iban',
    :'source_type' => :'source_type',
    :'destination_id' => :'destination_id',
    :'destination_name' => :'destination_name',
    :'destination_iban' => :'destination_iban',
    :'destination_type' => :'destination_type',
    :'tags' => :'tags',
    :'piggy_bank_id' => :'piggy_bank_id',
    :'piggy_bank_name' => :'piggy_bank_name'
  }
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



366
367
368
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 366

def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



159
160
161
162
163
164
165
166
167
168
169
170
171
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 159

def self.openapi_nullable
  Set.new([
    :'foreign_amount',
    :'foreign_currency_id',
    :'foreign_currency_code',
    :'foreign_currency_symbol',
    :'foreign_currency_decimal_places',
    :'budget_name',
    :'source_iban',
    :'destination_iban',
    :'tags',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 127

def self.openapi_types
  {
    :'description' => :'String',
    :'amount' => :'Float',
    :'foreign_amount' => :'Float',
    :'currency_id' => :'Integer',
    :'currency_code' => :'String',
    :'currency_symbol' => :'String',
    :'currency_decimal_places' => :'Integer',
    :'foreign_currency_id' => :'Integer',
    :'foreign_currency_code' => :'String',
    :'foreign_currency_symbol' => :'String',
    :'foreign_currency_decimal_places' => :'Integer',
    :'budget_id' => :'Integer',
    :'budget_name' => :'String',
    :'category_id' => :'Integer',
    :'category_name' => :'String',
    :'source_id' => :'Integer',
    :'source_name' => :'String',
    :'source_iban' => :'String',
    :'source_type' => :'AccountTypeProperty',
    :'destination_id' => :'Integer',
    :'destination_name' => :'String',
    :'destination_iban' => :'String',
    :'destination_type' => :'AccountTypeProperty',
    :'tags' => :'Array<String>',
    :'piggy_bank_id' => :'Integer',
    :'piggy_bank_name' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



320
321
322
323
324
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
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 320

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      description == o.description &&
      amount == o.amount &&
      foreign_amount == o.foreign_amount &&
      currency_id == o.currency_id &&
      currency_code == o.currency_code &&
      currency_symbol == o.currency_symbol &&
      currency_decimal_places == o.currency_decimal_places &&
      foreign_currency_id == o.foreign_currency_id &&
      foreign_currency_code == o.foreign_currency_code &&
      foreign_currency_symbol == o.foreign_currency_symbol &&
      foreign_currency_decimal_places == o.foreign_currency_decimal_places &&
      budget_id == o.budget_id &&
      budget_name == o.budget_name &&
      category_id == o.category_id &&
      category_name == o.category_name &&
      source_id == o.source_id &&
      source_name == o.source_name &&
      source_iban == o.source_iban &&
      source_type == o.source_type &&
      destination_id == o.destination_id &&
      destination_name == o.destination_name &&
      destination_iban == o.destination_iban &&
      destination_type == o.destination_type &&
      tags == o.tags &&
      piggy_bank_id == o.piggy_bank_id &&
      piggy_bank_name == o.piggy_bank_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
433
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 396

def _deserialize(type, value)
  case type.to_sym
  when :Time
    Time.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
    # models (e.g. Pet) or oneOf
    klass = FireflyIIIClient.const_get(type)
    klass.respond_to?(:openapi_one_of) ? klass.build(value) : klass.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



467
468
469
470
471
472
473
474
475
476
477
478
479
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 467

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



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

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.openapi_types.each_pair do |key, type|
    if attributes[self.class.attribute_map[key]].nil? && self.class.openapi_nullable.include?(key)
      self.send("#{key}=", nil)
    elsif 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
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


353
354
355
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 353

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



359
360
361
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 359

def hash
  [description, amount, foreign_amount, currency_id, currency_code, currency_symbol, currency_decimal_places, foreign_currency_id, foreign_currency_code, foreign_currency_symbol, foreign_currency_decimal_places, budget_id, budget_name, category_id, category_name, source_id, source_name, source_iban, source_type, destination_id, destination_name, destination_iban, destination_type, tags, piggy_bank_id, piggy_bank_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



297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 297

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

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



443
444
445
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 443

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



449
450
451
452
453
454
455
456
457
458
459
460
461
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 449

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    if value.nil?
      is_nullable = self.class.openapi_nullable.include?(attr)
      next if !is_nullable || (is_nullable && !instance_variable_defined?(:"@#{attr}"))
    end

    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



437
438
439
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 437

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



312
313
314
315
316
 
# File 'lib/firefly_iii_client/models/recurrence_transaction.rb', line 312

def valid?
  return false if @description.nil?
  return false if @amount.nil?
  true
end