straddle 0.3.0 → 0.5.0

data/rbi/straddle/resources/bridge/link.rbi

@@ -3,6 +3,12 @@
 module Straddle
   module Resources
     class Bridge
+      # Bridge provides a comprehensive suite of tools for connecting customer bank
+      # accounts. Use it to generate secure widget sessions for instant account
+      # verification, accept tokens from major providers like Plaid and Finicity, or
+      # verify accounts directly via our API. Bridge handles all sensitive banking
+      # credentials and ensures secure, compliant connections with support for 90% of US
+      # bank accounts.
       class Link
         # Use Bridge to create a new paykey using a bank routing and account number as the
         # source. This endpoint allows you to create a secure payment token linked to a
@@ -27,13 +33,13 @@ module Straddle
         def bank_account(
           # Body param: The bank account number.
           account_number:,
-          # Body param:
+          # Body param
           account_type:,
           # Body param: Unique identifier of the related customer object.
           customer_id:,
           # Body param: The routing number of the bank account.
           routing_number:,
-          # Body param:
+          # Body param
           config: nil,
           # Body param: Unique identifier for the paykey in your database, used for
           # cross-referencing between Straddle and your systems.
@@ -78,7 +84,7 @@ module Straddle
           # Body param: Quiltt processor token generated by your application for use with
           # the Straddle API.
           quiltt_token:,
-          # Body param:
+          # Body param
           config: nil,
           # Body param: Unique identifier for the paykey in your database, used for
           # cross-referencing between Straddle and your systems.
@@ -118,7 +124,7 @@ module Straddle
           ).returns(Straddle::Models::Bridge::LinkCreateTanResponse)
         end
         def create_tan(
-          # Body param:
+          # Body param
           account_type:,
           # Body param: Unique identifier of the related customer object.
           customer_id:,
@@ -126,7 +132,7 @@ module Straddle
           routing_number:,
           # Body param: Tokenized account number.
           tan:,
-          # Body param:
+          # Body param
           config: nil,
           # Body param: Unique identifier for the paykey in your database, used for
           # cross-referencing between Straddle and your systems.
@@ -171,7 +177,7 @@ module Straddle
           # Body param: Plaid processor token generated by your application for use with the
           # Straddle API.
           plaid_token:,
-          # Body param:
+          # Body param
           config: nil,
           # Body param: Unique identifier for the paykey in your database, used for
           # cross-referencing between Straddle and your systems.

data/rbi/straddle/resources/bridge.rbi

@@ -2,7 +2,19 @@
 
 module Straddle
   module Resources
+    # Bridge provides a comprehensive suite of tools for connecting customer bank
+    # accounts. Use it to generate secure widget sessions for instant account
+    # verification, accept tokens from major providers like Plaid and Finicity, or
+    # verify accounts directly via our API. Bridge handles all sensitive banking
+    # credentials and ensures secure, compliant connections with support for 90% of US
+    # bank accounts.
     class Bridge
+      # Bridge provides a comprehensive suite of tools for connecting customer bank
+      # accounts. Use it to generate secure widget sessions for instant account
+      # verification, accept tokens from major providers like Plaid and Finicity, or
+      # verify accounts directly via our API. Bridge handles all sensitive banking
+      # credentials and ensures secure, compliant connections with support for 90% of US
+      # bank accounts.
       sig { returns(Straddle::Resources::Bridge::Link) }
       attr_reader :link
 
@@ -23,7 +35,7 @@ module Straddle
         # Body param: The Straddle generated unique identifier of the `customer` to create
         # a bridge token for.
         customer_id:,
-        # Body param:
+        # Body param
         config: nil,
         # Body param: Unique identifier for the paykey in your database, used for
         # cross-referencing between Straddle and your systems.

data/rbi/straddle/resources/charges.rbi

@@ -2,6 +2,11 @@
 
 module Straddle
   module Resources
+    # Charges represent attempts to debit money from a customer's bank account using a
+    # Paykey. Each charge includes automatic balance verification, real-time fraud
+    # screening, and multi-rail optimization and detailed status tracking throughout
+    # the payment lifecycle. Use charges to accept bank payments with confidence
+    # knowing every transaction is protected.
     class Charges
       # Use charges to collect money from a customer for the sale of goods or services.
       sig do
@@ -10,7 +15,7 @@ module Straddle
           config: Straddle::ChargeCreateParams::Config::OrHash,
           consent_type: Straddle::ChargeCreateParams::ConsentType::OrSymbol,
           currency: String,
-          description: String,
+          description: T.nilable(String),
           device: Straddle::DeviceInfoV1::OrHash,
           external_id: String,
           paykey: String,
@@ -26,7 +31,7 @@ module Straddle
       def create(
         # Body param: The amount of the charge in cents.
         amount:,
-        # Body param:
+        # Body param
         config:,
         # Body param: The channel or mechanism through which the payment was authorized.
         # Use `internet` for payments made online or through a mobile app and `signed` for
@@ -37,7 +42,7 @@ module Straddle
         currency:,
         # Body param: An arbitrary description for the charge.
         description:,
-        # Body param:
+        # Body param
         device:,
         # Body param: Unique identifier for the charge in your database. This value must
         # be unique across all charges.
@@ -70,7 +75,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,
@@ -81,7 +86,7 @@ module Straddle
         ).returns(Straddle::ChargeV1)
       end
       def update(
-        # Path param:
+        # Path param
         id,
         # Body param: The amount of the charge in cents.
         amount:,
@@ -121,7 +126,7 @@ module Straddle
         ).returns(Straddle::ChargeV1)
       end
       def cancel(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the charge status was updated.
         reason: nil,
@@ -176,7 +181,7 @@ module Straddle
         ).returns(Straddle::ChargeV1)
       end
       def hold(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the charge status was updated.
         reason: nil,
@@ -208,7 +213,7 @@ module Straddle
         ).returns(Straddle::ChargeV1)
       end
       def release(
-        # Path param:
+        # Path param
         id,
         # Body param: Details about why the charge status was updated.
         reason: nil,

data/rbi/straddle/resources/customers/review.rbi

@@ -3,6 +3,12 @@
 module Straddle
   module Resources
     class Customers
+      # Customers represent the end users who send or receive payments through your
+      # integration. Each customer undergoes automatic identity verification and fraud
+      # screening upon creation. Use customers to track payment history, manage bank
+      # account connections, and maintain a secure record of all transactions associated
+      # with a user. Customers can be either individuals or businesses with appropriate
+      # compliance checks for each type.
       class Review
         # Updates the status of a customer's identity decision. This endpoint allows you
         # to modify the outcome of a customer risk screening and is useful for correcting
@@ -20,7 +26,7 @@ module Straddle
           ).returns(Straddle::CustomerV1)
         end
         def decision(
-          # Path param:
+          # Path param
           id,
           # Body param: The final status of the customer review.
           status:,

data/rbi/straddle/resources/customers.rbi

@@ -2,7 +2,19 @@
 
 module Straddle
   module Resources
+    # Customers represent the end users who send or receive payments through your
+    # integration. Each customer undergoes automatic identity verification and fraud
+    # screening upon creation. Use customers to track payment history, manage bank
+    # account connections, and maintain a secure record of all transactions associated
+    # with a user. Customers can be either individuals or businesses with appropriate
+    # compliance checks for each type.
     class Customers
+      # Customers represent the end users who send or receive payments through your
+      # integration. Each customer undergoes automatic identity verification and fraud
+      # screening upon creation. Use customers to track payment history, manage bank
+      # account connections, and maintain a secure record of all transactions associated
+      # with a user. Customers can be either individuals or businesses with appropriate
+      # compliance checks for each type.
       sig { returns(Straddle::Resources::Customers::Review) }
       attr_reader :review
 
@@ -35,7 +47,7 @@ module Straddle
         ).returns(Straddle::CustomerV1)
       end
       def create(
-        # Body param:
+        # Body param
         device:,
         # Body param: The customer's email address.
         email:,
@@ -44,7 +56,7 @@ module Straddle
         # Body param: The customer's phone number in E.164 format. Mobile number is
         # preferred.
         phone:,
-        # Body param:
+        # Body param
         type:,
         # Body param: An object containing the customer's address. **This is optional.**
         # If used, all required fields must be present.
@@ -53,7 +65,7 @@ module Straddle
         # optional.** If all required fields must be present for the appropriate customer
         # type.
         compliance_profile: nil,
-        # Body param:
+        # Body param
         config: nil,
         # Body param: Unique identifier for the customer in your database, used for
         # cross-referencing between Straddle and your systems.
@@ -103,9 +115,9 @@ module Straddle
         ).returns(Straddle::CustomerV1)
       end
       def update(
-        # Path param:
+        # Path param
         id,
-        # Body param:
+        # Body param
         device:,
         # Body param: The customer's email address.
         email:,
@@ -113,7 +125,7 @@ module Straddle
         name:,
         # Body param: The customer's phone number in E.164 format.
         phone:,
-        # Body param:
+        # Body param
         status:,
         # Body param: An object containing the customer's address. This is optional, but
         # if provided, all required fields must be present.
@@ -186,9 +198,9 @@ module Straddle
         page_size: nil,
         # Query param: General search term to filter customers.
         search_text: nil,
-        # Query param:
+        # Query param
         sort_by: nil,
-        # Query param:
+        # Query param
         sort_order: nil,
         # Query param: Filter customers by their current `status`.
         status: nil,

data/rbi/straddle/resources/embed/accounts/capability_requests.rbi

@@ -4,6 +4,10 @@ module Straddle
   module Resources
     class Embed
       class Accounts
+        # Capabilities enable specific features and services for an Account. Use
+        # capability requests to unlock higher processing limits, new payment types, or
+        # additional platform features as your users' businesses grow. Track approval
+        # status and manage documentation requirements through a single interface.
         class CapabilityRequests
           # Submits a request to enable a specific capability for an account. Use this
           # endpoint to request additional features or services for an account.
@@ -29,7 +33,7 @@ module Straddle
             ).returns(Straddle::Embed::Accounts::CapabilityRequestPagedV1)
           end
           def create(
-            # Path param:
+            # Path param
             account_id,
             # Body param: Allows the account to accept payments from businesses.
             businesses: nil,
@@ -83,7 +87,7 @@ module Straddle
             )
           end
           def list(
-            # Path param:
+            # Path param
             account_id,
             # Query param: Filter capability requests by category.
             category: nil,

data/rbi/straddle/resources/embed/accounts.rbi

@@ -3,7 +3,16 @@
 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.
       class Accounts
+        # Capabilities enable specific features and services for an Account. Use
+        # capability requests to unlock higher processing limits, new payment types, or
+        # additional platform features as your users' businesses grow. Track approval
+        # status and manage documentation requirements through a single interface.
         sig do
           returns(Straddle::Resources::Embed::Accounts::CapabilityRequests)
         end
@@ -35,7 +44,7 @@ module Straddle
           # Body param: The type of account to be created. Currently, only `business` is
           # supported.
           account_type:,
-          # Body param:
+          # Body param
           business_profile:,
           # Body param: The unique identifier of the organization related to this account.
           organization_id:,
@@ -71,9 +80,9 @@ module Straddle
           ).returns(Straddle::Embed::AccountV1)
         end
         def update(
-          # Path param:
+          # Path param
           account_id,
-          # Body param:
+          # Body param
           business_profile:,
           # Body param: Unique identifier for the account in your database, used for
           # cross-referencing between Straddle and your systems.
@@ -98,6 +107,7 @@ module Straddle
         # filtering options.
         sig do
           params(
+            external_id: String,
             page_number: Integer,
             page_size: Integer,
             search_text: String,
@@ -115,19 +125,21 @@ module Straddle
           )
         end
         def list(
+          # Query param
+          external_id: nil,
           # Query param: Results page number. Starts at page 1. Default value: 1
           page_number: nil,
           # Query param: Page size. Default value: 100. Max value: 1000
           page_size: nil,
-          # Query param:
+          # Query param
           search_text: nil,
           # Query param: Sort By. Default value: 'id'.
           sort_by: nil,
           # Query param: Sort Order. Default value: 'asc'.
           sort_order: nil,
-          # Query param:
+          # Query param
           status: nil,
-          # Query param:
+          # Query param
           type: nil,
           # Header param: Optional client generated identifier to trace and debug a series
           # of requests.
@@ -174,9 +186,9 @@ module Straddle
           ).returns(Straddle::Embed::AccountV1)
         end
         def onboard(
-          # Path param:
+          # Path param
           account_id,
-          # Body param:
+          # Body param
           terms_of_service:,
           # Header param: Optional client generated identifier to trace and debug a series
           # of requests.
@@ -203,9 +215,9 @@ module Straddle
           ).returns(Straddle::Embed::AccountV1)
         end
         def simulate(
-          # Path param:
+          # Path param
           account_id,
-          # Query param:
+          # Query param
           final_status: nil,
           # Header param: Optional client generated identifier to trace and debug a series
           # of requests.

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.