Class: FireflyIIIClient::PiggyBank

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ PiggyBank

Initializes the object

Parameters:

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

    Model attributes in the form of hash



124
125
126
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
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
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

The ID of the asset account this piggy bank is connected to.



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

def 
  @account_id
end

#account_name ⇒ Object

The name of the asset account this piggy bank is connected to.



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

def 
  @account_name
end

#active ⇒ Object

Returns the value of attribute active.



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

def active
  @active
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#currency_code ⇒ Object

Returns the value of attribute currency_code.



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

def currency_code
  @currency_code
end

#currency_decimal_places ⇒ Object

Number of decimals supported by the currency



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

def currency_decimal_places
  @currency_decimal_places
end

#currency_id ⇒ Object

Returns the value of attribute currency_id.



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

def currency_id
  @currency_id
end

#currency_symbol ⇒ Object

Returns the value of attribute currency_symbol.



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

def currency_symbol
  @currency_symbol
end

#current_amount ⇒ Object

Returns the value of attribute current_amount.



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

def current_amount
  @current_amount
end

#left_to_save ⇒ Object

Returns the value of attribute left_to_save.



45
46
47
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 45

def left_to_save
  @left_to_save
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#notes ⇒ Object

Returns the value of attribute notes.



59
60
61
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 59

def notes
  @notes
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#percentage ⇒ Object

Returns the value of attribute percentage.



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

def percentage
  @percentage
end

#save_per_month ⇒ Object

Returns the value of attribute save_per_month.



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

def save_per_month
  @save_per_month
end

#start_date ⇒ Object

The date you started with this piggy bank.



50
51
52
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 50

def start_date
  @start_date
end

#target_amount ⇒ Object

Returns the value of attribute target_amount.



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

def target_amount
  @target_amount
end

#target_date ⇒ Object

The date you intend to finish saving money.



53
54
55
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 53

def target_date
  @target_date
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



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

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 62

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'name' => :'name',
    :'account_id' => :'account_id',
    :'account_name' => :'account_name',
    :'currency_id' => :'currency_id',
    :'currency_code' => :'currency_code',
    :'currency_symbol' => :'currency_symbol',
    :'currency_decimal_places' => :'currency_decimal_places',
    :'target_amount' => :'target_amount',
    :'percentage' => :'percentage',
    :'current_amount' => :'current_amount',
    :'left_to_save' => :'left_to_save',
    :'save_per_month' => :'save_per_month',
    :'start_date' => :'start_date',
    :'target_date' => :'target_date',
    :'order' => :'order',
    :'active' => :'active',
    :'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



283
284
285
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 283

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



117
118
119
120
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 117

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

.openapi_types ⇒ Object

Attribute type mapping.



92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 92

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'name' => :'String',
    :'account_id' => :'Integer',
    :'account_name' => :'String',
    :'currency_id' => :'Integer',
    :'currency_code' => :'String',
    :'currency_symbol' => :'String',
    :'currency_decimal_places' => :'Integer',
    :'target_amount' => :'Float',
    :'percentage' => :'Float',
    :'current_amount' => :'Float',
    :'left_to_save' => :'Float',
    :'save_per_month' => :'Float',
    :'start_date' => :'Date',
    :'target_date' => :'Date',
    :'order' => :'Integer',
    :'active' => :'Boolean',
    :'notes' => :'String'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 244

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 &&
       == o. &&
       == o. &&
      currency_id == o.currency_id &&
      currency_code == o.currency_code &&
      currency_symbol == o.currency_symbol &&
      currency_decimal_places == o.currency_decimal_places &&
      target_amount == o.target_amount &&
      percentage == o.percentage &&
      current_amount == o.current_amount &&
      left_to_save == o.left_to_save &&
      save_per_month == o.save_per_month &&
      start_date == o.start_date &&
      target_date == o.target_date &&
      order == o.order &&
      active == o.active &&
      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



313
314
315
316
317
318
319
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
350
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 313

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



384
385
386
387
388
389
390
391
392
393
394
395
396
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 384

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



290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 290

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


270
271
272
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 270

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



276
277
278
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 276

def hash
  [created_at, updated_at, name, , , currency_id, currency_code, currency_symbol, currency_decimal_places, target_amount, percentage, current_amount, left_to_save, save_per_month, start_date, target_date, order, active, 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



216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 216

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

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

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



360
361
362
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 360

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



366
367
368
369
370
371
372
373
374
375
376
377
378
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 366

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



354
355
356
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 354

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



235
236
237
238
239
240
 
# File 'lib/firefly_iii_client/models/piggy_bank.rb', line 235

def valid?
  return false if @name.nil?
  return false if @account_id.nil?
  return false if @target_amount.nil?
  true
end