dodopayments 2.14.0 → 2.16.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/entitlements/grants.rb

@@ -6,14 +6,12 @@ module Dodopayments
       class Grants
         # GET /entitlements/{id}/grants (public API)
         #
-        # @overload list(id, customer_id: nil, integration_type: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
+        # @overload list(id, customer_id: nil, page_number: nil, page_size: nil, status: nil, request_options: {})
         #
         # @param id [String] Entitlement ID
         #
         # @param customer_id [String] Filter by customer ID
         #
-        # @param integration_type [Symbol, Dodopayments::Models::Entitlements::GrantListParams::IntegrationType] Filter by integration type
-        #
         # @param page_number [Integer] Page number (default 0)
         #
         # @param page_size [Integer] Page size (default 10, max 100)

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.14.0"
+  VERSION = "2.16.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/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/customer_retrieve_payment_methods_response.rbi

@@ -85,7 +85,7 @@ module Dodopayments
         sig { returns(T.nilable(Time)) }
         attr_accessor :last_used_at
 
-        # All supported payment method types (from Hyperswitch).
+        # All supported payment method types.
         #
         # Used for disabled-payment-methods filtering and validation.
         sig do
@@ -116,7 +116,7 @@ module Dodopayments
           payment_method_id:,
           card: nil,
           last_used_at: nil,
-          # All supported payment method types (from Hyperswitch).
+          # All supported payment method types.
           #
           # Used for disabled-payment-methods filtering and validation.
           payment_method_type: nil,

data/rbi/dodopayments/models/dispute_list_response.rbi

@@ -45,7 +45,7 @@ module Dodopayments
       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
+      # routes (the merchant's own payment connector); `dodo` for everything Dodo
       # processed itself.
       sig do
         returns(
@@ -92,7 +92,7 @@ module Dodopayments
         # 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
+        # routes (the merchant's own payment connector); `dodo` for everything Dodo
         # processed itself.
         payment_provider:,
         # Whether the dispute was resolved by Rapid Dispute Resolution
@@ -121,7 +121,7 @@ module Dodopayments
       end
 
       # Which processor handled the underlying payment. `stripe` / `adyen` for BYOP
-      # routes (the merchant's own Hyperswitch connector); `dodo` for everything Dodo
+      # routes (the merchant's own payment connector); `dodo` for everything Dodo
       # processed itself.
       module PaymentProvider
         extend Dodopayments::Internal::Type::Enum

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