import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { RFCDate } from "../../types/rfcdate.js"; import { Employee } from "../components/employee.js"; import { HTTPMetadata } from "../components/httpmetadata.js"; import { SDKValidationError } from "../errors/sdkvalidationerror.js"; /** * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */ export declare const PutV1HistoricalEmployeesHeaderXGustoAPIVersion: { readonly TwoThousandAndTwentyFiveMinus06Minus15: "2025-06-15"; }; /** * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */ export type PutV1HistoricalEmployeesHeaderXGustoAPIVersion = ClosedEnum; /** * Primary work location for this historical employment row. */ export type WorkAddress = { /** * UUID of a company work location from the company locations response. */ locationUuid: string; }; /** * Residential address on file for tax withholding and compliance mail. */ export type HomeAddress = { /** * Street address line 1. */ street1: string; /** * Apartment, suite, unit, or building (optional). */ street2?: string | null | undefined; /** * City. */ city: string; /** * Two-letter U.S. state or territory postal abbreviation. */ state: string; /** * ZIP or ZIP+4. */ zip: string; }; /** * End of the historical employment period. */ export type Termination = { /** * Last day of employment (termination date). This is recorded on the employment; use the calendar date the person stopped working for the company. */ effectiveDate: RFCDate; }; /** * Hire date for the historical job used to build employments and filings. */ export type Job = { /** * First calendar day the employee was employed in this role at the company. */ hireDate: RFCDate; }; /** * Workers' compensation fields for Washington (WA) or Wyoming (WY) when the work address is in those states; omit when not applicable. */ export type EmployeeStateTaxes = { /** * Whether this job is eligible for workers' compensation coverage in the states of Washington (WA) or Wyoming (WY). */ wcCovered?: boolean | undefined; /** * The risk class code for workers' compensation in Washington or Wyoming state. For Washington, visit [Washington state's Risk Class page](https://www.lni.wa.gov/insurance/rates-risk-classes/risk-classes-for-workers-compensation/risk-class-lookup#/) to learn more. For Wyoming you can search for the code online using [WY Workforce Services website](https://dws.wyo.gov/dws-division/workers-compensation/) or call the agency at (307) 235-3217. */ wcClassCode?: string | undefined; }; /** * Request body for creating or updating a **historical employee**—someone who already separated from the company and must appear on year-to-date or tax filings without receiving ongoing payroll. * * @remarks * * Send this object under the JSON root key `employee`. All dates are ISO 8601 (`YYYY-MM-DD`). Use a `work_address.location_uuid` returned from your company locations API for an active work site. */ export type PutV1HistoricalEmployeesRequestBody = { /** * The current version of the object. See the [versioning guide](https://docs.gusto.com/embedded-payroll/docs/idempotency) for information on how to use this field. */ version: string; /** * Legal first name as it appears on government-issued identification. */ firstName: string; /** * Single middle initial, if any. */ middleInitial?: string | undefined; /** * Legal last name as it appears on government-issued identification. */ lastName: string; /** * Preferred given name for display; omit when the same as legal first name. */ preferredFirstName?: string | undefined; /** * Date of birth (YYYY-MM-DD). */ dateOfBirth: RFCDate; /** * Nine-digit U.S. Social Security number **without** dashes or spaces. Must pass Gusto/SSA validation in production; use a valid test SSN in sandbox environments. * * @remarks */ ssn: string; /** * Primary work location for this historical employment row. */ workAddress: WorkAddress; /** * Residential address on file for tax withholding and compliance mail. */ homeAddress: HomeAddress; /** * End of the historical employment period. */ termination: Termination; /** * Optional. When provided, stored on the employee record for notifications and profile. */ email?: string | undefined; /** * Hire date for the historical job used to build employments and filings. */ job: Job; /** * Workers' compensation fields for Washington (WA) or Wyoming (WY) when the work address is in those states; omit when not applicable. */ employeeStateTaxes?: EmployeeStateTaxes | undefined; }; export type PutV1HistoricalEmployeesRequest = { /** * Determines the date-based API version associated with your API call. If none is provided, your application's [minimum API version](https://docs.gusto.com/embedded-payroll/docs/api-versioning#minimum-api-version) is used. */ xGustoAPIVersion?: PutV1HistoricalEmployeesHeaderXGustoAPIVersion | undefined; /** * The UUID of the company that will employ this historical record. */ companyUuid: string; /** * The UUID of the historical employee returned from create or list responses. */ historicalEmployeeUuid: string; requestBody: PutV1HistoricalEmployeesRequestBody; }; export type PutV1HistoricalEmployeesResponse = { httpMeta: HTTPMetadata; /** * Successful */ employee?: Employee | undefined; }; /** @internal */ export declare const PutV1HistoricalEmployeesHeaderXGustoAPIVersion$outboundSchema: z.ZodNativeEnum; /** @internal */ export type WorkAddress$Outbound = { location_uuid: string; }; /** @internal */ export declare const WorkAddress$outboundSchema: z.ZodType; export declare function workAddressToJSON(workAddress: WorkAddress): string; /** @internal */ export type HomeAddress$Outbound = { street_1: string; street_2?: string | null | undefined; city: string; state: string; zip: string; }; /** @internal */ export declare const HomeAddress$outboundSchema: z.ZodType; export declare function homeAddressToJSON(homeAddress: HomeAddress): string; /** @internal */ export type Termination$Outbound = { effective_date: string; }; /** @internal */ export declare const Termination$outboundSchema: z.ZodType; export declare function terminationToJSON(termination: Termination): string; /** @internal */ export type Job$Outbound = { hire_date: string; }; /** @internal */ export declare const Job$outboundSchema: z.ZodType; export declare function jobToJSON(job: Job): string; /** @internal */ export type EmployeeStateTaxes$Outbound = { wc_covered?: boolean | undefined; wc_class_code?: string | undefined; }; /** @internal */ export declare const EmployeeStateTaxes$outboundSchema: z.ZodType; export declare function employeeStateTaxesToJSON(employeeStateTaxes: EmployeeStateTaxes): string; /** @internal */ export type PutV1HistoricalEmployeesRequestBody$Outbound = { version: string; first_name: string; middle_initial?: string | undefined; last_name: string; preferred_first_name?: string | undefined; date_of_birth: string; ssn: string; work_address: WorkAddress$Outbound; home_address: HomeAddress$Outbound; termination: Termination$Outbound; email?: string | undefined; job: Job$Outbound; employee_state_taxes?: EmployeeStateTaxes$Outbound | undefined; }; /** @internal */ export declare const PutV1HistoricalEmployeesRequestBody$outboundSchema: z.ZodType; export declare function putV1HistoricalEmployeesRequestBodyToJSON(putV1HistoricalEmployeesRequestBody: PutV1HistoricalEmployeesRequestBody): string; /** @internal */ export type PutV1HistoricalEmployeesRequest$Outbound = { "X-Gusto-API-Version": string; company_uuid: string; historical_employee_uuid: string; RequestBody: PutV1HistoricalEmployeesRequestBody$Outbound; }; /** @internal */ export declare const PutV1HistoricalEmployeesRequest$outboundSchema: z.ZodType; export declare function putV1HistoricalEmployeesRequestToJSON(putV1HistoricalEmployeesRequest: PutV1HistoricalEmployeesRequest): string; /** @internal */ export declare const PutV1HistoricalEmployeesResponse$inboundSchema: z.ZodType; export declare function putV1HistoricalEmployeesResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=putv1historicalemployees.d.ts.map