@novu/api 0.5.0 → 0.6.0

package/docs/sdks/authentication/README.md

@@ -5,12 +5,12 @@
 
 ### Available Operations
 
-* [chatAccessOauthCallBack](#chataccessoauthcallback) - Handle providers oauth redirect
 * [chatAccessOauth](#chataccessoauth) - Handle chat oauth
+* [chatAccessOauthCallBack](#chataccessoauthcallback) - Handle providers oauth redirect
 
-## chatAccessOauthCallBack
+## chatAccessOauth
 
-Handle providers oauth redirect
+Handle chat oauth
 
 ### Example Usage
 
@@ -22,12 +22,11 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.authentication.chatAccessOauthCallBack({
+  const result = await novu.subscribers.authentication.chatAccessOauth({
     subscriberId: "<id>",
     providerId: "<id>",
     hmacHash: "<value>",
     environmentId: "<id>",
-    code: "<value>",
   });
 
   // Handle the result
@@ -43,7 +42,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauthCallBack.js";
+import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauth.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -52,12 +51,11 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersAuthenticationChatAccessOauthCallBack(novu, {
+  const res = await subscribersAuthenticationChatAccessOauth(novu, {
     subscriberId: "<id>",
     providerId: "<id>",
     hmacHash: "<value>",
     environmentId: "<id>",
-    code: "<value>",
   });
 
   if (!res.ok) {
@@ -77,14 +75,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersV1ControllerChatOauthCallbackRequest](../../models/operations/subscribersv1controllerchatoauthcallbackrequest.md)                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.SubscribersV1ControllerChatAccessOauthRequest](../../models/operations/subscribersv1controllerchataccessoauthrequest.md)                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.SubscribersV1ControllerChatOauthCallbackResponse](../../models/operations/subscribersv1controllerchatoauthcallbackresponse.md)\>**
+**Promise\<[operations.SubscribersV1ControllerChatAccessOauthResponse](../../models/operations/subscribersv1controllerchataccessoauthresponse.md)\>**
 
 ### Errors
 
@@ -96,9 +94,9 @@ run();
 | errors.ErrorDto                        | 500                                    | application/json                       |
 | errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
 
-## chatAccessOauth
+## chatAccessOauthCallBack
 
-Handle chat oauth
+Handle providers oauth redirect
 
 ### Example Usage
 
@@ -110,11 +108,12 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.subscribers.authentication.chatAccessOauth({
+  const result = await novu.subscribers.authentication.chatAccessOauthCallBack({
     subscriberId: "<id>",
     providerId: "<id>",
     hmacHash: "<value>",
     environmentId: "<id>",
+    code: "<value>",
   });
 
   // Handle the result
@@ -130,7 +129,7 @@ The standalone function version of this method:
 
 ```typescript
 import { NovuCore } from "@novu/api/core.js";
-import { subscribersAuthenticationChatAccessOauth } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauth.js";
+import { subscribersAuthenticationChatAccessOauthCallBack } from "@novu/api/funcs/subscribersAuthenticationChatAccessOauthCallBack.js";
 
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
@@ -139,11 +138,12 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await subscribersAuthenticationChatAccessOauth(novu, {
+  const res = await subscribersAuthenticationChatAccessOauthCallBack(novu, {
     subscriberId: "<id>",
     providerId: "<id>",
     hmacHash: "<value>",
     environmentId: "<id>",
+    code: "<value>",
   });
 
   if (!res.ok) {
@@ -163,14 +163,14 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `request`                                                                                                                                                                      | [operations.SubscribersV1ControllerChatAccessOauthRequest](../../models/operations/subscribersv1controllerchataccessoauthrequest.md)                                           | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
+| `request`                                                                                                                                                                      | [operations.SubscribersV1ControllerChatOauthCallbackRequest](../../models/operations/subscribersv1controllerchatoauthcallbackrequest.md)                                       | :heavy_check_mark:                                                                                                                                                             | The request object to use for the request.                                                                                                                                     |
 | `options`                                                                                                                                                                      | RequestOptions                                                                                                                                                                 | :heavy_minus_sign:                                                                                                                                                             | Used to set various options for making HTTP requests.                                                                                                                          |
 | `options.fetchOptions`                                                                                                                                                         | [RequestInit](https://developer.mozilla.org/en-US/docs/Web/API/Request/Request#options)                                                                                        | :heavy_minus_sign:                                                                                                                                                             | Options that are passed to the underlying HTTP request. This can be used to inject extra headers for examples. All `Request` options, except `method` and `body`, are allowed. |
 | `options.retries`                                                                                                                                                              | [RetryConfig](../../lib/utils/retryconfig.md)                                                                                                                                  | :heavy_minus_sign:                                                                                                                                                             | Enables retrying HTTP requests under certain failure conditions.                                                                                                               |
 
 ### Response
 
-**Promise\<[operations.SubscribersV1ControllerChatAccessOauthResponse](../../models/operations/subscribersv1controllerchataccessoauthresponse.md)\>**
+**Promise\<[operations.SubscribersV1ControllerChatOauthCallbackResponse](../../models/operations/subscribersv1controllerchatoauthcallbackresponse.md)\>**
 
 ### Errors
 

package/docs/sdks/integrations/README.md

@@ -10,10 +10,10 @@ With the help of the Integration Store, you can easily integrate your favorite d
 
 * [list](#list) - Get integrations
 * [create](#create) - Create integration
-* [listActive](#listactive) - Get active integrations
 * [update](#update) - Update integration
 * [delete](#delete) - Delete integration
 * [setAsPrimary](#setasprimary) - Set integration as primary
+* [listActive](#listactive) - Get active integrations
 
 ## list
 
@@ -174,9 +174,9 @@ run();
 | errors.ErrorDto                        | 500                                    | application/json                       |
 | errors.SDKError                        | 4XX, 5XX                               | \*/\*                                  |
 
-## listActive
+## update
 
-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
 
@@ -188,7 +188,7 @@ 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);
@@ -203,7 +203,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.
@@ -212,7 +212,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;
@@ -231,6 +231,8 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `integrationId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
+| `updateIntegrationRequestDto`                                                                                                                                                  | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.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. |
@@ -238,21 +240,21 @@ run();
 
 ### Response
 
-**Promise\<[operations.IntegrationsControllerGetActiveIntegrationsResponse](../../models/operations/integrationscontrollergetactiveintegrationsresponse.md)\>**
+**Promise\<[operations.IntegrationsControllerUpdateIntegrationByIdResponse](../../models/operations/integrationscontrollerupdateintegrationbyidresponse.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                               | \*/\*                                  |
+| Error Type                        | Status Code                       | Content Type                      |
+| --------------------------------- | --------------------------------- | --------------------------------- |
+| errors.ErrorDto                   | 414                               | application/json                  |
+| errors.ErrorDto                   | 400, 401, 403, 405, 409, 413, 415 | application/json                  |
+| errors.ValidationErrorDto         | 422                               | application/json                  |
+| errors.ErrorDto                   | 500                               | application/json                  |
+| errors.SDKError                   | 4XX, 5XX                          | \*/\*                             |
 
-## update
+## delete
 
-Update integration
+Delete integration
 
 ### Example Usage
 
@@ -264,7 +266,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.update({}, "<id>");
+  const result = await novu.integrations.delete("<id>");
 
   // Handle the result
   console.log(result);
@@ -279,7 +281,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 { 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.
@@ -288,7 +290,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsUpdate(novu, {}, "<id>");
+  const res = await integrationsDelete(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -308,7 +310,6 @@ run();
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
 | `integrationId`                                                                                                                                                                | *string*                                                                                                                                                                       | :heavy_check_mark:                                                                                                                                                             | N/A                                                                                                                                                                            |
-| `updateIntegrationRequestDto`                                                                                                                                                  | [components.UpdateIntegrationRequestDto](../../models/components/updateintegrationrequestdto.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. |
@@ -316,21 +317,21 @@ run();
 
 ### Response
 
-**Promise\<[operations.IntegrationsControllerUpdateIntegrationByIdResponse](../../models/operations/integrationscontrollerupdateintegrationbyidresponse.md)\>**
+**Promise\<[operations.IntegrationsControllerRemoveIntegrationResponse](../../models/operations/integrationscontrollerremoveintegrationresponse.md)\>**
 
 ### Errors
 
-| Error Type                        | Status Code                       | Content Type                      |
-| --------------------------------- | --------------------------------- | --------------------------------- |
-| errors.ErrorDto                   | 414                               | application/json                  |
-| errors.ErrorDto                   | 400, 401, 403, 405, 409, 413, 415 | application/json                  |
-| errors.ValidationErrorDto         | 422                               | application/json                  |
-| errors.ErrorDto                   | 500                               | application/json                  |
-| errors.SDKError                   | 4XX, 5XX                          | \*/\*                             |
+| 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                               | \*/\*                                  |
 
-## delete
+## setAsPrimary
 
-Delete integration
+Set integration as primary
 
 ### Example Usage
 
@@ -342,7 +343,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.delete("<id>");
+  const result = await novu.integrations.setAsPrimary("<id>");
 
   // Handle the result
   console.log(result);
@@ -357,7 +358,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 { 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.
@@ -366,7 +367,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsDelete(novu, "<id>");
+  const res = await integrationsSetAsPrimary(novu, "<id>");
 
   if (!res.ok) {
     throw res.error;
@@ -393,21 +394,21 @@ run();
 
 ### Response
 
-**Promise\<[operations.IntegrationsControllerRemoveIntegrationResponse](../../models/operations/integrationscontrollerremoveintegrationresponse.md)\>**
+**Promise\<[operations.IntegrationsControllerSetIntegrationAsPrimaryResponse](../../models/operations/integrationscontrollersetintegrationasprimaryresponse.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                               | \*/\*                                  |
+| Error Type                        | Status Code                       | Content Type                      |
+| --------------------------------- | --------------------------------- | --------------------------------- |
+| errors.ErrorDto                   | 414                               | application/json                  |
+| errors.ErrorDto                   | 400, 401, 403, 405, 409, 413, 415 | application/json                  |
+| errors.ValidationErrorDto         | 422                               | application/json                  |
+| errors.ErrorDto                   | 500                               | application/json                  |
+| errors.SDKError                   | 4XX, 5XX                          | \*/\*                             |
 
-## setAsPrimary
+## listActive
 
-Set integration as primary
+Return all the active integrations the user has created for that organization. Review v.0.17.0 changelog for a breaking change
 
 ### Example Usage
 
@@ -419,7 +420,7 @@ const novu = new Novu({
 });
 
 async function run() {
-  const result = await novu.integrations.setAsPrimary("<id>");
+  const result = await novu.integrations.listActive();
 
   // Handle the result
   console.log(result);
@@ -434,7 +435,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 { 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.
@@ -443,7 +444,7 @@ const novu = new NovuCore({
 });
 
 async function run() {
-  const res = await integrationsSetAsPrimary(novu, "<id>");
+  const res = await integrationsListActive(novu);
 
   if (!res.ok) {
     throw res.error;
@@ -462,7 +463,6 @@ run();
 
 | Parameter                                                                                                                                                                      | Type                                                                                                                                                                           | Required                                                                                                                                                                       | Description                                                                                                                                                                    |
 | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| `integrationId`                                                                                                                                                                | *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. |
@@ -470,14 +470,14 @@ run();
 
 ### Response
 
-**Promise\<[operations.IntegrationsControllerSetIntegrationAsPrimaryResponse](../../models/operations/integrationscontrollersetintegrationasprimaryresponse.md)\>**
+**Promise\<[operations.IntegrationsControllerGetActiveIntegrationsResponse](../../models/operations/integrationscontrollergetactiveintegrationsresponse.md)\>**
 
 ### Errors
 
-| Error Type                        | Status Code                       | Content Type                      |
-| --------------------------------- | --------------------------------- | --------------------------------- |
-| errors.ErrorDto                   | 414                               | application/json                  |
-| errors.ErrorDto                   | 400, 401, 403, 405, 409, 413, 415 | application/json                  |
-| errors.ValidationErrorDto         | 422                               | application/json                  |
-| errors.ErrorDto                   | 500                               | application/json                  |
-| errors.SDKError                   | 4XX, 5XX                          | \*/\*                             |
+| 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                               | \*/\*                                  |