@novu/api 3.12.0 → 3.14.0

package/src/lib/sdks.ts

@@ -304,9 +304,9 @@ export class ClientSDK {
   }
 }
 
-const jsonLikeContentTypeRE = /(application|text)\/.*?\+*json.*/;
+const jsonLikeContentTypeRE = /^(application|text)\/([^+]+\+)*json.*/;
 const jsonlLikeContentTypeRE =
-  /(application|text)\/(.*?\+*\bjsonl\b.*|.*?\+*\bx-ndjson\b.*)/;
+  /^(application|text)\/([^+]+\+)*(jsonl|x-ndjson)\b.*/;
 async function logRequest(logger: Logger | undefined, req: Request) {
   if (!logger) {
     return;

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -50,7 +50,7 @@ export type ActivityNotificationJobResponseDtoType = ClosedEnum<
 /**
  * Optional payload for the job
  */
-export type ActivityNotificationJobResponseDtoPayload = {};
+export type Payload = {};
 
 export type ActivityNotificationJobResponseDto = {
   /**
@@ -80,7 +80,7 @@ export type ActivityNotificationJobResponseDto = {
   /**
    * Optional payload for the job
    */
-  payload?: ActivityNotificationJobResponseDtoPayload | undefined;
+  payload?: Payload | undefined;
   /**
    * Provider ID of the job
    */
@@ -106,25 +106,16 @@ export const ActivityNotificationJobResponseDtoType$inboundSchema:
   );
 
 /** @internal */
-export const ActivityNotificationJobResponseDtoPayload$inboundSchema: z.ZodType<
-  ActivityNotificationJobResponseDtoPayload,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
+export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
+  z.object({});
 
-export function activityNotificationJobResponseDtoPayloadFromJSON(
+export function payloadFromJSON(
   jsonString: string,
-): SafeParseResult<
-  ActivityNotificationJobResponseDtoPayload,
-  SDKValidationError
-> {
+): SafeParseResult<Payload, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) =>
-      ActivityNotificationJobResponseDtoPayload$inboundSchema.parse(
-        JSON.parse(x),
-      ),
-    `Failed to parse 'ActivityNotificationJobResponseDtoPayload' from JSON`,
+    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Payload' from JSON`,
   );
 }
 
@@ -142,8 +133,7 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
   ),
   step: ActivityNotificationStepResponseDto$inboundSchema,
   overrides: z.record(z.any()).optional(),
-  payload: z.lazy(() => ActivityNotificationJobResponseDtoPayload$inboundSchema)
-    .optional(),
+  payload: z.lazy(() => Payload$inboundSchema).optional(),
   providerId: ProvidersIdEnum$inboundSchema,
   status: z.string(),
   updatedAt: z.string().optional(),

package/src/models/components/bulkupdatesubscriberpreferencesdto.ts

@@ -9,16 +9,75 @@ import {
   BulkUpdateSubscriberPreferenceItemDto$outboundSchema,
 } from "./bulkupdatesubscriberpreferenceitemdto.js";
 
+/**
+ * Rich context object with id and optional data
+ */
+export type Context2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type BulkUpdateSubscriberPreferencesDtoContext = Context2 | string;
+
 export type BulkUpdateSubscriberPreferencesDto = {
   /**
    * Array of workflow preferences to update (maximum 100 items)
    */
   preferences: Array<BulkUpdateSubscriberPreferenceItemDto>;
+  context?: { [k: string]: Context2 | string } | undefined;
 };
 
+/** @internal */
+export type Context2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const Context2$outboundSchema: z.ZodType<
+  Context2$Outbound,
+  z.ZodTypeDef,
+  Context2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function context2ToJSON(context2: Context2): string {
+  return JSON.stringify(Context2$outboundSchema.parse(context2));
+}
+
+/** @internal */
+export type BulkUpdateSubscriberPreferencesDtoContext$Outbound =
+  | Context2$Outbound
+  | string;
+
+/** @internal */
+export const BulkUpdateSubscriberPreferencesDtoContext$outboundSchema:
+  z.ZodType<
+    BulkUpdateSubscriberPreferencesDtoContext$Outbound,
+    z.ZodTypeDef,
+    BulkUpdateSubscriberPreferencesDtoContext
+  > = z.union([z.lazy(() => Context2$outboundSchema), z.string()]);
+
+export function bulkUpdateSubscriberPreferencesDtoContextToJSON(
+  bulkUpdateSubscriberPreferencesDtoContext:
+    BulkUpdateSubscriberPreferencesDtoContext,
+): string {
+  return JSON.stringify(
+    BulkUpdateSubscriberPreferencesDtoContext$outboundSchema.parse(
+      bulkUpdateSubscriberPreferencesDtoContext,
+    ),
+  );
+}
+
 /** @internal */
 export type BulkUpdateSubscriberPreferencesDto$Outbound = {
   preferences: Array<BulkUpdateSubscriberPreferenceItemDto$Outbound>;
+  context?: { [k: string]: Context2$Outbound | string } | undefined;
 };
 
 /** @internal */
