dodopayments 2.9.1 → 2.11.0

data/rbi/dodopayments/models/product_collection.rbi

@@ -0,0 +1,108 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollection < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductCollection,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Unique identifier for the product collection
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Brand ID for the collection
+      sig { returns(String) }
+      attr_accessor :brand_id
+
+      # Timestamp when the collection was created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Groups in this collection
+      sig do
+        returns(
+          T::Array[
+            Dodopayments::ProductCollections::ProductCollectionGroupResponse
+          ]
+        )
+      end
+      attr_accessor :groups
+
+      # Name of the collection
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Timestamp when the collection was last updated
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Description of the collection
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # URL of the collection image
+      sig { returns(T.nilable(String)) }
+      attr_accessor :image
+
+      sig do
+        params(
+          id: String,
+          brand_id: String,
+          created_at: Time,
+          groups:
+            T::Array[
+              Dodopayments::ProductCollections::ProductCollectionGroupResponse::OrHash
+            ],
+          name: String,
+          updated_at: Time,
+          description: T.nilable(String),
+          image: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Unique identifier for the product collection
+        id:,
+        # Brand ID for the collection
+        brand_id:,
+        # Timestamp when the collection was created
+        created_at:,
+        # Groups in this collection
+        groups:,
+        # Name of the collection
+        name:,
+        # Timestamp when the collection was last updated
+        updated_at:,
+        # Description of the collection
+        description: nil,
+        # URL of the collection image
+        image: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            brand_id: String,
+            created_at: Time,
+            groups:
+              T::Array[
+                Dodopayments::ProductCollections::ProductCollectionGroupResponse
+              ],
+            name: String,
+            updated_at: Time,
+            description: T.nilable(String),
+            image: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collection_create_params.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollectionCreateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductCollectionCreateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Groups of products in this collection
+      sig do
+        returns(
+          T::Array[
+            Dodopayments::ProductCollections::ProductCollectionGroupDetails
+          ]
+        )
+      end
+      attr_accessor :groups
+
+      # Name of the product collection
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Brand id for the collection, if not provided will default to primary brand
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
+      # Optional description of the product collection
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      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(T.attached_class)
+      end
+      def self.new(
+        # 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
+        override.returns(
+          {
+            groups:
+              T::Array[
+                Dodopayments::ProductCollections::ProductCollectionGroupDetails
+              ],
+            name: String,
+            brand_id: T.nilable(String),
+            description: T.nilable(String),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collection_delete_params.rbi

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

data/rbi/dodopayments/models/product_collection_list_params.rbi

@@ -0,0 +1,82 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollectionListParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductCollectionListParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # List archived collections
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :archived
+
+      sig { params(archived: T::Boolean).void }
+      attr_writer :archived
+
+      # Filter by Brand id
+      sig { returns(T.nilable(String)) }
+      attr_reader :brand_id
+
+      sig { params(brand_id: String).void }
+      attr_writer :brand_id
+
+      # Page number default is 0
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_number
+
+      sig { params(page_number: Integer).void }
+      attr_writer :page_number
+
+      # Page size default is 10 max is 100
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
+      sig do
+        params(
+          archived: T::Boolean,
+          brand_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # 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
+        override.returns(
+          {
+            archived: T::Boolean,
+            brand_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collection_list_response.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollectionListResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::ProductCollectionListResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Collection ID
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Timestamp when created
+      sig { returns(Time) }
+      attr_accessor :created_at
+
+      # Collection name
+      sig { returns(String) }
+      attr_accessor :name
+
+      # Number of products in the collection
+      sig { returns(Integer) }
+      attr_accessor :products_count
+
+      # Timestamp when last updated
+      sig { returns(Time) }
+      attr_accessor :updated_at
+
+      # Collection description
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Collection image URL
+      sig { returns(T.nilable(String)) }
+      attr_accessor :image
+
+      sig do
+        params(
+          id: String,
+          created_at: Time,
+          name: String,
+          products_count: Integer,
+          updated_at: Time,
+          description: T.nilable(String),
+          image: T.nilable(String)
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Collection ID
+        id:,
+        # Timestamp when created
+        created_at:,
+        # Collection name
+        name:,
+        # Number of products in the collection
+        products_count:,
+        # Timestamp when last updated
+        updated_at:,
+        # Collection description
+        description: nil,
+        # Collection image URL
+        image: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            created_at: Time,
+            name: String,
+            products_count: Integer,
+            updated_at: Time,
+            description: T.nilable(String),
+            image: T.nilable(String)
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collection_retrieve_params.rbi

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

data/rbi/dodopayments/models/product_collection_unarchive_params.rbi

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

data/rbi/dodopayments/models/product_collection_unarchive_response.rbi

@@ -0,0 +1,56 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollectionUnarchiveResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::ProductCollectionUnarchiveResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Collection ID that was unarchived
+      sig { returns(String) }
+      attr_accessor :collection_id
+
+      # Product IDs that were excluded because they are archived
+      sig { returns(T::Array[String]) }
+      attr_accessor :excluded_product_ids
+
+      # Success message
+      sig { returns(String) }
+      attr_accessor :message
+
+      sig do
+        params(
+          collection_id: String,
+          excluded_product_ids: T::Array[String],
+          message: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Collection ID that was unarchived
+        collection_id:,
+        # Product IDs that were excluded because they are archived
+        excluded_product_ids:,
+        # Success message
+        message:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            collection_id: String,
+            excluded_product_ids: T::Array[String],
+            message: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collection_update_images_params.rbi

@@ -0,0 +1,52 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollectionUpdateImagesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductCollectionUpdateImagesParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # If true, generates a new image ID to force cache invalidation
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :force_update
+
+      sig do
+        params(
+          id: String,
+          force_update: T.nilable(T::Boolean),
+          request_options: Dodopayments::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        id:,
+        # If true, generates a new image ID to force cache invalidation
+        force_update: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            force_update: T.nilable(T::Boolean),
+            request_options: Dodopayments::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collection_update_images_response.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollectionUpdateImagesResponse < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::Models::ProductCollectionUpdateImagesResponse,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # Presigned S3 URL for uploading the image
+      sig { returns(String) }
+      attr_accessor :url
+
+      # Optional image ID (present when force_update is true)
+      sig { returns(T.nilable(String)) }
+      attr_accessor :image_id
+
+      sig do
+        params(url: String, image_id: T.nilable(String)).returns(
+          T.attached_class
+        )
+      end
+      def self.new(
+        # Presigned S3 URL for uploading the image
+        url:,
+        # Optional image ID (present when force_update is true)
+        image_id: nil
+      )
+      end
+
+      sig { override.returns({ url: String, image_id: T.nilable(String) }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/product_collection_update_params.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class ProductCollectionUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::ProductCollectionUpdateParams,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # Optional brand_id update
+      sig { returns(T.nilable(String)) }
+      attr_accessor :brand_id
+
+      # Optional description update - pass null to remove, omit to keep unchanged
+      sig { returns(T.nilable(String)) }
+      attr_accessor :description
+
+      # Optional new order for groups (array of group UUIDs in desired order)
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_accessor :group_order
+
+      # Optional image update - pass null to remove, omit to keep unchanged
+      sig { returns(T.nilable(String)) }
+      attr_accessor :image_id
+
+      # Optional new name for the collection
+      sig { returns(T.nilable(String)) }
+      attr_accessor :name
+
+      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
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        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
+        override.returns(
+          {
+            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
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end