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

package/src/models/components/environmentresponsedto.ts

@@ -4,14 +4,18 @@
 
 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 EnvironmentResponseDto = {
   id?: string | undefined;
+  name: string;
   organizationId: string;
-  parentId: string;
-  apiKeys?: Array<string> | undefined;
   identifier: string;
-  name: string;
+  apiKeys?: Array<string> | undefined;
+  parentId: string;
+  slug?: string | undefined;
 };
 
 /** @internal */
@@ -21,11 +25,12 @@ export const EnvironmentResponseDto$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   _id: z.string().optional(),
+  name: z.string(),
   _organizationId: z.string(),
-  _parentId: z.string(),
-  apiKeys: z.array(z.string()).optional(),
   identifier: z.string(),
-  name: z.string(),
+  apiKeys: z.array(z.string()).optional(),
+  _parentId: z.string(),
+  slug: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -37,11 +42,12 @@ export const EnvironmentResponseDto$inboundSchema: z.ZodType<
 /** @internal */
 export type EnvironmentResponseDto$Outbound = {
   _id?: string | undefined;
+  name: string;
   _organizationId: string;
-  _parentId: string;
-  apiKeys?: Array<string> | undefined;
   identifier: string;
-  name: string;
+  apiKeys?: Array<string> | undefined;
+  _parentId: string;
+  slug?: string | undefined;
 };
 
 /** @internal */
