Class: FireflyIIIClient::RuleTrigger

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RuleTrigger

Initializes the object

Parameters:

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

    Model attributes in the form of hash



102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 102

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

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

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

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

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

Instance Attribute Details

#activeObject

If the trigger is active.



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

def active
  @active
end

#created_atObject

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#idObject

Returns the value of attribute id.



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

def id
  @id
end

#orderObject

Order of the trigger



31
32
33
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 31

def order
  @order
end

#stop_processingObject

When true, other triggers will not be checked if this trigger was triggered.



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

def stop_processing
  @stop_processing
end

#typeObject

The type of thing this trigger responds to. A limited set is possible



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

def type
  @type
end

#updated_atObject

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#valueObject

The accompanying value the trigger responds to. This value is often mandatory, but this depends on the trigger.



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

def value
  @value
end

Class Method Details

.acceptable_attributesObject

Returns all the JSON keys this model knows about



76
77
78
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 76

def self.acceptable_attributes
  attribute_map.values
end

.attribute_mapObject

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



62
63
64
65
66
67
68
69
70
71
72
73
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 62

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'type' => :'type',
    :'value' => :'value',
    :'order' => :'order',
    :'active' => :'active',
    :'stop_processing' => :'stop_processing'
  }
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



213
214
215
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 213

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

.openapi_nullableObject

List of attributes with nullable: true



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

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

.openapi_typesObject

Attribute type mapping.



81
82
83
84
85
86
87
88
89
90
91
92
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 81

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'type' => :'String',
    :'value' => :'String',
    :'order' => :'Integer',
    :'active' => :'Boolean',
    :'stop_processing' => :'Boolean'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object)

    to be compared



185
186
187
188
189
190
191
192
193
194
195
196
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 185

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      created_at == o.created_at &&
      updated_at == o.updated_at &&
      type == o.type &&
      value == o.value &&
      order == o.order &&
      active == o.active &&
      stop_processing == o.stop_processing
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



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 243

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



314
315
316
317
318
319
320
321
322
323
324
325
326
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 314

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



220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 220

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


200
201
202
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 200

def eql?(o)
  self == o
end

#hashInteger

Calculates hash code according to all attributes.

Returns:

  • (Integer)

    Hash code



206
207
208
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 206

def hash
  [id, created_at, updated_at, type, value, order, active, stop_processing].hash
end

#list_invalid_propertiesObject

Show invalid properties with the reasons. Usually used together with valid?

Returns:

  • Array for valid properties with the reasons



150
151
152
153
154
155
156
157
158
159
160
161
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 150

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

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

  invalid_properties
end

#to_bodyHash

to_body is an alias to to_hash (backward compatibility)

Returns:

  • (Hash)

    Returns the object in the form of hash



290
291
292
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 290

def to_body
  to_hash
end

#to_hashHash

Returns the object in the form of hash

Returns:

  • (Hash)

    Returns the object in the form of hash



296
297
298
299
300
301
302
303
304
305
306
307
308
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 296

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_sString

Returns the string representation of the object

Returns:

  • (String)

    String presentation of the object



284
285
286
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 284

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



165
166
167
168
169
170
171
# File 'lib/firefly_iii_client/models/rule_trigger.rb', line 165

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["from_account_starts", "from_account_ends", "from_account_is", "from_account_contains", "to_account_starts", "to_account_ends", "to_account_is", "to_account_contains", "amount_less", "amount_exactly", "amount_more", "description_starts", "description_ends", "description_contains", "description_is", "transaction_type", "category_is", "budget_is", "tag_is", "currency_is", "has_attachments", "has_no_category", "has_any_category", "has_no_budget", "has_any_budget", "has_no_tag", "has_any_tag", "notes_contain", "notes_start", "notes_end", "notes_are", "no_notes", "any_notes"])
  return false unless type_validator.valid?(@type)
  return false if @value.nil?
  true
end