@novu/api 1.2.0 → 1.4.0

package/src/models/components/digeststepupsertdto.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 { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  LookBackWindowDto,
+  LookBackWindowDto$inboundSchema,
+  LookBackWindowDto$Outbound,
+  LookBackWindowDto$outboundSchema,
+} from "./lookbackwindowdto.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+
+/**
+ * The type of digest strategy. Determines which fields are applicable.
+ */
+export const DigestStepUpsertDtoType = {
+  Regular: "regular",
+  Timed: "timed",
+} as const;
+/**
+ * The type of digest strategy. Determines which fields are applicable.
+ */
+export type DigestStepUpsertDtoType = ClosedEnum<
+  typeof DigestStepUpsertDtoType
+>;
+
+/**
+ * The unit of time for the digest interval (for REGULAR type).
+ */
+export const DigestStepUpsertDtoUnit = {
+  Seconds: "seconds",
+  Minutes: "minutes",
+  Hours: "hours",
+  Days: "days",
+  Weeks: "weeks",
+  Months: "months",
+} as const;
+/**
+ * The unit of time for the digest interval (for REGULAR type).
+ */
+export type DigestStepUpsertDtoUnit = ClosedEnum<
+  typeof DigestStepUpsertDtoUnit
+>;
+
+/**
+ * Control values for the Digest step
+ */
+export type DigestStepUpsertDtoControlValues = {
+  /**
+   * 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;
+  /**
+   * The type of digest strategy. Determines which fields are applicable.
+   */
+  type?: DigestStepUpsertDtoType | undefined;
+  /**
+   * The amount of time for the digest interval (for REGULAR type). Min 1.
+   */
+  amount?: number | undefined;
+  /**
+   * The unit of time for the digest interval (for REGULAR type).
+   */
+  unit?: DigestStepUpsertDtoUnit | undefined;
+  /**
+   * Configuration for look-back window (for REGULAR type).
+   */
+  lookBackWindow?: LookBackWindowDto | undefined;
+  /**
+   * Cron expression for TIMED digest. Min length 1.
+   */
+  cron?: string | undefined;
+  /**
+   * Specify a custom key for digesting events instead of the default event key.
+   */
+  digestKey?: string | undefined;
+};
+
+export type DigestStepUpsertDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Control values for the Digest step
+   */
+  controlValues?: DigestStepUpsertDtoControlValues | null | undefined;
+};
+
+/** @internal */
+export const DigestStepUpsertDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof DigestStepUpsertDtoType
+> = z.nativeEnum(DigestStepUpsertDtoType);
+
+/** @internal */
+export const DigestStepUpsertDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof DigestStepUpsertDtoType
+> = DigestStepUpsertDtoType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DigestStepUpsertDtoType$ {
+  /** @deprecated use `DigestStepUpsertDtoType$inboundSchema` instead. */
+  export const inboundSchema = DigestStepUpsertDtoType$inboundSchema;
+  /** @deprecated use `DigestStepUpsertDtoType$outboundSchema` instead. */
+  export const outboundSchema = DigestStepUpsertDtoType$outboundSchema;
+}
+
+/** @internal */
+export const DigestStepUpsertDtoUnit$inboundSchema: z.ZodNativeEnum<
+  typeof DigestStepUpsertDtoUnit
+> = z.nativeEnum(DigestStepUpsertDtoUnit);
+
+/** @internal */
+export const DigestStepUpsertDtoUnit$outboundSchema: z.ZodNativeEnum<
+  typeof DigestStepUpsertDtoUnit
+> = DigestStepUpsertDtoUnit$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DigestStepUpsertDtoUnit$ {
+  /** @deprecated use `DigestStepUpsertDtoUnit$inboundSchema` instead. */
+  export const inboundSchema = DigestStepUpsertDtoUnit$inboundSchema;
+  /** @deprecated use `DigestStepUpsertDtoUnit$outboundSchema` instead. */
+  export const outboundSchema = DigestStepUpsertDtoUnit$outboundSchema;
+}
+
+/** @internal */
+export const DigestStepUpsertDtoControlValues$inboundSchema: z.ZodType<
+  DigestStepUpsertDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  type: DigestStepUpsertDtoType$inboundSchema.optional(),
+  amount: z.number().optional(),
+  unit: DigestStepUpsertDtoUnit$inboundSchema.optional(),
+  lookBackWindow: LookBackWindowDto$inboundSchema.optional(),
+  cron: z.string().optional(),
+  digestKey: z.string().optional(),
+});
+
+/** @internal */
+export type DigestStepUpsertDtoControlValues$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  type?: string | undefined;
+  amount?: number | undefined;
+  unit?: string | undefined;
+  lookBackWindow?: LookBackWindowDto$Outbound | undefined;
+  cron?: string | undefined;
+  digestKey?: string | undefined;
+};
+
+/** @internal */
+export const DigestStepUpsertDtoControlValues$outboundSchema: z.ZodType<
+  DigestStepUpsertDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  DigestStepUpsertDtoControlValues
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  type: DigestStepUpsertDtoType$outboundSchema.optional(),
+  amount: z.number().optional(),
+  unit: DigestStepUpsertDtoUnit$outboundSchema.optional(),
+  lookBackWindow: LookBackWindowDto$outboundSchema.optional(),
+  cron: z.string().optional(),
+  digestKey: z.string().optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DigestStepUpsertDtoControlValues$ {
+  /** @deprecated use `DigestStepUpsertDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = DigestStepUpsertDtoControlValues$inboundSchema;
+  /** @deprecated use `DigestStepUpsertDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = DigestStepUpsertDtoControlValues$outboundSchema;
+  /** @deprecated use `DigestStepUpsertDtoControlValues$Outbound` instead. */
+  export type Outbound = DigestStepUpsertDtoControlValues$Outbound;
+}
+
+export function digestStepUpsertDtoControlValuesToJSON(
+  digestStepUpsertDtoControlValues: DigestStepUpsertDtoControlValues,
+): string {
+  return JSON.stringify(
+    DigestStepUpsertDtoControlValues$outboundSchema.parse(
+      digestStepUpsertDtoControlValues,
+    ),
+  );
+}
+
+export function digestStepUpsertDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<DigestStepUpsertDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DigestStepUpsertDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DigestStepUpsertDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const DigestStepUpsertDto$inboundSchema: z.ZodType<
+  DigestStepUpsertDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  controlValues: z.nullable(
+    z.lazy(() => DigestStepUpsertDtoControlValues$inboundSchema),
+  ).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type DigestStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  name: string;
+  type: string;
+  controlValues?: DigestStepUpsertDtoControlValues$Outbound | null | undefined;
+};
+
+/** @internal */
+export const DigestStepUpsertDto$outboundSchema: z.ZodType<
+  DigestStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  DigestStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  controlValues: z.nullable(
+    z.lazy(() => DigestStepUpsertDtoControlValues$outboundSchema),
+  ).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 DigestStepUpsertDto$ {
+  /** @deprecated use `DigestStepUpsertDto$inboundSchema` instead. */
+  export const inboundSchema = DigestStepUpsertDto$inboundSchema;
+  /** @deprecated use `DigestStepUpsertDto$outboundSchema` instead. */
+  export const outboundSchema = DigestStepUpsertDto$outboundSchema;
+  /** @deprecated use `DigestStepUpsertDto$Outbound` instead. */
+  export type Outbound = DigestStepUpsertDto$Outbound;
+}
+
+export function digestStepUpsertDtoToJSON(
+  digestStepUpsertDto: DigestStepUpsertDto,
+): string {
+  return JSON.stringify(
+    DigestStepUpsertDto$outboundSchema.parse(digestStepUpsertDto),
+  );
+}
+
+export function digestStepUpsertDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DigestStepUpsertDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DigestStepUpsertDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DigestStepUpsertDto' from JSON`,
+  );
+}

