@novu/api 1.5.0 → 1.6.1-rc.0

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsDelete } from "../../funcs/layoutsDelete.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsDelete: ToolDefinition<typeof args> = {
+  name: "layouts-delete",
+  description: `Delete a layout
+
+Removes a specific layout by its unique identifier **layoutId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsDelete(
+      client,
+      args.layoutId,
+      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/layoutsDuplicate.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsDuplicate } from "../../funcs/layoutsDuplicate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  duplicateLayoutDto: components.DuplicateLayoutDto$inboundSchema,
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsDuplicate: ToolDefinition<typeof args> = {
+  name: "layouts-duplicate",
+  description: `Duplicate a layout
+
+Duplicates a layout by its unique identifier **layoutId**. This will create a new layout with the content of the original layout.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsDuplicate(
+      client,
+      args.duplicateLayoutDto,
+      args.layoutId,
+      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/layoutsGeneratePreview.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsGeneratePreview } from "../../funcs/layoutsGeneratePreview.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  layoutPreviewRequestDto: components.LayoutPreviewRequestDto$inboundSchema,
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsGeneratePreview: ToolDefinition<typeof args> = {
+  name: "layouts-generate-preview",
+  description: `Generate layout preview
+
+Generates a preview for a layout by its unique identifier **layoutId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsGeneratePreview(
+      client,
+      args.layoutPreviewRequestDto,
+      args.layoutId,
+      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/{retrieve.ts → layoutsList.ts}

@@ -2,20 +2,22 @@
  * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
  */
 
-import { retrieve } from "../../funcs/retrieve.js";
+import { layoutsList } from "../../funcs/layoutsList.js";
 import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
-  request: operations.LogsControllerGetLogsRequest$inboundSchema,
+  request: operations.LayoutsControllerListRequest$inboundSchema,
 };
 
-export const tool$retrieve: ToolDefinition<typeof args> = {
-  name: "retrieve",
-  description: ``,
+export const tool$layoutsList: ToolDefinition<typeof args> = {
+  name: "layouts-list",
+  description: `List all layouts
+
+Retrieves a list of layouts with optional filtering and pagination`,
   args,
   tool: async (client, args, ctx) => {
-    const [result, apiCall] = await retrieve(
+    const [result, apiCall] = await layoutsList(
       client,
       args.request,
       { fetchOptions: { signal: ctx.signal } },
@@ -28,7 +30,7 @@ export const tool$retrieve: ToolDefinition<typeof args> = {
       };
     }
 
-    const value = result.value;
+    const value = result.value.result;
 
     return formatResult(value, apiCall);
   },

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsRetrieve } from "../../funcs/layoutsRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsRetrieve: ToolDefinition<typeof args> = {
+  name: "layouts-retrieve",
+  description: `Retrieve a layout
+
+Fetches details of a specific layout by its unique identifier **layoutId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsRetrieve(
+      client,
+      args.layoutId,
+      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/layoutsUpdate.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsUpdate } from "../../funcs/layoutsUpdate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  updateLayoutDto: components.UpdateLayoutDto$inboundSchema,
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsUpdate: ToolDefinition<typeof args> = {
+  name: "layouts-update",
+  description: `Update a layout
+
+Updates the details of an existing layout, here **layoutId** is the identifier of the layout`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsUpdate(
+      client,
+      args.updateLayoutDto,
+      args.layoutId,
+      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/layoutsUsage.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { layoutsUsage } from "../../funcs/layoutsUsage.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  layoutId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$layoutsUsage: ToolDefinition<typeof args> = {
+  name: "layouts-usage",
+  description: `Get layout usage
+
+Retrieves information about workflows that use the specified layout by its unique identifier **layoutId**`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await layoutsUsage(
+      client,
+      args.layoutId,
+      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/subscribersCreate.ts

@@ -10,6 +10,7 @@ import { formatResult, ToolDefinition } from "../tools.js";
 const args = {
   createSubscriberRequestDto:
     components.CreateSubscriberRequestDto$inboundSchema,
+  failIfExists: z.boolean().optional(),
   idempotencyKey: z.string().optional(),
 };
 
@@ -24,6 +25,7 @@ Create a subscriber with the subscriber attributes.
     const [result, apiCall] = await subscribersCreate(
       client,
       args.createSubscriberRequestDto,
+      args.failIfExists,
       args.idempotencyKey,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();

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

@@ -16,9 +16,9 @@ const args = {
 
 export const tool$subscribersCredentialsAppend: ToolDefinition<typeof args> = {
   name: "subscribers-credentials-append",
-  description: `Create or Partially Update provider credentials
+  description: `Update provider credentials
 
-Create or Partially credentials for a provider such as **slack** and **FCM**. 
+Update credentials for a provider such as **slack** and **FCM**. 
       **providerId** is required field. This API creates the **deviceTokens** or replaces the existing ones.`,
   args,
   tool: async (client, args, ctx) => {

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

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { subscribersPreferencesBulkUpdate } from "../../funcs/subscribersPreferencesBulkUpdate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  bulkUpdateSubscriberPreferencesDto:
+    components.BulkUpdateSubscriberPreferencesDto$inboundSchema,
+  subscriberId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$subscribersPreferencesBulkUpdate: ToolDefinition<
+  typeof args
+> = {
+  name: "subscribers-preferences-bulk-update",
+  description: `Bulk update subscriber preferences
+
+Bulk update subscriber preferences by its unique key identifier **subscriberId**. 
+    This API allows updating multiple workflow preferences in a single request.`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await subscribersPreferencesBulkUpdate(
+      client,
+      args.bulkUpdateSubscriberPreferencesDto,
+      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

@@ -4,10 +4,12 @@
 
 import * as z from "zod";
 import { subscribersPreferencesList } from "../../funcs/subscribersPreferencesList.js";
+import * as operations from "../../models/operations/index.js";
 import { formatResult, ToolDefinition } from "../tools.js";
 
 const args = {
   subscriberId: z.string(),
+  criticality: operations.Criticality$inboundSchema.default("nonCritical"),
   idempotencyKey: z.string().optional(),
 };
 
@@ -22,6 +24,7 @@ Retrieve subscriber channel preferences by its unique key identifier **subscribe
     const [result, apiCall] = await subscribersPreferencesList(
       client,
       args.subscriberId,
+      args.criticality,
       args.idempotencyKey,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();

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

@@ -10,6 +10,7 @@ import { formatResult, ToolDefinition } from "../tools.js";
 const args = {
   createUpdateTopicRequestDto:
     components.CreateUpdateTopicRequestDto$inboundSchema,
+  failIfExists: z.boolean().optional(),
   idempotencyKey: z.string().optional(),
 };
 
@@ -17,12 +18,13 @@ export const tool$topicsCreate: ToolDefinition<typeof args> = {
   name: "topics-create",
   description: `Create a topic
 
-Creates a new topic if it does not exist, or updates an existing topic if it already exists`,
+Creates a new topic if it does not exist, or updates an existing topic if it already exists. Use ?failIfExists=true to prevent updates.`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await topicsCreate(
       client,
       args.createUpdateTopicRequestDto,
+      args.failIfExists,
       args.idempotencyKey,
       { fetchOptions: { signal: ctx.signal } },
     ).$inspect();

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsCreate } from "../../funcs/translationsCreate.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  createTranslationRequestDto:
+    components.CreateTranslationRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsCreate: ToolDefinition<typeof args> = {
+  name: "translations-create",
+  description: `Create or update translation
+
+Create or update a translation for a specific workflow and locale`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsCreate(
+      client,
+      args.createTranslationRequestDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import { translationsDelete } from "../../funcs/translationsDelete.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  request:
+    operations
+      .TranslationControllerDeleteTranslationEndpointRequest$inboundSchema,
+};
+
+export const tool$translationsDelete: ToolDefinition<typeof args> = {
+  name: "translations-delete",
+  description: `Delete translation
+
+Delete a specific translation by resource type, resource ID and locale`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsDelete(
+      client,
+      args.request,
+      { 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/translationsGroupsDelete.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsGroupsDelete } from "../../funcs/translationsGroupsDelete.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  resourceType: operations.ResourceType$inboundSchema,
+  resourceId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsGroupsDelete: ToolDefinition<typeof args> = {
+  name: "translations-groups-delete",
+  description: `Delete translation group
+
+Delete an entire translation group and all its translations`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsGroupsDelete(
+      client,
+      args.resourceType,
+      args.resourceId,
+      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/translationsGroupsRetrieve.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsGroupsRetrieve } from "../../funcs/translationsGroupsRetrieve.js";
+import * as operations from "../../models/operations/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  resourceType:
+    operations
+      .TranslationControllerGetTranslationGroupEndpointPathParamResourceType$inboundSchema,
+  resourceId: z.string(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsGroupsRetrieve: ToolDefinition<typeof args> = {
+  name: "translations-groups-retrieve",
+  description: `Get translation group
+
+Retrieves a single translation group by resourceId and resourceType`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsGroupsRetrieve(
+      client,
+      args.resourceType,
+      args.resourceId,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsMasterImport } from "../../funcs/translationsMasterImport.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  importMasterJsonRequestDto:
+    components.ImportMasterJsonRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsMasterImport: ToolDefinition<typeof args> = {
+  name: "translations-master-import",
+  description: `Import master translations JSON
+
+Import translations from master JSON format for a specific locale`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsMasterImport(
+      client,
+      args.importMasterJsonRequestDto,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};

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

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsMasterRetrieve } from "../../funcs/translationsMasterRetrieve.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  locale: z.string().optional(),
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsMasterRetrieve: ToolDefinition<typeof args> = {
+  name: "translations-master-retrieve",
+  description: `Get master translations JSON
+
+Get all translations for a locale in master JSON format organized by namespace and resource`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsMasterRetrieve(
+      client,
+      args.locale,
+      args.idempotencyKey,
+      { fetchOptions: { signal: ctx.signal } },
+    ).$inspect();
+
+    if (!result.ok) {
+      return {
+        content: [{ type: "text", text: result.error.message }],
+        isError: true,
+      };
+    }
+
+    const value = result.value;
+
+    return formatResult(value, apiCall);
+  },
+};