dodopayments 2.29.0 → 2.30.0

data/lib/dodopayments/resources/moderation.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Resources
+    class Moderation
+      # Shows how many billable screens you made and how close you are to your next
+      # charge.
+      #
+      # **Billing.** A billable screen is a live-mode screen that returns a verdict.
+      # Dodo Payments charges $0.30 for each full block of 1000 billable screens and
+      # debits the fee from your balance. Each full block is charged within one hour.
+      # Screens that do not fill a block stay unbilled until they do. Errors and
+      # test-mode screens are free and are not counted.
+      #
+      # @overload retrieve_usage(request_options: {})
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::ModerationRetrieveUsageResponse]
+      #
+      # @see Dodopayments::Models::ModerationRetrieveUsageParams
+      def retrieve_usage(params = {})
+        @client.request(
+          method: :get,
+          path: "moderation/usage",
+          model: Dodopayments::Models::ModerationRetrieveUsageResponse,
+          options: params[:request_options]
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Dodopayments::Models::ModerationScreenParams} for more details.
+      #
+      # Screens text, an image, or both, and returns a verdict: `allow`, `flag` or
+      # `deny`. The API is fail-closed: do not generate when you get no verdict.
+      #
+      # **Pricing.** Dodo Payments charges $0.30 per 1000 billable screens and debits
+      # the fee from your balance. A billable screen is a live-mode screen that returns
+      # a verdict. Errors and test-mode screens are free.
+      #
+      # **429.** Honour `Retry-After` and retry. A 429 is a throughput limit, not a
+      # verdict.
+      #
+      # **Test mode** returns mock verdicts and never calls the model. The default
+      # verdict is `allow`. Put one of these strings in `text` to select another
+      # outcome: `dodo_mock_flag` (`flag`), `dodo_mock_deny` (`deny`),
+      # `dodo_mock_overloaded` (429) or `dodo_mock_not_ready` (503).
+      #
+      # @overload screen(image: nil, request_id: nil, text: nil, request_options: {})
+      #
+      # @param image [String, nil] The image to screen, as base64, with or without a `data:image/...;base64,` prefi
+      #
+      # @param request_id [String, nil] Your identifier for this screen, up to 128 characters, with no control character
+      #
+      # @param text [String, nil] The text to screen, up to 8000 characters.
+      #
+      # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Dodopayments::Models::ModerationScreenResponse]
+      #
+      # @see Dodopayments::Models::ModerationScreenParams
+      def screen(params = {})
+        parsed, options = Dodopayments::ModerationScreenParams.dump_request(params)
+        @client.request(
+          method: :post,
+          path: "moderation/screen",
+          body: parsed,
+          model: Dodopayments::Models::ModerationScreenResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Dodopayments::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/dodopayments/resources/payouts/breakup/details.rb

@@ -5,10 +5,10 @@ module Dodopayments
     class Payouts
       class Breakup
         class Details
-          # Returns paginated individual balance ledger entries for a payout, with each
-          # entry's amount pro-rated into the payout's currency. Supports pagination via
-          # `page_size` (default 10, max 100) and `page_number` (default 0) query
-          # parameters.
+          # Returns paginated individual balance ledger entries for a payout. Each entry is
+          # converted into the payout's currency at the rate the payout settled at. Supports
+          # pagination via `page_size` (default 10, max 100) and `page_number` (default 0)
+          # query parameters.
           #
           # @overload list(payout_id, page_number: nil, page_size: nil, request_options: {})
           #

data/lib/dodopayments/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Dodopayments
-  VERSION = "2.29.0"
+  VERSION = "2.30.0"
 end

data/lib/dodopayments.rb

@@ -270,6 +270,15 @@ require_relative "dodopayments/models/meter_retrieve_params"
 require_relative "dodopayments/models/meter_unarchive_params"
 require_relative "dodopayments/models/misc_list_supported_countries_params"
 require_relative "dodopayments/models/misc_list_supported_countries_response"
+require_relative "dodopayments/models/moderation_category"
+require_relative "dodopayments/models/moderation_category_provenance"
+require_relative "dodopayments/models/moderation_category_scores"
+require_relative "dodopayments/models/moderation_decision"
+require_relative "dodopayments/models/moderation_provenance"
+require_relative "dodopayments/models/moderation_retrieve_usage_params"
+require_relative "dodopayments/models/moderation_retrieve_usage_response"
+require_relative "dodopayments/models/moderation_screen_params"
+require_relative "dodopayments/models/moderation_screen_response"
 require_relative "dodopayments/models/new_customer"
 require_relative "dodopayments/models/on_demand_subscription"
 require_relative "dodopayments/models/one_time_product_cart_item"
@@ -441,6 +450,7 @@ require_relative "dodopayments/resources/license_keys"
 require_relative "dodopayments/resources/licenses"
 require_relative "dodopayments/resources/meters"
 require_relative "dodopayments/resources/misc"
+require_relative "dodopayments/resources/moderation"
 require_relative "dodopayments/resources/payments"
 require_relative "dodopayments/resources/payouts"
 require_relative "dodopayments/resources/payouts/breakup"

data/rbi/dodopayments/client.rbi

@@ -101,6 +101,9 @@ module Dodopayments
     sig { returns(Dodopayments::Resources::ProductCollections) }
     attr_reader :product_collections
 
+    sig { returns(Dodopayments::Resources::Moderation) }
+    attr_reader :moderation
+
     # @api private
     sig { override.returns(T::Hash[String, String]) }
     private def auth_headers

data/rbi/dodopayments/models/balance_ledger_entry.rbi

@@ -253,6 +253,21 @@ module Dodopayments
             :deflection_fees_reversal,
             Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
           )
