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

package/src/models/components/credentialsdto.ts

@@ -3,52 +3,55 @@
  */
 
 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 TlsOptions = {};
 
 export type CredentialsDto = {
-  accessKey?: string | undefined;
-  accountSid?: string | undefined;
-  alertUid?: string | undefined;
   apiKey?: string | undefined;
-  apiKeyRequestHeader?: string | undefined;
-  apiToken?: string | undefined;
-  applicationId?: string | undefined;
-  authenticateByToken?: boolean | undefined;
-  authenticationTokenKey?: string | undefined;
-  baseUrl?: string | undefined;
-  channelId?: string | undefined;
-  clientId?: string | undefined;
-  datePath?: string | undefined;
+  user?: string | undefined;
+  secretKey?: string | undefined;
   domain?: string | undefined;
-  externalLink?: string | undefined;
-  from?: string | undefined;
-  hmac?: boolean | undefined;
-  host?: string | undefined;
-  idPath?: string | undefined;
-  ignoreTls?: boolean | undefined;
-  imageUrl?: string | undefined;
-  instanceId?: string | undefined;
-  ipPoolName?: string | undefined;
-  messageProfileId?: string | undefined;
   password?: string | undefined;
-  phoneNumberIdentification?: string | undefined;
+  host?: string | undefined;
   port?: string | undefined;
-  projectName?: string | undefined;
-  redirectUrl?: string | undefined;
-  region?: string | undefined;
-  requireTls?: boolean | undefined;
-  secretKey?: string | undefined;
-  secretKeyRequestHeader?: string | undefined;
   secure?: boolean | undefined;
+  region?: string | undefined;
+  accountSid?: string | undefined;
+  messageProfileId?: string | undefined;
+  token?: string | undefined;
+  from?: string | undefined;
   senderName?: string | undefined;
-  serviceAccount?: string | undefined;
-  state?: string | undefined;
-  title?: string | undefined;
+  projectName?: string | undefined;
+  applicationId?: string | undefined;
+  clientId?: string | undefined;
+  requireTls?: boolean | undefined;
+  ignoreTls?: boolean | undefined;
   tlsOptions?: TlsOptions | undefined;
-  token?: string | undefined;
-  user?: string | undefined;
+  baseUrl?: string | undefined;
   webhookUrl?: string | undefined;
+  redirectUrl?: string | undefined;
+  hmac?: boolean | undefined;
+  serviceAccount?: string | undefined;
+  ipPoolName?: string | undefined;
+  apiKeyRequestHeader?: string | undefined;
+  secretKeyRequestHeader?: string | undefined;
+  idPath?: string | undefined;
+  datePath?: string | undefined;
+  apiToken?: string | undefined;
+  authenticateByToken?: boolean | undefined;
+  authenticationTokenKey?: string | undefined;
+  instanceId?: string | undefined;
+  alertUid?: string | undefined;
+  title?: string | undefined;
+  imageUrl?: string | undefined;
+  state?: string | undefined;
+  externalLink?: string | undefined;
+  channelId?: string | undefined;
+  phoneNumberIdentification?: string | undefined;
+  accessKey?: string | undefined;
 };
 
 /** @internal */
@@ -81,100 +84,114 @@ export namespace TlsOptions$ {
   export type Outbound = TlsOptions$Outbound;
 }
 
