@novu/api 0.6.1 → 0.7.0

package/src/models/components/messageresponsedto.ts

@@ -45,7 +45,7 @@ import {
 /**
  * Content of the message, can be an email block or a string
  */
-export type Content = EmailBlock | string;
+export type Content = Array<EmailBlock> | string;
 
 /**
  * The payload that was used to send the notification trigger
@@ -102,6 +102,10 @@ export type MessageResponseDto = {
    * Creation date of the message
    */
   createdAt: string;
+  /**
+   * Array of delivery dates for the message, if the message has multiple delivery dates, for example after being snoozed
+   */
+  deliveredAt?: Array<string> | undefined;
   /**
    * Last seen date of the message, if available
    */
@@ -113,7 +117,7 @@ export type MessageResponseDto = {
   /**
    * Content of the message, can be an email block or a string
    */
-  content: EmailBlock | string;
+  content: Array<EmailBlock> | string;
   /**
    * Transaction ID associated with the message
    */
@@ -134,6 +138,10 @@ export type MessageResponseDto = {
    * Indicates if the message has been seen
    */
   seen: boolean;
+  /**
+   * Date when the message will be unsnoozed
+   */
+  snoozedUntil?: string | undefined;
   /**
    * Email address associated with the message, if applicable
    */
@@ -190,17 +198,17 @@ export type MessageResponseDto = {
 
 /** @internal */
 export const Content$inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown> =
-  z.union([EmailBlock$inboundSchema, z.string()]);
+  z.union([z.array(EmailBlock$inboundSchema), z.string()]);
 
 /** @internal */
-export type Content$Outbound = EmailBlock$Outbound | string;
+export type Content$Outbound = Array<EmailBlock$Outbound> | string;
 
 /** @internal */
 export const Content$outboundSchema: z.ZodType<
   Content$Outbound,
   z.ZodTypeDef,
   Content
-> = z.union([EmailBlock$outboundSchema, z.string()]);
+> = z.union([z.array(EmailBlock$outboundSchema), z.string()]);
 
 /**
  * @internal
@@ -344,14 +352,16 @@ export const MessageResponseDto$inboundSchema: z.ZodType<
   template: WorkflowResponse$inboundSchema.optional(),
   templateIdentifier: z.string().optional(),
   createdAt: z.string(),
+  deliveredAt: z.array(z.string()).optional(),
   lastSeenDate: z.string().optional(),
   lastReadDate: z.string().optional(),
-  content: z.union([EmailBlock$inboundSchema, z.string()]),
+  content: z.union([z.array(EmailBlock$inboundSchema), z.string()]),
   transactionId: z.string(),
   subject: z.string().optional(),
   channel: ChannelTypeEnum$inboundSchema,
   read: z.boolean(),
   seen: z.boolean(),
+  snoozedUntil: z.string().optional(),
   email: z.string().optional(),
   phone: z.string().optional(),
   directWebhookUrl: z.string().optional(),
@@ -391,14 +401,16 @@ export type MessageResponseDto$Outbound = {
   template?: WorkflowResponse$Outbound | undefined;
   templateIdentifier?: string | undefined;
   createdAt: string;
+  deliveredAt?: Array<string> | undefined;
   lastSeenDate?: string | undefined;
   lastReadDate?: string | undefined;
-  content: EmailBlock$Outbound | string;
+  content: Array<EmailBlock$Outbound> | string;
   transactionId: string;
   subject?: string | undefined;
   channel: string;
   read: boolean;
   seen: boolean;
+  snoozedUntil?: string | undefined;
   email?: string | undefined;
   phone?: string | undefined;
   directWebhookUrl?: string | undefined;
@@ -431,14 +443,16 @@ export const MessageResponseDto$outboundSchema: z.ZodType<
   template: WorkflowResponse$outboundSchema.optional(),
   templateIdentifier: z.string().optional(),
   createdAt: z.string(),
+  deliveredAt: z.array(z.string()).optional(),
   lastSeenDate: z.string().optional(),
   lastReadDate: z.string().optional(),
-  content: z.union([EmailBlock$outboundSchema, z.string()]),
+  content: z.union([z.array(EmailBlock$outboundSchema), z.string()]),
   transactionId: z.string(),
   subject: z.string().optional(),
   channel: ChannelTypeEnum$outboundSchema,
   read: z.boolean(),
   seen: z.boolean(),
+  snoozedUntil: z.string().optional(),
   email: z.string().optional(),
   phone: z.string().optional(),
   directWebhookUrl: z.string().optional(),

package/src/models/components/messagesresponsedto.ts

@@ -0,0 +1,103 @@
+/*
+ * 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";
+import {
+  MessageResponseDto,
+  MessageResponseDto$inboundSchema,
+  MessageResponseDto$Outbound,
+  MessageResponseDto$outboundSchema,
+} from "./messageresponsedto.js";
+
+export type MessagesResponseDto = {
+  /**
+   * Total number of messages available
+   */
+  totalCount?: number | undefined;
+  /**
+   * Indicates if there are more messages available
+   */
+  hasMore: boolean;
+  /**
+   * List of messages
+   */
+  data: Array<MessageResponseDto>;
+  /**
+   * Number of messages per page
+   */
+  pageSize: number;
+  /**
+   * Current page number
+   */
+  page: number;
+};
+
+/** @internal */
+export const MessagesResponseDto$inboundSchema: z.ZodType<
+  MessagesResponseDto,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  totalCount: z.number().optional(),
+  hasMore: z.boolean(),
+  data: z.array(MessageResponseDto$inboundSchema),
+  pageSize: z.number(),
+  page: z.number(),
+});
+
+/** @internal */
+export type MessagesResponseDto$Outbound = {
+  totalCount?: number | undefined;
+  hasMore: boolean;
+  data: Array<MessageResponseDto$Outbound>;
+  pageSize: number;
+  page: number;
+};
+
+/** @internal */
+export const MessagesResponseDto$outboundSchema: z.ZodType<
+  MessagesResponseDto$Outbound,
+  z.ZodTypeDef,
+  MessagesResponseDto
+> = z.object({
+  totalCount: z.number().optional(),
+  hasMore: z.boolean(),
+  data: z.array(MessageResponseDto$outboundSchema),
+  pageSize: z.number(),
+  page: z.number(),
+});
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace MessagesResponseDto$ {
+  /** @deprecated use `MessagesResponseDto$inboundSchema` instead. */
+  export const inboundSchema = MessagesResponseDto$inboundSchema;
+  /** @deprecated use `MessagesResponseDto$outboundSchema` instead. */
+  export const outboundSchema = MessagesResponseDto$outboundSchema;
+  /** @deprecated use `MessagesResponseDto$Outbound` instead. */
+  export type Outbound = MessagesResponseDto$Outbound;
+}
+
+export function messagesResponseDtoToJSON(
+  messagesResponseDto: MessagesResponseDto,
+): string {
+  return JSON.stringify(
+    MessagesResponseDto$outboundSchema.parse(messagesResponseDto),
+  );
+}
+
+export function messagesResponseDtoFromJSON(
+  jsonString: string,
+): SafeParseResult<MessagesResponseDto, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => MessagesResponseDto$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'MessagesResponseDto' from JSON`,
+  );
+}

package/src/models/components/notificationfeeditemdto.ts

@@ -132,10 +132,6 @@ export type NotificationFeedItemDto = {
    * Indicates whether the notification has been seen by the subscriber.
    */
   seen: boolean;
-  /**
-   * Indicates whether the notification has been deleted.
-   */
-  deleted: boolean;
   /**
    * Device tokens for push notifications, if applicable.
    */
@@ -210,7 +206,6 @@ export const NotificationFeedItemDto$inboundSchema: z.ZodType<
   channel: ChannelTypeEnum$inboundSchema,
   read: z.boolean(),
   seen: z.boolean(),
-  deleted: z.boolean(),
   deviceTokens: z.nullable(z.array(z.string())).optional(),
   cta: MessageCTA$inboundSchema,
   status: NotificationFeedItemDtoStatus$inboundSchema,
@@ -253,7 +248,6 @@ export type NotificationFeedItemDto$Outbound = {
   channel: string;
   read: boolean;
   seen: boolean;
-  deleted: boolean;
   deviceTokens?: Array<string> | null | undefined;
   cta: MessageCTA$Outbound;
   status: string;
@@ -288,7 +282,6 @@ export const NotificationFeedItemDto$outboundSchema: z.ZodType<
   channel: ChannelTypeEnum$outboundSchema,
   read: z.boolean(),
   seen: z.boolean(),
-  deleted: z.boolean(),
   deviceTokens: z.nullable(z.array(z.string())).optional(),
   cta: MessageCTA$outboundSchema,
   status: NotificationFeedItemDtoStatus$outboundSchema,

package/src/models/components/notificationstepdto.ts

@@ -59,7 +59,7 @@ import {
 /**
  * Metadata associated with the workflow step. Can vary based on the type of step.
  */
-export type NotificationStepDtoMetadata =
+export type Metadata =
   | DelayScheduledMetadata
   | DelayRegularMetadata
   | DigestTimedMetadata
@@ -119,8 +119,8 @@ export type NotificationStepDto = {
 };
 
 /** @internal */
-export const NotificationStepDtoMetadata$inboundSchema: z.ZodType<
-  NotificationStepDtoMetadata,
+export const Metadata$inboundSchema: z.ZodType<
+  Metadata,
   z.ZodTypeDef,
   unknown
 > = z.union([
@@ -131,17 +131,17 @@ export const NotificationStepDtoMetadata$inboundSchema: z.ZodType<
 ]);
 
 /** @internal */
-export type NotificationStepDtoMetadata$Outbound =
+export type Metadata$Outbound =
   | DelayScheduledMetadata$Outbound
   | DelayRegularMetadata$Outbound
   | DigestTimedMetadata$Outbound
   | DigestRegularMetadata$Outbound;
 
 /** @internal */
-export const NotificationStepDtoMetadata$outboundSchema: z.ZodType<
-  NotificationStepDtoMetadata$Outbound,
+export const Metadata$outboundSchema: z.ZodType<
+  Metadata$Outbound,
   z.ZodTypeDef,
-  NotificationStepDtoMetadata
+  Metadata
 > = z.union([
   DelayScheduledMetadata$outboundSchema,
   DelayRegularMetadata$outboundSchema,
@@ -153,32 +153,26 @@ export const NotificationStepDtoMetadata$outboundSchema: z.ZodType<
  * @internal
  * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
  */
-export namespace NotificationStepDtoMetadata$ {
-  /** @deprecated use `NotificationStepDtoMetadata$inboundSchema` instead. */
-  export const inboundSchema = NotificationStepDtoMetadata$inboundSchema;
-  /** @deprecated use `NotificationStepDtoMetadata$outboundSchema` instead. */
-  export const outboundSchema = NotificationStepDtoMetadata$outboundSchema;
-  /** @deprecated use `NotificationStepDtoMetadata$Outbound` instead. */
-  export type Outbound = NotificationStepDtoMetadata$Outbound;
+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 function notificationStepDtoMetadataToJSON(
-  notificationStepDtoMetadata: NotificationStepDtoMetadata,
-): string {
-  return JSON.stringify(
-    NotificationStepDtoMetadata$outboundSchema.parse(
-      notificationStepDtoMetadata,
-    ),
-  );
+export function metadataToJSON(metadata: Metadata): string {
+  return JSON.stringify(Metadata$outboundSchema.parse(metadata));
 }
 
-export function notificationStepDtoMetadataFromJSON(
+export function metadataFromJSON(
   jsonString: string,
-): SafeParseResult<NotificationStepDtoMetadata, SDKValidationError> {
+): SafeParseResult<Metadata, SDKValidationError> {
   return safeParse(
     jsonString,
-    (x) => NotificationStepDtoMetadata$inboundSchema.parse(JSON.parse(x)),
-    `Failed to parse 'NotificationStepDtoMetadata' from JSON`,
+    (x) => Metadata$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'Metadata' from JSON`,
   );
 }
 

