@novu/api 1.4.0 → 1.6.0

package/src/models/components/workflowresponsedto.ts

@@ -49,6 +49,11 @@ import {
   PushStepResponseDto$Outbound,
   PushStepResponseDto$outboundSchema,
 } from "./pushstepresponsedto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   RuntimeIssueDto,
   RuntimeIssueDto$inboundSchema,
@@ -61,11 +66,6 @@ import {
   SmsStepResponseDto$Outbound,
   SmsStepResponseDto$outboundSchema,
 } from "./smsstepresponsedto.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 import {
   WorkflowPreferencesResponseDto,
   WorkflowPreferencesResponseDto$inboundSchema,
@@ -83,6 +83,60 @@ import {
  */
 export type Slug = {};
 
+/**
+ * User last name
+ */
+export type LastName = {};
+
+/**
+ * User who last updated the workflow
+ */
+export type UpdatedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName?: string | null | undefined;
+  /**
+   * User last name
+   */
+  lastName?: LastName | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | null | undefined;
+};
+
+/**
+ * User last name
+ */
+export type WorkflowResponseDtoLastName = {};
+
+/**
+ * User who last published the workflow
+ */
+export type LastPublishedBy = {
+  /**
+   * User ID
+   */
+  id: string;
+  /**
+   * User first name
+   */
+  firstName?: string | null | undefined;
+  /**
+   * User last name
+   */
+  lastName?: WorkflowResponseDtoLastName | null | undefined;
+  /**
+   * User external ID
+   */
+  externalId?: string | null | undefined;
+};
+
 export type WorkflowResponseDtoSteps =
   | (InAppStepResponseDto & { type: "in_app" })
   | (EmailStepResponseDto & { type: "email" })
