dodopayments 2.8.1 → 2.9.0

data/lib/dodopayments/models/payment_create_response.rb

@@ -56,9 +56,9 @@ module Dodopayments
       # @!attribute product_cart
       #   Optional list of products included in the payment
       #
-      #   @return [Array<Dodopayments::Models::PaymentCreateResponse::ProductCart>, nil]
+      #   @return [Array<Dodopayments::Models::OneTimeProductCartItem>, nil]
       optional :product_cart,
-               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::PaymentCreateResponse::ProductCart] },
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::OneTimeProductCartItem] },
                nil?: true
 
       # @!method initialize(client_secret:, customer:, metadata:, payment_id:, total_amount:, discount_id: nil, expires_on: nil, payment_link: nil, product_cart: nil)
@@ -81,37 +81,7 @@ module Dodopayments
       #
       #   @param payment_link [String, nil] Optional URL to a hosted payment page
       #
-      #   @param product_cart [Array<Dodopayments::Models::PaymentCreateResponse::ProductCart>, nil] Optional list of products included in the payment
-
-      class ProductCart < Dodopayments::Internal::Type::BaseModel
-        # @!attribute product_id
-        #
-        #   @return [String]
-        required :product_id, String
-
-        # @!attribute quantity
-        #
-        #   @return [Integer]
-        required :quantity, Integer
-
-        # @!attribute amount
-        #   Amount the customer pays if pay_what_you_want is enabled. If disabled then
-        #   amount will be ignored Represented in the lowest denomination of the currency
-        #   (e.g., cents for USD). For example, to charge $1.00, pass `100`.
-        #
-        #   @return [Integer, nil]
-        optional :amount, Integer, nil?: true
-
-        # @!method initialize(product_id:, quantity:, amount: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Dodopayments::Models::PaymentCreateResponse::ProductCart} for more details.
-        #
-        #   @param product_id [String]
-        #
-        #   @param quantity [Integer]
-        #
-        #   @param amount [Integer, nil] Amount the customer pays if pay_what_you_want is enabled. If disabled then amoun
-      end
+      #   @param product_cart [Array<Dodopayments::Models::OneTimeProductCartItem>, nil] Optional list of products included in the payment
     end
   end
 end

data/lib/dodopayments/models/product.rb

@@ -31,8 +31,9 @@ module Dodopayments
       # @!attribute entitlements
       #   Attached entitlements (integration-based access grants)
       #
-      #   @return [Array<Dodopayments::Models::Product::Entitlement>]
-      required :entitlements, -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Product::Entitlement] }
+      #   @return [Array<Dodopayments::Models::ProductEntitlementSummary>]
+      required :entitlements,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductEntitlementSummary] }
 
       # @!attribute is_recurring
       #   Indicates if the product is recurring (e.g., subscriptions).
@@ -91,6 +92,10 @@ module Dodopayments
       optional :description, String, nil?: true
 
       # @!attribute digital_product_delivery
+      #   Digital-product-delivery payload for a grant. Populated for grants whose
+      #   entitlement has `integration_type = 'digital_files'`. `files` carries presigned
+      #   download URLs; the source (EE service or legacy in-process S3 presigning) is
+      #   opaque to the caller.
       #
       #   @return [Dodopayments::Models::DigitalProductDelivery, nil]
       optional :digital_product_delivery, -> { Dodopayments::DigitalProductDelivery }, nil?: true
@@ -136,6 +141,9 @@ module Dodopayments
       optional :product_collection_id, String, nil?: true
 
       # @!method initialize(brand_id:, business_id:, created_at:, credit_entitlements:, entitlements:, is_recurring:, license_key_enabled:, metadata:, price:, product_id:, tax_category:, updated_at:, addons: nil, description: nil, digital_product_delivery: nil, image: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, name: nil, product_collection_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::Product} for more details.
+      #
       #   @param brand_id [String]
       #
       #   @param business_id [String] Unique identifier for the business to which the product belongs.
@@ -144,7 +152,7 @@ module Dodopayments
       #
       #   @param credit_entitlements [Array<Dodopayments::Models::CreditEntitlementMappingResponse>] Attached credit entitlements with settings
       #
-      #   @param entitlements [Array<Dodopayments::Models::Product::Entitlement>] Attached entitlements (integration-based access grants)
+      #   @param entitlements [Array<Dodopayments::Models::ProductEntitlementSummary>] Attached entitlements (integration-based access grants)
       #
       #   @param is_recurring [Boolean] Indicates if the product is recurring (e.g., subscriptions).
       #