+export function tlsOptionsToJSON(tlsOptions: TlsOptions): string {
+  return JSON.stringify(TlsOptions$outboundSchema.parse(tlsOptions));
+}
+
+export function tlsOptionsFromJSON(
+  jsonString: string,
+): SafeParseResult<TlsOptions, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => TlsOptions$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'TlsOptions' from JSON`,
+  );
+}
+
 /** @internal */
 export const CredentialsDto$inboundSchema: z.ZodType<
   CredentialsDto,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  accessKey: z.string().optional(),
-  accountSid: z.string().optional(),
-  alertUid: z.string().optional(),
   apiKey: z.string().optional(),
-  apiKeyRequestHeader: z.string().optional(),
-  apiToken: z.string().optional(),
-  applicationId: z.string().optional(),
-  authenticateByToken: z.boolean().optional(),
-  authenticationTokenKey: z.string().optional(),
-  baseUrl: z.string().optional(),
-  channelId: z.string().optional(),
-  clientId: z.string().optional(),
-  datePath: z.string().optional(),
+  user: z.string().optional(),
+  secretKey: z.string().optional(),
   domain: z.string().optional(),
-  externalLink: z.string().optional(),
-  from: z.string().optional(),
-  hmac: z.boolean().optional(),
-  host: z.string().optional(),
-  idPath: z.string().optional(),
-  ignoreTls: z.boolean().optional(),
-  imageUrl: z.string().optional(),
-  instanceId: z.string().optional(),
-  ipPoolName: z.string().optional(),
-  messageProfileId: z.string().optional(),
   password: z.string().optional(),
-  phoneNumberIdentification: z.string().optional(),
+  host: z.string().optional(),
   port: z.string().optional(),
-  projectName: z.string().optional(),
-  redirectUrl: z.string().optional(),
-  region: z.string().optional(),
-  requireTls: z.boolean().optional(),
-  secretKey: z.string().optional(),
-  secretKeyRequestHeader: z.string().optional(),
   secure: z.boolean().optional(),
+  region: z.string().optional(),
+  accountSid: z.string().optional(),
+  messageProfileId: z.string().optional(),
+  token: z.string().optional(),
+  from: z.string().optional(),
   senderName: z.string().optional(),
-  serviceAccount: z.string().optional(),
-  state: z.string().optional(),
-  title: z.string().optional(),
+  projectName: z.string().optional(),
+  applicationId: z.string().optional(),
+  clientId: z.string().optional(),
+  requireTls: z.boolean().optional(),
+  ignoreTls: z.boolean().optional(),
   tlsOptions: z.lazy(() => TlsOptions$inboundSchema).optional(),
-  token: z.string().optional(),
-  user: z.string().optional(),
+  baseUrl: z.string().optional(),
   webhookUrl: z.string().optional(),
+  redirectUrl: z.string().optional(),
+  hmac: z.boolean().optional(),
+  serviceAccount: z.string().optional(),
+  ipPoolName: z.string().optional(),
+  apiKeyRequestHeader: z.string().optional(),
+  secretKeyRequestHeader: z.string().optional(),
+  idPath: z.string().optional(),
+  datePath: z.string().optional(),
+  apiToken: z.string().optional(),
+  authenticateByToken: z.boolean().optional(),
+  authenticationTokenKey: z.string().optional(),
+  instanceId: z.string().optional(),
+  alertUid: z.string().optional(),
+  title: z.string().optional(),
+  imageUrl: z.string().optional(),
+  state: z.string().optional(),
+  externalLink: z.string().optional(),
+  channelId: z.string().optional(),
+  phoneNumberIdentification: z.string().optional(),
+  accessKey: z.string().optional(),
 });
 
 /** @internal */
 export type CredentialsDto$Outbound = {
-  accessKey?: string | undefined;
-  accountSid?: string | undefined;
-  alertUid?: string | undefined;
   apiKey?: string | undefined;
-  apiKeyRequestHeader?: string | undefined;
-  apiToken?: string | undefined;
-  applicationId?: string | undefined;
-  authenticateByToken?: boolean | undefined;
-  authenticationTokenKey?: string | undefined;
-  baseUrl?: string | undefined;
-  channelId?: string | undefined;
-  clientId?: string | undefined;
-  datePath?: string | undefined;
+  user?: string | undefined;
+  secretKey?: string | undefined;
   domain?: string | undefined;
-  externalLink?: string | undefined;
-  from?: string | undefined;
-  hmac?: boolean | undefined;
-  host?: string | undefined;
-  idPath?: string | undefined;
-  ignoreTls?: boolean | undefined;
-  imageUrl?: string | undefined;
-  instanceId?: string | undefined;
-  ipPoolName?: string | undefined;
-  messageProfileId?: string | undefined;
   password?: string | undefined;
-  phoneNumberIdentification?: string | undefined;
+  host?: string | undefined;
   port?: string | undefined;
-  projectName?: string | undefined;
-  redirectUrl?: string | undefined;
-  region?: string | undefined;
-  requireTls?: boolean | undefined;
-  secretKey?: string | undefined;
-  secretKeyRequestHeader?: string | undefined;
   secure?: boolean | undefined;
+  region?: string | undefined;
+  accountSid?: string | undefined;
+  messageProfileId?: string | undefined;
+  token?: string | undefined;
+  from?: string | undefined;
   senderName?: string | undefined;
-  serviceAccount?: string | undefined;
-  state?: string | undefined;
-  title?: string | undefined;
+  projectName?: string | undefined;
+  applicationId?: string | undefined;
+  clientId?: string | undefined;
+  requireTls?: boolean | undefined;
+  ignoreTls?: boolean | undefined;
   tlsOptions?: TlsOptions$Outbound | undefined;
-  token?: string | undefined;
-  user?: string | undefined;
+  baseUrl?: string | undefined;
   webhookUrl?: string | undefined;
+  redirectUrl?: string | undefined;
+  hmac?: boolean | undefined;
+  serviceAccount?: string | undefined;
+  ipPoolName?: string | undefined;
+  apiKeyRequestHeader?: string | undefined;
+  secretKeyRequestHeader?: string | undefined;
+  idPath?: string | undefined;
+  datePath?: string | undefined;
+  apiToken?: string | undefined;
+  authenticateByToken?: boolean | undefined;
+  authenticationTokenKey?: string | undefined;
+  instanceId?: string | undefined;
+  alertUid?: string | undefined;
+  title?: string | undefined;
+  imageUrl?: string | undefined;
+  state?: string | undefined;
+  externalLink?: string | undefined;
+  channelId?: string | undefined;
+  phoneNumberIdentification?: string | undefined;
+  accessKey?: string | undefined;
 };
 
 /** @internal */
@@ -183,48 +200,48 @@ export const CredentialsDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   CredentialsDto
 > = z.object({
-  accessKey: z.string().optional(),
-  accountSid: z.string().optional(),
-  alertUid: z.string().optional(),
   apiKey: z.string().optional(),
-  apiKeyRequestHeader: z.string().optional(),
-  apiToken: z.string().optional(),
-  applicationId: z.string().optional(),
-  authenticateByToken: z.boolean().optional(),
-  authenticationTokenKey: z.string().optional(),
-  baseUrl: z.string().optional(),
-  channelId: z.string().optional(),
-  clientId: z.string().optional(),
-  datePath: z.string().optional(),
+  user: z.string().optional(),
+  secretKey: z.string().optional(),
   domain: z.string().optional(),
-  externalLink: z.string().optional(),
-  from: z.string().optional(),
-  hmac: z.boolean().optional(),
-  host: z.string().optional(),
-  idPath: z.string().optional(),
-  ignoreTls: z.boolean().optional(),
-  imageUrl: z.string().optional(),
-  instanceId: z.string().optional(),
-  ipPoolName: z.string().optional(),
-  messageProfileId: z.string().optional(),
   password: z.string().optional(),
-  phoneNumberIdentification: z.string().optional(),
+  host: z.string().optional(),
   port: z.string().optional(),
-  projectName: z.string().optional(),
-  redirectUrl: z.string().optional(),
-  region: z.string().optional(),
-  requireTls: z.boolean().optional(),
-  secretKey: z.string().optional(),
-  secretKeyRequestHeader: z.string().optional(),
   secure: z.boolean().optional(),
+  region: z.string().optional(),
+  accountSid: z.string().optional(),
+  messageProfileId: z.string().optional(),
+  token: z.string().optional(),
+  from: z.string().optional(),
   senderName: z.string().optional(),
-  serviceAccount: z.string().optional(),
-  state: z.string().optional(),
-  title: z.string().optional(),
+  projectName: z.string().optional(),
+  applicationId: z.string().optional(),
+  clientId: z.string().optional(),
+  requireTls: z.boolean().optional(),
+  ignoreTls: z.boolean().optional(),
   tlsOptions: z.lazy(() => TlsOptions$outboundSchema).optional(),
-  token: z.string().optional(),
-  user: z.string().optional(),
+  baseUrl: z.string().optional(),
   webhookUrl: z.string().optional(),
+  redirectUrl: z.string().optional(),
+  hmac: z.boolean().optional(),
+  serviceAccount: z.string().optional(),
+  ipPoolName: z.string().optional(),
+  apiKeyRequestHeader: z.string().optional(),
+  secretKeyRequestHeader: z.string().optional(),
+  idPath: z.string().optional(),
+  datePath: z.string().optional(),
+  apiToken: z.string().optional(),
+  authenticateByToken: z.boolean().optional(),
+  authenticationTokenKey: z.string().optional(),
+  instanceId: z.string().optional(),
+  alertUid: z.string().optional(),
+  title: z.string().optional(),
+  imageUrl: z.string().optional(),
+  state: z.string().optional(),
+  externalLink: z.string().optional(),
+  channelId: z.string().optional(),
+  phoneNumberIdentification: z.string().optional(),
+  accessKey: z.string().optional(),
 });
 
 /**
@@ -239,3 +256,17 @@ export namespace CredentialsDto$ {
   /** @deprecated use `CredentialsDto$Outbound` instead. */
   export type Outbound = CredentialsDto$Outbound;
 }
+
+export function credentialsDtoToJSON(credentialsDto: CredentialsDto): string {
+  return JSON.stringify(CredentialsDto$outboundSchema.parse(credentialsDto));
+}
+
+export function credentialsDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<CredentialsDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => CredentialsDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'CredentialsDto' from JSON`,
+  );
+}

