Class: Dodopayments::Models::ProductListResponse

Inherits:

Internal::Type::BaseModel

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

Defined in:

lib/dodopayments/models/product_list_response.rb

Overview

See Also:

• Resources::Products#list

Defined Under Namespace

Classes: Entitlement

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::ProductListResponse::Entitlement>

  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}

  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.

• #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.

Method Summary

Methods inherited from Internal::Type::BaseModel

==, #==, #[], coerce, #deconstruct_keys, #deep_to_h, dump, fields, hash, #hash, inherited, #initialize, 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

This class inherits a constructor from Dodopayments::Internal::Type::BaseModel

Instance Attribute Details

#business_id ⇒ String

Unique identifier for the business to which the product belongs.

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.

Returns:

• (Time)

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

required :created_at, Time

#currency ⇒ Symbol, ...

Currency of the price

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.

Returns:

• (String, nil)

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

optional :description, String, nil?: true

#entitlements ⇒ Array<Dodopayments::Models::ProductListResponse::Entitlement>

Entitlements linked to this product

Returns:

• (Array<Dodopayments::Models::ProductListResponse::Entitlement>)

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

required :entitlements,
-> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::ProductListResponse::Entitlement] }

#image ⇒ String^?

URL of the product image, optional.

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).

Returns:

• (Boolean)

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

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

#metadata ⇒ Hash{Symbol=>String}

Additional custom data associated with the product

Returns:

• (Hash{Symbol=>String})

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

required :metadata, Dodopayments::Internal::Type::HashOf[String]

#name ⇒ String^?

Name of the product, optional.

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.

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

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

#product_id ⇒ String

Unique identifier for the product.

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.

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

Returns:

• (Boolean, nil)

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

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

#updated_at ⇒ Time

Timestamp when the product was last updated.

Returns:

• (Time)

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

required :updated_at, Time