@novu/api 1.3.0 → 1.5.0

package/src/models/components/emailstepupsertdto.ts

@@ -0,0 +1,171 @@
+/*
+ * 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 {
+  EmailControlDto,
+  EmailControlDto$inboundSchema,
+  EmailControlDto$Outbound,
+  EmailControlDto$outboundSchema,
+} from "./emailcontroldto.js";
+import {
+  StepTypeEnum,
+  StepTypeEnum$inboundSchema,
+  StepTypeEnum$outboundSchema,
+} from "./steptypeenum.js";
+
+/**
+ * Control values for the Email step.
+ */
+export type EmailStepUpsertDtoControlValues = EmailControlDto | {
+  [k: string]: any;
+};
+
+export type EmailStepUpsertDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id?: string | undefined;
+  /**
+   * Name of the step
+   */
+  name: string;
+  /**
+   * Type of the step
+   */
+  type: StepTypeEnum;
+  /**
+   * Control values for the Email step.
+   */
+  controlValues?: EmailControlDto | { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const EmailStepUpsertDtoControlValues$inboundSchema: z.ZodType<
+  EmailStepUpsertDtoControlValues,
+  z.ZodTypeDef,
+  unknown
+> = z.union([EmailControlDto$inboundSchema, z.record(z.any())]);
+
+/** @internal */
+export type EmailStepUpsertDtoControlValues$Outbound =
+  | EmailControlDto$Outbound
+  | { [k: string]: any };
+
+/** @internal */
+export const EmailStepUpsertDtoControlValues$outboundSchema: z.ZodType<
+  EmailStepUpsertDtoControlValues$Outbound,
+  z.ZodTypeDef,
+  EmailStepUpsertDtoControlValues
+> = z.union([EmailControlDto$outboundSchema, z.record(z.any())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EmailStepUpsertDtoControlValues$ {
+  /** @deprecated use `EmailStepUpsertDtoControlValues$inboundSchema` instead. */
+  export const inboundSchema = EmailStepUpsertDtoControlValues$inboundSchema;
+  /** @deprecated use `EmailStepUpsertDtoControlValues$outboundSchema` instead. */
+  export const outboundSchema = EmailStepUpsertDtoControlValues$outboundSchema;
+  /** @deprecated use `EmailStepUpsertDtoControlValues$Outbound` instead. */
+  export type Outbound = EmailStepUpsertDtoControlValues$Outbound;
+}
+
+export function emailStepUpsertDtoControlValuesToJSON(
+  emailStepUpsertDtoControlValues: EmailStepUpsertDtoControlValues,
+): string {
+  return JSON.stringify(
+    EmailStepUpsertDtoControlValues$outboundSchema.parse(
+      emailStepUpsertDtoControlValues,
+    ),
+  );
+}
+
+export function emailStepUpsertDtoControlValuesFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailStepUpsertDtoControlValues, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailStepUpsertDtoControlValues$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailStepUpsertDtoControlValues' from JSON`,
+  );
+}
+
+/** @internal */
+export const EmailStepUpsertDto$inboundSchema: z.ZodType<
+  EmailStepUpsertDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$inboundSchema,
+  controlValues: z.union([EmailControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type EmailStepUpsertDto$Outbound = {
+  _id?: string | undefined;
+  name: string;
+  type: string;
+  controlValues?: EmailControlDto$Outbound | { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const EmailStepUpsertDto$outboundSchema: z.ZodType<
+  EmailStepUpsertDto$Outbound,
+  z.ZodTypeDef,
+  EmailStepUpsertDto
+> = z.object({
+  id: z.string().optional(),
+  name: z.string(),
+  type: StepTypeEnum$outboundSchema,
+  controlValues: z.union([EmailControlDto$outboundSchema, z.record(z.any())])
+    .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 EmailStepUpsertDto$ {
+  /** @deprecated use `EmailStepUpsertDto$inboundSchema` instead. */
+  export const inboundSchema = EmailStepUpsertDto$inboundSchema;
+  /** @deprecated use `EmailStepUpsertDto$outboundSchema` instead. */
+  export const outboundSchema = EmailStepUpsertDto$outboundSchema;
+  /** @deprecated use `EmailStepUpsertDto$Outbound` instead. */
+  export type Outbound = EmailStepUpsertDto$Outbound;
+}
+
+export function emailStepUpsertDtoToJSON(
+  emailStepUpsertDto: EmailStepUpsertDto,
+): string {
+  return JSON.stringify(
+    EmailStepUpsertDto$outboundSchema.parse(emailStepUpsertDto),
+  );
+}
+
+export function emailStepUpsertDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailStepUpsertDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailStepUpsertDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailStepUpsertDto' from JSON`,
+  );
+}

package/src/models/components/environmentresponsedto.ts

@@ -0,0 +1,173 @@
+/*
+ * 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 {
+  ApiKeyDto,
+  ApiKeyDto$inboundSchema,
+  ApiKeyDto$Outbound,
+  ApiKeyDto$outboundSchema,
+} from "./apikeydto.js";
+
+/**
+ * Type of the environment
+ */
+export const EnvironmentResponseDtoType = {
+  Dev: "dev",
+  Prod: "prod",
+} as const;
+/**
+ * Type of the environment
+ */
+export type EnvironmentResponseDtoType = ClosedEnum<
+  typeof EnvironmentResponseDtoType
+>;
+
+export type EnvironmentResponseDto = {
+  /**
+   * Unique identifier of the environment
+   */
+  id: string;
+  /**
+   * Name of the environment
+   */
+  name: string;
+  /**
+   * Organization ID associated with the environment
+   */
+  organizationId: string;
+  /**
+   * Unique identifier for the environment
+   */
+  identifier: string;
+  /**
+   * Type of the environment
+   */
+  type?: EnvironmentResponseDtoType | null | undefined;
+  /**
+   * List of API keys associated with the environment
+   */
+  apiKeys?: Array<ApiKeyDto> | undefined;
+  /**
+   * Parent environment ID
+   */
+  parentId?: string | undefined;
+  /**
+   * URL-friendly slug for the environment
+   */
+  slug?: string | undefined;
+};
+
+/** @internal */
+export const EnvironmentResponseDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof EnvironmentResponseDtoType
+> = z.nativeEnum(EnvironmentResponseDtoType);
+
+/** @internal */
+export const EnvironmentResponseDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof EnvironmentResponseDtoType
+> = EnvironmentResponseDtoType$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace EnvironmentResponseDtoType$ {
+  /** @deprecated use `EnvironmentResponseDtoType$inboundSchema` instead. */
+  export const inboundSchema = EnvironmentResponseDtoType$inboundSchema;
+  /** @deprecated use `EnvironmentResponseDtoType$outboundSchema` instead. */
+  export const outboundSchema = EnvironmentResponseDtoType$outboundSchema;
+}
+
+/** @internal */
+export const EnvironmentResponseDto$inboundSchema: z.ZodType<
+  EnvironmentResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  name: z.string(),
+  _organizationId: z.string(),
+  identifier: z.string(),
+  type: z.nullable(EnvironmentResponseDtoType$inboundSchema).optional(),
+  apiKeys: z.array(ApiKeyDto$inboundSchema).optional(),
+  _parentId: z.string().optional(),
+  slug: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_organizationId": "organizationId",
+    "_parentId": "parentId",
+  });
+});
+
+/** @internal */
+export type EnvironmentResponseDto$Outbound = {
+  _id: string;
+  name: string;
+  _organizationId: string;
+  identifier: string;
+  type?: string | null | undefined;
+  apiKeys?: Array<ApiKeyDto$Outbound> | undefined;
+  _parentId?: string | undefined;
+  slug?: string | undefined;
+};
+
+/** @internal */
+export const EnvironmentResponseDto$outboundSchema: z.ZodType<
+  EnvironmentResponseDto$Outbound,
+  z.ZodTypeDef,
+  EnvironmentResponseDto
+> = z.object({
+  id: z.string(),
+  name: z.string(),
+  organizationId: z.string(),
+  identifier: z.string(),
+  type: z.nullable(EnvironmentResponseDtoType$outboundSchema).optional(),
+  apiKeys: z.array(ApiKeyDto$outboundSchema).optional(),
+  parentId: z.string().optional(),
+  slug: z.string().optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    organizationId: "_organizationId",
+    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 EnvironmentResponseDto$ {
+  /** @deprecated use `EnvironmentResponseDto$inboundSchema` instead. */
+  export const inboundSchema = EnvironmentResponseDto$inboundSchema;
+  /** @deprecated use `EnvironmentResponseDto$outboundSchema` instead. */
+  export const outboundSchema = EnvironmentResponseDto$outboundSchema;
+  /** @deprecated use `EnvironmentResponseDto$Outbound` instead. */
+  export type Outbound = EnvironmentResponseDto$Outbound;
+}
+
+export function environmentResponseDtoToJSON(
+  environmentResponseDto: EnvironmentResponseDto,
+): string {
+  return JSON.stringify(
+    EnvironmentResponseDto$outboundSchema.parse(environmentResponseDto),
+  );
+}
+
+export function environmentResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvironmentResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EnvironmentResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvironmentResponseDto' from JSON`,
+  );
+}

package/src/models/components/getenvironmenttagsdto.ts

@@ -0,0 +1,66 @@
+/*
+ * 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 GetEnvironmentTagsDto = {
+  name: string;
+};
+
+/** @internal */
+export const GetEnvironmentTagsDto$inboundSchema: z.ZodType<
+  GetEnvironmentTagsDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+});
+
+/** @internal */
+export type GetEnvironmentTagsDto$Outbound = {
+  name: string;
+};
+
+/** @internal */
+export const GetEnvironmentTagsDto$outboundSchema: z.ZodType<
+  GetEnvironmentTagsDto$Outbound,
+  z.ZodTypeDef,
+  GetEnvironmentTagsDto
+> = z.object({
+  name: z.string(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetEnvironmentTagsDto$ {
+  /** @deprecated use `GetEnvironmentTagsDto$inboundSchema` instead. */
+  export const inboundSchema = GetEnvironmentTagsDto$inboundSchema;
+  /** @deprecated use `GetEnvironmentTagsDto$outboundSchema` instead. */
+  export const outboundSchema = GetEnvironmentTagsDto$outboundSchema;
+  /** @deprecated use `GetEnvironmentTagsDto$Outbound` instead. */
+  export type Outbound = GetEnvironmentTagsDto$Outbound;
+}
+
+export function getEnvironmentTagsDtoToJSON(
+  getEnvironmentTagsDto: GetEnvironmentTagsDto,
+): string {
+  return JSON.stringify(
+    GetEnvironmentTagsDto$outboundSchema.parse(getEnvironmentTagsDto),
+  );
+}
+
+export function getEnvironmentTagsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetEnvironmentTagsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetEnvironmentTagsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetEnvironmentTagsDto' from JSON`,
+  );
+}

package/src/models/components/inappcontroldto.ts

@@ -0,0 +1,135 @@
+/*
+ * 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 {
+  ActionDto,
+  ActionDto$inboundSchema,
+  ActionDto$Outbound,
+  ActionDto$outboundSchema,
+} from "./actiondto.js";
+import {
+  RedirectDto,
+  RedirectDto$inboundSchema,
+  RedirectDto$Outbound,
+  RedirectDto$outboundSchema,
+} from "./redirectdto.js";
+
+export type InAppControlDto = {
+  /**
+   * 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;
+  /**
+   * Content/body of the in-app message. Required if subject is empty.
+   */
+  body?: string | undefined;
+  /**
+   * Subject/title of the in-app message. Required if body is empty.
+   */
+  subject?: string | undefined;
+  /**
+   * URL for an avatar image. Must be a valid URL or start with / or {{"{{"}} variable }}.
+   */
+  avatar?: string | undefined;
+  /**
+   * Primary action button details.
+   */
+  primaryAction?: ActionDto | undefined;
+  /**
+   * Secondary action button details.
+   */
+  secondaryAction?: ActionDto | undefined;
+  /**
+   * Redirection URL configuration for the main content click (if no actions defined/clicked)..
+   */
+  redirect?: RedirectDto | undefined;
+  /**
+   * Disable sanitization of the output.
+   */
+  disableOutputSanitization?: boolean | undefined;
+  /**
+   * Additional data payload for the step.
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const InAppControlDto$inboundSchema: z.ZodType<
+  InAppControlDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+  subject: z.string().optional(),
+  avatar: z.string().optional(),
+  primaryAction: ActionDto$inboundSchema.optional(),
+  secondaryAction: ActionDto$inboundSchema.optional(),
+  redirect: RedirectDto$inboundSchema.optional(),
+  disableOutputSanitization: z.boolean().default(false),
+  data: z.record(z.any()).optional(),
+});
+
+/** @internal */
+export type InAppControlDto$Outbound = {
+  skip?: { [k: string]: any } | undefined;
+  body?: string | undefined;
+  subject?: string | undefined;
+  avatar?: string | undefined;
+  primaryAction?: ActionDto$Outbound | undefined;
+  secondaryAction?: ActionDto$Outbound | undefined;
+  redirect?: RedirectDto$Outbound | undefined;
+  disableOutputSanitization: boolean;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const InAppControlDto$outboundSchema: z.ZodType<
+  InAppControlDto$Outbound,
+  z.ZodTypeDef,
+  InAppControlDto
+> = z.object({
+  skip: z.record(z.any()).optional(),
+  body: z.string().optional(),
+  subject: z.string().optional(),
+  avatar: z.string().optional(),
+  primaryAction: ActionDto$outboundSchema.optional(),
+  secondaryAction: ActionDto$outboundSchema.optional(),
+  redirect: RedirectDto$outboundSchema.optional(),
+  disableOutputSanitization: z.boolean().default(false),
+  data: z.record(z.any()).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InAppControlDto$ {
+  /** @deprecated use `InAppControlDto$inboundSchema` instead. */
+  export const inboundSchema = InAppControlDto$inboundSchema;
+  /** @deprecated use `InAppControlDto$outboundSchema` instead. */
+  export const outboundSchema = InAppControlDto$outboundSchema;
+  /** @deprecated use `InAppControlDto$Outbound` instead. */
+  export type Outbound = InAppControlDto$Outbound;
+}
+
+export function inAppControlDtoToJSON(
+  inAppControlDto: InAppControlDto,
+): string {
+  return JSON.stringify(InAppControlDto$outboundSchema.parse(inAppControlDto));
+}
+
+export function inAppControlDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InAppControlDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InAppControlDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InAppControlDto' from JSON`,
+  );
+}

package/src/models/components/inappcontrolsmetadataresponsedto.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 {
+  InAppControlDto,
+  InAppControlDto$inboundSchema,
+  InAppControlDto$Outbound,
+  InAppControlDto$outboundSchema,
+} from "./inappcontroldto.js";
+import {
+  UiSchema,
+  UiSchema$inboundSchema,
+  UiSchema$Outbound,
+  UiSchema$outboundSchema,
+} from "./uischema.js";
+
+export type InAppControlsMetadataResponseDto = {
+  /**
+   * JSON Schema for data
+   */
+  dataSchema?: { [k: string]: any } | undefined;
+  /**
+   * UI Schema for rendering
+   */
+  uiSchema?: UiSchema | undefined;
+  /**
+   * Control values specific to In-App
+   */
+  values: InAppControlDto;
+};
+
+/** @internal */
+export const InAppControlsMetadataResponseDto$inboundSchema: z.ZodType<
+  InAppControlsMetadataResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$inboundSchema.optional(),
+  values: InAppControlDto$inboundSchema,
+});
+
+/** @internal */
+export type InAppControlsMetadataResponseDto$Outbound = {
+  dataSchema?: { [k: string]: any } | undefined;
+  uiSchema?: UiSchema$Outbound | undefined;
+  values: InAppControlDto$Outbound;
+};
+
+/** @internal */
+export const InAppControlsMetadataResponseDto$outboundSchema: z.ZodType<
+  InAppControlsMetadataResponseDto$Outbound,
+  z.ZodTypeDef,
+  InAppControlsMetadataResponseDto
+> = z.object({
+  dataSchema: z.record(z.any()).optional(),
+  uiSchema: UiSchema$outboundSchema.optional(),
+  values: InAppControlDto$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace InAppControlsMetadataResponseDto$ {
+  /** @deprecated use `InAppControlsMetadataResponseDto$inboundSchema` instead. */
+  export const inboundSchema = InAppControlsMetadataResponseDto$inboundSchema;
+  /** @deprecated use `InAppControlsMetadataResponseDto$outboundSchema` instead. */
+  export const outboundSchema = InAppControlsMetadataResponseDto$outboundSchema;
+  /** @deprecated use `InAppControlsMetadataResponseDto$Outbound` instead. */
+  export type Outbound = InAppControlsMetadataResponseDto$Outbound;
+}
+
+export function inAppControlsMetadataResponseDtoToJSON(
+  inAppControlsMetadataResponseDto: InAppControlsMetadataResponseDto,
+): string {
+  return JSON.stringify(
+    InAppControlsMetadataResponseDto$outboundSchema.parse(
+      inAppControlsMetadataResponseDto,
+    ),
+  );
+}
+
+export function inAppControlsMetadataResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<InAppControlsMetadataResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => InAppControlsMetadataResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'InAppControlsMetadataResponseDto' from JSON`,
+  );
+}