@novu/api 0.3.0 → 2.6.6

package/docs/sdks/notifications/README.md

@@ -18,7 +18,9 @@ Get notifications
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -42,7 +44,9 @@ import { notificationsList } from "@novu/api/funcs/notificationsList.js";
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -61,6 +65,34 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useNotificationsList,
+  useNotificationsListSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchNotificationsList,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateNotificationsList,
+  invalidateAllNotificationsList,
+} from "@novu/api/react-query/notificationsList.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -94,7 +126,9 @@ Get notification
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -118,7 +152,9 @@ import { notificationsRetrieve } from "@novu/api/funcs/notificationsRetrieve.js"
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -137,6 +173,34 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useNotificationsRetrieve,
+  useNotificationsRetrieveSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchNotificationsRetrieve,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateNotificationsRetrieve,
+  invalidateAllNotificationsRetrieve,
+} from "@novu/api/react-query/notificationsRetrieve.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/novu/README.md

@@ -28,7 +28,9 @@ Novu Documentation
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -70,7 +72,9 @@ import { trigger } from "@novu/api/funcs/trigger.js";
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -107,6 +111,23 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useTriggerMutation
+} from "@novu/api/react-query/trigger.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -144,7 +165,9 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -232,7 +255,9 @@ import { triggerBulk } from "@novu/api/funcs/triggerBulk.js";
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -315,6 +340,23 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useTriggerBulkMutation
+} from "@novu/api/react-query/triggerBulk.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -350,7 +392,9 @@ Trigger a broadcast event to all existing subscribers, could be used to send ann
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -382,7 +426,9 @@ import { triggerBroadcast } from "@novu/api/funcs/triggerBroadcast.js";
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -409,6 +455,23 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useTriggerBroadcastMutation
+} from "@novu/api/react-query/triggerBroadcast.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -446,7 +509,9 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -470,7 +535,9 @@ import { cancel } from "@novu/api/funcs/cancel.js";
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -489,6 +556,23 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useCancelMutation
+} from "@novu/api/react-query/cancel.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/novumessages/README.md

@@ -19,7 +19,9 @@ Mark a subscriber messages as seen, read, unseen or unread
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -46,7 +48,9 @@ import { subscribersMessagesMarkAllAs } from "@novu/api/funcs/subscribersMessage
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -68,6 +72,23 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useSubscribersMessagesMarkAllAsMutation
+} from "@novu/api/react-query/subscribersMessagesMarkAllAs.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -103,7 +124,9 @@ Marks all the subscriber messages as read, unread, seen or unseen. Optionally yo
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -129,7 +152,9 @@ import { subscribersMessagesMarkAll } from "@novu/api/funcs/subscribersMessagesM
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -150,6 +175,23 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useSubscribersMessagesMarkAllMutation
+} from "@novu/api/react-query/subscribersMessagesMarkAll.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -185,7 +227,9 @@ Mark message action as seen
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -216,7 +260,9 @@ import { subscribersMessagesUpdateAsSeen } from "@novu/api/funcs/subscribersMess
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -242,6 +288,23 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Mutation hook for triggering the API call.
+  useSubscribersMessagesUpdateAsSeenMutation
+} from "@novu/api/react-query/subscribersMessagesUpdateAsSeen.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/novunotifications/README.md

@@ -18,7 +18,9 @@ Get in-app notification feed for a particular subscriber
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -45,7 +47,9 @@ import { subscribersNotificationsFeed } from "@novu/api/funcs/subscribersNotific
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -67,6 +71,34 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useSubscribersNotificationsFeed,
+  useSubscribersNotificationsFeedSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchSubscribersNotificationsFeed,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateSubscribersNotificationsFeed,
+  invalidateAllSubscribersNotificationsFeed,
+} from "@novu/api/react-query/subscribersNotificationsFeed.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -100,7 +132,9 @@ Get the unseen in-app notifications count for subscribers feed
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -126,7 +160,9 @@ import { subscribersNotificationsUnseenCount } from "@novu/api/funcs/subscribers
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -147,6 +183,34 @@ async function run() {
 run();
 ```
 
+### React hooks and utilities
+
+This method can be used in React components through the following hooks and
+associated utilities.
+
+> Check out [this guide][hook-guide] for information about each of the utilities
+> below and how to get started using React hooks.
+
+[hook-guide]: ../../../REACT_QUERY.md
+
+```tsx
+import {
+  // Query hooks for fetching data.
+  useSubscribersNotificationsUnseenCount,
+  useSubscribersNotificationsUnseenCountSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchSubscribersNotificationsUnseenCount,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateSubscribersNotificationsUnseenCount,
+  invalidateAllSubscribersNotificationsUnseenCount,
+} from "@novu/api/react-query/subscribersNotificationsUnseenCount.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |