@novu/api 0.0.1-alpha.99 → 0.0.2

package/src/models/components/messagebutton.ts

@@ -4,50 +4,36 @@
 
 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";
-
-export const MessageButtonType = {
-  Primary: "primary",
-  Secondary: "secondary",
-} as const;
-export type MessageButtonType = ClosedEnum<typeof MessageButtonType>;
+import {
+  ButtonTypeEnum,
+  ButtonTypeEnum$inboundSchema,
+  ButtonTypeEnum$outboundSchema,
+} from "./buttontypeenum.js";
 
 export type MessageButton = {
-  type: MessageButtonType;
+  /**
+   * Type of button for the action result
+   */
+  type: ButtonTypeEnum;
+  /**
+   * Content of the button
+   */
   content: string;
+  /**
+   * Content of the result when the button is clicked
+   */
   resultContent?: string | undefined;
 };
 
-/** @internal */
-export const MessageButtonType$inboundSchema: z.ZodNativeEnum<
-  typeof MessageButtonType
-> = z.nativeEnum(MessageButtonType);
-
-/** @internal */
-export const MessageButtonType$outboundSchema: z.ZodNativeEnum<
-  typeof MessageButtonType
-> = MessageButtonType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MessageButtonType$ {
-  /** @deprecated use `MessageButtonType$inboundSchema` instead. */
-  export const inboundSchema = MessageButtonType$inboundSchema;
-  /** @deprecated use `MessageButtonType$outboundSchema` instead. */
-  export const outboundSchema = MessageButtonType$outboundSchema;
-}
-
 /** @internal */
 export const MessageButton$inboundSchema: z.ZodType<
   MessageButton,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: MessageButtonType$inboundSchema,
+  type: ButtonTypeEnum$inboundSchema,
   content: z.string(),
   resultContent: z.string().optional(),
 });
@@ -65,7 +51,7 @@ export const MessageButton$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageButton
 > = z.object({
-  type: MessageButtonType$outboundSchema,
+  type: ButtonTypeEnum$outboundSchema,
   content: z.string(),
   resultContent: z.string().optional(),
 });

package/src/models/components/messagecta.ts

@@ -4,9 +4,13 @@
 
 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 {
+  ChannelCTATypeEnum,
+  ChannelCTATypeEnum$inboundSchema,
+  ChannelCTATypeEnum$outboundSchema,
+} from "./channelctatypeenum.js";
 import {
   MessageAction,
   MessageAction$inboundSchema,
@@ -20,45 +24,28 @@ import {
   MessageCTAData$outboundSchema,
 } from "./messagectadata.js";
 
-export const MessageCTAType = {
-  Redirect: "redirect",
-} as const;
-export type MessageCTAType = ClosedEnum<typeof MessageCTAType>;
-
 export type MessageCTA = {
-  type?: MessageCTAType | undefined;
+  /**
+   * Type of call to action
+   */
+  type?: ChannelCTATypeEnum | undefined;
+  /**
+   * Data associated with the call to action
+   */
   data: MessageCTAData;
+  /**
+   * Action associated with the call to action
+   */
   action?: MessageAction | undefined;
 };
 
-/** @internal */
-export const MessageCTAType$inboundSchema: z.ZodNativeEnum<
-  typeof MessageCTAType
-> = z.nativeEnum(MessageCTAType);
-
-/** @internal */
-export const MessageCTAType$outboundSchema: z.ZodNativeEnum<
-  typeof MessageCTAType
-> = MessageCTAType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MessageCTAType$ {
-  /** @deprecated use `MessageCTAType$inboundSchema` instead. */
-  export const inboundSchema = MessageCTAType$inboundSchema;
-  /** @deprecated use `MessageCTAType$outboundSchema` instead. */
-  export const outboundSchema = MessageCTAType$outboundSchema;
-}
-
 /** @internal */
 export const MessageCTA$inboundSchema: z.ZodType<
   MessageCTA,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: MessageCTAType$inboundSchema.optional(),
+  type: ChannelCTATypeEnum$inboundSchema.optional(),
   data: MessageCTAData$inboundSchema,
   action: MessageAction$inboundSchema.optional(),
 });
