dodopayments 2.26.0 → 2.28.0

data/rbi/dodopayments/models/subscription_unpaused_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::SubscriptionUnpausedWebhookEvent::Data) }
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data: Dodopayments::SubscriptionUnpausedWebhookEvent::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::SubscriptionUnpausedWebhookEvent::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::SubscriptionUnpausedWebhookEvent::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::SubscriptionUnpausedWebhookEvent::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_update_params.rbi

@@ -289,6 +289,11 @@ module Dodopayments
             :cancelled_by_merchant_send_dunning,
             Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
           )
+        CANCELLED_BY_MERCHANT_GRACE_PERIOD_EXPIRED =
+          T.let(
+            :cancelled_by_merchant_grace_period_expired,
+            Dodopayments::SubscriptionUpdateParams::CancelReason::TaggedSymbol
+          )
         DODO_TEAM =
           T.let(
             :dodo_team,

data/rbi/dodopayments/models/subscription_update_payment_method_webhook_event.rbi

@@ -15,11 +15,19 @@ 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 do
+        returns(Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent::Data)
+      end
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data:
+            Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent::Data::OrHash
+        ).void
+      end
       attr_writer :data
 
       # The timestamp of when the event occurred
@@ -33,7 +41,8 @@ module Dodopayments
       sig do
         params(
           business_id: String,
-          data: Dodopayments::Subscription::OrHash,
+          data:
+            Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent::Data::OrHash,
           timestamp: Time,
           type: Symbol
         ).returns(T.attached_class)
@@ -41,7 +50,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 +64,8 @@ module Dodopayments
         override.returns(
           {
             business_id: String,
-            data: Dodopayments::Subscription,
+            data:
+              Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent::Data,
             timestamp: Time,
             type: Symbol
           }
@@ -62,6 +73,47 @@ module Dodopayments
       end
       def to_hash
       end
+
+      class Data < Dodopayments::Models::Subscription
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::SubscriptionUpdatePaymentMethodWebhookEvent::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_updated_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::SubscriptionUpdatedWebhookEvent::Data) }
       attr_reader :data
 
-      sig { params(data: Dodopayments::Subscription::OrHash).void }
+      sig do
+        params(
+          data: Dodopayments::SubscriptionUpdatedWebhookEvent::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::SubscriptionUpdatedWebhookEvent::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::SubscriptionUpdatedWebhookEvent::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::SubscriptionUpdatedWebhookEvent::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/unsafe_unwrap_webhook_event.rbi

@@ -49,6 +49,7 @@ module Dodopayments
             Dodopayments::SubscriptionExpiredWebhookEvent,
             Dodopayments::SubscriptionFailedWebhookEvent,
             Dodopayments::SubscriptionOnHoldWebhookEvent,
+            Dodopayments::SubscriptionPastDueWebhookEvent,
             Dodopayments::SubscriptionPausedWebhookEvent,
             Dodopayments::SubscriptionPlanChangedWebhookEvent,
             Dodopayments::SubscriptionRenewedWebhookEvent,

data/rbi/dodopayments/models/unwrap_webhook_event.rbi

@@ -49,6 +49,7 @@ module Dodopayments
             Dodopayments::SubscriptionExpiredWebhookEvent,
             Dodopayments::SubscriptionFailedWebhookEvent,
             Dodopayments::SubscriptionOnHoldWebhookEvent,
+            Dodopayments::SubscriptionPastDueWebhookEvent,
             Dodopayments::SubscriptionPausedWebhookEvent,
             Dodopayments::SubscriptionPlanChangedWebhookEvent,
             Dodopayments::SubscriptionRenewedWebhookEvent,

data/rbi/dodopayments/models/webhook_event_type.rbi

@@ -66,6 +66,11 @@ module Dodopayments
           :"subscription.on_hold",
           Dodopayments::WebhookEventType::TaggedSymbol
         )
+      SUBSCRIPTION_PAST_DUE =
+        T.let(
+          :"subscription.past_due",
+          Dodopayments::WebhookEventType::TaggedSymbol
+        )
       SUBSCRIPTION_PAUSED =
         T.let(
           :"subscription.paused",

data/rbi/dodopayments/models/webhook_payload.rbi

@@ -153,12 +153,41 @@ module Dodopayments
           sig { returns(Symbol) }
           attr_accessor :payload_type
 
+          # 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
+
           # Response struct representing subscription details
-          sig { params(payload_type: Symbol).returns(T.attached_class) }
-          def self.new(payload_type: :Subscription)
+          sig do
+            params(
+              past_due_ends_at: T.nilable(Time),
+              payload_type: Symbol
+            ).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,
+            payload_type: :Subscription
+          )
           end
 
-          sig { override.returns({ payload_type: Symbol }) }
+          sig do
+            override.returns(
+              { payload_type: Symbol, past_due_ends_at: T.nilable(Time) }
+            )
+          end
           def to_hash
           end
         end
@@ -867,6 +896,11 @@ module Dodopayments
                 :cancelled,
                 Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::TaggedSymbol
               )
+            PAST_DUE =
+              T.let(
+                :past_due,
+                Dodopayments::WebhookPayload::Data::DunningAttempt::TriggerState::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/dodopayments/models.rbi

@@ -38,6 +38,8 @@ module Dodopayments
 
   BillingAddress = Dodopayments::Models::BillingAddress
 
+  Blocklist = Dodopayments::Models::Blocklist
+
   Brand = Dodopayments::Models::Brand
 
   BrandArchiveParams = Dodopayments::Models::BrandArchiveParams
@@ -319,6 +321,10 @@ module Dodopayments
 
   LicenseValidateParams = Dodopayments::Models::LicenseValidateParams
 
+  ManualRetry = Dodopayments::Models::ManualRetry
+
+  ManualRetryState = Dodopayments::Models::ManualRetryState
+
   Metadata =
     T.let(
       Dodopayments::Models::Metadata,
@@ -380,6 +386,11 @@ module Dodopayments
 
   PaymentRetrieveParams = Dodopayments::Models::PaymentRetrieveParams
 
+  PaymentRetrieveRetryStateParams =
+    Dodopayments::Models::PaymentRetrieveRetryStateParams
+
+  PaymentRetryParams = Dodopayments::Models::PaymentRetryParams
+
   PaymentSucceededWebhookEvent =
     Dodopayments::Models::PaymentSucceededWebhookEvent
 
@@ -497,6 +508,9 @@ module Dodopayments
   SubscriptionOnHoldWebhookEvent =
     Dodopayments::Models::SubscriptionOnHoldWebhookEvent
 
+  SubscriptionPastDueWebhookEvent =
+    Dodopayments::Models::SubscriptionPastDueWebhookEvent
+
   SubscriptionPausedWebhookEvent =
     Dodopayments::Models::SubscriptionPausedWebhookEvent
 

data/rbi/dodopayments/resources/blocklist/customers/notes.rbi

@@ -0,0 +1,50 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Blocklist
+      class Customers
+        class Notes
+          sig do
+            params(
+              entry_id: String,
+              note: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(Dodopayments::Blocklist::Customers::BlockedCustomerNote)
+          end
+          def create(
+            # Blocklist entry id
+            entry_id,
+            note:,
+            request_options: {}
+          )
+          end
+
+          sig do
+            params(
+              note_id: String,
+              entry_id: String,
+              note: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(Dodopayments::Blocklist::Customers::BlockedCustomerNote)
+          end
+          def update(
+            # Path param: Note id
+            note_id,
+            # Path param: Blocklist entry id
+            entry_id:,
+            # Body param
+            note:,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/blocklist/customers.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Blocklist
+      class Customers
+        sig { returns(Dodopayments::Resources::Blocklist::Customers::Notes) }
+        attr_reader :notes
+
+        sig do
+          params(
+            create_blocked_customer_request:
+              T.any(
+                Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByCustomerID::OrHash,
+                Dodopayments::Blocklist::CreateBlockedCustomerRequest::BlocklistCustomersBlockByEmail::OrHash
+              ),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Blocklist::BlockedCustomer)
+        end
+        def create(create_blocked_customer_request:, request_options: {})
+        end
+
+        sig do
+          params(
+            entry_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Blocklist::BlockedCustomer)
+        end
+        def retrieve(
+          # Blocklist entry id
+          entry_id,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            blocked_by_email: T.nilable(String),
+            created_at_gte: T.nilable(Time),
+            created_at_lte: T.nilable(Time),
+            identifier: T.nilable(String),
+            page_number: T.nilable(Integer),
+            page_size: T.nilable(Integer),
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::Internal::DefaultPageNumberPagination[
+              Dodopayments::Blocklist::BlockedCustomer
+            ]
+          )
+        end
+        def list(
+          # Filter by the dashboard user who blocked the customer.
+          blocked_by_email: nil,
+          # Blocked on or after this time.
+          created_at_gte: nil,
+          # Blocked on or before this time.
+          created_at_lte: nil,
+          # Partial, case-insensitive match on the email and on the customer id.
+          identifier: nil,
+          # Page number. Default 0.
+          page_number: nil,
+          # Page size. Default 10, maximum 100.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          params(
+            entry_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).void
+        end
+        def delete(
+          # Blocklist entry id
+          entry_id,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/blocklist.rbi

@@ -0,0 +1,15 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Blocklist
+      sig { returns(Dodopayments::Resources::Blocklist::Customers) }
+      attr_reader :customers
+
+      # @api private
+      sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/credit_entitlements/balances.rbi

@@ -104,6 +104,7 @@ module Dodopayments
         # - `reason` - Optional human-readable reason
         # - `expires_at` - Optional expiration for credited amount (only for credit type)
         # - `idempotency_key` - Optional key to prevent duplicate entries
+        # - `metadata` - Optional key-value pairs
         #
         # # Responses
         #
@@ -145,7 +146,7 @@ module Dodopayments
           # Body param: Idempotency key to prevent duplicate entries
           idempotency_key: nil,
           # Body param: Optional metadata (max 50 key-value pairs, key max 40 chars, value
-          # max 500 chars)
+          # max 500 chars).
           metadata: nil,
           # Body param: Human-readable reason for the entry
           reason: nil,

data/rbi/dodopayments/resources/customers/emails.rbi

@@ -0,0 +1,60 @@
+# typed: strong
+
+module Dodopayments
+  module Resources
+    class Customers
+      class Emails
+        # Returns every transactional email sent to this customer in the last 180 days,
+        # newest first, with its delivery outcome. Delivery status comes from the email
+        # provider and is as fresh as replication, typically seconds.
+        sig do
+          params(
+            customer_id: String,
+            page_number: Integer,
+            page_size: Integer,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(
+            Dodopayments::Internal::DefaultPageNumberPagination[
+              Dodopayments::Customers::EmailLogItem
+            ]
+          )
+        end
+        def list(
+          # The customer's id
+          customer_id,
+          # Which page to return. The default is 0.
+          page_number: nil,
+          # How many emails to return. The default is 10 and the maximum is 100.
+          page_size: nil,
+          request_options: {}
+        )
+        end
+
+        # Returns the email exactly as it was sent, plus the reason it failed when it did.
+        # Some emails have no body to show: an authentication email carries a live login
+        # token, a blocked email never reached the provider, and the provider clears
+        # bodies at 180 days.
+        sig do
+          params(
+            email_log_id: String,
+            customer_id: String,
+            request_options: Dodopayments::RequestOptions::OrHash
+          ).returns(Dodopayments::Customers::EmailBody)
+        end
+        def retrieve_body(
+          # The email log entry's id
+          email_log_id,
+          # The customer's id
+          customer_id:,
+          request_options: {}
+        )
+        end
+
+        # @api private
+        sig { params(client: Dodopayments::Client).returns(T.attached_class) }
+        def self.new(client:)
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/resources/customers.rbi

@@ -9,6 +9,9 @@ module Dodopayments
       sig { returns(Dodopayments::Resources::Customers::Wallets) }
       attr_reader :wallets
 
+      sig { returns(Dodopayments::Resources::Customers::Emails) }
+      attr_reader :emails
+
       sig do
         params(
           email: String,