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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a516f81f01b9ea7b24c991040f7e588ce4f22f522774c44bda36f84fa4c0d95
-  data.tar.gz: 698f1bb3796033699051458fe674ee2c37c8054f57044b18be53d5a3083997c2
+  metadata.gz: 0baa06f8bc674518d4abf5fb86c2232ac10c6c709b082d783c3e15e41e09c55d
+  data.tar.gz: 7f59c107245deea6024b07c5c1ce7d35a0f81c98ce96b3e328dfdc2220e08cac
 SHA512:
-  metadata.gz: '09ef57663d79aebd52343bc5c40e7120ae29687dfbf6e1a471c120ddae9dec213b544cb4fc0e0b3b9a14920f6cc3d13a48eb159b1f6e762d2d5a6fbcbf2c2359'
-  data.tar.gz: 8f1be6bedac4265bb4587fa9788d87c5a0278072772c196d5e55f7b7f1e8bbc03d980d69d4d7a7674fc14b6cb2dee1ab022b05c7eb8537eabc3531998144fe35
+  metadata.gz: b791e603219364089fe168d43dad39b8755a0c1e6196ebcbbc0f0edf8a5c7f72fb33a6730b0477a4269ca9c6d74f3db0f06eb28148b02d8a4604416cbcd4a923
+  data.tar.gz: b406e67732f8cda1d32056a5619b562d94d2dbebf02b3c5873d51bcc0beaf830487b60f8c50db5e1326072a685dacf0929600985fde9d87c219cf487098ee9ec

