@novu/api 3.14.2 → 3.14.3

package/src/models/components/layoutcontrolvaluesdto.ts

@@ -9,15 +9,13 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 import {
   EmailControlsDto,
   EmailControlsDto$inboundSchema,
-  EmailControlsDto$Outbound,
-  EmailControlsDto$outboundSchema,
 } from "./emailcontrolsdto.js";
 
 export type LayoutControlValuesDto = {
   /**
    * Email layout controls
    */
-  email: EmailControlsDto;
+  email?: EmailControlsDto | undefined;
 };
 
 /** @internal */
@@ -26,29 +24,9 @@ export const LayoutControlValuesDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  email: EmailControlsDto$inboundSchema,
+  email: EmailControlsDto$inboundSchema.optional(),
 });
-/** @internal */
-export type LayoutControlValuesDto$Outbound = {
-  email: EmailControlsDto$Outbound;
-};
 
-/** @internal */
-export const LayoutControlValuesDto$outboundSchema: z.ZodType<
-  LayoutControlValuesDto$Outbound,
-  z.ZodTypeDef,
-  LayoutControlValuesDto
-> = z.object({
-  email: EmailControlsDto$outboundSchema,
-});
-
-export function layoutControlValuesDtoToJSON(
-  layoutControlValuesDto: LayoutControlValuesDto,
-): string {
-  return JSON.stringify(
-    LayoutControlValuesDto$outboundSchema.parse(layoutControlValuesDto),
-  );
-}
 export function layoutControlValuesDtoFromJSON(
   jsonString: string,
 ): SafeParseResult<LayoutControlValuesDto, SDKValidationError> {

package/src/models/components/marksubscribernotificationsasseendto.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type MarkSubscriberNotificationsAsSeenDto = {
+  /**
+   * Specific notification IDs to mark as seen
+   */
+  notificationIds?: Array<string> | undefined;
+  /**
+   * Filter notifications by workflow tags
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Filter notifications by data attributes (JSON string)
+   */
+  data?: string | undefined;
+  /**
+   * Context keys for filtering notifications
+   */
+  contextKeys?: Array<string> | undefined;
+};
+
+/** @internal */
+export type MarkSubscriberNotificationsAsSeenDto$Outbound = {
+  notificationIds?: Array<string> | undefined;
+  tags?: Array<string> | undefined;
+  data?: string | undefined;
+  contextKeys?: Array<string> | undefined;
+};
+
+/** @internal */
+export const MarkSubscriberNotificationsAsSeenDto$outboundSchema: z.ZodType<
+  MarkSubscriberNotificationsAsSeenDto$Outbound,
+  z.ZodTypeDef,
+  MarkSubscriberNotificationsAsSeenDto
+> = z.object({
+  notificationIds: z.array(z.string()).optional(),
+  tags: z.array(z.string()).optional(),
+  data: z.string().optional(),
+  contextKeys: z.array(z.string()).optional(),
+});
+
+export function markSubscriberNotificationsAsSeenDtoToJSON(
+  markSubscriberNotificationsAsSeenDto: MarkSubscriberNotificationsAsSeenDto,
+): string {
+  return JSON.stringify(
+    MarkSubscriberNotificationsAsSeenDto$outboundSchema.parse(
+      markSubscriberNotificationsAsSeenDto,
+    ),
+  );
+}

package/src/models/components/notificationworkflowdto.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SeverityLevelEnum,
+  SeverityLevelEnum$inboundSchema,
+} from "./severitylevelenum.js";
+
+export type NotificationWorkflowDto = {
+  /**
+   * Unique identifier of the workflow
+   */
+  id: string;
+  /**
+   * Workflow identifier used for triggering
+   */
+  identifier: string;
+  /**
+   * Human-readable name of the workflow
+   */
+  name: string;
+  /**
+   * Whether this workflow is marked as critical
+   */
+  critical: boolean;
+  /**
+   * Tags associated with the workflow
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Custom data associated with the workflow
+   */
+  data?: { [k: string]: any } | undefined;
+  /**
+   * Severity of the workflow
+   */
+  severity: SeverityLevelEnum;
+};
+
+/** @internal */
+export const NotificationWorkflowDto$inboundSchema: z.ZodType<
+  NotificationWorkflowDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+  critical: z.boolean(),
+  tags: z.array(z.string()).optional(),
+  data: z.record(z.any()).optional(),
+  severity: SeverityLevelEnum$inboundSchema,
+});
+
+export function notificationWorkflowDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationWorkflowDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationWorkflowDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationWorkflowDto' from JSON`,
+  );
+}