@@ -76,7 +63,7 @@ export const MessageCTA$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageCTA
 > = z.object({
-  type: MessageCTAType$outboundSchema.optional(),
+  type: ChannelCTATypeEnum$outboundSchema.optional(),
   data: MessageCTAData$outboundSchema,
   action: MessageAction$outboundSchema.optional(),
 });

package/src/models/components/messagectadata.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type MessageCTAData = {
+  /**
+   * URL for the call to action
+   */
   url?: string | undefined;
 };
 

package/src/models/components/messageresponsedto.ts

@@ -5,9 +5,13 @@
 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 {
+  ChannelTypeEnum,
+  ChannelTypeEnum$inboundSchema,
+  ChannelTypeEnum$outboundSchema,
+} from "./channeltypeenum.js";
 import {
   EmailBlock,
   EmailBlock$inboundSchema,
@@ -20,6 +24,11 @@ import {
   MessageCTA$Outbound,
   MessageCTA$outboundSchema,
 } from "./messagecta.js";
+import {
+  MessageStatusEnum,
+  MessageStatusEnum$inboundSchema,
+  MessageStatusEnum$outboundSchema,
+} from "./messagestatusenum.js";
 import {
   SubscriberResponseDto,
   SubscriberResponseDto$inboundSchema,
@@ -33,30 +42,11 @@ import {
   WorkflowResponse$outboundSchema,
 } from "./workflowresponse.js";
 
+/**
+ * Content of the message, can be an email block or a string
+ */
 export type Content = EmailBlock | string;
 
-export const MessageResponseDtoChannel = {
-  InApp: "in_app",
-  Email: "email",
-  Sms: "sms",
-  Chat: "chat",
-  Push: "push",
-} as const;
-export type MessageResponseDtoChannel = ClosedEnum<
-  typeof MessageResponseDtoChannel
->;
-
-export type FeedId = {};
-
-export const MessageResponseDtoStatus = {
-  Sent: "sent",
-  Error: "error",
-  Warning: "warning",
-} as const;
-export type MessageResponseDtoStatus = ClosedEnum<
-  typeof MessageResponseDtoStatus
->;
-
 /**
  * The payload that was used to send the notification trigger
  */
@@ -68,44 +58,134 @@ export type MessageResponseDtoPayload = {};
 export type MessageResponseDtoOverrides = {};
 
 export type MessageResponseDto = {
+  /**
+   * Unique identifier for the message
+   */
   id?: string | undefined;
+  /**
+   * Template ID associated with the message
+   */
   templateId: string;
+  /**
+   * Environment ID where the message is sent
+   */
   environmentId: string;
+  /**
+   * Message template ID
+   */
   messageTemplateId: string;
+  /**
+   * Organization ID associated with the message
+   */
   organizationId: string;
+  /**
+   * Notification ID associated with the message
+   */
   notificationId: string;
+  /**
+   * Subscriber ID associated with the message
+   */
   subscriberId: string;
+  /**
+   * Subscriber details, if available
+   */
   subscriber?: SubscriberResponseDto | undefined;
+  /**
+   * Workflow template associated with the message
+   */
   template?: WorkflowResponse | undefined;
+  /**
+   * Identifier for the message template
+   */
   templateIdentifier?: string | undefined;
+  /**
+   * Creation date of the message
+   */
   createdAt: string;
+  /**
+   * Last seen date of the message, if available
+   */
   lastSeenDate?: string | undefined;
+  /**
+   * Last read date of the message, if available
+   */
   lastReadDate?: string | undefined;
+  /**
+   * Content of the message, can be an email block or a string
+   */
   content: EmailBlock | string;
+  /**
+   * Transaction ID associated with the message
+   */
   transactionId: string;
+  /**
+   * Subject of the message, if applicable
+   */
   subject?: string | undefined;
-  channel: MessageResponseDtoChannel;
+  /**
+   * Channel type through which the message is sent
+   */
+  channel: ChannelTypeEnum;
+  /**
+   * Indicates if the message has been read
+   */
   read: boolean;
+  /**
+   * Indicates if the message has been seen
+   */
   seen: boolean;
+  /**
+   * Email address associated with the message, if applicable
+   */
   email?: string | undefined;
+  /**
+   * Phone number associated with the message, if applicable
+   */
   phone?: string | undefined;
+  /**
+   * Direct webhook URL for the message, if applicable
+   */
   directWebhookUrl?: string | undefined;
+  /**
+   * Provider ID associated with the message, if applicable
+   */
   providerId?: string | undefined;
+  /**
+   * Device tokens associated with the message, if applicable
+   */
   deviceTokens?: Array<string> | undefined;
+  /**
+   * Title of the message, if applicable
+   */
   title?: string | undefined;
+  /**
+   * Call to action associated with the message
+   */
   cta: MessageCTA;
-  feedId?: FeedId | null | undefined;
-  status: MessageResponseDtoStatus;
-  errorId: string;
-  errorText: string;
+  /**
+   * Feed ID associated with the message, if applicable
+   */
+  feedId?: string | null | undefined;
+  /**
+   * Status of the message
+   */
+  status: MessageStatusEnum;
+  /**
+   * Error ID if the message has an error
+   */
+  errorId?: string | undefined;
+  /**
+   * Error text if the message has an error
+   */
+  errorText?: string | undefined;
   /**
    * The payload that was used to send the notification trigger
    */
-  payload: MessageResponseDtoPayload;
+  payload?: MessageResponseDtoPayload | undefined;
   /**
    * Provider specific overrides used when triggering the notification
    */
-  overrides: MessageResponseDtoOverrides;
+  overrides?: MessageResponseDtoOverrides | undefined;
 };
 
 /** @internal */
@@ -149,89 +229,6 @@ export function contentFromJSON(
   );
 }
 
-/** @internal */
-export const MessageResponseDtoChannel$inboundSchema: z.ZodNativeEnum<
-  typeof MessageResponseDtoChannel
-> = z.nativeEnum(MessageResponseDtoChannel);
-
-/** @internal */
-export const MessageResponseDtoChannel$outboundSchema: z.ZodNativeEnum<
-  typeof MessageResponseDtoChannel
-> = MessageResponseDtoChannel$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MessageResponseDtoChannel$ {
-  /** @deprecated use `MessageResponseDtoChannel$inboundSchema` instead. */
-  export const inboundSchema = MessageResponseDtoChannel$inboundSchema;
-  /** @deprecated use `MessageResponseDtoChannel$outboundSchema` instead. */
-  export const outboundSchema = MessageResponseDtoChannel$outboundSchema;
-}
-
-/** @internal */
-export const FeedId$inboundSchema: z.ZodType<FeedId, z.ZodTypeDef, unknown> = z
-  .object({});
-
-/** @internal */
-export type FeedId$Outbound = {};
-
-/** @internal */
-export const FeedId$outboundSchema: z.ZodType<
-  FeedId$Outbound,
-  z.ZodTypeDef,
-  FeedId
-> = 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 FeedId$ {
-  /** @deprecated use `FeedId$inboundSchema` instead. */
-  export const inboundSchema = FeedId$inboundSchema;
-  /** @deprecated use `FeedId$outboundSchema` instead. */
-  export const outboundSchema = FeedId$outboundSchema;
-  /** @deprecated use `FeedId$Outbound` instead. */
-  export type Outbound = FeedId$Outbound;
-}
-
-export function feedIdToJSON(feedId: FeedId): string {
-  return JSON.stringify(FeedId$outboundSchema.parse(feedId));
-}
-
-export function feedIdFromJSON(
-  jsonString: string,
-): SafeParseResult<FeedId, SDKValidationError> {
-  return safeParse(
-    jsonString,
-    (x) => FeedId$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'FeedId' from JSON`,
-  );
-}
-
-/** @internal */
-export const MessageResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
-  typeof MessageResponseDtoStatus
-> = z.nativeEnum(MessageResponseDtoStatus);
-
-/** @internal */
-export const MessageResponseDtoStatus$outboundSchema: z.ZodNativeEnum<
-  typeof MessageResponseDtoStatus
-> = MessageResponseDtoStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MessageResponseDtoStatus$ {
-  /** @deprecated use `MessageResponseDtoStatus$inboundSchema` instead. */
-  export const inboundSchema = MessageResponseDtoStatus$inboundSchema;
-  /** @deprecated use `MessageResponseDtoStatus$outboundSchema` instead. */
-  export const outboundSchema = MessageResponseDtoStatus$outboundSchema;
-}
-
 /** @internal */
 export const MessageResponseDtoPayload$inboundSchema: z.ZodType<
   MessageResponseDtoPayload,
@@ -352,7 +349,7 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
   content: z.union([EmailBlock$inboundSchema, z.string()]),
   transactionId: z.string(),
   subject: z.string().optional(),
-  channel: MessageResponseDtoChannel$inboundSchema,
+  channel: ChannelTypeEnum$inboundSchema,
   read: z.boolean(),
   seen: z.boolean(),
   email: z.string().optional(),
@@ -362,12 +359,12 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
   deviceTokens: z.array(z.string()).optional(),
   title: z.string().optional(),
   cta: MessageCTA$inboundSchema,
-  _feedId: z.nullable(z.lazy(() => FeedId$inboundSchema)).optional(),
-  status: MessageResponseDtoStatus$inboundSchema,
-  errorId: z.string(),
-  errorText: z.string(),
-  payload: z.lazy(() => MessageResponseDtoPayload$inboundSchema),
-  overrides: z.lazy(() => MessageResponseDtoOverrides$inboundSchema),
+  _feedId: z.nullable(z.string()).optional(),
+  status: MessageStatusEnum$inboundSchema,
+  errorId: z.string().optional(),
+  errorText: z.string().optional(),
+  payload: z.lazy(() => MessageResponseDtoPayload$inboundSchema).optional(),
+  overrides: z.lazy(() => MessageResponseDtoOverrides$inboundSchema).optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -409,12 +406,12 @@ export type MessageResponseDto$Outbound = {
   deviceTokens?: Array<string> | undefined;
   title?: string | undefined;
   cta: MessageCTA$Outbound;
-  _feedId?: FeedId$Outbound | null | undefined;
+  _feedId?: string | null | undefined;
   status: string;
-  errorId: string;
-  errorText: string;
-  payload: MessageResponseDtoPayload$Outbound;
-  overrides: MessageResponseDtoOverrides$Outbound;
+  errorId?: string | undefined;
+  errorText?: string | undefined;
+  payload?: MessageResponseDtoPayload$Outbound | undefined;
+  overrides?: MessageResponseDtoOverrides$Outbound | undefined;
 };
 
 /** @internal */
@@ -439,7 +436,7 @@ export const MessageResponseDto$outboundSchema: z.ZodType<
   content: z.union([EmailBlock$outboundSchema, z.string()]),
   transactionId: z.string(),
   subject: z.string().optional(),
-  channel: MessageResponseDtoChannel$outboundSchema,
+  channel: ChannelTypeEnum$outboundSchema,
   read: z.boolean(),
   seen: z.boolean(),
   email: z.string().optional(),
@@ -449,12 +446,13 @@ export const MessageResponseDto$outboundSchema: z.ZodType<
   deviceTokens: z.array(z.string()).optional(),
   title: z.string().optional(),
   cta: MessageCTA$outboundSchema,
-  feedId: z.nullable(z.lazy(() => FeedId$outboundSchema)).optional(),
-  status: MessageResponseDtoStatus$outboundSchema,
-  errorId: z.string(),
-  errorText: z.string(),
-  payload: z.lazy(() => MessageResponseDtoPayload$outboundSchema),
-  overrides: z.lazy(() => MessageResponseDtoOverrides$outboundSchema),
+  feedId: z.nullable(z.string()).optional(),
+  status: MessageStatusEnum$outboundSchema,
+  errorId: z.string().optional(),
+  errorText: z.string().optional(),
+  payload: z.lazy(() => MessageResponseDtoPayload$outboundSchema).optional(),
+  overrides: z.lazy(() => MessageResponseDtoOverrides$outboundSchema)
+    .optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/messagestatusenum.ts

@@ -0,0 +1,40 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Status of the message
+ */
+export const MessageStatusEnum = {
+  Sent: "sent",
+  Error: "error",
+  Warning: "warning",
+} as const;
+/**
+ * Status of the message
+ */
+export type MessageStatusEnum = ClosedEnum<typeof MessageStatusEnum>;
+
+/** @internal */
+export const MessageStatusEnum$inboundSchema: z.ZodNativeEnum<
+  typeof MessageStatusEnum
+> = z.nativeEnum(MessageStatusEnum);
+
+/** @internal */
+export const MessageStatusEnum$outboundSchema: z.ZodNativeEnum<
+  typeof MessageStatusEnum
+> = MessageStatusEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessageStatusEnum$ {
+  /** @deprecated use `MessageStatusEnum$inboundSchema` instead. */
+  export const inboundSchema = MessageStatusEnum$inboundSchema;
+  /** @deprecated use `MessageStatusEnum$outboundSchema` instead. */
+  export const outboundSchema = MessageStatusEnum$outboundSchema;
+}

package/src/models/components/messagetemplatedto.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 MessageTemplateDto = {};
+
+/** @internal */
+export const MessageTemplateDto$inboundSchema: z.ZodType<
+  MessageTemplateDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type MessageTemplateDto$Outbound = {};
+
+/** @internal */
+export const MessageTemplateDto$outboundSchema: z.ZodType<
+  MessageTemplateDto$Outbound,
+  z.ZodTypeDef,
+  MessageTemplateDto
+> = 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 MessageTemplateDto$ {
+  /** @deprecated use `MessageTemplateDto$inboundSchema` instead. */
+  export const inboundSchema = MessageTemplateDto$inboundSchema;
+  /** @deprecated use `MessageTemplateDto$outboundSchema` instead. */
+  export const outboundSchema = MessageTemplateDto$outboundSchema;
+  /** @deprecated use `MessageTemplateDto$Outbound` instead. */
+  export type Outbound = MessageTemplateDto$Outbound;
+}
+
+export function messageTemplateDtoToJSON(
+  messageTemplateDto: MessageTemplateDto,
+): string {
+  return JSON.stringify(
+    MessageTemplateDto$outboundSchema.parse(messageTemplateDto),
+  );
+}
+
+export function messageTemplateDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageTemplateDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageTemplateDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageTemplateDto' from JSON`,
+  );
+}

package/src/models/components/monthlytypeenum.ts

@@ -0,0 +1,39 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * Type of monthly schedule
+ */
+export const MonthlyTypeEnum = {
+  Each: "each",
+  On: "on",
+} as const;
+/**
+ * Type of monthly schedule
+ */
+export type MonthlyTypeEnum = ClosedEnum<typeof MonthlyTypeEnum>;
+
+/** @internal */
+export const MonthlyTypeEnum$inboundSchema: z.ZodNativeEnum<
+  typeof MonthlyTypeEnum
+> = z.nativeEnum(MonthlyTypeEnum);
+
+/** @internal */
+export const MonthlyTypeEnum$outboundSchema: z.ZodNativeEnum<
+  typeof MonthlyTypeEnum
+> = MonthlyTypeEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MonthlyTypeEnum$ {
+  /** @deprecated use `MonthlyTypeEnum$inboundSchema` instead. */
+  export const inboundSchema = MonthlyTypeEnum$inboundSchema;
+  /** @deprecated use `MonthlyTypeEnum$outboundSchema` instead. */
+  export const outboundSchema = MonthlyTypeEnum$outboundSchema;
+}

package/src/models/components/notificationfeeditemdto.ts

@@ -121,7 +121,7 @@ export type NotificationFeedItemDto = {
    */
   subject?: string | null | undefined;
   /**
-   * The channel through which the notification is sent.
+   * Channel type through which the message is sent
    */
   channel: ChannelTypeEnum;
   /**