dodopayments 2.4.1 → 2.6.0

data/rbi/dodopayments/models/abandoned_checkout_recovered_webhook_event.rbi

@@ -0,0 +1,273 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class AbandonedCheckoutRecoveredWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Webhook payload for abandoned_checkout.detected and abandoned_checkout.recovered
+      # events
+      sig do
+        returns(Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data)
+      end
+      attr_reader :data
+
+      sig do
+        params(
+          data:
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig do
+        returns(
+          Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Type::TaggedSymbol
+        )
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data:
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type:
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Webhook payload for abandoned_checkout.detected and abandoned_checkout.recovered
+        # events
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data,
+            timestamp: Time,
+            type:
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Time) }
+        attr_accessor :abandoned_at
+
+        sig do
+          returns(
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::TaggedSymbol
+          )
+        end
+        attr_accessor :abandonment_reason
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig { returns(String) }
+        attr_accessor :payment_id
+
+        sig do
+          returns(
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :recovered_payment_id
+
+        # Webhook payload for abandoned_checkout.detected and abandoned_checkout.recovered
+        # events
+        sig do
+          params(
+            abandoned_at: Time,
+            abandonment_reason:
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::OrSymbol,
+            customer_id: String,
+            payment_id: String,
+            status:
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::OrSymbol,
+            recovered_payment_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          abandoned_at:,
+          abandonment_reason:,
+          customer_id:,
+          payment_id:,
+          status:,
+          recovered_payment_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              abandoned_at: Time,
+              abandonment_reason:
+                Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::TaggedSymbol,
+              customer_id: String,
+              payment_id: String,
+              status:
+                Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol,
+              recovered_payment_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module AbandonmentReason
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PAYMENT_FAILED =
+            T.let(
+              :payment_failed,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::TaggedSymbol
+            )
+          CHECKOUT_INCOMPLETE =
+            T.let(
+              :checkout_incomplete,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::AbandonmentReason::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ABANDONED =
+            T.let(
+              :abandoned,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+          RECOVERING =
+            T.let(
+              :recovering,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+          RECOVERED =
+            T.let(
+              :recovered,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+          EXHAUSTED =
+            T.let(
+              :exhausted,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+          OPTED_OUT =
+            T.let(
+              :opted_out,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # The event type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(
+              Symbol,
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Type
+            )
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        ABANDONED_CHECKOUT_RECOVERED =
+          T.let(
+            :"abandoned_checkout.recovered",
+            Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::AbandonedCheckoutRecoveredWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/balance_ledger_entry.rbi

@@ -197,6 +197,16 @@ module Dodopayments
             :currency_conversion,
             Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
           )
+        ABANDONED_CART_RECOVERY_FEE =
+          T.let(
+            :abandoned_cart_recovery_fee,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
+        DUNNING_FEES =
+          T.let(
+            :dunning_fees,
+            Dodopayments::BalanceLedgerEntry::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/balance_retrieve_ledger_params.rbi

@@ -995,6 +995,16 @@ module Dodopayments
             :currency_conversion,
             Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
           )
+        ABANDONED_CART_RECOVERY_FEE =
+          T.let(
+            :abandoned_cart_recovery_fee,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
+        DUNNING_FEES =
+          T.let(
+            :dunning_fees,
+            Dodopayments::BalanceRetrieveLedgerParams::EventType::TaggedSymbol
+          )
 
         sig do
           override.returns(

data/rbi/dodopayments/models/discount.rbi

@@ -32,6 +32,9 @@ module Dodopayments
       sig { returns(String) }
       attr_accessor :discount_id
 
+      sig { returns(T::Hash[Symbol, String]) }
+      attr_accessor :metadata
+
       # Whether this discount should be preserved when a subscription changes plans.
       # Default: false (discount is removed on plan change)
       sig { returns(T::Boolean) }
@@ -74,6 +77,7 @@ module Dodopayments
           code: String,
           created_at: Time,
           discount_id: String,
+          metadata: T::Hash[Symbol, String],
           preserve_on_plan_change: T::Boolean,
           restricted_to: T::Array[String],
           times_used: Integer,
@@ -99,6 +103,7 @@ module Dodopayments
         created_at:,
         # The unique discount ID
         discount_id:,
+        metadata:,
         # Whether this discount should be preserved when a subscription changes plans.
         # Default: false (discount is removed on plan change)
         preserve_on_plan_change:,
@@ -129,6 +134,7 @@ module Dodopayments
             code: String,
             created_at: Time,
             discount_id: String,
+            metadata: T::Hash[Symbol, String],
             preserve_on_plan_change: T::Boolean,
             restricted_to: T::Array[String],
             times_used: Integer,

data/rbi/dodopayments/models/discount_create_params.rbi

@@ -40,6 +40,13 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
+      # Additional metadata for the discount
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_reader :metadata
+
+      sig { params(metadata: T::Hash[Symbol, String]).void }
+      attr_writer :metadata
+
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
@@ -71,6 +78,7 @@ module Dodopayments
           type: Dodopayments::DiscountType::OrSymbol,
           code: T.nilable(String),
           expires_at: T.nilable(Time),
+          metadata: T::Hash[Symbol, String],
           name: T.nilable(String),
           preserve_on_plan_change: T::Boolean,
           restricted_to: T.nilable(T::Array[String]),
@@ -98,6 +106,8 @@ module Dodopayments
         code: nil,
         # When the discount expires, if ever.
         expires_at: nil,
+        # Additional metadata for the discount
+        metadata: nil,
         name: nil,
         # Whether this discount should be preserved when a subscription changes plans.
         # Default: false (discount is removed on plan change)
@@ -121,6 +131,7 @@ module Dodopayments
             type: Dodopayments::DiscountType::OrSymbol,
             code: T.nilable(String),
             expires_at: T.nilable(Time),
+            metadata: T::Hash[Symbol, String],
             name: T.nilable(String),
             preserve_on_plan_change: T::Boolean,
             restricted_to: T.nilable(T::Array[String]),

data/rbi/dodopayments/models/discount_update_params.rbi

@@ -34,6 +34,10 @@ module Dodopayments
       sig { returns(T.nilable(Time)) }
       attr_accessor :expires_at
 
+      # Additional metadata for the discount
+      sig { returns(T.nilable(T::Hash[Symbol, String])) }
+      attr_accessor :metadata
+
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
@@ -66,6 +70,7 @@ module Dodopayments
           amount: T.nilable(Integer),
           code: T.nilable(String),
           expires_at: T.nilable(Time),
+          metadata: T.nilable(T::Hash[Symbol, String]),
           name: T.nilable(String),
           preserve_on_plan_change: T.nilable(T::Boolean),
           restricted_to: T.nilable(T::Array[String]),
@@ -88,6 +93,8 @@ module Dodopayments
         # If present, update the discount code (uppercase).
         code: nil,
         expires_at: nil,
+        # Additional metadata for the discount
+        metadata: nil,
         name: nil,
         # Whether this discount should be preserved when a subscription changes plans. If
         # not provided, the existing value is kept.
@@ -113,6 +120,7 @@ module Dodopayments
             amount: T.nilable(Integer),
             code: T.nilable(String),
             expires_at: T.nilable(Time),
+            metadata: T.nilable(T::Hash[Symbol, String]),
             name: T.nilable(String),
             preserve_on_plan_change: T.nilable(T::Boolean),
             restricted_to: T.nilable(T::Array[String]),

data/rbi/dodopayments/models/dunning_recovered_webhook_event.rbi

@@ -0,0 +1,249 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class DunningRecoveredWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::DunningRecoveredWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      # Webhook payload for dunning.started and dunning.recovered events
+      sig { returns(Dodopayments::DunningRecoveredWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Dodopayments::DunningRecoveredWebhookEvent::Data::OrHash
+        ).void
+      end
+      attr_writer :data
+
+      # The timestamp of when the event occurred
+      sig { returns(Time) }
+      attr_accessor :timestamp
+
+      # The event type
+      sig do
+        returns(Dodopayments::DunningRecoveredWebhookEvent::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::DunningRecoveredWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Dodopayments::DunningRecoveredWebhookEvent::Type::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        # Webhook payload for dunning.started and dunning.recovered events
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::DunningRecoveredWebhookEvent::Data,
+            timestamp: Time,
+            type: Dodopayments::DunningRecoveredWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::DunningRecoveredWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            Dodopayments::DunningRecoveredWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(String) }
+        attr_accessor :subscription_id
+
+        sig do
+          returns(
+            Dodopayments::DunningRecoveredWebhookEvent::Data::TriggerState::TaggedSymbol
+          )
+        end
+        attr_accessor :trigger_state
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payment_id
+
+        # Webhook payload for dunning.started and dunning.recovered events
+        sig do
+          params(
+            created_at: Time,
+            customer_id: String,
+            status:
+              Dodopayments::DunningRecoveredWebhookEvent::Data::Status::OrSymbol,
+            subscription_id: String,
+            trigger_state:
+              Dodopayments::DunningRecoveredWebhookEvent::Data::TriggerState::OrSymbol,
+            payment_id: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          created_at:,
+          customer_id:,
+          status:,
+          subscription_id:,
+          trigger_state:,
+          payment_id: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              created_at: Time,
+              customer_id: String,
+              status:
+                Dodopayments::DunningRecoveredWebhookEvent::Data::Status::TaggedSymbol,
+              subscription_id: String,
+              trigger_state:
+                Dodopayments::DunningRecoveredWebhookEvent::Data::TriggerState::TaggedSymbol,
+              payment_id: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::DunningRecoveredWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          RECOVERING =
+            T.let(
+              :recovering,
+              Dodopayments::DunningRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+          RECOVERED =
+            T.let(
+              :recovered,
+              Dodopayments::DunningRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+          EXHAUSTED =
+            T.let(
+              :exhausted,
+              Dodopayments::DunningRecoveredWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::DunningRecoveredWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        module TriggerState
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::DunningRecoveredWebhookEvent::Data::TriggerState
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ON_HOLD =
+            T.let(
+              :on_hold,
+              Dodopayments::DunningRecoveredWebhookEvent::Data::TriggerState::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              Dodopayments::DunningRecoveredWebhookEvent::Data::TriggerState::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::DunningRecoveredWebhookEvent::Data::TriggerState::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
+      # The event type
+      module Type
+        extend Dodopayments::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias do
+            T.all(Symbol, Dodopayments::DunningRecoveredWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DUNNING_RECOVERED =
+          T.let(
+            :"dunning.recovered",
+            Dodopayments::DunningRecoveredWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::DunningRecoveredWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end