@novu/api 0.2.0 → 2.6.5

package/src/react-query/_types.ts

@@ -0,0 +1,91 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { RequestOptions } from "../lib/sdks.js";
+import { PageIterator } from "../types/operations.js";
+
+import type {
+  InfiniteData,
+  QueryKey,
+  UseInfiniteQueryOptions,
+  UseMutationOptions,
+  UseQueryOptions,
+  UseSuspenseInfiniteQueryOptions,
+  UseSuspenseQueryOptions,
+} from "@tanstack/react-query";
+
+export type TupleToPrefixes<T extends any[]> = T extends [...infer Prefix, any]
+  ? TupleToPrefixes<Prefix> | T
+  : never;
+
+export type QueryHookOptions<Data> =
+  & Omit<
+    UseQueryOptions<Data, Error>,
+    "queryKey" | "queryFn" | "select" | keyof RequestOptions
+  >
+  & RequestOptions;
+
+export type SuspenseQueryHookOptions<Data> =
+  & Omit<
+    UseSuspenseQueryOptions<Data, Error>,
+    "queryKey" | "queryFn" | "select" | keyof RequestOptions
+  >
+  & RequestOptions;
+
+export type InfiniteQueryHookOptions<
+  Data extends PageIterator<unknown, unknown>,
+> =
+  & Omit<
+    UseInfiniteQueryOptions<
+      Data,
+      Error,
+      InfiniteData<Data, Data["~next"]>,
+      Data,
+      QueryKey,
+      Data["~next"]
+    >,
+    | "queryKey"
+    | "queryFn"
+    | "select"
+    | "getNextPageParam"
+    | "getPreviousPageParam"
+    | "initialPageParam"
+    | keyof RequestOptions
+  >
+  & RequestOptions
+  & { initialPageParam?: Data["~next"] };
+
+export type SuspenseInfiniteQueryHookOptions<
+  Data extends PageIterator<unknown, unknown>,
+> =
+  & Omit<
+    UseSuspenseInfiniteQueryOptions<
+      Data,
+      Error,
+      InfiniteData<Data, Data["~next"]>,
+      Data,
+      QueryKey,
+      Data["~next"]
+    >,
+    | "queryKey"
+    | "queryFn"
+    | "select"
+    | "getNextPageParam"
+    | "getPreviousPageParam"
+    | "initialPageParam"
+    | keyof RequestOptions
+  >
+  & RequestOptions
+  & { initialPageParam?: Data["~next"] };
+
+export type MutationHookOptions<
+  Data = unknown,
+  Err = Error,
+  Variables = unknown,
+> =
+  & Omit<
+    UseMutationOptions<Data, Err, Variables>,
+    "mutationKey" | "mutationFn" | keyof RequestOptions
+  >
+  & RequestOptions;

