Class: Dodopayments::Models::CreditEntitlements::BalanceListGrantsParams

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::CreditEntitlements::BalanceListGrantsParams

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/credit_entitlements/balance_list_grants_params.rb

Overview

See Also:

• Resources::CreditEntitlements::Balances#list_grants

Defined Under Namespace

Modules: Status

Instance Attribute Summary

• #credit_entitlement_id ⇒ String
• #customer_id ⇒ String
• #page_number ⇒ Integer^?

  Page number default is 0.

• #page_size ⇒ Integer^?

  Page size default is 10 max is 100.

• #status ⇒ Symbol, ...

  Filter by grant status: active, expired, depleted.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(credit_entitlement_id:, customer_id:, page_number: nil, page_size: nil, status: nil, request_options: {}) ⇒ Object constructor

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:, page_number: nil, page_size: nil, status: nil, request_options: {}) ⇒ Object

Parameters:

• credit_entitlement_id (String)
• customer_id (String)
• 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

• status (Symbol, Dodopayments::Models::CreditEntitlements::BalanceListGrantsParams::Status) (defaults to: nil) —

  Filter by grant status: active, expired, depleted

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

# File 'lib/dodopayments/models/credit_entitlements/balance_list_grants_params.rb', line 39

Instance Attribute Details

#credit_entitlement_id ⇒ String

Returns:

• (String)

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

required :credit_entitlement_id, String

#customer_id ⇒ String

Returns:

• (String)

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

required :customer_id, String

#page_number ⇒ Integer^?

Page number default is 0

Returns:

• (Integer, nil)

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

optional :page_number, Integer

#page_size ⇒ Integer^?

Page size default is 10 max is 100

Returns:

• (Integer, nil)

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

optional :page_size, Integer

#status ⇒ Symbol, ...

Filter by grant status: active, expired, depleted

Returns:

• (Symbol, Dodopayments::Models::CreditEntitlements::BalanceListGrantsParams::Status, nil)

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

optional :status, enum: -> { Dodopayments::CreditEntitlements::BalanceListGrantsParams::Status }