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

package/src/models/components/messageactionresult.ts

@@ -3,9 +3,12 @@
  */
 
 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 type MessageActionResultPayload = {};
+export type Payload = {};
 
 export const MessageActionResultType = {
   Primary: "primary",
@@ -16,38 +19,49 @@ export type MessageActionResultType = ClosedEnum<
 >;
 
 export type MessageActionResult = {
-  payload?: MessageActionResultPayload | undefined;
+  payload?: Payload | undefined;
   type?: MessageActionResultType | undefined;
 };
 
 /** @internal */
-export const MessageActionResultPayload$inboundSchema: z.ZodType<
-  MessageActionResultPayload,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
+export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
+  z.object({});
 
 /** @internal */
-export type MessageActionResultPayload$Outbound = {};
+export type Payload$Outbound = {};
 
 /** @internal */
-export const MessageActionResultPayload$outboundSchema: z.ZodType<
-  MessageActionResultPayload$Outbound,
+export const Payload$outboundSchema: z.ZodType<
+  Payload$Outbound,
   z.ZodTypeDef,
-  MessageActionResultPayload
+  Payload
 > = 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 MessageActionResultPayload$ {
-  /** @deprecated use `MessageActionResultPayload$inboundSchema` instead. */
-  export const inboundSchema = MessageActionResultPayload$inboundSchema;
-  /** @deprecated use `MessageActionResultPayload$outboundSchema` instead. */
-  export const outboundSchema = MessageActionResultPayload$outboundSchema;
-  /** @deprecated use `MessageActionResultPayload$Outbound` instead. */
-  export type Outbound = MessageActionResultPayload$Outbound;
+export namespace Payload$ {
+  /** @deprecated use `Payload$inboundSchema` instead. */
+  export const inboundSchema = Payload$inboundSchema;
+  /** @deprecated use `Payload$outboundSchema` instead. */
+  export const outboundSchema = Payload$outboundSchema;
+  /** @deprecated use `Payload$Outbound` instead. */
+  export type Outbound = Payload$Outbound;
+}
+
+export function payloadToJSON(payload: Payload): string {
+  return JSON.stringify(Payload$outboundSchema.parse(payload));
+}
+
+export function payloadFromJSON(
+  jsonString: string,
+): SafeParseResult<Payload, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Payload' from JSON`,
+  );
 }
 
 /** @internal */
@@ -77,13 +91,13 @@ export const MessageActionResult$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  payload: z.lazy(() => MessageActionResultPayload$inboundSchema).optional(),
+  payload: z.lazy(() => Payload$inboundSchema).optional(),
   type: MessageActionResultType$inboundSchema.optional(),
 });
 
 /** @internal */
 export type MessageActionResult$Outbound = {
-  payload?: MessageActionResultPayload$Outbound | undefined;
+  payload?: Payload$Outbound | undefined;
   type?: string | undefined;
 };
 
@@ -93,7 +107,7 @@ export const MessageActionResult$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageActionResult
 > = z.object({
-  payload: z.lazy(() => MessageActionResultPayload$outboundSchema).optional(),
+  payload: z.lazy(() => Payload$outboundSchema).optional(),
   type: MessageActionResultType$outboundSchema.optional(),
 });
 
@@ -109,3 +123,21 @@ export namespace MessageActionResult$ {
   /** @deprecated use `MessageActionResult$Outbound` instead. */
   export type Outbound = MessageActionResult$Outbound;
 }
+
+export function messageActionResultToJSON(
+  messageActionResult: MessageActionResult,
+): string {
+  return JSON.stringify(
+    MessageActionResult$outboundSchema.parse(messageActionResult),
+  );
+}
+
+export function messageActionResultFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageActionResult, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageActionResult$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageActionResult' from JSON`,
+  );
+}

package/src/models/components/messagebutton.ts

@@ -3,7 +3,10 @@
  */
 
 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",
@@ -12,9 +15,9 @@ export const MessageButtonType = {
 export type MessageButtonType = ClosedEnum<typeof MessageButtonType>;
 
 export type MessageButton = {
+  type: MessageButtonType;
   content: string;
   resultContent?: string | undefined;
-  type: MessageButtonType;
 };
 
 /** @internal */
@@ -44,16 +47,16 @@ export const MessageButton$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
+  type: MessageButtonType$inboundSchema,
   content: z.string(),
   resultContent: z.string().optional(),
-  type: MessageButtonType$inboundSchema,
 });
 
 /** @internal */
 export type MessageButton$Outbound = {
+  type: string;
   content: string;
   resultContent?: string | undefined;
-  type: string;
 };
 
 /** @internal */
