import { APIResource } from "../../core/resource.js"; import * as HRISAPI from "../hris/hris.js"; import { APIPromise } from "../../core/api-promise.js"; import { RequestOptions } from "../../internal/request-options.js"; export declare class Individual extends APIResource { /** * Update sandbox individual * * @example * ```ts * const individual = await client.sandbox.individual.update( * 'individual_id', * ); * ``` */ update(individualID: string, body?: IndividualUpdateParams | null | undefined, options?: RequestOptions): APIPromise; } export interface IndividualUpdateResponse { /** * A stable Finch `id` (UUID v4) for an individual in the company. */ id?: string; dob?: string | null; emails?: Array | null; /** * Social Security Number of the individual in **encrypted** format. This field is * only available with the `ssn` scope enabled and the * `options: { include: ['ssn'] }` param set in the body. */ encrypted_ssn?: string | null; /** * The EEOC-defined ethnicity of the individual. */ ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; /** * The legal first name of the individual. */ first_name?: string | null; /** * The gender of the individual. */ gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null; /** * The legal last name of the individual. */ last_name?: string | null; /** * The legal middle name of the individual. */ middle_name?: string | null; phone_numbers?: Array | null; /** * The preferred name of the individual. */ preferred_name?: string | null; residence?: HRISAPI.Location | null; /** * Social Security Number of the individual. This field is only available with the * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the * body. * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). */ ssn?: string | null; } export declare namespace IndividualUpdateResponse { interface Email { data?: string; type?: 'work' | 'personal' | null; } interface PhoneNumber { data?: string | null; type?: 'work' | 'personal' | null; } } export interface IndividualUpdateParams { dob?: string | null; emails?: Array | null; /** * Social Security Number of the individual in **encrypted** format. This field is * only available with the `ssn` scope enabled and the * `options: { include: ['ssn'] }` param set in the body. */ encrypted_ssn?: string | null; /** * The EEOC-defined ethnicity of the individual. */ ethnicity?: 'asian' | 'white' | 'black_or_african_american' | 'native_hawaiian_or_pacific_islander' | 'american_indian_or_alaska_native' | 'hispanic_or_latino' | 'two_or_more_races' | 'decline_to_specify' | null; /** * The legal first name of the individual. */ first_name?: string | null; /** * The gender of the individual. */ gender?: 'female' | 'male' | 'other' | 'decline_to_specify' | null; /** * The legal last name of the individual. */ last_name?: string | null; /** * The legal middle name of the individual. */ middle_name?: string | null; phone_numbers?: Array | null; /** * The preferred name of the individual. */ preferred_name?: string | null; residence?: HRISAPI.Location | null; /** * Social Security Number of the individual. This field is only available with the * `ssn` scope enabled and the `options: { include: ['ssn'] }` param set in the * body. * [Click here to learn more about enabling the SSN field](/developer-resources/Enable-SSN-Field). */ ssn?: string | null; } export declare namespace IndividualUpdateParams { interface Email { data?: string; type?: 'work' | 'personal' | null; } interface PhoneNumber { data?: string | null; type?: 'work' | 'personal' | null; } } export declare namespace Individual { export { type IndividualUpdateResponse as IndividualUpdateResponse, type IndividualUpdateParams as IndividualUpdateParams, }; } //# sourceMappingURL=individual.d.ts.map