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

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.51"
 end

data/rbi/finch_api/models/connect/session_new_params.rbi

@@ -199,6 +199,21 @@ module FinchAPI
               :pay_statement,
               FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
             )
+          PLANS =
+            T.let(
+              :plans,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          PLANS_DEPENDENTS =
+            T.let(
+              :plans_dependents,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
+          PLANS_ENROLLMENTS =
+            T.let(
+              :plans_enrollments,
+              FinchAPI::Connect::SessionNewParams::Product::TaggedSymbol
+            )
           RECORDKEEPING =
             T.let(
               :recordkeeping,

data/rbi/finch_api/models/connect/session_reauthenticate_params.rbi

@@ -151,6 +151,21 @@ module FinchAPI
               :pay_statement,
               FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
             )
+          PLANS =
+            T.let(
+              :plans,
+              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
+            )
+          PLANS_DEPENDENTS =
+            T.let(
+              :plans_dependents,
+              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
+            )
+          PLANS_ENROLLMENTS =
+            T.let(
+              :plans_enrollments,
+              FinchAPI::Connect::SessionReauthenticateParams::Product::TaggedSymbol
+            )
           RECORDKEEPING =
             T.let(
               :recordkeeping,

data/rbi/finch_api/models/hris/employment_data.rbi

@@ -99,10 +99,20 @@ 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
+
           # `true` if the individual an an active employee or contractor at the company.
           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
@@ -147,6 +157,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
+
           # 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
           # connections.
@@ -204,7 +223,9 @@ module FinchAPI
                 T.nilable(
                   FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus::OrSymbol
                 ),
+              highly_compensated_employee: T.nilable(T::Boolean),
               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),
@@ -215,6 +236,8 @@ module FinchAPI
               middle_name: T.nilable(String),
               start_date: T.nilable(String),
               title: T.nilable(String),
+              union_code: T.nilable(String),
+              union_local: T.nilable(String),
               custom_fields:
                 T.nilable(
                   T::Array[
@@ -245,8 +268,14 @@ module FinchAPI
             # The FLSA status of the individual. Available options: `exempt`, `non_exempt`,
             # `unknown`.
             flsa_status:,
+            # 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:,
             # `true` if the individual an an active employee or contractor at the company.
             is_active:,
+            # IRS flag indicating whether the employee is classified as a Key Employee for
+            # top-heavy testing purposes. US-only.
+            key_employee:,
             # The legal last name of the individual.
             last_name:,
             latest_rehire_date:,
@@ -258,6 +287,11 @@ module FinchAPI
             start_date:,
             # The current title of the individual.
             title:,
+            # The code identifying the union the employee is a member of, as configured in the
+            # payroll system.
+            union_code:,
+            # The local chapter or local number within the employee's union.
+            union_local:,
             # 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
             # connections.
@@ -298,7 +332,9 @@ module FinchAPI
                   T.nilable(
                     FinchAPI::HRIS::EmploymentData::EmploymentDataResponseBody::FlsaStatus::TaggedSymbol
                   ),
+                highly_compensated_employee: T.nilable(T::Boolean),
                 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),
@@ -309,6 +345,8 @@ module FinchAPI
                 middle_name: T.nilable(String),
                 start_date: T.nilable(String),
                 title: T.nilable(String),
+                union_code: T.nilable(String),
+                union_local: T.nilable(String),
                 custom_fields:
                   T.nilable(
                     T::Array[

data/rbi/finch_api/models/hris/individual.rbi

@@ -58,6 +58,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::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :marital_status
+
           # The legal middle name of the individual.
           sig { returns(T.nilable(String)) }
           attr_accessor :middle_name
@@ -123,6 +134,10 @@ module FinchAPI
                   FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::OrSymbol
                 ),
               last_name: T.nilable(String),
+              marital_status:
+                T.nilable(
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::OrSymbol
+                ),
               middle_name: T.nilable(String),
               phone_numbers:
                 T.nilable(
@@ -156,6 +171,9 @@ module FinchAPI
             gender:,
             # The legal last name of the individual.
             last_name:,
+            # The employee's marital status, used for beneficiary designation and spousal
+            # consent workflows.
+            marital_status:,
             # The legal middle name of the individual.
             middle_name:,
             phone_numbers:,
@@ -190,6 +208,10 @@ module FinchAPI
                     FinchAPI::HRIS::Individual::IndividualResponseBody::Gender::TaggedSymbol
                   ),
                 last_name: T.nilable(String),
+                marital_status:
+                  T.nilable(
+                    FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+                  ),
                 middle_name: T.nilable(String),
                 phone_numbers:
                   T.nilable(
@@ -325,6 +347,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::HRIS::Individual::IndividualResponseBody::MaritalStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SINGLE =
+              T.let(
+                :single,
+                FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+              )
+            MARRIED =
+              T.let(
+                :married,
+                FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+              )
+            DIVORCED =
+              T.let(
+                :divorced,
+                FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+              )
+            WIDOWED =
+              T.let(
+                :widowed,
+                FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+              )
+            DOMESTIC_PARTNER =
+              T.let(
+                :domestic_partner,
+                FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+              )
+            UNKNOWN =
+              T.let(
+                :unknown,
+                FinchAPI::HRIS::Individual::IndividualResponseBody::MaritalStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::HRIS::Individual::IndividualResponseBody::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/directory_create_params.rbi

@@ -191,6 +191,11 @@ module FinchAPI
           end
           attr_accessor :gender
 
+          # 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.
@@ -208,6 +213,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
@@ -239,6 +249,17 @@ module FinchAPI
           end
           attr_writer :manager
 
+          # The employee's marital status, used for beneficiary designation and spousal
+          # consent workflows.
+          sig do
+            returns(
+              T.nilable(
+                FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::OrSymbol
+              )
+            )
+          end
+          attr_accessor :marital_status
+
           # The legal middle name of the individual.
           sig { returns(T.nilable(String)) }
           attr_accessor :middle_name
@@ -284,6 +305,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(
               class_code: T.nilable(String),
@@ -327,10 +357,12 @@ module FinchAPI
                 T.nilable(
                   FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::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),
@@ -338,6 +370,10 @@ module FinchAPI
                 T.nilable(
                   FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager::OrHash
                 ),
+              marital_status:
+                T.nilable(
+                  FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::OrSymbol
+                ),
               middle_name: T.nilable(String),
               phone_numbers:
                 T.nilable(
@@ -352,7 +388,9 @@ module FinchAPI
               source_id: T.nilable(String),
               ssn: 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(
@@ -384,6 +422,9 @@ module FinchAPI
             flsa_status: nil,
             # The gender of the individual.
             gender: 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.
@@ -392,12 +433,18 @@ 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,
             location: nil,
             # The manager object representing the manager of the individual within the org.
             manager: 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,
@@ -413,7 +460,12 @@ module FinchAPI
             ssn: 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
 
@@ -461,10 +513,12 @@ module FinchAPI
                   T.nilable(
                     FinchAPI::Sandbox::DirectoryCreateParams::Body::Gender::OrSymbol
                   ),
+                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),
@@ -472,6 +526,10 @@ module FinchAPI
                   T.nilable(
                     FinchAPI::Sandbox::DirectoryCreateParams::Body::Manager
                   ),
+                marital_status:
+                  T.nilable(
+                    FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::OrSymbol
+                  ),
                 middle_name: T.nilable(String),
                 phone_numbers:
                   T.nilable(
@@ -486,7 +544,9 @@ module FinchAPI
                 source_id: T.nilable(String),
                 ssn: 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
@@ -1088,6 +1148,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::DirectoryCreateParams::Body::MaritalStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SINGLE =
+              T.let(
+                :single,
+                FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::TaggedSymbol
+              )
+            MARRIED =
+              T.let(
+                :married,
+                FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::TaggedSymbol
+              )
+            DIVORCED =
+              T.let(
+                :divorced,
+                FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::TaggedSymbol
+              )
+            WIDOWED =
+              T.let(
+                :widowed,
+                FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::TaggedSymbol
+              )
+            DOMESTIC_PARTNER =
+              T.let(
+                :domestic_partner,
+                FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::TaggedSymbol
+              )
+            UNKNOWN =
+              T.let(
+                :unknown,
+                FinchAPI::Sandbox::DirectoryCreateParams::Body::MaritalStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  FinchAPI::Sandbox::DirectoryCreateParams::Body::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/employment_update_params.rbi

@@ -98,6 +98,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.
@@ -115,6 +120,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
@@ -159,6 +169,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(
             individual_id: String,
@@ -187,10 +206,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),
@@ -202,6 +223,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(T.attached_class)
         end
@@ -225,6 +248,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.
@@ -233,6 +259,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,
@@ -246,6 +275,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
@@ -279,9 +313,11 @@ module FinchAPI
                 T.nilable(
                   FinchAPI::Sandbox::EmploymentUpdateParams::FlsaStatus::OrSymbol
                 ),
+              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),
@@ -291,6 +327,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
             }
           )