Class: ModernTreasury::Models::LedgerTransactionListParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• ModernTreasury::Models::LedgerTransactionListParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/modern_treasury/models/ledger_transaction_list_params.rb

Overview

See Also:

• Resources::LedgerTransactions#list

Defined Under Namespace

Modules: LedgerableType, Status Classes: Amount, OrderBy

Instance Attribute Summary

• #after_cursor ⇒ String^?
• #amount ⇒ ModernTreasury::Models::LedgerTransactionListParams::Amount^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount.

• #effective_at ⇒ Hash{Symbol=>Time}^?

  Use “gt” (>), “gte” (>=), “lt” (<), “lte” (<=), or “eq” (=) to filter by effective at.

• #effective_date ⇒ Hash{Symbol=>Time}^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by effective date.

• #external_id ⇒ String^?
• #id ⇒ Array<String>^?

  If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with ‘id[]=`, for example `?id[]=123&id=abc`.

• #ledger_account_category_id ⇒ String^?
• #ledger_account_id ⇒ String^?
• #ledger_account_settlement_id ⇒ String^?
• #ledger_id ⇒ String^?
• #ledgerable_id ⇒ String^?
• #ledgerable_type ⇒ Symbol, ...
• #metadata ⇒ Hash{Symbol=>String}^?

  For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`.

• #order_by ⇒ ModernTreasury::Models::LedgerTransactionListParams::OrderBy^?

  Order by ‘created_at` or `effective_at` in `asc` or `desc` order.

• #partially_posts_ledger_transaction_id ⇒ String^?
• #per_page ⇒ Integer^?
• #posted_at ⇒ Hash{Symbol=>Time}^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp.

• #reverses_ledger_transaction_id ⇒ String^?
• #status ⇒ Symbol, ...
• #updated_at ⇒ Hash{Symbol=>Time}^?

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(eq: nil, gt: nil, gte: nil, lt: nil, lte: nil) ⇒ Object constructor

  Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount.

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(eq: nil, gt: nil, gte: nil, lt: nil, lte: nil) ⇒ Object

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount.

Parameters:

• eq (Integer) (defaults to: nil)
• gt (Integer) (defaults to: nil)
• gte (Integer) (defaults to: nil)
• lt (Integer) (defaults to: nil)
• lte (Integer) (defaults to: nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 203

Instance Attribute Details

#after_cursor ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 20

optional :after_cursor, String, nil?: true

#amount ⇒ ModernTreasury::Models::LedgerTransactionListParams::Amount^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by amount.

Returns:

• (ModernTreasury::Models::LedgerTransactionListParams::Amount, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 26

optional :amount, -> { ModernTreasury::LedgerTransactionListParams::Amount }

#effective_at ⇒ Hash{Symbol=>Time}^?

Use “gt” (>), “gte” (>=), “lt” (<), “lte” (<=), or “eq” (=) to filter by effective at. For example, for all transactions after Jan 1 2000, use effective_at%5Bgt%5D=2000-01-01T00:00:00:00.000Z.

Returns:

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

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 34

optional :effective_at, ModernTreasury::Internal::Type::HashOf[Time]

#effective_date ⇒ Hash{Symbol=>Time}^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by effective date. For example, for all dates after Jan 1 2000, use effective_date%5Bgt%5D=2000-01-01.

Returns:

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

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

optional :effective_date, ModernTreasury::Internal::Type::HashOf[Time]

#external_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 47

optional :external_id, String

#id ⇒ Array<String>^?

If you have specific IDs to retrieve in bulk, you can pass them as query parameters delimited with ‘id[]=`, for example `?id[]=123&id=abc`.

Returns:

• (Array<String>, nil)

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

optional :id, ModernTreasury::Internal::Type::ArrayOf[String]

#ledger_account_category_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 52

optional :ledger_account_category_id, String

#ledger_account_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 57

optional :ledger_account_id, String

#ledger_account_settlement_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 62

optional :ledger_account_settlement_id, String

#ledger_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 67

optional :ledger_id, String

#ledgerable_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 72

optional :ledgerable_id, String

#ledgerable_type ⇒ Symbol, ...

Returns:

• (Symbol, ModernTreasury::Models::LedgerTransactionListParams::LedgerableType, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 77

optional :ledgerable_type, enum: -> { ModernTreasury::LedgerTransactionListParams::LedgerableType }

#metadata ⇒ Hash{Symbol=>String}^?

For example, if you want to query for records with metadata key ‘Type` and value `Loan`, the query would be `metadata%5BType%5D=Loan`. This encodes the query parameters.

Returns:

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

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 85

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

#order_by ⇒ ModernTreasury::Models::LedgerTransactionListParams::OrderBy^?

Order by ‘created_at` or `effective_at` in `asc` or `desc` order. For example, to order by `effective_at asc`, use `order_by%5Beffective_at%5D=asc`. Ordering by only one field at a time is supported.

Returns:

• (ModernTreasury::Models::LedgerTransactionListParams::OrderBy, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 93

optional :order_by, -> { ModernTreasury::LedgerTransactionListParams::OrderBy }

#partially_posts_ledger_transaction_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 98

optional :partially_posts_ledger_transaction_id, String

#per_page ⇒ Integer^?

Returns:

• (Integer, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 103

optional :per_page, Integer

#posted_at ⇒ Hash{Symbol=>Time}^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use posted_at%5Bgt%5D=2000-01-01T12:00:00Z.

Returns:

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

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 111

optional :posted_at, ModernTreasury::Internal::Type::HashOf[Time]

#reverses_ledger_transaction_id ⇒ String^?

Returns:

• (String, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 116

optional :reverses_ledger_transaction_id, String

#status ⇒ Symbol, ...

Returns:

• (Symbol, Array<Symbol, ModernTreasury::Models::LedgerTransactionListParams::Status::UnionMember1>, ModernTreasury::Models::LedgerTransactionListParams::Status, nil)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 121

optional :status, union: -> { ModernTreasury::LedgerTransactionListParams::Status }

#updated_at ⇒ Hash{Symbol=>Time}^?

Use ‘gt` (>), `gte` (>=), `lt` (<), `lte` (<=), or `eq` (=) to filter by the posted at timestamp. For example, for all times after Jan 1 2000 12:00 UTC, use updated_at%5Bgt%5D=2000-01-01T12:00:00Z.

Returns:

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

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 129

optional :updated_at, ModernTreasury::Internal::Type::HashOf[Time]

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/modern_treasury/models/ledger_transaction_list_params.rb', line 222