/* * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT. */ import { MutationKey, useMutation, UseMutationResult, } from "@tanstack/react-query"; import { GustoEmbeddedCore } from "../core.js"; import { employeesDelete } from "../funcs/employeesDelete.js"; import { combineSignals } from "../lib/primitives.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 { DeleteV1EmployeeRequest, DeleteV1EmployeeResponse, } from "../models/operations/deletev1employee.js"; import { unwrapAsync } from "../types/fp.js"; import { useGustoEmbeddedContext } from "./_context.js"; import { MutationHookOptions } from "./_types.js"; export type EmployeesDeleteMutationVariables = { request: DeleteV1EmployeeRequest; options?: RequestOptions; }; export type EmployeesDeleteMutationData = DeleteV1EmployeeResponse; export type EmployeesDeleteMutationError = | NotFoundErrorObject | UnprocessableEntityError | GustoEmbeddedError | ResponseValidationError | ConnectionError | RequestAbortedError | RequestTimeoutError | InvalidRequestError | UnexpectedClientError | SDKValidationError; /** * Delete an onboarding employee * * @remarks * Use this endpoint to delete an employee who is in onboarding. Deleting * an onboarded employee is not allowed and will return a 422 response. Please check out the Terminations api * if you need to terminate an onboarded employee. * * scope: `employees:manage` */ export function useEmployeesDeleteMutation( options?: MutationHookOptions< EmployeesDeleteMutationData, EmployeesDeleteMutationError, EmployeesDeleteMutationVariables >, ): UseMutationResult< EmployeesDeleteMutationData, EmployeesDeleteMutationError, EmployeesDeleteMutationVariables > { const client = useGustoEmbeddedContext(); return useMutation({ ...buildEmployeesDeleteMutation(client, options), ...options, }); } export function mutationKeyEmployeesDelete(): MutationKey { return ["@gusto/embedded-api", "Employees", "delete"]; } export function buildEmployeesDeleteMutation( client$: GustoEmbeddedCore, hookOptions?: RequestOptions, ): { mutationKey: MutationKey; mutationFn: ( variables: EmployeesDeleteMutationVariables, ) => Promise; } { return { mutationKey: mutationKeyEmployeesDelete(), mutationFn: function employeesDeleteMutationFn({ request, options, }): Promise { const mergedOptions = { ...hookOptions, ...options, fetchOptions: { ...hookOptions?.fetchOptions, ...options?.fetchOptions, signal: combineSignals( hookOptions?.fetchOptions?.signal, options?.fetchOptions?.signal, ), }, }; return unwrapAsync(employeesDelete( client$, request, mergedOptions, )); }, }; }