Class: PbAPI::Resources::BalanceResource

Inherits:
PbAPI::Resource show all
Defined in:
lib/pb_api/resources/balance_resource.rb

Overview

see api docs

Constant Summary

Constants inherited from PbAPI::Resource

PbAPI::Resource::DATE_FORMAT_STRING

Instance Attribute Summary

Attributes inherited from PbAPI::Resource

#client

Instance Method Summary collapse

Methods inherited from PbAPI::Resource

#form_query, #initialize

Constructor Details

This class inherits a constructor from PbAPI::Resource

Instance Method Details

#common(uri, _key, start_date, account, end_date) ⇒ Object 



8
9
10
11
12
13
14
15
16
 
# File 'lib/pb_api/resources/balance_resource.rb', line 8

def common(uri, _key, start_date, , end_date)
  params_hash = form_query(start_date:, account:, end_date:)
  # Pass a block to handle the HTTP request using your resource's get_request method.

  PbAPI::PaginationHelper
    .paginate(params_hash:, key: "balances", type: PbAPI::Models::Balance) do |params|
      get_request(uri, params: params)
    end
end

#list(start_date, account = nil, end_date = nil) ⇒ Object

Get balance(s) start_date required account(iban string) and end_date optional



21
22
23
 
# File 'lib/pb_api/resources/balance_resource.rb', line 21

def list(start_date,  = nil, end_date = nil)
  common("statements/balance", "balances", start_date, , end_date)
end

#list_final(account = nil) ⇒ Object

account = string iban, optional



35
36
37
 
# File 'lib/pb_api/resources/balance_resource.rb', line 35

def list_final( = nil)
  common("statements/balance/final", "balances", start_date, , end_date)
end

#list_interim(start_date, account = nil, end_date = nil) ⇒ Array<PbAPI::Models::Balance>

Get interim balance(s)

Parameters:

  • start_date (String) —

    the start date for the balance query (required)

  • account (String, nil) (defaults to: nil) —

    the account IBAN (optional)

Returns:



30
31
32
 
# File 'lib/pb_api/resources/balance_resource.rb', line 30

def list_interim(start_date,  = nil, end_date = nil)
  common("statements/balance/interim", "balances", start_date, , end_date)
end