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

data/rbi/finch_api/models/sandbox/employment_update_response.rbi

@@ -105,6 +105,11 @@ module FinchAPI
         end
         attr_accessor :flsa_status
 
+        # IRS flag indicating whether the employee is classified as a Highly Compensated
+        # Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :highly_compensated_employee
+
         # 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,
         # depending on what information the provider returns.
@@ -122,6 +127,11 @@ module FinchAPI
         sig { returns(T.nilable(T::Boolean)) }
         attr_accessor :is_active
 
+        # IRS flag indicating whether the employee is classified as a Key Employee for
+        # top-heavy testing purposes. US-only.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :key_employee
+
         # The legal last name of the individual.
         sig { returns(T.nilable(String)) }
         attr_accessor :last_name
@@ -170,6 +180,15 @@ module FinchAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :title
 
+        # The code identifying the union the employee is a member of, as configured in the
+        # payroll system.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :union_code
+
+        # The local chapter or local number within the employee's union.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :union_local
+
         sig do
           params(
             id: String,
@@ -198,10 +217,12 @@ module FinchAPI
               T.nilable(
                 FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::OrSymbol
               ),
+            highly_compensated_employee: T.nilable(T::Boolean),
             income: T.nilable(FinchAPI::Income::OrHash),
             income_history:
               T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
             is_active: T.nilable(T::Boolean),
+            key_employee: T.nilable(T::Boolean),
             last_name: T.nilable(String),
             latest_rehire_date: T.nilable(String),
             location: T.nilable(FinchAPI::Location::OrHash),
@@ -212,7 +233,9 @@ module FinchAPI
             middle_name: T.nilable(String),
             source_id: T.nilable(String),
             start_date: T.nilable(String),
-            title: T.nilable(String)
+            title: T.nilable(String),
+            union_code: T.nilable(String),
+            union_local: T.nilable(String)
           ).returns(T.attached_class)
         end
         def self.new(
@@ -236,6 +259,9 @@ module FinchAPI
           # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
           # `unknown`.
           flsa_status: nil,
+          # IRS flag indicating whether the employee is classified as a Highly Compensated
+          # Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
+          highly_compensated_employee: nil,
           # 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,
           # depending on what information the provider returns.
@@ -244,6 +270,9 @@ module FinchAPI
           income_history: nil,
           # `true` if the individual an an active employee or contractor at the company.
           is_active: nil,
+          # IRS flag indicating whether the employee is classified as a Key Employee for
+          # top-heavy testing purposes. US-only.
+          key_employee: nil,
           # The legal last name of the individual.
           last_name: nil,
           latest_rehire_date: nil,
@@ -256,7 +285,12 @@ module FinchAPI
           source_id: nil,
           start_date: nil,
           # The current title of the individual.
-          title: nil
+          title: nil,
+          # The code identifying the union the employee is a member of, as configured in the
+          # payroll system.
+          union_code: nil,
+          # The local chapter or local number within the employee's union.
+          union_local: nil
         )
         end
 
@@ -289,9 +323,11 @@ module FinchAPI
                 T.nilable(
                   FinchAPI::Models::Sandbox::EmploymentUpdateResponse::FlsaStatus::TaggedSymbol
                 ),
+              highly_compensated_employee: T.nilable(T::Boolean),
               income: T.nilable(FinchAPI::Income),
               income_history: T.nilable(T::Array[T.nilable(FinchAPI::Income)]),
               is_active: T.nilable(T::Boolean),
+              key_employee: T.nilable(T::Boolean),
               last_name: T.nilable(String),
               latest_rehire_date: T.nilable(String),
               location: T.nilable(FinchAPI::Location),
@@ -302,7 +338,9 @@ module FinchAPI
               middle_name: T.nilable(String),
               source_id: T.nilable(String),
               start_date: T.nilable(String),
-              title: T.nilable(String)
+              title: T.nilable(String),
+              union_code: T.nilable(String),
+              union_local: T.nilable(String)
             }
           )
         end

data/rbi/finch_api/models/sandbox/individual_update_params.rbi

@@ -64,6 +64,17 @@ module FinchAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :last_name
 
+        # The employee's marital status, used for beneficiary designation and spousal
+        # consent workflows.
+        sig do
+          returns(
+            T.nilable(
+              FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::OrSymbol
+            )
+          )
+        end
+        attr_accessor :marital_status
+
         # The legal middle name of the individual.
         sig { returns(T.nilable(String)) }
         attr_accessor :middle_name
@@ -119,6 +130,10 @@ module FinchAPI
                 FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol
               ),
             last_name: T.nilable(String),
