class FireflyIIIClient::Recurrence

Attributes

active[RW]

If the recurrence is even active.

apply_rules[RW]

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

created_at[RW]
description[RW]

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

first_date[RW]

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

latest_date[RW]

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

notes[RW]
nr_of_repetitions[RW]

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

repeat_until[RW]

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

repetitions[RW]
title[RW]
transactions[RW]
type[RW]
updated_at[RW]

Public Class Methods

acceptable_attributes() click to toggle source

Returns all the JSON keys this model knows about

# File lib/firefly_iii_client/models/recurrence.rb, line 96
def self.acceptable_attributes
  attribute_map.values
end
attribute_map() click to toggle source

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

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# File lib/firefly_iii_client/models/recurrence.rb, line 278
def self.build_from_hash(attributes)
  new.build_from_hash(attributes)
end
new(attributes = {}) click to toggle source

Initializes the object @param [Hash] attributes Model attributes in the form of hash

# 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
openapi_nullable() click to toggle source

List of attributes with nullable: true

# File lib/firefly_iii_client/models/recurrence.rb, line 121
def self.openapi_nullable
  Set.new([
  ])
end
openapi_types() click to toggle source

Attribute type mapping.

# 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

Public Instance Methods

==(o) click to toggle source

Checks equality by comparing each attribute. @param [Object] Object to be compared

# 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) click to toggle source

Deserializes the data based on type @param string type Data type @param string value Value to be deserialized @return [Object] Deserialized data

# 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) click to toggle source

Outputs non-array value in the form of hash For object, use to_hash. Otherwise, just return the value @param [Object] value Any valid value @return [Hash] Returns the value in the form of hash

# 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) click to toggle source

Builds the object from hash @param [Hash] attributes Model attributes in the form of hash @return [Object] Returns the model itself

# 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) click to toggle source

@see the `==` method @param [Object] Object to be compared

# File lib/firefly_iii_client/models/recurrence.rb, line 265
def eql?(o)
  self == o
end
hash() click to toggle source

Calculates hash code according to all attributes. @return [Integer] Hash code

# 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() click to toggle source

Show invalid properties with the reasons. Usually used together with valid? @return Array for valid properties with the reasons

# 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() click to toggle source

to_body is an alias to to_hash (backward compatibility) @return [Hash] Returns the object in the form of hash

# File lib/firefly_iii_client/models/recurrence.rb, line 355
def to_body
  to_hash
end
to_hash() click to toggle source

Returns the object in the form of hash @return [Hash] Returns the object in the form of hash

# 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() click to toggle source

Returns the string representation of the object @return [String] String presentation of the object

# File lib/firefly_iii_client/models/recurrence.rb, line 349
def to_s
  to_hash.to_s
end
type=(type) click to toggle source

Custom attribute writer method checking allowed values (enum). @param [Object] type Object to be assigned

# File lib/firefly_iii_client/models/recurrence.rb, line 234
def type=(type)
  validator = EnumAttributeValidator.new('String', ["withdrawal", "transfer", "deposit", "opening-balance", "reconciliation"])
  unless validator.valid?(type)
    fail ArgumentError, "invalid value for \"type\", must be one of #{validator.allowable_values}."
  end
  @type = type
end
valid?() click to toggle source

Check to see if the all the properties in the model are valid @return true if the model is valid

# 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