finch-api 0.1.0.pre.alpha.24 → 0.1.0.pre.alpha.26

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 68924aafffb4beae3a435e75daeaaf72bd854593874f91774c9c482908a0e0df
-  data.tar.gz: de0cfd0589c9df6214e3e30680b11fe405bce5b5f1ca50312864451772a161d9
+  metadata.gz: 001b17120032e3a9858cbe7ec392b2a1f88335e016c832300173ab9a131fb295
+  data.tar.gz: e2da9d326d10fb9c2713261f8201dfb20370685804dc4a4440aea588ac66b156
 SHA512:
-  metadata.gz: fc44bb5eebf9f6832638e97c79b39cfa8e9c79b4f816eb1844a08a1651076130ee6cf2d0973bdbdc15a4ac3e188d2bd87115c159808c7872130555ceb275495b
-  data.tar.gz: 629faa02ee916ad364d7d2fff370e6981f1dbb3e557986982f10115b966b44215d27798fb512e0615bbe1ad6e577bd67542701e3b9756cc536e99c3e06da2f47
+  metadata.gz: d0fea639f345b1c5fafd5e21b65e3e94ed2ae2908194857534d3126f9dc5ee1efac374d3a9f6d7b9b97d3d248097ced859c046a00186fa9de64323bc095adf77
+  data.tar.gz: 65bb77a74431a281b7e14317852362278f082ff73ca91f1dc34035140c9eb56b2852b50b80229fa491525464360f3288c24c7ad64f41f3942c43b73c6cf06574

data/CHANGELOG.md

@@ -1,5 +1,40 @@
 # Changelog
 
