@novu/api 0.0.1-alpha.6

package/src/models/components/messageaction.ts

@@ -0,0 +1,47 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+import { MessageActionResult, MessageActionResult$ } from "./messageactionresult";
+import { MessageButton, MessageButton$ } from "./messagebutton";
+import * as z from "zod";
+
+export const MessageActionStatus = {
+    Pending: "pending",
+    Done: "done",
+} as const;
+export type MessageActionStatus = ClosedEnum<typeof MessageActionStatus>;
+
+export type MessageAction = {
+    buttons?: Array<MessageButton> | undefined;
+    result?: MessageActionResult | undefined;
+    status?: MessageActionStatus | undefined;
+};
+
+/** @internal */
+export namespace MessageActionStatus$ {
+    export const inboundSchema = z.nativeEnum(MessageActionStatus);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace MessageAction$ {
+    export const inboundSchema: z.ZodType<MessageAction, z.ZodTypeDef, unknown> = z.object({
+        buttons: z.array(MessageButton$.inboundSchema).optional(),
+        result: MessageActionResult$.inboundSchema.optional(),
+        status: MessageActionStatus$.inboundSchema.optional(),
+    });
+
+    export type Outbound = {
+        buttons?: Array<MessageButton$.Outbound> | undefined;
+        result?: MessageActionResult$.Outbound | undefined;
+        status?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageAction> = z.object({
+        buttons: z.array(MessageButton$.outboundSchema).optional(),
+        result: MessageActionResult$.outboundSchema.optional(),
+        status: MessageActionStatus$.outboundSchema.optional(),
+    });
+}

package/src/models/components/messageactionresult.ts

@@ -0,0 +1,55 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+import * as z from "zod";
+
+export type MessageActionResultPayload = {};
+
+export const MessageActionResultType = {
+    Primary: "primary",
+    Secondary: "secondary",
+    Clicked: "clicked",
+} as const;
+export type MessageActionResultType = ClosedEnum<typeof MessageActionResultType>;
+
+export type MessageActionResult = {
+    payload?: MessageActionResultPayload | undefined;
+    type?: MessageActionResultType | undefined;
+};
+
+/** @internal */
+export namespace MessageActionResultPayload$ {
+    export const inboundSchema: z.ZodType<MessageActionResultPayload, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageActionResultPayload> =
+        z.object({});
+}
+
+/** @internal */
+export namespace MessageActionResultType$ {
+    export const inboundSchema = z.nativeEnum(MessageActionResultType);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace MessageActionResult$ {
+    export const inboundSchema: z.ZodType<MessageActionResult, z.ZodTypeDef, unknown> = z.object({
+        payload: z.lazy(() => MessageActionResultPayload$.inboundSchema).optional(),
+        type: MessageActionResultType$.inboundSchema.optional(),
+    });
+
+    export type Outbound = {
+        payload?: MessageActionResultPayload$.Outbound | undefined;
+        type?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageActionResult> = z.object({
+        payload: z.lazy(() => MessageActionResultPayload$.outboundSchema).optional(),
+        type: MessageActionResultType$.outboundSchema.optional(),
+    });
+}

package/src/models/components/messagebutton.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+import * as z from "zod";
+
+export const MessageButtonType = {
+    Primary: "primary",
+    Secondary: "secondary",
+    Clicked: "clicked",
+} as const;
+export type MessageButtonType = ClosedEnum<typeof MessageButtonType>;
+
+export type MessageButton = {
+    content: string;
+    resultContent?: string | undefined;
+    type: MessageButtonType;
+};
+
+/** @internal */
+export namespace MessageButtonType$ {
+    export const inboundSchema = z.nativeEnum(MessageButtonType);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace MessageButton$ {
+    export const inboundSchema: z.ZodType<MessageButton, z.ZodTypeDef, unknown> = z.object({
+        content: z.string(),
+        resultContent: z.string().optional(),
+        type: MessageButtonType$.inboundSchema,
+    });
+
+    export type Outbound = {
+        content: string;
+        resultContent?: string | undefined;
+        type: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageButton> = z.object({
+        content: z.string(),
+        resultContent: z.string().optional(),
+        type: MessageButtonType$.outboundSchema,
+    });
+}

package/src/models/components/messagecta.ts

@@ -0,0 +1,46 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+import { MessageAction, MessageAction$ } from "./messageaction";
+import { MessageCTAData, MessageCTAData$ } from "./messagectadata";
+import * as z from "zod";
+
+export const MessageCTAType = {
+    Redirect: "redirect",
+} as const;
+export type MessageCTAType = ClosedEnum<typeof MessageCTAType>;
+
+export type MessageCTA = {
+    action?: MessageAction | undefined;
+    data: MessageCTAData;
+    type?: MessageCTAType | undefined;
+};
+
+/** @internal */
+export namespace MessageCTAType$ {
+    export const inboundSchema = z.nativeEnum(MessageCTAType);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace MessageCTA$ {
+    export const inboundSchema: z.ZodType<MessageCTA, z.ZodTypeDef, unknown> = z.object({
+        action: MessageAction$.inboundSchema.optional(),
+        data: MessageCTAData$.inboundSchema,
+        type: MessageCTAType$.inboundSchema.optional(),
+    });
+
+    export type Outbound = {
+        action?: MessageAction$.Outbound | undefined;
+        data: MessageCTAData$.Outbound;
+        type?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageCTA> = z.object({
+        action: MessageAction$.outboundSchema.optional(),
+        data: MessageCTAData$.outboundSchema,
+        type: MessageCTAType$.outboundSchema.optional(),
+    });
+}

package/src/models/components/messagectadata.ts

@@ -0,0 +1,24 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type MessageCTAData = {
+    url?: string | undefined;
+};
+
+/** @internal */
+export namespace MessageCTAData$ {
+    export const inboundSchema: z.ZodType<MessageCTAData, z.ZodTypeDef, unknown> = z.object({
+        url: z.string().optional(),
+    });
+
+    export type Outbound = {
+        url?: string | undefined;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageCTAData> = z.object({
+        url: z.string().optional(),
+    });
+}

package/src/models/components/messageentity.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type MessageEntity = {};
+
+/** @internal */
+export namespace MessageEntity$ {
+    export const inboundSchema: z.ZodType<MessageEntity, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageEntity> = z.object({});
+}

package/src/models/components/messagemarkasrequestdto.ts

@@ -0,0 +1,61 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { ClosedEnum } from "../../types";
+import * as z from "zod";
+
+export const MessageMarkAsRequestDtoMarkAs = {
+    Read: "read",
+    Seen: "seen",
+    Unread: "unread",
+    Unseen: "unseen",
+} as const;
+export type MessageMarkAsRequestDtoMarkAs = ClosedEnum<typeof MessageMarkAsRequestDtoMarkAs>;
+
+export type MessageId = string | Array<string>;
+
+export type MessageMarkAsRequestDto = {
+    markAs: MessageMarkAsRequestDtoMarkAs;
+    messageId: string | Array<string>;
+};
+
+/** @internal */
+export namespace MessageMarkAsRequestDtoMarkAs$ {
+    export const inboundSchema = z.nativeEnum(MessageMarkAsRequestDtoMarkAs);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace MessageId$ {
+    export const inboundSchema: z.ZodType<MessageId, z.ZodTypeDef, unknown> = z.union([
+        z.string(),
+        z.array(z.string()),
+    ]);
+
+    export type Outbound = string | Array<string>;
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageId> = z.union([
+        z.string(),
+        z.array(z.string()),
+    ]);
+}
+
+/** @internal */
+export namespace MessageMarkAsRequestDto$ {
+    export const inboundSchema: z.ZodType<MessageMarkAsRequestDto, z.ZodTypeDef, unknown> =
+        z.object({
+            markAs: MessageMarkAsRequestDtoMarkAs$.inboundSchema,
+            messageId: z.union([z.string(), z.array(z.string())]),
+        });
+
+    export type Outbound = {
+        markAs: string;
+        messageId: string | Array<string>;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageMarkAsRequestDto> =
+        z.object({
+            markAs: MessageMarkAsRequestDtoMarkAs$.outboundSchema,
+            messageId: z.union([z.string(), z.array(z.string())]),
+        });
+}

package/src/models/components/messageresponsedto.ts

@@ -0,0 +1,260 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import { ClosedEnum } from "../../types";
+import { EmailBlock, EmailBlock$ } from "./emailblock";
+import { MessageCTA, MessageCTA$ } from "./messagecta";
+import { SubscriberResponseDto, SubscriberResponseDto$ } from "./subscriberresponsedto";
+import { WorkflowResponse, WorkflowResponse$ } from "./workflowresponse";
+import * as z from "zod";
+
+export const MessageResponseDtoChannel = {
+    InApp: "in_app",
+    Email: "email",
+    Sms: "sms",
+    Chat: "chat",
+    Push: "push",
+} as const;
+export type MessageResponseDtoChannel = ClosedEnum<typeof MessageResponseDtoChannel>;
+
+export type Content = EmailBlock | string;
+
+/**
+ * Provider specific overrides used when triggering the notification
+ */
+export type Overrides = {};
+
+/**
+ * The payload that was used to send the notification trigger
+ */
+export type MessageResponseDtoPayload = {};
+
+export const MessageResponseDtoStatus = {
+    Sent: "sent",
+    Error: "error",
+    Warning: "warning",
+} as const;
+export type MessageResponseDtoStatus = ClosedEnum<typeof MessageResponseDtoStatus>;
+
+export type MessageResponseDto = {
+    environmentId: string;
+    feedId?: string | null | undefined;
+    id?: string | undefined;
+    messageTemplateId: string;
+    notificationId: string;
+    organizationId: string;
+    subscriberId: string;
+    templateId: string;
+    channel: MessageResponseDtoChannel;
+    content: EmailBlock | string;
+    createdAt: string;
+    cta: MessageCTA;
+    deviceTokens?: Array<string> | undefined;
+    directWebhookUrl?: string | undefined;
+    email?: string | undefined;
+    errorId: string;
+    errorText: string;
+    lastReadDate?: string | undefined;
+    lastSeenDate?: string | undefined;
+    /**
+     * Provider specific overrides used when triggering the notification
+     */
+    overrides: Overrides;
+    /**
+     * The payload that was used to send the notification trigger
+     */
+    payload: MessageResponseDtoPayload;
+    phone?: string | undefined;
+    providerId?: string | undefined;
+    read: boolean;
+    seen: boolean;
+    status: MessageResponseDtoStatus;
+    subject?: string | undefined;
+    subscriber?: SubscriberResponseDto | undefined;
+    template?: WorkflowResponse | undefined;
+    templateIdentifier?: string | undefined;
+    title?: string | undefined;
+    transactionId: string;
+};
+
+/** @internal */
+export namespace MessageResponseDtoChannel$ {
+    export const inboundSchema = z.nativeEnum(MessageResponseDtoChannel);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace Content$ {
+    export const inboundSchema: z.ZodType<Content, z.ZodTypeDef, unknown> = z.union([
+        EmailBlock$.inboundSchema,
+        z.string(),
+    ]);
+
+    export type Outbound = EmailBlock$.Outbound | string;
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Content> = z.union([
+        EmailBlock$.outboundSchema,
+        z.string(),
+    ]);
+}
+
+/** @internal */
+export namespace Overrides$ {
+    export const inboundSchema: z.ZodType<Overrides, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, Overrides> = z.object({});
+}
+
+/** @internal */
+export namespace MessageResponseDtoPayload$ {
+    export const inboundSchema: z.ZodType<MessageResponseDtoPayload, z.ZodTypeDef, unknown> =
+        z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageResponseDtoPayload> =
+        z.object({});
+}
+
+/** @internal */
+export namespace MessageResponseDtoStatus$ {
+    export const inboundSchema = z.nativeEnum(MessageResponseDtoStatus);
+    export const outboundSchema = inboundSchema;
+}
+
+/** @internal */
+export namespace MessageResponseDto$ {
+    export const inboundSchema: z.ZodType<MessageResponseDto, z.ZodTypeDef, unknown> = z
+        .object({
+            _environmentId: z.string(),
+            _feedId: z.nullable(z.string()).optional(),
+            _id: z.string().optional(),
+            _messageTemplateId: z.string(),
+            _notificationId: z.string(),
+            _organizationId: z.string(),
+            _subscriberId: z.string(),
+            _templateId: z.string(),
+            channel: MessageResponseDtoChannel$.inboundSchema,
+            content: z.union([EmailBlock$.inboundSchema, z.string()]),
+            createdAt: z.string(),
+            cta: MessageCTA$.inboundSchema,
+            deviceTokens: z.array(z.string()).optional(),
+            directWebhookUrl: z.string().optional(),
+            email: z.string().optional(),
+            errorId: z.string(),
+            errorText: z.string(),
+            lastReadDate: z.string().optional(),
+            lastSeenDate: z.string().optional(),
+            overrides: z.lazy(() => Overrides$.inboundSchema),
+            payload: z.lazy(() => MessageResponseDtoPayload$.inboundSchema),
+            phone: z.string().optional(),
+            providerId: z.string().optional(),
+            read: z.boolean(),
+            seen: z.boolean(),
+            status: MessageResponseDtoStatus$.inboundSchema,
+            subject: z.string().optional(),
+            subscriber: SubscriberResponseDto$.inboundSchema.optional(),
+            template: WorkflowResponse$.inboundSchema.optional(),
+            templateIdentifier: z.string().optional(),
+            title: z.string().optional(),
+            transactionId: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _environmentId: "environmentId",
+                _feedId: "feedId",
+                _id: "id",
+                _messageTemplateId: "messageTemplateId",
+                _notificationId: "notificationId",
+                _organizationId: "organizationId",
+                _subscriberId: "subscriberId",
+                _templateId: "templateId",
+            });
+        });
+
+    export type Outbound = {
+        _environmentId: string;
+        _feedId?: string | null | undefined;
+        _id?: string | undefined;
+        _messageTemplateId: string;
+        _notificationId: string;
+        _organizationId: string;
+        _subscriberId: string;
+        _templateId: string;
+        channel: string;
+        content: EmailBlock$.Outbound | string;
+        createdAt: string;
+        cta: MessageCTA$.Outbound;
+        deviceTokens?: Array<string> | undefined;
+        directWebhookUrl?: string | undefined;
+        email?: string | undefined;
+        errorId: string;
+        errorText: string;
+        lastReadDate?: string | undefined;
+        lastSeenDate?: string | undefined;
+        overrides: Overrides$.Outbound;
+        payload: MessageResponseDtoPayload$.Outbound;
+        phone?: string | undefined;
+        providerId?: string | undefined;
+        read: boolean;
+        seen: boolean;
+        status: string;
+        subject?: string | undefined;
+        subscriber?: SubscriberResponseDto$.Outbound | undefined;
+        template?: WorkflowResponse$.Outbound | undefined;
+        templateIdentifier?: string | undefined;
+        title?: string | undefined;
+        transactionId: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageResponseDto> = z
+        .object({
+            environmentId: z.string(),
+            feedId: z.nullable(z.string()).optional(),
+            id: z.string().optional(),
+            messageTemplateId: z.string(),
+            notificationId: z.string(),
+            organizationId: z.string(),
+            subscriberId: z.string(),
+            templateId: z.string(),
+            channel: MessageResponseDtoChannel$.outboundSchema,
+            content: z.union([EmailBlock$.outboundSchema, z.string()]),
+            createdAt: z.string(),
+            cta: MessageCTA$.outboundSchema,
+            deviceTokens: z.array(z.string()).optional(),
+            directWebhookUrl: z.string().optional(),
+            email: z.string().optional(),
+            errorId: z.string(),
+            errorText: z.string(),
+            lastReadDate: z.string().optional(),
+            lastSeenDate: z.string().optional(),
+            overrides: z.lazy(() => Overrides$.outboundSchema),
+            payload: z.lazy(() => MessageResponseDtoPayload$.outboundSchema),
+            phone: z.string().optional(),
+            providerId: z.string().optional(),
+            read: z.boolean(),
+            seen: z.boolean(),
+            status: MessageResponseDtoStatus$.outboundSchema,
+            subject: z.string().optional(),
+            subscriber: SubscriberResponseDto$.outboundSchema.optional(),
+            template: WorkflowResponse$.outboundSchema.optional(),
+            templateIdentifier: z.string().optional(),
+            title: z.string().optional(),
+            transactionId: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                environmentId: "_environmentId",
+                feedId: "_feedId",
+                id: "_id",
+                messageTemplateId: "_messageTemplateId",
+                notificationId: "_notificationId",
+                organizationId: "_organizationId",
+                subscriberId: "_subscriberId",
+                templateId: "_templateId",
+            });
+        });
+}

package/src/models/components/messagetemplate.ts

@@ -0,0 +1,16 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type MessageTemplate = {};
+
+/** @internal */
+export namespace MessageTemplate$ {
+    export const inboundSchema: z.ZodType<MessageTemplate, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageTemplate> = z.object({});
+}

package/src/models/components/messagetemplatedto.ts

@@ -0,0 +1,18 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import * as z from "zod";
+
+export type MessageTemplateDto = {};
+
+/** @internal */
+export namespace MessageTemplateDto$ {
+    export const inboundSchema: z.ZodType<MessageTemplateDto, z.ZodTypeDef, unknown> = z.object({});
+
+    export type Outbound = {};
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, MessageTemplateDto> = z.object(
+        {}
+    );
+}

package/src/models/components/notificationgroup.ts

@@ -0,0 +1,59 @@
+/*
+ * Code generated by Speakeasy (https://speakeasyapi.dev). DO NOT EDIT.
+ */
+
+import { remap as remap$ } from "../../lib/primitives";
+import * as z from "zod";
+
+export type NotificationGroup = {
+    environmentId: string;
+    id?: string | undefined;
+    organizationId: string;
+    parentId?: string | undefined;
+    name: string;
+};
+
+/** @internal */
+export namespace NotificationGroup$ {
+    export const inboundSchema: z.ZodType<NotificationGroup, z.ZodTypeDef, unknown> = z
+        .object({
+            _environmentId: z.string(),
+            _id: z.string().optional(),
+            _organizationId: z.string(),
+            _parentId: z.string().optional(),
+            name: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                _environmentId: "environmentId",
+                _id: "id",
+                _organizationId: "organizationId",
+                _parentId: "parentId",
+            });
+        });
+
+    export type Outbound = {
+        _environmentId: string;
+        _id?: string | undefined;
+        _organizationId: string;
+        _parentId?: string | undefined;
+        name: string;
+    };
+
+    export const outboundSchema: z.ZodType<Outbound, z.ZodTypeDef, NotificationGroup> = z
+        .object({
+            environmentId: z.string(),
+            id: z.string().optional(),
+            organizationId: z.string(),
+            parentId: z.string().optional(),
+            name: z.string(),
+        })
+        .transform((v) => {
+            return remap$(v, {
+                environmentId: "_environmentId",
+                id: "_id",
+                organizationId: "_organizationId",
+                parentId: "_parentId",
+            });
+        });
+}