@novu/api 0.6.2 → 1.0.0

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,
 });

package/src/models/components/updatetopicrequestdto.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 UpdateTopicRequestDto = {
+  /**
+   * The display name for the topic
+   */
+  name: string;
+};
+
+/** @internal */
+export const UpdateTopicRequestDto$inboundSchema: z.ZodType<
+  UpdateTopicRequestDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  name: z.string(),
+});
+
+/** @internal */
+export type UpdateTopicRequestDto$Outbound = {
+  name: string;
+};
+
+/** @internal */
+export const UpdateTopicRequestDto$outboundSchema: z.ZodType<
+  UpdateTopicRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateTopicRequestDto
+> = 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 UpdateTopicRequestDto$ {
+  /** @deprecated use `UpdateTopicRequestDto$inboundSchema` instead. */
+  export const inboundSchema = UpdateTopicRequestDto$inboundSchema;
+  /** @deprecated use `UpdateTopicRequestDto$outboundSchema` instead. */
+  export const outboundSchema = UpdateTopicRequestDto$outboundSchema;
+  /** @deprecated use `UpdateTopicRequestDto$Outbound` instead. */
+  export type Outbound = UpdateTopicRequestDto$Outbound;
+}
+
+export function updateTopicRequestDtoToJSON(
+  updateTopicRequestDto: UpdateTopicRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateTopicRequestDto$outboundSchema.parse(updateTopicRequestDto),
+  );
+}
+
+export function updateTopicRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<UpdateTopicRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => UpdateTopicRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'UpdateTopicRequestDto' from JSON`,
+  );
+}

package/src/models/components/workflowresponse.ts

@@ -26,11 +26,11 @@ import {
   NotificationTrigger$outboundSchema,
 } from "./notificationtrigger.js";
 import {
-  PreferenceChannels,
-  PreferenceChannels$inboundSchema,
-  PreferenceChannels$Outbound,
-  PreferenceChannels$outboundSchema,
-} from "./preferencechannels.js";
+  SubscriberPreferenceChannels,
+  SubscriberPreferenceChannels$inboundSchema,
+  SubscriberPreferenceChannels$Outbound,
+  SubscriberPreferenceChannels$outboundSchema,
+} from "./subscriberpreferencechannels.js";
 
 export type WorkflowResponseData = {};
 
@@ -42,7 +42,7 @@ export type WorkflowResponse = {
   description: string;
   active: boolean;
   draft: boolean;
-  preferenceSettings: PreferenceChannels;
+  preferenceSettings: SubscriberPreferenceChannels;
   critical: boolean;
   tags: Array<string>;
   steps: Array<NotificationStepDto>;
@@ -167,7 +167,7 @@ export const WorkflowResponse$inboundSchema: z.ZodType<
   description: z.string(),
   active: z.boolean(),
   draft: z.boolean(),
-  preferenceSettings: PreferenceChannels$inboundSchema,
+  preferenceSettings: SubscriberPreferenceChannels$inboundSchema,
   critical: z.boolean(),
   tags: z.array(z.string()),
   steps: z.array(NotificationStepDto$inboundSchema),
@@ -203,7 +203,7 @@ export type WorkflowResponse$Outbound = {
   description: string;
   active: boolean;
   draft: boolean;
-  preferenceSettings: PreferenceChannels$Outbound;
+  preferenceSettings: SubscriberPreferenceChannels$Outbound;
   critical: boolean;
   tags: Array<string>;
   steps: Array<NotificationStepDto$Outbound>;
@@ -232,7 +232,7 @@ export const WorkflowResponse$outboundSchema: z.ZodType<
   description: z.string(),
   active: z.boolean(),
   draft: z.boolean(),
-  preferenceSettings: PreferenceChannels$outboundSchema,
+  preferenceSettings: SubscriberPreferenceChannels$outboundSchema,
   critical: z.boolean(),
   tags: z.array(z.string()),
   steps: z.array(NotificationStepDto$outboundSchema),

package/src/models/errors/errordto.ts

@@ -3,6 +3,23 @@
  */
 
 import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "./sdkvalidationerror.js";
+
+export type Five = string | number | boolean | { [k: string]: any };
+
+export type Four = {};
+
+/**
+ * Value that failed validation
+ */
+export type Message =
+  | Four
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean | { [k: string]: any } | null>;
 
 export type ErrorDtoData = {
   /**
@@ -18,9 +35,16 @@ export type ErrorDtoData = {
    */
   path: string;
   /**
-   * A detailed error message.
+   * Value that failed validation
    */
-  message: string;
+  message?:
+    | Four
+    | string
+    | number
+    | boolean
+    | Array<string | number | boolean | { [k: string]: any } | null>
+    | null
+    | undefined;
   /**
    * Optional context object for additional error details.
    */
@@ -79,6 +103,148 @@ export class ErrorDto extends Error {
   }
 }
 
+/** @internal */
+export const Five$inboundSchema: z.ZodType<Five, z.ZodTypeDef, unknown> = z
+  .union([z.string(), z.number(), z.boolean(), z.record(z.any())]);
+
+/** @internal */
+export type Five$Outbound = string | number | boolean | { [k: string]: any };
+
+/** @internal */
+export const Five$outboundSchema: z.ZodType<Five$Outbound, z.ZodTypeDef, Five> =
+  z.union([z.string(), z.number(), z.boolean(), 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 Five$ {
+  /** @deprecated use `Five$inboundSchema` instead. */
+  export const inboundSchema = Five$inboundSchema;
+  /** @deprecated use `Five$outboundSchema` instead. */
+  export const outboundSchema = Five$outboundSchema;
+  /** @deprecated use `Five$Outbound` instead. */
+  export type Outbound = Five$Outbound;
+}
+
+export function fiveToJSON(five: Five): string {
+  return JSON.stringify(Five$outboundSchema.parse(five));
+}
+
+export function fiveFromJSON(
+  jsonString: string,
+): SafeParseResult<Five, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Five$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Five' from JSON`,
+  );
+}
+
+/** @internal */
+export const Four$inboundSchema: z.ZodType<Four, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Four$Outbound = {};
+
+/** @internal */
+export const Four$outboundSchema: z.ZodType<Four$Outbound, z.ZodTypeDef, Four> =
+  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 Four$ {
+  /** @deprecated use `Four$inboundSchema` instead. */
+  export const inboundSchema = Four$inboundSchema;
+  /** @deprecated use `Four$outboundSchema` instead. */
+  export const outboundSchema = Four$outboundSchema;
+  /** @deprecated use `Four$Outbound` instead. */
+  export type Outbound = Four$Outbound;
+}
+
+export function fourToJSON(four: Four): string {
+  return JSON.stringify(Four$outboundSchema.parse(four));
+}
+
+export function fourFromJSON(
+  jsonString: string,
+): SafeParseResult<Four, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Four$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Four' from JSON`,
+  );
+}
+
+/** @internal */
+export const Message$inboundSchema: z.ZodType<Message, z.ZodTypeDef, unknown> =
+  z.union([
+    z.lazy(() => Four$inboundSchema),
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(
+      z.nullable(
+        z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+      ),
+    ),
+  ]);
+
+/** @internal */
+export type Message$Outbound =
+  | Four$Outbound
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean | { [k: string]: any } | null>;
+
+/** @internal */
+export const Message$outboundSchema: z.ZodType<
+  Message$Outbound,
+  z.ZodTypeDef,
+  Message
+> = z.union([
+  z.lazy(() => Four$outboundSchema),
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(
+    z.nullable(
+      z.union([z.string(), z.number(), z.boolean(), 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 Message$ {
+  /** @deprecated use `Message$inboundSchema` instead. */
+  export const inboundSchema = Message$inboundSchema;
+  /** @deprecated use `Message$outboundSchema` instead. */
+  export const outboundSchema = Message$outboundSchema;
+  /** @deprecated use `Message$Outbound` instead. */
+  export type Outbound = Message$Outbound;
+}
+
+export function messageToJSON(message: Message): string {
+  return JSON.stringify(Message$outboundSchema.parse(message));
+}
+
+export function messageFromJSON(
+  jsonString: string,
+): SafeParseResult<Message, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Message$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Message' from JSON`,
+  );
+}
+
 /** @internal */
 export const ErrorDto$inboundSchema: z.ZodType<
   ErrorDto,
@@ -88,7 +254,19 @@ export const ErrorDto$inboundSchema: z.ZodType<
   statusCode: z.number(),
   timestamp: z.string(),
   path: z.string(),
-  message: z.string(),
+  message: z.nullable(
+    z.union([
+      z.lazy(() => Four$inboundSchema),
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.array(
+        z.nullable(
+          z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+        ),
+      ),
+    ]),
+  ).optional(),
   ctx: z.record(z.any()).optional(),
   errorId: z.string().optional(),
 })
@@ -101,7 +279,14 @@ export type ErrorDto$Outbound = {
   statusCode: number;
   timestamp: string;
   path: string;
-  message: string;
+  message?:
+    | Four$Outbound
+    | string
+    | number
+    | boolean
+    | Array<string | number | boolean | { [k: string]: any } | null>
+    | null
+    | undefined;
   ctx?: { [k: string]: any } | undefined;
   errorId?: string | undefined;
 };
@@ -117,7 +302,19 @@ export const ErrorDto$outboundSchema: z.ZodType<
     statusCode: z.number(),
     timestamp: z.string(),
     path: z.string(),
-    message: z.string(),
+    message: z.nullable(
+      z.union([
+        z.lazy(() => Four$outboundSchema),
+        z.string(),
+        z.number(),
+        z.boolean(),
+        z.array(
+          z.nullable(
+            z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+          ),
+        ),
+      ]),
+    ).optional(),
     ctx: z.record(z.any()).optional(),
     errorId: z.string().optional(),
   }));