finch-api 0.1.0.pre.alpha.48 → 0.1.0.pre.alpha.49

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a516f81f01b9ea7b24c991040f7e588ce4f22f522774c44bda36f84fa4c0d95
-  data.tar.gz: 698f1bb3796033699051458fe674ee2c37c8054f57044b18be53d5a3083997c2
+  metadata.gz: 0e808c0bba7f22123fbcea95871a5b0a7d0149de1e6c3e63b30cb30406088684
+  data.tar.gz: bffa0baac1966f4b99a88e6fdfc8aefadc7b342109c70224821216721724a171
 SHA512:
-  metadata.gz: '09ef57663d79aebd52343bc5c40e7120ae29687dfbf6e1a471c120ddae9dec213b544cb4fc0e0b3b9a14920f6cc3d13a48eb159b1f6e762d2d5a6fbcbf2c2359'
-  data.tar.gz: 8f1be6bedac4265bb4587fa9788d87c5a0278072772c196d5e55f7b7f1e8bbc03d980d69d4d7a7674fc14b6cb2dee1ab022b05c7eb8537eabc3531998144fe35
+  metadata.gz: c4900f43c809f22998d056aafce9a7b8563685df7bb302f2012eca4163ffaab3112285886f47765e754fd36237f63766e504c716e28d9924f3507f56e7337073
+  data.tar.gz: ec75b28b2b7d2ddcfe2c2b96d8fa33f77dd9cecd1c22c26a43c3b470b495abcab7b8120840222e7d6bde62f1db974e0e0851592f2f5b8d4447180e25191096d7

data/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)

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

data/lib/finch_api/models/base_webhook_event.rb

@@ -14,10 +14,7 @@ module FinchAPI
       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 @@ module FinchAPI
       #
       #   @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.
       #

data/lib/finch_api/models/create_access_token_response.rb

@@ -65,10 +65,7 @@ module FinchAPI
       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 @@ module FinchAPI
       #
       #   @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
       #

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

@@ -9,7 +9,8 @@ module FinchAPI
         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 @@ module FinchAPI
         #   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.
         #

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

@@ -9,13 +9,17 @@ module FinchAPI
         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

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

@@ -9,13 +9,17 @@ module FinchAPI
         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

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

@@ -9,7 +9,8 @@ module FinchAPI
         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 @@ module FinchAPI
         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]
         #

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

@@ -14,15 +14,19 @@ module FinchAPI
         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

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

@@ -14,7 +14,8 @@ module FinchAPI
         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 @@ module FinchAPI
         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.
         #

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

@@ -15,7 +15,8 @@ module FinchAPI
           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 @@ module FinchAPI
                    -> { 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.
           #

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

@@ -15,15 +15,20 @@ module FinchAPI
           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

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

@@ -15,7 +15,8 @@ module FinchAPI
           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 @@ module FinchAPI
           #
           #   @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
           #

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

@@ -15,7 +15,8 @@ module FinchAPI
           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 @@ module FinchAPI
           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.
           #

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

@@ -9,13 +9,17 @@ module FinchAPI
         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

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

@@ -9,7 +9,8 @@ module FinchAPI
         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 @@ module FinchAPI
         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)
         #

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

@@ -9,7 +9,8 @@ module FinchAPI
         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 @@ module FinchAPI
         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)
         #

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

@@ -9,7 +9,8 @@ module FinchAPI
         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]
@@ -44,7 +45,7 @@ module FinchAPI
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::HRIS::DocumentListParams} 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 individual_ids [Array<String>] Comma-delimited list of stable Finch uuids for each individual. If empty, defaul
         #

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

@@ -14,15 +14,19 @@ module FinchAPI
         required :document_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(document_id:, entity_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::DocumentRetreiveParams} for more details.
+        #
         #   @param document_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

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

@@ -16,15 +16,19 @@ module FinchAPI
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::EmploymentRetrieveManyParams::Request] }
 
         # @!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(requests:, entity_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::EmploymentRetrieveManyParams} for more details.
+        #
         #   @param requests [Array<FinchAPI::Models::HRIS::EmploymentRetrieveManyParams::Request>] The array of batch requests. Maximum 10000 items per request.
         #
-        #   @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}]
 

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

@@ -16,7 +16,8 @@ module FinchAPI
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::IndividualRetrieveManyParams::Request] }
 
         # @!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,12 @@ module FinchAPI
         optional :options, -> { FinchAPI::HRIS::IndividualRetrieveManyParams::Options }, nil?: true
 
         # @!method initialize(requests:, entity_ids: nil, options: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::IndividualRetrieveManyParams} for more details.
