@novu/api 0.6.2 → 1.0.0

package/docs/sdks/novu/README.md

@@ -41,9 +41,18 @@ async function run() {
       },
     },
     overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
+      steps: {
+        "email-step": {
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
+            },
+          },
+        },
+      },
+      providers: {
+        "sendgrid": {
+          "templateId": "1234567890",
         },
       },
     },
@@ -83,9 +92,18 @@ async function run() {
       },
     },
     overrides: {
-      "fcm": {
-        "data": {
-          "key": "value",
+      steps: {
+        "email-step": {
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
+            },
+          },
+        },
+      },
+      providers: {
+        "sendgrid": {
+          "templateId": "1234567890",
         },
       },
     },
@@ -234,6 +252,29 @@ async function run() {
         "text": "string",
       },
     },
+    overrides: {
+      steps: {
+        "email-step": {
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
+            },
+          },
+        },
+      },
+      providers: {
+        "sendgrid": {
+          "templateId": "1234567890",
+        },
+      },
+      additionalProperties: {
+        "fcm": {
+          "data": {
+            "key": "value",
+          },
+        },
+      },
+    },
   });
 
   // Handle the result
@@ -266,6 +307,29 @@ async function run() {
         "text": "string",
       },
     },
+    overrides: {
+      steps: {
+        "email-step": {
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
+            },
+          },
+        },
+      },
+      providers: {
+        "sendgrid": {
+          "templateId": "1234567890",
+        },
+      },
+      additionalProperties: {
+        "fcm": {
+          "data": {
+            "key": "value",
+          },
+        },
+      },
+    },
   });
 
   if (!res.ok) {
@@ -333,9 +397,18 @@ async function run() {
           },
         },
         overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
+          steps: {
+            "email-step": {
+              providers: {
+                "sendgrid": {
+                  "templateId": "1234567890",
+                },
+              },
+            },
+          },
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
             },
           },
         },
@@ -352,9 +425,18 @@ async function run() {
           },
         },
         overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
+          steps: {
+            "email-step": {
+              providers: {
+                "sendgrid": {
+                  "templateId": "1234567890",
+                },
+              },
+            },
+          },
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
             },
           },
         },
@@ -374,9 +456,18 @@ async function run() {
           },
         },
         overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
+          steps: {
+            "email-step": {
+              providers: {
+                "sendgrid": {
+                  "templateId": "1234567890",
+                },
+              },
+            },
+          },
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
             },
           },
         },
@@ -421,9 +512,18 @@ async function run() {
           },
         },
         overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
+          steps: {
+            "email-step": {
+              providers: {
+                "sendgrid": {
+                  "templateId": "1234567890",
+                },
+              },
+            },
+          },
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
             },
           },
         },
@@ -440,9 +540,18 @@ async function run() {
           },
         },
         overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
+          steps: {
+            "email-step": {
+              providers: {
+                "sendgrid": {
+                  "templateId": "1234567890",
+                },
+              },
+            },
+          },
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
             },
           },
         },
