straddle 0.4.0 → 1.0.0

data/lib/straddle/resources/accounts.rb

@@ -0,0 +1,268 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Resources
+    # Accounts represent businesses that use Straddle through a platform.
+    class Accounts
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::AccountCreateParams} for more details.
+      #
+      # Creates a business account in the specified organization and returns the
+      # account.
+      #
+      # @overload create(access_level:, account_type:, business_profile:, organization_id:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #
+      # @param access_level [Symbol, Straddle::Models::AccountCreateParams::AccessLevel] Body param: The account access level. `standard` provides normal account access,
+      #
+      # @param account_type [Symbol, Straddle::Models::AccountCreateParams::AccountType] Body param: Account type. The only accepted value is `business`.
+      #
+      # @param business_profile [Straddle::Models::AccountBusinessProfile] Body param
+      #
+      # @param organization_id [String] Body param: ID of the organization that will own the account.
+      #
+      # @param external_id [String, nil] Body param: Your unique ID for the account.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] Body param: Up to 20 user-defined key-value pairs.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::AccountResponse]
+      #
+      # @see Straddle::Models::AccountCreateParams
+      def create(params)
+        parsed, options = Straddle::AccountCreateParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id"
+        }
+        @client.request(
+          method: :post,
+          path: "v1/accounts",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::AccountResponse,
+          options: options
+        )
+      end
+
+      # Returns the account with the specified ID.
+      #
+      # @overload retrieve(account_id, correlation_id: nil, request_id: nil, request_options: {})
+      #
+      # @param account_id [String] The ID of the account.
+      #
+      # @param correlation_id [String] Optional client-generated identifier for tracing a series of related requests.
+      #
+      # @param request_id [String] Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::AccountResponse]
+      #
+      # @see Straddle::Models::AccountRetrieveParams
+      def retrieve(account_id, params = {})
+        parsed, options = Straddle::AccountRetrieveParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v1/accounts/%1$s", account_id],
+          headers: parsed.transform_keys(correlation_id: "correlation-id", request_id: "request-id"),
+          model: Straddle::AccountResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::AccountUpdateParams} for more details.
+      #
+      # Updates an account's business profile, metadata, and external ID, then returns
+      # the account.
+      #
+      # @overload update(account_id, business_profile:, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param business_profile [Straddle::Models::AccountBusinessProfile] Body param
+      #
+      # @param external_id [String, nil] Body param: Your unique ID for the account.
+      #
+      # @param metadata [Hash{Symbol=>String, nil}, nil] Body param: Up to 20 user-defined key-value pairs.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::AccountResponse]
+      #
+      # @see Straddle::Models::AccountUpdateParams
+      def update(account_id, params)
+        parsed, options = Straddle::AccountUpdateParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id"
+        }
+        @client.request(
+          method: :put,
+          path: ["v1/accounts/%1$s", account_id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::AccountResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::AccountListParams} for more details.
+      #
+      # Returns a paginated list of accounts for your platform. Filter the list by
+      # status, type, external ID, or text search.
+      #
+      # @overload list(external_id: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+      #
+      # @param external_id [String] Query param: Your external ID for the account.
+      #
+      # @param page_number [Integer] Query param: Page number. Defaults to `1`.
+      #
+      # @param page_size [Integer] Query param: Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      # @param search_text [String] Query param: Text to search for across account fields.
+      #
+      # @param sort_by [String] Query param: Field used to sort results. Defaults to `id`.
+      #
+      # @param sort_order [Symbol, Straddle::Models::AccountListParams::SortOrder] Query param: Sort direction. Defaults to `asc`.
+      #
+      # @param status [Symbol, Straddle::Models::AccountListParams::Status] Query param: Account status to return.
+      #
+      # @param type [Symbol, Straddle::Models::AccountListParams::Type] Query param: Account type to return.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::AccountList]
+      #
+      # @see Straddle::Models::AccountListParams
+      def list(params = {})
+        query_params = %i[external_id page_number page_size search_text sort_by sort_order status type]
+        parsed, options = Straddle::AccountListParams.dump_request(params)
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
+        @client.request(
+          method: :get,
+          path: "v1/accounts",
+          query: query,
+          headers:
+            parsed.except(*query_params).transform_keys(
+              correlation_id: "correlation-id",
+              request_id: "request-id"
+            ),
+          model: Straddle::AccountList,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::AccountOnboardParams} for more details.
+      #
+      # 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`.
+      #
+      # @overload onboard(account_id, terms_of_service:, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param terms_of_service [Straddle::Models::TermsOfService] Body param
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::AccountResponse]
+      #
+      # @see Straddle::Models::AccountOnboardParams
+      def onboard(account_id, params)
+        parsed, options = Straddle::AccountOnboardParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id"
+        }
+        @client.request(
+          method: :post,
+          path: ["v1/accounts/%1$s/onboard", account_id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::AccountResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::AccountSimulateOnboardingParams} for more details.
+      #
+      # Simulates an account status transition to `onboarding` or `active` in the
+      # sandbox and returns the account.
+      #
+      # @overload simulate_onboarding(account_id, final_status: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param final_status [Symbol, Straddle::Models::AccountSimulateOnboardingParams::FinalStatus] Query param: Final account status to produce in the sandbox simulation.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::AccountResponse]
+      #
+      # @see Straddle::Models::AccountSimulateOnboardingParams
+      def simulate_onboarding(account_id, params = {})
+        query_params = [:final_status]
+        parsed, options = Straddle::AccountSimulateOnboardingParams.dump_request(params)
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
+        @client.request(
+          method: :post,
+          path: ["v1/accounts/%1$s/simulate", account_id],
+          query: query,
+          headers:
+            parsed.except(*query_params).transform_keys(
+              correlation_id: "correlation-id",
+              idempotency_key: "idempotency-key",
+              request_id: "request-id"
+            ),
+          model: Straddle::AccountResponse,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Straddle::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end

data/lib/straddle/resources/bridge.rb

@@ -2,63 +2,197 @@
 
 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.
-      # @return [Straddle::Resources::Bridge::Link]
-      attr_reader :link
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::BridgeCreateBankAccountPaykeyParams} for more details.
+      #
+      # Creates a paykey from a routing number, account number, and account type.
+      #
+      # @overload create_bank_account_paykey(account_number:, account_type:, customer_id:, routing_number:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param account_number [String] Body param: Bank account number.
+      #
+      # @param account_type [Symbol, Straddle::Models::AccountType] Body param
+      #
+      # @param customer_id [String] Body param: Unique identifier for the customer associated with the paykey.
+      #
+      # @param routing_number [String] Body param: Bank routing number.
+      #
+      # @param config [Straddle::Models::PaykeyConfiguration] Body param
+      #
+      # @param external_id [String, nil] Body param: Unique identifier for the paykey in your system.
+      #
+      # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param straddle_account_id [String] Header param: For platform requests, the embedded account UUID that sets the req
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::PaykeyResponse]
+      #
+      # @see Straddle::Models::BridgeCreateBankAccountPaykeyParams
+      def create_bank_account_paykey(params)
+        parsed, options = Straddle::BridgeCreateBankAccountPaykeyParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id",
+          straddle_account_id: "straddle-account-id"
+        }
+        @client.request(
+          method: :post,
+          path: "v1/bridge/bank_account",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::PaykeyResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::BridgeCreatePlaidPaykeyParams} for more details.
+      #
+      # Creates a paykey from a Plaid processor token.
+      #
+      # @overload create_plaid_paykey(customer_id:, plaid_token:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param customer_id [String] Body param: Unique identifier for the customer associated with the paykey.
+      #
+      # @param plaid_token [String] Body param: Plaid processor token generated by your application for use with the
+      #
+      # @param config [Straddle::Models::PaykeyConfiguration] Body param
+      #
+      # @param external_id [String, nil] Body param: Unique identifier for the paykey in your system.
+      #
+      # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 user-defined key-value pairs associated with the paykey.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param straddle_account_id [String] Header param: For platform requests, the embedded account UUID that sets the req
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::PaykeyResponse]
+      #
+      # @see Straddle::Models::BridgeCreatePlaidPaykeyParams
+      def create_plaid_paykey(params)
+        parsed, options = Straddle::BridgeCreatePlaidPaykeyParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id",
+          straddle_account_id: "straddle-account-id"
+        }
+        @client.request(
+          method: :post,
+          path: "v1/bridge/plaid",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::PaykeyResponse,
+          options: options
+        )
+      end
 
       # Some parameter documentations has been truncated, see
