@botpress/client 0.23.1 → 0.24.0

package/dist/gen/operations/updateBot.d.ts

@@ -1,486 +0,0 @@
-export interface UpdateBotRequestHeaders {
-}
-export interface UpdateBotRequestQuery {
-}
-export interface UpdateBotRequestParams {
-    id: string;
-}
-export interface UpdateBotRequestBody {
-    /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
-     */
-    url?: string;
-    /**
-     * Type of the [Bot](#schema_bot) authentication (`iam`)
-     */
-    authentication?: "iam";
-    configuration?: {
-        /**
-         * Configuration data
-         */
-        data?: {
-            [k: string]: any;
-        };
-        /**
-         * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
-         */
-        schema?: {
-            [k: string]: any;
-        };
-    };
-    blocked?: boolean;
-    /**
-     * Indicates if the [Bot](#schema_bot) should be in always alive mode
-     */
-    alwaysAlive?: boolean;
-    user?: {
-        tags?: {
-            /**
-             * Definition of a tag that can be provided on the object
-             */
-            [k: string]: {
-                /**
-                 * Title of the tag
-                 */
-                title?: string;
-                /**
-                 * Description of the tag
-                 */
-                description?: string;
-            } | null;
-        };
-    };
-    message?: {
-        tags?: {
-            /**
-             * Definition of a tag that can be provided on the object
-             */
-            [k: string]: {
-                /**
-                 * Title of the tag
-                 */
-                title?: string;
-                /**
-                 * Description of the tag
-                 */
-                description?: string;
-            } | null;
-        };
-    };
-    conversation?: {
-        tags?: {
-            /**
-             * Definition of a tag that can be provided on the object
-             */
-            [k: string]: {
-                /**
-                 * Title of the tag
-                 */
-                title?: string;
-                /**
-                 * Description of the tag
-                 */
-                description?: string;
-            } | null;
-        };
-    };
-    events?: {
-        /**
-         * Event Definition
-         */
-        [k: string]: {
-            /**
-             * Title of the event
-             */
-            title?: string;
-            /**
-             * Description of the event
-             */
-            description?: string;
-            schema: {
-                [k: string]: any;
-            };
-        } | null;
-    };
-    actions?: {
-        /**
-         * Action definition
-         */
-        [k: string]: {
-            /**
-             * Title of the action
-             */
-            title?: string;
-            /**
-             * Description of the action
-             */
-            description?: string;
-            input: {
-                schema: {
-                    [k: string]: any;
-                };
-            };
-            output: {
-                schema: {
-                    [k: string]: any;
-                };
-            };
-        } | null;
-    };
-    states?: {
-        [k: string]: {
-            /**
-             * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
-             */
-            type: "conversation" | "user" | "bot" | "task";
-            /**
-             * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
-             */
-            schema: {
-                [k: string]: any;
-            };
-            /**
-             * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
-             */
-            expiry?: number;
-        } | null;
-    };
-    recurringEvents?: {
-        [k: string]: {
-            schedule: {
-                cron: string;
-            };
-            type: string;
-            payload: {
-                [k: string]: any;
-            };
-        } | null;
-    };
-    integrations?: {
-        [k: string]: {
-            enabled?: boolean;
-            configuration?: {
-                [k: string]: any;
-            };
-        } | null;
-    };
-    subscriptions?: {
-        events: {
-            [k: string]: {} | null;
-        } | null;
-    };
-    /**
-     * JavaScript code of the bot
-     */
-    code?: string;
-    /**
-     * Optional name for the bot, if not provided will be auto-generated
-     */
-    name?: string;
-    /**
-     * Media files associated with the [Bot](#schema_bot)
-     */
-    medias?: {
-        url: string;
-        name: string;
-    }[];
-}
-export type UpdateBotInput = UpdateBotRequestBody & UpdateBotRequestHeaders & UpdateBotRequestQuery & UpdateBotRequestParams;
-export type UpdateBotRequest = {
-    headers: UpdateBotRequestHeaders;
-    query: UpdateBotRequestQuery;
-    params: UpdateBotRequestParams;
-    body: UpdateBotRequestBody;
-};
-export declare const parseReq: (input: UpdateBotInput) => UpdateBotRequest & {
-    path: string;
-};
-export interface UpdateBotResponse {
-    bot: {
-        /**
-         * Id of the [Bot](#schema_bot)
-         */
-        id: string;
-        /**
-         * Creation date of the [Bot](#schema_bot) in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * Updating date of the [Bot](#schema_bot) in ISO 8601 format
-         */
-        updatedAt: string;
-        /**
-         * Signing secret of the [Bot](#schema_bot)
-         */
-        signingSecret: string;
-        /**
-         * A mapping of integrations to their configuration
-         */
-        integrations: {
-            [k: string]: {
-                enabled: boolean;
-                /**
-                 * Name of the [Integration](#schema_integration)
-                 */
-                name: string;
-                /**
-                 * Version of the [Integration](#schema_integration)
-                 */
-                version: string;
-                webhookUrl: string;
-                webhookId: string;
-                identifier?: string;
-                configuration: {
-                    [k: string]: any;
-                };
-                status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
-                statusReason: string | null;
-                /**
-                 * ID of the [Integration](#schema_integration)
-                 */
-                id: string;
-                /**
-                 * Creation date of the [Integration](#schema_integration) in ISO 8601 format
-                 */
-                createdAt: string;
-                /**
-                 * Updating date of the [Integration](#schema_integration) in ISO 8601 format
-                 */
-                updatedAt: string;
-                /**
-                 * Title of the integration. This is the name that will be displayed in the UI
-                 */
-                title: string;
-                /**
-                 * Description of the integration. This is the description that will be displayed in the UI
-                 */
-                description: string;
-                /**
-                 * URL of the icon of the integration. This is the icon that will be displayed in the UI
-                 */
-                iconUrl: string;
-                /**
-                 * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
-                 */
-                public: boolean;
-            };
-        };
-        /**
-         * User object configuration
-         */
-        user: {
-            tags: {
-                /**
-                 * Definition of a tag that can be provided on the object
-                 */
-                [k: string]: {
-                    /**
-                     * Title of the tag
-                     */
-                    title?: string;
-                    /**
-                     * Description of the tag
-                     */
-                    description?: string;
-                };
-            };
-        };
-        /**
-         * Conversation object configuration
-         */
-        conversation: {
-            tags: {
-                /**
-                 * Definition of a tag that can be provided on the object
-                 */
-                [k: string]: {
-                    /**
-                     * Title of the tag
-                     */
-                    title?: string;
-                    /**
-                     * Description of the tag
-                     */
-                    description?: string;
-                };
-            };
-        };
-        /**
-         * Message object configuration
-         */
-        message: {
-            tags: {
-                /**
-                 * Definition of a tag that can be provided on the object
-                 */
-                [k: string]: {
-                    /**
-                     * Title of the tag
-                     */
-                    title?: string;
-                    /**
-                     * Description of the tag
-                     */
-                    description?: string;
-                };
-            };
-        };
-        /**
-         * A mapping of states to their definition
-         */
-        states: {
-            [k: string]: {
-                /**
-                 * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
-                 */
-                type: "conversation" | "user" | "bot" | "task";
-                /**
-                 * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
-                 */
-                schema: {
-                    [k: string]: any;
-                };
-                /**
-                 * Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire.
-                 */
-                expiry?: number;
-            };
-        };
-        /**
-         * Configuration of the bot
-         */
-        configuration: {
-            /**
-             * Configuration data
-             */
-            data: {
-                [k: string]: any;
-            };
-            /**
-             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
-             */
-            schema: {
-                [k: string]: any;
-            };
-        };
-        /**
-         * Events definition
-         */
-        events: {
-            /**
-             * Event Definition
-             */
-            [k: string]: {
-                /**
-                 * Title of the event
-                 */
-                title?: string;
-                /**
-                 * Description of the event
-                 */
-                description?: string;
-                schema: {
-                    [k: string]: any;
-                };
-            };
-        };
-        /**
-         * Recurring events
-         */
-        recurringEvents: {
-            [k: string]: {
-                schedule: {
-                    cron: string;
-                };
-                type: string;
-                payload: {
-                    [k: string]: any;
-                };
-                /**
-                 * The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
-                 */
-                failedAttempts: number;
-                /**
-                 * The reason why the recurring event failed to run in the last attempt.
-                 */
-                lastFailureReason: string | null;
-            };
-        };
-        /**
-         * Subscriptions of the bot
-         */
-        subscriptions: {
-            /**
-             * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
-             */
-            events: {
-                [k: string]: {};
-            } | null;
-        };
-        /**
-         * Actions definition
-         */
-        actions: {
-            /**
-             * Action definition
-             */
-            [k: string]: {
-                /**
-                 * Title of the action
-                 */
-                title?: string;
-                /**
-                 * Description of the action
-                 */
-                description?: string;
-                input: {
-                    schema: {
-                        [k: string]: any;
-                    };
-                };
-                output: {
-                    schema: {
-                        [k: string]: any;
-                    };
-                };
-            };
-        };
-        /**
-         * Name of the [Bot](#schema_bot)
-         */
-        name: string;
-        /**
-         * Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
-         */
-        deployedAt?: string;
-        /**
-         * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
-         */
-        dev: boolean;
-        /**
-         * Id of the user that created the bot
-         */
-        createdBy?: string;
-        /**
-         * Indicates if the [Bot](#schema_bot) should be in always alive mode
-         */
-        alwaysAlive: boolean;
-        /**
-         * Status of the bot
-         */
-        status: "active" | "deploying";
-        /**
-         * Media files associated with the [Bot](#schema_bot)
-         */
-        medias: {
-            /**
-             * URL of the media file
-             */
-            url: string;
-            /**
-             * Name of the media file
-             */
-            name: string;
-        }[];
-    };
-}

