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

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

export type PayrollsPrepareMutationVariables = {
  request: PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareRequest;
  options?: RequestOptions;
};

export type PayrollsPrepareMutationData =
  PutV1CompaniesCompanyIdPayrollsPayrollIdPrepareResponse;

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

/**
 * Prepare a payroll for update
 *
 * @remarks
 * Prepares an unprocessed payroll for update, including: adding or removing eligible employees from the payroll,
 * and updating `check_date`, `payroll_deadline`, and `payroll_status_meta` dates and times.
 *
 * Use this endpoint before calling [PUT /v1/companies/{company_id}/payrolls/{payroll_id}](ref:put-v1-companies-company_id-payrolls).
 *
 * ### Notes
 *
 * * Nullifies `calculated_at` and `totals` if the payroll was previously calculated
 * * Returns the `version` parameter required for [updating the payroll](ref:put-v1-companies-company_id-payrolls)
 * * `employees:read` scope is required to include employee compensations data in the response.
 * * Results are paginated, with a maximum page size of 100 employee compensations.
 *
 * scope: `payrolls:write employees:read`
 */
export function usePayrollsPrepareMutation(
  options?: MutationHookOptions<
    PayrollsPrepareMutationData,
    PayrollsPrepareMutationError,
    PayrollsPrepareMutationVariables
  >,
): UseMutationResult<
  PayrollsPrepareMutationData,
  PayrollsPrepareMutationError,
  PayrollsPrepareMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildPayrollsPrepareMutation(client, options),
    ...options,
  });
}

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

export function buildPayrollsPrepareMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: PayrollsPrepareMutationVariables,
  ) => Promise<PayrollsPrepareMutationData>;
} {
  return {
    mutationKey: mutationKeyPayrollsPrepare(),
    mutationFn: function payrollsPrepareMutationFn({
      request,
      options,
    }): Promise<PayrollsPrepareMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(payrollsPrepare(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}