/*
 * 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 {
  GetV1CompaniesCompanyIdCustomFieldsHeaderXGustoAPIVersion,
  GetV1CompaniesCompanyIdCustomFieldsRequest,
} from "../models/operations/getv1companiescompanyidcustomfields.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildCompaniesGetCustomFieldsQuery,
  CompaniesGetCustomFieldsQueryData,
  prefetchCompaniesGetCustomFields,
  queryKeyCompaniesGetCustomFields,
} from "./companiesGetCustomFields.core.js";
export {
  buildCompaniesGetCustomFieldsQuery,
  type CompaniesGetCustomFieldsQueryData,
  prefetchCompaniesGetCustomFields,
  queryKeyCompaniesGetCustomFields,
};

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

/**
 * Get the custom fields of a company
 *
 * @remarks
 * Returns a list of the custom fields of the company. Useful when you need to know the schema of custom fields for an entire company.
 *
 * scope: `companies:read`
 */
export function useCompaniesGetCustomFields(
  request: GetV1CompaniesCompanyIdCustomFieldsRequest,
  options?: QueryHookOptions<
    CompaniesGetCustomFieldsQueryData,
    CompaniesGetCustomFieldsQueryError
  >,
): UseQueryResult<
  CompaniesGetCustomFieldsQueryData,
  CompaniesGetCustomFieldsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildCompaniesGetCustomFieldsQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get the custom fields of a company
 *
 * @remarks
 * Returns a list of the custom fields of the company. Useful when you need to know the schema of custom fields for an entire company.
 *
 * scope: `companies:read`
 */
export function useCompaniesGetCustomFieldsSuspense(
  request: GetV1CompaniesCompanyIdCustomFieldsRequest,
  options?: SuspenseQueryHookOptions<
    CompaniesGetCustomFieldsQueryData,
    CompaniesGetCustomFieldsQueryError
  >,
): UseSuspenseQueryResult<
  CompaniesGetCustomFieldsQueryData,
  CompaniesGetCustomFieldsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildCompaniesGetCustomFieldsQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setCompaniesGetCustomFieldsData(
  client: QueryClient,
  queryKeyBase: [
    companyId: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1CompaniesCompanyIdCustomFieldsHeaderXGustoAPIVersion
        | undefined;
      page?: number | undefined;
      per?: number | undefined;
    },
  ],
  data: CompaniesGetCustomFieldsQueryData,
): CompaniesGetCustomFieldsQueryData | undefined {
  const key = queryKeyCompaniesGetCustomFields(...queryKeyBase);

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

export function invalidateCompaniesGetCustomFields(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [
      companyId: string,
      parameters: {
        xGustoAPIVersion?:
          | GetV1CompaniesCompanyIdCustomFieldsHeaderXGustoAPIVersion
          | undefined;
        page?: number | undefined;
        per?: number | undefined;
      },
    ]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: [
      "@gusto/embedded-api",
      "Companies",
      "getCustomFields",
      ...queryKeyBase,
    ],
  });
}

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