@novu/api 0.0.1-alpha.11 → 0.0.1-alpha.25

package/docs/sdks/executiondetails/README.md

@@ -24,10 +24,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.executionDetails.retrieve("<value>", "<value>");
-  
+  const result = await novu.executionDetails.retrieve("<id>", "<id>");
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -48,7 +48,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await executionDetailsRetrieve(novu, "<value>", "<value>");
+  const res = await executionDetailsRetrieve(novu, "<id>", "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -57,7 +57,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -75,10 +75,10 @@ run();
 
 ### Response
 
-**Promise\<[components.ExecutionDetailsResponseDto[]](../../models/.md)\>**
+**Promise\<[operations.ExecutionDetailsControllerGetExecutionDetailsForNotificationResponse](../../models/operations/executiondetailscontrollergetexecutiondetailsfornotificationresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |

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
 
-* [create](#create) - Create integration
-* [delete](#delete) - Delete integration
 * [list](#list) - Get integrations
+* [create](#create) - Create integration
 * [listActive](#listactive) - Get active integrations
-* [setAsPrimary](#setasprimary) - Set integration as primary
 * [update](#update) - Update integration
+* [delete](#delete) - Delete integration
+* [setAsPrimary](#setasprimary) - Set integration as primary
 
-## create
+## list
 
-Create an integration for the current environment the user is based on the API key provided
+Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
 
 ### Example Usage
 
@@ -29,13 +29,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.create({
-    channel: "sms",
-    providerId: "<value>",
-  });
-  
+  const result = await novu.integrations.list();
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -47,7 +44,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { integrationsCreate } from "@novu/api/funcs/integrationsCreate.js";
+import { integrationsList } from "@novu/api/funcs/integrationsList.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -56,10 +53,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsCreate(novu, {
-    channel: "sms",
-    providerId: "<value>",
-  });
+  const res = await integrationsList(novu);
 
   if (!res.ok) {
     throw res.error;
@@ -68,7 +62,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -78,25 +72,23 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [components.CreateIntegrationRequestDto](../../models/components/createintegrationrequestdto.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\<[components.IntegrationResponseDto](../../models/components/integrationresponsedto.md)\>**
+**Promise\<[operations.IntegrationsControllerListIntegrationsResponse](../../models/operations/integrationscontrollerlistintegrationsresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## delete
+## create
 
-Delete integration
+Create an integration for the current environment the user is based on the API key provided
 
 ### Example Usage
 
@@ -108,10 +100,13 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.delete("<value>");
-  
+  const result = await novu.integrations.create({
+    providerId: "<id>",
+    channel: "sms",
+  });
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -123,7 +118,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { integrationsDelete } from "@novu/api/funcs/integrationsDelete.js";
+import { integrationsCreate } from "@novu/api/funcs/integrationsCreate.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -132,7 +127,10 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsDelete(novu, "<value>");
+  const res = await integrationsCreate(novu, {
+    providerId: "<id>",
+    channel: "sms",
+  });
 
   if (!res.ok) {
     throw res.error;
@@ -141,7 +139,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -151,25 +149,24 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `integrationId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `request`                                                                                                                                                                      | [components.CreateIntegrationRequestDto](../../models/components/createintegrationrequestdto.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\<[components.IntegrationResponseDto[]](../../models/.md)\>**
+**Promise\<[operations.IntegrationsControllerCreateIntegrationResponse](../../models/operations/integrationscontrollercreateintegrationresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
+## listActive
 
-## list
-
-Return all the integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
 
 ### Example Usage
 
@@ -181,10 +178,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.list();
-  
+  const result = await novu.integrations.listActive();
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -196,7 +193,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { integrationsList } from "@novu/api/funcs/integrationsList.js";
+import { integrationsListActive } from "@novu/api/funcs/integrationsListActive.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -205,7 +202,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsList(novu);
+  const res = await integrationsListActive(novu);
 
   if (!res.ok) {
     throw res.error;
@@ -214,7 +211,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -230,18 +227,17 @@ run();
 
 ### Response
 
-**Promise\<[components.IntegrationResponseDto[]](../../models/.md)\>**
+**Promise\<[operations.IntegrationsControllerGetActiveIntegrationsResponse](../../models/operations/integrationscontrollergetactiveintegrationsresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
+## update
 
-## listActive
-
-Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
+Update integration
 
 ### Example Usage
 
@@ -253,10 +249,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.listActive();
-  
+  const result = await novu.integrations.update({}, "<id>");
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -268,7 +264,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { integrationsListActive } from "@novu/api/funcs/integrationsListActive.js";
+import { integrationsUpdate } from "@novu/api/funcs/integrationsUpdate.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -277,7 +273,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsListActive(novu);
+  const res = await integrationsUpdate(novu, {}, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -286,7 +282,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -296,24 +292,25 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `integrationId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateIntegrationRequestDto`                                                                                                                                                  | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.IntegrationResponseDto[]](../../models/.md)\>**
+**Promise\<[operations.IntegrationsControllerUpdateIntegrationByIdResponse](../../models/operations/integrationscontrollerupdateintegrationbyidresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
-
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
-## setAsPrimary
+## delete
 
-Set integration as primary
+Delete integration
 
 ### Example Usage
 
@@ -325,10 +322,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.setAsPrimary("<value>");
-  
+  const result = await novu.integrations.delete("<id>");
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -340,7 +337,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { integrationsSetAsPrimary } from "@novu/api/funcs/integrationsSetAsPrimary.js";
+import { integrationsDelete } from "@novu/api/funcs/integrationsDelete.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -349,7 +346,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsSetAsPrimary(novu, "<value>");
+  const res = await integrationsDelete(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -358,7 +355,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -375,18 +372,17 @@ run();
 
 ### Response
 
-**Promise\<[components.IntegrationResponseDto](../../models/components/integrationresponsedto.md)\>**
+**Promise\<[operations.IntegrationsControllerRemoveIntegrationResponse](../../models/operations/integrationscontrollerremoveintegrationresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |
 
+## setAsPrimary
 
-## update
-
-Update integration
+Set integration as primary
 
 ### Example Usage
 
@@ -398,10 +394,10 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.update("<value>", {});
-  
+  const result = await novu.integrations.setAsPrimary("<id>");
+
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -413,7 +409,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { integrationsUpdate } from "@novu/api/funcs/integrationsUpdate.js";
+import { integrationsSetAsPrimary } from "@novu/api/funcs/integrationsSetAsPrimary.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -422,7 +418,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsUpdate(novu, "<value>", {});
+  const res = await integrationsSetAsPrimary(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -431,7 +427,7 @@ async function run() {
   const { value: result } = res;
 
   // Handle the result
-  console.log(result)
+  console.log(result);
 }
 
 run();
@@ -442,17 +438,16 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `integrationId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `updateIntegrationRequestDto`                                                                                                                                                  | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.md)                                                                               | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[components.IntegrationResponseDto](../../models/components/integrationresponsedto.md)\>**
+**Promise\<[operations.IntegrationsControllerSetIntegrationAsPrimaryResponse](../../models/operations/integrationscontrollersetintegrationasprimaryresponse.md)\>**
 
 ### Errors
 
-| Error Object    | Status Code     | Content Type    |
+| Error Type      | Status Code     | Content Type    |
 | --------------- | --------------- | --------------- |
-| errors.SDKError | 4xx-5xx         | */*             |
+| errors.SDKError | 4XX, 5XX        | \*/\*           |