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

package/src/models/components/activitynotificationstepresponsedto.ts

@@ -0,0 +1,116 @@
+/*
+ * 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";
+import {
+  MessageTemplateDto,
+  MessageTemplateDto$inboundSchema,
+  MessageTemplateDto$Outbound,
+  MessageTemplateDto$outboundSchema,
+} from "./messagetemplatedto.js";
+import {
+  StepFilter,
+  StepFilter$inboundSchema,
+  StepFilter$Outbound,
+  StepFilter$outboundSchema,
+} from "./stepfilter.js";
+
+export type ActivityNotificationStepResponseDto = {
+  /**
+   * Unique identifier of the step
+   */
+  id: string;
+  /**
+   * Whether the step is active or not
+   */
+  active: boolean;
+  /**
+   * Filter criteria for the step
+   */
+  filters: StepFilter;
+  /**
+   * Optional template for the step
+   */
+  template?: MessageTemplateDto | undefined;
+};
+
+/** @internal */
+export const ActivityNotificationStepResponseDto$inboundSchema: z.ZodType<
+  ActivityNotificationStepResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  _id: z.string(),
+  active: z.boolean(),
+  filters: StepFilter$inboundSchema,
+  template: MessageTemplateDto$inboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    "_id": "id",
+  });
+});
+
+/** @internal */
+export type ActivityNotificationStepResponseDto$Outbound = {
+  _id: string;
+  active: boolean;
+  filters: StepFilter$Outbound;
+  template?: MessageTemplateDto$Outbound | undefined;
+};
+
+/** @internal */
+export const ActivityNotificationStepResponseDto$outboundSchema: z.ZodType<
+  ActivityNotificationStepResponseDto$Outbound,
+  z.ZodTypeDef,
+  ActivityNotificationStepResponseDto
+> = z.object({
+  id: z.string(),
+  active: z.boolean(),
+  filters: StepFilter$outboundSchema,
+  template: MessageTemplateDto$outboundSchema.optional(),
+}).transform((v) => {
+  return remap$(v, {
+    id: "_id",
+  });
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace ActivityNotificationStepResponseDto$ {
+  /** @deprecated use `ActivityNotificationStepResponseDto$inboundSchema` instead. */
+  export const inboundSchema =
+    ActivityNotificationStepResponseDto$inboundSchema;
+  /** @deprecated use `ActivityNotificationStepResponseDto$outboundSchema` instead. */
+  export const outboundSchema =
+    ActivityNotificationStepResponseDto$outboundSchema;
+  /** @deprecated use `ActivityNotificationStepResponseDto$Outbound` instead. */
+  export type Outbound = ActivityNotificationStepResponseDto$Outbound;
+}
+
+export function activityNotificationStepResponseDtoToJSON(
+  activityNotificationStepResponseDto: ActivityNotificationStepResponseDto,
+): string {
+  return JSON.stringify(
+    ActivityNotificationStepResponseDto$outboundSchema.parse(
+      activityNotificationStepResponseDto,
+    ),
+  );
+}
+
+export function activityNotificationStepResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<ActivityNotificationStepResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) =>
+      ActivityNotificationStepResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'ActivityNotificationStepResponseDto' from JSON`,
+  );
+}

package/src/models/components/activitynotificationsubscriberresponsedto.ts

@@ -9,10 +9,25 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type ActivityNotificationSubscriberResponseDto = {
+  /**
+   * First name of the subscriber
+   */
   firstName?: string | undefined;
+  /**
+   * Unique identifier of the subscriber
+   */
   id: string;
+  /**
+   * Last name of the subscriber
+   */
   lastName?: string | undefined;
+  /**
+   * Email of the subscriber
+   */
   email?: string | undefined;
+  /**
+   * Phone number of the subscriber
+   */
   phone?: string | undefined;
 };
 

package/src/models/components/activitynotificationtemplateresponsedto.ts

@@ -7,11 +7,26 @@ 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";
+import {
+  NotificationTrigger,
+  NotificationTrigger$inboundSchema,
+  NotificationTrigger$Outbound,
+  NotificationTrigger$outboundSchema,
+} from "./notificationtrigger.js";
 
 export type ActivityNotificationTemplateResponseDto = {
+  /**
+   * Unique identifier of the template
+   */
   id?: string | undefined;
+  /**
+   * Name of the template
+   */
   name: string;
-  triggers: Array<string>;
+  /**
+   * Triggers of the template
+   */
+  triggers: Array<NotificationTrigger>;
 };
 
 /** @internal */
@@ -22,7 +37,7 @@ export const ActivityNotificationTemplateResponseDto$inboundSchema: z.ZodType<
 > = z.object({
   _id: z.string().optional(),
   name: z.string(),
-  triggers: z.array(z.string()),
+  triggers: z.array(NotificationTrigger$inboundSchema),
 }).transform((v) => {
   return remap$(v, {
     "_id": "id",
@@ -33,7 +48,7 @@ export const ActivityNotificationTemplateResponseDto$inboundSchema: z.ZodType<
 export type ActivityNotificationTemplateResponseDto$Outbound = {
   _id?: string | undefined;
   name: string;
-  triggers: Array<string>;
+  triggers: Array<NotificationTrigger$Outbound>;
 };
 
 /** @internal */
@@ -44,7 +59,7 @@ export const ActivityNotificationTemplateResponseDto$outboundSchema: z.ZodType<
 > = z.object({
   id: z.string().optional(),
   name: z.string(),
-  triggers: z.array(z.string()),
+  triggers: z.array(NotificationTrigger$outboundSchema),
 }).transform((v) => {
   return remap$(v, {
     id: "_id",

package/src/models/components/channelpreference.ts

@@ -11,7 +11,7 @@ import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 /**
  * The type of channel that is enabled or not
  */
-export const Type = {
+export const ChannelPreferenceType = {
   InApp: "in_app",
   Email: "email",
   Sms: "sms",
@@ -21,13 +21,13 @@ export const Type = {
 /**
  * The type of channel that is enabled or not
  */
-export type Type = ClosedEnum<typeof Type>;
+export type ChannelPreferenceType = ClosedEnum<typeof ChannelPreferenceType>;
 
 export type ChannelPreference = {
   /**
    * The type of channel that is enabled or not
    */
-  type: Type;
+  type: ChannelPreferenceType;
   /**
    * If channel is enabled or not
    */
@@ -35,23 +35,24 @@ export type ChannelPreference = {
 };
 
 /** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
+export const ChannelPreferenceType$inboundSchema: z.ZodNativeEnum<
+  typeof ChannelPreferenceType
+> = z.nativeEnum(ChannelPreferenceType);
 
 /** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
+export const ChannelPreferenceType$outboundSchema: z.ZodNativeEnum<
+  typeof ChannelPreferenceType
+> = ChannelPreferenceType$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace Type$ {
-  /** @deprecated use `Type$inboundSchema` instead. */
-  export const inboundSchema = Type$inboundSchema;
-  /** @deprecated use `Type$outboundSchema` instead. */
-  export const outboundSchema = Type$outboundSchema;
+export namespace ChannelPreferenceType$ {
+  /** @deprecated use `ChannelPreferenceType$inboundSchema` instead. */
+  export const inboundSchema = ChannelPreferenceType$inboundSchema;
+  /** @deprecated use `ChannelPreferenceType$outboundSchema` instead. */
+  export const outboundSchema = ChannelPreferenceType$outboundSchema;
 }
 
 /** @internal */
@@ -60,7 +61,7 @@ export const ChannelPreference$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: Type$inboundSchema,
+  type: ChannelPreferenceType$inboundSchema,
   enabled: z.boolean(),
 });
 
@@ -76,7 +77,7 @@ export const ChannelPreference$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   ChannelPreference
 > = z.object({
-  type: Type$outboundSchema,
+  type: ChannelPreferenceType$outboundSchema,
   enabled: z.boolean(),
 });
 

package/src/models/components/index.ts

@@ -4,7 +4,10 @@
 
 export * from "./activitiesresponsedto.js";
 export * from "./activitygraphstatesresponse.js";
+export * from "./activitynotificationexecutiondetailresponsedto.js";
+export * from "./activitynotificationjobresponsedto.js";
 export * from "./activitynotificationresponsedto.js";
+export * from "./activitynotificationstepresponsedto.js";
 export * from "./activitynotificationsubscriberresponsedto.js";
 export * from "./activitynotificationtemplateresponsedto.js";
 export * from "./activitystatsresponsedto.js";
@@ -12,7 +15,6 @@ export * from "./actorfeeditemdto.js";
 export * from "./actortypeenum.js";
 export * from "./addsubscribersrequestdto.js";
 export * from "./assignsubscribertotopicdto.js";
-export * from "./builderfieldtype.js";
 export * from "./bulksubscribercreatedto.js";
 export * from "./bulktriggereventdto.js";
 export * from "./channelcredentials.js";
@@ -36,7 +38,6 @@ export * from "./emailblock.js";
 export * from "./emailblockstyles.js";
 export * from "./failedassignmentsdto.js";
 export * from "./feedresponsedto.js";
-export * from "./fieldfilterpart.js";
 export * from "./filtertopicsresponsedto.js";
 export * from "./getsubscriberpreferencesresponsedto.js";
 export * from "./gettopicresponsedto.js";
@@ -52,6 +53,7 @@ export * from "./messageentity.js";
 export * from "./messagemarkasrequestdto.js";
 export * from "./messageresponsedto.js";
 export * from "./messagetemplate.js";
+export * from "./messagetemplatedto.js";
 export * from "./notificationfeeditemdto.js";
 export * from "./notificationgroup.js";
 export * from "./notificationstep.js";

package/src/models/components/messageactionresult.ts

@@ -8,7 +8,7 @@ import { ClosedEnum } from "../../types/enums.js";
 import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
-export type Payload = {};
+export type MessageActionResultPayload = {};
 
 export const MessageActionResultType = {
   Primary: "primary",
@@ -19,48 +19,55 @@ export type MessageActionResultType = ClosedEnum<
 >;
 
 export type MessageActionResult = {
-  payload?: Payload | undefined;
+  payload?: MessageActionResultPayload | undefined;
   type?: MessageActionResultType | undefined;
 };
 
 /** @internal */
-export const Payload$inboundSchema: z.ZodType<Payload, z.ZodTypeDef, unknown> =
-  z.object({});
+export const MessageActionResultPayload$inboundSchema: z.ZodType<
+  MessageActionResultPayload,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
 
 /** @internal */
-export type Payload$Outbound = {};
+export type MessageActionResultPayload$Outbound = {};
 
 /** @internal */
-export const Payload$outboundSchema: z.ZodType<
-  Payload$Outbound,
+export const MessageActionResultPayload$outboundSchema: z.ZodType<
+  MessageActionResultPayload$Outbound,
   z.ZodTypeDef,
-  Payload
+  MessageActionResultPayload
 > = 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 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 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 function payloadToJSON(payload: Payload): string {
-  return JSON.stringify(Payload$outboundSchema.parse(payload));
+export function messageActionResultPayloadToJSON(
+  messageActionResultPayload: MessageActionResultPayload,
+): string {
+  return JSON.stringify(
+    MessageActionResultPayload$outboundSchema.parse(messageActionResultPayload),
+  );
 }
 
-export function payloadFromJSON(
+export function messageActionResultPayloadFromJSON(
   jsonString: string,
-): SafeParseResult<Payload, SDKValidationError> {
+): SafeParseResult<MessageActionResultPayload, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => Payload$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'Payload' from JSON`,
+    (x) => MessageActionResultPayload$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageActionResultPayload' from JSON`,
   );
 }
 
@@ -91,13 +98,13 @@ export const MessageActionResult$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  payload: z.lazy(() => Payload$inboundSchema).optional(),
+  payload: z.lazy(() => MessageActionResultPayload$inboundSchema).optional(),
   type: MessageActionResultType$inboundSchema.optional(),
 });
 
 /** @internal */
 export type MessageActionResult$Outbound = {
-  payload?: Payload$Outbound | undefined;
+  payload?: MessageActionResultPayload$Outbound | undefined;
   type?: string | undefined;
 };
 
@@ -107,7 +114,7 @@ export const MessageActionResult$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   MessageActionResult
 > = z.object({
-  payload: z.lazy(() => Payload$outboundSchema).optional(),
+  payload: z.lazy(() => MessageActionResultPayload$outboundSchema).optional(),
   type: MessageActionResultType$outboundSchema.optional(),
 });
 

package/src/models/components/messagetemplatedto.ts

@@ -0,0 +1,58 @@
+/*
+ * 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 MessageTemplateDto = {};
+
+/** @internal */
+export const MessageTemplateDto$inboundSchema: z.ZodType<
+  MessageTemplateDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({});
+
+/** @internal */
+export type MessageTemplateDto$Outbound = {};
+
+/** @internal */
+export const MessageTemplateDto$outboundSchema: z.ZodType<
+  MessageTemplateDto$Outbound,
+  z.ZodTypeDef,
+  MessageTemplateDto
+> = 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 MessageTemplateDto$ {
+  /** @deprecated use `MessageTemplateDto$inboundSchema` instead. */
+  export const inboundSchema = MessageTemplateDto$inboundSchema;
+  /** @deprecated use `MessageTemplateDto$outboundSchema` instead. */
+  export const outboundSchema = MessageTemplateDto$outboundSchema;
+  /** @deprecated use `MessageTemplateDto$Outbound` instead. */
+  export type Outbound = MessageTemplateDto$Outbound;
+}
+
+export function messageTemplateDtoToJSON(
+  messageTemplateDto: MessageTemplateDto,
+): string {
+  return JSON.stringify(
+    MessageTemplateDto$outboundSchema.parse(messageTemplateDto),
+  );
+}
+
+export function messageTemplateDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<MessageTemplateDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessageTemplateDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessageTemplateDto' from JSON`,
+  );
+}

