dodopayments 2.14.0 → 2.15.0

data/rbi/dodopayments/models/abandoned_checkout_recovered_webhook_event.rbi

@@ -92,6 +92,10 @@ module Dodopayments
         end
         attr_accessor :abandonment_reason
 
+        # Brand id this abandoned checkout belongs to
+        sig { returns(String) }
+        attr_accessor :brand_id
+
         sig { returns(String) }
         attr_accessor :customer_id
 
@@ -115,6 +119,7 @@ module Dodopayments
             abandoned_at: Time,
             abandonment_reason:
               Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::OrSymbol,
+            brand_id: String,
             customer_id: String,
             payment_id: String,
             status:
@@ -125,6 +130,8 @@ module Dodopayments
         def self.new(
           abandoned_at:,
           abandonment_reason:,
+          # Brand id this abandoned checkout belongs to
+          brand_id:,
           customer_id:,
           payment_id:,
           status:,
@@ -138,6 +145,7 @@ module Dodopayments
               abandoned_at: Time,
               abandonment_reason:
                 Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::TaggedSymbol,
+              brand_id: String,
               customer_id: String,
               payment_id: String,
               status:

data/rbi/dodopayments/models/checkout_session_preview_response.rbi

@@ -35,6 +35,13 @@ module Dodopayments
       end
       attr_writer :current_breakup
 
+      # Whether the payment will be routed through the merchant's own processor (BYOP).
+      # True when the session's business has a BYOP route configured for the billing
+      # country; in that case the quoted amounts exclude Dodo-computed tax because the
+      # merchant is MoR and owns tax.
+      sig { returns(T::Boolean) }
+      attr_accessor :is_byop
+
       # The total product cart
       sig do
         returns(
@@ -84,6 +91,7 @@ module Dodopayments
           currency: Dodopayments::Currency::OrSymbol,
           current_breakup:
             Dodopayments::Models::CheckoutSessionPreviewResponse::CurrentBreakup::OrHash,
+          is_byop: T::Boolean,
           product_cart:
             T::Array[
               Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart::OrHash
@@ -104,6 +112,11 @@ module Dodopayments
         currency:,
         # Breakup of the current payment
         current_breakup:,
+        # Whether the payment will be routed through the merchant's own processor (BYOP).
+        # True when the session's business has a BYOP route configured for the billing
+        # country; in that case the quoted amounts exclude Dodo-computed tax because the
+        # merchant is MoR and owns tax.
+        is_byop:,
         # The total product cart
         product_cart:,
         # Total calculate price of the product cart
@@ -124,6 +137,7 @@ module Dodopayments
             currency: Dodopayments::Currency::TaggedSymbol,
             current_breakup:
               Dodopayments::Models::CheckoutSessionPreviewResponse::CurrentBreakup,
+            is_byop: T::Boolean,
             product_cart:
               T::Array[
                 Dodopayments::Models::CheckoutSessionPreviewResponse::ProductCart

data/rbi/dodopayments/models/credit_balance_low_webhook_event.rbi

@@ -79,6 +79,10 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :available_balance
 
+        # Brand id this credit entitlement belongs to
+        sig { returns(String) }
+        attr_accessor :brand_id
+
         sig { returns(String) }
         attr_accessor :credit_entitlement_id
 
@@ -104,6 +108,7 @@ module Dodopayments
         sig do
           params(
             available_balance: String,
+            brand_id: String,
             credit_entitlement_id: String,
             credit_entitlement_name: String,
             customer_id: String,
@@ -115,6 +120,8 @@ module Dodopayments
         end
         def self.new(
           available_balance:,
+          # Brand id this credit entitlement belongs to
+          brand_id:,
           credit_entitlement_id:,
           credit_entitlement_name:,
           customer_id:,
@@ -129,6 +136,7 @@ module Dodopayments
           override.returns(
             {
               available_balance: String,
+              brand_id: String,
               credit_entitlement_id: String,
               credit_entitlement_name: String,
               customer_id: String,

data/rbi/dodopayments/models/credit_entitlements/credit_ledger_entry.rbi

@@ -24,6 +24,10 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :balance_before
 
+        # Brand id this credit ledger entry belongs to
+        sig { returns(String) }
+        attr_accessor :brand_id
+
         sig { returns(String) }
         attr_accessor :business_id
 
@@ -71,6 +75,7 @@ module Dodopayments
             amount: String,
             balance_after: String,
             balance_before: String,
+            brand_id: String,
             business_id: String,
             created_at: Time,
             credit_entitlement_id: String,
@@ -91,6 +96,8 @@ module Dodopayments
           amount:,
           balance_after:,
           balance_before:,
+          # Brand id this credit ledger entry belongs to
+          brand_id:,
           business_id:,
           created_at:,
           credit_entitlement_id:,
@@ -113,6 +120,7 @@ module Dodopayments
               amount: String,
               balance_after: String,
               balance_before: String,
+              brand_id: String,
               business_id: String,
               created_at: Time,
               credit_entitlement_id: String,

data/rbi/dodopayments/models/dunning_recovered_webhook_event.rbi

@@ -76,6 +76,10 @@ module Dodopayments
             )
           end
 
+        # Brand id this dunning attempt belongs to
+        sig { returns(String) }
+        attr_accessor :brand_id
+
         sig { returns(Time) }
         attr_accessor :created_at
 
@@ -105,6 +109,7 @@ module Dodopayments
         # Webhook payload for dunning.started and dunning.recovered events
         sig do
           params(
+            brand_id: String,
             created_at: Time,
             customer_id: String,
             status:
@@ -116,6 +121,8 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
+          # Brand id this dunning attempt belongs to
+          brand_id:,
           created_at:,
           customer_id:,
           status:,
@@ -128,6 +135,7 @@ module Dodopayments
         sig do
           override.returns(
             {
+              brand_id: String,
               created_at: Time,
               customer_id: String,
               status:

data/rbi/dodopayments/models/dunning_started_webhook_event.rbi

@@ -76,6 +76,10 @@ module Dodopayments
             )
           end
 
+        # Brand id this dunning attempt belongs to
+        sig { returns(String) }
+        attr_accessor :brand_id
+
         sig { returns(Time) }
         attr_accessor :created_at
 
@@ -105,6 +109,7 @@ module Dodopayments
         # Webhook payload for dunning.started and dunning.recovered events
         sig do
           params(
+            brand_id: String,
             created_at: Time,
             customer_id: String,
             status:
@@ -116,6 +121,8 @@ module Dodopayments
           ).returns(T.attached_class)
         end
         def self.new(
+          # Brand id this dunning attempt belongs to
+          brand_id:,
           created_at:,
           customer_id:,
           status:,
@@ -128,6 +135,7 @@ module Dodopayments
         sig do
           override.returns(
             {
+              brand_id: String,
               created_at: Time,
               customer_id: String,
               status:

data/rbi/dodopayments/models/entitlements/entitlement_grant.rbi

@@ -18,6 +18,10 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :id
 
+        # Brand id this grant belongs to.
+        sig { returns(String) }
+        attr_accessor :brand_id
+
         # Identifier of the business that owns the grant.
         sig { returns(String) }
         attr_accessor :business_id
@@ -123,6 +127,7 @@ module Dodopayments
         sig do
           params(
             id: String,
+            brand_id: String,
             business_id: String,
             created_at: Time,
             customer_id: String,
@@ -151,6 +156,8 @@ module Dodopayments
         def self.new(
           # Unique identifier of the grant.
           id:,
+          # Brand id this grant belongs to.
+          brand_id:,
           # Identifier of the business that owns the grant.
           business_id:,
           # Timestamp when the grant was created.
@@ -200,6 +207,7 @@ module Dodopayments
           override.returns(
             {
               id: String,
+              brand_id: String,
               business_id: String,
               created_at: Time,
               customer_id: String,

data/rbi/dodopayments/models/entitlements/grant_list_params.rbi

@@ -25,24 +25,6 @@ module Dodopayments
         sig { params(customer_id: String).void }
         attr_writer :customer_id
 
-        # Filter by integration type
-        sig do
-          returns(
-            T.nilable(
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::OrSymbol
-            )
-          )
-        end
-        attr_reader :integration_type
-
-        sig do
-          params(
-            integration_type:
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::OrSymbol
-          ).void
-        end
-        attr_writer :integration_type
-
         # Page number (default 0)
         sig { returns(T.nilable(Integer)) }
         attr_reader :page_number
@@ -79,8 +61,6 @@ module Dodopayments
           params(
             id: String,
             customer_id: String,
-            integration_type:
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::OrSymbol,
             page_number: Integer,
             page_size: Integer,
             status:
@@ -92,8 +72,6 @@ module Dodopayments
           id:,
           # Filter by customer ID
           customer_id: nil,
-          # Filter by integration type
-          integration_type: nil,
           # Page number (default 0)
           page_number: nil,
           # Page size (default 10, max 100)
@@ -109,8 +87,6 @@ module Dodopayments
             {
               id: String,
               customer_id: String,
-              integration_type:
-                Dodopayments::Entitlements::GrantListParams::IntegrationType::OrSymbol,
               page_number: Integer,
               page_size: Integer,
               status:
@@ -122,71 +98,6 @@ module Dodopayments
         def to_hash
         end
 
-        # Filter by integration type
-        module IntegrationType
-          extend Dodopayments::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                Dodopayments::Entitlements::GrantListParams::IntegrationType
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          DISCORD =
-            T.let(
-              :discord,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-          TELEGRAM =
-            T.let(
-              :telegram,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-          GITHUB =
-            T.let(
-              :github,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-          FIGMA =
-            T.let(
-              :figma,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-          FRAMER =
-            T.let(
-              :framer,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-          NOTION =
-            T.let(
-              :notion,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-          DIGITAL_FILES =
-            T.let(
-              :digital_files,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-          LICENSE_KEY =
-            T.let(
-              :license_key,
-              Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                Dodopayments::Entitlements::GrantListParams::IntegrationType::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-
         # Filter by grant status
         module Status
           extend Dodopayments::Internal::Type::Enum

data/rbi/dodopayments/models/get_dispute.rbi

@@ -13,6 +13,10 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :amount
 
+      # Brand id this dispute belongs to
+      sig { returns(String) }
+      attr_accessor :brand_id
+
       # The unique identifier of the business involved in the dispute.
       sig { returns(String) }
       attr_accessor :business_id
@@ -50,6 +54,12 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :payment_id
 
+      # Which processor handled the underlying payment. `stripe` / `adyen` for BYOP
+      # routes (the merchant's own Hyperswitch connector); `dodo` for everything Dodo
+      # processed itself.
+      sig { returns(Dodopayments::GetDispute::PaymentProvider::TaggedSymbol) }
+      attr_accessor :payment_provider
+
       # Whether the dispute was resolved by Rapid Dispute Resolution
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :is_resolved_by_rdr
@@ -65,6 +75,7 @@ module Dodopayments
       sig do
         params(
           amount: String,
+          brand_id: String,
           business_id: String,
           created_at: Time,
           currency: String,
@@ -73,6 +84,7 @@ module Dodopayments
           dispute_stage: Dodopayments::DisputeStage::OrSymbol,
           dispute_status: Dodopayments::DisputeStatus::OrSymbol,
           payment_id: String,
+          payment_provider: Dodopayments::GetDispute::PaymentProvider::OrSymbol,
           is_resolved_by_rdr: T.nilable(T::Boolean),
           reason: T.nilable(String),
           remarks: T.nilable(String)
@@ -82,6 +94,8 @@ module Dodopayments
         # The amount involved in the dispute, represented as a string to accommodate
         # precision.
         amount:,
+        # Brand id this dispute belongs to
+        brand_id:,
         # The unique identifier of the business involved in the dispute.
         business_id:,
         # The timestamp of when the dispute was created, in UTC.
@@ -98,6 +112,10 @@ module Dodopayments
         dispute_status:,
         # The unique identifier of the payment associated with the dispute.
         payment_id:,
+        # Which processor handled the underlying payment. `stripe` / `adyen` for BYOP
+        # routes (the merchant's own Hyperswitch connector); `dodo` for everything Dodo
+        # processed itself.
+        payment_provider:,
         # Whether the dispute was resolved by Rapid Dispute Resolution
         is_resolved_by_rdr: nil,
         # Reason for the dispute
@@ -111,6 +129,7 @@ module Dodopayments
         override.returns(
           {
             amount: String,
+            brand_id: String,
             business_id: String,
             created_at: Time,
             currency: String,
@@ -119,6 +138,8 @@ module Dodopayments
             dispute_stage: Dodopayments::DisputeStage::TaggedSymbol,
             dispute_status: Dodopayments::DisputeStatus::TaggedSymbol,
             payment_id: String,
+            payment_provider:
+              Dodopayments::GetDispute::PaymentProvider::TaggedSymbol,
             is_resolved_by_rdr: T.nilable(T::Boolean),
             reason: T.nilable(String),
             remarks: T.nilable(String)
@@ -127,6 +148,37 @@ module Dodopayments
       end
       def to_hash
       end
+
+      # Which processor handled the underlying payment. `stripe` / `adyen` for BYOP
+      # routes (the merchant's own Hyperswitch connector); `dodo` for everything Dodo
+      # processed itself.
+      module PaymentProvider
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::GetDispute::PaymentProvider)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STRIPE =
+          T.let(
+            :stripe,
+            Dodopayments::GetDispute::PaymentProvider::TaggedSymbol
+          )
+        ADYEN =
+          T.let(:adyen, Dodopayments::GetDispute::PaymentProvider::TaggedSymbol)
+        DODO =
+          T.let(:dodo, Dodopayments::GetDispute::PaymentProvider::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[Dodopayments::GetDispute::PaymentProvider::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/integration_config.rbi

@@ -308,9 +308,9 @@ module Dodopayments
         sig { returns(T.nilable(Dodopayments::TimeInterval::OrSymbol)) }
         attr_accessor :duration_interval
 
-        # Fulfillment mode: `auto` (default) generates keys automatically; `manual`
-        # creates pending grants the merchant fulfills via the
-        # `POST /grants/{id}/license-key` endpoint.
+        # How license keys are fulfilled. `auto` (default) generates and delivers keys to
+        # customers automatically; `manual` creates pending grants that you fulfill with
+        # the supplied key via `POST /grants/{grant_id}/license-key`.
         sig do
           returns(
             T.nilable(
@@ -344,9 +344,9 @@ module Dodopayments
           duration_count: nil,
           # Unit of `duration_count`.
           duration_interval: nil,
-          # Fulfillment mode: `auto` (default) generates keys automatically; `manual`
-          # creates pending grants the merchant fulfills via the
-          # `POST /grants/{id}/license-key` endpoint.
+          # How license keys are fulfilled. `auto` (default) generates and delivers keys to
+          # customers automatically; `manual` creates pending grants that you fulfill with
+          # the supplied key via `POST /grants/{grant_id}/license-key`.
           fulfillment_mode: nil
         )
         end
@@ -369,9 +369,9 @@ module Dodopayments
         def to_hash
         end
 
-        # Fulfillment mode: `auto` (default) generates keys automatically; `manual`
-        # creates pending grants the merchant fulfills via the
-        # `POST /grants/{id}/license-key` endpoint.
+        # How license keys are fulfilled. `auto` (default) generates and delivers keys to
+        # customers automatically; `manual` creates pending grants that you fulfill with
+        # the supplied key via `POST /grants/{grant_id}/license-key`.
         module FulfillmentMode
           extend Dodopayments::Internal::Type::Enum
 

data/rbi/dodopayments/models/integration_config_response.rbi

@@ -425,11 +425,9 @@ module Dodopayments
         sig { returns(T.nilable(Dodopayments::TimeInterval::TaggedSymbol)) }
         attr_accessor :duration_interval
 
-        # Fulfillment mode:
-        #
-        # `auto` (default) generate and delivery license keys to customers automatically.
-        # `manual` creates pending grants, actual key is provided via the fulfillment API
-        # and delivered to the customer when fulfilled.
+        # How license keys are fulfilled. `auto` (default) generates and delivers keys to
+        # customers automatically; `manual` creates pending grants that you fulfill with
+        # the supplied key via `POST /grants/{grant_id}/license-key`.
         sig do
           returns(
             T.nilable(
@@ -463,11 +461,9 @@ module Dodopayments
           duration_count: nil,
           # Unit of `duration_count`.
           duration_interval: nil,
-          # Fulfillment mode:
-          #
-          # `auto` (default) generate and delivery license keys to customers automatically.
-          # `manual` creates pending grants, actual key is provided via the fulfillment API
-          # and delivered to the customer when fulfilled.
+          # How license keys are fulfilled. `auto` (default) generates and delivers keys to
+          # customers automatically; `manual` creates pending grants that you fulfill with
+          # the supplied key via `POST /grants/{grant_id}/license-key`.
           fulfillment_mode: nil
         )
         end
@@ -490,11 +486,9 @@ module Dodopayments
         def to_hash
         end
 
-        # Fulfillment mode:
-        #
-        # `auto` (default) generate and delivery license keys to customers automatically.
-        # `manual` creates pending grants, actual key is provided via the fulfillment API
-        # and delivered to the customer when fulfilled.
+        # How license keys are fulfilled. `auto` (default) generates and delivers keys to
+        # customers automatically; `manual` creates pending grants that you fulfill with
+        # the supplied key via `POST /grants/{grant_id}/license-key`.
         module FulfillmentMode
           extend Dodopayments::Internal::Type::Enum
 

data/rbi/dodopayments/models/license_key.rbi

@@ -12,6 +12,10 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :id
 
+      # Brand id this license key belongs to
+      sig { returns(String) }
+      attr_accessor :brand_id
+
       # The unique identifier of the business associated with the license key.
       sig { returns(String) }
       attr_accessor :business_id
@@ -65,6 +69,7 @@ module Dodopayments
       sig do
         params(
           id: String,
+          brand_id: String,
           business_id: String,
           created_at: Time,
           customer_id: String,
@@ -82,6 +87,8 @@ module Dodopayments
       def self.new(
         # The unique identifier of the license key.
         id:,
+        # Brand id this license key belongs to
+        brand_id:,
         # The unique identifier of the business associated with the license key.
         business_id:,
         # The timestamp indicating when the license key was created, in UTC.
@@ -115,6 +122,7 @@ module Dodopayments
         override.returns(
           {
             id: String,
+            brand_id: String,
             business_id: String,
             created_at: Time,
             customer_id: String,

data/rbi/dodopayments/models/payment.rbi

@@ -84,8 +84,9 @@ module Dodopayments
       sig { returns(Dodopayments::Currency::TaggedSymbol) }
       attr_accessor :settlement_currency
 
-      # Total amount charged to the customer including tax, in smallest currency unit
-      # (e.g. cents)
+      # Total amount charged to the customer including tax, in the currency's smallest
+      # unit (e.g. cents for USD, yen for JPY, fils for KWD — see the currency's decimal
+      # places)
       sig { returns(Integer) }
       attr_accessor :total_amount
 
@@ -179,7 +180,8 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :subscription_id
 
-      # Amount of tax collected in smallest currency unit (e.g. cents)
+      # Amount of tax collected in the currency's smallest unit (e.g. cents for USD, yen
+      # for JPY, fils for KWD)
       sig { returns(T.nilable(Integer)) }
       attr_accessor :tax
 
@@ -271,8 +273,9 @@ module Dodopayments
         # balance. This may differ from the customer's payment currency in adaptive
         # pricing scenarios.
         settlement_currency:,
-        # Total amount charged to the customer including tax, in smallest currency unit
-        # (e.g. cents)
+        # Total amount charged to the customer including tax, in the currency's smallest
+        # unit (e.g. cents for USD, yen for JPY, fils for KWD — see the currency's decimal
+        # places)
         total_amount:,
         # Cardholder name
         card_holder_name: nil,
@@ -320,7 +323,8 @@ module Dodopayments
         status: nil,
         # Identifier of the subscription if payment is part of a subscription
         subscription_id: nil,
-        # Amount of tax collected in smallest currency unit (e.g. cents)
+        # Amount of tax collected in the currency's smallest unit (e.g. cents for USD, yen
+        # for JPY, fils for KWD)
         tax: nil,
         # Timestamp when the payment was last updated
         updated_at: nil

data/rbi/dodopayments/models/payment_create_response.rbi

@@ -33,7 +33,8 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :payment_id
 
-      # Total amount of the payment in smallest currency unit (e.g. cents)
+      # Total amount of the payment in the currency's smallest unit (cents for USD, yen
+      # for JPY, fils for KWD)
       sig { returns(Integer) }
       attr_accessor :total_amount
 
@@ -83,7 +84,8 @@ module Dodopayments
         metadata:,
         # Unique identifier for the payment
         payment_id:,
-        # Total amount of the payment in smallest currency unit (e.g. cents)
+        # Total amount of the payment in the currency's smallest unit (cents for USD, yen
+        # for JPY, fils for KWD)
         total_amount:,
         # DEPRECATED: Use discount_ids instead. Returns the first discount's ID if
         # present.