@@ -51,11 +57,12 @@ export const EnvironmentResponseDto$outboundSchema: z.ZodType<
   EnvironmentResponseDto
 > = z.object({
   id: z.string().optional(),
+  name: z.string(),
   organizationId: z.string(),
-  parentId: z.string(),
-  apiKeys: z.array(z.string()).optional(),
   identifier: z.string(),
-  name: z.string(),
+  apiKeys: z.array(z.string()).optional(),
+  parentId: z.string(),
+  slug: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",
@@ -76,3 +83,21 @@ export namespace EnvironmentResponseDto$ {
   /** @deprecated use `EnvironmentResponseDto$Outbound` instead. */
   export type Outbound = EnvironmentResponseDto$Outbound;
 }
+
+export function environmentResponseDtoToJSON(
+  environmentResponseDto: EnvironmentResponseDto,
+): string {
+  return JSON.stringify(
+    EnvironmentResponseDto$outboundSchema.parse(environmentResponseDto),
+  );
+}
+
+export function environmentResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<EnvironmentResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => EnvironmentResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'EnvironmentResponseDto' from JSON`,
+  );
+}

package/src/models/components/executiondetailsresponsedto.ts

@@ -4,9 +4,12 @@
 
 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";
 
-export const ExecutionDetailsResponseDtoChannel = {
+export const Channel = {
   InApp: "in_app",
   Email: "email",
   Sms: "sms",
@@ -17,9 +20,7 @@ export const ExecutionDetailsResponseDtoChannel = {
   Delay: "delay",
   Custom: "custom",
 } as const;
-export type ExecutionDetailsResponseDtoChannel = ClosedEnum<
-  typeof ExecutionDetailsResponseDtoChannel
->;
+export type Channel = ClosedEnum<typeof Channel>;
 
 export const Source = {
   Credentials: "Credentials",
@@ -29,7 +30,7 @@ export const Source = {
 } as const;
 export type Source = ClosedEnum<typeof Source>;
 
-export const ExecutionDetailsResponseDtoStatus = {
+export const Status = {
   Success: "Success",
   Warning: "Warning",
   Failed: "Failed",
@@ -37,50 +38,45 @@ export const ExecutionDetailsResponseDtoStatus = {
   Queued: "Queued",
   ReadConfirmation: "ReadConfirmation",
 } as const;
-export type ExecutionDetailsResponseDtoStatus = ClosedEnum<
-  typeof ExecutionDetailsResponseDtoStatus
->;
+export type Status = ClosedEnum<typeof Status>;
 
 export type ExecutionDetailsResponseDto = {
-  environmentId: string;
   id?: string | undefined;
+  organizationId: string;
   jobId: string;
-  messageId?: string | undefined;
+  environmentId: string;
   notificationId: string;
   notificationTemplateId: string;
-  organizationId: string;
   subscriberId: string;
-  channel: ExecutionDetailsResponseDtoChannel;
-  createdAt?: string | undefined;
-  detail: string;
-  isRetry: boolean;
-  isTest: boolean;
+  messageId?: string | undefined;
   providerId?: string | undefined;
-  source: Source;
-  status: ExecutionDetailsResponseDtoStatus;
   transactionId: string;
+  channel: Channel;
+  detail: string;
+  source: Source;
+  status: Status;
+  isTest: boolean;
+  isRetry: boolean;
+  createdAt?: string | undefined;
 };
 
 /** @internal */
-export const ExecutionDetailsResponseDtoChannel$inboundSchema: z.ZodNativeEnum<
-  typeof ExecutionDetailsResponseDtoChannel
-> = z.nativeEnum(ExecutionDetailsResponseDtoChannel);
+export const Channel$inboundSchema: z.ZodNativeEnum<typeof Channel> = z
+  .nativeEnum(Channel);
 
 /** @internal */
-export const ExecutionDetailsResponseDtoChannel$outboundSchema: z.ZodNativeEnum<
-  typeof ExecutionDetailsResponseDtoChannel
-> = ExecutionDetailsResponseDtoChannel$inboundSchema;
+export const Channel$outboundSchema: z.ZodNativeEnum<typeof Channel> =
+  Channel$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace ExecutionDetailsResponseDtoChannel$ {
-  /** @deprecated use `ExecutionDetailsResponseDtoChannel$inboundSchema` instead. */
-  export const inboundSchema = ExecutionDetailsResponseDtoChannel$inboundSchema;
-  /** @deprecated use `ExecutionDetailsResponseDtoChannel$outboundSchema` instead. */
-  export const outboundSchema =
-    ExecutionDetailsResponseDtoChannel$outboundSchema;
+export namespace Channel$ {
+  /** @deprecated use `Channel$inboundSchema` instead. */
+  export const inboundSchema = Channel$inboundSchema;
+  /** @deprecated use `Channel$outboundSchema` instead. */
+  export const outboundSchema = Channel$outboundSchema;
 }
 
 /** @internal */
@@ -103,25 +99,22 @@ export namespace Source$ {
 }
 
 /** @internal */
-export const ExecutionDetailsResponseDtoStatus$inboundSchema: z.ZodNativeEnum<
-  typeof ExecutionDetailsResponseDtoStatus
-> = z.nativeEnum(ExecutionDetailsResponseDtoStatus);
+export const Status$inboundSchema: z.ZodNativeEnum<typeof Status> = z
+  .nativeEnum(Status);
 
 /** @internal */
-export const ExecutionDetailsResponseDtoStatus$outboundSchema: z.ZodNativeEnum<
-  typeof ExecutionDetailsResponseDtoStatus
-> = ExecutionDetailsResponseDtoStatus$inboundSchema;
+export const Status$outboundSchema: z.ZodNativeEnum<typeof Status> =
+  Status$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace ExecutionDetailsResponseDtoStatus$ {
-  /** @deprecated use `ExecutionDetailsResponseDtoStatus$inboundSchema` instead. */
-  export const inboundSchema = ExecutionDetailsResponseDtoStatus$inboundSchema;
-  /** @deprecated use `ExecutionDetailsResponseDtoStatus$outboundSchema` instead. */
-  export const outboundSchema =
-    ExecutionDetailsResponseDtoStatus$outboundSchema;
+export namespace Status$ {
+  /** @deprecated use `Status$inboundSchema` instead. */
+  export const inboundSchema = Status$inboundSchema;
+  /** @deprecated use `Status$outboundSchema` instead. */
+  export const outboundSchema = Status$outboundSchema;
 }
 
 /** @internal */
@@ -130,55 +123,55 @@ export const ExecutionDetailsResponseDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  _environmentId: z.string(),
   _id: z.string().optional(),
+  _organizationId: z.string(),
   _jobId: z.string(),
-  _messageId: z.string().optional(),
+  _environmentId: z.string(),
   _notificationId: z.string(),
   _notificationTemplateId: z.string(),
-  _organizationId: z.string(),
   _subscriberId: z.string(),
-  channel: ExecutionDetailsResponseDtoChannel$inboundSchema,
-  createdAt: z.string().optional(),
-  detail: z.string(),
-  isRetry: z.boolean(),
-  isTest: z.boolean(),
+  _messageId: z.string().optional(),
   providerId: z.string().optional(),
-  source: Source$inboundSchema,
-  status: ExecutionDetailsResponseDtoStatus$inboundSchema,
   transactionId: z.string(),
+  channel: Channel$inboundSchema,
+  detail: z.string(),
+  source: Source$inboundSchema,
+  status: Status$inboundSchema,
+  isTest: z.boolean(),
+  isRetry: z.boolean(),
+  createdAt: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    "_environmentId": "environmentId",
     "_id": "id",
+    "_organizationId": "organizationId",
     "_jobId": "jobId",
-    "_messageId": "messageId",
+    "_environmentId": "environmentId",
     "_notificationId": "notificationId",
     "_notificationTemplateId": "notificationTemplateId",
-    "_organizationId": "organizationId",
     "_subscriberId": "subscriberId",
+    "_messageId": "messageId",
   });
 });
 
 /** @internal */
 export type ExecutionDetailsResponseDto$Outbound = {
-  _environmentId: string;
   _id?: string | undefined;
+  _organizationId: string;
   _jobId: string;
-  _messageId?: string | undefined;
+  _environmentId: string;
   _notificationId: string;
   _notificationTemplateId: string;
-  _organizationId: string;
   _subscriberId: string;
+  _messageId?: string | undefined;
+  providerId?: string | undefined;
+  transactionId: string;
   channel: string;
-  createdAt?: string | undefined;
   detail: string;
-  isRetry: boolean;
-  isTest: boolean;
-  providerId?: string | undefined;
   source: string;
   status: string;
-  transactionId: string;
+  isTest: boolean;
+  isRetry: boolean;
+  createdAt?: string | undefined;
 };
 
 /** @internal */
@@ -187,33 +180,33 @@ export const ExecutionDetailsResponseDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ExecutionDetailsResponseDto
 > = z.object({
-  environmentId: z.string(),
   id: z.string().optional(),
+  organizationId: z.string(),
   jobId: z.string(),
-  messageId: z.string().optional(),
+  environmentId: z.string(),
   notificationId: z.string(),
   notificationTemplateId: z.string(),
-  organizationId: z.string(),
   subscriberId: z.string(),
-  channel: ExecutionDetailsResponseDtoChannel$outboundSchema,
-  createdAt: z.string().optional(),
-  detail: z.string(),
-  isRetry: z.boolean(),
-  isTest: z.boolean(),
+  messageId: z.string().optional(),
   providerId: z.string().optional(),
-  source: Source$outboundSchema,
-  status: ExecutionDetailsResponseDtoStatus$outboundSchema,
   transactionId: z.string(),
+  channel: Channel$outboundSchema,
+  detail: z.string(),
+  source: Source$outboundSchema,
+  status: Status$outboundSchema,
+  isTest: z.boolean(),
+  isRetry: z.boolean(),
+  createdAt: z.string().optional(),
 }).transform((v) => {
   return remap$(v, {
-    environmentId: "_environmentId",
     id: "_id",
+    organizationId: "_organizationId",
     jobId: "_jobId",
-    messageId: "_messageId",
+    environmentId: "_environmentId",
     notificationId: "_notificationId",
     notificationTemplateId: "_notificationTemplateId",
-    organizationId: "_organizationId",
     subscriberId: "_subscriberId",
+    messageId: "_messageId",
   });
 });
 
@@ -229,3 +222,23 @@ export namespace ExecutionDetailsResponseDto$ {
   /** @deprecated use `ExecutionDetailsResponseDto$Outbound` instead. */
   export type Outbound = ExecutionDetailsResponseDto$Outbound;
 }
+
+export function executionDetailsResponseDtoToJSON(
+  executionDetailsResponseDto: ExecutionDetailsResponseDto,
+): string {
+  return JSON.stringify(
+    ExecutionDetailsResponseDto$outboundSchema.parse(
+      executionDetailsResponseDto,
+    ),
+  );
+}
+
+export function executionDetailsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ExecutionDetailsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ExecutionDetailsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ExecutionDetailsResponseDto' from JSON`,
+  );
+}

