@novu/api 3.14.1 → 3.14.2-rc.1

package/src/models/components/digestregularoutput.ts

@@ -0,0 +1,72 @@
+/*
+ * 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 { TimeUnitEnum, TimeUnitEnum$inboundSchema } from "./timeunitenum.js";
+
+/**
+ * Look back window configuration
+ */
+export type LookBackWindow = {};
+
+export type DigestRegularOutput = {
+  /**
+   * Amount of time units
+   */
+  amount: number;
+  /**
+   * Time unit
+   */
+  unit: TimeUnitEnum;
+  /**
+   * Optional digest key
+   */
+  digestKey?: string | undefined;
+  /**
+   * Look back window configuration
+   */
+  lookBackWindow?: LookBackWindow | undefined;
+};
+
+/** @internal */
+export const LookBackWindow$inboundSchema: z.ZodType<
+  LookBackWindow,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+export function lookBackWindowFromJSON(
+  jsonString: string,
+): SafeParseResult<LookBackWindow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => LookBackWindow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'LookBackWindow' from JSON`,
+  );
+}
+
+/** @internal */
+export const DigestRegularOutput$inboundSchema: z.ZodType<
+  DigestRegularOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  amount: z.number(),
+  unit: TimeUnitEnum$inboundSchema,
+  digestKey: z.string().optional(),
+  lookBackWindow: z.lazy(() => LookBackWindow$inboundSchema).optional(),
+});
+
+export function digestRegularOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<DigestRegularOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DigestRegularOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DigestRegularOutput' from JSON`,
+  );
+}

package/src/models/components/emailcontroldto.ts

@@ -22,18 +22,6 @@ export type EmailControlDtoEditorType = ClosedEnum<
   typeof EmailControlDtoEditorType
 >;
 
-/**
- * Type of renderer to use (raw HTML or React Email step resolver)
- */
-export const RendererType = {
-  Html: "html",
-  ReactEmail: "react-email",
-} as const;
-/**
- * Type of renderer to use (raw HTML or React Email step resolver)
- */
-export type RendererType = ClosedEnum<typeof RendererType>;
-
 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.
@@ -51,10 +39,6 @@ export type EmailControlDto = {
    * Type of editor to use for the body.
    */
   editorType?: EmailControlDtoEditorType | undefined;
-  /**
-   * Type of renderer to use (raw HTML or React Email step resolver)
-   */
-  rendererType?: RendererType | undefined;
   /**
    * Disable sanitization of the output.
    */
@@ -74,13 +58,6 @@ export const EmailControlDtoEditorType$outboundSchema: z.ZodNativeEnum<
   typeof EmailControlDtoEditorType
 > = EmailControlDtoEditorType$inboundSchema;
 
-/** @internal */
-export const RendererType$inboundSchema: z.ZodNativeEnum<typeof RendererType> =
-  z.nativeEnum(RendererType);
-/** @internal */
-export const RendererType$outboundSchema: z.ZodNativeEnum<typeof RendererType> =
-  RendererType$inboundSchema;
-
 /** @internal */
 export const EmailControlDto$inboundSchema: z.ZodType<
   EmailControlDto,
@@ -91,7 +68,6 @@ export const EmailControlDto$inboundSchema: z.ZodType<
   subject: z.string(),
   body: z.string().default(""),
   editorType: EmailControlDtoEditorType$inboundSchema.default("block"),
-  rendererType: RendererType$inboundSchema.default("html"),
   disableOutputSanitization: z.boolean().default(false),
   layoutId: z.nullable(z.string()).optional(),
 });
@@ -101,7 +77,6 @@ export type EmailControlDto$Outbound = {
   subject: string;
   body: string;
   editorType: string;
-  rendererType: string;
   disableOutputSanitization: boolean;
   layoutId?: string | null | undefined;
 };
@@ -116,7 +91,6 @@ export const EmailControlDto$outboundSchema: z.ZodType<
   subject: z.string(),
   body: z.string().default(""),
   editorType: EmailControlDtoEditorType$outboundSchema.default("block"),
-  rendererType: RendererType$outboundSchema.default("html"),
   disableOutputSanitization: z.boolean().default(false),
   layoutId: z.nullable(z.string()).optional(),
 });