package/src/models/components/notificationtrigger.ts

@@ -14,39 +14,54 @@ import {
   NotificationTriggerVariable$outboundSchema,
 } from "./notificationtriggervariable.js";
 
-export const NotificationTriggerType = {
+/**
+ * Type of the trigger
+ */
+export const Type = {
   Event: "event",
 } as const;
-export type NotificationTriggerType = ClosedEnum<
-  typeof NotificationTriggerType
->;
+/**
+ * Type of the trigger
+ */
+export type Type = ClosedEnum<typeof Type>;
 
 export type NotificationTrigger = {
-  type: NotificationTriggerType;
+  /**
+   * Type of the trigger
+   */
+  type: Type;
+  /**
+   * Identifier of the trigger
+   */
   identifier: string;
+  /**
+   * Variables of the trigger
+   */
   variables: Array<NotificationTriggerVariable>;
+  /**
+   * Subscriber variables of the trigger
+   */
   subscriberVariables?: Array<NotificationTriggerVariable> | undefined;
 };
 
 /** @internal */
-export const NotificationTriggerType$inboundSchema: z.ZodNativeEnum<
-  typeof NotificationTriggerType
-> = z.nativeEnum(NotificationTriggerType);
+export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
+  Type,
+);
 
 /** @internal */
-export const NotificationTriggerType$outboundSchema: z.ZodNativeEnum<
-  typeof NotificationTriggerType
-> = NotificationTriggerType$inboundSchema;
+export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
+  Type$inboundSchema;
 
 /**
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace NotificationTriggerType$ {
-  /** @deprecated use `NotificationTriggerType$inboundSchema` instead. */
-  export const inboundSchema = NotificationTriggerType$inboundSchema;
-  /** @deprecated use `NotificationTriggerType$outboundSchema` instead. */
-  export const outboundSchema = NotificationTriggerType$outboundSchema;
+export namespace Type$ {
+  /** @deprecated use `Type$inboundSchema` instead. */
+  export const inboundSchema = Type$inboundSchema;
+  /** @deprecated use `Type$outboundSchema` instead. */
+  export const outboundSchema = Type$outboundSchema;
 }
 
 /** @internal */
