dodopayments 2.1.2 → 2.3.0

data/rbi/dodopayments/models/update_subscription_plan_req.rbi

@@ -39,6 +39,27 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :discount_code
 
+      # When to apply the plan change.
+      #
+      # - `immediately` (default): Apply the plan change right away
+      # - `next_billing_date`: Schedule the change for the next billing date
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol
+          )
+        )
+      end
+      attr_reader :effective_at
+
+      sig do
+        params(
+          effective_at:
+            Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol
+        ).void
+      end
+      attr_writer :effective_at
+
       # Metadata for the payment. If not passed, the metadata of the subscription will
       # be taken
       sig { returns(T.nilable(T::Hash[Symbol, String])) }
@@ -68,6 +89,8 @@ module Dodopayments
           quantity: Integer,
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
           discount_code: T.nilable(String),
+          effective_at:
+            Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol,
           metadata: T.nilable(T::Hash[Symbol, String]),
           on_payment_failure:
             T.nilable(
@@ -90,6 +113,11 @@ module Dodopayments
         # has an existing discount with `preserve_on_plan_change=true`, the existing
         # discount will be preserved (if applicable to the new product).
         discount_code: nil,
+        # When to apply the plan change.
+        #
+        # - `immediately` (default): Apply the plan change right away
+        # - `next_billing_date`: Schedule the change for the next billing date
+        effective_at: nil,
         # Metadata for the payment. If not passed, the metadata of the subscription will
         # be taken
         metadata: nil,
@@ -113,6 +141,8 @@ module Dodopayments
             quantity: Integer,
             addons: T.nilable(T::Array[Dodopayments::AttachAddon]),
             discount_code: T.nilable(String),
+            effective_at:
+              Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol,
             metadata: T.nilable(T::Hash[Symbol, String]),
             on_payment_failure:
               T.nilable(
@@ -152,6 +182,11 @@ module Dodopayments
             :difference_immediately,
             Dodopayments::UpdateSubscriptionPlanReq::ProrationBillingMode::TaggedSymbol
           )
+        DO_NOT_BILL =
+          T.let(
+            :do_not_bill,
+            Dodopayments::UpdateSubscriptionPlanReq::ProrationBillingMode::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -164,6 +199,41 @@ module Dodopayments
         end
       end
 
+      # When to apply the plan change.
+      #
+      # - `immediately` (default): Apply the plan change right away
+      # - `next_billing_date`: Schedule the change for the next billing date
+      module EffectiveAt
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IMMEDIATELY =
+          T.let(
+            :immediately,
+            Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::TaggedSymbol
+          )
+        NEXT_BILLING_DATE =
+          T.let(
+            :next_billing_date,
+            Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
       # Controls behavior when the plan change payment fails.
       #
       # - `prevent_change`: Keep subscription on current plan until payment succeeds

data/rbi/dodopayments/models/your_webhook_url_create_params.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class YourWebhookURLCreateParams < Dodopayments::Models::WebhookPayload
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::YourWebhookURLCreateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :webhook_id
+
+      sig { returns(String) }
+      attr_accessor :webhook_signature
+
+      sig { returns(String) }
+      attr_accessor :webhook_timestamp
+
+      sig do
+        params(
+          webhook_id: String,
+          webhook_signature: String,
+          webhook_timestamp: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        webhook_id:,
+        webhook_signature:,
+        webhook_timestamp:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            webhook_id: String,
+            webhook_signature: String,
+            webhook_timestamp: String,
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models.rbi

@@ -310,6 +310,29 @@ module Dodopayments
 
   ProductArchiveParams = Dodopayments::Models::ProductArchiveParams
 
+  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
 
   ProductItemReq = Dodopayments::Models::ProductItemReq
@@ -348,6 +371,9 @@ module Dodopayments
   SubscriptionActiveWebhookEvent =
     Dodopayments::Models::SubscriptionActiveWebhookEvent
 
+  SubscriptionCancelChangePlanParams =
+    Dodopayments::Models::SubscriptionCancelChangePlanParams
+
   SubscriptionCancelledWebhookEvent =
     Dodopayments::Models::SubscriptionCancelledWebhookEvent
 
@@ -442,4 +468,6 @@ module Dodopayments
   WebhookUnwrapParams = Dodopayments::Models::WebhookUnwrapParams
 
   WebhookUpdateParams = Dodopayments::Models::WebhookUpdateParams
+
+  YourWebhookURLCreateParams = Dodopayments::Models::YourWebhookURLCreateParams
 end

data/rbi/dodopayments/resources/checkout_sessions.rbi

@@ -11,6 +11,7 @@ module Dodopayments
           billing_address:
             T.nilable(Dodopayments::CheckoutSessionBillingAddress::OrHash),
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
+          cancel_url: T.nilable(String),
           confirm: T::Boolean,
           custom_fields: T.nilable(T::Array[Dodopayments::CustomField::OrHash]),
           customer:
@@ -49,6 +50,9 @@ module Dodopayments
         billing_address: nil,
         # This field is ingored if adaptive pricing is disabled
         billing_currency: nil,
+        # The URL to redirect the customer if they cancel or go back from the checkout. If
+        # not provided, the back button will not be displayed.
+        cancel_url: nil,
         # If confirm is true, all the details will be finalized. If required data is
         # missing, an API error is thrown.
         confirm: nil,
@@ -104,6 +108,7 @@ module Dodopayments
           billing_address:
             T.nilable(Dodopayments::CheckoutSessionBillingAddress::OrHash),
           billing_currency: T.nilable(Dodopayments::Currency::OrSymbol),
+          cancel_url: T.nilable(String),
           confirm: T::Boolean,
           custom_fields: T.nilable(T::Array[Dodopayments::CustomField::OrHash]),
           customer:
@@ -142,6 +147,9 @@ module Dodopayments
         billing_address: nil,
         # This field is ingored if adaptive pricing is disabled
         billing_currency: nil,
+        # The URL to redirect the customer if they cancel or go back from the checkout. If
+        # not provided, the back button will not be displayed.
+        cancel_url: nil,
         # If confirm is true, all the details will be finalized. If required data is
         # missing, an API error is thrown.
         confirm: nil,

data/rbi/dodopayments/resources/customers/customer_portal.rbi

@@ -7,6 +7,7 @@ module Dodopayments
         sig do
           params(
             customer_id: String,
+            return_url: String,
             send_email: T::Boolean,
             request_options: Dodopayments::RequestOptions::OrHash
           ).returns(Dodopayments::CustomerPortalSession)
@@ -14,6 +15,9 @@ module Dodopayments
         def create(
           # Customer Id
           customer_id,
+          # Optional return URL for this session. Overrides the business-level default. This
+          # URL will be shown as a "Return to {business}" back button in the portal.
+          return_url: nil,
           # If true, will send link to user.
           send_email: nil,
           request_options: {}

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/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::Groups::ItemCreateParams::Product::OrHash
+                ],
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(
+              T::Array[
+                Dodopayments::Models::ProductCollections::Groups::ItemCreateResponseItem
+              ]
+            )
+          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,90 @@
+# 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::GroupCreateParams::Product::OrHash
+              ],
+            group_name: T.nilable(String),
+            status: T.nilable(T::Boolean),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::Models::ProductCollections::GroupCreateResponse
+          )
+        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::ProductCollectionCreateParams::Group::OrHash
+            ],
+          name: String,
+          brand_id: T.nilable(String),
+          description: T.nilable(String),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(Dodopayments::Models::ProductCollectionCreateResponse)
+      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::Models::ProductCollectionRetrieveResponse)
+      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

