@hexabot-ai/types 3.0.0-alpha.0

package/dist/types/chat/message-contract.d.ts

@@ -0,0 +1,883 @@
+import { z } from "zod";
+import type { Attachment } from "../attachment/attachment";
+import { PayloadType } from "./button";
+import type { Message as EntityMessage } from "./message";
+export declare enum StdEventType {
+    message = "message",
+    delivery = "delivery",
+    read = "read",
+    typing = "typing",
+    follow = "follow",
+    echo = "echo",
+    error = "error",
+    unknown = ""
+}
+export declare enum IncomingMessageType {
+    text = "text",
+    postback = "postback",
+    quickReply = "quickReply",
+    location = "location",
+    attachment = "attachment",
+    unknown = ""
+}
+export declare const incomingMessageType: z.ZodEnum<typeof IncomingMessageType>;
+export type IncomingMessageTypeLiteral = z.infer<typeof incomingMessageType>;
+export declare enum OutgoingMessageType {
+    text = "text",
+    quickReply = "quickReply",
+    buttons = "buttons",
+    attachment = "attachment",
+    list = "list",
+    carousel = "carousel",
+    system = "system"
+}
+export declare const outgoingMessageTypeSchema: z.ZodEnum<typeof OutgoingMessageType>;
+export type OutgoingMessageTypeLiteral = z.infer<typeof outgoingMessageTypeSchema>;
+export declare const payloadTypeSchema: z.ZodEnum<typeof PayloadType>;
+export type PayloadTypeLiteral = z.infer<typeof payloadTypeSchema>;
+export declare const stdOutgoingTextMessageDataSchema: z.ZodObject<{
+    text: z.ZodString;
+}, z.core.$strip>;
+export type StdOutgoingTextMessageData = z.infer<typeof stdOutgoingTextMessageDataSchema>;
+export declare const stdOutgoingQuickRepliesMessageDataSchema: z.ZodObject<{
+    text: z.ZodString;
+    quickReplies: z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        payload: z.ZodString;
+    }, z.core.$strip>>;
+}, z.core.$strip>;
+export type StdOutgoingQuickRepliesMessageData = z.infer<typeof stdOutgoingQuickRepliesMessageDataSchema>;
+export declare const stdOutgoingButtonsMessageDataSchema: z.ZodObject<{
+    text: z.ZodString;
+    buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+}, z.core.$strip>;
+export type StdOutgoingButtonsMessageData = z.infer<typeof stdOutgoingButtonsMessageDataSchema>;
+export declare const contentElementSchema: z.ZodObject<{
+    id: z.ZodString;
+    title: z.ZodString;
+}, z.core.$catchall<z.ZodAny>>;
+export type ContentElement = z.infer<typeof contentElementSchema>;
+export declare const contentPaginationSchema: z.ZodObject<{
+    total: z.ZodNumber;
+    skip: z.ZodNumber;
+    limit: z.ZodNumber;
+}, z.core.$strip>;
+export type ContentPagination = z.infer<typeof contentPaginationSchema>;
+export declare const stdOutgoingListMessageDataSchema: z.ZodObject<{
+    options: z.ZodObject<{
+        display: z.ZodEnum<{
+            list: "list";
+            carousel: "carousel";
+        }>;
+        contentType: z.ZodOptional<z.ZodString>;
+        fields: z.ZodObject<{
+            title: z.ZodString;
+            subtitle: z.ZodOptional<z.ZodString>;
+            image_url: z.ZodOptional<z.ZodString>;
+            url: z.ZodOptional<z.ZodString>;
+            action_title: z.ZodOptional<z.ZodString>;
+            action_payload: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>;
+        buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+        limit: z.ZodNumber;
+        query: z.ZodOptional<z.ZodAny>;
+        top_element_style: z.ZodOptional<z.ZodEnum<{
+            compact: "compact";
+            large: "large";
+        }>>;
+    }, z.core.$strip>;
+    elements: z.ZodArray<z.ZodObject<{
+        id: z.ZodString;
+        title: z.ZodString;
+    }, z.core.$catchall<z.ZodAny>>>;
+    pagination: z.ZodObject<{
+        total: z.ZodNumber;
+        skip: z.ZodNumber;
+        limit: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingListMessageData = z.infer<typeof stdOutgoingListMessageDataSchema>;
+export interface OutgoingPopulatedListMessage {
+    title: string;
+    subtitle: string | null;
+    image_url?: {
+        payload: Attachment;
+        type: string;
+    } | null;
+    url?: string;
+    action_title?: string;
+    action_payload?: string;
+}
+export declare const stdOutgoingAttachmentMessageDataSchema: z.ZodObject<{
+    attachment: z.ZodObject<{
+        type: z.ZodEnum<typeof import("./attachment").FileType>;
+        payload: z.ZodUnion<readonly [z.ZodObject<{
+            id: z.ZodNullable<z.ZodString>;
+            url: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            url: z.ZodString;
+        }, z.core.$strip>]>;
+    }, z.core.$strip>;
+    quickReplies: z.ZodOptional<z.ZodArray<z.ZodObject<{
+        title: z.ZodString;
+        payload: z.ZodString;
+    }, z.core.$strip>>>;
+}, z.core.$strip>;
+export type StdOutgoingAttachmentMessageData = z.infer<typeof stdOutgoingAttachmentMessageDataSchema>;
+export declare const stdOutgoingSystemMessageDataSchema: z.ZodObject<{
+    outcome: z.ZodOptional<z.ZodString>;
+    data: z.ZodOptional<z.ZodAny>;
+}, z.core.$strip>;
+export type StdOutgoingSystemMessageData = z.infer<typeof stdOutgoingSystemMessageDataSchema>;
+export declare const stdOutgoingTextMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.text>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingTextMessage = z.infer<typeof stdOutgoingTextMessageSchema>;
+export declare const stdOutgoingQuickRepliesMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.quickReply>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        quickReplies: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingQuickRepliesMessage = z.infer<typeof stdOutgoingQuickRepliesMessageSchema>;
+export declare const stdOutgoingButtonsMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.buttons>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingButtonsMessage = z.infer<typeof stdOutgoingButtonsMessageSchema>;
+export declare const stdOutgoingListMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.list>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingListMessage = z.infer<typeof stdOutgoingListMessageSchema>;
+export declare const stdOutgoingCarouselMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.carousel>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingCarouselMessage = z.infer<typeof stdOutgoingCarouselMessageSchema>;
+export declare const stdOutgoingAttachmentMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.attachment>;
+    data: z.ZodObject<{
+        attachment: z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>;
+        quickReplies: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingAttachmentMessage = z.infer<typeof stdOutgoingAttachmentMessageSchema>;
+export declare const stdOutgoingMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.text>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.quickReply>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        quickReplies: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.buttons>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.list>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.carousel>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.attachment>;
+    data: z.ZodObject<{
+        attachment: z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>;
+        quickReplies: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export type StdOutgoingMessage = z.infer<typeof stdOutgoingMessageSchema>;
+export declare const stdIncomingTextMessageDataSchema: z.ZodObject<{
+    text: z.ZodString;
+}, z.core.$strip>;
+export type StdIncomingTextMessageData = z.infer<typeof stdIncomingTextMessageDataSchema>;
+export declare const stdIncomingPayloadMessageDataSchema: z.ZodObject<{
+    text: z.ZodString;
+    payload: z.ZodString;
+}, z.core.$strip>;
+export type StdIncomingPayloadMessageData = z.infer<typeof stdIncomingPayloadMessageDataSchema>;
+export declare const stdIncomingLocationMessageDataSchema: z.ZodObject<{
+    coordinates: z.ZodObject<{
+        lat: z.ZodNumber;
+        lon: z.ZodNumber;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdIncomingLocationMessageData = z.infer<typeof stdIncomingLocationMessageDataSchema>;
+export declare const stdIncomingAttachmentMessageDataSchema: z.ZodObject<{
+    serializedText: z.ZodString;
+    attachment: z.ZodUnion<readonly [z.ZodObject<{
+        type: z.ZodEnum<typeof import("./attachment").FileType>;
+        payload: z.ZodUnion<readonly [z.ZodObject<{
+            id: z.ZodNullable<z.ZodString>;
+            url: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            url: z.ZodString;
+        }, z.core.$strip>]>;
+    }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+        type: z.ZodEnum<typeof import("./attachment").FileType>;
+        payload: z.ZodUnion<readonly [z.ZodObject<{
+            id: z.ZodNullable<z.ZodString>;
+            url: z.ZodOptional<z.ZodString>;
+        }, z.core.$strip>, z.ZodObject<{
+            id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+            url: z.ZodString;
+        }, z.core.$strip>]>;
+    }, z.core.$strip>>]>;
+}, z.core.$strip>;
+export type StdIncomingAttachmentMessageData = z.infer<typeof stdIncomingAttachmentMessageDataSchema>;
+export declare const stdIncomingTextMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.text>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdIncomingTextMessage = z.infer<typeof stdIncomingTextMessageSchema>;
+export declare const stdIncomingPostBackMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.postback>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        payload: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdIncomingPostBackMessage = z.infer<typeof stdIncomingPostBackMessageSchema>;
+export declare const stdIncomingQuickReplyMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.quickReply>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        payload: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdIncomingQuickReplyMessage = z.infer<typeof stdIncomingQuickReplyMessageSchema>;
+export declare const stdIncomingLocationMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.location>;
+    data: z.ZodObject<{
+        coordinates: z.ZodObject<{
+            lat: z.ZodNumber;
+            lon: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdIncomingLocationMessage = z.infer<typeof stdIncomingLocationMessageSchema>;
+export declare const stdIncomingAttachmentMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.attachment>;
+    data: z.ZodObject<{
+        serializedText: z.ZodString;
+        attachment: z.ZodUnion<readonly [z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>>]>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdIncomingAttachmentMessage = z.infer<typeof stdIncomingAttachmentMessageSchema>;
+export declare const stdIncomingMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.text>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.postback>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        payload: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.quickReply>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        payload: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.location>;
+    data: z.ZodObject<{
+        coordinates: z.ZodObject<{
+            lat: z.ZodNumber;
+            lon: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<IncomingMessageType.attachment>;
+    data: z.ZodObject<{
+        serializedText: z.ZodString;
+        attachment: z.ZodUnion<readonly [z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>, z.ZodArray<z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>>]>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export type StdIncomingMessage = z.infer<typeof stdIncomingMessageSchema>;
+export interface IncomingMessage extends Omit<EntityMessage, "recipient" | "sentBy"> {
+    message: StdIncomingMessage;
+    sender: string;
+}
+export interface OutgoingMessage extends Omit<EntityMessage, "sender"> {
+    message: StdOutgoingMessage;
+    recipient: string;
+    sentBy?: string;
+    handover: boolean;
+}
+export type AnyMessage = IncomingMessage | OutgoingMessage;
+export declare const stdOutgoingTextEnvelopeSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.text>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingTextEnvelope = StdOutgoingTextMessage;
+export declare const stdOutgoingQuickRepliesEnvelopeSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.quickReply>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        quickReplies: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingQuickRepliesEnvelope = StdOutgoingQuickRepliesMessage;
+export declare const stdOutgoingButtonsEnvelopeSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.buttons>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingButtonsEnvelope = StdOutgoingButtonsMessage;
+export declare const stdOutgoingListEnvelopeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.list>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.carousel>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export type StdOutgoingListEnvelope = z.infer<typeof stdOutgoingListEnvelopeSchema>;
+export declare const stdOutgoingAttachmentEnvelopeSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.attachment>;
+    data: z.ZodObject<{
+        attachment: z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>;
+        quickReplies: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingAttachmentEnvelope = StdOutgoingAttachmentMessage;
+export declare const stdOutgoingSystemMessageSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.system>;
+    data: z.ZodObject<{
+        outcome: z.ZodOptional<z.ZodString>;
+        data: z.ZodOptional<z.ZodAny>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingSystemMessage = z.infer<typeof stdOutgoingSystemMessageSchema>;
+export declare const stdOutgoingSystemEnvelopeSchema: z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.system>;
+    data: z.ZodObject<{
+        outcome: z.ZodOptional<z.ZodString>;
+        data: z.ZodOptional<z.ZodAny>;
+    }, z.core.$strip>;
+}, z.core.$strip>;
+export type StdOutgoingSystemEnvelope = StdOutgoingSystemMessage;
+export declare const stdOutgoingMessageEnvelopeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.text>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.quickReply>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        quickReplies: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.buttons>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.list>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.carousel>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.attachment>;
+    data: z.ZodObject<{
+        attachment: z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>;
+        quickReplies: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export type StdOutgoingMessageEnvelope = StdOutgoingMessage;
+export declare const stdOutgoingEnvelopeSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.text>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.quickReply>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        quickReplies: z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.buttons>;
+    data: z.ZodObject<{
+        text: z.ZodString;
+        buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.list>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.carousel>;
+    data: z.ZodObject<{
+        options: z.ZodObject<{
+            display: z.ZodEnum<{
+                list: "list";
+                carousel: "carousel";
+            }>;
+            contentType: z.ZodOptional<z.ZodString>;
+            fields: z.ZodObject<{
+                title: z.ZodString;
+                subtitle: z.ZodOptional<z.ZodString>;
+                image_url: z.ZodOptional<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+                action_title: z.ZodOptional<z.ZodString>;
+                action_payload: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>;
+            buttons: z.ZodArray<z.ZodType<import("./button").Button, unknown, z.core.$ZodTypeInternals<import("./button").Button, unknown>>>;
+            limit: z.ZodNumber;
+            query: z.ZodOptional<z.ZodAny>;
+            top_element_style: z.ZodOptional<z.ZodEnum<{
+                compact: "compact";
+                large: "large";
+            }>>;
+        }, z.core.$strip>;
+        elements: z.ZodArray<z.ZodObject<{
+            id: z.ZodString;
+            title: z.ZodString;
+        }, z.core.$catchall<z.ZodAny>>>;
+        pagination: z.ZodObject<{
+            total: z.ZodNumber;
+            skip: z.ZodNumber;
+            limit: z.ZodNumber;
+        }, z.core.$strip>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.attachment>;
+    data: z.ZodObject<{
+        attachment: z.ZodObject<{
+            type: z.ZodEnum<typeof import("./attachment").FileType>;
+            payload: z.ZodUnion<readonly [z.ZodObject<{
+                id: z.ZodNullable<z.ZodString>;
+                url: z.ZodOptional<z.ZodString>;
+            }, z.core.$strip>, z.ZodObject<{
+                id: z.ZodOptional<z.ZodNullable<z.ZodString>>;
+                url: z.ZodString;
+            }, z.core.$strip>]>;
+        }, z.core.$strip>;
+        quickReplies: z.ZodOptional<z.ZodArray<z.ZodObject<{
+            title: z.ZodString;
+            payload: z.ZodString;
+        }, z.core.$strip>>>;
+    }, z.core.$strip>;
+}, z.core.$strip>, z.ZodObject<{
+    type: z.ZodLiteral<OutgoingMessageType.system>;
+    data: z.ZodObject<{
+        outcome: z.ZodOptional<z.ZodString>;
+        data: z.ZodOptional<z.ZodAny>;
+    }, z.core.$strip>;
+}, z.core.$strip>], "type">;
+export type StdOutgoingEnvelope = z.infer<typeof stdOutgoingEnvelopeSchema>;
+//# sourceMappingURL=message-contract.d.ts.map