dodopayments 2.9.1 → 2.11.0

data/lib/dodopayments/models/product_collection_list_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#list
+    class ProductCollectionListResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute id
+      #   Collection ID
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute created_at
+      #   Timestamp when created
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute name
+      #   Collection name
+      #
+      #   @return [String]
+      required :name, String
+
+      # @!attribute products_count
+      #   Number of products in the collection
+      #
+      #   @return [Integer]
+      required :products_count, Integer
+
+      # @!attribute updated_at
+      #   Timestamp when last updated
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute description
+      #   Collection description
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute image
+      #   Collection image URL
+      #
+      #   @return [String, nil]
+      optional :image, String, nil?: true
+
+      # @!method initialize(id:, created_at:, name:, products_count:, updated_at:, description: nil, image: nil)
+      #   @param id [String] Collection ID
+      #
+      #   @param created_at [Time] Timestamp when created
+      #
+      #   @param name [String] Collection name
+      #
+      #   @param products_count [Integer] Number of products in the collection
+      #
+      #   @param updated_at [Time] Timestamp when last updated
+      #
+      #   @param description [String, nil] Collection description
+      #
+      #   @param image [String, nil] Collection image URL
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#retrieve
+    class ProductCollectionRetrieveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_unarchive_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#unarchive
+    class ProductCollectionUnarchiveParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_unarchive_response.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#unarchive
+    class ProductCollectionUnarchiveResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute collection_id
+      #   Collection ID that was unarchived
+      #
+      #   @return [String]
+      required :collection_id, String
+
+      # @!attribute excluded_product_ids
+      #   Product IDs that were excluded because they are archived
+      #
+      #   @return [Array<String>]
+      required :excluded_product_ids, Dodopayments::Internal::Type::ArrayOf[String]
+
+      # @!attribute message
+      #   Success message
+      #
+      #   @return [String]
+      required :message, String
+
+      # @!method initialize(collection_id:, excluded_product_ids:, message:)
+      #   @param collection_id [String] Collection ID that was unarchived
+      #
+      #   @param excluded_product_ids [Array<String>] Product IDs that were excluded because they are archived
+      #
+      #   @param message [String] Success message
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_update_images_params.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#update_images
+    class ProductCollectionUpdateImagesParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute force_update
+      #   If true, generates a new image ID to force cache invalidation
+      #
+      #   @return [Boolean, nil]
+      optional :force_update, Dodopayments::Internal::Type::Boolean, nil?: true
+
+      # @!method initialize(id:, force_update: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param force_update [Boolean, nil] If true, generates a new image ID to force cache invalidation
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_update_images_response.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#update_images
+    class ProductCollectionUpdateImagesResponse < Dodopayments::Internal::Type::BaseModel
+      # @!attribute url
+      #   Presigned S3 URL for uploading the image
+      #
+      #   @return [String]
+      required :url, String
+
+      # @!attribute image_id
+      #   Optional image ID (present when force_update is true)
+      #
+      #   @return [String, nil]
+      optional :image_id, String, nil?: true
+
+      # @!method initialize(url:, image_id: nil)
+      #   @param url [String] Presigned S3 URL for uploading the image
+      #
+      #   @param image_id [String, nil] Optional image ID (present when force_update is true)
+    end
+  end
+end

