@novu/api 1.4.0 → 1.5.0

package/src/models/components/stepintegrationissue.ts

@@ -7,16 +7,16 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  StepIntegrationIssueEnum,
-  StepIntegrationIssueEnum$inboundSchema,
-  StepIntegrationIssueEnum$outboundSchema,
-} from "./stepintegrationissueenum.js";
+  IntegrationIssueEnum,
+  IntegrationIssueEnum$inboundSchema,
+  IntegrationIssueEnum$outboundSchema,
+} from "./integrationissueenum.js";
 
 export type StepIntegrationIssue = {
   /**
    * Type of integration issue
    */
-  issueType: StepIntegrationIssueEnum;
+  issueType: IntegrationIssueEnum;
   /**
    * Name of the variable related to the issue
    */
@@ -33,7 +33,7 @@ export const StepIntegrationIssue$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  issueType: StepIntegrationIssueEnum$inboundSchema,
+  issueType: IntegrationIssueEnum$inboundSchema,
   variableName: z.string().optional(),
   message: z.string(),
 });
@@ -51,7 +51,7 @@ export const StepIntegrationIssue$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StepIntegrationIssue
 > = z.object({
-  issueType: StepIntegrationIssueEnum$outboundSchema,
+  issueType: IntegrationIssueEnum$outboundSchema,
   variableName: z.string().optional(),
   message: z.string(),
 });

package/src/models/components/stepresponsedto.ts

@@ -13,6 +13,11 @@ import {
   ControlsMetadataDto$Outbound,
   ControlsMetadataDto$outboundSchema,
 } from "./controlsmetadatadto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   StepIssuesDto,
   StepIssuesDto$inboundSchema,
@@ -24,11 +29,6 @@ import {
   StepTypeEnum$inboundSchema,
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 
 /**
  * Slug of the step
@@ -71,7 +71,7 @@ export type StepResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Workflow identifier
    */
@@ -148,7 +148,7 @@ export const StepResponseDto$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => StepResponseDtoSlug$inboundSchema),
   type: StepTypeEnum$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
@@ -188,7 +188,7 @@ export const StepResponseDto$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => StepResponseDtoSlug$outboundSchema),
   type: StepTypeEnum$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$outboundSchema.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/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,
 });
 
 /**

package/src/models/components/workflowlistresponsedto.ts

@@ -7,22 +7,49 @@ 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 {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 import {
   WorkflowStatusEnum,
   WorkflowStatusEnum$inboundSchema,
   WorkflowStatusEnum$outboundSchema,
 } from "./workflowstatusenum.js";
 
+/**
+ * User last name
+ */
+export type WorkflowListResponseDtoLastName = {};
+
+/**
+ * User who last updated the workflow
+ */
+export type WorkflowListResponseDtoUpdatedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName?: string | null | undefined;
+  /**
+   * User last name
+   */
+  lastName?: WorkflowListResponseDtoLastName | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | null | undefined;
+};
+
 export type WorkflowListResponseDto = {
   /**
    * Name of the workflow
@@ -40,6 +67,10 @@ export type WorkflowListResponseDto = {
    * Creation timestamp
    */
   createdAt: string;
+  /**
+   * User who last updated the workflow
+   */
+  updatedBy?: WorkflowListResponseDtoUpdatedBy | null | undefined;
   /**
    * Unique database identifier
    */
@@ -59,7 +90,7 @@ export type WorkflowListResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Timestamp of the last workflow trigger
    */
@@ -68,8 +99,139 @@ export type WorkflowListResponseDto = {
    * Overview of step types in the workflow
    */
   stepTypeOverviews: Array<StepTypeEnum>;
+  /**
+   * Is translation enabled for the workflow
+   */
+  isTranslationEnabled: boolean;
+};
+
+/** @internal */
+export const WorkflowListResponseDtoLastName$inboundSchema: z.ZodType<
+  WorkflowListResponseDtoLastName,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type WorkflowListResponseDtoLastName$Outbound = {};
+
+/** @internal */
+export const WorkflowListResponseDtoLastName$outboundSchema: z.ZodType<
+  WorkflowListResponseDtoLastName$Outbound,
+  z.ZodTypeDef,
+  WorkflowListResponseDtoLastName
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WorkflowListResponseDtoLastName$ {
+  /** @deprecated use `WorkflowListResponseDtoLastName$inboundSchema` instead. */
+  export const inboundSchema = WorkflowListResponseDtoLastName$inboundSchema;
+  /** @deprecated use `WorkflowListResponseDtoLastName$outboundSchema` instead. */
+  export const outboundSchema = WorkflowListResponseDtoLastName$outboundSchema;
+  /** @deprecated use `WorkflowListResponseDtoLastName$Outbound` instead. */
+  export type Outbound = WorkflowListResponseDtoLastName$Outbound;
+}
+
+export function workflowListResponseDtoLastNameToJSON(
+  workflowListResponseDtoLastName: WorkflowListResponseDtoLastName,
+): string {
+  return JSON.stringify(
+    WorkflowListResponseDtoLastName$outboundSchema.parse(
+      workflowListResponseDtoLastName,
+    ),
+  );
+}
+
+export function workflowListResponseDtoLastNameFromJSON(
+  jsonString: string,
+): SafeParseResult<WorkflowListResponseDtoLastName, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WorkflowListResponseDtoLastName$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WorkflowListResponseDtoLastName' from JSON`,
+  );
+}
+
+/** @internal */
+export const WorkflowListResponseDtoUpdatedBy$inboundSchema: z.ZodType<
+  WorkflowListResponseDtoUpdatedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(
+    z.lazy(() => WorkflowListResponseDtoLastName$inboundSchema),
+  ).optional(),
+  externalId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type WorkflowListResponseDtoUpdatedBy$Outbound = {
+  _id: string;
+  firstName?: string | null | undefined;
+  lastName?: WorkflowListResponseDtoLastName$Outbound | null | undefined;
+  externalId?: string | null | undefined;
 };
 
