dodopayments 2.26.0 → 2.27.0

data/rbi/dodopayments/models/subscription_active_webhook_event.rbi

@@ -15,11 +15,16 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :business_id
 
-      # Response struct representing subscription details
-      sig { returns(Dodopayments::Subscription) }
+      # Subscription payload sent on a webhook. It carries every field of
+      # `SubscriptionResponse`, plus the grace-period deadline.
+      sig { returns(Dodopayments::SubscriptionActiveWebhookEvent::Data) }
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data: Dodopayments::SubscriptionActiveWebhookEvent::Data::OrHash
+        ).void
+      end
       attr_writer :data
 
       # The timestamp of when the event occurred
@@ -33,7 +38,7 @@ module Dodopayments
       sig do
         params(
           business_id: String,
-          data: Dodopayments::Subscription::OrHash,
+          data: Dodopayments::SubscriptionActiveWebhookEvent::Data::OrHash,
           timestamp: Time,
           type: Symbol
         ).returns(T.attached_class)
@@ -41,7 +46,8 @@ module Dodopayments
       def self.new(
         # The business identifier
         business_id:,
-        # Response struct representing subscription details
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
         data:,
         # The timestamp of when the event occurred
         timestamp:,
@@ -54,7 +60,7 @@ module Dodopayments
         override.returns(
           {
             business_id: String,
-            data: Dodopayments::Subscription,
+            data: Dodopayments::SubscriptionActiveWebhookEvent::Data,
             timestamp: Time,
             type: Symbol
           }
@@ -62,6 +68,47 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class Data < Dodopayments::Models::Subscription
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionActiveWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Time when the grace period ends. The subscription moves to `on_hold` or to
+        # `cancelled` at this time.
+        #
+        # Read in the same query as the rest of the payload, so it always comes from the
+        # row snapshot that produced `status`. It is set whenever the subscription sits in
+        # a window at that moment. A delayed event of another type therefore carries the
+        # deadline too, next to a `past_due` status.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :past_due_ends_at
+
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
+        sig do
+          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+        end
+        def self.new(
+          # Time when the grace period ends. The subscription moves to `on_hold` or to
+          # `cancelled` at this time.
+          #
+          # Read in the same query as the rest of the payload, so it always comes from the
+          # row snapshot that produced `status`. It is set whenever the subscription sits in
+          # a window at that moment. A delayed event of another type therefore carries the
+          # deadline too, next to a `past_due` status.
+          past_due_ends_at: nil
+        )
+        end
+
+        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_cancelled_webhook_event.rbi

@@ -15,11 +15,16 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :business_id
 
-      # Response struct representing subscription details
-      sig { returns(Dodopayments::Subscription) }
+      # Subscription payload sent on a webhook. It carries every field of
+      # `SubscriptionResponse`, plus the grace-period deadline.
+      sig { returns(Dodopayments::SubscriptionCancelledWebhookEvent::Data) }
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data: Dodopayments::SubscriptionCancelledWebhookEvent::Data::OrHash
+        ).void
+      end
       attr_writer :data
 
       # The timestamp of when the event occurred
@@ -33,7 +38,7 @@ module Dodopayments
       sig do
         params(
           business_id: String,
-          data: Dodopayments::Subscription::OrHash,
+          data: Dodopayments::SubscriptionCancelledWebhookEvent::Data::OrHash,
           timestamp: Time,
           type: Symbol
         ).returns(T.attached_class)
@@ -41,7 +46,8 @@ module Dodopayments
       def self.new(
         # The business identifier
         business_id:,
-        # Response struct representing subscription details
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
         data:,
         # The timestamp of when the event occurred
         timestamp:,
@@ -54,7 +60,7 @@ module Dodopayments
         override.returns(
           {
             business_id: String,
-            data: Dodopayments::Subscription,
+            data: Dodopayments::SubscriptionCancelledWebhookEvent::Data,
             timestamp: Time,
             type: Symbol
           }
@@ -62,6 +68,47 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class Data < Dodopayments::Models::Subscription
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionCancelledWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Time when the grace period ends. The subscription moves to `on_hold` or to
+        # `cancelled` at this time.
+        #
+        # Read in the same query as the rest of the payload, so it always comes from the
+        # row snapshot that produced `status`. It is set whenever the subscription sits in
+        # a window at that moment. A delayed event of another type therefore carries the
+        # deadline too, next to a `past_due` status.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :past_due_ends_at
+
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
+        sig do
+          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+        end
+        def self.new(
+          # Time when the grace period ends. The subscription moves to `on_hold` or to
+          # `cancelled` at this time.
+          #
+          # Read in the same query as the rest of the payload, so it always comes from the
+          # row snapshot that produced `status`. It is set whenever the subscription sits in
+          # a window at that moment. A delayed event of another type therefore carries the
+          # deadline too, next to a `past_due` status.
+          past_due_ends_at: nil
+        )
+        end
+
+        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_expired_webhook_event.rbi

@@ -15,11 +15,16 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :business_id
 
-      # Response struct representing subscription details
-      sig { returns(Dodopayments::Subscription) }
+      # Subscription payload sent on a webhook. It carries every field of
+      # `SubscriptionResponse`, plus the grace-period deadline.
+      sig { returns(Dodopayments::SubscriptionExpiredWebhookEvent::Data) }
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data: Dodopayments::SubscriptionExpiredWebhookEvent::Data::OrHash
+        ).void
+      end
       attr_writer :data
 
       # The timestamp of when the event occurred
@@ -33,7 +38,7 @@ module Dodopayments
       sig do
         params(
           business_id: String,
-          data: Dodopayments::Subscription::OrHash,
+          data: Dodopayments::SubscriptionExpiredWebhookEvent::Data::OrHash,
           timestamp: Time,
           type: Symbol
         ).returns(T.attached_class)
@@ -41,7 +46,8 @@ module Dodopayments
       def self.new(
         # The business identifier
         business_id:,
-        # Response struct representing subscription details
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
         data:,
         # The timestamp of when the event occurred
         timestamp:,
@@ -54,7 +60,7 @@ module Dodopayments
         override.returns(
           {
             business_id: String,
-            data: Dodopayments::Subscription,
+            data: Dodopayments::SubscriptionExpiredWebhookEvent::Data,
             timestamp: Time,
             type: Symbol
           }
@@ -62,6 +68,47 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class Data < Dodopayments::Models::Subscription
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionExpiredWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Time when the grace period ends. The subscription moves to `on_hold` or to
+        # `cancelled` at this time.
+        #
+        # Read in the same query as the rest of the payload, so it always comes from the
+        # row snapshot that produced `status`. It is set whenever the subscription sits in
+        # a window at that moment. A delayed event of another type therefore carries the
+        # deadline too, next to a `past_due` status.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :past_due_ends_at
+
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
+        sig do
+          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+        end
+        def self.new(
+          # Time when the grace period ends. The subscription moves to `on_hold` or to
+          # `cancelled` at this time.
+          #
+          # Read in the same query as the rest of the payload, so it always comes from the
+          # row snapshot that produced `status`. It is set whenever the subscription sits in
+          # a window at that moment. A delayed event of another type therefore carries the
+          # deadline too, next to a `past_due` status.
+          past_due_ends_at: nil
+        )
+        end
+
+        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_failed_webhook_event.rbi

@@ -15,11 +15,16 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :business_id
 
-      # Response struct representing subscription details
-      sig { returns(Dodopayments::Subscription) }
+      # Subscription payload sent on a webhook. It carries every field of
+      # `SubscriptionResponse`, plus the grace-period deadline.
+      sig { returns(Dodopayments::SubscriptionFailedWebhookEvent::Data) }
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data: Dodopayments::SubscriptionFailedWebhookEvent::Data::OrHash
+        ).void
+      end
       attr_writer :data
 
       # The timestamp of when the event occurred
@@ -33,7 +38,7 @@ module Dodopayments
       sig do
         params(
           business_id: String,
-          data: Dodopayments::Subscription::OrHash,
+          data: Dodopayments::SubscriptionFailedWebhookEvent::Data::OrHash,
           timestamp: Time,
           type: Symbol
         ).returns(T.attached_class)
@@ -41,7 +46,8 @@ module Dodopayments
       def self.new(
         # The business identifier
         business_id:,
-        # Response struct representing subscription details
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
         data:,
         # The timestamp of when the event occurred
         timestamp:,
@@ -54,7 +60,7 @@ module Dodopayments
         override.returns(
           {
             business_id: String,
-            data: Dodopayments::Subscription,
+            data: Dodopayments::SubscriptionFailedWebhookEvent::Data,
             timestamp: Time,
             type: Symbol
           }
@@ -62,6 +68,47 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class Data < Dodopayments::Models::Subscription
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionFailedWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Time when the grace period ends. The subscription moves to `on_hold` or to
+        # `cancelled` at this time.
+        #
+        # Read in the same query as the rest of the payload, so it always comes from the
+        # row snapshot that produced `status`. It is set whenever the subscription sits in
+        # a window at that moment. A delayed event of another type therefore carries the
+        # deadline too, next to a `past_due` status.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :past_due_ends_at
+
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
+        sig do
+          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+        end
+        def self.new(
+          # Time when the grace period ends. The subscription moves to `on_hold` or to
+          # `cancelled` at this time.
+          #
+          # Read in the same query as the rest of the payload, so it always comes from the
+          # row snapshot that produced `status`. It is set whenever the subscription sits in
+          # a window at that moment. A delayed event of another type therefore carries the
+          # deadline too, next to a `past_due` status.
+          past_due_ends_at: nil
+        )
+        end
+
+        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_list_params.rbi

@@ -186,6 +186,11 @@ module Dodopayments
             :expired,
             Dodopayments::SubscriptionListParams::Status::TaggedSymbol
           )
+        PAST_DUE =
+          T.let(
+            :past_due,
+            Dodopayments::SubscriptionListParams::Status::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/subscription_on_hold_webhook_event.rbi

@@ -15,11 +15,16 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :business_id
 
-      # Response struct representing subscription details
-      sig { returns(Dodopayments::Subscription) }
+      # Subscription payload sent on a webhook. It carries every field of
+      # `SubscriptionResponse`, plus the grace-period deadline.
+      sig { returns(Dodopayments::SubscriptionOnHoldWebhookEvent::Data) }
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data: Dodopayments::SubscriptionOnHoldWebhookEvent::Data::OrHash
+        ).void
+      end
       attr_writer :data
 
       # The timestamp of when the event occurred
@@ -33,7 +38,7 @@ module Dodopayments
       sig do
         params(
           business_id: String,
-          data: Dodopayments::Subscription::OrHash,
+          data: Dodopayments::SubscriptionOnHoldWebhookEvent::Data::OrHash,
           timestamp: Time,
           type: Symbol
         ).returns(T.attached_class)
@@ -41,7 +46,8 @@ module Dodopayments
       def self.new(
         # The business identifier
         business_id:,
-        # Response struct representing subscription details
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
         data:,
         # The timestamp of when the event occurred
         timestamp:,
@@ -54,7 +60,7 @@ module Dodopayments
         override.returns(
           {
             business_id: String,
-            data: Dodopayments::Subscription,
+            data: Dodopayments::SubscriptionOnHoldWebhookEvent::Data,
             timestamp: Time,
             type: Symbol
           }
@@ -62,6 +68,47 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class Data < Dodopayments::Models::Subscription
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionOnHoldWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Time when the grace period ends. The subscription moves to `on_hold` or to
+        # `cancelled` at this time.
+        #
+        # Read in the same query as the rest of the payload, so it always comes from the
+        # row snapshot that produced `status`. It is set whenever the subscription sits in
+        # a window at that moment. A delayed event of another type therefore carries the
+        # deadline too, next to a `past_due` status.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :past_due_ends_at
+
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
+        sig do
+          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+        end
+        def self.new(
+          # Time when the grace period ends. The subscription moves to `on_hold` or to
+          # `cancelled` at this time.
+          #
+          # Read in the same query as the rest of the payload, so it always comes from the
+          # row snapshot that produced `status`. It is set whenever the subscription sits in
+          # a window at that moment. A delayed event of another type therefore carries the
+          # deadline too, next to a `past_due` status.
+          past_due_ends_at: nil
+        )
+        end
+
+        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/dodopayments/models/subscription_past_due_webhook_event.rbi

@@ -0,0 +1,114 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class SubscriptionPastDueWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::SubscriptionPastDueWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Subscription payload sent on a webhook. It carries every field of
+      # `SubscriptionResponse`, plus the grace-period deadline.
+      sig { returns(Dodopayments::SubscriptionPastDueWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Dodopayments::SubscriptionPastDueWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig { returns(Symbol) }
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::SubscriptionPastDueWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type: :"subscription.past_due"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::SubscriptionPastDueWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Dodopayments::Models::Subscription
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionPastDueWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # Time when the grace period ends. The subscription moves to `on_hold` or to
+        # `cancelled` at this time.
+        #
+        # Read in the same query as the rest of the payload, so it always comes from the
+        # row snapshot that produced `status`. It is set whenever the subscription sits in
+        # a window at that moment. A delayed event of another type therefore carries the
+        # deadline too, next to a `past_due` status.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :past_due_ends_at
+
+        # Subscription payload sent on a webhook. It carries every field of
+        # `SubscriptionResponse`, plus the grace-period deadline.
+        sig do
+          params(past_due_ends_at: T.nilable(Time)).returns(T.attached_class)
+        end
+        def self.new(
+          # Time when the grace period ends. The subscription moves to `on_hold` or to
+          # `cancelled` at this time.
+          #
+          # Read in the same query as the rest of the payload, so it always comes from the
+          # row snapshot that produced `status`. It is set whenever the subscription sits in
+          # a window at that moment. A delayed event of another type therefore carries the
+          # deadline too, next to a `past_due` status.
+          past_due_ends_at: nil
+        )
+        end
+
+        sig { override.returns({ past_due_ends_at: T.nilable(Time) }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end