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

data/rbi/finch_api/models/payroll/pay_group_retrieve_params.rbi

@@ -18,7 +18,8 @@ module FinchAPI
         sig { returns(String) }
         attr_accessor :pay_group_id
 
-        # 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.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :entity_ids
 
@@ -34,7 +35,8 @@ module FinchAPI
         end
         def self.new(
           pay_group_id:,
-          # 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.
           entity_ids: nil,
           request_options: {}
         )

data/rbi/finch_api/models/sandbox/connection_create_response.rbi

@@ -26,7 +26,7 @@ module FinchAPI
         end
         attr_accessor :authentication_type
 
-        # [DEPRECATED] Use `connection_id` to associate a connection with an access token
+        # The Finch UUID of the company associated with the `access_token`.
         sig { returns(String) }
         attr_accessor :company_id
 
@@ -70,7 +70,7 @@ module FinchAPI
           # [DEPRECATED] Use `connection_id` to associate a connection with an access token
           account_id:,
           authentication_type:,
-          # [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          # The Finch UUID of the company associated with the `access_token`.
           company_id:,
           # The ID of the new connection
           connection_id:,

data/rbi/finch_api/models/sandbox/connections/account_create_response.rbi

@@ -27,7 +27,7 @@ module FinchAPI
           end
           attr_accessor :authentication_type
 
-          # [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          # The Finch UUID of the company associated with the `access_token`.
           sig { returns(String) }
           attr_accessor :company_id
 
@@ -64,7 +64,7 @@ module FinchAPI
             # [DEPRECATED] Use `connection_id` to associate a connection with an access token
             account_id:,
             authentication_type:,
-            # [DEPRECATED] Use `connection_id` to associate a connection with an access token
+            # The Finch UUID of the company associated with the `access_token`.
             company_id:,
             # The ID of the new connection
             connection_id:,

data/rbi/finch_api/models/sandbox/connections/account_update_response.rbi

@@ -24,7 +24,7 @@ module FinchAPI
           end
           attr_accessor :authentication_type
 
-          # [DEPRECATED] Use `connection_id` to associate a connection with an access token
+          # The Finch UUID of the company associated with the `access_token`.
           sig { returns(String) }
           attr_accessor :company_id
 
@@ -59,7 +59,7 @@ module FinchAPI
             # [DEPRECATED] Use `connection_id` to associate a connection with an access token
             account_id:,
             authentication_type:,
-            # [DEPRECATED] Use `connection_id` to associate a connection with an access token
+            # The Finch UUID of the company associated with the `access_token`.
             company_id:,
             # The ID of the new connection
             connection_id:,

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
             }
           )

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