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

libs/internal-sdk/src/react-query/integrationsList.ts
137 строк4 KB
Pawan Jain
refactor(api-service): validate flattened provider IDs fixes NV-8087 (#11611)
23 июн 2026, 07:40
23 июн 2026, 07:40043e6db
/*
 * 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 {
  buildIntegrationsListQuery,
  IntegrationsListQueryData,
  prefetchIntegrationsList,
  queryKeyIntegrationsList,
} from "./integrationsList.core.js";
export {
  buildIntegrationsListQuery,
  type IntegrationsListQueryData,
  prefetchIntegrationsList,
  queryKeyIntegrationsList,
};

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

/**
 * List all integrations
 *
 * @remarks
 * List all the channels integrations created in the organization. Only integration metadata is returned, credentials field is returned as an empty object.
 */
export function useIntegrationsList(
  idempotencyKey?: string | undefined,
  options?: QueryHookOptions<
    IntegrationsListQueryData,
    IntegrationsListQueryError
  >,
): UseQueryResult<IntegrationsListQueryData, IntegrationsListQueryError> {
  const client = useNovuContext();
  return useQuery({
    ...buildIntegrationsListQuery(
      client,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

/**
 * List all integrations
 *
 * @remarks
 * List all the channels integrations created in the organization. Only integration metadata is returned, credentials field is returned as an empty object.
 */
export function useIntegrationsListSuspense(
  idempotencyKey?: string | undefined,
  options?: SuspenseQueryHookOptions<
    IntegrationsListQueryData,
    IntegrationsListQueryError
  >,
): UseSuspenseQueryResult<
  IntegrationsListQueryData,
  IntegrationsListQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildIntegrationsListQuery(
      client,
      idempotencyKey,
      options,
    ),
    ...options,
  });
}

export function setIntegrationsListData(
  client: QueryClient,
  queryKeyBase: [parameters: { idempotencyKey?: string | undefined }],
  data: IntegrationsListQueryData,
): IntegrationsListQueryData | undefined {
  const key = queryKeyIntegrationsList(...queryKeyBase);

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

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

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