@novu/api 1.4.0 → 1.5.0

package/src/models/components/delaystepupsertdto.ts

@@ -5,9 +5,14 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  DelayControlDto,
+  DelayControlDto$inboundSchema,
+  DelayControlDto$Outbound,
+  DelayControlDto$outboundSchema,
+} from "./delaycontroldto.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -15,52 +20,10 @@ import {
 } from "./steptypeenum.js";
 
 /**
- * Type of the delay. Currently only 'regular' is supported by the schema.
- */
-export const DelayStepUpsertDtoType = {
-  Regular: "regular",
-} as const;
-/**
- * Type of the delay. Currently only 'regular' is supported by the schema.
- */
-export type DelayStepUpsertDtoType = ClosedEnum<typeof DelayStepUpsertDtoType>;
-
-/**
- * Unit of time for the delay amount.
+ * Control values for the Delay step.
  */
-export const DelayStepUpsertDtoUnit = {
-  Seconds: "seconds",
-  Minutes: "minutes",
-  Hours: "hours",
-  Days: "days",
-  Weeks: "weeks",
-  Months: "months",
-} as const;
-/**
- * Unit of time for the delay amount.
- */
-export type DelayStepUpsertDtoUnit = ClosedEnum<typeof DelayStepUpsertDtoUnit>;
-
-/**
- * Control values for the Delay step
- */
-export type DelayStepUpsertDtoControlValues = {
-  /**
-   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
-   */
-  skip?: { [k: string]: any } | undefined;
-  /**
-   * Type of the delay. Currently only 'regular' is supported by the schema.
-   */
-  type?: DelayStepUpsertDtoType | undefined;
-  /**
-   * Amount of time to delay.
-   */
-  amount: number;
-  /**
-   * Unit of time for the delay amount.
-   */
-  unit: DelayStepUpsertDtoUnit;
+export type DelayStepUpsertDtoControlValues = DelayControlDto | {
+  [k: string]: any;
 };
 
 export type DelayStepUpsertDto = {
@@ -77,84 +40,29 @@ export type DelayStepUpsertDto = {
    */
   type: StepTypeEnum;
   /**
-   * Control values for the Delay step
+   * Control values for the Delay step.
    */
-  controlValues?: DelayStepUpsertDtoControlValues | null | undefined;
+  controlValues?: DelayControlDto | { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export const DelayStepUpsertDtoType$inboundSchema: z.ZodNativeEnum<
-  typeof DelayStepUpsertDtoType
-> = z.nativeEnum(DelayStepUpsertDtoType);
-
-/** @internal */
-export const DelayStepUpsertDtoType$outboundSchema: z.ZodNativeEnum<
-  typeof DelayStepUpsertDtoType
-> = DelayStepUpsertDtoType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace DelayStepUpsertDtoType$ {
-  /** @deprecated use `DelayStepUpsertDtoType$inboundSchema` instead. */
-  export const inboundSchema = DelayStepUpsertDtoType$inboundSchema;
-  /** @deprecated use `DelayStepUpsertDtoType$outboundSchema` instead. */
-  export const outboundSchema = DelayStepUpsertDtoType$outboundSchema;
-}
-
-/** @internal */
-export const DelayStepUpsertDtoUnit$inboundSchema: z.ZodNativeEnum<
-  typeof DelayStepUpsertDtoUnit
-> = z.nativeEnum(DelayStepUpsertDtoUnit);
-
-/** @internal */
-export const DelayStepUpsertDtoUnit$outboundSchema: z.ZodNativeEnum<
-  typeof DelayStepUpsertDtoUnit
-> = DelayStepUpsertDtoUnit$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace DelayStepUpsertDtoUnit$ {
-  /** @deprecated use `DelayStepUpsertDtoUnit$inboundSchema` instead. */
-  export const inboundSchema = DelayStepUpsertDtoUnit$inboundSchema;
-  /** @deprecated use `DelayStepUpsertDtoUnit$outboundSchema` instead. */
-  export const outboundSchema = DelayStepUpsertDtoUnit$outboundSchema;
-}
-
 /** @internal */
 export const DelayStepUpsertDtoControlValues$inboundSchema: z.ZodType<
   DelayStepUpsertDtoControlValues,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  type: DelayStepUpsertDtoType$inboundSchema.default("regular"),
-  amount: z.number(),
-  unit: DelayStepUpsertDtoUnit$inboundSchema,
-});
+> = z.union([DelayControlDto$inboundSchema, z.record(z.any())]);
 
 /** @internal */
-export type DelayStepUpsertDtoControlValues$Outbound = {
-  skip?: { [k: string]: any } | undefined;
-  type: string;
-  amount: number;
-  unit: string;
-};
+export type DelayStepUpsertDtoControlValues$Outbound =
+  | DelayControlDto$Outbound
+  | { [k: string]: any };
 
 /** @internal */
 export const DelayStepUpsertDtoControlValues$outboundSchema: z.ZodType<
   DelayStepUpsertDtoControlValues$Outbound,
   z.ZodTypeDef,
   DelayStepUpsertDtoControlValues
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  type: DelayStepUpsertDtoType$outboundSchema.default("regular"),
-  amount: z.number(),
-  unit: DelayStepUpsertDtoUnit$outboundSchema,
-});
+> = z.union([DelayControlDto$outboundSchema, z.record(z.any())]);
 
 /**
  * @internal
@@ -198,9 +106,8 @@ export const DelayStepUpsertDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => DelayStepUpsertDtoControlValues$inboundSchema),
-  ).optional(),
+  controlValues: z.union([DelayControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -212,7 +119,7 @@ export type DelayStepUpsertDto$Outbound = {
   _id?: string | undefined;
   name: string;
   type: string;
-  controlValues?: DelayStepUpsertDtoControlValues$Outbound | null | undefined;
+  controlValues?: DelayControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -224,9 +131,8 @@ export const DelayStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => DelayStepUpsertDtoControlValues$outboundSchema),
-  ).optional(),
+  controlValues: z.union([DelayControlDto$outboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/digeststepresponsedto.ts

@@ -23,6 +23,11 @@ import {
   LookBackWindowDto$Outbound,
   LookBackWindowDto$outboundSchema,
 } from "./lookbackwindowdto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   StepIssuesDto,
   StepIssuesDto$inboundSchema,
@@ -34,11 +39,6 @@ import {
   StepTypeEnum$inboundSchema,
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 
 /**
  * The type of digest strategy. Determines which fields are applicable.
@@ -148,7 +148,7 @@ export type DigestStepResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Workflow identifier
    */
