Class: Dodopayments::Models::CreditEntitlements::BalanceListLedgerParams

Inherits:
Internal::Type::BaseModel show all
Extended by:
Internal::Type::RequestParameters::Converter
Includes:
Internal::Type::RequestParameters
Defined in:
lib/dodopayments/models/credit_entitlements/balance_list_ledger_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(credit_entitlement_id:, customer_id:, end_date: nil, page_number: nil, page_size: nil, start_date: nil, transaction_type: nil, request_options: {}) ⇒ Object

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

Parameters:

  • credit_entitlement_id (String)
  • customer_id (String)
  • end_date (Time) (defaults to: nil) —

    Filter by end date

  • 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

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

    Filter by start date

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

    Filter by transaction type (snake_case: credit_added, credit_deducted, credit_ex

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



# File 'lib/dodopayments/models/credit_entitlements/balance_list_ledger_params.rb', line 52

Instance Attribute Details

#credit_entitlement_id ⇒ String

Returns:

  • (String) 


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

required :credit_entitlement_id, String

#customer_id ⇒ String

Returns:

  • (String) 


19
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_ledger_params.rb', line 19

required :customer_id, String

#end_date ⇒ Time?

Filter by end date

Returns:

  • (Time, nil) 


25
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_ledger_params.rb', line 25

optional :end_date, Time

#page_number ⇒ Integer?

Page number default is 0

Returns:

  • (Integer, nil) 


31
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_ledger_params.rb', line 31

optional :page_number, Integer

#page_size ⇒ Integer?

Page size default is 10 max is 100

Returns:

  • (Integer, nil) 


37
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_ledger_params.rb', line 37

optional :page_size, Integer

#start_date ⇒ Time?

Filter by start date

Returns:

  • (Time, nil) 


43
 
# File 'lib/dodopayments/models/credit_entitlements/balance_list_ledger_params.rb', line 43

optional :start_date, Time

#transaction_type ⇒ String?

Filter by transaction type (snake_case: credit_added, credit_deducted, credit_expired, etc.)

Returns:

  • (String, nil) 


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

optional :transaction_type, String