-      # {Straddle::Models::BridgeInitializeParams} for more details.
+      # {Straddle::Models::BridgeCreateQuilttPaykeyParams} for more details.
+      #
+      # Creates a paykey from a Quiltt processor token.
       #
-      # Use this endpoint to generate a session token for use in the Bridge widget.
+      # @overload create_quiltt_paykey(customer_id:, quiltt_token:, config: nil, external_id: nil, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @overload initialize_(customer_id:, config: nil, external_id: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @param customer_id [String] Body param: Unique identifier for the customer associated with the paykey.
       #
-      # @param customer_id [String] Body param: The Straddle generated unique identifier of the `customer` to create
+      # @param quiltt_token [String] Body param: Quiltt processor token generated by your application for use with th
       #
-      # @param config [Straddle::Models::BridgeInitializeParams::Config] Body param
+      # @param config [Straddle::Models::PaykeyConfiguration] Body param
       #
-      # @param external_id [String, nil] Body param: Unique identifier for the paykey in your database, used for cross-re
+      # @param external_id [String, nil] Body param: Unique identifier for the paykey in your system.
       #
-      # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
+      # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 user-defined key-value pairs associated with the paykey.
       #
-      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
       #
-      # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
       #
-      # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param straddle_account_id [String] Header param: For platform requests, the embedded account UUID that sets the req
       #
       # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Straddle::Models::BridgeTokenV1]