package/src/models/components/databooleandto.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 DataBooleanDto = {
   data: boolean;
@@ -43,3 +46,17 @@ export namespace DataBooleanDto$ {
   /** @deprecated use `DataBooleanDto$Outbound` instead. */
   export type Outbound = DataBooleanDto$Outbound;
 }
+
+export function dataBooleanDtoToJSON(dataBooleanDto: DataBooleanDto): string {
+  return JSON.stringify(DataBooleanDto$outboundSchema.parse(dataBooleanDto));
+}
+
+export function dataBooleanDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<DataBooleanDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DataBooleanDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DataBooleanDto' from JSON`,
+  );
+}

package/src/models/components/delayregularmetadata.ts

@@ -3,16 +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 const DelayRegularMetadataType = {
-  Regular: "regular",
-} as const;
-export type DelayRegularMetadataType = ClosedEnum<
-  typeof DelayRegularMetadataType
->;
-
-export const Unit = {
+export const DelayRegularMetadataUnit = {
   Seconds: "seconds",
   Minutes: "minutes",
   Hours: "hours",
@@ -20,14 +16,44 @@ export const Unit = {
   Weeks: "weeks",
   Months: "months",
 } as const;
-export type Unit = ClosedEnum<typeof Unit>;
+export type DelayRegularMetadataUnit = ClosedEnum<
+  typeof DelayRegularMetadataUnit
+>;
+
+export const DelayRegularMetadataType = {
+  Regular: "regular",
+} as const;
+export type DelayRegularMetadataType = ClosedEnum<
+  typeof DelayRegularMetadataType
+>;
 
 export type DelayRegularMetadata = {
   amount?: number | undefined;
+  unit?: DelayRegularMetadataUnit | undefined;
   type: DelayRegularMetadataType;
-  unit?: Unit | undefined;
 };
 
+/** @internal */
+export const DelayRegularMetadataUnit$inboundSchema: z.ZodNativeEnum<
+  typeof DelayRegularMetadataUnit
+> = z.nativeEnum(DelayRegularMetadataUnit);
+
+/** @internal */
+export const DelayRegularMetadataUnit$outboundSchema: z.ZodNativeEnum<
+  typeof DelayRegularMetadataUnit
+> = DelayRegularMetadataUnit$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace DelayRegularMetadataUnit$ {
+  /** @deprecated use `DelayRegularMetadataUnit$inboundSchema` instead. */
+  export const inboundSchema = DelayRegularMetadataUnit$inboundSchema;
+  /** @deprecated use `DelayRegularMetadataUnit$outboundSchema` instead. */
+  export const outboundSchema = DelayRegularMetadataUnit$outboundSchema;
+}
+
 /** @internal */
 export const DelayRegularMetadataType$inboundSchema: z.ZodNativeEnum<
   typeof DelayRegularMetadataType
@@ -49,26 +75,6 @@ export namespace DelayRegularMetadataType$ {
   export const outboundSchema = DelayRegularMetadataType$outboundSchema;
 }
 
-/** @internal */
-export const Unit$inboundSchema: z.ZodNativeEnum<typeof Unit> = z.nativeEnum(
-  Unit,
-);
-
-/** @internal */
-export const Unit$outboundSchema: z.ZodNativeEnum<typeof Unit> =
-  Unit$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace Unit$ {
-  /** @deprecated use `Unit$inboundSchema` instead. */
-  export const inboundSchema = Unit$inboundSchema;
-  /** @deprecated use `Unit$outboundSchema` instead. */
-  export const outboundSchema = Unit$outboundSchema;
-}
-
 /** @internal */
 export const DelayRegularMetadata$inboundSchema: z.ZodType<
   DelayRegularMetadata,
@@ -76,15 +82,15 @@ export const DelayRegularMetadata$inboundSchema: z.ZodType<
   unknown
 > = z.object({
   amount: z.number().optional(),
+  unit: DelayRegularMetadataUnit$inboundSchema.optional(),
   type: DelayRegularMetadataType$inboundSchema,
-  unit: Unit$inboundSchema.optional(),
 });
 
 /** @internal */
 export type DelayRegularMetadata$Outbound = {
   amount?: number | undefined;
-  type: string;
   unit?: string | undefined;
+  type: string;
 };
 
 /** @internal */
@@ -94,8 +100,8 @@ export const DelayRegularMetadata$outboundSchema: z.ZodType<
   DelayRegularMetadata
 > = z.object({
   amount: z.number().optional(),
+  unit: DelayRegularMetadataUnit$outboundSchema.optional(),
   type: DelayRegularMetadataType$outboundSchema,
-  unit: Unit$outboundSchema.optional(),
 });
 
 /**
@@ -110,3 +116,21 @@ export namespace DelayRegularMetadata$ {
   /** @deprecated use `DelayRegularMetadata$Outbound` instead. */
   export type Outbound = DelayRegularMetadata$Outbound;
 }
+
+export function delayRegularMetadataToJSON(
+  delayRegularMetadata: DelayRegularMetadata,
+): string {
+  return JSON.stringify(
+    DelayRegularMetadata$outboundSchema.parse(delayRegularMetadata),
+  );
+}
+
+export function delayRegularMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<DelayRegularMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DelayRegularMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DelayRegularMetadata' from JSON`,
+  );
+}

