/*
 * 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 { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import {
  GetV1WebhookSubscriptionsHeaderXGustoAPIVersion,
  GetV1WebhookSubscriptionsRequest,
  GetV1WebhookSubscriptionsSecurity,
} from "../models/operations/getv1webhooksubscriptions.js";
import { useGustoEmbeddedContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildWebhooksListSubscriptionsQuery,
  prefetchWebhooksListSubscriptions,
  queryKeyWebhooksListSubscriptions,
  WebhooksListSubscriptionsQueryData,
} from "./webhooksListSubscriptions.core.js";
export {
  buildWebhooksListSubscriptionsQuery,
  prefetchWebhooksListSubscriptions,
  queryKeyWebhooksListSubscriptions,
  type WebhooksListSubscriptionsQueryData,
};

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

/**
 * List webhook subscriptions
 *
 * @remarks
 * Returns all webhook subscriptions associated with the provided Partner API token.
 *
 * 📘 System Access Authentication
 *
 * This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
 *
 * scope: `webhook_subscriptions:read`
 */
export function useWebhooksListSubscriptions(
  security: GetV1WebhookSubscriptionsSecurity,
  request: GetV1WebhookSubscriptionsRequest,
  options?: QueryHookOptions<
    WebhooksListSubscriptionsQueryData,
    WebhooksListSubscriptionsQueryError
  >,
): UseQueryResult<
  WebhooksListSubscriptionsQueryData,
  WebhooksListSubscriptionsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useQuery({
    ...buildWebhooksListSubscriptionsQuery(
      client,
      security,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * List webhook subscriptions
 *
 * @remarks
 * Returns all webhook subscriptions associated with the provided Partner API token.
 *
 * 📘 System Access Authentication
 *
 * This endpoint uses the [Bearer Auth scheme with the system-level access token in the HTTP Authorization header](https://docs.gusto.com/embedded-payroll/docs/system-access)
 *
 * scope: `webhook_subscriptions:read`
 */
export function useWebhooksListSubscriptionsSuspense(
  security: GetV1WebhookSubscriptionsSecurity,
  request: GetV1WebhookSubscriptionsRequest,
  options?: SuspenseQueryHookOptions<
    WebhooksListSubscriptionsQueryData,
    WebhooksListSubscriptionsQueryError
  >,
): UseSuspenseQueryResult<
  WebhooksListSubscriptionsQueryData,
  WebhooksListSubscriptionsQueryError
> {
  const client = useGustoEmbeddedContext();
  return useSuspenseQuery({
    ...buildWebhooksListSubscriptionsQuery(
      client,
      security,
      request,
      options,
    ),
    ...options,
  });
}

export function setWebhooksListSubscriptionsData(
  client: QueryClient,
  queryKeyBase: [
    parameters: {
      xGustoAPIVersion?:
        | GetV1WebhookSubscriptionsHeaderXGustoAPIVersion
        | undefined;
    },
  ],
  data: WebhooksListSubscriptionsQueryData,
): WebhooksListSubscriptionsQueryData | undefined {
  const key = queryKeyWebhooksListSubscriptions(...queryKeyBase);

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

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

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