straddle 0.5.0 → 1.0.0

data/rbi/straddle/models/paykey_list_params.rbi

@@ -53,74 +53,58 @@ module Straddle
       sig { params(search_text: String).void }
       attr_writer :search_text
 
+      # Field used to sort the results.
       sig { returns(T.nilable(Straddle::PaykeyListParams::SortBy::OrSymbol)) }
       attr_reader :sort_by
 
       sig { params(sort_by: Straddle::PaykeyListParams::SortBy::OrSymbol).void }
       attr_writer :sort_by
 
-      sig do
-        returns(T.nilable(Straddle::PaykeyListParams::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::PaykeyListParams::SortOrder::OrSymbol).void
-      end
+      sig { params(sort_order: Straddle::SortOrder::OrSymbol).void }
       attr_writer :sort_order
 
       # Filter paykeys by their source.
-      sig do
-        returns(
-          T.nilable(T::Array[Straddle::PaykeyListParams::Source::OrSymbol])
-        )
-      end
+      sig { returns(T.nilable(T::Array[Straddle::PaykeySource::OrSymbol])) }
       attr_reader :source
 
-      sig do
-        params(
-          source: T::Array[Straddle::PaykeyListParams::Source::OrSymbol]
-        ).void
-      end
+      sig { params(source: T::Array[Straddle::PaykeySource::OrSymbol]).void }
       attr_writer :source
 
       # Filter paykeys by their current status.
-      sig do
-        returns(
-          T.nilable(T::Array[Straddle::PaykeyListParams::Status::OrSymbol])
-        )
-      end
+      sig { returns(T.nilable(T::Array[Straddle::PaykeyStatus::OrSymbol])) }
       attr_reader :status
 
-      sig do
-        params(
-          status: T::Array[Straddle::PaykeyListParams::Status::OrSymbol]
-        ).void
-      end
+      sig { params(status: T::Array[Straddle::PaykeyStatus::OrSymbol]).void }
       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.
+      # Filters paykeys by unblock eligibility. `true` returns blocked paykeys that are
+      # eligible because of an `R29` return and have not been unblocked before. `false`
+      # returns blocked paykeys that are not eligible.
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :unblock_eligible
 
       sig { params(unblock_eligible: T::Boolean).void }
       attr_writer :unblock_eligible
 
+      # 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
 
@@ -136,9 +120,9 @@ module Straddle
           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],
+          sort_order: Straddle::SortOrder::OrSymbol,
+          source: T::Array[Straddle::PaykeySource::OrSymbol],
+          status: T::Array[Straddle::PaykeyStatus::OrSymbol],
           unblock_eligible: T::Boolean,
           correlation_id: String,
           request_id: String,
@@ -159,19 +143,23 @@ module Straddle
         page_size: nil,
         # General search term to filter paykeys.
         search_text: nil,
+        # Field used to sort the results.
         sort_by: nil,
+        # Order in which to sort the results.
         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.
+        # Filters paykeys by unblock eligibility. `true` returns blocked paykeys that are
+        # eligible because of an `R29` return and have not been unblocked before. `false`
+        # returns blocked paykeys that are not eligible.
         unblock_eligible: 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: {}
       )
@@ -187,9 +175,9 @@ module Straddle
             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],
+            sort_order: Straddle::SortOrder::OrSymbol,
+            source: T::Array[Straddle::PaykeySource::OrSymbol],
+            status: T::Array[Straddle::PaykeyStatus::OrSymbol],
             unblock_eligible: T::Boolean,
             correlation_id: String,
             request_id: String,
@@ -226,80 +214,6 @@ module Straddle
         def self.values
         end
       end
