@novu/api 0.0.1-alpha.191 → 0.0.1-alpha.193

package/src/models/components/notificationstepdata.ts

@@ -0,0 +1,287 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  DelayRegularMetadata,
+  DelayRegularMetadata$inboundSchema,
+  DelayRegularMetadata$Outbound,
+  DelayRegularMetadata$outboundSchema,
+} from "./delayregularmetadata.js";
+import {
+  DelayScheduledMetadata,
+  DelayScheduledMetadata$inboundSchema,
+  DelayScheduledMetadata$Outbound,
+  DelayScheduledMetadata$outboundSchema,
+} from "./delayscheduledmetadata.js";
+import {
+  DigestRegularMetadata,
+  DigestRegularMetadata$inboundSchema,
+  DigestRegularMetadata$Outbound,
+  DigestRegularMetadata$outboundSchema,
+} from "./digestregularmetadata.js";
+import {
+  DigestTimedMetadata,
+  DigestTimedMetadata$inboundSchema,
+  DigestTimedMetadata$Outbound,
+  DigestTimedMetadata$outboundSchema,
+} from "./digesttimedmetadata.js";
+import {
+  MessageTemplate,
+  MessageTemplate$inboundSchema,
+  MessageTemplate$Outbound,
+  MessageTemplate$outboundSchema,
+} from "./messagetemplate.js";
+import {
+  ReplyCallback,
+  ReplyCallback$inboundSchema,
+  ReplyCallback$Outbound,
+  ReplyCallback$outboundSchema,
+} from "./replycallback.js";
+import {
+  StepFilterDto,
+  StepFilterDto$inboundSchema,
+  StepFilterDto$Outbound,
+  StepFilterDto$outboundSchema,
+} from "./stepfilterdto.js";
+
+/**
+ * Metadata associated with the workflow step. Can vary based on the type of step.
+ */
+export type NotificationStepDataMetadata =
+  | DelayScheduledMetadata
+  | DelayRegularMetadata
+  | DigestTimedMetadata
+  | DigestRegularMetadata;
+
+export type NotificationStepData = {
+  /**
+   * Unique identifier for the notification step.
+   */
+  id?: string | undefined;
+  /**
+   * Universally unique identifier for the notification step.
+   */
+  uuid?: string | undefined;
+  /**
+   * Name of the notification step.
+   */
+  name?: string | undefined;
+  /**
+   * ID of the template associated with this notification step.
+   */
+  templateId?: string | undefined;
+  /**
+   * Indicates whether the notification step is active.
+   */
+  active?: boolean | undefined;
+  /**
+   * Determines if the process should stop on failure.
+   */
+  shouldStopOnFail?: boolean | undefined;
+  /**
+   * Message template used in this notification step.
+   */
+  template?: MessageTemplate | undefined;
+  /**
+   * Filters applied to this notification step.
+   */
+  filters?: Array<StepFilterDto> | undefined;
+  /**
+   * ID of the parent notification step, if applicable.
+   */
+  parentId?: string | undefined;
+  /**
+   * Metadata associated with the workflow step. Can vary based on the type of step.
+   */
+  metadata?:
+    | DelayScheduledMetadata
+    | DelayRegularMetadata
+    | DigestTimedMetadata
+    | DigestRegularMetadata
+    | undefined;
+  /**
+   * Callback information for replies, including whether it is active and the callback URL.
+   */
+  replyCallback?: ReplyCallback | undefined;
+};
+
+/** @internal */
+export const NotificationStepDataMetadata$inboundSchema: z.ZodType<
+  NotificationStepDataMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  DelayScheduledMetadata$inboundSchema,
+  DelayRegularMetadata$inboundSchema,
+  DigestTimedMetadata$inboundSchema,
+  DigestRegularMetadata$inboundSchema,
+]);
+
+/** @internal */
+export type NotificationStepDataMetadata$Outbound =
+  | DelayScheduledMetadata$Outbound
+  | DelayRegularMetadata$Outbound
+  | DigestTimedMetadata$Outbound
+  | DigestRegularMetadata$Outbound;
+
+/** @internal */
+export const NotificationStepDataMetadata$outboundSchema: z.ZodType<
+  NotificationStepDataMetadata$Outbound,
+  z.ZodTypeDef,
+  NotificationStepDataMetadata
+> = z.union([
+  DelayScheduledMetadata$outboundSchema,
+  DelayRegularMetadata$outboundSchema,
+  DigestTimedMetadata$outboundSchema,
+  DigestRegularMetadata$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationStepDataMetadata$ {
+  /** @deprecated use `NotificationStepDataMetadata$inboundSchema` instead. */
+  export const inboundSchema = NotificationStepDataMetadata$inboundSchema;
+  /** @deprecated use `NotificationStepDataMetadata$outboundSchema` instead. */
+  export const outboundSchema = NotificationStepDataMetadata$outboundSchema;
+  /** @deprecated use `NotificationStepDataMetadata$Outbound` instead. */
+  export type Outbound = NotificationStepDataMetadata$Outbound;
+}
+
+export function notificationStepDataMetadataToJSON(
+  notificationStepDataMetadata: NotificationStepDataMetadata,
+): string {
+  return JSON.stringify(
+    NotificationStepDataMetadata$outboundSchema.parse(
+      notificationStepDataMetadata,
+    ),
+  );
+}
+
+export function notificationStepDataMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationStepDataMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationStepDataMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationStepDataMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const NotificationStepData$inboundSchema: z.ZodType<
+  NotificationStepData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  uuid: z.string().optional(),
+  name: z.string().optional(),
+  _templateId: z.string().optional(),
+  active: z.boolean().optional(),
+  shouldStopOnFail: z.boolean().optional(),
+  template: MessageTemplate$inboundSchema.optional(),
+  filters: z.array(StepFilterDto$inboundSchema).optional(),
+  _parentId: z.string().optional(),
+  metadata: z.union([
+    DelayScheduledMetadata$inboundSchema,
+    DelayRegularMetadata$inboundSchema,
+    DigestTimedMetadata$inboundSchema,
+    DigestRegularMetadata$inboundSchema,
+  ]).optional(),
+  replyCallback: ReplyCallback$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_templateId": "templateId",
+    "_parentId": "parentId",
+  });
+});
+
+/** @internal */
+export type NotificationStepData$Outbound = {
+  _id?: string | undefined;
+  uuid?: string | undefined;
+  name?: string | undefined;
+  _templateId?: string | undefined;
+  active?: boolean | undefined;
+  shouldStopOnFail?: boolean | undefined;
+  template?: MessageTemplate$Outbound | undefined;
+  filters?: Array<StepFilterDto$Outbound> | undefined;
+  _parentId?: string | undefined;
+  metadata?:
+    | DelayScheduledMetadata$Outbound
+    | DelayRegularMetadata$Outbound
+    | DigestTimedMetadata$Outbound
+    | DigestRegularMetadata$Outbound
+    | undefined;
+  replyCallback?: ReplyCallback$Outbound | undefined;
+};
+
+/** @internal */
+export const NotificationStepData$outboundSchema: z.ZodType<
+  NotificationStepData$Outbound,
+  z.ZodTypeDef,
+  NotificationStepData
+> = z.object({
+  id: z.string().optional(),
+  uuid: z.string().optional(),
+  name: z.string().optional(),
+  templateId: z.string().optional(),
+  active: z.boolean().optional(),
+  shouldStopOnFail: z.boolean().optional(),
+  template: MessageTemplate$outboundSchema.optional(),
+  filters: z.array(StepFilterDto$outboundSchema).optional(),
+  parentId: z.string().optional(),
+  metadata: z.union([
+    DelayScheduledMetadata$outboundSchema,
+    DelayRegularMetadata$outboundSchema,
+    DigestTimedMetadata$outboundSchema,
+    DigestRegularMetadata$outboundSchema,
+  ]).optional(),
+  replyCallback: ReplyCallback$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    templateId: "_templateId",
+    parentId: "_parentId",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationStepData$ {
+  /** @deprecated use `NotificationStepData$inboundSchema` instead. */
+  export const inboundSchema = NotificationStepData$inboundSchema;
+  /** @deprecated use `NotificationStepData$outboundSchema` instead. */
+  export const outboundSchema = NotificationStepData$outboundSchema;
+  /** @deprecated use `NotificationStepData$Outbound` instead. */
+  export type Outbound = NotificationStepData$Outbound;
+}
+
+export function notificationStepDataToJSON(
+  notificationStepData: NotificationStepData,
+): string {
+  return JSON.stringify(
+    NotificationStepData$outboundSchema.parse(notificationStepData),
+  );
+}
+
+export function notificationStepDataFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationStepData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationStepData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationStepData' from JSON`,
+  );
+}

