@novu/api 1.4.0 → 1.6.0

package/src/models/components/chatstepupsertdto.ts

@@ -7,6 +7,12 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  ChatControlDto,
+  ChatControlDto$inboundSchema,
+  ChatControlDto$Outbound,
+  ChatControlDto$outboundSchema,
+} from "./chatcontroldto.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -14,17 +20,10 @@ import {
 } from "./steptypeenum.js";
 
 /**
- * Control values for the Chat step
+ * Control values for the Chat step.
  */
-export type ChatStepUpsertDtoControlValues = {
-  /**
-   * 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;
-  /**
-   * Content of the chat message.
-   */
-  body?: string | undefined;
+export type ChatStepUpsertDtoControlValues = ChatControlDto | {
+  [k: string]: any;
 };
 
 export type ChatStepUpsertDto = {
@@ -41,9 +40,9 @@ export type ChatStepUpsertDto = {
    */
   type: StepTypeEnum;
   /**
-   * Control values for the Chat step
+   * Control values for the Chat step.
    */
-  controlValues?: ChatStepUpsertDtoControlValues | null | undefined;
+  controlValues?: ChatControlDto | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -51,26 +50,19 @@ export const ChatStepUpsertDtoControlValues$inboundSchema: z.ZodType<
   ChatStepUpsertDtoControlValues,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  body: z.string().optional(),
-});
+> = z.union([ChatControlDto$inboundSchema, z.record(z.any())]);
 
 /** @internal */
-export type ChatStepUpsertDtoControlValues$Outbound = {
-  skip?: { [k: string]: any } | undefined;
-  body?: string | undefined;
-};
+export type ChatStepUpsertDtoControlValues$Outbound =
+  | ChatControlDto$Outbound
+  | { [k: string]: any };
 
 /** @internal */
 export const ChatStepUpsertDtoControlValues$outboundSchema: z.ZodType<
   ChatStepUpsertDtoControlValues$Outbound,
   z.ZodTypeDef,
   ChatStepUpsertDtoControlValues
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  body: z.string().optional(),
-});
+> = z.union([ChatControlDto$outboundSchema, z.record(z.any())]);
 
 /**
  * @internal
@@ -114,9 +106,8 @@ export const ChatStepUpsertDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => ChatStepUpsertDtoControlValues$inboundSchema),
-  ).optional(),
+  controlValues: z.union([ChatControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -128,7 +119,7 @@ export type ChatStepUpsertDto$Outbound = {
   _id?: string | undefined;
   name: string;
   type: string;
-  controlValues?: ChatStepUpsertDtoControlValues$Outbound | null | undefined;
+  controlValues?: ChatControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -140,9 +131,8 @@ export const ChatStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => ChatStepUpsertDtoControlValues$outboundSchema),
-  ).optional(),
+  controlValues: z.union([ChatControlDto$outboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/contentissueenum.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of step content issue
+ */
+export const ContentIssueEnum = {
+  IllegalVariableInControlValue: "ILLEGAL_VARIABLE_IN_CONTROL_VALUE",
+  InvalidFilterArgInVariable: "INVALID_FILTER_ARG_IN_VARIABLE",
+  MissingValue: "MISSING_VALUE",
+  TierLimitExceeded: "TIER_LIMIT_EXCEEDED",
+} as const;
+/**
+ * Type of step content issue
+ */
+export type ContentIssueEnum = ClosedEnum<typeof ContentIssueEnum>;
+
+/** @internal */
+export const ContentIssueEnum$inboundSchema: z.ZodNativeEnum<
+  typeof ContentIssueEnum
+> = z.nativeEnum(ContentIssueEnum);
+
+/** @internal */
+export const ContentIssueEnum$outboundSchema: z.ZodNativeEnum<
+  typeof ContentIssueEnum
+> = ContentIssueEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ContentIssueEnum$ {
+  /** @deprecated use `ContentIssueEnum$inboundSchema` instead. */
+  export const inboundSchema = ContentIssueEnum$inboundSchema;
+  /** @deprecated use `ContentIssueEnum$outboundSchema` instead. */
+  export const outboundSchema = ContentIssueEnum$outboundSchema;
+}

package/src/models/components/createworkflowdto.ts

@@ -94,6 +94,18 @@ export type CreateWorkflowDto = {
    * Whether the workflow is active
    */
   active?: boolean | undefined;
+  /**
+   * Enable or disable payload schema validation
+   */
+  validatePayload?: boolean | undefined;
+  /**
+   * The payload JSON Schema for the workflow
+   */
+  payloadSchema?: { [k: string]: any } | null | undefined;
+  /**
+   * Enable or disable translations for this workflow
+   */
+  isTranslationEnabled?: boolean | undefined;
   /**
    * Unique identifier for the workflow
    */
@@ -119,14 +131,6 @@ export type CreateWorkflowDto = {
    * Workflow preferences
    */
   preferences?: PreferencesRequestDto | undefined;
-  /**
-   * The payload JSON Schema for the workflow
-   */
-  payloadSchema?: { [k: string]: any } | undefined;
-  /**
-   * Enable or disable payload schema validation
-   */
-  validatePayload?: boolean | undefined;
 };
 
 /** @internal */
@@ -258,6 +262,9 @@ export const CreateWorkflowDto$inboundSchema: z.ZodType<
   description: z.string().optional(),
   tags: z.array(z.string()).optional(),
   active: z.boolean().default(false),
+  validatePayload: z.boolean().optional(),
+  payloadSchema: z.nullable(z.record(z.any())).optional(),
+  isTranslationEnabled: z.boolean().default(false),
   workflowId: z.string(),
   steps: z.array(
     z.union([
@@ -305,8 +312,6 @@ export const CreateWorkflowDto$inboundSchema: z.ZodType<
   ),
   __source: WorkflowCreationSourceEnum$inboundSchema.default("editor"),
   preferences: PreferencesRequestDto$inboundSchema.optional(),
-  payloadSchema: z.record(z.any()).optional(),
-  validatePayload: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     "__source": "source",
@@ -319,6 +324,9 @@ export type CreateWorkflowDto$Outbound = {
   description?: string | undefined;
   tags?: Array<string> | undefined;
   active: boolean;
+  validatePayload?: boolean | undefined;
+  payloadSchema?: { [k: string]: any } | null | undefined;
+  isTranslationEnabled: boolean;
   workflowId: string;
   steps: Array<
     | (InAppStepUpsertDto$Outbound & { type: "in_app" })
@@ -332,8 +340,6 @@ export type CreateWorkflowDto$Outbound = {
   >;
   __source: string;
   preferences?: PreferencesRequestDto$Outbound | undefined;
-  payloadSchema?: { [k: string]: any } | undefined;
-  validatePayload?: boolean | undefined;
 };
 
 /** @internal */
@@ -346,6 +352,9 @@ export const CreateWorkflowDto$outboundSchema: z.ZodType<
   description: z.string().optional(),
   tags: z.array(z.string()).optional(),
   active: z.boolean().default(false),
+  validatePayload: z.boolean().optional(),
+  payloadSchema: z.nullable(z.record(z.any())).optional(),
+  isTranslationEnabled: z.boolean().default(false),
   workflowId: z.string(),
   steps: z.array(
     z.union([
@@ -393,8 +402,6 @@ export const CreateWorkflowDto$outboundSchema: z.ZodType<
   ),
   source: WorkflowCreationSourceEnum$outboundSchema.default("editor"),
   preferences: PreferencesRequestDto$outboundSchema.optional(),
-  payloadSchema: z.record(z.any()).optional(),
-  validatePayload: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     source: "__source",

package/src/models/components/customstepresponsedto.ts

@@ -16,6 +16,11 @@ import {
   CustomControlsMetadataResponseDto$Outbound,
   CustomControlsMetadataResponseDto$outboundSchema,
 } from "./customcontrolsmetadataresponsedto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   StepIssuesDto,
   StepIssuesDto$inboundSchema,
@@ -27,11 +32,6 @@ import {
   StepTypeEnum$inboundSchema,
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 
 /**
  * Control values for the custom step
@@ -85,7 +85,7 @@ export type CustomStepResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Workflow identifier
    */
@@ -234,7 +234,7 @@ export const CustomStepResponseDto$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => CustomStepResponseDtoSlug$inboundSchema),
   type: StepTypeEnum$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
@@ -275,7 +275,7 @@ export const CustomStepResponseDto$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => CustomStepResponseDtoSlug$outboundSchema),
   type: StepTypeEnum$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$outboundSchema.optional(),

package/src/models/components/customstepupsertdto.ts

@@ -7,6 +7,12 @@ import { remap as remap$ } from "../../lib/primitives.js";
 import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  CustomControlDto,
+  CustomControlDto$inboundSchema,
+  CustomControlDto$Outbound,
+  CustomControlDto$outboundSchema,
+} from "./customcontroldto.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -14,13 +20,10 @@ import {
 } from "./steptypeenum.js";
 
 /**
- * Control values for the Custom step
+ * Control values for the Custom step.
  */
-export type CustomStepUpsertDtoControlValues = {
-  /**
-   * Custom control values for the step.
-   */
-  custom?: { [k: string]: any } | undefined;
+export type CustomStepUpsertDtoControlValues = CustomControlDto | {
+  [k: string]: any;
 };
 
 export type CustomStepUpsertDto = {
@@ -37,9 +40,9 @@ export type CustomStepUpsertDto = {
    */
   type: StepTypeEnum;
   /**
-   * Control values for the Custom step
+   * Control values for the Custom step.
    */
-  controlValues?: CustomStepUpsertDtoControlValues | null | undefined;
+  controlValues?: CustomControlDto | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -47,23 +50,19 @@ export const CustomStepUpsertDtoControlValues$inboundSchema: z.ZodType<
   CustomStepUpsertDtoControlValues,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  custom: z.record(z.any()).optional(),
-});
+> = z.union([CustomControlDto$inboundSchema, z.record(z.any())]);
 
 /** @internal */
-export type CustomStepUpsertDtoControlValues$Outbound = {
-  custom?: { [k: string]: any } | undefined;
-};
+export type CustomStepUpsertDtoControlValues$Outbound =
+  | CustomControlDto$Outbound
+  | { [k: string]: any };
 
 /** @internal */
 export const CustomStepUpsertDtoControlValues$outboundSchema: z.ZodType<
   CustomStepUpsertDtoControlValues$Outbound,
   z.ZodTypeDef,
   CustomStepUpsertDtoControlValues
-> = z.object({
-  custom: z.record(z.any()).optional(),
-});
+> = z.union([CustomControlDto$outboundSchema, z.record(z.any())]);
 
 /**
  * @internal
@@ -107,9 +106,8 @@ export const CustomStepUpsertDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => CustomStepUpsertDtoControlValues$inboundSchema),
-  ).optional(),
+  controlValues: z.union([CustomControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -121,7 +119,7 @@ export type CustomStepUpsertDto$Outbound = {
   _id?: string | undefined;
   name: string;
   type: string;
-  controlValues?: CustomStepUpsertDtoControlValues$Outbound | null | undefined;
+  controlValues?: CustomControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -133,9 +131,8 @@ export const CustomStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => CustomStepUpsertDtoControlValues$outboundSchema),
-  ).optional(),
+  controlValues: z.union([CustomControlDto$outboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/delaycontroldto.ts

@@ -22,7 +22,7 @@ export type Type = ClosedEnum<typeof Type>;
 /**
  * Unit of time for the delay amount.
  */
-export const DelayControlDtoUnit = {
+export const Unit = {
   Seconds: "seconds",
   Minutes: "minutes",
   Hours: "hours",
@@ -33,7 +33,7 @@ export const DelayControlDtoUnit = {
 /**
  * Unit of time for the delay amount.
  */
-export type DelayControlDtoUnit = ClosedEnum<typeof DelayControlDtoUnit>;
+export type Unit = ClosedEnum<typeof Unit>;
 
 export type DelayControlDto = {
   /**
@@ -51,7 +51,7 @@ export type DelayControlDto = {
   /**
    * Unit of time for the delay amount.
    */
-  unit: DelayControlDtoUnit;
+  unit: Unit;
 };
 
 /** @internal */
@@ -75,24 +75,23 @@ export namespace Type$ {
 }
 
 /** @internal */
-export const DelayControlDtoUnit$inboundSchema: z.ZodNativeEnum<
-  typeof DelayControlDtoUnit
-> = z.nativeEnum(DelayControlDtoUnit);
+export const Unit$inboundSchema: z.ZodNativeEnum<typeof Unit> = z.nativeEnum(
+  Unit,
+);
 
 /** @internal */
-export const DelayControlDtoUnit$outboundSchema: z.ZodNativeEnum<
-  typeof DelayControlDtoUnit
-> = DelayControlDtoUnit$inboundSchema;
+export const Unit$outboundSchema: z.ZodNativeEnum<typeof Unit> =
+  Unit$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace DelayControlDtoUnit$ {
-  /** @deprecated use `DelayControlDtoUnit$inboundSchema` instead. */
-  export const inboundSchema = DelayControlDtoUnit$inboundSchema;
-  /** @deprecated use `DelayControlDtoUnit$outboundSchema` instead. */
-  export const outboundSchema = DelayControlDtoUnit$outboundSchema;
+export namespace Unit$ {
+  /** @deprecated use `Unit$inboundSchema` instead. */
+  export const inboundSchema = Unit$inboundSchema;
+  /** @deprecated use `Unit$outboundSchema` instead. */
+  export const outboundSchema = Unit$outboundSchema;
 }
 
 /** @internal */
@@ -104,7 +103,7 @@ export const DelayControlDto$inboundSchema: z.ZodType<
   skip: z.record(z.any()).optional(),
   type: Type$inboundSchema.default("regular"),
   amount: z.number(),
-  unit: DelayControlDtoUnit$inboundSchema,
+  unit: Unit$inboundSchema,
 });
 
 /** @internal */
@@ -124,7 +123,7 @@ export const DelayControlDto$outboundSchema: z.ZodType<
   skip: z.record(z.any()).optional(),
   type: Type$outboundSchema.default("regular"),
   amount: z.number(),
-  unit: DelayControlDtoUnit$outboundSchema,
+  unit: Unit$outboundSchema,
 });
 
 /**

package/src/models/components/delaystepresponsedto.ts

@@ -17,6 +17,11 @@ import {
   DelayControlsMetadataResponseDto$Outbound,
   DelayControlsMetadataResponseDto$outboundSchema,
 } from "./delaycontrolsmetadataresponsedto.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 the delay. Currently only 'regular' is supported by the schema.
@@ -129,7 +129,7 @@ export type DelayStepResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Workflow identifier
    */
@@ -328,7 +328,7 @@ export const DelayStepResponseDto$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => DelayStepResponseDtoSlug$inboundSchema),
   type: StepTypeEnum$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
@@ -369,7 +369,7 @@ export const DelayStepResponseDto$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => DelayStepResponseDtoSlug$outboundSchema),
   type: StepTypeEnum$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$outboundSchema.optional(),