dodopayments 2.9.0 → 2.10.0

data/lib/dodopayments/models/payment_failed_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::PaymentFailedWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::PaymentFailedWebhookEvent::Type }
+      #   @return [Symbol, :"payment.failed"]
+      required :type, const: :"payment.failed"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payment.failed")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Payment]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::PaymentFailedWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::PaymentFailedWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        PAYMENT_FAILED = :"payment.failed"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"payment.failed"] The event type
     end
   end
 end

data/lib/dodopayments/models/payment_processing_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::PaymentProcessingWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::PaymentProcessingWebhookEvent::Type }
+      #   @return [Symbol, :"payment.processing"]
+      required :type, const: :"payment.processing"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payment.processing")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Payment]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::PaymentProcessingWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::PaymentProcessingWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        PAYMENT_PROCESSING = :"payment.processing"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"payment.processing"] The event type
     end
   end
 end

data/lib/dodopayments/models/payment_succeeded_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::PaymentSucceededWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::PaymentSucceededWebhookEvent::Type }
+      #   @return [Symbol, :"payment.succeeded"]
+      required :type, const: :"payment.succeeded"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"payment.succeeded")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Payment]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::PaymentSucceededWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::PaymentSucceededWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        PAYMENT_SUCCEEDED = :"payment.succeeded"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"payment.succeeded"] The event type
     end
   end
 end

data/lib/dodopayments/models/payout_list_response.rb

@@ -17,7 +17,8 @@ module Dodopayments
       required :business_id, String
 
       # @!attribute chargebacks
-      #   @deprecated
+      #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+      #   release.
       #
       #   The total value of chargebacks associated with the payout.
       #
@@ -55,7 +56,8 @@ module Dodopayments
       required :payout_id, String
 
       # @!attribute refunds
-      #   @deprecated
+      #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+      #   release.
       #
       #   The total value of refunds associated with the payout.
       #
@@ -69,7 +71,8 @@ module Dodopayments
       required :status, enum: -> { Dodopayments::Models::PayoutListResponse::Status }
 
       # @!attribute tax
-      #   @deprecated
+      #   @deprecated Use the v3 payout breakup endpoints instead. Will be removed in a future
+      #   release.
       #
       #   The tax applied to the payout.
       #

data/lib/dodopayments/models/price.rb

@@ -6,14 +6,16 @@ module Dodopayments
     module Price
       extend Dodopayments::Internal::Type::Union
 
+      discriminator :type
+
       # One-time price details.
-      variant -> { Dodopayments::Price::OneTimePrice }
+      variant :one_time_price, -> { Dodopayments::Price::OneTimePrice }
 
       # Recurring price details.
-      variant -> { Dodopayments::Price::RecurringPrice }
+      variant :recurring_price, -> { Dodopayments::Price::RecurringPrice }
 
       # Usage Based price details.
-      variant -> { Dodopayments::Price::UsageBasedPrice }
+      variant :usage_based_price, -> { Dodopayments::Price::UsageBasedPrice }
 
       class OneTimePrice < Dodopayments::Internal::Type::BaseModel
         # @!attribute currency
@@ -47,8 +49,8 @@ module Dodopayments
 
         # @!attribute type
         #
-        #   @return [Symbol, Dodopayments::Models::Price::OneTimePrice::Type]
-        required :type, enum: -> { Dodopayments::Price::OneTimePrice::Type }
+        #   @return [Symbol, :one_time_price]
+        required :type, const: :one_time_price
 
         # @!attribute pay_what_you_want
         #   Indicates whether the customer can pay any amount they choose. If set to `true`,
@@ -71,7 +73,7 @@ module Dodopayments
         #   @return [Boolean, nil]
         optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(currency:, discount:, price:, purchasing_power_parity:, type:, pay_what_you_want: nil, suggested_price: nil, tax_inclusive: nil)
+        # @!method initialize(currency:, discount:, price:, purchasing_power_parity:, pay_what_you_want: nil, suggested_price: nil, tax_inclusive: nil, type: :one_time_price)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::OneTimePrice} for more details.
         #
