/**
 * This file was auto-generated by Fern from our API Definition.
 */
import * as Merge from "../../../../../..";
export interface EmployeesListRequest {
    /**
     * If provided, will only return employees for this company.
     */
    companyId?: string;
    /**
     * If provided, will only return objects created after this datetime.
     */
    createdAfter?: Date;
    /**
     * If provided, will only return objects created before this datetime.
     */
    createdBefore?: Date;
    /**
     * The pagination cursor value.
     */
    cursor?: string;
    /**
     * If provided, will only return employees with this display name.
     */
    displayFullName?: string;
    /**
     * If provided, will only return employees with this employment status.
     *
     * * `ACTIVE` - ACTIVE
     * * `PENDING` - PENDING
     * * `INACTIVE` - INACTIVE
     */
    employmentStatus?: Merge.hris.EmployeesListRequestEmploymentStatus;
    /**
     * If provided, will only return employees that have an employment of the specified employment_type.
     */
    employmentType?: string;
    /**
     * Which relations should be returned in expanded form. Multiple relation names should be comma separated without spaces.
     */
    expand?: Merge.hris.EmployeesListRequestExpand;
    /**
     * If provided, will only return employees with this first name.
     */
    firstName?: string;
    /**
     * If provided, will only return employees matching the group ids; multiple groups can be separated by commas.
     */
    groups?: string;
    /**
     * If provided, will only return employees for this home location.
     */
    homeLocationId?: string;
    /**
     * Whether to include data that was marked as deleted by third party webhooks.
     */
    includeDeletedData?: boolean;
    /**
     * Whether to include the original data Merge fetched from the third-party to produce these models.
     */
    includeRemoteData?: boolean;
    /**
     * Whether to include sensitive fields (such as social security numbers) in the response.
     */
    includeSensitiveFields?: boolean;
    /**
     * If provided, will only return employees that have an employment of the specified job_title.
     */
    jobTitle?: string;
    /**
     * If provided, will only return employees with this last name.
     */
    lastName?: string;
    /**
     * If provided, will only return employees for this manager.
     */
    managerId?: string;
    /**
     * If provided, only objects synced by Merge after this date time will be returned.
     */
    modifiedAfter?: Date;
    /**
     * If provided, only objects synced by Merge before this date time will be returned.
     */
    modifiedBefore?: Date;
    /**
     * Number of results to return per page.
     */
    pageSize?: number;
    /**
     * If provided, will only return employees for this pay group
     */
    payGroupId?: string;
    /**
     * If provided, will only return Employees with this personal email
     */
    personalEmail?: string;
    /**
     * Deprecated. Use show_enum_origins.
     */
    remoteFields?: Merge.hris.EmployeesListRequestRemoteFields;
    /**
     * The API provider's ID for the given object.
     */
    remoteId?: string;
    /**
     * Which fields should be returned in non-normalized form.
     */
    showEnumOrigins?: Merge.hris.EmployeesListRequestShowEnumOrigins;
    /**
     * If provided, will only return employees that started after this datetime.
     */
    startedAfter?: Date;
    /**
     * If provided, will only return employees that started before this datetime.
     */
    startedBefore?: Date;
    /**
     * If provided, will only return employees for this team.
     */
    teamId?: string;
    /**
     * If provided, will only return employees that were terminated after this datetime.
     */
    terminatedAfter?: Date;
    /**
     * If provided, will only return employees that were terminated before this datetime.
     */
    terminatedBefore?: Date;
    /**
     * If provided, will only return Employees with this work email
     */
    workEmail?: string;
    /**
     * If provided, will only return employees for this location.
     */
    workLocationId?: string;
}
