@botpress/client 0.23.1 → 0.24.0

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

@@ -1,56 +0,0 @@
-export interface GetConversationRequestHeaders {
-}
-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 {
-    /**
-     * 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/getEvent.d.ts

@@ -1,61 +0,0 @@
-export interface GetEventRequestHeaders {
-}
-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 {
-    /**
-     * 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;
-    };
-}

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

@@ -1,85 +0,0 @@
-export interface GetFileRequestHeaders {
-}
-export interface GetFileRequestQuery {
-}
-export interface GetFileRequestParams {
-    id: string;
-}
-export interface GetFileRequestBody {
-}
-export type GetFileInput = GetFileRequestBody & GetFileRequestHeaders & GetFileRequestQuery & GetFileRequestParams;
-export type GetFileRequest = {
-    headers: GetFileRequestHeaders;
-    query: GetFileRequestQuery;
-    params: GetFileRequestParams;
-    body: GetFileRequestBody;
-};
-export declare const parseReq: (input: GetFileInput) => GetFileRequest & {
-    path: string;
-};
-export interface GetFileResponse {
-    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;
-    };
-}

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

@@ -1,315 +0,0 @@
-export interface GetIntegrationRequestHeaders {
-}
-export interface GetIntegrationRequestQuery {
-}
-export interface GetIntegrationRequestParams {
-    id: string;
-}
-export interface GetIntegrationRequestBody {
-}
-export type GetIntegrationInput = GetIntegrationRequestBody & GetIntegrationRequestHeaders & GetIntegrationRequestQuery & GetIntegrationRequestParams;
-export type GetIntegrationRequest = {
-    headers: GetIntegrationRequestHeaders;
-    query: GetIntegrationRequestQuery;
-    params: GetIntegrationRequestParams;
-    body: GetIntegrationRequestBody;
-};
-export declare const parseReq: (input: GetIntegrationInput) => GetIntegrationRequest & {
-    path: string;
-};
-export interface GetIntegrationResponse {
-    integration: {
-        /**
-         * 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;
-        /**
-         * Global identifier configuration of the [Integration](#schema_integration)
-         */
-        identifier: {
-            /**
-             * VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
-             */
-            fallbackHandlerScript?: string;
-            /**
-             * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
-             */
-            extractScript?: string;
-        };
-        /**
-         * URL of the [Integration](#schema_integration)
-         */
-        url: string;
-        /**
-         * Name of the [Integration](#schema_integration)
-         */
-        name: string;
-        /**
-         * Version of the [Integration](#schema_integration)
-         */
-        version: string;
-        interfaces: {
-            [k: string]: {
-                id: string;
-                entities: {
-                    [k: string]: {
-                        name: string;
-                    };
-                };
-                actions: {
-                    [k: string]: {
-                        name: string;
-                    };
-                };
-                events: {
-                    [k: string]: {
-                        name: string;
-                    };
-                };
-            };
-        };
-        /**
-         * Configuration definition
-         */
-        configuration: {
-            /**
-             * Identifier configuration of the [Integration](#schema_integration)
-             */
-            identifier: {
-                linkTemplateScript?: string;
-                required: boolean;
-            };
-            /**
-             * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
-             */
-            schema?: {
-                [k: string]: any;
-            };
-        };
-        channels: {
-            /**
-             * Channel definition
-             */
-            [k: string]: {
-                /**
-                 * Title of the channel
-                 */
-                title?: string;
-                /**
-                 * Description of the channel
-                 */
-                description?: string;
-                messages: {
-                    /**
-                     * Message definition
-                     */
-                    [k: string]: {
-                        schema: {
-                            [k: string]: any;
-                        };
-                    };
-                };
-                /**
-                 * 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;
-                        };
-                    };
-                    /**
-                     * The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
-                     */
-                    creation: {
-                        /**
-                         * Enable conversation creation
-                         */
-                        enabled: boolean;
-                        /**
-                         * The list of tags that are required to be specified when calling the API directly to create a conversation.
-                         */
-                        requiredTags: 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;
-                        };
-                    };
-                };
-            };
-        };
-        states: {
-            /**
-             * State definition
-             */
-            [k: string]: {
-                /**
-                 * Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
-                 */
-                type: "conversation" | "user" | "integration";
-                /**
-                 * 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;
-                };
-            };
-        };
-        events: {
-            /**
-             * Event Definition
-             */
-            [k: string]: {
-                /**
-                 * Title of the event
-                 */
-                title?: string;
-                /**
-                 * Description of the event
-                 */
-                description?: string;
-                schema: {
-                    [k: string]: any;
-                };
-            };
-        };
-        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;
-                    };
-                };
-            };
-        };
-        /**
-         * 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;
-                };
-            };
-            /**
-             * The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
-             */
-            creation: {
-                /**
-                 * Enable user creation
-                 */
-                enabled: boolean;
-                /**
-                 * The list of tags that are required to be specified when calling the API directly to create a user.
-                 */
-                requiredTags: string[];
-            };
-        };
-        entities: {
-            /**
-             * Entity definition
-             */
-            [k: string]: {
-                /**
-                 * Title of the entity
-                 */
-                title?: string;
-                /**
-                 * Description of the entity
-                 */
-                description?: string;
-                schema: {
-                    [k: string]: any;
-                };
-            };
-        };
-        /**
-         * Indicates if the integration is a development integration; Dev integrations run locally
-         */
-        dev: boolean;
-        /**
-         * 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;
-        /**
-         * URL of the readme of the integration. This is the readme that will be displayed in the UI
-         */
-        readmeUrl: string;
-        /**
-         * Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
-         */
-        public: boolean;
-        /**
-         * Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
-         */
-        secrets: string[];
-    };
-}