dodopayments 2.9.1 → 2.11.0

data/rbi/dodopayments/models.rbi

@@ -183,6 +183,8 @@ module Dodopayments
 
   DiscountDeleteParams = Dodopayments::Models::DiscountDeleteParams
 
+  DiscountDetail = Dodopayments::Models::DiscountDetail
+
   DiscountListParams = Dodopayments::Models::DiscountListParams
 
   DiscountRetrieveByCodeParams =
@@ -260,8 +262,12 @@ module Dodopayments
 
   FilterOperator = Dodopayments::Models::FilterOperator
 
+  FilterType = Dodopayments::Models::FilterType
+
   GetDispute = Dodopayments::Models::GetDispute
 
+  GitHubPermission = Dodopayments::Models::GitHubPermission
+
   IntegrationConfig = Dodopayments::Models::IntegrationConfig
 
   IntegrationConfigResponse = Dodopayments::Models::IntegrationConfigResponse
@@ -370,6 +376,31 @@ module Dodopayments
 
   ProductArchiveParams = Dodopayments::Models::ProductArchiveParams
 
+  ProductCollection = Dodopayments::Models::ProductCollection
+
+  ProductCollectionCreateParams =
+    Dodopayments::Models::ProductCollectionCreateParams
+
+  ProductCollectionDeleteParams =
+    Dodopayments::Models::ProductCollectionDeleteParams
+
+  ProductCollectionListParams =
+    Dodopayments::Models::ProductCollectionListParams
+
+  ProductCollectionRetrieveParams =
+    Dodopayments::Models::ProductCollectionRetrieveParams
+
+  ProductCollections = Dodopayments::Models::ProductCollections
+
+  ProductCollectionUnarchiveParams =
+    Dodopayments::Models::ProductCollectionUnarchiveParams
+
+  ProductCollectionUpdateImagesParams =
+    Dodopayments::Models::ProductCollectionUpdateImagesParams
+
+  ProductCollectionUpdateParams =
+    Dodopayments::Models::ProductCollectionUpdateParams
+
   ProductCreateParams = Dodopayments::Models::ProductCreateParams
 
   ProductEntitlementSummary = Dodopayments::Models::ProductEntitlementSummary

data/rbi/dodopayments/resources/checkout_sessions.rbi

@@ -21,8 +21,10 @@ module Dodopayments
                 Dodopayments::NewCustomer::OrHash
               )
             ),
+          customer_business_name: T.nilable(String),
           customization: Dodopayments::CheckoutSessionCustomization::OrHash,
           discount_code: T.nilable(String),
+          discount_codes: T.nilable(T::Array[String]),
           feature_flags: Dodopayments::CheckoutSessionFlags::OrHash,
           force_3ds: T.nilable(T::Boolean),
           mandate_min_amount_inr_paise: T.nilable(Integer),
@@ -61,9 +63,18 @@ module Dodopayments
         custom_fields: nil,
         # Customer details for the session
         customer: nil,
+        # Optional business / legal name associated with the tax id. When provided
+        # together with a valid tax id for a B2B purchase, this name is rendered on the
+        # invoice instead of the customer's personal name.
+        customer_business_name: nil,
         # Customization for the checkout session page
         customization: nil,
+        # DEPRECATED: Use discount_codes instead. Cannot be used together with
+        # discount_codes.
         discount_code: nil,
+        # Stacked discount codes to apply, in order. Max 20. Cannot be used together with
+        # discount_code.
+        discount_codes: nil,
         feature_flags: nil,
         # Override merchant default 3DS behaviour for this session
         force_3ds: nil,
@@ -126,8 +137,10 @@ module Dodopayments
                 Dodopayments::NewCustomer::OrHash
               )
             ),
+          customer_business_name: T.nilable(String),
           customization: Dodopayments::CheckoutSessionCustomization::OrHash,
           discount_code: T.nilable(String),
+          discount_codes: T.nilable(T::Array[String]),
           feature_flags: Dodopayments::CheckoutSessionFlags::OrHash,
           force_3ds: T.nilable(T::Boolean),
           mandate_min_amount_inr_paise: T.nilable(Integer),
@@ -166,9 +179,18 @@ module Dodopayments
         custom_fields: nil,
         # Customer details for the session
         customer: nil,
+        # Optional business / legal name associated with the tax id. When provided
+        # together with a valid tax id for a B2B purchase, this name is rendered on the
+        # invoice instead of the customer's personal name.
+        customer_business_name: nil,
         # Customization for the checkout session page
         customization: nil,
+        # DEPRECATED: Use discount_codes instead. Cannot be used together with
+        # discount_codes.
         discount_code: nil,
+        # Stacked discount codes to apply, in order. Max 20. Cannot be used together with
+        # discount_code.
+        discount_codes: nil,
         feature_flags: nil,
         # Override merchant default 3DS behaviour for this session
         force_3ds: nil,

data/rbi/dodopayments/resources/invoices/payments.rbi

@@ -13,6 +13,15 @@ module Dodopayments
         def retrieve(payment_id, request_options: {})
         end
 
+        sig do
+          params(
+            payout_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(StringIO)
+        end
+        def retrieve_payout(payout_id, request_options: {})
+        end
+
         sig do
           params(
             refund_id: String,

data/rbi/dodopayments/resources/payments.rbi

@@ -16,7 +16,9 @@ module Dodopayments
           allowed_payment_method_types:
             T.nilable(T::Array[Dodopayments::PaymentMethodTypes::OrSymbol]),
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
+          customer_business_name: T.nilable(String),
           discount_code: T.nilable(String),
+          discount_codes: T.nilable(T::Array[String]),
           force_3ds: T.nilable(T::Boolean),
           metadata: T::Hash[Symbol, String],
           payment_link: T.nilable(T::Boolean),
@@ -50,8 +52,16 @@ module Dodopayments
         # Fix the currency in which the end customer is billed. If Dodo Payments cannot
         # support that currency for this transaction, it will not proceed
         billing_currency: nil,
-        # Discount Code to apply to the transaction
+        # Optional business / legal name associated with the tax id. When provided
+        # together with a valid tax id for a B2B purchase, this name is rendered on the
+        # invoice instead of the customer's personal name.
+        customer_business_name: nil,
+        # DEPRECATED: Use discount_codes instead. Cannot be used together with
+        # discount_codes.
         discount_code: nil,
+        # Stacked discount codes to apply, in order of application. Max 20. Cannot be used
+        # together with discount_code.
+        discount_codes: nil,
         # Override merchant default 3DS behaviour for this payment
         force_3ds: nil,
         # Additional metadata associated with the payment. Defaults to empty if not

data/rbi/dodopayments/resources/product_collections/groups/items.rbi

@@ -0,0 +1,83 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class ProductCollections
+      class Groups
+        class Items
+          sig do
+            params(
+              group_id: String,
+              id: String,
+              products:
+                T::Array[
+                  Dodopayments::ProductCollections::GroupProduct::OrHash
+                ],
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(
+              T::Array[
+                Dodopayments::ProductCollections::Groups::ProductCollectionProduct
+              ]
+            )
+          end
+          def create(
+            # Path param: Product Collection Group Id
+            group_id,
+            # Path param: Product Collection Id
+            id:,
+            # Body param: Products to add to the group
+            products:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            params(
+              item_id: String,
+              id: String,
+              group_id: String,
+              status: T::Boolean,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).void
+          end
+          def update(
+            # Path param: Collection item Id (product membership in group)
+            item_id,
+            # Path param: Product Collection Id
+            id:,
+            # Path param: Product Collection Group Id
+            group_id:,
+            # Body param: Status of the product in the group
+            status:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            params(
+              item_id: String,
+              id: String,
+              group_id: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).void
+          end
+          def delete(
+            # Collection item Id (product membership in group)
+            item_id,
+            # Product Collection Id
+            id:,
+            # Product Collection Group Id
+            group_id:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/product_collections/groups.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class ProductCollections
+      class Groups
+        sig do
+          returns(Dodopayments::Resources::ProductCollections::Groups::Items)
+        end
+        attr_reader :items
+
+        sig do
+          params(
+            id: String,
+            products:
+              T::Array[Dodopayments::ProductCollections::GroupProduct::OrHash],
+            group_name: T.nilable(String),
+            status: T.nilable(T::Boolean),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::ProductCollections::ProductCollectionGroupResponse
+          )
+        end
+        def create(
+          # Product Collection Id
+          id,
+          # Products in this group
+          products:,
+          # Optional group name. Multiple groups can have null names, but named groups must
+          # be unique per collection
+          group_name: nil,
+          # Status of the group (defaults to true if not provided)
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            group_id: String,
+            id: String,
+            group_name: T.nilable(String),
+            product_order: T.nilable(T::Array[String]),
+            status: T.nilable(T::Boolean),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def update(
+          # Path param: Product Collection Group Id
+          group_id,
+          # Path param: Product Collection Id
+          id:,
+          # Body param: Optional group name update: Some(Some(name)) = set name, Some(None)
+          # = clear name, None = no change
+          group_name: nil,
+          # Body param: Optional new order for products in this group (array of
+          # product_collection_group_pdts UUIDs)
+          product_order: nil,
+          # Body param: Optional status update
+          status: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            group_id: String,
+            id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Product Collection Group Id
+          group_id,
+          # Product Collection Id
+          id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/product_collections.rbi

@@ -0,0 +1,149 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class ProductCollections
+      sig { returns(Dodopayments::Resources::ProductCollections::Groups) }
+      attr_reader :groups
+
+      sig do
+        params(
+          groups:
+            T::Array[
+              Dodopayments::ProductCollections::ProductCollectionGroupDetails::OrHash
+            ],
+          name: String,
+          brand_id: T.nilable(String),
+          description: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::ProductCollection)
+      end
+      def create(
+        # Groups of products in this collection
+        groups:,
+        # Name of the product collection
+        name:,
+        # Brand id for the collection, if not provided will default to primary brand
+        brand_id: nil,
+        # Optional description of the product collection
+        description: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::ProductCollection)
+      end
+      def retrieve(
+        # Product Collection Id
+        id,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          brand_id: T.nilable(String),
+          description: T.nilable(String),
+          group_order: T.nilable(T::Array[String]),
+          image_id: T.nilable(String),
+          name: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).void
+      end
+      def update(
+        # Product Collection Id
+        id,
+        # Optional brand_id update
+        brand_id: nil,
+        # Optional description update - pass null to remove, omit to keep unchanged
+        description: nil,
+        # Optional new order for groups (array of group UUIDs in desired order)
+        group_order: nil,
+        # Optional image update - pass null to remove, omit to keep unchanged
+        image_id: nil,
+        # Optional new name for the collection
+        name: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          archived: T::Boolean,
+          brand_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(
+          Dodopayments::Internal::DefaultPageNumberPagination[
+            Dodopayments::Models::ProductCollectionListResponse
+          ]
+        )
+      end
+      def list(
+        # List archived collections
+        archived: nil,
+        # Filter by Brand id
+        brand_id: nil,
+        # Page number default is 0
+        page_number: nil,
+        # Page size default is 10 max is 100
+        page_size: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).void
+      end
+      def delete(
+        # Product Collection Id
+        id,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::ProductCollectionUnarchiveResponse)
+      end
+      def unarchive(
+        # Product Collection Id
+        id,
+        request_options: {}
+      )
+      end
+
+      sig do
+        params(
+          id: String,
+          force_update: T.nilable(T::Boolean),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::ProductCollectionUpdateImagesResponse)
+      end
+      def update_images(
+        # Product Collection Id
+        id,
+        # If true, generates a new image ID to force cache invalidation
+        force_update: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/subscriptions.rbi

@@ -17,7 +17,9 @@ module Dodopayments
           allowed_payment_method_types:
             T.nilable(T::Array[Dodopayments::PaymentMethodTypes::OrSymbol]),
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
+          customer_business_name: T.nilable(String),
           discount_code: T.nilable(String),
+          discount_codes: T.nilable(T::Array[String]),
           force_3ds: T.nilable(T::Boolean),
           mandate_min_amount_inr_paise: T.nilable(Integer),
           metadata: T::Hash[Symbol, String],
@@ -57,8 +59,16 @@ module Dodopayments
         # Fix the currency in which the end customer is billed. If Dodo Payments cannot
         # support that currency for this transaction, it will not proceed
         billing_currency: nil,
-        # Discount Code to apply to the subscription
+        # Optional business / legal name associated with the tax id. When provided
+        # together with a valid tax id for a B2B purchase, this name is rendered on the
+        # invoice instead of the customer's personal name.
+        customer_business_name: nil,
+        # DEPRECATED: Use discount_codes instead. Cannot be used together with
+        # discount_codes.
         discount_code: nil,
+        # Stacked discount codes to apply, in order of application. Max 20. Cannot be used
+        # together with discount_code.
+        discount_codes: nil,
         # Override merchant default 3DS behaviour for this subscription
         force_3ds: nil,
         # Override the merchant-level mandate floor (in INR paise) for INR e-mandates on
@@ -134,6 +144,7 @@ module Dodopayments
                 Dodopayments::SubscriptionUpdateParams::CreditEntitlementCart::OrHash
               ]
             ),
+          customer_business_name: T.nilable(String),
           customer_name: T.nilable(String),
           disable_on_demand:
             T.nilable(
@@ -161,6 +172,11 @@ module Dodopayments
         cancellation_feedback: nil,
         # Update credit entitlement cart settings
         credit_entitlement_cart: nil,
+        # Optional business / legal name associated with the tax id. When provided
+        # together with a valid tax id for a B2B subscription, this name is rendered on
+        # the invoice instead of the customer's personal name. Send `null` to explicitly
+        # clear the business name.
+        customer_business_name: nil,
         customer_name: nil,
         disable_on_demand: nil,
         metadata: nil,
@@ -232,6 +248,7 @@ module Dodopayments
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
           discount_code: T.nilable(String),
+          discount_codes: T.nilable(T::Array[String]),
           effective_at:
             Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol,
           metadata: T.nilable(T::Hash[Symbol, String]),
@@ -257,11 +274,14 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
-        # Optional discount code to apply to the new plan. If provided, validates and
-        # applies the discount to the plan change. If not provided and the subscription
-        # has an existing discount with `preserve_on_plan_change=true`, the existing
-        # discount will be preserved (if applicable to the new product).
+        # DEPRECATED: Use discount_codes instead. Cannot be used together with
+        # discount_codes.
         discount_code: nil,
+        # Stacked discount codes to apply to the new plan. Max 20. Cannot be used together
+        # with discount_code. If provided, replaces any existing discount codes. Empty
+        # array removes all discounts. If not provided (None), existing discounts with
+        # preserve_on_plan_change=true are preserved.
+        discount_codes: nil,
         # When to apply the plan change.
         #
         # - `immediately` (default): Apply the plan change right away
@@ -332,6 +352,7 @@ module Dodopayments
           adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
           discount_code: T.nilable(String),
+          discount_codes: T.nilable(T::Array[String]),
           effective_at:
             Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol,
           metadata: T.nilable(T::Hash[Symbol, String]),
@@ -357,11 +378,14 @@ module Dodopayments
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
-        # Optional discount code to apply to the new plan. If provided, validates and
-        # applies the discount to the plan change. If not provided and the subscription
-        # has an existing discount with `preserve_on_plan_change=true`, the existing
-        # discount will be preserved (if applicable to the new product).
+        # DEPRECATED: Use discount_codes instead. Cannot be used together with
+        # discount_codes.
         discount_code: nil,
+        # Stacked discount codes to apply to the new plan. Max 20. Cannot be used together
+        # with discount_code. If provided, replaces any existing discount codes. Empty
+        # array removes all discounts. If not provided (None), existing discounts with
+        # preserve_on_plan_change=true are preserved.
+        discount_codes: nil,
         # When to apply the plan change.
         #
         # - `immediately` (default): Apply the plan change right away
@@ -472,10 +496,10 @@ module Dodopayments
       sig do
         params(
           subscription_id: String,
-          body:
+          payment_method:
             T.any(
-              Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::New::OrHash,
-              Dodopayments::SubscriptionUpdatePaymentMethodParams::Body::Existing::OrHash
+              Dodopayments::SubscriptionUpdatePaymentMethodParams::PaymentMethod::New::OrHash,
+              Dodopayments::SubscriptionUpdatePaymentMethodParams::PaymentMethod::Existing::OrHash
             ),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(Dodopayments::Models::SubscriptionUpdatePaymentMethodResponse)
@@ -483,7 +507,7 @@ module Dodopayments
       def update_payment_method(
         # Subscription Id
         subscription_id,
-        body:,
+        payment_method:,
         request_options: {}
       )
       end

data/sig/dodopayments/client.rbs

@@ -63,6 +63,8 @@ module Dodopayments
 
     attr_reader entitlements: Dodopayments::Resources::Entitlements
 
+    attr_reader product_collections: Dodopayments::Resources::ProductCollections
+
     private def auth_headers: -> ::Hash[String, String]
 
     def initialize: (

data/sig/dodopayments/models/abandoned_checkout_detected_webhook_event.rbs

@@ -5,7 +5,7 @@ module Dodopayments
         business_id: String,
         data: Dodopayments::AbandonedCheckoutDetectedWebhookEvent::Data,
         timestamp: Time,
-        type: Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent::type_
+        type: :"abandoned_checkout.detected"
       }
 
     class AbandonedCheckoutDetectedWebhookEvent < Dodopayments::Internal::Type::BaseModel
@@ -15,20 +15,20 @@ module Dodopayments
 
       attr_accessor timestamp: Time
 
-      attr_accessor type: Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent::type_
+      attr_accessor type: :"abandoned_checkout.detected"
 
       def initialize: (
         business_id: String,
         data: Dodopayments::AbandonedCheckoutDetectedWebhookEvent::Data,
         timestamp: Time,
-        type: Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent::type_
+        ?type: :"abandoned_checkout.detected"
       ) -> void
 
       def to_hash: -> {
         business_id: String,
         data: Dodopayments::AbandonedCheckoutDetectedWebhookEvent::Data,
         timestamp: Time,
-        type: Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent::type_
+        type: :"abandoned_checkout.detected"
       }
 
       type data =
@@ -98,16 +98,6 @@ module Dodopayments
           def self?.values: -> ::Array[Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent::Data::status]
         end
       end
-
-      type type_ = :"abandoned_checkout.detected"
-
-      module Type
-        extend Dodopayments::Internal::Type::Enum
-
-        ABANDONED_CHECKOUT_DETECTED: :"abandoned_checkout.detected"
-
-        def self?.values: -> ::Array[Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent::type_]
-      end
     end
   end
 end