Class: LunchMoney::Objects::RecurringItem

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

Overview

https://lunchmoney.dev/#recurring-items-object

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Object

#serialize

Constructor Details

#initialize(id:, payee:, currency:, created_by:, created_at:, updated_at:, billing_date:, source:, amount:, cadence:, granularity:, date:, is_income:, exclude_from_totals:, start_date: nil, end_date: nil, original_name: nil, description: nil, notes: nil, plaid_account_id: nil, asset_id: nil, category_id: nil, category_group_id: nil, quantity: nil, to_base: nil, occurrences: nil, transactions_within_range: nil, missing_dates_within_range: nil) ⇒ void

Parameters:

  • id (Integer)
  • payee (String)
  • currency (String)
  • created_by (Integer)
  • created_at (String)
  • updated_at (String)
  • billing_date (String)
  • source (String)
  • amount (String)
  • cadence (String)
  • granularity (String)
  • date (String)
  • is_income (Boolean)
  • exclude_from_totals (Boolean)
  • start_date (String, nil) (defaults to: nil)
  • end_date (String, nil) (defaults to: nil)
  • original_name (String, nil) (defaults to: nil)
  • description (String, nil) (defaults to: nil)
  • notes (String, nil) (defaults to: nil)
  • plaid_account_id (Integer, nil) (defaults to: nil)
  • asset_id (Integer, nil) (defaults to: nil)
  • category_id (Integer, nil) (defaults to: nil)
  • category_group_id (Integer, nil) (defaults to: nil)
  • quantity (Integer, nil) (defaults to: nil)
  • to_base (Number, nil) (defaults to: nil)
  • occurrences (Hash{String => Array<T.untyped>}, nil) (defaults to: nil)
  • transactions_within_range (Array<T.untyped>, nil) (defaults to: nil)
  • missing_dates_within_range (Array<T.untyped>, nil) (defaults to: nil) 


64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 64

def initialize(id:, payee:, currency:, created_by:, created_at:, updated_at:, billing_date:, source:,
  amount:, cadence:, granularity:, date:, is_income:, exclude_from_totals:, start_date: nil,
  end_date: nil, original_name: nil, description: nil, notes: nil, plaid_account_id: nil,
  asset_id: nil, category_id: nil, category_group_id: nil, quantity: nil, to_base: nil,
  occurrences: nil, transactions_within_range: nil, missing_dates_within_range: nil)
  super()
  @id = id
  @payee = payee
  @currency = currency
  @created_by = created_by
  @created_at = created_at
  @updated_at = updated_at
  @billing_date = billing_date
  @source = source
  @amount = amount
  @cadence = cadence
  @granularity = granularity
  @date = date
  @is_income = is_income
  @exclude_from_totals = exclude_from_totals
  @start_date = start_date
  @end_date = end_date
  @original_name = original_name
  @description = description
  @notes = notes
  @plaid_account_id = 
  @asset_id = asset_id
  @category_id = category_id
  @category_group_id = category_group_id
  @quantity = quantity
  @to_base = to_base
  @occurrences = occurrences
  @transactions_within_range = transactions_within_range
  @missing_dates_within_range = missing_dates_within_range
end

Instance Attribute Details

#amount ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def amount
  @amount
end

#asset_id ⇒ Integer?

Returns:

  • (Integer, nil) 


18
19
20
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 18

def asset_id
  @asset_id
end

#billing_date ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def billing_date
  @billing_date
end

#cadence ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def cadence
  @cadence
end

#category_group_id ⇒ Integer?

Returns:

  • (Integer, nil) 


18
19
20
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 18

def category_group_id
  @category_group_id
end

#category_id ⇒ Integer?

Returns:

  • (Integer, nil) 


18
19
20
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 18

def category_id
  @category_id
end

#created_at ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def created_at
  @created_at
end

#created_by ⇒ Integer

Returns:

  • (Integer) 


9
10
11
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 9

def created_by
  @created_by
end

#currency ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def currency
  @currency
end

#date ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def date
  @date
end

#description ⇒ String?

Returns:

  • (String, nil) 


15
16
17
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 15

def description
  @description
end

#end_date ⇒ String?

Returns:

  • (String, nil) 


15
16
17
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 15

def end_date
  @end_date
end

#exclude_from_totals ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 24

def exclude_from_totals
  @exclude_from_totals
end

#granularity ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def granularity
  @granularity
end

#id ⇒ Integer

Returns:

  • (Integer) 


9
10
11
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 9

def id
  @id
end

#is_income ⇒ Boolean

Returns:

  • (Boolean) 


24
25
26
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 24

def is_income
  @is_income
end

#missing_dates_within_range ⇒ Array<T.untyped>?

Returns:

  • (Array<T.untyped>, nil) 


30
31
32
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 30

def missing_dates_within_range
  @missing_dates_within_range
end

#notes ⇒ String?

Returns:

  • (String, nil) 


15
16
17
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 15

def notes
  @notes
end

#occurrences ⇒ Hash{String => Array<T.untyped>}?

Returns:

  • (Hash{String => Array<T.untyped>}, nil) 


27
28
29
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 27

def occurrences
  @occurrences
end

#original_name ⇒ String?

Returns:

  • (String, nil) 


15
16
17
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 15

def original_name
  @original_name
end

#payee ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def payee
  @payee
end

#plaid_account_id ⇒ Integer?

Returns:

  • (Integer, nil) 


18
19
20
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 18

def 
  @plaid_account_id
end

#quantity ⇒ Integer?

Returns:

  • (Integer, nil) 


18
19
20
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 18

def quantity
  @quantity
end

#source ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def source
  @source
end

#start_date ⇒ String?

Returns:

  • (String, nil) 


15
16
17
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 15

def start_date
  @start_date
end

#to_base ⇒ Number?

Returns:



21
22
23
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 21

def to_base
  @to_base
end

#transactions_within_range ⇒ Array<T.untyped>?

Returns:

  • (Array<T.untyped>, nil) 


30
31
32
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 30

def transactions_within_range
  @transactions_within_range
end

#updated_at ⇒ String

Returns:

  • (String) 


12
13
14
 
# File 'lib/lunchmoney/objects/recurring_item.rb', line 12

def updated_at
  @updated_at
end