Class: Dodopayments::Models::ProductListParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/product_list_params.rb

Overview

See Also:

• Resources::Products#list

Instance Attribute Summary

• #archived ⇒ Boolean^?

  List archived products.

• #brand_id ⇒ String^?

  filter by Brand id.

• #page_number ⇒ Integer^?

  Page number default is 0.

• #page_size ⇒ Integer^?

  Page size default is 10 max is 100.

• #recurring ⇒ Boolean^?

  Filter products by pricing type:.

Attributes included from Internal::Type::RequestParameters

#request_options

Instance Method Summary

• #initialize(archived: nil, brand_id: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {}) ⇒ Object constructor

  Some parameter documentations has been truncated, see ProductListParams 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(archived: nil, brand_id: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {}) ⇒ Object

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

Parameters:

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

  List archived products

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

  filter by Brand id

• 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

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

  Filter products by pricing type:

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

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

Instance Attribute Details

#archived ⇒ Boolean^?

List archived products

Returns:

• (Boolean, nil)

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

optional :archived, Dodopayments::Internal::Type::Boolean

#brand_id ⇒ String^?

filter by Brand id

Returns:

• (String, nil)

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

optional :brand_id, String

#page_number ⇒ Integer^?

Page number default is 0

Returns:

• (Integer, nil)

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

optional :page_number, Integer

#page_size ⇒ Integer^?

Page size default is 10 max is 100

Returns:

• (Integer, nil)

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

optional :page_size, Integer

#recurring ⇒ Boolean^?

Filter products by pricing type:

• ‘true`: Show only recurring pricing products (e.g. subscriptions)

• ‘false`: Show only one-time price products

• ‘null` or absent: Show both types of products

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/product_list_params.rb', line 42

optional :recurring, Dodopayments::Internal::Type::Boolean