dodopayments 2.4.1 → 2.5.0

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

data/rbi/dodopayments/models/dunning_started_webhook_event.rbi

@@ -0,0 +1,249 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    class DunningStartedWebhookEvent < Dodopayments::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Dodopayments::DunningStartedWebhookEvent,
+            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::DunningStartedWebhookEvent::Data) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: Dodopayments::DunningStartedWebhookEvent::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::DunningStartedWebhookEvent::Type::TaggedSymbol)
+      end
+      attr_accessor :type
+
+      sig do
+        params(
+          business_id: String,
+          data: Dodopayments::DunningStartedWebhookEvent::Data::OrHash,
+          timestamp: Time,
+          type: Dodopayments::DunningStartedWebhookEvent::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::DunningStartedWebhookEvent::Data,
+            timestamp: Time,
+            type: Dodopayments::DunningStartedWebhookEvent::Type::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Dodopayments::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Dodopayments::DunningStartedWebhookEvent::Data,
+              Dodopayments::Internal::AnyHash
+            )
+          end
+
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        sig do
+          returns(
+            Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        sig { returns(String) }
+        attr_accessor :subscription_id
+
+        sig do
+          returns(
+            Dodopayments::DunningStartedWebhookEvent::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::DunningStartedWebhookEvent::Data::Status::OrSymbol,
+            subscription_id: String,
+            trigger_state:
+              Dodopayments::DunningStartedWebhookEvent::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::DunningStartedWebhookEvent::Data::Status::TaggedSymbol,
+              subscription_id: String,
+              trigger_state:
+                Dodopayments::DunningStartedWebhookEvent::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::DunningStartedWebhookEvent::Data::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          RECOVERING =
+            T.let(
+              :recovering,
+              Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          RECOVERED =
+            T.let(
+              :recovered,
+              Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+            )
+          EXHAUSTED =
+            T.let(
+              :exhausted,
+              Dodopayments::DunningStartedWebhookEvent::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::DunningStartedWebhookEvent::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::DunningStartedWebhookEvent::Data::TriggerState
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ON_HOLD =
+            T.let(
+              :on_hold,
+              Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              Dodopayments::DunningStartedWebhookEvent::Data::TriggerState::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Dodopayments::DunningStartedWebhookEvent::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::DunningStartedWebhookEvent::Type)
+          end
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        DUNNING_STARTED =
+          T.let(
+            :"dunning.started",
+            Dodopayments::DunningStartedWebhookEvent::Type::TaggedSymbol
+          )
+
+        sig do
+          override.returns(
+            T::Array[
+              Dodopayments::DunningStartedWebhookEvent::Type::TaggedSymbol
+            ]
+          )
+        end
+        def self.values
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/payouts/breakup/detail_download_csv_params.rbi

@@ -0,0 +1,45 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Payouts
+      module Breakup
+        class DetailDownloadCsvParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Payouts::Breakup::DetailDownloadCsvParams,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :payout_id
+
+          sig do
+            params(
+              payout_id: String,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(payout_id:, request_options: {})
+          end
+
+          sig do
+            override.returns(
+              {
+                payout_id: String,
+                request_options: Dodopayments::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/dodopayments/models/payouts/breakup/detail_list_params.rbi

@@ -0,0 +1,70 @@
+# typed: strong
+
+module Dodopayments
+  module Models
+    module Payouts
+      module Breakup
+        class DetailListParams < Dodopayments::Internal::Type::BaseModel
+          extend Dodopayments::Internal::Type::RequestParameters::Converter
+          include Dodopayments::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Dodopayments::Payouts::Breakup::DetailListParams,
+                Dodopayments::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :payout_id
+
+          # Page number (0-indexed). Default: 0.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_number
+
+          sig { params(page_number: Integer).void }
+          attr_writer :page_number
+
+          # Number of items per page. Default: 10, Max: 100.
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_size
+
+          sig { params(page_size: Integer).void }
+          attr_writer :page_size
+
+          sig do
+            params(
+              payout_id: String,
+              page_number: Integer,
+              page_size: Integer,
+              request_options: Dodopayments::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            payout_id:,
+            # Page number (0-indexed). Default: 0.
+            page_number: nil,
+            # Number of items per page. Default: 10, Max: 100.
+            page_size: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                payout_id: String,
+                page_number: Integer,
+                page_size: Integer,
+                request_options: Dodopayments::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end