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

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

data/lib/finch_api/models/introspection.rb

@@ -70,10 +70,7 @@ module FinchAPI
                -> { FinchAPI::Internal::Type::ArrayOf[FinchAPI::Introspection::AuthenticationMethod] }
 
       # @!attribute company_id
-      #   @deprecated
-      #
-      #   [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection
-      #   instead of this company ID
+      #   The Finch UUID of the company associated with the `access_token`.
       #
       #   @return [String, nil]
       optional :company_id, String
@@ -153,7 +150,7 @@ module FinchAPI
       #
       #   @param authentication_methods [Array<FinchAPI::Models::Introspection::AuthenticationMethod>]
       #
-      #   @param company_id [String] [DEPRECATED] Use `connection_id` to associate tokens with a Finch connection ins
+      #   @param company_id [String] The Finch UUID of the company associated with the `access_token`.
       #
       #   @param customer_email [String, nil] The email of your customer you provided to Finch when a connect session was crea
       #

data/lib/finch_api/models/payroll/pay_group_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]
@@ -25,7 +26,10 @@ module FinchAPI
         optional :pay_frequencies, FinchAPI::Internal::Type::ArrayOf[String]
 
         # @!method initialize(entity_ids: nil, individual_id: nil, pay_frequencies: 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::Payroll::PayGroupListParams} for more details.
+        #
+        #   @param entity_ids [Array<String>] The entity IDs to specify which entities' data to access. Provide exactly one en
         #
         #   @param individual_id [String]
         #

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

@@ -14,15 +14,19 @@ module FinchAPI
         required :pay_group_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(pay_group_id:, entity_ids: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {FinchAPI::Models::Payroll::PayGroupRetrieveParams} for more details.
+        #
         #   @param pay_group_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/sandbox/connection_create_response.rb

@@ -25,9 +25,7 @@ module FinchAPI
                  enum: -> { FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType }
 
         # @!attribute company_id
-        #   @deprecated
-        #
-        #   [DEPRECATED] Use `connection_id` to associate a connection with an access token
+        #   The Finch UUID of the company associated with the `access_token`.
         #
         #   @return [String]
         required :company_id, String
@@ -67,7 +65,7 @@ module FinchAPI
         #
         #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::ConnectionCreateResponse::AuthenticationType]
         #
-        #   @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
+        #   @param company_id [String] The Finch UUID of the company associated with the `access_token`.
         #
         #   @param connection_id [String] The ID of the new connection
         #

data/lib/finch_api/models/sandbox/connections/account_create_response.rb

@@ -26,9 +26,7 @@ module FinchAPI
                    enum: -> { FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType }
 
           # @!attribute company_id
-          #   @deprecated
-          #
-          #   [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          #   The Finch UUID of the company associated with the `access_token`.
           #
           #   @return [String]
           required :company_id, String
@@ -63,7 +61,7 @@ module FinchAPI
           #
           #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountCreateResponse::AuthenticationType]
           #
-          #   @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          #   @param company_id [String] The Finch UUID of the company associated with the `access_token`.
           #
           #   @param connection_id [String] The ID of the new connection
           #

data/lib/finch_api/models/sandbox/connections/account_update_response.rb

@@ -21,9 +21,7 @@ module FinchAPI
                    enum: -> { FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType }
 
           # @!attribute company_id
-          #   @deprecated
-          #
-          #   [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          #   The Finch UUID of the company associated with the `access_token`.
           #
           #   @return [String]
           required :company_id, String
@@ -56,7 +54,7 @@ module FinchAPI
           #
           #   @param authentication_type [Symbol, FinchAPI::Models::Sandbox::Connections::AccountUpdateResponse::AuthenticationType]
           #
-          #   @param company_id [String] [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          #   @param company_id [String] The Finch UUID of the company associated with the `access_token`.
           #
           #   @param connection_id [String] The ID of the new connection
           #

data/lib/finch_api/models/sandbox/directory_create_params.rb

@@ -122,6 +122,13 @@ module FinchAPI
           #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil]
           optional :gender, enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender }, 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]
+          optional :highly_compensated_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
           # @!attribute income
           #   The employee's income as reported by the provider. This may not always be
           #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
@@ -144,6 +151,13 @@ module FinchAPI
           #   @return [Boolean, nil]
           optional :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]
