@novu/api 1.4.0 → 1.6.0

package/src/models/components/emailstepupsertdto.ts

@@ -5,9 +5,14 @@
 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 {
+  EmailControlDto,
+  EmailControlDto$inboundSchema,
+  EmailControlDto$Outbound,
+  EmailControlDto$outboundSchema,
+} from "./emailcontroldto.js";
 import {
   StepTypeEnum,
   StepTypeEnum$inboundSchema,
@@ -15,43 +20,10 @@ import {
 } from "./steptypeenum.js";
 
 /**
- * Type of editor to use for the body.
- */
-export const EmailStepUpsertDtoEditorType = {
-  Block: "block",
-  Html: "html",
-} as const;
-/**
- * Type of editor to use for the body.
- */
-export type EmailStepUpsertDtoEditorType = ClosedEnum<
-  typeof EmailStepUpsertDtoEditorType
->;
-
-/**
- * Control values for the Email step
+ * Control values for the Email step.
  */
-export type EmailStepUpsertDtoControlValues = {
-  /**
-   * 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?: EmailStepUpsertDtoEditorType | undefined;
-  /**
-   * Disable sanitization of the output.
-   */
-  disableOutputSanitization?: boolean | undefined;
+export type EmailStepUpsertDtoControlValues = EmailControlDto | {
+  [k: string]: any;
 };
 
 export type EmailStepUpsertDto = {
@@ -68,66 +40,29 @@ export type EmailStepUpsertDto = {
    */
   type: StepTypeEnum;
   /**
-   * Control values for the Email step
+   * Control values for the Email step.
    */
-  controlValues?: EmailStepUpsertDtoControlValues | null | undefined;
+  controlValues?: EmailControlDto | { [k: string]: any } | undefined;
 };
 
-/** @internal */
-export const EmailStepUpsertDtoEditorType$inboundSchema: z.ZodNativeEnum<
-  typeof EmailStepUpsertDtoEditorType
-> = z.nativeEnum(EmailStepUpsertDtoEditorType);
-
-/** @internal */
-export const EmailStepUpsertDtoEditorType$outboundSchema: z.ZodNativeEnum<
-  typeof EmailStepUpsertDtoEditorType
-> = EmailStepUpsertDtoEditorType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace EmailStepUpsertDtoEditorType$ {
-  /** @deprecated use `EmailStepUpsertDtoEditorType$inboundSchema` instead. */
-  export const inboundSchema = EmailStepUpsertDtoEditorType$inboundSchema;
-  /** @deprecated use `EmailStepUpsertDtoEditorType$outboundSchema` instead. */
-  export const outboundSchema = EmailStepUpsertDtoEditorType$outboundSchema;
-}
-
 /** @internal */
 export const EmailStepUpsertDtoControlValues$inboundSchema: z.ZodType<
   EmailStepUpsertDtoControlValues,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  subject: z.string(),
-  body: z.string().default(""),
-  editorType: EmailStepUpsertDtoEditorType$inboundSchema.default("block"),
-  disableOutputSanitization: z.boolean().default(false),
-});
+> = z.union([EmailControlDto$inboundSchema, z.record(z.any())]);
 
 /** @internal */
-export type EmailStepUpsertDtoControlValues$Outbound = {
-  skip?: { [k: string]: any } | undefined;
-  subject: string;
-  body: string;
-  editorType: string;
-  disableOutputSanitization: boolean;
-};
+export type EmailStepUpsertDtoControlValues$Outbound =
+  | EmailControlDto$Outbound
+  | { [k: string]: any };
 
 /** @internal */
 export const EmailStepUpsertDtoControlValues$outboundSchema: z.ZodType<
   EmailStepUpsertDtoControlValues$Outbound,
   z.ZodTypeDef,
   EmailStepUpsertDtoControlValues
-> = z.object({
-  skip: z.record(z.any()).optional(),
-  subject: z.string(),
-  body: z.string().default(""),
-  editorType: EmailStepUpsertDtoEditorType$outboundSchema.default("block"),
-  disableOutputSanitization: z.boolean().default(false),
-});
+> = z.union([EmailControlDto$outboundSchema, z.record(z.any())]);
 
 /**
  * @internal
@@ -171,9 +106,8 @@ export const EmailStepUpsertDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$inboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => EmailStepUpsertDtoControlValues$inboundSchema),
-  ).optional(),
+  controlValues: z.union([EmailControlDto$inboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -185,7 +119,7 @@ export type EmailStepUpsertDto$Outbound = {
   _id?: string | undefined;
   name: string;
   type: string;
-  controlValues?: EmailStepUpsertDtoControlValues$Outbound | null | undefined;
+  controlValues?: EmailControlDto$Outbound | { [k: string]: any } | undefined;
 };
 
 /** @internal */
@@ -197,9 +131,8 @@ export const EmailStepUpsertDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   name: z.string(),
   type: StepTypeEnum$outboundSchema,
-  controlValues: z.nullable(
-    z.lazy(() => EmailStepUpsertDtoControlValues$outboundSchema),
-  ).optional(),
+  controlValues: z.union([EmailControlDto$outboundSchema, z.record(z.any())])
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/environmentresponsedto.ts

@@ -5,6 +5,7 @@
 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 {
@@ -14,6 +15,20 @@ import {
   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
@@ -31,6 +46,10 @@ export type EnvironmentResponseDto = {
    * Unique identifier for the environment
    */
   identifier: string;
+  /**
+   * Type of the environment
+   */
+  type?: EnvironmentResponseDtoType | null | undefined;
   /**
    * List of API keys associated with the environment
    */
@@ -45,6 +64,27 @@ export type EnvironmentResponseDto = {
   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,
@@ -55,6 +95,7 @@ export const EnvironmentResponseDto$inboundSchema: z.ZodType<
   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(),
@@ -72,6 +113,7 @@ export type EnvironmentResponseDto$Outbound = {
   name: string;
   _organizationId: string;
   identifier: string;
+  type?: string | null | undefined;
   apiKeys?: Array<ApiKeyDto$Outbound> | undefined;
   _parentId?: string | undefined;
   slug?: string | undefined;
@@ -87,6 +129,7 @@ export const EnvironmentResponseDto$outboundSchema: z.ZodType<
   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(),

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/getpreferencesresponsedto.ts

@@ -0,0 +1,263 @@
+/*
+ * 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 {
+  PreferenceLevelEnum,
+  PreferenceLevelEnum$inboundSchema,
+  PreferenceLevelEnum$outboundSchema,
+} from "./preferencelevelenum.js";
+import {
+  SeverityLevelEnum,
+  SeverityLevelEnum$inboundSchema,
+  SeverityLevelEnum$outboundSchema,
+} from "./severitylevelenum.js";
+import {
+  SubscriberPreferenceChannels,
+  SubscriberPreferenceChannels$inboundSchema,
+  SubscriberPreferenceChannels$Outbound,
+  SubscriberPreferenceChannels$outboundSchema,
+} from "./subscriberpreferencechannels.js";
+
+/**
+ * Custom data associated with the workflow
+ */
+export type GetPreferencesResponseDtoData = {};
+
+/**
+ * Workflow information if this is a template-level preference
+ */
+export type Workflow = {
+  /**
+   * Unique identifier of the workflow
+   */
+  id: string;
+  /**
+   * Workflow identifier used for triggering
+   */
+  identifier: string;
+  /**
+   * Human-readable name of the workflow
+   */
+  name: string;
+  /**
+   * Whether this workflow is marked as critical
+   */
+  critical: boolean;
+  /**
+   * Tags associated with the workflow
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Custom data associated with the workflow
+   */
+  data?: GetPreferencesResponseDtoData | undefined;
+  /**
+   * Severity level of the workflow
+   */
+  severity: SeverityLevelEnum;
+};
+
+export type GetPreferencesResponseDto = {
+  /**
+   * The level of the preference (global or template)
+   */
+  level: PreferenceLevelEnum;
+  /**
+   * Workflow information if this is a template-level preference
+   */
+  workflow?: Workflow | null | undefined;
+  /**
+   * Whether the preference is enabled
+   */
+  enabled: boolean;
+  /**
+   * Channel-specific preference settings
+   */
+  channels: SubscriberPreferenceChannels;
+};
+
+/** @internal */
+export const GetPreferencesResponseDtoData$inboundSchema: z.ZodType<
+  GetPreferencesResponseDtoData,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type GetPreferencesResponseDtoData$Outbound = {};
+
+/** @internal */
+export const GetPreferencesResponseDtoData$outboundSchema: z.ZodType<
+  GetPreferencesResponseDtoData$Outbound,
+  z.ZodTypeDef,
+  GetPreferencesResponseDtoData
+> = 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 GetPreferencesResponseDtoData$ {
+  /** @deprecated use `GetPreferencesResponseDtoData$inboundSchema` instead. */
+  export const inboundSchema = GetPreferencesResponseDtoData$inboundSchema;
+  /** @deprecated use `GetPreferencesResponseDtoData$outboundSchema` instead. */
+  export const outboundSchema = GetPreferencesResponseDtoData$outboundSchema;
+  /** @deprecated use `GetPreferencesResponseDtoData$Outbound` instead. */
+  export type Outbound = GetPreferencesResponseDtoData$Outbound;
+}
+
+export function getPreferencesResponseDtoDataToJSON(
+  getPreferencesResponseDtoData: GetPreferencesResponseDtoData,
+): string {
+  return JSON.stringify(
+    GetPreferencesResponseDtoData$outboundSchema.parse(
+      getPreferencesResponseDtoData,
+    ),
+  );
+}
+
+export function getPreferencesResponseDtoDataFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPreferencesResponseDtoData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPreferencesResponseDtoData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPreferencesResponseDtoData' from JSON`,
+  );
+}
+
+/** @internal */
+export const Workflow$inboundSchema: z.ZodType<
+  Workflow,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  id: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+  critical: z.boolean(),
+  tags: z.array(z.string()).optional(),
+  data: z.lazy(() => GetPreferencesResponseDtoData$inboundSchema).optional(),
+  severity: SeverityLevelEnum$inboundSchema,
+});
+
+/** @internal */
+export type Workflow$Outbound = {
+  id: string;
+  identifier: string;
+  name: string;
+  critical: boolean;
+  tags?: Array<string> | undefined;
+  data?: GetPreferencesResponseDtoData$Outbound | undefined;
+  severity: string;
+};
+
+/** @internal */
+export const Workflow$outboundSchema: z.ZodType<
+  Workflow$Outbound,
+  z.ZodTypeDef,
+  Workflow
+> = z.object({
+  id: z.string(),
+  identifier: z.string(),
+  name: z.string(),
+  critical: z.boolean(),
+  tags: z.array(z.string()).optional(),
+  data: z.lazy(() => GetPreferencesResponseDtoData$outboundSchema).optional(),
+  severity: SeverityLevelEnum$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Workflow$ {
+  /** @deprecated use `Workflow$inboundSchema` instead. */
+  export const inboundSchema = Workflow$inboundSchema;
+  /** @deprecated use `Workflow$outboundSchema` instead. */
+  export const outboundSchema = Workflow$outboundSchema;
+  /** @deprecated use `Workflow$Outbound` instead. */
+  export type Outbound = Workflow$Outbound;
+}
+
+export function workflowToJSON(workflow: Workflow): string {
+  return JSON.stringify(Workflow$outboundSchema.parse(workflow));
+}
+
+export function workflowFromJSON(
+  jsonString: string,
+): SafeParseResult<Workflow, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Workflow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Workflow' from JSON`,
+  );
+}
+
+/** @internal */
+export const GetPreferencesResponseDto$inboundSchema: z.ZodType<
+  GetPreferencesResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  level: PreferenceLevelEnum$inboundSchema,
+  workflow: z.nullable(z.lazy(() => Workflow$inboundSchema)).optional(),
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$inboundSchema,
+});
+
+/** @internal */
+export type GetPreferencesResponseDto$Outbound = {
+  level: string;
+  workflow?: Workflow$Outbound | null | undefined;
+  enabled: boolean;
+  channels: SubscriberPreferenceChannels$Outbound;
+};
+
+/** @internal */
+export const GetPreferencesResponseDto$outboundSchema: z.ZodType<
+  GetPreferencesResponseDto$Outbound,
+  z.ZodTypeDef,
+  GetPreferencesResponseDto
+> = z.object({
+  level: PreferenceLevelEnum$outboundSchema,
+  workflow: z.nullable(z.lazy(() => Workflow$outboundSchema)).optional(),
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace GetPreferencesResponseDto$ {
+  /** @deprecated use `GetPreferencesResponseDto$inboundSchema` instead. */
+  export const inboundSchema = GetPreferencesResponseDto$inboundSchema;
+  /** @deprecated use `GetPreferencesResponseDto$outboundSchema` instead. */
+  export const outboundSchema = GetPreferencesResponseDto$outboundSchema;
+  /** @deprecated use `GetPreferencesResponseDto$Outbound` instead. */
+  export type Outbound = GetPreferencesResponseDto$Outbound;
+}
+
+export function getPreferencesResponseDtoToJSON(
+  getPreferencesResponseDto: GetPreferencesResponseDto,
+): string {
+  return JSON.stringify(
+    GetPreferencesResponseDto$outboundSchema.parse(getPreferencesResponseDto),
+  );
+}
+
+export function getPreferencesResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<GetPreferencesResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => GetPreferencesResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'GetPreferencesResponseDto' from JSON`,
+  );
+}

package/src/models/components/inappstepresponsedto.ts

@@ -28,6 +28,11 @@ import {
   RedirectDto$Outbound,
   RedirectDto$outboundSchema,
 } from "./redirectdto.js";
+import {
+  ResourceOriginEnum,
+  ResourceOriginEnum$inboundSchema,
+  ResourceOriginEnum$outboundSchema,
+} from "./resourceoriginenum.js";
 import {
   StepIssuesDto,
   StepIssuesDto$inboundSchema,
@@ -39,11 +44,6 @@ import {
   StepTypeEnum$inboundSchema,
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
-import {
-  WorkflowOriginEnum,
-  WorkflowOriginEnum$inboundSchema,
-  WorkflowOriginEnum$outboundSchema,
-} from "./workfloworiginenum.js";
 
 /**
  * Control values for the in-app step
@@ -129,7 +129,7 @@ export type InAppStepResponseDto = {
   /**
    * Origin of the workflow
    */
-  origin: WorkflowOriginEnum;
+  origin: ResourceOriginEnum;
   /**
    * Workflow identifier
    */
@@ -301,7 +301,7 @@ export const InAppStepResponseDto$inboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => InAppStepResponseDtoSlug$inboundSchema),
   type: StepTypeEnum$inboundSchema,
-  origin: WorkflowOriginEnum$inboundSchema,
+  origin: ResourceOriginEnum$inboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$inboundSchema.optional(),
@@ -342,7 +342,7 @@ export const InAppStepResponseDto$outboundSchema: z.ZodType<
   name: z.string(),
   slug: z.lazy(() => InAppStepResponseDtoSlug$outboundSchema),
   type: StepTypeEnum$outboundSchema,
-  origin: WorkflowOriginEnum$outboundSchema,
+  origin: ResourceOriginEnum$outboundSchema,
   workflowId: z.string(),
   workflowDatabaseId: z.string(),
   issues: StepIssuesDto$outboundSchema.optional(),