Class: FireflyIIIClient::RecurrenceRepetition

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

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ RecurrenceRepetition

Initializes the object

Parameters:

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

    Model attributes in the form of hash



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
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 107

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

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

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

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

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

Instance Attribute Details

#created_at ⇒ Object

Returns the value of attribute created_at.



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

def created_at
  @created_at
end

#description ⇒ Object

Auto-generated repetition description.



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

def description
  @description
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#moment ⇒ Object

Information that defined the type of repetition. - For ‘daily’, this is empty. - For ‘weekly’, it is day of the week between 1 and 7 (Monday - Sunday). - For ‘ndom’, it is ‘1,2’ or ‘4,5’ or something else, where the first number is the week in the month, and the second number is the day in the week (between 1 and 7). ‘2,3’ means: the 2nd Wednesday of the month - For ‘monthly’ it is the day of the month (1 - 31) - For yearly, it is a full date, ie ‘2018-09-17’. The year you use does not matter.



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

def moment
  @moment
end

#occurrences ⇒ Object

Array of future dates when the repetition will apply to. Auto generated.



40
41
42
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 40

def occurrences
  @occurrences
end

#skip ⇒ Object

How many occurrences to skip. 0 means skip nothing. 1 means every other.



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

def skip
  @skip
end

#type ⇒ Object

The type of the repetition. ndom means: the n-th weekday of the month, where you can also specify which day of the week.



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

def type
  @type
end

#updated_at ⇒ Object

Returns the value of attribute updated_at.



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

def updated_at
  @updated_at
end

#weekend ⇒ Object

How to respond when the recurring transaction falls in the weekend. Possible values: 1. Do nothing, just create it 2. Create no transaction. 3. Skip to the previous Friday. 4. Skip to the next Monday.



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

def weekend
  @weekend
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



80
81
82
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 80

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



65
66
67
68
69
70
71
72
73
74
75
76
77
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 65

def self.attribute_map
  {
    :'id' => :'id',
    :'created_at' => :'created_at',
    :'updated_at' => :'updated_at',
    :'type' => :'type',
    :'moment' => :'moment',
    :'skip' => :'skip',
    :'weekend' => :'weekend',
    :'description' => :'description',
    :'occurrences' => :'occurrences'
  }
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



225
226
227
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 225

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



100
101
102
103
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 100

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

.openapi_types ⇒ Object

Attribute type mapping.



85
86
87
88
89
90
91
92
93
94
95
96
97
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 85

def self.openapi_types
  {
    :'id' => :'Integer',
    :'created_at' => :'Time',
    :'updated_at' => :'Time',
    :'type' => :'String',
    :'moment' => :'String',
    :'skip' => :'Integer',
    :'weekend' => :'Integer',
    :'description' => :'String',
    :'occurrences' => :'Array<Date>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



196
197
198
199
200
201
202
203
204
205
206
207
208
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 196

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 &&
      moment == o.moment &&
      skip == o.skip &&
      weekend == o.weekend &&
      description == o.description &&
      occurrences == o.occurrences
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



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
281
282
283
284
285
286
287
288
289
290
291
292
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 255

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



326
327
328
329
330
331
332
333
334
335
336
337
338
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 326

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



232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 232

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


212
213
214
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 212

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



218
219
220
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 218

def hash
  [id, created_at, updated_at, type, moment, skip, weekend, description, occurrences].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



161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 161

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

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



302
303
304
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 302

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



308
309
310
311
312
313
314
315
316
317
318
319
320
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 308

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



296
297
298
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 296

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



176
177
178
179
180
181
182
 
# File 'lib/firefly_iii_client/models/recurrence_repetition.rb', line 176

def valid?
  return false if @type.nil?
  type_validator = EnumAttributeValidator.new('String', ["daily", "weekly", "ndom", "monthly", "yearly"])
  return false unless type_validator.valid?(@type)
  return false if @moment.nil?
  true
end