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

libs/internal-sdk/src/react-query/subscribersPreferencesList.ts
157 строк4 KB
Dima Grossman
chore(root): sdk gen version update for latest internal sdk changes (#10651)
10 апр 2026, 16:36
10 апр 2026, 16:36b5e0674
/*
 * 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 * as operations from "../models/operations/index.js";
import { useNovuContext } from "./_context.js";
import {
  QueryHookOptions,
  SuspenseQueryHookOptions,
  TupleToPrefixes,
} from "./_types.js";
import {
  buildSubscribersPreferencesListQuery,
  prefetchSubscribersPreferencesList,
  queryKeySubscribersPreferencesList,
  SubscribersPreferencesListQueryData,
} from "./subscribersPreferencesList.core.js";
export {
  buildSubscribersPreferencesListQuery,
  prefetchSubscribersPreferencesList,
  queryKeySubscribersPreferencesList,
  type SubscribersPreferencesListQueryData,
};

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

/**
 * Retrieve subscriber preferences
 *
 * @remarks
 * Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
 *     This API returns all five channels preferences for all workflows and global preferences.
 */
export function useSubscribersPreferencesList(
  request: operations.SubscribersControllerGetSubscriberPreferencesRequest,
  options?: QueryHookOptions<
    SubscribersPreferencesListQueryData,
    SubscribersPreferencesListQueryError
  >,
): UseQueryResult<
  SubscribersPreferencesListQueryData,
  SubscribersPreferencesListQueryError
> {
  const client = useNovuContext();
  return useQuery({
    ...buildSubscribersPreferencesListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Retrieve subscriber preferences
 *
 * @remarks
 * Retrieve subscriber channel preferences by its unique key identifier **subscriberId**.
 *     This API returns all five channels preferences for all workflows and global preferences.
 */
export function useSubscribersPreferencesListSuspense(
  request: operations.SubscribersControllerGetSubscriberPreferencesRequest,
  options?: SuspenseQueryHookOptions<
    SubscribersPreferencesListQueryData,
    SubscribersPreferencesListQueryError
  >,
): UseSuspenseQueryResult<
  SubscribersPreferencesListQueryData,
  SubscribersPreferencesListQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildSubscribersPreferencesListQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setSubscribersPreferencesListData(
  client: QueryClient,
  queryKeyBase: [
    subscriberId: string,
    parameters: {
      criticality?: operations.Criticality | undefined;
      contextKeys?: Array<string> | undefined;
      idempotencyKey?: string | undefined;
    },
  ],
  data: SubscribersPreferencesListQueryData,
): SubscribersPreferencesListQueryData | undefined {
  const key = queryKeySubscribersPreferencesList(...queryKeyBase);

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

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

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