dodopayments 2.4.1 → 2.6.0

data/sig/dodopayments/models/payouts/breakup/detail_list_response.rbs

@@ -0,0 +1,64 @@
+module Dodopayments
+  module Models
+    module Payouts
+      module Breakup
+        type detail_list_response =
+          {
+            id: String,
+            created_at: Time,
+            event_type: String,
+            original_amount: Integer,
+            original_currency: String,
+            payout_currency_amount: Integer,
+            usd_equivalent_amount: Integer,
+            description: String?,
+            reference_object_id: String?
+          }
+
+        class DetailListResponse < Dodopayments::Internal::Type::BaseModel
+          attr_accessor id: String
+
+          attr_accessor created_at: Time
+
+          attr_accessor event_type: String
+
+          attr_accessor original_amount: Integer
+
+          attr_accessor original_currency: String
+
+          attr_accessor payout_currency_amount: Integer
+
+          attr_accessor usd_equivalent_amount: Integer
+
+          attr_accessor description: String?
+
+          attr_accessor reference_object_id: String?
+
+          def initialize: (
+            id: String,
+            created_at: Time,
+            event_type: String,
+            original_amount: Integer,
+            original_currency: String,
+            payout_currency_amount: Integer,
+            usd_equivalent_amount: Integer,
+            ?description: String?,
+            ?reference_object_id: String?
+          ) -> void
+
+          def to_hash: -> {
+            id: String,
+            created_at: Time,
+            event_type: String,
+            original_amount: Integer,
+            original_currency: String,
+            payout_currency_amount: Integer,
+            usd_equivalent_amount: Integer,
+            description: String?,
+            reference_object_id: String?
+          }
+        end
+      end
+    end
+  end
+end

data/sig/dodopayments/models/payouts/breakup_retrieve_params.rbs

@@ -0,0 +1,25 @@
+module Dodopayments
+  module Models
+    module Payouts
+      type breakup_retrieve_params =
+        { payout_id: String } & Dodopayments::Internal::Type::request_parameters
+
+      class BreakupRetrieveParams < Dodopayments::Internal::Type::BaseModel
+        extend Dodopayments::Internal::Type::RequestParameters::Converter
+        include Dodopayments::Internal::Type::RequestParameters
+
+        attr_accessor payout_id: String
+
+        def initialize: (
+          payout_id: String,
+          ?request_options: Dodopayments::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          payout_id: String,
+          request_options: Dodopayments::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/dodopayments/models/payouts/breakup_retrieve_response.rbs

@@ -0,0 +1,23 @@
+module Dodopayments
+  module Models
+    module Payouts
+      type breakup_retrieve_response_item =
+        { event_type: String, total: Integer }
+
+      class BreakupRetrieveResponseItem < Dodopayments::Internal::Type::BaseModel
+        attr_accessor event_type: String
+
+        attr_accessor total: Integer
+
+        def initialize: (event_type: String, total: Integer) -> void
+
+        def to_hash: -> { event_type: String, total: Integer }
+      end
+
+      type breakup_retrieve_response =
+        ::Array[Dodopayments::Models::Payouts::BreakupRetrieveResponseItem]
+
+      BreakupRetrieveResponse: Dodopayments::Internal::Type::Converter
+    end
+  end
+end

data/sig/dodopayments/models/subscription_update_params.rbs

@@ -5,6 +5,7 @@ module Dodopayments
         subscription_id: String,
         billing: Dodopayments::BillingAddress?,
         cancel_at_next_billing_date: bool?,
+        cancel_reason: Dodopayments::Models::SubscriptionUpdateParams::cancel_reason?,
         credit_entitlement_cart: ::Array[Dodopayments::SubscriptionUpdateParams::CreditEntitlementCart]?,
         customer_name: String?,
         disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,
@@ -25,6 +26,8 @@ module Dodopayments
 
       attr_accessor cancel_at_next_billing_date: bool?
 
+      attr_accessor cancel_reason: Dodopayments::Models::SubscriptionUpdateParams::cancel_reason?
+
       attr_accessor credit_entitlement_cart: ::Array[Dodopayments::SubscriptionUpdateParams::CreditEntitlementCart]?
 
       attr_accessor customer_name: String?
@@ -43,6 +46,7 @@ module Dodopayments
         subscription_id: String,
         ?billing: Dodopayments::BillingAddress?,
         ?cancel_at_next_billing_date: bool?,
+        ?cancel_reason: Dodopayments::Models::SubscriptionUpdateParams::cancel_reason?,
         ?credit_entitlement_cart: ::Array[Dodopayments::SubscriptionUpdateParams::CreditEntitlementCart]?,
         ?customer_name: String?,
         ?disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,
@@ -57,6 +61,7 @@ module Dodopayments
         subscription_id: String,
         billing: Dodopayments::BillingAddress?,
         cancel_at_next_billing_date: bool?,
+        cancel_reason: Dodopayments::Models::SubscriptionUpdateParams::cancel_reason?,
         credit_entitlement_cart: ::Array[Dodopayments::SubscriptionUpdateParams::CreditEntitlementCart]?,
         customer_name: String?,
         disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,
@@ -67,6 +72,21 @@ module Dodopayments
         request_options: Dodopayments::RequestOptions
       }
 
+      type cancel_reason =
+        :cancelled_by_customer
+        | :cancelled_by_merchant
+        | :cancelled_by_merchant_send_dunning
+
+      module CancelReason
+        extend Dodopayments::Internal::Type::Enum
+
+        CANCELLED_BY_CUSTOMER: :cancelled_by_customer
+        CANCELLED_BY_MERCHANT: :cancelled_by_merchant
+        CANCELLED_BY_MERCHANT_SEND_DUNNING: :cancelled_by_merchant_send_dunning
+
+        def self?.values: -> ::Array[Dodopayments::Models::SubscriptionUpdateParams::cancel_reason]
+      end
+
       type credit_entitlement_cart =
         {
           credit_entitlement_id: String,

data/sig/dodopayments/models/unsafe_unwrap_webhook_event.rbs

@@ -1,7 +1,9 @@
 module Dodopayments
   module Models
     type unsafe_unwrap_webhook_event =
-      Dodopayments::CreditAddedWebhookEvent
+      Dodopayments::AbandonedCheckoutDetectedWebhookEvent
+      | Dodopayments::AbandonedCheckoutRecoveredWebhookEvent
+      | Dodopayments::CreditAddedWebhookEvent
       | Dodopayments::CreditBalanceLowWebhookEvent
       | Dodopayments::CreditDeductedWebhookEvent
       | Dodopayments::CreditExpiredWebhookEvent
@@ -16,6 +18,8 @@ module Dodopayments
       | Dodopayments::DisputeLostWebhookEvent
       | Dodopayments::DisputeOpenedWebhookEvent
       | Dodopayments::DisputeWonWebhookEvent
+      | Dodopayments::DunningRecoveredWebhookEvent
+      | Dodopayments::DunningStartedWebhookEvent
       | Dodopayments::LicenseKeyCreatedWebhookEvent
       | Dodopayments::PaymentCancelledWebhookEvent
       | Dodopayments::PaymentFailedWebhookEvent

data/sig/dodopayments/models/unwrap_webhook_event.rbs

@@ -1,7 +1,9 @@
 module Dodopayments
   module Models
     type unwrap_webhook_event =
-      Dodopayments::CreditAddedWebhookEvent
+      Dodopayments::AbandonedCheckoutDetectedWebhookEvent
+      | Dodopayments::AbandonedCheckoutRecoveredWebhookEvent
+      | Dodopayments::CreditAddedWebhookEvent
       | Dodopayments::CreditBalanceLowWebhookEvent
       | Dodopayments::CreditDeductedWebhookEvent
       | Dodopayments::CreditExpiredWebhookEvent
@@ -16,6 +18,8 @@ module Dodopayments
       | Dodopayments::DisputeLostWebhookEvent
       | Dodopayments::DisputeOpenedWebhookEvent
       | Dodopayments::DisputeWonWebhookEvent
+      | Dodopayments::DunningRecoveredWebhookEvent
+      | Dodopayments::DunningStartedWebhookEvent
       | Dodopayments::LicenseKeyCreatedWebhookEvent
       | Dodopayments::PaymentCancelledWebhookEvent
       | Dodopayments::PaymentFailedWebhookEvent

data/sig/dodopayments/models/webhook_event_type.rbs

@@ -36,6 +36,12 @@ module Dodopayments
       | :"credit.overage_charged"
       | :"credit.manual_adjustment"
       | :"credit.balance_low"
+      | :"abandoned_checkout.detected"
+      | :"abandoned_checkout.recovered"
+      | :"dunning.started"
+      | :"dunning.recovered"
+      | :"acr.email"
+      | :"dunning.email"
 
     module WebhookEventType
       extend Dodopayments::Internal::Type::Enum
@@ -75,6 +81,12 @@ module Dodopayments
       CREDIT_OVERAGE_CHARGED: :"credit.overage_charged"
       CREDIT_MANUAL_ADJUSTMENT: :"credit.manual_adjustment"
       CREDIT_BALANCE_LOW: :"credit.balance_low"
+      ABANDONED_CHECKOUT_DETECTED: :"abandoned_checkout.detected"
+      ABANDONED_CHECKOUT_RECOVERED: :"abandoned_checkout.recovered"
+      DUNNING_STARTED: :"dunning.started"
+      DUNNING_RECOVERED: :"dunning.recovered"
+      ACR_EMAIL: :"acr.email"
+      DUNNING_EMAIL: :"dunning.email"
 
       def self?.values: -> ::Array[Dodopayments::Models::webhook_event_type]
     end

data/sig/dodopayments/models/webhook_payload.rbs

@@ -39,6 +39,8 @@ module Dodopayments
         | Dodopayments::WebhookPayload::Data::LicenseKey
         | Dodopayments::WebhookPayload::Data::CreditLedgerEntry
         | Dodopayments::WebhookPayload::Data::CreditBalanceLow
+        | Dodopayments::WebhookPayload::Data::AbandonedCheckout
+        | Dodopayments::WebhookPayload::Data::DunningAttempt
 
       module Data
         extend Dodopayments::Internal::Type::Union
@@ -296,6 +298,169 @@ module Dodopayments
           end
         end
 
+        type abandoned_checkout =
+          {
+            abandoned_at: Time,
+            abandonment_reason: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::abandonment_reason,
+            customer_id: String,
+            payload_type: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::payload_type,
+            payment_id: String,
+            status: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::status,
+            recovered_payment_id: String?
+          }
+
+        class AbandonedCheckout < Dodopayments::Internal::Type::BaseModel
+          attr_accessor abandoned_at: Time
+
+          attr_accessor abandonment_reason: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::abandonment_reason
+
+          attr_accessor customer_id: String
+
+          attr_accessor payload_type: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::payload_type
+
+          attr_accessor payment_id: String
+
+          attr_accessor status: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::status
+
+          attr_accessor recovered_payment_id: String?
+
+          def initialize: (
+            abandoned_at: Time,
+            abandonment_reason: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::abandonment_reason,
+            customer_id: String,
+            payload_type: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::payload_type,
+            payment_id: String,
+            status: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::status,
+            ?recovered_payment_id: String?
+          ) -> void
+
+          def to_hash: -> {
+            abandoned_at: Time,
+            abandonment_reason: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::abandonment_reason,
+            customer_id: String,
+            payload_type: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::payload_type,
+            payment_id: String,
+            status: Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::status,
+            recovered_payment_id: String?
+          }
+
+          type abandonment_reason = :payment_failed | :checkout_incomplete
+
+          module AbandonmentReason
+            extend Dodopayments::Internal::Type::Enum
+
+            PAYMENT_FAILED: :payment_failed
+            CHECKOUT_INCOMPLETE: :checkout_incomplete
+
+            def self?.values: -> ::Array[Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::abandonment_reason]
+          end
+
+          type payload_type = :AbandonedCheckout
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            ABANDONED_CHECKOUT: :AbandonedCheckout
+
+            def self?.values: -> ::Array[Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::payload_type]
+          end
+
+          type status =
+            :abandoned | :recovering | :recovered | :exhausted | :opted_out
+
+          module Status
+            extend Dodopayments::Internal::Type::Enum
+
+            ABANDONED: :abandoned
+            RECOVERING: :recovering
+            RECOVERED: :recovered
+            EXHAUSTED: :exhausted
+            OPTED_OUT: :opted_out
+
+            def self?.values: -> ::Array[Dodopayments::Models::WebhookPayload::Data::AbandonedCheckout::status]
+          end
+        end
+
+        type dunning_attempt =
+          {
+            created_at: Time,
+            customer_id: String,
+            payload_type: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::payload_type,
+            status: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::status,
+            subscription_id: String,
+            trigger_state: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::trigger_state,
+            payment_id: String?
+          }
+
+        class DunningAttempt < Dodopayments::Internal::Type::BaseModel
+          attr_accessor created_at: Time
+
+          attr_accessor customer_id: String
+
+          attr_accessor payload_type: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::payload_type
+
+          attr_accessor status: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::status
+
+          attr_accessor subscription_id: String
+
+          attr_accessor trigger_state: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::trigger_state
+
+          attr_accessor payment_id: String?
+
+          def initialize: (
+            created_at: Time,
+            customer_id: String,
+            payload_type: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::payload_type,
+            status: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::status,
+            subscription_id: String,
+            trigger_state: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::trigger_state,
+            ?payment_id: String?
+          ) -> void
+
+          def to_hash: -> {
+            created_at: Time,
+            customer_id: String,
+            payload_type: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::payload_type,
+            status: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::status,
+            subscription_id: String,
+            trigger_state: Dodopayments::Models::WebhookPayload::Data::DunningAttempt::trigger_state,
+            payment_id: String?
+          }
+
+          type payload_type = :DunningAttempt
+
+          module PayloadType
+            extend Dodopayments::Internal::Type::Enum
+
+            DUNNING_ATTEMPT: :DunningAttempt
+
+            def self?.values: -> ::Array[Dodopayments::Models::WebhookPayload::Data::DunningAttempt::payload_type]
+          end
+
+          type status = :recovering | :recovered | :exhausted
+
+          module Status
+            extend Dodopayments::Internal::Type::Enum
+
+            RECOVERING: :recovering
+            RECOVERED: :recovered
+            EXHAUSTED: :exhausted
+
+            def self?.values: -> ::Array[Dodopayments::Models::WebhookPayload::Data::DunningAttempt::status]
+          end
+
+          type trigger_state = :on_hold | :cancelled
+
+          module TriggerState
+            extend Dodopayments::Internal::Type::Enum
+
+            ON_HOLD: :on_hold
+            CANCELLED: :cancelled
+
+            def self?.values: -> ::Array[Dodopayments::Models::WebhookPayload::Data::DunningAttempt::trigger_state]
+          end
+        end
+
         def self?.variants: -> ::Array[Dodopayments::Models::WebhookPayload::data]
       end
     end

data/sig/dodopayments/models.rbs

@@ -1,4 +1,8 @@
 module Dodopayments
+  class AbandonedCheckoutDetectedWebhookEvent = Dodopayments::Models::AbandonedCheckoutDetectedWebhookEvent
+
+  class AbandonedCheckoutRecoveredWebhookEvent = Dodopayments::Models::AbandonedCheckoutRecoveredWebhookEvent
+
   class AddMeterToPrice = Dodopayments::Models::AddMeterToPrice
 
   class AddonCartResponseItem = Dodopayments::Models::AddonCartResponseItem
@@ -177,6 +181,10 @@ module Dodopayments
 
   class DisputeWonWebhookEvent = Dodopayments::Models::DisputeWonWebhookEvent
 
+  class DunningRecoveredWebhookEvent = Dodopayments::Models::DunningRecoveredWebhookEvent
+
+  class DunningStartedWebhookEvent = Dodopayments::Models::DunningStartedWebhookEvent
+
   class Event = Dodopayments::Models::Event
 
   class EventInput = Dodopayments::Models::EventInput
@@ -269,6 +277,8 @@ module Dodopayments
 
   class PayoutListParams = Dodopayments::Models::PayoutListParams
 
+  module Payouts = Dodopayments::Models::Payouts
+
   module Price = Dodopayments::Models::Price
 
   class Product = Dodopayments::Models::Product

data/sig/dodopayments/resources/discounts.rbs

@@ -6,6 +6,7 @@ module Dodopayments
         type: Dodopayments::Models::discount_type,
         ?code: String?,
         ?expires_at: Time?,
+        ?metadata: ::Hash[Symbol, String],
         ?name: String?,
         ?preserve_on_plan_change: bool,
         ?restricted_to: ::Array[String]?,
@@ -24,6 +25,7 @@ module Dodopayments
         ?amount: Integer?,
         ?code: String?,
         ?expires_at: Time?,
+        ?metadata: ::Hash[Symbol, String]?,
         ?name: String?,
         ?preserve_on_plan_change: bool?,
         ?restricted_to: ::Array[String]?,

data/sig/dodopayments/resources/payouts/breakup/details.rbs

@@ -0,0 +1,23 @@
+module Dodopayments
+  module Resources
+    class Payouts
+      class Breakup
+        class Details
+          def list: (
+            String payout_id,
+            ?page_number: Integer,
+            ?page_size: Integer,
+            ?request_options: Dodopayments::request_opts
+          ) -> Dodopayments::Internal::DefaultPageNumberPagination[Dodopayments::Models::Payouts::Breakup::DetailListResponse]
+
+          def download_csv: (
+            String payout_id,
+            ?request_options: Dodopayments::request_opts
+          ) -> nil
+
+          def initialize: (client: Dodopayments::Client) -> void
+        end
+      end
+    end
+  end
+end

data/sig/dodopayments/resources/payouts/breakup.rbs

@@ -0,0 +1,16 @@
+module Dodopayments
+  module Resources
+    class Payouts
+      class Breakup
+        attr_reader details: Dodopayments::Resources::Payouts::Breakup::Details
+
+        def retrieve: (
+          String payout_id,
+          ?request_options: Dodopayments::request_opts
+        ) -> Dodopayments::Models::Payouts::breakup_retrieve_response
+
+        def initialize: (client: Dodopayments::Client) -> void
+      end
+    end
+  end
+end

data/sig/dodopayments/resources/payouts.rbs

@@ -1,6 +1,8 @@
 module Dodopayments
   module Resources
     class Payouts
+      attr_reader breakup: Dodopayments::Resources::Payouts::Breakup
+
       def list: (
         ?created_at_gte: Time,
         ?created_at_lte: Time,

data/sig/dodopayments/resources/subscriptions.rbs

@@ -34,6 +34,7 @@ module Dodopayments
         String subscription_id,
         ?billing: Dodopayments::BillingAddress?,
         ?cancel_at_next_billing_date: bool?,
+        ?cancel_reason: Dodopayments::Models::SubscriptionUpdateParams::cancel_reason?,
         ?credit_entitlement_cart: ::Array[Dodopayments::SubscriptionUpdateParams::CreditEntitlementCart]?,
         ?customer_name: String?,
         ?disable_on_demand: Dodopayments::SubscriptionUpdateParams::DisableOnDemand?,

data/sig/dodopayments/resources/webhooks.rbs

@@ -49,7 +49,9 @@ module Dodopayments
 
       def unsafe_unwrap: (
         String payload
-      ) -> (Dodopayments::CreditAddedWebhookEvent
+      ) -> (Dodopayments::AbandonedCheckoutDetectedWebhookEvent
+      | Dodopayments::AbandonedCheckoutRecoveredWebhookEvent
+      | Dodopayments::CreditAddedWebhookEvent
       | Dodopayments::CreditBalanceLowWebhookEvent
       | Dodopayments::CreditDeductedWebhookEvent
       | Dodopayments::CreditExpiredWebhookEvent
@@ -64,6 +66,8 @@ module Dodopayments
       | Dodopayments::DisputeLostWebhookEvent
       | Dodopayments::DisputeOpenedWebhookEvent
       | Dodopayments::DisputeWonWebhookEvent
+      | Dodopayments::DunningRecoveredWebhookEvent
+      | Dodopayments::DunningStartedWebhookEvent
       | Dodopayments::LicenseKeyCreatedWebhookEvent
       | Dodopayments::PaymentCancelledWebhookEvent
       | Dodopayments::PaymentFailedWebhookEvent
@@ -84,7 +88,9 @@ module Dodopayments
         String payload,
         headers: ::Hash[String, String],
         ?key: String?
-      ) -> (Dodopayments::CreditAddedWebhookEvent
+      ) -> (Dodopayments::AbandonedCheckoutDetectedWebhookEvent
+      | Dodopayments::AbandonedCheckoutRecoveredWebhookEvent
+      | Dodopayments::CreditAddedWebhookEvent
       | Dodopayments::CreditBalanceLowWebhookEvent
       | Dodopayments::CreditDeductedWebhookEvent
       | Dodopayments::CreditExpiredWebhookEvent
@@ -99,6 +105,8 @@ module Dodopayments
       | Dodopayments::DisputeLostWebhookEvent
       | Dodopayments::DisputeOpenedWebhookEvent
       | Dodopayments::DisputeWonWebhookEvent
+      | Dodopayments::DunningRecoveredWebhookEvent
+      | Dodopayments::DunningStartedWebhookEvent
       | Dodopayments::LicenseKeyCreatedWebhookEvent
       | Dodopayments::PaymentCancelledWebhookEvent
       | Dodopayments::PaymentFailedWebhookEvent