@@ -164,7 +172,7 @@ module Dodopayments
       #
       #   @param description [String, nil] Description of the product, optional.
       #
-      #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil]
+      #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Digital-product-delivery payload for a grant. Populated for grants whose
       #
       #   @param image [String, nil] URL of the product image, optional.
       #
@@ -177,219 +185,6 @@ module Dodopayments
       #   @param name [String, nil] Name of the product, optional.
       #
       #   @param product_collection_id [String, nil] The product collection ID this product belongs to, if any
-
-      class Entitlement < Dodopayments::Internal::Type::BaseModel
-        # @!attribute id
-        #
-        #   @return [String]
-        required :id, String
-
-        # @!attribute integration_config
-        #   Platform-specific configuration for an entitlement. Each variant uses unique
-        #   field names so `#[serde(untagged)]` can disambiguate correctly.
-        #
-        #   @return [Dodopayments::Models::Product::Entitlement::IntegrationConfig::GitHubConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::DiscordConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::TelegramConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::FigmaConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::FramerConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::NotionConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::LicenseKeyConfig]
-        required :integration_config, union: -> { Dodopayments::Product::Entitlement::IntegrationConfig }
-
-        # @!attribute integration_type
-        #
-        #   @return [Symbol, Dodopayments::Models::Product::Entitlement::IntegrationType]
-        required :integration_type, enum: -> { Dodopayments::Product::Entitlement::IntegrationType }
-
-        # @!attribute name
-        #
-        #   @return [String]
-        required :name, String
-
-        # @!attribute description
-        #
-        #   @return [String, nil]
-        optional :description, String, nil?: true
-
-        # @!method initialize(id:, integration_config:, integration_type:, name:, description: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Dodopayments::Models::Product::Entitlement} for more details.
-        #
-        #   Summary of an entitlement attached to a product
-        #
-        #   @param id [String]
-        #
-        #   @param integration_config [Dodopayments::Models::Product::Entitlement::IntegrationConfig::GitHubConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::DiscordConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::TelegramConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::FigmaConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::FramerConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::NotionConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::LicenseKeyConfig] Platform-specific configuration for an entitlement.
-        #
-        #   @param integration_type [Symbol, Dodopayments::Models::Product::Entitlement::IntegrationType]
-        #
-        #   @param name [String]
-        #
-        #   @param description [String, nil]
-
-        # Platform-specific configuration for an entitlement. Each variant uses unique
-        # field names so `#[serde(untagged)]` can disambiguate correctly.
-        #
-        # @see Dodopayments::Models::Product::Entitlement#integration_config
-        module IntegrationConfig
-          extend Dodopayments::Internal::Type::Union
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::GitHubConfig }
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::DiscordConfig }
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::TelegramConfig }
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::FigmaConfig }
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::FramerConfig }
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::NotionConfig }
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::DigitalFilesConfig }
-
-          variant -> { Dodopayments::Product::Entitlement::IntegrationConfig::LicenseKeyConfig }
-
-          class GitHubConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute permission
-            #   One of: pull, push, admin, maintain, triage
-            #
-            #   @return [String]
-            required :permission, String
-
-            # @!attribute target_id
-            #
-            #   @return [String]
-            required :target_id, String
-
-            # @!method initialize(permission:, target_id:)
-            #   @param permission [String] One of: pull, push, admin, maintain, triage
-            #
-            #   @param target_id [String]
-          end
-
-          class DiscordConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute guild_id
-            #
-            #   @return [String]
-            required :guild_id, String
-
-            # @!attribute role_id
-            #
-            #   @return [String, nil]
-            optional :role_id, String, nil?: true
-
-            # @!method initialize(guild_id:, role_id: nil)
-            #   @param guild_id [String]
-            #   @param role_id [String, nil]
-          end
-
-          class TelegramConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute chat_id
-            #
-            #   @return [String]
-            required :chat_id, String
-
-            # @!method initialize(chat_id:)
-            #   @param chat_id [String]
-          end
-
-          class FigmaConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute figma_file_id
-            #
-            #   @return [String]
-            required :figma_file_id, String
-
-            # @!method initialize(figma_file_id:)
-            #   @param figma_file_id [String]
-          end
-
-          class FramerConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute framer_template_id
-            #
-            #   @return [String]
-            required :framer_template_id, String
-
-            # @!method initialize(framer_template_id:)
-            #   @param framer_template_id [String]
-          end
-
-          class NotionConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute notion_template_id
-            #
-            #   @return [String]
-            required :notion_template_id, String
-
-            # @!method initialize(notion_template_id:)
-            #   @param notion_template_id [String]
-          end
-
-          class DigitalFilesConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute digital_file_ids
-            #
-            #   @return [Array<String>]
-            required :digital_file_ids, Dodopayments::Internal::Type::ArrayOf[String]
-
-            # @!attribute external_url
-            #
-            #   @return [String, nil]
-            optional :external_url, String, nil?: true
-
-            # @!attribute instructions
-            #
-            #   @return [String, nil]
-            optional :instructions, String, nil?: true
-
-            # @!method initialize(digital_file_ids:, external_url: nil, instructions: nil)
-            #   @param digital_file_ids [Array<String>]
-            #   @param external_url [String, nil]
-            #   @param instructions [String, nil]
-          end
-
-          class LicenseKeyConfig < Dodopayments::Internal::Type::BaseModel
-            # @!attribute activation_message
-            #
-            #   @return [String, nil]
-            optional :activation_message, String, nil?: true
-
-            # @!attribute activations_limit
-            #
-            #   @return [Integer, nil]
-            optional :activations_limit, Integer, nil?: true
-
-            # @!attribute duration_count
-            #
-            #   @return [Integer, nil]
-            optional :duration_count, Integer, nil?: true
-
-            # @!attribute duration_interval
-            #
-            #   @return [String, nil]
-            optional :duration_interval, String, nil?: true
-
-            # @!method initialize(activation_message: nil, activations_limit: nil, duration_count: nil, duration_interval: nil)
-            #   @param activation_message [String, nil]
-            #   @param activations_limit [Integer, nil]
-            #   @param duration_count [Integer, nil]
-            #   @param duration_interval [String, nil]
-          end
-
-          # @!method self.variants
-          #   @return [Array(Dodopayments::Models::Product::Entitlement::IntegrationConfig::GitHubConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::DiscordConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::TelegramConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::FigmaConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::FramerConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::NotionConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::DigitalFilesConfig, Dodopayments::Models::Product::Entitlement::IntegrationConfig::LicenseKeyConfig)]
-        end
-
-        # @see Dodopayments::Models::Product::Entitlement#integration_type
-        module IntegrationType
-          extend Dodopayments::Internal::Type::Enum
-
-          DISCORD = :discord
-          TELEGRAM = :telegram
-          GITHUB = :github
-          FIGMA = :figma
-          FRAMER = :framer
-          NOTION = :notion
-          DIGITAL_FILES = :digital_files
-          LICENSE_KEY = :license_key
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
     end
   end
 end

