@novu/api 3.14.0 → 3.14.2-rc.1

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),
+  );
+}

package/src/models/components/generatepreviewresponsedto.ts

@@ -0,0 +1,434 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+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 {
+  ChatRenderOutput,
+  ChatRenderOutput$inboundSchema,
+} from "./chatrenderoutput.js";
+import {
+  DigestRegularOutput,
+  DigestRegularOutput$inboundSchema,
+} from "./digestregularoutput.js";
+import {
+  EmailRenderOutput,
+  EmailRenderOutput$inboundSchema,
+} from "./emailrenderoutput.js";
+import {
+  InAppRenderOutput,
+  InAppRenderOutput$inboundSchema,
+} from "./inapprenderoutput.js";
+import {
+  PreviewErrorDto,
+  PreviewErrorDto$inboundSchema,
+} from "./previewerrordto.js";
+import {
+  PreviewPayloadDto,
+  PreviewPayloadDto$inboundSchema,
+} from "./previewpayloaddto.js";
+import {
+  PushRenderOutput,
+  PushRenderOutput$inboundSchema,
+} from "./pushrenderoutput.js";
+import {
+  SmsRenderOutput,
+  SmsRenderOutput$inboundSchema,
+} from "./smsrenderoutput.js";
+
+export const GeneratePreviewResponseDtoResult9Type = {
+  Digest: "digest",
+} as const;
+export type GeneratePreviewResponseDtoResult9Type = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResult9Type
+>;
+
+export type Nine = {
+  type?: GeneratePreviewResponseDtoResult9Type | undefined;
+  preview?: DigestRegularOutput | undefined;
+};
+
+export const GeneratePreviewResponseDtoResult8Type = {
+  Delay: "delay",
+} as const;
+export type GeneratePreviewResponseDtoResult8Type = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResult8Type
+>;
+
+export type Eight = {
+  type?: GeneratePreviewResponseDtoResult8Type | undefined;
+  preview?: DigestRegularOutput | undefined;
+};
+
+export const GeneratePreviewResponseDtoResult7Type = {
+  Chat: "chat",
+} as const;
+export type GeneratePreviewResponseDtoResult7Type = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResult7Type
+>;
+
+export type Seven = {
+  type?: GeneratePreviewResponseDtoResult7Type | undefined;
+  preview?: ChatRenderOutput | undefined;
+  error?: PreviewErrorDto | undefined;
+};
+
+export const GeneratePreviewResponseDtoResult6Type = {
+  Push: "push",
+} as const;
+export type GeneratePreviewResponseDtoResult6Type = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResult6Type
+>;
+
+export type Six = {
+  type?: GeneratePreviewResponseDtoResult6Type | undefined;
+  preview?: PushRenderOutput | undefined;
+  error?: PreviewErrorDto | undefined;
+};
+
+export const GeneratePreviewResponseDtoResult5Type = {
+  Sms: "sms",
+} as const;
+export type GeneratePreviewResponseDtoResult5Type = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResult5Type
+>;
+
+export type Result5 = {
+  type?: GeneratePreviewResponseDtoResult5Type | undefined;
+  preview?: SmsRenderOutput | undefined;
+  error?: PreviewErrorDto | undefined;
+};
+
+export const GeneratePreviewResponseDtoResult4Type = {
+  InApp: "in_app",
+} as const;
+export type GeneratePreviewResponseDtoResult4Type = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResult4Type
+>;
+
+export type Result4 = {
+  type?: GeneratePreviewResponseDtoResult4Type | undefined;
+  preview?: InAppRenderOutput | undefined;
+  error?: PreviewErrorDto | undefined;
+};
+
+export const GeneratePreviewResponseDtoResult3Type = {
+  Email: "email",
+} as const;
+export type GeneratePreviewResponseDtoResult3Type = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResult3Type
+>;
+
+export type Three = {
+  type?: GeneratePreviewResponseDtoResult3Type | undefined;
+  preview?: EmailRenderOutput | undefined;
+  error?: PreviewErrorDto | undefined;
+};
+
+export const GeneratePreviewResponseDtoResultType = {
+  Email: "email",
+} as const;
+export type GeneratePreviewResponseDtoResultType = ClosedEnum<
+  typeof GeneratePreviewResponseDtoResultType
+>;
+
+export type Result2 = {
+  type?: GeneratePreviewResponseDtoResultType | undefined;
+  preview?: EmailRenderOutput | undefined;
+  error?: PreviewErrorDto | undefined;
+};
+
+/**
+ * Preview result
+ */
+export type GeneratePreviewResponseDtoResult =
+  | { [k: string]: any }
+  | Result2
+  | Three
+  | Result4
+  | Result5
+  | Six
+  | Seven
+  | Eight
+  | Nine;
+
+export type GeneratePreviewResponseDto = {
+  /**
+   * Preview payload example
+   */
+  previewPayloadExample: PreviewPayloadDto;
+  /**
+   * The payload schema that was used to generate the preview payload example
+   */
+  schema?: { [k: string]: any } | null | undefined;
+  /**
+   * Sample novu-signature header value for HTTP request steps
+   */
+  novuSignature?: string | undefined;
+  /**
+   * Preview result
+   */
+  result:
+    | { [k: string]: any }
+    | Result2
+    | Three
+    | Result4
+    | Result5
+    | Six
+    | Seven
+    | Eight
+    | Nine;
+};
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult9Type$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResult9Type> = z.nativeEnum(
+    GeneratePreviewResponseDtoResult9Type,
+  );
+
+/** @internal */
+export const Nine$inboundSchema: z.ZodType<Nine, z.ZodTypeDef, unknown> = z
+  .object({
+    type: GeneratePreviewResponseDtoResult9Type$inboundSchema.optional(),
+    preview: DigestRegularOutput$inboundSchema.optional(),
+  });
+
+export function nineFromJSON(
+  jsonString: string,
+): SafeParseResult<Nine, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Nine$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Nine' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult8Type$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResult8Type> = z.nativeEnum(
+    GeneratePreviewResponseDtoResult8Type,
+  );
+
+/** @internal */
+export const Eight$inboundSchema: z.ZodType<Eight, z.ZodTypeDef, unknown> = z
+  .object({
+    type: GeneratePreviewResponseDtoResult8Type$inboundSchema.optional(),
+    preview: DigestRegularOutput$inboundSchema.optional(),
+  });
+
+export function eightFromJSON(
+  jsonString: string,
+): SafeParseResult<Eight, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Eight$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Eight' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult7Type$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResult7Type> = z.nativeEnum(
+    GeneratePreviewResponseDtoResult7Type,
+  );
+
+/** @internal */
+export const Seven$inboundSchema: z.ZodType<Seven, z.ZodTypeDef, unknown> = z
+  .object({
+    type: GeneratePreviewResponseDtoResult7Type$inboundSchema.optional(),
+    preview: ChatRenderOutput$inboundSchema.optional(),
+    error: PreviewErrorDto$inboundSchema.optional(),
+  });
+
+export function sevenFromJSON(
+  jsonString: string,
+): SafeParseResult<Seven, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Seven$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Seven' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult6Type$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResult6Type> = z.nativeEnum(
+    GeneratePreviewResponseDtoResult6Type,
+  );
+
+/** @internal */
+export const Six$inboundSchema: z.ZodType<Six, z.ZodTypeDef, unknown> = z
+  .object({
+    type: GeneratePreviewResponseDtoResult6Type$inboundSchema.optional(),
+    preview: PushRenderOutput$inboundSchema.optional(),
+    error: PreviewErrorDto$inboundSchema.optional(),
+  });
+
+export function sixFromJSON(
+  jsonString: string,
+): SafeParseResult<Six, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Six$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Six' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult5Type$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResult5Type> = z.nativeEnum(
+    GeneratePreviewResponseDtoResult5Type,
+  );
+
+/** @internal */
+export const Result5$inboundSchema: z.ZodType<Result5, z.ZodTypeDef, unknown> =
+  z.object({
+    type: GeneratePreviewResponseDtoResult5Type$inboundSchema.optional(),
+    preview: SmsRenderOutput$inboundSchema.optional(),
+    error: PreviewErrorDto$inboundSchema.optional(),
+  });
+
+export function result5FromJSON(
+  jsonString: string,
+): SafeParseResult<Result5, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Result5$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Result5' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult4Type$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResult4Type> = z.nativeEnum(
+    GeneratePreviewResponseDtoResult4Type,
+  );
+
+/** @internal */
+export const Result4$inboundSchema: z.ZodType<Result4, z.ZodTypeDef, unknown> =
+  z.object({
+    type: GeneratePreviewResponseDtoResult4Type$inboundSchema.optional(),
+    preview: InAppRenderOutput$inboundSchema.optional(),
+    error: PreviewErrorDto$inboundSchema.optional(),
+  });
+
+export function result4FromJSON(
+  jsonString: string,
+): SafeParseResult<Result4, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Result4$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Result4' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult3Type$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResult3Type> = z.nativeEnum(
+    GeneratePreviewResponseDtoResult3Type,
+  );
+
+/** @internal */
+export const Three$inboundSchema: z.ZodType<Three, z.ZodTypeDef, unknown> = z
+  .object({
+    type: GeneratePreviewResponseDtoResult3Type$inboundSchema.optional(),
+    preview: EmailRenderOutput$inboundSchema.optional(),
+    error: PreviewErrorDto$inboundSchema.optional(),
+  });
+
+export function threeFromJSON(
+  jsonString: string,
+): SafeParseResult<Three, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Three$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Three' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResultType$inboundSchema:
+  z.ZodNativeEnum<typeof GeneratePreviewResponseDtoResultType> = z.nativeEnum(
+    GeneratePreviewResponseDtoResultType,
+  );
+
+/** @internal */
+export const Result2$inboundSchema: z.ZodType<Result2, z.ZodTypeDef, unknown> =
+  z.object({
+    type: GeneratePreviewResponseDtoResultType$inboundSchema.optional(),
+    preview: EmailRenderOutput$inboundSchema.optional(),
+    error: PreviewErrorDto$inboundSchema.optional(),
+  });
+
+export function result2FromJSON(
+  jsonString: string,
+): SafeParseResult<Result2, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Result2$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Result2' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDtoResult$inboundSchema: z.ZodType<
+  GeneratePreviewResponseDtoResult,
+  z.ZodTypeDef,
+  unknown
+> = z.union([
+  z.record(z.any()),
+  z.lazy(() => Result2$inboundSchema),
+  z.lazy(() => Three$inboundSchema),
+  z.lazy(() => Result4$inboundSchema),
+  z.lazy(() => Result5$inboundSchema),
+  z.lazy(() => Six$inboundSchema),
+  z.lazy(() => Seven$inboundSchema),
+  z.lazy(() => Eight$inboundSchema),
+  z.lazy(() => Nine$inboundSchema),
+]);
+
+export function generatePreviewResponseDtoResultFromJSON(
+  jsonString: string,
+): SafeParseResult<GeneratePreviewResponseDtoResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GeneratePreviewResponseDtoResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GeneratePreviewResponseDtoResult' from JSON`,
+  );
+}
+
+/** @internal */
+export const GeneratePreviewResponseDto$inboundSchema: z.ZodType<
+  GeneratePreviewResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  previewPayloadExample: PreviewPayloadDto$inboundSchema,
+  schema: z.nullable(z.record(z.any())).optional(),
+  novuSignature: z.string().optional(),
+  result: z.union([
+    z.record(z.any()),
+    z.lazy(() => Result2$inboundSchema),
+    z.lazy(() => Three$inboundSchema),
+    z.lazy(() => Result4$inboundSchema),
+    z.lazy(() => Result5$inboundSchema),
+    z.lazy(() => Six$inboundSchema),
+    z.lazy(() => Seven$inboundSchema),
+    z.lazy(() => Eight$inboundSchema),
+    z.lazy(() => Nine$inboundSchema),
+  ]),
+});
+
+export function generatePreviewResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GeneratePreviewResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GeneratePreviewResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GeneratePreviewResponseDto' from JSON`,
+  );
+}