@@ -85,23 +87,13 @@ module Dodopayments
         #
         #   @param purchasing_power_parity [Boolean] Indicates if purchasing power parity adjustments are applied to the price.
         #
-        #   @param type [Symbol, Dodopayments::Models::Price::OneTimePrice::Type]
-        #
         #   @param pay_what_you_want [Boolean] Indicates whether the customer can pay any amount they choose.
         #
         #   @param suggested_price [Integer, nil] A suggested price for the user to pay. This value is only considered if
         #
         #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive.
-
-        # @see Dodopayments::Models::Price::OneTimePrice#type
-        module Type
-          extend Dodopayments::Internal::Type::Enum
-
-          ONE_TIME_PRICE = :one_time_price
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+        #
+        #   @param type [Symbol, :one_time_price]
       end
 
       class RecurringPrice < Dodopayments::Internal::Type::BaseModel
@@ -159,8 +151,8 @@ module Dodopayments
 
         # @!attribute type
         #
-        #   @return [Symbol, Dodopayments::Models::Price::RecurringPrice::Type]
-        required :type, enum: -> { Dodopayments::Price::RecurringPrice::Type }
+        #   @return [Symbol, :recurring_price]
+        required :type, const: :recurring_price
 
         # @!attribute tax_inclusive
         #   Indicates if the price is tax inclusive
@@ -174,7 +166,7 @@ module Dodopayments
         #   @return [Integer, nil]
         optional :trial_period_days, Integer
 
-        # @!method initialize(currency:, discount:, payment_frequency_count:, payment_frequency_interval:, price:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, type:, tax_inclusive: nil, trial_period_days: nil)
+        # @!method initialize(currency:, discount:, payment_frequency_count:, payment_frequency_interval:, price:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, tax_inclusive: nil, trial_period_days: nil, type: :recurring_price)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::RecurringPrice} for more details.
         #
@@ -196,21 +188,11 @@ module Dodopayments
         #
         #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
         #
-        #   @param type [Symbol, Dodopayments::Models::Price::RecurringPrice::Type]
-        #
         #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
         #
         #   @param trial_period_days [Integer] Number of days for the trial period. A value of `0` indicates no trial period.
-
-        # @see Dodopayments::Models::Price::RecurringPrice#type
-        module Type
-          extend Dodopayments::Internal::Type::Enum
-
-          RECURRING_PRICE = :recurring_price
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+        #
+        #   @param type [Symbol, :recurring_price]
       end
 
       class UsageBasedPrice < Dodopayments::Internal::Type::BaseModel
@@ -268,8 +250,8 @@ module Dodopayments
 
         # @!attribute type
         #
-        #   @return [Symbol, Dodopayments::Models::Price::UsageBasedPrice::Type]
-        required :type, enum: -> { Dodopayments::Price::UsageBasedPrice::Type }
+        #   @return [Symbol, :usage_based_price]
+        required :type, const: :usage_based_price
 
         # @!attribute meters
         #
@@ -286,7 +268,7 @@ module Dodopayments
         #   @return [Boolean, nil]
         optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
 
-        # @!method initialize(currency:, discount:, fixed_price:, payment_frequency_count:, payment_frequency_interval:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, type:, meters: nil, tax_inclusive: nil)
+        # @!method initialize(currency:, discount:, fixed_price:, payment_frequency_count:, payment_frequency_interval:, purchasing_power_parity:, subscription_period_count:, subscription_period_interval:, meters: nil, tax_inclusive: nil, type: :usage_based_price)
         #   Some parameter documentations has been truncated, see
         #   {Dodopayments::Models::Price::UsageBasedPrice} for more details.
         #
@@ -308,21 +290,11 @@ module Dodopayments
         #
         #   @param subscription_period_interval [Symbol, Dodopayments::Models::TimeInterval] The time interval for the subscription period (e.g., day, month, year).
         #
-        #   @param type [Symbol, Dodopayments::Models::Price::UsageBasedPrice::Type]
-        #
         #   @param meters [Array<Dodopayments::Models::AddMeterToPrice>, nil]
         #
         #   @param tax_inclusive [Boolean, nil] Indicates if the price is tax inclusive