package/src/models/components/notificationtriggerdto.ts

@@ -17,19 +17,21 @@ import {
 /**
  * Type of the trigger
  */
-export const Type = {
+export const NotificationTriggerDtoType = {
   Event: "event",
 } as const;
 /**
  * Type of the trigger
  */
-export type Type = ClosedEnum<typeof Type>;
+export type NotificationTriggerDtoType = ClosedEnum<
+  typeof NotificationTriggerDtoType
+>;
 
 export type NotificationTriggerDto = {
   /**
    * Type of the trigger
    */
-  type: Type;
+  type: NotificationTriggerDtoType;
   /**
    * Identifier of the trigger
    */
@@ -45,23 +47,24 @@ export type NotificationTriggerDto = {
 };
 
 /** @internal */
-export const Type$inboundSchema: z.ZodNativeEnum<typeof Type> = z.nativeEnum(
-  Type,
-);
+export const NotificationTriggerDtoType$inboundSchema: z.ZodNativeEnum<
+  typeof NotificationTriggerDtoType
+> = z.nativeEnum(NotificationTriggerDtoType);
 
 /** @internal */
-export const Type$outboundSchema: z.ZodNativeEnum<typeof Type> =
-  Type$inboundSchema;
+export const NotificationTriggerDtoType$outboundSchema: z.ZodNativeEnum<
+  typeof NotificationTriggerDtoType
+> = NotificationTriggerDtoType$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 NotificationTriggerDtoType$ {
+  /** @deprecated use `NotificationTriggerDtoType$inboundSchema` instead. */
+  export const inboundSchema = NotificationTriggerDtoType$inboundSchema;
+  /** @deprecated use `NotificationTriggerDtoType$outboundSchema` instead. */
+  export const outboundSchema = NotificationTriggerDtoType$outboundSchema;
 }
 
 /** @internal */
@@ -70,7 +73,7 @@ export const NotificationTriggerDto$inboundSchema: z.ZodType<
   z.ZodTypeDef,
   unknown
 > = z.object({
-  type: Type$inboundSchema,
+  type: NotificationTriggerDtoType$inboundSchema,
   identifier: z.string(),
   variables: z.array(NotificationTriggerVariable$inboundSchema),
   subscriberVariables: z.array(NotificationTriggerVariable$inboundSchema)
@@ -91,7 +94,7 @@ export const NotificationTriggerDto$outboundSchema: z.ZodType<
   z.ZodTypeDef,
   NotificationTriggerDto
 > = z.object({
-  type: Type$outboundSchema,
+  type: NotificationTriggerDtoType$outboundSchema,
   identifier: z.string(),
   variables: z.array(NotificationTriggerVariable$outboundSchema),
   subscriberVariables: z.array(NotificationTriggerVariable$outboundSchema)

package/src/models/components/patchsubscriberpreferencesdto.ts

@@ -19,7 +19,7 @@ export type PatchSubscriberPreferencesDto = {
    */
   channels: PatchPreferenceChannelsDto;
   /**
-   * If provided, update workflow specific preferences, otherwise update global preferences
+   * Workflow internal _id, identifier or slug. If provided, update workflow specific preferences, otherwise update global preferences
    */
   workflowId?: string | undefined;
 };

package/src/models/components/preferenceoverridesourceenum.ts

@@ -0,0 +1,42 @@
+/*
+ * Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+import { ClosedEnum } from "../../types/enums.js";
+
+/**
+ * The source of overrides
+ */
+export const PreferenceOverrideSourceEnum = {
+  Subscriber: "subscriber",
+  Template: "template",
+  WorkflowOverride: "workflowOverride",
+} as const;
+/**
+ * The source of overrides
+ */
+export type PreferenceOverrideSourceEnum = ClosedEnum<
+  typeof PreferenceOverrideSourceEnum
+>;
+
+/** @internal */
+export const PreferenceOverrideSourceEnum$inboundSchema: z.ZodNativeEnum<
+  typeof PreferenceOverrideSourceEnum
+> = z.nativeEnum(PreferenceOverrideSourceEnum);
+
+/** @internal */
+export const PreferenceOverrideSourceEnum$outboundSchema: z.ZodNativeEnum<
+  typeof PreferenceOverrideSourceEnum
+> = PreferenceOverrideSourceEnum$inboundSchema;
+
+/**
+ * @internal
+ * @deprecated This namespace will be removed in future versions. Use schemas and types that are exported directly from this module.
+ */
+export namespace PreferenceOverrideSourceEnum$ {
+  /** @deprecated use `PreferenceOverrideSourceEnum$inboundSchema` instead. */
+  export const inboundSchema = PreferenceOverrideSourceEnum$inboundSchema;
+  /** @deprecated use `PreferenceOverrideSourceEnum$outboundSchema` instead. */
+  export const outboundSchema = PreferenceOverrideSourceEnum$outboundSchema;
+}

package/src/models/components/providersidenum.ts

@@ -60,6 +60,7 @@ export const ProvidersIdEnum = {
   BrevoSms: "brevo-sms",
   EazySms: "eazy-sms",
   Mobishastra: "mobishastra",
+  AfroMessage: "afro-message",
   Fcm: "fcm",
   Apns: "apns",
   Expo: "expo",

package/src/models/components/stepfilterdto.ts

@@ -19,37 +19,38 @@ import {
   FieldFilterPartDto$outboundSchema,
 } from "./fieldfilterpartdto.js";
 
-export const Value = {
+export const StepFilterDtoValue = {
   And: "AND",
   Or: "OR",
 } as const;
-export type Value = ClosedEnum<typeof Value>;
+export type StepFilterDtoValue = ClosedEnum<typeof StepFilterDtoValue>;
 
 export type StepFilterDto = {
   isNegated: boolean;
   type: BuilderFieldTypeEnum;
-  value: Value;
+  value: StepFilterDtoValue;
   children: Array<FieldFilterPartDto>;
 };
 
 /** @internal */
-export const Value$inboundSchema: z.ZodNativeEnum<typeof Value> = z.nativeEnum(
-  Value,
-);
+export const StepFilterDtoValue$inboundSchema: z.ZodNativeEnum<
+  typeof StepFilterDtoValue
+> = z.nativeEnum(StepFilterDtoValue);
 
 /** @internal */
-export const Value$outboundSchema: z.ZodNativeEnum<typeof Value> =
-  Value$inboundSchema;
+export const StepFilterDtoValue$outboundSchema: z.ZodNativeEnum<
+  typeof StepFilterDtoValue
+> = StepFilterDtoValue$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 namespace StepFilterDtoValue$ {
+  /** @deprecated use `StepFilterDtoValue$inboundSchema` instead. */
+  export const inboundSchema = StepFilterDtoValue$inboundSchema;
+  /** @deprecated use `StepFilterDtoValue$outboundSchema` instead. */
+  export const outboundSchema = StepFilterDtoValue$outboundSchema;
 }
 
 /** @internal */
@@ -60,7 +61,7 @@ export const StepFilterDto$inboundSchema: z.ZodType<
 > = z.object({
   isNegated: z.boolean(),
   type: BuilderFieldTypeEnum$inboundSchema,
-  value: Value$inboundSchema,
+  value: StepFilterDtoValue$inboundSchema,
   children: z.array(FieldFilterPartDto$inboundSchema),
 });
 
@@ -80,7 +81,7 @@ export const StepFilterDto$outboundSchema: z.ZodType<
 > = z.object({
   isNegated: z.boolean(),
   type: BuilderFieldTypeEnum$outboundSchema,
-  value: Value$outboundSchema,
+  value: StepFilterDtoValue$outboundSchema,
   children: z.array(FieldFilterPartDto$outboundSchema),
 });
 

package/src/models/components/stepsoverrides.ts

@@ -0,0 +1,65 @@
+/*
+ * 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 StepsOverrides = {
+  /**
+   * Passing the provider id and the provider specific configurations
+   */
+  providers: { [k: string]: { [k: string]: any } };
+};
+
+/** @internal */
+export const StepsOverrides$inboundSchema: z.ZodType<
+  StepsOverrides,
+  z.ZodTypeDef,
+  unknown
+> = z.object({
+  providers: z.record(z.record(z.any())),
+});
+
+/** @internal */
+export type StepsOverrides$Outbound = {
+  providers: { [k: string]: { [k: string]: any } };
+};
+
+/** @internal */
+export const StepsOverrides$outboundSchema: z.ZodType<
+  StepsOverrides$Outbound,
+  z.ZodTypeDef,
+  StepsOverrides
+> = z.object({
+  providers: z.record(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 StepsOverrides$ {
+  /** @deprecated use `StepsOverrides$inboundSchema` instead. */
+  export const inboundSchema = StepsOverrides$inboundSchema;
+  /** @deprecated use `StepsOverrides$outboundSchema` instead. */
+  export const outboundSchema = StepsOverrides$outboundSchema;
+  /** @deprecated use `StepsOverrides$Outbound` instead. */
+  export type Outbound = StepsOverrides$Outbound;
+}
+
+export function stepsOverridesToJSON(stepsOverrides: StepsOverrides): string {
+  return JSON.stringify(StepsOverrides$outboundSchema.parse(stepsOverrides));
+}
+
+export function stepsOverridesFromJSON(
+  jsonString: string,
+): SafeParseResult<StepsOverrides, SDKValidationError> {
+  return safeParse(
+    jsonString,
+    (x) => StepsOverrides$inboundSchema.parse(JSON.parse(x)),
+    `Failed to parse 'StepsOverrides' from JSON`,
+  );
+}

package/src/models/components/steptypeenum.ts

@@ -6,7 +6,7 @@ import * as z from "zod";
 import { ClosedEnum } from "../../types/enums.js";
 
 /**
- * Channels of the notification
+ * Type of the step
  */
 export const StepTypeEnum = {
   InApp: "in_app",
@@ -20,7 +20,7 @@ export const StepTypeEnum = {
   Custom: "custom",
 } as const;
 /**
- * Channels of the notification
+ * Type of the step
  */
 export type StepTypeEnum = ClosedEnum<typeof StepTypeEnum>;