Class: LunchMoney::Objects::Budget

Inherits:
Object
  • Object
show all
Defined in:
lib/lunchmoney/objects/budget.rb

Overview

lunchmoney.dev/#budget-object

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#serialize

Constructor Details

#initialize(is_income:, exclude_from_budget:, exclude_from_totals:, data:, category_name:, order:, archived:, category_id: nil, category_group_name: nil, group_id: nil, is_group: nil, config: nil, recurring: nil) ⇒ void

Parameters:

  • is_income (Boolean)
  • exclude_from_budget (Boolean)
  • exclude_from_totals (Boolean)
  • data (Hash{Symbol => LunchMoney::Objects::Data})
  • category_name (String)
  • order (Integer)
  • archived (Boolean)
  • category_id (Integer, nil) (defaults to: nil)
  • category_group_name (String, nil) (defaults to: nil)
  • group_id (Integer, nil) (defaults to: nil)
  • is_group (Boolean, nil) (defaults to: nil)
  • config (Hash{Symbol => LunchMoney::Objects::Config}, nil) (defaults to: nil)
  • recurring (Hash, nil) (defaults to: nil) 


57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/lunchmoney/objects/budget.rb', line 57

def initialize(is_income:, exclude_from_budget:, exclude_from_totals:, data:, category_name:, order:, archived:,
  category_id: nil, category_group_name: nil, group_id: nil, is_group: nil, config: nil, recurring: nil)
  super()
  @category_id = category_id
  @is_income = is_income
  @exclude_from_budget = exclude_from_budget
  @exclude_from_totals = exclude_from_totals
  @data = data
  @category_name = category_name
  @order = order
  @category_group_name = category_group_name
  @group_id = group_id
  @is_group = is_group
  @config = config
  @archived = archived
  @recurring = recurring
end

Instance Attribute Details

#archived ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/lunchmoney/objects/budget.rb', line 29

def archived
  @archived
end

#category_group_name ⇒ String?

Returns:

  • (String, nil) 


20
21
22
 
# File 'lib/lunchmoney/objects/budget.rb', line 20

def category_group_name
  @category_group_name
end

#category_id ⇒ Integer?

Returns:

  • (Integer, nil) 


23
24
25
 
# File 'lib/lunchmoney/objects/budget.rb', line 23

def category_id
  @category_id
end

#category_name ⇒ String

API object reference documentation: lunchmoney.dev/#budget-object

Returns:

  • (String) 


14
15
16
 
# File 'lib/lunchmoney/objects/budget.rb', line 14

def category_name
  @category_name
end

#config ⇒ Hash{Symbol => LunchMoney::Objects::Config}?

Returns:



35
36
37
 
# File 'lib/lunchmoney/objects/budget.rb', line 35

def config
  @config
end

#data ⇒ Hash{Symbol => LunchMoney::Objects::Data}

Returns:



32
33
34
 
# File 'lib/lunchmoney/objects/budget.rb', line 32

def data
  @data
end

#exclude_from_budget ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/lunchmoney/objects/budget.rb', line 29

def exclude_from_budget
  @exclude_from_budget
end

#exclude_from_totals ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/lunchmoney/objects/budget.rb', line 29

def exclude_from_totals
  @exclude_from_totals
end

#group_id ⇒ Integer?

Returns:

  • (Integer, nil) 


23
24
25
 
# File 'lib/lunchmoney/objects/budget.rb', line 23

def group_id
  @group_id
end

#is_group ⇒ Boolean?

Returns:

  • (Boolean, nil) 


26
27
28
 
# File 'lib/lunchmoney/objects/budget.rb', line 26

def is_group
  @is_group
end

#is_income ⇒ Boolean

Returns:

  • (Boolean) 


29
30
31
 
# File 'lib/lunchmoney/objects/budget.rb', line 29

def is_income
  @is_income
end

#order ⇒ Integer

Returns:

  • (Integer) 


17
18
19
 
# File 'lib/lunchmoney/objects/budget.rb', line 17

def order
  @order
end

#recurring ⇒ Hash?

Returns:

  • (Hash, nil) 


38
39
40
 
# File 'lib/lunchmoney/objects/budget.rb', line 38

def recurring
  @recurring
end