package/src/models/components/feedresponsedto.ts

@@ -3,13 +3,16 @@
  */
 
 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 FeedResponseDto = {
-  data: Array<string>;
+  totalCount?: number | undefined;
   hasMore: boolean;
-  page: number;
+  data: Array<string>;
   pageSize: number;
-  totalCount?: number | undefined;
+  page: number;
 };
 
 /** @internal */
@@ -18,20 +21,20 @@ export const FeedResponseDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  data: z.array(z.string()),
+  totalCount: z.number().optional(),
   hasMore: z.boolean(),
-  page: z.number(),
+  data: z.array(z.string()),
   pageSize: z.number(),
-  totalCount: z.number().optional(),
+  page: z.number(),
 });
 
 /** @internal */
 export type FeedResponseDto$Outbound = {
-  data: Array<string>;
+  totalCount?: number | undefined;
   hasMore: boolean;
-  page: number;
+  data: Array<string>;
   pageSize: number;
-  totalCount?: number | undefined;
+  page: number;
 };
 
 /** @internal */
@@ -40,11 +43,11 @@ export const FeedResponseDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   FeedResponseDto
 > = z.object({
-  data: z.array(z.string()),
+  totalCount: z.number().optional(),
   hasMore: z.boolean(),
-  page: z.number(),
+  data: z.array(z.string()),
   pageSize: z.number(),
-  totalCount: z.number().optional(),
+  page: z.number(),
 });
 
 /**
@@ -59,3 +62,19 @@ export namespace FeedResponseDto$ {
   /** @deprecated use `FeedResponseDto$Outbound` instead. */
   export type Outbound = FeedResponseDto$Outbound;
 }
