@novu/api 0.1.6 → 2.6.5

package/src/react-query/integrationsWebhooksRetrieve.ts

@@ -0,0 +1,176 @@
+/*
+ * 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 { integrationsWebhooksRetrieve } from "../funcs/integrationsWebhooksRetrieve.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 IntegrationsWebhooksRetrieveQueryData =
+  operations.IntegrationsControllerGetWebhookSupportStatusResponse;
+
+/**
+ * Get webhook support status for provider
+ *
+ * @remarks
+ * Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value
+ */
+export function useIntegrationsWebhooksRetrieve(
+  providerOrIntegrationId: string,
+  idempotencyKey?: string | undefined,
+  options?: QueryHookOptions<IntegrationsWebhooksRetrieveQueryData>,
+): UseQueryResult<IntegrationsWebhooksRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildIntegrationsWebhooksRetrieveQuery(
+      client,
+      providerOrIntegrationId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get webhook support status for provider
+ *
+ * @remarks
+ * Return the status of the webhook for this provider, if it is supported or if it is not based on a boolean value
+ */
+export function useIntegrationsWebhooksRetrieveSuspense(
+  providerOrIntegrationId: string,
+  idempotencyKey?: string | undefined,
+  options?: SuspenseQueryHookOptions<IntegrationsWebhooksRetrieveQueryData>,
+): UseSuspenseQueryResult<IntegrationsWebhooksRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildIntegrationsWebhooksRetrieveQuery(
+      client,
+      providerOrIntegrationId,
+      idempotencyKey,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchIntegrationsWebhooksRetrieve(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  providerOrIntegrationId: string,
+  idempotencyKey?: string | undefined,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildIntegrationsWebhooksRetrieveQuery(
+      client$,
+      providerOrIntegrationId,
+      idempotencyKey,
+    ),
+  });
+}
+
+export function setIntegrationsWebhooksRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [
+    providerOrIntegrationId: string,
+    parameters: { idempotencyKey?: string | undefined },
+  ],
+  data: IntegrationsWebhooksRetrieveQueryData,
+): IntegrationsWebhooksRetrieveQueryData | undefined {
+  const key = queryKeyIntegrationsWebhooksRetrieve(...queryKeyBase);
+
+  return client.setQueryData<IntegrationsWebhooksRetrieveQueryData>(key, data);
+}
+
+export function invalidateIntegrationsWebhooksRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [
+      providerOrIntegrationId: string,
+      parameters: { idempotencyKey?: string | undefined },
+    ]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Webhooks", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllIntegrationsWebhooksRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Webhooks", "retrieve"],
+  });
+}
+
+export function buildIntegrationsWebhooksRetrieveQuery(
+  client$: NovuCore,
+  providerOrIntegrationId: string,
+  idempotencyKey?: string | undefined,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<IntegrationsWebhooksRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeyIntegrationsWebhooksRetrieve(providerOrIntegrationId, {
+      idempotencyKey,
+    }),
+    queryFn: async function integrationsWebhooksRetrieveQueryFn(
+      ctx,
+    ): Promise<IntegrationsWebhooksRetrieveQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(integrationsWebhooksRetrieve(
+        client$,
+        providerOrIntegrationId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyIntegrationsWebhooksRetrieve(
+  providerOrIntegrationId: string,
+  parameters: { idempotencyKey?: string | undefined },
+): QueryKey {
+  return [
+    "@novu/api",
+    "Webhooks",
+    "retrieve",
+    providerOrIntegrationId,
+    parameters,
+  ];
+}

package/src/react-query/messagesDelete.ts

@@ -0,0 +1,92 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import {
+  MutationKey,
+  useMutation,
+  UseMutationResult,
+} from "@tanstack/react-query";
+import { NovuCore } from "../core.js";
+import { messagesDelete } from "../funcs/messagesDelete.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 MessagesDeleteMutationVariables = {
+  messageId: string;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type MessagesDeleteMutationData =
+  operations.MessagesControllerDeleteMessageResponse;
+
+/**
+ * Delete message
+ *
+ * @remarks
+ * Deletes a message entity from the Novu platform
+ */
+export function useMessagesDeleteMutation(
+  options?: MutationHookOptions<
+    MessagesDeleteMutationData,
+    Error,
+    MessagesDeleteMutationVariables
+  >,
+): UseMutationResult<
+  MessagesDeleteMutationData,
+  Error,
+  MessagesDeleteMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildMessagesDeleteMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyMessagesDelete(): MutationKey {
+  return ["@novu/api", "Messages", "delete"];
+}
+
+export function buildMessagesDeleteMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: MessagesDeleteMutationVariables,
+  ) => Promise<MessagesDeleteMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyMessagesDelete(),
+    mutationFn: function messagesDeleteMutationFn({
+      messageId,
+      idempotencyKey,
+      options,
+    }): Promise<MessagesDeleteMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(messagesDelete(
+        client$,
+        messageId,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/messagesDeleteByTransactionId.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 { messagesDeleteByTransactionId } from "../funcs/messagesDeleteByTransactionId.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 MessagesDeleteByTransactionIdMutationVariables = {
+  transactionId: string;
+  channel?: operations.Channel | undefined;
+  idempotencyKey?: string | undefined;
+  options?: RequestOptions;
+};
+
+export type MessagesDeleteByTransactionIdMutationData =
+  | operations.MessagesControllerDeleteMessagesByTransactionIdResponse
+  | undefined;
+
+/**
+ * Delete messages by transactionId
+ *
+ * @remarks
+ * Deletes messages entity from the Novu platform using TransactionId of message
+ */
+export function useMessagesDeleteByTransactionIdMutation(
+  options?: MutationHookOptions<
+    MessagesDeleteByTransactionIdMutationData,
+    Error,
+    MessagesDeleteByTransactionIdMutationVariables
+  >,
+): UseMutationResult<
+  MessagesDeleteByTransactionIdMutationData,
+  Error,
+  MessagesDeleteByTransactionIdMutationVariables
+> {
+  const client = useNovuContext();
+  return useMutation({
+    ...buildMessagesDeleteByTransactionIdMutation(client, options),
+    ...options,
+  });
+}
+
+export function mutationKeyMessagesDeleteByTransactionId(): MutationKey {
+  return ["@novu/api", "Messages", "deleteByTransactionId"];
+}
+
+export function buildMessagesDeleteByTransactionIdMutation(
+  client$: NovuCore,
+  hookOptions?: RequestOptions,
+): {
+  mutationKey: MutationKey;
+  mutationFn: (
+    variables: MessagesDeleteByTransactionIdMutationVariables,
+  ) => Promise<MessagesDeleteByTransactionIdMutationData>;
+} {
+  return {
+    mutationKey: mutationKeyMessagesDeleteByTransactionId(),
+    mutationFn: function messagesDeleteByTransactionIdMutationFn({
+      transactionId,
+      channel,
+      idempotencyKey,
+      options,
+    }): Promise<MessagesDeleteByTransactionIdMutationData> {
+      const mergedOptions = {
+        ...hookOptions,
+        ...options,
+        fetchOptions: {
+          ...hookOptions?.fetchOptions,
+          ...options?.fetchOptions,
+          signal: combineSignals(
+            hookOptions?.fetchOptions?.signal,
+            options?.fetchOptions?.signal,
+          ),
+        },
+      };
+      return unwrapAsync(messagesDeleteByTransactionId(
+        client$,
+        transactionId,
+        channel,
+        idempotencyKey,
+        mergedOptions,
+      ));
+    },
+  };
+}

package/src/react-query/messagesRetrieve.ts

@@ -0,0 +1,184 @@
+/*
+ * 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 { messagesRetrieve } from "../funcs/messagesRetrieve.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 {
+  QueryHookOptions,
+  SuspenseQueryHookOptions,
+  TupleToPrefixes,
+} from "./_types.js";
+
+export type MessagesRetrieveQueryData =
+  operations.MessagesControllerGetMessagesResponse;
+
+/**
+ * Get messages
+ *
+ * @remarks
+ * Returns a list of messages, could paginate using the `page` query parameter
+ */
+export function useMessagesRetrieve(
+  request: operations.MessagesControllerGetMessagesRequest,
+  options?: QueryHookOptions<MessagesRetrieveQueryData>,
+): UseQueryResult<MessagesRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useQuery({
+    ...buildMessagesRetrieveQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+/**
+ * Get messages
+ *
+ * @remarks
+ * Returns a list of messages, could paginate using the `page` query parameter
+ */
+export function useMessagesRetrieveSuspense(
+  request: operations.MessagesControllerGetMessagesRequest,
+  options?: SuspenseQueryHookOptions<MessagesRetrieveQueryData>,
+): UseSuspenseQueryResult<MessagesRetrieveQueryData, Error> {
+  const client = useNovuContext();
+  return useSuspenseQuery({
+    ...buildMessagesRetrieveQuery(
+      client,
+      request,
+      options,
+    ),
+    ...options,
+  });
+}
+
+export function prefetchMessagesRetrieve(
+  queryClient: QueryClient,
+  client$: NovuCore,
+  request: operations.MessagesControllerGetMessagesRequest,
+): Promise<void> {
+  return queryClient.prefetchQuery({
+    ...buildMessagesRetrieveQuery(
+      client$,
+      request,
+    ),
+  });
+}
+
+export function setMessagesRetrieveData(
+  client: QueryClient,
+  queryKeyBase: [
+    parameters: {
+      channel?: components.ChannelTypeEnum | undefined;
+      subscriberId?: string | undefined;
+      transactionId?: Array<string> | undefined;
+      page?: number | undefined;
+      limit?: number | undefined;
+      idempotencyKey?: string | undefined;
+    },
+  ],
+  data: MessagesRetrieveQueryData,
+): MessagesRetrieveQueryData | undefined {
+  const key = queryKeyMessagesRetrieve(...queryKeyBase);
+
+  return client.setQueryData<MessagesRetrieveQueryData>(key, data);
+}
+
+export function invalidateMessagesRetrieve(
+  client: QueryClient,
+  queryKeyBase: TupleToPrefixes<
+    [parameters: {
+      channel?: components.ChannelTypeEnum | undefined;
+      subscriberId?: string | undefined;
+      transactionId?: Array<string> | undefined;
+      page?: number | undefined;
+      limit?: number | undefined;
+      idempotencyKey?: string | undefined;
+    }]
+  >,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Messages", "retrieve", ...queryKeyBase],
+  });
+}
+
+export function invalidateAllMessagesRetrieve(
+  client: QueryClient,
+  filters?: Omit<InvalidateQueryFilters, "queryKey" | "predicate" | "exact">,
+): Promise<void> {
+  return client.invalidateQueries({
+    ...filters,
+    queryKey: ["@novu/api", "Messages", "retrieve"],
+  });
+}
+
+export function buildMessagesRetrieveQuery(
+  client$: NovuCore,
+  request: operations.MessagesControllerGetMessagesRequest,
+  options?: RequestOptions,
+): {
+  queryKey: QueryKey;
+  queryFn: (
+    context: QueryFunctionContext,
+  ) => Promise<MessagesRetrieveQueryData>;
+} {
+  return {
+    queryKey: queryKeyMessagesRetrieve({
+      channel: request.channel,
+      subscriberId: request.subscriberId,
+      transactionId: request.transactionId,
+      page: request.page,
+      limit: request.limit,
+      idempotencyKey: request.idempotencyKey,
+    }),
+    queryFn: async function messagesRetrieveQueryFn(
+      ctx,
+    ): Promise<MessagesRetrieveQueryData> {
+      const sig = combineSignals(ctx.signal, options?.fetchOptions?.signal);
+      const mergedOptions = {
+        ...options,
+        fetchOptions: { ...options?.fetchOptions, signal: sig },
+      };
+
+      return unwrapAsync(messagesRetrieve(
+        client$,
+        request,
+        mergedOptions,
+      ));
+    },
+  };
+}
+
+export function queryKeyMessagesRetrieve(
+  parameters: {
+    channel?: components.ChannelTypeEnum | undefined;
+    subscriberId?: string | undefined;
+    transactionId?: Array<string> | undefined;
+    page?: number | undefined;
+    limit?: number | undefined;
+    idempotencyKey?: string | undefined;
+  },
+): QueryKey {
+  return ["@novu/api", "Messages", "retrieve", parameters];
+}