@novu/api 1.7.0 → 1.7.1

package/sources/json-development.json

@@ -13144,7 +13144,8 @@
             "example": "workflow",
             "schema": {
               "enum": [
-                "workflow"
+                "workflow",
+                "layout"
               ],
               "type": "string"
             }
@@ -13204,7 +13205,8 @@
             "description": "Resource type",
             "schema": {
               "enum": [
-                "workflow"
+                "workflow",
+                "layout"
               ],
               "type": "string"
             }
@@ -13279,7 +13281,8 @@
             "description": "Resource type",
             "schema": {
               "enum": [
-                "workflow"
+                "workflow",
+                "layout"
               ],
               "type": "string"
             }
@@ -13339,7 +13342,7 @@
         "x-speakeasy-name-override": "retrieve",
         "x-speakeasy-group": "Translations.Groups",
         "summary": "Retrieve a translation group",
-        "description": "Retrieves a single translation group by resource type (workflow) and resource ID (workflowId)",
+        "description": "Retrieves a single translation group by resource type (workflow, layout) and resource ID (workflowId, layoutId)",
         "parameters": [
           {
             "name": "resourceType",
@@ -13349,7 +13352,8 @@
             "example": "workflow",
             "schema": {
               "enum": [
-                "workflow"
+                "workflow",
+                "layout"
               ],
               "type": "string"
             }
@@ -26445,6 +26449,15 @@
               "type": "string"
             }
           },
+          {
+            "name": "contextSearch",
+            "required": false,
+            "in": "query",
+            "description": "Context search - can search by type, ID, or exact format \"type:id\"",
+            "schema": {
+              "type": "string"
+            }
+          },
           {
             "name": "after",
             "required": false,
@@ -33808,6 +33821,13 @@
           },
           "type": {
             "$ref": "#/components/schemas/TriggerRecipientsTypeEnum"
+          },
+          "exclude": {
+            "description": "Optional array of subscriber IDs to exclude from the topic trigger",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
           }
         },
         "required": [
@@ -34383,6 +34403,10 @@
           "cronExpression": {
             "type": "string",
             "description": "Cron expression for scheduling"
+          },
+          "untilDate": {
+            "type": "string",
+            "description": "Until date for scheduling"
           }
         }
       },
@@ -35356,6 +35380,13 @@
             "type": "boolean",
             "description": "Critical flag"
           },
+          "contextKeys": {
+            "description": "Contexts (keys) in which the workflow run was executed",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "steps": {
             "description": "Workflow run steps",
             "type": "array",
@@ -35599,6 +35630,13 @@
             "type": "boolean",
             "description": "Critical flag"
           },
+          "contextKeys": {
+            "description": "Contexts (keys) in which the workflow run was executed",
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
           "steps": {
             "description": "Step runs",
             "type": "array",
@@ -38577,11 +38615,13 @@
           "URL_TEXT_BOX",
           "DIGEST_AMOUNT",
           "DIGEST_UNIT",
+          "DIGEST_TYPE",
           "DIGEST_KEY",
           "DIGEST_CRON",
-          "DELAY_TYPE",
           "DELAY_AMOUNT",
           "DELAY_UNIT",
+          "DELAY_TYPE",
+          "DELAY_CRON",
           "THROTTLE_TYPE",
           "THROTTLE_WINDOW",
           "THROTTLE_UNIT",
@@ -38772,6 +38812,10 @@
             "type": "boolean",
             "description": "Whether the layout is the default layout"
           },
+          "isTranslationEnabled": {
+            "type": "boolean",
+            "description": "Whether the layout translations are enabled"
+          },
           "updatedAt": {
             "type": "string",
             "description": "Last updated timestamp"
@@ -38816,6 +38860,7 @@
           "slug",
           "name",
           "isDefault",
+          "isTranslationEnabled",
           "updatedAt",
           "createdAt",
           "origin",
@@ -38842,6 +38887,11 @@
             "type": "string",
             "description": "Name of the layout"
           },
+          "isTranslationEnabled": {
+            "type": "boolean",
+            "description": "Enable or disable translations for this layout",
+            "default": false
+          },
           "__source": {
             "$ref": "#/components/schemas/LayoutCreationSourceEnum"
           }
@@ -38858,6 +38908,11 @@
             "type": "string",
             "description": "Name of the layout"
           },
+          "isTranslationEnabled": {
+            "type": "boolean",
+            "description": "Enable or disable translations for this layout",
+            "default": false
+          },
           "controlValues": {
             "nullable": true,
             "description": "Control values for the layout",
@@ -38878,6 +38933,11 @@
           "name": {
             "type": "string",
             "description": "Name of the layout"
+          },
+          "isTranslationEnabled": {
+            "type": "boolean",
+            "description": "Enable or disable translations for this layout",
+            "default": false
           }
         },
         "required": [
@@ -40404,7 +40464,8 @@
           "type": {
             "type": "string",
             "enum": [
-              "regular"
+              "regular",
+              "timed"
             ],
             "description": "Type of the delay. Currently only 'regular' is supported by the schema.",
             "default": "regular"
@@ -40425,13 +40486,13 @@
             ],
             "type": "string",
             "description": "Unit of time for the delay amount."
+          },
+          "cron": {
+            "type": "string",
+            "minLength": 1,
+            "description": "Cron expression for the delay. Min length 1."
           }
-        },
-        "required": [
-          "type",
-          "amount",
-          "unit"
-        ]
+        }
       },
       "DelayControlsMetadataResponseDto": {
         "type": "object",
@@ -41424,7 +41485,7 @@
           },
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the workflow"
+            "description": "Database identifier of the workflow"
           },
           "workflowId": {
             "type": "string",
@@ -41569,7 +41630,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41601,7 +41667,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41633,7 +41704,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41665,7 +41741,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41697,7 +41778,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41729,7 +41815,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41761,7 +41852,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41793,7 +41889,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -41825,7 +41926,12 @@
         "properties": {
           "_id": {
             "type": "string",
-            "description": "Unique identifier of the step"
+            "description": "Database identifier of the step. Used for updating the step."
+          },
+          "stepId": {
+            "type": "string",
+            "pattern": "/^[a-z0-9]+(?:-[a-z0-9]+)*$/",
+            "description": "Unique identifier for the step"
           },
           "name": {
             "type": "string",
@@ -42719,7 +42825,8 @@
             "type": "string",
             "description": "The resource type to associate localizations with",
             "enum": [
-              "workflow"
+              "workflow",
+              "layout"
             ]
           }
         },
@@ -42776,7 +42883,8 @@
             "type": "string",
             "description": "The resource type to associate translation with",
             "enum": [
-              "workflow"
+              "workflow",
+              "layout"
             ]
           },
           "locale": {
@@ -42813,7 +42921,8 @@
             "description": "Resource type",
             "example": "workflow",
             "enum": [
-              "workflow"
+              "workflow",
+              "layout"
             ]
           },
           "locale": {
@@ -42865,10 +42974,21 @@
                 "reset.message": "Click the link to reset"
               }
             }