-      #
-      # @see Straddle::Models::BridgeInitializeParams
-      def initialize_(params)
-        parsed, options = Straddle::BridgeInitializeParams.dump_request(params)
-        header_params =
-          {
-            correlation_id: "correlation-id",
-            idempotency_key: "idempotency-key",
-            request_id: "request-id",
-            straddle_account_id: "straddle-account-id"
-          }
+      # @return [Straddle::Models::RevealedPaykeyResponse]
+      #
+      # @see Straddle::Models::BridgeCreateQuilttPaykeyParams
+      def create_quiltt_paykey(params)
+        parsed, options = Straddle::BridgeCreateQuilttPaykeyParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id",
+          straddle_account_id: "straddle-account-id"
+        }
+        @client.request(
+          method: :post,
+          path: "v1/bridge/quiltt",
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::RevealedPaykeyResponse,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::BridgeCreateTokenParams} for more details.
+      #
+      # Creates a session token for the Bridge widget.
+      #
+      # @overload create_token(customer_id:, config: nil, external_id: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      #
+      # @param customer_id [String] Body param: Unique identifier for the customer associated with the Bridge sessio
+      #
+      # @param config [Straddle::Models::PaykeyConfiguration] Body param
+      #
+      # @param external_id [String, nil] Body param: Unique identifier for the paykey in your system.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param straddle_account_id [String] Header param: For platform requests, the embedded account UUID that sets the req
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::BridgeTokenResponse]
+      #
+      # @see Straddle::Models::BridgeCreateTokenParams
+      def create_token(params)
+        parsed, options = Straddle::BridgeCreateTokenParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id",
+          straddle_account_id: "straddle-account-id"
+        }
         @client.request(
           method: :post,
           path: "v1/bridge/initialize",
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Straddle::BridgeTokenV1,
+          model: Straddle::BridgeTokenResponse,
           options: options
         )
       end
@@ -68,7 +202,6 @@ module Straddle
       # @param client [Straddle::Client]
       def initialize(client:)
         @client = client
-        @link = Straddle::Resources::Bridge::Link.new(client: client)
       end
     end
   end

data/lib/straddle/resources/capability_requests.rb

