Class: YNAB::ScheduledTransactionSummary

Inherits:
Object
  • Object
show all
Defined in:
lib/ynab/models/scheduled_transaction_summary.rb

Defined Under Namespace

Classes: EnumAttributeValidator

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ ScheduledTransactionSummary

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
158
159
160
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 107

def initialize(attributes = {})
  return unless attributes.is_a?(Hash)

  # convert string to symbol for hash key
  attributes = attributes.each_with_object({}) { |(k, v), h| h[k.to_sym] = v }

  if attributes.has_key?(:'id')
    self.id = attributes[:'id']
  end

  if attributes.has_key?(:'date_first')
    self.date_first = attributes[:'date_first']
  end

  if attributes.has_key?(:'date_next')
    self.date_next = attributes[:'date_next']
  end

  if attributes.has_key?(:'frequency')
    self.frequency = attributes[:'frequency']
  end

  if attributes.has_key?(:'amount')
    self.amount = attributes[:'amount']
  end

  if attributes.has_key?(:'memo')
    self.memo = attributes[:'memo']
  end

  if attributes.has_key?(:'flag_color')
    self.flag_color = attributes[:'flag_color']
  end

  if attributes.has_key?(:'account_id')
    self. = attributes[:'account_id']
  end

  if attributes.has_key?(:'payee_id')
    self.payee_id = attributes[:'payee_id']
  end

  if attributes.has_key?(:'category_id')
    self.category_id = attributes[:'category_id']
  end

  if attributes.has_key?(:'transfer_account_id')
    self. = attributes[:'transfer_account_id']
  end

  if attributes.has_key?(:'deleted')
    self.deleted = attributes[:'deleted']
  end
end

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



35
36
37
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 35

def 
  @account_id
end

#amount ⇒ Object

The scheduled transaction amount in milliunits format



28
29
30
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 28

def amount
  @amount
end

#category_id ⇒ Object

Returns the value of attribute category_id.



39
40
41
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 39

def category_id
  @category_id
end

#date_first ⇒ Object

The first date for which the Scheduled Transaction was scheduled.



20
21
22
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 20

def date_first
  @date_first
end

#date_next ⇒ Object

The next date for which the Scheduled Transaction is scheduled.



23
24
25
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 23

def date_next
  @date_next
end

#deleted ⇒ Object

Whether or not the scheduled transaction has been deleted. Deleted scheduled transactions will only be included in delta requests.



45
46
47
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 45

def deleted
  @deleted
end

#flag_color ⇒ Object

The scheduled transaction flag



33
34
35
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 33

def flag_color
  @flag_color
end

#frequency ⇒ Object

Returns the value of attribute frequency.



25
26
27
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 25

def frequency
  @frequency
end

#id ⇒ Object

Returns the value of attribute id.



17
18
19
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 17

def id
  @id
end

#memo ⇒ Object

Returns the value of attribute memo.



30
31
32
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 30

def memo
  @memo
end

#payee_id ⇒ Object

Returns the value of attribute payee_id.



37
38
39
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 37

def payee_id
  @payee_id
end

#transfer_account_id ⇒ Object

If a transfer, the account_id which the scheduled transaction transfers to



42
43
44
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 42

def 
  @transfer_account_id
end

Class Method Details

.attribute_map ⇒ Object

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



70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 70

def self.attribute_map
  {
    :'id' => :'id',
    :'date_first' => :'date_first',
    :'date_next' => :'date_next',
    :'frequency' => :'frequency',
    :'amount' => :'amount',
    :'memo' => :'memo',
    :'flag_color' => :'flag_color',
    :'account_id' => :'account_id',
    :'payee_id' => :'payee_id',
    :'category_id' => :'category_id',
    :'transfer_account_id' => :'transfer_account_id',
    :'deleted' => :'deleted'
  }
end

.swagger_types ⇒ Object

Attribute type mapping.



88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 88

def self.swagger_types
  {
    :'id' => :'String',
    :'date_first' => :'Date',
    :'date_next' => :'Date',
    :'frequency' => :'String',
    :'amount' => :'Integer',
    :'memo' => :'String',
    :'flag_color' => :'String',
    :'account_id' => :'String',
    :'payee_id' => :'String',
    :'category_id' => :'String',
    :'transfer_account_id' => :'String',
    :'deleted' => :'BOOLEAN'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 261

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      date_first == o.date_first &&
      date_next == o.date_next &&
      frequency == o.frequency &&
      amount == o.amount &&
      memo == o.memo &&
      flag_color == o.flag_color &&
       == o. &&
      payee_id == o.payee_id &&
      category_id == o.category_id &&
       == o. &&
      deleted == o.deleted
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



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
346
347
348
349
350
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 314

def _deserialize(type, value)
  case type.to_sym
  when :DateTime
    DateTime.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
    temp_model = YNAB.const_get(type).new
    temp_model.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



380
381
382
383
384
385
386
387
388
389
390
391
392
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 380

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



293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 293

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  self.class.swagger_types.each_pair do |key, type|
    if type =~ /\AArray<(.*)>/i
      # check to ensure the input is an array given that the 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 # or else data not found in attributes(hash), not an issue as the data can be optional
  end

  self
end

#eql?(o) ⇒ Boolean

Parameters:

  • Object (Object) —

    to be compared

Returns:

  • (Boolean)

See Also:

  • `==` method


280
281
282
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 280

def eql?(o)
  self == o
end

#hash ⇒ Fixnum

Calculates hash code according to all attributes.

Returns:

  • (Fixnum) —

    Hash code



286
287
288
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 286

def hash
  [id, date_first, date_next, frequency, amount, memo, flag_color, , payee_id, category_id, , deleted].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



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
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 164

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

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

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

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

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

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

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

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

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

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

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

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



360
361
362
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 360

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



366
367
368
369
370
371
372
373
374
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 366

def to_hash
  hash = {}
  self.class.attribute_map.each_pair do |attr, param|
    value = self.send(attr)
    next if value.nil?
    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



354
355
356
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 354

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



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

def valid?
  return false if @id.nil?
  return false if @date_first.nil?
  return false if @date_next.nil?
  return false if @frequency.nil?
  frequency_validator = EnumAttributeValidator.new('String', ['never', 'daily', 'weekly', 'everyOtherWeek', 'twiceAMonth', 'every4Weeks', 'monthly', 'everyOtherMonth', 'every3Months', 'every4Months', 'twiceAYear', 'yearly', 'everyOtherYear'])
  return false unless frequency_validator.valid?(@frequency)
  return false if @amount.nil?
  return false if @memo.nil?
  return false if @flag_color.nil?
  flag_color_validator = EnumAttributeValidator.new('String', ['red', 'orange', 'yellow', 'green', 'blue', 'purple'])
  return false unless flag_color_validator.valid?(@flag_color)
  return false if @account_id.nil?
  return false if @payee_id.nil?
  return false if @category_id.nil?
  return false if @transfer_account_id.nil?
  return false if @deleted.nil?
  true
end