@novu/api 3.11.0 → 3.11.2

package/src/models/components/topicsubscriptionresponsedto.ts

@@ -18,6 +18,10 @@ export type TopicSubscriptionResponseDto = {
    * The identifier of the subscription
    */
   id: string;
+  /**
+   * The identifier of the subscription
+   */
+  identifier: string;
   /**
    * The date and time the subscription was created
    */
@@ -39,6 +43,7 @@ export const TopicSubscriptionResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string(),
+  identifier: z.string(),
   createdAt: z.string(),
   topic: TopicResponseDto$inboundSchema,
   subscriber: SubscriberDto$inboundSchema,

package/src/models/components/translationresponsedto.ts

@@ -22,11 +22,6 @@ export type TranslationResponseDtoResourceType = ClosedEnum<
   typeof TranslationResponseDtoResourceType
 >;
 
-/**
- * Translation content as JSON object
- */
-export type TranslationResponseDtoContent = {};
-
 export type TranslationResponseDto = {
   /**
    * Resource identifier
@@ -43,7 +38,7 @@ export type TranslationResponseDto = {
   /**
    * Translation content as JSON object
    */
-  content: TranslationResponseDtoContent;
+  content: { [k: string]: any };
   /**
    * Creation timestamp
    */
@@ -59,23 +54,6 @@ export const TranslationResponseDtoResourceType$inboundSchema: z.ZodNativeEnum<
   typeof TranslationResponseDtoResourceType
 > = z.nativeEnum(TranslationResponseDtoResourceType);
 
-/** @internal */
-export const TranslationResponseDtoContent$inboundSchema: z.ZodType<
-  TranslationResponseDtoContent,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
-
-export function translationResponseDtoContentFromJSON(
-  jsonString: string,
-): SafeParseResult<TranslationResponseDtoContent, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => TranslationResponseDtoContent$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'TranslationResponseDtoContent' from JSON`,
-  );
-}
-
 /** @internal */
 export const TranslationResponseDto$inboundSchema: z.ZodType<
   TranslationResponseDto,
@@ -85,7 +63,7 @@ export const TranslationResponseDto$inboundSchema: z.ZodType<
   resourceId: z.string(),
   resourceType: TranslationResponseDtoResourceType$inboundSchema,
   locale: z.string(),
-  content: z.lazy(() => TranslationResponseDtoContent$inboundSchema),
+  content: z.record(z.any()),
   createdAt: z.string(),
   updatedAt: z.string(),
 });

package/src/models/components/triggereventrequestdto.ts

@@ -126,7 +126,7 @@ export type Tenant = string | TenantPayloadDto;
 /**
  * Rich context object with id and optional data
  */
-export type Two = {
+export type TriggerEventRequestDtoContext2 = {
   id: string;
   /**
    * Optional additional context data
@@ -134,7 +134,9 @@ export type Two = {
   data?: { [k: string]: any } | undefined;
 };
 
-export type Context = Two | string;
+export type TriggerEventRequestDtoContext =
+  | TriggerEventRequestDtoContext2
+  | string;
 
 export type TriggerEventRequestDto = {
   /**
@@ -182,7 +184,9 @@ export type TriggerEventRequestDto = {
    *     Existing tenants will be updated with the provided details.
    */
   tenant?: string | TenantPayloadDto | undefined;
-  context?: { [k: string]: Two | string } | undefined;
+  context?:
+    | { [k: string]: TriggerEventRequestDtoContext2 | string }
+    | undefined;
 };
 
 /** @internal */
@@ -310,34 +314,54 @@ export function tenantToJSON(tenant: Tenant): string {
 }
 
 /** @internal */
-export type Two$Outbound = {
+export type TriggerEventRequestDtoContext2$Outbound = {
   id: string;
   data?: { [k: string]: any } | undefined;
 };
 
 /** @internal */
-export const Two$outboundSchema: z.ZodType<Two$Outbound, z.ZodTypeDef, Two> = z
-  .object({
-    id: z.string(),
-    data: z.record(z.any()).optional(),
-  });
+export const TriggerEventRequestDtoContext2$outboundSchema: z.ZodType<
+  TriggerEventRequestDtoContext2$Outbound,
+  z.ZodTypeDef,
+  TriggerEventRequestDtoContext2
+> = 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 triggerEventRequestDtoContext2ToJSON(
+  triggerEventRequestDtoContext2: TriggerEventRequestDtoContext2,
+): string {
+  return JSON.stringify(
+    TriggerEventRequestDtoContext2$outboundSchema.parse(
+      triggerEventRequestDtoContext2,
+    ),
+  );
 }
 
 /** @internal */
-export type Context$Outbound = Two$Outbound | string;
+export type TriggerEventRequestDtoContext$Outbound =
+  | TriggerEventRequestDtoContext2$Outbound
+  | string;
 
 /** @internal */
-export const Context$outboundSchema: z.ZodType<
-  Context$Outbound,
+export const TriggerEventRequestDtoContext$outboundSchema: z.ZodType<
+  TriggerEventRequestDtoContext$Outbound,
   z.ZodTypeDef,
-  Context
-> = z.union([z.lazy(() => Two$outboundSchema), z.string()]);
-
-export function contextToJSON(context: Context): string {
-  return JSON.stringify(Context$outboundSchema.parse(context));
+  TriggerEventRequestDtoContext
+> = z.union([
+  z.lazy(() => TriggerEventRequestDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function triggerEventRequestDtoContextToJSON(
+  triggerEventRequestDtoContext: TriggerEventRequestDtoContext,
+): string {
+  return JSON.stringify(
+    TriggerEventRequestDtoContext$outboundSchema.parse(
+      triggerEventRequestDtoContext,
+    ),
+  );
 }
 
 /** @internal */
@@ -353,7 +377,9 @@ export type TriggerEventRequestDto$Outbound = {
   transactionId?: string | undefined;
   actor?: SubscriberPayloadDto$Outbound | string | undefined;
   tenant?: string | TenantPayloadDto$Outbound | undefined;
-  context?: { [k: string]: Two$Outbound | string } | undefined;
+  context?:
+    | { [k: string]: TriggerEventRequestDtoContext2$Outbound | string }
+    | undefined;
 };
 
 /** @internal */
@@ -380,8 +406,12 @@ export const TriggerEventRequestDto$outboundSchema: z.ZodType<
   transactionId: z.string().optional(),
   actor: z.union([SubscriberPayloadDto$outboundSchema, z.string()]).optional(),
   tenant: z.union([z.string(), TenantPayloadDto$outboundSchema]).optional(),
-  context: z.record(z.union([z.lazy(() => Two$outboundSchema), z.string()]))
-    .optional(),
+  context: z.record(
+    z.union([
+      z.lazy(() => TriggerEventRequestDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
 }).transform((v) => {
   return remap$(v, {
     workflowId: "name",

package/src/models/components/triggereventresponsedto.ts

@@ -27,6 +27,8 @@ export type TriggerEventResponseDtoStatus = ClosedEnum<
   typeof TriggerEventResponseDtoStatus
 >;
 
+export type JobData = {};
+
 export type TriggerEventResponseDto = {
   /**
    * Indicates whether the trigger was acknowledged or not
@@ -44,6 +46,7 @@ export type TriggerEventResponseDto = {
    * The returned transaction ID of the trigger
    */
   transactionId?: string | undefined;
+  jobData?: JobData | undefined;
 };
 
 /** @internal */
@@ -51,6 +54,20 @@ export const TriggerEventResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
   typeof TriggerEventResponseDtoStatus
 > = z.nativeEnum(TriggerEventResponseDtoStatus);
 
+/** @internal */
+export const JobData$inboundSchema: z.ZodType<JobData, z.ZodTypeDef, unknown> =
+  z.object({});
+
+export function jobDataFromJSON(
+  jsonString: string,
+): SafeParseResult<JobData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => JobData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'JobData' from JSON`,
+  );
+}
+
 /** @internal */
 export const TriggerEventResponseDto$inboundSchema: z.ZodType<
   TriggerEventResponseDto,
@@ -61,6 +78,7 @@ export const TriggerEventResponseDto$inboundSchema: z.ZodType<
   status: TriggerEventResponseDtoStatus$inboundSchema,
   error: z.array(z.string()).optional(),
   transactionId: z.string().optional(),
+  jobData: z.lazy(() => JobData$inboundSchema).optional(),
 });
 
 export function triggerEventResponseDtoFromJSON(

package/src/models/components/triggereventtoallrequestdto.ts

@@ -108,6 +108,21 @@ export type TriggerEventToAllRequestDtoActor = SubscriberPayloadDto | string;
  */
 export type TriggerEventToAllRequestDtoTenant = string | TenantPayloadDto;
 
+/**
+ * Rich context object with id and optional data
+ */
+export type TriggerEventToAllRequestDtoContext2 = {
+  id: string;
+  /**
+   * Optional additional context data
+   */
+  data?: { [k: string]: any } | undefined;
+};
+
+export type TriggerEventToAllRequestDtoContext =
+  | TriggerEventToAllRequestDtoContext2
+  | string;
+
 export type TriggerEventToAllRequestDto = {
   /**
    * The trigger identifier associated for the template you wish to send. This identifier can be found on the template page.
@@ -143,6 +158,9 @@ export type TriggerEventToAllRequestDto = {
    *     If a new tenant object is provided, we will create a new tenant.
    */
   tenant?: string | TenantPayloadDto | undefined;
+  context?:
+    | { [k: string]: TriggerEventToAllRequestDtoContext2 | string }
+    | undefined;
 };
 
 /** @internal */
@@ -263,6 +281,57 @@ export function triggerEventToAllRequestDtoTenantToJSON(
   );
 }
 
+/** @internal */
+export type TriggerEventToAllRequestDtoContext2$Outbound = {
+  id: string;
+  data?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const TriggerEventToAllRequestDtoContext2$outboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoContext2$Outbound,
+  z.ZodTypeDef,
+  TriggerEventToAllRequestDtoContext2
+> = z.object({
+  id: z.string(),
+  data: z.record(z.any()).optional(),
+});
+
+export function triggerEventToAllRequestDtoContext2ToJSON(
+  triggerEventToAllRequestDtoContext2: TriggerEventToAllRequestDtoContext2,
+): string {
+  return JSON.stringify(
+    TriggerEventToAllRequestDtoContext2$outboundSchema.parse(
+      triggerEventToAllRequestDtoContext2,
+    ),
+  );
+}
+
+/** @internal */
+export type TriggerEventToAllRequestDtoContext$Outbound =
+  | TriggerEventToAllRequestDtoContext2$Outbound
+  | string;
+
+/** @internal */
+export const TriggerEventToAllRequestDtoContext$outboundSchema: z.ZodType<
+  TriggerEventToAllRequestDtoContext$Outbound,
+  z.ZodTypeDef,
+  TriggerEventToAllRequestDtoContext
+> = z.union([
+  z.lazy(() => TriggerEventToAllRequestDtoContext2$outboundSchema),
+  z.string(),
+]);
+
+export function triggerEventToAllRequestDtoContextToJSON(
+  triggerEventToAllRequestDtoContext: TriggerEventToAllRequestDtoContext,
+): string {
+  return JSON.stringify(
+    TriggerEventToAllRequestDtoContext$outboundSchema.parse(
+      triggerEventToAllRequestDtoContext,
+    ),
+  );
+}
+
 /** @internal */
 export type TriggerEventToAllRequestDto$Outbound = {
   name: string;
@@ -271,6 +340,9 @@ export type TriggerEventToAllRequestDto$Outbound = {
   transactionId?: string | undefined;
   actor?: SubscriberPayloadDto$Outbound | string | undefined;
   tenant?: string | TenantPayloadDto$Outbound | undefined;
+  context?: {
+    [k: string]: TriggerEventToAllRequestDtoContext2$Outbound | string;
+  } | undefined;
 };
 
 /** @internal */
@@ -286,6 +358,12 @@ export const TriggerEventToAllRequestDto$outboundSchema: z.ZodType<
   transactionId: z.string().optional(),
   actor: z.union([SubscriberPayloadDto$outboundSchema, z.string()]).optional(),
   tenant: z.union([z.string(), TenantPayloadDto$outboundSchema]).optional(),
+  context: z.record(
+    z.union([
+      z.lazy(() => TriggerEventToAllRequestDtoContext2$outboundSchema),
+      z.string(),
+    ]),
+  ).optional(),
 });
 
 export function triggerEventToAllRequestDtoToJSON(

package/src/models/components/updatechannelconnectionrequestdto.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  AuthDto,
+  AuthDto$Outbound,
+  AuthDto$outboundSchema,
+} from "./authdto.js";
+import {
+  WorkspaceDto,
+  WorkspaceDto$Outbound,
+  WorkspaceDto$outboundSchema,
+} from "./workspacedto.js";
+
+export type UpdateChannelConnectionRequestDto = {
+  workspace: WorkspaceDto;
+  auth: AuthDto;
+};
+
+/** @internal */
+export type UpdateChannelConnectionRequestDto$Outbound = {
+  workspace: WorkspaceDto$Outbound;
+  auth: AuthDto$Outbound;
+};
+
+/** @internal */
+export const UpdateChannelConnectionRequestDto$outboundSchema: z.ZodType<
+  UpdateChannelConnectionRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateChannelConnectionRequestDto
+> = z.object({
+  workspace: WorkspaceDto$outboundSchema,
+  auth: AuthDto$outboundSchema,
+});
+
+export function updateChannelConnectionRequestDtoToJSON(
+  updateChannelConnectionRequestDto: UpdateChannelConnectionRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateChannelConnectionRequestDto$outboundSchema.parse(
+      updateChannelConnectionRequestDto,
+    ),
+  );
+}

package/src/models/components/updatechannelendpointrequestdto.ts

@@ -0,0 +1,108 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  PhoneEndpointDto,
+  PhoneEndpointDto$Outbound,
+  PhoneEndpointDto$outboundSchema,
+} from "./phoneendpointdto.js";
+import {
+  SlackChannelEndpointDto,
+  SlackChannelEndpointDto$Outbound,
+  SlackChannelEndpointDto$outboundSchema,
+} from "./slackchannelendpointdto.js";
+import {
+  SlackUserEndpointDto,
+  SlackUserEndpointDto$Outbound,
+  SlackUserEndpointDto$outboundSchema,
+} from "./slackuserendpointdto.js";
+import {
+  WebhookEndpointDto,
+  WebhookEndpointDto$Outbound,
+  WebhookEndpointDto$outboundSchema,
+} from "./webhookendpointdto.js";
+
+/**
+ * Updated endpoint data. The structure must match the existing channel endpoint type.
+ */
+export type UpdateChannelEndpointRequestDtoEndpoint =
+  | SlackChannelEndpointDto
+  | SlackUserEndpointDto
+  | WebhookEndpointDto
+  | PhoneEndpointDto;
+
+export type UpdateChannelEndpointRequestDto = {
+  /**
+   * Updated endpoint data. The structure must match the existing channel endpoint type.
+   */
+  endpoint:
+    | SlackChannelEndpointDto
+    | SlackUserEndpointDto
+    | WebhookEndpointDto
+    | PhoneEndpointDto;
+};
+
+/** @internal */
+export type UpdateChannelEndpointRequestDtoEndpoint$Outbound =
+  | SlackChannelEndpointDto$Outbound
+  | SlackUserEndpointDto$Outbound
+  | WebhookEndpointDto$Outbound
+  | PhoneEndpointDto$Outbound;
+
+/** @internal */
+export const UpdateChannelEndpointRequestDtoEndpoint$outboundSchema: z.ZodType<
+  UpdateChannelEndpointRequestDtoEndpoint$Outbound,
+  z.ZodTypeDef,
+  UpdateChannelEndpointRequestDtoEndpoint
+> = z.union([
+  SlackChannelEndpointDto$outboundSchema,
+  SlackUserEndpointDto$outboundSchema,
+  WebhookEndpointDto$outboundSchema,
+  PhoneEndpointDto$outboundSchema,
+]);
+
+export function updateChannelEndpointRequestDtoEndpointToJSON(
+  updateChannelEndpointRequestDtoEndpoint:
+    UpdateChannelEndpointRequestDtoEndpoint,
+): string {
+  return JSON.stringify(
+    UpdateChannelEndpointRequestDtoEndpoint$outboundSchema.parse(
+      updateChannelEndpointRequestDtoEndpoint,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateChannelEndpointRequestDto$Outbound = {
+  endpoint:
+    | SlackChannelEndpointDto$Outbound
+    | SlackUserEndpointDto$Outbound
+    | WebhookEndpointDto$Outbound
+    | PhoneEndpointDto$Outbound;
+};
+
+/** @internal */
+export const UpdateChannelEndpointRequestDto$outboundSchema: z.ZodType<
+  UpdateChannelEndpointRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateChannelEndpointRequestDto
+> = z.object({
+  endpoint: z.union([
+    SlackChannelEndpointDto$outboundSchema,
+    SlackUserEndpointDto$outboundSchema,
+    WebhookEndpointDto$outboundSchema,
+    PhoneEndpointDto$outboundSchema,
+  ]),
+});
+
+export function updateChannelEndpointRequestDtoToJSON(
+  updateChannelEndpointRequestDto: UpdateChannelEndpointRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateChannelEndpointRequestDto$outboundSchema.parse(
+      updateChannelEndpointRequestDto,
+    ),
+  );
+}

package/src/models/components/updatecontextrequestdto.ts

@@ -4,41 +4,16 @@
 
 import * as z from "zod/v3";
 
-/**
- * Custom data to associate with this context. Replaces existing data.
- */
-export type UpdateContextRequestDtoData = {};
-
 export type UpdateContextRequestDto = {
   /**
    * Custom data to associate with this context. Replaces existing data.
    */
-  data: UpdateContextRequestDtoData;
+  data: { [k: string]: any };
 };
 
-/** @internal */
-export type UpdateContextRequestDtoData$Outbound = {};
-
-/** @internal */
-export const UpdateContextRequestDtoData$outboundSchema: z.ZodType<
-  UpdateContextRequestDtoData$Outbound,
-  z.ZodTypeDef,
-  UpdateContextRequestDtoData
-> = z.object({});
-
-export function updateContextRequestDtoDataToJSON(
-  updateContextRequestDtoData: UpdateContextRequestDtoData,
-): string {
-  return JSON.stringify(
-    UpdateContextRequestDtoData$outboundSchema.parse(
-      updateContextRequestDtoData,
-    ),
-  );
-}
-
 /** @internal */
 export type UpdateContextRequestDto$Outbound = {
-  data: UpdateContextRequestDtoData$Outbound;
+  data: { [k: string]: any };
 };
 
 /** @internal */
@@ -47,7 +22,7 @@ export const UpdateContextRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   UpdateContextRequestDto
 > = z.object({
-  data: z.lazy(() => UpdateContextRequestDtoData$outboundSchema),
+  data: z.record(z.any()),
 });
 
 export function updateContextRequestDtoToJSON(

package/src/models/components/updatetopicsubscriptionrequestdto.ts

@@ -0,0 +1,100 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod/v3";
+import {
+  GroupPreferenceFilterDto,
+  GroupPreferenceFilterDto$Outbound,
+  GroupPreferenceFilterDto$outboundSchema,
+} from "./grouppreferencefilterdto.js";
+import {
+  WorkflowPreferenceRequestDto,
+  WorkflowPreferenceRequestDto$Outbound,
+  WorkflowPreferenceRequestDto$outboundSchema,
+} from "./workflowpreferencerequestdto.js";
+
+export type UpdateTopicSubscriptionRequestDtoPreferences =
+  | WorkflowPreferenceRequestDto
+  | GroupPreferenceFilterDto
+  | string;
+
+export type UpdateTopicSubscriptionRequestDto = {
+  /**
+   * The name of the subscription
+   */
+  name?: string | undefined;
+  /**
+   * The preferences of the topic. Can be a simple workflow ID string, workflow preference object, or group filter object
+   */
+  preferences?:
+    | Array<WorkflowPreferenceRequestDto | GroupPreferenceFilterDto | string>
+    | undefined;
+};
+
+/** @internal */
+export type UpdateTopicSubscriptionRequestDtoPreferences$Outbound =
+  | WorkflowPreferenceRequestDto$Outbound
+  | GroupPreferenceFilterDto$Outbound
+  | string;
+
+/** @internal */
+export const UpdateTopicSubscriptionRequestDtoPreferences$outboundSchema:
+  z.ZodType<
+    UpdateTopicSubscriptionRequestDtoPreferences$Outbound,
+    z.ZodTypeDef,
+    UpdateTopicSubscriptionRequestDtoPreferences
+  > = z.union([
+    WorkflowPreferenceRequestDto$outboundSchema,
+    GroupPreferenceFilterDto$outboundSchema,
+    z.string(),
+  ]);
+
+export function updateTopicSubscriptionRequestDtoPreferencesToJSON(
+  updateTopicSubscriptionRequestDtoPreferences:
+    UpdateTopicSubscriptionRequestDtoPreferences,
+): string {
+  return JSON.stringify(
+    UpdateTopicSubscriptionRequestDtoPreferences$outboundSchema.parse(
+      updateTopicSubscriptionRequestDtoPreferences,
+    ),
+  );
+}
+
+/** @internal */
+export type UpdateTopicSubscriptionRequestDto$Outbound = {
+  name?: string | undefined;
+  preferences?:
+    | Array<
+      | WorkflowPreferenceRequestDto$Outbound
+      | GroupPreferenceFilterDto$Outbound
+      | string
+    >
+    | undefined;
+};
+
+/** @internal */
+export const UpdateTopicSubscriptionRequestDto$outboundSchema: z.ZodType<
+  UpdateTopicSubscriptionRequestDto$Outbound,
+  z.ZodTypeDef,
+  UpdateTopicSubscriptionRequestDto
+> = z.object({
+  name: z.string().optional(),
+  preferences: z.array(
+    z.union([
+      WorkflowPreferenceRequestDto$outboundSchema,
+      GroupPreferenceFilterDto$outboundSchema,
+      z.string(),
+    ]),
+  ).optional(),
+});
+
+export function updateTopicSubscriptionRequestDtoToJSON(
+  updateTopicSubscriptionRequestDto: UpdateTopicSubscriptionRequestDto,
+): string {
+  return JSON.stringify(
+    UpdateTopicSubscriptionRequestDto$outboundSchema.parse(
+      updateTopicSubscriptionRequestDto,
+    ),
+  );
+}