Class: ModernTreasury::Models::LedgerAccountStatementCreateParams

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

Overview

See Also:

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(effective_at_lower_bound: , effective_at_upper_bound: , ledger_account_id: , description: nil, metadata: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see ModernTreasury::Models::LedgerAccountStatementCreateParams for more details.

Parameters:

  • effective_at_lower_bound (Time) (defaults to: ) —

    The inclusive lower bound of the effective_at timestamp of the ledger entries to

  • effective_at_upper_bound (Time) (defaults to: ) —

    The exclusive upper bound of the effective_at timestamp of the ledger entries to

  • ledger_account_id (String) (defaults to: ) —

    The id of the ledger account whose ledger entries are queried against, and its b

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

    The description of the ledger account statement.

  • metadata (Hash{Symbol=>String}) (defaults to: nil) —

    Additional data represented as key-value pairs. Both the key and value must be s

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



# File 'lib/modern_treasury/models/ledger_account_statement_create_params.rb', line 44

Instance Attribute Details

#description ⇒ String?

The description of the ledger account statement.

Returns:

  • (String, nil) 


35
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_params.rb', line 35

optional :description, String, nil?: true

#effective_at_lower_bound ⇒ Time

The inclusive lower bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.

Returns:

  • (Time) 


15
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_params.rb', line 15

required :effective_at_lower_bound, Time

#effective_at_upper_bound ⇒ Time

The exclusive upper bound of the effective_at timestamp of the ledger entries to be included in the ledger account statement.

Returns:

  • (Time) 


22
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_params.rb', line 22

required :effective_at_upper_bound, Time

#ledger_account_id ⇒ String

The id of the ledger account whose ledger entries are queried against, and its balances are computed as a result.

Returns:

  • (String) 


29
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_params.rb', line 29

required :ledger_account_id, String

#metadata ⇒ Hash{Symbol=>String}?

Additional data represented as key-value pairs. Both the key and value must be strings.

Returns:

  • (Hash{Symbol=>String}, nil) 


42
 
# File 'lib/modern_treasury/models/ledger_account_statement_create_params.rb', line 42

optional :metadata, ModernTreasury::Internal::Type::HashOf[String]