straddle 0.2.0 → 0.4.0

data/rbi/straddle/models/paykey_reveal_response.rbi

@@ -169,6 +169,11 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :expires_at
 
+        # Unique identifier for the paykey in your database, used for cross-referencing
+        # between Straddle and your systems.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_id
+
         # Name of the financial institution.
         sig { returns(T.nilable(String)) }
         attr_accessor :institution_name
@@ -214,6 +219,7 @@ module Straddle
               Straddle::Models::PaykeyRevealResponse::Data::BankData::OrHash,
             customer_id: T.nilable(String),
             expires_at: T.nilable(Time),
+            external_id: T.nilable(String),
             institution_name: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
             status_details:
@@ -242,6 +248,9 @@ module Straddle
           customer_id: nil,
           # Expiration date and time of the paykey, if applicable.
           expires_at: nil,
+          # Unique identifier for the paykey in your database, used for cross-referencing
+          # between Straddle and your systems.
+          external_id: nil,
           # Name of the financial institution.
           institution_name: nil,
           # Up to 20 additional user-defined key-value pairs. Useful for storing additional
@@ -268,6 +277,7 @@ module Straddle
               bank_data: Straddle::Models::PaykeyRevealResponse::Data::BankData,
               customer_id: T.nilable(String),
               expires_at: T.nilable(Time),
+              external_id: T.nilable(String),
               institution_name: T.nilable(String),
               metadata: T.nilable(T::Hash[Symbol, String]),
               status_details:
@@ -287,6 +297,23 @@ module Straddle
               )
             end
 
+          sig do
+            returns(
+              T.nilable(
+                Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :processing_method
+
+          sig do
+            params(
+              processing_method:
+                Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::OrSymbol
+            ).void
+          end
+          attr_writer :processing_method
+
           sig do
             returns(
               T.nilable(
@@ -306,16 +333,20 @@ module Straddle
 
           sig do
             params(
+              processing_method:
+                Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::OrSymbol,
               sandbox_outcome:
                 Straddle::Models::PaykeyRevealResponse::Data::Config::SandboxOutcome::OrSymbol
             ).returns(T.attached_class)
           end
-          def self.new(sandbox_outcome: nil)
+          def self.new(processing_method: nil, sandbox_outcome: nil)
           end
 
           sig do
             override.returns(
               {
+                processing_method:
+                  Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::TaggedSymbol,
                 sandbox_outcome:
                   Straddle::Models::PaykeyRevealResponse::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -324,6 +355,45 @@ module Straddle
           def to_hash
           end
 
+          module ProcessingMethod
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INLINE =
+              T.let(
+                :inline,
+                Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            BACKGROUND =
+              T.let(
+                :background,
+                Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            SKIP =
+              T.let(
+                :skip,
+                Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::Models::PaykeyRevealResponse::Data::Config::ProcessingMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           module SandboxOutcome
             extend Straddle::Internal::Type::Enum
 
@@ -351,6 +421,11 @@ module Straddle
                 :rejected,
                 Straddle::Models::PaykeyRevealResponse::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            REVIEW =
+              T.let(
+                :review,
+                Straddle::Models::PaykeyRevealResponse::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -455,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(
@@ -838,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(

data/rbi/straddle/models/paykey_summary_paged_v1.rbi

@@ -134,6 +134,11 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :expires_at
 
+        # Unique identifier for the paykey in your database, used for cross-referencing
+        # between Straddle and your systems.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_id
+
         # Name of the financial institution.
         sig { returns(T.nilable(String)) }
         attr_accessor :institution_name
@@ -153,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,
@@ -166,9 +177,11 @@ module Straddle
             bank_data: Straddle::PaykeySummaryPagedV1::Data::BankData::OrHash,
             customer_id: T.nilable(String),
             expires_at: T.nilable(Time),
+            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(
@@ -192,9 +205,16 @@ module Straddle
           customer_id: nil,
           # Expiration date and time of the paykey, if applicable.
           expires_at: nil,
+          # Unique identifier for the paykey in your database, used for cross-referencing
+          # between Straddle and your systems.
+          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
 
@@ -214,9 +234,11 @@ module Straddle
               bank_data: Straddle::PaykeySummaryPagedV1::Data::BankData,
               customer_id: T.nilable(String),
               expires_at: T.nilable(Time),
+              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
@@ -232,6 +254,23 @@ module Straddle
               )
             end
 
+          sig do
+            returns(
+              T.nilable(
+                Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :processing_method
+
+          sig do
+            params(
+              processing_method:
+                Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::OrSymbol
+            ).void
+          end
+          attr_writer :processing_method
+
           sig do
             returns(
               T.nilable(
@@ -251,16 +290,20 @@ module Straddle
 
           sig do
             params(
+              processing_method:
+                Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::OrSymbol,
               sandbox_outcome:
                 Straddle::PaykeySummaryPagedV1::Data::Config::SandboxOutcome::OrSymbol
             ).returns(T.attached_class)
           end
-          def self.new(sandbox_outcome: nil)
+          def self.new(processing_method: nil, sandbox_outcome: nil)
           end
 
           sig do
             override.returns(
               {
+                processing_method:
+                  Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::TaggedSymbol,
                 sandbox_outcome:
                   Straddle::PaykeySummaryPagedV1::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -269,6 +312,45 @@ module Straddle
           def to_hash
           end
 
+          module ProcessingMethod
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INLINE =
+              T.let(
+                :inline,
+                Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            BACKGROUND =
+              T.let(
+                :background,
+                Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            SKIP =
+              T.let(
+                :skip,
+                Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PaykeySummaryPagedV1::Data::Config::ProcessingMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           module SandboxOutcome
             extend Straddle::Internal::Type::Enum
 
@@ -296,6 +378,11 @@ module Straddle
                 :rejected,
                 Straddle::PaykeySummaryPagedV1::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            REVIEW =
+              T.let(
+                :review,
+                Straddle::PaykeySummaryPagedV1::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -394,6 +481,11 @@ module Straddle
               :review,
               Straddle::PaykeySummaryPagedV1::Data::Status::TaggedSymbol
             )
+          BLOCKED =
+            T.let(
+              :blocked,
+              Straddle::PaykeySummaryPagedV1::Data::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -683,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

@@ -135,6 +135,11 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :expires_at
 
+        # Unique identifier for the paykey in your database, used for cross-referencing
+        # between Straddle and your systems.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :external_id
+
         # Name of the financial institution.
         sig { returns(T.nilable(String)) }
         attr_accessor :institution_name
@@ -171,6 +176,7 @@ module Straddle
             bank_data: Straddle::PaykeyUnmaskedV1::Data::BankData::OrHash,
             customer_id: T.nilable(String),
             expires_at: T.nilable(Time),
+            external_id: T.nilable(String),
             institution_name: T.nilable(String),
             metadata: T.nilable(T::Hash[Symbol, String]),
             status_details:
@@ -198,6 +204,9 @@ module Straddle
           customer_id: nil,
           # Expiration date and time of the paykey, if applicable.
           expires_at: nil,
+          # Unique identifier for the paykey in your database, used for cross-referencing
+          # between Straddle and your systems.
+          external_id: nil,
           # Name of the financial institution.
           institution_name: nil,
           # Up to 20 additional user-defined key-value pairs. Useful for storing additional
@@ -222,6 +231,7 @@ module Straddle
               bank_data: Straddle::PaykeyUnmaskedV1::Data::BankData,
               customer_id: T.nilable(String),
               expires_at: T.nilable(Time),
+              external_id: T.nilable(String),
               institution_name: T.nilable(String),
               metadata: T.nilable(T::Hash[Symbol, String]),
               status_details: Straddle::PaykeyUnmaskedV1::Data::StatusDetails
@@ -240,6 +250,23 @@ module Straddle
               )
             end
 
+          sig do
+            returns(
+              T.nilable(
+                Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :processing_method
+
+          sig do
+            params(
+              processing_method:
+                Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::OrSymbol
+            ).void
+          end
+          attr_writer :processing_method
+
           sig do
             returns(
               T.nilable(
@@ -259,16 +286,20 @@ module Straddle
 
           sig do
             params(
+              processing_method:
+                Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::OrSymbol,
               sandbox_outcome:
                 Straddle::PaykeyUnmaskedV1::Data::Config::SandboxOutcome::OrSymbol
             ).returns(T.attached_class)
           end
-          def self.new(sandbox_outcome: nil)
+          def self.new(processing_method: nil, sandbox_outcome: nil)
           end
 
           sig do
             override.returns(
               {
+                processing_method:
+                  Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::TaggedSymbol,
                 sandbox_outcome:
                   Straddle::PaykeyUnmaskedV1::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -277,6 +308,45 @@ module Straddle
           def to_hash
           end
 
+          module ProcessingMethod
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INLINE =
+              T.let(
+                :inline,
+                Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            BACKGROUND =
+              T.let(
+                :background,
+                Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            SKIP =
+              T.let(
+                :skip,
+                Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PaykeyUnmaskedV1::Data::Config::ProcessingMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           module SandboxOutcome
             extend Straddle::Internal::Type::Enum
 
@@ -304,6 +374,11 @@ module Straddle
                 :rejected,
                 Straddle::PaykeyUnmaskedV1::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            REVIEW =
+              T.let(
+                :review,
+                Straddle::PaykeyUnmaskedV1::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -394,6 +469,11 @@ module Straddle
               :review,
               Straddle::PaykeyUnmaskedV1::Data::Status::TaggedSymbol
             )
+          BLOCKED =
+            T.let(
+              :blocked,
+              Straddle::PaykeyUnmaskedV1::Data::Status::TaggedSymbol
+            )
 
           sig do
             override.returns(
@@ -770,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/{customer_refresh_review_params.rbi → paykey_update_balance_params.rbi}

@@ -2,18 +2,21 @@
 
 module Straddle
   module Models
-    class CustomerRefreshReviewParams < Straddle::Internal::Type::BaseModel
+    class PaykeyUpdateBalanceParams < Straddle::Internal::Type::BaseModel
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
       OrHash =
         T.type_alias do
           T.any(
-            Straddle::CustomerRefreshReviewParams,
+            Straddle::PaykeyUpdateBalanceParams,
             Straddle::Internal::AnyHash
           )
         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,