@novu/api 0.0.1-alpha.11 → 0.0.1-alpha.110

package/src/models/components/notificationfeeditemdto.ts

@@ -0,0 +1,340 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 {
+  ActorFeedItemDto,
+  ActorFeedItemDto$inboundSchema,
+  ActorFeedItemDto$Outbound,
+  ActorFeedItemDto$outboundSchema,
+} from "./actorfeeditemdto.js";
+import {
+  ChannelTypeEnum,
+  ChannelTypeEnum$inboundSchema,
+  ChannelTypeEnum$outboundSchema,
+} from "./channeltypeenum.js";
+import {
+  MessageCTA,
+  MessageCTA$inboundSchema,
+  MessageCTA$Outbound,
+  MessageCTA$outboundSchema,
+} from "./messagecta.js";
+import {
+  SubscriberFeedResponseDto,
+  SubscriberFeedResponseDto$inboundSchema,
+  SubscriberFeedResponseDto$Outbound,
+  SubscriberFeedResponseDto$outboundSchema,
+} from "./subscriberfeedresponsedto.js";
+
+/**
+ * Current status of the notification.
+ */
+export const NotificationFeedItemDtoStatus = {
+  Sent: "sent",
+  Error: "error",
+  Warning: "warning",
+} as const;
+/**
+ * Current status of the notification.
+ */
+export type NotificationFeedItemDtoStatus = ClosedEnum<
+  typeof NotificationFeedItemDtoStatus
+>;
+
+export type NotificationFeedItemDto = {
+  /**
+   * Unique identifier for the notification.
+   */
+  id: string;
+  /**
+   * Identifier for the template used to generate the notification.
+   */
+  templateId: string;
+  /**
+   * Identifier for the environment where the notification is sent.
+   */
+  environmentId: string;
+  /**
+   * Identifier for the message template used.
+   */
+  messageTemplateId: string;
+  /**
+   * Identifier for the organization sending the notification.
+   */
+  organizationId: string;
+  /**
+   * Unique identifier for the notification instance.
+   */
+  notificationId: string;
+  /**
+   * Unique identifier for the subscriber receiving the notification.
+   */
+  subscriberId: string;
+  /**
+   * Identifier for the feed associated with the notification.
+   */
+  feedId: string;
+  /**
+   * Identifier for the job that triggered the notification.
+   */
+  jobId: string;
+  /**
+   * Timestamp indicating when the notification was created.
+   */
+  createdAt?: Date | null | undefined;
+  /**
+   * Timestamp indicating when the notification was last updated.
+   */
+  updatedAt?: Date | null | undefined;
+  /**
+   * Actor details related to the notification, if applicable.
+   */
+  actor?: ActorFeedItemDto | undefined;
+  /**
+   * Subscriber details associated with this notification.
+   */
+  subscriber?: SubscriberFeedResponseDto | undefined;
+  /**
+   * Unique identifier for the transaction associated with the notification.
+   */
+  transactionId: string;
+  /**
+   * Identifier for the template used, if applicable.
+   */
+  templateIdentifier?: string | null | undefined;
+  /**
+   * Identifier for the provider that sends the notification.
+   */
+  providerId?: string | null | undefined;
+  /**
+   * The main content of the notification.
+   */
+  content: string;
+  /**
+   * The subject line for email notifications, if applicable.
+   */
+  subject?: string | null | undefined;
+  /**
+   * The channel through which the notification is sent.
+   */
+  channel: ChannelTypeEnum;
+  /**
+   * Indicates whether the notification has been read by the subscriber.
+   */
+  read: boolean;
+  /**
+   * Indicates whether the notification has been seen by the subscriber.
+   */
+  seen: boolean;
+  /**
+   * Indicates whether the notification has been deleted.
+   */
+  deleted: boolean;
+  /**
+   * Device tokens for push notifications, if applicable.
+   */
+  deviceTokens?: Array<string> | null | undefined;
+  /**
+   * Call-to-action information associated with the notification.
+   */
+  cta: MessageCTA;
+  /**
+   * Current status of the notification.
+   */
+  status: NotificationFeedItemDtoStatus;
+  /**
+   * The payload that was used to send the notification trigger.
+   */
+  payload?: { [k: string]: any } | undefined;
+  /**
+   * Provider-specific overrides used when triggering the notification.
+   */
+  overrides?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const NotificationFeedItemDtoStatus$inboundSchema: z.ZodNativeEnum<
+  typeof NotificationFeedItemDtoStatus
+> = z.nativeEnum(NotificationFeedItemDtoStatus);
+
+/** @internal */
+export const NotificationFeedItemDtoStatus$outboundSchema: z.ZodNativeEnum<
+  typeof NotificationFeedItemDtoStatus
+> = NotificationFeedItemDtoStatus$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationFeedItemDtoStatus$ {
+  /** @deprecated use `NotificationFeedItemDtoStatus$inboundSchema` instead. */
+  export const inboundSchema = NotificationFeedItemDtoStatus$inboundSchema;
+  /** @deprecated use `NotificationFeedItemDtoStatus$outboundSchema` instead. */
+  export const outboundSchema = NotificationFeedItemDtoStatus$outboundSchema;
+}
+
+/** @internal */
+export const NotificationFeedItemDto$inboundSchema: z.ZodType<
+  NotificationFeedItemDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  _templateId: z.string(),
+  _environmentId: z.string(),
+  _messageTemplateId: z.string(),
+  _organizationId: z.string(),
+  _notificationId: z.string(),
+  _subscriberId: z.string(),
+  _feedId: z.string(),
+  _jobId: z.string(),
+  createdAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  updatedAt: z.nullable(
+    z.string().datetime({ offset: true }).transform(v => new Date(v)),
+  ).optional(),
+  actor: ActorFeedItemDto$inboundSchema.optional(),
+  subscriber: SubscriberFeedResponseDto$inboundSchema.optional(),
+  transactionId: z.string(),
+  templateIdentifier: z.nullable(z.string()).optional(),
+  providerId: z.nullable(z.string()).optional(),
+  content: z.string(),
+  subject: z.nullable(z.string()).optional(),
+  channel: ChannelTypeEnum$inboundSchema,
+  read: z.boolean(),
+  seen: z.boolean(),
+  deleted: z.boolean(),
+  deviceTokens: z.nullable(z.array(z.string())).optional(),
+  cta: MessageCTA$inboundSchema,
+  status: NotificationFeedItemDtoStatus$inboundSchema,
+  payload: z.record(z.any()).optional(),
+  overrides: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+    "_templateId": "templateId",
+    "_environmentId": "environmentId",
+    "_messageTemplateId": "messageTemplateId",
+    "_organizationId": "organizationId",
+    "_notificationId": "notificationId",
+    "_subscriberId": "subscriberId",
+    "_feedId": "feedId",
+    "_jobId": "jobId",
+  });
+});
+
+/** @internal */
+export type NotificationFeedItemDto$Outbound = {
+  _id: string;
+  _templateId: string;
+  _environmentId: string;
+  _messageTemplateId: string;
+  _organizationId: string;
+  _notificationId: string;
+  _subscriberId: string;
+  _feedId: string;
+  _jobId: string;
+  createdAt?: string | null | undefined;
+  updatedAt?: string | null | undefined;
+  actor?: ActorFeedItemDto$Outbound | undefined;
+  subscriber?: SubscriberFeedResponseDto$Outbound | undefined;
+  transactionId: string;
+  templateIdentifier?: string | null | undefined;
+  providerId?: string | null | undefined;
+  content: string;
+  subject?: string | null | undefined;
+  channel: string;
+  read: boolean;
+  seen: boolean;
+  deleted: boolean;
+  deviceTokens?: Array<string> | null | undefined;
+  cta: MessageCTA$Outbound;
+  status: string;
+  payload?: { [k: string]: any } | undefined;
+  overrides?: { [k: string]: any } | undefined;
+};
+
+/** @internal */
+export const NotificationFeedItemDto$outboundSchema: z.ZodType<
+  NotificationFeedItemDto$Outbound,
+  z.ZodTypeDef,
+  NotificationFeedItemDto
+> = z.object({
+  id: z.string(),
+  templateId: z.string(),
+  environmentId: z.string(),
+  messageTemplateId: z.string(),
+  organizationId: z.string(),
+  notificationId: z.string(),
+  subscriberId: z.string(),
+  feedId: z.string(),
+  jobId: z.string(),
+  createdAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  updatedAt: z.nullable(z.date().transform(v => v.toISOString())).optional(),
+  actor: ActorFeedItemDto$outboundSchema.optional(),
+  subscriber: SubscriberFeedResponseDto$outboundSchema.optional(),
+  transactionId: z.string(),
+  templateIdentifier: z.nullable(z.string()).optional(),
+  providerId: z.nullable(z.string()).optional(),
+  content: z.string(),
+  subject: z.nullable(z.string()).optional(),
+  channel: ChannelTypeEnum$outboundSchema,
+  read: z.boolean(),
+  seen: z.boolean(),
+  deleted: z.boolean(),
+  deviceTokens: z.nullable(z.array(z.string())).optional(),
+  cta: MessageCTA$outboundSchema,
+  status: NotificationFeedItemDtoStatus$outboundSchema,
+  payload: z.record(z.any()).optional(),
+  overrides: z.record(z.any()).optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+    templateId: "_templateId",
+    environmentId: "_environmentId",
+    messageTemplateId: "_messageTemplateId",
+    organizationId: "_organizationId",
+    notificationId: "_notificationId",
+    subscriberId: "_subscriberId",
+    feedId: "_feedId",
+    jobId: "_jobId",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace NotificationFeedItemDto$ {
+  /** @deprecated use `NotificationFeedItemDto$inboundSchema` instead. */
+  export const inboundSchema = NotificationFeedItemDto$inboundSchema;
+  /** @deprecated use `NotificationFeedItemDto$outboundSchema` instead. */
+  export const outboundSchema = NotificationFeedItemDto$outboundSchema;
+  /** @deprecated use `NotificationFeedItemDto$Outbound` instead. */
+  export type Outbound = NotificationFeedItemDto$Outbound;
+}
+
+export function notificationFeedItemDtoToJSON(
+  notificationFeedItemDto: NotificationFeedItemDto,
+): string {
+  return JSON.stringify(
+    NotificationFeedItemDto$outboundSchema.parse(notificationFeedItemDto),
+  );
+}
+
+export function notificationFeedItemDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationFeedItemDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationFeedItemDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationFeedItemDto' from JSON`,
+  );
+}

