Class: Lithic::Models::BalanceListParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/lithic/models/balance_list_params.rb

Overview

See Also:

Defined Under Namespace

Modules: FinancialAccountType

Instance Attribute Summary collapse

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary collapse

Methods included from Internal::Type::RequestParameters::Converter

dump_request

Methods included from Internal::Type::RequestParameters

included

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, inspect, #inspect, known_fields, optional, recursively_to_h, required, #to_h, #to_json, #to_s, to_sorbet_type, #to_yaml

Methods included from Internal::Type::Converter

#coerce, coerce, #dump, dump, inspect, #inspect, meta_info, new_coerce_state, type_info

Methods included from Internal::Util::SorbetRuntimeSupport

#const_missing, #define_sorbet_constant!, #sorbet_constant_defined?, #to_sorbet_type, to_sorbet_type

Constructor Details

#initialize(account_token: nil, balance_date: nil, business_account_token: nil, financial_account_type: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Lithic::Models::BalanceListParams for more details.

Parameters:

  • account_token (String) (defaults to: nil) —

    List balances for all financial accounts of a given account_token.

  • balance_date (Time) (defaults to: nil) —

    UTC date and time of the balances to retrieve. Defaults to latest available bala

  • business_account_token (String) (defaults to: nil) —

    List balances for all financial accounts of a given business_account_token.

  • financial_account_type (Symbol, Lithic::Models::BalanceListParams::FinancialAccountType) (defaults to: nil) —

    List balances for a given Financial Account type.

  • request_options (Lithic::RequestOptions, Hash{Symbol=>Object}) (defaults to: {}) 



# File 'lib/lithic/models/balance_list_params.rb', line 35

Instance Attribute Details

#account_token ⇒ String?

List balances for all financial accounts of a given account_token.

Returns:

  • (String, nil) 


14
 
# File 'lib/lithic/models/balance_list_params.rb', line 14

optional :account_token, String

#balance_date ⇒ Time?

UTC date and time of the balances to retrieve. Defaults to latest available balances

Returns:

  • (Time, nil) 


21
 
# File 'lib/lithic/models/balance_list_params.rb', line 21

optional :balance_date, Time

#business_account_token ⇒ String?

List balances for all financial accounts of a given business_account_token.

Returns:

  • (String, nil) 


27
 
# File 'lib/lithic/models/balance_list_params.rb', line 27

optional :business_account_token, String

#financial_account_type ⇒ Symbol, ...

List balances for a given Financial Account type.

Returns:



33
 
# File 'lib/lithic/models/balance_list_params.rb', line 33

optional :financial_account_type, enum: -> { Lithic::BalanceListParams::FinancialAccountType }