@@ -110,6 +164,18 @@ export type WorkflowResponseDto = {
    * 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 of the workflow
    */
@@ -130,6 +196,18 @@ export type WorkflowResponseDto = {
    * Creation timestamp
    */
   createdAt: string;
+  /**
+   * User who last updated the workflow
+   */
+  updatedBy?: UpdatedBy | null | undefined;
+  /**
+   * Timestamp of the last workflow publication
+   */
+  lastPublishedAt?: string | null | undefined;
+  /**
+   * User who last published the workflow
+   */
+  lastPublishedBy?: LastPublishedBy | null | undefined;
   /**
    * Steps of the workflow
    */
@@ -146,7 +224,7 @@ export type WorkflowResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Preferences for the workflow
    */
@@ -163,18 +241,10 @@ export type WorkflowResponseDto = {
    * Timestamp of the last workflow trigger
    */
   lastTriggeredAt?: string | null | undefined;
-  /**
-   * The payload JSON Schema for the workflow
-   */
-  payloadSchema?: { [k: string]: any } | null | undefined;
   /**
    * Generated payload example based on the payload schema
    */
   payloadExample?: { [k: string]: any } | null | undefined;
-  /**
-   * Whether payload schema validation is enabled
-   */
-  validatePayload?: boolean | undefined;
 };
 
 /** @internal */
@@ -215,6 +285,238 @@ export function slugFromJSON(
   );
 }
 
+/** @internal */
+export const LastName$inboundSchema: z.ZodType<
+  LastName,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type LastName$Outbound = {};
+
+/** @internal */
+export const LastName$outboundSchema: z.ZodType<
+  LastName$Outbound,
+  z.ZodTypeDef,
+  LastName
+> = 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 LastName$ {
+  /** @deprecated use `LastName$inboundSchema` instead. */
+  export const inboundSchema = LastName$inboundSchema;
+  /** @deprecated use `LastName$outboundSchema` instead. */
+  export const outboundSchema = LastName$outboundSchema;
+  /** @deprecated use `LastName$Outbound` instead. */
+  export type Outbound = LastName$Outbound;
+}
+
+export function lastNameToJSON(lastName: LastName): string {
+  return JSON.stringify(LastName$outboundSchema.parse(lastName));
+}
+
+export function lastNameFromJSON(
+  jsonString: string,
+): SafeParseResult<LastName, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LastName$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LastName' from JSON`,
+  );
+}
+
+/** @internal */
+export const UpdatedBy$inboundSchema: z.ZodType<
+  UpdatedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.lazy(() => LastName$inboundSchema)).optional(),
+  externalId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type UpdatedBy$Outbound = {
+  _id: string;
+  firstName?: string | null | undefined;
+  lastName?: LastName$Outbound | null | undefined;
+  externalId?: string | null | undefined;
+};
+
+/** @internal */
+export const UpdatedBy$outboundSchema: z.ZodType<
+  UpdatedBy$Outbound,
+  z.ZodTypeDef,
+  UpdatedBy
+> = z.object({
+  id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.lazy(() => LastName$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 UpdatedBy$ {
+  /** @deprecated use `UpdatedBy$inboundSchema` instead. */
+  export const inboundSchema = UpdatedBy$inboundSchema;
+  /** @deprecated use `UpdatedBy$outboundSchema` instead. */
+  export const outboundSchema = UpdatedBy$outboundSchema;
+  /** @deprecated use `UpdatedBy$Outbound` instead. */
+  export type Outbound = UpdatedBy$Outbound;
+}
+
+export function updatedByToJSON(updatedBy: UpdatedBy): string {
+  return JSON.stringify(UpdatedBy$outboundSchema.parse(updatedBy));
+}
+
+export function updatedByFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdatedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdatedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdatedBy' from JSON`,
+  );
+}
+
+/** @internal */
+export const WorkflowResponseDtoLastName$inboundSchema: z.ZodType<
+  WorkflowResponseDtoLastName,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type WorkflowResponseDtoLastName$Outbound = {};
+
+/** @internal */
+export const WorkflowResponseDtoLastName$outboundSchema: z.ZodType<
+  WorkflowResponseDtoLastName$Outbound,
+  z.ZodTypeDef,
+  WorkflowResponseDtoLastName
+> = 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 WorkflowResponseDtoLastName$ {
+  /** @deprecated use `WorkflowResponseDtoLastName$inboundSchema` instead. */
+  export const inboundSchema = WorkflowResponseDtoLastName$inboundSchema;
+  /** @deprecated use `WorkflowResponseDtoLastName$outboundSchema` instead. */
+  export const outboundSchema = WorkflowResponseDtoLastName$outboundSchema;
+  /** @deprecated use `WorkflowResponseDtoLastName$Outbound` instead. */
+  export type Outbound = WorkflowResponseDtoLastName$Outbound;
+}
+
+export function workflowResponseDtoLastNameToJSON(
+  workflowResponseDtoLastName: WorkflowResponseDtoLastName,
+): string {
+  return JSON.stringify(
+    WorkflowResponseDtoLastName$outboundSchema.parse(
+      workflowResponseDtoLastName,
+    ),
+  );
+}
+
+export function workflowResponseDtoLastNameFromJSON(
+  jsonString: string,
+): SafeParseResult<WorkflowResponseDtoLastName, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => WorkflowResponseDtoLastName$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'WorkflowResponseDtoLastName' from JSON`,
+  );
+}
+
+/** @internal */
+export const LastPublishedBy$inboundSchema: z.ZodType<
+  LastPublishedBy,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.lazy(() => WorkflowResponseDtoLastName$inboundSchema))
+    .optional(),
+  externalId: z.nullable(z.string()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type LastPublishedBy$Outbound = {
+  _id: string;
+  firstName?: string | null | undefined;
+  lastName?: WorkflowResponseDtoLastName$Outbound | null | undefined;
+  externalId?: string | null | undefined;
+};
+
+/** @internal */
+export const LastPublishedBy$outboundSchema: z.ZodType<
+  LastPublishedBy$Outbound,
+  z.ZodTypeDef,
+  LastPublishedBy
+> = z.object({
+  id: z.string(),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.lazy(() => WorkflowResponseDtoLastName$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 LastPublishedBy$ {
+  /** @deprecated use `LastPublishedBy$inboundSchema` instead. */
+  export const inboundSchema = LastPublishedBy$inboundSchema;
+  /** @deprecated use `LastPublishedBy$outboundSchema` instead. */
+  export const outboundSchema = LastPublishedBy$outboundSchema;
+  /** @deprecated use `LastPublishedBy$Outbound` instead. */
+  export type Outbound = LastPublishedBy$Outbound;
+}
+
+export function lastPublishedByToJSON(
+  lastPublishedBy: LastPublishedBy,
+): string {
+  return JSON.stringify(LastPublishedBy$outboundSchema.parse(lastPublishedBy));
+}
+
+export function lastPublishedByFromJSON(
+  jsonString: string,
+): SafeParseResult<LastPublishedBy, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LastPublishedBy$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LastPublishedBy' from JSON`,
+  );
+}
+
 /** @internal */
 export const WorkflowResponseDtoSteps$inboundSchema: z.ZodType<
   WorkflowResponseDtoSteps,
@@ -343,11 +645,18 @@ export const WorkflowResponseDto$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),
   _id: z.string(),
   workflowId: z.string(),
   slug: z.lazy(() => Slug$inboundSchema),
   updatedAt: z.string(),
   createdAt: z.string(),
