@novu/api 1.5.0 → 1.6.0

package/src/models/components/preferencesrequestdto.ts

@@ -48,7 +48,7 @@ export type PreferencesRequestDtoAll = WorkflowPreferenceDto;
 /**
  * Workflow-specific preferences
  */
-export type Workflow = {
+export type PreferencesRequestDtoWorkflow = {
   /**
    * A preference for the workflow. The values specified here will be used if no preference is specified for a channel.
    */
@@ -67,7 +67,7 @@ export type PreferencesRequestDto = {
   /**
    * Workflow-specific preferences
    */
-  workflow?: Workflow | null | undefined;
+  workflow?: PreferencesRequestDtoWorkflow | null | undefined;
 };
 
 /** @internal */
@@ -255,8 +255,8 @@ export function preferencesRequestDtoAllFromJSON(
 }
 
 /** @internal */
-export const Workflow$inboundSchema: z.ZodType<
-  Workflow,
+export const PreferencesRequestDtoWorkflow$inboundSchema: z.ZodType<
+  PreferencesRequestDtoWorkflow,
   z.ZodTypeDef,
   unknown
 > = z.object({
@@ -265,16 +265,16 @@ export const Workflow$inboundSchema: z.ZodType<
 });
 
 /** @internal */
-export type Workflow$Outbound = {
+export type PreferencesRequestDtoWorkflow$Outbound = {
   all: WorkflowPreferenceDto$Outbound;
   channels: { [k: string]: ChannelPreferenceDto$Outbound };
 };
 
 /** @internal */
-export const Workflow$outboundSchema: z.ZodType<
-  Workflow$Outbound,
+export const PreferencesRequestDtoWorkflow$outboundSchema: z.ZodType<
+  PreferencesRequestDtoWorkflow$Outbound,
   z.ZodTypeDef,
-  Workflow
+  PreferencesRequestDtoWorkflow
 > = z.object({
   all: WorkflowPreferenceDto$outboundSchema,
   channels: z.record(ChannelPreferenceDto$outboundSchema),
@@ -284,26 +284,32 @@ export const Workflow$outboundSchema: z.ZodType<
  * @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 namespace PreferencesRequestDtoWorkflow$ {
+  /** @deprecated use `PreferencesRequestDtoWorkflow$inboundSchema` instead. */
+  export const inboundSchema = PreferencesRequestDtoWorkflow$inboundSchema;
+  /** @deprecated use `PreferencesRequestDtoWorkflow$outboundSchema` instead. */
+  export const outboundSchema = PreferencesRequestDtoWorkflow$outboundSchema;
+  /** @deprecated use `PreferencesRequestDtoWorkflow$Outbound` instead. */
+  export type Outbound = PreferencesRequestDtoWorkflow$Outbound;
 }
 
-export function workflowToJSON(workflow: Workflow): string {
-  return JSON.stringify(Workflow$outboundSchema.parse(workflow));
+export function preferencesRequestDtoWorkflowToJSON(
+  preferencesRequestDtoWorkflow: PreferencesRequestDtoWorkflow,
+): string {
+  return JSON.stringify(
+    PreferencesRequestDtoWorkflow$outboundSchema.parse(
+      preferencesRequestDtoWorkflow,
+    ),
+  );
 }
 
-export function workflowFromJSON(
+export function preferencesRequestDtoWorkflowFromJSON(
   jsonString: string,
-): SafeParseResult<Workflow, SDKValidationError> {
+): SafeParseResult<PreferencesRequestDtoWorkflow, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Workflow$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Workflow' from JSON`,
+    (x) => PreferencesRequestDtoWorkflow$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'PreferencesRequestDtoWorkflow' from JSON`,
   );
 }
 
@@ -315,13 +321,15 @@ export const PreferencesRequestDto$inboundSchema: z.ZodType<
 > = z.object({
   user: z.nullable(z.lazy(() => UserWorkflowPreferencesDto$inboundSchema))
     .optional(),
-  workflow: z.nullable(z.lazy(() => Workflow$inboundSchema)).optional(),
+  workflow: z.nullable(
+    z.lazy(() => PreferencesRequestDtoWorkflow$inboundSchema),
+  ).optional(),
 });
 
 /** @internal */
 export type PreferencesRequestDto$Outbound = {
   user?: UserWorkflowPreferencesDto$Outbound | null | undefined;
-  workflow?: Workflow$Outbound | null | undefined;
+  workflow?: PreferencesRequestDtoWorkflow$Outbound | null | undefined;
 };
 
 /** @internal */
@@ -332,7 +340,9 @@ export const PreferencesRequestDto$outboundSchema: z.ZodType<
 > = z.object({
   user: z.nullable(z.lazy(() => UserWorkflowPreferencesDto$outboundSchema))
     .optional(),
-  workflow: z.nullable(z.lazy(() => Workflow$outboundSchema)).optional(),
+  workflow: z.nullable(
+    z.lazy(() => PreferencesRequestDtoWorkflow$outboundSchema),
+  ).optional(),
 });
 
 /**

package/src/models/components/providersidenum.ts

@@ -61,6 +61,8 @@ export const ProvidersIdEnum = {
   EazySms: "eazy-sms",
   Mobishastra: "mobishastra",
   AfroMessage: "afro-message",
+  Smsmode: "smsmode",
+  Imedia: "imedia",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/severitylevelenum.ts

@@ -0,0 +1,41 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Severity level of the workflow
+ */
+export const SeverityLevelEnum = {
+  High: "high",
+  Medium: "medium",
+  Low: "low",
+  None: "none",
+} as const;
+/**
+ * Severity level of the workflow
+ */
+export type SeverityLevelEnum = ClosedEnum<typeof SeverityLevelEnum>;
+
+/** @internal */
+export const SeverityLevelEnum$inboundSchema: z.ZodNativeEnum<
+  typeof SeverityLevelEnum
+> = z.nativeEnum(SeverityLevelEnum);
+
+/** @internal */
+export const SeverityLevelEnum$outboundSchema: z.ZodNativeEnum<
+  typeof SeverityLevelEnum
+> = SeverityLevelEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SeverityLevelEnum$ {
+  /** @deprecated use `SeverityLevelEnum$inboundSchema` instead. */
+  export const inboundSchema = SeverityLevelEnum$inboundSchema;
+  /** @deprecated use `SeverityLevelEnum$outboundSchema` instead. */
+  export const outboundSchema = SeverityLevelEnum$outboundSchema;
+}

package/src/models/components/stepsoverrides.ts

@@ -11,7 +11,11 @@ export type StepsOverrides = {
   /**
    * Passing the provider id and the provider specific configurations
    */
-  providers: { [k: string]: { [k: string]: any } };
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  /**
+   * Override the or remove the layout for this specific step
+   */
+  layoutId?: string | null | undefined;
 };
 
 /** @internal */
@@ -20,12 +24,14 @@ export const StepsOverrides$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  providers: z.record(z.record(z.any())),
+  providers: z.record(z.record(z.any())).optional(),
+  layoutId: z.nullable(z.string()).optional(),
 });
 
 /** @internal */
 export type StepsOverrides$Outbound = {
-  providers: { [k: string]: { [k: string]: any } };
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  layoutId?: string | null | undefined;
 };
 
 /** @internal */
@@ -34,7 +40,8 @@ export const StepsOverrides$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   StepsOverrides
 > = z.object({
-  providers: z.record(z.record(z.any())),
+  providers: z.record(z.record(z.any())).optional(),
+  layoutId: z.nullable(z.string()).optional(),
 });
 
 /**

package/src/models/components/triggereventrequestdto.ts

@@ -7,6 +7,12 @@ 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 {
+  EmailChannelOverrides,
+  EmailChannelOverrides$inboundSchema,
+  EmailChannelOverrides$Outbound,
+  EmailChannelOverrides$outboundSchema,
+} from "./emailchanneloverrides.js";
 import {
   StepsOverrides,
   StepsOverrides$inboundSchema,
@@ -32,14 +38,28 @@ import {
   TopicPayloadDto$outboundSchema,
 } from "./topicpayloaddto.js";
 
+/**
+ * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+ */
+export type Channels = {
+  /**
+   * Email channel specific overrides
+   */
+  email?: EmailChannelOverrides | undefined;
+};
+
 /**
  * This could be used to override provider specific configurations
  */
 export type Overrides = {
   /**
-   * This could be used to override provider specific configurations
+   * This could be used to override provider specific configurations or layout at the step level
    */
   steps?: { [k: string]: StepsOverrides } | undefined;
+  /**
+   * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+   */
+  channels?: Channels | undefined;
   /**
    * Overrides the provider configuration for the entire workflow and all steps
    */
@@ -129,7 +149,10 @@ export type TriggerEventRequestDto = {
     | Array<TopicPayloadDto | SubscriberPayloadDto | string>
     | string;
   /**
-   * A unique identifier for this transaction, we will generate a UUID if not provided.
+   * A unique identifier for deduplication. If the same **transactionId** is sent again,
+   *
+   * @remarks
+   *       the trigger is ignored. Useful to prevent duplicate notifications. The retention period depends on your billing tier.
    */
   transactionId?: string | undefined;
   /**
@@ -148,6 +171,56 @@ export type TriggerEventRequestDto = {
   tenant?: TenantPayloadDto | string | undefined;
 };
 
+/** @internal */
+export const Channels$inboundSchema: z.ZodType<
+  Channels,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: EmailChannelOverrides$inboundSchema.optional(),
+});
+
+/** @internal */
+export type Channels$Outbound = {
+  email?: EmailChannelOverrides$Outbound | undefined;
+};
+
+/** @internal */
+export const Channels$outboundSchema: z.ZodType<
+  Channels$Outbound,
+  z.ZodTypeDef,
+  Channels
+> = z.object({
+  email: EmailChannelOverrides$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 Channels$ {
+  /** @deprecated use `Channels$inboundSchema` instead. */
+  export const inboundSchema = Channels$inboundSchema;
+  /** @deprecated use `Channels$outboundSchema` instead. */
+  export const outboundSchema = Channels$outboundSchema;
+  /** @deprecated use `Channels$Outbound` instead. */
+  export type Outbound = Channels$Outbound;
+}
+
+export function channelsToJSON(channels: Channels): string {
+  return JSON.stringify(Channels$outboundSchema.parse(channels));
+}
+
+export function channelsFromJSON(
+  jsonString: string,
+): SafeParseResult<Channels, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Channels$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Channels' from JSON`,
+  );
+}
+
 /** @internal */
 export const Overrides$inboundSchema: z.ZodType<
   Overrides,
@@ -155,6 +228,7 @@ export const Overrides$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   steps: z.record(StepsOverrides$inboundSchema).optional(),
+  channels: z.lazy(() => Channels$inboundSchema).optional(),
   providers: z.record(z.record(z.any())).optional(),
   email: z.record(z.any()).optional(),
   push: z.record(z.any()).optional(),
@@ -166,6 +240,7 @@ export const Overrides$inboundSchema: z.ZodType<
 /** @internal */
 export type Overrides$Outbound = {
   steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
+  channels?: Channels$Outbound | undefined;
   providers?: { [k: string]: { [k: string]: any } } | undefined;
   email?: { [k: string]: any } | undefined;
   push?: { [k: string]: any } | undefined;
@@ -181,6 +256,7 @@ export const Overrides$outboundSchema: z.ZodType<
   Overrides
 > = z.object({
   steps: z.record(StepsOverrides$outboundSchema).optional(),
+  channels: z.lazy(() => Channels$outboundSchema).optional(),
   providers: z.record(z.record(z.any())).optional(),
   email: z.record(z.any()).optional(),
   push: z.record(z.any()).optional(),

package/src/models/components/triggereventtoallrequestdto.ts

@@ -10,6 +10,12 @@ import {
 } from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  EmailChannelOverrides,
+  EmailChannelOverrides$inboundSchema,
+  EmailChannelOverrides$Outbound,
+  EmailChannelOverrides$outboundSchema,
+} from "./emailchanneloverrides.js";
 import {
   StepsOverrides,
   StepsOverrides$inboundSchema,
@@ -29,14 +35,28 @@ import {
   TenantPayloadDto$outboundSchema,
 } from "./tenantpayloaddto.js";
 
+/**
+ * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+ */
+export type TriggerEventToAllRequestDtoChannels = {
+  /**
+   * Email channel specific overrides
+   */
+  email?: EmailChannelOverrides | undefined;
+};
+
 /**
  * This could be used to override provider specific configurations
  */
 export type TriggerEventToAllRequestDtoOverrides = {
   /**
-   * This could be used to override provider specific configurations
+   * This could be used to override provider specific configurations or layout at the step level
    */
   steps?: { [k: string]: StepsOverrides } | undefined;
+  /**
+   * Channel-specific overrides that apply to all steps of a particular channel type. Step-level overrides take precedence over channel-level overrides.
+   */
+  channels?: TriggerEventToAllRequestDtoChannels | undefined;
   /**
    * Overrides the provider configuration for the entire workflow and all steps
    */
@@ -127,6 +147,65 @@ export type TriggerEventToAllRequestDto = {
   tenant?: TenantPayloadDto | string | undefined;
 };
 
+/** @internal */
+export const TriggerEventToAllRequestDtoChannels$inboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoChannels,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  email: EmailChannelOverrides$inboundSchema.optional(),
+});
+
+/** @internal */
+export type TriggerEventToAllRequestDtoChannels$Outbound = {
+  email?: EmailChannelOverrides$Outbound | undefined;
+};
+
+/** @internal */
+export const TriggerEventToAllRequestDtoChannels$outboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoChannels$Outbound,
+  z.ZodTypeDef,
+  TriggerEventToAllRequestDtoChannels
+> = z.object({
+  email: EmailChannelOverrides$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 TriggerEventToAllRequestDtoChannels$ {
+  /** @deprecated use `TriggerEventToAllRequestDtoChannels$inboundSchema` instead. */
+  export const inboundSchema =
+    TriggerEventToAllRequestDtoChannels$inboundSchema;
+  /** @deprecated use `TriggerEventToAllRequestDtoChannels$outboundSchema` instead. */
+  export const outboundSchema =
+    TriggerEventToAllRequestDtoChannels$outboundSchema;
+  /** @deprecated use `TriggerEventToAllRequestDtoChannels$Outbound` instead. */
+  export type Outbound = TriggerEventToAllRequestDtoChannels$Outbound;
+}
+
+export function triggerEventToAllRequestDtoChannelsToJSON(
+  triggerEventToAllRequestDtoChannels: TriggerEventToAllRequestDtoChannels,
+): string {
+  return JSON.stringify(
+    TriggerEventToAllRequestDtoChannels$outboundSchema.parse(
+      triggerEventToAllRequestDtoChannels,
+    ),
+  );
+}
+
+export function triggerEventToAllRequestDtoChannelsFromJSON(
+  jsonString: string,
+): SafeParseResult<TriggerEventToAllRequestDtoChannels, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      TriggerEventToAllRequestDtoChannels$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TriggerEventToAllRequestDtoChannels' from JSON`,
+  );
+}
+
 /** @internal */
 export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
   TriggerEventToAllRequestDtoOverrides,
@@ -135,6 +214,8 @@ export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
 > = collectExtraKeys$(
   z.object({
     steps: z.record(StepsOverrides$inboundSchema).optional(),
+    channels: z.lazy(() => TriggerEventToAllRequestDtoChannels$inboundSchema)
+      .optional(),
     providers: z.record(z.record(z.any())).optional(),
     email: z.record(z.any()).optional(),
     push: z.record(z.any()).optional(),
@@ -149,6 +230,7 @@ export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
 /** @internal */
 export type TriggerEventToAllRequestDtoOverrides$Outbound = {
   steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
+  channels?: TriggerEventToAllRequestDtoChannels$Outbound | undefined;
   providers?: { [k: string]: { [k: string]: any } } | undefined;
   email?: { [k: string]: any } | undefined;
   push?: { [k: string]: any } | undefined;
@@ -165,6 +247,8 @@ export const TriggerEventToAllRequestDtoOverrides$outboundSchema: z.ZodType<
   TriggerEventToAllRequestDtoOverrides
 > = z.object({
   steps: z.record(StepsOverrides$outboundSchema).optional(),
+  channels: z.lazy(() => TriggerEventToAllRequestDtoChannels$outboundSchema)
+    .optional(),
   providers: z.record(z.record(z.any())).optional(),
   email: z.record(z.any()).optional(),
   push: z.record(z.any()).optional(),