finch-api 0.1.0.pre.alpha.39 → 0.1.0.pre.alpha.41

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0111f0539076aa0b796deb95cd2735264cde7205b9128ef2ab38c14451bab976
-  data.tar.gz: 38b82f3652758882b70bc01aef5f370d3c0dbbdd0f1b60e8ad3b47a0ab7568f0
+  metadata.gz: f0c2c976c70cb05a8a51e10cc2dd857fe65096c2547a525d0322d728d6b9c273
+  data.tar.gz: 25b6ecd53cfa6fbab429c14406bbe99d4b29cf261123db10253d66c6b9d56004
 SHA512:
-  metadata.gz: 30086bac7adbb05f5cddb9c0d8ed2c64ef68845ce83748e176fbff16c31c5d7e27df60682cfeeb3cbebb556f61206c60581ac15cdb1cd7068325ba707365e47d
-  data.tar.gz: 758c7e5addb846651c1ee651b64f38dac9ca141714dc61f26bd710e06ba119fb83bd415e2e4ffa94d4337ba8d9f61c633b8f5aa3935ae14941bbb00d0eb6822b
+  metadata.gz: 0676202b2ce5c5e50799b4b507b92a27fc63ba723ac05e56363621082032992c1f2bf3a9f74d27c860120141eb8e2df3904d37a3acf8f17f8fc55cfafb36fc4f
+  data.tar.gz: acaa49d18fc5567cd1d04cb8f34b80d62570f08d9c0cd4bc69230736249f2b5c138191e5b5f82e79875ae225175265a502a479604d341b40ae7657d675c4174e

data/CHANGELOG.md

@@ -1,5 +1,37 @@
 # Changelog
 