data/lib/dodopayments/models/product_collection_update_params.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    # @see Dodopayments::Resources::ProductCollections#update
+    class ProductCollectionUpdateParams < Dodopayments::Internal::Type::BaseModel
+      extend Dodopayments::Internal::Type::RequestParameters::Converter
+      include Dodopayments::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute brand_id
+      #   Optional brand_id update
+      #
+      #   @return [String, nil]
+      optional :brand_id, String, nil?: true
+
+      # @!attribute description
+      #   Optional description update - pass null to remove, omit to keep unchanged
+      #
+      #   @return [String, nil]
+      optional :description, String, nil?: true
+
+      # @!attribute group_order
+      #   Optional new order for groups (array of group UUIDs in desired order)
+      #
+      #   @return [Array<String>, nil]
+      optional :group_order, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
+      # @!attribute image_id
+      #   Optional image update - pass null to remove, omit to keep unchanged
+      #
+      #   @return [String, nil]
+      optional :image_id, String, nil?: true
+
+      # @!attribute name
+      #   Optional new name for the collection
+      #
+      #   @return [String, nil]
+      optional :name, String, nil?: true
+
+      # @!method initialize(id:, brand_id: nil, description: nil, group_order: nil, image_id: nil, name: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param brand_id [String, nil] Optional brand_id update
+      #
+      #   @param description [String, nil] Optional description update - pass null to remove, omit to keep unchanged
+      #
+      #   @param group_order [Array<String>, nil] Optional new order for groups (array of group UUIDs in desired order)
+      #
+      #   @param image_id [String, nil] Optional image update - pass null to remove, omit to keep unchanged
+      #
+      #   @param name [String, nil] Optional new name for the collection
+      #
+      #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/group_create_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      # @see Dodopayments::Resources::ProductCollections::Groups#create
+      class GroupCreateParams < Dodopayments::Models::ProductCollections::ProductCollectionGroupDetails
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/group_delete_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      # @see Dodopayments::Resources::ProductCollections::Groups#delete
+      class GroupDeleteParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute group_id
+        #
+        #   @return [String]
+        required :group_id, String
+
+        # @!method initialize(id:, group_id:, request_options: {})
+        #   @param id [String]
+        #   @param group_id [String]
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/group_product.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      class GroupProduct < Dodopayments::Internal::Type::BaseModel
+        # @!attribute product_id
+        #   Product ID to include in the group
+        #
+        #   @return [String]
+        required :product_id, String
+
+        # @!attribute status
+        #   Status of the product in this group (defaults to true if not provided)
+        #
+        #   @return [Boolean, nil]
+        optional :status, Dodopayments::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(product_id:, status: nil)
+        #   @param product_id [String] Product ID to include in the group
+        #
+        #   @param status [Boolean, nil] Status of the product in this group (defaults to true if not provided)
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/group_update_params.rb

@@ -0,0 +1,59 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      # @see Dodopayments::Resources::ProductCollections::Groups#update
+      class GroupUpdateParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute group_id
+        #
+        #   @return [String]
+        required :group_id, String
+
+        # @!attribute group_name
+        #   Optional group name update: Some(Some(name)) = set name, Some(None) = clear
+        #   name, None = no change
+        #
+        #   @return [String, nil]
+        optional :group_name, String, nil?: true
+
+        # @!attribute product_order
+        #   Optional new order for products in this group (array of
+        #   product_collection_group_pdts UUIDs)
+        #
+        #   @return [Array<String>, nil]
+        optional :product_order, Dodopayments::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute status
+        #   Optional status update
+        #
+        #   @return [Boolean, nil]
+        optional :status, Dodopayments::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(id:, group_id:, group_name: nil, product_order: nil, status: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Dodopayments::Models::ProductCollections::GroupUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param group_id [String]
+        #
+        #   @param group_name [String, nil] Optional group name update: Some(Some(name)) = set name, Some(None) = clear name
+        #
+        #   @param product_order [Array<String>, nil] Optional new order for products in this group (array of product_collection_group
+        #
+        #   @param status [Boolean, nil] Optional status update
+        #
+        #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/groups/item_create_params.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      module Groups
+        # @see Dodopayments::Resources::ProductCollections::Groups::Items#create
+        class ItemCreateParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute group_id
+          #
+          #   @return [String]
+          required :group_id, String
+
+          # @!attribute products
+          #   Products to add to the group
+          #
+          #   @return [Array<Dodopayments::Models::ProductCollections::GroupProduct>]
+          required :products,
+                   -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductCollections::GroupProduct] }
+
+          # @!method initialize(id:, group_id:, products:, request_options: {})
+          #   @param id [String]
+          #
+          #   @param group_id [String]
+          #
+          #   @param products [Array<Dodopayments::Models::ProductCollections::GroupProduct>] Products to add to the group
+          #
+          #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/groups/item_create_response.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      module Groups
+        # @type [Dodopayments::Internal::Type::Converter]
+        ItemCreateResponse =
+          Dodopayments::Internal::Type::ArrayOf[-> {
+            Dodopayments::ProductCollections::Groups::ProductCollectionProduct
+          }]
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/groups/item_delete_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      module Groups
+        # @see Dodopayments::Resources::ProductCollections::Groups::Items#delete
+        class ItemDeleteParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute group_id
+          #
+          #   @return [String]
+          required :group_id, String
+
+          # @!attribute item_id
+          #
+          #   @return [String]
+          required :item_id, String
+
+          # @!method initialize(id:, group_id:, item_id:, request_options: {})
+          #   @param id [String]
+          #   @param group_id [String]
+          #   @param item_id [String]
+          #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/groups/item_update_params.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      module Groups
+        # @see Dodopayments::Resources::ProductCollections::Groups::Items#update
+        class ItemUpdateParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute group_id
+          #
+          #   @return [String]
+          required :group_id, String
+
+          # @!attribute item_id
+          #
+          #   @return [String]
+          required :item_id, String
+
+          # @!attribute status
+          #   Status of the product in the group
+          #
+          #   @return [Boolean]
+          required :status, Dodopayments::Internal::Type::Boolean
+
+          # @!method initialize(id:, group_id:, item_id:, status:, request_options: {})
+          #   @param id [String]
+          #
+          #   @param group_id [String]
+          #
+          #   @param item_id [String]
+          #
+          #   @param status [Boolean] Status of the product in the group
+          #
+          #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/dodopayments/models/product_collections/groups/product_collection_product.rb