+          },
+          "layouts": {
+            "type": "object",
+            "description": "All translations for given locale organized by layout identifier",
+            "example": {
+              "default-layout": {
+                "layout.title": "Default layout",
+                "layout.message": "Hello there!"
+              }
+            }
           }
         },
         "required": [
-          "workflows"
+          "workflows",
+          "layouts"
         ]
       },
       "ImportMasterJsonRequestDto": {
@@ -42954,7 +43074,8 @@
             "description": "Resource type",
             "example": "workflow",
             "enum": [
-              "workflow"
+              "workflow",
+              "layout"
             ]
           },
           "resourceName": {

package/src/funcs/notificationsList.ts

@@ -101,6 +101,7 @@ async function $do(
     "after": payload.after,
     "before": payload.before,
     "channels": payload.channels,
+    "contextSearch": payload.contextSearch,
     "emails": payload.emails,
     "limit": payload.limit,
     "page": payload.page,

package/src/funcs/translationsGroupsRetrieve.ts

@@ -29,7 +29,7 @@ import { Result } from "../types/fp.js";
  * Retrieve a translation group
  *
  * @remarks
- * Retrieves a single translation group by resource type (workflow) and resource ID (workflowId)
+ * Retrieves a single translation group by resource type (workflow, layout) and resource ID (workflowId, layoutId)
  */
 export function translationsGroupsRetrieve(
   client: NovuCore,

package/src/lib/config.ts

@@ -59,7 +59,7 @@ export function serverURLFromOptions(options: SDKOptions): URL | null {
 export const SDK_METADATA = {
   language: "typescript",
   openapiDocVersion: "3.9.0",
-  sdkVersion: "1.7.0",
-  genVersion: "2.716.16",
-  userAgent: "speakeasy-sdk/typescript 1.7.0 2.716.16 3.9.0 @novu/api",
+  sdkVersion: "1.7.1",
+  genVersion: "2.721.3",
+  userAgent: "speakeasy-sdk/typescript 1.7.1 2.721.3 3.9.0 @novu/api",
 } as const;

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

@@ -19,7 +19,7 @@ const routes = buildRouteMap({
 export const app = buildApplication(routes, {
   name: "mcp",
   versionInfo: {
-    currentVersion: "1.7.0",
+    currentVersion: "1.7.1",
   },
 });
 

package/src/mcp-server/server.ts

@@ -99,7 +99,7 @@ export function createMCPServer(deps: {
 }) {
   const server = new McpServer({
     name: "Novu",
-    version: "1.7.0",
+    version: "1.7.1",
   });
 
   const client = new NovuCore({

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

@@ -19,7 +19,7 @@ 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)`,
+Retrieves a single translation group by resource type (workflow, layout) and resource ID (workflowId, layoutId)`,
   args,
   tool: async (client, args, ctx) => {
     const [result, apiCall] = await translationsGroupsRetrieve(

package/src/models/components/chatstepupsertdto.ts

@@ -28,9 +28,13 @@ export type ChatStepUpsertDtoControlValues = ChatControlDto | {
 
 export type ChatStepUpsertDto = {
   /**
-   * Unique identifier of the step
+   * Database identifier of the step. Used for updating the step.
    */
   id?: string | undefined;
+  /**
+   * Unique identifier for the step
+   */
+  stepId?: string | undefined;
   /**
    * Name of the step
    */
@@ -104,6 +108,7 @@ export const ChatStepUpsertDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
+  stepId: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
   controlValues: z.union([ChatControlDto$inboundSchema, z.record(z.any())])
@@ -117,6 +122,7 @@ export const ChatStepUpsertDto$inboundSchema: z.ZodType<
 /** @internal */
 export type ChatStepUpsertDto$Outbound = {
   _id?: string | undefined;
+  stepId?: string | undefined;
   name: string;
   type: string;
   controlValues?: ChatControlDto$Outbound | { [k: string]: any } | undefined;
@@ -129,6 +135,7 @@ export const ChatStepUpsertDto$outboundSchema: z.ZodType<
   ChatStepUpsertDto
 > = z.object({
   id: z.string().optional(),
+  stepId: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
   controlValues: z.union([ChatControlDto$outboundSchema, z.record(z.any())])

package/src/models/components/createlayoutdto.ts

@@ -22,6 +22,10 @@ export type CreateLayoutDto = {
    * Name of the layout
    */
   name: string;
+  /**
+   * Enable or disable translations for this layout
+   */
+  isTranslationEnabled?: boolean | undefined;
   /**
    * Source of layout creation
    */
@@ -36,6 +40,7 @@ export const CreateLayoutDto$inboundSchema: z.ZodType<
 > = z.object({
   layoutId: z.string(),
   name: z.string(),
+  isTranslationEnabled: z.boolean().default(false),
   __source: LayoutCreationSourceEnum$inboundSchema.default("dashboard"),
 }).transform((v) => {
   return remap$(v, {
@@ -47,6 +52,7 @@ export const CreateLayoutDto$inboundSchema: z.ZodType<
 export type CreateLayoutDto$Outbound = {
   layoutId: string;
   name: string;
+  isTranslationEnabled: boolean;
   __source: string;
 };
 
@@ -58,6 +64,7 @@ export const CreateLayoutDto$outboundSchema: z.ZodType<
 > = z.object({
   layoutId: z.string(),
   name: z.string(),
+  isTranslationEnabled: z.boolean().default(false),
   source: LayoutCreationSourceEnum$outboundSchema.default("dashboard"),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/createtranslationrequestdto.ts

@@ -13,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export const ResourceType = {
   Workflow: "workflow",
+  Layout: "layout",
 } as const;
 /**
  * The resource type to associate translation with

package/src/models/components/customstepupsertdto.ts

@@ -28,9 +28,13 @@ export type CustomStepUpsertDtoControlValues = CustomControlDto | {
 
 export type CustomStepUpsertDto = {
   /**
-   * Unique identifier of the step
+   * Database identifier of the step. Used for updating the step.
    */
   id?: string | undefined;
+  /**
+   * Unique identifier for the step
+   */
+  stepId?: string | undefined;
   /**
    * Name of the step
    */
@@ -104,6 +108,7 @@ export const CustomStepUpsertDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
+  stepId: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
   controlValues: z.union([CustomControlDto$inboundSchema, z.record(z.any())])
@@ -117,6 +122,7 @@ export const CustomStepUpsertDto$inboundSchema: z.ZodType<
 /** @internal */
 export type CustomStepUpsertDto$Outbound = {
   _id?: string | undefined;
+  stepId?: string | undefined;
   name: string;
   type: string;
   controlValues?: CustomControlDto$Outbound | { [k: string]: any } | undefined;
@@ -129,6 +135,7 @@ export const CustomStepUpsertDto$outboundSchema: z.ZodType<
   CustomStepUpsertDto
 > = z.object({
   id: z.string().optional(),
+  stepId: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
   controlValues: z.union([CustomControlDto$outboundSchema, z.record(z.any())])

package/src/models/components/delaycontroldto.ts

@@ -13,6 +13,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
  */
 export const Type = {
   Regular: "regular",
+  Timed: "timed",
 } as const;
 /**
  * Type of the delay. Currently only 'regular' is supported by the schema.
@@ -47,11 +48,15 @@ export type DelayControlDto = {
   /**
    * Amount of time to delay.
    */
-  amount: number;
+  amount?: number | undefined;
   /**
    * Unit of time for the delay amount.
    */
-  unit: Unit;
+  unit?: Unit | undefined;
+  /**
+   * Cron expression for the delay. Min length 1.
+   */
+  cron?: string | undefined;
 };
 
 /** @internal */
@@ -102,16 +107,18 @@ export const DelayControlDto$inboundSchema: z.ZodType<
 > = z.object({
   skip: z.record(z.any()).optional(),
   type: Type$inboundSchema.default("regular"),
-  amount: z.number(),
-  unit: Unit$inboundSchema,
+  amount: z.number().optional(),
+  unit: Unit$inboundSchema.optional(),
+  cron: z.string().optional(),
 });
 
 /** @internal */
 export type DelayControlDto$Outbound = {
   skip?: { [k: string]: any } | undefined;
   type: string;
-  amount: number;
-  unit: string;
+  amount?: number | undefined;
+  unit?: string | undefined;
+  cron?: string | undefined;
 };
 
 /** @internal */
@@ -122,8 +129,9 @@ export const DelayControlDto$outboundSchema: z.ZodType<
 > = z.object({
   skip: z.record(z.any()).optional(),
   type: Type$outboundSchema.default("regular"),
-  amount: z.number(),
-  unit: Unit$outboundSchema,
+  amount: z.number().optional(),
+  unit: Unit$outboundSchema.optional(),
+  cron: z.string().optional(),
 });
 
 /**