@novu/api 1.4.0 → 1.6.0

package/src/models/components/stepsoverrides.ts

@@ -11,7 +11,11 @@ export type StepsOverrides = {
   /**
    * Passing the provider id and the provider specific configurations
    */
-  providers: { [k: string]: { [k: string]: any } };
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  /**
+   * Override the or remove the layout for this specific step
+   */
+  layoutId?: string | null | undefined;
 };
 
 /** @internal */
@@ -20,12 +24,14 @@ export const StepsOverrides$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  providers: z.record(z.record(z.any())),
+  providers: z.record(z.record(z.any())).optional(),
+  layoutId: z.nullable(z.string()).optional(),
 });
 
 /** @internal */
 export type StepsOverrides$Outbound = {
-  providers: { [k: string]: { [k: string]: any } };
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  layoutId?: string | null | undefined;
 };
 
 /** @internal */
@@ -34,7 +40,8 @@ export const StepsOverrides$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StepsOverrides
 > = z.object({
-  providers: z.record(z.record(z.any())),
+  providers: z.record(z.record(z.any())).optional(),
+  layoutId: z.nullable(z.string()).optional(),
 });
 
 /**

package/src/models/components/subscriberchanneldto.ts

@@ -28,6 +28,7 @@ export const ProviderId = {
   Getstream: "getstream",
   RocketChat: "rocket-chat",
   WhatsappBusiness: "whatsapp-business",
+  ChatWebhook: "chat-webhook",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/triggereventrequestdto.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 {
+  EmailChannelOverrides,
+  EmailChannelOverrides$inboundSchema,
+  EmailChannelOverrides$Outbound,
+  EmailChannelOverrides$outboundSchema,
+} from "./emailchanneloverrides.js";
 import {
   StepsOverrides,
   StepsOverrides$inboundSchema,
@@ -32,14 +38,28 @@ import {
   TopicPayloadDto$outboundSchema,
 } from "./topicpayloaddto.js";
 
+/**
+ * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+ */
+export type Channels = {
+  /**
+   * Email channel specific overrides
+   */
+  email?: EmailChannelOverrides | undefined;
+};
+
 /**
  * This could be used to override provider specific configurations
  */
 export type Overrides = {
   /**
-   * This could be used to override provider specific configurations
+   * This could be used to override provider specific configurations or layout at the step level
    */
   steps?: { [k: string]: StepsOverrides } | undefined;
+  /**
+   * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+   */
+  channels?: Channels | undefined;
   /**
    * Overrides the provider configuration for the entire workflow and all steps
    */
@@ -129,7 +149,10 @@ export type TriggerEventRequestDto = {
     | Array<TopicPayloadDto | SubscriberPayloadDto | string>
     | string;
   /**
-   * A unique identifier for this transaction, we will generate a UUID if not provided.
+   * A unique identifier for deduplication. If the same **transactionId** is sent again,
+   *
+   * @remarks
+   *       the trigger is ignored. Useful to prevent duplicate notifications. The retention period depends on your billing tier.
    */
   transactionId?: string | undefined;
   /**
@@ -148,6 +171,56 @@ export type TriggerEventRequestDto = {
   tenant?: TenantPayloadDto | string | undefined;
 };
 
+/** @internal */
+export const Channels$inboundSchema: z.ZodType<
+  Channels,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: EmailChannelOverrides$inboundSchema.optional(),
+});
+
+/** @internal */
+export type Channels$Outbound = {
+  email?: EmailChannelOverrides$Outbound | undefined;
+};
+
+/** @internal */
+export const Channels$outboundSchema: z.ZodType<
+  Channels$Outbound,
+  z.ZodTypeDef,
+  Channels
+> = z.object({
+  email: EmailChannelOverrides$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Channels$ {
+  /** @deprecated use `Channels$inboundSchema` instead. */
+  export const inboundSchema = Channels$inboundSchema;
+  /** @deprecated use `Channels$outboundSchema` instead. */
+  export const outboundSchema = Channels$outboundSchema;
+  /** @deprecated use `Channels$Outbound` instead. */
+  export type Outbound = Channels$Outbound;
+}
+
+export function channelsToJSON(channels: Channels): string {
+  return JSON.stringify(Channels$outboundSchema.parse(channels));
+}
+
+export function channelsFromJSON(
+  jsonString: string,
+): SafeParseResult<Channels, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Channels$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Channels' from JSON`,
+  );
+}
+
 /** @internal */
 export const Overrides$inboundSchema: z.ZodType<
   Overrides,
