Class: FireflyIIIClient::Account

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

Defined Under Namespace

Classes: EnumAttributeValidator

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



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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_number ⇒ Object

Returns the value of attribute account_number.



31
32
33
 
# File 'lib/firefly_iii_client/models/account.rb', line 31

def 
  @account_number
end

#account_role ⇒ Object

Is only mandatory when the type is asset.



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

def 
  @account_role
end

#active ⇒ Object

If omitted, defaults to true.



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

def active
  @active
end

#bic ⇒ Object

Returns the value of attribute bic.



29
30
31
 
# File 'lib/firefly_iii_client/models/account.rb', line 29

def bic
  @bic
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#credit_card_type ⇒ Object

Mandatory when the account_role is ccAsset. Can only be monthlyFull.



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

def credit_card_type
  @credit_card_type
end

#currency_code ⇒ Object

Use either currency_id or currency_code. Defaults to the user’s default currency.



47
48
49
 
# File 'lib/firefly_iii_client/models/account.rb', line 47

def currency_code
  @currency_code
end

#currency_decimal_places ⇒ Object

Returns the value of attribute currency_decimal_places.



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

def currency_decimal_places
  @currency_decimal_places
end

#currency_id ⇒ Object

Use either currency_id or currency_code. Defaults to the user’s default currency.



44
45
46
 
# File 'lib/firefly_iii_client/models/account.rb', line 44

def currency_id
  @currency_id
end

#currency_symbol ⇒ Object

Returns the value of attribute currency_symbol.



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

def currency_symbol
  @currency_symbol
end

#current_balance ⇒ Object

Returns the value of attribute current_balance.



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

def current_balance
  @current_balance
end

#current_balance_date ⇒ Object

Returns the value of attribute current_balance_date.



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

def current_balance_date
  @current_balance_date
end

#iban ⇒ Object

Returns the value of attribute iban.



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

def iban
  @iban
end

#include_net_worth ⇒ Object

If omitted, defaults to true.



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

def include_net_worth
  @include_net_worth
end

#interest ⇒ Object

Mandatory when type is liability. Interest percentage.



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

def interest
  @interest
end

#interest_period ⇒ Object

Mandatory when type is liability. Period over which the interest is calculated.



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

def interest_period
  @interest_period
end

#liability_amount ⇒ Object

Mandatory when type is liability. Amount of money in the liability. Must be positive.



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

def liability_amount
  @liability_amount
end

#liability_start_date ⇒ Object

Mandatory when type is liability. Start date for the liability.



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

def liability_start_date
  @liability_start_date
end

#liability_type ⇒ Object

Mandatory when type is liability. Specifies the exact type.



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

def liability_type
  @liability_type
end

#monthly_payment_date ⇒ Object

Mandatory when the account_role is ccAsset. Moment at which CC payment installments are asked for by the bank.



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

def monthly_payment_date
  @monthly_payment_date
end

#name ⇒ Object

Returns the value of attribute name.



22
23
24
 
# File 'lib/firefly_iii_client/models/account.rb', line 22

def name
  @name
end

#notes ⇒ Object

Returns the value of attribute notes.



83
84
85
 
# File 'lib/firefly_iii_client/models/account.rb', line 83

def notes
  @notes
end

#opening_balance ⇒ Object

Returns the value of attribute opening_balance.



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

def opening_balance
  @opening_balance
end

#opening_balance_date ⇒ Object

Returns the value of attribute opening_balance_date.



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

def opening_balance_date
  @opening_balance_date
end

#type ⇒ Object

Can only be one one these account types. import, initial-balance and reconciliation cannot be set manually.



25
26
27
 
# File 'lib/firefly_iii_client/models/account.rb', line 25

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



20
21
22
 
# File 'lib/firefly_iii_client/models/account.rb', line 20

def updated_at
  @updated_at
end

#virtual_balance ⇒ Object

Returns the value of attribute virtual_balance.



37
38
39
 
# File 'lib/firefly_iii_client/models/account.rb', line 37

def virtual_balance
  @virtual_balance
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



141
142
143
 
# File 'lib/firefly_iii_client/models/account.rb', line 141

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name' => :'name',
    :'type' => :'type',
    :'iban' => :'iban',
    :'bic' => :'bic',
    :'account_number' => :'account_number',
    :'opening_balance' => :'opening_balance',
    :'opening_balance_date' => :'opening_balance_date',
    :'virtual_balance' => :'virtual_balance',
    :'current_balance' => :'current_balance',
    :'current_balance_date' => :'current_balance_date',
    :'currency_id' => :'currency_id',
    :'currency_code' => :'currency_code',
    :'currency_symbol' => :'currency_symbol',
    :'currency_decimal_places' => :'currency_decimal_places',
    :'active' => :'active',
    :'include_net_worth' => :'include_net_worth',
    :'account_role' => :'account_role',
    :'credit_card_type' => :'credit_card_type',
    :'monthly_payment_date' => :'monthly_payment_date',
    :'liability_type' => :'liability_type',
    :'liability_amount' => :'liability_amount',
    :'liability_start_date' => :'liability_start_date',
    :'interest' => :'interest',
    :'interest_period' => :'interest_period',
    :'notes' => :'notes'
  }
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



