straddle 0.2.0 → 0.4.0

data/rbi/straddle/models/paykey_v1.rbi

@@ -124,6 +124,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
@@ -143,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,
@@ -157,9 +168,11 @@ module Straddle
             bank_data: Straddle::PaykeyV1::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: 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(
@@ -183,12 +196,19 @@ 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
           # 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
 
@@ -207,9 +227,11 @@ module Straddle
               bank_data: Straddle::PaykeyV1::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::PaykeyV1::Data::StatusDetails
+              status_details: Straddle::PaykeyV1::Data::StatusDetails,
+              unblock_eligible: T.nilable(T::Boolean)
             }
           )
         end
@@ -225,6 +247,23 @@ module Straddle
               )
             end
 
+          sig do
+            returns(
+              T.nilable(
+                Straddle::PaykeyV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            )
+          end
+          attr_reader :processing_method
+
+          sig do
+            params(
+              processing_method:
+                Straddle::PaykeyV1::Data::Config::ProcessingMethod::OrSymbol
+            ).void
+          end
+          attr_writer :processing_method
+
           sig do
             returns(
               T.nilable(
@@ -244,16 +283,20 @@ module Straddle
 
           sig do
             params(
+              processing_method:
+                Straddle::PaykeyV1::Data::Config::ProcessingMethod::OrSymbol,
               sandbox_outcome:
                 Straddle::PaykeyV1::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::PaykeyV1::Data::Config::ProcessingMethod::TaggedSymbol,
                 sandbox_outcome:
                   Straddle::PaykeyV1::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -262,6 +305,45 @@ module Straddle
           def to_hash
           end
 
+          module ProcessingMethod
+            extend Straddle::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Straddle::PaykeyV1::Data::Config::ProcessingMethod
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            INLINE =
+              T.let(
+                :inline,
+                Straddle::PaykeyV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            BACKGROUND =
+              T.let(
+                :background,
+                Straddle::PaykeyV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+            SKIP =
+              T.let(
+                :skip,
+                Straddle::PaykeyV1::Data::Config::ProcessingMethod::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Straddle::PaykeyV1::Data::Config::ProcessingMethod::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
           module SandboxOutcome
             extend Straddle::Internal::Type::Enum
 
@@ -286,6 +368,11 @@ module Straddle
                 :rejected,
                 Straddle::PaykeyV1::Data::Config::SandboxOutcome::TaggedSymbol
               )
+            REVIEW =
+              T.let(
+                :review,
+                Straddle::PaykeyV1::Data::Config::SandboxOutcome::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -342,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(
@@ -708,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

@@ -0,0 +1,121 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Paykeys
+      class ReviewDecisionParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Paykeys::ReviewDecisionParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig do
+          returns(Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol)
+        end
+        attr_accessor :status
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :straddle_account_id
+
+        sig { params(straddle_account_id: String).void }
+        attr_writer :straddle_account_id
+
+        sig do
+          params(
+            id: String,
+            status: Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          status:,
+          correlation_id: nil,
+          idempotency_key: nil,
+          request_id: nil,
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              status: Straddle::Paykeys::ReviewDecisionParams::Status::OrSymbol,
+              correlation_id: String,
+              idempotency_key: String,
+              request_id: String,
+              straddle_account_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Status
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::Paykeys::ReviewDecisionParams::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ACTIVE =
+            T.let(
+              :active,
+              Straddle::Paykeys::ReviewDecisionParams::Status::TaggedSymbol
+            )
+          REJECTED =
+            T.let(
+              :rejected,
+              Straddle::Paykeys::ReviewDecisionParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Straddle::Paykeys::ReviewDecisionParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module Paykeys
+      class ReviewGetParams < Straddle::Internal::Type::BaseModel
+        extend Straddle::Internal::Type::RequestParameters::Converter
+        include Straddle::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Straddle::Paykeys::ReviewGetParams,
+              Straddle::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :correlation_id
+
+        sig { params(correlation_id: String).void }
+        attr_writer :correlation_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :straddle_account_id
+
+        sig { params(straddle_account_id: String).void }
+        attr_writer :straddle_account_id
+
+        sig do
+          params(
+            id: String,
+            correlation_id: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id:,
+          correlation_id: nil,
+          request_id: nil,
+          straddle_account_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              correlation_id: String,
+              request_id: String,
+              straddle_account_id: String,
+              request_options: Straddle::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end