@novu/api 0.6.2 → 1.0.0

package/src/models/components/activitynotificationstepresponsedto.ts

@@ -33,7 +33,7 @@ export type ControlVariables = {};
 /**
  * Metadata for the workflow step
  */
-export type Metadata = {};
+export type ActivityNotificationStepResponseDtoMetadata = {};
 
 /**
  * Step issues
@@ -60,7 +60,7 @@ export type ActivityNotificationStepResponseDto = {
   /**
    * Metadata for the workflow step
    */
-  metadata?: Metadata | undefined;
+  metadata?: ActivityNotificationStepResponseDtoMetadata | undefined;
   /**
    * Step issues
    */
@@ -202,46 +202,63 @@ export function controlVariablesFromJSON(
 }
 
 /** @internal */
-export const Metadata$inboundSchema: z.ZodType<
-  Metadata,
-  z.ZodTypeDef,
-  unknown
-> = z.object({});
+export const ActivityNotificationStepResponseDtoMetadata$inboundSchema:
+  z.ZodType<
+    ActivityNotificationStepResponseDtoMetadata,
+    z.ZodTypeDef,
+    unknown
+  > = z.object({});
 
 /** @internal */
-export type Metadata$Outbound = {};
+export type ActivityNotificationStepResponseDtoMetadata$Outbound = {};
 
 /** @internal */
