Class: Dodopayments::Models::DiscountListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/discount_list_params.rb,
sig/dodopayments/models/discount_list_params.rbs

Overview

See Also:

• Dodopayments::Resources::Discounts#list

Constant Summary

Constants included from Internal::Type::RequestParameters

Internal::Type::RequestParameters::Dodopayments

Instance Attribute Summary

• #active ⇒ Boolean^?

  Filter by active status.

• #code ⇒ String^?

  Filter by discount code (partial match, case-insensitive).

• #discount_type ⇒ Symbol, ...

  Filter by discount type.

• #page_number ⇒ Integer^?

  Page number (default = 0).

• #page_size ⇒ Integer^?

  Page size (default = 10, max = 100).

• #product_id ⇒ String^?

  Filter by product restriction (only discounts that apply to this product).

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(active: nil, code: nil, discount_type: nil, page_number: nil, page_size: nil, product_id: nil, request_options: {}) ⇒ Object constructor

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

• #to_hash ⇒ {

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(active: nil, code: nil, discount_type: nil, page_number: nil, page_size: nil, product_id: nil, request_options: {}) ⇒ Object

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

Parameters:

• active (Boolean) (defaults to: nil) —

  Filter by active status. true = currently redeemable (started, not

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

  Filter by discount code (partial match, case-insensitive)

• discount_type (Symbol, Dodopayments::Models::DiscountType) (defaults to: nil) —

  Filter by discount type

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

  Page number (default = 0).

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

  Page size (default = 10, max = 100).

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

  Filter by product restriction (only discounts that apply to this product)

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

# File 'lib/dodopayments/models/discount_list_params.rb', line 48

Instance Attribute Details

#active ⇒ Boolean^?

Filter by active status. true = currently redeemable (started, not expired, not usage-exhausted). false = not currently redeemable (expired, usage-exhausted, or pending a future starts_at).

Parameters:

• (Boolean)

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/discount_list_params.rb', line 16

optional :active, Dodopayments::Internal::Type::Boolean

#code ⇒ String^?

Filter by discount code (partial match, case-insensitive)

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/discount_list_params.rb', line 22

optional :code, String

#discount_type ⇒ Symbol, ...

Filter by discount type

Returns:

• (Symbol, Dodopayments::Models::DiscountType, nil)

# File 'lib/dodopayments/models/discount_list_params.rb', line 28

optional :discount_type, enum: -> { Dodopayments::DiscountType }

#page_number ⇒ Integer^?

Page number (default = 0).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/discount_list_params.rb', line 34

optional :page_number, Integer

#page_size ⇒ Integer^?

Page size (default = 10, max = 100).

Parameters:

• (Integer)

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/discount_list_params.rb', line 40

optional :page_size, Integer

#product_id ⇒ String^?

Filter by product restriction (only discounts that apply to this product)

Parameters:

• (String)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/discount_list_params.rb', line 46

optional :product_id, String

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/dodopayments/models/discount_list_params.rbs', line 54

def to_hash: -> {