dodopayments 2.8.0 → 2.9.0

data/rbi/dodopayments/models/subscription_list_response.rbi

@@ -122,21 +122,12 @@ module Dodopayments
       attr_accessor :product_name
 
       # Scheduled plan change details, if any
-      sig do
-        returns(
-          T.nilable(
-            Dodopayments::Models::SubscriptionListResponse::ScheduledChange
-          )
-        )
-      end
+      sig { returns(T.nilable(Dodopayments::ScheduledPlanChange)) }
       attr_reader :scheduled_change
 
       sig do
         params(
-          scheduled_change:
-            T.nilable(
-              Dodopayments::Models::SubscriptionListResponse::ScheduledChange::OrHash
-            )
+          scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange::OrHash)
         ).void
       end
       attr_writer :scheduled_change
@@ -174,9 +165,7 @@ module Dodopayments
           payment_method_id: T.nilable(String),
           product_name: T.nilable(String),
           scheduled_change:
-            T.nilable(
-              Dodopayments::Models::SubscriptionListResponse::ScheduledChange::OrHash
-            ),
+            T.nilable(Dodopayments::ScheduledPlanChange::OrHash),
           tax_id: T.nilable(String)
         ).returns(T.attached_class)
       end
@@ -270,165 +259,13 @@ module Dodopayments
             discount_id: T.nilable(String),
             payment_method_id: T.nilable(String),
             product_name: T.nilable(String),
-            scheduled_change:
-              T.nilable(
-                Dodopayments::Models::SubscriptionListResponse::ScheduledChange
-              ),
+            scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange),
             tax_id: T.nilable(String)
           }
         )
       end
       def to_hash
       end
-
-      class ScheduledChange < Dodopayments::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Dodopayments::Models::SubscriptionListResponse::ScheduledChange,
-              Dodopayments::Internal::AnyHash
-            )
-          end
-
-        # The scheduled plan change ID
-        sig { returns(String) }
-        attr_accessor :id
-
-        # Addons included in the scheduled change
-        sig do
-          returns(
-            T::Array[
-              Dodopayments::Models::SubscriptionListResponse::ScheduledChange::Addon
-            ]
-          )
-        end
-        attr_accessor :addons
-
-        # When this scheduled change was created
-        sig { returns(Time) }
-        attr_accessor :created_at
-
-        # When the change will be applied
-        sig { returns(Time) }
-        attr_accessor :effective_at
-
-        # The product ID the subscription will change to
-        sig { returns(String) }
-        attr_accessor :product_id
-
-        # Quantity for the new plan
-        sig { returns(Integer) }
-        attr_accessor :quantity
-
-        # Description of the product being changed to
-        sig { returns(T.nilable(String)) }
-        attr_accessor :product_description
-
-        # Name of the product being changed to
-        sig { returns(T.nilable(String)) }
-        attr_accessor :product_name
-
-        # Scheduled plan change details, if any
-        sig do
-          params(
-            id: String,
-            addons:
-              T::Array[
-                Dodopayments::Models::SubscriptionListResponse::ScheduledChange::Addon::OrHash
-              ],
-            created_at: Time,
-            effective_at: Time,
-            product_id: String,
-            quantity: Integer,
-            product_description: T.nilable(String),
-            product_name: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The scheduled plan change ID
-          id:,
-          # Addons included in the scheduled change
-          addons:,
-          # When this scheduled change was created
-          created_at:,
-          # When the change will be applied
-          effective_at:,
-          # The product ID the subscription will change to
-          product_id:,
-          # Quantity for the new plan
-          quantity:,
-          # Description of the product being changed to
-          product_description: nil,
-          # Name of the product being changed to
-          product_name: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              id: String,
-              addons:
-                T::Array[
-                  Dodopayments::Models::SubscriptionListResponse::ScheduledChange::Addon
-                ],
-              created_at: Time,
-              effective_at: Time,
-              product_id: String,
-              quantity: Integer,
-              product_description: T.nilable(String),
-              product_name: T.nilable(String)
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class Addon < Dodopayments::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Dodopayments::Models::SubscriptionListResponse::ScheduledChange::Addon,
-                Dodopayments::Internal::AnyHash
-              )
-            end
-
-          # The addon ID
-          sig { returns(String) }
-          attr_accessor :addon_id
-
-          # Name of the addon
-          sig { returns(String) }
-          attr_accessor :name
-
-          # Quantity of the addon
-          sig { returns(Integer) }
-          attr_accessor :quantity
-
-          sig do
-            params(addon_id: String, name: String, quantity: Integer).returns(
-              T.attached_class
-            )
-          end
-          def self.new(
-            # The addon ID
-            addon_id:,
-            # Name of the addon
-            name:,
-            # Quantity of the addon
-            quantity:
-          )
-          end
-
-          sig do
-            override.returns(
-              { addon_id: String, name: String, quantity: Integer }
-            )
-          end
-          def to_hash
-          end
-        end
-      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_update_params.rbi

