ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.487.0 (#48)

Co-authored-by: speakeasybot <[email protected]>
novuhq · Feb 7, 2025 · 6cc5110 · 6cc5110
1 parent 920b6ca
commit 6cc5110
Show file tree

Hide file tree

Showing 188 changed files with 2,947 additions and 12,706 deletions.
diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -13,7 +13,7 @@ generation:
     oAuth2ClientCredentialsEnabled: false
     oAuth2PasswordEnabled: false
 typescript:
-  version: 0.1.6
+  version: 0.2.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,21 +1,21 @@
-speakeasyVersion: 1.484.1
+speakeasyVersion: 1.487.0
 sources:
     json-development:
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:99ea321c34d0f567e12853535239654663d289adfd8fb1488582bc42cd402ba6
-        sourceBlobDigest: sha256:a920ae5a5cbf3dcdcd0f78ae6241fadf8841d72afe2897dc0318c16213970dab
+        sourceRevisionDigest: sha256:caa7c1cf2d96a601fd6b338bd1827e6db447c4f5a106ea233295818a4d9a8b5c
+        sourceBlobDigest: sha256:07b6df397e8f8c7e1e1ba33ef2aa72bd74f9c14abc9962bf0b25ca4e761143ff
         tags:
             - latest
-            - speakeasy-sdk-regen-1738628235
+            - speakeasy-sdk-regen-1738930252
             - "1.0"
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:99ea321c34d0f567e12853535239654663d289adfd8fb1488582bc42cd402ba6
-        sourceBlobDigest: sha256:a920ae5a5cbf3dcdcd0f78ae6241fadf8841d72afe2897dc0318c16213970dab
+        sourceRevisionDigest: sha256:caa7c1cf2d96a601fd6b338bd1827e6db447c4f5a106ea233295818a4d9a8b5c
+        sourceBlobDigest: sha256:07b6df397e8f8c7e1e1ba33ef2aa72bd74f9c14abc9962bf0b25ca4e761143ff
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:e5a03274e63c6dc47fff9cffc48e6e11ae77b41c2e18a4e348f6c733f5cdb111
+        codeSamplesRevisionDigest: sha256:da58446cdc959c426f9c4718103b2157d0fa034afce88d51e0b803d78c9a6fec
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/FUNCTIONS.md b/FUNCTIONS.md
@@ -26,7 +26,7 @@ import { SDKValidationError } from "@novu/api/models/errors/sdkvalidationerror.j
 // Use `NovuCore` for best tree-shaking performance.
 // You can create one instance of it to use across an application.
 const novu = new NovuCore({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {

diff --git a/README.md b/README.md
@@ -83,7 +83,7 @@ For supported JavaScript runtimes, please consult [RUNTIMES.md](RUNTIMES.md).
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -121,7 +121,7 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -205,7 +205,7 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -233,7 +233,7 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -293,12 +293,9 @@ run();
 ### [subscribers](docs/sdks/subscribers/README.md)
 
 * [list](docs/sdks/subscribers/README.md#list) - Get subscribers
-* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
-* [retrieveLegacy](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
-* [updateLegacy](docs/sdks/subscribers/README.md#updatelegacy) - Update subscriber
-* [~~deleteLegacy~~](docs/sdks/subscribers/README.md#deletelegacy) - Delete subscriber :warning: **Deprecated**
 * [createBulk](docs/sdks/subscribers/README.md#createbulk) - Bulk create subscribers
 * [search](docs/sdks/subscribers/README.md#search) - Search for subscribers
+* [create](docs/sdks/subscribers/README.md#create) - Create subscriber
 * [retrieve](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
 * [patch](docs/sdks/subscribers/README.md#patch) - Patch subscriber
 * [delete](docs/sdks/subscribers/README.md#delete) - Delete subscriber
@@ -327,16 +324,9 @@ run();
 
 #### [subscribers.preferences](docs/sdks/preferences/README.md)
 
-* [~~listLegacy~~](docs/sdks/preferences/README.md#listlegacy) - Get subscriber preferences :warning: **Deprecated**
-* [~~retrieveByLevelLegacy~~](docs/sdks/preferences/README.md#retrievebylevellegacy) - Get subscriber preferences by level :warning: **Deprecated**
-* [updateLegacy](docs/sdks/preferences/README.md#updatelegacy) - Update subscriber preference
-* [retrieve](docs/sdks/preferences/README.md#retrieve) - Get subscriber preferences
+* [list](docs/sdks/preferences/README.md#list) - Get subscriber preferences
 * [update](docs/sdks/preferences/README.md#update) - Update subscriber global or workflow specific preferences
 
-#### [subscribers.preferences.legacy](docs/sdks/legacy/README.md)
-
-* [updateGlobal](docs/sdks/legacy/README.md#updateglobal) - Update subscriber global preferences
-
 #### [subscribers.properties](docs/sdks/properties/README.md)
 
 * [updateOnlineFlag](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
@@ -403,15 +393,11 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`subscribersNotificationsFeed`](docs/sdks/novunotifications/README.md#feed) - Get in-app notification feed for a particular subscriber
 - [`subscribersNotificationsUnseenCount`](docs/sdks/novunotifications/README.md#unseencount) - Get the unseen in-app notifications count for subscribers feed
 - [`subscribersPatch`](docs/sdks/subscribers/README.md#patch) - Patch subscriber
-- [`subscribersPreferencesLegacyUpdateGlobal`](docs/sdks/legacy/README.md#updateglobal) - Update subscriber global preferences
-- [`subscribersPreferencesRetrieve`](docs/sdks/preferences/README.md#retrieve) - Get subscriber preferences
+- [`subscribersPreferencesList`](docs/sdks/preferences/README.md#list) - Get subscriber preferences
 - [`subscribersPreferencesUpdate`](docs/sdks/preferences/README.md#update) - Update subscriber global or workflow specific preferences
-- [`subscribersPreferencesUpdateLegacy`](docs/sdks/preferences/README.md#updatelegacy) - Update subscriber preference
 - [`subscribersPropertiesUpdateOnlineFlag`](docs/sdks/properties/README.md#updateonlineflag) - Update subscriber online status
 - [`subscribersRetrieve`](docs/sdks/subscribers/README.md#retrieve) - Get subscriber
-- [`subscribersRetrieveLegacy`](docs/sdks/subscribers/README.md#retrievelegacy) - Get subscriber
 - [`subscribersSearch`](docs/sdks/subscribers/README.md#search) - Search for subscribers
-- [`subscribersUpdateLegacy`](docs/sdks/subscribers/README.md#updatelegacy) - Update subscriber
 - [`topicsCreate`](docs/sdks/topics/README.md#create) - Topic creation
 - [`topicsDelete`](docs/sdks/topics/README.md#delete) - Delete topic
 - [`topicsList`](docs/sdks/topics/README.md#list) - Get topic list filtered 
@@ -423,9 +409,6 @@ To read more about standalone functions, check [FUNCTIONS.md](./FUNCTIONS.md).
 - [`trigger`](docs/sdks/novu/README.md#trigger) - Trigger event
 - [`triggerBroadcast`](docs/sdks/novu/README.md#triggerbroadcast) - Broadcast event to all
 - [`triggerBulk`](docs/sdks/novu/README.md#triggerbulk) - Bulk trigger event
-- ~~[`subscribersDeleteLegacy`](docs/sdks/subscribers/README.md#deletelegacy)~~ - Delete subscriber :warning: **Deprecated**
-- ~~[`subscribersPreferencesListLegacy`](docs/sdks/preferences/README.md#listlegacy)~~ - Get subscriber preferences :warning: **Deprecated**
-- ~~[`subscribersPreferencesRetrieveByLevelLegacy`](docs/sdks/preferences/README.md#retrievebylevellegacy)~~ - Get subscriber preferences by level :warning: **Deprecated**
 
 </details>
 <!-- End Standalone functions [standalone-funcs] -->
@@ -446,7 +429,7 @@ Here's an example of one such pagination call:
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -487,7 +470,7 @@ import {
 } from "@novu/api/models/errors";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -589,7 +572,7 @@ import { Novu } from "@novu/api";
 
 const novu = new Novu({
   serverIdx: 1,
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -629,7 +612,7 @@ import { Novu } from "@novu/api";
 
 const novu = new Novu({
   serverURL: "https://api.novu.co",
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -727,7 +710,7 @@ To authenticate with the API the `secretKey` parameter must be set when initiali
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -770,7 +753,7 @@ To change the default retry strategy for a single API call, simply provide a ret
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -828,7 +811,7 @@ const novu = new Novu({
     },
     retryConnectionErrors: false,
   },
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {

diff --git a/RELEASES.md b/RELEASES.md
@@ -68,4 +68,14 @@ Based on:
 ### Generated
 - [typescript v0.1.6] .
 ### Releases
-- [NPM v0.1.6] https://www.npmjs.com/package/@novu/api/v/0.1.6 - .
+- [NPM v0.1.6] https://www.npmjs.com/package/@novu/api/v/0.1.6 - .
+
+## 2025-02-07 12:10:35
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.487.0 (2.506.0) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.2.0] .
+### Releases
+- [NPM v0.2.0] https://www.npmjs.com/package/@novu/api/v/0.2.0 - .
diff --git a/USAGE.md b/USAGE.md
@@ -5,7 +5,7 @@
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -43,7 +43,7 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -127,7 +127,7 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {
@@ -155,7 +155,7 @@ run();
 import { Novu } from "@novu/api";
 
 const novu = new Novu({
-  secretKey: "<YOUR_API_KEY_HERE>",
+  secretKey: "YOUR_SECRET_KEY_HERE",
 });
 
 async function run() {

diff --git a/docs/models/components/activitiesresponsedto.md b/docs/models/components/activitiesresponsedto.md
@@ -8,8 +8,8 @@ import { ActivitiesResponseDto } from "@novu/api/models/components";
 let value: ActivitiesResponseDto = {
   hasMore: false,
   data: [],
-  pageSize: 5761.57,
-  page: 5920.42,
+  pageSize: 201.07,
+  page: 8289.4,
 };
 ```
 

diff --git a/docs/models/components/activitygraphstatesresponse.md b/docs/models/components/activitygraphstatesresponse.md
@@ -7,7 +7,7 @@ import { ActivityGraphStatesResponse } from "@novu/api/models/components";
 
 let value: ActivityGraphStatesResponse = {
   id: "<id>",
-  count: 1494.48,
+  count: 4358.65,
   templates: [
     "<value>",
   ],

diff --git a/docs/models/components/activitynotificationexecutiondetailresponsedto.md b/docs/models/components/activitynotificationexecutiondetailresponsedto.md
@@ -7,12 +7,12 @@ import { ActivityNotificationExecutionDetailResponseDto } from "@novu/api/models
 
 let value: ActivityNotificationExecutionDetailResponseDto = {
   id: "<id>",
-  status: "Success",
+  status: "Failed",
   detail: "<value>",
   isRetry: false,
   isTest: false,
-  providerId: "braze",
-  source: "Payload",
+  providerId: "generic-sms",
+  source: "Credentials",
 };
 ```
 

diff --git a/docs/models/components/activitynotificationjobresponsedto.md b/docs/models/components/activitynotificationjobresponsedto.md
@@ -7,15 +7,15 @@ import { ActivityNotificationJobResponseDto } from "@novu/api/models/components"
 
 let value: ActivityNotificationJobResponseDto = {
   id: "<id>",
-  type: "sms",
+  type: "trigger",
   executionDetails: [
     {
       id: "<id>",
-      status: "ReadConfirmation",
+      status: "Warning",
       detail: "<value>",
       isRetry: false,
       isTest: false,
-      providerId: "infobip-sms",
+      providerId: "mobishastra",
       source: "Webhook",
     },
   ],
@@ -25,21 +25,21 @@ let value: ActivityNotificationJobResponseDto = {
     filters: [
       {
         isNegated: false,
-        type: "LIST",
-        value: "AND",
+        type: "TEXT",
+        value: "OR",
         children: [
           {
             field: "<value>",
             value: "<value>",
-            operator: "LIKE",
-            on: "subscriber",
+            operator: "NOT_IN",
+            on: "payload",
           },
         ],
       },
     ],
     templateId: "<id>",
   },
-  providerId: "discord",
+  providerId: "clickatell",
   status: "<value>",
 };
 ```

diff --git a/docs/models/components/activitynotificationjobresponsedtotype.md b/docs/models/components/activitynotificationjobresponsedtotype.md
@@ -7,7 +7,7 @@ Type of the job
 ```typescript
 import { ActivityNotificationJobResponseDtoType } from "@novu/api/models/components";
 
-let value: ActivityNotificationJobResponseDtoType = "digest";
+let value: ActivityNotificationJobResponseDtoType = "in_app";
 ```
 
 ## Values

diff --git a/docs/models/components/activitynotificationstepresponsedto.md b/docs/models/components/activitynotificationstepresponsedto.md
@@ -11,14 +11,14 @@ let value: ActivityNotificationStepResponseDto = {
   filters: [
     {
       isNegated: false,
-      type: "GROUP",
+      type: "NUMBER",
       value: "OR",
       children: [
         {
           field: "<value>",
           value: "<value>",
-          operator: "NOT_BETWEEN",
-          on: "payload",
+          operator: "BETWEEN",
+          on: "subscriber",
         },
       ],
     },

diff --git a/docs/models/components/activitystatsresponsedto.md b/docs/models/components/activitystatsresponsedto.md
@@ -6,8 +6,8 @@
 import { ActivityStatsResponseDto } from "@novu/api/models/components";
 
 let value: ActivityStatsResponseDto = {
-  weeklySent: 9194.83,
-  monthlySent: 7142.42,
+  weeklySent: 4314.18,
+  monthlySent: 8965.47,
 };
 ```
 

diff --git a/docs/models/components/actorfeeditemdto.md b/docs/models/components/actorfeeditemdto.md
@@ -7,7 +7,7 @@ import { ActorFeedItemDto } from "@novu/api/models/components";
 
 let value: ActorFeedItemDto = {
   data: null,
-  type: "system_icon",
+  type: "none",
 };
 ```
 

diff --git a/docs/models/components/actortypeenum.md b/docs/models/components/actortypeenum.md
@@ -7,7 +7,7 @@ The type of the actor, indicating the role in the notification process.
 ```typescript
 import { ActorTypeEnum } from "@novu/api/models/components";
 
-let value: ActorTypeEnum = "system_icon";
+let value: ActorTypeEnum = "user";
 ```
 
 ## Values