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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 314161384d71b7c4f61f36dde0af6cf63e97c43cb141ea124e251d2914cf041b
-  data.tar.gz: e0762fe9916202301a471b652e611a628a41002fe31f40789d70ce662c4a6152
+  metadata.gz: f0c2c976c70cb05a8a51e10cc2dd857fe65096c2547a525d0322d728d6b9c273
+  data.tar.gz: 25b6ecd53cfa6fbab429c14406bbe99d4b29cf261123db10253d66c6b9d56004
 SHA512:
-  metadata.gz: e3944b694e4288ff64e7f28cf7ce0ad411edf547cca87ac4665cac03e9f75138adc9162ab7425c336aaead70fe22516bf48040b006dce3cf6a1e4b6470c82e10
-  data.tar.gz: 50b5484f1ad97eed848afff3115d25de3743a94a35981658dded01d0b8325743e5c6b747bedc6a71183de87d78c2b4de30e1daf9e69800ebc80d4fece8f57213
+  metadata.gz: 0676202b2ce5c5e50799b4b507b92a27fc63ba723ac05e56363621082032992c1f2bf3a9f74d27c860120141eb8e2df3904d37a3acf8f17f8fc55cfafb36fc4f
+  data.tar.gz: acaa49d18fc5567cd1d04cb8f34b80d62570f08d9c0cd4bc69230736249f2b5c138191e5b5f82e79875ae225175265a502a479604d341b40ae7657d675c4174e

data/CHANGELOG.md

@@ -1,5 +1,19 @@
 # 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)

data/README.md

@@ -26,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.40"
+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/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.40"
+  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/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.

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: finch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha.40
+  version: 0.1.0.pre.alpha.41
 platform: ruby
 authors:
 - Finch
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2026-01-06 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