straddle 0.3.0 → 0.4.0

data/rbi/straddle/models/payout_v1.rbi

@@ -89,7 +89,7 @@ module Straddle
         attr_accessor :currency
 
         # An arbitrary description for the payout.
-        sig { returns(String) }
+        sig { returns(T.nilable(String)) }
         attr_accessor :description
 
         # Information about the device used when the customer authorized the payout.
@@ -132,6 +132,10 @@ module Straddle
         sig { returns(T::Array[Straddle::PayoutV1::Data::StatusHistory]) }
         attr_accessor :status_history
 
+        # Trace Ids.
+        sig { returns(T::Hash[Symbol, String]) }
+        attr_accessor :trace_ids
+
         # The time the payout was created.
         sig { returns(T.nilable(Time)) }
         attr_accessor :created_at
@@ -182,6 +186,19 @@ module Straddle
         sig { returns(T.nilable(Time)) }
         attr_accessor :processed_at
 
+        # Related payments.
+        sig do
+          returns(
+            T.nilable(
+              T::Hash[
+                Symbol,
+                Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+              ]
+            )
+          )
+        end
+        attr_accessor :related_payments
+
         # The time the payout was last updated.
         sig { returns(T.nilable(Time)) }
         attr_accessor :updated_at
@@ -192,7 +209,7 @@ module Straddle
             amount: Integer,
             config: Straddle::PayoutV1::Data::Config::OrHash,
             currency: String,
-            description: String,
+            description: T.nilable(String),
             device: Straddle::DeviceInfoV1::OrHash,
             external_id: String,
             funding_ids: T::Array[String],
@@ -202,6 +219,7 @@ module Straddle
             status_details: Straddle::StatusDetailsV1::OrHash,
             status_history:
               T::Array[Straddle::PayoutV1::Data::StatusHistory::OrHash],
+            trace_ids: T::Hash[Symbol, String],
             created_at: T.nilable(Time),
             customer_details: Straddle::CustomerDetailsV1::OrHash,
             effective_at: T.nilable(Time),
@@ -209,6 +227,13 @@ module Straddle
             paykey_details: Straddle::PaykeyDetailsV1::OrHash,
             payment_rail: Straddle::PayoutV1::Data::PaymentRail::OrSymbol,
             processed_at: T.nilable(Time),
+            related_payments:
+              T.nilable(
+                T::Hash[
+                  Symbol,
+                  Straddle::PayoutV1::Data::RelatedPayment::OrSymbol
+                ]
+              ),
             updated_at: T.nilable(Time)
           ).returns(T.attached_class)
         end
@@ -241,6 +266,8 @@ module Straddle
           status_details:,
           # History of the status changes for the payout.
           status_history:,
+          # Trace Ids.
+          trace_ids:,
           # The time the payout was created.
           created_at: nil,
           # Information about the customer associated with the payout.
@@ -258,6 +285,8 @@ module Straddle
           # The time the payout was processed by Straddle and originated to the payment
           # rail.
           processed_at: nil,
+          # Related payments.
+          related_payments: nil,
           # The time the payout was last updated.
           updated_at: nil
         )
@@ -270,7 +299,7 @@ module Straddle
               amount: Integer,
               config: Straddle::PayoutV1::Data::Config,
               currency: String,
-              description: String,
+              description: T.nilable(String),
               device: Straddle::DeviceInfoV1,
               external_id: String,
               funding_ids: T::Array[String],
@@ -279,6 +308,7 @@ module Straddle
               status: Straddle::PayoutV1::Data::Status::TaggedSymbol,
               status_details: Straddle::StatusDetailsV1,
               status_history: T::Array[Straddle::PayoutV1::Data::StatusHistory],
+              trace_ids: T::Hash[Symbol, String],
               created_at: T.nilable(Time),
               customer_details: Straddle::CustomerDetailsV1,
               effective_at: T.nilable(Time),
@@ -286,6 +316,13 @@ module Straddle
               paykey_details: Straddle::PaykeyDetailsV1,
               payment_rail: Straddle::PayoutV1::Data::PaymentRail::TaggedSymbol,
               processed_at: T.nilable(Time),
+              related_payments:
+                T.nilable(
+                  T::Hash[
+                    Symbol,
+                    Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+                  ]
+                ),
               updated_at: T.nilable(Time)
             }
           )
@@ -302,6 +339,14 @@ module Straddle
               )
             end
 
