Class: Dodopayments::Models::ProductListResponse

Inherits:

Internal::Type::BaseModel

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

Defined in:

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

Overview

See Also:

• Dodopayments::Resources::Products#list

Instance Attribute Summary

• #business_id ⇒ String

  Unique identifier for the business to which the product belongs.

• #created_at ⇒ Time

  Timestamp when the product was created.

• #currency ⇒ Symbol, ...

  Currency of the price.

• #description ⇒ String^?

  Description of the product, optional.

• #entitlements ⇒ Array<Dodopayments::Models::ProductEntitlementSummary>

  Entitlements linked to this product.

• #image ⇒ String^?

  URL of the product image, optional.

• #is_recurring ⇒ Boolean

  Indicates if the product is recurring (e.g., subscriptions).

• #metadata ⇒ Hash{Symbol=>String, Float, Boolean}

  Additional custom data associated with the product.

• #name ⇒ String^?

  Name of the product, optional.

• #price ⇒ Integer^?

  Price of the product, optional.

• #price_detail ⇒ Dodopayments::Models::Price::OneTimePrice, ...

  Details of the price.

• #pricing_mode ⇒ Symbol, ...

  Pricing mode for localized pricing.

• #product_id ⇒ String

  Unique identifier for the product.

• #tax_category ⇒ Symbol, Dodopayments::Models::TaxCategory

  Tax category associated with the product.

• #tax_inclusive ⇒ Boolean^?

  Indicates if the price is tax inclusive.

• #updated_at ⇒ Time

  Timestamp when the product was last updated.

Instance Method Summary

• #initialize(business_id:, created_at:, entitlements:, is_recurring:, metadata:, product_id:, tax_category:, updated_at:, currency: nil, description: nil, image: nil, name: nil, price: nil, price_detail: nil, pricing_mode: nil, tax_inclusive: nil) ⇒ Object constructor

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

• #to_hash ⇒ {

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(business_id:, created_at:, entitlements:, is_recurring:, metadata:, product_id:, tax_category:, updated_at:, currency: nil, description: nil, image: nil, name: nil, price: nil, price_detail: nil, pricing_mode: nil, tax_inclusive: nil) ⇒ Object

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

Parameters:

• business_id (String) —

  Unique identifier for the business to which the product belongs.

• created_at (Time) —

  Timestamp when the product was created.

• entitlements (Array<Dodopayments::Models::ProductEntitlementSummary>) —

  Entitlements linked to this product

• is_recurring (Boolean) —

  Indicates if the product is recurring (e.g., subscriptions).

• metadata (Hash{Symbol=>String, Float, Boolean}) —

  Additional custom data associated with the product

• product_id (String) —

  Unique identifier for the product.

• tax_category (Symbol, Dodopayments::Models::TaxCategory) —

  Tax category associated with the product.

• updated_at (Time) —

  Timestamp when the product was last updated.

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

  Currency of the price

• description (String, nil) (defaults to: nil) —

  Description of the product, optional.

• image (String, nil) (defaults to: nil) —

  URL of the product image, optional.

• name (String, nil) (defaults to: nil) —

  Name of the product, optional.

• price (Integer, nil) (defaults to: nil) —

  Price of the product, optional.

• price_detail (Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, Dodopayments::Models::Price::UsageBasedPrice, nil) (defaults to: nil) —

  Details of the price

• pricing_mode (Symbol, Dodopayments::Models::Products::PricingMode, nil) (defaults to: nil) —

  Pricing mode for localized pricing. NULL means base-only (no localized rules app

• tax_inclusive (Boolean, nil) (defaults to: nil) —

  Indicates if the price is tax inclusive

# File 'lib/dodopayments/models/product_list_response.rb', line 114

Instance Attribute Details

#business_id ⇒ String

Unique identifier for the business to which the product belongs.

Parameters:

• value (String)

Returns:

• (String)

# File 'lib/dodopayments/models/product_list_response.rb', line 11

required :business_id, String

#created_at ⇒ Time

Timestamp when the product was created.

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/dodopayments/models/product_list_response.rb', line 17

required :created_at, Time

#currency ⇒ Symbol, ...

Currency of the price

Parameters:

• value (Dodopayments::Models::currency, nil)

Returns:

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

# File 'lib/dodopayments/models/product_list_response.rb', line 60

optional :currency, enum: -> { Dodopayments::Currency }, nil?: true

#description ⇒ String^?

Description of the product, optional.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_list_response.rb', line 66

optional :description, String, nil?: true

#entitlements ⇒ Array<Dodopayments::Models::ProductEntitlementSummary>

Entitlements linked to this product

Parameters:

• value (::Array[Dodopayments::ProductEntitlementSummary])

Returns:

• (Array<Dodopayments::Models::ProductEntitlementSummary>)

# File 'lib/dodopayments/models/product_list_response.rb', line 23

required :entitlements,
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductEntitlementSummary] }