-
-        # @see Dodopayments::Models::Price::UsageBasedPrice#type
-        module Type
-          extend Dodopayments::Internal::Type::Enum
-
-          USAGE_BASED_PRICE = :usage_based_price
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
+        #
+        #   @param type [Symbol, :usage_based_price]
       end
 
       # @!method self.variants

data/lib/dodopayments/models/product.rb

@@ -42,7 +42,7 @@ module Dodopayments
       required :is_recurring, Dodopayments::Internal::Type::Boolean
 
       # @!attribute license_key_enabled
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Indicates whether the product requires a license key.
       #
@@ -92,10 +92,8 @@ 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.
+      #   Digital-product-delivery payload, present on grants for `digital_files`
+      #   entitlements. Each file carries a short-lived presigned download URL.
       #
       #   @return [Dodopayments::Models::DigitalProductDelivery, nil]
       optional :digital_product_delivery, -> { Dodopayments::DigitalProductDelivery }, nil?: true
@@ -107,7 +105,7 @@ module Dodopayments
       optional :image, String, nil?: true
 
       # @!attribute license_key_activation_message
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Message sent upon license key activation, if applicable.
       #
@@ -115,7 +113,7 @@ module Dodopayments
       optional :license_key_activation_message, String, nil?: true
 
       # @!attribute license_key_activations_limit
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Limit on the number of activations for the license key, if enabled.
       #
@@ -172,7 +170,7 @@ module Dodopayments
       #
       #   @param description [String, nil] Description of the product, optional.
       #
-      #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Digital-product-delivery payload for a grant. Populated for grants whose
+      #   @param digital_product_delivery [Dodopayments::Models::DigitalProductDelivery, nil] Digital-product-delivery payload, present on grants for `digital_files`
       #
       #   @param image [String, nil] URL of the product image, optional.
       #

data/lib/dodopayments/models/product_create_params.rb

@@ -70,7 +70,7 @@ module Dodopayments
                nil?: true
 
       # @!attribute license_key_activation_message
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Optional message displayed during license key activation
       #
@@ -81,7 +81,7 @@ module Dodopayments
       optional :license_key_activation_message, String, nil?: true
 
       # @!attribute license_key_activations_limit
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   The number of times the license key can be activated. Must be 0 or greater
       #
@@ -103,7 +103,7 @@ module Dodopayments
       optional :license_key_duration, -> { Dodopayments::LicenseKeyDuration }, nil?: true
 
       # @!attribute license_key_enabled
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   When true, generates and sends a license key to your customer. Defaults to false
       #

data/lib/dodopayments/models/product_entitlement_summary.rb

@@ -9,10 +9,10 @@ module Dodopayments
       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.
+      #   Integration-specific configuration on an entitlement read response.
+      #
+      #   For `digital_files` entitlements the response includes presigned download URLs
+      #   for each attached file; other integrations match the shape supplied at creation.
       #
       #   @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 }
@@ -45,7 +45,7 @@ module Dodopayments
       #
       #   @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_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] Integration-specific configuration on an entitlement read response.
       #
       #   @param integration_type [Symbol, Dodopayments::Models::EntitlementIntegrationType]
       #

data/lib/dodopayments/models/product_item_req.rb

@@ -32,7 +32,18 @@ module Dodopayments
       #   @return [Integer, nil]
       optional :amount, Integer, nil?: true
 
-      # @!method initialize(product_id:, quantity:, addons: nil, amount: nil)
+      # @!attribute credit_entitlements
+      #   Per-checkout-session overrides for credit entitlements already attached to this
+      #   product. Each entry overrides the `credits_amount` granted by the referenced
+      #   credit entitlement when this checkout session is fulfilled. The
+      #   credit_entitlement_id must already be attached to the product.
+      #
+      #   @return [Array<Dodopayments::Models::ProductItemReq::CreditEntitlement>, nil]
+      optional :credit_entitlements,
+               -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductItemReq::CreditEntitlement] },
+               nil?: true
+
+      # @!method initialize(product_id:, quantity:, addons: nil, amount: nil, credit_entitlements: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::ProductItemReq} for more details.
       #
