/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { GustoEmbeddedCore } from "../core.js";
import { jobsAndCompensationsDeleteCompensation } from "../funcs/jobsAndCompensationsDeleteCompensation.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 {
  DeleteV1CompensationsCompensationIdRequest,
  DeleteV1CompensationsCompensationIdResponse,
} from "../models/operations/deletev1compensationscompensationid.js";
import { unwrapAsync } from "../types/fp.js";
import { useGustoEmbeddedContext } from "./_context.js";
import { MutationHookOptions } from "./_types.js";

export type JobsAndCompensationsDeleteCompensationMutationVariables = {
  request: DeleteV1CompensationsCompensationIdRequest;
  options?: RequestOptions;
};

export type JobsAndCompensationsDeleteCompensationMutationData =
  DeleteV1CompensationsCompensationIdResponse;

export type JobsAndCompensationsDeleteCompensationMutationError =
  | NotFoundErrorObject
  | UnprocessableEntityError
  | GustoEmbeddedError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Delete a compensation
 *
 * @remarks
 * Compensations contain information on how much is paid out for a job. Jobs may have many compensations, but only one that is active. The current compensation is the one with the most recent `effective_date`. This endpoint deletes a compensation for a job that hasn't been processed on payroll.
 *
 * ### Webhooks
 * - `employee_job_compensation.destroyed`: Fires when a compensation is successfully deleted
 *
 * scope: `compensations:write`
 */
export function useJobsAndCompensationsDeleteCompensationMutation(
  options?: MutationHookOptions<
    JobsAndCompensationsDeleteCompensationMutationData,
    JobsAndCompensationsDeleteCompensationMutationError,
    JobsAndCompensationsDeleteCompensationMutationVariables
  >,
): UseMutationResult<
  JobsAndCompensationsDeleteCompensationMutationData,
  JobsAndCompensationsDeleteCompensationMutationError,
  JobsAndCompensationsDeleteCompensationMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildJobsAndCompensationsDeleteCompensationMutation(client, options),
    ...options,
  });
}

export function mutationKeyJobsAndCompensationsDeleteCompensation(): MutationKey {
  return ["@gusto/embedded-api", "jobsAndCompensations", "deleteCompensation"];
}

export function buildJobsAndCompensationsDeleteCompensationMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: JobsAndCompensationsDeleteCompensationMutationVariables,
  ) => Promise<JobsAndCompensationsDeleteCompensationMutationData>;
} {
  return {
    mutationKey: mutationKeyJobsAndCompensationsDeleteCompensation(),
    mutationFn: function jobsAndCompensationsDeleteCompensationMutationFn({
      request,
      options,
    }): Promise<JobsAndCompensationsDeleteCompensationMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(jobsAndCompensationsDeleteCompensation(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}