@@ -186,6 +186,19 @@ module Dodopayments
       )
       end
 
+      sig do
+        params(
+          subscription_id: String,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).void
+      end
+      def cancel_change_plan(
+        # Subscription Id
+        subscription_id,
+        request_options: {}
+      )
+      end
+
       sig do
         params(
           subscription_id: String,
@@ -195,6 +208,8 @@ module Dodopayments
           quantity: Integer,
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
           discount_code: T.nilable(String),
+          effective_at:
+            Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol,
           metadata: T.nilable(T::Hash[Symbol, String]),
           on_payment_failure:
             T.nilable(
@@ -220,6 +235,11 @@ module Dodopayments
         # has an existing discount with `preserve_on_plan_change=true`, the existing
         # discount will be preserved (if applicable to the new product).
         discount_code: nil,
+        # When to apply the plan change.
+        #
+        # - `immediately` (default): Apply the plan change right away
+        # - `next_billing_date`: Schedule the change for the next billing date
+        effective_at: nil,
         # Metadata for the payment. If not passed, the metadata of the subscription will
         # be taken
         metadata: nil,
@@ -284,6 +304,8 @@ module Dodopayments
           quantity: Integer,
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
           discount_code: T.nilable(String),
+          effective_at:
+            Dodopayments::UpdateSubscriptionPlanReq::EffectiveAt::OrSymbol,
           metadata: T.nilable(T::Hash[Symbol, String]),
           on_payment_failure:
             T.nilable(
@@ -309,6 +331,11 @@ module Dodopayments
         # has an existing discount with `preserve_on_plan_change=true`, the existing
         # discount will be preserved (if applicable to the new product).
         discount_code: nil,
+        # When to apply the plan change.
+        #
+        # - `immediately` (default): Apply the plan change right away
+        # - `next_billing_date`: Schedule the change for the next billing date
+        effective_at: nil,
         # Metadata for the payment. If not passed, the metadata of the subscription will
         # be taken
         metadata: nil,

data/rbi/dodopayments/resources/webhooks.rbi

@@ -171,7 +171,11 @@ module Dodopayments
       end
 
       sig do
-        params(payload: String).returns(
+        params(
+          payload: String,
+          headers: T::Hash[String, String],
+          key: T.nilable(String)
+        ).returns(
           T.any(
             Dodopayments::CreditAddedWebhookEvent,
             Dodopayments::CreditBalanceLowWebhookEvent,
@@ -208,7 +212,11 @@ module Dodopayments
       end
       def unwrap(
         # The raw webhook payload as a string
-        payload
+        payload,
+        # The raw HTTP headers that came with the payload
+        headers:,
+        # The webhook signing key
+        key: @client.webhook_key
       )
       end