@@ -155,6 +228,7 @@ export const Overrides$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   steps: z.record(StepsOverrides$inboundSchema).optional(),
+  channels: z.lazy(() => Channels$inboundSchema).optional(),
   providers: z.record(z.record(z.any())).optional(),
   email: z.record(z.any()).optional(),
   push: z.record(z.any()).optional(),
@@ -166,6 +240,7 @@ export const Overrides$inboundSchema: z.ZodType<
 /** @internal */
 export type Overrides$Outbound = {
   steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
+  channels?: Channels$Outbound | undefined;
   providers?: { [k: string]: { [k: string]: any } } | undefined;
   email?: { [k: string]: any } | undefined;
   push?: { [k: string]: any } | undefined;
@@ -181,6 +256,7 @@ export const Overrides$outboundSchema: z.ZodType<
   Overrides
 > = z.object({
   steps: z.record(StepsOverrides$outboundSchema).optional(),
+  channels: z.lazy(() => Channels$outboundSchema).optional(),
   providers: z.record(z.record(z.any())).optional(),
   email: z.record(z.any()).optional(),
   push: z.record(z.any()).optional(),

package/src/models/components/triggereventtoallrequestdto.ts

@@ -10,6 +10,12 @@ import {
 } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EmailChannelOverrides,
+  EmailChannelOverrides$inboundSchema,
+  EmailChannelOverrides$Outbound,
+  EmailChannelOverrides$outboundSchema,
+} from "./emailchanneloverrides.js";
 import {
   StepsOverrides,
   StepsOverrides$inboundSchema,
@@ -29,14 +35,28 @@ import {
   TenantPayloadDto$outboundSchema,
 } from "./tenantpayloaddto.js";
 
+/**
+ * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+ */
+export type TriggerEventToAllRequestDtoChannels = {
+  /**
+   * Email channel specific overrides
+   */
+  email?: EmailChannelOverrides | undefined;
+};
+
 /**
  * This could be used to override provider specific configurations
  */
 export type TriggerEventToAllRequestDtoOverrides = {
   /**
-   * This could be used to override provider specific configurations
+   * This could be used to override provider specific configurations or layout at the step level
    */
   steps?: { [k: string]: StepsOverrides } | undefined;
+  /**
+   * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+   */
+  channels?: TriggerEventToAllRequestDtoChannels | undefined;
   /**
    * Overrides the provider configuration for the entire workflow and all steps
    */
@@ -127,6 +147,65 @@ export type TriggerEventToAllRequestDto = {
   tenant?: TenantPayloadDto | string | undefined;
 };
 
+/** @internal */
+export const TriggerEventToAllRequestDtoChannels$inboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoChannels,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: EmailChannelOverrides$inboundSchema.optional(),
+});
+
+/** @internal */
+export type TriggerEventToAllRequestDtoChannels$Outbound = {
+  email?: EmailChannelOverrides$Outbound | undefined;
+};
+
+/** @internal */
+export const TriggerEventToAllRequestDtoChannels$outboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoChannels$Outbound,
+  z.ZodTypeDef,
+  TriggerEventToAllRequestDtoChannels
+> = z.object({
+  email: EmailChannelOverrides$outboundSchema.optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace TriggerEventToAllRequestDtoChannels$ {
+  /** @deprecated use `TriggerEventToAllRequestDtoChannels$inboundSchema` instead. */
+  export const inboundSchema =
+    TriggerEventToAllRequestDtoChannels$inboundSchema;
+  /** @deprecated use `TriggerEventToAllRequestDtoChannels$outboundSchema` instead. */
+  export const outboundSchema =
+    TriggerEventToAllRequestDtoChannels$outboundSchema;
+  /** @deprecated use `TriggerEventToAllRequestDtoChannels$Outbound` instead. */
+  export type Outbound = TriggerEventToAllRequestDtoChannels$Outbound;
+}
+
+export function triggerEventToAllRequestDtoChannelsToJSON(
+  triggerEventToAllRequestDtoChannels: TriggerEventToAllRequestDtoChannels,
+): string {
+  return JSON.stringify(
+    TriggerEventToAllRequestDtoChannels$outboundSchema.parse(
+      triggerEventToAllRequestDtoChannels,
+    ),
+  );
+}
+
+export function triggerEventToAllRequestDtoChannelsFromJSON(
+  jsonString: string,
+): SafeParseResult<TriggerEventToAllRequestDtoChannels, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TriggerEventToAllRequestDtoChannels$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TriggerEventToAllRequestDtoChannels' from JSON`,
+  );
+}
+
 /** @internal */
 export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
   TriggerEventToAllRequestDtoOverrides,
@@ -135,6 +214,8 @@ export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
 > = collectExtraKeys$(
   z.object({
     steps: z.record(StepsOverrides$inboundSchema).optional(),
+    channels: z.lazy(() => TriggerEventToAllRequestDtoChannels$inboundSchema)
+      .optional(),
     providers: z.record(z.record(z.any())).optional(),
     email: z.record(z.any()).optional(),
     push: z.record(z.any()).optional(),
@@ -149,6 +230,7 @@ export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
 /** @internal */
 export type TriggerEventToAllRequestDtoOverrides$Outbound = {
   steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
+  channels?: TriggerEventToAllRequestDtoChannels$Outbound | undefined;
   providers?: { [k: string]: { [k: string]: any } } | undefined;
   email?: { [k: string]: any } | undefined;
   push?: { [k: string]: any } | undefined;
@@ -165,6 +247,8 @@ export const TriggerEventToAllRequestDtoOverrides$outboundSchema: z.ZodType<
   TriggerEventToAllRequestDtoOverrides
 > = z.object({
   steps: z.record(StepsOverrides$outboundSchema).optional(),
+  channels: z.lazy(() => TriggerEventToAllRequestDtoChannels$outboundSchema)
+    .optional(),
   providers: z.record(z.record(z.any())).optional(),
   email: z.record(z.any()).optional(),
   push: z.record(z.any()).optional(),

package/src/models/components/uicomponentenum.ts

@@ -10,6 +10,7 @@ import { ClosedEnum } from "../../types/enums.js";
  */
 export const UiComponentEnum = {
   EmailEditorSelect: "EMAIL_EDITOR_SELECT",
+  LayoutSelect: "LAYOUT_SELECT",
   BlockEditor: "BLOCK_EDITOR",
   EmailBody: "EMAIL_BODY",
   TextFullLine: "TEXT_FULL_LINE",
@@ -34,6 +35,7 @@ export const UiComponentEnum = {
   PushSubject: "PUSH_SUBJECT",
   QueryEditor: "QUERY_EDITOR",
   Data: "DATA",
+  LayoutEmail: "LAYOUT_EMAIL",
 } as const;
 /**
  * Component type for the UI Schema Property

package/src/models/components/uischemagroupenum.ts

@@ -17,6 +17,7 @@ export const UiSchemaGroupEnum = {
   Chat: "CHAT",
   Push: "PUSH",
   Skip: "SKIP",
+  Layout: "LAYOUT",
 } as const;
 /**
  * Group of the UI Schema

package/src/models/components/uischemaproperty.ts

@@ -40,6 +40,10 @@ export type UiSchemaProperty = {
    * Component type for the UI Schema Property
    */
   component: UiComponentEnum;
+  /**
+   * Properties of the UI Schema
+   */
+  properties?: { [k: string]: UiSchemaProperty } | undefined;
 };
 
 /** @internal */
@@ -164,6 +168,7 @@ export const UiSchemaProperty$inboundSchema: z.ZodType<
     ]),
   ).optional(),
   component: UiComponentEnum$inboundSchema,
+  properties: z.record(z.lazy(() => UiSchemaProperty$inboundSchema)).optional(),
 });
 
 /** @internal */
@@ -177,6 +182,7 @@ export type UiSchemaProperty$Outbound = {
     | null
     | undefined;
   component: string;
+  properties?: { [k: string]: UiSchemaProperty$Outbound } | undefined;
 };
 
 /** @internal */
@@ -197,6 +203,8 @@ export const UiSchemaProperty$outboundSchema: z.ZodType<
     ]),
   ).optional(),
   component: UiComponentEnum$outboundSchema,
