Class: FireflyIIIClient::Bill

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Bill

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

If the bill is active.



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

def active
  @active
end

#amount_max ⇒ Object

Returns the value of attribute amount_max.



36
37
38
 
# File 'lib/firefly_iii_client/models/bill.rb', line 36

def amount_max
  @amount_max
end

#amount_min ⇒ Object

Returns the value of attribute amount_min.



34
35
36
 
# File 'lib/firefly_iii_client/models/bill.rb', line 34

def amount_min
  @amount_min
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currency_code ⇒ Object

Use either currency_id or currency_code



26
27
28
 
# File 'lib/firefly_iii_client/models/bill.rb', line 26

def currency_code
  @currency_code
end

#currency_decimal_places ⇒ Object

Returns the value of attribute currency_decimal_places.



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

def currency_decimal_places
  @currency_decimal_places
end

#currency_id ⇒ Object

Use either currency_id or currency_code



23
24
25
 
# File 'lib/firefly_iii_client/models/bill.rb', line 23

def currency_id
  @currency_id
end

#currency_symbol ⇒ Object

Returns the value of attribute currency_symbol.



28
29
30
 
# File 'lib/firefly_iii_client/models/bill.rb', line 28

def currency_symbol
  @currency_symbol
end

#date ⇒ Object

Returns the value of attribute date.



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

def date
  @date
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#next_expected_match ⇒ Object

When the bill is expected to be due.



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

def next_expected_match
  @next_expected_match
end

#notes ⇒ Object

Returns the value of attribute notes.



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

def notes
  @notes
end

Array of past transactions when the bill was paid.



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

def paid_dates
  @paid_dates
end

#pay_dates ⇒ Object

Array of future dates when the bill is expected to be paid. Autogenerated.



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

def pay_dates
  @pay_dates
end

#repeat_freq ⇒ Object

How often the bill must be paid.



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

def repeat_freq
  @repeat_freq
end

#skip ⇒ Object

How often the bill must be skipped. 1 means a bi-monthly bill.



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

def skip
  @skip
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



106
107
108
 
# File 'lib/firefly_iii_client/models/bill.rb', line 106

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/firefly_iii_client/models/bill.rb', line 83

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'currency_id' => :'currency_id',
    :'currency_code' => :'currency_code',
    :'currency_symbol' => :'currency_symbol',
    :'currency_decimal_places' => :'currency_decimal_places',
    :'name' => :'name',
    :'amount_min' => :'amount_min',
    :'amount_max' => :'amount_max',
    :'date' => :'date',
    :'repeat_freq' => :'repeat_freq',
    :'skip' => :'skip',
    :'active' => :'active',
    :'notes' => :'notes',
    :'next_expected_match' => :'next_expected_match',
    :'pay_dates' => :'pay_dates',
    :'paid_dates' => :'paid_dates'
  }
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



316
317
318
 
# File 'lib/firefly_iii_client/models/bill.rb', line 316

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



134
135
136
137
 
# File 'lib/firefly_iii_client/models/bill.rb', line 134

def self.openapi_nullable
  Set.new([
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
 
# File 'lib/firefly_iii_client/models/bill.rb', line 111

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'currency_id' => :'Integer',
    :'currency_code' => :'String',
    :'currency_symbol' => :'String',
    :'currency_decimal_places' => :'Integer',
    :'name' => :'String',
    :'amount_min' => :'Float',
    :'amount_max' => :'Float',
    :'date' => :'Date',
    :'repeat_freq' => :'String',
    :'skip' => :'Integer',
    :'active' => :'Boolean',
    :'notes' => :'String',
    :'next_expected_match' => :'Date',
    :'pay_dates' => :'Array<Date>',
    :'paid_dates' => :'Array<BillPaidDates>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/firefly_iii_client/models/bill.rb', line 279

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      currency_id == o.currency_id &&
      currency_code == o.currency_code &&
      currency_symbol == o.currency_symbol &&
      currency_decimal_places == o.currency_decimal_places &&
      name == o.name &&
      amount_min == o.amount_min &&
      amount_max == o.amount_max &&
      date == o.date &&
      repeat_freq == o.repeat_freq &&
      skip == o.skip &&
      active == o.active &&
      notes == o.notes &&
      next_expected_match == o.next_expected_match &&
      pay_dates == o.pay_dates &&
      paid_dates == o.paid_dates
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



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
377
378
379
380
381
382
383
 
# File 'lib/firefly_iii_client/models/bill.rb', line 346

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



417
418
419
420
421
422
423
424
425
426
427
428
429
 
# File 'lib/firefly_iii_client/models/bill.rb', line 417

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



323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
 
# File 'lib/firefly_iii_client/models/bill.rb', line 323

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


303
304
305
 
# File 'lib/firefly_iii_client/models/bill.rb', line 303

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



309
310
311
 
# File 'lib/firefly_iii_client/models/bill.rb', line 309

def hash
  [created_at, updated_at, currency_id, currency_code, currency_symbol, currency_decimal_places, name, amount_min, amount_max, date, repeat_freq, skip, active, notes, next_expected_match, pay_dates, paid_dates].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



229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
 
# File 'lib/firefly_iii_client/models/bill.rb', line 229

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

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

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

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

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



393
394
395
 
# File 'lib/firefly_iii_client/models/bill.rb', line 393

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



399
400
401
402
403
404
405
406
407
408
409
410
411
 
# File 'lib/firefly_iii_client/models/bill.rb', line 399

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



387
388
389
 
# File 'lib/firefly_iii_client/models/bill.rb', line 387

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



256
257
258
259
260
261
262
263
264
265
 
# File 'lib/firefly_iii_client/models/bill.rb', line 256

def valid?
  return false if @name.nil?
  return false if @amount_min.nil?
  return false if @amount_max.nil?
  return false if @date.nil?
  return false if @repeat_freq.nil?
  repeat_freq_validator = EnumAttributeValidator.new('String', ["weekly", "monthly", "quarterly", "half-year", "yearly"])
  return false unless repeat_freq_validator.valid?(@repeat_freq)
  true
end