data/lib/dodopayments/models/product_create_params.rb

@@ -54,22 +54,29 @@ module Dodopayments
       # @!attribute digital_product_delivery
       #   Choose how you would like you digital product delivered
       #
+      #   deprecated: use entitlements instead
+      #
       #   @return [Dodopayments::Models::ProductCreateParams::DigitalProductDelivery, nil]
       optional :digital_product_delivery,
                -> { Dodopayments::ProductCreateParams::DigitalProductDelivery },
                nil?: true
 
-      # @!attribute entitlement_ids
-      #   Optional entitlement IDs to attach to this product (max 20)
+      # @!attribute entitlements
+      #   Optional entitlements to attach to this product (max 20)
       #
-      #   @return [Array<String>, nil]
-      optional :entitlement_ids, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+      #   @return [Array<Dodopayments::Models::AttachProductEntitlement>, nil]
+      optional :entitlements,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::AttachProductEntitlement] },
+               nil?: true
 
       # @!attribute license_key_activation_message
       #   @deprecated
       #
       #   Optional message displayed during license key activation
       #
+      #   deprecated: use entitlements instead. Ignored when a `license_key` entitlement
+      #   is attached via the `entitlements` field.
+      #
       #   @return [String, nil]
       optional :license_key_activation_message, String, nil?: true
 
@@ -78,6 +85,9 @@ module Dodopayments
       #
       #   The number of times the license key can be activated. Must be 0 or greater
       #
+      #   deprecated: use entitlements instead. Ignored when a `license_key` entitlement
+      #   is attached via the `entitlements` field.
+      #
       #   @return [Integer, nil]
       optional :license_key_activations_limit, Integer, nil?: true
 
@@ -86,6 +96,9 @@ module Dodopayments
       #   license key to expire. For subscriptions, the lifetime of the license key is
       #   tied to the subscription period
       #
+      #   deprecated: use entitlements instead. Ignored when a `license_key` entitlement
+      #   is attached via the `entitlements` field.
+      #
       #   @return [Dodopayments::Models::LicenseKeyDuration, nil]
       optional :license_key_duration, -> { Dodopayments::LicenseKeyDuration }, nil?: true
 