@@ -38,6 +38,16 @@ module Dodopayments
       end
       attr_accessor :cancel_reason
 
+      # Free-text cancellation comment (only valid when cancelling or scheduling
+      # cancellation).
+      sig { returns(T.nilable(String)) }
+      attr_accessor :cancellation_comment
+
+      # Customer-supplied churn reason (only valid when cancelling or scheduling
+      # cancellation).
+      sig { returns(T.nilable(Dodopayments::CancellationFeedback::OrSymbol)) }
+      attr_accessor :cancellation_feedback
+
       # Update credit entitlement cart settings
       sig do
         returns(
@@ -91,6 +101,9 @@ module Dodopayments
             T.nilable(
               Dodopayments::SubscriptionUpdateParams::CancelReason::OrSymbol
             ),
+          cancellation_comment: T.nilable(String),
+          cancellation_feedback:
+            T.nilable(Dodopayments::CancellationFeedback::OrSymbol),
           credit_entitlement_cart:
             T.nilable(
               T::Array[
@@ -115,6 +128,12 @@ module Dodopayments
         # When set, the subscription will remain active until the end of billing period
         cancel_at_next_billing_date: nil,
         cancel_reason: nil,
+        # Free-text cancellation comment (only valid when cancelling or scheduling
+        # cancellation).
+        cancellation_comment: nil,
+        # Customer-supplied churn reason (only valid when cancelling or scheduling
+        # cancellation).
+        cancellation_feedback: nil,
         # Update credit entitlement cart settings
         credit_entitlement_cart: nil,
         customer_name: nil,
@@ -137,6 +156,9 @@ module Dodopayments
               T.nilable(
                 Dodopayments::SubscriptionUpdateParams::CancelReason::OrSymbol
               ),
+            cancellation_comment: T.nilable(String),
+            cancellation_feedback:
+              T.nilable(Dodopayments::CancellationFeedback::OrSymbol),
             credit_entitlement_cart:
               T.nilable(
                 T::Array[
@@ -183,6 +205,11 @@ module Dodopayments
             :cancelled_by_merchant_send_dunning,
             Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
           )
+        DODO_TEAM =
+          T.let(
+            :dodo_team,
+            Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/unsafe_unwrap_webhook_event.rbi

@@ -16,6 +16,7 @@ module Dodopayments
             Dodopayments::CreditExpiredWebhookEvent,
             Dodopayments::CreditManualAdjustmentWebhookEvent,
             Dodopayments::CreditOverageChargedWebhookEvent,
+            Dodopayments::CreditOverageResetWebhookEvent,
             Dodopayments::CreditRolledOverWebhookEvent,
             Dodopayments::CreditRolloverForfeitedWebhookEvent,
             Dodopayments::DisputeAcceptedWebhookEvent,
@@ -27,6 +28,10 @@ module Dodopayments
             Dodopayments::DisputeWonWebhookEvent,
             Dodopayments::DunningRecoveredWebhookEvent,
             Dodopayments::DunningStartedWebhookEvent,
+            Dodopayments::EntitlementGrantCreatedWebhookEvent,
+            Dodopayments::EntitlementGrantDeliveredWebhookEvent,
+            Dodopayments::EntitlementGrantFailedWebhookEvent,
+            Dodopayments::EntitlementGrantRevokedWebhookEvent,
             Dodopayments::LicenseKeyCreatedWebhookEvent,
             Dodopayments::PaymentCancelledWebhookEvent,
             Dodopayments::PaymentFailedWebhookEvent,

data/rbi/dodopayments/models/unwrap_webhook_event.rbi

@@ -16,6 +16,7 @@ module Dodopayments
             Dodopayments::CreditExpiredWebhookEvent,
             Dodopayments::CreditManualAdjustmentWebhookEvent,
             Dodopayments::CreditOverageChargedWebhookEvent,
+            Dodopayments::CreditOverageResetWebhookEvent,
             Dodopayments::CreditRolledOverWebhookEvent,
             Dodopayments::CreditRolloverForfeitedWebhookEvent,
             Dodopayments::DisputeAcceptedWebhookEvent,
@@ -27,6 +28,10 @@ module Dodopayments
             Dodopayments::DisputeWonWebhookEvent,
             Dodopayments::DunningRecoveredWebhookEvent,
             Dodopayments::DunningStartedWebhookEvent,
+            Dodopayments::EntitlementGrantCreatedWebhookEvent,
+            Dodopayments::EntitlementGrantDeliveredWebhookEvent,
+            Dodopayments::EntitlementGrantFailedWebhookEvent,
+            Dodopayments::EntitlementGrantRevokedWebhookEvent,
             Dodopayments::LicenseKeyCreatedWebhookEvent,
             Dodopayments::PaymentCancelledWebhookEvent,
             Dodopayments::PaymentFailedWebhookEvent,

data/rbi/dodopayments/models/update_subscription_plan_req.rbi

@@ -27,6 +27,11 @@ module Dodopayments
       sig { returns(Integer) }
       attr_accessor :quantity
 
+      # Whether adaptive currency fees should be included in the price (true) or added
+      # on top (false). If not specified, uses the subscription's stored setting.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :adaptive_currency_fees_inclusive
+
       # Addons for the new plan. Note : Leaving this empty would remove any existing
       # addons
       sig { returns(T.nilable(T::Array[Dodopayments::AttachAddon])) }
@@ -87,6 +92,7 @@ module Dodopayments
           proration_billing_mode:
             Dodopayments::UpdateSubscriptionPlanReq::ProrationBillingMode::OrSymbol,
           quantity: Integer,
+          adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
           addons: T.nilable(T::Array[Dodopayments::AttachAddon::OrHash]),
           discount_code: T.nilable(String),
           effective_at:
@@ -105,6 +111,9 @@ module Dodopayments
         proration_billing_mode:,
         # Number of units to subscribe for. Must be at least 1.
         quantity:,
+        # Whether adaptive currency fees should be included in the price (true) or added
+        # on top (false). If not specified, uses the subscription's stored setting.
+        adaptive_currency_fees_inclusive: nil,
         # Addons for the new plan. Note : Leaving this empty would remove any existing
         # addons
         addons: nil,
@@ -139,6 +148,7 @@ module Dodopayments
             proration_billing_mode:
               Dodopayments::UpdateSubscriptionPlanReq::ProrationBillingMode::OrSymbol,
             quantity: Integer,
+            adaptive_currency_fees_inclusive: T.nilable(T::Boolean),
             addons: T.nilable(T::Array[Dodopayments::AttachAddon]),
             discount_code: T.nilable(String),
             effective_at:

data/rbi/dodopayments/models/webhook_event_type.rbi

@@ -133,6 +133,11 @@ module Dodopayments
           :"credit.overage_charged",
           Dodopayments::WebhookEventType::TaggedSymbol
         )
+      CREDIT_OVERAGE_RESET =
+        T.let(
+          :"credit.overage_reset",
+          Dodopayments::WebhookEventType::TaggedSymbol
+        )
       CREDIT_MANUAL_ADJUSTMENT =
         T.let(
           :"credit.manual_adjustment",

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -1018,7 +1018,7 @@ module Dodopayments
           end
         end
 
-        class EntitlementGrant < Dodopayments::Internal::Type::BaseModel
+        class EntitlementGrant < Dodopayments::Models::Entitlements::EntitlementGrant
           OrHash =
             T.type_alias do
               T.any(
@@ -1027,24 +1027,6 @@ module Dodopayments
               )
             end
 
-          sig { returns(String) }
-          attr_accessor :id
-
-          sig { returns(String) }
-          attr_accessor :business_id
-
-          sig { returns(Time) }
-          attr_accessor :created_at
-
-          sig { returns(String) }
-          attr_accessor :customer_id
-
-          sig { returns(String) }
-          attr_accessor :entitlement_id
-
-          sig { returns(String) }
-          attr_accessor :external_id
-
           sig do
             returns(
               Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol
@@ -1052,151 +1034,20 @@ module Dodopayments
           end
           attr_accessor :payload_type
 
-          sig do
-            returns(
-              Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::OrSymbol
-            )
-          end
-          attr_accessor :status
-
-          sig { returns(Time) }
-          attr_accessor :updated_at
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :delivered_at
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :error_code
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :error_message
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :license_key
-
-          sig { returns(T.nilable(Integer)) }
-          attr_accessor :license_key_activations_limit
-
-          sig { returns(T.nilable(Integer)) }
-          attr_accessor :license_key_activations_used
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :license_key_expires_at
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :license_key_status
-
-          sig { returns(T.nilable(T.anything)) }
-          attr_reader :metadata
-
-          sig { params(metadata: T.anything).void }
-          attr_writer :metadata
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :oauth_expires_at
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :oauth_url
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :payment_id
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :revocation_reason
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :revoked_at
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :subscription_id
-
           sig do
             params(
-              id: String,
-              business_id: String,
-              created_at: Time,
-              customer_id: String,
-              entitlement_id: String,
-              external_id: String,
               payload_type:
-                Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol,
-              status:
-                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::OrSymbol,
-              updated_at: Time,
-              delivered_at: T.nilable(Time),
-              error_code: T.nilable(String),
-              error_message: T.nilable(String),
-              license_key: T.nilable(String),
-              license_key_activations_limit: T.nilable(Integer),
-              license_key_activations_used: T.nilable(Integer),
-              license_key_expires_at: T.nilable(Time),
-              license_key_status: T.nilable(String),
-              metadata: T.anything,
-              oauth_expires_at: T.nilable(Time),
-              oauth_url: T.nilable(String),
-              payment_id: T.nilable(String),
-              revocation_reason: T.nilable(String),
-              revoked_at: T.nilable(Time),
-              subscription_id: T.nilable(String)
+                Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol
             ).returns(T.attached_class)
           end
-          def self.new(
-            id:,
-            business_id:,
-            created_at:,
-            customer_id:,
-            entitlement_id:,
-            external_id:,
-            payload_type:,
-            status:,
-            updated_at:,
-            delivered_at: nil,
-            error_code: nil,
-            error_message: nil,
-            license_key: nil,
-            license_key_activations_limit: nil,
-            license_key_activations_used: nil,
-            license_key_expires_at: nil,
-            license_key_status: nil,
-            metadata: nil,
-            oauth_expires_at: nil,
-            oauth_url: nil,
-            payment_id: nil,
-            revocation_reason: nil,
-            revoked_at: nil,
-            subscription_id: nil
-          )
+          def self.new(payload_type:)
           end
 
           sig do
             override.returns(
               {
-                id: String,
-                business_id: String,
-                created_at: Time,
-                customer_id: String,
-                entitlement_id: String,
-                external_id: String,
                 payload_type:
-                  Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol,
-                status:
-                  Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::OrSymbol,
-                updated_at: Time,
-                delivered_at: T.nilable(Time),
-                error_code: T.nilable(String),
-                error_message: T.nilable(String),
-                license_key: T.nilable(String),
-                license_key_activations_limit: T.nilable(Integer),
-                license_key_activations_used: T.nilable(Integer),
-                license_key_expires_at: T.nilable(Time),
-                license_key_status: T.nilable(String),
-                metadata: T.anything,
-                oauth_expires_at: T.nilable(Time),
-                oauth_url: T.nilable(String),
-                payment_id: T.nilable(String),
-                revocation_reason: T.nilable(String),
-                revoked_at: T.nilable(Time),
-                subscription_id: T.nilable(String)
+                  Dodopayments::WebhookPayload::Data::EntitlementGrant::PayloadType::OrSymbol
               }
             )
           end
@@ -1231,50 +1082,6 @@ module Dodopayments
             def self.values
             end
           end
-
-          module Status
-            extend Dodopayments::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  Dodopayments::WebhookPayload::Data::EntitlementGrant::Status
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            PENDING =
-              T.let(
-                :Pending,
-                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
-              )
-            DELIVERED =
-              T.let(
-                :Delivered,
-                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
-              )
-            FAILED =
-              T.let(
-                :Failed,
-                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
-              )
-            REVOKED =
-              T.let(
-                :Revoked,
-                Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Dodopayments::WebhookPayload::Data::EntitlementGrant::Status::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
         end
 
         sig do

data/rbi/dodopayments/models.rbi

@@ -29,6 +29,8 @@ module Dodopayments
 
   AttachExistingCustomer = Dodopayments::Models::AttachExistingCustomer
 
+  AttachProductEntitlement = Dodopayments::Models::AttachProductEntitlement
+
   BalanceLedgerEntry = Dodopayments::Models::BalanceLedgerEntry
 
   BalanceRetrieveLedgerParams =
@@ -48,6 +50,8 @@ module Dodopayments
 
   BrandUpdateParams = Dodopayments::Models::BrandUpdateParams
 
+  CancellationFeedback = Dodopayments::Models::CancellationFeedback
+
   CbbOverageBehavior = Dodopayments::Models::CbbOverageBehavior
 
   CbbProrationBehavior = Dodopayments::Models::CbbProrationBehavior
@@ -124,6 +128,9 @@ module Dodopayments
   CreditOverageChargedWebhookEvent =
     Dodopayments::Models::CreditOverageChargedWebhookEvent
 
+  CreditOverageResetWebhookEvent =
+    Dodopayments::Models::CreditOverageResetWebhookEvent
+
   CreditRolledOverWebhookEvent =
     Dodopayments::Models::CreditRolledOverWebhookEvent
 
@@ -144,6 +151,9 @@ module Dodopayments
   CustomerListCreditEntitlementsParams =
     Dodopayments::Models::CustomerListCreditEntitlementsParams
 
+  CustomerListEntitlementsParams =
+    Dodopayments::Models::CustomerListEntitlementsParams
+
   CustomerListParams = Dodopayments::Models::CustomerListParams
 
   CustomerPortalSession = Dodopayments::Models::CustomerPortalSession
@@ -216,6 +226,34 @@ module Dodopayments
 
   DunningStartedWebhookEvent = Dodopayments::Models::DunningStartedWebhookEvent
 
+  Entitlement = Dodopayments::Models::Entitlement
+
+  EntitlementCreateParams = Dodopayments::Models::EntitlementCreateParams
+
+  EntitlementDeleteParams = Dodopayments::Models::EntitlementDeleteParams
+
+  EntitlementGrantCreatedWebhookEvent =
+    Dodopayments::Models::EntitlementGrantCreatedWebhookEvent
+
+  EntitlementGrantDeliveredWebhookEvent =
+    Dodopayments::Models::EntitlementGrantDeliveredWebhookEvent
+
+  EntitlementGrantFailedWebhookEvent =
+    Dodopayments::Models::EntitlementGrantFailedWebhookEvent
+
+  EntitlementGrantRevokedWebhookEvent =
+    Dodopayments::Models::EntitlementGrantRevokedWebhookEvent
+
+  EntitlementIntegrationType = Dodopayments::Models::EntitlementIntegrationType
+
+  EntitlementListParams = Dodopayments::Models::EntitlementListParams
+
+  EntitlementRetrieveParams = Dodopayments::Models::EntitlementRetrieveParams
+
+  Entitlements = Dodopayments::Models::Entitlements
+
+  EntitlementUpdateParams = Dodopayments::Models::EntitlementUpdateParams
+
   Event = Dodopayments::Models::Event
 
   EventInput = Dodopayments::Models::EventInput
@@ -224,6 +262,10 @@ module Dodopayments
 
   GetDispute = Dodopayments::Models::GetDispute
 
+  IntegrationConfig = Dodopayments::Models::IntegrationConfig
+
+  IntegrationConfigResponse = Dodopayments::Models::IntegrationConfigResponse
+
   IntentStatus = Dodopayments::Models::IntentStatus
 
   Invoices = Dodopayments::Models::Invoices
@@ -330,6 +372,8 @@ module Dodopayments
 
   ProductCreateParams = Dodopayments::Models::ProductCreateParams
 
+  ProductEntitlementSummary = Dodopayments::Models::ProductEntitlementSummary
+
   ProductItemReq = Dodopayments::Models::ProductItemReq
 
   ProductListParams = Dodopayments::Models::ProductListParams
@@ -361,6 +405,8 @@ module Dodopayments
   RefundSucceededWebhookEvent =
     Dodopayments::Models::RefundSucceededWebhookEvent
 
+  ScheduledPlanChange = Dodopayments::Models::ScheduledPlanChange
+
   Subscription = Dodopayments::Models::Subscription
 
   SubscriptionActiveWebhookEvent =