straddle 0.2.0 → 0.4.0

data/lib/straddle/resources/paykeys.rb

@@ -2,14 +2,27 @@
 
 module Straddle
   module Resources
+    # Paykeys are secure tokens that link verified customer identities to their bank
+    # accounts. Each Paykey includes built-in balance checking, fraud detection
+    # through LSTM machine learning models, and can be reused for subscriptions and
+    # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+    # ensuring the person initiating payment owns the funding account.
     class Paykeys
+      # Paykeys are secure tokens that link verified customer identities to their bank
+      # accounts. Each Paykey includes built-in balance checking, fraud detection
+      # through LSTM machine learning models, and can be reused for subscriptions and
+      # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+      # ensuring the person initiating payment owns the funding account.
+      # @return [Straddle::Resources::Paykeys::Review]
+      attr_reader :review
+
       # Some parameter documentations has been truncated, see
       # {Straddle::Models::PaykeyListParams} for more details.
       #
       # Returns a list of paykeys associated with a Straddle account. This endpoint
       # supports advanced sorting and filtering options.
       #
-      # @overload list(customer_id: nil, page_number: nil, page_size: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload list(customer_id: nil, page_number: nil, page_size: nil, search_text: nil, sort_by: nil, sort_order: nil, source: nil, status: nil, unblock_eligible: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param customer_id [String] Query param: Filter paykeys by related customer ID.
       #
@@ -17,14 +30,18 @@ module Straddle
       #
       # @param page_size [Integer] Query param: Number of results per page. Maximum: 1000.
       #
-      # @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy] Query param:
+      # @param search_text [String] Query param: General search term to filter paykeys.
+      #
+      # @param sort_by [Symbol, Straddle::Models::PaykeyListParams::SortBy] Query param
       #
-      # @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder] Query param:
+      # @param sort_order [Symbol, Straddle::Models::PaykeyListParams::SortOrder] Query param
       #
       # @param source [Array<Symbol, Straddle::Models::PaykeyListParams::Source>] Query param: Filter paykeys by their source.
       #
       # @param status [Array<Symbol, Straddle::Models::PaykeyListParams::Status>] Query param: Filter paykeys by their current status.
       #
+      # @param unblock_eligible [Boolean] Query param: Filter paykeys by unblock eligibility. When true, returns only bloc
+      #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
       # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
@@ -37,12 +54,24 @@ module Straddle
       #
       # @see Straddle::Models::PaykeyListParams
       def list(params = {})
+        query_params =
+          [
+            :customer_id,
+            :page_number,
+            :page_size,
+            :search_text,
+            :sort_by,
+            :sort_order,
+            :source,
+            :status,
+            :unblock_eligible
+          ]
         parsed, options = Straddle::PaykeyListParams.dump_request(params)
-        query_params = [:customer_id, :page_number, :page_size, :sort_by, :sort_order, :source, :status]
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v1/paykeys",
-          query: parsed.slice(*query_params),
+          query: query,
           headers: parsed.except(*query_params).transform_keys(
             correlation_id: "correlation-id",
             request_id: "request-id",
@@ -59,9 +88,9 @@ module Straddle
       #
       # @overload cancel(id, reason: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @param id [String] Path param:
+      # @param id [String] Path param
       #
-      # @param reason [String, nil] Body param:
+      # @param reason [String, nil] Body param
       #
       # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
       #
@@ -129,10 +158,9 @@ module Straddle
         )
       end
 
-      # Retrieves the details of a paykey that has previously been created, including
-      # unmasked bank account fields. Supply the unique paykey ID that was returned from
-      # your previous request, and Straddle will return the corresponding paykey
-      # information.
+      # Retrieves the details of a paykey that has previously been created. Supply the
+      # unique paykey ID that was returned from your previous request, and Straddle will
+      # return the corresponding paykey information including the unmasked token.
       #
       # @overload reveal(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
@@ -164,80 +192,73 @@ module Straddle
         )
       end
 
-      # Some parameter documentations has been truncated, see
-      # {Straddle::Models::PaykeyReviewParams} for more details.
-      #
-      # Update the status of a paykey when in review status
-      #
-      # @overload review(id, status:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
-      #
-      # @param id [String] Path param:
+      # Retrieves the unmasked details of an existing paykey. Supply the unique paykey
+      # `id` and Straddle will return the corresponding paykey record, including the
+      # unmasked bank account details. This endpoint needs to be enabled by Straddle for
+      # your account and should only be used when absolutely necessary.
       #
