chore: 🐝 Update SDK - Generate 0.4.0 (#53)

* ci: regenerated with OpenAPI Doc , Speakeasy CLI 1.502.0 * empty commit to trigger [run-tests] workflow --------- Co-authored-by: speakeasybot <[email protected]> Co-authored-by: speakeasy-github[bot] <128539517+speakeasy-github[bot]@users.noreply.github.com>
novuhq · Feb 25, 2025 · 2164068 · 2164068
1 parent cc44b8e
commit 2164068
Show file tree

Hide file tree

Showing 131 changed files with 4,703 additions and 107 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,5 @@
+/mcp-server
+/bin
 /.eslintcache
 /.speakeasy/reports
 /react-query

diff --git a/.npmignore b/.npmignore
@@ -4,6 +4,7 @@
 !/REACT_QUERY.md
 !/**/*.ts
 !/**/*.js
+!/**/*.mjs
 !/**/*.json
 !/**/*.map
 

diff --git a/.speakeasy/gen.lock b/.speakeasy/gen.lock
@@ -3,10 +3,10 @@ id: 6bff3a53-3f0b-40b4-942f-ff70dc583ae5
 management:
   docChecksum: e581b83557f00a8a1f177ccc3d920d23
   docVersion: "1.0"
-  speakeasyVersion: 1.494.0
-  generationVersion: 2.515.0
-  releaseVersion: 0.3.0
-  configChecksum: 35683929341d803bc9d28ca5eb899567
+  speakeasyVersion: 1.502.0
+  generationVersion: 2.524.1
+  releaseVersion: 0.4.0
+  configChecksum: 0153040bd86a2834b9d6029c7673b59e
   repoURL: https://github.com/novuhq/novu-ts.git
   installationURL: https://github.com/novuhq/novu-ts
   published: true
@@ -15,7 +15,7 @@ features:
     acceptHeaders: 2.81.2
     additionalDependencies: 0.1.0
     constsAndDefaults: 0.1.11
-    core: 3.20.0
+    core: 3.21.1
     defaultEnabledRetries: 0.1.0
     deprecations: 2.81.1
     enumUnions: 0.1.0
@@ -27,8 +27,9 @@ features:
     globalSecurityFlattening: 0.1.0
     globalServerURLs: 2.82.4
     groups: 2.81.2
+    mcpServer: 0.3.0
     nameOverrides: 2.81.2
-    nullables: 0.1.0
+    nullables: 0.1.1
     pagination: 2.82.8
     responseFormat: 0.2.3
     retries: 2.83.0
@@ -403,6 +404,63 @@ generatedFiles:
   - src/lib/sdks.ts
   - src/lib/security.ts
   - src/lib/url.ts
+  - src/mcp-server/build.mts
+  - src/mcp-server/cli.ts
+  - src/mcp-server/cli/start/command.ts
+  - src/mcp-server/cli/start/impl.ts
+  - src/mcp-server/console-logger.ts
+  - src/mcp-server/mcp-server.ts
+  - src/mcp-server/resources.ts
+  - src/mcp-server/scopes.ts
+  - src/mcp-server/server.ts
+  - src/mcp-server/shared.ts
+  - src/mcp-server/tools.ts
+  - src/mcp-server/tools/cancel.ts
+  - src/mcp-server/tools/integrationsCreate.ts
+  - src/mcp-server/tools/integrationsDelete.ts
+  - src/mcp-server/tools/integrationsList.ts
+  - src/mcp-server/tools/integrationsListActive.ts
+  - src/mcp-server/tools/integrationsSetAsPrimary.ts
+  - src/mcp-server/tools/integrationsUpdate.ts
+  - src/mcp-server/tools/integrationsWebhooksRetrieve.ts
+  - src/mcp-server/tools/messagesDelete.ts
+  - src/mcp-server/tools/messagesDeleteByTransactionId.ts
+  - src/mcp-server/tools/messagesRetrieve.ts
+  - src/mcp-server/tools/notificationsList.ts
+  - src/mcp-server/tools/notificationsRetrieve.ts
+  - src/mcp-server/tools/notificationsStatsGraph.ts
+  - src/mcp-server/tools/notificationsStatsRetrieve.ts
+  - src/mcp-server/tools/subscribersAuthenticationChatAccessOauth.ts
+  - src/mcp-server/tools/subscribersAuthenticationChatAccessOauthCallBack.ts
+  - src/mcp-server/tools/subscribersCreate.ts
+  - src/mcp-server/tools/subscribersCreateBulk.ts
+  - src/mcp-server/tools/subscribersCredentialsAppend.ts
+  - src/mcp-server/tools/subscribersCredentialsDelete.ts
+  - src/mcp-server/tools/subscribersCredentialsUpdate.ts
+  - src/mcp-server/tools/subscribersDelete.ts
+  - src/mcp-server/tools/subscribersList.ts
+  - src/mcp-server/tools/subscribersMessagesMarkAll.ts
+  - src/mcp-server/tools/subscribersMessagesMarkAllAs.ts
+  - src/mcp-server/tools/subscribersMessagesUpdateAsSeen.ts
+  - src/mcp-server/tools/subscribersNotificationsFeed.ts
+  - src/mcp-server/tools/subscribersNotificationsUnseenCount.ts
+  - src/mcp-server/tools/subscribersPatch.ts
+  - src/mcp-server/tools/subscribersPreferencesList.ts
+  - src/mcp-server/tools/subscribersPreferencesUpdate.ts
+  - src/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.ts
+  - src/mcp-server/tools/subscribersRetrieve.ts
+  - src/mcp-server/tools/subscribersSearch.ts
+  - src/mcp-server/tools/topicsCreate.ts
+  - src/mcp-server/tools/topicsDelete.ts
+  - src/mcp-server/tools/topicsList.ts
+  - src/mcp-server/tools/topicsRename.ts
+  - src/mcp-server/tools/topicsRetrieve.ts
+  - src/mcp-server/tools/topicsSubscribersAssign.ts
+  - src/mcp-server/tools/topicsSubscribersRemove.ts
+  - src/mcp-server/tools/topicsSubscribersRetrieve.ts
+  - src/mcp-server/tools/trigger.ts
+  - src/mcp-server/tools/triggerBroadcast.ts
+  - src/mcp-server/tools/triggerBulk.ts
   - src/models/components/activitiesresponsedto.ts
   - src/models/components/activitygraphstatesresponse.ts
   - src/models/components/activitynotificationexecutiondetailresponsedto.ts

diff --git a/.speakeasy/gen.yaml b/.speakeasy/gen.yaml
@@ -15,7 +15,7 @@ generation:
     oAuth2ClientCredentialsEnabled: false
     oAuth2PasswordEnabled: false
 typescript:
-  version: 0.3.0
+  version: 0.4.0
   additionalDependencies:
     dependencies: {}
     devDependencies: {}
@@ -25,6 +25,7 @@ typescript:
   clientServerStatusCodesAsErrors: true
   defaultErrorName: SDKError
   enableCustomCodeRegions: false
+  enableMCPServer: true
   enableReactQuery: false
   enumFormat: union
   flattenGlobalSecurity: true

diff --git a/.speakeasy/workflow.lock b/.speakeasy/workflow.lock
@@ -1,21 +1,21 @@
-speakeasyVersion: 1.494.0
+speakeasyVersion: 1.502.0
 sources:
     json-development:
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:5b534f729df60d25ae9a868905689010f8c0985a8efaeb9b54bf783e4cf64580
+        sourceRevisionDigest: sha256:f38630d9cba1ddc1afada0e7eb94c7d81248893ceaaf7b73141a04b131abbfa5
         sourceBlobDigest: sha256:3901a42e01b82ed5e37f76a1d5e38efd6c354a41d4a8e04b57cbde9f4649ed5f
         tags:
             - latest
-            - speakeasy-sdk-regen-1739492253
+            - speakeasy-sdk-regen-1740474061
             - "1.0"
 targets:
     my-first-target:
         source: json-development
         sourceNamespace: json-development
-        sourceRevisionDigest: sha256:5b534f729df60d25ae9a868905689010f8c0985a8efaeb9b54bf783e4cf64580
+        sourceRevisionDigest: sha256:f38630d9cba1ddc1afada0e7eb94c7d81248893ceaaf7b73141a04b131abbfa5
         sourceBlobDigest: sha256:3901a42e01b82ed5e37f76a1d5e38efd6c354a41d4a8e04b57cbde9f4649ed5f
         codeSamplesNamespace: code-samples-typescript
-        codeSamplesRevisionDigest: sha256:0b78d306f2233cea5fc76344b40b2672232da2e23be91bd930799d216524c204
+        codeSamplesRevisionDigest: sha256:d127c62ae7ebac9a886f58bdd1c89b9f6736a86aed166b3865d8a4248be70229
 workflow:
     workflowVersion: 1.0.0
     speakeasyVersion: latest

diff --git a/README.md b/README.md
@@ -66,6 +66,58 @@ yarn add @novu/api zod
 # Note that Yarn does not install peer dependencies automatically. You will need
 # to install zod as shown above.
 ```
+
+
+
+### Model Context Protocol (MCP) Server
+
+This SDK is also an installable MCP server where the various SDK methods are
+exposed as tools that can be invoked by AI applications.
+
+> Node.js v20 or greater is required to run the MCP server.
+
+<details>
+<summary>Claude installation steps</summary>
+
+Add the following server definition to your `claude_desktop_config.json` file:
+
+```json
+{
+  "mcpServers": {
+    "Novu": {
+      "command": "npx",
+      "args": [
+        "-y", "--package", "@novu/api",
+        "--",
+        "mcp", "start",
+        "--secret-key", "..."
+      ]
+    }
+  }
+}
+```
+
+</details>
+
+<details>
+<summary>Cursor installation steps</summary>
+
+Go to `Cursor Settings > Features > MCP Servers > Add new MCP server` and use the following settings:
+
+- Name: Novu
+- Type: `command`
+- Command:
+```sh
+npx -y --package @novu/api -- mcp start --secret-key ... 
+```
+
+</details>
+
+For a full list of server arguments, run:
+
+```sh
+npx -y --package @novu/api -- mcp start --help
+```
 <!-- End SDK Installation [installation] -->
 
 <!-- Start Requirements [requirements] -->

diff --git a/RELEASES.md b/RELEASES.md
@@ -98,4 +98,14 @@ Based on:
 ### Generated
 - [typescript v0.3.0] .
 ### Releases
-- [NPM v0.3.0] https://www.npmjs.com/package/@novu/api/v/0.3.0 - .
+- [NPM v0.3.0] https://www.npmjs.com/package/@novu/api/v/0.3.0 - .
+
+## 2025-02-25 09:00:42
+### Changes
+Based on:
+- OpenAPI Doc  
+- Speakeasy CLI 1.502.0 (2.524.1) https://github.com/speakeasy-api/speakeasy
+### Generated
+- [typescript v0.4.0] .
+### Releases
+- [NPM v0.4.0] https://www.npmjs.com/package/@novu/api/v/0.4.0 - .
diff --git a/docs/models/components/listsubscribersresponsedto.md b/docs/models/components/listsubscribersresponsedto.md
@@ -32,8 +32,8 @@ let value: ListSubscribersResponseDto = {
       organizationId: "<id>",
       environmentId: "<id>",
       deleted: false,
-      createdAt: "1735131063107",
-      updatedAt: "1739907627986",
+      createdAt: "1735680868433",
+      updatedAt: "1740457433312",
     },
   ],
   next: "<value>",

diff --git a/docs/models/components/messageresponsedto.md b/docs/models/components/messageresponsedto.md
@@ -37,10 +37,10 @@ let value: MessageResponseDto = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1710101879274",
-    updatedAt: "1739855156028",
+    createdAt: "1710651684597",
+    updatedAt: "1740404961351",
   },
-  createdAt: "1708972379821",
+  createdAt: "1709522185144",
   content: "<value>",
   transactionId: "<id>",
   channel: "email",

diff --git a/docs/models/components/subscriberresponsedto.md b/docs/models/components/subscriberresponsedto.md
@@ -30,8 +30,8 @@ let value: SubscriberResponseDto = {
   organizationId: "<id>",
   environmentId: "<id>",
   deleted: false,
-  createdAt: "1713101277984",
-  updatedAt: "1739912881622",
+  createdAt: "1713651083309",
+  updatedAt: "1740462686947",
 };
 ```
 

diff --git a/docs/models/operations/subscriberscontrollercreatesubscriberresponse.md b/docs/models/operations/subscriberscontrollercreatesubscriberresponse.md
@@ -36,8 +36,8 @@ let value: SubscribersControllerCreateSubscriberResponse = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1726314408269",
-    updatedAt: "1739839499245",
+    createdAt: "1726864213661",
+    updatedAt: "1740389304637",
   },
 };
 ```

diff --git a/docs/models/operations/subscriberscontrollergetsubscriberresponse.md b/docs/models/operations/subscriberscontrollergetsubscriberresponse.md
@@ -36,8 +36,8 @@ let value: SubscribersControllerGetSubscriberResponse = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1727691325935",
-    updatedAt: "1739891178316",
+    createdAt: "1728241131327",
+    updatedAt: "1740440983708",
   },
 };
 ```

