finch-api 0.1.0.pre.alpha.28 → 0.1.0.pre.alpha.30

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ecf78c65c2b898a2b5031cd7fcc3328bfdc13e98431b09900bc6e1d8210edca8
-  data.tar.gz: 9d8bb5ffed3d5db0299511d1204935d73e3b3cf039e876925135cc17a8e405b9
+  metadata.gz: 3496470a02b2525dd330a546b1704038a2127435260524e54d0b454744fc0511
+  data.tar.gz: 513a145229c45d27e4a85f913a724f8e30822fbeb93fb0425abab26884abe7ee
 SHA512:
-  metadata.gz: 7886c407c082c9c2ca8070104bd1024515434914420b22e1a20df818cfe8d37aebac55d0687ea126f93dc3a0d1b7c4628d7b178dc5f7dcf8bdd93e5c9ede7be8
-  data.tar.gz: 23e139493a3c37ed53380063b9f3dd3507e542baea5f5c5afe59c95b2850f00e311bff1fe5fb645499c2ff10f337b91d3de7e51232f4fac3d3b6949ef16015b0
+  metadata.gz: e67aa03accd57373be7e4805ff36c2272699cd54f157ffb395e46a312c3db4dacc4e2d12cd7de8ffb70a80976ad55a31fb616b27ea3e3794ab2f97752109d2a7
+  data.tar.gz: 7924c3afdc7c4474d830209e24b068bd0a9a49cdca40aefc4aebda37a91732cdf65ecd010260fe9a3dbfa801d2dd2f9db756ce44131a1de87f8a0acff75a17a6

data/CHANGELOG.md

@@ -1,5 +1,27 @@
 # Changelog
 