@@ -0,0 +1,132 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      module Groups
+        class ProductCollectionProduct < Dodopayments::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute addons_count
+          #
+          #   @return [Integer]
+          required :addons_count, Integer
+
+          # @!attribute files_count
+          #
+          #   @return [Integer]
+          required :files_count, Integer
+
+          # @!attribute has_credit_entitlements
+          #   Whether this product has any credit entitlements attached
+          #
+          #   @return [Boolean]
+          required :has_credit_entitlements, Dodopayments::Internal::Type::Boolean
+
+          # @!attribute is_recurring
+          #
+          #   @return [Boolean]
+          required :is_recurring, Dodopayments::Internal::Type::Boolean
+
+          # @!attribute license_key_enabled
+          #
+          #   @return [Boolean]
+          required :license_key_enabled, Dodopayments::Internal::Type::Boolean
+
+          # @!attribute meters_count
+          #
+          #   @return [Integer]
+          required :meters_count, Integer
+
+          # @!attribute product_id
+          #
+          #   @return [String]
+          required :product_id, String
+
+          # @!attribute status
+          #
+          #   @return [Boolean]
+          required :status, Dodopayments::Internal::Type::Boolean
+
+          # @!attribute currency
+          #
+          #   @return [Symbol, Dodopayments::Models::Currency, nil]
+          optional :currency, enum: -> { Dodopayments::Currency }, nil?: true
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!attribute name
+          #
+          #   @return [String, nil]
+          optional :name, String, nil?: true
+
+          # @!attribute price
+          #
+          #   @return [Integer, nil]
+          optional :price, Integer, nil?: true
+
+          # @!attribute price_detail
+          #   One-time price details.
+          #
+          #   @return [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, Dodopayments::Models::Price::UsageBasedPrice, nil]
+          optional :price_detail, union: -> { Dodopayments::Price }, nil?: true
+
+          # @!attribute tax_category
+          #   Represents the different categories of taxation applicable to various products
+          #   and services.
+          #
+          #   @return [Symbol, Dodopayments::Models::TaxCategory, nil]
+          optional :tax_category, enum: -> { Dodopayments::TaxCategory }, nil?: true
+
+          # @!attribute tax_inclusive
+          #
+          #   @return [Boolean, nil]
+          optional :tax_inclusive, Dodopayments::Internal::Type::Boolean, nil?: true
+
+          # @!method initialize(id:, addons_count:, files_count:, has_credit_entitlements:, is_recurring:, license_key_enabled:, meters_count:, product_id:, status:, currency: nil, description: nil, name: nil, price: nil, price_detail: nil, tax_category: nil, tax_inclusive: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Dodopayments::Models::ProductCollections::Groups::ProductCollectionProduct} for
+          #   more details.
+          #
+          #   @param id [String]
+          #
+          #   @param addons_count [Integer]
+          #
+          #   @param files_count [Integer]
+          #
+          #   @param has_credit_entitlements [Boolean] Whether this product has any credit entitlements attached
+          #
+          #   @param is_recurring [Boolean]
+          #
+          #   @param license_key_enabled [Boolean]
+          #
+          #   @param meters_count [Integer]
+          #
+          #   @param product_id [String]
+          #
+          #   @param status [Boolean]
+          #
+          #   @param currency [Symbol, Dodopayments::Models::Currency, nil]
+          #
+          #   @param description [String, nil]
+          #
+          #   @param name [String, nil]
+          #
+          #   @param price [Integer, nil]
+          #
+          #   @param price_detail [Dodopayments::Models::Price::OneTimePrice, Dodopayments::Models::Price::RecurringPrice, Dodopayments::Models::Price::UsageBasedPrice, nil] One-time price details.
+          #
+          #   @param tax_category [Symbol, Dodopayments::Models::TaxCategory, nil] Represents the different categories of taxation applicable to various products a
+          #
+          #   @param tax_inclusive [Boolean, nil]
+        end
+      end
+    end
+  end
+end