@@ -0,0 +1,117 @@
+# frozen_string_literal: true
+
+module Straddle
+  module Resources
+    # Capability requests change the payment, customer, and consent types available to
+    # an account.
+    class CapabilityRequests
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::CapabilityRequestCreateParams} for more details.
+      #
+      # Creates one or more capability requests for an account and returns the resulting
+      # requests.
+      #
+      # @overload create(account_id, businesses: nil, charges: nil, individuals: nil, internet: nil, payouts: nil, signed_agreement: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, request_options: {})
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param businesses [Straddle::Models::CapabilityRequestCreateParams::Businesses] Body param: Request to enable or disable payments from businesses.
+      #
+      # @param charges [Straddle::Models::CapabilityRequestCreateParams::Charges] Body param: Requested charge capability and limits.
+      #
+      # @param individuals [Straddle::Models::CapabilityRequestCreateParams::Individuals] Body param: Request to enable or disable payments from individuals.
+      #
+      # @param internet [Straddle::Models::CapabilityRequestCreateParams::Internet] Body param: Request to enable or disable internet and mobile payment authorizati
+      #
+      # @param payouts [Straddle::Models::CapabilityRequestCreateParams::Payouts] Body param: Requested payout capability and limits.
+      #
+      # @param signed_agreement [Straddle::Models::CapabilityRequestCreateParams::SignedAgreement] Body param: Request to enable or disable signed-agreement payment authorization.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param idempotency_key [String] Header param: Optional client-generated key for an idempotent request.
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::CapabilityRequestList]
+      #
+      # @see Straddle::Models::CapabilityRequestCreateParams
+      def create(account_id, params = {})
+        parsed, options = Straddle::CapabilityRequestCreateParams.dump_request(params)
+        header_params = {
+          correlation_id: "correlation-id",
+          idempotency_key: "idempotency-key",
+          request_id: "request-id"
+        }
+        @client.request(
+          method: :post,
+          path: ["v1/accounts/%1$s/capability_requests", account_id],
+          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
+          body: parsed.except(*header_params.keys),
+          model: Straddle::CapabilityRequestList,
+          options: options
+        )
+      end
+
+      # Some parameter documentations has been truncated, see
+      # {Straddle::Models::CapabilityRequestListParams} for more details.
+      #
+      # Returns a paginated list of capability requests for an account. Filter the list
+      # by capability type, category, or status.
+      #
+      # @overload list(account_id, category: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, status: nil, type: nil, correlation_id: nil, request_id: nil, request_options: {})
+      #
+      # @param account_id [String] Path param: The ID of the account.
+      #
+      # @param category [Symbol, Straddle::Models::CapabilityRequestListParams::Category] Query param: Capability category to return.
+      #
+      # @param page_number [Integer] Query param: Page number. Defaults to `1`.
+      #
+      # @param page_size [Integer] Query param: Number of results per page. Defaults to `100`. Maximum `1000`.
+      #
+      # @param sort_by [String] Query param: Field used to sort results. Defaults to `id`.
+      #
+      # @param sort_order [Symbol, Straddle::Models::CapabilityRequestListParams::SortOrder] Query param: Sort direction. Defaults to `asc`.
+      #
+      # @param status [Symbol, Straddle::Models::CapabilityRequestListParams::Status] Query param: Capability request status to return.
+      #
+      # @param type [Symbol, Straddle::Models::CapabilityRequestListParams::Type] Query param: Capability type to return.
+      #
+      # @param correlation_id [String] Header param: Optional client-generated identifier for tracing a series of relat
+      #
+      # @param request_id [String] Header param: Optional client-generated identifier for tracing one request.
+      #
+      # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
+      #
+      # @return [Straddle::Models::CapabilityRequestList]
+      #
+      # @see Straddle::Models::CapabilityRequestListParams
+      def list(account_id, params = {})
+        query_params = %i[category page_number page_size sort_by sort_order status type]
+        parsed, options = Straddle::CapabilityRequestListParams.dump_request(params)
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
+        @client.request(
+          method: :get,
+          path: ["v1/accounts/%1$s/capability_requests", account_id],
+          query: query,
+          headers:
+            parsed.except(*query_params).transform_keys(
+              correlation_id: "correlation-id",
+              request_id: "request-id"
+            ),
+          model: Straddle::CapabilityRequestList,
+          options: options
+        )
+      end
+
+      # @api private
+      #
+      # @param client [Straddle::Client]
+      def initialize(client:)
+        @client = client
+      end
+    end
+  end
+end