package/src/models/components/directionenum.ts

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

package/src/models/components/emailcontroldto.ts

@@ -0,0 +1,127 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { ClosedEnum } from "../../types/enums.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+
+/**
+ * Type of editor to use for the body.
+ */
+export const EditorType = {
+  Block: "block",
+  Html: "html",
+} as const;
+/**
+ * Type of editor to use for the body.
+ */
+export type EditorType = ClosedEnum<typeof EditorType>;
+
+export type EmailControlDto = {
+  /**
+   * 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;
+  /**
+   * Subject of the email.
+   */
+  subject: string;
+  /**
+   * Body content of the email, either a valid Maily JSON object, or html string.
+   */
+  body?: string | undefined;
+  /**
+   * Type of editor to use for the body.
+   */
+  editorType?: EditorType | undefined;
+  /**
+   * Disable sanitization of the output.
+   */
+  disableOutputSanitization?: boolean | undefined;
+};
+
+/** @internal */
+export const EditorType$inboundSchema: z.ZodNativeEnum<typeof EditorType> = z
+  .nativeEnum(EditorType);
+
+/** @internal */
+export const EditorType$outboundSchema: z.ZodNativeEnum<typeof EditorType> =
+  EditorType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EditorType$ {
+  /** @deprecated use `EditorType$inboundSchema` instead. */
+  export const inboundSchema = EditorType$inboundSchema;
+  /** @deprecated use `EditorType$outboundSchema` instead. */
+  export const outboundSchema = EditorType$outboundSchema;
+}
+
+/** @internal */
+export const EmailControlDto$inboundSchema: z.ZodType<
+  EmailControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  subject: z.string(),
+  body: z.string().default(""),
+  editorType: EditorType$inboundSchema.default("block"),
+  disableOutputSanitization: z.boolean().default(false),
+});
+
+/** @internal */
+export type EmailControlDto$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  subject: string;
+  body: string;
+  editorType: string;
+  disableOutputSanitization: boolean;
+};
+
+/** @internal */
+export const EmailControlDto$outboundSchema: z.ZodType<
+  EmailControlDto$Outbound,
+  z.ZodTypeDef,
+  EmailControlDto
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  subject: z.string(),
+  body: z.string().default(""),
+  editorType: EditorType$outboundSchema.default("block"),
+  disableOutputSanitization: z.boolean().default(false),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EmailControlDto$ {
+  /** @deprecated use `EmailControlDto$inboundSchema` instead. */
+  export const inboundSchema = EmailControlDto$inboundSchema;
+  /** @deprecated use `EmailControlDto$outboundSchema` instead. */
+  export const outboundSchema = EmailControlDto$outboundSchema;
+  /** @deprecated use `EmailControlDto$Outbound` instead. */
+  export type Outbound = EmailControlDto$Outbound;
+}
+
+export function emailControlDtoToJSON(
+  emailControlDto: EmailControlDto,
+): string {
+  return JSON.stringify(EmailControlDto$outboundSchema.parse(emailControlDto));
+}
+
+export function emailControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailControlDto' from JSON`,
+  );
+}