package/src/models/components/notificationstepdto.ts

@@ -0,0 +1,297 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+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 {
+  DelayRegularMetadata,
+  DelayRegularMetadata$inboundSchema,
+  DelayRegularMetadata$Outbound,
+  DelayRegularMetadata$outboundSchema,
+} from "./delayregularmetadata.js";
+import {
+  DelayScheduledMetadata,
+  DelayScheduledMetadata$inboundSchema,
+  DelayScheduledMetadata$Outbound,
+  DelayScheduledMetadata$outboundSchema,
+} from "./delayscheduledmetadata.js";
+import {
+  DigestRegularMetadata,
+  DigestRegularMetadata$inboundSchema,
+  DigestRegularMetadata$Outbound,
+  DigestRegularMetadata$outboundSchema,
+} from "./digestregularmetadata.js";
+import {
+  DigestTimedMetadata,
+  DigestTimedMetadata$inboundSchema,
+  DigestTimedMetadata$Outbound,
+  DigestTimedMetadata$outboundSchema,
+} from "./digesttimedmetadata.js";
+import {
+  MessageTemplate,
+  MessageTemplate$inboundSchema,
+  MessageTemplate$Outbound,
+  MessageTemplate$outboundSchema,
+} from "./messagetemplate.js";
+import {
+  NotificationStepData,
+  NotificationStepData$inboundSchema,
+  NotificationStepData$Outbound,
+  NotificationStepData$outboundSchema,
+} from "./notificationstepdata.js";
+import {
+  ReplyCallback,
+  ReplyCallback$inboundSchema,
+  ReplyCallback$Outbound,
+  ReplyCallback$outboundSchema,
+} from "./replycallback.js";
+import {
+  StepFilterDto,
+  StepFilterDto$inboundSchema,
+  StepFilterDto$Outbound,
+  StepFilterDto$outboundSchema,
+} from "./stepfilterdto.js";
+
+/**
+ * Metadata associated with the workflow step. Can vary based on the type of step.
+ */
+export type NotificationStepDtoMetadata =
+  | DelayScheduledMetadata
+  | DelayRegularMetadata
+  | DigestTimedMetadata
+  | DigestRegularMetadata;
+
+export type NotificationStepDto = {
+  /**
+   * Unique identifier for the notification step.
+   */
+  id?: string | undefined;
+  /**
+   * Universally unique identifier for the notification step.
+   */
+  uuid?: string | undefined;
+  /**
+   * Name of the notification step.
+   */
+  name?: string | undefined;
+  /**
+   * ID of the template associated with this notification step.
+   */
+  templateId?: string | undefined;
+  /**
+   * Indicates whether the notification step is active.
+   */
+  active?: boolean | undefined;
+  /**
+   * Determines if the process should stop on failure.
+   */
+  shouldStopOnFail?: boolean | undefined;
+  /**
+   * Message template used in this notification step.
+   */
+  template?: MessageTemplate | undefined;
+  /**
+   * Filters applied to this notification step.
+   */
+  filters?: Array<StepFilterDto> | undefined;
+  /**
+   * ID of the parent notification step, if applicable.
+   */
+  parentId?: string | undefined;
+  /**
+   * Metadata associated with the workflow step. Can vary based on the type of step.
+   */
+  metadata?:
+    | DelayScheduledMetadata
+    | DelayRegularMetadata
+    | DigestTimedMetadata
+    | DigestRegularMetadata
+    | undefined;
+  /**
+   * Callback information for replies, including whether it is active and the callback URL.
+   */
+  replyCallback?: ReplyCallback | undefined;
+  variants?: Array<NotificationStepData> | undefined;
+};
+
+/** @internal */
+export const NotificationStepDtoMetadata$inboundSchema: z.ZodType<
+  NotificationStepDtoMetadata,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  DelayScheduledMetadata$inboundSchema,
+  DelayRegularMetadata$inboundSchema,
+  DigestTimedMetadata$inboundSchema,
+  DigestRegularMetadata$inboundSchema,
+]);
+
+/** @internal */
+export type NotificationStepDtoMetadata$Outbound =
+  | DelayScheduledMetadata$Outbound
+  | DelayRegularMetadata$Outbound
+  | DigestTimedMetadata$Outbound
+  | DigestRegularMetadata$Outbound;
+
+/** @internal */
+export const NotificationStepDtoMetadata$outboundSchema: z.ZodType<
+  NotificationStepDtoMetadata$Outbound,
+  z.ZodTypeDef,
+  NotificationStepDtoMetadata
+> = z.union([
+  DelayScheduledMetadata$outboundSchema,
+  DelayRegularMetadata$outboundSchema,
+  DigestTimedMetadata$outboundSchema,
+  DigestRegularMetadata$outboundSchema,
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationStepDtoMetadata$ {
+  /** @deprecated use `NotificationStepDtoMetadata$inboundSchema` instead. */
+  export const inboundSchema = NotificationStepDtoMetadata$inboundSchema;
+  /** @deprecated use `NotificationStepDtoMetadata$outboundSchema` instead. */
+  export const outboundSchema = NotificationStepDtoMetadata$outboundSchema;
+  /** @deprecated use `NotificationStepDtoMetadata$Outbound` instead. */
+  export type Outbound = NotificationStepDtoMetadata$Outbound;
+}
+
+export function notificationStepDtoMetadataToJSON(
+  notificationStepDtoMetadata: NotificationStepDtoMetadata,
+): string {
+  return JSON.stringify(
+    NotificationStepDtoMetadata$outboundSchema.parse(
+      notificationStepDtoMetadata,
+    ),
+  );
+}
+
+export function notificationStepDtoMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationStepDtoMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationStepDtoMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationStepDtoMetadata' from JSON`,
+  );
+}
+
+/** @internal */
+export const NotificationStepDto$inboundSchema: z.ZodType<
+  NotificationStepDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  uuid: z.string().optional(),
+  name: z.string().optional(),
+  _templateId: z.string().optional(),
+  active: z.boolean().optional(),
+  shouldStopOnFail: z.boolean().optional(),
+  template: MessageTemplate$inboundSchema.optional(),
+  filters: z.array(StepFilterDto$inboundSchema).optional(),
+  _parentId: z.string().optional(),
+  metadata: z.union([
+    DelayScheduledMetadata$inboundSchema,
+    DelayRegularMetadata$inboundSchema,
+    DigestTimedMetadata$inboundSchema,
+    DigestRegularMetadata$inboundSchema,
+  ]).optional(),
+  replyCallback: ReplyCallback$inboundSchema.optional(),
+  variants: z.array(NotificationStepData$inboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_templateId": "templateId",
+    "_parentId": "parentId",
+  });
+});
+
+/** @internal */
+export type NotificationStepDto$Outbound = {
+  _id?: string | undefined;
+  uuid?: string | undefined;
+  name?: string | undefined;
+  _templateId?: string | undefined;
+  active?: boolean | undefined;
+  shouldStopOnFail?: boolean | undefined;
+  template?: MessageTemplate$Outbound | undefined;
+  filters?: Array<StepFilterDto$Outbound> | undefined;
+  _parentId?: string | undefined;
+  metadata?:
+    | DelayScheduledMetadata$Outbound
+    | DelayRegularMetadata$Outbound
+    | DigestTimedMetadata$Outbound
+    | DigestRegularMetadata$Outbound
+    | undefined;
+  replyCallback?: ReplyCallback$Outbound | undefined;
+  variants?: Array<NotificationStepData$Outbound> | undefined;
+};
+
+/** @internal */
+export const NotificationStepDto$outboundSchema: z.ZodType<
+  NotificationStepDto$Outbound,
+  z.ZodTypeDef,
+  NotificationStepDto
+> = z.object({
+  id: z.string().optional(),
+  uuid: z.string().optional(),
+  name: z.string().optional(),
+  templateId: z.string().optional(),
+  active: z.boolean().optional(),
+  shouldStopOnFail: z.boolean().optional(),
+  template: MessageTemplate$outboundSchema.optional(),
+  filters: z.array(StepFilterDto$outboundSchema).optional(),
+  parentId: z.string().optional(),
+  metadata: z.union([
+    DelayScheduledMetadata$outboundSchema,
+    DelayRegularMetadata$outboundSchema,
+    DigestTimedMetadata$outboundSchema,
+    DigestRegularMetadata$outboundSchema,
+  ]).optional(),
+  replyCallback: ReplyCallback$outboundSchema.optional(),
+  variants: z.array(NotificationStepData$outboundSchema).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    templateId: "_templateId",
+    parentId: "_parentId",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationStepDto$ {
+  /** @deprecated use `NotificationStepDto$inboundSchema` instead. */
+  export const inboundSchema = NotificationStepDto$inboundSchema;
+  /** @deprecated use `NotificationStepDto$outboundSchema` instead. */
+  export const outboundSchema = NotificationStepDto$outboundSchema;
+  /** @deprecated use `NotificationStepDto$Outbound` instead. */
+  export type Outbound = NotificationStepDto$Outbound;
+}
+
+export function notificationStepDtoToJSON(
+  notificationStepDto: NotificationStepDto,
+): string {
+  return JSON.stringify(
+    NotificationStepDto$outboundSchema.parse(notificationStepDto),
+  );
+}
+
+export function notificationStepDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationStepDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationStepDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationStepDto' from JSON`,
+  );
+}

