finch-api 0.1.0.pre.alpha.25 → 0.1.0.pre.alpha.27

data/rbi/finch_api/errors.rbi

@@ -59,10 +59,10 @@ module FinchAPI
     end
 
     class APIConnectionError < FinchAPI::Errors::APIError
-      sig { void }
+      sig { returns(NilClass) }
       attr_accessor :status
 
-      sig { void }
+      sig { returns(NilClass) }
       attr_accessor :body
 
       # @api private

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/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.25
+  version: 0.1.0.pre.alpha.27
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-08-07 00:00:00.000000000 Z
+date: 2025-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: connection_pool