Class: Dodopayments::Models::BalanceRetrieveLedgerParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::BalanceRetrieveLedgerParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/balance_retrieve_ledger_params.rb

Overview

See Also:

• Resources::Balances#retrieve_ledger

Defined Under Namespace

Modules: Currency, EventType

Instance Attribute Summary

• #created_at_gte ⇒ Time^?

  Get events after this created time.

• #created_at_lte ⇒ Time^?

  Get events created before this time.

• #currency ⇒ Symbol, ...

  Filter by currency.

• #event_type ⇒ Symbol, ...

  Filter by Ledger Event Type.

• #limit ⇒ Integer^?

  Min : 1, Max : 100, default 10.

• #page_number ⇒ Integer^?

  Page number default is 0.

• #page_size ⇒ Integer^?

  Page size default is 10 max is 100.

• #reference_object_id ⇒ String^?

  Get events history of a specific object like payment/subscription/refund/dispute.

Attributes included from Internal::Type::RequestParameters

#request_options

Class Method Summary

• .values ⇒ Array<Symbol>

Instance Method Summary

• #initialize(created_at_gte: nil, created_at_lte: nil, currency: nil, event_type: nil, limit: nil, page_number: nil, page_size: nil, reference_object_id: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see BalanceRetrieveLedgerParams for more details.

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(created_at_gte: nil, created_at_lte: nil, currency: nil, event_type: nil, limit: nil, page_number: nil, page_size: nil, reference_object_id: nil, request_options: {}) ⇒ Object

Some parameter documentations has been truncated, see Dodopayments::Models::BalanceRetrieveLedgerParams for more details.

Parameters:

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

  Get events after this created time

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

  Get events created before this time

• currency (Symbol, Dodopayments::Models::BalanceRetrieveLedgerParams::Currency) (defaults to: nil) —

  Filter by currency

• event_type (Symbol, Dodopayments::Models::BalanceRetrieveLedgerParams::EventType) (defaults to: nil) —

  Filter by Ledger Event Type

• limit (Integer) (defaults to: nil) —

  Min : 1, Max : 100, default 10

• page_number (Integer) (defaults to: nil) —

  Page number default is 0

• page_size (Integer) (defaults to: nil) —

  Page size default is 10 max is 100

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

  Get events history of a specific object like payment/subscription/refund/dispute

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

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 58

Instance Attribute Details

#created_at_gte ⇒ Time^?

Get events after this created time

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 14

optional :created_at_gte, Time

#created_at_lte ⇒ Time^?

Get events created before this time

Returns:

• (Time, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 20

optional :created_at_lte, Time

#currency ⇒ Symbol, ...

Filter by currency

Returns:

• (Symbol, Dodopayments::Models::BalanceRetrieveLedgerParams::Currency, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 26

optional :currency, enum: -> { Dodopayments::BalanceRetrieveLedgerParams::Currency }

#event_type ⇒ Symbol, ...

Filter by Ledger Event Type

Returns:

• (Symbol, Dodopayments::Models::BalanceRetrieveLedgerParams::EventType, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 32

optional :event_type, enum: -> { Dodopayments::BalanceRetrieveLedgerParams::EventType }

#limit ⇒ Integer^?

Min : 1, Max : 100, default 10

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 38

optional :limit, Integer

#page_number ⇒ Integer^?

Page number default is 0

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 44

optional :page_number, Integer

#page_size ⇒ Integer^?

Page size default is 10 max is 100

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 50

optional :page_size, Integer

#reference_object_id ⇒ String^?

Get events history of a specific object like payment/subscription/refund/dispute

Returns:

• (String, nil)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 56

optional :reference_object_id, String

Class Method Details

.values ⇒ Array<Symbol>

Returns:

• (Array<Symbol>)

# File 'lib/dodopayments/models/balance_retrieve_ledger_params.rb', line 230