package/src/models/components/getenvironmentvariableusageresponsedto.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";
+import {
+  EnvironmentVariableWorkflowInfoDto,
+  EnvironmentVariableWorkflowInfoDto$inboundSchema,
+} from "./environmentvariableworkflowinfodto.js";
+
+export type GetEnvironmentVariableUsageResponseDto = {
+  /**
+   * Array of workflows that reference this environment variable
+   */
+  workflows: Array<EnvironmentVariableWorkflowInfoDto>;
+};
+
+/** @internal */
+export const GetEnvironmentVariableUsageResponseDto$inboundSchema: z.ZodType<
+  GetEnvironmentVariableUsageResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  workflows: z.array(EnvironmentVariableWorkflowInfoDto$inboundSchema),
+});
+
+export function getEnvironmentVariableUsageResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEnvironmentVariableUsageResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetEnvironmentVariableUsageResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEnvironmentVariableUsageResponseDto' from JSON`,
+  );
+}

package/src/models/components/getsubscribernotificationscountresponsedto.ts

@@ -0,0 +1,43 @@
+/*
+ * 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 GetSubscriberNotificationsCountResponseDto = {
+  /**
+   * The count of notifications matching the filter
+   */
+  count: number;
+  /**
+   * The filter applied
+   */
+  filter: { [k: string]: any };
+};
+
+/** @internal */
+export const GetSubscriberNotificationsCountResponseDto$inboundSchema:
+  z.ZodType<GetSubscriberNotificationsCountResponseDto, z.ZodTypeDef, unknown> =
+    z.object({
+      count: z.number(),
+      filter: z.record(z.any()),
+    });
+
+export function getSubscriberNotificationsCountResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<
+  GetSubscriberNotificationsCountResponseDto,
+  SDKValidationError
+> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubscriberNotificationsCountResponseDto$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'GetSubscriberNotificationsCountResponseDto' from JSON`,
+  );
+}

package/src/models/components/getsubscribernotificationsresponsedto.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 {
+  InboxNotificationDto,
+  InboxNotificationDto$inboundSchema,
+} from "./inboxnotificationdto.js";
+
+/**
+ * The filter applied to the notifications
+ */
+export type Filter = {};
+
+export type GetSubscriberNotificationsResponseDto = {
+  /**
+   * Array of notifications
+   */
+  data: Array<InboxNotificationDto>;
+  /**
+   * Indicates if there are more notifications available
+   */
+  hasMore: boolean;
+  /**
+   * The filter applied to the notifications
+   */
+  filter: Filter;
+};
+
+/** @internal */
+export const Filter$inboundSchema: z.ZodType<Filter, z.ZodTypeDef, unknown> = z
+  .object({});
+
+export function filterFromJSON(
+  jsonString: string,
+): SafeParseResult<Filter, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Filter$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Filter' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetSubscriberNotificationsResponseDto$inboundSchema: z.ZodType<
+  GetSubscriberNotificationsResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  data: z.array(InboxNotificationDto$inboundSchema),
+  hasMore: z.boolean(),
+  filter: z.lazy(() => Filter$inboundSchema),
+});
+
+export function getSubscriberNotificationsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetSubscriberNotificationsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      GetSubscriberNotificationsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetSubscriberNotificationsResponseDto' from JSON`,
+  );
+}

package/src/models/components/httpmethodenum.ts

@@ -0,0 +1,30 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * HTTP method
+ */
+export const HttpMethodEnum = {
+  Get: "GET",
+  Post: "POST",
+  Put: "PUT",
+  Delete: "DELETE",
+  Patch: "PATCH",
+} as const;
+/**
+ * HTTP method
+ */
+export type HttpMethodEnum = ClosedEnum<typeof HttpMethodEnum>;
+
+/** @internal */
+export const HttpMethodEnum$inboundSchema: z.ZodNativeEnum<
+  typeof HttpMethodEnum
+> = z.nativeEnum(HttpMethodEnum);
+/** @internal */
+export const HttpMethodEnum$outboundSchema: z.ZodNativeEnum<
+  typeof HttpMethodEnum
+> = HttpMethodEnum$inboundSchema;