/*
 * 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 {
  GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessHeaderXGustoAPIVersion,
  GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessRequest,
} from "../models/operations/getv1partnermanagedcompaniescompanyuuidmigrationreadiness.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQuery,
  CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData,
  prefetchCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness,
  queryKeyCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness,
} from "./companiesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness.core.js";
export {
  buildCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQuery,
  type CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData,
  prefetchCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness,
  queryKeyCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness,
};

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

/**
 * Check company migration readiness
 *
 * @remarks
 * Check if an existing Gusto customer is ready to be migrated to embedded payroll. This endpoint returns blockers and warnings associated with migrating the company and is recommended to be called before attempting to migrate a company.
 *
 * scope: `partner_managed_companies:read`
 */
export function useCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness(
  request: GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessRequest,
  options?: QueryHookOptions<
    CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData,
    CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryError
  >,
): UseQueryResult<
  CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData,
  CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Check company migration readiness
 *
 * @remarks
 * Check if an existing Gusto customer is ready to be migrated to embedded payroll. This endpoint returns blockers and warnings associated with migrating the company and is recommended to be called before attempting to migrate a company.
 *
 * scope: `partner_managed_companies:read`
 */
export function useCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessSuspense(
  request: GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessRequest,
  options?: SuspenseQueryHookOptions<
    CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData,
    CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryError
  >,
): UseSuspenseQueryResult<
  CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData,
  CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessData(
  client: QueryClient,
  queryKeyBase: [
    companyUuid: string,
    parameters: {
      xGustoAPIVersion?:
        | GetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data:
    CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData,
):
  | CompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadinessQueryData
  | undefined
{
  const key =
    queryKeyCompaniesGetV1PartnerManagedCompaniesCompanyUuidMigrationReadiness(
      ...queryKeyBase,
    );

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

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

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