release: 0.1.0-alpha.49

.release-please-manifest.json

@@ -1,3 +1,3 @@
 {
-  ".": "0.1.0-alpha.48"
+  ".": "0.1.0-alpha.49"
 }

.stats.yml

@@ -1,4 +1,4 @@
 configured_endpoints: 48
-openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-a6b05e51c46366a54466c2009f5fdde74e0fa40bbcc6568601a4e3342dd16937.yml
-openapi_spec_hash: 084797c220144df17d98eb984dd4cba2
+openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/finch/finch-166cc05754d8591beda094f4ee6f438f55d5f65d490ab364ea130c5100134375.yml
+openapi_spec_hash: 4582a35bbe9fb5404d1e4f804c877fa8
 config_hash: 9ae56f40cec7304896138bfad5caf748

CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.1.0-alpha.49 (2026-07-15)
+
+Full Changelog: [v0.1.0-alpha.48...v0.1.0-alpha.49](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.48...v0.1.0-alpha.49)
+
+### Features
+
+* **api:** api update ([41c1dd6](https://github.com/Finch-API/finch-api-ruby/commit/41c1dd679e77e2a293321fbdff1d145149c3af5f))
+
 ## 0.1.0-alpha.48 (2026-07-13)
 
 Full Changelog: [v0.1.0-alpha.47...v0.1.0-alpha.48](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.47...v0.1.0-alpha.48)

Gemfile.lock

@@ -11,7 +11,7 @@ GIT
 PATH
   remote: .
   specs:
-    finch-api (0.1.0.pre.alpha.48)
+    finch-api (0.1.0.pre.alpha.49)
       cgi
       connection_pool
 

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

lib/finch_api/models/base_webhook_event.rb

@@ -14,10 +14,7 @@ class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel
       required :account_id, String
 
       # @!attribute company_id
-      #   @deprecated
-      #
-      #   [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
-      #   `connection_id` instead to identify the connection associated with this event.
+      #   Unique Finch ID of the company for which data has been updated.
       #
       #   @return [String]
       required :company_id, String
@@ -40,7 +37,7 @@ class BaseWebhookEvent < FinchAPI::Internal::Type::BaseModel
       #
       #   @param account_id [String] [DEPRECATED] Unique Finch ID of the employer account used to make this connectio
       #
-      #   @param company_id [String] [DEPRECATED] Unique Finch ID of the company for which data has been updated. Use
+      #   @param company_id [String] Unique Finch ID of the company for which data has been updated.
       #
       #   @param connection_id [String] Unique Finch ID of the connection associated with the webhook event.
       #

lib/finch_api/models/create_access_token_response.rb

@@ -65,10 +65,7 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
       optional :account_id, String
 
       # @!attribute company_id
-      #   @deprecated
-      #
-      #   [DEPRECATED] Use `connection_id` to identify the connection instead of this
-      #   company ID
+      #   The Finch UUID of the company associated with the `access_token`.
       #
       #   @return [String, nil]
       optional :company_id, String
@@ -109,7 +106,7 @@ class CreateAccessTokenResponse < FinchAPI::Internal::Type::BaseModel
       #
       #   @param account_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this acco
       #
-      #   @param company_id [String] [DEPRECATED] Use `connection_id` to identify the connection instead of this comp
+      #   @param company_id [String] The Finch UUID of the company associated with the `access_token`.
       #
       #   @param customer_id [String, nil] The ID of your customer you provided to Finch when a connect session was created
       #

lib/finch_api/models/hris/benefit_create_params.rb

@@ -9,7 +9,8 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -46,7 +47,7 @@ class BenefitCreateParams < FinchAPI::Internal::Type::BaseModel
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::HRIS::BenefitCreateParams} for more details.
         #
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param company_contribution [FinchAPI::Models::HRIS::BenefitCreateParams::CompanyContribution, nil] The company match for this benefit.
         #

lib/finch_api/models/hris/benefit_list_params.rb

@@ -9,13 +9,17 @@ class BenefitListParams < FinchAPI::Internal::Type::BaseModel
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(entity_ids: nil, request_options: {})
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::BenefitListParams} for more details.
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end

lib/finch_api/models/hris/benefit_list_supported_benefits_params.rb

@@ -9,13 +9,17 @@ class BenefitListSupportedBenefitsParams < FinchAPI::Internal::Type::BaseModel
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(entity_ids: nil, request_options: {})
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::BenefitListSupportedBenefitsParams} for more details.
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end

lib/finch_api/models/hris/benefit_register_params.rb

@@ -9,7 +9,8 @@ class BenefitRegisterParams < FinchAPI::Internal::Type::BaseModel
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -32,7 +33,10 @@ class BenefitRegisterParams < FinchAPI::Internal::Type::BaseModel
         optional :type, enum: -> { FinchAPI::HRIS::BenefitType }, nil?: true
 
         # @!method initialize(entity_ids: nil, description: nil, frequency: nil, type: nil, request_options: {})
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::BenefitRegisterParams} for more details.
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param description [String]
         #

lib/finch_api/models/hris/benefit_retrieve_params.rb

@@ -14,15 +14,19 @@ class BenefitRetrieveParams < FinchAPI::Internal::Type::BaseModel
         required :benefit_id, String
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(benefit_id:, entity_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::BenefitRetrieveParams} for more details.
+        #
         #   @param benefit_id [String]
         #
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end