diff --git a/docs/models/operations/subscriberscontrollerpatchsubscriberresponse.md b/docs/models/operations/subscriberscontrollerpatchsubscriberresponse.md
@@ -36,8 +36,8 @@ let value: SubscribersControllerPatchSubscriberResponse = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1729890160116",
-    updatedAt: "1739868936968",
+    createdAt: "1730439965508",
+    updatedAt: "1740418742360",
   },
 };
 ```

diff --git a/docs/models/operations/subscriberscontrollersearchsubscribersresponse.md b/docs/models/operations/subscriberscontrollersearchsubscribersresponse.md
@@ -38,8 +38,8 @@ let value: SubscribersControllerSearchSubscribersResponse = {
         organizationId: "<id>",
         environmentId: "<id>",
         deleted: false,
-        createdAt: "1716731301335",
-        updatedAt: "1739904768833",
+        createdAt: "1717281106727",
+        updatedAt: "1740454574225",
       },
     ],
     next: "<value>",

diff --git a/docs/models/operations/subscribersv1controllerlistsubscribersresponse.md b/docs/models/operations/subscribersv1controllerlistsubscribersresponse.md
@@ -41,8 +41,8 @@ let value: SubscribersV1ControllerListSubscribersResponse = {
         organizationId: "<id>",
         environmentId: "<id>",
         deleted: false,
-        createdAt: "1712909064923",
-        updatedAt: "1739919494245",
+        createdAt: "1713458870309",
+        updatedAt: "1740469299631",
       },
     ],
   },

diff --git a/docs/models/operations/subscribersv1controllerlistsubscribersresponsebody.md b/docs/models/operations/subscribersv1controllerlistsubscribersresponsebody.md
@@ -35,8 +35,8 @@ let value: SubscribersV1ControllerListSubscribersResponseBody = {
       organizationId: "<id>",
       environmentId: "<id>",
       deleted: false,
-      createdAt: "1733590539470",
-      updatedAt: "1739877747143",
+      createdAt: "1734140344845",
+      updatedAt: "1740427552518",
     },
   ],
 };

diff --git a/docs/models/operations/subscribersv1controllermarkactionasseenresponse.md b/docs/models/operations/subscribersv1controllermarkactionasseenresponse.md
@@ -43,10 +43,10 @@ let value: SubscribersV1ControllerMarkActionAsSeenResponse = {
       organizationId: "<id>",
       environmentId: "<id>",
       deleted: false,
-      createdAt: "1711418835299",
-      updatedAt: "1739922241126",
+      createdAt: "1711968640638",
+      updatedAt: "1740472046465",
     },
-    createdAt: "1723167659831",
+    createdAt: "1723717465170",
     content: "<value>",
     transactionId: "<id>",
     channel: "chat",

diff --git a/docs/models/operations/subscribersv1controllermarkmessagesasresponse.md b/docs/models/operations/subscribersv1controllermarkmessagesasresponse.md
@@ -44,10 +44,10 @@ let value: SubscribersV1ControllerMarkMessagesAsResponse = {
         organizationId: "<id>",
         environmentId: "<id>",
         deleted: false,
-        createdAt: "1723093852042",
-        updatedAt: "1739858994102",
+        createdAt: "1723643657382",
+        updatedAt: "1740408799443",
       },
-      createdAt: "1713401540608",
+      createdAt: "1713951345948",
       content: {
         type: "text",
         content: "<value>",

diff --git a/docs/models/operations/subscribersv1controllermodifysubscriberchannelresponse.md b/docs/models/operations/subscribersv1controllermodifysubscriberchannelresponse.md
@@ -36,8 +36,8 @@ let value: SubscribersV1ControllerModifySubscriberChannelResponse = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1712454095467",
-    updatedAt: "1739865128567",
+    createdAt: "1713003900860",
+    updatedAt: "1740414933960",
   },
 };
 ```

diff --git a/docs/models/operations/subscribersv1controllerupdatesubscriberchannelresponse.md b/docs/models/operations/subscribersv1controllerupdatesubscriberchannelresponse.md
@@ -36,8 +36,8 @@ let value: SubscribersV1ControllerUpdateSubscriberChannelResponse = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1710287546275",
-    updatedAt: "1739895483840",
+    createdAt: "1710837351667",
+    updatedAt: "1740445289233",
   },
 };
 ```

diff --git a/.../models/operations/subscribersv1controllerupdatesubscriberonlineflagresponse.md b/.../models/operations/subscribersv1controllerupdatesubscriberonlineflagresponse.md
@@ -36,8 +36,8 @@ let value: SubscribersV1ControllerUpdateSubscriberOnlineFlagResponse = {
     organizationId: "<id>",
     environmentId: "<id>",
     deleted: false,
-    createdAt: "1726370000695",
-    updatedAt: "1739875770646",
+    createdAt: "1726919806063",
+    updatedAt: "1740425576013",
   },
 };
 ```