@novu/api 1.6.0 → 1.7.0

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/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/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 a translation
+
+Create a translation for a specific workflow and locale, if the translation already exists, it will be updated`,
+  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 a 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 a 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: `Retrieve a translation group
+
+Retrieves a single translation group by resource type (workflow) and resource ID (workflowId)`,
+  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 for multiple workflows 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: `Retrieve master translations JSON
+
+Retrieve all translations for a locale in master JSON format organized by resourceId (workflowId)`,
+  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);
+  },
+};

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

@@ -0,0 +1,37 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsMasterUpload } from "../../funcs/translationsMasterUpload.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsMasterUpload: ToolDefinition<typeof args> = {
+  name: "translations-master-upload",
+  description: `Upload master translations JSON file
+
+Upload a master JSON file containing translations for multiple workflows. Locale is automatically detected from filename (e.g., en_US.json)`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsMasterUpload(
+      client,
+      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/translationsRetrieve.ts

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

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

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { translationsUpload } from "../../funcs/translationsUpload.js";
+import * as components from "../../models/components/index.js";
+import { formatResult, ToolDefinition } from "../tools.js";
+
+const args = {
+  uploadTranslationsRequestDto:
+    components.UploadTranslationsRequestDto$inboundSchema,
+  idempotencyKey: z.string().optional(),
+};
+
+export const tool$translationsUpload: ToolDefinition<typeof args> = {
+  name: "translations-upload",
+  description: `Upload translation files
+
+Upload one or more JSON translation files for a specific workflow. Files name must match the locale, e.g. en_US.json`,
+  args,
+  tool: async (client, args, ctx) => {
+    const [result, apiCall] = await translationsUpload(
+      client,
+      args.uploadTranslationsRequestDto,
+      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/models/components/activitynotificationexecutiondetailresponsedto.ts

@@ -51,7 +51,7 @@ export type ActivityNotificationExecutionDetailResponseDto = {
   /**
    * Provider ID of the job
    */
-  providerId: ProvidersIdEnum;
+  providerId?: ProvidersIdEnum | undefined;
   /**
    * Raw data of the execution
    */
@@ -75,7 +75,7 @@ export const ActivityNotificationExecutionDetailResponseDto$inboundSchema:
     detail: z.string(),
     isRetry: z.boolean(),
     isTest: z.boolean(),
-    providerId: ProvidersIdEnum$inboundSchema,
+    providerId: ProvidersIdEnum$inboundSchema.optional(),
     raw: z.nullable(z.string()).optional(),
     source: ExecutionDetailsSourceEnum$inboundSchema,
   }).transform((v) => {
@@ -92,7 +92,7 @@ export type ActivityNotificationExecutionDetailResponseDto$Outbound = {
   detail: string;
   isRetry: boolean;
   isTest: boolean;
-  providerId: string;
+  providerId?: string | undefined;
   raw?: string | null | undefined;
   source: string;
 };
@@ -110,7 +110,7 @@ export const ActivityNotificationExecutionDetailResponseDto$outboundSchema:
     detail: z.string(),
     isRetry: z.boolean(),
     isTest: z.boolean(),
-    providerId: ProvidersIdEnum$outboundSchema,
+    providerId: ProvidersIdEnum$outboundSchema.optional(),
     raw: z.nullable(z.string()).optional(),
     source: ExecutionDetailsSourceEnum$outboundSchema,
   }).transform((v) => {

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -44,6 +44,7 @@ export const ActivityNotificationJobResponseDtoType = {
   Digest: "digest",
   Trigger: "trigger",
   Delay: "delay",
+  Throttle: "throttle",
   Custom: "custom",
 } as const;
 /**
@@ -99,6 +100,10 @@ export type ActivityNotificationJobResponseDto = {
    * Updated time of the notification
    */
   updatedAt?: string | undefined;
+  /**
+   * The number of times the digest/delay job has been extended to align with the subscribers schedule
+   */
+  scheduleExtensionsCount?: number | undefined;
 };
 
 /** @internal */
@@ -204,6 +209,7 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
   providerId: ProvidersIdEnum$inboundSchema,
   status: z.string(),
   updatedAt: z.string().optional(),
+  scheduleExtensionsCount: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -224,6 +230,7 @@ export type ActivityNotificationJobResponseDto$Outbound = {
   providerId: string;
   status: string;
   updatedAt?: string | undefined;
+  scheduleExtensionsCount?: number | undefined;
 };
 
 /** @internal */
@@ -246,6 +253,7 @@ export const ActivityNotificationJobResponseDto$outboundSchema: z.ZodType<
   providerId: ProvidersIdEnum$outboundSchema,
   status: z.string(),
   updatedAt: z.string().optional(),
+  scheduleExtensionsCount: z.number().optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",