@novu/api 1.4.0 → 1.6.0

package/src/models/components/inappstepupsertdto.ts

@@ -8,17 +8,11 @@ import { safeParse } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
-  ActionDto,
-  ActionDto$inboundSchema,
-  ActionDto$Outbound,
-  ActionDto$outboundSchema,
-} from "./actiondto.js";
-import {
-  RedirectDto,
-  RedirectDto$inboundSchema,
-  RedirectDto$Outbound,
-  RedirectDto$outboundSchema,
-} from "./redirectdto.js";
+  InAppControlDto,
+  InAppControlDto$inboundSchema,
+  InAppControlDto$Outbound,
+  InAppControlDto$outboundSchema,
+} from "./inappcontroldto.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -26,46 +20,9 @@ import {
 } from "./steptypeenum.js";
 
 /**
- * Control values for the In-App step
+ * Control values for the In-App step.
  */
-export type ControlValues = {
-  /**
-   * 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/body of the in-app message. Required if subject is empty.
-   */
-  body?: string | undefined;
-  /**
-   * Subject/title of the in-app message. Required if body is empty.
-   */
-  subject?: string | undefined;
-  /**
-   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
-   */
-  avatar?: string | undefined;
-  /**
-   * Primary action button details.
-   */
-  primaryAction?: ActionDto | undefined;
-  /**
-   * Secondary action button details.
-   */
-  secondaryAction?: ActionDto | undefined;
-  /**
-   * Redirection URL configuration for the main content click (if no actions defined/clicked)..
-   */
-  redirect?: RedirectDto | undefined;
-  /**
-   * Disable sanitization of the output.
-   */
-  disableOutputSanitization?: boolean | undefined;
-  /**
-   * Additional data payload for the step.
-   */
-  data?: { [k: string]: any } | undefined;
-};
+export type ControlValues = InAppControlDto | { [k: string]: any };
 
 export type InAppStepUpsertDto = {
   /**
@@ -81,9 +38,9 @@ export type InAppStepUpsertDto = {
    */
   type: StepTypeEnum;
   /**
-   * Control values for the In-App step
+   * Control values for the In-App step.
    */
-  controlValues?: ControlValues | null | undefined;
+  controlValues?: InAppControlDto | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -91,29 +48,11 @@ export const ControlValues$inboundSchema: z.ZodType<
   ControlValues,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  body: z.string().optional(),
-  subject: z.string().optional(),
-  avatar: z.string().optional(),
-  primaryAction: ActionDto$inboundSchema.optional(),
-  secondaryAction: ActionDto$inboundSchema.optional(),
-  redirect: RedirectDto$inboundSchema.optional(),
-  disableOutputSanitization: z.boolean().default(false),
-  data: z.record(z.any()).optional(),
-});
+> = z.union([InAppControlDto$inboundSchema, z.record(z.any())]);
 
 /** @internal */