@@ -62,9 +65,9 @@ export const MessageButton$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageButton
 > = z.object({
+  type: MessageButtonType$outboundSchema,
   content: z.string(),
   resultContent: z.string().optional(),
-  type: MessageButtonType$outboundSchema,
 });
 
 /**
@@ -79,3 +82,17 @@ export namespace MessageButton$ {
   /** @deprecated use `MessageButton$Outbound` instead. */
   export type Outbound = MessageButton$Outbound;
 }
+
+export function messageButtonToJSON(messageButton: MessageButton): string {
+  return JSON.stringify(MessageButton$outboundSchema.parse(messageButton));
+}
+
+export function messageButtonFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageButton, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageButton$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageButton' from JSON`,
+  );
+}

package/src/models/components/messagecta.ts

@@ -3,7 +3,10 @@
  */
 
 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 {
   MessageAction,
   MessageAction$inboundSchema,
@@ -23,9 +26,9 @@ export const MessageCTAType = {
 export type MessageCTAType = ClosedEnum<typeof MessageCTAType>;
 
 export type MessageCTA = {
-  action?: MessageAction | undefined;
-  data: MessageCTAData;
   type?: MessageCTAType | undefined;
+  data: MessageCTAData;
+  action?: MessageAction | undefined;
 };
 
 /** @internal */
@@ -55,16 +58,16 @@ export const MessageCTA$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  action: MessageAction$inboundSchema.optional(),
-  data: MessageCTAData$inboundSchema,
   type: MessageCTAType$inboundSchema.optional(),
+  data: MessageCTAData$inboundSchema,
+  action: MessageAction$inboundSchema.optional(),
 });
 
 /** @internal */
 export type MessageCTA$Outbound = {
-  action?: MessageAction$Outbound | undefined;
-  data: MessageCTAData$Outbound;
   type?: string | undefined;
+  data: MessageCTAData$Outbound;
+  action?: MessageAction$Outbound | undefined;
 };
 
 /** @internal */
@@ -73,9 +76,9 @@ export const MessageCTA$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageCTA
 > = z.object({
-  action: MessageAction$outboundSchema.optional(),
-  data: MessageCTAData$outboundSchema,
   type: MessageCTAType$outboundSchema.optional(),
+  data: MessageCTAData$outboundSchema,
+  action: MessageAction$outboundSchema.optional(),
 });
 
 /**
@@ -90,3 +93,17 @@ export namespace MessageCTA$ {
   /** @deprecated use `MessageCTA$Outbound` instead. */
   export type Outbound = MessageCTA$Outbound;
 }
+
+export function messageCTAToJSON(messageCTA: MessageCTA): string {
+  return JSON.stringify(MessageCTA$outboundSchema.parse(messageCTA));
+}
+
+export function messageCTAFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageCTA, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageCTA$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageCTA' from JSON`,
+  );
+}

package/src/models/components/messagectadata.ts

@@ -3,6 +3,9 @@
  */
 
 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 MessageCTAData = {
   url?: string | undefined;
@@ -43,3 +46,17 @@ export namespace MessageCTAData$ {
   /** @deprecated use `MessageCTAData$Outbound` instead. */
   export type Outbound = MessageCTAData$Outbound;
 }
+
+export function messageCTADataToJSON(messageCTAData: MessageCTAData): string {
+  return JSON.stringify(MessageCTAData$outboundSchema.parse(messageCTAData));
+}
+
+export function messageCTADataFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageCTAData, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageCTAData$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageCTAData' from JSON`,
+  );
+}

package/src/models/components/messageentity.ts

@@ -3,6 +3,9 @@
  */
 
 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 MessageEntity = {};
 
@@ -35,3 +38,17 @@ export namespace MessageEntity$ {
   /** @deprecated use `MessageEntity$Outbound` instead. */
   export type Outbound = MessageEntity$Outbound;
 }
+
+export function messageEntityToJSON(messageEntity: MessageEntity): string {
+  return JSON.stringify(MessageEntity$outboundSchema.parse(messageEntity));
+}
+
+export function messageEntityFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageEntity, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageEntity$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageEntity' from JSON`,
+  );
+}

package/src/models/components/messagemarkasrequestdto.ts