+          optional :key_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
           # @!attribute last_name
           #   The legal last name of the individual.
           #
@@ -166,6 +180,15 @@ module FinchAPI
           #   @return [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil]
           optional :manager, -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager }, nil?: true
 
+          # @!attribute marital_status
+          #   The employee's marital status, used for beneficiary designation and spousal
+          #   consent workflows.
+          #
+          #   @return [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::MaritalStatus, nil]
+          optional :marital_status,
+                   enum: -> { FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus },
+                   nil?: true
+
           # @!attribute middle_name
           #   The legal middle name of the individual.
           #
@@ -219,7 +242,20 @@ module FinchAPI
           #   @return [String, nil]
           optional :title, String, nil?: true
 
-          # @!method initialize(class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, flsa_status: nil, gender: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil)
+          # @!attribute union_code
+          #   The code identifying the union the employee is a member of, as configured in the
+          #   payroll system.
+          #
+          #   @return [String, nil]
+          optional :union_code, String, nil?: true
+
+          # @!attribute union_local
+          #   The local chapter or local number within the employee's union.
+          #
+          #   @return [String, nil]
+          optional :union_local, String, nil?: true
+
+          # @!method initialize(class_code: nil, custom_fields: nil, department: nil, dob: nil, emails: nil, employment: nil, employment_status: nil, encrypted_ssn: nil, end_date: nil, ethnicity: nil, first_name: nil, flsa_status: nil, gender: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, marital_status: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, source_id: nil, ssn: nil, start_date: nil, title: nil, union_code: nil, union_local: nil)
           #   Some parameter documentations has been truncated, see
           #   {FinchAPI::Models::Sandbox::DirectoryCreateParams::Body} for more details.
           #
@@ -249,12 +285,16 @@ module FinchAPI
           #
           #   @param gender [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Gender, nil] The gender of the individual.
           #
+          #   @param highly_compensated_employee [Boolean, nil] IRS flag indicating whether the employee is classified as a Highly Compensated E
+          #
           #   @param income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
           #
           #   @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
           #
           #   @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]
@@ -263,6 +303,8 @@ module FinchAPI
           #
           #   @param manager [FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::Manager, nil] The manager object representing the manager of the individual within the org.
           #
+          #   @param marital_status [Symbol, FinchAPI::Models::Sandbox::DirectoryCreateParams::Body::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::Sandbox::DirectoryCreateParams::Body::PhoneNumber, nil>, nil]
@@ -278,6 +320,10 @@ module FinchAPI
           #   @param start_date [String, nil]
           #
           #   @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.
 
           class CustomField < FinchAPI::Internal::Type::BaseModel
             # @!attribute name
@@ -508,6 +554,24 @@ module FinchAPI
             #   @param id [String] A stable Finch `id` (UUID v4) for an individual in the company.
           end
 
+          # The employee's marital status, used for beneficiary designation and spousal
+          # consent workflows.
+          #
+          # @see FinchAPI::Models::Sandbox::DirectoryCreateParams::Body#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/sandbox/employment_update_params.rb

@@ -69,6 +69,13 @@ module FinchAPI
         #   @return [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::FlsaStatus, nil]
         optional :flsa_status, enum: -> { FinchAPI::Sandbox::EmploymentUpdateParams::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]
+        optional :highly_compensated_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
         # @!attribute income
         #   The employee's income as reported by the provider. This may not always be
         #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
@@ -91,6 +98,13 @@ module FinchAPI
         #   @return [Boolean, nil]
         optional :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]
+        optional :key_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
         # @!attribute last_name
         #   The legal last name of the individual.
         #
@@ -136,7 +150,20 @@ module FinchAPI
         #   @return [String, nil]
         optional :title, String, nil?: true
 
-        # @!method initialize(individual_id:, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, request_options: {})
+        # @!attribute union_code
+        #   The code identifying the union the employee is a member of, as configured in the
+        #   payroll system.
+        #
+        #   @return [String, nil]
+        optional :union_code, String, nil?: true
+
+        # @!attribute union_local
+        #   The local chapter or local number within the employee's union.
+        #
+        #   @return [String, nil]
+        optional :union_local, String, nil?: true
+
+        # @!method initialize(individual_id:, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::EmploymentUpdateParams} for more details.
         #