package/src/react-query/cancel.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { cancel } from "../funcs/cancel.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 CancelMutationVariables = {
+  transactionId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type CancelMutationData = operations.EventsControllerCancelResponse;
+
+/**
+ * Cancel triggered event
+ *
+ * @remarks
+ *
+ *     Using a previously generated transactionId during the event trigger,
+ *      will cancel any active or pending workflows. This is useful to cancel active digests, delays etc...
+ */
+export function useCancelMutation(
+  options?: MutationHookOptions<
+    CancelMutationData,
+    Error,
+    CancelMutationVariables
+  >,
+): UseMutationResult<CancelMutationData, Error, CancelMutationVariables> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildCancelMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyCancel(): MutationKey {
+  return ["@novu/api", "cancel"];
+}
+
+export function buildCancelMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: CancelMutationVariables,
+  ) => Promise<CancelMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyCancel(),
+    mutationFn: function cancelMutationFn({
+      transactionId,
+      idempotencyKey,
+      options,
+    }): Promise<CancelMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(cancel(
+        client$,
+        transactionId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/index.ts

@@ -0,0 +1,64 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+export { NovuProvider, useNovuContext } from "./_context.js";
+export * from "./_types.js";
+
+export * from "./cancel.js";
+export * from "./integrationsCreate.js";
+export * from "./integrationsDelete.js";
+export * from "./integrationsList.js";
+export * from "./integrationsListActive.js";
+export * from "./integrationsSetAsPrimary.js";
+export * from "./integrationsUpdate.js";
+export * from "./integrationsWebhooksRetrieve.js";
+export * from "./messagesDelete.js";
+export * from "./messagesDeleteByTransactionId.js";
+export * from "./messagesRetrieve.js";
+export * from "./notificationsList.js";
+export * from "./notificationsRetrieve.js";
+export * from "./notificationsStatsGraph.js";
+export * from "./notificationsStatsRetrieve.js";
+export * from "./subscribersAuthenticationChatAccessOauth.js";
+export * from "./subscribersAuthenticationChatAccessOauthCallBack.js";
+export * from "./subscribersCreate.js";
+export * from "./subscribersCreateBulk.js";
+export * from "./subscribersCredentialsAppend.js";
+export * from "./subscribersCredentialsDelete.js";
+export * from "./subscribersCredentialsUpdate.js";
+export * from "./subscribersDelete.js";
+export * from "./subscribersList.js";
+export * from "./subscribersMessagesMarkAll.js";
+export * from "./subscribersMessagesMarkAllAs.js";
+export * from "./subscribersMessagesUpdateAsSeen.js";
+export * from "./subscribersNotificationsFeed.js";
+export * from "./subscribersNotificationsUnseenCount.js";
+export * from "./subscribersPatch.js";
+export * from "./subscribersPreferencesList.js";
+export * from "./subscribersPreferencesUpdate.js";
+export * from "./subscribersPropertiesUpdateOnlineFlag.js";
+export * from "./subscribersRetrieve.js";
+export * from "./subscribersSearch.js";
+export * from "./topicsCreate.js";
+export * from "./topicsDelete.js";
+export * from "./topicsList.js";
+export * from "./topicsRename.js";
+export * from "./topicsRetrieve.js";
+export * from "./topicsSubscribersAssign.js";
+export * from "./topicsSubscribersRemove.js";
+export * from "./topicsSubscribersRetrieve.js";
+export * from "./trigger.js";
+export * from "./triggerBroadcast.js";
+export * from "./triggerBulk.js";
+export * from "./workflowsCreate.js";
+export * from "./workflowsDelete.js";
+export * from "./workflowsGetStepData.js";
+export * from "./workflowsGetWorkflowTestData.js";
+export * from "./workflowsRetrieve.js";
+export * from "./workflowsUpdate.js";
+export * from "./workflowsWorkflowControllerGeneratePreview.js";
+export * from "./workflowsWorkflowControllerPatchWorkflow.js";
+export * from "./workflowsWorkflowControllerPatchWorkflowStepData.js";
+export * from "./workflowsWorkflowControllerSearchWorkflows.js";
+export * from "./workflowsWorkflowControllerSync.js";

package/src/react-query/integrationsCreate.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 { integrationsCreate } from "../funcs/integrationsCreate.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 IntegrationsCreateMutationVariables = {
+  createIntegrationRequestDto: components.CreateIntegrationRequestDto;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type IntegrationsCreateMutationData =
+  operations.IntegrationsControllerCreateIntegrationResponse;
+
+/**
+ * Create integration
+ *
+ * @remarks
+ * Create an integration for the current environment the user is based on the API key provided
+ */
+export function useIntegrationsCreateMutation(
+  options?: MutationHookOptions<
+    IntegrationsCreateMutationData,
+    Error,
+    IntegrationsCreateMutationVariables
+  >,
+): UseMutationResult<
+  IntegrationsCreateMutationData,
+  Error,
+  IntegrationsCreateMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildIntegrationsCreateMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIntegrationsCreate(): MutationKey {
+  return ["@novu/api", "Integrations", "create"];
+}
+
+export function buildIntegrationsCreateMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IntegrationsCreateMutationVariables,
+  ) => Promise<IntegrationsCreateMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIntegrationsCreate(),
+    mutationFn: function integrationsCreateMutationFn({
+      createIntegrationRequestDto,
+      idempotencyKey,
+      options,
+    }): Promise<IntegrationsCreateMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(integrationsCreate(
+        client$,
+        createIntegrationRequestDto,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/integrationsDelete.ts

@@ -0,0 +1,89 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { integrationsDelete } from "../funcs/integrationsDelete.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 IntegrationsDeleteMutationVariables = {
+  integrationId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type IntegrationsDeleteMutationData =
+  operations.IntegrationsControllerRemoveIntegrationResponse;
+
+/**
+ * Delete integration
+ */
+export function useIntegrationsDeleteMutation(
+  options?: MutationHookOptions<
+    IntegrationsDeleteMutationData,
+    Error,
+    IntegrationsDeleteMutationVariables
+  >,
+): UseMutationResult<
+  IntegrationsDeleteMutationData,
+  Error,
+  IntegrationsDeleteMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildIntegrationsDeleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyIntegrationsDelete(): MutationKey {
+  return ["@novu/api", "Integrations", "delete"];
+}
+
+export function buildIntegrationsDeleteMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: IntegrationsDeleteMutationVariables,
+  ) => Promise<IntegrationsDeleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyIntegrationsDelete(),
+    mutationFn: function integrationsDeleteMutationFn({
+      integrationId,
+      idempotencyKey,
+      options,
+    }): Promise<IntegrationsDeleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(integrationsDelete(
+        client$,
+        integrationId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/integrationsList.ts

@@ -0,0 +1,153 @@
+/*
+ * 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 { integrationsList } from "../funcs/integrationsList.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 IntegrationsListQueryData =
+  operations.IntegrationsControllerListIntegrationsResponse;
+
+/**
+ * Get integrations
+ *
+ * @remarks
+ * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+ */
+export function useIntegrationsList(
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<IntegrationsListQueryData>,
+): UseQueryResult<IntegrationsListQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildIntegrationsListQuery(
+      client,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get integrations
+ *
+ * @remarks
+ * Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+ */
+export function useIntegrationsListSuspense(
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<IntegrationsListQueryData>,
+): UseSuspenseQueryResult<IntegrationsListQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildIntegrationsListQuery(
+      client,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchIntegrationsList(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildIntegrationsListQuery(
+      client$,
+      idempotencyKey,
+    ),
+  });
+}
+
+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"],
+  });
+}
+
+export function buildIntegrationsListQuery(
+  client$: NovuCore,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<IntegrationsListQueryData>;
+} {
+  return {
+    queryKey: queryKeyIntegrationsList({ idempotencyKey }),
+    queryFn: async function integrationsListQueryFn(
+      ctx,
+    ): Promise<IntegrationsListQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(integrationsList(
+        client$,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyIntegrationsList(
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return ["@novu/api", "Integrations", "list", parameters];
+}