@novu/api 1.6.0 → 1.7.0

package/src/models/components/generatelayoutpreviewresponsedto.ts

@@ -0,0 +1,220 @@
+/*
+ * 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";
+import {
+  EmailLayoutRenderOutput,
+  EmailLayoutRenderOutput$inboundSchema,
+  EmailLayoutRenderOutput$Outbound,
+  EmailLayoutRenderOutput$outboundSchema,
+} from "./emaillayoutrenderoutput.js";
+import {
+  LayoutPreviewPayloadDto,
+  LayoutPreviewPayloadDto$inboundSchema,
+  LayoutPreviewPayloadDto$Outbound,
+  LayoutPreviewPayloadDto$outboundSchema,
+} from "./layoutpreviewpayloaddto.js";
+
+export const ResultType = {
+  Email: "email",
+} as const;
+export type ResultType = ClosedEnum<typeof ResultType>;
+
+export type One = {
+  type?: ResultType | undefined;
+  preview?: EmailLayoutRenderOutput | undefined;
+};
+
+/**
+ * Preview result
+ */
+export type Result = One;
+
+export type GenerateLayoutPreviewResponseDto = {
+  /**
+   * Preview payload example
+   */
+  previewPayloadExample: LayoutPreviewPayloadDto;
+  /**
+   * The payload schema that was used to generate the preview payload example
+   */
+  schema?: { [k: string]: any } | null | undefined;
+  /**
+   * Preview result
+   */
+  result: One;
+};
+
+/** @internal */
+export const ResultType$inboundSchema: z.ZodNativeEnum<typeof ResultType> = z
+  .nativeEnum(ResultType);
+
+/** @internal */
+export const ResultType$outboundSchema: z.ZodNativeEnum<typeof ResultType> =
+  ResultType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ResultType$ {
+  /** @deprecated use `ResultType$inboundSchema` instead. */
+  export const inboundSchema = ResultType$inboundSchema;
+  /** @deprecated use `ResultType$outboundSchema` instead. */
+  export const outboundSchema = ResultType$outboundSchema;
+}
+
+/** @internal */
+export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z
+  .object({
+    type: ResultType$inboundSchema.optional(),
+    preview: EmailLayoutRenderOutput$inboundSchema.optional(),
+  });
+
+/** @internal */
+export type One$Outbound = {
+  type?: string | undefined;
+  preview?: EmailLayoutRenderOutput$Outbound | undefined;
+};
+
+/** @internal */
+export const One$outboundSchema: z.ZodType<One$Outbound, z.ZodTypeDef, One> = z
+  .object({
+    type: ResultType$outboundSchema.optional(),
+    preview: EmailLayoutRenderOutput$outboundSchema.optional(),
+  });
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace One$ {
+  /** @deprecated use `One$inboundSchema` instead. */
+  export const inboundSchema = One$inboundSchema;
+  /** @deprecated use `One$outboundSchema` instead. */
+  export const outboundSchema = One$outboundSchema;
+  /** @deprecated use `One$Outbound` instead. */
+  export type Outbound = One$Outbound;
+}
+
+export function oneToJSON(one: One): string {
+  return JSON.stringify(One$outboundSchema.parse(one));
+}
+
+export function oneFromJSON(
+  jsonString: string,
+): SafeParseResult<One, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => One$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'One' from JSON`,
+  );
+}
+
+/** @internal */
+export const Result$inboundSchema: z.ZodType<Result, z.ZodTypeDef, unknown> = z
+  .lazy(() => One$inboundSchema);
+
+/** @internal */
+export type Result$Outbound = One$Outbound;
+
+/** @internal */
+export const Result$outboundSchema: z.ZodType<
+  Result$Outbound,
+  z.ZodTypeDef,
+  Result
+> = z.lazy(() => One$outboundSchema);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Result$ {
+  /** @deprecated use `Result$inboundSchema` instead. */
+  export const inboundSchema = Result$inboundSchema;
+  /** @deprecated use `Result$outboundSchema` instead. */
+  export const outboundSchema = Result$outboundSchema;
+  /** @deprecated use `Result$Outbound` instead. */
+  export type Outbound = Result$Outbound;
+}
+
+export function resultToJSON(result: Result): string {
+  return JSON.stringify(Result$outboundSchema.parse(result));
+}
+
+export function resultFromJSON(
+  jsonString: string,
+): SafeParseResult<Result, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Result$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Result' from JSON`,
+  );
+}
+
+/** @internal */
+export const GenerateLayoutPreviewResponseDto$inboundSchema: z.ZodType<
+  GenerateLayoutPreviewResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  previewPayloadExample: LayoutPreviewPayloadDto$inboundSchema,
+  schema: z.nullable(z.record(z.any())).optional(),
+  result: z.lazy(() => One$inboundSchema),
+});
+
+/** @internal */
+export type GenerateLayoutPreviewResponseDto$Outbound = {
+  previewPayloadExample: LayoutPreviewPayloadDto$Outbound;
+  schema?: { [k: string]: any } | null | undefined;
+  result: One$Outbound;
+};
+
+/** @internal */
+export const GenerateLayoutPreviewResponseDto$outboundSchema: z.ZodType<
+  GenerateLayoutPreviewResponseDto$Outbound,
+  z.ZodTypeDef,
+  GenerateLayoutPreviewResponseDto
+> = z.object({
+  previewPayloadExample: LayoutPreviewPayloadDto$outboundSchema,
+  schema: z.nullable(z.record(z.any())).optional(),
+  result: z.lazy(() => One$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GenerateLayoutPreviewResponseDto$ {
+  /** @deprecated use `GenerateLayoutPreviewResponseDto$inboundSchema` instead. */
+  export const inboundSchema = GenerateLayoutPreviewResponseDto$inboundSchema;
+  /** @deprecated use `GenerateLayoutPreviewResponseDto$outboundSchema` instead. */
+  export const outboundSchema = GenerateLayoutPreviewResponseDto$outboundSchema;
+  /** @deprecated use `GenerateLayoutPreviewResponseDto$Outbound` instead. */
+  export type Outbound = GenerateLayoutPreviewResponseDto$Outbound;
+}
+
+export function generateLayoutPreviewResponseDtoToJSON(
+  generateLayoutPreviewResponseDto: GenerateLayoutPreviewResponseDto,
+): string {
+  return JSON.stringify(
+    GenerateLayoutPreviewResponseDto$outboundSchema.parse(
+      generateLayoutPreviewResponseDto,
+    ),
+  );
+}
+
+export function generateLayoutPreviewResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GenerateLayoutPreviewResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GenerateLayoutPreviewResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GenerateLayoutPreviewResponseDto' from JSON`,
+  );
+}

package/src/models/components/getlayoutusageresponsedto.ts

@@ -0,0 +1,75 @@
+/*
+ * 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 {
+  WorkflowInfoDto,
+  WorkflowInfoDto$inboundSchema,
+  WorkflowInfoDto$Outbound,
+  WorkflowInfoDto$outboundSchema,
+} from "./workflowinfodto.js";
+
+export type GetLayoutUsageResponseDto = {
+  /**
+   * Array of workflows that use this layout
+   */
+  workflows: Array<WorkflowInfoDto>;
+};
+
+/** @internal */
+export const GetLayoutUsageResponseDto$inboundSchema: z.ZodType<
+  GetLayoutUsageResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  workflows: z.array(WorkflowInfoDto$inboundSchema),
+});
+
+/** @internal */
+export type GetLayoutUsageResponseDto$Outbound = {
+  workflows: Array<WorkflowInfoDto$Outbound>;
+};
+
+/** @internal */
+export const GetLayoutUsageResponseDto$outboundSchema: z.ZodType<
+  GetLayoutUsageResponseDto$Outbound,
+  z.ZodTypeDef,
+  GetLayoutUsageResponseDto
+> = z.object({
+  workflows: z.array(WorkflowInfoDto$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetLayoutUsageResponseDto$ {
+  /** @deprecated use `GetLayoutUsageResponseDto$inboundSchema` instead. */
+  export const inboundSchema = GetLayoutUsageResponseDto$inboundSchema;
+  /** @deprecated use `GetLayoutUsageResponseDto$outboundSchema` instead. */
+  export const outboundSchema = GetLayoutUsageResponseDto$outboundSchema;
+  /** @deprecated use `GetLayoutUsageResponseDto$Outbound` instead. */
+  export type Outbound = GetLayoutUsageResponseDto$Outbound;
+}
+
+export function getLayoutUsageResponseDtoToJSON(
+  getLayoutUsageResponseDto: GetLayoutUsageResponseDto,
+): string {
+  return JSON.stringify(
+    GetLayoutUsageResponseDto$outboundSchema.parse(getLayoutUsageResponseDto),
+  );
+}
+
+export function getLayoutUsageResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetLayoutUsageResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetLayoutUsageResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetLayoutUsageResponseDto' from JSON`,
+  );
+}

package/src/models/components/getmasterjsonresponsedto.ts

@@ -0,0 +1,118 @@
+/*
+ * 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";
+
+/**
+ * All translations for given locale organized by workflow identifier
+ */
+export type Workflows = {};
+
+export type GetMasterJsonResponseDto = {
+  /**
+   * All translations for given locale organized by workflow identifier
+   */
+  workflows: Workflows;
+};
+
+/** @internal */
+export const Workflows$inboundSchema: z.ZodType<
+  Workflows,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type Workflows$Outbound = {};
+
+/** @internal */
+export const Workflows$outboundSchema: z.ZodType<
+  Workflows$Outbound,
+  z.ZodTypeDef,
+  Workflows
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Workflows$ {
+  /** @deprecated use `Workflows$inboundSchema` instead. */
+  export const inboundSchema = Workflows$inboundSchema;
+  /** @deprecated use `Workflows$outboundSchema` instead. */
+  export const outboundSchema = Workflows$outboundSchema;
+  /** @deprecated use `Workflows$Outbound` instead. */
+  export type Outbound = Workflows$Outbound;
+}
+
+export function workflowsToJSON(workflows: Workflows): string {
+  return JSON.stringify(Workflows$outboundSchema.parse(workflows));
+}
+
+export function workflowsFromJSON(
+  jsonString: string,
+): SafeParseResult<Workflows, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Workflows$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Workflows' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetMasterJsonResponseDto$inboundSchema: z.ZodType<
+  GetMasterJsonResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  workflows: z.lazy(() => Workflows$inboundSchema),
+});
+
+/** @internal */
+export type GetMasterJsonResponseDto$Outbound = {
+  workflows: Workflows$Outbound;
+};
+
+/** @internal */
+export const GetMasterJsonResponseDto$outboundSchema: z.ZodType<
+  GetMasterJsonResponseDto$Outbound,
+  z.ZodTypeDef,
+  GetMasterJsonResponseDto
+> = z.object({
+  workflows: z.lazy(() => Workflows$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetMasterJsonResponseDto$ {
+  /** @deprecated use `GetMasterJsonResponseDto$inboundSchema` instead. */
+  export const inboundSchema = GetMasterJsonResponseDto$inboundSchema;
+  /** @deprecated use `GetMasterJsonResponseDto$outboundSchema` instead. */
+  export const outboundSchema = GetMasterJsonResponseDto$outboundSchema;
+  /** @deprecated use `GetMasterJsonResponseDto$Outbound` instead. */
+  export type Outbound = GetMasterJsonResponseDto$Outbound;
+}
+
+export function getMasterJsonResponseDtoToJSON(
+  getMasterJsonResponseDto: GetMasterJsonResponseDto,
+): string {
+  return JSON.stringify(
+    GetMasterJsonResponseDto$outboundSchema.parse(getMasterJsonResponseDto),
+  );
+}
+
+export function getMasterJsonResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetMasterJsonResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetMasterJsonResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetMasterJsonResponseDto' from JSON`,
+  );
+}

package/src/models/components/getpreferencesresponsedto.ts

@@ -57,7 +57,7 @@ export type Workflow = {
    */
   data?: GetPreferencesResponseDtoData | undefined;
   /**
-   * Severity level of the workflow
+   * Severity of the workflow
    */
   severity: SeverityLevelEnum;
 };

package/src/models/components/importmasterjsonrequestdto.ts

@@ -0,0 +1,125 @@
+/*
+ * 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";
+
+/**
+ * Master JSON object containing all translations organized by workflow identifier
+ */
+export type MasterJson = {};
+
+export type ImportMasterJsonRequestDto = {
+  /**
+   * The locale for which translations are being imported
+   */
+  locale: string;
+  /**
+   * Master JSON object containing all translations organized by workflow identifier
+   */
+  masterJson: MasterJson;
+};
+
+/** @internal */
+export const MasterJson$inboundSchema: z.ZodType<
+  MasterJson,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type MasterJson$Outbound = {};
+
+/** @internal */
+export const MasterJson$outboundSchema: z.ZodType<
+  MasterJson$Outbound,
+  z.ZodTypeDef,
+  MasterJson
+> = z.object({});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MasterJson$ {
+  /** @deprecated use `MasterJson$inboundSchema` instead. */
+  export const inboundSchema = MasterJson$inboundSchema;
+  /** @deprecated use `MasterJson$outboundSchema` instead. */
+  export const outboundSchema = MasterJson$outboundSchema;
+  /** @deprecated use `MasterJson$Outbound` instead. */
+  export type Outbound = MasterJson$Outbound;
+}
+
+export function masterJsonToJSON(masterJson: MasterJson): string {
+  return JSON.stringify(MasterJson$outboundSchema.parse(masterJson));
+}
+
+export function masterJsonFromJSON(
+  jsonString: string,
+): SafeParseResult<MasterJson, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MasterJson$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MasterJson' from JSON`,
+  );
+}
+
+/** @internal */
+export const ImportMasterJsonRequestDto$inboundSchema: z.ZodType<
+  ImportMasterJsonRequestDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  locale: z.string(),
+  masterJson: z.lazy(() => MasterJson$inboundSchema),
+});
+
+/** @internal */
+export type ImportMasterJsonRequestDto$Outbound = {
+  locale: string;
+  masterJson: MasterJson$Outbound;
+};
+
+/** @internal */
+export const ImportMasterJsonRequestDto$outboundSchema: z.ZodType<
+  ImportMasterJsonRequestDto$Outbound,
+  z.ZodTypeDef,
+  ImportMasterJsonRequestDto
+> = z.object({
+  locale: z.string(),
+  masterJson: z.lazy(() => MasterJson$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ImportMasterJsonRequestDto$ {
+  /** @deprecated use `ImportMasterJsonRequestDto$inboundSchema` instead. */
+  export const inboundSchema = ImportMasterJsonRequestDto$inboundSchema;
+  /** @deprecated use `ImportMasterJsonRequestDto$outboundSchema` instead. */
+  export const outboundSchema = ImportMasterJsonRequestDto$outboundSchema;
+  /** @deprecated use `ImportMasterJsonRequestDto$Outbound` instead. */
+  export type Outbound = ImportMasterJsonRequestDto$Outbound;
+}
+
+export function importMasterJsonRequestDtoToJSON(
+  importMasterJsonRequestDto: ImportMasterJsonRequestDto,
+): string {
+  return JSON.stringify(
+    ImportMasterJsonRequestDto$outboundSchema.parse(importMasterJsonRequestDto),
+  );
+}
+
+export function importMasterJsonRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ImportMasterJsonRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ImportMasterJsonRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImportMasterJsonRequestDto' from JSON`,
+  );
+}

package/src/models/components/importmasterjsonresponsedto.ts

@@ -0,0 +1,92 @@
+/*
+ * 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";
+
+export type ImportMasterJsonResponseDto = {
+  /**
+   * Overall success status of the import operation
+   */
+  success: boolean;
+  /**
+   * Human-readable message describing the import result
+   */
+  message: string;
+  /**
+   * List of resource IDs that were successfully imported
+   */
+  successful?: Array<string> | undefined;
+  /**
+   * List of resource IDs that failed to import
+   */
+  failed?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ImportMasterJsonResponseDto$inboundSchema: z.ZodType<
+  ImportMasterJsonResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  success: z.boolean(),
+  message: z.string(),
+  successful: z.array(z.string()).optional(),
+  failed: z.array(z.string()).optional(),
+});
+
+/** @internal */
+export type ImportMasterJsonResponseDto$Outbound = {
+  success: boolean;
+  message: string;
+  successful?: Array<string> | undefined;
+  failed?: Array<string> | undefined;
+};
+
+/** @internal */
+export const ImportMasterJsonResponseDto$outboundSchema: z.ZodType<
+  ImportMasterJsonResponseDto$Outbound,
+  z.ZodTypeDef,
+  ImportMasterJsonResponseDto
+> = z.object({
+  success: z.boolean(),
+  message: z.string(),
+  successful: z.array(z.string()).optional(),
+  failed: z.array(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 ImportMasterJsonResponseDto$ {
+  /** @deprecated use `ImportMasterJsonResponseDto$inboundSchema` instead. */
+  export const inboundSchema = ImportMasterJsonResponseDto$inboundSchema;
+  /** @deprecated use `ImportMasterJsonResponseDto$outboundSchema` instead. */
+  export const outboundSchema = ImportMasterJsonResponseDto$outboundSchema;
+  /** @deprecated use `ImportMasterJsonResponseDto$Outbound` instead. */
+  export type Outbound = ImportMasterJsonResponseDto$Outbound;
+}
+
+export function importMasterJsonResponseDtoToJSON(
+  importMasterJsonResponseDto: ImportMasterJsonResponseDto,
+): string {
+  return JSON.stringify(
+    ImportMasterJsonResponseDto$outboundSchema.parse(
+      importMasterJsonResponseDto,
+    ),
+  );
+}
+
+export function importMasterJsonResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ImportMasterJsonResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ImportMasterJsonResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ImportMasterJsonResponseDto' from JSON`,
+  );
+}