@novu/api 0.1.6 → 2.6.5

package/src/react-query/subscribersSearch.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { subscribersSearch } from "../funcs/subscribersSearch.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type SubscribersSearchQueryData =
+  operations.SubscribersControllerSearchSubscribersResponse;
+
+/**
+ * Search for subscribers
+ */
+export function useSubscribersSearch(
+  request: operations.SubscribersControllerSearchSubscribersRequest,
+  options?: QueryHookOptions<SubscribersSearchQueryData>,
+): UseQueryResult<SubscribersSearchQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildSubscribersSearchQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Search for subscribers
+ */
+export function useSubscribersSearchSuspense(
+  request: operations.SubscribersControllerSearchSubscribersRequest,
+  options?: SuspenseQueryHookOptions<SubscribersSearchQueryData>,
+): UseSuspenseQueryResult<SubscribersSearchQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildSubscribersSearchQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchSubscribersSearch(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  request: operations.SubscribersControllerSearchSubscribersRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildSubscribersSearchQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setSubscribersSearchData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      after?: string | undefined;
+      before?: string | undefined;
+      email?: string | undefined;
+      name?: string | undefined;
+      phone?: string | undefined;
+      subscriberId?: string | undefined;
+      limit?: number | undefined;
+      orderDirection?: operations.OrderDirection | undefined;
+      orderBy?: any | 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;
+      email?: string | undefined;
+      name?: string | undefined;
+      phone?: string | undefined;
+      subscriberId?: string | undefined;
+      limit?: number | undefined;
+      orderDirection?: operations.OrderDirection | undefined;
+      orderBy?: any | 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"],
+  });
+}
+
+export function buildSubscribersSearchQuery(
+  client$: NovuCore,
+  request: operations.SubscribersControllerSearchSubscribersRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<SubscribersSearchQueryData>;
+} {
+  return {
+    queryKey: queryKeySubscribersSearch({
+      after: request.after,
+      before: request.before,
+      email: request.email,
+      name: request.name,
+      phone: request.phone,
+      subscriberId: request.subscriberId,
+      limit: request.limit,
+      orderDirection: request.orderDirection,
+      orderBy: request.orderBy,
+      idempotencyKey: request.idempotencyKey,
+    }),
+    queryFn: async function subscribersSearchQueryFn(
+      ctx,
+    ): Promise<SubscribersSearchQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(subscribersSearch(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeySubscribersSearch(
+  parameters: {
+    after?: string | undefined;
+    before?: string | undefined;
+    email?: string | undefined;
+    name?: string | undefined;
+    phone?: string | undefined;
+    subscriberId?: string | undefined;
+    limit?: number | undefined;
+    orderDirection?: operations.OrderDirection | undefined;
+    orderBy?: any | undefined;
+    idempotencyKey?: string | undefined;
+  },
+): QueryKey {
+  return ["@novu/api", "Subscribers", "search", parameters];
+}

package/src/react-query/topicsCreate.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { topicsCreate } from "../funcs/topicsCreate.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type TopicsCreateMutationVariables = {
+  createTopicRequestDto: components.CreateTopicRequestDto;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TopicsCreateMutationData =
+  operations.TopicsControllerCreateTopicResponse;
+
+/**
+ * Topic creation
+ *
+ * @remarks
+ * Create a topic
+ */
+export function useTopicsCreateMutation(
+  options?: MutationHookOptions<
+    TopicsCreateMutationData,
+    Error,
+    TopicsCreateMutationVariables
+  >,
+): UseMutationResult<
+  TopicsCreateMutationData,
+  Error,
+  TopicsCreateMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTopicsCreateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTopicsCreate(): MutationKey {
+  return ["@novu/api", "Topics", "create"];
+}
+
+export function buildTopicsCreateMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TopicsCreateMutationVariables,
+  ) => Promise<TopicsCreateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTopicsCreate(),
+    mutationFn: function topicsCreateMutationFn({
+      createTopicRequestDto,
+      idempotencyKey,
+      options,
+    }): Promise<TopicsCreateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(topicsCreate(
+        client$,
+        createTopicRequestDto,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/topicsDelete.ts

@@ -0,0 +1,93 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { topicsDelete } from "../funcs/topicsDelete.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type TopicsDeleteMutationVariables = {
+  topicKey: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TopicsDeleteMutationData =
+  | operations.TopicsControllerDeleteTopicResponse
+  | undefined;
+
+/**
+ * Delete topic
+ *
+ * @remarks
+ * Delete a topic by its topic key if it has no subscribers
+ */
+export function useTopicsDeleteMutation(
+  options?: MutationHookOptions<
+    TopicsDeleteMutationData,
+    Error,
+    TopicsDeleteMutationVariables
+  >,
+): UseMutationResult<
+  TopicsDeleteMutationData,
+  Error,
+  TopicsDeleteMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTopicsDeleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTopicsDelete(): MutationKey {
+  return ["@novu/api", "Topics", "delete"];
+}
+
+export function buildTopicsDeleteMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TopicsDeleteMutationVariables,
+  ) => Promise<TopicsDeleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTopicsDelete(),
+    mutationFn: function topicsDeleteMutationFn({
+      topicKey,
+      idempotencyKey,
+      options,
+    }): Promise<TopicsDeleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(topicsDelete(
+        client$,
+        topicKey,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/topicsList.ts

@@ -0,0 +1,172 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  InvalidateQueryFilters,
+  QueryClient,
+  QueryFunctionContext,
+  QueryKey,
+  useQuery,
+  UseQueryResult,
+  useSuspenseQuery,
+  UseSuspenseQueryResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { topicsList } from "../funcs/topicsList.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type TopicsListQueryData = operations.TopicsControllerListTopicsResponse;
+
+/**
+ * Get topic list filtered
+ *
+ * @remarks
+ * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter
+ */
+export function useTopicsList(
+  request: operations.TopicsControllerListTopicsRequest,
+  options?: QueryHookOptions<TopicsListQueryData>,
+): UseQueryResult<TopicsListQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildTopicsListQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get topic list filtered
+ *
+ * @remarks
+ * Returns a list of topics that can be paginated using the `page` query parameter and filtered by the topic key with the `key` query parameter
+ */
+export function useTopicsListSuspense(
+  request: operations.TopicsControllerListTopicsRequest,
+  options?: SuspenseQueryHookOptions<TopicsListQueryData>,
+): UseSuspenseQueryResult<TopicsListQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildTopicsListQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchTopicsList(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  request: operations.TopicsControllerListTopicsRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildTopicsListQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setTopicsListData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      page?: number | undefined;
+      pageSize?: number | undefined;
+      key?: string | undefined;
+      idempotencyKey?: string | undefined;
+    },
+  ],
+  data: TopicsListQueryData,
+): TopicsListQueryData | undefined {
+  const key = queryKeyTopicsList(...queryKeyBase);
+
+  return client.setQueryData<TopicsListQueryData>(key, data);
+}
+
+export function invalidateTopicsList(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      page?: number | undefined;
+      pageSize?: number | undefined;
+      key?: string | undefined;
+      idempotencyKey?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Topics", "list", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllTopicsList(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Topics", "list"],
+  });
+}
+
+export function buildTopicsListQuery(
+  client$: NovuCore,
+  request: operations.TopicsControllerListTopicsRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (context: QueryFunctionContext) => Promise<TopicsListQueryData>;
+} {
+  return {
+    queryKey: queryKeyTopicsList({
+      page: request.page,
+      pageSize: request.pageSize,
+      key: request.key,
+      idempotencyKey: request.idempotencyKey,
+    }),
+    queryFn: async function topicsListQueryFn(
+      ctx,
+    ): Promise<TopicsListQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(topicsList(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyTopicsList(
+  parameters: {
+    page?: number | undefined;
+    pageSize?: number | undefined;
+    key?: string | undefined;
+    idempotencyKey?: string | undefined;
+  },
+): QueryKey {
+  return ["@novu/api", "Topics", "list", parameters];
+}

package/src/react-query/topicsRename.ts

@@ -0,0 +1,96 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { topicsRename } from "../funcs/topicsRename.js";
+import { combineSignals } from "../lib/primitives.js";
+import { RequestOptions } from "../lib/sdks.js";
+import * as components from "../models/components/index.js";
+import * as operations from "../models/operations/index.js";
+import { unwrapAsync } from "../types/fp.js";
+import { useNovuContext } from "./_context.js";
+import { MutationHookOptions } from "./_types.js";
+
+export type TopicsRenameMutationVariables = {
+  renameTopicRequestDto: components.RenameTopicRequestDto;
+  topicKey: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type TopicsRenameMutationData =
+  operations.TopicsControllerRenameTopicResponse;
+
+/**
+ * Rename a topic
+ *
+ * @remarks
+ * Rename a topic by providing a new name
+ */
+export function useTopicsRenameMutation(
+  options?: MutationHookOptions<
+    TopicsRenameMutationData,
+    Error,
+    TopicsRenameMutationVariables
+  >,
+): UseMutationResult<
+  TopicsRenameMutationData,
+  Error,
+  TopicsRenameMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildTopicsRenameMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyTopicsRename(): MutationKey {
+  return ["@novu/api", "Topics", "rename"];
+}
+
+export function buildTopicsRenameMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: TopicsRenameMutationVariables,
+  ) => Promise<TopicsRenameMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyTopicsRename(),
+    mutationFn: function topicsRenameMutationFn({
+      renameTopicRequestDto,
+      topicKey,
+      idempotencyKey,
+      options,
+    }): Promise<TopicsRenameMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(topicsRename(
+        client$,
+        renameTopicRequestDto,
+        topicKey,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}