+        RESERVE_HOLD =
+          T.let(
+            :reserve_hold,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
+        RESERVE_RELEASE =
+          T.let(
+            :reserve_release,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
+        MODERATION_FEES =
+          T.let(
+            :moderation_fees,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/balance_retrieve_ledger_params.rbi

@@ -1045,6 +1045,21 @@ module Dodopayments
             :deflection_fees_reversal,
             Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
           )
+        RESERVE_HOLD =
+          T.let(
+            :reserve_hold,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
+        RESERVE_RELEASE =
+          T.let(
+            :reserve_release,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
+        MODERATION_FEES =
+          T.let(
+            :moderation_fees,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/checkout_session_flags.rbi

@@ -137,6 +137,16 @@ module Dodopayments
       sig { params(redirect_immediately: T::Boolean).void }
       attr_writer :redirect_immediately
 
+      # If true, the customer must give the name on the card to pay by card. The
+      # checkout page enforces this. Other payment methods ignore it.
+      #
+      # Default is false
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :require_cardholder_name
+
+      sig { params(require_cardholder_name: T::Boolean).void }
+      attr_writer :require_cardholder_name
+
       # If true, the customer must provide a phone number to complete checkout. Requires
       # `allow_phone_number_collection` to also be true.
       #
@@ -193,6 +203,7 @@ module Dodopayments
           allow_tax_id: T::Boolean,
           always_create_new_customer: T::Boolean,
           redirect_immediately: T::Boolean,
+          require_cardholder_name: T::Boolean,
           require_phone_number: T::Boolean,
           require_tax_id: T::Boolean,
           single_page: T::Boolean
@@ -245,6 +256,11 @@ module Dodopayments
         #
         # Default is false
         redirect_immediately: nil,
+        # If true, the customer must give the name on the card to pay by card. The
+        # checkout page enforces this. Other payment methods ignore it.
+        #
+        # Default is false
+        require_cardholder_name: nil,
         # If true, the customer must provide a phone number to complete checkout. Requires
         # `allow_phone_number_collection` to also be true.
         #
@@ -290,6 +306,7 @@ module Dodopayments
             allow_tax_id: T::Boolean,
             always_create_new_customer: T::Boolean,
             redirect_immediately: T::Boolean,
+            require_cardholder_name: T::Boolean,
             require_phone_number: T::Boolean,
             require_tax_id: T::Boolean,
             single_page: T::Boolean

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
 
@@ -216,6 +219,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

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

@@ -28,8 +28,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
 
@@ -53,8 +54,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