straddle 0.5.0 → 1.0.0

data/rbi/straddle/models/funding_event_list_params.rbi

@@ -11,44 +11,26 @@ module Straddle
           T.any(Straddle::FundingEventListParams, Straddle::Internal::AnyHash)
         end
 
-      # The start date of the range to filter by using the `YYYY-MM-DD` format.
+      # Filter to funding events created on or after this date.
       sig { returns(T.nilable(Date)) }
       attr_accessor :created_from
 
-      # The end date of the range to filter by using the `YYYY-MM-DD` format.
+      # Filter to funding events created on or before this date.
       sig { returns(T.nilable(Date)) }
       attr_accessor :created_to
 
-      # Describes the direction of the funding event from the perspective of the
-      # `linked_bank_account`.
-      sig do
-        returns(
-          T.nilable(Straddle::FundingEventListParams::Direction::OrSymbol)
-        )
-      end
+      # Filter by transfer direction relative to the linked bank account.
+      sig { returns(T.nilable(Straddle::TransferDirection::OrSymbol)) }
       attr_reader :direction
 
-      sig do
-        params(
-          direction: Straddle::FundingEventListParams::Direction::OrSymbol
-        ).void
-      end
+      sig { params(direction: Straddle::TransferDirection::OrSymbol).void }
       attr_writer :direction
 
-      # The funding event types describes the direction and reason for the funding
-      # event.
-      sig do
-        returns(
-          T.nilable(Straddle::FundingEventListParams::EventType::OrSymbol)
-        )
-      end
+      # Filter by funding event type.
+      sig { returns(T.nilable(Straddle::FundingEventType::OrSymbol)) }
       attr_reader :event_type
 
-      sig do
-        params(
-          event_type: Straddle::FundingEventListParams::EventType::OrSymbol
-        ).void
-      end
+      sig { params(event_type: Straddle::FundingEventType::OrSymbol).void }
       attr_writer :event_type
 
       # Results page number. Starts at page 1.
@@ -58,18 +40,18 @@ module Straddle
       sig { params(page_number: Integer).void }
       attr_writer :page_number
 
-      # Results page size. Max value: 1000
+      # Results page size. Max value: 1000.
       sig { returns(T.nilable(Integer)) }
       attr_reader :page_size
 
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
-      # Search text.
+      # Free-text search across funding event fields.
       sig { returns(T.nilable(String)) }
       attr_accessor :search_text
 
-      # The field to sort the results by.
+      # Field used to sort the results.
       sig do
         returns(T.nilable(Straddle::FundingEventListParams::SortBy::OrSymbol))
       end
@@ -80,71 +62,52 @@ module Straddle
       end
       attr_writer :sort_by
 
-      # The order in which to sort the results.
-      sig do
-        returns(
-          T.nilable(Straddle::FundingEventListParams::SortOrder::OrSymbol)
-        )
-      end
+      # Order in which to sort the results.
+      sig { returns(T.nilable(Straddle::SortOrder::OrSymbol)) }
       attr_reader :sort_order
 
-      sig do
-        params(
-          sort_order: Straddle::FundingEventListParams::SortOrder::OrSymbol
-        ).void
-      end
+      sig { params(sort_order: Straddle::SortOrder::OrSymbol).void }
       attr_writer :sort_order
 
-      # Funding Event status.
-      sig do
-        returns(
-          T.nilable(
-            T::Array[Straddle::FundingEventListParams::Status::OrSymbol]
-          )
-        )
-      end
+      # Filter by funding event status.
+      sig { returns(T.nilable(T::Array[Straddle::PaymentStatus::OrSymbol])) }
       attr_accessor :status
 
-      # Reason for latest payment status change.
+      # Filter by the reason for the most recent status change.
       sig do
-        returns(
-          T.nilable(
-            T::Array[Straddle::FundingEventListParams::StatusReason::OrSymbol]
-          )
-        )
+        returns(T.nilable(T::Array[Straddle::PaymentStatusReason::OrSymbol]))
       end
       attr_accessor :status_reason
 
-      # Source of latest payment status change.
+      # Filter by the source of the most recent status change.
       sig do
