Class: YNAB::BudgetDetail

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(attributes = {}) ⇒ BudgetDetail

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
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
216
217
218
219
220
221
222
223
224
 
# File 'lib/ynab/models/budget_detail.rb', line 124

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Instance Attribute Details

#accounts ⇒ Object

Returns the value of attribute accounts.



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

def accounts
  @accounts
end

#categories ⇒ Object

Returns the value of attribute categories.



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

def categories
  @categories
end

#category_groups ⇒ Object

Returns the value of attribute category_groups.



41
42
43
 
# File 'lib/ynab/models/budget_detail.rb', line 41

def category_groups
  @category_groups
end

#currency_format ⇒ Object

Returns the value of attribute currency_format.



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

def currency_format
  @currency_format
end

#date_format ⇒ Object

Returns the value of attribute date_format.



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

def date_format
  @date_format
end

#first_month ⇒ Object

The earliest budget month



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

def first_month
  @first_month
end

#id ⇒ Object

Returns the value of attribute id.



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

def id
  @id
end

#last_modified_on ⇒ Object

The last time any changes were made to the budget from either a web or mobile client



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

def last_modified_on
  @last_modified_on
end

#last_month ⇒ Object

The latest budget month



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

def last_month
  @last_month
end

#months ⇒ Object

Returns the value of attribute months.



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

def months
  @months
end

#name ⇒ Object

Returns the value of attribute name.



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

def name
  @name
end

#payee_locations ⇒ Object

Returns the value of attribute payee_locations.



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

def payee_locations
  @payee_locations
end

#payees ⇒ Object

Returns the value of attribute payees.



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

def payees
  @payees
end

#scheduled_subtransactions ⇒ Object

Returns the value of attribute scheduled_subtransactions.



53
54
55
 
# File 'lib/ynab/models/budget_detail.rb', line 53

def scheduled_subtransactions
  @scheduled_subtransactions
end

#scheduled_transactions ⇒ Object

Returns the value of attribute scheduled_transactions.



51
52
53
 
# File 'lib/ynab/models/budget_detail.rb', line 51

def scheduled_transactions
  @scheduled_transactions
end

#subtransactions ⇒ Object

Returns the value of attribute subtransactions.



49
50
51
 
# File 'lib/ynab/models/budget_detail.rb', line 49

def subtransactions
  @subtransactions
end

#transactions ⇒ Object

Returns the value of attribute transactions.



47
48
49
 
# File 'lib/ynab/models/budget_detail.rb', line 47

def transactions
  @transactions
end

Class Method Details

.acceptable_attributes ⇒ Object

Returns all the JSON keys this model knows about



79
80
81
 
# File 'lib/ynab/models/budget_detail.rb', line 79

def self.acceptable_attributes
  attribute_map.values
end

.attribute_map ⇒ Object

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



56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'lib/ynab/models/budget_detail.rb', line 56

def self.attribute_map
  {
    :'id' => :'id',
    :'name' => :'name',
    :'last_modified_on' => :'last_modified_on',
    :'first_month' => :'first_month',
    :'last_month' => :'last_month',
    :'date_format' => :'date_format',
    :'currency_format' => :'currency_format',
    :'accounts' => :'accounts',
    :'payees' => :'payees',
    :'payee_locations' => :'payee_locations',
    :'category_groups' => :'category_groups',
    :'categories' => :'categories',
    :'months' => :'months',
    :'transactions' => :'transactions',
    :'subtransactions' => :'subtransactions',
    :'scheduled_transactions' => :'scheduled_transactions',
    :'scheduled_subtransactions' => :'scheduled_subtransactions'
  }
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



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

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

.openapi_all_of ⇒ Object

List of class defined in allOf (OpenAPI v3)



115
116
117
118
119
120
 
# File 'lib/ynab/models/budget_detail.rb', line 115

def self.openapi_all_of
  [
  :'BudgetDetailAllOf',
  :'BudgetSummary'
  ]
end

.openapi_nullable ⇒ Object

List of attributes with nullable: true



107
108
109
110
111
112
 
# File 'lib/ynab/models/budget_detail.rb', line 107

def self.openapi_nullable
  Set.new([
    :'date_format',
    :'currency_format',
  ])
end

.openapi_types ⇒ Object

Attribute type mapping.



84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ynab/models/budget_detail.rb', line 84

def self.openapi_types
  {
    :'id' => :'String',
    :'name' => :'String',
    :'last_modified_on' => :'Time',
    :'first_month' => :'Date',
    :'last_month' => :'Date',
    :'date_format' => :'DateFormat',
    :'currency_format' => :'CurrencyFormat',
    :'accounts' => :'Array<Account>',
    :'payees' => :'Array<Payee>',
    :'payee_locations' => :'Array<PayeeLocation>',
    :'category_groups' => :'Array<CategoryGroup>',
    :'categories' => :'Array<Category>',
    :'months' => :'Array<MonthDetail>',
    :'transactions' => :'Array<TransactionSummary>',
    :'subtransactions' => :'Array<SubTransaction>',
    :'scheduled_transactions' => :'Array<ScheduledTransactionSummary>',
    :'scheduled_subtransactions' => :'Array<ScheduledSubTransaction>'
  }
end

Instance Method Details

#==(o) ⇒ Object

Checks equality by comparing each attribute.

Parameters:

  • Object (Object) —

    to be compared



243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
 
# File 'lib/ynab/models/budget_detail.rb', line 243

def ==(o)
  return true if self.equal?(o)
  self.class == o.class &&
      id == o.id &&
      name == o.name &&
      last_modified_on == o.last_modified_on &&
      first_month == o.first_month &&
      last_month == o.last_month &&
      date_format == o.date_format &&
      currency_format == o.currency_format &&
      accounts == o.accounts &&
      payees == o.payees &&
      payee_locations == o.payee_locations &&
      category_groups == o.category_groups &&
      categories == o.categories &&
      months == o.months &&
      transactions == o.transactions &&
      subtransactions == o.subtransactions &&
      scheduled_transactions == o.scheduled_transactions &&
      scheduled_subtransactions == o.scheduled_subtransactions
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



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
346
347
348
 
# File 'lib/ynab/models/budget_detail.rb', line 311

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



382
383
384
385
386
387
388
389
390
391
392
393
394
 
# File 'lib/ynab/models/budget_detail.rb', line 382

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



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
 
# File 'lib/ynab/models/budget_detail.rb', line 287

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


267
268
269
 
# File 'lib/ynab/models/budget_detail.rb', line 267

def eql?(o)
  self == o
end

#hash ⇒ Integer

Calculates hash code according to all attributes.

Returns:

  • (Integer) —

    Hash code



273
274
275
 
# File 'lib/ynab/models/budget_detail.rb', line 273

def hash
  [id, name, last_modified_on, first_month, last_month, date_format, currency_format, accounts, payees, payee_locations, category_groups, categories, months, transactions, subtransactions, scheduled_transactions, scheduled_subtransactions].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



228
229
230
231
 
# File 'lib/ynab/models/budget_detail.rb', line 228

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



358
359
360
 
# File 'lib/ynab/models/budget_detail.rb', line 358

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



364
365
366
367
368
369
370
371
372
373
374
375
376
 
# File 'lib/ynab/models/budget_detail.rb', line 364

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



352
353
354
 
# File 'lib/ynab/models/budget_detail.rb', line 352

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



235
236
237
238
239
 
# File 'lib/ynab/models/budget_detail.rb', line 235

def valid?
  return false if @id.nil?
  return false if @name.nil?
  true
end