@novu/api 0.0.1-alpha.10 → 0.0.1-alpha.104

package/RUNTIMES.md

@@ -0,0 +1,22 @@
+# Supported JavaScript runtimes
+
+This SDK is intended to be used in JavaScript runtimes that support the following features:
+
+* [Web Fetch API][web-fetch]
+* [Web Streams API][web-streams] and in particular `ReadableStream`
+* [Async iterables][async-iter] using `Symbol.asyncIterator`
+
+[web-fetch]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
+[web-streams]: https://developer.mozilla.org/en-US/docs/Web/API/Streams_API
+[async-iter]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Iteration_protocols#the_async_iterator_and_async_iterable_protocols
+
+Runtime environments that are explicitly supported are:
+
+- Evergreen browsers which include: Chrome, Safari, Edge, Firefox
+- Node.js active and maintenance LTS releases
+  - Currently, this is v18 and v20
+- Bun v1 and above
+- Deno v1.39
+  - Note that Deno does not currently have native support for streaming file uploads backed by the filesystem ([issue link][deno-file-streaming])
+
+[deno-file-streaming]: https://github.com/denoland/deno/issues/11018

package/docs/sdks/authentication/README.md

@@ -5,12 +5,12 @@
 
 ### Available Operations
 
-* [chatAccessOauth](#chataccessoauth) - Handle chat oauth
 * [chatAccessOauthCallBack](#chataccessoauthcallback) - Handle providers oauth redirect
+* [chatAccessOauth](#chataccessoauth) - Handle chat oauth
 
-## chatAccessOauth
+## chatAccessOauthCallBack
 
-Handle chat oauth
+Handle providers oauth redirect
 
 ### Example Usage
 
@@ -22,14 +22,16 @@ const novu = new Novu({
 });
 
 async function run() {
-  await novu.subscribers.authentication.chatAccessOauth({
-    subscriberId: "<value>",
-    providerId: "<value>",
+  const result = await novu.subscribers.authentication.chatAccessOauthCallBack({
+    subscriberId: "<id>",
+    providerId: "<id>",
+    code: "<value>",
     hmacHash: "<value>",
-    environmentId: "<value>",
+    environmentId: "<id>",
   });
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -41,7 +43,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauth.js";
+import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauthCallBack.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -50,11 +52,12 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersAuthenticationChatAccessOauth(novu, {
-    subscriberId: "<value>",
-    providerId: "<value>",
+  const res = await subscribersAuthenticationChatAccessOauthCallBack(novu, {
+    subscriberId: "<id>",
+    providerId: "<id>",
+    code: "<value>",
     hmacHash: "<value>",
-    environmentId: "<value>",
+    environmentId: "<id>",
   });
 
   if (!res.ok) {
@@ -63,7 +66,8 @@ async function run() {
 
   const { value: result } = res;
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -73,25 +77,25 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerChatAccessOauthRequest](../../models/operations/subscriberscontrollerchataccessoauthrequest.md)                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.SubscribersControllerChatOauthCallbackRequest](../../models/operations/subscriberscontrollerchatoauthcallbackrequest.md)                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `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. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<void\>**
+**Promise\<[operations.SubscribersControllerChatOauthCallbackResponse](../../models/operations/subscriberscontrollerchatoauthcallbackresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
-## chatAccessOauthCallBack
+## chatAccessOauth
 
-Handle providers oauth redirect
+Handle chat oauth
 
 ### Example Usage
 
@@ -103,16 +107,15 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.authentication.chatAccessOauthCallBack({
-    subscriberId: "<value>",
-    providerId: "<value>",
-    code: "<value>",
+  const result = await novu.subscribers.authentication.chatAccessOauth({
+    subscriberId: "<id>",
+    providerId: "<id>",
     hmacHash: "<value>",
-    environmentId: "<value>",
+    environmentId: "<id>",
   });
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -124,7 +127,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauthCallBack.js";
+import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauth.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -133,12 +136,11 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersAuthenticationChatAccessOauthCallBack(novu, {
-    subscriberId: "<value>",
-    providerId: "<value>",
-    code: "<value>",
+  const res = await subscribersAuthenticationChatAccessOauth(novu, {
+    subscriberId: "<id>",
+    providerId: "<id>",
     hmacHash: "<value>",
-    environmentId: "<value>",
+    environmentId: "<id>",
   });
 
   if (!res.ok) {
@@ -148,7 +150,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -158,17 +160,18 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersControllerChatOauthCallbackRequest](../../models/operations/subscriberscontrollerchatoauthcallbackrequest.md)                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.SubscribersControllerChatAccessOauthRequest](../../models/operations/subscriberscontrollerchataccessoauthrequest.md)                                               | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `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. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.SubscribersControllerChatOauthCallbackResponseBody](../../models/operations/subscriberscontrollerchatoauthcallbackresponsebody.md)\>**
+**Promise\<[operations.SubscribersControllerChatAccessOauthResponse](../../models/operations/subscriberscontrollerchataccessoauthresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |

package/docs/sdks/credentials/README.md

@@ -5,14 +5,13 @@
 
 ### Available Operations
 
+* [update](#update) - Update subscriber credentials
 * [append](#append) - Modify subscriber credentials
 * [delete](#delete) - Delete subscriber credentials by providerId
-* [update](#update) - Update subscriber credentials
 
-## append
+## update
 
 Subscriber credentials associated to the delivery methods such as slack and push tokens.
-    This endpoint appends provided credentials and deviceTokens to the existing ones.
 
 ### Example Usage
 
@@ -24,15 +23,15 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.credentials.append("<value>", {
+  const result = await novu.subscribers.credentials.update({
+    providerId: "pushpad",
     credentials: {
-      webhookUrl: "<value>",
+      webhookUrl: "https://grown-worth.name",
     },
-    providerId: 3462.44,
-  });
+  }, "<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -44,7 +43,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersCredentialsAppend } from "@novu/api/funcs/subscribersCredentialsAppend.js";
+import { subscribersCredentialsUpdate } from "@novu/api/funcs/subscribersCredentialsUpdate.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -53,12 +52,12 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersCredentialsAppend(novu, "<value>", {
+  const res = await subscribersCredentialsUpdate(novu, {
+    providerId: "pushpad",
     credentials: {
-      webhookUrl: "<value>",
+      webhookUrl: "https://grown-worth.name",
     },
-    providerId: 5829.63,
-  });
+  }, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -67,7 +66,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -85,18 +84,20 @@ run();
 
 ### Response
 
-**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>**
+**Promise\<[operations.SubscribersControllerUpdateSubscriberChannelResponse](../../models/operations/subscriberscontrollerupdatesubscriberchannelresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
+## append
 
-## delete
+Subscriber credentials associated to the delivery methods such as slack and push tokens.
 
-Delete subscriber credentials such as slack and expo tokens.
+    This endpoint appends provided credentials and deviceTokens to the existing ones.
 
 ### Example Usage
 
@@ -108,9 +109,15 @@ const novu = new Novu({
 });
 
 async function run() {
-  await novu.subscribers.credentials.delete("<value>", "<value>");
+  const result = await novu.subscribers.credentials.append({
+    providerId: "zulip",
+    credentials: {
+      webhookUrl: "https://talkative-pop.org",
+    },
+  }, "<id>");
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -122,7 +129,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersCredentialsDelete } from "@novu/api/funcs/subscribersCredentialsDelete.js";
+import { subscribersCredentialsAppend } from "@novu/api/funcs/subscribersCredentialsAppend.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -131,7 +138,12 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersCredentialsDelete(novu, "<value>", "<value>");
+  const res = await subscribersCredentialsAppend(novu, {
+    providerId: "zulip",
+    credentials: {
+      webhookUrl: "https://talkative-pop.org",
+    },
+  }, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -139,7 +151,8 @@ async function run() {
 
   const { value: result } = res;
 
-  
+  // Handle the result
+  console.log(result);
 }
 
 run();
@@ -150,25 +163,25 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `providerId`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateSubscriberChannelRequestDto`                                                                                                                                            | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
 | `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. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<void\>**
+**Promise\<[operations.SubscribersControllerModifySubscriberChannelResponse](../../models/operations/subscriberscontrollermodifysubscriberchannelresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |
 
-## update
+## delete
 
-Subscriber credentials associated to the delivery methods such as slack and push tokens.
+Delete subscriber credentials such as slack and expo tokens.
 
 ### Example Usage
 
@@ -180,15 +193,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.credentials.update("<value>", {
-    credentials: {
-      webhookUrl: "<value>",
-    },
-    providerId: 8574.78,
-  });
+  const result = await novu.subscribers.credentials.delete("<id>", "<id>");
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -200,7 +208,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersCredentialsUpdate } from "@novu/api/funcs/subscribersCredentialsUpdate.js";
+import { subscribersCredentialsDelete } from "@novu/api/funcs/subscribersCredentialsDelete.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -209,12 +217,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersCredentialsUpdate(novu, "<value>", {
-    credentials: {
-      webhookUrl: "<value>",
-    },
-    providerId: 5971.29,
-  });
+  const res = await subscribersCredentialsDelete(novu, "<id>", "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -223,7 +226,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -234,17 +237,18 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `subscriberId`                                                                                                                                                                 | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `updateSubscriberChannelRequestDto`                                                                                                                                            | [components.UpdateSubscriberChannelRequestDto](../../models/components/updatesubscriberchannelrequestdto.md)                                                                   | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `providerId`                                                                                                                                                                   | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
 | `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. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.SubscriberResponseDto](../../models/components/subscriberresponsedto.md)\>**
+**Promise\<[operations.SubscribersControllerDeleteSubscriberCredentialsResponse](../../models/operations/subscriberscontrollerdeletesubscribercredentialsresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
-| --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| Error Type       | Status Code      | Content Type     |
+| ---------------- | ---------------- | ---------------- |
+| errors.ErrorDto  | 400, 404, 409    | application/json |
+| errors.SDKError  | 4XX, 5XX         | \*/\*            |