@novu/api 1.5.0 → 1.6.0

package/src/models/components/bulkupdatesubscriberpreferenceitemdto.ts

@@ -0,0 +1,87 @@
+/*
+ * 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 {
+  PatchPreferenceChannelsDto,
+  PatchPreferenceChannelsDto$inboundSchema,
+  PatchPreferenceChannelsDto$Outbound,
+  PatchPreferenceChannelsDto$outboundSchema,
+} from "./patchpreferencechannelsdto.js";
+
+export type BulkUpdateSubscriberPreferenceItemDto = {
+  /**
+   * Channel-specific preference settings
+   */
+  channels: PatchPreferenceChannelsDto;
+  /**
+   * Workflow internal _id, identifier or slug
+   */
+  workflowId: string;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferenceItemDto$inboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferenceItemDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  channels: PatchPreferenceChannelsDto$inboundSchema,
+  workflowId: z.string(),
+});
+
+/** @internal */
+export type BulkUpdateSubscriberPreferenceItemDto$Outbound = {
+  channels: PatchPreferenceChannelsDto$Outbound;
+  workflowId: string;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferenceItemDto$outboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferenceItemDto$Outbound,
+  z.ZodTypeDef,
+  BulkUpdateSubscriberPreferenceItemDto
+> = z.object({
+  channels: PatchPreferenceChannelsDto$outboundSchema,
+  workflowId: 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 BulkUpdateSubscriberPreferenceItemDto$ {
+  /** @deprecated use `BulkUpdateSubscriberPreferenceItemDto$inboundSchema` instead. */
+  export const inboundSchema =
+    BulkUpdateSubscriberPreferenceItemDto$inboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferenceItemDto$outboundSchema` instead. */
+  export const outboundSchema =
+    BulkUpdateSubscriberPreferenceItemDto$outboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferenceItemDto$Outbound` instead. */
+  export type Outbound = BulkUpdateSubscriberPreferenceItemDto$Outbound;
+}
+
+export function bulkUpdateSubscriberPreferenceItemDtoToJSON(
+  bulkUpdateSubscriberPreferenceItemDto: BulkUpdateSubscriberPreferenceItemDto,
+): string {
+  return JSON.stringify(
+    BulkUpdateSubscriberPreferenceItemDto$outboundSchema.parse(
+      bulkUpdateSubscriberPreferenceItemDto,
+    ),
+  );
+}
+
+export function bulkUpdateSubscriberPreferenceItemDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BulkUpdateSubscriberPreferenceItemDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BulkUpdateSubscriberPreferenceItemDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BulkUpdateSubscriberPreferenceItemDto' from JSON`,
+  );
+}

package/src/models/components/bulkupdatesubscriberpreferencesdto.ts

@@ -0,0 +1,79 @@
+/*
+ * 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 {
+  BulkUpdateSubscriberPreferenceItemDto,
+  BulkUpdateSubscriberPreferenceItemDto$inboundSchema,
+  BulkUpdateSubscriberPreferenceItemDto$Outbound,
+  BulkUpdateSubscriberPreferenceItemDto$outboundSchema,
+} from "./bulkupdatesubscriberpreferenceitemdto.js";
+
+export type BulkUpdateSubscriberPreferencesDto = {
+  /**
+   * Array of workflow preferences to update (maximum 100 items)
+   */
+  preferences: Array<BulkUpdateSubscriberPreferenceItemDto>;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferencesDto$inboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferencesDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  preferences: z.array(BulkUpdateSubscriberPreferenceItemDto$inboundSchema),
+});
+
+/** @internal */
+export type BulkUpdateSubscriberPreferencesDto$Outbound = {
+  preferences: Array<BulkUpdateSubscriberPreferenceItemDto$Outbound>;
+};
+
+/** @internal */
+export const BulkUpdateSubscriberPreferencesDto$outboundSchema: z.ZodType<
+  BulkUpdateSubscriberPreferencesDto$Outbound,
+  z.ZodTypeDef,
+  BulkUpdateSubscriberPreferencesDto
+> = z.object({
+  preferences: z.array(BulkUpdateSubscriberPreferenceItemDto$outboundSchema),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace BulkUpdateSubscriberPreferencesDto$ {
+  /** @deprecated use `BulkUpdateSubscriberPreferencesDto$inboundSchema` instead. */
+  export const inboundSchema = BulkUpdateSubscriberPreferencesDto$inboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferencesDto$outboundSchema` instead. */
+  export const outboundSchema =
+    BulkUpdateSubscriberPreferencesDto$outboundSchema;
+  /** @deprecated use `BulkUpdateSubscriberPreferencesDto$Outbound` instead. */
+  export type Outbound = BulkUpdateSubscriberPreferencesDto$Outbound;
+}
+
+export function bulkUpdateSubscriberPreferencesDtoToJSON(
+  bulkUpdateSubscriberPreferencesDto: BulkUpdateSubscriberPreferencesDto,
+): string {
+  return JSON.stringify(
+    BulkUpdateSubscriberPreferencesDto$outboundSchema.parse(
+      bulkUpdateSubscriberPreferencesDto,
+    ),
+  );
+}
+
+export function bulkUpdateSubscriberPreferencesDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<BulkUpdateSubscriberPreferencesDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      BulkUpdateSubscriberPreferencesDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'BulkUpdateSubscriberPreferencesDto' from JSON`,
+  );
+}

package/src/models/components/emailchanneloverrides.ts

@@ -0,0 +1,69 @@
+/*
+ * 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 EmailChannelOverrides = {
+  /**
+   * Override or remove the layout for all email steps in the workflow
+   */
+  layoutId?: string | null | undefined;
+};
+
+/** @internal */
+export const EmailChannelOverrides$inboundSchema: z.ZodType<
+  EmailChannelOverrides,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  layoutId: z.nullable(z.string()).optional(),
+});
+
+/** @internal */
+export type EmailChannelOverrides$Outbound = {
+  layoutId?: string | null | undefined;
+};
+
+/** @internal */
+export const EmailChannelOverrides$outboundSchema: z.ZodType<
+  EmailChannelOverrides$Outbound,
+  z.ZodTypeDef,
+  EmailChannelOverrides
+> = z.object({
+  layoutId: z.nullable(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 EmailChannelOverrides$ {
+  /** @deprecated use `EmailChannelOverrides$inboundSchema` instead. */
+  export const inboundSchema = EmailChannelOverrides$inboundSchema;
+  /** @deprecated use `EmailChannelOverrides$outboundSchema` instead. */
+  export const outboundSchema = EmailChannelOverrides$outboundSchema;
+  /** @deprecated use `EmailChannelOverrides$Outbound` instead. */
+  export type Outbound = EmailChannelOverrides$Outbound;
+}
+
+export function emailChannelOverridesToJSON(
+  emailChannelOverrides: EmailChannelOverrides,
+): string {
+  return JSON.stringify(
+    EmailChannelOverrides$outboundSchema.parse(emailChannelOverrides),
+  );
+}
+
+export function emailChannelOverridesFromJSON(
+  jsonString: string,
+): SafeParseResult<EmailChannelOverrides, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EmailChannelOverrides$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EmailChannelOverrides' 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/index.ts

@@ -19,6 +19,8 @@ export * from "./builderfieldtypeenum.js";
 export * from "./bulkcreatesubscriberresponsedto.js";
 export * from "./bulksubscribercreatedto.js";
 export * from "./bulktriggereventdto.js";
+export * from "./bulkupdatesubscriberpreferenceitemdto.js";
+export * from "./bulkupdatesubscriberpreferencesdto.js";
 export * from "./buttontypeenum.js";
 export * from "./channelcredentials.js";
 export * from "./channelcredentialsdto.js";
@@ -71,6 +73,7 @@ export * from "./directionenum.js";
 export * from "./emailblock.js";
 export * from "./emailblockstyles.js";
 export * from "./emailblocktypeenum.js";
+export * from "./emailchanneloverrides.js";
 export * from "./emailcontroldto.js";
 export * from "./emailcontrolsmetadataresponsedto.js";
 export * from "./emailstepresponsedto.js";
@@ -82,6 +85,7 @@ export * from "./failedoperationdto.js";
 export * from "./feedresponsedto.js";
 export * from "./fieldfilterpartdto.js";
 export * from "./getenvironmenttagsdto.js";
+export * from "./getpreferencesresponsedto.js";
 export * from "./getsubscriberpreferencesdto.js";
 export * from "./inappcontroldto.js";
 export * from "./inappcontrolsmetadataresponsedto.js";
@@ -125,6 +129,7 @@ export * from "./patchsubscriberpreferencesdto.js";
 export * from "./patchsubscriberrequestdto.js";
 export * from "./patchworkflowdto.js";
 export * from "./payloadvalidationerrordto.js";
+export * from "./preferencelevelenum.js";
 export * from "./preferenceoverridesourceenum.js";
 export * from "./preferencesrequestdto.js";
 export * from "./providersidenum.js";
@@ -138,6 +143,7 @@ export * from "./replycallback.js";
 export * from "./resourceoriginenum.js";
 export * from "./runtimeissuedto.js";
 export * from "./security.js";
+export * from "./severitylevelenum.js";
 export * from "./smscontroldto.js";
 export * from "./smscontrolsmetadataresponsedto.js";
 export * from "./smsstepresponsedto.js";

package/src/models/components/preferencelevelenum.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The level of the preference (global or template)
+ */
+export const PreferenceLevelEnum = {
+  Global: "global",
+  Template: "template",
+} as const;
+/**
+ * The level of the preference (global or template)
+ */
+export type PreferenceLevelEnum = ClosedEnum<typeof PreferenceLevelEnum>;
+
+/** @internal */
+export const PreferenceLevelEnum$inboundSchema: z.ZodNativeEnum<
+  typeof PreferenceLevelEnum
+> = z.nativeEnum(PreferenceLevelEnum);
+
+/** @internal */
+export const PreferenceLevelEnum$outboundSchema: z.ZodNativeEnum<
+  typeof PreferenceLevelEnum
+> = PreferenceLevelEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PreferenceLevelEnum$ {
+  /** @deprecated use `PreferenceLevelEnum$inboundSchema` instead. */
+  export const inboundSchema = PreferenceLevelEnum$inboundSchema;
+  /** @deprecated use `PreferenceLevelEnum$outboundSchema` instead. */
+  export const outboundSchema = PreferenceLevelEnum$outboundSchema;
+}