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

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

export type CompanyBenefitsDeleteMutationVariables = {
  request: DeleteV1CompanyBenefitsCompanyBenefitIdRequest;
  options?: RequestOptions;
};

export type CompanyBenefitsDeleteMutationData =
  DeleteV1CompanyBenefitsCompanyBenefitIdResponse;

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

/**
 * Delete a company benefit
 *
 * @remarks
 * The following must be true in order to delete a company benefit
 *
 *   - There are no employee benefits associated with the company benefit
 *   - There are no payroll items associated with the company benefit
 *   - The benefit is not managed by a Partner or by Gusto (type must be 'External')
 *
 * When the application has the `company_benefits:write:benefit_type_limited` data scope, the application can only delete company benefits for benefit types that are permitted for the application.
 *
 * scope: `company_benefits:write`
 */
export function useCompanyBenefitsDeleteMutation(
  options?: MutationHookOptions<
    CompanyBenefitsDeleteMutationData,
    CompanyBenefitsDeleteMutationError,
    CompanyBenefitsDeleteMutationVariables
  >,
): UseMutationResult<
  CompanyBenefitsDeleteMutationData,
  CompanyBenefitsDeleteMutationError,
  CompanyBenefitsDeleteMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildCompanyBenefitsDeleteMutation(client, options),
    ...options,
  });
}

export function mutationKeyCompanyBenefitsDelete(): MutationKey {
  return ["@gusto/embedded-api", "companyBenefits", "delete"];
}

export function buildCompanyBenefitsDeleteMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: CompanyBenefitsDeleteMutationVariables,
  ) => Promise<CompanyBenefitsDeleteMutationData>;
} {
  return {
    mutationKey: mutationKeyCompanyBenefitsDelete(),
    mutationFn: function companyBenefitsDeleteMutationFn({
      request,
      options,
    }): Promise<CompanyBenefitsDeleteMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(companyBenefitsDelete(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}