Class: ModernTreasury::Resources::InternalAccounts::BalanceReports

Inherits:
Object
  • Object
show all
Defined in:
lib/modern_treasury/resources/internal_accounts/balance_reports.rb

Instance Method Summary collapse

Constructor Details

#initialize(client:) ⇒ BalanceReports

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of BalanceReports.

Parameters:



141
142
143
 
# File 'lib/modern_treasury/resources/internal_accounts/balance_reports.rb', line 141

def initialize(client:)
  @client = client
end

Instance Method Details

#create(internal_account_id, as_of_date: , as_of_time: , balance_report_type: , balances: , request_options: {}) ⇒ ModernTreasury::Models::InternalAccounts::BalanceReport

Some parameter documentations has been truncated, see Models::InternalAccounts::BalanceReportCreateParams for more details.

create balance reports

Parameters:

Returns:

See Also:



30
31
32
33
34
35
36
37
38
39
 
# File 'lib/modern_treasury/resources/internal_accounts/balance_reports.rb', line 30

def create(, params)
  parsed, options = ModernTreasury::InternalAccounts::BalanceReportCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: ["api/internal_accounts/%1$s/balance_reports", ],
    body: parsed,
    model: ModernTreasury::InternalAccounts::BalanceReport,
    options: options
  )
end

#delete(id, internal_account_id: , request_options: {}) ⇒ nil

Some parameter documentations has been truncated, see Models::InternalAccounts::BalanceReportDeleteParams for more details.

Deletes a given balance report.

Parameters:

  • id (String) —

    Either the unique identifier of the balance report or ‘latest’ for the latest ba

  • internal_account_id (String)
  • request_options (ModernTreasury::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

  • (nil)

See Also:



124
125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/modern_treasury/resources/internal_accounts/balance_reports.rb', line 124

def delete(id, params)
  parsed, options = ModernTreasury::InternalAccounts::BalanceReportDeleteParams.dump_request(params)
   =
    parsed.delete(:internal_account_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :delete,
    path: ["api/internal_accounts/%1$s/balance_reports/%2$s", , id],
    model: NilClass,
    options: options
  )
end

#list(internal_account_id, after_cursor: nil, as_of_date: nil, balance_report_type: nil, per_page: nil, request_options: {}) ⇒ ModernTreasury::Internal::Page<ModernTreasury::Models::InternalAccounts::BalanceReport>

Some parameter documentations has been truncated, see Models::InternalAccounts::BalanceReportListParams for more details.

Get all balance reports for a given internal account.

Parameters:

Returns:

See Also:



95
96
97
98
99
100
101
102
103
104
105
 
# File 'lib/modern_treasury/resources/internal_accounts/balance_reports.rb', line 95

def list(, params = {})
  parsed, options = ModernTreasury::InternalAccounts::BalanceReportListParams.dump_request(params)
  @client.request(
    method: :get,
    path: ["api/internal_accounts/%1$s/balance_reports", ],
    query: parsed,
    page: ModernTreasury::Internal::Page,
    model: ModernTreasury::InternalAccounts::BalanceReport,
    options: options
  )
end

#retrieve(id, internal_account_id: , request_options: {}) ⇒ ModernTreasury::Models::InternalAccounts::BalanceReport

Some parameter documentations has been truncated, see Models::InternalAccounts::BalanceReportRetrieveParams for more details.

Get a single balance report for a given internal account.

Parameters:

Returns:

See Also:



58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/modern_treasury/resources/internal_accounts/balance_reports.rb', line 58

def retrieve(id, params)
  parsed, options = ModernTreasury::InternalAccounts::BalanceReportRetrieveParams.dump_request(params)
   =
    parsed.delete(:internal_account_id) do
      raise ArgumentError.new("missing required path argument #{_1}")
    end
  @client.request(
    method: :get,
    path: ["api/internal_accounts/%1$s/balance_reports/%2$s", , id],
    model: ModernTreasury::InternalAccounts::BalanceReport,
    options: options
  )
end