package/src/models/components/previewerrordto.ts

@@ -0,0 +1,44 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PreviewErrorDto = {
+  /**
+   * Short error title
+   */
+  title: string;
+  /**
+   * Detailed error message
+   */
+  message: string;
+  /**
+   * Actionable hint for the user
+   */
+  hint: string;
+};
+
+/** @internal */
+export const PreviewErrorDto$inboundSchema: z.ZodType<
+  PreviewErrorDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  title: z.string(),
+  message: z.string(),
+  hint: z.string(),
+});
+
+export function previewErrorDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PreviewErrorDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PreviewErrorDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreviewErrorDto' from JSON`,
+  );
+}

package/src/models/components/previewpayloaddto.ts

@@ -0,0 +1,193 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  SubscriberResponseDtoOptional,
+  SubscriberResponseDtoOptional$inboundSchema,
+  SubscriberResponseDtoOptional$Outbound,
+  SubscriberResponseDtoOptional$outboundSchema,
+} from "./subscriberresponsedtooptional.js";
+
+/**
+ * Rich context object with id and optional data
+ */
+export type PreviewPayloadDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type PreviewPayloadDtoContext = PreviewPayloadDtoContext2 | string;
+
+export type PreviewPayloadDto = {
+  /**
+   * Partial subscriber information
+   */
+  subscriber?: SubscriberResponseDtoOptional | undefined;
+  /**
+   * Payload data
+   */
+  payload?: { [k: string]: any } | undefined;
+  /**
+   * Steps data
+   */
+  steps?: { [k: string]: any } | undefined;
+  context?: { [k: string]: PreviewPayloadDtoContext2 | string } | undefined;
+  /**
+   * Environment variables data
+   */
+  env?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PreviewPayloadDtoContext2$inboundSchema: z.ZodType<
+  PreviewPayloadDtoContext2,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+/** @internal */
+export type PreviewPayloadDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PreviewPayloadDtoContext2$outboundSchema: z.ZodType<
+  PreviewPayloadDtoContext2$Outbound,
+  z.ZodTypeDef,
+  PreviewPayloadDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function previewPayloadDtoContext2ToJSON(
+  previewPayloadDtoContext2: PreviewPayloadDtoContext2,
+): string {
+  return JSON.stringify(
+    PreviewPayloadDtoContext2$outboundSchema.parse(previewPayloadDtoContext2),
+  );
+}
+export function previewPayloadDtoContext2FromJSON(
+  jsonString: string,
+): SafeParseResult<PreviewPayloadDtoContext2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PreviewPayloadDtoContext2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreviewPayloadDtoContext2' from JSON`,
+  );
+}
+
+/** @internal */
+export const PreviewPayloadDtoContext$inboundSchema: z.ZodType<
+  PreviewPayloadDtoContext,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.lazy(() => PreviewPayloadDtoContext2$inboundSchema),
+  z.string(),
+]);
+/** @internal */
+export type PreviewPayloadDtoContext$Outbound =
+  | PreviewPayloadDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const PreviewPayloadDtoContext$outboundSchema: z.ZodType<
+  PreviewPayloadDtoContext$Outbound,
+  z.ZodTypeDef,
+  PreviewPayloadDtoContext
+> = z.union([
+  z.lazy(() => PreviewPayloadDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function previewPayloadDtoContextToJSON(
+  previewPayloadDtoContext: PreviewPayloadDtoContext,
+): string {
+  return JSON.stringify(
+    PreviewPayloadDtoContext$outboundSchema.parse(previewPayloadDtoContext),
+  );
+}
+export function previewPayloadDtoContextFromJSON(
+  jsonString: string,
+): SafeParseResult<PreviewPayloadDtoContext, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PreviewPayloadDtoContext$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreviewPayloadDtoContext' from JSON`,
+  );
+}
+
+/** @internal */
+export const PreviewPayloadDto$inboundSchema: z.ZodType<
+  PreviewPayloadDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subscriber: SubscriberResponseDtoOptional$inboundSchema.optional(),
+  payload: z.record(z.any()).optional(),
+  steps: z.record(z.any()).optional(),
+  context: z.record(
+    z.union([
+      z.lazy(() => PreviewPayloadDtoContext2$inboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  env: z.record(z.any()).optional(),
+});
+/** @internal */
+export type PreviewPayloadDto$Outbound = {
+  subscriber?: SubscriberResponseDtoOptional$Outbound | undefined;
+  payload?: { [k: string]: any } | undefined;
+  steps?: { [k: string]: any } | undefined;
+  context?:
+    | { [k: string]: PreviewPayloadDtoContext2$Outbound | string }
+    | undefined;
+  env?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const PreviewPayloadDto$outboundSchema: z.ZodType<
+  PreviewPayloadDto$Outbound,
+  z.ZodTypeDef,
+  PreviewPayloadDto
+> = z.object({
+  subscriber: SubscriberResponseDtoOptional$outboundSchema.optional(),
+  payload: z.record(z.any()).optional(),
+  steps: z.record(z.any()).optional(),
+  context: z.record(
+    z.union([
+      z.lazy(() => PreviewPayloadDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
+  env: z.record(z.any()).optional(),
+});
+
+export function previewPayloadDtoToJSON(
+  previewPayloadDto: PreviewPayloadDto,
+): string {
+  return JSON.stringify(
+    PreviewPayloadDto$outboundSchema.parse(previewPayloadDto),
+  );
+}
+export function previewPayloadDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<PreviewPayloadDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PreviewPayloadDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreviewPayloadDto' from JSON`,
+  );
+}

package/src/models/components/pushrenderoutput.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type PushRenderOutput = {
+  /**
+   * Subject of the push notification
+   */
+  subject: string;
+  /**
+   * Body of the push notification
+   */
+  body: string;
+};
+
+/** @internal */
+export const PushRenderOutput$inboundSchema: z.ZodType<
+  PushRenderOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subject: z.string(),
+  body: z.string(),
+});
+
+export function pushRenderOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<PushRenderOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => PushRenderOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PushRenderOutput' from JSON`,
+  );
+}

package/src/models/components/redirectdto.ts

@@ -9,7 +9,7 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 /**
- * Target window for the redirection.
+ * Target attribute for the redirect link
  */
 export const Target = {
   Self: "_self",
@@ -19,17 +19,17 @@ export const Target = {
   UnfencedTop: "_unfencedTop",
 } as const;
 /**
- * Target window for the redirection.
+ * Target attribute for the redirect link
  */
 export type Target = ClosedEnum<typeof Target>;
 
 export type RedirectDto = {
   /**
-   * URL for redirection. Must be a valid URL or start with / or {{ variable }}.
+   * URL to redirect to
    */
-  url?: string | undefined;
+  url: string;
   /**
-   * Target window for the redirection.
+   * Target attribute for the redirect link
    */
   target?: Target | undefined;
 };
@@ -47,13 +47,13 @@ export const RedirectDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  url: z.string().optional(),
-  target: Target$inboundSchema.default("_self"),
+  url: z.string(),
+  target: Target$inboundSchema.optional(),
 });
 /** @internal */
 export type RedirectDto$Outbound = {
-  url?: string | undefined;
-  target: string;
+  url: string;
+  target?: string | undefined;
 };
 
 /** @internal */
@@ -62,8 +62,8 @@ export const RedirectDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   RedirectDto
 > = z.object({
-  url: z.string().optional(),
-  target: Target$outboundSchema.default("_self"),
+  url: z.string(),
+  target: Target$outboundSchema.optional(),
 });
 
 export function redirectDtoToJSON(redirectDto: RedirectDto): string {

package/src/models/components/smsrenderoutput.ts

@@ -0,0 +1,34 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+export type SmsRenderOutput = {
+  /**
+   * Body of the SMS message
+   */
+  body: string;
+};
+
+/** @internal */
+export const SmsRenderOutput$inboundSchema: z.ZodType<
+  SmsRenderOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  body: z.string(),
+});
+
+export function smsRenderOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<SmsRenderOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SmsRenderOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SmsRenderOutput' from JSON`,
+  );
+}

