finch-api 0.1.0.pre.alpha.59 → 0.1.0.pre.alpha.61

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -15,7 +15,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -17,6 +17,14 @@ module FinchAPI
           #   @return [String]
           required :id, String
 
+          # @!attribute benefit_eligibility_class
+          #   The employer defined benefit eligibility class that groups an employee into a
+          #   set of eligible benefit plans, as stored by the provider. Null when not
+          #   configured.
+          #
+          #   @return [String, nil]
+          required :benefit_eligibility_class, String, nil?: true
+
           # @!attribute class_code
           #   Worker's compensation classification code for this employee
           #
@@ -185,13 +193,15 @@ 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:, 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)
+          # @!method initialize(id:, benefit_eligibility_class:, 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.
           #
           #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
           #
+          #   @param benefit_eligibility_class [String, nil] The employer defined benefit eligibility class that groups an employee into a se
+          #
           #   @param class_code [String, nil] Worker's compensation classification code for this employee
           #
           #   @param department [FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::Department, nil] The department object.

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

@@ -17,7 +17,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -17,7 +17,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -11,7 +11,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to create the rule for. Provide exactly one entity ID per
-          #   request; a maximum of one is accepted.
+          #   request; a maximum of one is accepted. Required when the connection has more
+          #   than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          #   for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to delete the rule for. Provide exactly one entity ID per
-          #   request; a maximum of one is accepted.
+          #   request; a maximum of one is accepted. Required when the connection has more
+          #   than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          #   for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -11,7 +11,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
-          #   a maximum of one is accepted.
+          #   a maximum of one is accepted. Required when the connection has more than one
+          #   entity — omitting it returns a `400` `invalid_request_error`. Optional for
+          #   single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -16,7 +16,9 @@ module FinchAPI
 
           # @!attribute entity_ids
           #   The entity IDs to update the rule for. Provide exactly one entity ID per
-          #   request; a maximum of one is accepted.
+          #   request; a maximum of one is accepted. Required when the connection has more
+          #   than one entity — omitting it returns a `400` `invalid_request_error`. Optional
+          #   for single-entity connections.
           #
           #   @return [Array<String>, nil]
           optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -25,7 +25,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -17,7 +17,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

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

@@ -24,7 +24,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/payroll/pay_group_list_params.rb

@@ -10,7 +10,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]

data/lib/finch_api/models/payroll/pay_group_retrieve_params.rb

@@ -15,7 +15,9 @@ module FinchAPI
 
         # @!attribute entity_ids
         #   The entity IDs to specify which entities' data to access. Provide exactly one
-        #   entity ID per request; a maximum of one is accepted.
+        #   entity ID per request; a maximum of one is accepted. Required when the
+        #   connection has more than one entity — omitting it returns a `400`
+        #   `invalid_request_error`. Optional for single-entity connections.
         #
         #   @return [Array<String>, nil]
         optional :entity_ids, FinchAPI::Internal::Type::ArrayOf[String]