dodopayments 2.11.1 → 2.12.0

data/rbi/dodopayments/models/product_collection.rbi

@@ -45,10 +45,65 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
+      # Default effective_at setting for subscription plan downgrades (null = inherit
+      # from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollection::EffectiveAtOnDowngrade::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :effective_at_on_downgrade
+
+      # Default effective_at setting for subscription plan upgrades (null = inherit from
+      # business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollection::EffectiveAtOnUpgrade::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :effective_at_on_upgrade
+
       # URL of the collection image
       sig { returns(T.nilable(String)) }
       attr_accessor :image
 
+      # Default behavior for subscription plan changes on payment failure (null =
+      # inherit from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollection::OnPaymentFailure::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :on_payment_failure
+
+      # Default proration billing mode for subscription plan downgrades (null = inherit
+      # from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :proration_billing_mode_on_downgrade
+
+      # Default proration billing mode for subscription plan upgrades (null = inherit
+      # from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+        )
+      end
+      attr_accessor :proration_billing_mode_on_upgrade
+
       sig do
         params(
           id: String,
@@ -61,7 +116,27 @@ module Dodopayments
           name: String,
           updated_at: Time,
           description: T.nilable(String),
-          image: T.nilable(String)
+          effective_at_on_downgrade:
+            T.nilable(
+              Dodopayments::ProductCollection::EffectiveAtOnDowngrade::OrSymbol
+            ),
+          effective_at_on_upgrade:
+            T.nilable(
+              Dodopayments::ProductCollection::EffectiveAtOnUpgrade::OrSymbol
+            ),
+          image: T.nilable(String),
+          on_payment_failure:
+            T.nilable(
+              Dodopayments::ProductCollection::OnPaymentFailure::OrSymbol
+            ),
+          proration_billing_mode_on_downgrade:
+            T.nilable(
+              Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::OrSymbol
+            ),
+          proration_billing_mode_on_upgrade:
+            T.nilable(
+              Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::OrSymbol
+            )
         ).returns(T.attached_class)
       end
       def self.new(
@@ -79,8 +154,23 @@ module Dodopayments
         updated_at:,
         # Description of the collection
         description: nil,
+        # Default effective_at setting for subscription plan downgrades (null = inherit
+        # from business)
+        effective_at_on_downgrade: nil,
+        # Default effective_at setting for subscription plan upgrades (null = inherit from
+        # business)
+        effective_at_on_upgrade: nil,
         # URL of the collection image
-        image: nil
+        image: nil,
+        # Default behavior for subscription plan changes on payment failure (null =
+        # inherit from business)
+        on_payment_failure: nil,
+        # Default proration billing mode for subscription plan downgrades (null = inherit
+        # from business)
+        proration_billing_mode_on_downgrade: nil,
+        # Default proration billing mode for subscription plan upgrades (null = inherit
+        # from business)
+        proration_billing_mode_on_upgrade: nil
       )
       end
 
@@ -97,12 +187,226 @@ module Dodopayments
             name: String,
             updated_at: Time,
             description: T.nilable(String),
-            image: T.nilable(String)
+            effective_at_on_downgrade:
+              T.nilable(
+                Dodopayments::ProductCollection::EffectiveAtOnDowngrade::TaggedSymbol
+              ),
+            effective_at_on_upgrade:
+              T.nilable(
+                Dodopayments::ProductCollection::EffectiveAtOnUpgrade::TaggedSymbol
+              ),
+            image: T.nilable(String),
+            on_payment_failure:
+              T.nilable(
+                Dodopayments::ProductCollection::OnPaymentFailure::TaggedSymbol
+              ),
+            proration_billing_mode_on_downgrade:
+              T.nilable(
+                Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::TaggedSymbol
+              ),
+            proration_billing_mode_on_upgrade:
+              T.nilable(
+                Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::TaggedSymbol
+              )
           }
         )
       end
       def to_hash
       end