+            marital_status:
+              T.nilable(
+                FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::OrSymbol
+              ),
             middle_name: T.nilable(String),
             phone_numbers:
               T.nilable(
@@ -150,6 +165,9 @@ module FinchAPI
           gender: nil,
           # The legal last name of the individual.
           last_name: nil,
+          # The employee's marital status, used for beneficiary designation and spousal
+          # consent workflows.
+          marital_status: nil,
           # The legal middle name of the individual.
           middle_name: nil,
           phone_numbers: nil,
@@ -185,6 +203,10 @@ module FinchAPI
                   FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol
                 ),
               last_name: T.nilable(String),
+              marital_status:
+                T.nilable(
+                  FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::OrSymbol
+                ),
               middle_name: T.nilable(String),
               phone_numbers:
                 T.nilable(
@@ -396,6 +418,62 @@ module FinchAPI
           end
         end
 
+        # The employee's marital status, used for beneficiary designation and spousal
+        # consent workflows.
+        module MaritalStatus
+          extend FinchAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SINGLE =
+            T.let(
+              :single,
+              FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::TaggedSymbol
+            )
+          MARRIED =
+            T.let(
+              :married,
+              FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::TaggedSymbol
+            )
+          DIVORCED =
+            T.let(
+              :divorced,
+              FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::TaggedSymbol
+            )
+          WIDOWED =
+            T.let(
+              :widowed,
+              FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::TaggedSymbol
+            )
+          DOMESTIC_PARTNER =
+            T.let(
+              :domestic_partner,
+              FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::TaggedSymbol
+            )
+          UNKNOWN =
+            T.let(
+              :unknown,
+              FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class PhoneNumber < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/finch_api/models/sandbox/individual_update_response.rbi

@@ -67,6 +67,17 @@ module FinchAPI
         sig { returns(T.nilable(String)) }
         attr_accessor :last_name
 
+        # The employee's marital status, used for beneficiary designation and spousal
+        # consent workflows.
+        sig do
+          returns(
+            T.nilable(
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+            )
+          )
+        end
+        attr_accessor :marital_status
+
         # The legal middle name of the individual.
         sig { returns(T.nilable(String)) }
         attr_accessor :middle_name
@@ -122,6 +133,10 @@ module FinchAPI
                 FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::OrSymbol
               ),
             last_name: T.nilable(String),
+            marital_status:
+              T.nilable(
+                FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::OrSymbol
+              ),
             middle_name: T.nilable(String),
             phone_numbers:
               T.nilable(
@@ -153,6 +168,9 @@ module FinchAPI
           gender: nil,
           # The legal last name of the individual.
           last_name: nil,
+          # The employee's marital status, used for beneficiary designation and spousal
+          # consent workflows.
+          marital_status: nil,
           # The legal middle name of the individual.
           middle_name: nil,
           phone_numbers: nil,
@@ -189,6 +207,10 @@ module FinchAPI
                   FinchAPI::Models::Sandbox::IndividualUpdateResponse::Gender::TaggedSymbol
                 ),
               last_name: T.nilable(String),
+              marital_status:
+                T.nilable(
+                  FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+                ),
               middle_name: T.nilable(String),
               phone_numbers:
                 T.nilable(
@@ -402,6 +424,62 @@ module FinchAPI
           end
         end
 
+        # The employee's marital status, used for beneficiary designation and spousal
+        # consent workflows.
+        module MaritalStatus
+          extend FinchAPI::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          SINGLE =
+            T.let(
+              :single,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+            )
+          MARRIED =
+            T.let(
+              :married,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+            )
+          DIVORCED =
+            T.let(
+              :divorced,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+            )
+          WIDOWED =
+            T.let(
+              :widowed,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+            )
+          DOMESTIC_PARTNER =
+            T.let(
+              :domestic_partner,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+            )
+          UNKNOWN =
+            T.let(
+              :unknown,
+              FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                FinchAPI::Models::Sandbox::IndividualUpdateResponse::MaritalStatus::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
         class PhoneNumber < FinchAPI::Internal::Type::BaseModel
           OrHash =
             T.type_alias do

data/rbi/finch_api/resources/sandbox/employment.rbi

@@ -33,10 +33,12 @@ module FinchAPI
               T.nilable(
                 FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::OrSymbol
               ),
+            highly_compensated_employee: T.nilable(T::Boolean),
             income: T.nilable(FinchAPI::Income::OrHash),
             income_history:
               T.nilable(T::Array[T.nilable(FinchAPI::Income::OrHash)]),
             is_active: T.nilable(T::Boolean),
+            key_employee: T.nilable(T::Boolean),
             last_name: T.nilable(String),
             latest_rehire_date: T.nilable(String),
             location: T.nilable(FinchAPI::Location::OrHash),
@@ -48,6 +50,8 @@ module FinchAPI
             source_id: T.nilable(String),
             start_date: T.nilable(String),
             title: T.nilable(String),
+            union_code: T.nilable(String),
+            union_local: T.nilable(String),
             request_options: FinchAPI::RequestOptions::OrHash
           ).returns(FinchAPI::Models::Sandbox::EmploymentUpdateResponse)
         end
@@ -71,6 +75,9 @@ module FinchAPI
           # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
           # `unknown`.
           flsa_status: nil,
+          # IRS flag indicating whether the employee is classified as a Highly Compensated
+          # Employee for nondiscrimination testing purposes (ADP/ACP tests). US-only.
+          highly_compensated_employee: nil,
           # 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,
           # depending on what information the provider returns.
@@ -79,6 +86,9 @@ module FinchAPI
           income_history: nil,
           # `true` if the individual an an active employee or contractor at the company.
           is_active: nil,
+          # IRS flag indicating whether the employee is classified as a Key Employee for
+          # top-heavy testing purposes. US-only.
+          key_employee: nil,
           # The legal last name of the individual.
           last_name: nil,
           latest_rehire_date: nil,
@@ -92,6 +102,11 @@ module FinchAPI
           start_date: nil,
           # The current title of the individual.
           title: nil,
+          # The code identifying the union the employee is a member of, as configured in the
+          # payroll system.
+          union_code: nil,
+          # The local chapter or local number within the employee's union.
+          union_local: nil,
           request_options: {}
         )
         end

data/rbi/finch_api/resources/sandbox/individual.rbi

@@ -26,6 +26,10 @@ module FinchAPI
                 FinchAPI::Sandbox::IndividualUpdateParams::Gender::OrSymbol
               ),
             last_name: T.nilable(String),