@@ -28,6 +87,9 @@ export const BulkUpdateSubscriberPreferencesDto$outboundSchema: z.ZodType<
   BulkUpdateSubscriberPreferencesDto
 > = z.object({
   preferences: z.array(BulkUpdateSubscriberPreferenceItemDto$outboundSchema),
+  context: z.record(
+    z.union([z.lazy(() => Context2$outboundSchema), z.string()]),
+  ).optional(),
 });
 
 export function bulkUpdateSubscriberPreferencesDtoToJSON(

package/src/models/components/createchannelconnectionrequestdto.ts

@@ -17,7 +17,7 @@ import {
 /**
  * Rich context object with id and optional data
  */
-export type Two = {
+export type CreateChannelConnectionRequestDtoContext2 = {
   id: string;
   /**
    * Optional additional context data
@@ -25,7 +25,9 @@ export type Two = {
   data?: { [k: string]: any } | undefined;
 };
 
-export type Context = Two | string;
+export type CreateChannelConnectionRequestDtoContext =
+  | CreateChannelConnectionRequestDtoContext2
+  | string;
 
 export type CreateChannelConnectionRequestDto = {
   /**
@@ -36,7 +38,9 @@ export type CreateChannelConnectionRequestDto = {
    * The subscriber ID to link the channel connection to
    */
   subscriberId?: string | undefined;
-  context?: { [k: string]: Two | string } | undefined;
+  context?:
+    | { [k: string]: CreateChannelConnectionRequestDtoContext2 | string }
+    | undefined;
   /**
    * The identifier of the integration to use for this channel connection.
    */
@@ -46,41 +50,66 @@ export type CreateChannelConnectionRequestDto = {
 };
 
 /** @internal */
-export type Two$Outbound = {
+export type CreateChannelConnectionRequestDtoContext2$Outbound = {
   id: string;
   data?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
-export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
-  .object({
+export const CreateChannelConnectionRequestDtoContext2$outboundSchema:
+  z.ZodType<
+    CreateChannelConnectionRequestDtoContext2$Outbound,
+    z.ZodTypeDef,
+    CreateChannelConnectionRequestDtoContext2
+  > = z.object({
     id: z.string(),
     data: z.record(z.any()).optional(),
   });
 
-export function twoToJSON(two: Two): string {
-  return JSON.stringify(Two$outboundSchema.parse(two));
+export function createChannelConnectionRequestDtoContext2ToJSON(
+  createChannelConnectionRequestDtoContext2:
+    CreateChannelConnectionRequestDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateChannelConnectionRequestDtoContext2$outboundSchema.parse(
+      createChannelConnectionRequestDtoContext2,
+    ),
+  );
 }
 
 /** @internal */
-export type Context$Outbound = Two$Outbound | string;
+export type CreateChannelConnectionRequestDtoContext$Outbound =
+  | CreateChannelConnectionRequestDtoContext2$Outbound
+  | string;
 
 /** @internal */
-export const Context$outboundSchema: z.ZodType<
-  Context$Outbound,
+export const CreateChannelConnectionRequestDtoContext$outboundSchema: z.ZodType<
+  CreateChannelConnectionRequestDtoContext$Outbound,
   z.ZodTypeDef,
-  Context
-> = z.union([z.lazy(() => Two$outboundSchema), z.string()]);
+  CreateChannelConnectionRequestDtoContext
+> = z.union([
+  z.lazy(() => CreateChannelConnectionRequestDtoContext2$outboundSchema),
+  z.string(),
+]);
 
-export function contextToJSON(context: Context): string {
-  return JSON.stringify(Context$outboundSchema.parse(context));
+export function createChannelConnectionRequestDtoContextToJSON(
+  createChannelConnectionRequestDtoContext:
+    CreateChannelConnectionRequestDtoContext,
+): string {
+  return JSON.stringify(
+    CreateChannelConnectionRequestDtoContext$outboundSchema.parse(
+      createChannelConnectionRequestDtoContext,
+    ),
+  );
 }
 
 /** @internal */
 export type CreateChannelConnectionRequestDto$Outbound = {
   identifier?: string | undefined;
   subscriberId?: string | undefined;
-  context?: { [k: string]: Two$Outbound | string } | undefined;
+  context?: {
+    [k: string]: CreateChannelConnectionRequestDtoContext2$Outbound | string;
+  } | undefined;
   integrationIdentifier: string;
   workspace: WorkspaceDto$Outbound;
   auth: AuthDto$Outbound;
@@ -94,8 +123,12 @@ export const CreateChannelConnectionRequestDto$outboundSchema: z.ZodType<
 > = z.object({
   identifier: z.string().optional(),
   subscriberId: z.string().optional(),
-  context: z.record(z.union([z.lazy(() => Two$outboundSchema), z.string()]))
-    .optional(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateChannelConnectionRequestDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
   integrationIdentifier: z.string(),
   workspace: WorkspaceDto$outboundSchema,
   auth: AuthDto$outboundSchema,

package/src/models/components/createslackchannelendpointdto.ts

@@ -12,7 +12,7 @@ import {
 /**
  * Rich context object with id and optional data
  */
-export type Context2 = {
+export type CreateSlackChannelEndpointDtoContext2 = {
   id: string;
   /**
    * Optional additional context data
@@ -20,7 +20,9 @@ export type Context2 = {
   data?: { [k: string]: any } | undefined;
 };
 
-export type CreateSlackChannelEndpointDtoContext = Context2 | string;
+export type CreateSlackChannelEndpointDtoContext =
+  | CreateSlackChannelEndpointDtoContext2
+  | string;
 
 export type CreateSlackChannelEndpointDto = {
   /**
@@ -31,7 +33,9 @@ export type CreateSlackChannelEndpointDto = {
    * The subscriber ID to which the channel endpoint is linked
    */
   subscriberId: string;
-  context?: { [k: string]: Context2 | string } | undefined;
+  context?:
+    | { [k: string]: CreateSlackChannelEndpointDtoContext2 | string }
+    | undefined;
   /**
    * The identifier of the integration to use for this channel endpoint.
    */
@@ -51,28 +55,34 @@ export type CreateSlackChannelEndpointDto = {
 };
 
 /** @internal */
-export type Context2$Outbound = {
+export type CreateSlackChannelEndpointDtoContext2$Outbound = {
   id: string;
   data?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
-export const Context2$outboundSchema: z.ZodType<
-  Context2$Outbound,
+export const CreateSlackChannelEndpointDtoContext2$outboundSchema: z.ZodType<
+  CreateSlackChannelEndpointDtoContext2$Outbound,
   z.ZodTypeDef,
-  Context2
+  CreateSlackChannelEndpointDtoContext2
 > = z.object({
   id: z.string(),
   data: z.record(z.any()).optional(),
 });
 
-export function context2ToJSON(context2: Context2): string {
-  return JSON.stringify(Context2$outboundSchema.parse(context2));
+export function createSlackChannelEndpointDtoContext2ToJSON(
+  createSlackChannelEndpointDtoContext2: CreateSlackChannelEndpointDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateSlackChannelEndpointDtoContext2$outboundSchema.parse(
+      createSlackChannelEndpointDtoContext2,
+    ),
+  );
 }
 
 /** @internal */
 export type CreateSlackChannelEndpointDtoContext$Outbound =
-  | Context2$Outbound
+  | CreateSlackChannelEndpointDtoContext2$Outbound
   | string;
 
 /** @internal */
@@ -80,7 +90,10 @@ export const CreateSlackChannelEndpointDtoContext$outboundSchema: z.ZodType<
   CreateSlackChannelEndpointDtoContext$Outbound,
   z.ZodTypeDef,
   CreateSlackChannelEndpointDtoContext
-> = z.union([z.lazy(() => Context2$outboundSchema), z.string()]);
+> = z.union([
+  z.lazy(() => CreateSlackChannelEndpointDtoContext2$outboundSchema),
+  z.string(),
+]);
 
 export function createSlackChannelEndpointDtoContextToJSON(
   createSlackChannelEndpointDtoContext: CreateSlackChannelEndpointDtoContext,
@@ -96,7 +109,9 @@ export function createSlackChannelEndpointDtoContextToJSON(
 export type CreateSlackChannelEndpointDto$Outbound = {
   identifier?: string | undefined;
   subscriberId: string;
-  context?: { [k: string]: Context2$Outbound | string } | undefined;
+  context?: {
+    [k: string]: CreateSlackChannelEndpointDtoContext2$Outbound | string;
+  } | undefined;
   integrationIdentifier: string;
   connectionIdentifier?: string | undefined;
   type: "slack_channel";
@@ -112,7 +127,10 @@ export const CreateSlackChannelEndpointDto$outboundSchema: z.ZodType<
   identifier: z.string().optional(),
   subscriberId: z.string(),
   context: z.record(
-    z.union([z.lazy(() => Context2$outboundSchema), z.string()]),
+    z.union([
+      z.lazy(() => CreateSlackChannelEndpointDtoContext2$outboundSchema),
+      z.string(),
+    ]),
   ).optional(),
   integrationIdentifier: z.string(),
   connectionIdentifier: z.string().optional(),

package/src/models/components/createtopicsubscriptionsrequestdto.ts

@@ -21,6 +21,21 @@ import {
 
 export type Subscriptions = TopicSubscriberIdentifierDto | string;
 
+/**
+ * Rich context object with id and optional data
+ */
+export type CreateTopicSubscriptionsRequestDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type CreateTopicSubscriptionsRequestDtoContext =
+  | CreateTopicSubscriptionsRequestDtoContext2
+  | string;
+
 export type Preferences =
   | WorkflowPreferenceRequestDto
   | GroupPreferenceFilterDto
@@ -41,6 +56,9 @@ export type CreateTopicSubscriptionsRequestDto = {
    * The name of the topic
    */
   name?: string | undefined;
+  context?:
+    | { [k: string]: CreateTopicSubscriptionsRequestDtoContext2 | string }
+    | undefined;
   /**
    * The preferences of the topic. Can be a simple workflow ID string, workflow preference object, or group filter object
    */
@@ -65,6 +83,61 @@ export function subscriptionsToJSON(subscriptions: Subscriptions): string {
   return JSON.stringify(Subscriptions$outboundSchema.parse(subscriptions));
 }
 
+/** @internal */
+export type CreateTopicSubscriptionsRequestDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const CreateTopicSubscriptionsRequestDtoContext2$outboundSchema:
+  z.ZodType<
+    CreateTopicSubscriptionsRequestDtoContext2$Outbound,
+    z.ZodTypeDef,
+    CreateTopicSubscriptionsRequestDtoContext2
+  > = z.object({
+    id: z.string(),
+    data: z.record(z.any()).optional(),
+  });
+
+export function createTopicSubscriptionsRequestDtoContext2ToJSON(
+  createTopicSubscriptionsRequestDtoContext2:
+    CreateTopicSubscriptionsRequestDtoContext2,
+): string {
+  return JSON.stringify(
+    CreateTopicSubscriptionsRequestDtoContext2$outboundSchema.parse(
+      createTopicSubscriptionsRequestDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type CreateTopicSubscriptionsRequestDtoContext$Outbound =
+  | CreateTopicSubscriptionsRequestDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const CreateTopicSubscriptionsRequestDtoContext$outboundSchema:
+  z.ZodType<
+    CreateTopicSubscriptionsRequestDtoContext$Outbound,
+    z.ZodTypeDef,
+    CreateTopicSubscriptionsRequestDtoContext
+  > = z.union([
+    z.lazy(() => CreateTopicSubscriptionsRequestDtoContext2$outboundSchema),
+    z.string(),
+  ]);
+
+export function createTopicSubscriptionsRequestDtoContextToJSON(
+  createTopicSubscriptionsRequestDtoContext:
+    CreateTopicSubscriptionsRequestDtoContext,
+): string {
+  return JSON.stringify(
+    CreateTopicSubscriptionsRequestDtoContext$outboundSchema.parse(
+      createTopicSubscriptionsRequestDtoContext,
+    ),
+  );
+}
+
 /** @internal */
 export type Preferences$Outbound =
   | WorkflowPreferenceRequestDto$Outbound
@@ -93,6 +166,9 @@ export type CreateTopicSubscriptionsRequestDto$Outbound = {
     | Array<TopicSubscriberIdentifierDto$Outbound | string>
     | undefined;
   name?: string | undefined;
+  context?: {
+    [k: string]: CreateTopicSubscriptionsRequestDtoContext2$Outbound | string;
+  } | undefined;
   preferences?:
     | Array<
       | WorkflowPreferenceRequestDto$Outbound
@@ -113,6 +189,12 @@ export const CreateTopicSubscriptionsRequestDto$outboundSchema: z.ZodType<
     z.union([TopicSubscriberIdentifierDto$outboundSchema, z.string()]),
   ).optional(),
   name: z.string().optional(),
+  context: z.record(
+    z.union([
+      z.lazy(() => CreateTopicSubscriptionsRequestDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
   preferences: z.array(
     z.union([
       WorkflowPreferenceRequestDto$outboundSchema,

package/src/models/components/index.ts

@@ -214,6 +214,7 @@ export * from "./subscriberpreferencesworkflowinfodto.js";
 export * from "./subscriberresponsedto.js";
 export * from "./subscriberresponsedtooptional.js";
 export * from "./subscriberworkflowpreferencedto.js";
+export * from "./subscriptiondetailsresponsedto.js";
 export * from "./subscriptiondto.js";
 export * from "./subscriptionerrordto.js";
 export * from "./subscriptionpreferencedto.js";

package/src/models/components/messageactionresult.ts

@@ -11,43 +11,24 @@ import {
   ButtonTypeEnum$inboundSchema,
 } from "./buttontypeenum.js";
 
-/**
- * Payload of the action result
- */
-export type Payload = {};
-
 export type MessageActionResult = {
   /**
    * Payload of the action result
    */
-  payload?: Payload | undefined;
+  payload?: { [k: string]: any } | undefined;
   /**
    * Type of button for the action result
    */
   type?: ButtonTypeEnum | undefined;
 };
 
-/** @internal */
-export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
-  z.object({});
-
-export function payloadFromJSON(
-  jsonString: string,
-): SafeParseResult<Payload, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Payload' from JSON`,
-  );
-}
-
 /** @internal */
 export const MessageActionResult$inboundSchema: z.ZodType<
   MessageActionResult,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  payload: z.lazy(() => Payload$inboundSchema).optional(),
+  payload: z.record(z.any()).optional(),
   type: ButtonTypeEnum$inboundSchema.optional(),
 });
 

package/src/models/components/messageresponsedto.ts

@@ -31,16 +31,6 @@ import {
  */
 export type Content = Array<EmailBlock> | string;
 
-/**
- * The payload that was used to send the notification trigger
- */
-export type MessageResponseDtoPayload = {};
-
-/**
- * Provider specific overrides used when triggering the notification
- */
-export type MessageResponseDtoOverrides = {};
-
 export type MessageResponseDto = {
   /**
    * Unique identifier for the message
@@ -173,11 +163,11 @@ export type MessageResponseDto = {
   /**
    * The payload that was used to send the notification trigger
    */
-  payload?: MessageResponseDtoPayload | undefined;
+  payload?: { [k: string]: any } | undefined;
   /**
    * Provider specific overrides used when triggering the notification
    */
-  overrides?: MessageResponseDtoOverrides | undefined;
+  overrides?: { [k: string]: any } | undefined;
   /**
    * Context (single or multi) in which the message was sent
    */
@@ -198,40 +188,6 @@ export function contentFromJSON(
   );
 }
 
-/** @internal */
-export const MessageResponseDtoPayload$inboundSchema: z.ZodType<
-  MessageResponseDtoPayload,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-export function messageResponseDtoPayloadFromJSON(
-  jsonString: string,
-): SafeParseResult<MessageResponseDtoPayload, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => MessageResponseDtoPayload$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'MessageResponseDtoPayload' from JSON`,
-  );
-}
-
-/** @internal */
-export const MessageResponseDtoOverrides$inboundSchema: z.ZodType<
-  MessageResponseDtoOverrides,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-export function messageResponseDtoOverridesFromJSON(
-  jsonString: string,
-): SafeParseResult<MessageResponseDtoOverrides, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => MessageResponseDtoOverrides$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'MessageResponseDtoOverrides' from JSON`,
-  );
-}
-
 /** @internal */
 export const MessageResponseDto$inboundSchema: z.ZodType<
   MessageResponseDto,
@@ -271,8 +227,8 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
   status: MessageStatusEnum$inboundSchema,
   errorId: z.string().optional(),
   errorText: z.string().optional(),
-  payload: z.lazy(() => MessageResponseDtoPayload$inboundSchema).optional(),
-  overrides: z.lazy(() => MessageResponseDtoOverrides$inboundSchema).optional(),
+  payload: z.record(z.any()).optional(),
+  overrides: z.record(z.any()).optional(),
   contextKeys: z.array(z.string()).optional(),
 }).transform((v) => {
   return remap$(v, {