dodopayments 2.2.0 → 2.3.0

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

@@ -0,0 +1,160 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      # @see Dodopayments::Resources::ProductCollections::Groups#create
+      class GroupCreateResponse < Dodopayments::Internal::Type::BaseModel
+        # @!attribute group_id
+        #
+        #   @return [String]
+        required :group_id, String
+
+        # @!attribute products
+        #
+        #   @return [Array<Dodopayments::Models::ProductCollections::GroupCreateResponse::Product>]
+        required :products,
+                 -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Models::ProductCollections::GroupCreateResponse::Product] }
+
+        # @!attribute status
+        #
+        #   @return [Boolean]
+        required :status, Dodopayments::Internal::Type::Boolean
+
+        # @!attribute group_name
+        #
+        #   @return [String, nil]
+        optional :group_name, String, nil?: true
+
+        # @!method initialize(group_id:, products:, status:, group_name: nil)
+        #   @param group_id [String]
+        #   @param products [Array<Dodopayments::Models::ProductCollections::GroupCreateResponse::Product>]
+        #   @param status [Boolean]
+        #   @param group_name [String, nil]
+
+        class Product < 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::GroupCreateResponse::Product} 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

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_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,60 @@
+# 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::Groups::ItemCreateParams::Product>]
+          required :products,
+                   -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::ProductCollections::Groups::ItemCreateParams::Product] }
+
+          # @!method initialize(id:, group_id:, products:, request_options: {})
+          #   @param id [String]
+          #
+          #   @param group_id [String]
+          #
+          #   @param products [Array<Dodopayments::Models::ProductCollections::Groups::ItemCreateParams::Product>] Products to add to the group
+          #
+          #   @param request_options [Dodopayments::RequestOptions, Hash{Symbol=>Object}]
+
+          class Product < 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
+  end
+end

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

@@ -0,0 +1,136 @@
+# frozen_string_literal: true
+
+module Dodopayments
+  module Models
+    module ProductCollections
+      module Groups
+        class ItemCreateResponseItem < 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::ItemCreateResponseItem} 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
+
+        # @type [Dodopayments::Internal::Type::Converter]
+        ItemCreateResponse =
+          Dodopayments::Internal::Type::ArrayOf[-> { Dodopayments::Models::ProductCollections::Groups::ItemCreateResponseItem }]
+      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/subscription.rb

@@ -190,13 +190,19 @@ module Dodopayments
       #   @return [String, nil]
       optional :payment_method_id, String, nil?: true
 
+      # @!attribute scheduled_change
+      #   Scheduled plan change details, if any
+      #
+      #   @return [Dodopayments::Models::Subscription::ScheduledChange, nil]
+      optional :scheduled_change, -> { Dodopayments::Subscription::ScheduledChange }, nil?: true
+
       # @!attribute tax_id
       #   Tax identifier provided for this subscription (if applicable)
       #
       #   @return [String, nil]
       optional :tax_id, String, nil?: true
 
-      # @!method initialize(addons:, billing:, cancel_at_next_billing_date:, created_at:, credit_entitlement_cart:, currency:, customer:, metadata:, meter_credit_entitlement_cart:, meters:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, custom_field_responses: nil, discount_cycles_remaining: nil, discount_id: nil, expires_at: nil, payment_method_id: nil, tax_id: nil)
+      # @!method initialize(addons:, billing:, cancel_at_next_billing_date:, created_at:, credit_entitlement_cart:, currency:, customer:, metadata:, meter_credit_entitlement_cart:, meters:, next_billing_date:, on_demand:, payment_frequency_count:, payment_frequency_interval:, previous_billing_date:, product_id:, quantity:, recurring_pre_tax_amount:, status:, subscription_id:, subscription_period_count:, subscription_period_interval:, tax_inclusive:, trial_period_days:, cancelled_at: nil, custom_field_responses: nil, discount_cycles_remaining: nil, discount_id: nil, expires_at: nil, payment_method_id: nil, scheduled_change: nil, tax_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {Dodopayments::Models::Subscription} for more details.
       #
@@ -262,7 +268,107 @@ module Dodopayments
       #
       #   @param payment_method_id [String, nil] Saved payment method id used for recurring charges
       #
+      #   @param scheduled_change [Dodopayments::Models::Subscription::ScheduledChange, nil] Scheduled plan change details, if any
+      #
       #   @param tax_id [String, nil] Tax identifier provided for this subscription (if applicable)
+
+      # @see Dodopayments::Models::Subscription#scheduled_change
+      class ScheduledChange < Dodopayments::Internal::Type::BaseModel
+        # @!attribute id
+        #   The scheduled plan change ID
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute addons
+        #   Addons included in the scheduled change
+        #
+        #   @return [Array<Dodopayments::Models::Subscription::ScheduledChange::Addon>]
+        required :addons,
+                 -> { Dodopayments::Internal::Type::ArrayOf[Dodopayments::Subscription::ScheduledChange::Addon] }
+
+        # @!attribute created_at
+        #   When this scheduled change was created
+        #
+        #   @return [Time]
+        required :created_at, Time
+
+        # @!attribute effective_at
+        #   When the change will be applied
+        #
+        #   @return [Time]
+        required :effective_at, Time
+
+        # @!attribute product_id
+        #   The product ID the subscription will change to
+        #
+        #   @return [String]
+        required :product_id, String
+
+        # @!attribute quantity
+        #   Quantity for the new plan
+        #
+        #   @return [Integer]
+        required :quantity, Integer
+
+        # @!attribute product_description
+        #   Description of the product being changed to
+        #
+        #   @return [String, nil]
+        optional :product_description, String, nil?: true
+
+        # @!attribute product_name
+        #   Name of the product being changed to
+        #
+        #   @return [String, nil]
+        optional :product_name, String, nil?: true
+
+        # @!method initialize(id:, addons:, created_at:, effective_at:, product_id:, quantity:, product_description: nil, product_name: nil)
+        #   Scheduled plan change details, if any
+        #
+        #   @param id [String] The scheduled plan change ID
+        #
+        #   @param addons [Array<Dodopayments::Models::Subscription::ScheduledChange::Addon>] Addons included in the scheduled change
+        #
+        #   @param created_at [Time] When this scheduled change was created
+        #
+        #   @param effective_at [Time] When the change will be applied
+        #
+        #   @param product_id [String] The product ID the subscription will change to
+        #
+        #   @param quantity [Integer] Quantity for the new plan
+        #
+        #   @param product_description [String, nil] Description of the product being changed to
+        #
+        #   @param product_name [String, nil] Name of the product being changed to
+
+        class Addon < Dodopayments::Internal::Type::BaseModel
+          # @!attribute addon_id
+          #   The addon ID
+          #
+          #   @return [String]
+          required :addon_id, String
+
+          # @!attribute name
+          #   Name of the addon
+          #
+          #   @return [String]
+          required :name, String
+
+          # @!attribute quantity
+          #   Quantity of the addon
+          #
+          #   @return [Integer]
+          required :quantity, Integer
+
+          # @!method initialize(addon_id:, name:, quantity:)
+          #   @param addon_id [String] The addon ID
+          #
+          #   @param name [String] Name of the addon
+          #
+          #   @param quantity [Integer] Quantity of the addon
+        end
+      end
     end
   end
 end

data/lib/dodopayments/models/subscription_cancel_change_plan_params.rb

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