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

import {
  MutationKey,
  useMutation,
  UseMutationResult,
} from "@tanstack/react-query";
import { GustoEmbeddedCore } from "../core.js";
import { payrollsSkip } from "../funcs/payrollsSkip.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 { PayrollBlockersError } from "../models/errors/payrollblockerserror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import {
  PostCompaniesPayrollSkipCompanyUuidRequest,
  PostCompaniesPayrollSkipCompanyUuidResponse,
} from "../models/operations/postcompaniespayrollskipcompanyuuid.js";
import { unwrapAsync } from "../types/fp.js";
import { useGustoEmbeddedContext } from "./_context.js";
import { MutationHookOptions } from "./_types.js";

export type PayrollsSkipMutationVariables = {
  request: PostCompaniesPayrollSkipCompanyUuidRequest;
  options?: RequestOptions;
};

export type PayrollsSkipMutationData =
  PostCompaniesPayrollSkipCompanyUuidResponse;

export type PayrollsSkipMutationError =
  | NotFoundErrorObject
  | PayrollBlockersError
  | GustoEmbeddedError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Skip a payroll
 *
 * @remarks
 * Submits a $0 payroll for employees associated with the pay schedule to skip payroll. This submission is asynchronous and a successful request responds with a 202 HTTP status. Upon success, the payroll is transitioned to the `processed` state.
 *
 * If the company is blocked from running payroll due to issues like incomplete setup, missing information or other compliance issues, the response will be 422 Unprocessable Entity with a categorization of the blockers as described in the error responses.
 *
 * scope: `payrolls:run`
 */
export function usePayrollsSkipMutation(
  options?: MutationHookOptions<
    PayrollsSkipMutationData,
    PayrollsSkipMutationError,
    PayrollsSkipMutationVariables
  >,
): UseMutationResult<
  PayrollsSkipMutationData,
  PayrollsSkipMutationError,
  PayrollsSkipMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildPayrollsSkipMutation(client, options),
    ...options,
  });
}

export function mutationKeyPayrollsSkip(): MutationKey {
  return ["@gusto/embedded-api", "Payrolls", "skip"];
}

export function buildPayrollsSkipMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: PayrollsSkipMutationVariables,
  ) => Promise<PayrollsSkipMutationData>;
} {
  return {
    mutationKey: mutationKeyPayrollsSkip(),
    mutationFn: function payrollsSkipMutationFn({
      request,
      options,
    }): Promise<PayrollsSkipMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(payrollsSkip(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}