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

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

export type PaySchedulesUpdateMutationVariables = {
  request: PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdRequest;
  options?: RequestOptions;
};

export type PaySchedulesUpdateMutationData =
  PutV1CompaniesCompanyIdPaySchedulesPayScheduleIdResponse;

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

/**
 * Update a pay schedule
 *
 * @remarks
 * Updates a pay schedule. The `version` parameter from the GET response is required for [optimistic concurrency](doc:api-fundamentals); a mismatch returns 409 Conflict.
 *
 * ### Effect on payrolls
 * Updating a pay schedule will delete any unprocessed regular payrolls whose pay period end date is today or in the future. Already-processed payrolls are not affected.
 *
 * ### Pay schedules may be automatically adjusted
 * If an onboarded company misses their first pay date, Gusto will automatically adjust the pay schedule to the next available pay date.
 *
 * ### Webhooks
 * - `pay_schedule.updated`: Fires when a pay schedule is successfully updated.
 *
 * ### Related guides
 * - [Create a pay schedule](doc:create-a-pay-schedule)
 * - [Manage Pay Schedules via API](doc:manage-pay-schedules-api)
 *
 * scope: `pay_schedules:write`
 */
export function usePaySchedulesUpdateMutation(
  options?: MutationHookOptions<
    PaySchedulesUpdateMutationData,
    PaySchedulesUpdateMutationError,
    PaySchedulesUpdateMutationVariables
  >,
): UseMutationResult<
  PaySchedulesUpdateMutationData,
  PaySchedulesUpdateMutationError,
  PaySchedulesUpdateMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildPaySchedulesUpdateMutation(client, options),
    ...options,
  });
}

export function mutationKeyPaySchedulesUpdate(): MutationKey {
  return ["@gusto/embedded-api", "paySchedules", "update"];
}

export function buildPaySchedulesUpdateMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: PaySchedulesUpdateMutationVariables,
  ) => Promise<PaySchedulesUpdateMutationData>;
} {
  return {
    mutationKey: mutationKeyPaySchedulesUpdate(),
    mutationFn: function paySchedulesUpdateMutationFn({
      request,
      options,
    }): Promise<PaySchedulesUpdateMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(paySchedulesUpdate(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}