package/src/models/components/delayscheduledmetadata.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 DelayScheduledMetadataType = {
   Scheduled: "scheduled",
@@ -13,8 +16,8 @@ export type DelayScheduledMetadataType = ClosedEnum<
 >;
 
 export type DelayScheduledMetadata = {
-  delayPath: string;
   type: DelayScheduledMetadataType;
+  delayPath: string;
 };
 
 /** @internal */
@@ -44,14 +47,14 @@ export const DelayScheduledMetadata$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  delayPath: z.string(),
   type: DelayScheduledMetadataType$inboundSchema,
+  delayPath: z.string(),
 });
 
 /** @internal */
 export type DelayScheduledMetadata$Outbound = {
-  delayPath: string;
   type: string;
+  delayPath: string;
 };
 
 /** @internal */
@@ -60,8 +63,8 @@ export const DelayScheduledMetadata$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   DelayScheduledMetadata
 > = z.object({
-  delayPath: z.string(),
   type: DelayScheduledMetadataType$outboundSchema,
+  delayPath: z.string(),
 });
 
 /**
@@ -76,3 +79,21 @@ export namespace DelayScheduledMetadata$ {
   /** @deprecated use `DelayScheduledMetadata$Outbound` instead. */
   export type Outbound = DelayScheduledMetadata$Outbound;
 }
+
+export function delayScheduledMetadataToJSON(
+  delayScheduledMetadata: DelayScheduledMetadata,
+): string {
+  return JSON.stringify(
+    DelayScheduledMetadata$outboundSchema.parse(delayScheduledMetadata),
+  );
+}
+
+export function delayScheduledMetadataFromJSON(
+  jsonString: string,
+): SafeParseResult<DelayScheduledMetadata, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => DelayScheduledMetadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'DelayScheduledMetadata' from JSON`,
+  );
+}