Class: Dodopayments::Models::ProductUpdateParams::DigitalProductDelivery

Inherits:

Internal::Type::BaseModel

• Object
• Internal::Type::BaseModel
• Dodopayments::Models::ProductUpdateParams::DigitalProductDelivery

Defined in:

lib/dodopayments/models/product_update_params.rb

Instance Attribute Summary

• #external_url ⇒ String^?

  External URL to digital product.

• #files ⇒ Array<String>^?

  Uploaded files ids of digital product.

• #instructions ⇒ String^?

  Instructions to download and use the digital product.

Instance Method Summary

• #initialize(id:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, pricing_mode: nil, tax_category: nil, request_options: {}) ⇒ Object constructor

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

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(id:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, pricing_mode: nil, tax_category: nil, request_options: {}) ⇒ Object

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

Parameters:

• id (String)
• addons (Array<String>, nil) (defaults to: nil) —

  Available Addons for subscription products

• brand_id (String, nil) (defaults to: nil)
• credit_entitlements (Array<Dodopayments::Models::AttachCreditEntitlement>, nil) (defaults to: nil) —

  Credit entitlements to update (replaces all existing when present)

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

  Description of the product, optional and must be at most 1000 characters.

• digital_product_delivery (Dodopayments::Models::ProductUpdateParams::DigitalProductDelivery, nil) (defaults to: nil) —

  Choose how you would like you digital product delivered

• entitlements (Array<Dodopayments::Models::AttachProductEntitlement>, nil) (defaults to: nil) —

  Entitlements to attach (replaces all existing when present)

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

  Product image id after its uploaded to S3

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

  Message sent to the customer upon license key activation.

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

  Limit for the number of activations for the license key.

• license_key_duration (Dodopayments::Models::LicenseKeyDuration, nil) (defaults to: nil) —

  Duration of the license key if enabled.

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

  Whether the product requires a license key.

• metadata (Hash{Symbol=>String}, nil) (defaults to: nil) —

  Additional metadata for the product

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

  Name of the product, optional and must be at most 100 characters.

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

  Price details of the product.

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

  Update the pricing mode. Omit to leave unchanged; set to null to clear

• tax_category (Symbol, Dodopayments::Models::TaxCategory, nil) (defaults to: nil) —

  Tax category of the product.

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

# File 'lib/dodopayments/models/product_update_params.rb', line 188

class DigitalProductDelivery < Dodopayments::Internal::Type::BaseModel
  # @!attribute external_url
  #   External URL to digital product
  #
  #   @return [String, nil]
  optional :external_url, String, nil?: true

  # @!attribute files
  #   Uploaded files ids of digital product
  #
  #   @return [Array<String>, nil]
  optional :files, Dodopayments::Internal::Type::ArrayOf[String], nil?: true

  # @!attribute instructions
  #   Instructions to download and use the digital product
  #
  #   @return [String, nil]
  optional :instructions, String, nil?: true

  # @!method initialize(external_url: nil, files: nil, instructions: nil)
  #   Choose how you would like you digital product delivered
  #
  #   deprecated: use entitlements instead
  #
  #   @param external_url [String, nil] External URL to digital product
  #
  #   @param files [Array<String>, nil] Uploaded files ids of digital product
  #
  #   @param instructions [String, nil] Instructions to download and use the digital product
end

Instance Attribute Details

#external_url ⇒ String^?

External URL to digital product

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_update_params.rb', line 193

optional :external_url, String, nil?: true

#files ⇒ Array<String>^?

Uploaded files ids of digital product

Returns:

• (Array<String>, nil)

# File 'lib/dodopayments/models/product_update_params.rb', line 199

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

#instructions ⇒ String^?

Instructions to download and use the digital product

Returns:

• (String, nil)

# File 'lib/dodopayments/models/product_update_params.rb', line 205

optional :instructions, String, nil?: true