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 { PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest, PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse } from "../models/operations/putv1companiescompanyidpayrollspayrollidprepare.js"; import { MutationHookOptions } from "./_types.js"; export type PayrollsPrepareMutationVariables = { request: PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest; options?: RequestOptions; }; export type PayrollsPrepareMutationData = PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse; export type PayrollsPrepareMutationError = NotFoundErrorObject | UnprocessableEntityError | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Prepare a payroll for update * * @remarks * Prepares an unprocessed payroll for update, including: adding or removing eligible employees from the payroll, * and updating `check_date`, `payroll_deadline`, and `payroll_status_meta` dates and times. * * Use this endpoint before calling [PUT /v1/companies/{company_id}/payrolls/{payroll_id}](ref:put-v1-companies-company_id-payrolls). * * ### Notes * * * Nullifies `calculated_at` and `totals` if the payroll was previously calculated * * Returns the `version` parameter required for [updating the payroll](ref:put-v1-companies-company_id-payrolls) * * `employees:read` scope is required to include employee compensations data in the response. * * Results are paginated, with a maximum page size of 100 employee compensations. * * scope: `payrolls:write employees:read` */ export declare function usePayrollsPrepareMutation(options?: MutationHookOptions): UseMutationResult; export declare function mutationKeyPayrollsPrepare(): MutationKey; export declare function buildPayrollsPrepareMutation(client$: GustoEmbeddedCore, hookOptions?: RequestOptions): { mutationKey: MutationKey; mutationFn: (variables: PayrollsPrepareMutationVariables) => Promise; }; //# sourceMappingURL=payrollsPrepare.d.ts.map