package/src/models/components/notificationgroup.ts

@@ -4,13 +4,16 @@
 
 import * as z from "zod";
 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";
 
 export type NotificationGroup = {
-  environmentId: string;
   id?: string | undefined;
+  name: string;
+  environmentId: string;
   organizationId: string;
   parentId?: string | undefined;
-  name: string;
 };
 
 /** @internal */
@@ -19,15 +22,15 @@ export const NotificationGroup$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _environmentId: z.string(),
   _id: z.string().optional(),
+  name: z.string(),
+  _environmentId: z.string(),
   _organizationId: z.string(),
   _parentId: z.string().optional(),
-  name: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    "_environmentId": "environmentId",
     "_id": "id",
+    "_environmentId": "environmentId",
     "_organizationId": "organizationId",
     "_parentId": "parentId",
   });
@@ -35,11 +38,11 @@ export const NotificationGroup$inboundSchema: z.ZodType<
 
 /** @internal */
 export type NotificationGroup$Outbound = {
-  _environmentId: string;
   _id?: string | undefined;
+  name: string;
+  _environmentId: string;
   _organizationId: string;
   _parentId?: string | undefined;
-  name: string;
 };
 
 /** @internal */
@@ -48,15 +51,15 @@ export const NotificationGroup$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   NotificationGroup
 > = z.object({
-  environmentId: z.string(),
   id: z.string().optional(),
+  name: z.string(),
+  environmentId: z.string(),
   organizationId: z.string(),
   parentId: z.string().optional(),
-  name: z.string(),
 }).transform((v) => {
   return remap$(v, {
-    environmentId: "_environmentId",
     id: "_id",
+    environmentId: "_environmentId",
     organizationId: "_organizationId",
     parentId: "_parentId",
   });
@@ -74,3 +77,21 @@ export namespace NotificationGroup$ {
   /** @deprecated use `NotificationGroup$Outbound` instead. */
   export type Outbound = NotificationGroup$Outbound;
 }
+
+export function notificationGroupToJSON(
+  notificationGroup: NotificationGroup,
+): string {
+  return JSON.stringify(
+    NotificationGroup$outboundSchema.parse(notificationGroup),
+  );
+}
+
+export function notificationGroupFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationGroup, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationGroup$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationGroup' from JSON`,
+  );
+}

package/src/models/components/notificationstep.ts

@@ -4,6 +4,9 @@
 
 import * as z from "zod";
 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 {
   DelayRegularMetadata,
   DelayRegularMetadata$inboundSchema,
@@ -59,21 +62,21 @@ export type ReplyCallback = {};
 
 export type NotificationStep = {
   id?: string | undefined;
-  parentId?: ParentId | undefined;
+  uuid?: string | undefined;
+  name?: string | undefined;
   templateId?: string | undefined;
   active?: boolean | undefined;
+  shouldStopOnFail?: boolean | undefined;
+  template?: MessageTemplate | undefined;
   filters?: Array<StepFilter> | undefined;
+  parentId?: ParentId | undefined;
   metadata?:
     | DelayScheduledMetadata
     | DelayRegularMetadata
     | DigestTimedMetadata
     | DigestRegularMetadata
     | undefined;
-  name?: string | undefined;
   replyCallback?: ReplyCallback | undefined;
-  shouldStopOnFail?: boolean | undefined;
-  template?: MessageTemplate | undefined;
-  uuid?: string | undefined;
   variants?: NotificationStepVariant | undefined;
 };
 
@@ -107,6 +110,20 @@ export namespace ParentId$ {
   export type Outbound = ParentId$Outbound;
 }
 
+export function parentIdToJSON(parentId: ParentId): string {
+  return JSON.stringify(ParentId$outboundSchema.parse(parentId));
+}
+
+export function parentIdFromJSON(
+  jsonString: string,
+): SafeParseResult<ParentId, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ParentId$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ParentId' from JSON`,
+  );
+}
+
 /** @internal */
 export const Metadata$inboundSchema: z.ZodType<
   Metadata,
@@ -151,6 +168,20 @@ export namespace Metadata$ {
   export type Outbound = Metadata$Outbound;
 }
 
+export function metadataToJSON(metadata: Metadata): string {
+  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
+}
+
+export function metadataFromJSON(
+  jsonString: string,
+): SafeParseResult<Metadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
+  );
+}
+
 /** @internal */
 export const ReplyCallback$inboundSchema: z.ZodType<
   ReplyCallback,
@@ -181,6 +212,20 @@ export namespace ReplyCallback$ {
   export type Outbound = ReplyCallback$Outbound;
 }
 
+export function replyCallbackToJSON(replyCallback: ReplyCallback): string {
+  return JSON.stringify(ReplyCallback$outboundSchema.parse(replyCallback));
+}
+
+export function replyCallbackFromJSON(
+  jsonString: string,
+): SafeParseResult<ReplyCallback, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ReplyCallback$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ReplyCallback' from JSON`,
+  );
+}
+
 /** @internal */
 export const NotificationStep$inboundSchema: z.ZodType<
   NotificationStep,
@@ -188,48 +233,48 @@ export const NotificationStep$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
-  _parentId: z.lazy(() => ParentId$inboundSchema).optional(),
+  uuid: z.string().optional(),
+  name: z.string().optional(),
   _templateId: z.string().optional(),
   active: z.boolean().optional(),
+  shouldStopOnFail: z.boolean().optional(),
+  template: MessageTemplate$inboundSchema.optional(),
   filters: z.array(StepFilter$inboundSchema).optional(),
+  _parentId: z.lazy(() => ParentId$inboundSchema).optional(),
   metadata: z.union([
     DelayScheduledMetadata$inboundSchema,
     DelayRegularMetadata$inboundSchema,
     DigestTimedMetadata$inboundSchema,
     DigestRegularMetadata$inboundSchema,
   ]).optional(),
-  name: z.string().optional(),
   replyCallback: z.lazy(() => ReplyCallback$inboundSchema).optional(),
-  shouldStopOnFail: z.boolean().optional(),
-  template: MessageTemplate$inboundSchema.optional(),
-  uuid: z.string().optional(),
   variants: NotificationStepVariant$inboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
-    "_parentId": "parentId",
     "_templateId": "templateId",
+    "_parentId": "parentId",
   });
 });
 
 /** @internal */
 export type NotificationStep$Outbound = {
   _id?: string | undefined;
-  _parentId?: ParentId$Outbound | undefined;
+  uuid?: string | undefined;
+  name?: string | undefined;
   _templateId?: string | undefined;
   active?: boolean | undefined;
+  shouldStopOnFail?: boolean | undefined;
+  template?: MessageTemplate$Outbound | undefined;
   filters?: Array<StepFilter$Outbound> | undefined;
+  _parentId?: ParentId$Outbound | undefined;
   metadata?:
     | DelayScheduledMetadata$Outbound
     | DelayRegularMetadata$Outbound
     | DigestTimedMetadata$Outbound
     | DigestRegularMetadata$Outbound
     | undefined;
-  name?: string | undefined;
   replyCallback?: ReplyCallback$Outbound | undefined;
-  shouldStopOnFail?: boolean | undefined;
-  template?: MessageTemplate$Outbound | undefined;
-  uuid?: string | undefined;
   variants?: NotificationStepVariant$Outbound | undefined;
 };
 
@@ -240,27 +285,27 @@ export const NotificationStep$outboundSchema: z.ZodType<
   NotificationStep
 > = z.object({
   id: z.string().optional(),
-  parentId: z.lazy(() => ParentId$outboundSchema).optional(),
+  uuid: z.string().optional(),
+  name: z.string().optional(),
   templateId: z.string().optional(),
   active: z.boolean().optional(),
+  shouldStopOnFail: z.boolean().optional(),
+  template: MessageTemplate$outboundSchema.optional(),
   filters: z.array(StepFilter$outboundSchema).optional(),
+  parentId: z.lazy(() => ParentId$outboundSchema).optional(),
   metadata: z.union([
     DelayScheduledMetadata$outboundSchema,
     DelayRegularMetadata$outboundSchema,
     DigestTimedMetadata$outboundSchema,
     DigestRegularMetadata$outboundSchema,
   ]).optional(),
-  name: z.string().optional(),
   replyCallback: z.lazy(() => ReplyCallback$outboundSchema).optional(),
-  shouldStopOnFail: z.boolean().optional(),
-  template: MessageTemplate$outboundSchema.optional(),
-  uuid: z.string().optional(),
   variants: NotificationStepVariant$outboundSchema.optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",
-    parentId: "_parentId",
     templateId: "_templateId",
+    parentId: "_parentId",
   });
 });
 
@@ -276,3 +321,21 @@ export namespace NotificationStep$ {
   /** @deprecated use `NotificationStep$Outbound` instead. */
   export type Outbound = NotificationStep$Outbound;
 }
+
+export function notificationStepToJSON(
+  notificationStep: NotificationStep,
+): string {
+  return JSON.stringify(
+    NotificationStep$outboundSchema.parse(notificationStep),
+  );
+}
+
+export function notificationStepFromJSON(
+  jsonString: string,
+): SafeParseResult<NotificationStep, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => NotificationStep$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'NotificationStep' from JSON`,
+  );
+}