@@ -3,46 +3,26 @@
  */
 
 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 MessageMarkAsRequestDtoMarkAs = {
+export type MessageId = string | Array<string>;
+
+export const MarkAs = {
   Read: "read",
   Seen: "seen",
   Unread: "unread",
   Unseen: "unseen",
 } as const;
-export type MessageMarkAsRequestDtoMarkAs = ClosedEnum<
-  typeof MessageMarkAsRequestDtoMarkAs
->;
-
-export type MessageId = string | Array<string>;
+export type MarkAs = ClosedEnum<typeof MarkAs>;
 
 export type MessageMarkAsRequestDto = {
-  markAs: MessageMarkAsRequestDtoMarkAs;
   messageId: string | Array<string>;
+  markAs: MarkAs;
 };
 
-/** @internal */
-export const MessageMarkAsRequestDtoMarkAs$inboundSchema: z.ZodNativeEnum<
-  typeof MessageMarkAsRequestDtoMarkAs
-> = z.nativeEnum(MessageMarkAsRequestDtoMarkAs);
-
-/** @internal */
-export const MessageMarkAsRequestDtoMarkAs$outboundSchema: z.ZodNativeEnum<
-  typeof MessageMarkAsRequestDtoMarkAs
-> = MessageMarkAsRequestDtoMarkAs$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace MessageMarkAsRequestDtoMarkAs$ {
-  /** @deprecated use `MessageMarkAsRequestDtoMarkAs$inboundSchema` instead. */
-  export const inboundSchema = MessageMarkAsRequestDtoMarkAs$inboundSchema;
-  /** @deprecated use `MessageMarkAsRequestDtoMarkAs$outboundSchema` instead. */
-  export const outboundSchema = MessageMarkAsRequestDtoMarkAs$outboundSchema;
-}
-
 /** @internal */
 export const MessageId$inboundSchema: z.ZodType<
   MessageId,
@@ -73,20 +53,53 @@ export namespace MessageId$ {
   export type Outbound = MessageId$Outbound;
 }
 
+export function messageIdToJSON(messageId: MessageId): string {
+  return JSON.stringify(MessageId$outboundSchema.parse(messageId));
+}
+
+export function messageIdFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageId, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageId$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageId' from JSON`,
+  );
+}
+
+/** @internal */
+export const MarkAs$inboundSchema: z.ZodNativeEnum<typeof MarkAs> = z
+  .nativeEnum(MarkAs);
+
+/** @internal */
+export const MarkAs$outboundSchema: z.ZodNativeEnum<typeof MarkAs> =
+  MarkAs$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MarkAs$ {
+  /** @deprecated use `MarkAs$inboundSchema` instead. */
+  export const inboundSchema = MarkAs$inboundSchema;
+  /** @deprecated use `MarkAs$outboundSchema` instead. */
+  export const outboundSchema = MarkAs$outboundSchema;
+}
+
 /** @internal */
 export const MessageMarkAsRequestDto$inboundSchema: z.ZodType<
   MessageMarkAsRequestDto,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  markAs: MessageMarkAsRequestDtoMarkAs$inboundSchema,
   messageId: z.union([z.string(), z.array(z.string())]),
+  markAs: MarkAs$inboundSchema,
 });
 
 /** @internal */
 export type MessageMarkAsRequestDto$Outbound = {
-  markAs: string;
   messageId: string | Array<string>;
+  markAs: string;
 };
 
 /** @internal */
@@ -95,8 +108,8 @@ export const MessageMarkAsRequestDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageMarkAsRequestDto
 > = z.object({
-  markAs: MessageMarkAsRequestDtoMarkAs$outboundSchema,
   messageId: z.union([z.string(), z.array(z.string())]),
+  markAs: MarkAs$outboundSchema,
 });
 
 /**
@@ -111,3 +124,21 @@ export namespace MessageMarkAsRequestDto$ {
   /** @deprecated use `MessageMarkAsRequestDto$Outbound` instead. */
   export type Outbound = MessageMarkAsRequestDto$Outbound;
 }
+
+export function messageMarkAsRequestDtoToJSON(
+  messageMarkAsRequestDto: MessageMarkAsRequestDto,
+): string {
+  return JSON.stringify(
+    MessageMarkAsRequestDto$outboundSchema.parse(messageMarkAsRequestDto),
+  );
+}
+
+export function messageMarkAsRequestDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageMarkAsRequestDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageMarkAsRequestDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageMarkAsRequestDto' from JSON`,
+  );
+}