+        #
         #   @param requests [Array<FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Request>] The array of batch requests. Maximum 10000 items per request.
         #
-        #   @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 options [FinchAPI::Models::HRIS::IndividualRetrieveManyParams::Options, nil]
         #

data/lib/finch_api/models/hris/pay_statement_item/rule_create_params.rb

@@ -10,7 +10,8 @@ module FinchAPI
           include FinchAPI::Internal::Type::RequestParameters
 
           # @!attribute entity_ids
-          #   The entity IDs to create the rule for.
+          #   The entity IDs to create the rule for. 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,10 @@ module FinchAPI
           optional :entity_type, enum: -> { FinchAPI::HRIS::PayStatementItem::RuleCreateParams::EntityType }
 
           # @!method initialize(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>] The entity IDs to create the rule for.
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams} for more details.
+          #
+          #   @param entity_ids [Array<String>] The entity IDs to create the rule for. Provide exactly one entity ID per request
           #
           #   @param attributes [FinchAPI::Models::HRIS::PayStatementItem::RuleCreateParams::Attributes] Specifies the fields to be applied when the condition is met.
           #

data/lib/finch_api/models/hris/pay_statement_item/rule_delete_params.rb

@@ -15,15 +15,19 @@ module FinchAPI
           required :rule_id, String
 
           # @!attribute entity_ids
-          #   The entity IDs to delete the rule for.
+          #   The entity IDs to delete the rule for. 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(rule_id:, entity_ids: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::PayStatementItem::RuleDeleteParams} for more details.
+          #
           #   @param rule_id [String]
           #
-          #   @param entity_ids [Array<String>] The entity IDs to delete the rule for.
+          #   @param entity_ids [Array<String>] The entity IDs to delete the rule for. Provide exactly one entity ID per request
           #
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/finch_api/models/hris/pay_statement_item/rule_list_params.rb

@@ -10,13 +10,17 @@ module FinchAPI
           include FinchAPI::Internal::Type::RequestParameters
 
           # @!attribute entity_ids
-          #   The entity IDs to retrieve rules for.
+          #   The entity IDs to retrieve rules for. 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 retrieve rules for.
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::PayStatementItem::RuleListParams} for more details.
+          #
+          #   @param entity_ids [Array<String>] The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
           #
           #   @param request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
         end

data/lib/finch_api/models/hris/pay_statement_item/rule_update_params.rb

@@ -15,7 +15,8 @@ module FinchAPI
           required :rule_id, String
 
           # @!attribute entity_ids
-          #   The entity IDs to update the rule for.
+          #   The entity IDs to update the rule for. 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 @@ module FinchAPI
           optional :optional_property, FinchAPI::Internal::Type::Unknown, api_name: :optionalProperty
 
           # @!method initialize(rule_id:, entity_ids: nil, optional_property: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {FinchAPI::Models::HRIS::PayStatementItem::RuleUpdateParams} for more details.
+          #
           #   @param rule_id [String]
           #
-          #   @param entity_ids [Array<String>] The entity IDs to update the rule for.
+          #   @param entity_ids [Array<String>] The entity IDs to update the rule for. Provide exactly one entity ID per request
           #
           #   @param optional_property [Object]
           #

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

@@ -24,7 +24,8 @@ module FinchAPI
         optional :end_date, Date
 
         # @!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]
@@ -56,7 +57,7 @@ module FinchAPI
         #
         #   @param end_date [Date] The end date to retrieve pay statement items by via their last seen pay date in
         #
-        #   @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 name [String] Case-insensitive partial match search by pay statement item name.
         #

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

@@ -16,15 +16,19 @@ module FinchAPI
                  -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::HRIS::PayStatementRetrieveManyParams::Request] }
 
         # @!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(requests:, entity_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::HRIS::PayStatementRetrieveManyParams} for more details.
+        #
         #   @param requests [Array<FinchAPI::Models::HRIS::PayStatementRetrieveManyParams::Request>] The array of batch requests. Maximum 10 payment_ids per request.
         #
-        #   @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}]
 

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

@@ -23,7 +23,8 @@ module FinchAPI
         required :start_date, Date
 
         # @!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]
@@ -36,7 +37,7 @@ module FinchAPI
         #
         #   @param start_date [Date] The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD` for
         #
-        #   @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