+## 0.1.0-alpha.30 (2025-09-08)
+
+Full Changelog: [v0.1.0-alpha.29...v0.1.0-alpha.30](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.29...v0.1.0-alpha.30)
+
+### Features
+
+* **api:** api update ([a67b714](https://github.com/Finch-API/finch-api-ruby/commit/a67b7140a175c5091a52ef82b90860b39a74075f))
+* **api:** make client id, client secret optional again ([d1b769f](https://github.com/Finch-API/finch-api-ruby/commit/d1b769f81ce16d27fe940f647c19d6f6e4b1b2b4))
+
+## 0.1.0-alpha.29 (2025-08-24)
+
+Full Changelog: [v0.1.0-alpha.28...v0.1.0-alpha.29](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.28...v0.1.0-alpha.29)
+
+### Features
+
+* **api:** api update ([a8f432a](https://github.com/Finch-API/finch-api-ruby/commit/a8f432a47e2e5ffbb1be53637b672383301d1baf))
+
+
+### Chores
+
+* add json schema comment for rubocop.yml ([9c458ab](https://github.com/Finch-API/finch-api-ruby/commit/9c458abf8ac902197c09eb4be5612d48d8d0723e))
+
 ## 0.1.0-alpha.28 (2025-08-20)
 
 Full Changelog: [v0.1.0-alpha.27...v0.1.0-alpha.28](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.27...v0.1.0-alpha.28)

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.28"
+gem "finch-api", "~> 0.1.0.pre.alpha.30"
 ```
 
 <!-- x-release-please-end -->

data/lib/finch_api/models/access_token_create_params.rb

@@ -7,23 +7,23 @@ module FinchAPI
       extend FinchAPI::Internal::Type::RequestParameters::Converter
       include FinchAPI::Internal::Type::RequestParameters
 
+      # @!attribute code
+      #   The authorization code received from the authorization server
+      #
+      #   @return [String]
+      required :code, String
+
       # @!attribute client_id
       #   The client ID for your application
       #
-      #   @return [String]
-      required :client_id, String
+      #   @return [String, nil]
+      optional :client_id, String
 
       # @!attribute client_secret
       #   The client secret for your application
       #
-      #   @return [String]
-      required :client_secret, String
-
-      # @!attribute code
-      #   The authorization code received from the authorization server
-      #
-      #   @return [String]
-      required :code, String
+      #   @return [String, nil]
+      optional :client_secret, String
 
       # @!attribute redirect_uri
       #   The redirect URI used in the authorization request (optional)
@@ -31,13 +31,13 @@ module FinchAPI
       #   @return [String, nil]
       optional :redirect_uri, String
 
-      # @!method initialize(client_id:, client_secret:, code:, redirect_uri: nil, request_options: {})
+      # @!method initialize(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
+      #   @param code [String] The authorization code received from the authorization server
+      #
       #   @param client_id [String] The client ID for your application
       #
       #   @param client_secret [String] The client secret for your application
       #
-      #   @param code [String] The authorization code received from the authorization server
-      #
       #   @param redirect_uri [String] The redirect URI used in the authorization request (optional)
       #
       #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]

data/lib/finch_api/models/hris/pay_statement.rb

@@ -176,31 +176,19 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::Earning#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::Earning::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::Earning::Attributes::Metadata} for more
-              #   details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::Earning::Attributes} for more details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 
@@ -256,31 +244,20 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata}
-              #   for more details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::EmployeeDeduction::Attributes} for more
+            #   details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 
@@ -332,31 +309,20 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes::Metadata}
-              #   for more details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::EmployerContribution::Attributes} for
+            #   more details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 
@@ -441,31 +407,19 @@ module FinchAPI
           # @see FinchAPI::Models::HRIS::PayStatement::Tax#attributes
           class Attributes < FinchAPI::Internal::Type::BaseModel
             # @!attribute metadata
+            #   The metadata to be attached to the entity by existing rules. It is a key-value
+            #   pairs where the values can be of any type (string, number, boolean, object,
+            #   array, etc.).
             #
-            #   @return [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata]
-            required :metadata, -> { FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata }
+            #   @return [Hash{Symbol=>Object, nil}]
+            required :metadata,
+                     FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
 
             # @!method initialize(metadata:)
-            #   @param metadata [FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata]
-
-            # @see FinchAPI::Models::HRIS::PayStatement::Tax::Attributes#metadata
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              # @!attribute metadata
-              #   The metadata to be attached to the entity by existing rules. It is a key-value
-              #   pairs where the values can be of any type (string, number, boolean, object,
-              #   array, etc.).
-              #
-              #   @return [Hash{Symbol=>Object, nil}]
-              required :metadata,
-                       FinchAPI::Internal::Type::HashOf[FinchAPI::Internal::Type::Unknown, nil?: true]
-
-              # @!method initialize(metadata:)
-              #   Some parameter documentations has been truncated, see
-              #   {FinchAPI::Models::HRIS::PayStatement::Tax::Attributes::Metadata} for more
-              #   details.
-              #
-              #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
-            end
+            #   Some parameter documentations has been truncated, see
+            #   {FinchAPI::Models::HRIS::PayStatement::Tax::Attributes} for more details.
+            #
+            #   @param metadata [Hash{Symbol=>Object, nil}] The metadata to be attached to the entity by existing rules. It is a key-value p
           end
         end
 

data/lib/finch_api/models/introspection.rb

@@ -99,6 +99,18 @@ module FinchAPI
       #   @return [String, nil]
       optional :customer_name, String, nil?: true
 
+      # @!attribute entity_ids
+      #   Array of entity IDs associated with this connection.
+      #
+      #   @return [Array<String>, nil]
+      optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
+
+      # @!attribute entity_mode
+      #   Indicates whether this connection manages a single entity or multiple entities.
+      #
+      #   @return [Symbol, FinchAPI::Models::Introspection::EntityMode, nil]
+      optional :entity_mode, enum: -> { FinchAPI::Introspection::EntityMode }
+
       # @!attribute manual
       #   Whether the connection associated with the `access_token` uses the Assisted
       #   Connect Flow. (`true` if using Assisted Connect, `false` if connection is
@@ -122,7 +134,7 @@ module FinchAPI
       #   @return [String, nil]
       optional :username, String, nil?: true
 
-      # @!method initialize(id:, client_id:, client_type:, connection_id:, connection_status:, connection_type:, products:, provider_id:, account_id: nil, authentication_methods: nil, company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, manual: nil, payroll_provider_id: nil, username: nil)
+      # @!method initialize(id:, client_id:, client_type:, connection_id:, connection_status:, connection_type:, products:, provider_id:, account_id: nil, authentication_methods: nil, company_id: nil, customer_email: nil, customer_id: nil, customer_name: nil, entity_ids: nil, entity_mode: nil, manual: nil, payroll_provider_id: nil, username: nil)
       #   Some parameter documentations has been truncated, see
       #   {FinchAPI::Models::Introspection} for more details.
       #
@@ -154,6 +166,10 @@ module FinchAPI
       #
       #   @param customer_name [String, nil] The name of your customer you provided to Finch when a connect session was creat
       #
+      #   @param entity_ids [Array<String>] Array of entity IDs associated with this connection.
+      #
+      #   @param entity_mode [Symbol, FinchAPI::Models::Introspection::EntityMode] Indicates whether this connection manages a single entity or multiple entities.
+      #
       #   @param manual [Boolean] Whether the connection associated with the `access_token` uses the Assisted Conn
       #
       #   @param payroll_provider_id [String] [DEPRECATED] Use `provider_id` to identify the provider instead of this payroll
@@ -317,6 +333,19 @@ module FinchAPI
           end
         end
       end
+
+      # Indicates whether this connection manages a single entity or multiple entities.
+      #
+      # @see FinchAPI::Models::Introspection#entity_mode
+      module EntityMode
+        extend FinchAPI::Internal::Type::Enum
+
+        SINGLE = :single
+        MULTI = :multi
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
     end
   end
 end

data/lib/finch_api/resources/access_tokens.rb

@@ -5,14 +5,14 @@ module FinchAPI
     class AccessTokens
       # Exchange the authorization code for an access token
       #
-      # @overload create(client_id:, client_secret:, code:, redirect_uri: nil, request_options: {})
+      # @overload create(code:, client_id: nil, client_secret: nil, redirect_uri: nil, request_options: {})
+      #
+      # @param code [String] The authorization code received from the authorization server
       #
       # @param client_id [String] The client ID for your application
       #
       # @param client_secret [String] The client secret for your application
       #
-      # @param code [String] The authorization code received from the authorization server
-      #
       # @param redirect_uri [String] The redirect URI used in the authorization request (optional)
       #
       # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]

data/lib/finch_api/version.rb

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

data/rbi/finch_api/models/access_token_create_params.rbi

@@ -11,17 +11,23 @@ module FinchAPI
           T.any(FinchAPI::AccessTokenCreateParams, FinchAPI::Internal::AnyHash)
         end
 
-      # The client ID for your application
+      # The authorization code received from the authorization server
       sig { returns(String) }
-      attr_accessor :client_id
+      attr_accessor :code
+
+      # The client ID for your application
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_id
+
+      sig { params(client_id: String).void }
+      attr_writer :client_id
 
       # The client secret for your application
-      sig { returns(String) }
-      attr_accessor :client_secret
+      sig { returns(T.nilable(String)) }
+      attr_reader :client_secret
 
-      # The authorization code received from the authorization server
-      sig { returns(String) }
-      attr_accessor :code
+      sig { params(client_secret: String).void }
+      attr_writer :client_secret
 
       # The redirect URI used in the authorization request (optional)
       sig { returns(T.nilable(String)) }
@@ -32,20 +38,20 @@ module FinchAPI
 
       sig do
         params(
+          code: String,
           client_id: String,
           client_secret: String,
-          code: String,
           redirect_uri: String,
           request_options: FinchAPI::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        # The client ID for your application
-        client_id:,
-        # The client secret for your application
-        client_secret:,
         # The authorization code received from the authorization server
         code:,
+        # The client ID for your application
+        client_id: nil,
+        # The client secret for your application
+        client_secret: nil,
         # The redirect URI used in the authorization request (optional)
         redirect_uri: nil,
         request_options: {}
@@ -55,9 +61,9 @@ module FinchAPI
       sig do
         override.returns(
           {
+            code: String,
             client_id: String,
             client_secret: String,
-            code: String,
             redirect_uri: String,
             request_options: FinchAPI::RequestOptions
           }

data/rbi/finch_api/models/hris/pay_statement.rbi

@@ -382,77 +382,32 @@ module FinchAPI
                 )
               end
 
-            sig do
-              returns(
-                FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
-              )
-            end
-            attr_reader :metadata
+            # The metadata to be attached to the entity by existing rules. It is a key-value
+            # pairs where the values can be of any type (string, number, boolean, object,
+            # array, etc.).
+            sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
+            attr_accessor :metadata
 
             sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash
-              ).void
-            end
-            attr_writer :metadata
-
-            sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata::OrHash
-              ).returns(T.attached_class)
+              params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).returns(
+                T.attached_class
+              )
             end
-            def self.new(metadata:)
+            def self.new(
+              # The metadata to be attached to the entity by existing rules. It is a key-value
+              # pairs where the values can be of any type (string, number, boolean, object,
+              # array, etc.).
+              metadata:
+            )
             end
 
             sig do
               override.returns(
-                {
-                  metadata:
-                    FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
-                }
+                { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
               )
             end
             def to_hash
             end
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata,
-                    FinchAPI::Internal::AnyHash
-                  )
-                end
-
-              # The metadata to be attached to the entity by existing rules. It is a key-value
-              # pairs where the values can be of any type (string, number, boolean, object,
-              # array, etc.).
-              sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
-              attr_accessor :metadata
-
-              sig do
-                params(
-                  metadata: T::Hash[Symbol, T.nilable(T.anything)]
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                # The metadata to be attached to the entity by existing rules. It is a key-value
-                # pairs where the values can be of any type (string, number, boolean, object,
-                # array, etc.).
-                metadata:
-              )
-              end
-
-              sig do
-                override.returns(
-                  { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
-                )
-              end
-              def to_hash
-              end
-            end
           end
         end
 
@@ -559,77 +514,32 @@ module FinchAPI
                 )
               end
 
-            sig do
-              returns(
-                FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
-              )
-            end
-            attr_reader :metadata
+            # The metadata to be attached to the entity by existing rules. It is a key-value
+            # pairs where the values can be of any type (string, number, boolean, object,
+            # array, etc.).
+            sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
+            attr_accessor :metadata
 
             sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash
-              ).void
-            end
-            attr_writer :metadata
-
-            sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata::OrHash
-              ).returns(T.attached_class)
+              params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).returns(
+                T.attached_class
+              )
             end
-            def self.new(metadata:)
+            def self.new(
+              # The metadata to be attached to the entity by existing rules. It is a key-value
+              # pairs where the values can be of any type (string, number, boolean, object,
+              # array, etc.).
+              metadata:
+            )
             end
 
             sig do
               override.returns(
-                {
-                  metadata:
-                    FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
-                }
+                { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
               )
             end
             def to_hash
             end
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata,
-                    FinchAPI::Internal::AnyHash
-                  )
-                end
-
-              # The metadata to be attached to the entity by existing rules. It is a key-value
-              # pairs where the values can be of any type (string, number, boolean, object,
-              # array, etc.).
-              sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
-              attr_accessor :metadata
-
-              sig do
-                params(
-                  metadata: T::Hash[Symbol, T.nilable(T.anything)]
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                # The metadata to be attached to the entity by existing rules. It is a key-value
-                # pairs where the values can be of any type (string, number, boolean, object,
-                # array, etc.).
-                metadata:
-              )
-              end
-
-              sig do
-                override.returns(
-                  { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
-                )
-              end
-              def to_hash
-              end
-            end
           end
         end
 
@@ -728,77 +638,32 @@ module FinchAPI
                 )
               end
 
-            sig do
-              returns(
-                FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
-              )
-            end
-            attr_reader :metadata
+            # The metadata to be attached to the entity by existing rules. It is a key-value
+            # pairs where the values can be of any type (string, number, boolean, object,
+            # array, etc.).
+            sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
+            attr_accessor :metadata
 
             sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata::OrHash
-              ).void
-            end
-            attr_writer :metadata
-
-            sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata::OrHash
-              ).returns(T.attached_class)
+              params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).returns(
+                T.attached_class
+              )
             end
-            def self.new(metadata:)
+            def self.new(
+              # The metadata to be attached to the entity by existing rules. It is a key-value
+              # pairs where the values can be of any type (string, number, boolean, object,
+              # array, etc.).
+              metadata:
+            )
             end
 
             sig do
               override.returns(
-                {
-                  metadata:
-                    FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
-                }
+                { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
               )
             end
             def to_hash
             end
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata,
-                    FinchAPI::Internal::AnyHash
-                  )
-                end
-
-              # The metadata to be attached to the entity by existing rules. It is a key-value
-              # pairs where the values can be of any type (string, number, boolean, object,
-              # array, etc.).
-              sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
-              attr_accessor :metadata
-
-              sig do
-                params(
-                  metadata: T::Hash[Symbol, T.nilable(T.anything)]
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                # The metadata to be attached to the entity by existing rules. It is a key-value
-                # pairs where the values can be of any type (string, number, boolean, object,
-                # array, etc.).
-                metadata:
-              )
-              end
-
-              sig do
-                override.returns(
-                  { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
-                )
-              end
-              def to_hash
-              end
-            end
           end
         end
 
@@ -980,75 +845,32 @@ module FinchAPI
                 )
               end
 
-            sig do
-              returns(FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata)
-            end
-            attr_reader :metadata
+            # The metadata to be attached to the entity by existing rules. It is a key-value
+            # pairs where the values can be of any type (string, number, boolean, object,
+            # array, etc.).
+            sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
+            attr_accessor :metadata
 
             sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata::OrHash
-              ).void
-            end
-            attr_writer :metadata
-
-            sig do
-              params(
-                metadata:
-                  FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata::OrHash
-              ).returns(T.attached_class)
+              params(metadata: T::Hash[Symbol, T.nilable(T.anything)]).returns(
+                T.attached_class
+              )
             end
-            def self.new(metadata:)
+            def self.new(
+              # The metadata to be attached to the entity by existing rules. It is a key-value
+              # pairs where the values can be of any type (string, number, boolean, object,
+              # array, etc.).
+              metadata:
+            )
             end
 
             sig do
               override.returns(
-                {
-                  metadata:
-                    FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
-                }
+                { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
               )
             end
             def to_hash
             end
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              OrHash =
-                T.type_alias do
-                  T.any(
-                    FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata,
-                    FinchAPI::Internal::AnyHash
-                  )
-                end
-
-              # The metadata to be attached to the entity by existing rules. It is a key-value
-              # pairs where the values can be of any type (string, number, boolean, object,
-              # array, etc.).
-              sig { returns(T::Hash[Symbol, T.nilable(T.anything)]) }
-              attr_accessor :metadata
-
-              sig do
-                params(
-                  metadata: T::Hash[Symbol, T.nilable(T.anything)]
-                ).returns(T.attached_class)
-              end
-              def self.new(
-                # The metadata to be attached to the entity by existing rules. It is a key-value
-                # pairs where the values can be of any type (string, number, boolean, object,
-                # array, etc.).
-                metadata:
-              )
-              end
-
-              sig do
-                override.returns(
-                  { metadata: T::Hash[Symbol, T.nilable(T.anything)] }
-                )
-              end
-              def to_hash
-              end
-            end
           end
         end
 

data/rbi/finch_api/models/introspection.rbi

@@ -95,6 +95,24 @@ module FinchAPI
       sig { returns(T.nilable(String)) }
       attr_accessor :customer_name
 
+      # Array of entity IDs associated with this connection.
+      sig { returns(T.nilable(T::Array[String])) }
+      attr_reader :entity_ids
+
+      sig { params(entity_ids: T::Array[String]).void }
+      attr_writer :entity_ids
+
+      # Indicates whether this connection manages a single entity or multiple entities.
+      sig do
+        returns(T.nilable(FinchAPI::Introspection::EntityMode::TaggedSymbol))
+      end
+      attr_reader :entity_mode
+
+      sig do
+        params(entity_mode: FinchAPI::Introspection::EntityMode::OrSymbol).void
+      end
+      attr_writer :entity_mode
+
       # Whether the connection associated with the `access_token` uses the Assisted
       # Connect Flow. (`true` if using Assisted Connect, `false` if connection is
       # automated)
@@ -133,6 +151,8 @@ module FinchAPI
           customer_email: T.nilable(String),
           customer_id: T.nilable(String),
           customer_name: T.nilable(String),
+          entity_ids: T::Array[String],
+          entity_mode: FinchAPI::Introspection::EntityMode::OrSymbol,
           manual: T::Boolean,
           payroll_provider_id: String,
           username: T.nilable(String)
@@ -173,6 +193,10 @@ module FinchAPI
         # The name of your customer you provided to Finch when a connect session was
         # created for this connection
         customer_name: nil,
+        # Array of entity IDs associated with this connection.
+        entity_ids: nil,
+        # Indicates whether this connection manages a single entity or multiple entities.
+        entity_mode: nil,
         # Whether the connection associated with the `access_token` uses the Assisted
         # Connect Flow. (`true` if using Assisted Connect, `false` if connection is
         # automated)
@@ -204,6 +228,8 @@ module FinchAPI
             customer_email: T.nilable(String),
             customer_id: T.nilable(String),
             customer_name: T.nilable(String),
+            entity_ids: T::Array[String],
+            entity_mode: FinchAPI::Introspection::EntityMode::TaggedSymbol,
             manual: T::Boolean,
             payroll_provider_id: String,
             username: T.nilable(String)
@@ -544,6 +570,27 @@ module FinchAPI
           end
         end
       end
+
+      # Indicates whether this connection manages a single entity or multiple entities.
+      module EntityMode
+        extend FinchAPI::Internal::Type::Enum
+
+        TaggedSymbol =
+          T.type_alias { T.all(Symbol, FinchAPI::Introspection::EntityMode) }
+        OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+        SINGLE =
+          T.let(:single, FinchAPI::Introspection::EntityMode::TaggedSymbol)
+        MULTI = T.let(:multi, FinchAPI::Introspection::EntityMode::TaggedSymbol)
+
+        sig do
+          override.returns(
+            T::Array[FinchAPI::Introspection::EntityMode::TaggedSymbol]
+          )
+        end
+        def self.values
+        end
+      end
     end
   end
 end

data/rbi/finch_api/resources/access_tokens.rbi

@@ -6,20 +6,20 @@ module FinchAPI
       # Exchange the authorization code for an access token
       sig do
         params(
+          code: String,
           client_id: String,
           client_secret: String,
-          code: String,
           redirect_uri: String,
           request_options: FinchAPI::RequestOptions::OrHash
         ).returns(FinchAPI::CreateAccessTokenResponse)
       end
       def create(
-        # The client ID for your application
-        client_id:,
-        # The client secret for your application
-        client_secret:,
         # The authorization code received from the authorization server
         code:,
+        # The client ID for your application
+        client_id: nil,
+        # The client secret for your application
+        client_secret: nil,
         # The redirect URI used in the authorization request (optional)
         redirect_uri: nil,
         request_options: {}

data/sig/finch_api/models/access_token_create_params.rbs

@@ -2,9 +2,9 @@ module FinchAPI
   module Models
     type access_token_create_params =
       {
+        code: String,
         client_id: String,
         client_secret: String,
-        code: String,
         redirect_uri: String
       }
       & FinchAPI::Internal::Type::request_parameters
@@ -13,28 +13,32 @@ module FinchAPI
       extend FinchAPI::Internal::Type::RequestParameters::Converter
       include FinchAPI::Internal::Type::RequestParameters
 
-      attr_accessor client_id: String
+      attr_accessor code: String
 
-      attr_accessor client_secret: String
+      attr_reader client_id: String?
 
-      attr_accessor code: String
+      def client_id=: (String) -> String
+
+      attr_reader client_secret: String?
+
+      def client_secret=: (String) -> String
 
       attr_reader redirect_uri: String?
 
       def redirect_uri=: (String) -> String
 
       def initialize: (
-        client_id: String,
-        client_secret: String,
         code: String,
+        ?client_id: String,
+        ?client_secret: String,
         ?redirect_uri: String,
         ?request_options: FinchAPI::request_opts
       ) -> void
 
       def to_hash: -> {
+        code: String,
         client_id: String,
         client_secret: String,
-        code: String,
         redirect_uri: String,
         request_options: FinchAPI::RequestOptions
       }

data/sig/finch_api/models/hris/pay_statement.rbs

@@ -138,31 +138,14 @@ module FinchAPI
             def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Earning::type_]
           end
 
-          type attributes =
-            {
-              metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
-            }
+          type attributes = { metadata: ::Hash[Symbol, top?] }
 
           class Attributes < FinchAPI::Internal::Type::BaseModel
-            attr_accessor metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
+            attr_accessor metadata: ::Hash[Symbol, top?]
 
-            def initialize: (
-              metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
-            ) -> void
+            def initialize: (metadata: ::Hash[Symbol, top?]) -> void
 
-            def to_hash: -> {
-              metadata: FinchAPI::HRIS::PayStatement::Earning::Attributes::Metadata
-            }
-
-            type metadata = { metadata: ::Hash[Symbol, top?] }
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              attr_accessor metadata: ::Hash[Symbol, top?]
-
-              def initialize: (metadata: ::Hash[Symbol, top?]) -> void
-
-              def to_hash: -> { metadata: ::Hash[Symbol, top?] }
-            end
+            def to_hash: -> { metadata: ::Hash[Symbol, top?] }
           end
         end
 
@@ -207,31 +190,14 @@ module FinchAPI
             attributes: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes?
           }
 
-          type attributes =
-            {
-              metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
-            }
+          type attributes = { metadata: ::Hash[Symbol, top?] }
 
           class Attributes < FinchAPI::Internal::Type::BaseModel
-            attr_accessor metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
-
-            def initialize: (
-              metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
-            ) -> void
-
-            def to_hash: -> {
-              metadata: FinchAPI::HRIS::PayStatement::EmployeeDeduction::Attributes::Metadata
-            }
-
-            type metadata = { metadata: ::Hash[Symbol, top?] }
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              attr_accessor metadata: ::Hash[Symbol, top?]
+            attr_accessor metadata: ::Hash[Symbol, top?]
 
-              def initialize: (metadata: ::Hash[Symbol, top?]) -> void
+            def initialize: (metadata: ::Hash[Symbol, top?]) -> void
 
-              def to_hash: -> { metadata: ::Hash[Symbol, top?] }
-            end
+            def to_hash: -> { metadata: ::Hash[Symbol, top?] }
           end
         end
 
@@ -271,31 +237,14 @@ module FinchAPI
             attributes: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes?
           }
 
-          type attributes =
-            {
-              metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
-            }
+          type attributes = { metadata: ::Hash[Symbol, top?] }
 
           class Attributes < FinchAPI::Internal::Type::BaseModel
-            attr_accessor metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
+            attr_accessor metadata: ::Hash[Symbol, top?]
 
-            def initialize: (
-              metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
-            ) -> void
+            def initialize: (metadata: ::Hash[Symbol, top?]) -> void
 
-            def to_hash: -> {
-              metadata: FinchAPI::HRIS::PayStatement::EmployerContribution::Attributes::Metadata
-            }
-
-            type metadata = { metadata: ::Hash[Symbol, top?] }
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              attr_accessor metadata: ::Hash[Symbol, top?]
-
-              def initialize: (metadata: ::Hash[Symbol, top?]) -> void
-
-              def to_hash: -> { metadata: ::Hash[Symbol, top?] }
-            end
+            def to_hash: -> { metadata: ::Hash[Symbol, top?] }
           end
         end
 
@@ -365,31 +314,14 @@ module FinchAPI
             def self?.values: -> ::Array[FinchAPI::Models::HRIS::PayStatement::Tax::type_]
           end
 
-          type attributes =
-            {
-              metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
-            }
+          type attributes = { metadata: ::Hash[Symbol, top?] }
 
           class Attributes < FinchAPI::Internal::Type::BaseModel
-            attr_accessor metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
-
-            def initialize: (
-              metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
-            ) -> void
-
-            def to_hash: -> {
-              metadata: FinchAPI::HRIS::PayStatement::Tax::Attributes::Metadata
-            }
-
-            type metadata = { metadata: ::Hash[Symbol, top?] }
-
-            class Metadata < FinchAPI::Internal::Type::BaseModel
-              attr_accessor metadata: ::Hash[Symbol, top?]
+            attr_accessor metadata: ::Hash[Symbol, top?]
 
-              def initialize: (metadata: ::Hash[Symbol, top?]) -> void
+            def initialize: (metadata: ::Hash[Symbol, top?]) -> void
 
-              def to_hash: -> { metadata: ::Hash[Symbol, top?] }
-            end
+            def to_hash: -> { metadata: ::Hash[Symbol, top?] }
           end
         end
 

data/sig/finch_api/models/introspection.rbs

@@ -16,6 +16,8 @@ module FinchAPI
         customer_email: String?,
         customer_id: String?,
         customer_name: String?,
+        entity_ids: ::Array[String],
+        entity_mode: FinchAPI::Models::Introspection::entity_mode,
         manual: bool,
         payroll_provider_id: String,
         username: String?
@@ -58,6 +60,16 @@ module FinchAPI
 
       attr_accessor customer_name: String?
 
+      attr_reader entity_ids: ::Array[String]?
+
+      def entity_ids=: (::Array[String]) -> ::Array[String]
+
+      attr_reader entity_mode: FinchAPI::Models::Introspection::entity_mode?
+
+      def entity_mode=: (
+        FinchAPI::Models::Introspection::entity_mode
+      ) -> FinchAPI::Models::Introspection::entity_mode
+
       attr_reader manual: bool?
 
       def manual=: (bool) -> bool
@@ -83,6 +95,8 @@ module FinchAPI
         ?customer_email: String?,
         ?customer_id: String?,
         ?customer_name: String?,
+        ?entity_ids: ::Array[String],
+        ?entity_mode: FinchAPI::Models::Introspection::entity_mode,
         ?manual: bool,
         ?payroll_provider_id: String,
         ?username: String?
@@ -103,6 +117,8 @@ module FinchAPI
         customer_email: String?,
         customer_id: String?,
         customer_name: String?,
+        entity_ids: ::Array[String],
+        entity_mode: FinchAPI::Models::Introspection::entity_mode,
         manual: bool,
         payroll_provider_id: String,
         username: String?
@@ -252,6 +268,17 @@ module FinchAPI
           end
         end
       end
+
+      type entity_mode = :single | :multi
+
+      module EntityMode
+        extend FinchAPI::Internal::Type::Enum
+
+        SINGLE: :single
+        MULTI: :multi
+
+        def self?.values: -> ::Array[FinchAPI::Models::Introspection::entity_mode]
+      end
     end
   end
 end

data/sig/finch_api/resources/access_tokens.rbs

@@ -2,9 +2,9 @@ module FinchAPI
   module Resources
     class AccessTokens
       def create: (
-        client_id: String,
-        client_secret: String,
         code: String,
+        ?client_id: String,
+        ?client_secret: String,
         ?redirect_uri: String,
         ?request_options: FinchAPI::request_opts
       ) -> FinchAPI::CreateAccessTokenResponse

metadata

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