+            marital_status:
+              T.nilable(
+                FinchAPI::Sandbox::IndividualUpdateParams::MaritalStatus::OrSymbol
+              ),
             middle_name: T.nilable(String),
             phone_numbers:
               T.nilable(
@@ -57,6 +61,9 @@ module FinchAPI
           gender: nil,
           # The legal last name of the individual.
           last_name: nil,
+          # The employee's marital status, used for beneficiary designation and spousal
+          # consent workflows.
+          marital_status: nil,
           # The legal middle name of the individual.
           middle_name: nil,
           phone_numbers: nil,

data/sig/finch_api/models/connect/session_new_params.rbs

@@ -73,6 +73,9 @@ module FinchAPI
           | :individual
           | :payment
           | :pay_statement
+          | :plans
+          | :plans_dependents
+          | :plans_enrollments
           | :recordkeeping
           | :ssn
 
@@ -88,6 +91,9 @@ module FinchAPI
           INDIVIDUAL: :individual
           PAYMENT: :payment
           PAY_STATEMENT: :pay_statement
+          PLANS: :plans
+          PLANS_DEPENDENTS: :plans_dependents
+          PLANS_ENROLLMENTS: :plans_enrollments
           RECORDKEEPING: :recordkeeping
           SSN: :ssn
 

data/sig/finch_api/models/connect/session_reauthenticate_params.rbs

@@ -50,6 +50,9 @@ module FinchAPI
           | :individual
           | :payment
           | :pay_statement
+          | :plans
+          | :plans_dependents
+          | :plans_enrollments
           | :recordkeeping
           | :ssn
 
@@ -65,6 +68,9 @@ module FinchAPI
           INDIVIDUAL: :individual
           PAYMENT: :payment
           PAY_STATEMENT: :pay_statement
+          PLANS: :plans
+          PLANS_DEPENDENTS: :plans_dependents
+          PLANS_ENROLLMENTS: :plans_enrollments
           RECORDKEEPING: :recordkeeping
           SSN: :ssn
 

data/sig/finch_api/models/hris/employment_data.rbs

@@ -18,7 +18,9 @@ module FinchAPI
             end_date: String?,
             first_name: String?,
             flsa_status: FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::flsa_status?,
+            highly_compensated_employee: bool?,
             is_active: bool?,
+            key_employee: bool?,
             last_name: String?,
             latest_rehire_date: String?,
             location: FinchAPI::Location?,
@@ -26,6 +28,8 @@ module FinchAPI
             middle_name: String?,
             start_date: String?,
             title: String?,
+            union_code: String?,
+            union_local: String?,
             custom_fields: ::Array[FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField]?,
             income: FinchAPI::Income?,
             income_history: ::Array[FinchAPI::Income?]?,
@@ -50,8 +54,12 @@ module FinchAPI
 
           attr_accessor flsa_status: FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::flsa_status?
 
+          attr_accessor highly_compensated_employee: bool?
+
           attr_accessor is_active: bool?
 
+          attr_accessor key_employee: bool?
+
           attr_accessor last_name: String?
 
           attr_accessor latest_rehire_date: String?
@@ -66,6 +74,10 @@ module FinchAPI
 
           attr_accessor title: String?
 
+          attr_accessor union_code: String?
+
+          attr_accessor union_local: String?
+
           attr_accessor custom_fields: ::Array[FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField]?
 
           attr_accessor income: FinchAPI::Income?
@@ -85,7 +97,9 @@ module FinchAPI
             end_date: String?,
             first_name: String?,
             flsa_status: FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::flsa_status?,
+            highly_compensated_employee: bool?,
             is_active: bool?,
+            key_employee: bool?,
             last_name: String?,
             latest_rehire_date: String?,
             location: FinchAPI::Location?,
@@ -93,6 +107,8 @@ module FinchAPI
             middle_name: String?,
             start_date: String?,
             title: String?,
+            union_code: String?,
+            union_local: String?,
             ?custom_fields: ::Array[FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField]?,
             ?income: FinchAPI::Income?,
             ?income_history: ::Array[FinchAPI::Income?]?,
@@ -109,7 +125,9 @@ module FinchAPI
             end_date: String?,
             first_name: String?,
             flsa_status: FinchAPI::Models::HRIS::EmploymentData::EmploymentDataResponseBody::flsa_status?,
+            highly_compensated_employee: bool?,
             is_active: bool?,
+            key_employee: bool?,
             last_name: String?,
             latest_rehire_date: String?,
             location: FinchAPI::Location?,
@@ -117,6 +135,8 @@ module FinchAPI
             middle_name: String?,
             start_date: String?,
             title: String?,
+            union_code: String?,
+            union_local: String?,
             custom_fields: ::Array[FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::CustomField]?,
             income: FinchAPI::Income?,
             income_history: ::Array[FinchAPI::Income?]?,

data/sig/finch_api/models/hris/individual.rbs

@@ -16,6 +16,7 @@ module FinchAPI
             first_name: String?,
             gender: FinchAPI::Models::HRIS::Individual::IndividualResponseBody::gender?,
             last_name: String?,
+            marital_status: FinchAPI::Models::HRIS::Individual::IndividualResponseBody::marital_status?,
             middle_name: String?,
             phone_numbers: ::Array[FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber?]?,
             preferred_name: String?,
@@ -38,6 +39,8 @@ module FinchAPI
 
           attr_accessor last_name: String?
 
+          attr_accessor marital_status: FinchAPI::Models::HRIS::Individual::IndividualResponseBody::marital_status?
+
           attr_accessor middle_name: String?
 
           attr_accessor phone_numbers: ::Array[FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber?]?
@@ -59,6 +62,7 @@ module FinchAPI
             first_name: String?,
             gender: FinchAPI::Models::HRIS::Individual::IndividualResponseBody::gender?,
             last_name: String?,
+            marital_status: FinchAPI::Models::HRIS::Individual::IndividualResponseBody::marital_status?,
             middle_name: String?,
             phone_numbers: ::Array[FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber?]?,
             preferred_name: String?,
@@ -75,6 +79,7 @@ module FinchAPI
             first_name: String?,
             gender: FinchAPI::Models::HRIS::Individual::IndividualResponseBody::gender?,
             last_name: String?,
+            marital_status: FinchAPI::Models::HRIS::Individual::IndividualResponseBody::marital_status?,
             middle_name: String?,
             phone_numbers: ::Array[FinchAPI::HRIS::Individual::IndividualResponseBody::PhoneNumber?]?,
             preferred_name: String?,
@@ -122,6 +127,27 @@ module FinchAPI
             def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::IndividualResponseBody::gender]
           end
 
+          type marital_status =
+            :single
+            | :married
+            | :divorced
+            | :widowed
+            | :domestic_partner
+            | :unknown
+
+          module MaritalStatus
+            extend FinchAPI::Internal::Type::Enum
+
+            SINGLE: :single
+            MARRIED: :married
+            DIVORCED: :divorced
+            WIDOWED: :widowed
+            DOMESTIC_PARTNER: :domestic_partner
+            UNKNOWN: :unknown
+
+            def self?.values: -> ::Array[FinchAPI::Models::HRIS::Individual::IndividualResponseBody::marital_status]
+          end
+
           type phone_number =
             {
               data: String?,