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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js"; import { SDKValidationError } from "../models/errors/sdkvalidationerror.js"; import { UnprocessableEntityError } from "../models/errors/unprocessableentityerror.js"; import { PostV1CompaniesCompanyIdPayrollsRequest, PostV1CompaniesCompanyIdPayrollsResponse } from "../models/operations/postv1companiescompanyidpayrolls.js"; import { MutationHookOptions } from "./_types.js"; export type PayrollsCreateOffCycleMutationVariables = { request: PostV1CompaniesCompanyIdPayrollsRequest; options?: RequestOptions; }; export type PayrollsCreateOffCycleMutationData = PostV1CompaniesCompanyIdPayrollsResponse; export type PayrollsCreateOffCycleMutationError = NotFoundErrorObject | UnprocessableEntityError | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Create an off-cycle payroll * * @remarks * Creates a new, unprocessed, off-cycle payroll. * * ## `off_cycle_reason` * By default: * - External benefits and deductions will be included when the `off_cycle_reason` is set to `Correction`. * - All benefits and deductions are blocked when the `off_cycle_reason` is set to `Bonus`. * * These elections can be overridden with the `skip_regular_deductions` boolean. * * scope: `payrolls:run` */ export declare function usePayrollsCreateOffCycleMutation(options?: MutationHookOptions): UseMutationResult; export declare function mutationKeyPayrollsCreateOffCycle(): MutationKey; export declare function buildPayrollsCreateOffCycleMutation(client$: GustoEmbeddedCore, hookOptions?: RequestOptions): { mutationKey: MutationKey; mutationFn: (variables: PayrollsCreateOffCycleMutationVariables) => Promise; }; //# sourceMappingURL=payrollsCreateOffCycle.d.ts.map