-
-      module SortOrder
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Straddle::PaykeyListParams::SortOrder) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        ASC = T.let(:asc, Straddle::PaykeyListParams::SortOrder::TaggedSymbol)
-        DESC = T.let(:desc, Straddle::PaykeyListParams::SortOrder::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[Straddle::PaykeyListParams::SortOrder::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      module Source
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Straddle::PaykeyListParams::Source) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        BANK_ACCOUNT =
-          T.let(:bank_account, Straddle::PaykeyListParams::Source::TaggedSymbol)
-        STRADDLE =
-          T.let(:straddle, Straddle::PaykeyListParams::Source::TaggedSymbol)
-        MX = T.let(:mx, Straddle::PaykeyListParams::Source::TaggedSymbol)
-        PLAID = T.let(:plaid, Straddle::PaykeyListParams::Source::TaggedSymbol)
-        TAN = T.let(:tan, Straddle::PaykeyListParams::Source::TaggedSymbol)
-        QUILTT =
-          T.let(:quiltt, Straddle::PaykeyListParams::Source::TaggedSymbol)
-
-        sig do
-          override.returns(
-            T::Array[Straddle::PaykeyListParams::Source::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
-
-      module Status
-        extend Straddle::Internal::Type::Enum
-
-        TaggedSymbol =
-          T.type_alias { T.all(Symbol, Straddle::PaykeyListParams::Status) }
-        OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-        PENDING =
-          T.let(:pending, Straddle::PaykeyListParams::Status::TaggedSymbol)
-        ACTIVE =
-          T.let(:active, Straddle::PaykeyListParams::Status::TaggedSymbol)
-        INACTIVE =
-          T.let(:inactive, Straddle::PaykeyListParams::Status::TaggedSymbol)
-        REJECTED =
-          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(
-            T::Array[Straddle::PaykeyListParams::Status::TaggedSymbol]
-          )
-        end
-        def self.values
-        end
-      end
     end
   end
 end

data/rbi/straddle/models/paykey_list_unmasked_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaykeyListUnmaskedParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PaykeyListUnmaskedParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # 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
+
+      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:,
+        # 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: {}
+      )
+      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

data/rbi/straddle/models/paykey_processing_mode.rbi

@@ -0,0 +1,24 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module PaykeyProcessingMode
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol =
+        T.type_alias { T.all(Symbol, Straddle::PaykeyProcessingMode) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      INLINE = T.let(:inline, Straddle::PaykeyProcessingMode::TaggedSymbol)
+      BACKGROUND =
+        T.let(:background, Straddle::PaykeyProcessingMode::TaggedSymbol)
+      SKIP = T.let(:skip, Straddle::PaykeyProcessingMode::TaggedSymbol)
+
+      sig do
+        override.returns(T::Array[Straddle::PaykeyProcessingMode::TaggedSymbol])
+      end
+      def self.values
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykey_refresh_balance_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaykeyRefreshBalanceParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::PaykeyRefreshBalanceParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # 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 key for an idempotent request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # 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
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          id: String,
+          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:,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
+        idempotency_key: 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: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykey_refresh_review_params.rbi

@@ -0,0 +1,88 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaykeyRefreshReviewParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(
+            Straddle::PaykeyRefreshReviewParams,
+            Straddle::Internal::AnyHash
+          )
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # 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 key for an idempotent request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :idempotency_key
+
+      sig { params(idempotency_key: String).void }
+      attr_writer :idempotency_key
+
+      # 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
+
+      sig { params(straddle_account_id: String).void }
+      attr_writer :straddle_account_id
+
+      sig do
+        params(
+          id: String,
+          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:,
+        # Optional client-generated identifier for tracing a series of related requests.
+        correlation_id: nil,
+        # Optional client-generated key for an idempotent request.
+        idempotency_key: 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: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            id: String,
+            correlation_id: String,
+            idempotency_key: String,
+            request_id: String,
+            straddle_account_id: String,
+            request_options: Straddle::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykey_response.rbi

@@ -0,0 +1,67 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaykeyResponse < Straddle::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PaykeyResponse, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(Straddle::Paykey) }
+      attr_reader :data
+
+      sig { params(data: Straddle::Paykey::OrHash).void }
+      attr_writer :data
+
+      # Metadata for an API request.
+      sig { returns(Straddle::ResponseMetadata) }
+      attr_reader :meta
+
+      sig { params(meta: Straddle::ResponseMetadata::OrHash).void }
+      attr_writer :meta
+
+      # Shape of the response envelope.
+      #
+      # - `object` means `data` contains one JSON object.
+      # - `array` means `data` contains an array of JSON objects.
+      # - `error` means `error` contains the error details.
+      # - `none` means the response contains no data.
+      sig { returns(Straddle::ResponseType::TaggedSymbol) }
+      attr_accessor :response_type
+
+      sig do
+        params(
+          data: Straddle::Paykey::OrHash,
+          meta: Straddle::ResponseMetadata::OrHash,
+          response_type: Straddle::ResponseType::OrSymbol
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        data:,
+        # Metadata for an API request.
+        meta:,
+        # Shape of the response envelope.
+        #
+        # - `object` means `data` contains one JSON object.
+        # - `array` means `data` contains an array of JSON objects.
+        # - `error` means `error` contains the error details.
+        # - `none` means the response contains no data.
+        response_type:
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: Straddle::Paykey,
+            meta: Straddle::ResponseMetadata,
+            response_type: Straddle::ResponseType::TaggedSymbol
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/straddle/models/paykey_retrieve_params.rbi

@@ -0,0 +1,74 @@
+# typed: strong
+
+module Straddle
+  module Models
+    class PaykeyRetrieveParams < Straddle::Internal::Type::BaseModel
+      extend Straddle::Internal::Type::RequestParameters::Converter
+      include Straddle::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(Straddle::PaykeyRetrieveParams, Straddle::Internal::AnyHash)
+        end
+
+      sig { returns(String) }
+      attr_accessor :id
+
+      # 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
+
+      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:,
+        # 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: {}
+      )
+      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

data/rbi/straddle/models/paykey_reveal_params.rbi

@@ -14,18 +14,21 @@ module Straddle
       sig { returns(String) }
       attr_accessor :id
 
+      # 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
 
@@ -43,8 +46,11 @@ module Straddle
       end
       def self.new(
         id:,
+        # 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: {}
       )

data/rbi/straddle/models/paykey_source.rbi

@@ -0,0 +1,23 @@
+# typed: strong
+
+module Straddle
+  module Models
+    module PaykeySource
+      extend Straddle::Internal::Type::Enum
+
+      TaggedSymbol = T.type_alias { T.all(Symbol, Straddle::PaykeySource) }
+      OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+      BANK_ACCOUNT = T.let(:bank_account, Straddle::PaykeySource::TaggedSymbol)
+      STRADDLE = T.let(:straddle, Straddle::PaykeySource::TaggedSymbol)
+      MX = T.let(:mx, Straddle::PaykeySource::TaggedSymbol)
+      PLAID = T.let(:plaid, Straddle::PaykeySource::TaggedSymbol)
+      TAN = T.let(:tan, Straddle::PaykeySource::TaggedSymbol)
+      QUILTT = T.let(:quiltt, Straddle::PaykeySource::TaggedSymbol)
+
+      sig { override.returns(T::Array[Straddle::PaykeySource::TaggedSymbol]) }
+      def self.values
+      end
+    end
+  end
+end