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

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

export type EmployeeAddressesUpdateMutationVariables = {
  request: PutV1HomeAddressesHomeAddressUuidRequest;
  options?: RequestOptions;
};

export type EmployeeAddressesUpdateMutationData =
  PutV1HomeAddressesHomeAddressUuidResponse;

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

/**
 * Update an employee's home address
 *
 * @remarks
 * The home address of an employee is used to determine certain tax information about them. Addresses are geocoded on create and update to ensure validity.
 *
 * Supports home address effective dating and courtesy withholding.
 *
 * scope: `employees:write`
 */
export function useEmployeeAddressesUpdateMutation(
  options?: MutationHookOptions<
    EmployeeAddressesUpdateMutationData,
    EmployeeAddressesUpdateMutationError,
    EmployeeAddressesUpdateMutationVariables
  >,
): UseMutationResult<
  EmployeeAddressesUpdateMutationData,
  EmployeeAddressesUpdateMutationError,
  EmployeeAddressesUpdateMutationVariables
> {
  const client = useGustoEmbeddedContext();
  return useMutation({
    ...buildEmployeeAddressesUpdateMutation(client, options),
    ...options,
  });
}

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

export function buildEmployeeAddressesUpdateMutation(
  client$: GustoEmbeddedCore,
  hookOptions?: RequestOptions,
): {
  mutationKey: MutationKey;
  mutationFn: (
    variables: EmployeeAddressesUpdateMutationVariables,
  ) => Promise<EmployeeAddressesUpdateMutationData>;
} {
  return {
    mutationKey: mutationKeyEmployeeAddressesUpdate(),
    mutationFn: function employeeAddressesUpdateMutationFn({
      request,
      options,
    }): Promise<EmployeeAddressesUpdateMutationData> {
      const mergedOptions = {
        ...hookOptions,
        ...options,
        fetchOptions: {
          ...hookOptions?.fetchOptions,
          ...options?.fetchOptions,
          signal: combineSignals(
            hookOptions?.fetchOptions?.signal,
            options?.fetchOptions?.signal,
          ),
        },
      };
      return unwrapAsync(employeeAddressesUpdate(
        client$,
        request,
        mergedOptions,
      ));
    },
  };
}