+
+      # Default effective_at setting for subscription plan downgrades (null = inherit
+      # from business)
+      module EffectiveAtOnDowngrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollection::EffectiveAtOnDowngrade
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IMMEDIATELY =
+          T.let(
+            :immediately,
+            Dodopayments::ProductCollection::EffectiveAtOnDowngrade::TaggedSymbol
+          )
+        NEXT_BILLING_DATE =
+          T.let(
+            :next_billing_date,
+            Dodopayments::ProductCollection::EffectiveAtOnDowngrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollection::EffectiveAtOnDowngrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default effective_at setting for subscription plan upgrades (null = inherit from
+      # business)
+      module EffectiveAtOnUpgrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::ProductCollection::EffectiveAtOnUpgrade)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IMMEDIATELY =
+          T.let(
+            :immediately,
+            Dodopayments::ProductCollection::EffectiveAtOnUpgrade::TaggedSymbol
+          )
+        NEXT_BILLING_DATE =
+          T.let(
+            :next_billing_date,
+            Dodopayments::ProductCollection::EffectiveAtOnUpgrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollection::EffectiveAtOnUpgrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default behavior for subscription plan changes on payment failure (null =
+      # inherit from business)
+      module OnPaymentFailure
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::ProductCollection::OnPaymentFailure)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PREVENT_CHANGE =
+          T.let(
+            :prevent_change,
+            Dodopayments::ProductCollection::OnPaymentFailure::TaggedSymbol
+          )
+        APPLY_CHANGE =
+          T.let(
+            :apply_change,
+            Dodopayments::ProductCollection::OnPaymentFailure::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollection::OnPaymentFailure::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default proration billing mode for subscription plan downgrades (null = inherit
+      # from business)
+      module ProrationBillingModeOnDowngrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRORATED_IMMEDIATELY =
+          T.let(
+            :prorated_immediately,
+            Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+        FULL_IMMEDIATELY =
+          T.let(
+            :full_immediately,
+            Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+        DIFFERENCE_IMMEDIATELY =
+          T.let(
+            :difference_immediately,
+            Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+        DO_NOT_BILL =
+          T.let(
+            :do_not_bill,
+            Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollection::ProrationBillingModeOnDowngrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default proration billing mode for subscription plan upgrades (null = inherit
+      # from business)
+      module ProrationBillingModeOnUpgrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRORATED_IMMEDIATELY =
+          T.let(
+            :prorated_immediately,
+            Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+        FULL_IMMEDIATELY =
+          T.let(
+            :full_immediately,
+            Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+        DIFFERENCE_IMMEDIATELY =
+          T.let(
+            :difference_immediately,
+            Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+        DO_NOT_BILL =
+          T.let(
+            :do_not_bill,
+            Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollection::ProrationBillingModeOnUpgrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/product_collection_create_params.rbi

@@ -36,6 +36,61 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :description
 
+      # Default effective_at setting for subscription plan downgrades (NULL = inherit
+      # from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollectionCreateParams::EffectiveAtOnDowngrade::OrSymbol
+          )
+        )
+      end
+      attr_accessor :effective_at_on_downgrade
+
+      # Default effective_at setting for subscription plan upgrades (NULL = inherit from
+      # business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollectionCreateParams::EffectiveAtOnUpgrade::OrSymbol
+          )
+        )
+      end
+      attr_accessor :effective_at_on_upgrade
+
+      # Default behavior for subscription plan changes on payment failure (NULL =
+      # inherit from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollectionCreateParams::OnPaymentFailure::OrSymbol
+          )
+        )
+      end
+      attr_accessor :on_payment_failure
+
+      # Default proration billing mode for subscription plan downgrades (NULL = inherit
+      # from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::OrSymbol
+          )
+        )
+      end
+      attr_accessor :proration_billing_mode_on_downgrade
+
+      # Default proration billing mode for subscription plan upgrades (NULL = inherit
+      # from business)
+      sig do
+        returns(
+          T.nilable(
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::OrSymbol
+          )
+        )
+      end
+      attr_accessor :proration_billing_mode_on_upgrade
+
       sig do
         params(
           groups:
@@ -45,6 +100,26 @@ module Dodopayments
           name: String,
           brand_id: T.nilable(String),
           description: T.nilable(String),
+          effective_at_on_downgrade:
+            T.nilable(
+              Dodopayments::ProductCollectionCreateParams::EffectiveAtOnDowngrade::OrSymbol
+            ),
+          effective_at_on_upgrade:
+            T.nilable(
+              Dodopayments::ProductCollectionCreateParams::EffectiveAtOnUpgrade::OrSymbol
+            ),
+          on_payment_failure:
+            T.nilable(
+              Dodopayments::ProductCollectionCreateParams::OnPaymentFailure::OrSymbol
+            ),
+          proration_billing_mode_on_downgrade:
+            T.nilable(
+              Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::OrSymbol
+            ),
+          proration_billing_mode_on_upgrade:
+            T.nilable(
+              Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::OrSymbol
+            ),
           request_options: Dodopayments::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -57,6 +132,21 @@ module Dodopayments
         brand_id: nil,
         # Optional description of the product collection
         description: nil,
+        # Default effective_at setting for subscription plan downgrades (NULL = inherit
+        # from business)
+        effective_at_on_downgrade: nil,
+        # Default effective_at setting for subscription plan upgrades (NULL = inherit from
+        # business)
+        effective_at_on_upgrade: nil,
+        # Default behavior for subscription plan changes on payment failure (NULL =
+        # inherit from business)
+        on_payment_failure: nil,
+        # Default proration billing mode for subscription plan downgrades (NULL = inherit
+        # from business)
+        proration_billing_mode_on_downgrade: nil,
+        # Default proration billing mode for subscription plan upgrades (NULL = inherit
+        # from business)
+        proration_billing_mode_on_upgrade: nil,
         request_options: {}
       )
       end
@@ -71,12 +161,232 @@ module Dodopayments
             name: String,
             brand_id: T.nilable(String),
             description: T.nilable(String),
+            effective_at_on_downgrade:
+              T.nilable(
+                Dodopayments::ProductCollectionCreateParams::EffectiveAtOnDowngrade::OrSymbol
+              ),
+            effective_at_on_upgrade:
+              T.nilable(
+                Dodopayments::ProductCollectionCreateParams::EffectiveAtOnUpgrade::OrSymbol
+              ),
+            on_payment_failure:
+              T.nilable(
+                Dodopayments::ProductCollectionCreateParams::OnPaymentFailure::OrSymbol
+              ),
+            proration_billing_mode_on_downgrade:
+              T.nilable(
+                Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::OrSymbol
+              ),
+            proration_billing_mode_on_upgrade:
+              T.nilable(
+                Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::OrSymbol
+              ),
             request_options: Dodopayments::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      # Default effective_at setting for subscription plan downgrades (NULL = inherit
+      # from business)
+      module EffectiveAtOnDowngrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollectionCreateParams::EffectiveAtOnDowngrade
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IMMEDIATELY =
+          T.let(
+            :immediately,
+            Dodopayments::ProductCollectionCreateParams::EffectiveAtOnDowngrade::TaggedSymbol
+          )
+        NEXT_BILLING_DATE =
+          T.let(
+            :next_billing_date,
+            Dodopayments::ProductCollectionCreateParams::EffectiveAtOnDowngrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollectionCreateParams::EffectiveAtOnDowngrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default effective_at setting for subscription plan upgrades (NULL = inherit from
+      # business)
+      module EffectiveAtOnUpgrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollectionCreateParams::EffectiveAtOnUpgrade
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        IMMEDIATELY =
+          T.let(
+            :immediately,
+            Dodopayments::ProductCollectionCreateParams::EffectiveAtOnUpgrade::TaggedSymbol
+          )
+        NEXT_BILLING_DATE =
+          T.let(
+            :next_billing_date,
+            Dodopayments::ProductCollectionCreateParams::EffectiveAtOnUpgrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollectionCreateParams::EffectiveAtOnUpgrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default behavior for subscription plan changes on payment failure (NULL =
+      # inherit from business)
+      module OnPaymentFailure
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollectionCreateParams::OnPaymentFailure
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PREVENT_CHANGE =
+          T.let(
+            :prevent_change,
+            Dodopayments::ProductCollectionCreateParams::OnPaymentFailure::TaggedSymbol
+          )
+        APPLY_CHANGE =
+          T.let(
+            :apply_change,
+            Dodopayments::ProductCollectionCreateParams::OnPaymentFailure::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollectionCreateParams::OnPaymentFailure::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default proration billing mode for subscription plan downgrades (NULL = inherit
+      # from business)
+      module ProrationBillingModeOnDowngrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRORATED_IMMEDIATELY =
+          T.let(
+            :prorated_immediately,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+        FULL_IMMEDIATELY =
+          T.let(
+            :full_immediately,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+        DIFFERENCE_IMMEDIATELY =
+          T.let(
+            :difference_immediately,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+        DO_NOT_BILL =
+          T.let(
+            :do_not_bill,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnDowngrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+
+      # Default proration billing mode for subscription plan upgrades (NULL = inherit
+      # from business)
+      module ProrationBillingModeOnUpgrade
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        PRORATED_IMMEDIATELY =
+          T.let(
+            :prorated_immediately,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+        FULL_IMMEDIATELY =
+          T.let(
+            :full_immediately,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+        DIFFERENCE_IMMEDIATELY =
+          T.let(
+            :difference_immediately,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+        DO_NOT_BILL =
+          T.let(
+            :do_not_bill,
+            Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::ProductCollectionCreateParams::ProrationBillingModeOnUpgrade::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end