package/src/models/components/emailcontrolsmetadataresponsedto.ts

@@ -0,0 +1,97 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EmailControlDto,
+  EmailControlDto$inboundSchema,
+  EmailControlDto$Outbound,
+  EmailControlDto$outboundSchema,
+} from "./emailcontroldto.js";
+import {
+  UiSchema,
+  UiSchema$inboundSchema,
+  UiSchema$Outbound,
+  UiSchema$outboundSchema,
+} from "./uischema.js";
+
+export type EmailControlsMetadataResponseDto = {
+  /**
+   * JSON Schema for data
+   */
+  dataSchema?: { [k: string]: any } | undefined;
+  /**
+   * UI Schema for rendering
+   */
+  uiSchema?: UiSchema | undefined;
+  /**
+   * Control values specific to Email
+   */
+  values: EmailControlDto;
+};
+
+/** @internal */
+export const EmailControlsMetadataResponseDto$inboundSchema: z.ZodType<
+  EmailControlsMetadataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$inboundSchema.optional(),
+  values: EmailControlDto$inboundSchema,
+});
+
+/** @internal */
+export type EmailControlsMetadataResponseDto$Outbound = {
+  dataSchema?: { [k: string]: any } | undefined;
+  uiSchema?: UiSchema$Outbound | undefined;
+  values: EmailControlDto$Outbound;
+};
+
+/** @internal */
+export const EmailControlsMetadataResponseDto$outboundSchema: z.ZodType<
+  EmailControlsMetadataResponseDto$Outbound,
+  z.ZodTypeDef,
+  EmailControlsMetadataResponseDto
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$outboundSchema.optional(),
+  values: EmailControlDto$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EmailControlsMetadataResponseDto$ {
+  /** @deprecated use `EmailControlsMetadataResponseDto$inboundSchema` instead. */
+  export const inboundSchema = EmailControlsMetadataResponseDto$inboundSchema;
+  /** @deprecated use `EmailControlsMetadataResponseDto$outboundSchema` instead. */
+  export const outboundSchema = EmailControlsMetadataResponseDto$outboundSchema;
+  /** @deprecated use `EmailControlsMetadataResponseDto$Outbound` instead. */
+  export type Outbound = EmailControlsMetadataResponseDto$Outbound;
+}
+
+export function emailControlsMetadataResponseDtoToJSON(
+  emailControlsMetadataResponseDto: EmailControlsMetadataResponseDto,
+): string {
+  return JSON.stringify(
+    EmailControlsMetadataResponseDto$outboundSchema.parse(
+      emailControlsMetadataResponseDto,
+    ),
+  );
+}
+
+export function emailControlsMetadataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailControlsMetadataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailControlsMetadataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailControlsMetadataResponseDto' from JSON`,
+  );
+}