class FireflyIIIClient::Rule

Attributes

actions[RW]
active[RW]

Whether or not the rule is even active. Default is true.

created_at[RW]
description[RW]
order[RW]
rule_group_id[RW]

ID of the rule group under which the rule must be stored. Either this field or rule_group_title is mandatory.

rule_group_title[RW]

Title of the rule group under which the rule must be stored. Either this field or rule_group_id is mandatory.

stop_processing[RW]

If this value is true and the rule is triggered, other rules after this one in the group will be skipped. Default value is false.

strict[RW]

If the rule is set to be strict, ALL triggers must hit in order for the rule to fire. Otherwise, just one is enough. Default value is true.

title[RW]
trigger[RW]

Which action is necessary for the rule to fire? Use either store-journal or update-journal.

triggers[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/rule.rb, line 92
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/rule.rb, line 73
def self.attribute_map
  {
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'title' => :'title',
    :'description' => :'description',
    :'rule_group_id' => :'rule_group_id',
    :'rule_group_title' => :'rule_group_title',
    :'order' => :'order',
    :'trigger' => :'trigger',
    :'active' => :'active',
    :'strict' => :'strict',
    :'stop_processing' => :'stop_processing',
    :'triggers' => :'triggers',
    :'actions' => :'actions'
  }
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/rule.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/rule.rb, line 123
def initialize(attributes = {})
  if (!attributes.is_a?(Hash))
    fail ArgumentError, "The input argument (attributes) must be a hash in `FireflyIIIClient::Rule` 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::Rule`. 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?(:'title')
    self.title = attributes[:'title']
  end

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

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

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

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

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

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

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

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

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

  if attributes.key?(:'actions')
    if (value = attributes[:'actions']).is_a?(Array)
      self.actions = value
    end
  end
end
openapi_nullable() click to toggle source

List of attributes with nullable: true

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

Attribute type mapping.

# File lib/firefly_iii_client/models/rule.rb, line 97
def self.openapi_types
  {
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'title' => :'String',
    :'description' => :'String',
    :'rule_group_id' => :'Integer',
    :'rule_group_title' => :'String',
    :'order' => :'Integer',
    :'trigger' => :'String',
    :'active' => :'Boolean',
    :'strict' => :'Boolean',
    :'stop_processing' => :'Boolean',
    :'triggers' => :'Array<RuleTrigger>',
    :'actions' => :'Array<RuleAction>'
  }
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/rule.rb, line 245
def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      title == o.title &&
      description == o.description &&
      rule_group_id == o.rule_group_id &&
      rule_group_title == o.rule_group_title &&
      order == o.order &&
      trigger == o.trigger &&
      active == o.active &&
      strict == o.strict &&
      stop_processing == o.stop_processing &&
      triggers == o.triggers &&
      actions == o.actions
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/rule.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/rule.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/rule.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/rule.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/rule.rb, line 271
def hash
  [created_at, updated_at, title, description, rule_group_id, rule_group_title, order, trigger, active, strict, stop_processing, triggers, actions].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/rule.rb, line 195
def list_invalid_properties
  invalid_properties = Array.new
  if @title.nil?
    invalid_properties.push('invalid value for "title", title cannot be nil.')
  end

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

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

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

  if @actions.nil?
    invalid_properties.push('invalid value for "actions", actions 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/rule.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/rule.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/rule.rb, line 349
def to_s
  to_hash.to_s
end
trigger=(trigger) click to toggle source

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

# File lib/firefly_iii_client/models/rule.rb, line 235
def trigger=(trigger)
  validator = EnumAttributeValidator.new('String', ["store-journal", "update-journal"])
  unless validator.valid?(trigger)
    fail ArgumentError, "invalid value for \"trigger\", must be one of #{validator.allowable_values}."
  end
  @trigger = trigger
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/rule.rb, line 222
def valid?
  return false if @title.nil?
  return false if @rule_group_id.nil?
  return false if @trigger.nil?
  trigger_validator = EnumAttributeValidator.new('String', ["store-journal", "update-journal"])
  return false unless trigger_validator.valid?(@trigger)
  return false if @triggers.nil?
  return false if @actions.nil?
  true
end