import * as z from "zod/v3"; import { ClosedEnum } from "../../types/enums.js"; import { Result as SafeParseResult } from "../../types/fp.js"; import { HTTPMetadata } from "../components/httpmetadata.js"; import { ShowEmployees } from "../components/showemployees.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 GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion: { 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 GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion = ClosedEnum; export declare const GetV1CompaniesCompanyIdEmployeesQueryParamInclude: { readonly AllCompensations: "all_compensations"; readonly AllHomeAddresses: "all_home_addresses"; readonly CompanyName: "company_name"; readonly CurrentHomeAddress: "current_home_address"; readonly CustomFields: "custom_fields"; readonly PortalInvitations: "portal_invitations"; }; export type GetV1CompaniesCompanyIdEmployeesQueryParamInclude = ClosedEnum; export type GetV1CompaniesCompanyIdEmployeesRequest = { /** * 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?: GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion | undefined; /** * The UUID of the company */ companyId: string; /** * Filter employees by a specific primary work location */ locationUuid?: string | undefined; /** * Filter employees by a specific payroll */ payrollUuid?: string | undefined; /** * A string to search for in the object's names */ searchTerm?: string | undefined; /** * Sort employees by a given field. Cannot be used with search_term. Append `:asc` or `:desc` to specify direction (e.g., `name:desc`). Defaults to ascending. */ sortBy?: string | undefined; /** * Include the requested attribute(s) in each employee response. Multiple options are comma separated. */ include?: Array | undefined; /** * Filters employees by those who have completed onboarding */ onboarded?: boolean | undefined; /** * Filters employees who are ready to work (onboarded AND active today) */ onboardedActive?: boolean | undefined; /** * Filters employees by those who have been or are scheduled to be terminated */ terminated?: boolean | undefined; /** * Filters employees by those who have been terminated and whose termination is in effect today (excludes active and scheduled to be terminated) */ terminatedToday?: boolean | undefined; /** * Optional subset of employees to fetch. */ uuids?: Array | undefined; /** * The page that is requested. When unspecified, will load all objects unless endpoint forces pagination. */ page?: number | undefined; /** * Number of objects per page. For majority of endpoints will default to 25 */ per?: number | undefined; }; export type GetV1CompaniesCompanyIdEmployeesResponse = { httpMeta: HTTPMetadata; /** * successful */ showEmployees?: Array | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion$outboundSchema: z.ZodNativeEnum; /** @internal */ export declare const GetV1CompaniesCompanyIdEmployeesQueryParamInclude$outboundSchema: z.ZodNativeEnum; /** @internal */ export type GetV1CompaniesCompanyIdEmployeesRequest$Outbound = { "X-Gusto-API-Version": string; company_id: string; location_uuid?: string | undefined; payroll_uuid?: string | undefined; search_term?: string | undefined; sort_by?: string | undefined; include?: Array | undefined; onboarded?: boolean | undefined; onboarded_active?: boolean | undefined; terminated?: boolean | undefined; terminated_today?: boolean | undefined; uuids?: Array | undefined; page?: number | undefined; per?: number | undefined; }; /** @internal */ export declare const GetV1CompaniesCompanyIdEmployeesRequest$outboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdEmployeesRequestToJSON(getV1CompaniesCompanyIdEmployeesRequest: GetV1CompaniesCompanyIdEmployeesRequest): string; /** @internal */ export declare const GetV1CompaniesCompanyIdEmployeesResponse$inboundSchema: z.ZodType; export declare function getV1CompaniesCompanyIdEmployeesResponseFromJSON(jsonString: string): SafeParseResult; //# sourceMappingURL=getv1companiescompanyidemployees.d.ts.map