data/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 0.1.0-alpha.50 (2026-07-17)
+
+Full Changelog: [v0.1.0-alpha.49...v0.1.0-alpha.50](https://github.com/Finch-API/finch-api-ruby/compare/v0.1.0-alpha.49...v0.1.0-alpha.50)
+
+### Features
+
+* **api:** api update ([043c5b5](https://github.com/Finch-API/finch-api-ruby/commit/043c5b520c2561f0f20d377cfa75c443b07b4bb6))
+* **stlc:** configurable CI runner and private-production-repo support in workflow templates ([ba8e0a7](https://github.com/Finch-API/finch-api-ruby/commit/ba8e0a7037b38eed4f688e413b0b001af0e31a26))
+
+## 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.50"
 ```
 
 <!-- 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_data.rb

@@ -67,12 +67,26 @@ module FinchAPI
                    enum: -> { FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus },
                    nil?: true
 
+          # @!attribute highly_compensated_employee
+          #   IRS flag indicating whether the employee is classified as a Highly Compensated
+          #   Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
+          #
+          #   @return [Boolean, nil]
+          required :highly_compensated_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
           # @!attribute is_active
           #   `true` if the individual an an active employee or contractor at the company.
           #
           #   @return [Boolean, nil]
           required :is_active, FinchAPI::Internal::Type::Boolean, nil?: true
 
+          # @!attribute key_employee
+          #   IRS flag indicating whether the employee is classified as a Key Employee for
+          #   top-heavy testing purposes. US-only.
+          #
+          #   @return [Boolean, nil]
+          required :key_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
           # @!attribute last_name
           #   The legal last name of the individual.
           #
@@ -116,6 +130,19 @@ module FinchAPI
           #   @return [String, nil]
           required :title, String, nil?: true
 
+          # @!attribute union_code
+          #   The code identifying the union the employee is a member of, as configured in the
+          #   payroll system.
+          #
+          #   @return [String, nil]
+          required :union_code, String, nil?: true
+
+          # @!attribute union_local
+          #   The local chapter or local number within the employee's union.
+          #
+          #   @return [String, nil]
+          required :union_local, String, nil?: true
+
           # @!attribute custom_fields
           #   Custom fields for the individual. These are fields which are defined by the
           #   employer in the system. Custom fields are not currently supported for assisted
@@ -158,7 +185,7 @@ module FinchAPI
           #   @return [String, nil]
           optional :work_id, String, nil?: true
 
-          # @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, flsa_status:, is_active:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
+          # @!method initialize(id:, class_code:, department:, employment:, employment_status:, end_date:, first_name:, flsa_status:, highly_compensated_employee:, is_active:, key_employee:, last_name:, latest_rehire_date:, location:, manager:, middle_name:, start_date:, title:, union_code:, union_local:, custom_fields: nil, income: nil, income_history: nil, source_id: nil, work_id: nil)
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody} for more
           #   details.
@@ -179,8 +206,12 @@ module FinchAPI
           #
           #   @param flsa_status [Symbol, FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus, nil] The FLSA status of the individual. Available options: `exempt`, `non_exempt`, `u
           #
+          #   @param highly_compensated_employee [Boolean, nil] IRS flag indicating whether the employee is classified as a Highly Compensated E
+          #
           #   @param is_active [Boolean, nil] `true` if the individual an an active employee or contractor at the company.
           #
+          #   @param key_employee [Boolean, nil] IRS flag indicating whether the employee is classified as a Key Employee for top
+          #
           #   @param last_name [String, nil] The legal last name of the individual.
           #
           #   @param latest_rehire_date [String, nil]
@@ -195,6 +226,10 @@ module FinchAPI
           #
           #   @param title [String, nil] The current title of the individual.
           #
+          #   @param union_code [String, nil] The code identifying the union the employee is a member of, as configured in the
+          #
+          #   @param union_local [String, nil] The local chapter or local number within the employee's union.
+          #
           #   @param custom_fields [Array<FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField>, nil] Custom fields for the individual. These are fields which are defined by the empl
           #
           #   @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual

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

@@ -52,6 +52,15 @@ module FinchAPI
           #   @return [String, nil]
           required :last_name, String, nil?: true
 
+          # @!attribute marital_status
+          #   The employee's marital status, used for beneficiary designation and spousal
+          #   consent workflows.
+          #
+          #   @return [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::MaritalStatus, nil]
+          required :marital_status,
+                   enum: -> { FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus },
+                   nil?: true
+
           # @!attribute middle_name
           #   The legal middle name of the individual.
           #
@@ -105,7 +114,7 @@ module FinchAPI
           #   @return [String, nil]
           optional :ssn, String, nil?: true
 
-          # @!method initialize(id:, dob:, ethnicity:, first_name:, gender:, last_name:, middle_name:, phone_numbers:, preferred_name:, residence:, emails: nil, encrypted_ssn: nil, ssn: nil)
+          # @!method initialize(id:, dob:, ethnicity:, first_name:, gender:, last_name:, marital_status:, middle_name:, phone_numbers:, preferred_name:, residence:, emails: nil, encrypted_ssn: nil, ssn: nil)
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::HRIS::Individual::IndividualResponseBody} for more details.
           #
@@ -121,6 +130,8 @@ module FinchAPI
           #
           #   @param last_name [String, nil] The legal last name of the individual.
           #
+          #   @param marital_status [Symbol, FinchAPI::Models::HRIS::Individual::IndividualResponseBody::MaritalStatus, nil] The employee's marital status, used for beneficiary designation and spousal cons
+          #
           #   @param middle_name [String, nil] The legal middle name of the individual.
           #
           #   @param phone_numbers [Array<FinchAPI::Models::HRIS::Individual::IndividualResponseBody::PhoneNumber, nil>, nil]
@@ -169,6 +180,24 @@ module FinchAPI
             #   @return [Array<Symbol>]
           end
 
+          # The employee's marital status, used for beneficiary designation and spousal
+          # consent workflows.
+          #
+          # @see FinchAPI::Models::HRIS::Individual::IndividualResponseBody#marital_status
+          module MaritalStatus
+            extend FinchAPI::Internal::Type::Enum
+
+            SINGLE = :single
+            MARRIED = :married
+            DIVORCED = :divorced
+            WIDOWED = :widowed
+            DOMESTIC_PARTNER = :domestic_partner
+            UNKNOWN = :unknown
+
+            # @!method self.values
+            #   @return [Array<Symbol>]
+          end
+
           class PhoneNumber < FinchAPI::Internal::Type::BaseModel
             # @!attribute data
             #

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