straddle 0.3.0 → 0.4.0

data/rbi/straddle/resources/embed/linked_bank_accounts.rbi

@@ -3,6 +3,10 @@
 module Straddle
   module Resources
     class Embed
+      # Linked bank accounts connect your platform users' external bank accounts to
+      # Straddle for settlements and payment funding. Each linked account undergoes
+      # automated verification and continuous monitoring. Use linked accounts to manage
+      # where clients receive deposits, fund payouts, and track settlement preferences.
       class LinkedBankAccounts
         # Creates a new linked bank account associated with a Straddle account. This
         # endpoint allows you to associate external bank accounts with a Straddle account
@@ -32,7 +36,7 @@ module Straddle
           # Body param: The unique identifier of the Straddle account to associate this bank
           # account with.
           account_id:,
-          # Body param:
+          # Body param
           bank_account:,
           # Body param: Optional description for the bank account.
           description: nil,
@@ -72,9 +76,9 @@ module Straddle
           ).returns(Straddle::Embed::LinkedBankAccountV1)
         end
         def update(
-          # Path param:
+          # Path param
           linked_bank_account_id,
-          # Body param:
+          # Body param
           bank_account:,
           # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
           # additional information about the linked bank account in a structured format.
@@ -120,7 +124,7 @@ module Straddle
         def list(
           # Query param: The unique identifier of the related account.
           account_id: nil,
-          # Query param:
+          # Query param
           level: nil,
           # Query param: Results page number. Starts at page 1.
           page_number: nil,

data/rbi/straddle/resources/embed/organizations.rbi

@@ -3,6 +3,10 @@
 module Straddle
   module Resources
     class Embed
+      # Organizations are a powerful feature in Straddle that allow you to manage
+      # multiple accounts under a single umbrella. This hierarchical structure is
+      # particularly useful for businesses with complex operations, multiple
+      # departments, or legally related entities.
       class Organizations
         # Creates a new organization related to your Straddle integration. Organizations
         # can be used to group related accounts and manage permissions across multiple

data/rbi/straddle/resources/embed/representatives.rbi

@@ -3,6 +3,12 @@
 module Straddle
   module Resources
     class Embed
+      # Representatives are individuals who have legal authority or significant
+      # responsibility within a business entity associated with a Straddle account. Each
+      # representative undergoes automated verification as part of KYC/KYB compliance.
+      # Use representatives to collect and verify beneficial owners, control persons,
+      # and authorized signers required for account onboarding. Representatives also
+      # determine who can legally operate the account and make important changes.
       class Representatives
         # Creates a new representative associated with an account. Representatives are
         # individuals who have legal authority or significant responsibility within the
@@ -41,7 +47,7 @@ module Straddle
           last_name:,
           # Body param: The mobile phone number of the representative.
           mobile_number:,
-          # Body param:
+          # Body param
           relationship:,
           # Body param: The last 4 digits of the representative's Social Security Number.
           ssn_last4:,
@@ -85,7 +91,7 @@ module Straddle
           ).returns(Straddle::Embed::Representative)
         end
         def update(
-          # Path param:
+          # Path param
           representative_id,
           # Body param: The date of birth of the representative, in ISO 8601 format
           # (YYYY-MM-DD).
@@ -98,7 +104,7 @@ module Straddle
           last_name:,
           # Body param: The mobile phone number of the representative.
           mobile_number:,
-          # Body param:
+          # Body param
           relationship:,
           # Body param: The last 4 digits of the representative's Social Security Number.
           ssn_last4:,
@@ -146,15 +152,15 @@ module Straddle
         def list(
           # Query param: The unique identifier of the account to list representatives for.
           account_id: nil,
-          # Query param:
+          # Query param
           level: nil,
-          # Query param:
+          # Query param
           organization_id: nil,
           # Query param: Results page number. Starts at page 1.
           page_number: nil,
           # Query param: Page size. Max value: 1000
           page_size: nil,
-          # Query param:
+          # Query param
           platform_id: nil,
           # Query param: Sort By.
           sort_by: nil,

data/rbi/straddle/resources/embed.rbi

@@ -3,15 +3,34 @@
 module Straddle
   module Resources
     class Embed
+      # Accounts represent businesses using Straddle through your platform. Each account
+      # must complete automated verification before processing payments. Use accounts to
+      # manage your users' payment capabilities, track verification status, and control
+      # access to features. Accounts can be instantly created in sandbox and require
+      # additional verification for production access.
       sig { returns(Straddle::Resources::Embed::Accounts) }
       attr_reader :accounts
 
+      # Linked bank accounts connect your platform users' external bank accounts to
+      # Straddle for settlements and payment funding. Each linked account undergoes
+      # automated verification and continuous monitoring. Use linked accounts to manage
+      # where clients receive deposits, fund payouts, and track settlement preferences.
       sig { returns(Straddle::Resources::Embed::LinkedBankAccounts) }
       attr_reader :linked_bank_accounts
 
+      # Organizations are a powerful feature in Straddle that allow you to manage
+      # multiple accounts under a single umbrella. This hierarchical structure is
+      # particularly useful for businesses with complex operations, multiple
+      # departments, or legally related entities.
       sig { returns(Straddle::Resources::Embed::Organizations) }
       attr_reader :organizations
 
+      # Representatives are individuals who have legal authority or significant
+      # responsibility within a business entity associated with a Straddle account. Each
+      # representative undergoes automated verification as part of KYC/KYB compliance.
+      # Use representatives to collect and verify beneficial owners, control persons,
+      # and authorized signers required for account onboarding. Representatives also
+      # determine who can legally operate the account and make important changes.
       sig { returns(Straddle::Resources::Embed::Representatives) }
       attr_reader :representatives
 

data/rbi/straddle/resources/funding_events.rbi

@@ -2,6 +2,12 @@
 
 module Straddle
   module Resources
+    # Funding events represent all money movement between Straddle and an Account's
+    # external bank accounts. They are automatically generated when charges settle or
+    # payouts are initiated. Each event provides detailed tracking of settlement
+    # status, fee breakdowns, and reconciliation data across both incoming and
+    # outgoing transfers. Use funding events to monitor your platform's entire money
+    # movement lifecycle.
     class FundingEvents
       # Retrieves a list of funding events for your account. This endpoint supports
       # advanced sorting and filtering options.
@@ -16,6 +22,19 @@ module Straddle
           search_text: T.nilable(String),
           sort_by: Straddle::FundingEventListParams::SortBy::OrSymbol,
           sort_order: Straddle::FundingEventListParams::SortOrder::OrSymbol,
+          status:
+            T.nilable(
+              T::Array[Straddle::FundingEventListParams::Status::OrSymbol]
+            ),
+          status_reason:
+            T.nilable(
+              T::Array[Straddle::FundingEventListParams::StatusReason::OrSymbol]
+            ),
+          status_source:
+            T.nilable(
+              T::Array[Straddle::FundingEventListParams::StatusSource::OrSymbol]
+            ),
+          trace_id: T.nilable(String),
           trace_number: T.nilable(String),
           correlation_id: String,
           request_id: String,
@@ -50,6 +69,14 @@ module Straddle
         sort_by: nil,
         # Query param: The order in which to sort the results.
         sort_order: nil,
+        # Query param: Funding Event status.
+        status: nil,
+        # Query param: Reason for latest payment status change.
+        status_reason: nil,
+        # Query param: Source of latest payment status change.
+        status_source: nil,
+        # Query param: Trace Id.
+        trace_id: nil,
         # Query param: Trace number.
         trace_number: nil,
         # Header param: Optional client generated identifier to trace and debug a series

data/rbi/straddle/resources/paykeys/review.rbi

@@ -3,6 +3,11 @@
 module Straddle
   module Resources
     class Paykeys
+      # Paykeys are secure tokens that link verified customer identities to their bank
+      # accounts. Each Paykey includes built-in balance checking, fraud detection
+      # through LSTM machine learning models, and can be reused for subscriptions and
+      # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+      # ensuring the person initiating payment owns the funding account.
       class Review
         # Update the status of a paykey when in review status
         sig do
@@ -17,9 +22,9 @@ module Straddle
           ).returns(Straddle::PaykeyV1)
         end
         def decision(
-          # Path param:
+          # Path param
           id,
-          # Body param:
+          # Body param
           status:,
           # Header param: Optional client generated identifier to trace and debug a series
           # of requests.

data/rbi/straddle/resources/paykeys.rbi

@@ -2,7 +2,17 @@
 
 module Straddle
   module Resources
+    # Paykeys are secure tokens that link verified customer identities to their bank
+    # accounts. Each Paykey includes built-in balance checking, fraud detection
+    # through LSTM machine learning models, and can be reused for subscriptions and
+    # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+    # ensuring the person initiating payment owns the funding account.
     class Paykeys
+      # Paykeys are secure tokens that link verified customer identities to their bank
+      # accounts. Each Paykey includes built-in balance checking, fraud detection
+      # through LSTM machine learning models, and can be reused for subscriptions and
+      # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+      # ensuring the person initiating payment owns the funding account.
       sig { returns(Straddle::Resources::Paykeys::Review) }
       attr_reader :review
 
@@ -13,10 +23,12 @@ module Straddle
           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,
@@ -34,14 +46,21 @@ module Straddle
         page_number: nil,
         # Query param: Number of results per page. Maximum: 1000.
         page_size: nil,
-        # Query param:
+        # Query param: General search term to filter paykeys.
+        search_text: nil,
+        # Query param
         sort_by: nil,
-        # Query param:
+        # Query param
         sort_order: nil,
         # Query param: Filter paykeys by their source.
         source: nil,
         # Query param: Filter paykeys by their current status.
         status: nil,
+        # Query param: 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,
         # Header param: Optional client generated identifier to trace and debug a series
         # of requests.
         correlation_id: nil,
@@ -66,9 +85,9 @@ module Straddle
         ).returns(Straddle::PaykeyV1)
       end
       def cancel(
-        # Path param:
+        # Path param
         id,
-        # Body param:
+        # Body param
         reason: nil,
         # Header param: Optional client generated identifier to trace and debug a series
         # of requests.
@@ -108,10 +127,9 @@ module Straddle
       )
       end
 
-      # Retrieves the details of a paykey that has previously been created, including
-      # unmasked bank account fields. Supply the unique paykey ID that was returned from
-      # your previous request, and Straddle will return the corresponding paykey
-      # information.
+      # Retrieves the details of a paykey that has previously been created. Supply the
+      # unique paykey ID that was returned from your previous request, and Straddle will
+      # return the corresponding paykey information including the unmasked token.
       sig do
         params(
           id: String,

data/rbi/straddle/resources/payments.rbi

@@ -2,6 +2,8 @@
 
 module Straddle
   module Resources
+    # Payments provide endpoints to filter both Charges and Payouts with multiple
+    # different parameters.
     class Payments
       # Search for payments, including `charges` and `payouts`, using a variety of
       # criteria. This endpoint supports advanced sorting and filtering options.
@@ -14,6 +16,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,
@@ -51,16 +54,18 @@ module Straddle
       def list(
         # Query param: Search using the `customer_id` of a `charge` or `payout`.
         customer_id: nil,
-        # Query param:
+        # Query param
         default_page_size: nil,
         # Query param: The field to sort the results by.
         default_sort: nil,
-        # Query param:
+        # Query param
         default_sort_order: nil,
         # Query param: Search using the `external_id` of a `charge` or `payout`.
         external_id: nil,
         # Query param: Search using the `funding_id` of a `charge` or `payout`.
         funding_id: nil,
+        # Query param: Include the metadata for payments in the returned data.
+        include_metadata: nil,
         # Query param: Search using a maximum `amount` of a `charge` or `payout`.
         max_amount: nil,
         # Query param: Search using the latest `created_at` date of a `charge` or
@@ -98,7 +103,7 @@ module Straddle
         search_text: nil,
         # Query param: The field to sort the results by.
         sort_by: nil,
-        # Query param:
+        # Query param
         sort_order: nil,
         # Query param: Reason for latest payment status change.
         status_reason: nil,

data/rbi/straddle/resources/payouts.rbi

@@ -2,13 +2,17 @@
 
 module Straddle
   module Resources
+    # Payouts represent transfers from Straddle to customer bank accounts. Create
+    # payouts to handle disbursements, process refunds, or manage marketplace
+    # settlements. Use payouts to send money quickly and securely with the most
+    # cost-effective rail automatically selected.
     class Payouts
       # Use payouts to send money to your customers.
       sig do
         params(
           amount: Integer,
           currency: String,
-          description: String,
+          description: T.nilable(String),
           device: Straddle::DeviceInfoV1::OrHash,
           external_id: String,
           paykey: String,
@@ -40,7 +44,7 @@ module Straddle
         # Body param: The desired date on which the payout should be occur. For payouts,
         # this means the date you want the funds to be sent from your bank account.
         payment_date:,
-        # Body param:
+        # Body param
         config: nil,
         # Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
         # additional information about the payout in a structured format.
@@ -65,7 +69,7 @@ module Straddle
         params(
           id: String,
           amount: Integer,
-          description: String,
+          description: T.nilable(String),
           payment_date: Date,
           metadata: T.nilable(T::Hash[Symbol, String]),
           correlation_id: String,
@@ -76,7 +80,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def update(
-        # Path param:
+        # Path param
         id,
         # Body param: The amount of the payout in cents.
         amount:,
@@ -116,7 +120,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def cancel(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the payout status was updated.
         reason:,
@@ -171,7 +175,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def hold(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the payout status was updated.
         reason:,
@@ -203,7 +207,7 @@ module Straddle
         ).returns(Straddle::PayoutV1)
       end
       def release(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the payout status was updated.
         reason:,

data/sig/straddle/internal/util.rbs

@@ -106,6 +106,16 @@ module Straddle
       JSON_CONTENT: Regexp
       JSONL_CONTENT: Regexp
 
+      def encode_query_params: (
+        ::Hash[Symbol, top] query
+      ) -> ::Hash[Symbol, top]
+
+      private def write_query_param_element!: (
+        ::Hash[Symbol, top] collection,
+        String key,
+        top element
+      ) -> nil
+
       def self?.write_multipart_content: (
         Enumerator::Yielder y,
         val: top,

data/sig/straddle/models/bridge/link_create_paykey_response.rbs

@@ -201,7 +201,8 @@ module Straddle
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreatePaykeyResponse::Data::source]
           end
 
-          type status = :pending | :active | :inactive | :rejected | :review
+          type status =
+            :pending | :active | :inactive | :rejected | :review | :blocked
 
           module Status
             extend Straddle::Internal::Type::Enum
@@ -211,6 +212,7 @@ module Straddle
             INACTIVE: :inactive
             REJECTED: :rejected
             REVIEW: :review
+            BLOCKED: :blocked
 
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreatePaykeyResponse::Data::status]
           end
@@ -349,6 +351,13 @@ module Straddle
               | :ok
               | :other_network_return
               | :payout_refused
+              | :cancel_request
+              | :failed_verification
+              | :require_review
+              | :blocked_by_system
+              | :watchtower_review
+              | :validating
+              | :auto_hold
 
             module Reason
               extend Straddle::Internal::Type::Enum
@@ -373,6 +382,13 @@ module Straddle
               OK: :ok
               OTHER_NETWORK_RETURN: :other_network_return
               PAYOUT_REFUSED: :payout_refused
+              CANCEL_REQUEST: :cancel_request
+              FAILED_VERIFICATION: :failed_verification
+              REQUIRE_REVIEW: :require_review
+              BLOCKED_BY_SYSTEM: :blocked_by_system
+              WATCHTOWER_REVIEW: :watchtower_review
+              VALIDATING: :validating
+              AUTO_HOLD: :auto_hold
 
               def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreatePaykeyResponse::Data::StatusDetails::reason]
             end

data/sig/straddle/models/bridge/link_create_tan_response.rbs

@@ -201,7 +201,8 @@ module Straddle
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreateTanResponse::Data::source]
           end
 
-          type status = :pending | :active | :inactive | :rejected | :review
+          type status =
+            :pending | :active | :inactive | :rejected | :review | :blocked
 
           module Status
             extend Straddle::Internal::Type::Enum
@@ -211,6 +212,7 @@ module Straddle
             INACTIVE: :inactive
             REJECTED: :rejected
             REVIEW: :review
+            BLOCKED: :blocked
 
             def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreateTanResponse::Data::status]
           end
@@ -349,6 +351,13 @@ module Straddle
               | :ok
               | :other_network_return
               | :payout_refused
+              | :cancel_request
+              | :failed_verification
+              | :require_review
+              | :blocked_by_system
+              | :watchtower_review
+              | :validating
+              | :auto_hold
 
             module Reason
               extend Straddle::Internal::Type::Enum
@@ -373,6 +382,13 @@ module Straddle
               OK: :ok
               OTHER_NETWORK_RETURN: :other_network_return
               PAYOUT_REFUSED: :payout_refused
+              CANCEL_REQUEST: :cancel_request
+              FAILED_VERIFICATION: :failed_verification
+              REQUIRE_REVIEW: :require_review
+              BLOCKED_BY_SYSTEM: :blocked_by_system
+              WATCHTOWER_REVIEW: :watchtower_review
+              VALIDATING: :validating
+              AUTO_HOLD: :auto_hold
 
               def self?.values: -> ::Array[Straddle::Models::Bridge::LinkCreateTanResponse::Data::StatusDetails::reason]
             end

data/sig/straddle/models/charge_cancel_params.rbs

@@ -2,6 +2,7 @@ module Straddle
   module Models
     type charge_cancel_params =
       {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,
@@ -14,6 +15,8 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_accessor reason: String?
 
       attr_reader correlation_id: String?
@@ -33,6 +36,7 @@ module Straddle
       def straddle_account_id=: (String) -> String
 
       def initialize: (
+        id: String,
         ?reason: String?,
         ?correlation_id: String,
         ?idempotency_key: String,
@@ -42,6 +46,7 @@ module Straddle
       ) -> void
 
       def to_hash: -> {
+        id: String,
         reason: String?,
         correlation_id: String,
         idempotency_key: String,

data/sig/straddle/models/charge_create_params.rbs

@@ -6,7 +6,7 @@ module Straddle
         config: Straddle::ChargeCreateParams::Config,
         consent_type: Straddle::Models::ChargeCreateParams::consent_type,
         currency: String,
-        description: String,
+        description: String?,
         device: Straddle::DeviceInfoV1,
         external_id: String,
         paykey: String,
@@ -31,7 +31,7 @@ module Straddle
 
       attr_accessor currency: String
 
-      attr_accessor description: String
+      attr_accessor description: String?
 
       attr_accessor device: Straddle::DeviceInfoV1
 
@@ -64,7 +64,7 @@ module Straddle
         config: Straddle::ChargeCreateParams::Config,
         consent_type: Straddle::Models::ChargeCreateParams::consent_type,
         currency: String,
-        description: String,
+        description: String?,
         device: Straddle::DeviceInfoV1,
         external_id: String,
         paykey: String,
@@ -82,7 +82,7 @@ module Straddle
         config: Straddle::ChargeCreateParams::Config,
         consent_type: Straddle::Models::ChargeCreateParams::consent_type,
         currency: String,
-        description: String,
+        description: String?,
         device: Straddle::DeviceInfoV1,
         external_id: String,
         paykey: String,
@@ -98,12 +98,18 @@ module Straddle
       type config =
         {
           balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check,
+          auto_hold: bool?,
+          auto_hold_message: String?,
           sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome
         }
 
       class Config < Straddle::Internal::Type::BaseModel
         attr_accessor balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check
 
+        attr_accessor auto_hold: bool?
+
+        attr_accessor auto_hold_message: String?
+
         attr_reader sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome?
 
         def sandbox_outcome=: (
@@ -112,11 +118,15 @@ module Straddle
 
         def initialize: (
           balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check,
+          ?auto_hold: bool?,
+          ?auto_hold_message: String?,
           ?sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome
         ) -> void
 
         def to_hash: -> {
           balance_check: Straddle::Models::ChargeCreateParams::Config::balance_check,
+          auto_hold: bool?,
+          auto_hold_message: String?,
           sandbox_outcome: Straddle::Models::ChargeCreateParams::Config::sandbox_outcome
         }
 

data/sig/straddle/models/charge_get_params.rbs

@@ -2,6 +2,7 @@ module Straddle
   module Models
     type charge_get_params =
       {
+        id: String,
         correlation_id: String,
         request_id: String,
         straddle_account_id: String
@@ -12,6 +13,8 @@ module Straddle
       extend Straddle::Internal::Type::RequestParameters::Converter
       include Straddle::Internal::Type::RequestParameters
 
+      attr_accessor id: String
+
       attr_reader correlation_id: String?
 
       def correlation_id=: (String) -> String
@@ -25,6 +28,7 @@ module Straddle
       def straddle_account_id=: (String) -> String
 
       def initialize: (
+        id: String,
         ?correlation_id: String,
         ?request_id: String,
         ?straddle_account_id: String,
@@ -32,6 +36,7 @@ module Straddle
       ) -> void
 
       def to_hash: -> {
+        id: String,
         correlation_id: String,
         request_id: String,
         straddle_account_id: String,