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

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/hris/benefits/individuals.rbi

@@ -25,7 +25,8 @@ module FinchAPI
           def enroll_many(
             # Path param
             benefit_id,
-            # Query param: The entity IDs to specify which entities' data to access.
+            # Query param: 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,
             # Body param: Array of the individual_id to enroll and a configuration object.
             individuals: nil,
@@ -45,7 +46,8 @@ module FinchAPI
           end
           def enrolled_ids(
             benefit_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: {}
           )
@@ -66,7 +68,8 @@ module FinchAPI
           end
           def retrieve_many_benefits(
             benefit_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,
             # comma-delimited list of stable Finch uuids for each individual. If empty,
             # defaults to all individuals
@@ -89,7 +92,8 @@ module FinchAPI
           def unenroll_many(
             # Path param
             benefit_id,
-            # Query param: The entity IDs to specify which entities' data to access.
+            # Query param: 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,
             # Body param: Array of individual_ids to unenroll.
             individual_ids: nil,

data/rbi/finch_api/resources/hris/benefits.rbi

@@ -23,7 +23,8 @@ module FinchAPI
           ).returns(FinchAPI::HRIS::CreateCompanyBenefitsResponse)
         end
         def create(
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: 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,
           # Body param: The company match for this benefit.
           company_contribution: nil,
@@ -49,7 +50,8 @@ module FinchAPI
         end
         def retrieve(
           benefit_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: {}
         )
@@ -67,7 +69,8 @@ module FinchAPI
         def update(
           # Path param
           benefit_id,
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: 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,
           # Body param: Updated name or description.
           description: nil,
@@ -85,7 +88,8 @@ module FinchAPI
           )
         end
         def list(
-          # 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: {}
         )
@@ -101,7 +105,8 @@ module FinchAPI
           )
         end
         def list_supported_benefits(
-          # 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: {}
         )
@@ -119,7 +124,8 @@ module FinchAPI
           ).returns(FinchAPI::HRIS::RegisterCompanyBenefitResponse)
         end
         def register(
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: 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,
           # Body param
           description: nil,

data/rbi/finch_api/resources/hris/company.rbi

@@ -12,7 +12,8 @@ module FinchAPI
           ).returns(FinchAPI::HRIS::HRISCompany)
         end
         def retrieve(
-          # 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/resources/hris/directory.rbi

@@ -18,7 +18,8 @@ module FinchAPI
           )
         end
         def list(
-          # 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,
           # Number of employees to return (defaults to 100, maximum 10000)
           limit: nil,

data/rbi/finch_api/resources/hris/documents.rbi

@@ -17,7 +17,8 @@ module FinchAPI
           ).returns(FinchAPI::Models::HRIS::DocumentListResponse)
         end
         def list(
-          # 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,
           # Comma-delimited list of stable Finch uuids for each individual. If empty,
           # defaults to all individuals
@@ -45,7 +46,8 @@ module FinchAPI
         def retreive(
           # The unique identifier of the document.
           document_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/resources/hris/employments.rbi

@@ -22,7 +22,8 @@ module FinchAPI
         def retrieve_many(
           # Body param: The array of batch requests. Maximum 10000 items per request.
           requests:,
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: 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/resources/hris/individuals.rbi

@@ -26,7 +26,8 @@ module FinchAPI
         def retrieve_many(
           # Body param: The array of batch requests. Maximum 10000 items per request.
           requests:,
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: 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,
           # Body param
           options: nil,

data/rbi/finch_api/resources/hris/pay_statement_item/rules.rbi

@@ -28,7 +28,8 @@ module FinchAPI
             )
           end
           def create(
-            # Query param: The entity IDs to create the rule for.
+            # Query param: The entity IDs to create the rule for. Provide exactly one entity
+            # ID per request; a maximum of one is accepted.
             entity_ids: nil,
             # Body param: Specifies the fields to be applied when the condition is met.
             attributes: nil,
@@ -59,7 +60,8 @@ module FinchAPI
           def update(
             # Path param
             rule_id,
-            # Query param: The entity IDs to update the rule for.
+            # Query param: The entity IDs to update the rule for. Provide exactly one entity
+            # ID per request; a maximum of one is accepted.
             entity_ids: nil,
             # Body param
             optional_property: nil,
@@ -79,7 +81,8 @@ module FinchAPI
             )
           end
           def list(
-            # The entity IDs to retrieve rules for.
+            # The entity IDs to retrieve rules for. Provide exactly one entity ID per request;
+            # a maximum of one is accepted.
             entity_ids: nil,
             request_options: {}
           )
@@ -97,7 +100,8 @@ module FinchAPI
           end
           def delete(
             rule_id,
-            # The entity IDs to delete the rule for.
+            # The entity IDs to delete the rule for. Provide exactly one entity ID per
+            # request; a maximum of one is accepted.
             entity_ids: nil,
             request_options: {}
           )

data/rbi/finch_api/resources/hris/pay_statement_item.rbi

@@ -34,7 +34,8 @@ module FinchAPI
           # The end date to retrieve pay statement items by via their last seen pay date in
           # `YYYY-MM-DD` format.
           end_date: nil,
-          # 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,
           # Case-insensitive partial match search by pay statement item name.
           name: nil,

data/rbi/finch_api/resources/hris/pay_statements.rbi

@@ -25,7 +25,8 @@ module FinchAPI
         def retrieve_many(
           # Body param: The array of batch requests. Maximum 10 payment_ids per request.
           requests:,
-          # Query param: The entity IDs to specify which entities' data to access.
+          # Query param: 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/resources/hris/payments.rbi

@@ -20,7 +20,8 @@ module FinchAPI
           # The start date to retrieve payments by a company (inclusive) in `YYYY-MM-DD`
           # format. Filters payments by their **pay_date** field.
           start_date:,
-          # 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/resources/payroll/pay_groups.rbi

@@ -14,7 +14,8 @@ module FinchAPI
         end
         def retrieve(
           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: {}
         )
@@ -34,7 +35,8 @@ module FinchAPI
           )
         end
         def list(
-          # 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,
           individual_id: nil,
           pay_frequencies: nil,

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/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?,