+## 0.1.0-alpha.41 (2026-01-13)
+
+Full Changelog: [v0.1.0-alpha.40...v0.1.0-alpha.41](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.40...v0.1.0-alpha.41)
+
+### Features
+
+* **api:** api update ([c7cf406](https://github.com/Finch-API/finch-api-ruby/commit/c7cf4068b9cff10eb1b8c34ee507375a31bcc412))
+
+
+### Chores
+
+* fix typo in descriptions ([6ea1ae9](https://github.com/Finch-API/finch-api-ruby/commit/6ea1ae93b192ad7ec8a54e9881665decc46a716b))
+* move `cgi` into dependencies for ruby 4 ([05f9567](https://github.com/Finch-API/finch-api-ruby/commit/05f95676c9102c184d4d157c055f4387f42dc66b))
+
+## 0.1.0-alpha.40 (2026-01-05)
+
+Full Changelog: [v0.1.0-alpha.39...v0.1.0-alpha.40](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.39...v0.1.0-alpha.40)
+
+### Features
+
+* **api:** api update ([82c2483](https://github.com/Finch-API/finch-api-ruby/commit/82c2483e09e0facae50bc1fc3601b922ae86a5a5))
+
+
+### Chores
+
+* **internal:** codegen related update ([74a742a](https://github.com/Finch-API/finch-api-ruby/commit/74a742a5f1c7673a9f8fb06b5daaac5daf204fd5))
+
+
+### Documentation
+
+* prominently feature MCP server setup in root SDK readmes ([6d995c9](https://github.com/Finch-API/finch-api-ruby/commit/6d995c9789915687a71b11c33b1b5b8ccc9ffa48))
+
 ## 0.1.0-alpha.39 (2025-12-19)
 
 Full Changelog: [v0.1.0-alpha.38...v0.1.0-alpha.39](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.38...v0.1.0-alpha.39)

data/README.md

@@ -4,6 +4,15 @@ The Finch Ruby library provides convenient access to the Finch REST API from any
 
 It is generated with [Stainless](https://www.stainless.com/).
 
+## MCP Server
+
+Use the Finch MCP Server to enable AI assistants to interact with this API, allowing them to explore endpoints, make test requests, and use documentation to help integrate this SDK into your application.
+
+[![Add to Cursor](https://cursor.com/deeplink/mcp-install-dark.svg)](https://cursor.com/en-US/install-mcp?name=%40tryfinch%2Ffinch-api-mcp&config=eyJjb21tYW5kIjoibnB4IiwiYXJncyI6WyIteSIsIkB0cnlmaW5jaC9maW5jaC1hcGktbWNwIl19)
+[![Install in VS Code](https://img.shields.io/badge/_-Add_to_VS_Code-blue?style=for-the-badge&logo=data:image/svg%2bxml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIGZpbGw9Im5vbmUiIHZpZXdCb3g9IjAgMCA0MCA0MCI+PHBhdGggZmlsbD0iI0VFRSIgZmlsbC1ydWxlPSJldmVub2RkIiBkPSJNMzAuMjM1IDM5Ljg4NGEyLjQ5MSAyLjQ5MSAwIDAgMS0xLjc4MS0uNzNMMTIuNyAyNC43OGwtMy40NiAyLjYyNC0zLjQwNiAyLjU4MmExLjY2NSAxLjY2NSAwIDAgMS0xLjA4Mi4zMzggMS42NjQgMS42NjQgMCAwIDEtMS4wNDYtLjQzMWwtMi4yLTJhMS42NjYgMS42NjYgMCAwIDEgMC0yLjQ2M0w3LjQ1OCAyMCA0LjY3IDE3LjQ1MyAxLjUwNyAxNC41N2ExLjY2NSAxLjY2NSAwIDAgMSAwLTIuNDYzbDIuMi0yYTEuNjY1IDEuNjY1IDAgMCAxIDIuMTMtLjA5N2w2Ljg2MyA1LjIwOUwyOC40NTIuODQ0YTIuNDg4IDIuNDg4IDAgMCAxIDEuODQxLS43MjljLjM1MS4wMDkuNjk5LjA5MSAxLjAxOS4yNDVsOC4yMzYgMy45NjFhMi41IDIuNSAwIDAgMSAxLjQxNSAyLjI1M3YuMDk5LS4wNDVWMzMuMzd2LS4wNDUuMDk1YTIuNTAxIDIuNTAxIDAgMCAxLTEuNDE2IDIuMjU3bC04LjIzNSAzLjk2MWEyLjQ5MiAyLjQ5MiAwIDAgMS0xLjA3Ny4yNDZabS43MTYtMjguOTQ3LTExLjk0OCA5LjA2MiAxMS45NTIgOS4wNjUtLjAwNC0xOC4xMjdaIi8+PC9zdmc+)](https://vscode.stainless.com/mcp/%7B%22name%22%3A%22%40tryfinch%2Ffinch-api-mcp%22%2C%22command%22%3A%22npx%22%2C%22args%22%3A%5B%22-y%22%2C%22%40tryfinch%2Ffinch-api-mcp%22%5D%7D)
+
+> Note: You may need to set environment variables in your MCP client.
+
 ## Documentation
 
 Documentation for releases of this gem can be found [on RubyDoc](https://gemdocs.org/gems/finch-api).
@@ -17,7 +26,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.39"
+gem "finch-api", "~> 0.1.0.pre.alpha.41"
 ```
 
 <!-- x-release-please-end -->

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

@@ -36,8 +36,7 @@ module FinchAPI
           required :employment, -> { FinchAPI::HRIS::EmploymentData::UnionMember0::Employment }, nil?: true
 
           # @!attribute employment_status
-          #   The detailed employment status of the individual. Available options: `active`,
-          #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          #   The detailed employment status of the individual.
           #
           #   @return [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil]
           required :employment_status,
@@ -154,7 +153,7 @@ module FinchAPI
           #
           #   @param employment [FinchAPI::Models::HRIS::EmploymentData::UnionMember0::Employment, nil] The employment object.
           #
-          #   @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
+          #   @param employment_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::UnionMember0::EmploymentStatus, nil] The detailed employment status of the individual.
           #
           #   @param end_date [String, nil]
           #
@@ -264,8 +263,7 @@ module FinchAPI
             end
           end
 
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           #
           # @see FinchAPI::Models::HRIS::EmploymentData::UnionMember0#employment_status
           module EmploymentStatus

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

@@ -10,14 +10,14 @@ module FinchAPI
 
         # @!attribute end_date
         #   The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-        #   format.
+        #   format. Filters payments by their **pay_date** field.
         #
         #   @return [Date]
         required :end_date, Date
 
         # @!attribute start_date
         #   The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-        #   format.
+        #   format. Filters payments by their **pay_date** field.
         #
         #   @return [Date]
         required :start_date, Date

data/lib/finch_api/models/sandbox/connection_create_response.rb

@@ -38,6 +38,12 @@ module FinchAPI
         #   @return [String]
         required :connection_id, String
 
+        # @!attribute entity_id
+        #   The ID of the entity for this connection
+        #
+        #   @return [String]
+        required :entity_id, String
+
         # @!attribute products
         #
         #   @return [Array<String>]
@@ -54,7 +60,7 @@ module FinchAPI
         #   @return [String, nil]
         optional :token_type, String
 
-        # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:, token_type: nil)
+        # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:, token_type: nil)
         #   @param access_token [String]
         #
         #   @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
@@ -65,6 +71,8 @@ module FinchAPI
         #
         #   @param connection_id [String] The ID of the new connection
         #
+        #   @param entity_id [String] The ID of the entity for this connection
+        #
         #   @param products [Array<String>]
         #
         #   @param provider_id [String] The ID of the provider associated with the `access_token`.

data/lib/finch_api/models/sandbox/connections/account_create_response.rb

@@ -39,6 +39,12 @@ module FinchAPI
           #   @return [String]
           required :connection_id, String
 
+          # @!attribute entity_id
+          #   The ID of the entity for this connection
+          #
+          #   @return [String]
+          required :entity_id, String
+
           # @!attribute products
           #
           #   @return [Array<String>]
@@ -50,7 +56,7 @@ module FinchAPI
           #   @return [String]
           required :provider_id, String
 
-          # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, products:, provider_id:)
+          # @!method initialize(access_token:, account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:)
           #   @param access_token [String]
           #
           #   @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
@@ -61,6 +67,8 @@ module FinchAPI
           #
           #   @param connection_id [String] The ID of the new connection
           #
+          #   @param entity_id [String] The ID of the entity for this connection
+          #
           #   @param products [Array<String>]
           #
           #   @param provider_id [String] The ID of the provider associated with the `access_token`

data/lib/finch_api/models/sandbox/connections/account_update_response.rb

@@ -28,6 +28,18 @@ module FinchAPI
           #   @return [String]
           required :company_id, String
 
+          # @!attribute connection_id
+          #   The ID of the new connection
+          #
+          #   @return [String]
+          required :connection_id, String
+
+          # @!attribute entity_id
+          #   The ID of the entity whose status was updated
+          #
+          #   @return [String]
+          required :entity_id, String
+
           # @!attribute products
           #
           #   @return [Array<String>]
@@ -39,24 +51,20 @@ module FinchAPI
           #   @return [String]
           required :provider_id, String
 
-          # @!attribute connection_id
-          #   The ID of the new connection
-          #
-          #   @return [String, nil]
-          optional :connection_id, String
-
-          # @!method initialize(account_id:, authentication_type:, company_id:, products:, provider_id:, connection_id: nil)
+          # @!method initialize(account_id:, authentication_type:, company_id:, connection_id:, entity_id:, products:, provider_id:)
           #   @param account_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
           #
           #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType]
           #
           #   @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
           #
+          #   @param connection_id [String] The ID of the new connection
+          #
+          #   @param entity_id [String] The ID of the entity whose status was updated
+          #
           #   @param products [Array<String>]
           #
           #   @param provider_id [String] The ID of the provider associated with the `access_token`
-          #
-          #   @param connection_id [String] The ID of the new connection
 
           # @see FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse#authentication_type
           module AuthenticationType

data/lib/finch_api/models/sandbox/directory_create_params.rb

@@ -69,8 +69,7 @@ module FinchAPI
           optional :employment, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Employment }, nil?: true
 
           # @!attribute employment_status
-          #   The detailed employment status of the individual. Available options: `active`,
-          #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          #   The detailed employment status of the individual.
           #
           #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil]
           optional :employment_status,
@@ -225,7 +224,7 @@ module FinchAPI
           #
           #   @param employment [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Employment, nil] The employment object.
           #
-          #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
+          #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::EmploymentStatus, nil] The detailed employment status of the individual.
           #
           #   @param encrypted_ssn [String, nil] Social Security Number of the individual in **encrypted** format. This field is
           #
@@ -392,8 +391,7 @@ module FinchAPI
             end
           end
 
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           #
           # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#employment_status
           module EmploymentStatus

data/lib/finch_api/models/sandbox/employment_update_params.rb

@@ -39,8 +39,7 @@ module FinchAPI
         optional :employment, -> { FinchAPI::Sandbox::EmploymentUpdateParams::Employment }, nil?: true
 
         # @!attribute employment_status
-        #   The detailed employment status of the individual. Available options: `active`,
-        #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        #   The detailed employment status of the individual.
         #
         #   @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil]
         optional :employment_status,
@@ -137,7 +136,7 @@ module FinchAPI
         #
         #   @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
         #
-        #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
+        #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
         #
         #   @param end_date [String, nil]
         #
@@ -257,8 +256,7 @@ module FinchAPI
           end
         end
 
-        # The detailed employment status of the individual. Available options: `active`,
-        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        # The detailed employment status of the individual.
         module EmploymentStatus
           extend FinchAPI::Internal::Type::Enum
 

data/lib/finch_api/models/sandbox/employment_update_response.rb

@@ -40,8 +40,7 @@ module FinchAPI
         optional :employment, -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment }, nil?: true
 
         # @!attribute employment_status
-        #   The detailed employment status of the individual. Available options: `active`,
-        #   `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        #   The detailed employment status of the individual.
         #
         #   @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil]
         optional :employment_status,
@@ -140,7 +139,7 @@ module FinchAPI
         #
         #   @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateResponse::Employment, nil] The employment object.
         #
-        #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
+        #   @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::EmploymentStatus, nil] The detailed employment status of the individual.
         #
         #   @param end_date [String, nil]
         #
@@ -260,8 +259,7 @@ module FinchAPI
           end
         end
 
-        # The detailed employment status of the individual. Available options: `active`,
-        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        # The detailed employment status of the individual.
         #
         # @see FinchAPI::Models::Sandbox::EmploymentUpdateResponse#employment_status
         module EmploymentStatus

data/lib/finch_api/resources/hris/benefits/individuals.rb

@@ -12,7 +12,7 @@ module FinchAPI
           #
           # @overload enroll_many(benefit_id, entity_ids: nil, individuals: nil, request_options: {})
           #
-          # @param benefit_id [String] Path param:
+          # @param benefit_id [String] Path param
           #
           # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
           #
@@ -94,7 +94,7 @@ module FinchAPI
           #
           # @overload unenroll_many(benefit_id, entity_ids: nil, individual_ids: nil, request_options: {})
           #
-          # @param benefit_id [String] Path param:
+          # @param benefit_id [String] Path param
           #
           # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
           #

data/lib/finch_api/resources/hris/benefits.rb

@@ -71,7 +71,7 @@ module FinchAPI
         #
         # @overload update(benefit_id, entity_ids: nil, description: nil, request_options: {})
         #
-        # @param benefit_id [String] Path param:
+        # @param benefit_id [String] Path param
         #
         # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
         #

data/lib/finch_api/resources/hris/company/pay_statement_item/rules.rb

@@ -10,12 +10,10 @@ module FinchAPI
             # {FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams} for more
             # details.
             #
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon Custom rules can be created to associate
-            # specific attributes to pay statement items depending on the use case. For
-            # example, pay statement items that meet certain conditions can be labeled as a
-            # pre-tax 401k. This metadata can be retrieved where pay statement item
-            # information is available.
+            # Custom rules can be created to associate specific attributes to pay statement
+            # items depending on the use case. For example, pay statement items that meet
+            # certain conditions can be labeled as a pre-tax 401k. This metadata can be
+            # retrieved where pay statement item information is available.
             #
             # @overload create(entity_ids: nil, attributes: nil, conditions: nil, effective_end_date: nil, effective_start_date: nil, entity_type: nil, request_options: {})
             #
@@ -23,7 +21,7 @@ module FinchAPI
             #
             # @param attributes [FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Attributes] Body param: Specifies the fields to be applied when the condition is met.
             #
-            # @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>] Body param:
+            # @param conditions [Array<FinchAPI::Models::HRIS::Company::PayStatementItem::RuleCreateParams::Condition>] Body param
             #
             # @param effective_end_date [String, nil] Body param: Specifies when the rules should stop applying rules based on the dat
             #
@@ -49,16 +47,15 @@ module FinchAPI
               )
             end
 
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon Update a rule for a pay statement item.
+            # Update a rule for a pay statement item.
             #
             # @overload update(rule_id, entity_ids: nil, optional_property: nil, request_options: {})
             #
-            # @param rule_id [String] Path param:
+            # @param rule_id [String] Path param
             #
             # @param entity_ids [Array<String>] Query param: The entity IDs to update the rule for.
             #
-            # @param optional_property [Object] Body param:
+            # @param optional_property [Object] Body param
             #
             # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
             #
@@ -78,8 +75,7 @@ module FinchAPI
               )
             end
 
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon List all rules of a connection account.
+            # List all rules of a connection account.
             #
             # @overload list(entity_ids: nil, request_options: {})
             #
@@ -102,8 +98,7 @@ module FinchAPI
               )
             end
 
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon Delete a rule for a pay statement item.
+            # Delete a rule for a pay statement item.
             #
             # @overload delete(rule_id, entity_ids: nil, request_options: {})
             #

data/lib/finch_api/resources/hris/company/pay_statement_item.rb

@@ -11,9 +11,8 @@ module FinchAPI
           # Some parameter documentations has been truncated, see
           # {FinchAPI::Models::HRIS::Company::PayStatementItemListParams} for more details.
           #
-          # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-          # historical support will be added soon Retrieve a list of detailed pay statement
-          # items for the access token's connection account.
+          # Retrieve a list of detailed pay statement items for the access token's
+          # connection account.
           #
           # @overload list(categories: nil, end_date: nil, entity_ids: nil, name: nil, start_date: nil, type: nil, request_options: {})
           #

data/lib/finch_api/resources/hris/individuals.rb

@@ -10,9 +10,9 @@ module FinchAPI
         #
         # @param entity_ids [Array<String>] Query param: The entity IDs to specify which entities' data to access.
         #
-        # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param:
+        # @param options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil] Body param
         #
-        # @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] Body param:
+        # @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] Body param
         #
         # @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}, nil]
         #

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

@@ -4,8 +4,8 @@ module FinchAPI
   module Resources
     class Jobs
       class Manual
-        # Get a manual job by `job_id`. Manual jobs are completed by a human and include
-        # Assisted Benefits jobs.
+        # Check the status and outcome of a job by `job_id`. This includes all deductions
+        # jobs including those for both automated and assisted integrations.
         #
         # @overload retrieve(job_id, request_options: {})
         #

data/lib/finch_api/resources/sandbox/employment.rb

@@ -21,7 +21,7 @@ module FinchAPI
         #
         # @param employment [FinchAPI::Models::Sandbox::EmploymentUpdateParams::Employment, nil] The employment object.
         #
-        # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual. Available options: `active`, `
+        # @param employment_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::EmploymentStatus, nil] The detailed employment status of the individual.
         #
         # @param end_date [String, nil]
         #

data/lib/finch_api/version.rb

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

data/rbi/finch_api/models/hris/employment_data.rbi

@@ -71,8 +71,7 @@ module FinchAPI
           end
           attr_writer :employment
 
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           sig do
             returns(
               T.nilable(
@@ -221,8 +220,7 @@ module FinchAPI
             department:,
             # The employment object.
             employment:,
-            # The detailed employment status of the individual. Available options: `active`,
-            # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+            # The detailed employment status of the individual.
             employment_status:,
             end_date:,
             # The legal first name of the individual.
@@ -491,8 +489,7 @@ module FinchAPI
             end
           end
 
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           module EmploymentStatus
             extend FinchAPI::Internal::Type::Enum
 

data/rbi/finch_api/models/hris/payment_list_params.rbi

@@ -16,12 +16,12 @@ module FinchAPI
           end
 
         # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-        # format.
+        # format. Filters payments by their **pay_date** field.
         sig { returns(Date) }
         attr_accessor :end_date
 
         # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-        # format.
+        # format. Filters payments by their **pay_date** field.
         sig { returns(Date) }
         attr_accessor :start_date
 
@@ -42,10 +42,10 @@ module FinchAPI
         end
         def self.new(
           # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-          # format.
+          # format. Filters payments by their **pay_date** field.
           end_date:,
           # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-          # format.
+          # format. Filters payments by their **pay_date** field.
           start_date:,
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,

data/rbi/finch_api/models/sandbox/connection_create_response.rbi

@@ -34,6 +34,10 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :connection_id
 
+        # The ID of the entity for this connection
+        sig { returns(String) }
+        attr_accessor :entity_id
+
         sig { returns(T::Array[String]) }
         attr_accessor :products
 
@@ -55,6 +59,7 @@ module FinchAPI
               FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::OrSymbol,
             company_id: String,
             connection_id: String,
+            entity_id: String,
             products: T::Array[String],
             provider_id: String,
             token_type: String
@@ -69,6 +74,8 @@ module FinchAPI
           company_id:,
           # The ID of the new connection
           connection_id:,
+          # The ID of the entity for this connection
+          entity_id:,
           products:,
           # The ID of the provider associated with the `access_token`.
           provider_id:,
@@ -85,6 +92,7 @@ module FinchAPI
                 FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType::TaggedSymbol,
               company_id: String,
               connection_id: String,
+              entity_id: String,
               products: T::Array[String],
               provider_id: String,
               token_type: String

data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi

@@ -35,6 +35,10 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :connection_id
 
+          # The ID of the entity for this connection
+          sig { returns(String) }
+          attr_accessor :entity_id
+
           sig { returns(T::Array[String]) }
           attr_accessor :products
 
@@ -50,6 +54,7 @@ module FinchAPI
                 FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::OrSymbol,
               company_id: String,
               connection_id: String,
+              entity_id: String,
               products: T::Array[String],
               provider_id: String
             ).returns(T.attached_class)
@@ -63,6 +68,8 @@ module FinchAPI
             company_id:,
             # The ID of the new connection
             connection_id:,
+            # The ID of the entity for this connection
+            entity_id:,
             products:,
             # The ID of the provider associated with the `access_token`
             provider_id:
@@ -78,6 +85,7 @@ module FinchAPI
                   FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType::TaggedSymbol,
                 company_id: String,
                 connection_id: String,
+                entity_id: String,
                 products: T::Array[String],
                 provider_id: String
               }

data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi

@@ -28,6 +28,14 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :company_id
 
+          # The ID of the new connection
+          sig { returns(String) }
+          attr_accessor :connection_id
+
+          # The ID of the entity whose status was updated
+          sig { returns(String) }
+          attr_accessor :entity_id
+
           sig { returns(T::Array[String]) }
           attr_accessor :products
 
@@ -35,22 +43,16 @@ module FinchAPI
           sig { returns(String) }
           attr_accessor :provider_id
 
-          # The ID of the new connection
-          sig { returns(T.nilable(String)) }
-          attr_reader :connection_id
-
-          sig { params(connection_id: String).void }
-          attr_writer :connection_id
-
           sig do
             params(
               account_id: String,
               authentication_type:
                 FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::OrSymbol,
               company_id: String,
+              connection_id: String,
+              entity_id: String,
               products: T::Array[String],
-              provider_id: String,
-              connection_id: String
+              provider_id: String
             ).returns(T.attached_class)
           end
           def self.new(
@@ -59,11 +61,13 @@ module FinchAPI
             authentication_type:,
             # [DEPRECATED] Use `connection_id` to associate a connection with an access token
             company_id:,
+            # The ID of the new connection
+            connection_id:,
+            # The ID of the entity whose status was updated
+            entity_id:,
             products:,
             # The ID of the provider associated with the `access_token`
-            provider_id:,
-            # The ID of the new connection
-            connection_id: nil
+            provider_id:
           )
           end
 
@@ -74,9 +78,10 @@ module FinchAPI
                 authentication_type:
                   FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType::TaggedSymbol,
                 company_id: String,
+                connection_id: String,
+                entity_id: String,
                 products: T::Array[String],
-                provider_id: String,
-                connection_id: String
+                provider_id: String
               }
             )
           end

data/rbi/finch_api/models/sandbox/directory_create_params.rbi

@@ -137,8 +137,7 @@ module FinchAPI
           end
           attr_writer :employment
 
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           sig do
             returns(
               T.nilable(
@@ -354,8 +353,7 @@ module FinchAPI
             emails: nil,
             # The employment object.
             employment: nil,
-            # The detailed employment status of the individual. Available options: `active`,
-            # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+            # The detailed employment status of the individual.
             employment_status: nil,
             # Social Security Number of the individual in **encrypted** format. This field is
             # only available with the `ssn` scope enabled and the
@@ -778,8 +776,7 @@ module FinchAPI
             end
           end
 
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           module EmploymentStatus
             extend FinchAPI::Internal::Type::Enum
 

data/rbi/finch_api/models/sandbox/employment_update_params.rbi

@@ -67,8 +67,7 @@ module FinchAPI
         end
         attr_writer :employment
 
-        # The detailed employment status of the individual. Available options: `active`,
-        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        # The detailed employment status of the individual.
         sig do
           returns(
             T.nilable(
@@ -198,8 +197,7 @@ module FinchAPI
           department: nil,
           # The employment object.
           employment: nil,
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           employment_status: nil,
           end_date: nil,
           # The legal first name of the individual.
@@ -492,8 +490,7 @@ module FinchAPI
           end
         end
 
-        # The detailed employment status of the individual. Available options: `active`,
-        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        # The detailed employment status of the individual.
         module EmploymentStatus
           extend FinchAPI::Internal::Type::Enum
 

data/rbi/finch_api/models/sandbox/employment_update_response.rbi

@@ -77,8 +77,7 @@ module FinchAPI
         end
         attr_writer :employment
 
-        # The detailed employment status of the individual. Available options: `active`,
-        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        # The detailed employment status of the individual.
         sig do
           returns(
             T.nilable(
@@ -214,8 +213,7 @@ module FinchAPI
           department: nil,
           # The employment object.
           employment: nil,
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           employment_status: nil,
           end_date: nil,
           # The legal first name of the individual.
@@ -509,8 +507,7 @@ module FinchAPI
           end
         end
 
-        # The detailed employment status of the individual. Available options: `active`,
-        # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+        # The detailed employment status of the individual.
         module EmploymentStatus
           extend FinchAPI::Internal::Type::Enum
 

data/rbi/finch_api/resources/hris/benefits/individuals.rbi

@@ -23,7 +23,7 @@ module FinchAPI
             )
           end
           def enroll_many(
-            # Path param:
+            # Path param
             benefit_id,
             # Query param: The entity IDs to specify which entities' data to access.
             entity_ids: nil,
@@ -87,7 +87,7 @@ module FinchAPI
             )
           end
           def unenroll_many(
-            # Path param:
+            # Path param
             benefit_id,
             # Query param: The entity IDs to specify which entities' data to access.
             entity_ids: nil,

data/rbi/finch_api/resources/hris/benefits.rbi

@@ -65,7 +65,7 @@ module FinchAPI
           ).returns(FinchAPI::HRIS::UpdateCompanyBenefitResponse)
         end
         def update(
-          # Path param:
+          # Path param
           benefit_id,
           # Query param: The entity IDs to specify which entities' data to access.
           entity_ids: nil,

data/rbi/finch_api/resources/hris/company/pay_statement_item/rules.rbi

@@ -6,12 +6,10 @@ module FinchAPI
       class Company
         class PayStatementItem
           class Rules
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon Custom rules can be created to associate
-            # specific attributes to pay statement items depending on the use case. For
-            # example, pay statement items that meet certain conditions can be labeled as a
-            # pre-tax 401k. This metadata can be retrieved where pay statement item
-            # information is available.
+            # Custom rules can be created to associate specific attributes to pay statement
+            # items depending on the use case. For example, pay statement items that meet
+            # certain conditions can be labeled as a pre-tax 401k. This metadata can be
+            # retrieved where pay statement item information is available.
             sig do
               params(
                 entity_ids: T::Array[String],
@@ -35,7 +33,7 @@ module FinchAPI
               entity_ids: nil,
               # Body param: Specifies the fields to be applied when the condition is met.
               attributes: nil,
-              # Body param:
+              # Body param
               conditions: nil,
               # Body param: Specifies when the rules should stop applying rules based on the
               # date.
@@ -48,8 +46,7 @@ module FinchAPI
             )
             end
 
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon Update a rule for a pay statement item.
+            # Update a rule for a pay statement item.
             sig do
               params(
                 rule_id: String,
@@ -61,18 +58,17 @@ module FinchAPI
               )
             end
             def update(
-              # Path param:
+              # Path param
               rule_id,
               # Query param: The entity IDs to update the rule for.
               entity_ids: nil,
-              # Body param:
+              # Body param
               optional_property: nil,
               request_options: {}
             )
             end
 
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon List all rules of a connection account.
+            # List all rules of a connection account.
             sig do
               params(
                 entity_ids: T::Array[String],
@@ -90,8 +86,7 @@ module FinchAPI
             )
             end
 
-            # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-            # historical support will be added soon Delete a rule for a pay statement item.
+            # Delete a rule for a pay statement item.
             sig do
               params(
                 rule_id: String,

data/rbi/finch_api/resources/hris/company/pay_statement_item.rbi

@@ -10,9 +10,8 @@ module FinchAPI
           end
           attr_reader :rules
 
-          # **Beta:** this endpoint currently serves employers onboarded after March 4th and
-          # historical support will be added soon Retrieve a list of detailed pay statement
-          # items for the access token's connection account.
+          # Retrieve a list of detailed pay statement items for the access token's
+          # connection account.
           sig do
             params(
               categories:

data/rbi/finch_api/resources/hris/individuals.rbi

@@ -26,9 +26,9 @@ module FinchAPI
         def retrieve_many(
           # Query param: The entity IDs to specify which entities' data to access.
           entity_ids: nil,
-          # Body param:
+          # Body param
           options: nil,
-          # Body param:
+          # Body param
           requests: nil,
           request_options: {}
         )

data/rbi/finch_api/resources/hris/payments.rbi

@@ -15,10 +15,10 @@ module FinchAPI
         end
         def list(
           # The end date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-          # format.
+          # format. Filters payments by their **pay_date** field.
           end_date:,
           # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
-          # format.
+          # format. Filters payments by their **pay_date** field.
           start_date:,
           # The entity IDs to specify which entities' data to access.
           entity_ids: nil,

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

@@ -4,8 +4,8 @@ module FinchAPI
   module Resources
     class Jobs
       class Manual
-        # Get a manual job by `job_id`. Manual jobs are completed by a human and include
-        # Assisted Benefits jobs.
+        # Check the status and outcome of a job by `job_id`. This includes all deductions
+        # jobs including those for both automated and assisted integrations.
         sig do
           params(
             job_id: String,

data/rbi/finch_api/resources/sandbox/employment.rbi

@@ -59,8 +59,7 @@ module FinchAPI
           department: nil,
           # The employment object.
           employment: nil,
-          # The detailed employment status of the individual. Available options: `active`,
-          # `deceased`, `leave`, `onboarding`, `prehire`, `retired`, `terminated`.
+          # The detailed employment status of the individual.
           employment_status: nil,
           end_date: nil,
           # The legal first name of the individual.

data/sig/finch_api/models/sandbox/connection_create_response.rbs

@@ -8,6 +8,7 @@ module FinchAPI
           authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
           company_id: String,
           connection_id: String,
+          entity_id: String,
           products: ::Array[String],
           provider_id: String,
           token_type: String
@@ -24,6 +25,8 @@ module FinchAPI
 
         attr_accessor connection_id: String
 
+        attr_accessor entity_id: String
+
         attr_accessor products: ::Array[String]
 
         attr_accessor provider_id: String
@@ -38,6 +41,7 @@ module FinchAPI
           authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
           company_id: String,
           connection_id: String,
+          entity_id: String,
           products: ::Array[String],
           provider_id: String,
           ?token_type: String
@@ -49,6 +53,7 @@ module FinchAPI
           authentication_type: FinchAPI::Models::Sandbox::ConnectionCreateResponse::authentication_type,
           company_id: String,
           connection_id: String,
+          entity_id: String,
           products: ::Array[String],
           provider_id: String,
           token_type: String

data/sig/finch_api/models/sandbox/connections/account_create_response.rbs

@@ -9,6 +9,7 @@ module FinchAPI
             authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type,
             company_id: String,
             connection_id: String,
+            entity_id: String,
             products: ::Array[String],
             provider_id: String
           }
@@ -24,6 +25,8 @@ module FinchAPI
 
           attr_accessor connection_id: String
 
+          attr_accessor entity_id: String
+
           attr_accessor products: ::Array[String]
 
           attr_accessor provider_id: String
@@ -34,6 +37,7 @@ module FinchAPI
             authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type,
             company_id: String,
             connection_id: String,
+            entity_id: String,
             products: ::Array[String],
             provider_id: String
           ) -> void
@@ -44,6 +48,7 @@ module FinchAPI
             authentication_type: FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::authentication_type,
             company_id: String,
             connection_id: String,
+            entity_id: String,
             products: ::Array[String],
             provider_id: String
           }

data/sig/finch_api/models/sandbox/connections/account_update_response.rbs

@@ -7,9 +7,10 @@ module FinchAPI
             account_id: String,
             authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type,
             company_id: String,
+            connection_id: String,
+            entity_id: String,
             products: ::Array[String],
-            provider_id: String,
-            connection_id: String
+            provider_id: String
           }
 
         class AccountUpdateResponse < FinchAPI::Internal::Type::BaseModel
@@ -19,30 +20,32 @@ module FinchAPI
 
           attr_accessor company_id: String
 
-          attr_accessor products: ::Array[String]
+          attr_accessor connection_id: String
 
-          attr_accessor provider_id: String
+          attr_accessor entity_id: String
 
-          attr_reader connection_id: String?
+          attr_accessor products: ::Array[String]
 
-          def connection_id=: (String) -> String
+          attr_accessor provider_id: String
 
           def initialize: (
             account_id: String,
             authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type,
             company_id: String,
+            connection_id: String,
+            entity_id: String,
             products: ::Array[String],
-            provider_id: String,
-            ?connection_id: String
+            provider_id: String
           ) -> void
 
           def to_hash: -> {
             account_id: String,
             authentication_type: FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::authentication_type,
             company_id: String,
+            connection_id: String,
+            entity_id: String,
             products: ::Array[String],
-            provider_id: String,
-            connection_id: String
+            provider_id: String
           }
 
           type authentication_type =

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.39
+  version: 0.1.0.pre.alpha.41
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2025-12-30 00:00:00.000000000 Z
+date: 2026-01-13 00:00:00.000000000 Z
 dependencies:
+- !ruby/object:Gem::Dependency
+  name: cgi
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: connection_pool
   requirement: !ruby/object:Gem::Requirement