straddle 0.3.0 → 0.5.0

data/rbi/straddle/models/funding_event_summary_paged_v1.rbi

@@ -132,6 +132,38 @@ module Straddle
         sig { returns(Time) }
         attr_accessor :updated_at
 
+        # The current status of the `charge` or `payout`.
+        sig do
+          returns(
+            T.nilable(
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          )
+        end
+        attr_reader :status
+
+        sig do
+          params(
+            status: Straddle::FundingEventSummaryPagedV1::Data::Status::OrSymbol
+          ).void
+        end
+        attr_writer :status
+
+        sig do
+          returns(
+            T.nilable(Straddle::FundingEventSummaryPagedV1::Data::StatusDetails)
+          )
+        end
+        attr_reader :status_details
+
+        sig do
+          params(
+            status_details:
+              Straddle::FundingEventSummaryPagedV1::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
@@ -150,6 +182,10 @@ module Straddle
             trace_numbers: T::Array[String],
             transfer_date: Date,
             updated_at: Time,
+            status:
+              Straddle::FundingEventSummaryPagedV1::Data::Status::OrSymbol,
+            status_details:
+              Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::OrHash,
             trace_number: T.nilable(String)
           ).returns(T.attached_class)
         end
@@ -178,6 +214,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
         )
@@ -198,6 +237,10 @@ module Straddle
               trace_numbers: T::Array[String],
               transfer_date: Date,
               updated_at: Time,
+              status:
+                Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol,
+              status_details:
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails,
               trace_number: T.nilable(String)
             }
           )