package/src/models/components/notificationtrigger.ts

@@ -14,54 +14,39 @@ import {
   NotificationTriggerVariable$outboundSchema,
 } from "./notificationtriggervariable.js";
 
-/**
- * Type of the trigger
- */
-export const Type = {
+export const NotificationTriggerType = {
   Event: "event",
 } as const;
-/**
- * Type of the trigger
- */
-export type Type = ClosedEnum<typeof Type>;
+export type NotificationTriggerType = ClosedEnum<
+  typeof NotificationTriggerType
+>;
 
 export type NotificationTrigger = {
-  /**
-   * Type of the trigger
-   */
-  type: Type;
-  /**
-   * Identifier of the trigger
-   */
+  type: NotificationTriggerType;
   identifier: string;
-  /**
-   * Variables of the trigger
-   */
   variables: Array<NotificationTriggerVariable>;
-  /**
-   * Subscriber variables of the trigger
-   */
   subscriberVariables?: Array<NotificationTriggerVariable> | undefined;
 };
 
 /** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
+export const NotificationTriggerType$inboundSchema: z.ZodNativeEnum<
+  typeof NotificationTriggerType
+> = z.nativeEnum(NotificationTriggerType);
 
 /** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
+export const NotificationTriggerType$outboundSchema: z.ZodNativeEnum<
+  typeof NotificationTriggerType
+> = NotificationTriggerType$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Type$ {
-  /** @deprecated use `Type$inboundSchema` instead. */
-  export const inboundSchema = Type$inboundSchema;
-  /** @deprecated use `Type$outboundSchema` instead. */
-  export const outboundSchema = Type$outboundSchema;
+export namespace NotificationTriggerType$ {
+  /** @deprecated use `NotificationTriggerType$inboundSchema` instead. */
+  export const inboundSchema = NotificationTriggerType$inboundSchema;
+  /** @deprecated use `NotificationTriggerType$outboundSchema` instead. */
+  export const outboundSchema = NotificationTriggerType$outboundSchema;
 }
 
 /** @internal */
@@ -70,7 +55,7 @@ export const NotificationTrigger$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: Type$inboundSchema,
+  type: NotificationTriggerType$inboundSchema,
   identifier: z.string(),
   variables: z.array(NotificationTriggerVariable$inboundSchema),
   subscriberVariables: z.array(NotificationTriggerVariable$inboundSchema)
@@ -91,7 +76,7 @@ export const NotificationTrigger$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   NotificationTrigger
 > = z.object({
-  type: Type$outboundSchema,
+  type: NotificationTriggerType$outboundSchema,
   identifier: z.string(),
   variables: z.array(NotificationTriggerVariable$outboundSchema),
   subscriberVariables: z.array(NotificationTriggerVariable$outboundSchema)