dodopayments 2.13.0 → 2.15.0

data/lib/dodopayments/models/webhook_payload.rb

@@ -141,6 +141,12 @@ module Dodopayments
           #   @return [String]
           required :available_balance, String
 
+          # @!attribute brand_id
+          #   Brand id this credit entitlement belongs to
+          #
+          #   @return [String]
+          required :brand_id, String
+
           # @!attribute credit_entitlement_id
           #
           #   @return [String]
@@ -181,15 +187,25 @@ module Dodopayments
           #   @return [Integer]
           required :threshold_percent, Integer
 
-          # @!method initialize(available_balance:, credit_entitlement_id:, credit_entitlement_name:, customer_id:, subscription_credits_amount:, subscription_id:, threshold_amount:, threshold_percent:, payload_type: :CreditBalanceLow)
+          # @!method initialize(available_balance:, brand_id:, credit_entitlement_id:, credit_entitlement_name:, customer_id:, subscription_credits_amount:, subscription_id:, threshold_amount:, threshold_percent:, payload_type: :CreditBalanceLow)
           #   @param available_balance [String]
+          #
+          #   @param brand_id [String] Brand id this credit entitlement belongs to
+          #
           #   @param credit_entitlement_id [String]
+          #
           #   @param credit_entitlement_name [String]
+          #
           #   @param customer_id [String]
+          #
           #   @param subscription_credits_amount [String]
+          #
           #   @param subscription_id [String]
+          #
           #   @param threshold_amount [String]
+          #
           #   @param threshold_percent [Integer]
+          #
           #   @param payload_type [Symbol, :CreditBalanceLow]
         end
 
@@ -205,6 +221,12 @@ module Dodopayments
           required :abandonment_reason,
                    enum: -> { Dodopayments::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason }
 
+          # @!attribute brand_id
+          #   Brand id this abandoned checkout belongs to
+          #
+          #   @return [String]
+          required :brand_id, String
+
           # @!attribute customer_id
           #
           #   @return [String]
@@ -230,13 +252,21 @@ module Dodopayments
           #   @return [String, nil]
           optional :recovered_payment_id, String, nil?: true
 
-          # @!method initialize(abandoned_at:, abandonment_reason:, customer_id:, payment_id:, status:, recovered_payment_id: nil, payload_type: :AbandonedCheckout)
+          # @!method initialize(abandoned_at:, abandonment_reason:, brand_id:, customer_id:, payment_id:, status:, recovered_payment_id: nil, payload_type: :AbandonedCheckout)
           #   @param abandoned_at [Time]
+          #
           #   @param abandonment_reason [Symbol, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::AbandonmentReason]
+          #
+          #   @param brand_id [String] Brand id this abandoned checkout belongs to
+          #
           #   @param customer_id [String]
+          #
           #   @param payment_id [String]
+          #
           #   @param status [Symbol, Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::Status]
+          #
           #   @param recovered_payment_id [String, nil]
+          #
           #   @param payload_type [Symbol, :AbandonedCheckout]
 
           # @see Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout#abandonment_reason
@@ -266,6 +296,12 @@ module Dodopayments
         end
 
         class DunningAttempt < Dodopayments::Internal::Type::BaseModel
+          # @!attribute brand_id
+          #   Brand id this dunning attempt belongs to
+          #
+          #   @return [String]
+          required :brand_id, String
+
           # @!attribute created_at
           #
           #   @return [Time]
@@ -301,13 +337,21 @@ module Dodopayments
           #   @return [String, nil]
           optional :payment_id, String, nil?: true
 
-          # @!method initialize(created_at:, customer_id:, status:, subscription_id:, trigger_state:, payment_id: nil, payload_type: :DunningAttempt)
+          # @!method initialize(brand_id:, created_at:, customer_id:, status:, subscription_id:, trigger_state:, payment_id: nil, payload_type: :DunningAttempt)
+          #   @param brand_id [String] Brand id this dunning attempt belongs to
+          #
           #   @param created_at [Time]
+          #
           #   @param customer_id [String]
+          #
           #   @param status [Symbol, Dodopayments::Models::WebhookPayload::Data::DunningAttempt::Status]
