Class: Dodopayments::Models::ProductCreateParams

Inherits:

Internal::Type::BaseModel

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

Extended by:

Internal::Type::RequestParameters::Converter

Includes:

Internal::Type::RequestParameters

Defined in:

lib/dodopayments/models/product_create_params.rb

Overview

See Also:

• Resources::Products#create

Defined Under Namespace

Classes: DigitalProductDelivery

Instance Attribute Summary

• #addons ⇒ Array<String>^?

  Addons available for subscription product.

• #brand_id ⇒ String^?

  Brand id for the product, if not provided will default to primary brand.

• #description ⇒ String^?

  Optional description of the product.

• #digital_product_delivery ⇒ Dodopayments::Models::ProductCreateParams::DigitalProductDelivery^?

  Choose how you would like you digital product delivered.

• #license_key_activation_message ⇒ String^?

  Optional message displayed during license key activation.

• #license_key_activations_limit ⇒ Integer^?

  The number of times the license key can be activated.

• #license_key_duration ⇒ Dodopayments::Models::LicenseKeyDuration^?

  Duration configuration for the license key.

• #license_key_enabled ⇒ Boolean^?

  When true, generates and sends a license key to your customer.

• #metadata ⇒ Hash{Symbol=>String}^?

  Additional metadata for the product.

• #name ⇒ String

  Name of the product.

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

  Price configuration for the product.

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

  Tax category applied to this product.

Attributes included from Internal::Type::RequestParameters

#request_options

Method Summary

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, #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

#addons ⇒ Array<String>^?

Addons available for subscription product

Returns:

• (Array<String>, nil)

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

optional :addons, Dodopayments::Internal::Type::ArrayOf[String], nil?: true

#brand_id ⇒ String^?

Brand id for the product, if not provided will default to primary brand

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_create_params.rb', line 38

optional :brand_id, String, nil?: true

#description ⇒ String^?

Optional description of the product

Returns:

• (String, nil)

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

optional :description, String, nil?: true

#digital_product_delivery ⇒ Dodopayments::Models::ProductCreateParams::DigitalProductDelivery^?

Choose how you would like you digital product delivered

Returns:

• (Dodopayments::Models::ProductCreateParams::DigitalProductDelivery, nil)

# File 'lib/dodopayments/models/product_create_params.rb', line 50

optional :digital_product_delivery,
-> { Dodopayments::ProductCreateParams::DigitalProductDelivery },
nil?: true

#license_key_activation_message ⇒ String^?

Optional message displayed during license key activation

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_create_params.rb', line 58

optional :license_key_activation_message, String, nil?: true

#license_key_activations_limit ⇒ Integer^?

The number of times the license key can be activated. Must be 0 or greater

Returns:

• (Integer, nil)

# File 'lib/dodopayments/models/product_create_params.rb', line 64

optional :license_key_activations_limit, Integer, nil?: true

#license_key_duration ⇒ Dodopayments::Models::LicenseKeyDuration^?

Duration configuration for the license key. Set to null if you don’t want the license key to expire. For subscriptions, the lifetime of the license key is tied to the subscription period

Returns:

• (Dodopayments::Models::LicenseKeyDuration, nil)

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

optional :license_key_duration, -> { Dodopayments::LicenseKeyDuration }, nil?: true

#license_key_enabled ⇒ Boolean^?

When true, generates and sends a license key to your customer. Defaults to false

Returns:

• (Boolean, nil)

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

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

#metadata ⇒ Hash{Symbol=>String}^?

Additional metadata for the product

Returns:

• (Hash{Symbol=>String}, nil)

# File 'lib/dodopayments/models/product_create_params.rb', line 84

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

#name ⇒ String

Name of the product

Returns:

• (String)

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

required :name, String

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

Price configuration for the product

Returns:

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

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

required :price, union: -> { Dodopayments::Price }

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

Tax category applied to this product

Returns:

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

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

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