npm - @novu/api - Versions diffs - 0.1.0 → 0.1.2 - Mend

@novu/api 0.1.0 → 0.1.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (530) hide show

package/FUNCTIONS.md CHANGED Viewed

@@ -26,22 +26,28 @@ import { SDKValidationError } from "@novu/api/models/errors/sdkvalidationerror.j
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const res = await trigger(novu, {
-    name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
   switch (true) {

package/README.md CHANGED Viewed

@@ -1,5 +1,5 @@
 <div align="center">
-  <img src="https://github.com/speakeasy-sdks/novu-ts/assets/68016351/dabaa829-32c8-451b-b912-0fa1d10300bd" width="500">
+  <img src="https://raw.githubusercontent.com/novuhq/novu-ts/HEAD/assets/banner.png" width="500">
   <p>Novu is an open-source notification infrastructure.</p>
   <a href="https://docs.novu.co/api-reference/overview"><img src="https://img.shields.io/static/v1?label=Docs&message=API Ref&color=000000&style=for-the-badge" /></a>
   <a href="https://opensource.org/licenses/MIT"><img src="https://img.shields.io/badge/License-MIT-blue.svg?style=for-the-badge" /></a>
@@ -83,22 +83,28 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const result = await novu.trigger({
-    name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
   // Handle the result
@@ -115,39 +121,71 @@ run();
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const result = await novu.triggerBulk({
     events: [
       {
-        name: "workflow_identifier",
-        to: [
-          {
-            topicKey: "<value>",
-            type: "Topic",
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
           },
-          {
-            subscriberId: "<id>",
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
           },
-        ],
-      },
-      {
-        name: "workflow_identifier",
-        to: [],
+        },
+        to: {
+          subscriberId: "<id>",
+        },
       },
       {
-        name: "workflow_identifier",
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
+          },
+        },
         to: [
           {
             topicKey: "<value>",
-            type: "Topic",
+            type: "Subscriber",
           },
-          {
-            topicKey: "<value>",
-            type: "Topic",
+        ],
+      },
+      {
+        workflowId: "workflow_identifier",
+        payload: {
+          "comment_id": "string",
+          "post": {
+            "text": "string",
+          },
+        },
+        overrides: {
+          "fcm": {
+            "data": {
+              "key": "value",
+            },
           },
+        },
+        to: [
+          "SUBSCRIBER_ID",
+          "SUBSCRIBER_ID",
         ],
       },
     ],
@@ -167,7 +205,7 @@ run();
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
@@ -195,7 +233,7 @@ run();
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
@@ -256,10 +294,14 @@ run();
 * [list](docs/sdks/subscribers/README.md#list) - Get subscribers
 * [create](docs/sdks/subscribers/README.md#create) - Create subscriber
-* [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
+* [retrieveLegacy](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
 * [update](docs/sdks/subscribers/README.md#update) - Update subscriber
-* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
+* [~~deleteLegacy~~](docs/sdks/subscribers/README.md#deletelegacy) - Delete subscriber :warning: **Deprecated**
 * [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
+* [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
+* [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
+* [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
+* [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
 #### [subscribers.authentication](docs/sdks/authentication/README.md)
@@ -355,12 +397,15 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`subscribersMessagesUpdateAsSeen`](docs/sdks/novumessages/README.md#updateasseen) - Mark message action as seen
 - [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Get in-app notification feed for a particular subscriber
 - [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed
+- [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Patch subscriber
 - [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Get subscriber preferences
 - [`subscribersPreferencesRetrieveByLevel`](docs/sdks/preferences/README.md#retrievebylevel) - Get subscriber preferences by level
 - [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber preference
 - [`subscribersPreferencesUpdateGlobal`](docs/sdks/preferences/README.md#updateglobal) - Update subscriber global preferences
 - [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
 - [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
+- [`subscribersRetrieveLegacy`](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
+- [`subscribersSearch`](docs/sdks/subscribers/README.md#search) - Search for subscribers
 - [`subscribersUpdate`](docs/sdks/subscribers/README.md#update) - Update subscriber
 - [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
 - [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
@@ -373,6 +418,7 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
 - [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
 - [`triggerBulk`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
+- ~~[`subscribersDeleteLegacy`](docs/sdks/subscribers/README.md#deletelegacy)~~ - Delete subscriber :warning: **Deprecated**
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -393,11 +439,11 @@ Here's an example of one such pagination call:
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
-  const result = await novu.subscribers.list();
+  const result = await novu.subscribers.list(10);
   for await (const page of result) {
     // Handle the page
@@ -417,8 +463,8 @@ Some methods specify known errors which can be thrown. All the known errors are
 | Error Type                | Status Code                            | Content Type     |
 | ------------------------- | -------------------------------------- | ---------------- |
-| errors.ErrorDto           | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
 | errors.ErrorDto           | 414                                    | application/json |
+| errors.ErrorDto           | 400, 401, 403, 404, 405, 409, 413, 415 | application/json |
 | errors.ValidationErrorDto | 422                                    | application/json |
 | errors.ErrorDto           | 500                                    | application/json |
 | errors.SDKError           | 4XX, 5XX                               | \*/\*            |
@@ -434,24 +480,30 @@ import {
 } from "@novu/api/models/errors";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   let result;
   try {
     result = await novu.trigger({
-      name: "workflow_identifier",
-      to: [
-        {
-          topicKey: "<value>",
-          type: "Topic",
+      workflowId: "workflow_identifier",
+      payload: {
+        "comment_id": "string",
+        "post": {
+          "text": "string",
         },
-        {
-          topicKey: "<value>",
-          type: "Topic",
+      },
+      overrides: {
+        "fcm": {
+          "data": {
+            "key": "value",
+          },
         },
-      ],
+      },
+      to: {
+        subscriberId: "<id>",
+      },
     });
     // Handle the result
@@ -530,22 +582,28 @@ import { Novu } from "@novu/api";
 const novu = new Novu({
   serverIdx: 1,
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const result = await novu.trigger({
-    name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
   // Handle the result
@@ -564,22 +622,28 @@ import { Novu } from "@novu/api";
 const novu = new Novu({
   serverURL: "https://api.novu.co",
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const result = await novu.trigger({
-    name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
   // Handle the result
@@ -647,31 +711,37 @@ const sdk = new Novu({ httpClient });
 This SDK supports the following security scheme globally:
-| Name     | Type   | Scheme  |
-| -------- | ------ | ------- |
-| `apiKey` | apiKey | API key |
+| Name        | Type   | Scheme  |
+| ----------- | ------ | ------- |
+| `secretKey` | apiKey | API key |
-To authenticate with the API the `apiKey` parameter must be set when initializing the SDK client instance. For example:
+To authenticate with the API the `secretKey` parameter must be set when initializing the SDK client instance. For example:
 ```typescript
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const result = await novu.trigger({
-    name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
   // Handle the result
@@ -693,22 +763,28 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const result = await novu.trigger({
-    name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   }, {
     retries: {
       strategy: "backoff",
@@ -745,22 +821,28 @@ const novu = new Novu({
     },
     retryConnectionErrors: false,
   },
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
   const result = await novu.trigger({
-    name: "workflow_identifier",
-    to: [
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    workflowId: "workflow_identifier",
+    payload: {
+      "comment_id": "string",
+      "post": {
+        "text": "string",
       },
-      {
-        topicKey: "<value>",
-        type: "Topic",
+    },
+    overrides: {
+      "fcm": {
+        "data": {
+          "key": "value",
+        },
       },
-    ],
+    },
+    to: {
+      subscriberId: "<id>",
+    },
   });
   // Handle the result

package/docs/sdks/authentication/README.md CHANGED Viewed

@@ -18,7 +18,7 @@ Handle providers oauth redirect
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
@@ -48,7 +48,7 @@ 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({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
@@ -77,21 +77,21 @@ 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.SubscribersV1ControllerChatOauthCallbackRequest](../../models/operations/subscribersv1controllerchatoauthcallbackrequest.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.SubscribersControllerChatOauthCallbackResponse](../../models/operations/subscriberscontrollerchatoauthcallbackresponse.md)\>**
+**Promise\<[operations.SubscribersV1ControllerChatOauthCallbackResponse](../../models/operations/subscribersv1controllerchatoauthcallbackresponse.md)\>**
 ### Errors
 | Error Type                             | Status Code                            | Content Type                           |
 | -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
 | errors.ErrorDto                        | 414                                    | application/json                       |
+| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
 | errors.ValidationErrorDto              | 422                                    | application/json                       |
 | errors.ErrorDto                        | 500                                    | application/json                       |
 | errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
@@ -106,7 +106,7 @@ Handle chat oauth
 import { Novu } from "@novu/api";
 const novu = new Novu({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
@@ -135,7 +135,7 @@ 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({
-  apiKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "<YOUR_API_KEY_HERE>",
 });
 async function run() {
@@ -163,21 +163,21 @@ 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.SubscribersV1ControllerChatAccessOauthRequest](../../models/operations/subscribersv1controllerchataccessoauthrequest.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.SubscribersControllerChatAccessOauthResponse](../../models/operations/subscriberscontrollerchataccessoauthresponse.md)\>**
+**Promise\<[operations.SubscribersV1ControllerChatAccessOauthResponse](../../models/operations/subscribersv1controllerchataccessoauthresponse.md)\>**
 ### Errors
 | Error Type                             | Status Code                            | Content Type                           |
 | -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
 | errors.ErrorDto                        | 414                                    | application/json                       |
+| errors.ErrorDto                        | 400, 401, 403, 404, 405, 409, 413, 415 | application/json                       |
 | errors.ValidationErrorDto              | 422                                    | application/json                       |
 | errors.ErrorDto                        | 500                                    | application/json                       |
 | errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |