@novu/api 0.0.1-alpha.191 → 0.0.1-alpha.193

package/src/models/components/activitynotificationexecutiondetailresponsedto.ts

@@ -5,47 +5,24 @@
 import * as z from "zod";
 import { remap as remap$ } from "../../lib/primitives.js";
 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 {
+  ExecutionDetailsSourceEnum,
+  ExecutionDetailsSourceEnum$inboundSchema,
+  ExecutionDetailsSourceEnum$outboundSchema,
+} from "./executiondetailssourceenum.js";
+import {
+  ExecutionDetailsStatusEnum,
+  ExecutionDetailsStatusEnum$inboundSchema,
+  ExecutionDetailsStatusEnum$outboundSchema,
+} from "./executiondetailsstatusenum.js";
 import {
   ProvidersIdEnum,
   ProvidersIdEnum$inboundSchema,
   ProvidersIdEnum$outboundSchema,
 } from "./providersidenum.js";
 
-/**
- * Status of the execution detail
- */
-export const ActivityNotificationExecutionDetailResponseDtoStatus = {
-  Success: "Success",
-  Warning: "Warning",
-  Failed: "Failed",
-  Pending: "Pending",
-  Queued: "Queued",
-  ReadConfirmation: "ReadConfirmation",
-} as const;
-/**
- * Status of the execution detail
- */
-export type ActivityNotificationExecutionDetailResponseDtoStatus = ClosedEnum<
-  typeof ActivityNotificationExecutionDetailResponseDtoStatus
->;
-
-/**
- * Source of the execution detail
- */
-export const Source = {
-  Credentials: "Credentials",
-  Internal: "Internal",
-  Payload: "Payload",
-  Webhook: "Webhook",
-} as const;
-/**
- * Source of the execution detail
- */
-export type Source = ClosedEnum<typeof Source>;
-
 export type ActivityNotificationExecutionDetailResponseDto = {
   /**
    * Unique identifier of the execution detail
@@ -58,7 +35,7 @@ export type ActivityNotificationExecutionDetailResponseDto = {
   /**
    * Status of the execution detail
    */
-  status: ActivityNotificationExecutionDetailResponseDtoStatus;
+  status: ExecutionDetailsStatusEnum;
   /**
    * Detailed information about the execution
    */
@@ -82,51 +59,9 @@ export type ActivityNotificationExecutionDetailResponseDto = {
   /**
    * Source of the execution detail
    */
-  source: Source;
+  source: ExecutionDetailsSourceEnum;
 };
 
-/** @internal */
-export const ActivityNotificationExecutionDetailResponseDtoStatus$inboundSchema:
-  z.ZodNativeEnum<typeof ActivityNotificationExecutionDetailResponseDtoStatus> =
-    z.nativeEnum(ActivityNotificationExecutionDetailResponseDtoStatus);
-
-/** @internal */
-export const ActivityNotificationExecutionDetailResponseDtoStatus$outboundSchema:
-  z.ZodNativeEnum<typeof ActivityNotificationExecutionDetailResponseDtoStatus> =
-    ActivityNotificationExecutionDetailResponseDtoStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ActivityNotificationExecutionDetailResponseDtoStatus$ {
-  /** @deprecated use `ActivityNotificationExecutionDetailResponseDtoStatus$inboundSchema` instead. */
-  export const inboundSchema =
-    ActivityNotificationExecutionDetailResponseDtoStatus$inboundSchema;
-  /** @deprecated use `ActivityNotificationExecutionDetailResponseDtoStatus$outboundSchema` instead. */
-  export const outboundSchema =
-    ActivityNotificationExecutionDetailResponseDtoStatus$outboundSchema;
-}
-
-/** @internal */
-export const Source$inboundSchema: z.ZodNativeEnum<typeof Source> = z
-  .nativeEnum(Source);
-
-/** @internal */
-export const Source$outboundSchema: z.ZodNativeEnum<typeof Source> =
-  Source$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Source$ {
-  /** @deprecated use `Source$inboundSchema` instead. */
-  export const inboundSchema = Source$inboundSchema;
-  /** @deprecated use `Source$outboundSchema` instead. */
-  export const outboundSchema = Source$outboundSchema;
-}
-
 /** @internal */
 export const ActivityNotificationExecutionDetailResponseDto$inboundSchema:
   z.ZodType<
@@ -136,13 +71,13 @@ export const ActivityNotificationExecutionDetailResponseDto$inboundSchema:
   > = z.object({
     _id: z.string(),
     createdAt: z.string().optional(),
-    status: ActivityNotificationExecutionDetailResponseDtoStatus$inboundSchema,
+    status: ExecutionDetailsStatusEnum$inboundSchema,
     detail: z.string(),
     isRetry: z.boolean(),
     isTest: z.boolean(),
     providerId: ProvidersIdEnum$inboundSchema,
     raw: z.string().optional(),
-    source: Source$inboundSchema,
+    source: ExecutionDetailsSourceEnum$inboundSchema,
   }).transform((v) => {
     return remap$(v, {
       "_id": "id",
@@ -171,13 +106,13 @@ export const ActivityNotificationExecutionDetailResponseDto$outboundSchema:
   > = z.object({
     id: z.string(),
     createdAt: z.string().optional(),
-    status: ActivityNotificationExecutionDetailResponseDtoStatus$outboundSchema,
+    status: ExecutionDetailsStatusEnum$outboundSchema,
     detail: z.string(),
     isRetry: z.boolean(),
     isTest: z.boolean(),
     providerId: ProvidersIdEnum$outboundSchema,
     raw: z.string().optional(),
-    source: Source$outboundSchema,
+    source: ExecutionDetailsSourceEnum$outboundSchema,
   }).transform((v) => {
     return remap$(v, {
       id: "_id",

package/src/models/components/activitynotificationjobresponsedto.ts

@@ -21,11 +21,11 @@ import {
   ActivityNotificationStepResponseDto$outboundSchema,
 } from "./activitynotificationstepresponsedto.js";
 import {
-  DigestWithEventsDto,
-  DigestWithEventsDto$inboundSchema,
-  DigestWithEventsDto$Outbound,
-  DigestWithEventsDto$outboundSchema,
-} from "./digestwitheventsdto.js";
+  DigestMetadataDto,
+  DigestMetadataDto$inboundSchema,
+  DigestMetadataDto$Outbound,
+  DigestMetadataDto$outboundSchema,
+} from "./digestmetadatadto.js";
 import {
   ProvidersIdEnum,
   ProvidersIdEnum$inboundSchema,
@@ -70,7 +70,7 @@ export type ActivityNotificationJobResponseDto = {
   /**
    * Optional digest for the job, including metadata and events
    */
-  digest?: DigestWithEventsDto | undefined;
+  digest?: DigestMetadataDto | undefined;
   /**
    * Execution details of the job
    */
@@ -170,7 +170,7 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string(),
   type: ActivityNotificationJobResponseDtoType$inboundSchema,
-  digest: DigestWithEventsDto$inboundSchema.optional(),
+  digest: DigestMetadataDto$inboundSchema.optional(),
   executionDetails: z.array(
     ActivityNotificationExecutionDetailResponseDto$inboundSchema,
   ),
@@ -189,7 +189,7 @@ export const ActivityNotificationJobResponseDto$inboundSchema: z.ZodType<
 export type ActivityNotificationJobResponseDto$Outbound = {
   _id: string;
   type: string;
-  digest?: DigestWithEventsDto$Outbound | undefined;
+  digest?: DigestMetadataDto$Outbound | undefined;
   executionDetails: Array<
     ActivityNotificationExecutionDetailResponseDto$Outbound
   >;
@@ -208,7 +208,7 @@ export const ActivityNotificationJobResponseDto$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string(),
   type: ActivityNotificationJobResponseDtoType$outboundSchema,
-  digest: DigestWithEventsDto$outboundSchema.optional(),
+  digest: DigestMetadataDto$outboundSchema.optional(),
   executionDetails: z.array(
     ActivityNotificationExecutionDetailResponseDto$outboundSchema,
   ),

package/src/models/components/activitynotificationresponsedto.ts

@@ -31,6 +31,21 @@ import {
   StepTypeEnum$outboundSchema,
 } from "./steptypeenum.js";
 
+/**
+ * Payload of the notification
+ */
+export type ActivityNotificationResponseDtoPayload = {};
+
+/**
+ * Controls associated with the notification
+ */
+export type Controls = {};
+
+/**
+ * To field for subscriber definition
+ */
+export type ActivityNotificationResponseDtoTo = {};
+
 export type ActivityNotificationResponseDto = {
   /**
    * Unique identifier of the notification
@@ -44,14 +59,30 @@ export type ActivityNotificationResponseDto = {
    * Organization ID of the notification
    */
   organizationId: string;
+  /**
+   * Subscriber ID of the notification
+   */
+  subscriberId: string;
   /**
    * Transaction ID of the notification
    */
   transactionId: string;
+  /**
+   * Template ID of the notification
+   */
+  templateId?: string | undefined;
+  /**
+   * Digested Notification ID
+   */
+  digestedNotificationId?: string | undefined;
   /**
    * Creation time of the notification
    */
   createdAt?: string | undefined;
+  /**
+   * Last updated time of the notification
+   */
+  updatedAt?: string | undefined;
   channels?: Array<StepTypeEnum> | undefined;
   /**
    * Subscriber of the notification
@@ -65,8 +96,173 @@ export type ActivityNotificationResponseDto = {
    * Jobs of the notification
    */
   jobs?: Array<ActivityNotificationJobResponseDto> | undefined;
+  /**
+   * Payload of the notification
+   */
+  payload?: ActivityNotificationResponseDtoPayload | undefined;
+  /**
+   * Tags associated with the notification
+   */
+  tags?: Array<string> | undefined;
+  /**
+   * Controls associated with the notification
+   */
+  controls?: Controls | undefined;
+  /**
+   * To field for subscriber definition
+   */
+  to?: ActivityNotificationResponseDtoTo | undefined;
 };
 
+/** @internal */
+export const ActivityNotificationResponseDtoPayload$inboundSchema: z.ZodType<
+  ActivityNotificationResponseDtoPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type ActivityNotificationResponseDtoPayload$Outbound = {};
+
+/** @internal */
+export const ActivityNotificationResponseDtoPayload$outboundSchema: z.ZodType<
+  ActivityNotificationResponseDtoPayload$Outbound,
+  z.ZodTypeDef,
+  ActivityNotificationResponseDtoPayload
+> = 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 ActivityNotificationResponseDtoPayload$ {
+  /** @deprecated use `ActivityNotificationResponseDtoPayload$inboundSchema` instead. */
+  export const inboundSchema =
+    ActivityNotificationResponseDtoPayload$inboundSchema;
+  /** @deprecated use `ActivityNotificationResponseDtoPayload$outboundSchema` instead. */
+  export const outboundSchema =
+    ActivityNotificationResponseDtoPayload$outboundSchema;
+  /** @deprecated use `ActivityNotificationResponseDtoPayload$Outbound` instead. */
+  export type Outbound = ActivityNotificationResponseDtoPayload$Outbound;
+}
+
+export function activityNotificationResponseDtoPayloadToJSON(
+  activityNotificationResponseDtoPayload:
+    ActivityNotificationResponseDtoPayload,
+): string {
+  return JSON.stringify(
+    ActivityNotificationResponseDtoPayload$outboundSchema.parse(
+      activityNotificationResponseDtoPayload,
+    ),
+  );
+}
+
+export function activityNotificationResponseDtoPayloadFromJSON(
+  jsonString: string,
+): SafeParseResult<ActivityNotificationResponseDtoPayload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ActivityNotificationResponseDtoPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActivityNotificationResponseDtoPayload' from JSON`,
+  );
+}
+
+/** @internal */
+export const Controls$inboundSchema: z.ZodType<
+  Controls,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type Controls$Outbound = {};
+
+/** @internal */
+export const Controls$outboundSchema: z.ZodType<
+  Controls$Outbound,
+  z.ZodTypeDef,
+  Controls
+> = 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 Controls$ {
+  /** @deprecated use `Controls$inboundSchema` instead. */
+  export const inboundSchema = Controls$inboundSchema;
+  /** @deprecated use `Controls$outboundSchema` instead. */
+  export const outboundSchema = Controls$outboundSchema;
+  /** @deprecated use `Controls$Outbound` instead. */
+  export type Outbound = Controls$Outbound;
+}
+
+export function controlsToJSON(controls: Controls): string {
+  return JSON.stringify(Controls$outboundSchema.parse(controls));
+}
+
+export function controlsFromJSON(
+  jsonString: string,
+): SafeParseResult<Controls, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Controls$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Controls' from JSON`,
+  );
+}
+
+/** @internal */
+export const ActivityNotificationResponseDtoTo$inboundSchema: z.ZodType<
+  ActivityNotificationResponseDtoTo,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type ActivityNotificationResponseDtoTo$Outbound = {};
+
+/** @internal */
+export const ActivityNotificationResponseDtoTo$outboundSchema: z.ZodType<
+  ActivityNotificationResponseDtoTo$Outbound,
+  z.ZodTypeDef,
+  ActivityNotificationResponseDtoTo
+> = 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 ActivityNotificationResponseDtoTo$ {
+  /** @deprecated use `ActivityNotificationResponseDtoTo$inboundSchema` instead. */
+  export const inboundSchema = ActivityNotificationResponseDtoTo$inboundSchema;
+  /** @deprecated use `ActivityNotificationResponseDtoTo$outboundSchema` instead. */
+  export const outboundSchema =
+    ActivityNotificationResponseDtoTo$outboundSchema;
+  /** @deprecated use `ActivityNotificationResponseDtoTo$Outbound` instead. */
+  export type Outbound = ActivityNotificationResponseDtoTo$Outbound;
+}
+
+export function activityNotificationResponseDtoToToJSON(
+  activityNotificationResponseDtoTo: ActivityNotificationResponseDtoTo,
+): string {
+  return JSON.stringify(
+    ActivityNotificationResponseDtoTo$outboundSchema.parse(
+      activityNotificationResponseDtoTo,
+    ),
+  );
+}
+
+export function activityNotificationResponseDtoToFromJSON(
+  jsonString: string,
+): SafeParseResult<ActivityNotificationResponseDtoTo, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ActivityNotificationResponseDtoTo$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActivityNotificationResponseDtoTo' from JSON`,
+  );
+}
+
 /** @internal */
 export const ActivityNotificationResponseDto$inboundSchema: z.ZodType<
   ActivityNotificationResponseDto,
@@ -76,18 +272,30 @@ export const ActivityNotificationResponseDto$inboundSchema: z.ZodType<
   _id: z.string().optional(),
   _environmentId: z.string(),
   _organizationId: z.string(),
+  _subscriberId: z.string(),
   transactionId: z.string(),
+  _templateId: z.string().optional(),
+  _digestedNotificationId: z.string().optional(),
   createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
   channels: z.array(StepTypeEnum$inboundSchema).optional(),
   subscriber: ActivityNotificationSubscriberResponseDto$inboundSchema
     .optional(),
   template: ActivityNotificationTemplateResponseDto$inboundSchema.optional(),
   jobs: z.array(ActivityNotificationJobResponseDto$inboundSchema).optional(),
+  payload: z.lazy(() => ActivityNotificationResponseDtoPayload$inboundSchema)
+    .optional(),
+  tags: z.array(z.string()).optional(),
+  controls: z.lazy(() => Controls$inboundSchema).optional(),
+  to: z.lazy(() => ActivityNotificationResponseDtoTo$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
     "_environmentId": "environmentId",
     "_organizationId": "organizationId",
+    "_subscriberId": "subscriberId",
+    "_templateId": "templateId",
+    "_digestedNotificationId": "digestedNotificationId",
   });
 });
 
@@ -96,12 +304,20 @@ export type ActivityNotificationResponseDto$Outbound = {
   _id?: string | undefined;
   _environmentId: string;
   _organizationId: string;
+  _subscriberId: string;
   transactionId: string;
+  _templateId?: string | undefined;
+  _digestedNotificationId?: string | undefined;
   createdAt?: string | undefined;
+  updatedAt?: string | undefined;
   channels?: Array<string> | undefined;
   subscriber?: ActivityNotificationSubscriberResponseDto$Outbound | undefined;
   template?: ActivityNotificationTemplateResponseDto$Outbound | undefined;
   jobs?: Array<ActivityNotificationJobResponseDto$Outbound> | undefined;
+  payload?: ActivityNotificationResponseDtoPayload$Outbound | undefined;
+  tags?: Array<string> | undefined;
+  controls?: Controls$Outbound | undefined;
+  to?: ActivityNotificationResponseDtoTo$Outbound | undefined;
 };
 
 /** @internal */
@@ -113,18 +329,30 @@ export const ActivityNotificationResponseDto$outboundSchema: z.ZodType<
   id: z.string().optional(),
   environmentId: z.string(),
   organizationId: z.string(),
+  subscriberId: z.string(),
   transactionId: z.string(),
+  templateId: z.string().optional(),
+  digestedNotificationId: z.string().optional(),
   createdAt: z.string().optional(),
+  updatedAt: z.string().optional(),
   channels: z.array(StepTypeEnum$outboundSchema).optional(),
   subscriber: ActivityNotificationSubscriberResponseDto$outboundSchema
     .optional(),
   template: ActivityNotificationTemplateResponseDto$outboundSchema.optional(),
   jobs: z.array(ActivityNotificationJobResponseDto$outboundSchema).optional(),
+  payload: z.lazy(() => ActivityNotificationResponseDtoPayload$outboundSchema)
+    .optional(),
+  tags: z.array(z.string()).optional(),
+  controls: z.lazy(() => Controls$outboundSchema).optional(),
+  to: z.lazy(() => ActivityNotificationResponseDtoTo$outboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",
     environmentId: "_environmentId",
     organizationId: "_organizationId",
+    subscriberId: "_subscriberId",
+    templateId: "_templateId",
+    digestedNotificationId: "_digestedNotificationId",
   });
 });