@botpress/webchat 1.1.0 → 1.2.0

package/dist/gen/models/index.d.ts

@@ -0,0 +1,851 @@
+import type { Conversation } from './conversation.t';
+import type { Message } from './message.t';
+import type { User } from './user.t';
+export declare const zod: {
+    conversation: import("zod").ZodObject<{
+        id: import("zod").ZodString;
+        createdAt: import("zod").ZodString;
+        updatedAt: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+    }, {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+    }>;
+    message: import("zod").ZodObject<{
+        id: import("zod").ZodString;
+        createdAt: import("zod").ZodString;
+        payload: import("zod").ZodUnion<[import("zod").ZodObject<{
+            audioUrl: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"audio">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "audio";
+            audioUrl: string;
+        }, {
+            type: "audio";
+            audioUrl: string;
+        }>, import("zod").ZodObject<{
+            title: import("zod").ZodString;
+            subtitle: import("zod").ZodOptional<import("zod").ZodString>;
+            imageUrl: import("zod").ZodOptional<import("zod").ZodString>;
+            actions: import("zod").ZodArray<import("zod").ZodObject<{
+                action: import("zod").ZodEnum<["postback", "url", "say"]>;
+                label: import("zod").ZodString;
+                value: import("zod").ZodString;
+            }, "strip", import("zod").ZodTypeAny, {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }, {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }>, "many">;
+            type: import("zod").ZodLiteral<"card">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        }, {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        }>, import("zod").ZodObject<{
+            items: import("zod").ZodArray<import("zod").ZodObject<{
+                title: import("zod").ZodString;
+                subtitle: import("zod").ZodOptional<import("zod").ZodString>;
+                imageUrl: import("zod").ZodOptional<import("zod").ZodString>;
+                actions: import("zod").ZodArray<import("zod").ZodObject<{
+                    action: import("zod").ZodEnum<["postback", "url", "say"]>;
+                    label: import("zod").ZodString;
+                    value: import("zod").ZodString;
+                }, "strip", import("zod").ZodTypeAny, {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }, {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }>, "many">;
+            }, "strip", import("zod").ZodTypeAny, {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }, {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }>, "many">;
+            type: import("zod").ZodLiteral<"carousel">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        }, {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        }>, import("zod").ZodObject<{
+            text: import("zod").ZodString;
+            options: import("zod").ZodArray<import("zod").ZodObject<{
+                label: import("zod").ZodString;
+                value: import("zod").ZodString;
+            }, "strip", import("zod").ZodTypeAny, {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+            type: import("zod").ZodLiteral<"choice">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>, import("zod").ZodObject<{
+            text: import("zod").ZodString;
+            options: import("zod").ZodArray<import("zod").ZodObject<{
+                label: import("zod").ZodString;
+                value: import("zod").ZodString;
+            }, "strip", import("zod").ZodTypeAny, {
+                value: string;
+                label: string;
+            }, {
+                value: string;
+                label: string;
+            }>, "many">;
+            type: import("zod").ZodLiteral<"dropdown">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }, {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        }>, import("zod").ZodObject<{
+            fileUrl: import("zod").ZodString;
+            title: import("zod").ZodOptional<import("zod").ZodString>;
+            type: import("zod").ZodLiteral<"file">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        }, {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        }>, import("zod").ZodObject<{
+            imageUrl: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"image">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "image";
+            imageUrl: string;
+        }, {
+            type: "image";
+            imageUrl: string;
+        }>, import("zod").ZodObject<{
+            latitude: import("zod").ZodNumber;
+            longitude: import("zod").ZodNumber;
+            address: import("zod").ZodOptional<import("zod").ZodString>;
+            title: import("zod").ZodOptional<import("zod").ZodString>;
+            type: import("zod").ZodLiteral<"location">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        }, {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        }>, import("zod").ZodObject<{
+            markdown: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"markdown">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "markdown";
+            markdown: string;
+        }, {
+            type: "markdown";
+            markdown: string;
+        }>, import("zod").ZodObject<{
+            text: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"text">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "text";
+            text: string;
+        }, {
+            type: "text";
+            text: string;
+        }>, import("zod").ZodObject<{
+            videoUrl: import("zod").ZodString;
+            type: import("zod").ZodLiteral<"video">;
+        }, "strip", import("zod").ZodTypeAny, {
+            type: "video";
+            videoUrl: string;
+        }, {
+            type: "video";
+            videoUrl: string;
+        }>]>;
+        userId: import("zod").ZodString;
+        conversationId: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        payload: {
+            type: "audio";
+            audioUrl: string;
+        } | {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        } | {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        } | {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        } | {
+            type: "image";
+            imageUrl: string;
+        } | {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        } | {
+            type: "markdown";
+            markdown: string;
+        } | {
+            type: "text";
+            text: string;
+        } | {
+            type: "video";
+            videoUrl: string;
+        };
+        id: string;
+        userId: string;
+        conversationId: string;
+        createdAt: string;
+    }, {
+        payload: {
+            type: "audio";
+            audioUrl: string;
+        } | {
+            type: "card";
+            title: string;
+            actions: {
+                value: string;
+                action: "url" | "postback" | "say";
+                label: string;
+            }[];
+            subtitle?: string | undefined;
+            imageUrl?: string | undefined;
+        } | {
+            type: "carousel";
+            items: {
+                title: string;
+                actions: {
+                    value: string;
+                    action: "url" | "postback" | "say";
+                    label: string;
+                }[];
+                subtitle?: string | undefined;
+                imageUrl?: string | undefined;
+            }[];
+        } | {
+            type: "choice";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "dropdown";
+            options: {
+                value: string;
+                label: string;
+            }[];
+            text: string;
+        } | {
+            type: "file";
+            fileUrl: string;
+            title?: string | undefined;
+        } | {
+            type: "image";
+            imageUrl: string;
+        } | {
+            type: "location";
+            latitude: number;
+            longitude: number;
+            address?: string | undefined;
+            title?: string | undefined;
+        } | {
+            type: "markdown";
+            markdown: string;
+        } | {
+            type: "text";
+            text: string;
+        } | {
+            type: "video";
+            videoUrl: string;
+        };
+        id: string;
+        userId: string;
+        conversationId: string;
+        createdAt: string;
+    }>;
+    user: import("zod").ZodObject<{
+        name: import("zod").ZodOptional<import("zod").ZodString>;
+        pictureUrl: import("zod").ZodOptional<import("zod").ZodString>;
+        profile: import("zod").ZodOptional<import("zod").ZodString>;
+        id: import("zod").ZodString;
+        createdAt: import("zod").ZodString;
+        updatedAt: import("zod").ZodString;
+    }, "strip", import("zod").ZodTypeAny, {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        name?: string | undefined;
+        pictureUrl?: string | undefined;
+        profile?: string | undefined;
+    }, {
+        id: string;
+        createdAt: string;
+        updatedAt: string;
+        name?: string | undefined;
+        pictureUrl?: string | undefined;
+        profile?: string | undefined;
+    }>;
+};
+export declare const json: {
+    conversation: {
+        type: string;
+        properties: {
+            id: {
+                type: string;
+            };
+            createdAt: {
+                type: string;
+                format: string;
+            };
+            updatedAt: {
+                type: string;
+                format: string;
+            };
+        };
+        required: string[];
+        additionalProperties: boolean;
+        $schema: string;
+    };
+    message: {
+        type: string;
+        properties: {
+            id: {
+                type: string;
+            };
+            createdAt: {
+                type: string;
+                format: string;
+            };
+            payload: {
+                anyOf: ({
+                    type: string;
+                    properties: {
+                        audioUrl: {
+                            type: string;
+                            minLength: number;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        title?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        title: {
+                            type: string;
+                            minLength: number;
+                        };
+                        subtitle: {
+                            type: string;
+                            minLength: number;
+                        };
+                        imageUrl: {
+                            type: string;
+                            minLength: number;
+                        };
+                        actions: {
+                            type: string;
+                            items: {
+                                type: string;
+                                properties: {
+                                    action: {
+                                        type: string;
+                                        enum: string[];
+                                    };
+                                    label: {
+                                        type: string;
+                                        minLength: number;
+                                    };
+                                    value: {
+                                        type: string;
+                                        minLength: number;
+                                    };
+                                };
+                                required: string[];
+                                additionalProperties: boolean;
+                            };
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        items?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        items: {
+                            type: string;
+                            items: {
+                                type: string;
+                                properties: {
+                                    title: {
+                                        type: string;
+                                        minLength: number;
+                                    };
+                                    subtitle: {
+                                        type: string;
+                                        minLength: number;
+                                    };
+                                    imageUrl: {
+                                        type: string;
+                                        minLength: number;
+                                    };
+                                    actions: {
+                                        type: string;
+                                        items: {
+                                            type: string;
+                                            properties: {
+                                                action: {
+                                                    type: string;
+                                                    enum: string[];
+                                                };
+                                                label: {
+                                                    type: string;
+                                                    minLength: number;
+                                                };
+                                                value: {
+                                                    type: string;
+                                                    minLength: number;
+                                                };
+                                            };
+                                            required: string[];
+                                            additionalProperties: boolean;
+                                        };
+                                    };
+                                };
+                                required: string[];
+                                additionalProperties: boolean;
+                            };
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        title?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        text: {
+                            type: string;
+                            minLength: number;
+                        };
+                        options: {
+                            type: string;
+                            items: {
+                                type: string;
+                                properties: {
+                                    label: {
+                                        type: string;
+                                        minLength: number;
+                                    };
+                                    value: {
+                                        type: string;
+                                        minLength: number;
+                                    };
+                                };
+                                required: string[];
+                                additionalProperties: boolean;
+                            };
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        title?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        fileUrl: {
+                            type: string;
+                            minLength: number;
+                        };
+                        title: {
+                            type: string;
+                            minLength: number;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        imageUrl: {
+                            type: string;
+                            minLength: number;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        title?: undefined;
+                        subtitle?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        latitude: {
+                            type: string;
+                        };
+                        longitude: {
+                            type: string;
+                        };
+                        address: {
+                            type: string;
+                        };
+                        title: {
+                            type: string;
+                            minLength?: undefined;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        markdown: {
+                            type: string;
+                            minLength: number;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        title?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        text: {
+                            type: string;
+                            minLength: number;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        title?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                        videoUrl?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                } | {
+                    type: string;
+                    properties: {
+                        videoUrl: {
+                            type: string;
+                            minLength: number;
+                        };
+                        type: {
+                            type: string;
+                            const: string;
+                        };
+                        audioUrl?: undefined;
+                        title?: undefined;
+                        subtitle?: undefined;
+                        imageUrl?: undefined;
+                        actions?: undefined;
+                        items?: undefined;
+                        text?: undefined;
+                        options?: undefined;
+                        fileUrl?: undefined;
+                        latitude?: undefined;
+                        longitude?: undefined;
+                        address?: undefined;
+                        markdown?: undefined;
+                    };
+                    required: string[];
+                    additionalProperties: boolean;
+                })[];
+            };
+            userId: {
+                type: string;
+            };
+            conversationId: {
+                type: string;
+            };
+        };
+        required: string[];
+        additionalProperties: boolean;
+        $schema: string;
+    };
+    user: {
+        type: string;
+        properties: {
+            name: {
+                type: string;
+            };
+            pictureUrl: {
+                type: string;
+            };
+            profile: {
+                type: string;
+            };
+            id: {
+                type: string;
+            };
+            createdAt: {
+                type: string;
+                format: string;
+            };
+            updatedAt: {
+                type: string;
+                format: string;
+            };
+        };
+        required: string[];
+        additionalProperties: boolean;
+        $schema: string;
+    };
+};
+export type Types = {
+    conversation: Conversation;
+    message: Message;
+    user: User;
+};