libs/internal-sdk/src/react-query/domainsRetrieve.ts - next - githubmirror/novu

libs/internal-sdk/src/react-query/domainsRetrieve.ts
141 строка4 KB
Dima Grossman
refactor(api-service, dashboard): routes pagination and managed entity (#10895)
28 апр 2026, 01:00
28 апр 2026, 01:00bcf1922
/*
 * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
 */

import {
  InvalidateQueryFilters,
  QueryClient,
  useQuery,
  UseQueryResult,
  useSuspenseQuery,
  UseSuspenseQueryResult,
} from "@tanstack/react-query";
import {
  ConnectionError,
  InvalidRequestError,
  RequestAbortedError,
  RequestTimeoutError,
  UnexpectedClientError,
} from "../models/errors/httpclienterrors.js";
import * as errors from "../models/errors/index.js";
import { NovuError } from "../models/errors/novuerror.js";
import { ResponseValidationError } from "../models/errors/responsevalidationerror.js";
import { SDKValidationError } from "../models/errors/sdkvalidationerror.js";
import { useNovuContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildDomainsRetrieveQuery,
  DomainsRetrieveQueryData,
  prefetchDomainsRetrieve,
  queryKeyDomainsRetrieve,
} from "./domainsRetrieve.core.js";
export {
  buildDomainsRetrieveQuery,
  type DomainsRetrieveQueryData,
  prefetchDomainsRetrieve,
  queryKeyDomainsRetrieve,
};

export type DomainsRetrieveQueryError =
  | errors.ErrorDto
  | errors.ValidationErrorDto
  | NovuError
  | ResponseValidationError
  | ConnectionError
  | RequestAbortedError
  | RequestTimeoutError
  | InvalidRequestError
  | UnexpectedClientError
  | SDKValidationError;

/**
 * Retrieve a domain by name
 *
 * @remarks
 * Returns the domain configuration and the DNS records that must be in place. This is a pure read; call `domains.verify` to refresh verification status from DNS.
 */
export function useDomainsRetrieve(
  domain: string,
  idempotencyKey?: string | undefined,
  options?: QueryHookOptions<
    DomainsRetrieveQueryData,
    DomainsRetrieveQueryError
  >,
): UseQueryResult<DomainsRetrieveQueryData, DomainsRetrieveQueryError> {
  const client = useNovuContext();
  return useQuery({
    ...buildDomainsRetrieveQuery(
      client,
      domain,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

/**
 * Retrieve a domain by name
 *
 * @remarks
 * Returns the domain configuration and the DNS records that must be in place. This is a pure read; call `domains.verify` to refresh verification status from DNS.
 */
export function useDomainsRetrieveSuspense(
  domain: string,
  idempotencyKey?: string | undefined,
  options?: SuspenseQueryHookOptions<
    DomainsRetrieveQueryData,
    DomainsRetrieveQueryError
  >,
): UseSuspenseQueryResult<DomainsRetrieveQueryData, DomainsRetrieveQueryError> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildDomainsRetrieveQuery(
      client,
      domain,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

export function setDomainsRetrieveData(
  client: QueryClient,
  queryKeyBase: [
    domain: string,
    parameters: { idempotencyKey?: string | undefined },
  ],
  data: DomainsRetrieveQueryData,
): DomainsRetrieveQueryData | undefined {
  const key = queryKeyDomainsRetrieve(...queryKeyBase);

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

export function invalidateDomainsRetrieve(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [domain: string, parameters: { idempotencyKey?: string | undefined }]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Domains", "retrieve", ...queryKeyBase],
  });
}

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