@novu/api 0.3.0 → 2.6.6

package/docs/sdks/novusubscribers/README.md

@@ -19,7 +19,9 @@ Add subscribers to a topic by key
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -49,7 +51,9 @@ import { topicsSubscribersAssign } from "@novu/api/funcs/topicsSubscribersAssign
 // 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() {
@@ -74,6 +78,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.
+  useTopicsSubscribersAssignMutation
+} from "@novu/api/react-query/topicsSubscribersAssign.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -109,11 +130,13 @@ Check if a subscriber belongs to a certain topic
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
-  const result = await novu.topics.subscribers.retrieve("<id>", "<value>");
+  const result = await novu.topics.subscribers.retrieve("<value>", "<id>");
 
   // Handle the result
   console.log(result);
@@ -133,11 +156,13 @@ import { topicsSubscribersRetrieve } from "@novu/api/funcs/topicsSubscribersRetr
 // 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() {
-  const res = await topicsSubscribersRetrieve(novu, "<id>", "<value>");
+  const res = await topicsSubscribersRetrieve(novu, "<value>", "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -152,12 +177,40 @@ 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.
+  useTopicsSubscribersRetrieve,
+  useTopicsSubscribersRetrieveSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchTopicsSubscribersRetrieve,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateTopicsSubscribersRetrieve,
+  invalidateAllTopicsSubscribersRetrieve,
+} from "@novu/api/react-query/topicsSubscribersRetrieve.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `externalSubscriberId`                                                                                                                                                         | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The external subscriber id                                                                                                                                                     |
 | `topicKey`                                                                                                                                                                     | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The topic key                                                                                                                                                                  |
+| `externalSubscriberId`                                                                                                                                                         | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The external subscriber id                                                                                                                                                     |
 | `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
@@ -187,7 +240,9 @@ Remove subscribers from a topic
 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 +271,9 @@ import { topicsSubscribersRemove } from "@novu/api/funcs/topicsSubscribersRemove
 // 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() {
@@ -240,6 +297,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.
+  useTopicsSubscribersRemoveMutation
+} from "@novu/api/react-query/topicsSubscribersRemove.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/preferences/README.md

@@ -18,7 +18,9 @@ Get subscriber global and workflow specific preferences
 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 { subscribersPreferencesList } from "@novu/api/funcs/subscribersPreferenc
 // 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.
+  useSubscribersPreferencesList,
+  useSubscribersPreferencesListSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchSubscribersPreferencesList,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateSubscribersPreferencesList,
+  invalidateAllSubscribersPreferencesList,
+} from "@novu/api/react-query/subscribersPreferencesList.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -95,7 +127,9 @@ Update subscriber global or workflow specific preferences
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -121,7 +155,9 @@ import { subscribersPreferencesUpdate } from "@novu/api/funcs/subscribersPrefere
 // 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() {
@@ -142,6 +178,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.
+  useSubscribersPreferencesUpdateMutation
+} from "@novu/api/react-query/subscribersPreferencesUpdate.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/properties/README.md

@@ -17,7 +17,9 @@ Used to update the subscriber isOnline flag.
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -43,7 +45,9 @@ import { subscribersPropertiesUpdateOnlineFlag } from "@novu/api/funcs/subscribe
 // 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() {
@@ -64,6 +68,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.
+  useSubscribersPropertiesUpdateOnlineFlagMutation
+} from "@novu/api/react-query/subscribersPropertiesUpdateOnlineFlag.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/stats/README.md

@@ -18,7 +18,9 @@ Get notification statistics
 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 { notificationsStatsRetrieve } from "@novu/api/funcs/notificationsStatsRe
 // 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.
+  useNotificationsStatsRetrieve,
+  useNotificationsStatsRetrieveSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchNotificationsStatsRetrieve,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateNotificationsStatsRetrieve,
+  invalidateAllNotificationsStatsRetrieve,
+} from "@novu/api/react-query/notificationsStatsRetrieve.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -94,7 +126,9 @@ Get notification graph statistics
 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 { notificationsStatsGraph } from "@novu/api/funcs/notificationsStatsGraph
 // 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.
+  useNotificationsStatsGraph,
+  useNotificationsStatsGraphSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchNotificationsStatsGraph,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateNotificationsStatsGraph,
+  invalidateAllNotificationsStatsGraph,
+} from "@novu/api/react-query/notificationsStatsGraph.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |