Class: LunchMoney::Calls::Assets

Inherits:
Base
  • Object
show all
Defined in:
lib/lunchmoney/calls/assets.rb

Overview

https://lunchmoney.dev/#assets

Constant Summary

Constants inherited from Base

Base::BASE_URL

Instance Attribute Summary

Attributes inherited from Base

#api_key

Instance Method Summary collapse

Methods inherited from Base

#initialize

Constructor Details

This class inherits a constructor from LunchMoney::Calls::Base

Instance Method Details

#assets ⇒ Array<LunchMoney::Objects::Asset>, LunchMoney::Errors

Returns:



11
12
13
14
15
16
17
18
19
 
# File 'lib/lunchmoney/calls/assets.rb', line 11

def assets
  response = get("assets")

  handle_api_response(response) do |body|
    body[:assets].map do |asset|
      LunchMoney::Objects::Asset.new(**asset)
    end
  end
end

#create_asset(type_name:, name:, balance:, subtype_name: nil, display_name: nil, balance_as_of: nil, currency: nil, institution_name: nil, closed_on: nil, exclude_transactions: nil) ⇒ LunchMoney::Objects::Asset, LunchMoney::Errors

Parameters:

  • type_name (String)
  • name (String)
  • balance (String)
  • subtype_name (String, nil) (defaults to: nil)
  • display_name (String, nil) (defaults to: nil)
  • balance_as_of (String, nil) (defaults to: nil)
  • currency (String, nil) (defaults to: nil)
  • institution_name (String, nil) (defaults to: nil)
  • closed_on (String, nil) (defaults to: nil)
  • exclude_transactions (Boolean, nil) (defaults to: nil)

Returns:



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/lunchmoney/calls/assets.rb', line 35

def create_asset(type_name:, name:, balance:, subtype_name: nil, display_name: nil, balance_as_of: nil,
  currency: nil, institution_name: nil, closed_on: nil, exclude_transactions: nil)
  params = {
    type_name:,
    name:,
    balance:,
    subtype_name:,
    display_name:,
    balance_as_of:,
    currency:,
    institution_name:,
    closed_on:,
    exclude_transactions:,
  }

  response = post("assets", params)

  handle_api_response(response) do |body|
    LunchMoney::Objects::Asset.new(**body)
  end
end

#update_asset(asset_id, type_name: nil, name: nil, balance: nil, subtype_name: nil, display_name: nil, balance_as_of: nil, currency: nil, institution_name: nil, closed_on: nil, exclude_transactions: nil) ⇒ LunchMoney::Objects::Asset, LunchMoney::Errors

Parameters:

  • asset_id (Integer)
  • type_name (String, nil) (defaults to: nil)
  • name (String, nil) (defaults to: nil)
  • balance (String, nil) (defaults to: nil)
  • subtype_name (String, nil) (defaults to: nil)
  • display_name (String, nil) (defaults to: nil)
  • balance_as_of (String, nil) (defaults to: nil)
  • currency (String, nil) (defaults to: nil)
  • institution_name (String, nil) (defaults to: nil)
  • closed_on (String, nil) (defaults to: nil)
  • exclude_transactions (Boolean, nil) (defaults to: nil)

Returns:



72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
 
# File 'lib/lunchmoney/calls/assets.rb', line 72

def update_asset(asset_id, type_name: nil, name: nil, balance: nil, subtype_name: nil, display_name: nil,
  balance_as_of: nil, currency: nil, institution_name: nil, closed_on: nil, exclude_transactions: nil)
  params = {
    type_name:,
    name:,
    balance:,
    subtype_name:,
    display_name:,
    balance_as_of:,
    currency:,
    institution_name:,
    closed_on:,
    exclude_transactions:,
  }

  response = put("assets/#{asset_id}", params)

  handle_api_response(response) do |body|
    LunchMoney::Objects::Asset.new(**body)
  end
end