-      # @param status [Symbol, Straddle::Models::PaykeyReviewParams::Status] Body param:
+      # @overload unmasked(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @param correlation_id [String] Header param: Optional client generated identifier to trace and debug a series o
+      # @param id [String]
       #
-      # @param idempotency_key [String] Header param: Optional client generated value to use for idempotent requests.
+      # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
       #
-      # @param request_id [String] Header param: Optional client generated identifier to trace and debug a request.
+      # @param request_id [String] Optional client generated identifier to trace and debug a request.
       #
-      # @param straddle_account_id [String] Header param: For use by platforms to specify an account id and set scope of a r
+      # @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
       #
       # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Straddle::Models::PaykeyV1]
+      # @return [Straddle::Models::PaykeyUnmaskedV1]
       #
-      # @see Straddle::Models::PaykeyReviewParams
-      def review(id, params)
-        parsed, options = Straddle::PaykeyReviewParams.dump_request(params)
-        header_params =
-          {
+      # @see Straddle::Models::PaykeyUnmaskedParams
+      def unmasked(id, params = {})
+        parsed, options = Straddle::PaykeyUnmaskedParams.dump_request(params)
+        @client.request(
+          method: :get,
+          path: ["v1/paykeys/%1$s/unmasked", id],
+          headers: parsed.transform_keys(
             correlation_id: "correlation-id",
-            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
-          }
-        @client.request(
-          method: :patch,
-          path: ["v1/paykeys/%1$s/review", id],
-          headers: parsed.slice(*header_params.keys).transform_keys(header_params),
-          body: parsed.except(*header_params.keys),
-          model: Straddle::PaykeyV1,
+          ),
+          model: Straddle::PaykeyUnmaskedV1,
           options: options
         )
       end
 
-      # Retrieves the unmasked details of an existing paykey. Supply the unique paykey
-      # `id` and Straddle will return the corresponding paykey record, including the
-      # unmasked bank account details. This endpoint needs to be enabled by Straddle for
-      # your account and should only be used when absolutely necessary.
+      # Updates the balance of a paykey. This endpoint allows you to refresh the balance
+      # of a paykey.
       #
-      # @overload unmasked(id, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload update_balance(id, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param id [String]
       #
       # @param correlation_id [String] Optional client generated identifier to trace and debug a series of requests.
       #
+      # @param idempotency_key [String] Optional client generated value to use for idempotent requests.
+      #
       # @param request_id [String] Optional client generated identifier to trace and debug a request.
       #
       # @param straddle_account_id [String] For use by platforms to specify an account id and set scope of a request.
       #
       # @param request_options [Straddle::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Straddle::Models::PaykeyUnmaskedV1]
+      # @return [Straddle::Models::PaykeyV1]
       #
-      # @see Straddle::Models::PaykeyUnmaskedParams
-      def unmasked(id, params = {})
-        parsed, options = Straddle::PaykeyUnmaskedParams.dump_request(params)
+      # @see Straddle::Models::PaykeyUpdateBalanceParams
+      def update_balance(id, params = {})
+        parsed, options = Straddle::PaykeyUpdateBalanceParams.dump_request(params)
         @client.request(
-          method: :get,
-          path: ["v1/paykeys/%1$s/unmasked", id],
+          method: :put,
+          path: ["v1/paykeys/%1$s/refresh_balance", id],
           headers: parsed.transform_keys(
             correlation_id: "correlation-id",
+            idempotency_key: "idempotency-key",
             request_id: "request-id",
             straddle_account_id: "straddle-account-id"
           ),
-          model: Straddle::PaykeyUnmaskedV1,
+          model: Straddle::PaykeyV1,
           options: options
         )
       end
@@ -247,6 +268,7 @@ module Straddle
       # @param client [Straddle::Client]
       def initialize(client:)
         @client = client
+        @review = Straddle::Resources::Paykeys::Review.new(client: client)
       end
     end
   end

data/lib/straddle/resources/payments.rb

@@ -2,6 +2,8 @@
 
 module Straddle
   module Resources
+    # Payments provide endpoints to filter both Charges and Payouts with multiple
+    # different parameters.
     class Payments
       # Some parameter documentations has been truncated, see
       # {Straddle::Models::PaymentListParams} for more details.
@@ -9,20 +11,22 @@ module Straddle
       # Search for payments, including `charges` and `payouts`, using a variety of
       # criteria. This endpoint supports advanced sorting and filtering options.
       #
-      # @overload list(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
+      # @overload list(customer_id: nil, default_page_size: nil, default_sort: nil, default_sort_order: nil, external_id: nil, funding_id: nil, include_metadata: nil, max_amount: nil, max_created_at: nil, max_effective_at: nil, max_payment_date: nil, min_amount: nil, min_created_at: nil, min_effective_at: nil, min_payment_date: nil, page_number: nil, page_size: nil, paykey: nil, paykey_id: nil, payment_id: nil, payment_status: nil, payment_type: nil, search_text: nil, sort_by: nil, sort_order: nil, status_reason: nil, status_source: nil, correlation_id: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
       # @param customer_id [String] Query param: Search using the `customer_id` of a `charge` or `payout`.
       #
-      # @param default_page_size [Integer] Query param:
+      # @param default_page_size [Integer] Query param
       #
       # @param default_sort [Symbol, Straddle::Models::PaymentListParams::DefaultSort] Query param: The field to sort the results by.
       #
-      # @param default_sort_order [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder] Query param:
+      # @param default_sort_order [Symbol, Straddle::Models::PaymentListParams::DefaultSortOrder] Query param
       #
       # @param external_id [String] Query param: Search using the `external_id` of a `charge` or `payout`.
       #
       # @param funding_id [String] Query param: Search using the `funding_id` of a `charge` or `payout`.
       #
+      # @param include_metadata [Boolean] Query param: Include the metadata for payments in the returned data.
+      #
       # @param max_amount [Integer] Query param: Search using a maximum `amount` of a `charge` or `payout`.
       #
       # @param max_created_at [Time] Query param: Search using the latest `created_at` date of a `charge` or `payout`
@@ -57,7 +61,7 @@ module Straddle
       #
       # @param sort_by [Symbol, Straddle::Models::PaymentListParams::SortBy] Query param: The field to sort the results by.
       #
-      # @param sort_order [Symbol, Straddle::Models::PaymentListParams::SortOrder] Query param:
+      # @param sort_order [Symbol, Straddle::Models::PaymentListParams::SortOrder] Query param
       #
       # @param status_reason [Array<Symbol, Straddle::Models::PaymentListParams::StatusReason>] Query param: Reason for latest payment status change.
       #
@@ -75,7 +79,6 @@ module Straddle
       #
       # @see Straddle::Models::PaymentListParams
       def list(params = {})
-        parsed, options = Straddle::PaymentListParams.dump_request(params)
         query_params =
           [
             :customer_id,
@@ -84,6 +87,7 @@ module Straddle
             :default_sort_order,
             :external_id,
             :funding_id,
+            :include_metadata,
             :max_amount,
             :max_created_at,
             :max_effective_at,
@@ -105,10 +109,12 @@ module Straddle
             :status_reason,
             :status_source
           ]
+        parsed, options = Straddle::PaymentListParams.dump_request(params)
+        query = Straddle::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v1/payments",
-          query: parsed.slice(*query_params),
+          query: query,
           headers: parsed.except(*query_params).transform_keys(
             correlation_id: "correlation-id",
             request_id: "request-id",

data/lib/straddle/resources/payouts.rb

@@ -2,6 +2,10 @@
 
 module Straddle
   module Resources
+    # Payouts represent transfers from Straddle to customer bank accounts. Create
+    # payouts to handle disbursements, process refunds, or manage marketplace
+    # settlements. Use payouts to send money quickly and securely with the most
+    # cost-effective rail automatically selected.
     class Payouts
       # Some parameter documentations has been truncated, see
       # {Straddle::Models::PayoutCreateParams} for more details.
@@ -14,7 +18,7 @@ module Straddle
       #
       # @param currency [String] Body param: The currency of the payout. Only USD is supported.
       #
-      # @param description [String] Body param: An arbitrary description for the payout.
+      # @param description [String, nil] Body param: An arbitrary description for the payout.
       #
       # @param device [Straddle::Models::DeviceInfoV1] Body param: Information about the device used when the customer authorized the p
       #
@@ -24,7 +28,7 @@ module Straddle
       #
       # @param payment_date [Date] Body param: The desired date on which the payout should be occur. For payouts, t
       #
-      # @param config [Straddle::Models::PayoutCreateParams::Config] Body param:
+      # @param config [Straddle::Models::PayoutCreateParams::Config] Body param
       #
       # @param metadata [Hash{Symbol=>String}, nil] Body param: Up to 20 additional user-defined key-value pairs. Useful for storing
       #
@@ -68,11 +72,11 @@ module Straddle
       #
       # @overload update(id, amount:, description:, payment_date:, metadata: nil, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @param id [String] Path param:
+      # @param id [String] Path param
       #
       # @param amount [Integer] Body param: The amount of the payout in cents.
       #
-      # @param description [String] Body param: An arbitrary description for the payout.
+      # @param description [String, nil] Body param: An arbitrary description for the payout.
       #
       # @param payment_date [Date] Body param: The desired date on which the payment should be occur. For payouts,
       #
@@ -118,7 +122,7 @@ module Straddle
       #
       # @overload cancel(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @param id [String] Path param:
+      # @param id [String] Path param
       #
       # @param reason [String] Body param: Details about why the payout status was updated.
       #
@@ -195,7 +199,7 @@ module Straddle
       #
       # @overload hold(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @param id [String] Path param:
+      # @param id [String] Path param
       #
       # @param reason [String] Body param: Details about why the payout status was updated.
       #
@@ -239,7 +243,7 @@ module Straddle
       #
       # @overload release(id, reason:, correlation_id: nil, idempotency_key: nil, request_id: nil, straddle_account_id: nil, request_options: {})
       #
-      # @param id [String] Path param:
+      # @param id [String] Path param
       #
       # @param reason [String] Body param: Details about why the payout status was updated.
       #

data/lib/straddle/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Straddle
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/straddle.rb

@@ -3,12 +3,14 @@
 # Standard libraries.
 # rubocop:disable Lint/RedundantRequireStatement
 require "English"
+require "base64"
 require "cgi"
 require "date"
 require "erb"
 require "etc"
 require "json"
 require "net/http"
+require "openssl"
 require "pathname"
 require "rbconfig"
 require "securerandom"
@@ -74,11 +76,11 @@ require_relative "straddle/models/customer_delete_params"
 require_relative "straddle/models/customer_details_v1"
 require_relative "straddle/models/customer_get_params"
 require_relative "straddle/models/customer_list_params"
-require_relative "straddle/models/customer_refresh_review_params"
 require_relative "straddle/models/customers/customer_review_v1"
 require_relative "straddle/models/customers/identity_verification_breakdown_v1"
 require_relative "straddle/models/customers/review_decision_params"
 require_relative "straddle/models/customers/review_get_params"
+require_relative "straddle/models/customers/review_refresh_review_params"
 require_relative "straddle/models/customer_summary_paged_v1"
 require_relative "straddle/models/customer_unmasked_params"
 require_relative "straddle/models/customer_unmasked_v1"
@@ -135,10 +137,14 @@ require_relative "straddle/models/paykey_get_params"
 require_relative "straddle/models/paykey_list_params"
 require_relative "straddle/models/paykey_reveal_params"
 require_relative "straddle/models/paykey_reveal_response"
-require_relative "straddle/models/paykey_review_params"
+require_relative "straddle/models/paykeys/review_decision_params"
+require_relative "straddle/models/paykeys/review_get_params"
+require_relative "straddle/models/paykeys/review_get_response"
+require_relative "straddle/models/paykeys/review_refresh_review_params"
 require_relative "straddle/models/paykey_summary_paged_v1"
 require_relative "straddle/models/paykey_unmasked_params"
 require_relative "straddle/models/paykey_unmasked_v1"
+require_relative "straddle/models/paykey_update_balance_params"
 require_relative "straddle/models/paykey_v1"
 require_relative "straddle/models/payment_list_params"
 require_relative "straddle/models/payment_summary_paged_v1"
@@ -169,6 +175,7 @@ require_relative "straddle/resources/embed/organizations"
 require_relative "straddle/resources/embed/representatives"
 require_relative "straddle/resources/funding_events"
 require_relative "straddle/resources/paykeys"
+require_relative "straddle/resources/paykeys/review"
 require_relative "straddle/resources/payments"
 require_relative "straddle/resources/payouts"
 require_relative "straddle/resources/reports"

data/manifest.yaml

@@ -1,11 +1,13 @@
 dependencies:
   - English
+  - base64
   - cgi
   - date
   - erb
   - etc
   - json
   - net/http
+  - openssl
   - pathname
   - rbconfig
   - securerandom

data/rbi/straddle/client.rbi

@@ -27,24 +27,58 @@ module Straddle
     sig { returns(Straddle::Resources::Embed) }
     attr_reader :embed
 
+    # 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) }
     attr_reader :bridge
 
+    # 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) }
     attr_reader :customers
 
+    # Paykeys are secure tokens that link verified customer identities to their bank
+    # accounts. Each Paykey includes built-in balance checking, fraud detection
+    # through LSTM machine learning models, and can be reused for subscriptions and
+    # recurring payments without storing sensitive data. Paykeys eliminate fraud by
+    # ensuring the person initiating payment owns the funding account.
     sig { returns(Straddle::Resources::Paykeys) }
     attr_reader :paykeys
 
+    # 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.
     sig { returns(Straddle::Resources::Charges) }
     attr_reader :charges
 
+    # 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.
     sig { returns(Straddle::Resources::FundingEvents) }
     attr_reader :funding_events
 
+    # Payments provide endpoints to filter both Charges and Payouts with multiple
+    # different parameters.
     sig { returns(Straddle::Resources::Payments) }
     attr_reader :payments
 
+    # Payouts represent transfers from Straddle to customer bank accounts. Create
+    # payouts to handle disbursements, process refunds, or manage marketplace
+    # settlements. Use payouts to send money quickly and securely with the most
+    # cost-effective rail automatically selected.
     sig { returns(Straddle::Resources::Payouts) }
     attr_reader :payouts
 

data/rbi/straddle/internal/transport/base_client.rbi

@@ -176,6 +176,11 @@ module Straddle
         private def auth_headers
         end
 
+        # @api private
+        sig { returns(String) }
+        private def user_agent
+        end
+
         # @api private
         sig { returns(String) }
         private def generate_idempotency_key

data/rbi/straddle/internal/transport/pooled_net_requester.rbi

@@ -26,8 +26,12 @@ module Straddle
 
         class << self
           # @api private
-          sig { params(url: URI::Generic).returns(Net::HTTP) }
-          def connect(url)
+          sig do
+            params(cert_store: OpenSSL::X509::Store, url: URI::Generic).returns(
+              Net::HTTP
+            )
+          end
+          def connect(cert_store:, url:)
           end
 
           # @api private

data/rbi/straddle/internal/type/base_model.rbi

@@ -31,7 +31,7 @@ module Straddle
           #
           # Assumes superclass fields are totally defined before fields are accessed /
           # defined on subclasses.
-          sig { params(child: T.self_type).void }
+          sig { params(child: Straddle::Internal::Type::BaseModel).void }
           def inherited(child)
           end
 
@@ -274,9 +274,13 @@ module Straddle
 
         # Create a new instance of a model.
         sig do
-          params(data: T.any(T::Hash[Symbol, T.anything], T.self_type)).returns(
-            T.attached_class
-          )
+          params(
+            data:
+              T.any(
+                T::Hash[Symbol, T.anything],
+                Straddle::Internal::Type::BaseModel
+              )
+          ).returns(T.attached_class)
         end
         def self.new(data = {})
         end

data/rbi/straddle/internal/util.rbi

@@ -296,11 +296,31 @@ module Straddle
       end
 
       JSON_CONTENT =
-        T.let(%r{^application/(?:vnd(?:\.[^.]+)*\+)?json(?!l)}, Regexp)
+        T.let(%r{^application/(?:[a-zA-Z0-9.-]+\+)?json(?!l)}, Regexp)
       JSONL_CONTENT =
         T.let(%r{^application/(:?x-(?:n|l)djson)|(:?(?:x-)?jsonl)}, Regexp)
 
       class << self
+        # @api private
+        sig do
+          params(query: Straddle::Internal::AnyHash).returns(
+            Straddle::Internal::AnyHash
+          )
+        end
+        def encode_query_params(query)
+        end
+
+        # @api private
+        sig do
+          params(
+            collection: Straddle::Internal::AnyHash,
+            key: String,
+            element: T.anything
+          ).void
+        end
+        private def write_query_param_element!(collection, key, element)
+        end
+
         # @api private
         sig do
           params(