import { InvalidateQueryFilters, QueryClient, UseQueryResult, 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 { GetV1EmployeesEmployeeIdGarnishmentsHeaderXGustoAPIVersion, GetV1EmployeesEmployeeIdGarnishmentsRequest } from "../models/operations/getv1employeesemployeeidgarnishments.js"; import { QueryHookOptions, SuspenseQueryHookOptions, TupleToPrefixes } from "./_types.js"; import { buildGarnishmentsListQuery, GarnishmentsListQueryData, prefetchGarnishmentsList, queryKeyGarnishmentsList } from "./garnishmentsList.core.js"; export { buildGarnishmentsListQuery, type GarnishmentsListQueryData, prefetchGarnishmentsList, queryKeyGarnishmentsList, }; export type GarnishmentsListQueryError = NotFoundErrorObject | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Get garnishments for an employee * * @remarks * Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments. * * scope: `garnishments:read` */ export declare function useGarnishmentsList(request: GetV1EmployeesEmployeeIdGarnishmentsRequest, options?: QueryHookOptions): UseQueryResult; /** * Get garnishments for an employee * * @remarks * Garnishments, or employee deductions, are fixed amounts or percentages deducted from an employee’s pay. They can be deducted a specific number of times or on a recurring basis. Garnishments can also have maximum deductions on a yearly or per-pay-period bases. Common uses for garnishments are court-ordered payments for child support or back taxes. Some companies provide loans to their employees that are repaid via garnishments. * * scope: `garnishments:read` */ export declare function useGarnishmentsListSuspense(request: GetV1EmployeesEmployeeIdGarnishmentsRequest, options?: SuspenseQueryHookOptions): UseSuspenseQueryResult; export declare function setGarnishmentsListData(client: QueryClient, queryKeyBase: [ employeeId: string, parameters: { xGustoAPIVersion?: GetV1EmployeesEmployeeIdGarnishmentsHeaderXGustoAPIVersion | undefined; page?: number | undefined; per?: number | undefined; } ], data: GarnishmentsListQueryData): GarnishmentsListQueryData | undefined; export declare function invalidateGarnishmentsList(client: QueryClient, queryKeyBase: TupleToPrefixes<[ employeeId: string, parameters: { xGustoAPIVersion?: GetV1EmployeesEmployeeIdGarnishmentsHeaderXGustoAPIVersion | undefined; page?: number | undefined; per?: number | undefined; } ]>, filters?: Omit): Promise; export declare function invalidateAllGarnishmentsList(client: QueryClient, filters?: Omit): Promise; //# sourceMappingURL=garnishmentsList.d.ts.map