Class: FireflyIIIClient::Recurrence

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Recurrence

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#active ⇒ Object

If the recurrence is even active.



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

def active
  @active
end

#apply_rules ⇒ Object

Whether or not to fire the rules after the creation of a transaction.



42
43
44
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 42

def apply_rules
  @apply_rules
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Not to be confused with the description of the actual transaction(s) being created.



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

def description
  @description
end

#first_date ⇒ Object

First time the recurring transaction will fire. Must be after today.



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

def first_date
  @first_date
end

#latest_date ⇒ Object

First time the recurring transaction will fire. Must be after today.



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

def latest_date
  @latest_date
end

#notes ⇒ Object

Returns the value of attribute notes.



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

def notes
  @notes
end

#nr_of_repetitions ⇒ Object

Max number of created transactions. Use either this field or repeat_until.



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

def nr_of_repetitions
  @nr_of_repetitions
end

#repeat_until ⇒ Object

Date until the recurring transaction can fire. Use either this field or repetitions.



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

def repeat_until
  @repeat_until
end

#repetitions ⇒ Object

Returns the value of attribute repetitions.



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

def repetitions
  @repetitions
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

#transactions ⇒ Object

Returns the value of attribute transactions.



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

def transactions
  @transactions
end

#type ⇒ Object

Returns the value of attribute type.



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

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



96
97
98
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 96

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 76

def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'type' => :'type',
    :'title' => :'title',
    :'description' => :'description',
    :'first_date' => :'first_date',
    :'latest_date' => :'latest_date',
    :'repeat_until' => :'repeat_until',
    :'nr_of_repetitions' => :'nr_of_repetitions',
    :'apply_rules' => :'apply_rules',
    :'active' => :'active',
    :'notes' => :'notes',
    :'repetitions' => :'repetitions',
    :'transactions' => :'transactions'
  }
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



278
279
280
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 278

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



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

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

.openapi_types ⇒ Object

Attribute type mapping.



101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 101

def self.openapi_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'type' => :'String',
    :'title' => :'String',
    :'description' => :'String',
    :'first_date' => :'Date',
    :'latest_date' => :'Date',
    :'repeat_until' => :'Date',
    :'nr_of_repetitions' => :'Integer',
    :'apply_rules' => :'Boolean',
    :'active' => :'Boolean',
    :'notes' => :'String',
    :'repetitions' => :'Array<RecurrenceRepetition>',
    :'transactions' => :'Array<RecurrenceTransaction>'
  }
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
 
# File 'lib/firefly_iii_client/models/recurrence.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 &&
      type == o.type &&
      title == o.title &&
      description == o.description &&
      first_date == o.first_date &&
      latest_date == o.latest_date &&
      repeat_until == o.repeat_until &&
      nr_of_repetitions == o.nr_of_repetitions &&
      apply_rules == o.apply_rules &&
      active == o.active &&
      notes == o.notes &&
      repetitions == o.repetitions &&
      transactions == o.transactions
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



308
309
310
311
312
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
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 308

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



379
380
381
382
383
384
385
386
387
388
389
390
391
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 379

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



285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 285

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


265
266
267
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 265

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



271
272
273
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 271

def hash
  [created_at, updated_at, type, title, description, first_date, latest_date, repeat_until, nr_of_repetitions, apply_rules, active, notes, repetitions, transactions].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



204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 204

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

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

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



355
356
357
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 355

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



361
362
363
364
365
366
367
368
369
370
371
372
373
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 361

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



349
350
351
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 349

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



223
224
225
226
227
228
229
230
 
# File 'lib/firefly_iii_client/models/recurrence.rb', line 223

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["withdrawal", "transfer", "deposit", "opening-balance", "reconciliation"])
  return false unless type_validator.valid?(@type)
  return false if @title.nil?
  return false if @first_date.nil?
  true
end