straddle 0.3.0 → 0.5.0

data/rbi/straddle/models/funding_event_summary_item_v1.rbi

@@ -135,6 +135,38 @@ module Straddle
         sig { returns(Time) }
         attr_accessor :updated_at
 
+        # The current status of the `charge` or `payout`.
+        sig do
+          returns(
+            T.nilable(
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Straddle::FundingEventSummaryItemV1::Data::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          returns(
+            T.nilable(Straddle::FundingEventSummaryItemV1::Data::StatusDetails)
+          )
+        end
+        attr_reader :status_details
+
+        sig do
+          params(
+            status_details:
+              Straddle::FundingEventSummaryItemV1::Data::StatusDetails::OrHash
+          ).void
+        end
+        attr_writer :status_details
+
         # The trace number of the funding event.
         sig { returns(T.nilable(String)) }
         attr_accessor :trace_number
@@ -153,6 +185,9 @@ module Straddle
             trace_numbers: T::Array[String],
             transfer_date: Date,
             updated_at: Time,
+            status: Straddle::FundingEventSummaryItemV1::Data::Status::OrSymbol,
+            status_details:
+              Straddle::FundingEventSummaryItemV1::Data::StatusDetails::OrHash,
             trace_number: T.nilable(String)
           ).returns(T.attached_class)
         end
@@ -181,6 +216,9 @@ module Straddle
           transfer_date:,
           # Updated at.
           updated_at:,
+          # The current status of the `charge` or `payout`.
+          status: nil,
+          status_details: nil,
           # The trace number of the funding event.
           trace_number: nil
         )
@@ -201,6 +239,10 @@ module Straddle
               trace_numbers: T::Array[String],
               transfer_date: Date,
               updated_at: Time,
+              status:
+                Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol,
+              status_details:
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails,
               trace_number: T.nilable(String)
             }
           )
@@ -289,6 +331,356 @@ module Straddle
           def self.values
           end
         end
+
+        # The current status of the `charge` or `payout`.
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::FundingEventSummaryItemV1::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREATED =
+            T.let(
+              :created,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          SCHEDULED =
+            T.let(
+              :scheduled,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          ON_HOLD =
+            T.let(
+              :on_hold,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          PENDING =
+            T.let(
+              :pending,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          PAID =
+            T.let(
+              :paid,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          REVERSED =
+            T.let(
+              :reversed,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+          VALIDATING =
+            T.let(
+              :validating,
+              Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::FundingEventSummaryItemV1::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class StatusDetails < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails,
+                Straddle::Internal::AnyHash
+              )
+            end
+
+          # The time the status change occurred.
+          sig { returns(Time) }
+          attr_accessor :changed_at
+
+          # A human-readable description of the current status.
+          sig { returns(String) }
+          attr_accessor :message
+
+          sig do
+            returns(
+              Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+            )
+          end
+          attr_accessor :reason
+
+          sig do
+            returns(
+              Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol
+            )
+          end
+          attr_accessor :source
+
+          # The status code if applicable.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :code
+
+          sig do
+            params(
+              changed_at: Time,
+              message: String,
+              reason:
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::OrSymbol,
+              source:
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::OrSymbol,
+              code: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # The time the status change occurred.
+            changed_at:,
+            # A human-readable description of the current status.
+            message:,
+            reason:,
+            source:,
+            # The status code if applicable.
+            code: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                changed_at: Time,
+                message: String,
+                reason:
+                  Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol,
+                source:
+                  Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol,
+                code: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          module Reason
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INSUFFICIENT_FUNDS =
+              T.let(
+                :insufficient_funds,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            CLOSED_BANK_ACCOUNT =
+              T.let(
+                :closed_bank_account,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INVALID_BANK_ACCOUNT =
+              T.let(
+                :invalid_bank_account,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INVALID_ROUTING =
+              T.let(
+                :invalid_routing,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            DISPUTED =
+              T.let(
+                :disputed,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            PAYMENT_STOPPED =
+              T.let(
+                :payment_stopped,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            OWNER_DECEASED =
+              T.let(
+                :owner_deceased,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FROZEN_BANK_ACCOUNT =
+              T.let(
+                :frozen_bank_account,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            RISK_REVIEW =
+              T.let(
+                :risk_review,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FRAUDULENT =
+              T.let(
+                :fraudulent,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            DUPLICATE_ENTRY =
+              T.let(
+                :duplicate_entry,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INVALID_PAYKEY =
+              T.let(
+                :invalid_paykey,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            PAYMENT_BLOCKED =
+              T.let(
+                :payment_blocked,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            AMOUNT_TOO_LARGE =
+              T.let(
+                :amount_too_large,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            TOO_MANY_ATTEMPTS =
+              T.let(
+                :too_many_attempts,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INTERNAL_SYSTEM_ERROR =
+              T.let(
+                :internal_system_error,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            USER_REQUEST =
+              T.let(
+                :user_request,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            OK =
+              T.let(
+                :ok,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            OTHER_NETWORK_RETURN =
+              T.let(
+                :other_network_return,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            PAYOUT_REFUSED =
+              T.let(
+                :payout_refused,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Reason::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Source
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            WATCHTOWER =
+              T.let(
+                :watchtower,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            BANK_DECLINE =
+              T.let(
+                :bank_decline,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            CUSTOMER_DISPUTE =
+              T.let(
+                :customer_dispute,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            USER_ACTION =
+              T.let(
+                :user_action,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            SYSTEM =
+              T.let(
+                :system,
+                Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::FundingEventSummaryItemV1::Data::StatusDetails::Source::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       # Indicates the structure of the returned content.