-export const Metadata$outboundSchema: z.ZodType<
-  Metadata$Outbound,
-  z.ZodTypeDef,
-  Metadata
-> = z.object({});
+export const ActivityNotificationStepResponseDtoMetadata$outboundSchema:
+  z.ZodType<
+    ActivityNotificationStepResponseDtoMetadata$Outbound,
+    z.ZodTypeDef,
+    ActivityNotificationStepResponseDtoMetadata
+  > = 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 Metadata$ {
-  /** @deprecated use `Metadata$inboundSchema` instead. */
-  export const inboundSchema = Metadata$inboundSchema;
-  /** @deprecated use `Metadata$outboundSchema` instead. */
-  export const outboundSchema = Metadata$outboundSchema;
-  /** @deprecated use `Metadata$Outbound` instead. */
-  export type Outbound = Metadata$Outbound;
+export namespace ActivityNotificationStepResponseDtoMetadata$ {
+  /** @deprecated use `ActivityNotificationStepResponseDtoMetadata$inboundSchema` instead. */
+  export const inboundSchema =
+    ActivityNotificationStepResponseDtoMetadata$inboundSchema;
+  /** @deprecated use `ActivityNotificationStepResponseDtoMetadata$outboundSchema` instead. */
+  export const outboundSchema =
+    ActivityNotificationStepResponseDtoMetadata$outboundSchema;
+  /** @deprecated use `ActivityNotificationStepResponseDtoMetadata$Outbound` instead. */
+  export type Outbound = ActivityNotificationStepResponseDtoMetadata$Outbound;
 }
 
-export function metadataToJSON(metadata: Metadata): string {
-  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
+export function activityNotificationStepResponseDtoMetadataToJSON(
+  activityNotificationStepResponseDtoMetadata:
+    ActivityNotificationStepResponseDtoMetadata,
+): string {
+  return JSON.stringify(
+    ActivityNotificationStepResponseDtoMetadata$outboundSchema.parse(
+      activityNotificationStepResponseDtoMetadata,
+    ),
+  );
 }
 
-export function metadataFromJSON(
+export function activityNotificationStepResponseDtoMetadataFromJSON(
   jsonString: string,
-): SafeParseResult<Metadata, SDKValidationError> {
+): SafeParseResult<
+  ActivityNotificationStepResponseDtoMetadata,
+  SDKValidationError
+> {
   return safeParse(
     jsonString,
-    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Metadata' from JSON`,
+    (x) =>
+      ActivityNotificationStepResponseDtoMetadata$inboundSchema.parse(
+        JSON.parse(x),
+      ),
+    `Failed to parse 'ActivityNotificationStepResponseDtoMetadata' from JSON`,
   );
 }
 
@@ -298,7 +315,9 @@ export const ActivityNotificationStepResponseDto$inboundSchema: z.ZodType<
     ActivityNotificationStepResponseDtoReplyCallback$inboundSchema
   ).optional(),
   controlVariables: z.lazy(() => ControlVariables$inboundSchema).optional(),
-  metadata: z.lazy(() => Metadata$inboundSchema).optional(),
+  metadata: z.lazy(() =>
+    ActivityNotificationStepResponseDtoMetadata$inboundSchema
+  ).optional(),
   issues: z.lazy(() => Issues$inboundSchema).optional(),
   filters: z.array(StepFilterDto$inboundSchema),
   template: MessageTemplateDto$inboundSchema.optional(),
@@ -324,7 +343,7 @@ export type ActivityNotificationStepResponseDto$Outbound = {
     | ActivityNotificationStepResponseDtoReplyCallback$Outbound
     | undefined;
   controlVariables?: ControlVariables$Outbound | undefined;
-  metadata?: Metadata$Outbound | undefined;
+  metadata?: ActivityNotificationStepResponseDtoMetadata$Outbound | undefined;
   issues?: Issues$Outbound | undefined;
   filters: Array<StepFilterDto$Outbound>;
   template?: MessageTemplateDto$Outbound | undefined;
@@ -346,7 +365,9 @@ export const ActivityNotificationStepResponseDto$outboundSchema: z.ZodType<
     ActivityNotificationStepResponseDtoReplyCallback$outboundSchema
   ).optional(),
   controlVariables: z.lazy(() => ControlVariables$outboundSchema).optional(),
-  metadata: z.lazy(() => Metadata$outboundSchema).optional(),
+  metadata: z.lazy(() =>
+    ActivityNotificationStepResponseDtoMetadata$outboundSchema
+  ).optional(),
   issues: z.lazy(() => Issues$outboundSchema).optional(),
   filters: z.array(StepFilterDto$outboundSchema),
   template: MessageTemplateDto$outboundSchema.optional(),

package/src/models/components/activitytopicdto.ts

@@ -0,0 +1,85 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+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 ActivityTopicDto = {
+  /**
+   * Internal Topic ID of the notification
+   */
+  topicId: string;
+  /**
+   * Topic Key of the notification
+   */
+  topicKey: string;
+};
+
+/** @internal */
+export const ActivityTopicDto$inboundSchema: z.ZodType<
+  ActivityTopicDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _topicId: z.string(),
+  topicKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    "_topicId": "topicId",
+  });
+});
+
+/** @internal */
+export type ActivityTopicDto$Outbound = {
+  _topicId: string;
+  topicKey: string;
+};
+
+/** @internal */
+export const ActivityTopicDto$outboundSchema: z.ZodType<
+  ActivityTopicDto$Outbound,
+  z.ZodTypeDef,
+  ActivityTopicDto
+> = z.object({
+  topicId: z.string(),
+  topicKey: z.string(),
+}).transform((v) => {
+  return remap$(v, {
+    topicId: "_topicId",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityTopicDto$ {
+  /** @deprecated use `ActivityTopicDto$inboundSchema` instead. */
+  export const inboundSchema = ActivityTopicDto$inboundSchema;
+  /** @deprecated use `ActivityTopicDto$outboundSchema` instead. */
+  export const outboundSchema = ActivityTopicDto$outboundSchema;
+  /** @deprecated use `ActivityTopicDto$Outbound` instead. */
+  export type Outbound = ActivityTopicDto$Outbound;
+}
+
+export function activityTopicDtoToJSON(
+  activityTopicDto: ActivityTopicDto,
+): string {
+  return JSON.stringify(
+    ActivityTopicDto$outboundSchema.parse(activityTopicDto),
+  );
+}
+
+export function activityTopicDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ActivityTopicDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ActivityTopicDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActivityTopicDto' from JSON`,
+  );
+}

package/src/models/components/channelsettingsdto.ts

@@ -5,7 +5,6 @@
 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 {
@@ -14,39 +13,17 @@ import {
   ChannelCredentials$Outbound,
   ChannelCredentials$outboundSchema,
 } from "./channelcredentials.js";
-
-/**
- * The provider identifier for the credentials
- */
-export const ProviderId = {
-  Slack: "slack",
-  Discord: "discord",
-  Msteams: "msteams",
-  Mattermost: "mattermost",
-  Ryver: "ryver",
-  Zulip: "zulip",
-  GrafanaOnCall: "grafana-on-call",
-  Getstream: "getstream",
-  RocketChat: "rocket-chat",
-  WhatsappBusiness: "whatsapp-business",
-  Fcm: "fcm",
-  Apns: "apns",
-  Expo: "expo",
-  OneSignal: "one-signal",
-  Pushpad: "pushpad",
-  PushWebhook: "push-webhook",
-  PusherBeams: "pusher-beams",
-} as const;
-/**
- * The provider identifier for the credentials
- */
-export type ProviderId = ClosedEnum<typeof ProviderId>;
+import {
+  ChatOrPushProviderEnum,
+  ChatOrPushProviderEnum$inboundSchema,
+  ChatOrPushProviderEnum$outboundSchema,
+} from "./chatorpushproviderenum.js";
 
 export type ChannelSettingsDto = {
   /**
    * The provider identifier for the credentials
    */
-  providerId: ProviderId;
+  providerId: ChatOrPushProviderEnum;
   /**
    * The integration identifier
    */
@@ -61,32 +38,13 @@ export type ChannelSettingsDto = {
   integrationId: string;
 };
 
-/** @internal */
-export const ProviderId$inboundSchema: z.ZodNativeEnum<typeof ProviderId> = z
-  .nativeEnum(ProviderId);
-
-/** @internal */
-export const ProviderId$outboundSchema: z.ZodNativeEnum<typeof ProviderId> =
-  ProviderId$inboundSchema;
-
-/**
- * @internal
- * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
- */
-export namespace ProviderId$ {
-  /** @deprecated use `ProviderId$inboundSchema` instead. */
-  export const inboundSchema = ProviderId$inboundSchema;
-  /** @deprecated use `ProviderId$outboundSchema` instead. */
-  export const outboundSchema = ProviderId$outboundSchema;
-}
-
 /** @internal */
 export const ChannelSettingsDto$inboundSchema: z.ZodType<
   ChannelSettingsDto,
   z.ZodTypeDef,
   unknown
 > = z.object({
-  providerId: ProviderId$inboundSchema,
+  providerId: ChatOrPushProviderEnum$inboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentials$inboundSchema,
   _integrationId: z.string(),
@@ -110,7 +68,7 @@ export const ChannelSettingsDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ChannelSettingsDto
 > = z.object({
-  providerId: ProviderId$outboundSchema,
+  providerId: ChatOrPushProviderEnum$outboundSchema,
   integrationIdentifier: z.string().optional(),
   credentials: ChannelCredentials$outboundSchema,
   integrationId: z.string(),

package/src/models/components/chatorpushproviderenum.ts

@@ -0,0 +1,54 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The provider identifier for the credentials
+ */
+export const ChatOrPushProviderEnum = {
+  Slack: "slack",
+  Discord: "discord",
+  Msteams: "msteams",
+  Mattermost: "mattermost",
+  Ryver: "ryver",
+  Zulip: "zulip",
+  GrafanaOnCall: "grafana-on-call",
+  Getstream: "getstream",
+  RocketChat: "rocket-chat",
+  WhatsappBusiness: "whatsapp-business",
+  Fcm: "fcm",
+  Apns: "apns",
+  Expo: "expo",
+  OneSignal: "one-signal",
+  Pushpad: "pushpad",
+  PushWebhook: "push-webhook",
+  PusherBeams: "pusher-beams",
+} as const;
+/**
+ * The provider identifier for the credentials
+ */
+export type ChatOrPushProviderEnum = ClosedEnum<typeof ChatOrPushProviderEnum>;
+
+/** @internal */
+export const ChatOrPushProviderEnum$inboundSchema: z.ZodNativeEnum<
+  typeof ChatOrPushProviderEnum
+> = z.nativeEnum(ChatOrPushProviderEnum);
+
+/** @internal */
+export const ChatOrPushProviderEnum$outboundSchema: z.ZodNativeEnum<
+  typeof ChatOrPushProviderEnum
+> = ChatOrPushProviderEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ChatOrPushProviderEnum$ {
+  /** @deprecated use `ChatOrPushProviderEnum$inboundSchema` instead. */
+  export const inboundSchema = ChatOrPushProviderEnum$inboundSchema;
+  /** @deprecated use `ChatOrPushProviderEnum$outboundSchema` instead. */
+  export const outboundSchema = ChatOrPushProviderEnum$outboundSchema;
+}

package/src/models/components/constraintvalidation.ts

@@ -0,0 +1,270 @@
+/*
+ * 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 Five = string | number | boolean | { [k: string]: any };
+
+export type Four = {};
+
+/**
+ * Value that failed validation
+ */
+export type Value =
+  | Four
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean | { [k: string]: any } | null>;
+
+export type ConstraintValidation = {
+  /**
+   * List of validation error messages
+   */
+  messages: Array<string>;
+  /**
+   * Value that failed validation
+   */
+  value?:
+    | Four
+    | string
+    | number
+    | boolean
+    | Array<string | number | boolean | { [k: string]: any } | null>
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const Five$inboundSchema: z.ZodType<Five, z.ZodTypeDef, unknown> = z
+  .union([z.string(), z.number(), z.boolean(), z.record(z.any())]);
+
+/** @internal */
+export type Five$Outbound = string | number | boolean | { [k: string]: any };
+
+/** @internal */
+export const Five$outboundSchema: z.ZodType<Five$Outbound, z.ZodTypeDef, Five> =
+  z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Five$ {
+  /** @deprecated use `Five$inboundSchema` instead. */
+  export const inboundSchema = Five$inboundSchema;
+  /** @deprecated use `Five$outboundSchema` instead. */
+  export const outboundSchema = Five$outboundSchema;
+  /** @deprecated use `Five$Outbound` instead. */
+  export type Outbound = Five$Outbound;
+}
+
+export function fiveToJSON(five: Five): string {
+  return JSON.stringify(Five$outboundSchema.parse(five));
+}
+
+export function fiveFromJSON(
+  jsonString: string,
+): SafeParseResult<Five, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Five$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Five' from JSON`,
+  );
+}
+
+/** @internal */
+export const Four$inboundSchema: z.ZodType<Four, z.ZodTypeDef, unknown> = z
+  .object({});
+
+/** @internal */
+export type Four$Outbound = {};
+
+/** @internal */
+export const Four$outboundSchema: z.ZodType<Four$Outbound, z.ZodTypeDef, Four> =
+  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 Four$ {
+  /** @deprecated use `Four$inboundSchema` instead. */
+  export const inboundSchema = Four$inboundSchema;
+  /** @deprecated use `Four$outboundSchema` instead. */
+  export const outboundSchema = Four$outboundSchema;
+  /** @deprecated use `Four$Outbound` instead. */
+  export type Outbound = Four$Outbound;
+}
+
+export function fourToJSON(four: Four): string {
+  return JSON.stringify(Four$outboundSchema.parse(four));
+}
+
+export function fourFromJSON(
+  jsonString: string,
+): SafeParseResult<Four, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Four$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Four' from JSON`,
+  );
+}
+
+/** @internal */
+export const Value$inboundSchema: z.ZodType<Value, z.ZodTypeDef, unknown> = z
+  .union([
+    z.lazy(() => Four$inboundSchema),
+    z.string(),
+    z.number(),
+    z.boolean(),
+    z.array(
+      z.nullable(
+        z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+      ),
+    ),
+  ]);
+
+/** @internal */
+export type Value$Outbound =
+  | Four$Outbound
+  | string
+  | number
+  | boolean
+  | Array<string | number | boolean | { [k: string]: any } | null>;
+
+/** @internal */
+export const Value$outboundSchema: z.ZodType<
+  Value$Outbound,
+  z.ZodTypeDef,
+  Value
+> = z.union([
+  z.lazy(() => Four$outboundSchema),
+  z.string(),
+  z.number(),
+  z.boolean(),
+  z.array(
+    z.nullable(
+      z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+    ),
+  ),
+]);
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace Value$ {
+  /** @deprecated use `Value$inboundSchema` instead. */
+  export const inboundSchema = Value$inboundSchema;
+  /** @deprecated use `Value$outboundSchema` instead. */
+  export const outboundSchema = Value$outboundSchema;
+  /** @deprecated use `Value$Outbound` instead. */
+  export type Outbound = Value$Outbound;
+}
+
+export function valueToJSON(value: Value): string {
+  return JSON.stringify(Value$outboundSchema.parse(value));
+}
+
+export function valueFromJSON(
+  jsonString: string,
+): SafeParseResult<Value, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => Value$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Value' from JSON`,
+  );
+}
+
+/** @internal */
+export const ConstraintValidation$inboundSchema: z.ZodType<
+  ConstraintValidation,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  messages: z.array(z.string()),
+  value: z.nullable(
+    z.union([
+      z.lazy(() => Four$inboundSchema),
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.array(
+        z.nullable(
+          z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+        ),
+      ),
+    ]),
+  ).optional(),
+});
+
+/** @internal */
+export type ConstraintValidation$Outbound = {
+  messages: Array<string>;
+  value?:
+    | Four$Outbound
+    | string
+    | number
+    | boolean
+    | Array<string | number | boolean | { [k: string]: any } | null>
+    | null
+    | undefined;
+};
+
+/** @internal */
+export const ConstraintValidation$outboundSchema: z.ZodType<
+  ConstraintValidation$Outbound,
+  z.ZodTypeDef,
+  ConstraintValidation
+> = z.object({
+  messages: z.array(z.string()),
+  value: z.nullable(
+    z.union([
+      z.lazy(() => Four$outboundSchema),
+      z.string(),
+      z.number(),
+      z.boolean(),
+      z.array(
+        z.nullable(
+          z.union([z.string(), z.number(), z.boolean(), z.record(z.any())]),
+        ),
+      ),
+    ]),
+  ).optional(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ConstraintValidation$ {
+  /** @deprecated use `ConstraintValidation$inboundSchema` instead. */
+  export const inboundSchema = ConstraintValidation$inboundSchema;
+  /** @deprecated use `ConstraintValidation$outboundSchema` instead. */
+  export const outboundSchema = ConstraintValidation$outboundSchema;
+  /** @deprecated use `ConstraintValidation$Outbound` instead. */
+  export type Outbound = ConstraintValidation$Outbound;
+}
+
+export function constraintValidationToJSON(
+  constraintValidation: ConstraintValidation,
+): string {
+  return JSON.stringify(
+    ConstraintValidation$outboundSchema.parse(constraintValidation),
+  );
+}
+
+export function constraintValidationFromJSON(
+  jsonString: string,
+): SafeParseResult<ConstraintValidation, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => ConstraintValidation$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ConstraintValidation' from JSON`,
+  );
+}