dodopayments 2.20.1 → 2.22.0

data/rbi/dodopayments/models/payout_success_webhook_event.rbi

@@ -0,0 +1,270 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class PayoutSuccessWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::PayoutSuccessWebhookEvent,
+            Dodopayments::Internal::AnyHash
+          )
+        end
+
+      # The business identifier
+      sig { returns(String) }
+      attr_accessor :business_id
+
+      sig { returns(Dodopayments::PayoutSuccessWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(data: Dodopayments::PayoutSuccessWebhookEvent::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::PayoutSuccessWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Symbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The business identifier
+        business_id:,
+        data:,
+        # The timestamp of when the event occurred
+        timestamp:,
+        # The event type
+        type: :"payout.success"
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            business_id: String,
+            data: Dodopayments::PayoutSuccessWebhookEvent::Data,
+            timestamp: Time,
+            type: Symbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::PayoutSuccessWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        # The total amount of the payout.
+        sig { returns(Integer) }
+        attr_accessor :amount
+
+        # The unique identifier of the business associated with the payout.
+        sig { returns(String) }
+        attr_accessor :business_id
+
+        # The total value of chargebacks associated with the payout.
+        sig { returns(Integer) }
+        attr_accessor :chargebacks
+
+        # The timestamp when the payout was created, in UTC.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # The currency of the payout, represented as an ISO 4217 currency code.
+        sig { returns(Dodopayments::Currency::TaggedSymbol) }
+        attr_accessor :currency
+
+        # The fee charged for processing the payout.
+        sig { returns(Integer) }
+        attr_accessor :fee
+
+        # The payment method used for the payout (e.g., bank transfer, card, etc.).
+        sig { returns(String) }
+        attr_accessor :payment_method
+
+        # The unique identifier of the payout.
+        sig { returns(String) }
+        attr_accessor :payout_id
+
+        # The total value of refunds associated with the payout.
+        sig { returns(Integer) }
+        attr_accessor :refunds
+
+        # The current status of the payout.
+        sig do
+          returns(
+            Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # The tax applied to the payout.
+        sig { returns(Integer) }
+        attr_accessor :tax
+
+        # The timestamp when the payout was last updated, in UTC.
+        sig { returns(Time) }
+        attr_accessor :updated_at
+
+        # The name of the payout recipient or purpose.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :name
+
+        # The URL of the document associated with the payout.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :payout_document_url
+
+        # Any additional remarks or notes associated with the payout.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :remarks
+
+        sig do
+          params(
+            amount: Integer,
+            business_id: String,
+            chargebacks: Integer,
+            created_at: Time,
+            currency: Dodopayments::Currency::OrSymbol,
+            fee: Integer,
+            payment_method: String,
+            payout_id: String,
+            refunds: Integer,
+            status:
+              Dodopayments::PayoutSuccessWebhookEvent::Data::Status::OrSymbol,
+            tax: Integer,
+            updated_at: Time,
+            name: T.nilable(String),
+            payout_document_url: T.nilable(String),
+            remarks: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The total amount of the payout.
+          amount:,
+          # The unique identifier of the business associated with the payout.
+          business_id:,
+          # The total value of chargebacks associated with the payout.
+          chargebacks:,
+          # The timestamp when the payout was created, in UTC.
+          created_at:,
+          # The currency of the payout, represented as an ISO 4217 currency code.
+          currency:,
+          # The fee charged for processing the payout.
+          fee:,
+          # The payment method used for the payout (e.g., bank transfer, card, etc.).
+          payment_method:,
+          # The unique identifier of the payout.
+          payout_id:,
+          # The total value of refunds associated with the payout.
+          refunds:,
+          # The current status of the payout.
+          status:,
+          # The tax applied to the payout.
+          tax:,
+          # The timestamp when the payout was last updated, in UTC.
+          updated_at:,
+          # The name of the payout recipient or purpose.
+          name: nil,
+          # The URL of the document associated with the payout.
+          payout_document_url: nil,
+          # Any additional remarks or notes associated with the payout.
+          remarks: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              amount: Integer,
+              business_id: String,
+              chargebacks: Integer,
+              created_at: Time,
+              currency: Dodopayments::Currency::TaggedSymbol,
+              fee: Integer,
+              payment_method: String,
+              payout_id: String,
+              refunds: Integer,
+              status:
+                Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol,
+              tax: Integer,
+              updated_at: Time,
+              name: T.nilable(String),
+              payout_document_url: T.nilable(String),
+              remarks: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # The current status of the payout.
+        module Status
+          extend Dodopayments::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                Dodopayments::PayoutSuccessWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          NOT_INITIATED =
+            T.let(
+              :not_initiated,
+              Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol
+            )
+          IN_PROGRESS =
+            T.let(
+              :in_progress,
+              Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol
+            )
+          ON_HOLD =
+            T.let(
+              :on_hold,
+              Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol
+            )
+          SUCCESS =
+            T.let(
+              :success,
+              Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::PayoutSuccessWebhookEvent::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/price.rbi

@@ -176,6 +176,16 @@ module Dodopayments
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :tax_inclusive
 
+        # Amount charged today for a paid trial, in the price currency's minor units.
+        # Requires `trial_period_days > 0`. Omit or null for a free trial (the default).
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :trial_amount
+
+        # Whether discount codes reduce the trial charge. Defaults to false. Only
+        # meaningful when a paid trial is configured.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :trial_apply_discounts
+
         # Number of days for the trial period. A value of `0` indicates no trial period.
         sig { returns(T.nilable(Integer)) }
         attr_reader :trial_period_days
@@ -195,6 +205,8 @@ module Dodopayments
             subscription_period_count: Integer,
             subscription_period_interval: Dodopayments::TimeInterval::OrSymbol,
             tax_inclusive: T.nilable(T::Boolean),
+            trial_amount: T.nilable(Integer),
+            trial_apply_discounts: T.nilable(T::Boolean),
             trial_period_days: Integer,
             type: Symbol
           ).returns(T.attached_class)
@@ -222,6 +234,12 @@ module Dodopayments
           subscription_period_interval:,
           # Indicates if the price is tax inclusive
           tax_inclusive: nil,
+          # Amount charged today for a paid trial, in the price currency's minor units.
+          # Requires `trial_period_days > 0`. Omit or null for a free trial (the default).
+          trial_amount: nil,
+          # Whether discount codes reduce the trial charge. Defaults to false. Only
+          # meaningful when a paid trial is configured.
+          trial_apply_discounts: nil,
           # Number of days for the trial period. A value of `0` indicates no trial period.
           trial_period_days: nil,
           type: :recurring_price
@@ -242,6 +260,8 @@ module Dodopayments
                 Dodopayments::TimeInterval::OrSymbol,
               type: Symbol,
               tax_inclusive: T.nilable(T::Boolean),
+              trial_amount: T.nilable(Integer),
+              trial_apply_discounts: T.nilable(T::Boolean),
               trial_period_days: Integer
             }
           )

data/rbi/dodopayments/models/subscription.rbi

@@ -178,6 +178,12 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :tax_id
 
+      # Per-unit trial amount after discounts, snapshotted at subscription creation
+      # (price currency minor units, pre-quantity, pre-tax). Null for a free trial or no
+      # trial.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :trial_amount
+
       # Response struct representing subscription details
       sig do
         params(
@@ -222,7 +228,8 @@ module Dodopayments
           payment_method_id: T.nilable(String),
           scheduled_change:
             T.nilable(Dodopayments::ScheduledPlanChange::OrHash),
-          tax_id: T.nilable(String)
+          tax_id: T.nilable(String),
+          trial_amount: T.nilable(Integer)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -302,7 +309,11 @@ module Dodopayments
         # Scheduled plan change details, if any
         scheduled_change: nil,
         # Tax identifier provided for this subscription (if applicable)
-        tax_id: nil
+        tax_id: nil,
+        # Per-unit trial amount after discounts, snapshotted at subscription creation
+        # (price currency minor units, pre-quantity, pre-tax). Null for a free trial or no
+        # trial.
+        trial_amount: nil
       )
       end
 
@@ -351,7 +362,8 @@ module Dodopayments
             expires_at: T.nilable(Time),
             payment_method_id: T.nilable(String),
             scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange),
-            tax_id: T.nilable(String)
+            tax_id: T.nilable(String),
+            trial_amount: T.nilable(Integer)
           }
         )
       end

data/rbi/dodopayments/models/subscription_create_response.rbi

@@ -75,6 +75,11 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :payment_link
 
+      # Per-unit trial amount after discounts, in the price currency's minor units
+      # (pre-quantity, pre-tax). Null for a free trial or no trial.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :trial_amount
+
       sig do
         params(
           addons: T::Array[Dodopayments::AddonCartResponseItem::OrHash],
@@ -93,7 +98,8 @@ module Dodopayments
                 Dodopayments::Models::SubscriptionCreateResponse::OneTimeProductCart::OrHash
               ]
             ),
-          payment_link: T.nilable(String)
+          payment_link: T.nilable(String),
+          trial_amount: T.nilable(Integer)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -123,7 +129,10 @@ module Dodopayments
         # One time products associated with the purchase of subscription
         one_time_product_cart: nil,
         # URL to checkout page
-        payment_link: nil
+        payment_link: nil,
+        # Per-unit trial amount after discounts, in the price currency's minor units
+        # (pre-quantity, pre-tax). Null for a free trial or no trial.
+        trial_amount: nil
       )
       end
 
@@ -146,7 +155,8 @@ module Dodopayments
                   Dodopayments::Models::SubscriptionCreateResponse::OneTimeProductCart
                 ]
               ),
-            payment_link: T.nilable(String)
+            payment_link: T.nilable(String),
+            trial_amount: T.nilable(Integer)
           }
         )
       end

data/rbi/dodopayments/models/subscription_list_response.rbi

@@ -149,6 +149,12 @@ module Dodopayments
       sig { returns(T.nilable(String)) }
       attr_accessor :tax_id
 
+      # Per-unit trial amount after discounts, snapshotted at subscription creation
+      # (price currency minor units, pre-quantity, pre-tax). Null for a free trial or no
+      # trial.
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :trial_amount
+
       # Response struct representing subscription details
       sig do
         params(
@@ -184,7 +190,8 @@ module Dodopayments
           product_name: T.nilable(String),
           scheduled_change:
             T.nilable(Dodopayments::ScheduledPlanChange::OrHash),
-          tax_id: T.nilable(String)
+          tax_id: T.nilable(String),
+          trial_amount: T.nilable(Integer)
         ).returns(T.attached_class)
       end
       def self.new(
@@ -248,7 +255,11 @@ module Dodopayments
         # Scheduled plan change details, if any
         scheduled_change: nil,
         # Tax identifier provided for this subscription (if applicable)
-        tax_id: nil
+        tax_id: nil,
+        # Per-unit trial amount after discounts, snapshotted at subscription creation
+        # (price currency minor units, pre-quantity, pre-tax). Null for a free trial or no
+        # trial.
+        trial_amount: nil
       )
       end
 
@@ -288,7 +299,8 @@ module Dodopayments
             payment_method_id: T.nilable(String),
             product_name: T.nilable(String),
             scheduled_change: T.nilable(Dodopayments::ScheduledPlanChange),
-            tax_id: T.nilable(String)
+            tax_id: T.nilable(String),
+            trial_amount: T.nilable(Integer)
           }
         )
       end

data/rbi/dodopayments/models/unsafe_unwrap_webhook_event.rbi

@@ -37,6 +37,11 @@ module Dodopayments
             Dodopayments::PaymentFailedWebhookEvent,
             Dodopayments::PaymentProcessingWebhookEvent,
             Dodopayments::PaymentSucceededWebhookEvent,
+            Dodopayments::PayoutCreatedWebhookEvent,
+            Dodopayments::PayoutFailedWebhookEvent,
+            Dodopayments::PayoutInProgressWebhookEvent,
+            Dodopayments::PayoutOnHoldWebhookEvent,
+            Dodopayments::PayoutSuccessWebhookEvent,
             Dodopayments::RefundFailedWebhookEvent,
             Dodopayments::RefundSucceededWebhookEvent,
             Dodopayments::SubscriptionActiveWebhookEvent,

data/rbi/dodopayments/models/unwrap_webhook_event.rbi

@@ -37,6 +37,11 @@ module Dodopayments
             Dodopayments::PaymentFailedWebhookEvent,
             Dodopayments::PaymentProcessingWebhookEvent,
             Dodopayments::PaymentSucceededWebhookEvent,
+            Dodopayments::PayoutCreatedWebhookEvent,
+            Dodopayments::PayoutFailedWebhookEvent,
+            Dodopayments::PayoutInProgressWebhookEvent,
+            Dodopayments::PayoutOnHoldWebhookEvent,
+            Dodopayments::PayoutSuccessWebhookEvent,
             Dodopayments::RefundFailedWebhookEvent,
             Dodopayments::RefundSucceededWebhookEvent,
             Dodopayments::SubscriptionActiveWebhookEvent,

data/rbi/dodopayments/models/webhook_event_type.rbi

@@ -106,11 +106,8 @@ module Dodopayments
           :"license_key.created",
           Dodopayments::WebhookEventType::TaggedSymbol
         )
-      PAYOUT_NOT_INITIATED =
-        T.let(
-          :"payout.not_initiated",
-          Dodopayments::WebhookEventType::TaggedSymbol
-        )
+      PAYOUT_CREATED =
+        T.let(:"payout.created", Dodopayments::WebhookEventType::TaggedSymbol)
       PAYOUT_ON_HOLD =
         T.let(:"payout.on_hold", Dodopayments::WebhookEventType::TaggedSymbol)
       PAYOUT_IN_PROGRESS =