+  properties: z.record(z.lazy(() => UiSchemaProperty$outboundSchema))
+    .optional(),
 });
 
 /**

package/src/models/components/updateworkflowdto.ts

@@ -54,17 +54,17 @@ import {
   PushStepUpsertDto$Outbound,
   PushStepUpsertDto$outboundSchema,
 } from "./pushstepupsertdto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   SmsStepUpsertDto,
   SmsStepUpsertDto$inboundSchema,
   SmsStepUpsertDto$Outbound,
   SmsStepUpsertDto$outboundSchema,
 } from "./smsstepupsertdto.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 
 export type UpdateWorkflowDtoSteps =
   | (InAppStepUpsertDto & { type: "in_app" })
@@ -93,6 +93,18 @@ export type UpdateWorkflowDto = {
    * 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;
   /**
    * Workflow ID (allowed only for code-first workflows)
    */
@@ -117,15 +129,7 @@ export type UpdateWorkflowDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
-  /**
-   * The payload JSON Schema for the workflow
-   */
-  payloadSchema?: { [k: string]: any } | undefined;
-  /**
-   * Enable or disable payload schema validation
-   */
-  validatePayload?: boolean | undefined;
+  origin: ResourceOriginEnum;
 };
 
 /** @internal */
@@ -256,6 +260,9 @@ export const UpdateWorkflowDto$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().optional(),
   steps: z.array(
     z.union([
@@ -302,9 +309,7 @@ export const UpdateWorkflowDto$inboundSchema: z.ZodType<
     ]),
   ),
   preferences: PreferencesRequestDto$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
-  payloadSchema: z.record(z.any()).optional(),
-  validatePayload: z.boolean().optional(),
+  origin: ResourceOriginEnum$inboundSchema,
 });
 
 /** @internal */
@@ -313,6 +318,9 @@ export type UpdateWorkflowDto$Outbound = {
   description?: string | undefined;
   tags?: Array<string> | undefined;
   active: boolean;
+  validatePayload?: boolean | undefined;
+  payloadSchema?: { [k: string]: any } | null | undefined;
+  isTranslationEnabled: boolean;
   workflowId?: string | undefined;
   steps: Array<
     | (InAppStepUpsertDto$Outbound & { type: "in_app" })
@@ -326,8 +334,6 @@ export type UpdateWorkflowDto$Outbound = {
   >;
   preferences: PreferencesRequestDto$Outbound;
   origin: string;
-  payloadSchema?: { [k: string]: any } | undefined;
-  validatePayload?: boolean | undefined;
 };
 
 /** @internal */
@@ -340,6 +346,9 @@ export const UpdateWorkflowDto$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().optional(),
   steps: z.array(
     z.union([
@@ -386,9 +395,7 @@ export const UpdateWorkflowDto$outboundSchema: z.ZodType<
     ]),
   ),
   preferences: PreferencesRequestDto$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
-  payloadSchema: z.record(z.any()).optional(),
-  validatePayload: z.boolean().optional(),
+  origin: ResourceOriginEnum$outboundSchema,
 });
 
 /**