+
+export function feedResponseDtoToJSON(
+  feedResponseDto: FeedResponseDto,
+): string {
+  return JSON.stringify(FeedResponseDto$outboundSchema.parse(feedResponseDto));
+}
+
+export function feedResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<FeedResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FeedResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FeedResponseDto' from JSON`,
+  );
+}

package/src/models/components/fieldfilterpart.ts

@@ -3,13 +3,10 @@
  */
 
 import * as z from "zod";
+import { safeParse } from "../../lib/schemas.js";
 import { ClosedEnum } from "../../types/enums.js";
-
-export const On = {
-  Subscriber: "subscriber",
-  Payload: "payload",
-} as const;
-export type On = ClosedEnum<typeof On>;
+import { Result as SafeParseResult } from "../../types/fp.js";
+import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export const Operator = {
   Larger: "LARGER",
@@ -29,47 +26,53 @@ export const Operator = {
 } as const;
 export type Operator = ClosedEnum<typeof Operator>;
 
+export const On = {
+  Subscriber: "subscriber",
+  Payload: "payload",
+} as const;
+export type On = ClosedEnum<typeof On>;
+
 export type FieldFilterPart = {
   field: string;
-  on: On;
-  operator: Operator;
   value: string;
+  operator: Operator;
+  on: On;
 };
 
 /** @internal */
-export const On$inboundSchema: z.ZodNativeEnum<typeof On> = z.nativeEnum(On);
+export const Operator$inboundSchema: z.ZodNativeEnum<typeof Operator> = z
+  .nativeEnum(Operator);
 
 /** @internal */
-export const On$outboundSchema: z.ZodNativeEnum<typeof On> = On$inboundSchema;
+export const Operator$outboundSchema: z.ZodNativeEnum<typeof Operator> =
+  Operator$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace On$ {
-  /** @deprecated use `On$inboundSchema` instead. */
-  export const inboundSchema = On$inboundSchema;
-  /** @deprecated use `On$outboundSchema` instead. */
-  export const outboundSchema = On$outboundSchema;
+export namespace Operator$ {
+  /** @deprecated use `Operator$inboundSchema` instead. */
+  export const inboundSchema = Operator$inboundSchema;
+  /** @deprecated use `Operator$outboundSchema` instead. */
+  export const outboundSchema = Operator$outboundSchema;
 }
 
 /** @internal */
-export const Operator$inboundSchema: z.ZodNativeEnum<typeof Operator> = z
-  .nativeEnum(Operator);
+export const On$inboundSchema: z.ZodNativeEnum<typeof On> = z.nativeEnum(On);
 
 /** @internal */
-export const Operator$outboundSchema: z.ZodNativeEnum<typeof Operator> =
-  Operator$inboundSchema;
+export const On$outboundSchema: z.ZodNativeEnum<typeof On> = On$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Operator$ {
-  /** @deprecated use `Operator$inboundSchema` instead. */
-  export const inboundSchema = Operator$inboundSchema;
-  /** @deprecated use `Operator$outboundSchema` instead. */
-  export const outboundSchema = Operator$outboundSchema;
+export namespace On$ {
+  /** @deprecated use `On$inboundSchema` instead. */
+  export const inboundSchema = On$inboundSchema;
+  /** @deprecated use `On$outboundSchema` instead. */
+  export const outboundSchema = On$outboundSchema;
 }
 
 /** @internal */
@@ -79,17 +82,17 @@ export const FieldFilterPart$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   field: z.string(),
-  on: On$inboundSchema,
-  operator: Operator$inboundSchema,
   value: z.string(),
+  operator: Operator$inboundSchema,
+  on: On$inboundSchema,
 });
 
 /** @internal */
 export type FieldFilterPart$Outbound = {
   field: string;
-  on: string;
-  operator: string;
   value: string;
+  operator: string;
+  on: string;
 };
 
 /** @internal */
@@ -99,9 +102,9 @@ export const FieldFilterPart$outboundSchema: z.ZodType<
   FieldFilterPart
 > = z.object({
   field: z.string(),
-  on: On$outboundSchema,
-  operator: Operator$outboundSchema,
   value: z.string(),
+  operator: Operator$outboundSchema,
+  on: On$outboundSchema,
 });
 
 /**
@@ -116,3 +119,19 @@ export namespace FieldFilterPart$ {
   /** @deprecated use `FieldFilterPart$Outbound` instead. */
   export type Outbound = FieldFilterPart$Outbound;
 }
+
+export function fieldFilterPartToJSON(
+  fieldFilterPart: FieldFilterPart,
+): string {
+  return JSON.stringify(FieldFilterPart$outboundSchema.parse(fieldFilterPart));
+}
+
+export function fieldFilterPartFromJSON(
+  jsonString: string,
+): SafeParseResult<FieldFilterPart, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FieldFilterPart$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FieldFilterPart' from JSON`,
+  );
+}

package/src/models/components/filtertopicsresponsedto.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";
 import {
   TopicDto,
   TopicDto$inboundSchema,
@@ -61,3 +64,21 @@ export namespace FilterTopicsResponseDto$ {
   /** @deprecated use `FilterTopicsResponseDto$Outbound` instead. */
   export type Outbound = FilterTopicsResponseDto$Outbound;
 }
+
+export function filterTopicsResponseDtoToJSON(
+  filterTopicsResponseDto: FilterTopicsResponseDto,
+): string {
+  return JSON.stringify(
+    FilterTopicsResponseDto$outboundSchema.parse(filterTopicsResponseDto),
+  );
+}
+
+export function filterTopicsResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<FilterTopicsResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => FilterTopicsResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'FilterTopicsResponseDto' from JSON`,
+  );
+}