package/src/models/components/emailrenderoutput.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 EmailRenderOutput = {
+  /**
+   * Subject of the email
+   */
+  subject: string;
+  /**
+   * Body of the email
+   */
+  body: string;
+};
+
+/** @internal */
+export const EmailRenderOutput$inboundSchema: z.ZodType<
+  EmailRenderOutput,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  subject: z.string(),
+  body: z.string(),
+});
+
+export function emailRenderOutputFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailRenderOutput, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailRenderOutput$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailRenderOutput' from JSON`,
+  );
+}

package/src/models/components/emailstepresponsedto.ts

@@ -35,20 +35,6 @@ export type EmailStepResponseDtoEditorType = ClosedEnum<
   typeof EmailStepResponseDtoEditorType
 >;
 
-/**
- * Type of renderer to use (raw HTML or React Email step resolver)
- */
-export const EmailStepResponseDtoRendererType = {
-  Html: "html",
-  ReactEmail: "react-email",
-} as const;
-/**
- * Type of renderer to use (raw HTML or React Email step resolver)
- */
-export type EmailStepResponseDtoRendererType = ClosedEnum<
-  typeof EmailStepResponseDtoRendererType
->;
-
 /**
  * Control values for the email step
  */
@@ -69,10 +55,6 @@ export type EmailStepResponseDtoControlValues = {
    * Type of editor to use for the body.
    */
   editorType: EmailStepResponseDtoEditorType;
-  /**
-   * Type of renderer to use (raw HTML or React Email step resolver)
-   */
-  rendererType: EmailStepResponseDtoRendererType;
   /**
    * Disable sanitization of the output.
    */
@@ -144,11 +126,6 @@ export const EmailStepResponseDtoEditorType$inboundSchema: z.ZodNativeEnum<
   typeof EmailStepResponseDtoEditorType
 > = z.nativeEnum(EmailStepResponseDtoEditorType);
 
-/** @internal */
-export const EmailStepResponseDtoRendererType$inboundSchema: z.ZodNativeEnum<
-  typeof EmailStepResponseDtoRendererType
-> = z.nativeEnum(EmailStepResponseDtoRendererType);
-
 /** @internal */
 export const EmailStepResponseDtoControlValues$inboundSchema: z.ZodType<
   EmailStepResponseDtoControlValues,
@@ -160,9 +137,6 @@ export const EmailStepResponseDtoControlValues$inboundSchema: z.ZodType<
     subject: z.string(),
     body: z.string().default(""),
     editorType: EmailStepResponseDtoEditorType$inboundSchema.default("block"),
-    rendererType: EmailStepResponseDtoRendererType$inboundSchema.default(
-      "html",
-    ),
     disableOutputSanitization: z.boolean().default(false),
     layoutId: z.nullable(z.string()).optional(),
   }).catchall(z.any()),

package/src/models/components/environmentvariableresponsedto.ts

@@ -0,0 +1,68 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  EnvironmentVariableValueResponseDto,
+  EnvironmentVariableValueResponseDto$inboundSchema,
+} from "./environmentvariablevalueresponsedto.js";
+
+export const EnvironmentVariableResponseDtoType = {
+  String: "string",
+} as const;
+export type EnvironmentVariableResponseDtoType = ClosedEnum<
+  typeof EnvironmentVariableResponseDtoType
+>;
+
+export type EnvironmentVariableResponseDto = {
+  id: string;
+  organizationId: string;
+  key: string;
+  type: EnvironmentVariableResponseDtoType;
+  isSecret: boolean;
+  values: Array<EnvironmentVariableValueResponseDto>;
+  createdAt: string;
+  updatedAt: string;
+};
+
+/** @internal */
+export const EnvironmentVariableResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof EnvironmentVariableResponseDtoType
+> = z.nativeEnum(EnvironmentVariableResponseDtoType);
+
+/** @internal */
+export const EnvironmentVariableResponseDto$inboundSchema: z.ZodType<
+  EnvironmentVariableResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  _organizationId: z.string(),
+  key: z.string(),
+  type: EnvironmentVariableResponseDtoType$inboundSchema,
+  isSecret: z.boolean(),
+  values: z.array(EnvironmentVariableValueResponseDto$inboundSchema),
+  createdAt: z.string(),
+  updatedAt: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_organizationId": "organizationId",
+  });
+});
+
+export function environmentVariableResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvironmentVariableResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EnvironmentVariableResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvironmentVariableResponseDto' from JSON`,
+  );
+}