+          #
           #   @param subscription_id [String]
+          #
           #   @param trigger_state [Symbol, Dodopayments::Models::WebhookPayload::Data::DunningAttempt::TriggerState]
+          #
           #   @param payment_id [String, nil]
+          #
           #   @param payload_type [Symbol, :DunningAttempt]
 
           # @see Dodopayments::Models::WebhookPayload::Data::DunningAttempt#status

data/lib/dodopayments/resources/products.rb

@@ -12,7 +12,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::ProductCreateParams} for more details.
       #
-      # @overload create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, request_options: {})
+      # @overload create(name:, price:, tax_category:, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, pricing_mode: nil, request_options: {})
       #
       # @param name [String] Name of the product
       #
@@ -24,13 +24,13 @@ module Dodopayments
       #
       # @param brand_id [String, nil] Brand id for the product, if not provided will default to primary brand
       #
-      # @param credit_entitlements [Array<Dodopayments::Models::AttachCreditEntitlement>, nil] Optional credit entitlements to attach (max 3)
+      # @param credit_entitlements [Array<Dodopayments::Models::AttachCreditEntitlement>, nil] Optional credit entitlements to attach (max 5)
       #
       # @param description [String, nil] Optional description of the product
       #
       # @param digital_product_delivery [Dodopayments::Models::ProductCreateParams::DigitalProductDelivery, nil] Choose how you would like you digital product delivered
       #
-      # @param entitlements [Array<Dodopayments::Models::AttachProductEntitlement>, nil] Optional entitlements to attach to this product (max 20)
+      # @param entitlements [Array<Dodopayments::Models::AttachProductEntitlement>, nil] Optional entitlements to attach to this product (max 50)
       #
       # @param license_key_activation_message [String, nil] Optional message displayed during license key activation
       #
@@ -42,6 +42,8 @@ module Dodopayments
       #
       # @param metadata [Hash{Symbol=>String}] Additional metadata for the product
       #
+      # @param pricing_mode [Symbol, Dodopayments::Models::ProductCreateParams::PricingMode, nil] Pricing mode for localized pricing. When set, rules from
+      #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Dodopayments::Models::Product]
@@ -79,7 +81,7 @@ module Dodopayments
       # Some parameter documentations has been truncated, see
       # {Dodopayments::Models::ProductUpdateParams} for more details.
       #
-      # @overload update(id, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, tax_category: nil, request_options: {})
+      # @overload update(id, addons: nil, brand_id: nil, credit_entitlements: nil, description: nil, digital_product_delivery: nil, entitlements: nil, image_id: nil, license_key_activation_message: nil, license_key_activations_limit: nil, license_key_duration: nil, license_key_enabled: nil, metadata: nil, name: nil, price: nil, pricing_mode: nil, tax_category: nil, request_options: {})
       #
       # @param id [String]
       #
@@ -111,6 +113,8 @@ module Dodopayments
       #
       # @param price [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, Dodopayments::Models::Price::UsageBasedPrice, nil] Price details of the product.
       #
+      # @param pricing_mode [Symbol, Dodopayments::Models::ProductUpdateParams::PricingMode, nil] Update the pricing mode. Omit to leave unchanged; set to null to clear
+      #
       # @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Tax category of the product.
       #
       # @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/dodopayments/version.rb

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

data/rbi/dodopayments/models/abandoned_checkout_detected_webhook_event.rbi

@@ -90,6 +90,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
 
@@ -113,6 +117,7 @@ module Dodopayments
             abandoned_at: Time,
             abandonment_reason:
               Dodopayments::AbandonedCheckoutDetectedWebhookEvent::Data::AbandonmentReason::OrSymbol,
+            brand_id: String,
             customer_id: String,
             payment_id: String,
             status:
@@ -123,6 +128,8 @@ module Dodopayments
         def self.new(
           abandoned_at:,
           abandonment_reason:,
+          # Brand id this abandoned checkout belongs to
+          brand_id:,
           customer_id:,
           payment_id:,
           status:,
@@ -136,6 +143,7 @@ module Dodopayments
               abandoned_at: Time,
               abandonment_reason:
                 Dodopayments::AbandonedCheckoutDetectedWebhookEvent::Data::AbandonmentReason::TaggedSymbol,
+              brand_id: String,
               customer_id: String,
               payment_id: String,
               status:

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/balance_ledger_entry.rbi

@@ -212,6 +212,11 @@ module Dodopayments
             :payment_retry_fee,
             Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
           )
