@botpress/webchat 1.3.2 → 1.3.4

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

@@ -0,0 +1,36 @@
+export interface GetConversationRequestHeaders {
+    "x-user-key": string;
+}
+export interface GetConversationRequestQuery {
+}
+export interface GetConversationRequestParams {
+    id: string;
+}
+export interface GetConversationRequestBody {
+}
+export type GetConversationInput = GetConversationRequestBody & GetConversationRequestHeaders & GetConversationRequestQuery & GetConversationRequestParams;
+export type GetConversationRequest = {
+    headers: GetConversationRequestHeaders;
+    query: GetConversationRequestQuery;
+    params: GetConversationRequestParams;
+    body: GetConversationRequestBody;
+};
+export declare const parseReq: (input: GetConversationInput) => GetConversationRequest & {
+    path: string;
+};
+export interface GetConversationResponse {
+    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/getEvent.d.ts

@@ -0,0 +1,58 @@
+export interface GetEventRequestHeaders {
+    "x-user-key": string;
+}
+export interface GetEventRequestQuery {
+}
+export interface GetEventRequestParams {
+    id: string;
+}
+export interface GetEventRequestBody {
+}
+export type GetEventInput = GetEventRequestBody & GetEventRequestHeaders & GetEventRequestQuery & GetEventRequestParams;
+export type GetEventRequest = {
+    headers: GetEventRequestHeaders;
+    query: GetEventRequestQuery;
+    params: GetEventRequestParams;
+    body: GetEventRequestBody;
+};
+export declare const parseReq: (input: GetEventInput) => GetEventRequest & {
+    path: string;
+};
+export interface GetEventResponse {
+    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/getMessage.d.ts

@@ -0,0 +1,157 @@
+export interface GetMessageRequestHeaders {
+    "x-user-key": string;
+}
+export interface GetMessageRequestQuery {
+}
+export interface GetMessageRequestParams {
+    id: string;
+}
+export interface GetMessageRequestBody {
+}
+export type GetMessageInput = GetMessageRequestBody & GetMessageRequestHeaders & GetMessageRequestQuery & GetMessageRequestParams;
+export type GetMessageRequest = {
+    headers: GetMessageRequestHeaders;
+    query: GetMessageRequestQuery;
+    params: GetMessageRequestParams;
+    body: GetMessageRequestBody;
+};
+export declare const parseReq: (input: GetMessageInput) => GetMessageRequest & {
+    path: string;
+};
+export interface GetMessageResponse {
+    /**
+     * 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/getParticipant.d.ts

@@ -0,0 +1,48 @@
+export interface GetParticipantRequestHeaders {
+    "x-user-key": string;
+}
+export interface GetParticipantRequestQuery {
+}
+export interface GetParticipantRequestParams {
+    id: string;
+    userId: string;
+}
+export interface GetParticipantRequestBody {
+}
+export type GetParticipantInput = GetParticipantRequestBody & GetParticipantRequestHeaders & GetParticipantRequestQuery & GetParticipantRequestParams;
+export type GetParticipantRequest = {
+    headers: GetParticipantRequestHeaders;
+    query: GetParticipantRequestQuery;
+    params: GetParticipantRequestParams;
+    body: GetParticipantRequestBody;
+};
+export declare const parseReq: (input: GetParticipantInput) => GetParticipantRequest & {
+    path: string;
+};
+export interface GetParticipantResponse {
+    /**
+     * 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/getUser.d.ts

@@ -0,0 +1,46 @@
+export interface GetUserRequestHeaders {
+    "x-user-key": string;
+}
+export interface GetUserRequestQuery {
+}
+export interface GetUserRequestParams {
+}
+export interface GetUserRequestBody {
+}
+export type GetUserInput = GetUserRequestBody & GetUserRequestHeaders & GetUserRequestQuery & GetUserRequestParams;
+export type GetUserRequest = {
+    headers: GetUserRequestHeaders;
+    query: GetUserRequestQuery;
+    params: GetUserRequestParams;
+    body: GetUserRequestBody;
+};
+export declare const parseReq: (input: GetUserInput) => GetUserRequest & {
+    path: string;
+};
+export interface GetUserResponse {
+    /**
+     * 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;
+    };
+}

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

@@ -0,0 +1,161 @@
+export interface ListConversationMessagesRequestHeaders {
+    "x-user-key": string;
+}
+export interface ListConversationMessagesRequestQuery {
+    nextToken?: string;
+}
+export interface ListConversationMessagesRequestParams {
+    id: string;
+}
+export interface ListConversationMessagesRequestBody {
+}
+export type ListConversationMessagesInput = ListConversationMessagesRequestBody & ListConversationMessagesRequestHeaders & ListConversationMessagesRequestQuery & ListConversationMessagesRequestParams;
+export type ListConversationMessagesRequest = {
+    headers: ListConversationMessagesRequestHeaders;
+    query: ListConversationMessagesRequestQuery;
+    params: ListConversationMessagesRequestParams;
+    body: ListConversationMessagesRequestBody;
+};
+export declare const parseReq: (input: ListConversationMessagesInput) => ListConversationMessagesRequest & {
+    path: string;
+};
+export interface ListConversationMessagesResponse {
+    messages: {
+        /**
+         * 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;
+    }[];
+    meta: {
+        /**
+         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
+         */
+        nextToken?: string;
+    };
+}

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

@@ -0,0 +1,42 @@
+export interface ListConversationsRequestHeaders {
+    "x-user-key": string;
+}
+export interface ListConversationsRequestQuery {
+    nextToken?: string;
+}
+export interface ListConversationsRequestParams {
+}
+export interface ListConversationsRequestBody {
+}
+export type ListConversationsInput = ListConversationsRequestBody & ListConversationsRequestHeaders & ListConversationsRequestQuery & ListConversationsRequestParams;
+export type ListConversationsRequest = {
+    headers: ListConversationsRequestHeaders;
+    query: ListConversationsRequestQuery;
+    params: ListConversationsRequestParams;
+    body: ListConversationsRequestBody;
+};
+export declare const parseReq: (input: ListConversationsInput) => ListConversationsRequest & {
+    path: string;
+};
+export interface ListConversationsResponse {
+    conversations: {
+        /**
+         * 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;
+    }[];
+    meta: {
+        /**
+         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
+         */
+        nextToken?: string;
+    };
+}

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

@@ -0,0 +1,51 @@
+export interface ListParticipantsRequestHeaders {
+    "x-user-key": string;
+}
+export interface ListParticipantsRequestQuery {
+    nextToken?: string;
+}
+export interface ListParticipantsRequestParams {
+    id: string;
+}
+export interface ListParticipantsRequestBody {
+}
+export type ListParticipantsInput = ListParticipantsRequestBody & ListParticipantsRequestHeaders & ListParticipantsRequestQuery & ListParticipantsRequestParams;
+export type ListParticipantsRequest = {
+    headers: ListParticipantsRequestHeaders;
+    query: ListParticipantsRequestQuery;
+    params: ListParticipantsRequestParams;
+    body: ListParticipantsRequestBody;
+};
+export declare const parseReq: (input: ListParticipantsInput) => ListParticipantsRequest & {
+    path: string;
+};
+export interface ListParticipantsResponse {
+    participants: {
+        /**
+         * 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;
+    }[];
+    meta: {
+        /**
+         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
+         */
+        nextToken?: string;
+    };
+}

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

@@ -0,0 +1,22 @@
+export interface ListenConversationRequestHeaders {
+    "x-user-key": string;
+}
+export interface ListenConversationRequestQuery {
+}
+export interface ListenConversationRequestParams {
+    id: string;
+}
+export interface ListenConversationRequestBody {
+}
+export type ListenConversationInput = ListenConversationRequestBody & ListenConversationRequestHeaders & ListenConversationRequestQuery & ListenConversationRequestParams;
+export type ListenConversationRequest = {
+    headers: ListenConversationRequestHeaders;
+    query: ListenConversationRequestQuery;
+    params: ListenConversationRequestParams;
+    body: ListenConversationRequestBody;
+};
+export declare const parseReq: (input: ListenConversationInput) => ListenConversationRequest & {
+    path: string;
+};
+export interface ListenConversationResponse {
+}

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

@@ -0,0 +1,23 @@
+export interface RemoveParticipantRequestHeaders {
+    "x-user-key": string;
+}
+export interface RemoveParticipantRequestQuery {
+}
+export interface RemoveParticipantRequestParams {
+    id: string;
+    userId: string;
+}
+export interface RemoveParticipantRequestBody {
+}
+export type RemoveParticipantInput = RemoveParticipantRequestBody & RemoveParticipantRequestHeaders & RemoveParticipantRequestQuery & RemoveParticipantRequestParams;
+export type RemoveParticipantRequest = {
+    headers: RemoveParticipantRequestHeaders;
+    query: RemoveParticipantRequestQuery;
+    params: RemoveParticipantRequestParams;
+    body: RemoveParticipantRequestBody;
+};
+export declare const parseReq: (input: RemoveParticipantInput) => RemoveParticipantRequest & {
+    path: string;
+};
+export interface RemoveParticipantResponse {
+}