-export type ControlValues$Outbound = {
-  skip?: { [k: string]: any } | undefined;
-  body?: string | undefined;
-  subject?: string | undefined;
-  avatar?: string | undefined;
-  primaryAction?: ActionDto$Outbound | undefined;
-  secondaryAction?: ActionDto$Outbound | undefined;
-  redirect?: RedirectDto$Outbound | undefined;
-  disableOutputSanitization: boolean;
-  data?: { [k: string]: any } | undefined;
+export type ControlValues$Outbound = InAppControlDto$Outbound | {
+  [k: string]: any;
 };
 
 /** @internal */
@@ -121,17 +60,7 @@ export const ControlValues$outboundSchema: z.ZodType<
   ControlValues$Outbound,
   z.ZodTypeDef,
   ControlValues
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  body: z.string().optional(),
-  subject: z.string().optional(),
-  avatar: z.string().optional(),
-  primaryAction: ActionDto$outboundSchema.optional(),
-  secondaryAction: ActionDto$outboundSchema.optional(),
-  redirect: RedirectDto$outboundSchema.optional(),
-  disableOutputSanitization: z.boolean().default(false),
-  data: z.record(z.any()).optional(),
-});
+> = z.union([InAppControlDto$outboundSchema, z.record(z.any())]);
 
 /**
  * @internal
@@ -169,7 +98,7 @@ export const InAppStepUpsertDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
-  controlValues: z.nullable(z.lazy(() => ControlValues$inboundSchema))
+  controlValues: z.union([InAppControlDto$inboundSchema, z.record(z.any())])
     .optional(),
 }).transform((v) => {
   return remap$(v, {
@@ -182,7 +111,7 @@ export type InAppStepUpsertDto$Outbound = {
   _id?: string | undefined;
   name: string;
   type: string;
-  controlValues?: ControlValues$Outbound | null | undefined;
+  controlValues?: InAppControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -194,7 +123,7 @@ export const InAppStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
-  controlValues: z.nullable(z.lazy(() => ControlValues$outboundSchema))
+  controlValues: z.union([InAppControlDto$outboundSchema, z.record(z.any())])
     .optional(),
 }).transform((v) => {
   return remap$(v, {

package/src/models/components/index.ts

@@ -19,6 +19,8 @@ export * from "./builderfieldtypeenum.js";
 export * from "./bulkcreatesubscriberresponsedto.js";
 export * from "./bulksubscribercreatedto.js";
 export * from "./bulktriggereventdto.js";
+export * from "./bulkupdatesubscriberpreferenceitemdto.js";
+export * from "./bulkupdatesubscriberpreferencesdto.js";
 export * from "./buttontypeenum.js";
 export * from "./channelcredentials.js";
 export * from "./channelcredentialsdto.js";
@@ -32,6 +34,7 @@ export * from "./chatorpushproviderenum.js";
 export * from "./chatstepresponsedto.js";
 export * from "./chatstepupsertdto.js";
 export * from "./constraintvalidation.js";
+export * from "./contentissueenum.js";
 export * from "./controlsmetadatadto.js";
 export * from "./createdsubscriberdto.js";
 export * from "./createenvironmentrequestdto.js";
@@ -70,6 +73,7 @@ export * from "./directionenum.js";
 export * from "./emailblock.js";
 export * from "./emailblockstyles.js";
 export * from "./emailblocktypeenum.js";
+export * from "./emailchanneloverrides.js";
 export * from "./emailcontroldto.js";
 export * from "./emailcontrolsmetadataresponsedto.js";
 export * from "./emailstepresponsedto.js";
@@ -80,12 +84,15 @@ export * from "./executiondetailsstatusenum.js";
 export * from "./failedoperationdto.js";
 export * from "./feedresponsedto.js";
 export * from "./fieldfilterpartdto.js";
+export * from "./getenvironmenttagsdto.js";
+export * from "./getpreferencesresponsedto.js";
 export * from "./getsubscriberpreferencesdto.js";
 export * from "./inappcontroldto.js";
 export * from "./inappcontrolsmetadataresponsedto.js";
 export * from "./inappstepresponsedto.js";
 export * from "./inappstepupsertdto.js";
 export * from "./inboundparsedomaindto.js";
+export * from "./integrationissueenum.js";
 export * from "./integrationresponsedto.js";
 export * from "./listsubscribersresponsedto.js";
 export * from "./listtopicsresponsedto.js";
@@ -122,6 +129,7 @@ export * from "./patchsubscriberpreferencesdto.js";
 export * from "./patchsubscriberrequestdto.js";
 export * from "./patchworkflowdto.js";
 export * from "./payloadvalidationerrordto.js";
+export * from "./preferencelevelenum.js";
 export * from "./preferenceoverridesourceenum.js";
 export * from "./preferencesrequestdto.js";
 export * from "./providersidenum.js";
@@ -132,17 +140,17 @@ export * from "./pushstepupsertdto.js";
 export * from "./redirectdto.js";
 export * from "./removesubscriberresponsedto.js";
 export * from "./replycallback.js";
+export * from "./resourceoriginenum.js";
 export * from "./runtimeissuedto.js";
 export * from "./security.js";
+export * from "./severitylevelenum.js";
 export * from "./smscontroldto.js";
 export * from "./smscontrolsmetadataresponsedto.js";
 export * from "./smsstepresponsedto.js";
 export * from "./smsstepupsertdto.js";
 export * from "./stepcontentissuedto.js";
-export * from "./stepcontentissueenum.js";
 export * from "./stepfilterdto.js";
 export * from "./stepintegrationissue.js";
-export * from "./stepintegrationissueenum.js";
 export * from "./stepissuesdto.js";
 export * from "./stepresponsedto.js";
 export * from "./stepsoverrides.js";
@@ -187,7 +195,6 @@ export * from "./updatetopicrequestdto.js";
 export * from "./updateworkflowdto.js";
 export * from "./workflowcreationsourceenum.js";
 export * from "./workflowlistresponsedto.js";
-export * from "./workfloworiginenum.js";
 export * from "./workflowpreferencedto.js";
 export * from "./workflowpreferencesdto.js";
 export * from "./workflowpreferencesresponsedto.js";

package/src/models/components/integrationissueenum.ts

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

package/src/models/components/lookbackwindowdto.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * Unit of time for the look-back window.
  */