@@ -55,7 +70,7 @@ export const NotificationTrigger$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: NotificationTriggerType$inboundSchema,
+  type: Type$inboundSchema,
   identifier: z.string(),
   variables: z.array(NotificationTriggerVariable$inboundSchema),
   subscriberVariables: z.array(NotificationTriggerVariable$inboundSchema)
@@ -76,7 +91,7 @@ export const NotificationTrigger$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   NotificationTrigger
 > = z.object({
-  type: NotificationTriggerType$outboundSchema,
+  type: Type$outboundSchema,
   identifier: z.string(),
   variables: z.array(NotificationTriggerVariable$outboundSchema),
   subscriberVariables: z.array(NotificationTriggerVariable$outboundSchema)

package/src/models/components/notificationtriggervariable.ts

@@ -8,6 +8,9 @@ import { Result as SafeParseResult } from "../../types/fp.js";
 import { SDKValidationError } from "../errors/sdkvalidationerror.js";
 
 export type NotificationTriggerVariable = {
+  /**
+   * Name of the variable
+   */
   name: string;
 };
 

package/src/models/components/stepfilter.ts

@@ -4,85 +4,27 @@
 
 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 {
-  BuilderFieldType,
-  BuilderFieldType$inboundSchema,
-  BuilderFieldType$outboundSchema,
-} from "./builderfieldtype.js";
-import {
-  FieldFilterPart,
-  FieldFilterPart$inboundSchema,
-  FieldFilterPart$Outbound,
-  FieldFilterPart$outboundSchema,
-} from "./fieldfilterpart.js";
 
-export const Value = {
-  And: "AND",
-  Or: "OR",
-} as const;
-export type Value = ClosedEnum<typeof Value>;
-
-export type StepFilter = {
-  isNegated: boolean;
-  type: BuilderFieldType;
-  value: Value;
-  children: Array<FieldFilterPart>;
-};
-
-/** @internal */
-export const Value$inboundSchema: z.ZodNativeEnum<typeof Value> = z.nativeEnum(
-  Value,
-);
-
-/** @internal */
-export const Value$outboundSchema: z.ZodNativeEnum<typeof Value> =
-  Value$inboundSchema;
-
-/**
- * @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;
-}
+export type StepFilter = {};
 
 /** @internal */
 export const StepFilter$inboundSchema: z.ZodType<
   StepFilter,
   z.ZodTypeDef,
   unknown
-> = z.object({
-  isNegated: z.boolean(),
-  type: BuilderFieldType$inboundSchema,
-  value: Value$inboundSchema,
-  children: z.array(FieldFilterPart$inboundSchema),
-});
+> = z.object({});
 
 /** @internal */
-export type StepFilter$Outbound = {
-  isNegated: boolean;
-  type: string;
-  value: string;
-  children: Array<FieldFilterPart$Outbound>;
-};
+export type StepFilter$Outbound = {};
 
 /** @internal */
 export const StepFilter$outboundSchema: z.ZodType<
   StepFilter$Outbound,
   z.ZodTypeDef,
   StepFilter
-> = z.object({
-  isNegated: z.boolean(),
-  type: BuilderFieldType$outboundSchema,
-  value: Value$outboundSchema,
-  children: z.array(FieldFilterPart$outboundSchema),
-});
+> = z.object({});
 
 /**
  * @internal