/*
 * 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 { UnprocessableEntityError } from "../models/errors/unprocessableentityerror.js";
import {
  GetCompaniesCompanyUuidReportTemplatesReportTypeHeaderXGustoAPIVersion,
  GetCompaniesCompanyUuidReportTemplatesReportTypeRequest,
} from "../models/operations/getcompaniescompanyuuidreporttemplatesreporttype.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildReportsGetTemplateQuery,
  prefetchReportsGetTemplate,
  queryKeyReportsGetTemplate,
  ReportsGetTemplateQueryData,
} from "./reportsGetTemplate.core.js";
export {
  buildReportsGetTemplateQuery,
  prefetchReportsGetTemplate,
  queryKeyReportsGetTemplate,
  type ReportsGetTemplateQueryData,
};

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

/**
 * Get a report template
 *
 * @remarks
 * Get a company's report template. The only supported report type is `payroll_journal`. The resulting columns and groupings from this endpoint can be used as a guidance to create the report using the POST create report endpoint.
 *
 * scope: `company_reports:write`
 */
export function useReportsGetTemplate(
  request: GetCompaniesCompanyUuidReportTemplatesReportTypeRequest,
  options?: QueryHookOptions<
    ReportsGetTemplateQueryData,
    ReportsGetTemplateQueryError
  >,
): UseQueryResult<ReportsGetTemplateQueryData, ReportsGetTemplateQueryError> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildReportsGetTemplateQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Get a report template
 *
 * @remarks
 * Get a company's report template. The only supported report type is `payroll_journal`. The resulting columns and groupings from this endpoint can be used as a guidance to create the report using the POST create report endpoint.
 *
 * scope: `company_reports:write`
 */
export function useReportsGetTemplateSuspense(
  request: GetCompaniesCompanyUuidReportTemplatesReportTypeRequest,
  options?: SuspenseQueryHookOptions<
    ReportsGetTemplateQueryData,
    ReportsGetTemplateQueryError
  >,
): UseSuspenseQueryResult<
  ReportsGetTemplateQueryData,
  ReportsGetTemplateQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildReportsGetTemplateQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setReportsGetTemplateData(
  client: QueryClient,
  queryKeyBase: [
    companyUuid: string,
    reportType: string,
    parameters: {
      xGustoAPIVersion?:
        | GetCompaniesCompanyUuidReportTemplatesReportTypeHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: ReportsGetTemplateQueryData,
): ReportsGetTemplateQueryData | undefined {
  const key = queryKeyReportsGetTemplate(...queryKeyBase);

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

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

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