#image ⇒ String^?

URL of the product image, optional.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_list_response.rb', line 72

optional :image, String, nil?: true

#is_recurring ⇒ Boolean

Indicates if the product is recurring (e.g., subscriptions).

Parameters:

• value (Boolean)

Returns:

• (Boolean)

# File 'lib/dodopayments/models/product_list_response.rb', line 30

required :is_recurring, Dodopayments::Internal::Type::Boolean

#metadata ⇒ Hash{Symbol=>String, Float, Boolean}

Additional custom data associated with the product

Parameters:

• value (Dodopayments::Models::metadata)

Returns:

• (Hash{Symbol=>String, Float, Boolean})

# File 'lib/dodopayments/models/product_list_response.rb', line 36

required :metadata, -> { Dodopayments::Internal::Type::HashOf[union: Dodopayments::MetadataItem] }

#name ⇒ String^?

Name of the product, optional.

Parameters:

• value (String, nil)

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_list_response.rb', line 78

optional :name, String, nil?: true

#price ⇒ Integer^?

Price of the product, optional.

The price is represented in the lowest denomination of the currency. For example:

• In USD, a price of $12.34 would be represented as 1234 (cents).
• In JPY, a price of ¥1500 would be represented as 1500 (yen).
• In INR, a price of ₹1234.56 would be represented as 123456 (paise).

This ensures precision and avoids floating-point rounding errors.

Parameters:

• value (Integer, nil)

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/product_list_response.rb', line 93

optional :price, Integer, nil?: true

#price_detail ⇒ Dodopayments::Models::Price::OneTimePrice, ...

Details of the price

Parameters:

• value (Dodopayments::Models::price, nil)

Returns:

• (Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, Dodopayments::Models::Price::UsageBasedPrice, nil)

# File 'lib/dodopayments/models/product_list_response.rb', line 99

optional :price_detail, union: -> { Dodopayments::Price }, nil?: true

#pricing_mode ⇒ Symbol, ...

Pricing mode for localized pricing. NULL means base-only (no localized rules apply).

Parameters:

• value (Dodopayments::Models::Products::pricing_mode, nil)

Returns:

• (Symbol, Dodopayments::Models::Products::PricingMode, nil)

# File 'lib/dodopayments/models/product_list_response.rb', line 106

optional :pricing_mode, enum: -> { Dodopayments::Products::PricingMode }, nil?: true

#product_id ⇒ String

Unique identifier for the product.

Parameters:

• value (String)

Returns:

• (String)

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

required :product_id, String

#tax_category ⇒ Symbol, Dodopayments::Models::TaxCategory

Tax category associated with the product.

Parameters:

• value (Dodopayments::Models::tax_category)

Returns:

• (Symbol, Dodopayments::Models::TaxCategory)

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

required :tax_category, enum: -> { Dodopayments::TaxCategory }

#tax_inclusive ⇒ Boolean^?

Indicates if the price is tax inclusive

Parameters:

• value (Boolean, nil)

Returns:

• (Boolean, nil)

# File 'lib/dodopayments/models/product_list_response.rb', line 112

optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true

#updated_at ⇒ Time

Timestamp when the product was last updated.

Parameters:

• value (Time)

Returns:

• (Time)

# File 'lib/dodopayments/models/product_list_response.rb', line 54

required :updated_at, Time

Instance Method Details

#to_hash ⇒ {

Returns:

• ({)

# File 'sig/dodopayments/models/product_list_response.rbs', line 75

def to_hash: -> {