package/src/models/components/snoozesubscribernotificationdto.ts

@@ -0,0 +1,36 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+
+export type SnoozeSubscriberNotificationDto = {
+  /**
+   * The date and time until which the notification should be snoozed
+   */
+  snoozeUntil: Date;
+};
+
+/** @internal */
+export type SnoozeSubscriberNotificationDto$Outbound = {
+  snoozeUntil: string;
+};
+
+/** @internal */
+export const SnoozeSubscriberNotificationDto$outboundSchema: z.ZodType<
+  SnoozeSubscriberNotificationDto$Outbound,
+  z.ZodTypeDef,
+  SnoozeSubscriberNotificationDto
+> = z.object({
+  snoozeUntil: z.date().transform(v => v.toISOString()),
+});
+
+export function snoozeSubscriberNotificationDtoToJSON(
+  snoozeSubscriberNotificationDto: SnoozeSubscriberNotificationDto,
+): string {
+  return JSON.stringify(
+    SnoozeSubscriberNotificationDto$outboundSchema.parse(
+      snoozeSubscriberNotificationDto,
+    ),
+  );
+}

package/src/models/components/subscriberresponsedto.ts

@@ -20,11 +20,11 @@ export type SubscriberResponseDto = {
   /**
    * The first name of the subscriber.
    */
-  firstName: string | null;
+  firstName?: string | null | undefined;
   /**
    * The last name of the subscriber.
    */
-  lastName: string | null;
+  lastName?: string | null | undefined;
   /**
    * The email address of the subscriber.
    */
@@ -54,11 +54,11 @@ export type SubscriberResponseDto = {
   /**
    * Indicates whether the subscriber is currently online.
    */
-  isOnline: boolean | null;
+  isOnline?: boolean | null | undefined;
   /**
    * The timestamp indicating when the subscriber was last online, in ISO 8601 format.
    */
-  lastOnlineAt: string | null;
+  lastOnlineAt?: string | null | undefined;
   /**
    * The version of the subscriber document.
    */
@@ -104,16 +104,16 @@ export const SubscriberResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
-  firstName: z.nullable(z.string()),
-  lastName: z.nullable(z.string()),
+  firstName: z.nullable(z.string()).optional(),
+  lastName: z.nullable(z.string()).optional(),
   email: z.nullable(z.string()).optional(),
   phone: z.nullable(z.string()).optional(),
   avatar: z.nullable(z.string()).optional(),
   locale: z.nullable(z.string()).optional(),
   channels: z.array(ChannelSettingsDto$inboundSchema).optional(),
   topics: z.array(z.string()).optional(),
-  isOnline: z.nullable(z.boolean()),
-  lastOnlineAt: z.nullable(z.string()),
+  isOnline: z.nullable(z.boolean()).optional(),
+  lastOnlineAt: z.nullable(z.string()).optional(),
   __v: z.number().optional(),
   data: z.nullable(z.record(z.any())).optional(),
   timezone: z.nullable(z.string()).optional(),