release: 0.1.0-alpha.41

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.40"
+  ".": "0.1.0-alpha.41"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 46
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-ded87cb73affcaff9cf779d9cfd119a4026cfc1757b39be95d933edea48a0328.yml
-openapi_spec_hash: 0e6394b222fc68d7607114e70b72d23e
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch%2Ffinch-46f433f34d440aa1dfcc48cc8d822c598571b68be2f723ec99e1b4fba6c13b1e.yml
+openapi_spec_hash: 5b5cd728776723ac773900f7e8a32c05
 config_hash: 0892e2e0eeb0343a022afa62e9080dd1

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)

Gemfile.lock

@@ -11,7 +11,8 @@ GIT
 PATH
   remote: .
   specs:
-    finch-api (0.1.0.pre.alpha.40)
+    finch-api (0.1.0.pre.alpha.41)
+      cgi
       connection_pool
 
 GEM
@@ -42,6 +43,7 @@ GEM
     base64 (0.3.0)
     benchmark (0.5.0)
     bigdecimal (3.3.1)
+    cgi (0.5.1)
     concurrent-ruby (1.3.5)
     connection_pool (2.5.4)
     console (1.34.2)

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 -->

finch_api.gemspec

@@ -24,5 +24,6 @@ Gem::Specification.new do |s|
     ".ignore"
   ]
   s.extra_rdoc_files = ["README.md"]
+  s.add_dependency "cgi"
   s.add_dependency "connection_pool"
 end

lib/finch_api/models/hris/employment_data.rb

@@ -36,8 +36,7 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
           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 @@ class UnionMember0 < FinchAPI::Internal::Type::BaseModel
           #
           #   @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 Type
             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

lib/finch_api/models/hris/payment_list_params.rb

@@ -10,14 +10,14 @@ class PaymentListParams < FinchAPI::Internal::Type::BaseModel
 
         # @!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

lib/finch_api/models/sandbox/directory_create_params.rb

@@ -69,8 +69,7 @@ class Body < FinchAPI::Internal::Type::BaseModel
           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 @@ class Body < FinchAPI::Internal::Type::BaseModel
           #
           #   @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 Type
             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

lib/finch_api/models/sandbox/employment_update_params.rb

@@ -39,8 +39,7 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
         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 @@ class EmploymentUpdateParams < FinchAPI::Internal::Type::BaseModel
         #
         #   @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 Type
           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
 

lib/finch_api/models/sandbox/employment_update_response.rb

@@ -40,8 +40,7 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
         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 @@ class EmploymentUpdateResponse < FinchAPI::Internal::Type::BaseModel
         #
         #   @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 Type
           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

lib/finch_api/resources/hris/benefits.rb

@@ -71,7 +71,7 @@ def retrieve(benefit_id, params = {})
         #
         # @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.
         #

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

@@ -12,7 +12,7 @@ class Individuals
           #
           # @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 @@ def retrieve_many_benefits(benefit_id, params = {})
           #
           # @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.
           #

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

@@ -11,9 +11,8 @@ class PayStatementItem
           # 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: {})
           #

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

@@ -10,20 +10,18 @@ class Rules
             # {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: {})
             #
             # @param entity_ids [Array<String>] Query param: The entity IDs to create the rule for.
             #
             # @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 @@ def create(params = {})
               )
             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 @@ def update(rule_id, params = {})
               )
             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 @@ def list(params = {})
               )
             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: {})
             #

lib/finch_api/resources/hris/individuals.rb

@@ -10,9 +10,9 @@ class Individuals
         #
         # @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]
         #

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: {})
         #

lib/finch_api/resources/sandbox/employment.rb

@@ -21,7 +21,7 @@ class Employment
         #
         # @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]
         #

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

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