+          # Defines whether to automatically place this charge on hold after being created.
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_accessor :auto_hold
+
+          # The reason the payout is being automatically held on creation.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :auto_hold_message
+
           # Payment will simulate processing if not Standard.
           sig do
             returns(
@@ -323,11 +368,17 @@ module Straddle
           # Configuration for the payout.
           sig do
             params(
+              auto_hold: T.nilable(T::Boolean),
+              auto_hold_message: T.nilable(String),
               sandbox_outcome:
                 Straddle::PayoutV1::Data::Config::SandboxOutcome::OrSymbol
             ).returns(T.attached_class)
           end
           def self.new(
+            # Defines whether to automatically place this charge on hold after being created.
+            auto_hold: nil,
+            # The reason the payout is being automatically held on creation.
+            auto_hold_message: nil,
             # Payment will simulate processing if not Standard.
             sandbox_outcome: nil
           )
@@ -336,6 +387,8 @@ module Straddle
           sig do
             override.returns(
               {
+                auto_hold: T.nilable(T::Boolean),
+                auto_hold_message: T.nilable(String),
                 sandbox_outcome:
                   Straddle::PayoutV1::Data::Config::SandboxOutcome::TaggedSymbol
               }
@@ -445,6 +498,8 @@ module Straddle
           PAID = T.let(:paid, Straddle::PayoutV1::Data::Status::TaggedSymbol)
           REVERSED =
             T.let(:reversed, Straddle::PayoutV1::Data::Status::TaggedSymbol)
+          VALIDATING =
+            T.let(:validating, Straddle::PayoutV1::Data::Status::TaggedSymbol)
 
           sig do
             override.returns(
@@ -659,6 +714,41 @@ module Straddle
                 :payout_refused,
                 Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
               )
+            CANCEL_REQUEST =
+              T.let(
+                :cancel_request,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            FAILED_VERIFICATION =
+              T.let(
+                :failed_verification,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            REQUIRE_REVIEW =
+              T.let(
+                :require_review,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            BLOCKED_BY_SYSTEM =
+              T.let(
+                :blocked_by_system,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            WATCHTOWER_REVIEW =
+              T.let(
+                :watchtower_review,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
+            AUTO_HOLD =
+              T.let(
+                :auto_hold,
+                Straddle::PayoutV1::Data::StatusHistory::Reason::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -769,6 +859,11 @@ module Straddle
                 :reversed,
                 Straddle::PayoutV1::Data::StatusHistory::Status::TaggedSymbol
               )
+            VALIDATING =
+              T.let(
+                :validating,
+                Straddle::PayoutV1::Data::StatusHistory::Status::TaggedSymbol
+              )
 
             sig do
               override.returns(
@@ -802,6 +897,40 @@ module Straddle
           def self.values
           end
         end
+
+        module RelatedPayment
+          extend Straddle::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Straddle::PayoutV1::Data::RelatedPayment)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          ORIGINAL =
+            T.let(
+              :original,
+              Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+            )
+          RESUBMIT =
+            T.let(
+              :resubmit,
+              Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+            )
+          REFUND =
+            T.let(
+              :refund,
+              Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[Straddle::PayoutV1::Data::RelatedPayment::TaggedSymbol]
+            )
+          end
+          def self.values
+          end
+        end
       end
 
       # Indicates the structure of the returned content.

data/rbi/straddle/models/status_details_v1.rbi

@@ -162,6 +162,35 @@ module Straddle
             :payout_refused,
             Straddle::StatusDetailsV1::Reason::TaggedSymbol
           )
+        CANCEL_REQUEST =
+          T.let(
+            :cancel_request,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        FAILED_VERIFICATION =
+          T.let(
+            :failed_verification,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        REQUIRE_REVIEW =
+          T.let(
+            :require_review,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        BLOCKED_BY_SYSTEM =
+          T.let(
+            :blocked_by_system,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        WATCHTOWER_REVIEW =
+          T.let(
+            :watchtower_review,
+            Straddle::StatusDetailsV1::Reason::TaggedSymbol
+          )
+        VALIDATING =
+          T.let(:validating, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
+        AUTO_HOLD =
+          T.let(:auto_hold, Straddle::StatusDetailsV1::Reason::TaggedSymbol)
 
         sig do
           override.returns(

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.
@@ -119,15 +128,15 @@ module Straddle
           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 +183,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 +212,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.