-export const Unit = {
+export const LookBackWindowDtoUnit = {
   Seconds: "seconds",
   Minutes: "minutes",
   Hours: "hours",
@@ -22,7 +22,7 @@ export const Unit = {
 /**
  * Unit of time for the look-back window.
  */
-export type Unit = ClosedEnum<typeof Unit>;
+export type LookBackWindowDtoUnit = ClosedEnum<typeof LookBackWindowDtoUnit>;
 
 export type LookBackWindowDto = {
   /**
@@ -32,27 +32,28 @@ export type LookBackWindowDto = {
   /**
    * Unit of time for the look-back window.
    */
-  unit: Unit;
+  unit: LookBackWindowDtoUnit;
 };
 
 /** @internal */
-export const Unit$inboundSchema: z.ZodNativeEnum<typeof Unit> = z.nativeEnum(
-  Unit,
-);
+export const LookBackWindowDtoUnit$inboundSchema: z.ZodNativeEnum<
+  typeof LookBackWindowDtoUnit
+> = z.nativeEnum(LookBackWindowDtoUnit);
 
 /** @internal */
-export const Unit$outboundSchema: z.ZodNativeEnum<typeof Unit> =
-  Unit$inboundSchema;
+export const LookBackWindowDtoUnit$outboundSchema: z.ZodNativeEnum<
+  typeof LookBackWindowDtoUnit
+> = LookBackWindowDtoUnit$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Unit$ {
-  /** @deprecated use `Unit$inboundSchema` instead. */
-  export const inboundSchema = Unit$inboundSchema;
-  /** @deprecated use `Unit$outboundSchema` instead. */
-  export const outboundSchema = Unit$outboundSchema;
+export namespace LookBackWindowDtoUnit$ {
+  /** @deprecated use `LookBackWindowDtoUnit$inboundSchema` instead. */
+  export const inboundSchema = LookBackWindowDtoUnit$inboundSchema;
+  /** @deprecated use `LookBackWindowDtoUnit$outboundSchema` instead. */
+  export const outboundSchema = LookBackWindowDtoUnit$outboundSchema;
 }
 
 /** @internal */
@@ -62,7 +63,7 @@ export const LookBackWindowDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   amount: z.number(),
-  unit: Unit$inboundSchema,
+  unit: LookBackWindowDtoUnit$inboundSchema,
 });
 
 /** @internal */
@@ -78,7 +79,7 @@ export const LookBackWindowDto$outboundSchema: z.ZodType<
   LookBackWindowDto
 > = z.object({
   amount: z.number(),
-  unit: Unit$outboundSchema,
+  unit: LookBackWindowDtoUnit$outboundSchema,
 });
 
 /**

package/src/models/components/messageresponsedto.ts

@@ -65,7 +65,7 @@ export type MessageResponseDto = {
   /**
    * Template ID associated with the message
    */
-  templateId: string;
+  templateId?: string | null | undefined;
   /**
    * Environment ID where the message is sent
    */
@@ -73,7 +73,7 @@ export type MessageResponseDto = {
   /**
    * Message template ID
    */
-  messageTemplateId: string;
+  messageTemplateId?: string | null | undefined;
   /**
    * Organization ID associated with the message
    */
@@ -117,7 +117,7 @@ export type MessageResponseDto = {
   /**
    * Content of the message, can be an email block or a string
    */
-  content: Array<EmailBlock> | string;
+  content?: Array<EmailBlock> | string | null | undefined;
   /**
    * Transaction ID associated with the message
    */
@@ -342,9 +342,9 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
-  _templateId: z.string(),
+  _templateId: z.nullable(z.string()).optional(),
   _environmentId: z.string(),
-  _messageTemplateId: z.string(),
+  _messageTemplateId: z.nullable(z.string()).optional(),
   _organizationId: z.string(),
   _notificationId: z.string(),
   _subscriberId: z.string(),
@@ -355,7 +355,8 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
   deliveredAt: z.array(z.string()).optional(),
   lastSeenDate: z.string().optional(),
   lastReadDate: z.string().optional(),
-  content: z.union([z.array(EmailBlock$inboundSchema), z.string()]),
+  content: z.nullable(z.union([z.array(EmailBlock$inboundSchema), z.string()]))
+    .optional(),
   transactionId: z.string(),
   subject: z.string().optional(),
   channel: ChannelTypeEnum$inboundSchema,
@@ -391,9 +392,9 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
 /** @internal */
 export type MessageResponseDto$Outbound = {
   _id?: string | undefined;
-  _templateId: string;
+  _templateId?: string | null | undefined;
   _environmentId: string;
-  _messageTemplateId: string;
+  _messageTemplateId?: string | null | undefined;
   _organizationId: string;
   _notificationId: string;
   _subscriberId: string;
@@ -404,7 +405,7 @@ export type MessageResponseDto$Outbound = {
   deliveredAt?: Array<string> | undefined;
   lastSeenDate?: string | undefined;
   lastReadDate?: string | undefined;
-  content: Array<EmailBlock$Outbound> | string;
+  content?: Array<EmailBlock$Outbound> | string | null | undefined;
   transactionId: string;
   subject?: string | undefined;
   channel: string;
@@ -433,9 +434,9 @@ export const MessageResponseDto$outboundSchema: z.ZodType<
   MessageResponseDto
 > = z.object({
   id: z.string().optional(),
-  templateId: z.string(),
+  templateId: z.nullable(z.string()).optional(),
   environmentId: z.string(),
-  messageTemplateId: z.string(),
+  messageTemplateId: z.nullable(z.string()).optional(),
   organizationId: z.string(),
   notificationId: z.string(),
   subscriberId: z.string(),
@@ -446,7 +447,8 @@ export const MessageResponseDto$outboundSchema: z.ZodType<
   deliveredAt: z.array(z.string()).optional(),
   lastSeenDate: z.string().optional(),
   lastReadDate: z.string().optional(),
-  content: z.union([z.array(EmailBlock$outboundSchema), z.string()]),
+  content: z.nullable(z.union([z.array(EmailBlock$outboundSchema), z.string()]))
+    .optional(),
   transactionId: z.string(),
   subject: z.string().optional(),
   channel: ChannelTypeEnum$outboundSchema,

package/src/models/components/notificationfeeditemdto.ts

@@ -148,10 +148,18 @@ export type NotificationFeedItemDto = {
    * The payload that was used to send the notification trigger.
    */
   payload?: { [k: string]: any } | undefined;
+  /**
+   * The data sent with the notification.
+   */
+  data?: { [k: string]: any } | null | undefined;
   /**
    * Provider-specific overrides used when triggering the notification.
    */
   overrides?: { [k: string]: any } | undefined;
+  /**
+   * Tags associated with the workflow that triggered the notification.
+   */
+  tags?: Array<string> | null | undefined;
 };
 
 /** @internal */
@@ -210,7 +218,9 @@ export const NotificationFeedItemDto$inboundSchema: z.ZodType<
   cta: MessageCTA$inboundSchema,
   status: NotificationFeedItemDtoStatus$inboundSchema,
   payload: z.record(z.any()).optional(),
+  data: z.nullable(z.record(z.any())).optional(),
   overrides: z.record(z.any()).optional(),
+  tags: z.nullable(z.array(z.string())).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -252,7 +262,9 @@ export type NotificationFeedItemDto$Outbound = {
   cta: MessageCTA$Outbound;
   status: string;
   payload?: { [k: string]: any } | undefined;
+  data?: { [k: string]: any } | null | undefined;
   overrides?: { [k: string]: any } | undefined;
+  tags?: Array<string> | null | undefined;
 };
 
 /** @internal */
@@ -286,7 +298,9 @@ export const NotificationFeedItemDto$outboundSchema: z.ZodType<
   cta: MessageCTA$outboundSchema,
   status: NotificationFeedItemDtoStatus$outboundSchema,
   payload: z.record(z.any()).optional(),
+  data: z.nullable(z.record(z.any())).optional(),
   overrides: z.record(z.any()).optional(),
+  tags: z.nullable(z.array(z.string())).optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/patchworkflowdto.ts

@@ -27,11 +27,15 @@ export type PatchWorkflowDto = {
   /**
    * The payload JSON Schema for the workflow
    */
-  payloadSchema?: { [k: string]: any } | undefined;
+  payloadSchema?: { [k: string]: any } | null | undefined;
   /**
    * Enable or disable payload schema validation
    */
   validatePayload?: boolean | undefined;
+  /**
+   * Enable or disable translations for this workflow
+   */
+  isTranslationEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -44,8 +48,9 @@ export const PatchWorkflowDto$inboundSchema: z.ZodType<
   name: z.string().optional(),
   description: z.string().optional(),
   tags: z.array(z.string()).optional(),
-  payloadSchema: z.record(z.any()).optional(),
+  payloadSchema: z.nullable(z.record(z.any())).optional(),
   validatePayload: z.boolean().optional(),
+  isTranslationEnabled: z.boolean().optional(),
 });
 
 /** @internal */
@@ -54,8 +59,9 @@ export type PatchWorkflowDto$Outbound = {
   name?: string | undefined;
   description?: string | undefined;
   tags?: Array<string> | undefined;
-  payloadSchema?: { [k: string]: any } | undefined;
+  payloadSchema?: { [k: string]: any } | null | undefined;
   validatePayload?: boolean | undefined;
+  isTranslationEnabled?: boolean | undefined;
 };
 
 /** @internal */
@@ -68,8 +74,9 @@ export const PatchWorkflowDto$outboundSchema: z.ZodType<
   name: z.string().optional(),
   description: z.string().optional(),
   tags: z.array(z.string()).optional(),
-  payloadSchema: z.record(z.any()).optional(),
+  payloadSchema: z.nullable(z.record(z.any())).optional(),
   validatePayload: z.boolean().optional(),
+  isTranslationEnabled: z.boolean().optional(),
 });
 
 /**

package/src/models/components/preferencelevelenum.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The level of the preference (global or template)
+ */
+export const PreferenceLevelEnum = {
+  Global: "global",
+  Template: "template",
+} as const;
+/**
+ * The level of the preference (global or template)
+ */
+export type PreferenceLevelEnum = ClosedEnum<typeof PreferenceLevelEnum>;
+
+/** @internal */
+export const PreferenceLevelEnum$inboundSchema: z.ZodNativeEnum<
+  typeof PreferenceLevelEnum
+> = z.nativeEnum(PreferenceLevelEnum);
+
+/** @internal */
+export const PreferenceLevelEnum$outboundSchema: z.ZodNativeEnum<
+  typeof PreferenceLevelEnum
+> = PreferenceLevelEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PreferenceLevelEnum$ {
+  /** @deprecated use `PreferenceLevelEnum$inboundSchema` instead. */
+  export const inboundSchema = PreferenceLevelEnum$inboundSchema;
+  /** @deprecated use `PreferenceLevelEnum$outboundSchema` instead. */
+  export const outboundSchema = PreferenceLevelEnum$outboundSchema;
+}