@@ -357,7 +357,7 @@ export const DigestStepResponseDto$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => DigestStepResponseDtoSlug$inboundSchema),
   type: StepTypeEnum$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
@@ -398,7 +398,7 @@ export const DigestStepResponseDto$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => DigestStepResponseDtoSlug$outboundSchema),
   type: StepTypeEnum$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$outboundSchema.optional(),

package/src/models/components/digeststepupsertdto.ts

@@ -5,15 +5,14 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
-import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  LookBackWindowDto,
-  LookBackWindowDto$inboundSchema,
-  LookBackWindowDto$Outbound,
-  LookBackWindowDto$outboundSchema,
-} from "./lookbackwindowdto.js";
+  DigestControlDto,
+  DigestControlDto$inboundSchema,
+  DigestControlDto$Outbound,
+  DigestControlDto$outboundSchema,
+} from "./digestcontroldto.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -21,69 +20,10 @@ import {
 } from "./steptypeenum.js";
 
 /**
- * The type of digest strategy. Determines which fields are applicable.
+ * Control values for the Digest step.
  */
-export const DigestStepUpsertDtoType = {
-  Regular: "regular",
-  Timed: "timed",
-} as const;
-/**
- * The type of digest strategy. Determines which fields are applicable.
- */
-export type DigestStepUpsertDtoType = ClosedEnum<
-  typeof DigestStepUpsertDtoType
->;
-
-/**
- * The unit of time for the digest interval (for REGULAR type).
- */
-export const DigestStepUpsertDtoUnit = {
-  Seconds: "seconds",
-  Minutes: "minutes",
-  Hours: "hours",
-  Days: "days",
-  Weeks: "weeks",
-  Months: "months",
-} as const;
-/**
- * The unit of time for the digest interval (for REGULAR type).
- */
-export type DigestStepUpsertDtoUnit = ClosedEnum<
-  typeof DigestStepUpsertDtoUnit
->;
-
-/**
- * Control values for the Digest step
- */
-export type DigestStepUpsertDtoControlValues = {
-  /**
-   * JSONLogic filter conditions for conditionally skipping the step execution. Supports complex logical operations with AND, OR, and comparison operators. See https://jsonlogic.com/ for full typing reference.
-   */
-  skip?: { [k: string]: any } | undefined;
-  /**
-   * The type of digest strategy. Determines which fields are applicable.
-   */
-  type?: DigestStepUpsertDtoType | undefined;
-  /**
-   * The amount of time for the digest interval (for REGULAR type). Min 1.
-   */
-  amount?: number | undefined;
-  /**
-   * The unit of time for the digest interval (for REGULAR type).
-   */
-  unit?: DigestStepUpsertDtoUnit | undefined;
-  /**
-   * Configuration for look-back window (for REGULAR type).
-   */
-  lookBackWindow?: LookBackWindowDto | undefined;
-  /**
-   * Cron expression for TIMED digest. Min length 1.
-   */
-  cron?: string | undefined;
-  /**
-   * Specify a custom key for digesting events instead of the default event key.
-   */
-  digestKey?: string | undefined;
+export type DigestStepUpsertDtoControlValues = DigestControlDto | {
+  [k: string]: any;
 };
 
 export type DigestStepUpsertDto = {
@@ -100,93 +40,29 @@ export type DigestStepUpsertDto = {
    */
   type: StepTypeEnum;
   /**
-   * Control values for the Digest step
+   * Control values for the Digest step.
    */
-  controlValues?: DigestStepUpsertDtoControlValues | null | undefined;
+  controlValues?: DigestControlDto | { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export const DigestStepUpsertDtoType$inboundSchema: z.ZodNativeEnum<
-  typeof DigestStepUpsertDtoType
-> = z.nativeEnum(DigestStepUpsertDtoType);
-
-/** @internal */
-export const DigestStepUpsertDtoType$outboundSchema: z.ZodNativeEnum<
-  typeof DigestStepUpsertDtoType
-> = DigestStepUpsertDtoType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace DigestStepUpsertDtoType$ {
-  /** @deprecated use `DigestStepUpsertDtoType$inboundSchema` instead. */
-  export const inboundSchema = DigestStepUpsertDtoType$inboundSchema;
-  /** @deprecated use `DigestStepUpsertDtoType$outboundSchema` instead. */
-  export const outboundSchema = DigestStepUpsertDtoType$outboundSchema;
-}
-
-/** @internal */
-export const DigestStepUpsertDtoUnit$inboundSchema: z.ZodNativeEnum<
-  typeof DigestStepUpsertDtoUnit
-> = z.nativeEnum(DigestStepUpsertDtoUnit);
-
-/** @internal */
-export const DigestStepUpsertDtoUnit$outboundSchema: z.ZodNativeEnum<
-  typeof DigestStepUpsertDtoUnit
-> = DigestStepUpsertDtoUnit$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace DigestStepUpsertDtoUnit$ {
-  /** @deprecated use `DigestStepUpsertDtoUnit$inboundSchema` instead. */
-  export const inboundSchema = DigestStepUpsertDtoUnit$inboundSchema;
-  /** @deprecated use `DigestStepUpsertDtoUnit$outboundSchema` instead. */
-  export const outboundSchema = DigestStepUpsertDtoUnit$outboundSchema;
-}
-
 /** @internal */
 export const DigestStepUpsertDtoControlValues$inboundSchema: z.ZodType<
   DigestStepUpsertDtoControlValues,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  type: DigestStepUpsertDtoType$inboundSchema.optional(),
-  amount: z.number().optional(),
-  unit: DigestStepUpsertDtoUnit$inboundSchema.optional(),
-  lookBackWindow: LookBackWindowDto$inboundSchema.optional(),
-  cron: z.string().optional(),
-  digestKey: z.string().optional(),
-});
+> = z.union([DigestControlDto$inboundSchema, z.record(z.any())]);
 
 /** @internal */
-export type DigestStepUpsertDtoControlValues$Outbound = {
-  skip?: { [k: string]: any } | undefined;
-  type?: string | undefined;
-  amount?: number | undefined;
-  unit?: string | undefined;
-  lookBackWindow?: LookBackWindowDto$Outbound | undefined;
-  cron?: string | undefined;
-  digestKey?: string | undefined;
-};
+export type DigestStepUpsertDtoControlValues$Outbound =
+  | DigestControlDto$Outbound
+  | { [k: string]: any };
 
 /** @internal */
 export const DigestStepUpsertDtoControlValues$outboundSchema: z.ZodType<
   DigestStepUpsertDtoControlValues$Outbound,
   z.ZodTypeDef,
   DigestStepUpsertDtoControlValues
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  type: DigestStepUpsertDtoType$outboundSchema.optional(),
-  amount: z.number().optional(),
-  unit: DigestStepUpsertDtoUnit$outboundSchema.optional(),
-  lookBackWindow: LookBackWindowDto$outboundSchema.optional(),
-  cron: z.string().optional(),
-  digestKey: z.string().optional(),
-});
+> = z.union([DigestControlDto$outboundSchema, z.record(z.any())]);
 
 /**
  * @internal
@@ -230,9 +106,8 @@ export const DigestStepUpsertDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => DigestStepUpsertDtoControlValues$inboundSchema),
-  ).optional(),
+  controlValues: z.union([DigestControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -244,7 +119,7 @@ export type DigestStepUpsertDto$Outbound = {
   _id?: string | undefined;
   name: string;
   type: string;
-  controlValues?: DigestStepUpsertDtoControlValues$Outbound | null | undefined;
+  controlValues?: DigestControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -256,9 +131,8 @@ export const DigestStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => DigestStepUpsertDtoControlValues$outboundSchema),
-  ).optional(),
+  controlValues: z.union([DigestControlDto$outboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/emailcontroldto.ts

@@ -41,6 +41,10 @@ export type EmailControlDto = {
    * Disable sanitization of the output.
    */
   disableOutputSanitization?: boolean | undefined;
+  /**
+   * Layout ID to use for the email. Null means no layout, undefined means default layout.
+   */
+  layoutId?: string | null | undefined;
 };
 
 /** @internal */
@@ -73,6 +77,7 @@ export const EmailControlDto$inboundSchema: z.ZodType<
   body: z.string().default(""),
   editorType: EditorType$inboundSchema.default("block"),
   disableOutputSanitization: z.boolean().default(false),
+  layoutId: z.nullable(z.string()).optional(),
 });
 
 /** @internal */
@@ -82,6 +87,7 @@ export type EmailControlDto$Outbound = {
   body: string;
   editorType: string;
   disableOutputSanitization: boolean;
+  layoutId?: string | null | undefined;
 };
 
 /** @internal */
@@ -95,6 +101,7 @@ export const EmailControlDto$outboundSchema: z.ZodType<
   body: z.string().default(""),
   editorType: EditorType$outboundSchema.default("block"),
   disableOutputSanitization: z.boolean().default(false),
+  layoutId: z.nullable(z.string()).optional(),
 });
 
 /**

package/src/models/components/emailstepresponsedto.ts

@@ -17,6 +17,11 @@ import {
   EmailControlsMetadataResponseDto$Outbound,
   EmailControlsMetadataResponseDto$outboundSchema,
 } from "./emailcontrolsmetadataresponsedto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   StepIssuesDto,
   StepIssuesDto$inboundSchema,
@@ -28,11 +33,6 @@ import {
   StepTypeEnum$inboundSchema,
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 
 /**
  * Type of editor to use for the body.
@@ -72,6 +72,10 @@ export type EmailStepResponseDtoControlValues = {
    * Disable sanitization of the output.
    */
   disableOutputSanitization?: boolean | undefined;
+  /**
+   * Layout ID to use for the email. Null means no layout, undefined means default layout.
+   */
+  layoutId?: string | null | undefined;
   additionalProperties?: { [k: string]: any };
 };
 
@@ -116,7 +120,7 @@ export type EmailStepResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Workflow identifier
    */
@@ -164,6 +168,7 @@ export const EmailStepResponseDtoControlValues$inboundSchema: z.ZodType<
     body: z.string().default(""),
     editorType: EmailStepResponseDtoEditorType$inboundSchema.default("block"),
     disableOutputSanitization: z.boolean().default(false),
+    layoutId: z.nullable(z.string()).optional(),
   }).catchall(z.any()),
   "additionalProperties",
   true,
@@ -176,6 +181,7 @@ export type EmailStepResponseDtoControlValues$Outbound = {
   body: string;
   editorType: string;
   disableOutputSanitization: boolean;
+  layoutId?: string | null | undefined;
   [additionalProperties: string]: unknown;
 };
 
@@ -190,6 +196,7 @@ export const EmailStepResponseDtoControlValues$outboundSchema: z.ZodType<
   body: z.string().default(""),
   editorType: EmailStepResponseDtoEditorType$outboundSchema.default("block"),
   disableOutputSanitization: z.boolean().default(false),
+  layoutId: z.nullable(z.string()).optional(),
   additionalProperties: z.record(z.any()),
 }).transform((v) => {
   return {
@@ -297,7 +304,7 @@ export const EmailStepResponseDto$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => EmailStepResponseDtoSlug$inboundSchema),
   type: StepTypeEnum$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
@@ -338,7 +345,7 @@ export const EmailStepResponseDto$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => EmailStepResponseDtoSlug$outboundSchema),
   type: StepTypeEnum$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$outboundSchema.optional(),