import { MutationKey, UseMutationResult } from "@tanstack/react-query"; import { GustoEmbeddedCore } from "../core.js"; import { RequestOptions } from "../lib/sdks.js"; 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 { PayrollBlockersError } from "../models/errors/payrollblockerserror.js"; import { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { PostCompaniesPayrollSkipCompanyUuidRequest, PostCompaniesPayrollSkipCompanyUuidResponse } from "../models/operations/postcompaniespayrollskipcompanyuuid.js"; import { MutationHookOptions } from "./_types.js"; export type PayrollsSkipMutationVariables = { request: PostCompaniesPayrollSkipCompanyUuidRequest; options?: RequestOptions; }; export type PayrollsSkipMutationData = PostCompaniesPayrollSkipCompanyUuidResponse; export type PayrollsSkipMutationError = NotFoundErrorObject | PayrollBlockersError | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Skip a payroll * * @remarks * Submits a $0 payroll for employees associated with the pay schedule to skip payroll. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, the payroll is transitioned to the `processed` state. * * If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses. * * scope: `payrolls:run` */ export declare function usePayrollsSkipMutation(options?: MutationHookOptions): UseMutationResult; export declare function mutationKeyPayrollsSkip(): MutationKey; export declare function buildPayrollsSkipMutation(client$: GustoEmbeddedCore, hookOptions?: RequestOptions): { mutationKey: MutationKey; mutationFn: (variables: PayrollsSkipMutationVariables) => Promise; }; //# sourceMappingURL=payrollsSkip.d.ts.map