package/src/models/components/environmentvariablevaluedto.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { remap as remap$ } from "../../lib/primitives.js";
+
+export type EnvironmentVariableValueDto = {
+  environmentId: string;
+  value: string;
+};
+
+/** @internal */
+export type EnvironmentVariableValueDto$Outbound = {
+  _environmentId: string;
+  value: string;
+};
+
+/** @internal */
+export const EnvironmentVariableValueDto$outboundSchema: z.ZodType<
+  EnvironmentVariableValueDto$Outbound,
+  z.ZodTypeDef,
+  EnvironmentVariableValueDto
+> = z.object({
+  environmentId: z.string(),
+  value: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    environmentId: "_environmentId",
+  });
+});
+
+export function environmentVariableValueDtoToJSON(
+  environmentVariableValueDto: EnvironmentVariableValueDto,
+): string {
+  return JSON.stringify(
+    EnvironmentVariableValueDto$outboundSchema.parse(
+      environmentVariableValueDto,
+    ),
+  );
+}

package/src/models/components/environmentvariablevalueresponsedto.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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";
+
+export type EnvironmentVariableValueResponseDto = {
+  environmentId: string;
+  /**
+   * Value is masked (••••••••) for secret variables
+   */
+  value: string;
+};
+
+/** @internal */
+export const EnvironmentVariableValueResponseDto$inboundSchema: z.ZodType<
+  EnvironmentVariableValueResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _environmentId: z.string(),
+  value: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_environmentId": "environmentId",
+  });
+});
+
+export function environmentVariableValueResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvironmentVariableValueResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentVariableValueResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvironmentVariableValueResponseDto' from JSON`,
+  );
+}

package/src/models/components/environmentvariableworkflowinfodto.ts

@@ -0,0 +1,40 @@
+/*
+ * 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 EnvironmentVariableWorkflowInfoDto = {
+  /**
+   * The name of the workflow
+   */
+  name: string;
+  /**
+   * The unique identifier of the workflow
+   */
+  workflowId: string;
+};
+
+/** @internal */
+export const EnvironmentVariableWorkflowInfoDto$inboundSchema: z.ZodType<
+  EnvironmentVariableWorkflowInfoDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+  workflowId: z.string(),
+});
+
+export function environmentVariableWorkflowInfoDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvironmentVariableWorkflowInfoDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      EnvironmentVariableWorkflowInfoDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvironmentVariableWorkflowInfoDto' from JSON`,
+  );
+}

package/src/models/components/generatepreviewrequestdto.ts

@@ -0,0 +1,45 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  PreviewPayloadDto,
+  PreviewPayloadDto$Outbound,
+  PreviewPayloadDto$outboundSchema,
+} from "./previewpayloaddto.js";
+
+export type GeneratePreviewRequestDto = {
+  /**
+   * Optional control values
+   */
+  controlValues?: { [k: string]: any } | undefined;
+  /**
+   * Optional payload for preview generation
+   */
+  previewPayload?: PreviewPayloadDto | undefined;
+};
+
+/** @internal */
+export type GeneratePreviewRequestDto$Outbound = {
+  controlValues?: { [k: string]: any } | undefined;
+  previewPayload?: PreviewPayloadDto$Outbound | undefined;
+};
+
+/** @internal */
+export const GeneratePreviewRequestDto$outboundSchema: z.ZodType<
+  GeneratePreviewRequestDto$Outbound,
+  z.ZodTypeDef,
+  GeneratePreviewRequestDto
+> = z.object({
+  controlValues: z.record(z.any()).optional(),
+  previewPayload: PreviewPayloadDto$outboundSchema.optional(),
+});
+
+export function generatePreviewRequestDtoToJSON(
+  generatePreviewRequestDto: GeneratePreviewRequestDto,
+): string {
+  return JSON.stringify(
+    GeneratePreviewRequestDto$outboundSchema.parse(generatePreviewRequestDto),
+  );
+}