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



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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#account_id ⇒ Object

Returns the value of attribute account_id.



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

def 
  @account_id
end

#amount ⇒ Object

The scheduled transaction amount in milliunits format



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

def amount
  @amount
end

#category_id ⇒ Object

Returns the value of attribute category_id.



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

def category_id
  @category_id
end

#date_first ⇒ Object

The first date for which the Scheduled Transaction was scheduled.



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

def date_first
  @date_first
end

#date_next ⇒ Object

The next date for which the Scheduled Transaction is scheduled.



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

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.



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

def deleted
  @deleted
end

#flag_color ⇒ Object

The scheduled transaction flag



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

def flag_color
  @flag_color
end

#frequency ⇒ Object

Returns the value of attribute frequency.



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

def frequency
  @frequency
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#memo ⇒ Object

Returns the value of attribute memo.



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

def memo
  @memo
end

#payee_id ⇒ Object

Returns the value of attribute payee_id.



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

def payee_id
  @payee_id
end

#transfer_account_id ⇒ Object

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



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

def 
  @transfer_account_id
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



89
90
91
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 89

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



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

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

.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



256
257
258
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 256

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

.openapi_nullable ⇒ Object

List of attributes with nullable: true



112
113
114
115
116
117
118
119
120
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 112

def self.openapi_nullable
  Set.new([
    :'memo',
    :'flag_color',
    :'payee_id',
    :'category_id',
    :'transfer_account_id',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 94

def self.openapi_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



224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 224

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 287

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 = YNAB.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



358
359
360
361
362
363
364
365
366
367
368
369
370
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 358

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



263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 263

def build_from_hash(attributes)
  return nil unless attributes.is_a?(Hash)
  attributes = attributes.transform_keys(&:to_sym)
  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


243
244
245
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 243

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



249
250
251
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 249

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



188
189
190
191
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 188

def list_invalid_properties
  invalid_properties = Array.new
  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



334
335
336
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 334

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



340
341
342
343
344
345
346
347
348
349
350
351
352
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 340

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



328
329
330
 
# File 'lib/ynab/models/scheduled_transaction_summary.rb', line 328

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



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

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?
  flag_color_validator = EnumAttributeValidator.new('String', ["red", "orange", "yellow", "green", "blue", "purple", "null"])
  return false unless flag_color_validator.valid?(@flag_color)
  return false if @account_id.nil?
  return false if @deleted.nil?
  true
end