@botpress/webchat 1.3.2 → 1.3.4

package/dist/gen/{models/message.t.d.ts → client/models.d.ts}

@@ -1,11 +1,57 @@
 /**
- * This file was automatically generated by json-schema-to-typescript.
- * DO NOT MODIFY IT BY HAND. Instead, modify the source JSONSchema file,
- * and run json-schema-to-typescript to regenerate this file.
+ * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
+ */
+export interface User {
+    /**
+     * Name of the [User](#schema_user)
+     */
+    name?: string;
+    /**
+     * Picture url of the [User](#schema_user)
+     */
+    pictureUrl?: string;
+    /**
+     * Id of the [User](#schema_user)
+     */
+    id: string;
+    /**
+     * Creation date of the [User](#schema_user) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Updating date of the [User](#schema_user) in ISO 8601 format
+     */
+    updatedAt: string;
+}
+export interface Conversation {
+    /**
+     * Id of the [Conversation](#schema_conversation)
+     */
+    id: string;
+    /**
+     * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
+     */
+    updatedAt: string;
+}
+/**
+ * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
  */
 export interface Message {
+    /**
+     * Id of the [Message](#schema_message)
+     */
     id: string;
+    /**
+     * Creation date of the [Message](#schema_message) in ISO 8601 format
+     */
     createdAt: string;
+    /**
+     * Payload is the content type of the message.
+     */
     payload: {
         audioUrl: string;
         /**
@@ -117,6 +163,48 @@ export interface Message {
         className?: string;
         type: "video";
     };
+    /**
+     * ID of the [User](#schema_user)
+     */
     userId: string;
+    /**
+     * ID of the [Conversation](#schema_conversation)
+     */
     conversationId: string;
 }
+export interface Event {
+    /**
+     * ID of the [Event](#schema_event).
+     */
+    id: string;
+    /**
+     * Creation date of the [Event](#schema_event) in ISO 8601 format
+     */
+    createdAt: string;
+    /**
+     * Payload is the content of the event.
+     */
+    payload: {
+        type: "custom";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    } | {
+        type: "conversation_started";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    };
+    /**
+     * ID of the [Conversation](#schema_conversation).
+     */
+    conversationId: string;
+    /**
+     * ID of the [User](#schema_user).
+     */
+    userId: string;
+}

package/dist/gen/client/operations/addParticipant.d.ts

@@ -0,0 +1,51 @@
+export interface AddParticipantRequestHeaders {
+    "x-user-key": string;
+}
+export interface AddParticipantRequestQuery {
+}
+export interface AddParticipantRequestParams {
+    id: string;
+}
+export interface AddParticipantRequestBody {
+    /**
+     * User id
+     */
+    userId: string;
+}
+export type AddParticipantInput = AddParticipantRequestBody & AddParticipantRequestHeaders & AddParticipantRequestQuery & AddParticipantRequestParams;
+export type AddParticipantRequest = {
+    headers: AddParticipantRequestHeaders;
+    query: AddParticipantRequestQuery;
+    params: AddParticipantRequestParams;
+    body: AddParticipantRequestBody;
+};
+export declare const parseReq: (input: AddParticipantInput) => AddParticipantRequest & {
+    path: string;
+};
+export interface AddParticipantResponse {
+    /**
+     * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
+     */
+    participant: {
+        /**
+         * Name of the [User](#schema_user)
+         */
+        name?: string;
+        /**
+         * Picture url of the [User](#schema_user)
+         */
+        pictureUrl?: string;
+        /**
+         * Id of the [User](#schema_user)
+         */
+        id: string;
+        /**
+         * Creation date of the [User](#schema_user) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [User](#schema_user) in ISO 8601 format
+         */
+        updatedAt: string;
+    };
+}

package/dist/gen/client/operations/createConversation.d.ts

@@ -0,0 +1,39 @@
+export interface CreateConversationRequestHeaders {
+    "x-user-key": string;
+}
+export interface CreateConversationRequestQuery {
+}
+export interface CreateConversationRequestParams {
+}
+/**
+ * Conversation properties
+ */
+export interface CreateConversationRequestBody {
+    _?: string;
+}
+export type CreateConversationInput = CreateConversationRequestBody & CreateConversationRequestHeaders & CreateConversationRequestQuery & CreateConversationRequestParams;
+export type CreateConversationRequest = {
+    headers: CreateConversationRequestHeaders;
+    query: CreateConversationRequestQuery;
+    params: CreateConversationRequestParams;
+    body: CreateConversationRequestBody;
+};
+export declare const parseReq: (input: CreateConversationInput) => CreateConversationRequest & {
+    path: string;
+};
+export interface CreateConversationResponse {
+    conversation: {
+        /**
+         * Id of the [Conversation](#schema_conversation)
+         */
+        id: string;
+        /**
+         * Creation date of the [Conversation](#schema_conversation) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
+         */
+        updatedAt: string;
+    };
+}

package/dist/gen/client/operations/createEvent.d.ts

@@ -0,0 +1,79 @@
+export interface CreateEventRequestHeaders {
+    "x-user-key": string;
+}
+export interface CreateEventRequestQuery {
+}
+export interface CreateEventRequestParams {
+}
+export interface CreateEventRequestBody {
+    /**
+     * Payload is the content type of the event.
+     */
+    payload: {
+        type: "custom";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    } | {
+        type: "conversation_started";
+        data: {
+            [k: string]: {
+                [k: string]: any;
+            };
+        };
+    };
+    /**
+     * ID of the [Conversation](#schema_conversation)
+     */
+    conversationId: string;
+}
+export type CreateEventInput = CreateEventRequestBody & CreateEventRequestHeaders & CreateEventRequestQuery & CreateEventRequestParams;
+export type CreateEventRequest = {
+    headers: CreateEventRequestHeaders;
+    query: CreateEventRequestQuery;
+    params: CreateEventRequestParams;
+    body: CreateEventRequestBody;
+};
+export declare const parseReq: (input: CreateEventInput) => CreateEventRequest & {
+    path: string;
+};
+export interface CreateEventResponse {
+    event: {
+        /**
+         * ID of the [Event](#schema_event).
+         */
+        id: string;
+        /**
+         * Creation date of the [Event](#schema_event) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Payload is the content of the event.
+         */
+        payload: {
+            type: "custom";
+            data: {
+                [k: string]: {
+                    [k: string]: any;
+                };
+            };
+        } | {
+            type: "conversation_started";
+            data: {
+                [k: string]: {
+                    [k: string]: any;
+                };
+            };
+        };
+        /**
+         * ID of the [Conversation](#schema_conversation).
+         */
+        conversationId: string;
+        /**
+         * ID of the [User](#schema_user).
+         */
+        userId: string;
+    };
+}

package/dist/gen/client/operations/createMessage.d.ts

@@ -0,0 +1,274 @@
+export interface CreateMessageRequestHeaders {
+    "x-user-key": string;
+}
+export interface CreateMessageRequestQuery {
+}
+export interface CreateMessageRequestParams {
+}
+export interface CreateMessageRequestBody {
+    /**
+     * Payload is the content type of the message.
+     */
+    payload: {
+        audioUrl: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "audio";
+    } | {
+        title: string;
+        subtitle?: string;
+        imageUrl?: string;
+        actions: {
+            action: "postback" | "url" | "say";
+            label: string;
+            value: string;
+        }[];
+        type: "card";
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+    } | {
+        items: {
+            title: string;
+            subtitle?: string;
+            imageUrl?: string;
+            actions: {
+                action: "postback" | "url" | "say";
+                label: string;
+                value: string;
+            }[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+        }[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "carousel";
+    } | {
+        text: string;
+        options: {
+            label: string;
+            value: string;
+        }[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "choice";
+        disableFreeText?: boolean;
+    } | {
+        text: string;
+        options: {
+            label: string;
+            value: string;
+        }[];
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "dropdown";
+    } | {
+        fileUrl: string;
+        title?: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "file";
+    } | {
+        imageUrl: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "image";
+    } | {
+        latitude: number;
+        longitude: number;
+        address?: string;
+        title?: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "location";
+    } | {
+        markdown: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "markdown";
+    } | {
+        text: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "text";
+    } | {
+        videoUrl: string;
+        /**
+         * CSS className to apply to the message
+         */
+        className?: string;
+        type: "video";
+    };
+    /**
+     * ID of the [Conversation](#schema_conversation)
+     */
+    conversationId: string;
+}
+export type CreateMessageInput = CreateMessageRequestBody & CreateMessageRequestHeaders & CreateMessageRequestQuery & CreateMessageRequestParams;
+export type CreateMessageRequest = {
+    headers: CreateMessageRequestHeaders;
+    query: CreateMessageRequestQuery;
+    params: CreateMessageRequestParams;
+    body: CreateMessageRequestBody;
+};
+export declare const parseReq: (input: CreateMessageInput) => CreateMessageRequest & {
+    path: string;
+};
+export interface CreateMessageResponse {
+    /**
+     * The Message object represents a message in a [Conversation](#schema_conversation) for a specific [User](#schema_user).
+     */
+    message: {
+        /**
+         * Id of the [Message](#schema_message)
+         */
+        id: string;
+        /**
+         * Creation date of the [Message](#schema_message) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Payload is the content type of the message.
+         */
+        payload: {
+            audioUrl: string;
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "audio";
+        } | {
+            title: string;
+            subtitle?: string;
+            imageUrl?: string;
+            actions: {
+                action: "postback" | "url" | "say";
+                label: string;
+                value: string;
+            }[];
+            type: "card";
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+        } | {
+            items: {
+                title: string;
+                subtitle?: string;
+                imageUrl?: string;
+                actions: {
+                    action: "postback" | "url" | "say";
+                    label: string;
+                    value: string;
+                }[];
+                /**
+                 * CSS className to apply to the message
+                 */
+                className?: string;
+            }[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "carousel";
+        } | {
+            text: string;
+            options: {
+                label: string;
+                value: string;
+            }[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "choice";
+            disableFreeText?: boolean;
+        } | {
+            text: string;
+            options: {
+                label: string;
+                value: string;
+            }[];
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "dropdown";
+        } | {
+            fileUrl: string;
+            title?: string;
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "file";
+        } | {
+            imageUrl: string;
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "image";
+        } | {
+            latitude: number;
+            longitude: number;
+            address?: string;
+            title?: string;
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "location";
+        } | {
+            markdown: string;
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "markdown";
+        } | {
+            text: string;
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "text";
+        } | {
+            videoUrl: string;
+            /**
+             * CSS className to apply to the message
+             */
+            className?: string;
+            type: "video";
+        };
+        /**
+         * ID of the [User](#schema_user)
+         */
+        userId: string;
+        /**
+         * ID of the [Conversation](#schema_conversation)
+         */
+        conversationId: string;
+    };
+}

package/dist/gen/client/operations/createUser.d.ts

@@ -0,0 +1,60 @@
+export interface CreateUserRequestHeaders {
+}
+export interface CreateUserRequestQuery {
+}
+export interface CreateUserRequestParams {
+}
+export interface CreateUserRequestBody {
+    /**
+     * Name of the [User](#schema_user) (not a unique identifier)
+     */
+    name?: string;
+    /**
+     * Picture url of the [User](#schema_user)
+     */
+    pictureUrl?: string;
+    /**
+     * User data
+     */
+    userData?: {
+        [k: string]: any;
+    };
+}
+export type CreateUserInput = CreateUserRequestBody & CreateUserRequestHeaders & CreateUserRequestQuery & CreateUserRequestParams;
+export type CreateUserRequest = {
+    headers: CreateUserRequestHeaders;
+    query: CreateUserRequestQuery;
+    params: CreateUserRequestParams;
+    body: CreateUserRequestBody;
+};
+export declare const parseReq: (input: CreateUserInput) => CreateUserRequest & {
+    path: string;
+};
+export interface CreateUserResponse {
+    /**
+     * The user object represents someone interacting with the bot within a specific integration. The same person interacting with a bot in slack and messenger will be represented with two different users.
+     */
+    user: {
+        /**
+         * Name of the [User](#schema_user)
+         */
+        name?: string;
+        /**
+         * Picture url of the [User](#schema_user)
+         */
+        pictureUrl?: string;
+        /**
+         * Id of the [User](#schema_user)
+         */
+        id: string;
+        /**
+         * Creation date of the [User](#schema_user) in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the [User](#schema_user) in ISO 8601 format
+         */
+        updatedAt: string;
+    };
+    key: string;
+}

package/dist/gen/client/operations/deleteConversation.d.ts

@@ -0,0 +1,22 @@
+export interface DeleteConversationRequestHeaders {
+    "x-user-key": string;
+}
+export interface DeleteConversationRequestQuery {
+}
+export interface DeleteConversationRequestParams {
+    id: string;
+}
+export interface DeleteConversationRequestBody {
+}
+export type DeleteConversationInput = DeleteConversationRequestBody & DeleteConversationRequestHeaders & DeleteConversationRequestQuery & DeleteConversationRequestParams;
+export type DeleteConversationRequest = {
+    headers: DeleteConversationRequestHeaders;
+    query: DeleteConversationRequestQuery;
+    params: DeleteConversationRequestParams;
+    body: DeleteConversationRequestBody;
+};
+export declare const parseReq: (input: DeleteConversationInput) => DeleteConversationRequest & {
+    path: string;
+};
+export interface DeleteConversationResponse {
+}

package/dist/gen/client/operations/deleteMessage.d.ts

@@ -0,0 +1,22 @@
+export interface DeleteMessageRequestHeaders {
+    "x-user-key": string;
+}
+export interface DeleteMessageRequestQuery {
+}
+export interface DeleteMessageRequestParams {
+    id: string;
+}
+export interface DeleteMessageRequestBody {
+}
+export type DeleteMessageInput = DeleteMessageRequestBody & DeleteMessageRequestHeaders & DeleteMessageRequestQuery & DeleteMessageRequestParams;
+export type DeleteMessageRequest = {
+    headers: DeleteMessageRequestHeaders;
+    query: DeleteMessageRequestQuery;
+    params: DeleteMessageRequestParams;
+    body: DeleteMessageRequestBody;
+};
+export declare const parseReq: (input: DeleteMessageInput) => DeleteMessageRequest & {
+    path: string;
+};
+export interface DeleteMessageResponse {
+}

package/dist/gen/client/operations/deleteUser.d.ts

@@ -0,0 +1,21 @@
+export interface DeleteUserRequestHeaders {
+    "x-user-key": string;
+}
+export interface DeleteUserRequestQuery {
+}
+export interface DeleteUserRequestParams {
+}
+export interface DeleteUserRequestBody {
+}
+export type DeleteUserInput = DeleteUserRequestBody & DeleteUserRequestHeaders & DeleteUserRequestQuery & DeleteUserRequestParams;
+export type DeleteUserRequest = {
+    headers: DeleteUserRequestHeaders;
+    query: DeleteUserRequestQuery;
+    params: DeleteUserRequestParams;
+    body: DeleteUserRequestBody;
+};
+export declare const parseReq: (input: DeleteUserInput) => DeleteUserRequest & {
+    path: string;
+};
+export interface DeleteUserResponse {
+}