@@ -286,6 +329,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::FundingEventSummaryPagedV1::Data::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          CREATED =
+            T.let(
+              :created,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          SCHEDULED =
+            T.let(
+              :scheduled,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          ON_HOLD =
+            T.let(
+              :on_hold,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          PENDING =
+            T.let(
+              :pending,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          PAID =
+            T.let(
+              :paid,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          REVERSED =
+            T.let(
+              :reversed,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+          VALIDATING =
+            T.let(
+              :validating,
+              Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::FundingEventSummaryPagedV1::Data::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class StatusDetails < Straddle::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Straddle::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+            )
+          end
+          attr_accessor :reason
+
+          sig do
+            returns(
+              Straddle::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::OrSymbol,
+              source:
+                Straddle::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol,
+                source:
+                  Straddle::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::Data::StatusDetails::Reason
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INSUFFICIENT_FUNDS =
+              T.let(
+                :insufficient_funds,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            CLOSED_BANK_ACCOUNT =
+              T.let(
+                :closed_bank_account,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INVALID_BANK_ACCOUNT =
+              T.let(
+                :invalid_bank_account,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INVALID_ROUTING =
+              T.let(
+                :invalid_routing,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            DISPUTED =
+              T.let(
+                :disputed,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            PAYMENT_STOPPED =
+              T.let(
+                :payment_stopped,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            OWNER_DECEASED =
+              T.let(
+                :owner_deceased,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FROZEN_BANK_ACCOUNT =
+              T.let(
+                :frozen_bank_account,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            RISK_REVIEW =
+              T.let(
+                :risk_review,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FRAUDULENT =
+              T.let(
+                :fraudulent,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            DUPLICATE_ENTRY =
+              T.let(
+                :duplicate_entry,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INVALID_PAYKEY =
+              T.let(
+                :invalid_paykey,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            PAYMENT_BLOCKED =
+              T.let(
+                :payment_blocked,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            AMOUNT_TOO_LARGE =
+              T.let(
+                :amount_too_large,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            TOO_MANY_ATTEMPTS =
+              T.let(
+                :too_many_attempts,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            INTERNAL_SYSTEM_ERROR =
+              T.let(
+                :internal_system_error,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            USER_REQUEST =
+              T.let(
+                :user_request,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            OK =
+              T.let(
+                :ok,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            OTHER_NETWORK_RETURN =
+              T.let(
+                :other_network_return,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            PAYOUT_REFUSED =
+              T.let(
+                :payout_refused,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::FundingEventSummaryPagedV1::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::FundingEventSummaryPagedV1::Data::StatusDetails::Source
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            WATCHTOWER =
+              T.let(
+                :watchtower,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            BANK_DECLINE =
+              T.let(
+                :bank_decline,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            CUSTOMER_DISPUTE =
+              T.let(
+                :customer_dispute,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            USER_ACTION =
+              T.let(
+                :user_action,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+            SYSTEM =
+              T.let(
+                :system,
+                Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Source::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::FundingEventSummaryPagedV1::Data::StatusDetails::Source::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
       end
 
       class Meta < Straddle::Internal::Type::BaseModel

data/rbi/straddle/models/paykey_cancel_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::PaykeyCancelParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
@@ -40,6 +43,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           reason: T.nilable(String),
           correlation_id: String,
           idempotency_key: String,
@@ -49,6 +53,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         reason: nil,
         correlation_id: nil,
         idempotency_key: nil,
@@ -61,6 +66,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             reason: T.nilable(String),
             correlation_id: String,
             idempotency_key: String,

data/rbi/straddle/models/paykey_get_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::PaykeyGetParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -31,6 +34,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           correlation_id: String,
           request_id: String,
           straddle_account_id: String,
@@ -38,6 +42,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         correlation_id: nil,
         request_id: nil,
         straddle_account_id: nil,
@@ -48,6 +53,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             correlation_id: String,
             request_id: String,
             straddle_account_id: String,

data/rbi/straddle/models/paykey_list_params.rbi

@@ -11,6 +11,20 @@ module Straddle
           T.any(Straddle::PaykeyListParams, Straddle::Internal::AnyHash)
         end
 
+      # Start date for filtering by creation date.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_from
+
+      sig { params(created_from: Time).void }
+      attr_writer :created_from
+
+      # End date for filtering by creation date.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_to
+
+      sig { params(created_to: Time).void }
+      attr_writer :created_to
+
       # Filter paykeys by related customer ID.
       sig { returns(T.nilable(String)) }
       attr_reader :customer_id
@@ -32,6 +46,13 @@ module Straddle
       sig { params(page_size: Integer).void }
       attr_writer :page_size
 
+      # General search term to filter paykeys.
+      sig { returns(T.nilable(String)) }
+      attr_reader :search_text
+
+      sig { params(search_text: String).void }
+      attr_writer :search_text
+
       sig { returns(T.nilable(Straddle::PaykeyListParams::SortBy::OrSymbol)) }
       attr_reader :sort_by
 
@@ -78,6 +99,16 @@ module Straddle
       end
       attr_writer :status
 
+      # Filter paykeys by unblock eligibility. When true, returns only blocked paykeys
+      # eligible for client-initiated unblocking (blocked due to R29 returns and not
+      # previously unblocked). When false, returns only blocked paykeys that are not
+      # eligible for unblocking.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :unblock_eligible
+
+      sig { params(unblock_eligible: T::Boolean).void }
+      attr_writer :unblock_eligible
+
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -98,13 +129,17 @@ module Straddle
 
       sig do
         params(
+          created_from: Time,
+          created_to: Time,
           customer_id: String,
           page_number: Integer,
           page_size: Integer,
+          search_text: String,
           sort_by: Straddle::PaykeyListParams::SortBy::OrSymbol,
           sort_order: Straddle::PaykeyListParams::SortOrder::OrSymbol,
           source: T::Array[Straddle::PaykeyListParams::Source::OrSymbol],
           status: T::Array[Straddle::PaykeyListParams::Status::OrSymbol],
+          unblock_eligible: T::Boolean,
           correlation_id: String,
           request_id: String,
           straddle_account_id: String,
@@ -112,18 +147,29 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        # Start date for filtering by creation date.
+        created_from: nil,
+        # End date for filtering by creation date.
+        created_to: nil,
         # Filter paykeys by related customer ID.
         customer_id: nil,
         # Page number for paginated results. Starts at 1.
         page_number: nil,
         # Number of results per page. Maximum: 1000.
         page_size: nil,
+        # General search term to filter paykeys.
+        search_text: nil,
         sort_by: nil,
         sort_order: nil,
         # Filter paykeys by their source.
         source: nil,
         # Filter paykeys by their current status.
         status: nil,
+        # Filter paykeys by unblock eligibility. When true, returns only blocked paykeys
+        # eligible for client-initiated unblocking (blocked due to R29 returns and not
+        # previously unblocked). When false, returns only blocked paykeys that are not
+        # eligible for unblocking.
+        unblock_eligible: nil,
         correlation_id: nil,
         request_id: nil,
         straddle_account_id: nil,
@@ -134,13 +180,17 @@ module Straddle
       sig do
         override.returns(
           {
+            created_from: Time,
+            created_to: Time,
             customer_id: String,
             page_number: Integer,
             page_size: Integer,
+            search_text: String,
             sort_by: Straddle::PaykeyListParams::SortBy::OrSymbol,
             sort_order: Straddle::PaykeyListParams::SortOrder::OrSymbol,
             source: T::Array[Straddle::PaykeyListParams::Source::OrSymbol],
             status: T::Array[Straddle::PaykeyListParams::Status::OrSymbol],
+            unblock_eligible: T::Boolean,
             correlation_id: String,
             request_id: String,
             straddle_account_id: String,
@@ -239,6 +289,8 @@ module Straddle
           T.let(:rejected, Straddle::PaykeyListParams::Status::TaggedSymbol)
         REVIEW =
           T.let(:review, Straddle::PaykeyListParams::Status::TaggedSymbol)
+        BLOCKED =
+          T.let(:blocked, Straddle::PaykeyListParams::Status::TaggedSymbol)
 
         sig do
           override.returns(

data/rbi/straddle/models/paykey_reveal_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::PaykeyRevealParams, Straddle::Internal::AnyHash)
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -31,6 +34,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           correlation_id: String,
           request_id: String,
           straddle_account_id: String,
@@ -38,6 +42,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         correlation_id: nil,
         request_id: nil,
         straddle_account_id: nil,
@@ -48,6 +53,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             correlation_id: String,
             request_id: String,
             straddle_account_id: String,

data/rbi/straddle/models/paykey_reveal_response.rbi

@@ -530,6 +530,11 @@ module Straddle
               :review,
               Straddle::Models::PaykeyRevealResponse::Data::Status::TaggedSymbol
             )
+          BLOCKED =
+            T.let(
+              :blocked,
+              Straddle::Models::PaykeyRevealResponse::Data::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -913,6 +918,41 @@ module Straddle
                 :payout_refused,
                 Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::Models::PaykeyRevealResponse::Data::StatusDetails::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(