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 { UnprocessableEntityError } from "../models/errors/unprocessableentityerror.js"; import { Frequency, GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion, GetV1CompaniesCompanyIdPaySchedulesPreviewRequest } from "../models/operations/getv1companiescompanyidpayschedulespreview.js"; import { RFCDate } from "../types/rfcdate.js"; import { QueryHookOptions, SuspenseQueryHookOptions, TupleToPrefixes } from "./_types.js"; import { buildPaySchedulesGetPreviewQuery, PaySchedulesGetPreviewQueryData, prefetchPaySchedulesGetPreview, queryKeyPaySchedulesGetPreview } from "./paySchedulesGetPreview.core.js"; export { buildPaySchedulesGetPreviewQuery, type PaySchedulesGetPreviewQueryData, prefetchPaySchedulesGetPreview, queryKeyPaySchedulesGetPreview, }; export type PaySchedulesGetPreviewQueryError = NotFoundErrorObject | UnprocessableEntityError | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Preview pay schedule dates * * @remarks * Provides a preview of a pay schedule with the specified parameters for the next 18 months. Use this before creating or updating a pay schedule to show expected check dates, pay period boundaries, and payroll deadlines. * * ### Related guides * - [Create a pay schedule](doc:create-a-pay-schedule) * - [Manage Pay Schedules via API](doc:manage-pay-schedules-api) * * scope: `pay_schedules:write` */ export declare function usePaySchedulesGetPreview(request: GetV1CompaniesCompanyIdPaySchedulesPreviewRequest, options?: QueryHookOptions): UseQueryResult; /** * Preview pay schedule dates * * @remarks * Provides a preview of a pay schedule with the specified parameters for the next 18 months. Use this before creating or updating a pay schedule to show expected check dates, pay period boundaries, and payroll deadlines. * * ### Related guides * - [Create a pay schedule](doc:create-a-pay-schedule) * - [Manage Pay Schedules via API](doc:manage-pay-schedules-api) * * scope: `pay_schedules:write` */ export declare function usePaySchedulesGetPreviewSuspense(request: GetV1CompaniesCompanyIdPaySchedulesPreviewRequest, options?: SuspenseQueryHookOptions): UseSuspenseQueryResult; export declare function setPaySchedulesGetPreviewData(client: QueryClient, queryKeyBase: [ companyId: string, parameters: { xGustoAPIVersion?: GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion | undefined; frequency: Frequency; anchorPayDate: RFCDate; anchorEndOfPayPeriod: RFCDate; day1?: number | undefined; day2?: number | undefined; endDate?: RFCDate | undefined; } ], data: PaySchedulesGetPreviewQueryData): PaySchedulesGetPreviewQueryData | undefined; export declare function invalidatePaySchedulesGetPreview(client: QueryClient, queryKeyBase: TupleToPrefixes<[ companyId: string, parameters: { xGustoAPIVersion?: GetV1CompaniesCompanyIdPaySchedulesPreviewHeaderXGustoAPIVersion | undefined; frequency: Frequency; anchorPayDate: RFCDate; anchorEndOfPayPeriod: RFCDate; day1?: number | undefined; day2?: number | undefined; endDate?: RFCDate | undefined; } ]>, filters?: Omit): Promise; export declare function invalidateAllPaySchedulesGetPreview(client: QueryClient, filters?: Omit): Promise; //# sourceMappingURL=paySchedulesGetPreview.d.ts.map