@novu/api 0.3.0 → 2.6.6

package/docs/sdks/authentication/README.md

@@ -18,7 +18,9 @@ Handle providers oauth redirect
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -48,7 +50,9 @@ import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/func
 // 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() {
@@ -73,6 +77,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.
+  useSubscribersAuthenticationChatAccessOauthCallBack,
+  useSubscribersAuthenticationChatAccessOauthCallBackSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchSubscribersAuthenticationChatAccessOauthCallBack,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateSubscribersAuthenticationChatAccessOauthCallBack,
+  invalidateAllSubscribersAuthenticationChatAccessOauthCallBack,
+} from "@novu/api/react-query/subscribersAuthenticationChatAccessOauthCallBack.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -106,7 +138,9 @@ Handle chat oauth
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -135,7 +169,9 @@ import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscr
 // 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() {
@@ -159,6 +195,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.
+  useSubscribersAuthenticationChatAccessOauth,
+  useSubscribersAuthenticationChatAccessOauthSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchSubscribersAuthenticationChatAccessOauth,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateSubscribersAuthenticationChatAccessOauth,
+  invalidateAllSubscribersAuthenticationChatAccessOauth,
+} from "@novu/api/react-query/subscribersAuthenticationChatAccessOauth.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/credentials/README.md

@@ -19,7 +19,9 @@ Subscriber credentials associated to the delivery methods such as slack and push
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -59,7 +61,9 @@ import { subscribersCredentialsUpdate } from "@novu/api/funcs/subscribersCredent
 // 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() {
@@ -94,6 +98,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.
+  useSubscribersCredentialsUpdateMutation
+} from "@novu/api/react-query/subscribersCredentialsUpdate.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -130,7 +151,9 @@ Subscriber credentials associated to the delivery methods such as slack and push
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -170,7 +193,9 @@ import { subscribersCredentialsAppend } from "@novu/api/funcs/subscribersCredent
 // 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() {
@@ -205,6 +230,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.
+  useSubscribersCredentialsAppendMutation
+} from "@novu/api/react-query/subscribersCredentialsAppend.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -240,7 +282,9 @@ Delete subscriber credentials such as slack and expo tokens.
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -264,7 +308,9 @@ import { subscribersCredentialsDelete } from "@novu/api/funcs/subscribersCredent
 // 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() {
@@ -283,6 +329,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.
+  useSubscribersCredentialsDeleteMutation
+} from "@novu/api/react-query/subscribersCredentialsDelete.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/integrations/README.md

@@ -25,7 +25,9 @@ Return all the integrations the user has created for that organization. Review v
 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 { integrationsList } from "@novu/api/funcs/integrationsList.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() {
@@ -68,6 +72,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.
+  useIntegrationsList,
+  useIntegrationsListSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchIntegrationsList,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateIntegrationsList,
+  invalidateAllIntegrationsList,
+} from "@novu/api/react-query/integrationsList.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -101,7 +133,9 @@ Create an integration for the current environment the user is based on the API k
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -128,7 +162,9 @@ import { integrationsCreate } from "@novu/api/funcs/integrationsCreate.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() {
@@ -150,6 +186,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.
+  useIntegrationsCreateMutation
+} from "@novu/api/react-query/integrationsCreate.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -184,7 +237,9 @@ Return all the active integrations the user has created for that organization. R
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -208,7 +263,9 @@ import { integrationsListActive } from "@novu/api/funcs/integrationsListActive.j
 // 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() {
@@ -227,6 +284,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.
+  useIntegrationsListActive,
+  useIntegrationsListActiveSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchIntegrationsListActive,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateIntegrationsListActive,
+  invalidateAllIntegrationsListActive,
+} from "@novu/api/react-query/integrationsListActive.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -260,7 +345,9 @@ Update integration
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -284,7 +371,9 @@ import { integrationsUpdate } from "@novu/api/funcs/integrationsUpdate.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() {
@@ -303,6 +392,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.
+  useIntegrationsUpdateMutation
+} from "@novu/api/react-query/integrationsUpdate.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -338,7 +444,9 @@ Delete integration
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -362,7 +470,9 @@ import { integrationsDelete } from "@novu/api/funcs/integrationsDelete.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() {
@@ -381,6 +491,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.
+  useIntegrationsDeleteMutation
+} from "@novu/api/react-query/integrationsDelete.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -415,7 +542,9 @@ Set integration as primary
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -439,7 +568,9 @@ import { integrationsSetAsPrimary } from "@novu/api/funcs/integrationsSetAsPrima
 // 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() {
@@ -458,6 +589,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.
+  useIntegrationsSetAsPrimaryMutation
+} from "@novu/api/react-query/integrationsSetAsPrimary.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |

package/docs/sdks/messages/README.md

@@ -22,7 +22,9 @@ Returns a list of messages, could paginate using the `page` query parameter
 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 { messagesRetrieve } from "@novu/api/funcs/messagesRetrieve.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() {
@@ -65,6 +69,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.
+  useMessagesRetrieve,
+  useMessagesRetrieveSuspense,
+
+  // Utility for prefetching data during server-side rendering and in React
+  // Server Components that will be immediately available to client components
+  // using the hooks.
+  prefetchMessagesRetrieve,
+  
+  // Utilities to invalidate the query cache for this query in response to
+  // mutations and other user actions.
+  invalidateMessagesRetrieve,
+  invalidateAllMessagesRetrieve,
+} from "@novu/api/react-query/messagesRetrieve.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -98,7 +130,9 @@ Deletes a message entity from the Novu platform
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -122,7 +156,9 @@ import { messagesDelete } from "@novu/api/funcs/messagesDelete.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() {
@@ -141,6 +177,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.
+  useMessagesDeleteMutation
+} from "@novu/api/react-query/messagesDelete.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
@@ -175,7 +228,9 @@ Deletes messages entity from the Novu platform using TransactionId of message
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
+  security: {
+    secretKey: "YOUR_SECRET_KEY_HERE",
+  },
 });
 
 async function run() {
@@ -199,7 +254,9 @@ import { messagesDeleteByTransactionId } from "@novu/api/funcs/messagesDeleteByT
 // 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() {
@@ -218,6 +275,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.
+  useMessagesDeleteByTransactionIdMutation
+} from "@novu/api/react-query/messagesDeleteByTransactionId.js";
+```
+
 ### Parameters
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |