dodopayments 2.29.0 → 2.31.0

data/rbi/dodopayments/models/checkout_session_preview_response.rbi

@@ -64,7 +64,9 @@ module Dodopayments
       # The upcoming billing date for subscriptions, computed relative to now: with a
       # trial it is `now + trial_period_days`, otherwise `now + payment frequency`.
       # `None` for one-time-only carts. This is a preview estimate; the authoritative
-      # value is set when the subscription activates.
+      # value is set when the subscription activates. For a cart of more than one
+      # subscription, this is the earliest date of the cart. `subscriptions` gives the
+      # date of each subscription.
       sig { returns(T.nilable(Time)) }
       attr_accessor :next_billing_date
 
@@ -88,6 +90,19 @@ module Dodopayments
       end
       attr_writer :recurring_breakup
 
+      # One entry for each subscription of a cart that holds more than one. Each
+      # subscription renews on its own schedule, so the checkout shows each one here.
+      sig do
+        returns(
+          T.nilable(
+            T::Array[
+              Dodopayments::Models::CheckoutSessionPreviewResponse::Subscription
+            ]
+          )
+        )
+      end
+      attr_accessor :subscriptions
+
       # Registered business name from the official registry (EU/GB/AU) when found
       sig { returns(T.nilable(String)) }
       attr_accessor :tax_id_business_name
@@ -106,12 +121,15 @@ module Dodopayments
 
       # Per-unit trial amount after discounts, in the price currency's minor units
       # (pre-quantity, pre-tax; see `current_breakup` for the taxed total due today).
-      # Only present for a paid trial; `None` for a free trial or no trial.
+      # Only present for a paid trial; `None` for a free trial or no trial. Always
+      # `None` for a cart of more than one subscription.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :trial_amount
 
       # Effective trial duration in days for the subscription line, when there's a trial
-      # (free or paid). `None` if no subscription or no trial.
+      # (free or paid). `None` if no subscription or no trial. Always `None` for a cart
+      # of more than one subscription. Read the trial of each subscription from
+      # `subscriptions`.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :trial_period_days
 
@@ -134,6 +152,12 @@ module Dodopayments
             T.nilable(
               Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup::OrHash
             ),
+          subscriptions:
+            T.nilable(
+              T::Array[
+                Dodopayments::Models::CheckoutSessionPreviewResponse::Subscription::OrHash
+              ]
+            ),
           tax_id_business_name: T.nilable(String),
           tax_id_err_msg: T.nilable(String),
           tax_id_format_name: T.nilable(String),
@@ -164,10 +188,15 @@ module Dodopayments
         # The upcoming billing date for subscriptions, computed relative to now: with a
         # trial it is `now + trial_period_days`, otherwise `now + payment frequency`.
         # `None` for one-time-only carts. This is a preview estimate; the authoritative
-        # value is set when the subscription activates.
+        # value is set when the subscription activates. For a cart of more than one
+        # subscription, this is the earliest date of the cart. `subscriptions` gives the
+        # date of each subscription.
         next_billing_date: nil,
         # Breakup of recurring payments (None for one-time only)
         recurring_breakup: nil,
+        # One entry for each subscription of a cart that holds more than one. Each
+        # subscription renews on its own schedule, so the checkout shows each one here.
+        subscriptions: nil,
         # Registered business name from the official registry (EU/GB/AU) when found
         tax_id_business_name: nil,
         # Error message if tax ID validation failed
@@ -178,10 +207,13 @@ module Dodopayments
         total_tax: nil,
         # Per-unit trial amount after discounts, in the price currency's minor units
         # (pre-quantity, pre-tax; see `current_breakup` for the taxed total due today).
-        # Only present for a paid trial; `None` for a free trial or no trial.
+        # Only present for a paid trial; `None` for a free trial or no trial. Always
+        # `None` for a cart of more than one subscription.
         trial_amount: nil,
         # Effective trial duration in days for the subscription line, when there's a trial
-        # (free or paid). `None` if no subscription or no trial.
+        # (free or paid). `None` if no subscription or no trial. Always `None` for a cart
+        # of more than one subscription. Read the trial of each subscription from
+        # `subscriptions`.
         trial_period_days: nil
       )
       end
@@ -205,6 +237,12 @@ module Dodopayments
               T.nilable(
                 Dodopayments::Models::CheckoutSessionPreviewResponse::RecurringBreakup
               ),
+            subscriptions:
+              T.nilable(
+                T::Array[
+                  Dodopayments::Models::CheckoutSessionPreviewResponse::Subscription
+                ]
+              ),
             tax_id_business_name: T.nilable(String),
             tax_id_err_msg: T.nilable(String),
             tax_id_format_name: T.nilable(String),
@@ -796,6 +834,92 @@ module Dodopayments
         def to_hash
         end
       end
+
+      class Subscription < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::Models::CheckoutSessionPreviewResponse::Subscription,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The amount this subscription charges today, including tax.
+        sig { returns(Integer) }
+        attr_accessor :amount_due_now
+
+        # The subscription product.
+        sig { returns(String) }
+        attr_accessor :product_id
+
+        # The amount of each renewal, including tax.
+        sig { returns(Integer) }
+        attr_accessor :recurring_amount
+
+        # A preview of the first renewal date. The date is set when the subscription
+        # activates.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :next_billing_date
+
+        # The tax in `recurring_amount`.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :recurring_tax
+
+        # The tax in `amount_due_now`.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :tax_due_now
+
+        # The trial duration in days. `None` when the subscription has no trial.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :trial_period_days
+
+        # The quote of one subscription in a cart of several.
+        sig do
+          params(
+            amount_due_now: Integer,
+            product_id: String,
+            recurring_amount: Integer,
+            next_billing_date: T.nilable(Time),
+            recurring_tax: T.nilable(Integer),
+            tax_due_now: T.nilable(Integer),
+            trial_period_days: T.nilable(Integer)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The amount this subscription charges today, including tax.
+          amount_due_now:,
+          # The subscription product.
+          product_id:,
+          # The amount of each renewal, including tax.
+          recurring_amount:,
+          # A preview of the first renewal date. The date is set when the subscription
+          # activates.
+          next_billing_date: nil,
+          # The tax in `recurring_amount`.
+          recurring_tax: nil,
+          # The tax in `amount_due_now`.
+          tax_due_now: nil,
+          # The trial duration in days. `None` when the subscription has no trial.
+          trial_period_days: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount_due_now: Integer,
+              product_id: String,
+              recurring_amount: Integer,
+              next_billing_date: T.nilable(Time),
+              recurring_tax: T.nilable(Integer),
+              tax_due_now: T.nilable(Integer),
+              trial_period_days: T.nilable(Integer)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/checkout_session_request.rbi

@@ -11,6 +11,9 @@ module Dodopayments
           )
         end
 
+      # The products of the checkout. A cart holds at most 20 of them, one-time and
+      # subscription products together. An empty cart is valid for the
+      # product-collection flow, where the customer chooses the product later.
       sig { returns(T::Array[Dodopayments::ProductItemReq]) }
       attr_accessor :product_cart
 
@@ -37,7 +40,14 @@ module Dodopayments
       end
       attr_writer :billing_address
 
-      # This field is ingored if adaptive pricing is disabled
+      # The currency to charge the customer in.
+      #
+      # Adaptive pricing must be enabled for the business. The customer then pays in
+      # this currency. If you do not set it, the currency comes from the billing
+      # country.
+      #
+      # If adaptive pricing is disabled, the API discards this field. The currency then
+      # comes from the product price, or from the billing country.
       sig { returns(T.nilable(Dodopayments::Currency::OrSymbol)) }
       attr_accessor :billing_currency
 
@@ -130,11 +140,11 @@ module Dodopayments
 
       # If true, only zipcode is required when confirm is true; other address fields
       # remain optional
+      #
+      # Default is true when `feature_flags.single_page` is true. Otherwise, default is
+      # false.
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :minimal_address
-
-      sig { params(minimal_address: T::Boolean).void }
-      attr_writer :minimal_address
+      attr_accessor :minimal_address
 
       # Optional payment method ID to use for this checkout session. Only allowed when
       # `confirm` is true. If provided, existing customer id must also be provided.
@@ -205,7 +215,7 @@ module Dodopayments
           mandate_min_amount_inr_paise: T.nilable(Integer),
           metadata:
             T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
-          minimal_address: T::Boolean,
+          minimal_address: T.nilable(T::Boolean),
           payment_method_id: T.nilable(String),
           product_collection_id: T.nilable(String),
           return_url: T.nilable(String),
@@ -216,6 +226,9 @@ module Dodopayments
         ).returns(T.attached_class)
       end
       def self.new(
+        # The products of the checkout. A cart holds at most 20 of them, one-time and
+        # subscription products together. An empty cart is valid for the
+        # product-collection flow, where the customer chooses the product later.
         product_cart:,
         # Customers will never see payment methods that are not in this list. However,
         # adding a method here does not guarantee customers will see it. Availability
@@ -226,7 +239,14 @@ module Dodopayments
         allowed_payment_method_types: nil,
         # Billing address information for the session
         billing_address: nil,
-        # This field is ingored if adaptive pricing is disabled
+        # The currency to charge the customer in.
+        #
+        # Adaptive pricing must be enabled for the business. The customer then pays in
+        # this currency. If you do not set it, the currency comes from the billing
+        # country.
+        #
+        # If adaptive pricing is disabled, the API discards this field. The currency then
+        # comes from the product price, or from the billing country.
         billing_currency: nil,
         # The URL to redirect the customer if they cancel or go back from the checkout. If
         # not provided, the back button will not be displayed.
@@ -265,6 +285,9 @@ module Dodopayments
         metadata: nil,
         # If true, only zipcode is required when confirm is true; other address fields
         # remain optional
+        #
+        # Default is true when `feature_flags.single_page` is true. Otherwise, default is
+        # false.
         minimal_address: nil,
         # Optional payment method ID to use for this checkout session. Only allowed when
         # `confirm` is true. If provided, existing customer id must also be provided.
@@ -312,7 +335,7 @@ module Dodopayments
             mandate_min_amount_inr_paise: T.nilable(Integer),
             metadata:
               T.nilable(T::Hash[Symbol, Dodopayments::MetadataItem::Variants]),
-            minimal_address: T::Boolean,
+            minimal_address: T.nilable(T::Boolean),
             payment_method_id: T.nilable(String),
             product_collection_id: T.nilable(String),
             return_url: T.nilable(String),

data/rbi/dodopayments/models/customers/email_log_item.rbi

@@ -63,7 +63,8 @@ module Dodopayments
         sig { returns(T.nilable(String)) }
         attr_accessor :from
 
-        # The address the email reached.
+        # The address the email went to. On a failed email this is the address the
+        # provider reports as bounced.
         sig { returns(T.nilable(String)) }
         attr_accessor :recipient
 
@@ -111,7 +112,8 @@ module Dodopayments
           failure_reason: nil,
           # The address the email was sent from.
           from: nil,
-          # The address the email reached.
+          # The address the email went to. On a failed email this is the address the
+          # provider reports as bounced.
           recipient: nil,
           # The subject line as it was sent. Empty until the provider replicates.
           subject: nil

data/rbi/dodopayments/models/customers/email_policies.rbi

@@ -12,7 +12,8 @@ module Dodopayments
             )
           end
 
-        # A permanent failure was recorded, so the same address would be a no-op.
+        # A permanent failure was recorded, so a send to the same address delivers
+        # nothing. It is false for a suppressed address that a resend can clear.
         sig { returns(T::Boolean) }
         attr_accessor :requires_different_address
 
@@ -28,8 +29,9 @@ module Dodopayments
         sig { returns(T::Boolean) }
         attr_accessor :retry_allowed
 
-        # A later send of this email reached the provider, so this row is history. To send
-        # it again would deliver a second copy.
+        # A later send of this email replaced this row, so this row is history. A row that
+        # never went out needs a later send that reached the provider. A failed row needs
+        # a later send that was delivered.
         sig { returns(T::Boolean) }
         attr_accessor :superseded
 
@@ -45,7 +47,8 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
-          # A permanent failure was recorded, so the same address would be a no-op.
+          # A permanent failure was recorded, so a send to the same address delivers
+          # nothing. It is false for a suppressed address that a resend can clear.
           requires_different_address:,
           # The row was delivered and may be sent again.
           resend_allowed:,
@@ -53,8 +56,9 @@ module Dodopayments
           resends_remaining:,
           # The row failed and may be sent again.
           retry_allowed:,
-          # A later send of this email reached the provider, so this row is history. To send
-          # it again would deliver a second copy.
+          # A later send of this email replaced this row, so this row is history. A row that
+          # never went out needs a later send that reached the provider. A failed row needs
+          # a later send that was delivered.
           superseded:
         )
         end

data/rbi/dodopayments/models/discount_create_params.rbi

@@ -33,9 +33,11 @@ module Dodopayments
       attr_accessor :code
 
       # Per-currency options (flat deduction / percentage cap + minimum subtotal).
-      # Required for `flat` codes (must include a resolvable default); optional
-      # per-currency caps for `percentage` codes. Per-row invariants are checked in
-      # `normalize_currency_options`, not via `#[validate(nested)]`.
+      # Checkout uses the row for the currency the buyer pays in. For any other currency
+      # it converts the default row. Required for `flat` codes (must include a
+      # resolvable default); optional per-currency caps for `percentage` codes. Per-row
+      # invariants are checked in `normalize_currency_options`, not via
+      # `#[validate(nested)]`.
       sig do
         returns(
           T.nilable(
@@ -152,9 +154,11 @@ module Dodopayments
         # - If omitted, a random 16-character code is generated.
         code: nil,
         # Per-currency options (flat deduction / percentage cap + minimum subtotal).
-        # Required for `flat` codes (must include a resolvable default); optional
-        # per-currency caps for `percentage` codes. Per-row invariants are checked in
-        # `normalize_currency_options`, not via `#[validate(nested)]`.
+        # Checkout uses the row for the currency the buyer pays in. For any other currency
+        # it converts the default row. Required for `flat` codes (must include a
+        # resolvable default); optional per-currency caps for `percentage` codes. Per-row
+        # invariants are checked in `normalize_currency_options`, not via
+        # `#[validate(nested)]`.
         currency_options: nil,
         # Who may redeem this discount code. Defaults to `any` (unrestricted). `specific`
         # starts with zero attached customers (fails closed) until customers are attached
@@ -225,12 +229,13 @@ module Dodopayments
             )
           end
 
-        # The currency this option applies to.
+        # The currency this option applies to. The row applies when the buyer pays in this
+        # currency.
         sig { returns(Dodopayments::Currency::OrSymbol) }
         attr_accessor :currency
 
-        # Whether this row is the default to convert from for unconfigured currencies. At
-        # most one row per discount may be default.
+        # Whether this row is the default to convert from when the buyer pays in a
+        # currency that has no row. At most one row per discount may be default.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_default
 
@@ -264,10 +269,11 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
-          # The currency this option applies to.
+          # The currency this option applies to. The row applies when the buyer pays in this
+          # currency.
           currency:,
-          # Whether this row is the default to convert from for unconfigured currencies. At
-          # most one row per discount may be default.
+          # Whether this row is the default to convert from when the buyer pays in a
+          # currency that has no row. At most one row per discount may be default.
           is_default: nil,
           # The most this code discounts in this currency's subunits. For `flat` codes this
           # is the deduction; for `percentage` codes it is the max-discount cap. Must be > 0

data/rbi/dodopayments/models/discount_update_params.rbi

@@ -211,12 +211,13 @@ module Dodopayments
             )
           end
 