+  updatedBy: z.nullable(z.lazy(() => UpdatedBy$inboundSchema)).optional(),
+  lastPublishedAt: z.nullable(z.string()).optional(),
+  lastPublishedBy: z.nullable(z.lazy(() => LastPublishedBy$inboundSchema))
+    .optional(),
   steps: z.array(
     z.union([
       InAppStepResponseDto$inboundSchema.and(
@@ -392,14 +701,12 @@ export const WorkflowResponseDto$inboundSchema: z.ZodType<
       ),
     ]),
   ),
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   preferences: WorkflowPreferencesResponseDto$inboundSchema,
   status: WorkflowStatusEnum$inboundSchema,
   issues: z.record(RuntimeIssueDto$inboundSchema).optional(),
   lastTriggeredAt: z.nullable(z.string()).optional(),
-  payloadSchema: z.nullable(z.record(z.any())).optional(),
   payloadExample: z.nullable(z.record(z.any())).optional(),
-  validatePayload: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -412,11 +719,17 @@ export type WorkflowResponseDto$Outbound = {
   description?: string | undefined;
   tags?: Array<string> | undefined;
   active: boolean;
+  validatePayload?: boolean | undefined;
+  payloadSchema?: { [k: string]: any } | null | undefined;
+  isTranslationEnabled: boolean;
   _id: string;
   workflowId: string;
   slug: Slug$Outbound;
   updatedAt: string;
   createdAt: string;
+  updatedBy?: UpdatedBy$Outbound | null | undefined;
+  lastPublishedAt?: string | null | undefined;
+  lastPublishedBy?: LastPublishedBy$Outbound | null | undefined;
   steps: Array<
     | (InAppStepResponseDto$Outbound & { type: "in_app" })
     | (EmailStepResponseDto$Outbound & { type: "email" })
@@ -432,9 +745,7 @@ export type WorkflowResponseDto$Outbound = {
   status: string;
   issues?: { [k: string]: RuntimeIssueDto$Outbound } | undefined;
   lastTriggeredAt?: string | null | undefined;
-  payloadSchema?: { [k: string]: any } | null | undefined;
   payloadExample?: { [k: string]: any } | null | undefined;
-  validatePayload?: boolean | undefined;
 };
 
 /** @internal */
@@ -447,11 +758,18 @@ export const WorkflowResponseDto$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),
   id: z.string(),
   workflowId: z.string(),
   slug: z.lazy(() => Slug$outboundSchema),
   updatedAt: z.string(),
   createdAt: z.string(),
+  updatedBy: z.nullable(z.lazy(() => UpdatedBy$outboundSchema)).optional(),
+  lastPublishedAt: z.nullable(z.string()).optional(),
+  lastPublishedBy: z.nullable(z.lazy(() => LastPublishedBy$outboundSchema))
+    .optional(),
   steps: z.array(
     z.union([
       InAppStepResponseDto$outboundSchema.and(
@@ -496,14 +814,12 @@ export const WorkflowResponseDto$outboundSchema: z.ZodType<
       ),
     ]),
   ),
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   preferences: WorkflowPreferencesResponseDto$outboundSchema,
   status: WorkflowStatusEnum$outboundSchema,
   issues: z.record(RuntimeIssueDto$outboundSchema).optional(),
   lastTriggeredAt: z.nullable(z.string()).optional(),
-  payloadSchema: z.nullable(z.record(z.any())).optional(),
   payloadExample: z.nullable(z.record(z.any())).optional(),
-  validatePayload: z.boolean().optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/errors/index.ts

@@ -8,4 +8,6 @@ export * from "./payloadvalidationexceptiondto.js";
 export * from "./responsevalidationerror.js";
 export * from "./sdkerror.js";
 export * from "./sdkvalidationerror.js";
+export * from "./subscriberresponsedto.js";
+export * from "./topicresponsedto.js";
 export * from "./validationerrordto.js";

package/src/models/errors/sdkerror.ts

@@ -25,8 +25,14 @@ export class SDKError extends NovuError {
       }`;
     }
     const body = httpMeta.body || `""`;
-    message += body.length > 100 ? "\n" : " ";
-    message += `Body ${body}`;
+    message += body.length > 100 ? "\n" : ". ";
+    let bodyDisplay = body;
+    if (body.length > 10000) {
+      const truncated = body.substring(0, 10000);
+      const remaining = body.length - 10000;
+      bodyDisplay = `${truncated}...and ${remaining} more chars`;
+    }
+    message += `Body: ${bodyDisplay}`;
     message = message.trim();
     super(message, httpMeta);
     this.name = "SDKError";