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

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
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 {
  GetV1LocationsLocationIdHeaderXGustoAPIVersion,
  GetV1LocationsLocationIdRequest,
} from "../models/operations/getv1locationslocationid.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildLocationsRetrieveQuery,
  LocationsRetrieveQueryData,
  prefetchLocationsRetrieve,
  queryKeyLocationsRetrieve,
} from "./locationsRetrieve.core.js";
export {
  buildLocationsRetrieveQuery,
  type LocationsRetrieveQueryData,
  prefetchLocationsRetrieve,
  queryKeyLocationsRetrieve,
};

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

/**
 * Get a location
 *
 * @remarks
 * Get a location.
 *
 * scope: `companies:read`
 */
export function useLocationsRetrieve(
  request: GetV1LocationsLocationIdRequest,
  options?: QueryHookOptions<
    LocationsRetrieveQueryData,
    LocationsRetrieveQueryError
  >,
): UseQueryResult<LocationsRetrieveQueryData, LocationsRetrieveQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildLocationsRetrieveQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get a location
 *
 * @remarks
 * Get a location.
 *
 * scope: `companies:read`
 */
export function useLocationsRetrieveSuspense(
  request: GetV1LocationsLocationIdRequest,
  options?: SuspenseQueryHookOptions<
    LocationsRetrieveQueryData,
    LocationsRetrieveQueryError
  >,
): UseSuspenseQueryResult<
  LocationsRetrieveQueryData,
  LocationsRetrieveQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildLocationsRetrieveQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setLocationsRetrieveData(
  client: QueryClient,
  queryKeyBase: [
    locationId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1LocationsLocationIdHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: LocationsRetrieveQueryData,
): LocationsRetrieveQueryData | undefined {
  const key = queryKeyLocationsRetrieve(...queryKeyBase);

  return client.setQueryData<LocationsRetrieveQueryData>(key, data);
}

export function invalidateLocationsRetrieve(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      locationId: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1LocationsLocationIdHeaderXGustoAPIVersion
          | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gusto/embedded-api", "Locations", "retrieve", ...queryKeyBase],
  });
}

export function invalidateAllLocationsRetrieve(
  client: QueryClient,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@gusto/embedded-api", "Locations", "retrieve"],
  });
}