@novu/api 1.0.0 → 1.1.0

package/docs/sdks/credentials/README.md

@@ -5,13 +5,14 @@
 
 ### Available Operations
 
-* [update](#update) - Update subscriber credentials
-* [append](#append) - Modify subscriber credentials
-* [delete](#delete) - Delete subscriber credentials by providerId
+* [update](#update) - Update provider credentials
+* [append](#append) - Upsert provider credentials
+* [delete](#delete) - Delete provider credentials
 
 ## update
 
-Subscriber credentials associated to the delivery methods such as slack and push tokens.
+Update credentials for a provider such as slack and push tokens. 
+      **providerId** is required field. This API appends the **deviceTokens** to the existing ones.
 
 ### Example Usage
 
@@ -24,7 +25,7 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.subscribers.credentials.update({
-    providerId: "pushpad",
+    providerId: "slack",
     credentials: {
       webhookUrl: "https://example.com/webhook",
       channel: "general",
@@ -64,7 +65,7 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersCredentialsUpdate(novu, {
-    providerId: "pushpad",
+    providerId: "slack",
     credentials: {
       webhookUrl: "https://example.com/webhook",
       channel: "general",
@@ -121,8 +122,8 @@ run();
 
 ## append
 
-Subscriber credentials associated to the delivery methods such as slack and push tokens.
-    This endpoint appends provided credentials and deviceTokens to the existing ones.
+Update credentials for a provider such as **slack** and **FCM**. 
+      **providerId** is required field. This API replaces the existing deviceTokens with the provided ones.
 
 ### Example Usage
 
@@ -135,7 +136,7 @@ const novu = new Novu({
 
 async function run() {
   const result = await novu.subscribers.credentials.append({
-    providerId: "zulip",
+    providerId: "one-signal",
     credentials: {
       webhookUrl: "https://example.com/webhook",
       channel: "general",
@@ -175,7 +176,7 @@ const novu = new NovuCore({
 
 async function run() {
   const res = await subscribersCredentialsAppend(novu, {
-    providerId: "zulip",
+    providerId: "one-signal",
     credentials: {
       webhookUrl: "https://example.com/webhook",
       channel: "general",
@@ -232,7 +233,8 @@ run();
 
 ## delete
 
-Delete subscriber credentials such as slack and expo tokens.
+Delete subscriber credentials for a provider such as **slack** and **FCM** by **providerId**. 
+    This action is irreversible and will remove the credentials for the provider for particular **subscriberId**.
 
 ### Example Usage
 

package/docs/sdks/integrations/README.md

@@ -8,16 +8,16 @@ With the help of the Integration Store, you can easily integrate your favorite d
 
 ### Available Operations
 
-* [list](#list) - Get integrations
-* [create](#create) - Create integration
-* [update](#update) - Update integration
-* [delete](#delete) - Delete integration
-* [setAsPrimary](#setasprimary) - Set integration as primary
-* [listActive](#listactive) - Get active integrations
+* [list](#list) - List all integrations
+* [create](#create) - Create an integration
+* [update](#update) - Update an integration
+* [delete](#delete) - Delete an integration
+* [setAsPrimary](#setasprimary) - Update integration as primary
+* [listActive](#listactive) - List active integrations
 
 ## list
 
-Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+List all the channels integrations created in the organization
 
 ### Example Usage
 
@@ -93,7 +93,8 @@ run();
 
 ## create
 
-Create an integration for the current environment the user is based on the API key provided
+Create an integration for the current environment the user is based on the API key provided. 
+    Each provider supports different credentials, check the provider documentation for more details.
 
 ### Example Usage
 
@@ -107,7 +108,7 @@ const novu = new Novu({
 async function run() {
   const result = await novu.integrations.create({
     providerId: "<id>",
-    channel: "sms",
+    channel: "email",
   });
 
   // Handle the result
@@ -134,7 +135,7 @@ const novu = new NovuCore({
 async function run() {
   const res = await integrationsCreate(novu, {
     providerId: "<id>",
-    channel: "sms",
+    channel: "email",
   });
 
   if (!res.ok) {
@@ -176,7 +177,8 @@ run();
 
 ## update
 
-Update integration
+Update an integration by its unique key identifier **integrationId**. 
+    Each provider supports different credentials, check the provider documentation for more details.
 
 ### Example Usage
 
@@ -254,7 +256,8 @@ run();
 
 ## delete
 
-Delete integration
+Delete an integration by its unique key identifier **integrationId**. 
+    This action is irreversible.
 
 ### Example Usage
 
@@ -331,7 +334,9 @@ run();
 
 ## setAsPrimary
 
-Set integration as primary
+Update an integration as **primary** by its unique key identifier **integrationId**. 
+    This API will set the integration as primary for that channel in the current environment. 
+    Primary integration is used to deliver notification for sms and email channels in the workflow.
 
 ### Example Usage
 
@@ -408,7 +413,7 @@ run();
 
 ## listActive
 
-Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+List all the active integrations created in the organization
 
 ### Example Usage
 

package/docs/sdks/messages/README.md

@@ -8,13 +8,15 @@ A message in Novu represents a notification delivered to a recipient on a partic
 
 ### Available Operations
 
-* [retrieve](#retrieve) - Get messages
-* [delete](#delete) - Delete message
+* [retrieve](#retrieve) - List all messages
+* [delete](#delete) - Delete a message
 * [deleteByTransactionId](#deletebytransactionid) - Delete messages by transactionId
 
 ## retrieve
 
-Returns a list of messages, could paginate using the `page` query parameter
+List all messages for the current environment. 
+    This API supports filtering by **channel**, **subscriberId**, and **transactionId**. 
+    This API returns a paginated list of messages.
 
 ### Example Usage
 
@@ -90,7 +92,8 @@ run();
 
 ## delete
 
-Deletes a message entity from the Novu platform
+Delete a message entity from the Novu platform by **messageId**. 
+    This action is irreversible. **messageId** is required and of mongodbId type.
 
 ### Example Usage
 
@@ -102,7 +105,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.messages.delete("<id>");
+  const result = await novu.messages.delete("507f1f77bcf86cd799439011");
 
   // Handle the result
   console.log(result);
@@ -126,7 +129,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await messagesDelete(novu, "<id>");
+  const res = await messagesDelete(novu, "507f1f77bcf86cd799439011");
 
   if (!res.ok) {
     throw res.error;
@@ -143,13 +146,13 @@ run();
 
 ### Parameters
 
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `messageId`                                                                                                                                                                    | *string*                                                                                                                                                                       | :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.                                                                                                               |
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    | Example                                                                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `messageId`                                                                                                                                                                    | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            | [object Object]                                                                                                                                                                |
+| `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
 
@@ -167,7 +170,8 @@ run();
 
 ## deleteByTransactionId
 
-Deletes messages entity from the Novu platform using TransactionId of message
+Delete multiple messages from the Novu platform using **transactionId** of triggered event. 
+    This API supports filtering by **channel** and delete all messages associated with the **transactionId**.
 
 ### Example Usage
 
@@ -179,7 +183,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.messages.deleteByTransactionId("<id>");
+  const result = await novu.messages.deleteByTransactionId("507f1f77bcf86cd799439011");
 
   // Handle the result
   console.log(result);
@@ -203,7 +207,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await messagesDeleteByTransactionId(novu, "<id>");
+  const res = await messagesDeleteByTransactionId(novu, "507f1f77bcf86cd799439011");
 
   if (!res.ok) {
     throw res.error;
@@ -220,14 +224,14 @@ run();
 
 ### Parameters
 
-| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
-| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `transactionId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `channel`                                                                                                                                                                      | [operations.Channel](../../models/operations/channel.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | The channel of the message to be deleted                                                                                                                                       |
-| `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.                                                                                                               |
+| Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    | Example                                                                                                                                                                        |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `transactionId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            | [object Object]                                                                                                                                                                |
+| `channel`                                                                                                                                                                      | [operations.Channel](../../models/operations/channel.md)                                                                                                                       | :heavy_minus_sign:                                                                                                                                                             | The channel of the message to be deleted                                                                                                                                       |                                                                                                                                                                                |
+| `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
 

package/docs/sdks/notifications/README.md

@@ -5,12 +5,15 @@
 
 ### Available Operations
 
-* [list](#list) - Get notifications
-* [retrieve](#retrieve) - Get notification
+* [list](#list) - List all events
+* [retrieve](#retrieve) - Retrieve an event
 
 ## list
 
-Get notifications
+List all notification events (triggered events) for the current environment. 
+    This API supports filtering by **channels**, **templates**, **emails**, **subscriberIds**, **transactionId**, **topicKey**. 
+    Checkout all available filters in the query section.
+    This API returns event triggers, to list each channel notifications, check messages APIs.
 
 ### Example Usage
 
@@ -86,7 +89,9 @@ run();
 
 ## retrieve
 
-Get notification
+Retrieve an event by its unique key identifier **notificationId**. 
+    Here **notificationId** is of mongodbId type. 
+    This API returns the event details - execution logs, status, actual notification (message) generated by each workflow step.
 
 ### Example Usage
 

package/docs/sdks/novu/README.md

@@ -40,25 +40,8 @@ async function run() {
         "text": "string",
       },
     },
-    overrides: {
-      steps: {
-        "email-step": {
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-      },
-      providers: {
-        "sendgrid": {
-          "templateId": "1234567890",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
-    },
+    overrides: {},
+    to: "SUBSCRIBER_ID",
   });
 
   // Handle the result
@@ -91,25 +74,8 @@ async function run() {
         "text": "string",
       },
     },
-    overrides: {
-      steps: {
-        "email-step": {
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-      },
-      providers: {
-        "sendgrid": {
-          "templateId": "1234567890",
-        },
-      },
-    },
-    to: {
-      subscriberId: "<id>",
-    },
+    overrides: {},
+    to: "SUBSCRIBER_ID",
   });
 
   if (!res.ok) {
@@ -253,20 +219,6 @@ async function run() {
       },
     },
     overrides: {
-      steps: {
-        "email-step": {
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-      },
-      providers: {
-        "sendgrid": {
-          "templateId": "1234567890",
-        },
-      },
       additionalProperties: {
         "fcm": {
           "data": {
@@ -308,20 +260,6 @@ async function run() {
       },
     },
     overrides: {
-      steps: {
-        "email-step": {
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-      },
-      providers: {
-        "sendgrid": {
-          "templateId": "1234567890",
-        },
-      },
       additionalProperties: {
         "fcm": {
           "data": {
@@ -396,25 +334,8 @@ async function run() {
             "text": "string",
           },
         },
-        overrides: {
-          steps: {
-            "email-step": {
-              providers: {
-                "sendgrid": {
-                  "templateId": "1234567890",
-                },
-              },
-            },
-          },
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-        to: {
-          subscriberId: "<id>",
-        },
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
       {
         workflowId: "workflow_identifier",
@@ -424,28 +345,8 @@ async function run() {
             "text": "string",
           },
         },
-        overrides: {
-          steps: {
-            "email-step": {
-              providers: {
-                "sendgrid": {
-                  "templateId": "1234567890",
-                },
-              },
-            },
-          },
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-        to: [
-          {
-            topicKey: "<value>",
-            type: "Subscriber",
-          },
-        ],
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
       {
         workflowId: "workflow_identifier",
@@ -455,26 +356,8 @@ async function run() {
             "text": "string",
           },
         },
-        overrides: {
-          steps: {
-            "email-step": {
-              providers: {
-                "sendgrid": {
-                  "templateId": "1234567890",
-                },
-              },
-            },
-          },
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-        to: [
-          "SUBSCRIBER_ID",
-          "SUBSCRIBER_ID",
-        ],
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
     ],
   });
@@ -511,25 +394,8 @@ async function run() {
             "text": "string",
           },
         },
-        overrides: {
-          steps: {
-            "email-step": {
-              providers: {
-                "sendgrid": {
-                  "templateId": "1234567890",
-                },
-              },
-            },
-          },
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-        to: {
-          subscriberId: "<id>",
-        },
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
       {
         workflowId: "workflow_identifier",
@@ -539,28 +405,8 @@ async function run() {
             "text": "string",
           },
         },
-        overrides: {
-          steps: {
-            "email-step": {
-              providers: {
-                "sendgrid": {
-                  "templateId": "1234567890",
-                },
-              },
-            },
-          },
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-        to: [
-          {
-            topicKey: "<value>",
-            type: "Subscriber",
-          },
-        ],
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
       {
         workflowId: "workflow_identifier",
@@ -570,26 +416,8 @@ async function run() {
             "text": "string",
           },
         },
-        overrides: {
-          steps: {
-            "email-step": {
-              providers: {
-                "sendgrid": {
-                  "templateId": "1234567890",
-                },
-              },
-            },
-          },
-          providers: {
-            "sendgrid": {
-              "templateId": "1234567890",
-            },
-          },
-        },
-        to: [
-          "SUBSCRIBER_ID",
-          "SUBSCRIBER_ID",
-        ],
+        overrides: {},
+        to: "SUBSCRIBER_ID",
       },
     ],
   });