-        returns(
-          T.nilable(
-            T::Array[Straddle::FundingEventListParams::StatusSource::OrSymbol]
-          )
-        )
+        returns(T.nilable(T::Array[Straddle::PaymentStatusSource::OrSymbol]))
       end
       attr_accessor :status_source
 
-      # Trace Id.
+      # Filter by a network-level trace identifier assigned during processing.
       sig { returns(T.nilable(String)) }
       attr_accessor :trace_id
 
-      # Trace number.
+      # Filter by a network trace number assigned during processing.
       sig { returns(T.nilable(String)) }
       attr_accessor :trace_number
 
+      # Optional client-generated identifier for tracing a series of related requests.
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
       sig { params(correlation_id: String).void }
       attr_writer :correlation_id
 
+      # Optional client-generated identifier for tracing one request.
       sig { returns(T.nilable(String)) }
       attr_reader :request_id
 
       sig { params(request_id: String).void }
       attr_writer :request_id
 
+      # For platform requests, the embedded account UUID that sets the request scope.
       sig { returns(T.nilable(String)) }
       attr_reader :straddle_account_id
 
@@ -155,25 +118,18 @@ module Straddle
         params(
           created_from: T.nilable(Date),
           created_to: T.nilable(Date),
-          direction: Straddle::FundingEventListParams::Direction::OrSymbol,
-          event_type: Straddle::FundingEventListParams::EventType::OrSymbol,
+          direction: Straddle::TransferDirection::OrSymbol,
+          event_type: Straddle::FundingEventType::OrSymbol,
           page_number: Integer,
           page_size: Integer,
           search_text: T.nilable(String),
           sort_by: Straddle::FundingEventListParams::SortBy::OrSymbol,
-          sort_order: Straddle::FundingEventListParams::SortOrder::OrSymbol,
-          status:
-            T.nilable(
-              T::Array[Straddle::FundingEventListParams::Status::OrSymbol]
-            ),
+          sort_order: Straddle::SortOrder::OrSymbol,
+          status: T.nilable(T::Array[Straddle::PaymentStatus::OrSymbol]),
           status_reason:
-            T.nilable(
-              T::Array[Straddle::FundingEventListParams::StatusReason::OrSymbol]
-            ),
+            T.nilable(T::Array[Straddle::PaymentStatusReason::OrSymbol]),
           status_source:
-            T.nilable(
-              T::Array[Straddle::FundingEventListParams::StatusSource::OrSymbol]
-            ),
+            T.nilable(T::Array[Straddle::PaymentStatusSource::OrSymbol]),
           trace_id: T.nilable(String),
           trace_number: T.nilable(String),
           correlation_id: String,
@@ -183,38 +139,39 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
-        # The start date of the range to filter by using the `YYYY-MM-DD` format.
+        # Filter to funding events created on or after this date.
         created_from: nil,
-        # The end date of the range to filter by using the `YYYY-MM-DD` format.
+        # Filter to funding events created on or before this date.
         created_to: nil,
-        # Describes the direction of the funding event from the perspective of the
-        # `linked_bank_account`.
+        # Filter by transfer direction relative to the linked bank account.
         direction: nil,
-        # The funding event types describes the direction and reason for the funding
-        # event.
+        # Filter by funding event type.
         event_type: nil,
         # Results page number. Starts at page 1.
         page_number: nil,
-        # Results page size. Max value: 1000
+        # Results page size. Max value: 1000.
         page_size: nil,
-        # Search text.
+        # Free-text search across funding event fields.
         search_text: nil,
-        # The field to sort the results by.
+        # Field used to sort the results.
         sort_by: nil,
-        # The order in which to sort the results.
+        # Order in which to sort the results.
         sort_order: nil,
-        # Funding Event status.
+        # Filter by funding event status.
         status: nil,
-        # Reason for latest payment status change.
+        # Filter by the reason for the most recent status change.
         status_reason: nil,
-        # Source of latest payment status change.
+        # Filter by the source of the most recent status change.
         status_source: nil,
-        # Trace Id.
+        # Filter by a network-level trace identifier assigned during processing.
         trace_id: nil,
-        # Trace number.
+        # Filter by a network trace number assigned during processing.
         trace_number: nil,
+        # Optional client-generated identifier for tracing a series of related requests.
         correlation_id: nil,
+        # Optional client-generated identifier for tracing one request.
         request_id: nil,
+        # For platform requests, the embedded account UUID that sets the request scope.
         straddle_account_id: nil,
         request_options: {}
       )
