@botpress/client 0.23.1 → 0.24.0

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

@@ -1,487 +0,0 @@
-export interface CreateBotRequestHeaders {
-}
-export interface CreateBotRequestQuery {
-}
-export interface CreateBotRequestParams {
-}
-export interface CreateBotRequestBody {
-    /**
-     * 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;
-        };
-    };
-    /**
-     * Events definition
-     */
-    events?: {
-        /**
-         * Event Definition
-         */
-        [k: string]: {
-            /**
-             * Title of the event
-             */
-            title?: string;
-            /**
-             * Description of the event
-             */
-            description?: string;
-            schema: {
-                [k: string]: any;
-            };
-        };
-    };
-    recurringEvents?: {
-        [k: string]: {
-            schedule: {
-                cron: string;
-            };
-            type: string;
-            payload: {
-                [k: string]: any;
-            };
-        };
-    };
-    /**
-     * 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;
-                };
-            };
-        };
-    };
-    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;
-        };
-    };
-    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?: {
-        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?: {
-        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;
-            };
-        };
-    };
-    /**
-     * 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;
-    }[];
-    /**
-     * URL of the [Bot](#schema_bot); Only available for dev bots
-     */
-    url?: string;
-    /**
-     * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
-     */
-    dev?: boolean;
-}
-export type CreateBotInput = CreateBotRequestBody & CreateBotRequestHeaders & CreateBotRequestQuery & CreateBotRequestParams;
-export type CreateBotRequest = {
-    headers: CreateBotRequestHeaders;
-    query: CreateBotRequestQuery;
-    params: CreateBotRequestParams;
-    body: CreateBotRequestBody;
-};
-export declare const parseReq: (input: CreateBotInput) => CreateBotRequest & {
-    path: string;
-};
-export interface CreateBotResponse {
-    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/createConversation.d.ts

@@ -1,70 +0,0 @@
-export interface CreateConversationRequestHeaders {
-}
-export interface CreateConversationRequestQuery {
-}
-export interface CreateConversationRequestParams {
-}
-export interface CreateConversationRequestBody {
-    /**
-     * Channel name
-     */
-    channel: string;
-    /**
-     * Tags for the [Conversation](#schema_conversation)
-     */
-    tags: {
-        [k: string]: string;
-    };
-    /**
-     * @deprecated
-     * [DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.
-     */
-    integrationName?: 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 {
-    /**
-     * 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/createEvent.d.ts

@@ -1,95 +0,0 @@
-export interface CreateEventRequestHeaders {
-}
-export interface CreateEventRequestQuery {
-}
-export interface CreateEventRequestParams {
-}
-export interface CreateEventRequestBody {
-    /**
-     * Type of the [Event](#schema_event).
-     */
-    type: string;
-    /**
-     * Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our API.
-     */
-    payload: {
-        [k: string]: any;
-    };
-    /**
-     * Schedule the Event to be sent at a specific time. Either dateTime or delay must be provided.
-     */
-    schedule?: {
-        /**
-         * When the [Event](#schema_event) will be sent, in the ISO 8601 format
-         */
-        dateTime?: string;
-        /**
-         * Delay in milliseconds before sending the [Event](#schema_event)
-         */
-        delay?: number;
-    };
-    /**
-     * ID of the [Conversation](#schema_conversation) to link the event to.
-     */
-    conversationId?: string;
-    /**
-     * ID of the [User](#schema_user) to link the event to.
-     */
-    userId?: string;
-    /**
-     * ID of the [Message](#schema_message) to link the event to.
-     */
-    messageId?: 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 {
-    /**
-     * The event object represents an action or an occurrence.
-     */
-    event: {
-        /**
-         * Id of the [Event](#schema_event)
-         */
-        id: string;
-        /**
-         * Creation date of the [Event](#schema_event) in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * Type of the [Event](#schema_event).
-         */
-        type: string;
-        /**
-         * Payload is the content of the event defined by the integration installed on your bot or one of the default events created by our api.
-         */
-        payload: {
-            [k: string]: any;
-        };
-        /**
-         * ID of the [Conversation](#schema_conversation) to link the event to.
-         */
-        conversationId?: string;
-        /**
-         * ID of the [User](#schema_user) to link the event to.
-         */
-        userId?: string;
-        /**
-         * ID of the [Message](#schema_message) to link the event to.
-         */
-        messageId?: string;
-        status: "pending" | "processed" | "ignored" | "failed";
-        /**
-         * Reason why the event failed to be processed
-         */
-        failureReason: string | null;
-    };
-}