@novu/api 0.0.1-alpha.142 → 0.0.1-alpha.145

package/src/models/components/messageaction.ts

@@ -4,7 +4,6 @@
 
 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 {
@@ -13,6 +12,11 @@ import {
   MessageActionResult$Outbound,
   MessageActionResult$outboundSchema,
 } from "./messageactionresult.js";
+import {
+  MessageActionStatusEnum,
+  MessageActionStatusEnum$inboundSchema,
+  MessageActionStatusEnum$outboundSchema,
+} from "./messageactionstatusenum.js";
 import {
   MessageButton,
   MessageButton$inboundSchema,
@@ -20,46 +24,28 @@ import {
   MessageButton$outboundSchema,
 } from "./messagebutton.js";
 
-export const MessageActionStatus = {
-  Pending: "pending",
-  Done: "done",
-} as const;
-export type MessageActionStatus = ClosedEnum<typeof MessageActionStatus>;
-
 export type MessageAction = {
-  status?: MessageActionStatus | undefined;
+  /**
+   * Status of the message action
+   */
+  status?: MessageActionStatusEnum | undefined;
+  /**
+   * List of buttons associated with the message action
+   */
   buttons?: Array<MessageButton> | undefined;
+  /**
+   * Result of the message action
+   */
   result?: MessageActionResult | undefined;
 };
 
-/** @internal */
-export const MessageActionStatus$inboundSchema: z.ZodNativeEnum<
-  typeof MessageActionStatus
-> = z.nativeEnum(MessageActionStatus);
-
-/** @internal */
-export const MessageActionStatus$outboundSchema: z.ZodNativeEnum<
-  typeof MessageActionStatus
-> = MessageActionStatus$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MessageActionStatus$ {
-  /** @deprecated use `MessageActionStatus$inboundSchema` instead. */
-  export const inboundSchema = MessageActionStatus$inboundSchema;
-  /** @deprecated use `MessageActionStatus$outboundSchema` instead. */
-  export const outboundSchema = MessageActionStatus$outboundSchema;
-}
-
 /** @internal */
 export const MessageAction$inboundSchema: z.ZodType<
   MessageAction,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  status: MessageActionStatus$inboundSchema.optional(),
+  status: MessageActionStatusEnum$inboundSchema.optional(),
   buttons: z.array(MessageButton$inboundSchema).optional(),
   result: MessageActionResult$inboundSchema.optional(),
 });
@@ -77,7 +63,7 @@ export const MessageAction$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageAction
 > = z.object({
-  status: MessageActionStatus$outboundSchema.optional(),
+  status: MessageActionStatusEnum$outboundSchema.optional(),
   buttons: z.array(MessageButton$outboundSchema).optional(),
   result: MessageActionResult$outboundSchema.optional(),
 });

package/src/models/components/messageactionresult.ts

@@ -4,23 +4,28 @@
 
 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 {
+  ButtonTypeEnum,
+  ButtonTypeEnum$inboundSchema,
+  ButtonTypeEnum$outboundSchema,
+} from "./buttontypeenum.js";
 
+/**
+ * Payload of the action result
+ */
 export type MessageActionResultPayload = {};
 
-export const MessageActionResultType = {
-  Primary: "primary",
-  Secondary: "secondary",
-} as const;
-export type MessageActionResultType = ClosedEnum<
-  typeof MessageActionResultType
->;
-
 export type MessageActionResult = {
+  /**
+   * Payload of the action result
+   */
   payload?: MessageActionResultPayload | undefined;
-  type?: MessageActionResultType | undefined;
+  /**
+   * Type of button for the action result
+   */
+  type?: ButtonTypeEnum | undefined;
 };
 
 /** @internal */
@@ -71,27 +76,6 @@ export function messageActionResultPayloadFromJSON(
   );
 }
 
-/** @internal */
-export const MessageActionResultType$inboundSchema: z.ZodNativeEnum<
-  typeof MessageActionResultType
-> = z.nativeEnum(MessageActionResultType);
-
-/** @internal */
-export const MessageActionResultType$outboundSchema: z.ZodNativeEnum<
-  typeof MessageActionResultType
-> = MessageActionResultType$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MessageActionResultType$ {
-  /** @deprecated use `MessageActionResultType$inboundSchema` instead. */
-  export const inboundSchema = MessageActionResultType$inboundSchema;
-  /** @deprecated use `MessageActionResultType$outboundSchema` instead. */
-  export const outboundSchema = MessageActionResultType$outboundSchema;
-}
-
 /** @internal */
 export const MessageActionResult$inboundSchema: z.ZodType<
   MessageActionResult,
@@ -99,7 +83,7 @@ export const MessageActionResult$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   payload: z.lazy(() => MessageActionResultPayload$inboundSchema).optional(),
-  type: MessageActionResultType$inboundSchema.optional(),
+  type: ButtonTypeEnum$inboundSchema.optional(),
 });
 
 /** @internal */
@@ -115,7 +99,7 @@ export const MessageActionResult$outboundSchema: z.ZodType<
   MessageActionResult
 > = z.object({
   payload: z.lazy(() => MessageActionResultPayload$outboundSchema).optional(),
-  type: MessageActionResultType$outboundSchema.optional(),
+  type: ButtonTypeEnum$outboundSchema.optional(),
 });
 
 /**

package/src/models/components/messageactionstatusenum.ts

@@ -0,0 +1,41 @@
+/*
+ * 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 action
+ */
+export const MessageActionStatusEnum = {
+  Pending: "pending",
+  Done: "done",
+} as const;
+/**
+ * Status of the message action
+ */
+export type MessageActionStatusEnum = ClosedEnum<
+  typeof MessageActionStatusEnum
+>;
+
+/** @internal */
+export const MessageActionStatusEnum$inboundSchema: z.ZodNativeEnum<
+  typeof MessageActionStatusEnum
+> = z.nativeEnum(MessageActionStatusEnum);
+
+/** @internal */
+export const MessageActionStatusEnum$outboundSchema: z.ZodNativeEnum<
+  typeof MessageActionStatusEnum
+> = MessageActionStatusEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessageActionStatusEnum$ {
+  /** @deprecated use `MessageActionStatusEnum$inboundSchema` instead. */
+  export const inboundSchema = MessageActionStatusEnum$inboundSchema;
+  /** @deprecated use `MessageActionStatusEnum$outboundSchema` instead. */
+  export const outboundSchema = MessageActionStatusEnum$outboundSchema;
+}

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;
 };