+        BYOP_FEE =
+          T.let(
+            :byop_fee,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/balance_retrieve_ledger_params.rbi

@@ -1010,6 +1010,11 @@ module Dodopayments
             :payment_retry_fee,
             Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
           )
+        BYOP_FEE =
+          T.let(
+            :byop_fee,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

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/dispute_list_response.rbi

@@ -44,6 +44,16 @@ 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 do
+        returns(
+          Dodopayments::Models::DisputeListResponse::PaymentProvider::TaggedSymbol
+        )
+      end
+      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
@@ -58,6 +68,8 @@ module Dodopayments
           dispute_stage: Dodopayments::DisputeStage::OrSymbol,
           dispute_status: Dodopayments::DisputeStatus::OrSymbol,
           payment_id: String,
+          payment_provider:
+            Dodopayments::Models::DisputeListResponse::PaymentProvider::OrSymbol,
           is_resolved_by_rdr: T.nilable(T::Boolean)
         ).returns(T.attached_class)
       end
@@ -79,6 +91,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
       )
@@ -95,12 +111,56 @@ module Dodopayments
             dispute_stage: Dodopayments::DisputeStage::TaggedSymbol,
             dispute_status: Dodopayments::DisputeStatus::TaggedSymbol,
             payment_id: String,
+            payment_provider:
+              Dodopayments::Models::DisputeListResponse::PaymentProvider::TaggedSymbol,
             is_resolved_by_rdr: T.nilable(T::Boolean)
           }
         )
       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::Models::DisputeListResponse::PaymentProvider
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        STRIPE =
+          T.let(
+            :stripe,
+            Dodopayments::Models::DisputeListResponse::PaymentProvider::TaggedSymbol
+          )
+        ADYEN =
+          T.let(
+            :adyen,
+            Dodopayments::Models::DisputeListResponse::PaymentProvider::TaggedSymbol
+          )
+        DODO =
+          T.let(
+            :dodo,
+            Dodopayments::Models::DisputeListResponse::PaymentProvider::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::Models::DisputeListResponse::PaymentProvider::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

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
@@ -34,6 +38,10 @@ module Dodopayments
         sig { returns(String) }
         attr_accessor :entitlement_id
 
+        # The integration type of the grant's entitlement (e.g. `license_key`).
+        sig { returns(Dodopayments::EntitlementIntegrationType::TaggedSymbol) }
+        attr_accessor :integration_type
+
         # Arbitrary key-value metadata recorded on the grant.
         sig { returns(T::Hash[Symbol, String]) }
         attr_accessor :metadata
@@ -119,10 +127,13 @@ module Dodopayments
         sig do
           params(
             id: String,
+            brand_id: String,
             business_id: String,
             created_at: Time,
             customer_id: String,
             entitlement_id: String,
+            integration_type:
+              Dodopayments::EntitlementIntegrationType::OrSymbol,
             metadata: T::Hash[Symbol, String],
             status:
               Dodopayments::Entitlements::EntitlementGrant::Status::OrSymbol,
@@ -145,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.
@@ -153,6 +166,8 @@ module Dodopayments
           customer_id:,
           # Identifier of the entitlement this grant was issued from.
           entitlement_id:,
+          # The integration type of the grant's entitlement (e.g. `license_key`).
+          integration_type:,
           # Arbitrary key-value metadata recorded on the grant.
           metadata:,
           # Lifecycle status of the grant.
@@ -192,10 +207,13 @@ module Dodopayments
           override.returns(
             {
               id: String,
+              brand_id: String,
               business_id: String,
               created_at: Time,
               customer_id: String,
               entitlement_id: String,
+              integration_type:
+                Dodopayments::EntitlementIntegrationType::TaggedSymbol,
               metadata: T::Hash[Symbol, String],
               status:
                 Dodopayments::Entitlements::EntitlementGrant::Status::TaggedSymbol,