-        # The currency this option applies to.
+        # The currency this option applies to. The row applies when the buyer pays in this
+        # currency.
         sig { returns(Dodopayments::Currency::OrSymbol) }
         attr_accessor :currency
 
-        # Whether this row is the default to convert from for unconfigured currencies. At
-        # most one row per discount may be default.
+        # Whether this row is the default to convert from when the buyer pays in a
+        # currency that has no row. At most one row per discount may be default.
         sig { returns(T.nilable(T::Boolean)) }
         attr_reader :is_default
 
@@ -250,10 +251,11 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
-          # The currency this option applies to.
+          # The currency this option applies to. The row applies when the buyer pays in this
+          # currency.
           currency:,
-          # Whether this row is the default to convert from for unconfigured currencies. At
-          # most one row per discount may be default.
+          # Whether this row is the default to convert from when the buyer pays in a
+          # currency that has no row. At most one row per discount may be default.
           is_default: nil,
           # The most this code discounts in this currency's subunits. For `flat` codes this
           # is the deduction; for `percentage` codes it is the max-discount cap. Must be > 0

data/rbi/dodopayments/models/moderation_category.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    # A moderation category.
+    module ModerationCategory
+      extend Dodopayments::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Dodopayments::ModerationCategory) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      VIOLENT_CRIMES =
+        T.let(:violent_crimes, Dodopayments::ModerationCategory::TaggedSymbol)
+      SEX_RELATED_CRIMES =
+        T.let(
+          :sex_related_crimes,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      CHILD_SEXUAL_EXPLOITATION =
+        T.let(
+          :child_sexual_exploitation,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      SUICIDE_AND_SELF_HARM =
+        T.let(
+          :suicide_and_self_harm,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      INDISCRIMINATE_WEAPONS =
+        T.let(
+          :indiscriminate_weapons,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      INTELLECTUAL_PROPERTY =
+        T.let(
+          :intellectual_property,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      DEFAMATION =
+        T.let(:defamation, Dodopayments::ModerationCategory::TaggedSymbol)
+      NON_VIOLENT_CRIMES =
+        T.let(
+          :non_violent_crimes,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      HATE = T.let(:hate, Dodopayments::ModerationCategory::TaggedSymbol)
+      PRIVACY = T.let(:privacy, Dodopayments::ModerationCategory::TaggedSymbol)
+      SPECIALIZED_ADVICE =
+        T.let(
+          :specialized_advice,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      SEXUAL_CONTENT =
+        T.let(:sexual_content, Dodopayments::ModerationCategory::TaggedSymbol)
+      NON_CONSENSUAL_INTIMATE_IMAGERY =
+        T.let(
+          :non_consensual_intimate_imagery,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      MINOR_CODED_LANGUAGE =
+        T.let(
+          :minor_coded_language,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      REAL_PERSON_LIKENESS =
+        T.let(
+          :real_person_likeness,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      LIVING_ARTIST_STYLE =
+        T.let(
+          :living_artist_style,
+          Dodopayments::ModerationCategory::TaggedSymbol
+        )
+      PROMPT_INJECTION =
+        T.let(:prompt_injection, Dodopayments::ModerationCategory::TaggedSymbol)
+
+      sig do
+        override.returns(
+          T::Array[Dodopayments::ModerationCategory::TaggedSymbol]
+        )
+      end
+      def self.values
+      end
+    end
+  end
+end