/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
import { GustoEmbeddedError } from "../models/errors/gustoembeddederror.js";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import { NotFoundErrorObject } from "../models/errors/notfounderrorobject.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import {
  GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion,
  GetV1CompaniesCompanyIdEmployeesRequest,
  Include,
} from "../models/operations/getv1companiescompanyidemployees.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildEmployeesListQuery,
  EmployeesListQueryData,
  prefetchEmployeesList,
  queryKeyEmployeesList,
} from "./employeesList.core.js";
export {
  buildEmployeesListQuery,
  type EmployeesListQueryData,
  prefetchEmployeesList,
  queryKeyEmployeesList,
};

export type EmployeesListQueryError =
  | NotFoundErrorObject
  | GustoEmbeddedError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Get employees of a company
 *
 * @remarks
 * Get all of the employees, onboarding, active and terminated, for a given company.
 *
 * Note: Compensation data (pay rate, payment unit, and related fields) represents sensitive employee pay information. When retrieving employee job data, these fields (`rate`, `payment_unit`, `current_compensation_uuid`, `compensations`) are only returned when the `compensations:read` scope is included. This allows you to access employee and job metadata without exposing pay rates.
 *
 * scope: `employees:read`
 */
export function useEmployeesList(
  request: GetV1CompaniesCompanyIdEmployeesRequest,
  options?: QueryHookOptions<EmployeesListQueryData, EmployeesListQueryError>,
): UseQueryResult<EmployeesListQueryData, EmployeesListQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildEmployeesListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get employees of a company
 *
 * @remarks
 * Get all of the employees, onboarding, active and terminated, for a given company.
 *
 * Note: Compensation data (pay rate, payment unit, and related fields) represents sensitive employee pay information. When retrieving employee job data, these fields (`rate`, `payment_unit`, `current_compensation_uuid`, `compensations`) are only returned when the `compensations:read` scope is included. This allows you to access employee and job metadata without exposing pay rates.
 *
 * scope: `employees:read`
 */
export function useEmployeesListSuspense(
  request: GetV1CompaniesCompanyIdEmployeesRequest,
  options?: SuspenseQueryHookOptions<
    EmployeesListQueryData,
    EmployeesListQueryError
  >,
): UseSuspenseQueryResult<EmployeesListQueryData, EmployeesListQueryError> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildEmployeesListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setEmployeesListData(
  client: QueryClient,
  queryKeyBase: [
    companyId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion
        | undefined;
      locationUuid?: string | undefined;
      payrollUuid?: string | undefined;
      searchTerm?: string | undefined;
      sortBy?: string | undefined;
      include?: Array<Include> | undefined;
      onboarded?: boolean | undefined;
      onboardedActive?: boolean | undefined;
      terminated?: boolean | undefined;
      terminatedToday?: boolean | undefined;
      uuids?: Array<string> | undefined;
      page?: number | undefined;
      per?: number | undefined;
    },
  ],
  data: EmployeesListQueryData,
): EmployeesListQueryData | undefined {
  const key = queryKeyEmployeesList(...queryKeyBase);

  return client.setQueryData<EmployeesListQueryData>(key, data);
}

export function invalidateEmployeesList(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      companyId: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1CompaniesCompanyIdEmployeesHeaderXGustoAPIVersion
          | undefined;
        locationUuid?: string | undefined;
        payrollUuid?: string | undefined;
        searchTerm?: string | undefined;
        sortBy?: string | undefined;
        include?: Array<Include> | undefined;
        onboarded?: boolean | undefined;
        onboardedActive?: boolean | undefined;
        terminated?: boolean | undefined;
        terminatedToday?: boolean | undefined;
        uuids?: Array<string> | undefined;
        page?: number | undefined;
        per?: number | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gusto/embedded-api", "Employees", "list", ...queryKeyBase],
  });
}

export function invalidateAllEmployeesList(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gusto/embedded-api", "Employees", "list"],
  });
}