@@ -158,12 +185,16 @@ module FinchAPI
         #
         #   @param flsa_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateParams::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 income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
         #
         #   @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
         #
         #   @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]
@@ -180,6 +211,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 request_options [FinchAPI::RequestOptions, Hash{Symbol=>Object}]
 
         class CustomField < FinchAPI::Internal::Type::BaseModel

data/lib/finch_api/models/sandbox/employment_update_response.rb

@@ -67,6 +67,13 @@ module FinchAPI
                  enum: -> { FinchAPI::Models::Sandbox::EmploymentUpdateResponse::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]
+        optional :highly_compensated_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
         # @!attribute income
         #   The employee's income as reported by the provider. This may not always be
         #   annualized income, but may be in units of bi-weekly, semi-monthly, daily, etc,
@@ -89,6 +96,13 @@ module FinchAPI
         #   @return [Boolean, nil]
         optional :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]
+        optional :key_employee, FinchAPI::Internal::Type::Boolean, nil?: true
+
         # @!attribute last_name
         #   The legal last name of the individual.
         #
@@ -134,7 +148,20 @@ module FinchAPI
         #   @return [String, nil]
         optional :title, String, nil?: true
 
-        # @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, income: nil, income_history: nil, is_active: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil)
+        # @!attribute union_code
+        #   The code identifying the union the employee is a member of, as configured in the
+        #   payroll system.
+        #
+        #   @return [String, nil]
+        optional :union_code, String, nil?: true
+
+        # @!attribute union_local
+        #   The local chapter or local number within the employee's union.
+        #
+        #   @return [String, nil]
+        optional :union_local, String, nil?: true
+
+        # @!method initialize(id: nil, class_code: nil, custom_fields: nil, department: nil, employment: nil, employment_status: nil, end_date: nil, first_name: nil, flsa_status: nil, highly_compensated_employee: nil, income: nil, income_history: nil, is_active: nil, key_employee: nil, last_name: nil, latest_rehire_date: nil, location: nil, manager: nil, middle_name: nil, source_id: nil, start_date: nil, title: nil, union_code: nil, union_local: nil)
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::EmploymentUpdateResponse} for more details.
         #
@@ -156,12 +183,16 @@ module FinchAPI
         #
         #   @param flsa_status [Symbol, FinchAPI::Models::Sandbox::EmploymentUpdateResponse::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 income [FinchAPI::Models::Income, nil] The employee's income as reported by the provider. This may not always be annual
         #
         #   @param income_history [Array<FinchAPI::Models::Income, nil>, nil] The array of income history.
         #
         #   @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]
@@ -177,6 +208,10 @@ module FinchAPI
         #   @param start_date [String, nil]
         #
         #   @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.
 
         class CustomField < FinchAPI::Internal::Type::BaseModel
           # @!attribute name

data/lib/finch_api/models/sandbox/individual_update_params.rb

@@ -57,6 +57,15 @@ module FinchAPI
         #   @return [String, nil]
         optional :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::Sandbox::IndividualUpdateParams::MaritalStatus, nil]
+        optional :marital_status,
+                 enum: -> { FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus },
+                 nil?: true
+
         # @!attribute middle_name
         #   The legal middle name of the individual.
         #
@@ -93,7 +102,7 @@ module FinchAPI
         #   @return [String, nil]
         optional :ssn, String, nil?: true
 
-        # @!method initialize(individual_id:, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil, request_options: {})
+        # @!method initialize(individual_id:, dob: nil, emails: nil, encrypted_ssn: nil, ethnicity: nil, first_name: nil, gender: nil, last_name: nil, marital_status: nil, middle_name: nil, phone_numbers: nil, preferred_name: nil, residence: nil, ssn: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::IndividualUpdateParams} for more details.
         #
@@ -113,6 +122,8 @@ module FinchAPI
         #
         #   @param last_name [String, nil] The legal last name of the individual.
         #
+        #   @param marital_status [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateParams::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::Sandbox::IndividualUpdateParams::PhoneNumber, nil>, nil]
@@ -182,6 +193,22 @@ module FinchAPI
           #   @return [Array<Symbol>]
         end
 
+        # The employee's marital status, used for beneficiary designation and spousal
+        # consent workflows.
+        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
           #