Class: FireflyIIIClient::Rule

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ Rule

Initializes the object

Parameters:

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

    Model attributes in the form of hash



123
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
 
# 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

Instance Attribute Details

#actions ⇒ Object

Returns the value of attribute actions.



48
49
50
 
# File 'lib/firefly_iii_client/models/rule.rb', line 48

def actions
  @actions
end

#active ⇒ Object

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



38
39
40
 
# File 'lib/firefly_iii_client/models/rule.rb', line 38

def active
  @active
end

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Returns the value of attribute description.



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

def description
  @description
end

#order ⇒ Object

Returns the value of attribute order.



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

def order
  @order
end

#rule_group_id ⇒ Object

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



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

def rule_group_id
  @rule_group_id
end

#rule_group_title ⇒ Object

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



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

def rule_group_title
  @rule_group_title
end

#stop_processing ⇒ Object

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.



44
45
46
 
# File 'lib/firefly_iii_client/models/rule.rb', line 44

def stop_processing
  @stop_processing
end

#strict ⇒ Object

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.



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

def strict
  @strict
end

#title ⇒ Object

Returns the value of attribute title.



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

def title
  @title
end

#trigger ⇒ Object

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



35
36
37
 
# File 'lib/firefly_iii_client/models/rule.rb', line 35

def trigger
  @trigger
end

#triggers ⇒ Object

Returns the value of attribute triggers.



46
47
48
 
# File 'lib/firefly_iii_client/models/rule.rb', line 46

def triggers
  @triggers
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



92
93
94
 
# File 'lib/firefly_iii_client/models/rule.rb', line 92

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
 
# 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) ⇒ 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/rule.rb', line 278

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



116
117
118
119
 
# File 'lib/firefly_iii_client/models/rule.rb', line 116

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

.openapi_types ⇒ Object

Attribute type mapping.



97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
 
# 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

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
 
# 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) ⇒ 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/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) ⇒ 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/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) ⇒ 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/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) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


265
266
267
 
# File 'lib/firefly_iii_client/models/rule.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/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 ⇒ Object

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

Returns:

  • Array for valid properties with the reasons



195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# 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 ⇒ 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/rule.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/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 ⇒ String

Returns the string representation of the object

Returns:

  • (String) —

    String presentation of the object



349
350
351
 
# File 'lib/firefly_iii_client/models/rule.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



222
223
224
225
226
227
228
229
230
231
 
# 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