straddle 0.3.0 → 0.4.0

data/rbi/straddle/models/paykey_summary_paged_v1.rbi

@@ -158,6 +158,12 @@ module Straddle
         end
         attr_writer :status_details
 
+        # Indicates whether this paykey is eligible for client-initiated unblocking. Only
+        # present for blocked paykeys. True when blocked due to R29 returns and not
+        # previously unblocked, false otherwise. Null when paykey is not blocked.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :unblock_eligible
+
         sig do
           params(
             id: String,
@@ -174,7 +180,8 @@ module Straddle
             external_id: T.nilable(String),
             institution_name: T.nilable(String),
             status_details:
-              Straddle::PaykeySummaryPagedV1::Data::StatusDetails::OrHash
+              Straddle::PaykeySummaryPagedV1::Data::StatusDetails::OrHash,
+            unblock_eligible: T.nilable(T::Boolean)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -203,7 +210,11 @@ module Straddle
           external_id: nil,
           # Name of the financial institution.
           institution_name: nil,
-          status_details: nil
+          status_details: nil,
+          # Indicates whether this paykey is eligible for client-initiated unblocking. Only
+          # present for blocked paykeys. True when blocked due to R29 returns and not
+          # previously unblocked, false otherwise. Null when paykey is not blocked.
+          unblock_eligible: nil
         )
         end
 
@@ -226,7 +237,8 @@ module Straddle
               external_id: T.nilable(String),
               institution_name: T.nilable(String),
               status_details:
-                Straddle::PaykeySummaryPagedV1::Data::StatusDetails
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails,
+              unblock_eligible: T.nilable(T::Boolean)
             }
           )
         end
@@ -469,6 +481,11 @@ module Straddle
               :review,
               Straddle::PaykeySummaryPagedV1::Data::Status::TaggedSymbol
             )
+          BLOCKED =
+            T.let(
+              :blocked,
+              Straddle::PaykeySummaryPagedV1::Data::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -758,6 +775,41 @@ module Straddle
                 :payout_refused,
                 Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::PaykeySummaryPagedV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/straddle/models/paykey_unmasked_params.rbi

@@ -11,6 +11,9 @@ module Straddle
           T.any(Straddle::PaykeyUnmaskedParams, 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_unmasked_v1.rbi

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

data/rbi/straddle/models/paykey_update_balance_params.rbi

@@ -14,6 +14,9 @@ module Straddle
           )
         end
 
+      sig { returns(String) }
+      attr_accessor :id
+
       sig { returns(T.nilable(String)) }
       attr_reader :correlation_id
 
@@ -40,6 +43,7 @@ module Straddle
 
       sig do
         params(
+          id: String,
           correlation_id: String,
           idempotency_key: String,
           request_id: String,
@@ -48,6 +52,7 @@ module Straddle
         ).returns(T.attached_class)
       end
       def self.new(
+        id:,
         correlation_id: nil,
         idempotency_key: nil,
         request_id: nil,
@@ -59,6 +64,7 @@ module Straddle
       sig do
         override.returns(
           {
+            id: String,
             correlation_id: String,
             idempotency_key: String,
             request_id: String,

data/rbi/straddle/models/paykey_v1.rbi

@@ -148,6 +148,12 @@ module Straddle
         end
         attr_writer :status_details
 
+        # Indicates whether this paykey is eligible for client-initiated unblocking. Only
+        # present for blocked paykeys. True when blocked due to R29 returns and not
+        # previously unblocked, false otherwise. Null when paykey is not blocked.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :unblock_eligible
+
         sig do
           params(
             id: String,
@@ -165,7 +171,8 @@ module Straddle
             external_id: T.nilable(String),
             institution_name: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
-            status_details: Straddle::PaykeyV1::Data::StatusDetails::OrHash
+            status_details: Straddle::PaykeyV1::Data::StatusDetails::OrHash,
+            unblock_eligible: T.nilable(T::Boolean)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -197,7 +204,11 @@ module Straddle
           # Up to 20 additional user-defined key-value pairs. Useful for storing additional
           # information about the paykey in a structured format.
           metadata: nil,
-          status_details: nil
+          status_details: nil,
+          # Indicates whether this paykey is eligible for client-initiated unblocking. Only
+          # present for blocked paykeys. True when blocked due to R29 returns and not
+          # previously unblocked, false otherwise. Null when paykey is not blocked.
+          unblock_eligible: nil
         )
         end
 
@@ -219,7 +230,8 @@ module Straddle
               external_id: T.nilable(String),
               institution_name: T.nilable(String),
               metadata: T.nilable(T::Hash[Symbol, String]),
-              status_details: Straddle::PaykeyV1::Data::StatusDetails
+              status_details: Straddle::PaykeyV1::Data::StatusDetails,
+              unblock_eligible: T.nilable(T::Boolean)
             }
           )
         end
@@ -417,6 +429,8 @@ module Straddle
             T.let(:rejected, Straddle::PaykeyV1::Data::Status::TaggedSymbol)
           REVIEW =
             T.let(:review, Straddle::PaykeyV1::Data::Status::TaggedSymbol)
+          BLOCKED =
+            T.let(:blocked, Straddle::PaykeyV1::Data::Status::TaggedSymbol)
 
           sig do
             override.returns(
@@ -783,6 +797,41 @@ module Straddle
                 :payout_refused,
                 Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::PaykeyV1::Data::StatusDetails::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(

data/rbi/straddle/models/paykeys/review_decision_params.rbi

@@ -15,6 +15,9 @@ module Straddle
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :id
+
         sig do
           returns(Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol)
         end
@@ -46,6 +49,7 @@ module Straddle
 
         sig do
           params(
+            id: String,
             status: Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol,
             correlation_id: String,
             idempotency_key: String,
@@ -55,6 +59,7 @@ module Straddle
           ).returns(T.attached_class)
         end
         def self.new(
+          id:,
           status:,
           correlation_id: nil,
           idempotency_key: nil,
@@ -67,6 +72,7 @@ module Straddle
         sig do
           override.returns(
             {
+              id: String,
               status: Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol,
               correlation_id: String,
               idempotency_key: String,

data/rbi/straddle/models/paykeys/review_get_params.rbi

@@ -15,6 +15,9 @@ module Straddle
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :id
+
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -35,6 +38,7 @@ module Straddle
 
         sig do
           params(
+            id: String,
             correlation_id: String,
             request_id: String,
             straddle_account_id: String,
@@ -42,6 +46,7 @@ module Straddle
           ).returns(T.attached_class)
         end
         def self.new(
+          id:,
           correlation_id: nil,
           request_id: nil,
           straddle_account_id: nil,
@@ -52,6 +57,7 @@ module Straddle
         sig do
           override.returns(
             {
+              id: String,
               correlation_id: String,
               request_id: String,
               straddle_account_id: String,

data/rbi/straddle/models/paykeys/review_get_response.rbi

@@ -276,6 +276,12 @@ module Straddle
             end
             attr_writer :status_details
 
+            # Indicates whether this paykey is eligible for client-initiated unblocking. Only
+            # present for blocked paykeys. True when blocked due to R29 returns and not
+            # previously unblocked, false otherwise. Null when paykey is not blocked.
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_accessor :unblock_eligible
+
             sig do
               params(
                 id: String,
@@ -299,7 +305,8 @@ module Straddle
                 institution_name: T.nilable(String),
                 metadata: T.nilable(T::Hash[Symbol, String]),
                 status_details:
-                  Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::OrHash
+                  Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::OrHash,
+                unblock_eligible: T.nilable(T::Boolean)
               ).returns(T.attached_class)
             end
             def self.new(
@@ -331,7 +338,11 @@ module Straddle
               # Up to 20 additional user-defined key-value pairs. Useful for storing additional
               # information about the paykey in a structured format.
               metadata: nil,
-              status_details: nil
+              status_details: nil,
+              # Indicates whether this paykey is eligible for client-initiated unblocking. Only
+              # present for blocked paykeys. True when blocked due to R29 returns and not
+              # previously unblocked, false otherwise. Null when paykey is not blocked.
+              unblock_eligible: nil
             )
             end
 
@@ -359,7 +370,8 @@ module Straddle
                   institution_name: T.nilable(String),
                   metadata: T.nilable(T::Hash[Symbol, String]),
                   status_details:
-                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails,
+                  unblock_eligible: T.nilable(T::Boolean)
                 }
               )
             end
@@ -608,6 +620,11 @@ module Straddle
                   :review,
                   Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Status::TaggedSymbol
                 )
+              BLOCKED =
+                T.let(
+                  :blocked,
+                  Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::Status::TaggedSymbol
+                )
 
               sig do
                 override.returns(
@@ -991,6 +1008,41 @@ module Straddle
                     :payout_refused,
                     Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
                   )
+                CANCEL_REQUEST =
+                  T.let(
+                    :cancel_request,
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
+                  )
+                FAILED_VERIFICATION =
+                  T.let(
+                    :failed_verification,
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
+                  )
+                REQUIRE_REVIEW =
+                  T.let(
+                    :require_review,
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
+                  )
+                BLOCKED_BY_SYSTEM =
+                  T.let(
+                    :blocked_by_system,
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
+                  )
+                WATCHTOWER_REVIEW =
+                  T.let(
+                    :watchtower_review,
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
+                  )
+                VALIDATING =
+                  T.let(
+                    :validating,
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
+                  )
+                AUTO_HOLD =
+                  T.let(
+                    :auto_hold,
+                    Straddle::Models::Paykeys::ReviewGetResponse::Data::PaykeyDetails::StatusDetails::Reason::TaggedSymbol
+                  )
 
                 sig do
                   override.returns(
@@ -1269,11 +1321,6 @@ module Straddle
                     end
                   OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-                  UNKNOWN =
-                    T.let(
-                      :unknown,
-                      Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::AccountValidation::Decision::TaggedSymbol
-                    )
                   ACCEPT =
                     T.let(
                       :accept,
@@ -1388,11 +1435,6 @@ module Straddle
                     end
                   OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-                  UNKNOWN =
-                    T.let(
-                      :unknown,
-                      Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Breakdown::NameMatch::Decision::TaggedSymbol
-                    )
                   ACCEPT =
                     T.let(
                       :accept,
@@ -1434,11 +1476,6 @@ module Straddle
                 end
               OrSymbol = T.type_alias { T.any(Symbol, String) }
 
-              UNKNOWN =
-                T.let(
-                  :unknown,
-                  Straddle::Models::Paykeys::ReviewGetResponse::Data::VerificationDetails::Decision::TaggedSymbol
-                )
               ACCEPT =
                 T.let(
                   :accept,

data/rbi/straddle/models/paykeys/review_refresh_review_params.rbi

@@ -15,6 +15,9 @@ module Straddle
             )
           end
 
+        sig { returns(String) }
+        attr_accessor :id
+
         sig { returns(T.nilable(String)) }
         attr_reader :correlation_id
 
@@ -41,6 +44,7 @@ module Straddle
 
         sig do
           params(
+            id: String,
             correlation_id: String,
             idempotency_key: String,
             request_id: String,
@@ -49,6 +53,7 @@ module Straddle
           ).returns(T.attached_class)
         end
         def self.new(
+          id:,
           correlation_id: nil,
           idempotency_key: nil,
           request_id: nil,
@@ -60,6 +65,7 @@ module Straddle
         sig do
           override.returns(
             {
+              id: String,
               correlation_id: String,
               idempotency_key: String,
               request_id: String,

data/rbi/straddle/models/payment_list_params.rbi

@@ -66,6 +66,13 @@ module Straddle
       sig { params(funding_id: String).void }
       attr_writer :funding_id
 
+      # Include the metadata for payments in the returned data.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :include_metadata
+
+      sig { params(include_metadata: T::Boolean).void }
+      attr_writer :include_metadata
+
       # Search using a maximum `amount` of a `charge` or `payout`.
       sig { returns(T.nilable(Integer)) }
       attr_reader :max_amount
@@ -284,6 +291,7 @@ module Straddle
             Straddle::PaymentListParams::DefaultSortOrder::OrSymbol,
           external_id: String,
           funding_id: String,
+          include_metadata: T::Boolean,
           max_amount: Integer,
           max_created_at: Time,
           max_effective_at: Time,
@@ -325,6 +333,8 @@ module Straddle
         external_id: nil,
         # Search using the `funding_id` of a `charge` or `payout`.
         funding_id: nil,
+        # Include the metadata for payments in the returned data.
+        include_metadata: nil,
         # Search using a maximum `amount` of a `charge` or `payout`.
         max_amount: nil,
         # Search using the latest `created_at` date of a `charge` or `payout`.
@@ -381,6 +391,7 @@ module Straddle
               Straddle::PaymentListParams::DefaultSortOrder::OrSymbol,
             external_id: String,
             funding_id: String,
+            include_metadata: T::Boolean,
             max_amount: Integer,
             max_created_at: Time,
             max_effective_at: Time,
@@ -531,6 +542,11 @@ module Straddle
             :reversed,
             Straddle::PaymentListParams::PaymentStatus::TaggedSymbol
           )
+        VALIDATING =
+          T.let(
+            :validating,
+            Straddle::PaymentListParams::PaymentStatus::TaggedSymbol
+          )
 
         sig do
           override.returns(
@@ -723,6 +739,41 @@ module Straddle
             :payout_refused,
             Straddle::PaymentListParams::StatusReason::TaggedSymbol
           )
+        CANCEL_REQUEST =
+          T.let(
+            :cancel_request,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        FAILED_VERIFICATION =
+          T.let(
+            :failed_verification,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        REQUIRE_REVIEW =
+          T.let(
+            :require_review,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        BLOCKED_BY_SYSTEM =
+          T.let(
+            :blocked_by_system,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        WATCHTOWER_REVIEW =
+          T.let(
+            :watchtower_review,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        VALIDATING =
+          T.let(
+            :validating,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
+        AUTO_HOLD =
+          T.let(
+            :auto_hold,
+            Straddle::PaymentListParams::StatusReason::TaggedSymbol
+          )
 
         sig do
           override.returns(