@botpress/webchat-client 0.3.0 → 0.4.0

package/dist/index.d.ts

@@ -186,13 +186,12 @@ export declare type Client = {
     getMessage: (params: MessageIdParam) => Promise<ClientTypes_2.GetMessageResponse>;
     deleteMessage: (params: MessageIdParam) => Promise<ClientTypes_2.DeleteMessageResponse>;
     createFile: (params: ClientTypes_2.CreateFileBody) => Promise<ClientTypes_2.CreateFileResponse>;
-    createUser: (params: ClientTypes_2.CreateUserBody) => Promise<ClientTypes_2.CreateUserResponse>;
     getUser: () => Promise<ClientTypes_2.GetUserResponse>;
     updateUser: (params: ClientTypes_2.CreateUserBody) => Promise<ClientTypes_2.UpdateUserResponse>;
     deleteUser: (params: UserIdParam) => Promise<ClientTypes_2.DeleteUserResponse>;
     createEvent: (params: ClientTypes_2.CreateEventBody) => Promise<ClientTypes_2.CreateEventResponse>;
     getEvent: (params: EventIdParam) => Promise<ClientTypes_2.GetEventResponse>;
-    listenConversation: (params: ConversationIdParam) => EventEmitter<Record<Event_3['type'], Event_3['data']>>['on'];
+    listenConversation: (params: ConversationIdParam) => EventEmitter<EventMap>['on'];
     addMessageFeedback: (params: MessageIdParam & ClientTypes_2.AddMessageFeedbackBody) => Promise<ClientTypes_2.AddMessageFeedbackResponse>;
     removeMessageFeedback: (params: MessageIdParam) => Promise<ClientTypes_2.RemoveMessageFeedbackResponse>;
     generateUserKey: (params: ClientTypes_2.GenerateUserKeyBody & {
@@ -220,6 +219,7 @@ declare namespace ClientTypes_2 {
         Message,
         Event_2 as Event,
         File_2 as File,
+        Perf,
         CreateConversationBody,
         AddParticipantBody,
         CreateMessageBody,
@@ -231,6 +231,7 @@ declare namespace ClientTypes_2 {
         UpdateUserBody,
         CreateEventBody,
         CreateFileBody,
+        SendPerfMetricsBody,
         DeleteConversationData,
         DeleteConversationErrors,
         DeleteConversationError,
@@ -361,6 +362,11 @@ declare namespace ClientTypes_2 {
         InitializeConversationError,
         InitializeConversationResponses,
         InitializeConversationResponse,
+        SendPerfMetricsData,
+        SendPerfMetricsErrors,
+        SendPerfMetricsError,
+        SendPerfMetricsResponses,
+        SendPerfMetricsResponse,
         ClientOptions,
         Options,
         deleteConversation,
@@ -388,7 +394,8 @@ declare namespace ClientTypes_2 {
         getEvent,
         createEvent,
         createFile,
-        initializeConversation
+        initializeConversation,
+        sendPerfMetrics_2 as sendPerfMetrics
     }
 }
 
@@ -489,16 +496,173 @@ export declare type Conversation = {
      * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
      */
     updatedAt: string;
+    /**
+     * The last [Message](#schema_message) sent in the [Conversation](#schema_conversation)
+     */
+    lastMessage?: {
+        /**
+         * 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 of the message.
+         */
+        payload: {
+            audioUrl: string;
+            type: 'audio';
+        } | {
+            title: string;
+            subtitle?: string;
+            imageUrl?: string;
+            actions: Array<{
+                action: 'postback' | 'url' | 'say';
+                label: string;
+                value: string;
+            }>;
+            type: 'card';
+        } | {
+            items: Array<{
+                title: string;
+                subtitle?: string;
+                imageUrl?: string;
+                actions: Array<{
+                    action: 'postback' | 'url' | 'say';
+                    label: string;
+                    value: string;
+                }>;
+            }>;
+            type: 'carousel';
+        } | {
+            text: string;
+            options: Array<{
+                label: string;
+                value: string;
+            }>;
+            disableFreeText?: boolean;
+            type: 'choice';
+        } | {
+            text: string;
+            options: Array<{
+                label: string;
+                value: string;
+            }>;
+            disableFreeText?: boolean;
+            type: 'dropdown';
+        } | {
+            fileUrl: string;
+            title?: string;
+            type: 'file';
+        } | {
+            imageUrl: string;
+            type: 'image';
+        } | {
+            latitude: number;
+            longitude: number;
+            address?: string;
+            title?: string;
+            type: 'location';
+        } | {
+            text: string;
+            value?: string;
+            type: 'text';
+        } | {
+            videoUrl: string;
+            type: 'video';
+        } | {
+            items: Array<{
+                type: 'text';
+                payload: {
+                    text: string;
+                    value?: string;
+                };
+            } | {
+                type: 'markdown';
+                payload: {
+                    markdown: string;
+                };
+            } | {
+                type: 'image';
+                payload: {
+                    imageUrl: string;
+                };
+            } | {
+                type: 'audio';
+                payload: {
+                    audioUrl: string;
+                };
+            } | {
+                type: 'video';
+                payload: {
+                    videoUrl: string;
+                };
+            } | {
+                type: 'file';
+                payload: {
+                    fileUrl: string;
+                    title?: string;
+                };
+            } | {
+                type: 'location';
+                payload: {
+                    latitude: number;
+                    longitude: number;
+                    address?: string;
+                    title?: string;
+                };
+            }>;
+            type: 'bloc';
+        } | {
+            markdown: string;
+            type: 'markdown';
+        } | {
+            url: string;
+            name: string;
+            data?: unknown;
+            type: 'custom';
+        };
+        /**
+         * ID of the [User](#schema_user)
+         */
+        userId: string;
+        /**
+         * ID of the [Conversation](#schema_conversation)
+         */
+        conversationId: string;
+        /**
+         * Metadata of the message
+         */
+        metadata?: {};
+        /**
+         * ID of the message this message is replying to
+         */
+        replyTo?: string;
+        /**
+         * ID of the user who selected this message. Undefined if not selected.
+         */
+        selectedBy?: string;
+        /**
+         * Feedback of the message
+         */
+        feedback?: {
+            value: 'positive' | 'negative';
+            comment?: string;
+        };
+    };
 };
 
 declare type ConversationIdParam = {
     conversationId: string;
 };
 
-export declare const createClient: ({ userKey, clientId, apiUrl, }: {
+export declare const createClient: ({ userKey, clientId, apiUrl, customHeaders, }: {
     userKey: string;
     clientId: string;
     apiUrl?: string;
+    customHeaders?: Record<string, string>;
 }) => Client;
 
 /**
@@ -894,11 +1058,12 @@ export declare type CreateMessageResponses = {
     };
 };
 
-export declare const createUser: ({ clientId, apiUrl, adminSecret, }: {
+export declare const createUser: ({ clientId, apiUrl, adminSecret, customHeaders, ...body }: {
     clientId: string;
     apiUrl?: string;
     adminSecret?: string;
-}) => Promise<{
+    customHeaders?: Record<string, string>;
+} & ClientTypes_2.CreateUserBody) => Promise<{
     user: ClientTypes_2.User;
     key: string;
 }>;
@@ -1172,6 +1337,10 @@ declare type EventIdParam = {
     eventId: string;
 };
 
+declare type EventMap = {
+    [E in Event_3 as E['type']]: E['data'];
+};
+
 declare type File_2 = {
     id: string;
     botId: string;
@@ -1514,17 +1683,18 @@ declare type Initialize = {
         messages: ListConversationMessagesResponse['messages'];
         participants: ListParticipantsResponse['participants'];
         user: GetUserResponse['user'] & {
-            userKey?: string;
+            userKey: string;
         };
     };
 };
 
-export declare const initialize: ({ conversationId, userToken, clientId, apiUrl, }: {
+export declare const initialize: ({ conversationId, userToken, clientId, apiUrl, adminSecret, }: {
     conversationId?: string;
     userToken?: string;
     apiUrl?: string;
     clientId: string;
-}) => <U extends "custom" | "error" | "message_created" | "message_updated" | "typing_started" | "typing_stopped" | "webchat_config" | "webchat_visibility" | "participant_added" | "participant_removed" | "message_status_changed" | "init" | "open">(event: U, callback: (args: Record<"custom" | "error" | "message_created" | "message_updated" | "typing_started" | "typing_stopped" | "webchat_config" | "webchat_visibility" | "participant_added" | "participant_removed" | "message_status_changed" | "init" | "open", any>[U]) => void) => () => void;
+    adminSecret?: string;
+}) => <U extends "custom" | "error" | "message_created" | "message_updated" | "typing_started" | "typing_stopped" | "webchat_config" | "webchat_visibility" | "participant_added" | "participant_removed" | "message_status_changed" | "init" | "open">(event: U, callback: (args: EventMap[U]) => void) => () => void;
 
 /**
  * Creates a SSE stream to receive messages and events. The first event will be a payload containing the conversation details.
@@ -1542,6 +1712,10 @@ export declare type InitializeConversationData = {
          * Authentication Key
          */
         'x-user-key'?: string;
+        /**
+         * Admin Key for managing users
+         */
+        'x-admin-secret'?: string;
     };
     path?: never;
     query?: {
@@ -1675,6 +1849,132 @@ declare const listConversations: <ThrowOnError extends boolean = false>(options:
         id: string;
         createdAt: string;
         updatedAt: string;
+        lastMessage?: {
+            id: string;
+            createdAt: string;
+            payload: {
+                audioUrl: string;
+                type: "audio";
+            } | {
+                title: string;
+                subtitle?: string;
+                imageUrl?: string;
+                actions: Array<{
+                    action: "postback" | "url" | "say";
+                    label: string;
+                    value: string;
+                }>;
+                type: "card";
+            } | {
+                items: Array<{
+                    title: string;
+                    subtitle?: string;
+                    imageUrl?: string;
+                    actions: Array<{
+                        action: "postback" | "url" | "say";
+                        label: string;
+                        value: string;
+                    }>;
+                }>;
+                type: "carousel";
+            } | {
+                text: string;
+                options: Array<{
+                    label: string;
+                    value: string;
+                }>;
+                disableFreeText?: boolean;
+                type: "choice";
+            } | {
+                text: string;
+                options: Array<{
+                    label: string;
+                    value: string;
+                }>;
+                disableFreeText?: boolean;
+                type: "dropdown";
+            } | {
+                fileUrl: string;
+                title?: string;
+                type: "file";
+            } | {
+                imageUrl: string;
+                type: "image";
+            } | {
+                latitude: number;
+                longitude: number;
+                address?: string;
+                title?: string;
+                type: "location";
+            } | {
+                text: string;
+                value?: string;
+                type: "text";
+            } | {
+                videoUrl: string;
+                type: "video";
+            } | {
+                items: Array<{
+                    type: "text";
+                    payload: {
+                        text: string;
+                        value?: string;
+                    };
+                } | {
+                    type: "markdown";
+                    payload: {
+                        markdown: string;
+                    };
+                } | {
+                    type: "image";
+                    payload: {
+                        imageUrl: string;
+                    };
+                } | {
+                    type: "audio";
+                    payload: {
+                        audioUrl: string;
+                    };
+                } | {
+                    type: "video";
+                    payload: {
+                        videoUrl: string;
+                    };
+                } | {
+                    type: "file";
+                    payload: {
+                        fileUrl: string;
+                        title?: string;
+                    };
+                } | {
+                    type: "location";
+                    payload: {
+                        latitude: number;
+                        longitude: number;
+                        address?: string;
+                        title?: string;
+                    };
+                }>;
+                type: "bloc";
+            } | {
+                markdown: string;
+                type: "markdown";
+            } | {
+                url: string;
+                name: string;
+                data?: unknown;
+                type: "custom";
+            };
+            userId: string;
+            conversationId: string;
+            metadata?: {};
+            replyTo?: string;
+            selectedBy?: string;
+            feedback?: {
+                value: "positive" | "negative";
+                comment?: string;
+            };
+        };
     }>;
     meta: {
         nextToken?: string;
@@ -1684,6 +1984,132 @@ declare const listConversations: <ThrowOnError extends boolean = false>(options:
         id: string;
         createdAt: string;
         updatedAt: string;
+        lastMessage?: {
+            id: string;
+            createdAt: string;
+            payload: {
+                audioUrl: string;
+                type: "audio";
+            } | {
+                title: string;
+                subtitle?: string;
+                imageUrl?: string;
+                actions: Array<{
+                    action: "postback" | "url" | "say";
+                    label: string;
+                    value: string;
+                }>;
+                type: "card";
+            } | {
+                items: Array<{
+                    title: string;
+                    subtitle?: string;
+                    imageUrl?: string;
+                    actions: Array<{
+                        action: "postback" | "url" | "say";
+                        label: string;
+                        value: string;
+                    }>;
+                }>;
+                type: "carousel";
+            } | {
+                text: string;
+                options: Array<{
+                    label: string;
+                    value: string;
+                }>;
+                disableFreeText?: boolean;
+                type: "choice";
+            } | {
+                text: string;
+                options: Array<{
+                    label: string;
+                    value: string;
+                }>;
+                disableFreeText?: boolean;
+                type: "dropdown";
+            } | {
+                fileUrl: string;
+                title?: string;
+                type: "file";
+            } | {
+                imageUrl: string;
+                type: "image";
+            } | {
+                latitude: number;
+                longitude: number;
+                address?: string;
+                title?: string;
+                type: "location";
+            } | {
+                text: string;
+                value?: string;
+                type: "text";
+            } | {
+                videoUrl: string;
+                type: "video";
+            } | {
+                items: Array<{
+                    type: "text";
+                    payload: {
+                        text: string;
+                        value?: string;
+                    };
+                } | {
+                    type: "markdown";
+                    payload: {
+                        markdown: string;
+                    };
+                } | {
+                    type: "image";
+                    payload: {
+                        imageUrl: string;
+                    };
+                } | {
+                    type: "audio";
+                    payload: {
+                        audioUrl: string;
+                    };
+                } | {
+                    type: "video";
+                    payload: {
+                        videoUrl: string;
+                    };
+                } | {
+                    type: "file";
+                    payload: {
+                        fileUrl: string;
+                        title?: string;
+                    };
+                } | {
+                    type: "location";
+                    payload: {
+                        latitude: number;
+                        longitude: number;
+                        address?: string;
+                        title?: string;
+                    };
+                }>;
+                type: "bloc";
+            } | {
+                markdown: string;
+                type: "markdown";
+            } | {
+                url: string;
+                name: string;
+                data?: unknown;
+                type: "custom";
+            };
+            userId: string;
+            conversationId: string;
+            metadata?: {};
+            replyTo?: string;
+            selectedBy?: string;
+            feedback?: {
+                value: "positive" | "negative";
+                comment?: string;
+            };
+        };
     }>;
     meta: {
         nextToken?: string;
@@ -1728,6 +2154,162 @@ export declare type ListConversationsErrors = {
              * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
              */
             updatedAt: string;
+            /**
+             * The last [Message](#schema_message) sent in the [Conversation](#schema_conversation)
+             */
+            lastMessage?: {
+                /**
+                 * 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 of the message.
+                 */
+                payload: {
+                    audioUrl: string;
+                    type: 'audio';
+                } | {
+                    title: string;
+                    subtitle?: string;
+                    imageUrl?: string;
+                    actions: Array<{
+                        action: 'postback' | 'url' | 'say';
+                        label: string;
+                        value: string;
+                    }>;
+                    type: 'card';
+                } | {
+                    items: Array<{
+                        title: string;
+                        subtitle?: string;
+                        imageUrl?: string;
+                        actions: Array<{
+                            action: 'postback' | 'url' | 'say';
+                            label: string;
+                            value: string;
+                        }>;
+                    }>;
+                    type: 'carousel';
+                } | {
+                    text: string;
+                    options: Array<{
+                        label: string;
+                        value: string;
+                    }>;
+                    disableFreeText?: boolean;
+                    type: 'choice';
+                } | {
+                    text: string;
+                    options: Array<{
+                        label: string;
+                        value: string;
+                    }>;
+                    disableFreeText?: boolean;
+                    type: 'dropdown';
+                } | {
+                    fileUrl: string;
+                    title?: string;
+                    type: 'file';
+                } | {
+                    imageUrl: string;
+                    type: 'image';
+                } | {
+                    latitude: number;
+                    longitude: number;
+                    address?: string;
+                    title?: string;
+                    type: 'location';
+                } | {
+                    text: string;
+                    value?: string;
+                    type: 'text';
+                } | {
+                    videoUrl: string;
+                    type: 'video';
+                } | {
+                    items: Array<{
+                        type: 'text';
+                        payload: {
+                            text: string;
+                            value?: string;
+                        };
+                    } | {
+                        type: 'markdown';
+                        payload: {
+                            markdown: string;
+                        };
+                    } | {
+                        type: 'image';
+                        payload: {
+                            imageUrl: string;
+                        };
+                    } | {
+                        type: 'audio';
+                        payload: {
+                            audioUrl: string;
+                        };
+                    } | {
+                        type: 'video';
+                        payload: {
+                            videoUrl: string;
+                        };
+                    } | {
+                        type: 'file';
+                        payload: {
+                            fileUrl: string;
+                            title?: string;
+                        };
+                    } | {
+                        type: 'location';
+                        payload: {
+                            latitude: number;
+                            longitude: number;
+                            address?: string;
+                            title?: string;
+                        };
+                    }>;
+                    type: 'bloc';
+                } | {
+                    markdown: string;
+                    type: 'markdown';
+                } | {
+                    url: string;
+                    name: string;
+                    data?: unknown;
+                    type: 'custom';
+                };
+                /**
+                 * ID of the [User](#schema_user)
+                 */
+                userId: string;
+                /**
+                 * ID of the [Conversation](#schema_conversation)
+                 */
+                conversationId: string;
+                /**
+                 * Metadata of the message
+                 */
+                metadata?: {};
+                /**
+                 * ID of the message this message is replying to
+                 */
+                replyTo?: string;
+                /**
+                 * ID of the user who selected this message. Undefined if not selected.
+                 */
+                selectedBy?: string;
+                /**
+                 * Feedback of the message
+                 */
+                feedback?: {
+                    value: 'positive' | 'negative';
+                    comment?: string;
+                };
+            };
         }>;
         meta: {
             /**
@@ -1758,6 +2340,162 @@ export declare type ListConversationsResponses = {
              * Updating date of the [Conversation](#schema_conversation) in ISO 8601 format
              */
             updatedAt: string;
+            /**
+             * The last [Message](#schema_message) sent in the [Conversation](#schema_conversation)
+             */
+            lastMessage?: {
+                /**
+                 * 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 of the message.
+                 */
+                payload: {
+                    audioUrl: string;
+                    type: 'audio';
+                } | {
+                    title: string;
+                    subtitle?: string;
+                    imageUrl?: string;
+                    actions: Array<{
+                        action: 'postback' | 'url' | 'say';
+                        label: string;
+                        value: string;
+                    }>;
+                    type: 'card';
+                } | {
+                    items: Array<{
+                        title: string;
+                        subtitle?: string;
+                        imageUrl?: string;
+                        actions: Array<{
+                            action: 'postback' | 'url' | 'say';
+                            label: string;
+                            value: string;
+                        }>;
+                    }>;
+                    type: 'carousel';
+                } | {
+                    text: string;
+                    options: Array<{
+                        label: string;
+                        value: string;
+                    }>;
+                    disableFreeText?: boolean;
+                    type: 'choice';
+                } | {
+                    text: string;
+                    options: Array<{
+                        label: string;
+                        value: string;
+                    }>;
+                    disableFreeText?: boolean;
+                    type: 'dropdown';
+                } | {
+                    fileUrl: string;
+                    title?: string;
+                    type: 'file';
+                } | {
+                    imageUrl: string;
+                    type: 'image';
+                } | {
+                    latitude: number;
+                    longitude: number;
+                    address?: string;
+                    title?: string;
+                    type: 'location';
+                } | {
+                    text: string;
+                    value?: string;
+                    type: 'text';
+                } | {
+                    videoUrl: string;
+                    type: 'video';
+                } | {
+                    items: Array<{
+                        type: 'text';
+                        payload: {
+                            text: string;
+                            value?: string;
+                        };
+                    } | {
+                        type: 'markdown';
+                        payload: {
+                            markdown: string;
+                        };
+                    } | {
+                        type: 'image';
+                        payload: {
+                            imageUrl: string;
+                        };
+                    } | {
+                        type: 'audio';
+                        payload: {
+                            audioUrl: string;
+                        };
+                    } | {
+                        type: 'video';
+                        payload: {
+                            videoUrl: string;
+                        };
+                    } | {
+                        type: 'file';
+                        payload: {
+                            fileUrl: string;
+                            title?: string;
+                        };
+                    } | {
+                        type: 'location';
+                        payload: {
+                            latitude: number;
+                            longitude: number;
+                            address?: string;
+                            title?: string;
+                        };
+                    }>;
+                    type: 'bloc';
+                } | {
+                    markdown: string;
+                    type: 'markdown';
+                } | {
+                    url: string;
+                    name: string;
+                    data?: unknown;
+                    type: 'custom';
+                };
+                /**
+                 * ID of the [User](#schema_user)
+                 */
+                userId: string;
+                /**
+                 * ID of the [Conversation](#schema_conversation)
+                 */
+                conversationId: string;
+                /**
+                 * Metadata of the message
+                 */
+                metadata?: {};
+                /**
+                 * ID of the message this message is replying to
+                 */
+                replyTo?: string;
+                /**
+                 * ID of the user who selected this message. Undefined if not selected.
+                 */
+                selectedBy?: string;
+                /**
+                 * Feedback of the message
+                 */
+                feedback?: {
+                    value: 'positive' | 'negative';
+                    comment?: string;
+                };
+            };
         }>;
         meta: {
             /**
@@ -2689,6 +3427,12 @@ declare type ParticipantRemoved = {
     };
 };
 
+export declare type Perf = {
+    duration: number;
+    event: string;
+    properties: {};
+};
+
 declare type QuerySerializer = (query: Record<string, unknown>) => string;
 
 declare interface QuerySerializerOptions {
@@ -2897,6 +3641,60 @@ export declare type SelectMessageResponses = {
     };
 };
 
+export declare const sendPerfMetrics: (clientId: string, body: ClientTypes_2.SendPerfMetricsBody, apiUrl?: string, customHeaders?: Record<string, string>) => Promise<{
+    [key: string]: never;
+}>;
+
+/**
+ * Sends performance metrics to the server.
+ */
+declare const sendPerfMetrics_2: <ThrowOnError extends boolean = false>(options?: Options<SendPerfMetricsData, ThrowOnError>) => RequestResult<{
+    [key: string]: never;
+}, {
+    [key: string]: never;
+}, ThrowOnError>;
+
+/**
+ * Performance metrics
+ */
+export declare type SendPerfMetricsBody = {
+    duration: number;
+    event: string;
+    properties: {};
+};
+
+export declare type SendPerfMetricsData = {
+    /**
+     * Performance metrics
+     */
+    body?: SendPerfMetricsBody;
+    path?: never;
+    query?: never;
+    url: '/p';
+};
+
+export declare type SendPerfMetricsError = SendPerfMetricsErrors[keyof SendPerfMetricsErrors];
+
+export declare type SendPerfMetricsErrors = {
+    /**
+     * Returns nothing
+     */
+    default: {
+        [key: string]: never;
+    };
+};
+
+export declare type SendPerfMetricsResponse = SendPerfMetricsResponses[keyof SendPerfMetricsResponses];
+
+export declare type SendPerfMetricsResponses = {
+    /**
+     * Returns nothing
+     */
+    200: {
+        [key: string]: never;
+    };
+};
+
 declare interface SerializerOptions<T> {
     /**
      * @default true