+## 0.1.0-alpha.26 (2025-08-14)
+
+Full Changelog: [v0.1.0-alpha.25...v0.1.0-alpha.26](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.25...v0.1.0-alpha.26)
+
+### Features
+
+* **api:** api update ([80b711b](https://github.com/Finch-API/finch-api-ruby/commit/80b711bc0c917ce1f1f4daaac3301b5c8e5bd1e7))
+* **api:** api update ([5b2d8f2](https://github.com/Finch-API/finch-api-ruby/commit/5b2d8f2d1c30039ca4d4c5acfa055b5c60acefb9))
+
+
+### Bug Fixes
+
+* **client:** prioritise bearer auth ([d8817a5](https://github.com/Finch-API/finch-api-ruby/commit/d8817a5e6c6f289dc1dd1a5a5ad35c43049d1f0e))
+
+
+### Chores
+
+* collect metadata from type DSL ([e919ec0](https://github.com/Finch-API/finch-api-ruby/commit/e919ec0b110aa3a5ba703bf9dd317b2ea4091a28))
+* **internal:** update comment in script ([5969020](https://github.com/Finch-API/finch-api-ruby/commit/59690202144cf2295b6edc7542f10cd6932b0da2))
+* update @stainless-api/prism-cli to v5.15.0 ([2953337](https://github.com/Finch-API/finch-api-ruby/commit/29533376815ef4be96be5fde8de45fcf3f48a232))
+
+## 0.1.0-alpha.25 (2025-07-31)
+
+Full Changelog: [v0.1.0-alpha.24...v0.1.0-alpha.25](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.24...v0.1.0-alpha.25)
+
+### Bug Fixes
+
+* **internal:** ensure sorbet test always runs serially ([007501f](https://github.com/Finch-API/finch-api-ruby/commit/007501f8faade4e909775c5c2de7f99b3e344bb7))
+
+
+### Chores
+
+* **internal:** increase visibility of internal helper method ([66d0f39](https://github.com/Finch-API/finch-api-ruby/commit/66d0f3947c6724659efbd8d23890a5e5519be22c))
+* update contribute.md ([7d83851](https://github.com/Finch-API/finch-api-ruby/commit/7d8385183a2e4d9919780cd73a350431b27f4312))
+
 ## 0.1.0-alpha.24 (2025-07-23)
 
 Full Changelog: [v0.1.0-alpha.23...v0.1.0-alpha.24](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.23...v0.1.0-alpha.24)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "finch-api", "~> 0.1.0.pre.alpha.24"
+gem "finch-api", "~> 0.1.0.pre.alpha.26"
 ```
 
 <!-- x-release-please-end -->

data/lib/finch_api/client.rb

@@ -58,7 +58,9 @@ module FinchAPI
     #
     # @return [Hash{String=>String}]
     private def auth_headers
-      {**bearer_auth, **basic_auth}
+      return bearer_auth unless bearer_auth.empty?
+      return basic_auth unless basic_auth.empty?
+      {}
     end
 
     # @api private

data/lib/finch_api/internal/transport/base_client.rb

@@ -365,7 +365,7 @@ module FinchAPI
         #
         # @raise [FinchAPI::Errors::APIError]
         # @return [Array(Integer, Net::HTTPResponse, Enumerable<String>)]
-        private def send_request(request, redirect_count:, retry_count:, send_retry_header:)
+        def send_request(request, redirect_count:, retry_count:, send_retry_header:)
           url, headers, max_retries, timeout = request.fetch_values(:url, :headers, :max_retries, :timeout)
           input = {**request.except(:timeout), deadline: FinchAPI::Internal::Util.monotonic_secs + timeout}
 

data/lib/finch_api/internal/type/array_of.rb

@@ -148,6 +148,7 @@ module FinchAPI
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = FinchAPI::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = FinchAPI::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

data/lib/finch_api/internal/type/base_model.rb

@@ -52,6 +52,7 @@ module FinchAPI
           #
           #   @option spec [Boolean] :"nil?"
           private def add_field(name_sym, required:, type_info:, spec:)
+            meta = FinchAPI::Internal::Type::Converter.meta_info(type_info, spec)
             type_fn, info =
               case type_info
               in Proc | FinchAPI::Internal::Type::Converter | Class
@@ -81,7 +82,8 @@ module FinchAPI
                 required: required,
                 nilable: nilable,
                 const: const,
-                type_fn: type_fn
+                type_fn: type_fn,
+                meta: meta
               }
 
             define_method(setter) do |value|

data/lib/finch_api/internal/type/converter.rb

@@ -98,6 +98,33 @@ module FinchAPI
             end
           end
 
+          # @api private
+          #
+          # @param type_info [Hash{Symbol=>Object}, Proc, FinchAPI::Internal::Type::Converter, Class] .
+          #
+          #   @option type_info [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option type_info [Proc] :enum
+          #
+          #   @option type_info [Proc] :union
+          #
+          #   @option type_info [Boolean] :"nil?"
+          #
+          # @param spec [Hash{Symbol=>Object}, Proc, FinchAPI::Internal::Type::Converter, Class] .
+          #
+          #   @option spec [NilClass, TrueClass, FalseClass, Integer, Float, Symbol] :const
+          #
+          #   @option spec [Proc] :enum
+          #
+          #   @option spec [Proc] :union
+          #
+          #   @option spec [Boolean] :"nil?"
+          #
+          # @return [Hash{Symbol=>Object}]
+          def meta_info(type_info, spec)
+            [spec, type_info].grep(Hash).first.to_h.except(:const, :enum, :union, :nil?)
+          end
+
           # @api private
           #
           # @param translate_names [Boolean]

data/lib/finch_api/internal/type/hash_of.rb

@@ -168,6 +168,7 @@ module FinchAPI
         #   @option spec [Boolean] :"nil?"
         def initialize(type_info, spec = {})
           @item_type_fn = FinchAPI::Internal::Type::Converter.type_info(type_info || spec)
+          @meta = FinchAPI::Internal::Type::Converter.meta_info(type_info, spec)
           @nilable = spec.fetch(:nil?, false)
         end
 

data/lib/finch_api/internal/type/union.rb

@@ -33,20 +33,20 @@ module FinchAPI
         #
         # All of the specified variant info for this union.
         #
-        # @return [Array<Array(Symbol, Proc)>]
+        # @return [Array<Array(Symbol, Proc, Hash{Symbol=>Object})>]
         private def known_variants = (@known_variants ||= [])
 
         # @api private
         #
-        # @return [Array<Array(Symbol, Object)>]
+        # @return [Array<Array(Symbol, Object, Hash{Symbol=>Object})>]
         protected def derefed_variants
-          known_variants.map { |key, variant_fn| [key, variant_fn.call] }
+          known_variants.map { |key, variant_fn, meta| [key, variant_fn.call, meta] }
         end
 
         # All of the specified variants for this union.
         #
         # @return [Array<Object>]
-        def variants = derefed_variants.map(&:last)
+        def variants = derefed_variants.map { _2 }
 
         # @api private
         #
@@ -72,12 +72,13 @@ module FinchAPI
         #
         #   @option spec [Boolean] :"nil?"
         private def variant(key, spec = nil)
+          meta = FinchAPI::Internal::Type::Converter.meta_info(nil, spec)
           variant_info =
             case key
             in Symbol
-              [key, FinchAPI::Internal::Type::Converter.type_info(spec)]
+              [key, FinchAPI::Internal::Type::Converter.type_info(spec), meta]
             in Proc | FinchAPI::Internal::Type::Converter | Class | Hash
-              [nil, FinchAPI::Internal::Type::Converter.type_info(key)]
+              [nil, FinchAPI::Internal::Type::Converter.type_info(key), meta]
             end
 
           known_variants << variant_info
@@ -100,7 +101,8 @@ module FinchAPI
             return nil if key == FinchAPI::Internal::OMIT
 
             key = key.to_sym if key.is_a?(String)
-            known_variants.find { |k,| k == key }&.last&.call
+            _, found = known_variants.find { |k,| k == key }
+            found&.call
           else
             nil
           end

data/lib/finch_api/models/disconnect_response.rb

@@ -5,13 +5,13 @@ module FinchAPI
     # @see FinchAPI::Resources::Account#disconnect
     class DisconnectResponse < FinchAPI::Internal::Type::BaseModel
       # @!attribute status
-      #   If the request is successful, Finch will return “success” (HTTP 200 status).
+      #   If the request is successful, Finch will return "success" (HTTP 200 status).
       #
       #   @return [String]
       required :status, String
 
       # @!method initialize(status:)
-      #   @param status [String] If the request is successful, Finch will return “success” (HTTP 200 status).
+      #   @param status [String] If the request is successful, Finch will return "success" (HTTP 200 status).
     end
   end
 end

data/lib/finch_api/models/jobs/automated_async_job.rb

@@ -40,7 +40,7 @@ module FinchAPI
         # @!attribute scheduled_at
         #   The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
         #   be in the future if the job has not yet been enqueued. For ad-hoc jobs, this
-        #   field will be null.
+        #   field will be null.
         #
         #   @return [Time, nil]
         required :scheduled_at, Time, nil?: true

data/lib/finch_api/models/jobs/automated_list_params.rb

@@ -8,6 +8,14 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        # @!attribute entity_id
+        #   The entity ID to use when authenticating with a multi-account token. Required
+        #   when using a multi-account token to specify which entity's data to access.
+        #   Example: `123e4567-e89b-12d3-a456-426614174000`
+        #
+        #   @return [String, nil]
+        optional :entity_id, String
+
         # @!attribute limit
         #   Number of items to return
         #
@@ -20,7 +28,12 @@ module FinchAPI
         #   @return [Integer, nil]
         optional :offset, Integer
 
-        # @!method initialize(limit: nil, offset: nil, request_options: {})
+        # @!method initialize(entity_id: nil, limit: nil, offset: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Jobs::AutomatedListParams} for more details.
+        #
+        #   @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
+        #
         #   @param limit [Integer] Number of items to return
         #
         #   @param offset [Integer] Index to start from (defaults to 0)

data/lib/finch_api/models/jobs/automated_retrieve_params.rb

@@ -8,7 +8,20 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute entity_id
+        #   The entity ID to use when authenticating with a multi-account token. Required
+        #   when using a multi-account token to specify which entity's data to access.
+        #   Example: `123e4567-e89b-12d3-a456-426614174000`
+        #
+        #   @return [String, nil]
+        optional :entity_id, String
+
+        # @!method initialize(entity_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Jobs::AutomatedRetrieveParams} for more details.
+        #
+        #   @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/finch_api/models/jobs/manual_async_job.rb

@@ -8,8 +8,10 @@ module FinchAPI
         # @!attribute body
         #   Specific information about the job, such as individual statuses for batch jobs.
         #
-        #   @return [Array<Object>, nil]
-        required :body, FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown], nil?: true
+        #   @return [Array<Object, nil>, nil]
+        required :body,
+                 FinchAPI::Internal::Type::ArrayOf[FinchAPI::Internal::Type::Unknown, nil?: true],
+                 nil?: true
 
         # @!attribute job_id
         #
@@ -22,7 +24,7 @@ module FinchAPI
         required :status, enum: -> { FinchAPI::Jobs::ManualAsyncJob::Status }
 
         # @!method initialize(body:, job_id:, status:)
-        #   @param body [Array<Object>, nil] Specific information about the job, such as individual statuses for batch jobs.
+        #   @param body [Array<Object, nil>, nil] Specific information about the job, such as individual statuses for batch jobs.
         #
         #   @param job_id [String]
         #

data/lib/finch_api/models/jobs/manual_retrieve_params.rb

@@ -8,7 +8,20 @@ module FinchAPI
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        # @!method initialize(request_options: {})
+        # @!attribute entity_id
+        #   The entity ID to use when authenticating with a multi-account token. Required
+        #   when using a multi-account token to specify which entity's data to access.
+        #   Example: `123e4567-e89b-12d3-a456-426614174000`
+        #
+        #   @return [String, nil]
+        optional :entity_id, String
+
+        # @!method initialize(entity_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Jobs::ManualRetrieveParams} for more details.
+        #
+        #   @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
+        #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end
     end

data/lib/finch_api/models/request_forwarding_forward_response.rb

@@ -5,16 +5,16 @@ module FinchAPI
     # @see FinchAPI::Resources::RequestForwarding#forward
     class RequestForwardingForwardResponse < FinchAPI::Internal::Type::BaseModel
       # @!attribute data
-      #   A string representation of the HTTP response body of the forwarded request’s
-      #   response received from the underlying integration’s API. This field may be null
-      #   in the case where the upstream system’s response is empty.
+      #   A string representation of the HTTP response body of the forwarded request's
+      #   response received from the underlying integration's API. This field may be null
+      #   in the case where the upstream system's response is empty.
       #
       #   @return [String, nil]
       required :data, String, nil?: true
 
       # @!attribute headers
-      #   The HTTP headers of the forwarded request’s response, exactly as received from
-      #   the underlying integration’s API.
+      #   The HTTP headers of the forwarded request's response, exactly as received from
+      #   the underlying integration's API.
       #
       #   @return [Object, nil]
       required :headers, FinchAPI::Internal::Type::Unknown, nil?: true
@@ -27,8 +27,8 @@ module FinchAPI
       required :request, -> { FinchAPI::Models::RequestForwardingForwardResponse::Request }
 
       # @!attribute status_code
-      #   The HTTP status code of the forwarded request’s response, exactly received from
-      #   the underlying integration’s API. This value will be returned as an integer.
+      #   The HTTP status code of the forwarded request's response, exactly received from
+      #   the underlying integration's API. This value will be returned as an integer.
       #
       #   @return [Integer]
       required :status_code, Integer, api_name: :statusCode
@@ -37,13 +37,13 @@ module FinchAPI
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::RequestForwardingForwardResponse} for more details.
       #
-      #   @param data [String, nil] A string representation of the HTTP response body of the forwarded request’s res
+      #   @param data [String, nil] A string representation of the HTTP response body of the forwarded request's res
       #
-      #   @param headers [Object, nil] The HTTP headers of the forwarded request’s response, exactly as received from t
+      #   @param headers [Object, nil] The HTTP headers of the forwarded request's response, exactly as received from t
       #
       #   @param request [FinchAPI::Models::RequestForwardingForwardResponse::Request] An object containing details of your original forwarded request, for your ease o
       #
-      #   @param status_code [Integer] The HTTP status code of the forwarded request’s response, exactly received from
+      #   @param status_code [Integer] The HTTP status code of the forwarded request's response, exactly received from
 
       # @see FinchAPI::Models::RequestForwardingForwardResponse#request
       class Request < FinchAPI::Internal::Type::BaseModel

data/lib/finch_api/resources/jobs/automated.rb

@@ -41,30 +41,43 @@ module FinchAPI
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Jobs::AutomatedRetrieveParams} for more details.
+        #
         # Get an automated job by `job_id`.
         #
-        # @overload retrieve(job_id, request_options: {})
+        # @overload retrieve(job_id, entity_id: nil, request_options: {})
         #
         # @param job_id [String]
+        #
+        # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
+        #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [FinchAPI::Models::Jobs::AutomatedAsyncJob]
         #
         # @see FinchAPI::Models::Jobs::AutomatedRetrieveParams
         def retrieve(job_id, params = {})
+          parsed, options = FinchAPI::Jobs::AutomatedRetrieveParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["jobs/automated/%1$s", job_id],
+            query: parsed,
             model: FinchAPI::Jobs::AutomatedAsyncJob,
-            options: params[:request_options]
+            options: options
           )
         end
 
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Jobs::AutomatedListParams} for more details.
+        #
         # Get all automated jobs. Automated jobs are completed by a machine. By default,
         # jobs are sorted in descending order by submission time. For scheduled jobs such
         # as data syncs, only the next scheduled job is shown.
         #
-        # @overload list(limit: nil, offset: nil, request_options: {})
+        # @overload list(entity_id: nil, limit: nil, offset: nil, request_options: {})
+        #
+        # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
         #
         # @param limit [Integer] Number of items to return
         #

data/lib/finch_api/resources/jobs/manual.rb

@@ -4,23 +4,31 @@ module FinchAPI
   module Resources
     class Jobs
       class Manual
+        # Some parameter documentations has been truncated, see
+        # {FinchAPI::Models::Jobs::ManualRetrieveParams} for more details.
+        #
         # Get a manual job by `job_id`. Manual jobs are completed by a human and include
         # Assisted Benefits jobs.
         #
-        # @overload retrieve(job_id, request_options: {})
+        # @overload retrieve(job_id, entity_id: nil, request_options: {})
         #
         # @param job_id [String]
+        #
+        # @param entity_id [String] The entity ID to use when authenticating with a multi-account token. Required wh
+        #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #
         # @return [FinchAPI::Models::Jobs::ManualAsyncJob]
         #
         # @see FinchAPI::Models::Jobs::ManualRetrieveParams
         def retrieve(job_id, params = {})
+          parsed, options = FinchAPI::Jobs::ManualRetrieveParams.dump_request(params)
           @client.request(
             method: :get,
             path: ["jobs/manual/%1$s", job_id],
+            query: parsed,
             model: FinchAPI::Jobs::ManualAsyncJob,
-            options: params[:request_options]
+            options: options
           )
         end
 

data/lib/finch_api/resources/request_forwarding.rb

@@ -7,8 +7,8 @@ module FinchAPI
       # {FinchAPI::Models::RequestForwardingForwardParams} for more details.
       #
       # The Forward API allows you to make direct requests to an employment system. If
-      # Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
-      # Forward allows you to push or pull data models directly against an integration’s
+      # Finch's unified API doesn't have a data model that cleanly fits your needs, then
+      # Forward allows you to push or pull data models directly against an integration's
       # API.
       #
       # @overload forward(method_:, route:, data: nil, headers: nil, params: nil, request_options: {})

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0.pre.alpha.24"
+  VERSION = "0.1.0.pre.alpha.26"
 end

data/rbi/finch_api/internal/transport/base_client.rbi

@@ -213,7 +213,7 @@ module FinchAPI
             send_retry_header: T::Boolean
           ).returns([Integer, Net::HTTPResponse, T::Enumerable[String]])
         end
-        private def send_request(
+        def send_request(
           request,
           redirect_count:,
           retry_count:,

data/rbi/finch_api/internal/type/converter.rbi

@@ -90,6 +90,60 @@ module FinchAPI
           def self.type_info(spec)
           end
 
+          # @api private
+          sig do
+            params(
+              type_info:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          FinchAPI::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          FinchAPI::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(FinchAPI::Internal::Type::Converter::Input),
+                  FinchAPI::Internal::Type::Converter::Input
+                ),
+              spec:
+                T.any(
+                  {
+                    const:
+                      T.nilable(
+                        T.any(NilClass, T::Boolean, Integer, Float, Symbol)
+                      ),
+                    enum:
+                      T.nilable(
+                        T.proc.returns(
+                          FinchAPI::Internal::Type::Converter::Input
+                        )
+                      ),
+                    union:
+                      T.nilable(
+                        T.proc.returns(
+                          FinchAPI::Internal::Type::Converter::Input
+                        )
+                      )
+                  },
+                  T.proc.returns(FinchAPI::Internal::Type::Converter::Input),
+                  FinchAPI::Internal::Type::Converter::Input
+                )
+            ).returns(FinchAPI::Internal::AnyHash)
+          end
+          def self.meta_info(type_info, spec)
+          end
+
           # @api private
           sig do
             params(translate_names: T::Boolean).returns(

data/rbi/finch_api/internal/type/union.rbi

@@ -16,7 +16,8 @@ module FinchAPI
             T::Array[
               [
                 T.nilable(Symbol),
-                T.proc.returns(FinchAPI::Internal::Type::Converter::Input)
+                T.proc.returns(FinchAPI::Internal::Type::Converter::Input),
+                FinchAPI::Internal::AnyHash
               ]
             ]
           )
@@ -25,7 +26,13 @@ module FinchAPI
         end
 
         # @api private
-        sig { returns(T::Array[[T.nilable(Symbol), T.anything]]) }
+        sig do
+          returns(
+            T::Array[
+              [T.nilable(Symbol), T.anything, FinchAPI::Internal::AnyHash]
+            ]
+          )
+        end
         protected def derefed_variants
         end
 

data/rbi/finch_api/models/disconnect_response.rbi

@@ -8,13 +8,13 @@ module FinchAPI
           T.any(FinchAPI::DisconnectResponse, FinchAPI::Internal::AnyHash)
         end
 
-      # If the request is successful, Finch will return “success” (HTTP 200 status).
+      # If the request is successful, Finch will return "success" (HTTP 200 status).
       sig { returns(String) }
       attr_accessor :status
 
       sig { params(status: String).returns(T.attached_class) }
       def self.new(
-        # If the request is successful, Finch will return “success” (HTTP 200 status).
+        # If the request is successful, Finch will return "success" (HTTP 200 status).
         status:
       )
       end

data/rbi/finch_api/models/jobs/automated_async_job.rbi

@@ -43,7 +43,7 @@ module FinchAPI
 
         # The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
         # be in the future if the job has not yet been enqueued. For ad-hoc jobs, this
-        # field will be null.
+        # field will be null.
         sig { returns(T.nilable(Time)) }
         attr_accessor :scheduled_at
 
@@ -87,7 +87,7 @@ module FinchAPI
           params:,
           # The datetime a job is scheduled to be run. For scheduled jobs, this datetime can
           # be in the future if the job has not yet been enqueued. For ad-hoc jobs, this
-          # field will be null.
+          # field will be null.
           scheduled_at:,
           # The datetime a job entered into the job queue.
           started_at:,

data/rbi/finch_api/models/jobs/automated_list_params.rbi

@@ -15,6 +15,15 @@ module FinchAPI
             )
           end
 
+        # The entity ID to use when authenticating with a multi-account token. Required
+        # when using a multi-account token to specify which entity's data to access.
+        # Example: `123e4567-e89b-12d3-a456-426614174000`
+        sig { returns(T.nilable(String)) }
+        attr_reader :entity_id
+
+        sig { params(entity_id: String).void }
+        attr_writer :entity_id
+
         # Number of items to return
         sig { returns(T.nilable(Integer)) }
         attr_reader :limit
@@ -31,12 +40,17 @@ module FinchAPI
 
         sig do
           params(
+            entity_id: String,
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # The entity ID to use when authenticating with a multi-account token. Required
+          # when using a multi-account token to specify which entity's data to access.
+          # Example: `123e4567-e89b-12d3-a456-426614174000`
+          entity_id: nil,
           # Number of items to return
           limit: nil,
           # Index to start from (defaults to 0)
@@ -48,6 +62,7 @@ module FinchAPI
         sig do
           override.returns(
             {
+              entity_id: String,
               limit: Integer,
               offset: Integer,
               request_options: FinchAPI::RequestOptions

data/rbi/finch_api/models/jobs/automated_retrieve_params.rbi

@@ -15,15 +15,35 @@ module FinchAPI
             )
           end
 
+        # The entity ID to use when authenticating with a multi-account token. Required
+        # when using a multi-account token to specify which entity's data to access.
+        # Example: `123e4567-e89b-12d3-a456-426614174000`
+        sig { returns(T.nilable(String)) }
+        attr_reader :entity_id
+
+        sig { params(entity_id: String).void }
+        attr_writer :entity_id
+
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            entity_id: String,
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # The entity ID to use when authenticating with a multi-account token. Required
+          # when using a multi-account token to specify which entity's data to access.
+          # Example: `123e4567-e89b-12d3-a456-426614174000`
+          entity_id: nil,
+          request_options: {}
+        )
         end
 
-        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
+        sig do
+          override.returns(
+            { entity_id: String, request_options: FinchAPI::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/finch_api/models/jobs/manual_async_job.rbi

@@ -10,7 +10,7 @@ module FinchAPI
           end
 
         # Specific information about the job, such as individual statuses for batch jobs.
-        sig { returns(T.nilable(T::Array[T.anything])) }
+        sig { returns(T.nilable(T::Array[T.nilable(T.anything)])) }
         attr_accessor :body
 
         sig { returns(String) }
@@ -21,7 +21,7 @@ module FinchAPI
 
         sig do
           params(
-            body: T.nilable(T::Array[T.anything]),
+            body: T.nilable(T::Array[T.nilable(T.anything)]),
             job_id: String,
             status: FinchAPI::Jobs::ManualAsyncJob::Status::OrSymbol
           ).returns(T.attached_class)
@@ -37,7 +37,7 @@ module FinchAPI
         sig do
           override.returns(
             {
-              body: T.nilable(T::Array[T.anything]),
+              body: T.nilable(T::Array[T.nilable(T.anything)]),
               job_id: String,
               status: FinchAPI::Jobs::ManualAsyncJob::Status::TaggedSymbol
             }

data/rbi/finch_api/models/jobs/manual_retrieve_params.rbi

@@ -15,15 +15,35 @@ module FinchAPI
             )
           end
 
+        # The entity ID to use when authenticating with a multi-account token. Required
+        # when using a multi-account token to specify which entity's data to access.
+        # Example: `123e4567-e89b-12d3-a456-426614174000`
+        sig { returns(T.nilable(String)) }
+        attr_reader :entity_id
+
+        sig { params(entity_id: String).void }
+        attr_writer :entity_id
+
         sig do
-          params(request_options: FinchAPI::RequestOptions::OrHash).returns(
-            T.attached_class
-          )
+          params(
+            entity_id: String,
+            request_options: FinchAPI::RequestOptions::OrHash
+          ).returns(T.attached_class)
         end
-        def self.new(request_options: {})
+        def self.new(
+          # The entity ID to use when authenticating with a multi-account token. Required
+          # when using a multi-account token to specify which entity's data to access.
+          # Example: `123e4567-e89b-12d3-a456-426614174000`
+          entity_id: nil,
+          request_options: {}
+        )
         end
 
-        sig { override.returns({ request_options: FinchAPI::RequestOptions }) }
+        sig do
+          override.returns(
+            { entity_id: String, request_options: FinchAPI::RequestOptions }
+          )
+        end
         def to_hash
         end
       end

data/rbi/finch_api/models/request_forwarding_forward_response.rbi

@@ -11,14 +11,14 @@ module FinchAPI
           )
         end
 
-      # A string representation of the HTTP response body of the forwarded request’s
-      # response received from the underlying integration’s API. This field may be null
-      # in the case where the upstream system’s response is empty.
+      # A string representation of the HTTP response body of the forwarded request's
+      # response received from the underlying integration's API. This field may be null
+      # in the case where the upstream system's response is empty.
       sig { returns(T.nilable(String)) }
       attr_accessor :data
 
-      # The HTTP headers of the forwarded request’s response, exactly as received from
-      # the underlying integration’s API.
+      # The HTTP headers of the forwarded request's response, exactly as received from
+      # the underlying integration's API.
       sig { returns(T.nilable(T.anything)) }
       attr_accessor :headers
 
@@ -37,8 +37,8 @@ module FinchAPI
       end
       attr_writer :request
 
-      # The HTTP status code of the forwarded request’s response, exactly received from
-      # the underlying integration’s API. This value will be returned as an integer.
+      # The HTTP status code of the forwarded request's response, exactly received from
+      # the underlying integration's API. This value will be returned as an integer.
       sig { returns(Integer) }
       attr_accessor :status_code
 
@@ -52,18 +52,18 @@ module FinchAPI
         ).returns(T.attached_class)
       end
       def self.new(
-        # A string representation of the HTTP response body of the forwarded request’s
-        # response received from the underlying integration’s API. This field may be null
-        # in the case where the upstream system’s response is empty.
+        # A string representation of the HTTP response body of the forwarded request's
+        # response received from the underlying integration's API. This field may be null
+        # in the case where the upstream system's response is empty.
         data:,
-        # The HTTP headers of the forwarded request’s response, exactly as received from
-        # the underlying integration’s API.
+        # The HTTP headers of the forwarded request's response, exactly as received from
+        # the underlying integration's API.
         headers:,
         # An object containing details of your original forwarded request, for your ease
         # of reference.
         request:,
-        # The HTTP status code of the forwarded request’s response, exactly received from
-        # the underlying integration’s API. This value will be returned as an integer.
+        # The HTTP status code of the forwarded request's response, exactly received from
+        # the underlying integration's API. This value will be returned as an integer.
         status_code:
       )
       end

data/rbi/finch_api/resources/jobs/automated.rbi

@@ -37,10 +37,18 @@ module FinchAPI
         sig do
           params(
             job_id: String,
+            entity_id: String,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Jobs::AutomatedAsyncJob)
         end
-        def retrieve(job_id, request_options: {})
+        def retrieve(
+          job_id,
+          # The entity ID to use when authenticating with a multi-account token. Required
+          # when using a multi-account token to specify which entity's data to access.
+          # Example: `123e4567-e89b-12d3-a456-426614174000`
+          entity_id: nil,
+          request_options: {}
+        )
         end
 
         # Get all automated jobs. Automated jobs are completed by a machine. By default,
@@ -48,12 +56,17 @@ module FinchAPI
         # as data syncs, only the next scheduled job is shown.
         sig do
           params(
+            entity_id: String,
             limit: Integer,
             offset: Integer,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Models::Jobs::AutomatedListResponse)
         end
         def list(
+          # The entity ID to use when authenticating with a multi-account token. Required
+          # when using a multi-account token to specify which entity's data to access.
+          # Example: `123e4567-e89b-12d3-a456-426614174000`
+          entity_id: nil,
           # Number of items to return
           limit: nil,
           # Index to start from (defaults to 0)

data/rbi/finch_api/resources/jobs/manual.rbi

@@ -9,10 +9,18 @@ module FinchAPI
         sig do
           params(
             job_id: String,
+            entity_id: String,
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Jobs::ManualAsyncJob)
         end
-        def retrieve(job_id, request_options: {})
+        def retrieve(
+          job_id,
+          # The entity ID to use when authenticating with a multi-account token. Required
+          # when using a multi-account token to specify which entity's data to access.
+          # Example: `123e4567-e89b-12d3-a456-426614174000`
+          entity_id: nil,
+          request_options: {}
+        )
         end
 
         # @api private

data/rbi/finch_api/resources/request_forwarding.rbi

@@ -4,8 +4,8 @@ module FinchAPI
   module Resources
     class RequestForwarding
       # The Forward API allows you to make direct requests to an employment system. If
-      # Finch’s unified API doesn’t have a data model that cleanly fits your needs, then
-      # Forward allows you to push or pull data models directly against an integration’s
+      # Finch's unified API doesn't have a data model that cleanly fits your needs, then
+      # Forward allows you to push or pull data models directly against an integration's
       # API.
       sig do
         params(

data/sig/finch_api/internal/transport/base_client.rbs

@@ -99,7 +99,7 @@ module FinchAPI
           retry_count: Integer
         ) -> Float
 
-        private def send_request: (
+        def send_request: (
           FinchAPI::Internal::Transport::BaseClient::request_input request,
           redirect_count: Integer,
           retry_count: Integer,

data/sig/finch_api/internal/type/converter.rbs

@@ -39,6 +39,23 @@ module FinchAPI
           | FinchAPI::Internal::Type::Converter::input spec
         ) -> (^-> top)
 
+        def self.meta_info: (
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> FinchAPI::Internal::Type::Converter::input?,
+            union: ^-> FinchAPI::Internal::Type::Converter::input?
+          }
+          | ^-> FinchAPI::Internal::Type::Converter::input
+          | FinchAPI::Internal::Type::Converter::input type_info,
+          {
+            const: (nil | bool | Integer | Float | Symbol)?,
+            enum: ^-> FinchAPI::Internal::Type::Converter::input?,
+            union: ^-> FinchAPI::Internal::Type::Converter::input?
+          }
+          | ^-> FinchAPI::Internal::Type::Converter::input
+          | FinchAPI::Internal::Type::Converter::input spec
+        ) -> ::Hash[Symbol, top]
+
         def self.new_coerce_state: (
           ?translate_names: bool
         ) -> FinchAPI::Internal::Type::Converter::coerce_state

data/sig/finch_api/internal/type/union.rbs

@@ -5,9 +5,9 @@ module FinchAPI
         include FinchAPI::Internal::Type::Converter
         include FinchAPI::Internal::Util::SorbetRuntimeSupport
 
-        private def self.known_variants: -> ::Array[[Symbol?, (^-> FinchAPI::Internal::Type::Converter::input)]]
+        private def self.known_variants: -> ::Array[[Symbol?, (^-> FinchAPI::Internal::Type::Converter::input), ::Hash[Symbol, top]]]
 
-        def self.derefed_variants: -> ::Array[[Symbol?, top]]
+        def self.derefed_variants: -> ::Array[[Symbol?, top, ::Hash[Symbol, top]]]
 
         def self.variants: -> ::Array[top]
 

data/sig/finch_api/models/jobs/automated_list_params.rbs

@@ -2,13 +2,17 @@ module FinchAPI
   module Models
     module Jobs
       type automated_list_params =
-        { limit: Integer, offset: Integer }
+        { entity_id: String, limit: Integer, offset: Integer }
         & FinchAPI::Internal::Type::request_parameters
 
       class AutomatedListParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
+        attr_reader entity_id: String?
+
+        def entity_id=: (String) -> String
+
         attr_reader limit: Integer?
 
         def limit=: (Integer) -> Integer
@@ -18,12 +22,14 @@ module FinchAPI
         def offset=: (Integer) -> Integer
 
         def initialize: (
+          ?entity_id: String,
           ?limit: Integer,
           ?offset: Integer,
           ?request_options: FinchAPI::request_opts
         ) -> void
 
         def to_hash: -> {
+          entity_id: String,
           limit: Integer,
           offset: Integer,
           request_options: FinchAPI::RequestOptions

data/sig/finch_api/models/jobs/automated_retrieve_params.rbs

@@ -2,15 +2,25 @@ module FinchAPI
   module Models
     module Jobs
       type automated_retrieve_params =
-        {  } & FinchAPI::Internal::Type::request_parameters
+        { entity_id: String } & FinchAPI::Internal::Type::request_parameters
 
       class AutomatedRetrieveParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        def initialize: (?request_options: FinchAPI::request_opts) -> void
+        attr_reader entity_id: String?
 
-        def to_hash: -> { request_options: FinchAPI::RequestOptions }
+        def entity_id=: (String) -> String
+
+        def initialize: (
+          ?entity_id: String,
+          ?request_options: FinchAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          entity_id: String,
+          request_options: FinchAPI::RequestOptions
+        }
       end
     end
   end

data/sig/finch_api/models/jobs/manual_async_job.rbs

@@ -3,26 +3,26 @@ module FinchAPI
     module Jobs
       type manual_async_job =
         {
-          body: ::Array[top]?,
+          body: ::Array[top?]?,
           job_id: String,
           status: FinchAPI::Models::Jobs::ManualAsyncJob::status
         }
 
       class ManualAsyncJob < FinchAPI::Internal::Type::BaseModel
-        attr_accessor body: ::Array[top]?
+        attr_accessor body: ::Array[top?]?
 
         attr_accessor job_id: String
 
         attr_accessor status: FinchAPI::Models::Jobs::ManualAsyncJob::status
 
         def initialize: (
-          body: ::Array[top]?,
+          body: ::Array[top?]?,
           job_id: String,
           status: FinchAPI::Models::Jobs::ManualAsyncJob::status
         ) -> void
 
         def to_hash: -> {
-          body: ::Array[top]?,
+          body: ::Array[top?]?,
           job_id: String,
           status: FinchAPI::Models::Jobs::ManualAsyncJob::status
         }

data/sig/finch_api/models/jobs/manual_retrieve_params.rbs

@@ -2,15 +2,25 @@ module FinchAPI
   module Models
     module Jobs
       type manual_retrieve_params =
-        {  } & FinchAPI::Internal::Type::request_parameters
+        { entity_id: String } & FinchAPI::Internal::Type::request_parameters
 
       class ManualRetrieveParams < FinchAPI::Internal::Type::BaseModel
         extend FinchAPI::Internal::Type::RequestParameters::Converter
         include FinchAPI::Internal::Type::RequestParameters
 
-        def initialize: (?request_options: FinchAPI::request_opts) -> void
+        attr_reader entity_id: String?
 
-        def to_hash: -> { request_options: FinchAPI::RequestOptions }
+        def entity_id=: (String) -> String
+
+        def initialize: (
+          ?entity_id: String,
+          ?request_options: FinchAPI::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          entity_id: String,
+          request_options: FinchAPI::RequestOptions
+        }
       end
     end
   end

data/sig/finch_api/resources/jobs/automated.rbs

@@ -10,10 +10,12 @@ module FinchAPI
 
         def retrieve: (
           String job_id,
+          ?entity_id: String,
           ?request_options: FinchAPI::request_opts
         ) -> FinchAPI::Jobs::AutomatedAsyncJob
 
         def list: (
+          ?entity_id: String,
           ?limit: Integer,
           ?offset: Integer,
           ?request_options: FinchAPI::request_opts

data/sig/finch_api/resources/jobs/manual.rbs

@@ -4,6 +4,7 @@ module FinchAPI
       class Manual
         def retrieve: (
           String job_id,
+          ?entity_id: String,
           ?request_options: FinchAPI::request_opts
         ) -> FinchAPI::Jobs::ManualAsyncJob
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.24
+  version: 0.1.0.pre.alpha.26
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-07-25 00:00:00.000000000 Z
+date: 2025-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool