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

libs/internal-sdk/src/react-query/subscribersSearch.ts
166 строк5 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 {
  buildSubscribersSearchQuery,
  prefetchSubscribersSearch,
  queryKeySubscribersSearch,
  SubscribersSearchQueryData,
} from "./subscribersSearch.core.js";
export {
  buildSubscribersSearchQuery,
  prefetchSubscribersSearch,
  queryKeySubscribersSearch,
  type SubscribersSearchQueryData,
};

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

/**
 * Search subscribers
 *
 * @remarks
 * Search subscribers by their **email**, **phone**, **subscriberId** and **name**.
 *     The search is case sensitive and supports pagination.Checkout all available filters in the query section.
 */
export function useSubscribersSearch(
  request: operations.SubscribersControllerSearchSubscribersRequest,
  options?: QueryHookOptions<
    SubscribersSearchQueryData,
    SubscribersSearchQueryError
  >,
): UseQueryResult<SubscribersSearchQueryData, SubscribersSearchQueryError> {
  const client = useNovuContext();
  return useQuery({
    ...buildSubscribersSearchQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

/**
 * Search subscribers
 *
 * @remarks
 * Search subscribers by their **email**, **phone**, **subscriberId** and **name**.
 *     The search is case sensitive and supports pagination.Checkout all available filters in the query section.
 */
export function useSubscribersSearchSuspense(
  request: operations.SubscribersControllerSearchSubscribersRequest,
  options?: SuspenseQueryHookOptions<
    SubscribersSearchQueryData,
    SubscribersSearchQueryError
  >,
): UseSuspenseQueryResult<
  SubscribersSearchQueryData,
  SubscribersSearchQueryError
> {
  const client = useNovuContext();
  return useSuspenseQuery({
    ...buildSubscribersSearchQuery(
      client,
      request,
      options,
    ),
    ...options,
  });
}

export function setSubscribersSearchData(
  client: QueryClient,
  queryKeyBase: [
    parameters: {
      after?: string | undefined;
      before?: string | undefined;
      limit?: number | undefined;
      orderDirection?: operations.QueryParamOrderDirection | undefined;
      orderBy?: string | undefined;
      includeCursor?: boolean | undefined;
      email?: string | undefined;
      name?: string | undefined;
      phone?: string | undefined;
      subscriberId?: string | undefined;
      idempotencyKey?: string | undefined;
    },
  ],
  data: SubscribersSearchQueryData,
): SubscribersSearchQueryData | undefined {
  const key = queryKeySubscribersSearch(...queryKeyBase);

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

export function invalidateSubscribersSearch(
  client: QueryClient,
  queryKeyBase: TupleToPrefixes<
    [parameters: {
      after?: string | undefined;
      before?: string | undefined;
      limit?: number | undefined;
      orderDirection?: operations.QueryParamOrderDirection | undefined;
      orderBy?: string | undefined;
      includeCursor?: boolean | undefined;
      email?: string | undefined;
      name?: string | undefined;
      phone?: string | undefined;
      subscriberId?: string | undefined;
      idempotencyKey?: string | undefined;
    }]
  >,
  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
): Promise<void> {
  return client.invalidateQueries({
    ...filters,
    queryKey: ["@novu/api", "Subscribers", "search", ...queryKeyBase],
  });
}

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