447
448
449
 
# File 'lib/firefly_iii_client/models/account.rb', line 447

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



179
180
181
182
183
184
 
# File 'lib/firefly_iii_client/models/account.rb', line 179

def self.openapi_nullable
  Set.new([
    :'credit_card_type',
    :'monthly_payment_date',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



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

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'type' => :'String',
    :'iban' => :'String',
    :'bic' => :'String',
    :'account_number' => :'String',
    :'opening_balance' => :'Float',
    :'opening_balance_date' => :'Date',
    :'virtual_balance' => :'Float',
    :'current_balance' => :'Float',
    :'current_balance_date' => :'Date',
    :'currency_id' => :'Integer',
    :'currency_code' => :'String',
    :'currency_symbol' => :'String',
    :'currency_decimal_places' => :'Integer',
    :'active' => :'Boolean',
    :'include_net_worth' => :'Boolean',
    :'account_role' => :'String',
    :'credit_card_type' => :'String',
    :'monthly_payment_date' => :'Date',
    :'liability_type' => :'String',
    :'liability_amount' => :'Float',
    :'liability_start_date' => :'Date',
    :'interest' => :'Float',
    :'interest_period' => :'String',
    :'notes' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



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

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      name == o.name &&
      type == o.type &&
      iban == o.iban &&
      bic == o.bic &&
       == o. &&
      opening_balance == o.opening_balance &&
      opening_balance_date == o.opening_balance_date &&
      virtual_balance == o.virtual_balance &&
      current_balance == o.current_balance &&
      current_balance_date == o.current_balance_date &&
      currency_id == o.currency_id &&
      currency_code == o.currency_code &&
      currency_symbol == o.currency_symbol &&
      currency_decimal_places == o.currency_decimal_places &&
      active == o.active &&
      include_net_worth == o.include_net_worth &&
       == o. &&
      credit_card_type == o.credit_card_type &&
      monthly_payment_date == o.monthly_payment_date &&
      liability_type == o.liability_type &&
      liability_amount == o.liability_amount &&
      liability_start_date == o.liability_start_date &&
      interest == o.interest &&
      interest_period == o.interest_period &&
      notes == o.notes
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



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
507
508
509
510
511
512
513
514
 
# File 'lib/firefly_iii_client/models/account.rb', line 477

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



548
549
550
551
552
553
554
555
556
557
558
559
560
 
# File 'lib/firefly_iii_client/models/account.rb', line 548

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



454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
 
# File 'lib/firefly_iii_client/models/account.rb', line 454

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


434
435
436
 
# File 'lib/firefly_iii_client/models/account.rb', line 434

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



440
441
442
 
# File 'lib/firefly_iii_client/models/account.rb', line 440

def hash
  [created_at, updated_at, name, type, iban, bic, , opening_balance, opening_balance_date, virtual_balance, current_balance, current_balance_date, currency_id, currency_code, currency_symbol, currency_decimal_places, active, include_net_worth, , credit_card_type, monthly_payment_date, liability_type, liability_amount, liability_start_date, interest, interest_period, notes].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



312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/firefly_iii_client/models/account.rb', line 312

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

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

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



524
525
526
 
# File 'lib/firefly_iii_client/models/account.rb', line 524

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



530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/firefly_iii_client/models/account.rb', line 530

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



518
519
520
 
# File 'lib/firefly_iii_client/models/account.rb', line 518

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



331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
 
# File 'lib/firefly_iii_client/models/account.rb', line 331

def valid?
  return false if @name.nil?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["asset", "expense", "import", "revenue", "cash", "liability", "liabilities", "initial-balance", "reconciliation"])
  return false unless type_validator.valid?(@type)
  return false if @account_role.nil?
   = EnumAttributeValidator.new('String', ["defaultAsset", "sharedAsset", "savingAsset", "ccAsset", "cashWalletAsset"])
  return false unless .valid?(@account_role)
  credit_card_type_validator = EnumAttributeValidator.new('String', ["monthlyFull"])
  return false unless credit_card_type_validator.valid?(@credit_card_type)
  liability_type_validator = EnumAttributeValidator.new('String', ["loan", "debt", "mortgage"])
  return false unless liability_type_validator.valid?(@liability_type)
  interest_period_validator = EnumAttributeValidator.new('String', ["daily", "monthly", "yearly"])
  return false unless interest_period_validator.valid?(@interest_period)
  true
end