Class: Dodopayments::Resources::Products

Inherits:

Object

• Object
• Dodopayments::Resources::Products

Defined in:

lib/dodopayments/resources/products.rb,
lib/dodopayments/resources/products/images.rb,
lib/dodopayments/resources/products/short_links.rb,
lib/dodopayments/resources/products/localized_prices.rb

Defined Under Namespace

Classes: Images, LocalizedPrices, ShortLinks

Instance Attribute Summary

• #images ⇒ Dodopayments::Resources::Products::Images readonly
• #localized_prices ⇒ Dodopayments::Resources::Products::LocalizedPrices readonly
• #short_links ⇒ Dodopayments::Resources::Products::ShortLinks readonly

Instance Method Summary

• #archive(id, request_options: {}) ⇒ nil
• #create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, pricing_mode: nil, request_options: {}) ⇒ Dodopayments::Models::Product

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

• #initialize(client:) ⇒ Products constructor private

  A new instance of Products.

• #list(archived: nil, brand_id: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::ProductListResponse>

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

• #retrieve(id, request_options: {}) ⇒ Dodopayments::Models::Product
• #unarchive(id, request_options: {}) ⇒ nil
• #update(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: {}) ⇒ nil

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

• #update_files(id, file_name:, request_options: {}) ⇒ Dodopayments::Models::ProductUpdateFilesResponse

Constructor Details

#initialize(client:) ⇒ Products

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of Products.

Parameters:

• client (Dodopayments::Client)

# File 'lib/dodopayments/resources/products.rb', line 233

def initialize(client:)
  @client = client
  @images = Dodopayments::Resources::Products::Images.new(client: client)
  @short_links = Dodopayments::Resources::Products::ShortLinks.new(client: client)
  @localized_prices = Dodopayments::Resources::Products::LocalizedPrices.new(client: client)
end

Instance Attribute Details

#images ⇒ Dodopayments::Resources::Products::Images (readonly)

Returns:

• (Dodopayments::Resources::Products::Images)

# File 'lib/dodopayments/resources/products.rb', line 7

def images
  @images
end

#localized_prices ⇒ Dodopayments::Resources::Products::LocalizedPrices (readonly)

Returns:

• (Dodopayments::Resources::Products::LocalizedPrices)

# File 'lib/dodopayments/resources/products.rb', line 13

def localized_prices
  @localized_prices
end

#short_links ⇒ Dodopayments::Resources::Products::ShortLinks (readonly)

Returns:

• (Dodopayments::Resources::Products::ShortLinks)

# File 'lib/dodopayments/resources/products.rb', line 10

def short_links
  @short_links
end

Instance Method Details

#archive(id, request_options: {}) ⇒ nil

Parameters:

• id (String) —

  Product Id

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

Returns:

• (nil)

See Also:

• Models::ProductArchiveParams

# File 'lib/dodopayments/resources/products.rb', line 181

def archive(id, params = {})
  @client.request(
    method: :delete,
    path: ["products/%1$s", id],
    model: NilClass,
    options: params[:request_options]
  )
end

#create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, pricing_mode: nil, request_options: {}) ⇒ Dodopayments::Models::Product

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

Parameters:

• name (String) —

  Name of the product

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

  Price configuration for the product

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

  Tax category applied to this product

• addons (Array<String>, nil) —

  Addons available for subscription product

• brand_id (String, nil) —

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

• credit_entitlements (Array<Dodopayments::Models::AttachCreditEntitlement>, nil) —

  Optional credit entitlements to attach (max 5)

• description (String, nil) —

  Optional description of the product

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

  Choose how you would like you digital product delivered

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

  Optional entitlements to attach to this product (max 50)

• license_key_activation_message (String, nil) —

  Optional message displayed during license key activation

• license_key_activations_limit (Integer, nil) —

  The number of times the license key can be activated.

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

  Duration configuration for the license key.

• license_key_enabled (Boolean, nil) —

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

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

  Additional metadata for the product

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

  Pricing mode for localized pricing. When set, rules from

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

Returns:

• (Dodopayments::Models::Product)

See Also:

• Models::ProductCreateParams

# File 'lib/dodopayments/resources/products.rb', line 55

def create(params)
  parsed, options = Dodopayments::ProductCreateParams.dump_request(params)
  @client.request(
    method: :post,
    path: "products",
    body: parsed,
    model: Dodopayments::Product,
    options: options
  )
end

#list(archived: nil, brand_id: nil, page_number: nil, page_size: nil, recurring: nil, request_options: {}) ⇒ Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::ProductListResponse>

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

Parameters:

• 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:

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

Returns:

• (Dodopayments::Internal::DefaultPageNumberPagination<Dodopayments::Models::ProductListResponse>)

See Also:

• Models::ProductListParams

# File 'lib/dodopayments/resources/products.rb', line 159

def list(params = {})
  parsed, options = Dodopayments::ProductListParams.dump_request(params)
  query = Dodopayments::Internal::Util.encode_query_params(parsed)
  @client.request(
    method: :get,
    path: "products",
    query: query,
    page: Dodopayments::Internal::DefaultPageNumberPagination,
    model: Dodopayments::Models::ProductListResponse,
    options: options
  )
end

#retrieve(id, request_options: {}) ⇒ Dodopayments::Models::Product

Parameters:

• id (String) —

  Product Id

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

Returns:

• (Dodopayments::Models::Product)

See Also:

• Models::ProductRetrieveParams

# File 'lib/dodopayments/resources/products.rb', line 75

def retrieve(id, params = {})
  @client.request(
    method: :get,
    path: ["products/%1$s", id],
    model: Dodopayments::Product,
    options: params[:request_options]
  )
end

#unarchive(id, request_options: {}) ⇒ nil

Parameters:

• id (String) —

  Product Id

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

Returns:

• (nil)

See Also:

• Models::ProductUnarchiveParams

# File 'lib/dodopayments/resources/products.rb', line 199

def unarchive(id, params = {})
  @client.request(
    method: :post,
    path: ["products/%1$s/unarchive", id],
    model: NilClass,
    options: params[:request_options]
  )
end

#update(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: {}) ⇒ nil

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

Parameters:

• id (String) —

  Product Id

• addons (Array<String>, nil) —

  Available Addons for subscription products

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

  Credit entitlements to update (replaces all existing when present)

• description (String, nil) —

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

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

  Choose how you would like you digital product delivered

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

  Entitlements to attach (replaces all existing when present)

• image_id (String, nil) —

  Product image id after its uploaded to S3

• license_key_activation_message (String, nil) —

  Message sent to the customer upon license key activation.

• license_key_activations_limit (Integer, nil) —

  Limit for the number of activations for the license key.

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

  Duration of the license key if enabled.

• license_key_enabled (Boolean, nil) —

  Whether the product requires a license key.

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

  Additional metadata for the product

• name (String, 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) —

  Price details of the product.

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

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

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

  Tax category of the product.

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

Returns:

• (nil)

See Also:

• Models::ProductUpdateParams

# File 'lib/dodopayments/resources/products.rb', line 128

def update(id, params = {})
  parsed, options = Dodopayments::ProductUpdateParams.dump_request(params)
  @client.request(
    method: :patch,
    path: ["products/%1$s", id],
    body: parsed,
    model: NilClass,
    options: options
  )
end

#update_files(id, file_name:, request_options: {}) ⇒ Dodopayments::Models::ProductUpdateFilesResponse

Parameters:

• id (String) —

  Product Id

• file_name (String)
• request_options (Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil)

Returns:

• (Dodopayments::Models::ProductUpdateFilesResponse)

See Also:

• Models::ProductUpdateFilesParams

# File 'lib/dodopayments/resources/products.rb', line 219

def update_files(id, params)
  parsed, options = Dodopayments::ProductUpdateFilesParams.dump_request(params)
  @client.request(
    method: :put,
    path: ["products/%1$s/files", id],
    body: parsed,
    model: Dodopayments::Models::ProductUpdateFilesResponse,
    options: options
  )
end