@@ -94,6 +107,10 @@ module Dodopayments
       #
       #   When true, generates and sends a license key to your customer. Defaults to false
       #
+      #   deprecated: use entitlements instead. If a `license_key` entitlement is also
+      #   attached via the `entitlements` field, the `license_key_*` config fields below
+      #   are ignored — the attached entitlement's config is the source of truth.
+      #
       #   @return [Boolean, nil]
       optional :license_key_enabled, Dodopayments::Internal::Type::Boolean, nil?: true
 
@@ -103,7 +120,7 @@ module Dodopayments
       #   @return [Hash{Symbol=>String}, nil]
       optional :metadata, Dodopayments::Internal::Type::HashOf[String]
 
-      # @!method initialize(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlement_ids: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, request_options: {})
+      # @!method initialize(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, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::ProductCreateParams} for more details.
       #
@@ -123,7 +140,7 @@ module Dodopayments
       #
       #   @param digital_product_delivery [Dodopayments::Models::ProductCreateParams::DigitalProductDelivery, nil] Choose how you would like you digital product delivered
       #
-      #   @param entitlement_ids [Array<String>, nil] Optional entitlement IDs to attach to this product (max 20)
+      #   @param entitlements [Array<Dodopayments::Models::AttachProductEntitlement>, nil] Optional entitlements to attach to this product (max 20)
       #
       #   @param license_key_activation_message [String, nil] Optional message displayed during license key activation
       #
@@ -153,6 +170,8 @@ module Dodopayments
         # @!method initialize(external_url: 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 instructions [String, nil] Instructions to download and use the digital product

data/lib/dodopayments/models/product_entitlement_summary.rb

@@ -0,0 +1,57 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    class ProductEntitlementSummary < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute integration_config
+      #   Public-facing variant of [`IntegrationConfig`]. Mirrors every variant shape on
+      #   the wire EXCEPT `DigitalFiles`, which is replaced with a hydrated
+      #   `digital_files` object (resolved download URLs etc.). The persisted JSONB stays
+      #   ID-only via [`IntegrationConfig`]; this enum is response-only.
+      #
+      #   @return [Dodopayments::Models::IntegrationConfigResponse::GitHubConfig, Dodopayments::Models::IntegrationConfigResponse::DiscordConfig, Dodopayments::Models::IntegrationConfigResponse::TelegramConfig, Dodopayments::Models::IntegrationConfigResponse::FigmaConfig, Dodopayments::Models::IntegrationConfigResponse::FramerConfig, Dodopayments::Models::IntegrationConfigResponse::NotionConfig, Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig, Dodopayments::Models::IntegrationConfigResponse::LicenseKeyConfig]
+      required :integration_config, union: -> { Dodopayments::IntegrationConfigResponse }
+
+      # @!attribute integration_type
+      #
+      #   @return [Symbol, Dodopayments::Models::EntitlementIntegrationType]
+      required :integration_type, enum: -> { Dodopayments::EntitlementIntegrationType }
+
+      # @!attribute name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!method initialize(id:, integration_config:, integration_type:, name:, description: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Dodopayments::Models::ProductEntitlementSummary} for more details.
+      #
+      #   Summary of an entitlement attached to a product.
+      #
+      #   `integration_config` uses [`IntegrationConfigResponse`] (NOT the persisted
+      #   [`IntegrationConfig`]) so digital_files entitlements embed the resolved
+      #   `digital_files` object — matching what `GET /entitlements/{id}` returns. All
+      #   other variants pass through unchanged via `#[serde(untagged)]`.
+      #
+      #   @param id [String]
+      #
+      #   @param integration_config [Dodopayments::Models::IntegrationConfigResponse::GitHubConfig, Dodopayments::Models::IntegrationConfigResponse::DiscordConfig, Dodopayments::Models::IntegrationConfigResponse::TelegramConfig, Dodopayments::Models::IntegrationConfigResponse::FigmaConfig, Dodopayments::Models::IntegrationConfigResponse::FramerConfig, Dodopayments::Models::IntegrationConfigResponse::NotionConfig, Dodopayments::Models::IntegrationConfigResponse::DigitalFilesConfig, Dodopayments::Models::IntegrationConfigResponse::LicenseKeyConfig] Public-facing variant of [`IntegrationConfig`]. Mirrors every variant
+      #
+      #   @param integration_type [Symbol, Dodopayments::Models::EntitlementIntegrationType]
+      #
+      #   @param name [String]
+      #
+      #   @param description [String, nil]
+    end
+  end
+end