lib/finch_api/models/hris/benefit_update_params.rb

@@ -14,7 +14,8 @@ class BenefitUpdateParams < FinchAPI::Internal::Type::BaseModel
         required :benefit_id, String
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -26,9 +27,12 @@ class BenefitUpdateParams < FinchAPI::Internal::Type::BaseModel
         optional :description, String
 
         # @!method initialize(benefit_id:, entity_ids: nil, description: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::BenefitUpdateParams} for more details.
+        #
         #   @param benefit_id [String]
         #
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param description [String] Updated name or description.
         #

lib/finch_api/models/hris/benefits/individual_enroll_many_params.rb

@@ -15,7 +15,8 @@ class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel
           required :benefit_id, String
 
           # @!attribute entity_ids
-          #   The entity IDs to specify which entities' data to access.
+          #   The entity IDs to specify which entities' data to access. Provide exactly one
+          #   entity ID per request; a maximum of one is accepted.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -28,9 +29,12 @@ class IndividualEnrollManyParams < FinchAPI::Internal::Type::BaseModel
                    -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::Benefits::IndividualEnrollManyParams::Individual] }
 
           # @!method initialize(benefit_id:, entity_ids: nil, individuals: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams} for more details.
+          #
           #   @param benefit_id [String]
           #
-          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
           #
           #   @param individuals [Array<FinchAPI::Models::HRIS::Benefits::IndividualEnrollManyParams::Individual>] Array of the individual_id to enroll and a configuration object.
           #

lib/finch_api/models/hris/benefits/individual_enrolled_ids_params.rb

@@ -15,15 +15,20 @@ class IndividualEnrolledIDsParams < FinchAPI::Internal::Type::BaseModel
           required :benefit_id, String
 
           # @!attribute entity_ids
-          #   The entity IDs to specify which entities' data to access.
+          #   The entity IDs to specify which entities' data to access. Provide exactly one
+          #   entity ID per request; a maximum of one is accepted.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
           # @!method initialize(benefit_id:, entity_ids: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::Benefits::IndividualEnrolledIDsParams} for more
+          #   details.
+          #
           #   @param benefit_id [String]
           #
-          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
           #
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
         end

lib/finch_api/models/hris/benefits/individual_retrieve_many_benefits_params.rb

@@ -15,7 +15,8 @@ class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel
           required :benefit_id, String
 
           # @!attribute entity_ids
-          #   The entity IDs to specify which entities' data to access.
+          #   The entity IDs to specify which entities' data to access. Provide exactly one
+          #   entity ID per request; a maximum of one is accepted.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -34,7 +35,7 @@ class IndividualRetrieveManyBenefitsParams < FinchAPI::Internal::Type::BaseModel
           #
           #   @param benefit_id [String]
           #
-          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
           #
           #   @param individual_ids [String] comma-delimited list of stable Finch uuids for each individual. If empty, defaul
           #

lib/finch_api/models/hris/benefits/individual_unenroll_many_params.rb

@@ -15,7 +15,8 @@ class IndividualUnenrollManyParams < FinchAPI::Internal::Type::BaseModel
           required :benefit_id, String
 
           # @!attribute entity_ids
-          #   The entity IDs to specify which entities' data to access.
+          #   The entity IDs to specify which entities' data to access. Provide exactly one
+          #   entity ID per request; a maximum of one is accepted.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -27,9 +28,13 @@ class IndividualUnenrollManyParams < FinchAPI::Internal::Type::BaseModel
           optional :individual_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
           # @!method initialize(benefit_id:, entity_ids: nil, individual_ids: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::Benefits::IndividualUnenrollManyParams} for more
+          #   details.
+          #
           #   @param benefit_id [String]
           #
-          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+          #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
           #
           #   @param individual_ids [Array<String>] Array of individual_ids to unenroll.
           #

lib/finch_api/models/hris/company_retrieve_params.rb

@@ -9,13 +9,17 @@ class CompanyRetrieveParams < FinchAPI::Internal::Type::BaseModel
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(entity_ids: nil, request_options: {})
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::CompanyRetrieveParams} for more details.
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
       end

lib/finch_api/models/hris/directory_list_individuals_params.rb

@@ -9,7 +9,8 @@ class DirectoryListIndividualsParams < FinchAPI::Internal::Type::BaseModel
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -27,7 +28,10 @@ class DirectoryListIndividualsParams < FinchAPI::Internal::Type::BaseModel
         optional :offset, Integer
 
         # @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {})
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::DirectoryListIndividualsParams} for more details.
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
         #

lib/finch_api/models/hris/directory_list_params.rb

@@ -9,7 +9,8 @@ class DirectoryListParams < FinchAPI::Internal::Type::BaseModel
         include FinchAPI::Internal::Type::RequestParameters
 
         # @!attribute entity_ids
-        #   The entity IDs to specify which entities' data to access.
+        #   The entity IDs to specify which entities' data to access. Provide exactly one
+        #   entity ID per request; a maximum of one is accepted.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]
@@ -27,7 +28,10 @@ class DirectoryListParams < FinchAPI::Internal::Type::BaseModel
         optional :offset, Integer
 
         # @!method initialize(entity_ids: nil, limit: nil, offset: nil, request_options: {})
-        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access.
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::DirectoryListParams} for more details.
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param limit [Integer] Number of employees to return (defaults to 100, maximum 10000)
         #