straddle 0.4.0 → 1.0.0

data/rbi/straddle/resources/accounts.rbi

@@ -0,0 +1,211 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    # Accounts represent businesses that use Straddle through a platform.
+    class Accounts
+      # Creates a business account in the specified organization and returns the
+      # account.
+      sig do
+        params(
+          access_level: Straddle::AccountCreateParams::AccessLevel::OrSymbol,
+          account_type: Straddle::AccountCreateParams::AccountType::OrSymbol,
+          business_profile: Straddle::AccountBusinessProfile::OrHash,
+          organization_id: String,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::AccountResponse)
+      end
+      def create(
+        # Body param: The account access level. `standard` provides normal account access,
+        # including access to the Straddle dashboard. `managed` means the platform manages
+        # the account and account users cannot access the Straddle dashboard.
+        access_level:,
+        # Body param: Account type. The only accepted value is `business`.
+        account_type:,
+        # Body param
+        business_profile:,
+        # Body param: ID of the organization that will own the account.
+        organization_id:,
+        # Body param: Your unique ID for the account.
+        external_id: nil,
+        # Body param: Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns the account with the specified ID.
+      sig do
+        params(
+          account_id: String,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::AccountResponse)
+      end
+      def retrieve(
+        # The ID of the account.
+        account_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,
+        request_options: {}
+      )
+      end
+
+      # Updates an account's business profile, metadata, and external ID, then returns
+      # the account.
+      sig do
+        params(
+          account_id: String,
+          business_profile: Straddle::AccountBusinessProfile::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, T.nilable(String)]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::AccountResponse)
+      end
+      def update(
+        # Path param: The ID of the account.
+        account_id,
+        # Body param
+        business_profile:,
+        # Body param: Your unique ID for the account.
+        external_id: nil,
+        # Body param: Up to 20 user-defined key-value pairs.
+        metadata: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of accounts for your platform. Filter the list by
+      # status, type, external ID, or text search.
+      sig do
+        params(
+          external_id: String,
+          page_number: Integer,
+          page_size: Integer,
+          search_text: String,
+          sort_by: String,
+          sort_order: Straddle::AccountListParams::SortOrder::OrSymbol,
+          status: Straddle::AccountListParams::Status::OrSymbol,
+          type: Straddle::AccountListParams::Type::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::AccountList)
+      end
+      def list(
+        # Query param: Your external ID for the account.
+        external_id: nil,
+        # Query param: Page number. Defaults to `1`.
+        page_number: nil,
+        # Query param: Number of results per page. Defaults to `100`. Maximum `1000`.
+        page_size: nil,
+        # Query param: Text to search for across account fields.
+        search_text: nil,
+        # Query param: Field used to sort results. Defaults to `id`.
+        sort_by: nil,
+        # Query param: Sort direction. Defaults to `asc`.
+        sort_order: nil,
+        # Query param: Account status to return.
+        status: nil,
+        # Query param: Account type to return.
+        type: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Starts onboarding and records the account's acceptance of Straddle's Terms of
+      # Service. The account must have at least one representative and one linked bank
+      # account. This operation also moves all associated representatives and linked
+      # bank accounts to `onboarding`.
+      sig do
+        params(
+          account_id: String,
+          terms_of_service: Straddle::TermsOfService::OrHash,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::AccountResponse)
+      end
+      def onboard(
+        # Path param: The ID of the account.
+        account_id,
+        # Body param
+        terms_of_service:,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Simulates an account status transition to `onboarding` or `active` in the
+      # sandbox and returns the account.
+      sig do
+        params(
+          account_id: String,
+          final_status:
+            Straddle::AccountSimulateOnboardingParams::FinalStatus::OrSymbol,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::AccountResponse)
+      end
+      def simulate_onboarding(
+        # Path param: The ID of the account.
+        account_id,
+        # Query param: Final account status to produce in the sandbox simulation.
+        final_status: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Straddle::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end

data/rbi/straddle/resources/bridge.rbi

@@ -2,53 +2,167 @@
 
 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.
+    # Bridge connects customer bank accounts and creates paykeys from supported
+    # provider tokens or bank account details.
     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
+      # Creates a paykey from a routing number, account number, and account type.
+      sig do
+        params(
+          account_number: String,
+          account_type: Straddle::AccountType::OrSymbol,
+          customer_id: String,
+          routing_number: String,
+          config: Straddle::PaykeyConfiguration::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PaykeyResponse)
+      end
+      def create_bank_account_paykey(
+        # Body param: Bank account number.
+        account_number:,
+        # Body param
+        account_type:,
+        # Body param: Unique identifier for the customer associated with the paykey.
+        customer_id:,
+        # Body param: Bank routing number.
+        routing_number:,
+        # Body param
+        config: nil,
+        # Body param: Unique identifier for the paykey in your system.
+        external_id: nil,
+        # Body param: Up to 20 user-defined key-value pairs associated with the paykey.
+        metadata: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        # Header param: For platform requests, the embedded account UUID that sets the
+        # request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Creates a paykey from a Plaid processor token.
+      sig do
+        params(
+          customer_id: String,
+          plaid_token: String,
+          config: Straddle::PaykeyConfiguration::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::PaykeyResponse)
+      end
+      def create_plaid_paykey(
+        # Body param: Unique identifier for the customer associated with the paykey.
+        customer_id:,
+        # Body param: Plaid processor token generated by your application for use with the
+        # Straddle API.
+        plaid_token:,
+        # Body param
+        config: nil,
+        # Body param: Unique identifier for the paykey in your system.
+        external_id: nil,
+        # Body param: Up to 20 user-defined key-value pairs associated with the paykey.
+        metadata: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        # Header param: For platform requests, the embedded account UUID that sets the
+        # request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Creates a paykey from a Quiltt processor token.
+      sig do
+        params(
+          customer_id: String,
+          quiltt_token: String,
+          config: Straddle::PaykeyConfiguration::OrHash,
+          external_id: T.nilable(String),
+          metadata: T.nilable(T::Hash[Symbol, String]),
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          straddle_account_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::RevealedPaykeyResponse)
+      end
+      def create_quiltt_paykey(
+        # Body param: Unique identifier for the customer associated with the paykey.
+        customer_id:,
+        # Body param: Quiltt processor token generated by your application for use with
+        # the Straddle API.
+        quiltt_token:,
+        # Body param
+        config: nil,
+        # Body param: Unique identifier for the paykey in your system.
+        external_id: nil,
+        # Body param: Up to 20 user-defined key-value pairs associated with the paykey.
+        metadata: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        # Header param: For platform requests, the embedded account UUID that sets the
+        # request scope.
+        straddle_account_id: nil,
+        request_options: {}
+      )
+      end
 
-      # Use this endpoint to generate a session token for use in the Bridge widget.
+      # Creates a session token for the Bridge widget.
       sig do
         params(
           customer_id: String,
-          config: Straddle::BridgeInitializeParams::Config::OrHash,
+          config: Straddle::PaykeyConfiguration::OrHash,
           external_id: T.nilable(String),
           correlation_id: String,
           idempotency_key: String,
           request_id: String,
           straddle_account_id: String,
           request_options: Straddle::RequestOptions::OrHash
-        ).returns(Straddle::BridgeTokenV1)
+        ).returns(Straddle::BridgeTokenResponse)
       end
-      def initialize_(
-        # Body param: The Straddle generated unique identifier of the `customer` to create
-        # a bridge token for.
+      def create_token(
+        # Body param: Unique identifier for the customer associated with the Bridge
+        # session.
         customer_id:,
         # Body param
         config: nil,
-        # Body param: Unique identifier for the paykey in your database, used for
-        # cross-referencing between Straddle and your systems.
+        # Body param: Unique identifier for the paykey in your system.
         external_id: nil,
-        # Header param: Optional client generated identifier to trace and debug a series
-        # of requests.
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
         correlation_id: nil,
-        # Header param: Optional client generated value to use for idempotent requests.
+        # Header param: Optional client-generated key for an idempotent request.
         idempotency_key: nil,
-        # Header param: Optional client generated identifier to trace and debug a request.
+        # Header param: Optional client-generated identifier for tracing one request.
         request_id: nil,
-        # Header param: For use by platforms to specify an account id and set scope of a
-        # request.
+        # Header param: For platform requests, the embedded account UUID that sets the
+        # request scope.
         straddle_account_id: nil,
         request_options: {}
       )

data/rbi/straddle/resources/capability_requests.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module Straddle
+  module Resources
+    # Capability requests change the payment, customer, and consent types available to
+    # an account.
+    class CapabilityRequests
+      # Creates one or more capability requests for an account and returns the resulting
+      # requests.
+      sig do
+        params(
+          account_id: String,
+          businesses:
+            Straddle::CapabilityRequestCreateParams::Businesses::OrHash,
+          charges: Straddle::CapabilityRequestCreateParams::Charges::OrHash,
+          individuals:
+            Straddle::CapabilityRequestCreateParams::Individuals::OrHash,
+          internet: Straddle::CapabilityRequestCreateParams::Internet::OrHash,
+          payouts: Straddle::CapabilityRequestCreateParams::Payouts::OrHash,
+          signed_agreement:
+            Straddle::CapabilityRequestCreateParams::SignedAgreement::OrHash,
+          correlation_id: String,
+          idempotency_key: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CapabilityRequestList)
+      end
+      def create(
+        # Path param: The ID of the account.
+        account_id,
+        # Body param: Request to enable or disable payments from businesses.
+        businesses: nil,
+        # Body param: Requested charge capability and limits.
+        charges: nil,
+        # Body param: Request to enable or disable payments from individuals.
+        individuals: nil,
+        # Body param: Request to enable or disable internet and mobile payment
+        # authorization.
+        internet: nil,
+        # Body param: Requested payout capability and limits.
+        payouts: nil,
+        # Body param: Request to enable or disable signed-agreement payment authorization.
+        signed_agreement: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated key for an idempotent request.
+        idempotency_key: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # Returns a paginated list of capability requests for an account. Filter the list
+      # by capability type, category, or status.
+      sig do
+        params(
+          account_id: String,
+          category: Straddle::CapabilityRequestListParams::Category::OrSymbol,
+          page_number: Integer,
+          page_size: Integer,
+          sort_by: String,
+          sort_order:
+            Straddle::CapabilityRequestListParams::SortOrder::OrSymbol,
+          status: Straddle::CapabilityRequestListParams::Status::OrSymbol,
+          type: Straddle::CapabilityRequestListParams::Type::OrSymbol,
+          correlation_id: String,
+          request_id: String,
+          request_options: Straddle::RequestOptions::OrHash
+        ).returns(Straddle::CapabilityRequestList)
+      end
+      def list(
+        # Path param: The ID of the account.
+        account_id,
+        # Query param: Capability category to return.
+        category: nil,
+        # Query param: Page number. Defaults to `1`.
+        page_number: nil,
+        # Query param: Number of results per page. Defaults to `100`. Maximum `1000`.
+        page_size: nil,
+        # Query param: Field used to sort results. Defaults to `id`.
+        sort_by: nil,
+        # Query param: Sort direction. Defaults to `asc`.
+        sort_order: nil,
+        # Query param: Capability request status to return.
+        status: nil,
+        # Query param: Capability type to return.
+        type: nil,
+        # Header param: Optional client-generated identifier for tracing a series of
+        # related requests.
+        correlation_id: nil,
+        # Header param: Optional client-generated identifier for tracing one request.
+        request_id: nil,
+        request_options: {}
+      )
+      end
+
+      # @api private
+      sig { params(client: Straddle::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end