@novu/api 0.3.0 → 0.4.0

package/src/mcp-server/tools/subscribersPatch.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { subscribersPatch } from "../../funcs/subscribersPatch.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  patchSubscriberRequestDto: components.PatchSubscriberRequestDto$inboundSchema,
+  subscriberId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$subscribersPatch: ToolDefinition<typeof args> = {
+  name: "subscribers_patch",
+  description: `Patch subscriber
+
+Patch subscriber by your internal id used to identify the subscriber`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersPatch(
+      client,
+      args.patchSubscriberRequestDto,
+      args.subscriberId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/subscribersPreferencesList.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { subscribersPreferencesList } from "../../funcs/subscribersPreferencesList.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  subscriberId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$subscribersPreferencesList: ToolDefinition<typeof args> = {
+  name: "subscribers-preferences_list",
+  description: `Get subscriber preferences
+
+Get subscriber global and workflow specific preferences`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersPreferencesList(
+      client,
+      args.subscriberId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/subscribersPreferencesUpdate.ts

@@ -0,0 +1,43 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { subscribersPreferencesUpdate } from "../../funcs/subscribersPreferencesUpdate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  patchSubscriberPreferencesDto:
+    components.PatchSubscriberPreferencesDto$inboundSchema,
+  subscriberId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$subscribersPreferencesUpdate: ToolDefinition<typeof args> = {
+  name: "subscribers-preferences_update",
+  description: `Update subscriber global or workflow specific preferences
+
+Update subscriber global or workflow specific preferences`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersPreferencesUpdate(
+      client,
+      args.patchSubscriberPreferencesDto,
+      args.subscriberId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/subscribersPropertiesUpdateOnlineFlag.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { subscribersPropertiesUpdateOnlineFlag } from "../../funcs/subscribersPropertiesUpdateOnlineFlag.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  updateSubscriberOnlineFlagRequestDto:
+    components.UpdateSubscriberOnlineFlagRequestDto$inboundSchema,
+  subscriberId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$subscribersPropertiesUpdateOnlineFlag: ToolDefinition<
+  typeof args
+> = {
+  name: "subscribers-properties_update-online-flag",
+  description: `Update subscriber online status
+
+Used to update the subscriber isOnline flag.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersPropertiesUpdateOnlineFlag(
+      client,
+      args.updateSubscriberOnlineFlagRequestDto,
+      args.subscriberId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/subscribersRetrieve.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { subscribersRetrieve } from "../../funcs/subscribersRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  subscriberId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$subscribersRetrieve: ToolDefinition<typeof args> = {
+  name: "subscribers_retrieve",
+  description: `Get subscriber
+
+Get subscriber by your internal id used to identify the subscriber`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersRetrieve(
+      client,
+      args.subscriberId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/subscribersSearch.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { subscribersSearch } from "../../funcs/subscribersSearch.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations.SubscribersControllerSearchSubscribersRequest$inboundSchema,
+};
+
+export const tool$subscribersSearch: ToolDefinition<typeof args> = {
+  name: "subscribers_search",
+  description: `Search for subscribers`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersSearch(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsCreate.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsCreate } from "../../funcs/topicsCreate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  createTopicRequestDto: components.CreateTopicRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsCreate: ToolDefinition<typeof args> = {
+  name: "topics_create",
+  description: `Topic creation
+
+Create a topic`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsCreate(
+      client,
+      args.createTopicRequestDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsDelete.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsDelete } from "../../funcs/topicsDelete.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsDelete: ToolDefinition<typeof args> = {
+  name: "topics_delete",
+  description: `Delete topic
+
+Delete a topic by its topic key if it has no subscribers`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsDelete(
+      client,
+      args.topicKey,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsList.ts

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { topicsList } from "../../funcs/topicsList.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request: operations.TopicsControllerListTopicsRequest$inboundSchema,
+};
+
+export const tool$topicsList: ToolDefinition<typeof args> = {
+  name: "topics_list",
+  description: `Get topic list filtered 
+
+Returns a list of topics that can be paginated using the \`page\` query parameter and filtered by the topic key with the \`key\` query parameter`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsList(
+      client,
+      args.request,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsRename.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsRename } from "../../funcs/topicsRename.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  renameTopicRequestDto: components.RenameTopicRequestDto$inboundSchema,
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsRename: ToolDefinition<typeof args> = {
+  name: "topics_rename",
+  description: `Rename a topic
+
+Rename a topic by providing a new name`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsRename(
+      client,
+      args.renameTopicRequestDto,
+      args.topicKey,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsRetrieve.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsRetrieve } from "../../funcs/topicsRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsRetrieve: ToolDefinition<typeof args> = {
+  name: "topics_retrieve",
+  description: `Get topic
+
+Get a topic by its topic key`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsRetrieve(
+      client,
+      args.topicKey,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsSubscribersAssign.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsSubscribersAssign } from "../../funcs/topicsSubscribersAssign.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  addSubscribersRequestDto: components.AddSubscribersRequestDto$inboundSchema,
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsSubscribersAssign: ToolDefinition<typeof args> = {
+  name: "topics-subscribers_assign",
+  description: `Subscribers addition
+
+Add subscribers to a topic by key`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsSubscribersAssign(
+      client,
+      args.addSubscribersRequestDto,
+      args.topicKey,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsSubscribersRemove.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsSubscribersRemove } from "../../funcs/topicsSubscribersRemove.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  removeSubscribersRequestDto:
+    components.RemoveSubscribersRequestDto$inboundSchema,
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsSubscribersRemove: ToolDefinition<typeof args> = {
+  name: "topics-subscribers_remove",
+  description: `Subscribers removal
+
+Remove subscribers from a topic`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsSubscribersRemove(
+      client,
+      args.removeSubscribersRequestDto,
+      args.topicKey,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    return formatResult(void 0, apiCall);
+  },
+};

package/src/mcp-server/tools/topicsSubscribersRetrieve.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { topicsSubscribersRetrieve } from "../../funcs/topicsSubscribersRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  externalSubscriberId: z.string(),
+  topicKey: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$topicsSubscribersRetrieve: ToolDefinition<typeof args> = {
+  name: "topics-subscribers_retrieve",
+  description: `Check topic subscriber
+
+Check if a subscriber belongs to a certain topic`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await topicsSubscribersRetrieve(
+      client,
+      args.externalSubscriberId,
+      args.topicKey,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/trigger.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { trigger } from "../../funcs/trigger.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  triggerEventRequestDto: components.TriggerEventRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$trigger: ToolDefinition<typeof args> = {
+  name: "trigger",
+  description: `Trigger event
+
+
+    Trigger event is the main (and only) way to send notifications to subscribers. 
+    The trigger identifier is used to match the particular workflow associated with it. 
+    Additional information can be passed according the body interface below.
+    `,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await trigger(
+      client,
+      args.triggerEventRequestDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};

package/src/mcp-server/tools/triggerBroadcast.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { triggerBroadcast } from "../../funcs/triggerBroadcast.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  triggerEventToAllRequestDto:
+    components.TriggerEventToAllRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$triggerBroadcast: ToolDefinition<typeof args> = {
+  name: "trigger-broadcast",
+  description: `Broadcast event to all
+
+Trigger a broadcast event to all existing subscribers, could be used to send announcements, etc.
+      In the future could be used to trigger events to a subset of subscribers based on defined filters.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await triggerBroadcast(
+      client,
+      args.triggerEventToAllRequestDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value.result;
+
+    return formatResult(value, apiCall);
+  },
+};