package/dist/gen/operations/updateConversation.d.ts

@@ -1,63 +0,0 @@
-export interface UpdateConversationRequestHeaders {
-}
-export interface UpdateConversationRequestQuery {
-}
-export interface UpdateConversationRequestParams {
-    id: string;
-}
-export interface UpdateConversationRequestBody {
-    currentTaskId?: string;
-    /**
-     * Tags for the [Conversation](#schema_conversation)
-     */
-    tags?: {
-        [k: string]: string;
-    };
-}
-export type UpdateConversationInput = UpdateConversationRequestBody & UpdateConversationRequestHeaders & UpdateConversationRequestQuery & UpdateConversationRequestParams;
-export type UpdateConversationRequest = {
-    headers: UpdateConversationRequestHeaders;
-    query: UpdateConversationRequestQuery;
-    params: UpdateConversationRequestParams;
-    body: UpdateConversationRequestBody;
-};
-export declare const parseReq: (input: UpdateConversationInput) => UpdateConversationRequest & {
-    path: string;
-};
-export interface UpdateConversationResponse {
-    /**
-     * The conversation object represents an exchange of messages between one or more users. A [Conversation](#schema_conversation) is always linked to an integration's channels. For example, a Slack channel represents a conversation.
-     */
-    conversation: {
-        /**
-         * Id of the [Conversation](#schema_conversation)
-         */
-        id: string;
-        /**
-         * Id of the current [Task](#schema_task)
-         */
-        currentTaskId?: 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;
-        /**
-         * Name of the channel where the [Conversation](#schema_conversation) is happening
-         */
-        channel: string;
-        /**
-         * Name of the integration that created the [Conversation](#schema_conversation)
-         */
-        integration: string;
-        /**
-         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.
-         */
-        tags: {
-            [k: string]: string;
-        };
-    };
-}

package/dist/gen/operations/updateFileMetadata.d.ts

@@ -1,95 +0,0 @@
-export interface UpdateFileMetadataRequestHeaders {
-}
-export interface UpdateFileMetadataRequestQuery {
-}
-export interface UpdateFileMetadataRequestParams {
-    id: string;
-}
-export interface UpdateFileMetadataRequestBody {
-    /**
-     * The file tags to update as an object of key-value pairs with `string` (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`.
-     */
-    tags?: {
-        [k: string]: string | null;
-    };
-    /**
-     * New access policies to set for the file. Omit to keep existing policies intact.
-     */
-    accessPolicies?: ("integrations" | "public_content")[];
-}
-export type UpdateFileMetadataInput = UpdateFileMetadataRequestBody & UpdateFileMetadataRequestHeaders & UpdateFileMetadataRequestQuery & UpdateFileMetadataRequestParams;
-export type UpdateFileMetadataRequest = {
-    headers: UpdateFileMetadataRequestHeaders;
-    query: UpdateFileMetadataRequestQuery;
-    params: UpdateFileMetadataRequestParams;
-    body: UpdateFileMetadataRequestBody;
-};
-export declare const parseReq: (input: UpdateFileMetadataInput) => UpdateFileMetadataRequest & {
-    path: string;
-};
-export interface UpdateFileMetadataResponse {
-    file: {
-        /**
-         * File ID
-         */
-        id: string;
-        /**
-         * The ID of the bot the file belongs to
-         */
-        botId: string;
-        /**
-         * Unique key for the file. Must be unique across the bot (and the integration, when applicable).
-         */
-        key: string;
-        /**
-         * URL to retrieve the file content. This URL will be ready to use once the file is uploaded.
-         *
-         * If the file has a `public_content` policy, this will contain the permanent public URL to retrieve the file, otherwise this will contain a temporary pre-signed URL to download the file which should be used shortly after retrieving and should not be stored long-term as the URL will expire after a short timeframe.
-         */
-        url: string;
-        /**
-         * File size in bytes. Non-null if file upload status is "COMPLETE".
-         */
-        size: number | null;
-        /**
-         * MIME type of the file's content
-         */
-        contentType: string;
-        /**
-         * The tags of the file as an object of key/value pairs
-         */
-        tags: {
-            [k: string]: string;
-        };
-        /**
-         * File creation timestamp in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * File last update timestamp in ISO 8601 format
-         */
-        updatedAt: string;
-        /**
-         * Access policies configured for the file.
-         */
-        accessPolicies: ("integrations" | "public_content")[];
-        /**
-         * Whether the file was requested to be indexed for search or not.
-         */
-        index: boolean;
-        /**
-         * Status of the file. If the status is `upload_pending`, the file content has not been uploaded yet. The status will be set to `upload_completed` once the file content has been uploaded successfully.
-         *
-         * If the upload failed for any reason (e.g. exceeding the storage quota or the maximum file size limit) the status will be set to `upload_failed` and the reason for the failure will be available in the `failedStatusReason` field of the file.
-         *
-         * However, if the file has been uploaded and the `index` attribute was set to `true` on the file, the status will immediately transition to the `indexing_pending` status (the `upload_completed` status step will be skipped).
-         *
-         * Once the indexing is completed and the file is ready to be used for searching its status will be set to `indexing_completed`. If the indexing failed the status will be set to `indexing_failed` and the reason for the failure will be available in the `failedStatusReason` field.
-         */
-        status: "upload_pending" | "upload_failed" | "upload_completed" | "indexing_pending" | "indexing_failed" | "indexing_completed";
-        /**
-         * If the file status is `upload_failed` or `indexing_failed` this will contain the reason of the failure.
-         */
-        failedStatusReason?: string;
-    };
-}