@novu/api 0.6.1 → 0.7.0

package/src/models/components/subscriberworkflowpreferencedto.ts

@@ -0,0 +1,110 @@
+/*
+ * 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 {
+  SubscriberPreferenceChannels,
+  SubscriberPreferenceChannels$inboundSchema,
+  SubscriberPreferenceChannels$Outbound,
+  SubscriberPreferenceChannels$outboundSchema,
+} from "./subscriberpreferencechannels.js";
+import {
+  SubscriberPreferenceOverrideDto,
+  SubscriberPreferenceOverrideDto$inboundSchema,
+  SubscriberPreferenceOverrideDto$Outbound,
+  SubscriberPreferenceOverrideDto$outboundSchema,
+} from "./subscriberpreferenceoverridedto.js";
+import {
+  SubscriberPreferencesWorkflowInfoDto,
+  SubscriberPreferencesWorkflowInfoDto$inboundSchema,
+  SubscriberPreferencesWorkflowInfoDto$Outbound,
+  SubscriberPreferencesWorkflowInfoDto$outboundSchema,
+} from "./subscriberpreferencesworkflowinfodto.js";
+
+export type SubscriberWorkflowPreferenceDto = {
+  /**
+   * Whether notifications are enabled for this workflow
+   */
+  enabled: boolean;
+  /**
+   * Channel-specific preference settings for this workflow
+   */
+  channels: SubscriberPreferenceChannels;
+  /**
+   * List of preference overrides
+   */
+  overrides: Array<SubscriberPreferenceOverrideDto>;
+  /**
+   * Workflow information
+   */
+  workflow: SubscriberPreferencesWorkflowInfoDto;
+};
+
+/** @internal */
+export const SubscriberWorkflowPreferenceDto$inboundSchema: z.ZodType<
+  SubscriberWorkflowPreferenceDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$inboundSchema,
+  overrides: z.array(SubscriberPreferenceOverrideDto$inboundSchema),
+  workflow: SubscriberPreferencesWorkflowInfoDto$inboundSchema,
+});
+
+/** @internal */
+export type SubscriberWorkflowPreferenceDto$Outbound = {
+  enabled: boolean;
+  channels: SubscriberPreferenceChannels$Outbound;
+  overrides: Array<SubscriberPreferenceOverrideDto$Outbound>;
+  workflow: SubscriberPreferencesWorkflowInfoDto$Outbound;
+};
+
+/** @internal */
+export const SubscriberWorkflowPreferenceDto$outboundSchema: z.ZodType<
+  SubscriberWorkflowPreferenceDto$Outbound,
+  z.ZodTypeDef,
+  SubscriberWorkflowPreferenceDto
+> = z.object({
+  enabled: z.boolean(),
+  channels: SubscriberPreferenceChannels$outboundSchema,
+  overrides: z.array(SubscriberPreferenceOverrideDto$outboundSchema),
+  workflow: SubscriberPreferencesWorkflowInfoDto$outboundSchema,
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace SubscriberWorkflowPreferenceDto$ {
+  /** @deprecated use `SubscriberWorkflowPreferenceDto$inboundSchema` instead. */
+  export const inboundSchema = SubscriberWorkflowPreferenceDto$inboundSchema;
+  /** @deprecated use `SubscriberWorkflowPreferenceDto$outboundSchema` instead. */
+  export const outboundSchema = SubscriberWorkflowPreferenceDto$outboundSchema;
+  /** @deprecated use `SubscriberWorkflowPreferenceDto$Outbound` instead. */
+  export type Outbound = SubscriberWorkflowPreferenceDto$Outbound;
+}
+
+export function subscriberWorkflowPreferenceDtoToJSON(
+  subscriberWorkflowPreferenceDto: SubscriberWorkflowPreferenceDto,
+): string {
+  return JSON.stringify(
+    SubscriberWorkflowPreferenceDto$outboundSchema.parse(
+      subscriberWorkflowPreferenceDto,
+    ),
+  );
+}
+
+export function subscriberWorkflowPreferenceDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<SubscriberWorkflowPreferenceDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => SubscriberWorkflowPreferenceDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'SubscriberWorkflowPreferenceDto' from JSON`,
+  );
+}

package/src/models/components/timedconfig.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export const TimedConfigWeekDays = {
+export const WeekDays = {
   Monday: "monday",
   Tuesday: "tuesday",
   Wednesday: "wednesday",
@@ -17,7 +17,7 @@ export const TimedConfigWeekDays = {
   Saturday: "saturday",
   Sunday: "sunday",
 } as const;
-export type TimedConfigWeekDays = ClosedEnum<typeof TimedConfigWeekDays>;
+export type WeekDays = ClosedEnum<typeof WeekDays>;
 
 export const Ordinal = {
   One: "1",
@@ -51,7 +51,7 @@ export type MonthlyType = ClosedEnum<typeof MonthlyType>;
 
 export type TimedConfig = {
   atTime?: string | undefined;
-  weekDays?: Array<TimedConfigWeekDays> | undefined;
+  weekDays?: Array<WeekDays> | undefined;
   monthDays?: Array<string> | undefined;
   ordinal?: Ordinal | undefined;
   ordinalValue?: OrdinalValue | undefined;
@@ -59,24 +59,22 @@ export type TimedConfig = {
 };
 
 /** @internal */
-export const TimedConfigWeekDays$inboundSchema: z.ZodNativeEnum<
-  typeof TimedConfigWeekDays
-> = z.nativeEnum(TimedConfigWeekDays);
+export const WeekDays$inboundSchema: z.ZodNativeEnum<typeof WeekDays> = z
+  .nativeEnum(WeekDays);
 
 /** @internal */
-export const TimedConfigWeekDays$outboundSchema: z.ZodNativeEnum<
-  typeof TimedConfigWeekDays
-> = TimedConfigWeekDays$inboundSchema;
+export const WeekDays$outboundSchema: z.ZodNativeEnum<typeof WeekDays> =
+  WeekDays$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace TimedConfigWeekDays$ {
-  /** @deprecated use `TimedConfigWeekDays$inboundSchema` instead. */
-  export const inboundSchema = TimedConfigWeekDays$inboundSchema;
-  /** @deprecated use `TimedConfigWeekDays$outboundSchema` instead. */
-  export const outboundSchema = TimedConfigWeekDays$outboundSchema;
+export namespace WeekDays$ {
+  /** @deprecated use `WeekDays$inboundSchema` instead. */
+  export const inboundSchema = WeekDays$inboundSchema;
+  /** @deprecated use `WeekDays$outboundSchema` instead. */
+  export const outboundSchema = WeekDays$outboundSchema;
 }
 
 /** @internal */
@@ -143,7 +141,7 @@ export const TimedConfig$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   atTime: z.string().optional(),
-  weekDays: z.array(TimedConfigWeekDays$inboundSchema).optional(),
+  weekDays: z.array(WeekDays$inboundSchema).optional(),
   monthDays: z.array(z.string()).optional(),
   ordinal: Ordinal$inboundSchema.optional(),
   ordinalValue: OrdinalValue$inboundSchema.optional(),
@@ -167,7 +165,7 @@ export const TimedConfig$outboundSchema: z.ZodType<
   TimedConfig
 > = z.object({
   atTime: z.string().optional(),
-  weekDays: z.array(TimedConfigWeekDays$outboundSchema).optional(),
+  weekDays: z.array(WeekDays$outboundSchema).optional(),
   monthDays: z.array(z.string()).optional(),
   ordinal: Ordinal$outboundSchema.optional(),
   ordinalValue: OrdinalValue$outboundSchema.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 {
+  StepsOverrides,
+  StepsOverrides$inboundSchema,
+  StepsOverrides$Outbound,
+  StepsOverrides$outboundSchema,
+} from "./stepsoverrides.js";
 import {
   SubscriberPayloadDto,
   SubscriberPayloadDto$inboundSchema,
@@ -26,6 +32,50 @@ import {
   TopicPayloadDto$outboundSchema,
 } from "./topicpayloaddto.js";
 
+/**
+ * This could be used to override provider specific configurations
+ */
+export type Overrides = {
+  /**
+   * This could be used to override provider specific configurations
+   */
+  steps?: { [k: string]: StepsOverrides } | undefined;
+  /**
+   * Overrides the provider configuration for the entire workflow and all steps
+   */
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  /**
+   * Override the email provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  email?: { [k: string]: any } | undefined;
+  /**
+   * Override the push provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  push?: { [k: string]: any } | undefined;
+  /**
+   * Override the sms provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  sms?: { [k: string]: any } | undefined;
+  /**
+   * Override the chat provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  chat?: { [k: string]: any } | undefined;
+  /**
+   * Override the layout identifier for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  layoutIdentifier?: string | undefined;
+};
+
 export type One = TopicPayloadDto | SubscriberPayloadDto | string;
 
 /**
@@ -69,7 +119,7 @@ export type TriggerEventRequestDto = {
   /**
    * This could be used to override provider specific configurations
    */
-  overrides?: { [k: string]: { [k: string]: any } } | undefined;
+  overrides?: Overrides | undefined;
   /**
    * The recipients list of people who will receive the notification.
    */
@@ -98,6 +148,74 @@ export type TriggerEventRequestDto = {
   tenant?: TenantPayloadDto | string | undefined;
 };
 
+/** @internal */
+export const Overrides$inboundSchema: z.ZodType<
+  Overrides,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  steps: z.record(StepsOverrides$inboundSchema).optional(),
+  providers: z.record(z.record(z.any())).optional(),
+  email: z.record(z.any()).optional(),
+  push: z.record(z.any()).optional(),
+  sms: z.record(z.any()).optional(),
+  chat: z.record(z.any()).optional(),
+  layoutIdentifier: z.string().optional(),
+});
+
+/** @internal */
+export type Overrides$Outbound = {
+  steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  email?: { [k: string]: any } | undefined;
+  push?: { [k: string]: any } | undefined;
+  sms?: { [k: string]: any } | undefined;
+  chat?: { [k: string]: any } | undefined;
+  layoutIdentifier?: string | undefined;
+};
+
+/** @internal */
+export const Overrides$outboundSchema: z.ZodType<
+  Overrides$Outbound,
+  z.ZodTypeDef,
+  Overrides
+> = z.object({
+  steps: z.record(StepsOverrides$outboundSchema).optional(),
+  providers: z.record(z.record(z.any())).optional(),
+  email: z.record(z.any()).optional(),
+  push: z.record(z.any()).optional(),
+  sms: z.record(z.any()).optional(),
+  chat: z.record(z.any()).optional(),
+  layoutIdentifier: 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 Overrides$ {
+  /** @deprecated use `Overrides$inboundSchema` instead. */
+  export const inboundSchema = Overrides$inboundSchema;
+  /** @deprecated use `Overrides$outboundSchema` instead. */
+  export const outboundSchema = Overrides$outboundSchema;
+  /** @deprecated use `Overrides$Outbound` instead. */
+  export type Outbound = Overrides$Outbound;
+}
+
+export function overridesToJSON(overrides: Overrides): string {
+  return JSON.stringify(Overrides$outboundSchema.parse(overrides));
+}
+
+export function overridesFromJSON(
+  jsonString: string,
+): SafeParseResult<Overrides, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Overrides$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Overrides' from JSON`,
+  );
+}
+
 /** @internal */
 export const One$inboundSchema: z.ZodType<One, z.ZodTypeDef, unknown> = z.union(
   [
@@ -301,7 +419,7 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
 > = z.object({
   name: z.string(),
   payload: z.record(z.any()).optional(),
-  overrides: z.record(z.record(z.any())).optional(),
+  overrides: z.lazy(() => Overrides$inboundSchema).optional(),
   to: z.union([
     TopicPayloadDto$inboundSchema,
     SubscriberPayloadDto$inboundSchema,
@@ -327,7 +445,7 @@ export const TriggerEventRequestDto$inboundSchema: z.ZodType<
 export type TriggerEventRequestDto$Outbound = {
   name: string;
   payload?: { [k: string]: any } | undefined;
-  overrides?: { [k: string]: { [k: string]: any } } | undefined;
+  overrides?: Overrides$Outbound | undefined;
   to:
     | TopicPayloadDto$Outbound
     | SubscriberPayloadDto$Outbound
@@ -346,7 +464,7 @@ export const TriggerEventRequestDto$outboundSchema: z.ZodType<
 > = z.object({
   workflowId: z.string(),
   payload: z.record(z.any()).optional(),
-  overrides: z.record(z.record(z.any())).optional(),
+  overrides: z.lazy(() => Overrides$outboundSchema).optional(),
   to: z.union([
     TopicPayloadDto$outboundSchema,
     SubscriberPayloadDto$outboundSchema,

package/src/models/components/triggereventtoallrequestdto.ts

@@ -3,9 +3,19 @@
  */
 
 import * as z from "zod";
-import { safeParse } from "../../lib/schemas.js";
+import { remap as remap$ } from "../../lib/primitives.js";
+import {
+  collectExtraKeys as collectExtraKeys$,
+  safeParse,
+} from "../../lib/schemas.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
+import {
+  StepsOverrides,
+  StepsOverrides$inboundSchema,
+  StepsOverrides$Outbound,
+  StepsOverrides$outboundSchema,
+} from "./stepsoverrides.js";
 import {
   SubscriberPayloadDto,
   SubscriberPayloadDto$inboundSchema,
@@ -22,7 +32,47 @@ import {
 /**
  * This could be used to override provider specific configurations
  */
-export type TriggerEventToAllRequestDtoOverrides = {};
+export type TriggerEventToAllRequestDtoOverrides = {
+  /**
+   * This could be used to override provider specific configurations
+   */
+  steps?: { [k: string]: StepsOverrides } | undefined;
+  /**
+   * Overrides the provider configuration for the entire workflow and all steps
+   */
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  /**
+   * Override the email provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  email?: { [k: string]: any } | undefined;
+  /**
+   * Override the push provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  push?: { [k: string]: any } | undefined;
+  /**
+   * Override the sms provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  sms?: { [k: string]: any } | undefined;
+  /**
+   * Override the chat provider specific configurations for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  chat?: { [k: string]: any } | undefined;
+  /**
+   * Override the layout identifier for the entire workflow
+   *
+   * @deprecated field: This will be removed in a future release, please migrate away from it as soon as possible.
+   */
+  layoutIdentifier?: string | undefined;
+  additionalProperties?: { [k: string]: { [k: string]: any } };
+};
 
 /**
  * It is used to display the Avatar of the provided actor's subscriber id or actor object.
@@ -82,17 +132,54 @@ export const TriggerEventToAllRequestDtoOverrides$inboundSchema: z.ZodType<
   TriggerEventToAllRequestDtoOverrides,
   z.ZodTypeDef,
   unknown
-> = z.object({});
+> = collectExtraKeys$(
+  z.object({
+    steps: z.record(StepsOverrides$inboundSchema).optional(),
+    providers: z.record(z.record(z.any())).optional(),
+    email: z.record(z.any()).optional(),
+    push: z.record(z.any()).optional(),
+    sms: z.record(z.any()).optional(),
+    chat: z.record(z.any()).optional(),
+    layoutIdentifier: z.string().optional(),
+  }).catchall(z.record(z.any())),
+  "additionalProperties",
+  true,
+);
 
 /** @internal */
-export type TriggerEventToAllRequestDtoOverrides$Outbound = {};
+export type TriggerEventToAllRequestDtoOverrides$Outbound = {
+  steps?: { [k: string]: StepsOverrides$Outbound } | undefined;
+  providers?: { [k: string]: { [k: string]: any } } | undefined;
+  email?: { [k: string]: any } | undefined;
+  push?: { [k: string]: any } | undefined;
+  sms?: { [k: string]: any } | undefined;
+  chat?: { [k: string]: any } | undefined;
+  layoutIdentifier?: string | undefined;
+  [additionalProperties: string]: unknown;
+};
 
 /** @internal */
 export const TriggerEventToAllRequestDtoOverrides$outboundSchema: z.ZodType<
   TriggerEventToAllRequestDtoOverrides$Outbound,
   z.ZodTypeDef,
   TriggerEventToAllRequestDtoOverrides
-> = z.object({});
+> = z.object({
+  steps: z.record(StepsOverrides$outboundSchema).optional(),
+  providers: z.record(z.record(z.any())).optional(),
+  email: z.record(z.any()).optional(),
+  push: z.record(z.any()).optional(),
+  sms: z.record(z.any()).optional(),
+  chat: z.record(z.any()).optional(),
+  layoutIdentifier: z.string().optional(),
+  additionalProperties: z.record(z.record(z.any())),
+}).transform((v) => {
+  return {
+    ...v.additionalProperties,
+    ...remap$(v, {
+      additionalProperties: null,
+    }),
+  };
+});
 
 /**
  * @internal

package/src/models/components/updatesubscriberchannelrequestdto.ts

@@ -4,7 +4,6 @@
 
 import * as z from "zod";
 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 {
@@ -13,41 +12,17 @@ import {
   ChannelCredentials$Outbound,
   ChannelCredentials$outboundSchema,
 } from "./channelcredentials.js";
-
-/**
- * The provider identifier for the credentials
- */
-export const UpdateSubscriberChannelRequestDtoProviderId = {
-  Slack: "slack",
-  Discord: "discord",
-  Msteams: "msteams",
-  Mattermost: "mattermost",
-  Ryver: "ryver",
-  Zulip: "zulip",
-  GrafanaOnCall: "grafana-on-call",
-  Getstream: "getstream",
-  RocketChat: "rocket-chat",
-  WhatsappBusiness: "whatsapp-business",
-  Fcm: "fcm",
-  Apns: "apns",
-  Expo: "expo",
-  OneSignal: "one-signal",
-  Pushpad: "pushpad",
-  PushWebhook: "push-webhook",
-  PusherBeams: "pusher-beams",
-} as const;
-/**
- * The provider identifier for the credentials
- */
-export type UpdateSubscriberChannelRequestDtoProviderId = ClosedEnum<
-  typeof UpdateSubscriberChannelRequestDtoProviderId
->;
+import {
+  ChatOrPushProviderEnum,
+  ChatOrPushProviderEnum$inboundSchema,
+  ChatOrPushProviderEnum$outboundSchema,
+} from "./chatorpushproviderenum.js";
 
 export type UpdateSubscriberChannelRequestDto = {
   /**
    * The provider identifier for the credentials
    */
-  providerId: UpdateSubscriberChannelRequestDtoProviderId;
+  providerId: ChatOrPushProviderEnum;
   /**
    * The integration identifier
    */
@@ -58,36 +33,13 @@ export type UpdateSubscriberChannelRequestDto = {
   credentials: ChannelCredentials;
 };
 
-/** @internal */
-export const UpdateSubscriberChannelRequestDtoProviderId$inboundSchema:
-  z.ZodNativeEnum<typeof UpdateSubscriberChannelRequestDtoProviderId> = z
-    .nativeEnum(UpdateSubscriberChannelRequestDtoProviderId);
-
-/** @internal */
-export const UpdateSubscriberChannelRequestDtoProviderId$outboundSchema:
-  z.ZodNativeEnum<typeof UpdateSubscriberChannelRequestDtoProviderId> =
-    UpdateSubscriberChannelRequestDtoProviderId$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace UpdateSubscriberChannelRequestDtoProviderId$ {
-  /** @deprecated use `UpdateSubscriberChannelRequestDtoProviderId$inboundSchema` instead. */
-  export const inboundSchema =
-    UpdateSubscriberChannelRequestDtoProviderId$inboundSchema;
-  /** @deprecated use `UpdateSubscriberChannelRequestDtoProviderId$outboundSchema` instead. */
-  export const outboundSchema =
-    UpdateSubscriberChannelRequestDtoProviderId$outboundSchema;
-}
-
 /** @internal */
 export const UpdateSubscriberChannelRequestDto$inboundSchema: z.ZodType<
   UpdateSubscriberChannelRequestDto,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  providerId: UpdateSubscriberChannelRequestDtoProviderId$inboundSchema,
+  providerId: ChatOrPushProviderEnum$inboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentials$inboundSchema,
 });
@@ -105,7 +57,7 @@ export const UpdateSubscriberChannelRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateSubscriberChannelRequestDto
 > = z.object({
-  providerId: UpdateSubscriberChannelRequestDtoProviderId$outboundSchema,
+  providerId: ChatOrPushProviderEnum$outboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentials$outboundSchema,
 });