@@ -462,9 +571,18 @@ async function run() {
           },
         },
         overrides: {
-          "fcm": {
-            "data": {
-              "key": "value",
+          steps: {
+            "email-step": {
+              providers: {
+                "sendgrid": {
+                  "templateId": "1234567890",
+                },
+              },
+            },
+          },
+          providers: {
+            "sendgrid": {
+              "templateId": "1234567890",
             },
           },
         },

package/docs/sdks/novumessages/README.md

@@ -6,7 +6,7 @@
 ### Available Operations
 
 * [updateAsSeen](#updateasseen) - Mark message action as seen
-* [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
+* [markAll](#markall) - Marks all the subscriber messages as read, unread, seen or unseen.
 * [markAllAs](#markallas) - Mark a subscriber messages as seen, read, unseen or unread
 
 ## updateAsSeen
@@ -101,7 +101,7 @@ run();
 
 ## markAll
 
-Marks all the subscriber messages as read, unread, seen or unseen. Optionally you can pass feed id (or array) to mark messages of a particular feed.
+Marks all the subscriber messages as read, unread, seen or unseen.
 
 ### Example Usage
 

package/docs/sdks/novusubscribers/README.md

@@ -5,99 +5,7 @@
 
 ### Available Operations
 
-* [assign](#assign) - Subscribers addition
 * [retrieve](#retrieve) - Check topic subscriber
-* [remove](#remove) - Subscribers removal
-
-## assign
-
-Add subscribers to a topic by key
-
-### Example Usage
-
-```typescript
-import { Novu } from "@novu/api";
-
-const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
-});
-
-async function run() {
-  const result = await novu.topics.subscribers.assign({
-    subscribers: [
-      "<value>",
-      "<value>",
-      "<value>",
-    ],
-  }, "<value>");
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NovuCore } from "@novu/api/core.js";
-import { topicsSubscribersAssign } from "@novu/api/funcs/topicsSubscribersAssign.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",
-});
-
-async function run() {
-  const res = await topicsSubscribersAssign(novu, {
-    subscribers: [
-      "<value>",
-      "<value>",
-      "<value>",
-    ],
-  }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `topicKey`                                                                                                                                                                     | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The topic key                                                                                                                                                                  |
-| `addSubscribersRequestDto`                                                                                                                                                     | [components.AddSubscribersRequestDto](../../models/components/addsubscribersrequestdto.md)                                                                                     | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.TopicsControllerAssignResponse](../../models/operations/topicscontrollerassignresponse.md)\>**
-
-### Errors
-
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| 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                               | \*/\*                                  |
 
 ## retrieve
 
@@ -165,95 +73,7 @@ run();
 
 ### Response
 
-**Promise\<[operations.TopicsControllerGetTopicSubscriberResponse](../../models/operations/topicscontrollergettopicsubscriberresponse.md)\>**
-
-### Errors
-
-| Error Type                             | Status Code                            | Content Type                           |
-| -------------------------------------- | -------------------------------------- | -------------------------------------- |
-| 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                               | \*/\*                                  |
-
-## remove
-
-Remove subscribers from a topic
-
-### Example Usage
-
-```typescript
-import { Novu } from "@novu/api";
-
-const novu = new Novu({
-  secretKey: "YOUR_SECRET_KEY_HERE",
-});
-
-async function run() {
-  const result = await novu.topics.subscribers.remove({
-    subscribers: [
-      "<value>",
-      "<value>",
-    ],
-  }, "<value>");
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Standalone function
-
-The standalone function version of this method:
-
-```typescript
-import { NovuCore } from "@novu/api/core.js";
-import { topicsSubscribersRemove } from "@novu/api/funcs/topicsSubscribersRemove.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",
-});
-
-async function run() {
-  const res = await topicsSubscribersRemove(novu, {
-    subscribers: [
-      "<value>",
-      "<value>",
-    ],
-  }, "<value>");
-
-  if (!res.ok) {
-    throw res.error;
-  }
-
-  const { value: result } = res;
-
-  // Handle the result
-  console.log(result);
-}
-
-run();
-```
-
-### Parameters
-
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `topicKey`                                                                                                                                                                     | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | The topic key                                                                                                                                                                  |
-| `removeSubscribersRequestDto`                                                                                                                                                  | [components.RemoveSubscribersRequestDto](../../models/components/removesubscribersrequestdto.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `idempotencyKey`                                                                                                                                                               | *string*                                                                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | A header for idempotency purposes                                                                                                                                              |
-| `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
-| `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
-| `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
-
-### Response
-
-**Promise\<[operations.TopicsControllerRemoveSubscribersResponse](../../models/operations/topicscontrollerremovesubscribersresponse.md)\>**
+**Promise\<[operations.TopicsV1ControllerGetTopicSubscriberResponse](../../models/operations/topicsv1controllergettopicsubscriberresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/novutopics/README.md

@@ -0,0 +1,88 @@
+# NovuTopics
+(*subscribers.topics*)
+
+## Overview
+
+### Available Operations
+
+* [list](#list) - List topics a subscriber is subscribed to
+
+## list
+
+List topic subscriptions for a subscriber with pagination and filtering
+
+### Example Usage
+
+```typescript
+import { Novu } from "@novu/api";
+
+const novu = new Novu({
+  secretKey: "YOUR_SECRET_KEY_HERE",
+});
+
+async function run() {
+  const result = await novu.subscribers.topics.list({
+    subscriberId: "<id>",
+  });
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Standalone function
+
+The standalone function version of this method:
+
+```typescript
+import { NovuCore } from "@novu/api/core.js";
+import { subscribersTopicsList } from "@novu/api/funcs/subscribersTopicsList.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",
+});
+
+async function run() {
+  const res = await subscribersTopicsList(novu, {
+    subscriberId: "<id>",
+  });
+
+  if (!res.ok) {
+    throw res.error;
+  }
+
+  const { value: result } = res;
+
+  // Handle the result
+  console.log(result);
+}
+
+run();
+```
+
+### Parameters
+
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `request`                                                                                                                                                                      | [operations.SubscribersControllerListSubscriberTopicsRequest](../../models/operations/subscriberscontrollerlistsubscribertopicsrequest.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.SubscribersControllerListSubscriberTopicsResponse](../../models/operations/subscriberscontrollerlistsubscribertopicsresponse.md)\>**
+
+### Errors
+
+| Error Type                             | Status Code                            | Content Type                           |
+| -------------------------------------- | -------------------------------------- | -------------------------------------- |
+| 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                               | \*/\*                                  |

package/docs/sdks/subscribers/README.md

@@ -95,7 +95,7 @@ run();
 
 ## create
 
-Create subscriber with the given data
+Create subscriber with the given data, if the subscriber already exists, it will be updated
 
 ### Example Usage