+/** @internal */
+export const WorkflowListResponseDtoUpdatedBy$outboundSchema: z.ZodType<
+  WorkflowListResponseDtoUpdatedBy$Outbound,
+  z.ZodTypeDef,
+  WorkflowListResponseDtoUpdatedBy
+> = z.object({
+  id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(
+    z.lazy(() => WorkflowListResponseDtoLastName$outboundSchema),
+  ).optional(),
+  externalId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace WorkflowListResponseDtoUpdatedBy$ {
+  /** @deprecated use `WorkflowListResponseDtoUpdatedBy$inboundSchema` instead. */
+  export const inboundSchema = WorkflowListResponseDtoUpdatedBy$inboundSchema;
+  /** @deprecated use `WorkflowListResponseDtoUpdatedBy$outboundSchema` instead. */
+  export const outboundSchema = WorkflowListResponseDtoUpdatedBy$outboundSchema;
+  /** @deprecated use `WorkflowListResponseDtoUpdatedBy$Outbound` instead. */
+  export type Outbound = WorkflowListResponseDtoUpdatedBy$Outbound;
+}
+
+export function workflowListResponseDtoUpdatedByToJSON(
+  workflowListResponseDtoUpdatedBy: WorkflowListResponseDtoUpdatedBy,
+): string {
+  return JSON.stringify(
+    WorkflowListResponseDtoUpdatedBy$outboundSchema.parse(
+      workflowListResponseDtoUpdatedBy,
+    ),
+  );
+}
+
+export function workflowListResponseDtoUpdatedByFromJSON(
+  jsonString: string,
+): SafeParseResult<WorkflowListResponseDtoUpdatedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WorkflowListResponseDtoUpdatedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WorkflowListResponseDtoUpdatedBy' from JSON`,
+  );
+}
+
 /** @internal */
 export const WorkflowListResponseDto$inboundSchema: z.ZodType<
   WorkflowListResponseDto,
@@ -80,13 +242,17 @@ export const WorkflowListResponseDto$inboundSchema: z.ZodType<
   tags: z.array(z.string()).optional(),
   updatedAt: z.string(),
   createdAt: z.string(),
+  updatedBy: z.nullable(
+    z.lazy(() => WorkflowListResponseDtoUpdatedBy$inboundSchema),
+  ).optional(),
   _id: z.string(),
   workflowId: z.string(),
   slug: z.string(),
   status: WorkflowStatusEnum$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   lastTriggeredAt: z.nullable(z.string()).optional(),
   stepTypeOverviews: z.array(StepTypeEnum$inboundSchema),
+  isTranslationEnabled: z.boolean(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -99,6 +265,7 @@ export type WorkflowListResponseDto$Outbound = {
   tags?: Array<string> | undefined;
   updatedAt: string;
   createdAt: string;
+  updatedBy?: WorkflowListResponseDtoUpdatedBy$Outbound | null | undefined;
   _id: string;
   workflowId: string;
   slug: string;
@@ -106,6 +273,7 @@ export type WorkflowListResponseDto$Outbound = {
   origin: string;
   lastTriggeredAt?: string | null | undefined;
   stepTypeOverviews: Array<string>;
+  isTranslationEnabled: boolean;
 };
 
 /** @internal */
@@ -118,13 +286,17 @@ export const WorkflowListResponseDto$outboundSchema: z.ZodType<
   tags: z.array(z.string()).optional(),
   updatedAt: z.string(),
   createdAt: z.string(),
+  updatedBy: z.nullable(
+    z.lazy(() => WorkflowListResponseDtoUpdatedBy$outboundSchema),
+  ).optional(),
   id: z.string(),
   workflowId: z.string(),
   slug: z.string(),
   status: WorkflowStatusEnum$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   lastTriggeredAt: z.nullable(z.string()).optional(),
   stepTypeOverviews: z.array(StepTypeEnum$outboundSchema),
+  isTranslationEnabled: z.boolean(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",