@@ -43,6 +54,36 @@ module Dodopayments
       #   @param addons [Array<Dodopayments::Models::AttachAddon>, nil] only valid if product is a subscription
       #
       #   @param amount [Integer, nil] Amount the customer pays if pay_what_you_want is enabled. If disabled then amoun
+      #
+      #   @param credit_entitlements [Array<Dodopayments::Models::ProductItemReq::CreditEntitlement>, nil] Per-checkout-session overrides for credit entitlements already attached
+
+      class CreditEntitlement < Dodopayments::Internal::Type::BaseModel
+        # @!attribute credit_entitlement_id
+        #   ID of the credit entitlement to override. Must already be attached to the
+        #   product.
+        #
+        #   @return [String]
+        required :credit_entitlement_id, String
+
+        # @!attribute credits_amount
+        #   Number of credits to grant for this checkout session, overriding the
+        #   product-level `credits_amount` set on the credit entitlement mapping. Must be
+        #   greater than zero.
+        #
+        #   @return [String]
+        required :credits_amount, String
+
+        # @!method initialize(credit_entitlement_id:, credits_amount:)
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::ProductItemReq::CreditEntitlement} for more details.
+        #
+        #   Per-checkout-session override for a single credit entitlement attached to a
+        #   product.
+        #
+        #   @param credit_entitlement_id [String] ID of the credit entitlement to override. Must already be attached to the produc
+        #
+        #   @param credits_amount [String] Number of credits to grant for this checkout session, overriding the
+      end
     end
   end
 end

data/lib/dodopayments/models/product_update_params.rb

@@ -64,7 +64,7 @@ module Dodopayments
       optional :image_id, String, nil?: true
 
       # @!attribute license_key_activation_message
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Message sent to the customer upon license key activation.
       #
@@ -77,7 +77,7 @@ module Dodopayments
       optional :license_key_activation_message, String, nil?: true
 
       # @!attribute license_key_activations_limit
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Limit for the number of activations for the license key.
       #
@@ -101,7 +101,7 @@ module Dodopayments
       optional :license_key_duration, -> { Dodopayments::LicenseKeyDuration }, nil?: true
 
       # @!attribute license_key_enabled
-      #   @deprecated
+      #   @deprecated Use the dedicated entitlements API to configure license-key delivery.
       #
       #   Whether the product requires a license key.
       #

data/lib/dodopayments/models/refund_failed_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::RefundFailedWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::RefundFailedWebhookEvent::Type }
+      #   @return [Symbol, :"refund.failed"]
+      required :type, const: :"refund.failed"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"refund.failed")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Refund]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::RefundFailedWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::RefundFailedWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        REFUND_FAILED = :"refund.failed"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"refund.failed"] The event type
     end
   end
 end

data/lib/dodopayments/models/refund_succeeded_webhook_event.rb

@@ -23,29 +23,17 @@ module Dodopayments
       # @!attribute type
       #   The event type
       #
-      #   @return [Symbol, Dodopayments::Models::RefundSucceededWebhookEvent::Type]
-      required :type, enum: -> { Dodopayments::RefundSucceededWebhookEvent::Type }
+      #   @return [Symbol, :"refund.succeeded"]
+      required :type, const: :"refund.succeeded"
 
-      # @!method initialize(business_id:, data:, timestamp:, type:)
+      # @!method initialize(business_id:, data:, timestamp:, type: :"refund.succeeded")
       #   @param business_id [String] The business identifier
       #
       #   @param data [Dodopayments::Models::Refund]
       #
       #   @param timestamp [Time] The timestamp of when the event occurred
       #
-      #   @param type [Symbol, Dodopayments::Models::RefundSucceededWebhookEvent::Type] The event type
-
-      # The event type
-      #
-      # @see Dodopayments::Models::RefundSucceededWebhookEvent#type
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        REFUND_SUCCEEDED = :"refund.succeeded"
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
+      #   @param type [Symbol, :"refund.succeeded"] The event type
     end
   end
 end