@@ -225,29 +182,18 @@ module Straddle
           {
             created_from: T.nilable(Date),
             created_to: T.nilable(Date),
-            direction: Straddle::FundingEventListParams::Direction::OrSymbol,
-            event_type: Straddle::FundingEventListParams::EventType::OrSymbol,
+            direction: Straddle::TransferDirection::OrSymbol,
+            event_type: Straddle::FundingEventType::OrSymbol,
             page_number: Integer,
             page_size: Integer,
             search_text: T.nilable(String),
             sort_by: Straddle::FundingEventListParams::SortBy::OrSymbol,
-            sort_order: Straddle::FundingEventListParams::SortOrder::OrSymbol,
-            status:
-              T.nilable(
-                T::Array[Straddle::FundingEventListParams::Status::OrSymbol]
-              ),
+            sort_order: Straddle::SortOrder::OrSymbol,
+            status: T.nilable(T::Array[Straddle::PaymentStatus::OrSymbol]),
             status_reason:
-              T.nilable(
-                T::Array[
-                  Straddle::FundingEventListParams::StatusReason::OrSymbol
-                ]
-              ),
+              T.nilable(T::Array[Straddle::PaymentStatusReason::OrSymbol]),
             status_source:
-              T.nilable(
-                T::Array[
-                  Straddle::FundingEventListParams::StatusSource::OrSymbol
-                ]
-              ),
+              T.nilable(T::Array[Straddle::PaymentStatusSource::OrSymbol]),
             trace_id: T.nilable(String),
             trace_number: T.nilable(String),
             correlation_id: String,
@@ -260,79 +206,6 @@ module Straddle
       def to_hash
       end
 
-      # Describes the direction of the funding event from the perspective of the
-      # `linked_bank_account`.
-      module Direction
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Straddle::FundingEventListParams::Direction)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        DEPOSIT =
-          T.let(
-            :deposit,
-            Straddle::FundingEventListParams::Direction::TaggedSymbol
-          )
-        WITHDRAWAL =
-          T.let(
-            :withdrawal,
-            Straddle::FundingEventListParams::Direction::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Straddle::FundingEventListParams::Direction::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      # The funding event types describes the direction and reason for the funding
-      # event.
-      module EventType
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Straddle::FundingEventListParams::EventType)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        CHARGE_DEPOSIT =
-          T.let(
-            :charge_deposit,
-            Straddle::FundingEventListParams::EventType::TaggedSymbol
-          )
-        CHARGE_REVERSAL =
-          T.let(
-            :charge_reversal,
-            Straddle::FundingEventListParams::EventType::TaggedSymbol
-          )
-        PAYOUT_RETURN =
-          T.let(
-            :payout_return,
-            Straddle::FundingEventListParams::EventType::TaggedSymbol
-          )
-        PAYOUT_WITHDRAWAL =
-          T.let(
-            :payout_withdrawal,
-            Straddle::FundingEventListParams::EventType::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Straddle::FundingEventListParams::EventType::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      # The field to sort the results by.
       module SortBy
         extend Straddle::Internal::Type::Enum
 
@@ -359,294 +232,6 @@ module Straddle
         def self.values
         end
       end
-
-      # The order in which to sort the results.
-      module SortOrder
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Straddle::FundingEventListParams::SortOrder)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ASC =
-          T.let(:asc, Straddle::FundingEventListParams::SortOrder::TaggedSymbol)
-        DESC =
-          T.let(
-            :desc,
-            Straddle::FundingEventListParams::SortOrder::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Straddle::FundingEventListParams::SortOrder::TaggedSymbol]
-          )
-        end
-        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::FundingEventListParams::Status)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        CREATED =
-          T.let(
-            :created,
-            Straddle::FundingEventListParams::Status::TaggedSymbol
-          )
-        SCHEDULED =
-          T.let(
-            :scheduled,
-            Straddle::FundingEventListParams::Status::TaggedSymbol
-          )
-        FAILED =
-          T.let(:failed, Straddle::FundingEventListParams::Status::TaggedSymbol)
-        CANCELLED =
-          T.let(
-            :cancelled,
-            Straddle::FundingEventListParams::Status::TaggedSymbol
-          )
-        ON_HOLD =
-          T.let(
-            :on_hold,
-            Straddle::FundingEventListParams::Status::TaggedSymbol
-          )
-        PENDING =
-          T.let(
-            :pending,
-            Straddle::FundingEventListParams::Status::TaggedSymbol
-          )
-        PAID =
-          T.let(:paid, Straddle::FundingEventListParams::Status::TaggedSymbol)
-        REVERSED =
-          T.let(
-            :reversed,
-            Straddle::FundingEventListParams::Status::TaggedSymbol
-          )
-        VALIDATING =
-          T.let(
-            :validating,
-            Straddle::FundingEventListParams::Status::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[Straddle::FundingEventListParams::Status::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      module StatusReason
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Straddle::FundingEventListParams::StatusReason)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        INSUFFICIENT_FUNDS =
-          T.let(
-            :insufficient_funds,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        CLOSED_BANK_ACCOUNT =
-          T.let(
-            :closed_bank_account,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        INVALID_BANK_ACCOUNT =
-          T.let(
-            :invalid_bank_account,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        INVALID_ROUTING =
-          T.let(
-            :invalid_routing,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        DISPUTED =
-          T.let(
-            :disputed,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        PAYMENT_STOPPED =
-          T.let(
-            :payment_stopped,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        OWNER_DECEASED =
-          T.let(
-            :owner_deceased,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        FROZEN_BANK_ACCOUNT =
-          T.let(
-            :frozen_bank_account,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        RISK_REVIEW =
-          T.let(
-            :risk_review,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        FRAUDULENT =
-          T.let(
-            :fraudulent,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        DUPLICATE_ENTRY =
-          T.let(
-            :duplicate_entry,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        INVALID_PAYKEY =
-          T.let(
-            :invalid_paykey,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        PAYMENT_BLOCKED =
-          T.let(
-            :payment_blocked,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        AMOUNT_TOO_LARGE =
-          T.let(
-            :amount_too_large,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        TOO_MANY_ATTEMPTS =
-          T.let(
-            :too_many_attempts,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        INTERNAL_SYSTEM_ERROR =
-          T.let(
-            :internal_system_error,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        USER_REQUEST =
-          T.let(
-            :user_request,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        OK =
-          T.let(
-            :ok,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        OTHER_NETWORK_RETURN =
-          T.let(
-            :other_network_return,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        PAYOUT_REFUSED =
-          T.let(
-            :payout_refused,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        CANCEL_REQUEST =
-          T.let(
-            :cancel_request,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        FAILED_VERIFICATION =
-          T.let(
-            :failed_verification,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        REQUIRE_REVIEW =
-          T.let(
-            :require_review,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        BLOCKED_BY_SYSTEM =
-          T.let(
-            :blocked_by_system,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        WATCHTOWER_REVIEW =
-          T.let(
-            :watchtower_review,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        VALIDATING =
-          T.let(
-            :validating,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-        AUTO_HOLD =
-          T.let(
-            :auto_hold,
-            Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Straddle::FundingEventListParams::StatusReason::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
-
-      module StatusSource
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias do
-            T.all(Symbol, Straddle::FundingEventListParams::StatusSource)
-          end
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        WATCHTOWER =
-          T.let(
-            :watchtower,
-            Straddle::FundingEventListParams::StatusSource::TaggedSymbol
-          )
-        BANK_DECLINE =
-          T.let(
-            :bank_decline,
-            Straddle::FundingEventListParams::StatusSource::TaggedSymbol
-          )
-        CUSTOMER_DISPUTE =
-          T.let(
-            :customer_dispute,
-            Straddle::FundingEventListParams::StatusSource::TaggedSymbol
-          )
-        USER_ACTION =
-          T.let(
-            :user_action,
-            Straddle::FundingEventListParams::StatusSource::TaggedSymbol
-          )
-        SYSTEM =
-          T.let(
-            :system,
-            Straddle::FundingEventListParams::StatusSource::TaggedSymbol
-          )
-
-        sig do
-          override.returns(
-            T::Array[
-              Straddle::FundingEventListParams::StatusSource::TaggedSymbol
-            ]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end