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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e808c0bba7f22123fbcea95871a5b0a7d0149de1e6c3e63b30cb30406088684
-  data.tar.gz: bffa0baac1966f4b99a88e6fdfc8aefadc7b342109c70224821216721724a171
+  metadata.gz: 0baa06f8bc674518d4abf5fb86c2232ac10c6c709b082d783c3e15e41e09c55d
+  data.tar.gz: 7f59c107245deea6024b07c5c1ce7d35a0f81c98ce96b3e328dfdc2220e08cac
 SHA512:
-  metadata.gz: c4900f43c809f22998d056aafce9a7b8563685df7bb302f2012eca4163ffaab3112285886f47765e754fd36237f63766e504c716e28d9924f3507f56e7337073
-  data.tar.gz: ec75b28b2b7d2ddcfe2c2b96d8fa33f77dd9cecd1c22c26a43c3b470b495abcab7b8120840222e7d6bde62f1db974e0e0851592f2f5b8d4447180e25191096d7
+  metadata.gz: b791e603219364089fe168d43dad39b8755a0c1e6196ebcbbc0f0edf8a5c7f72fb33a6730b0477a4269ca9c6d74f3db0f06eb28148b02d8a4604416cbcd4a923
+  data.tar.gz: b406e67732f8cda1d32056a5619b562d94d2dbebf02b3c5873d51bcc0beaf830487b60f8c50db5e1326072a685dacf0929600985fde9d87c219cf487098ee9ec

data/CHANGELOG.md

@@ -1,5 +1,14 @@
 # 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)

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

data/lib/finch_api/models/sandbox/individual_update_response.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::IndividualUpdateResponse::MaritalStatus, nil]
+        optional :marital_status,
+                 enum: -> { FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus },
+                 nil?: true
+
         # @!attribute middle_name
         #   The legal middle name of the individual.
         #
@@ -90,7 +99,7 @@ module FinchAPI
         #   @return [String, nil]
         optional :ssn, String, nil?: true
 
-        # @!method initialize(id: nil, 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)
+        # @!method initialize(id: nil, 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)
         #   Some parameter documentations has been truncated, see
         #   {FinchAPI::Models::Sandbox::IndividualUpdateResponse} for more details.
         #
@@ -110,6 +119,8 @@ module FinchAPI
         #
         #   @param last_name [String, nil] The legal last name of the individual.
         #
+        #   @param marital_status [Symbol, FinchAPI::Models::Sandbox::IndividualUpdateResponse::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::IndividualUpdateResponse::PhoneNumber, nil>, nil]
@@ -181,6 +192,24 @@ module FinchAPI
           #   @return [Array<Symbol>]
         end
 
+        # The employee's marital status, used for beneficiary designation and spousal
+        # consent workflows.
+        #
+        # @see FinchAPI::Models::Sandbox::IndividualUpdateResponse#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/resources/sandbox/employment.rb

@@ -9,7 +9,7 @@ module FinchAPI
         #
         # Update sandbox employment
         #
-        # @overload update(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: {})
+        # @overload update(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: {})
         #
         # @param individual_id [String]
         #
@@ -29,12 +29,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]
@@ -51,6 +55,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}, nil]
         #
         # @return [FinchAPI::Models::Sandbox::EmploymentUpdateResponse]

data/lib/finch_api/resources/sandbox/individual.rb

@@ -9,7 +9,7 @@ module FinchAPI
         #
         # Update sandbox individual
         #
-        # @overload update(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: {})
+        # @overload update(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: {})
         #
         # @param individual_id [String]
         #
@@ -27,6 +27,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]

data/lib/finch_api/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module FinchAPI
-  VERSION = "0.1.0.pre.alpha.49"
+  VERSION = "0.1.0.pre.alpha.50"
 end