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 { PutV1EmployeesEmployeeIdOnboardingStatusRequest, PutV1EmployeesEmployeeIdOnboardingStatusResponse } from "../models/operations/putv1employeesemployeeidonboardingstatus.js"; import { MutationHookOptions } from "./_types.js"; export type EmployeesUpdateOnboardingStatusMutationVariables = { request: PutV1EmployeesEmployeeIdOnboardingStatusRequest; options?: RequestOptions; }; export type EmployeesUpdateOnboardingStatusMutationData = PutV1EmployeesEmployeeIdOnboardingStatusResponse; export type EmployeesUpdateOnboardingStatusMutationError = NotFoundErrorObject | UnprocessableEntityError | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Update the employee's onboarding status * * @remarks * Updates an employee's onboarding status. * Below is a list of valid onboarding status changes depending on the intended action to be performed on behalf of the employee. * * | Action | current onboarding_status | new onboarding_status | * |:------------------|:------------:|----------:| * | Mark an employee as self-onboarding | `admin_onboarding_incomplete` | `self_onboarding_pending_invite` | * | Invite an employee to self-onboard | `admin_onboarding_incomplete` or `self_onboarding_pending_invite` | `self_onboarding_invited` | * | Cancel an employee's self-onboarding | `self_onboarding_invited` or `self_onboarding_pending_invite` | `admin_onboarding_incomplete` | * | Review an employee's self-onboarded info | `self_onboarding_completed_by_employee` | `self_onboarding_awaiting_admin_review` | * | Finish an employee's onboarding | `admin_onboarding_incomplete` or `self_onboarding_awaiting_admin_review` | `onboarding_completed` | * * scope: `employees:manage` */ export declare function useEmployeesUpdateOnboardingStatusMutation(options?: MutationHookOptions): UseMutationResult; export declare function mutationKeyEmployeesUpdateOnboardingStatus(): MutationKey; export declare function buildEmployeesUpdateOnboardingStatusMutation(client$: GustoEmbeddedCore, hookOptions?: RequestOptions): { mutationKey: MutationKey; mutationFn: (variables: EmployeesUpdateOnboardingStatusMutationVariables) => Promise; }; //# sourceMappingURL=employeesUpdateOnboardingStatus.d.ts.map