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 { GetV1GarnishmentsGarnishmentIdHeaderXGustoAPIVersion, GetV1GarnishmentsGarnishmentIdRequest } from "../models/operations/getv1garnishmentsgarnishmentid.js"; import { QueryHookOptions, SuspenseQueryHookOptions, TupleToPrefixes } from "./_types.js"; import { buildGarnishmentsGetQuery, GarnishmentsGetQueryData, prefetchGarnishmentsGet, queryKeyGarnishmentsGet } from "./garnishmentsGet.core.js"; export { buildGarnishmentsGetQuery, type GarnishmentsGetQueryData, prefetchGarnishmentsGet, queryKeyGarnishmentsGet, }; export type GarnishmentsGetQueryError = NotFoundErrorObject | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Get a garnishment * * @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 useGarnishmentsGet(request: GetV1GarnishmentsGarnishmentIdRequest, options?: QueryHookOptions): UseQueryResult; /** * Get a garnishment * * @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 useGarnishmentsGetSuspense(request: GetV1GarnishmentsGarnishmentIdRequest, options?: SuspenseQueryHookOptions): UseSuspenseQueryResult; export declare function setGarnishmentsGetData(client: QueryClient, queryKeyBase: [ garnishmentId: string, parameters: { xGustoAPIVersion?: GetV1GarnishmentsGarnishmentIdHeaderXGustoAPIVersion | undefined; } ], data: GarnishmentsGetQueryData): GarnishmentsGetQueryData | undefined; export declare function invalidateGarnishmentsGet(client: QueryClient, queryKeyBase: TupleToPrefixes<[ garnishmentId: string, parameters: { xGustoAPIVersion?: GetV1GarnishmentsGarnishmentIdHeaderXGustoAPIVersion | undefined; } ]>, filters?: Omit): Promise; export declare function invalidateAllGarnishmentsGet(client: QueryClient, filters?: Omit): Promise; //# sourceMappingURL=garnishmentsGet.d.ts.map