@botpress/client 0.23.1 → 0.24.0

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

@@ -1,70 +0,0 @@
-export interface GetOrCreateConversationRequestHeaders {
-}
-export interface GetOrCreateConversationRequestQuery {
-}
-export interface GetOrCreateConversationRequestParams {
-}
-export interface GetOrCreateConversationRequestBody {
-    /**
-     * 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 GetOrCreateConversationInput = GetOrCreateConversationRequestBody & GetOrCreateConversationRequestHeaders & GetOrCreateConversationRequestQuery & GetOrCreateConversationRequestParams;
-export type GetOrCreateConversationRequest = {
-    headers: GetOrCreateConversationRequestHeaders;
-    query: GetOrCreateConversationRequestQuery;
-    params: GetOrCreateConversationRequestParams;
-    body: GetOrCreateConversationRequestBody;
-};
-export declare const parseReq: (input: GetOrCreateConversationInput) => GetOrCreateConversationRequest & {
-    path: string;
-};
-export interface GetOrCreateConversationResponse {
-    /**
-     * 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/getOrCreateMessage.d.ts

@@ -1,98 +0,0 @@
-export interface GetOrCreateMessageRequestHeaders {
-}
-export interface GetOrCreateMessageRequestQuery {
-}
-export interface GetOrCreateMessageRequestParams {
-}
-export interface GetOrCreateMessageRequestBody {
-    /**
-     * Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
-     */
-    payload: {
-        [k: string]: any;
-    };
-    /**
-     * ID of the [User](#schema_user)
-     */
-    userId: string;
-    /**
-     * ID of the [Conversation](#schema_conversation)
-     */
-    conversationId: string;
-    /**
-     * Type of the [Message](#schema_message) represents the resource type that the message is related to
-     */
-    type: string;
-    /**
-     * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) 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;
-    };
-    /**
-     * Schedule the Message to be sent at a specific time. Either dateTime or delay must be provided.
-     */
-    schedule?: {
-        /**
-         * When the [Message](#schema_message) will be sent, in the ISO 8601 format
-         */
-        dateTime?: string;
-        /**
-         * Delay in milliseconds before sending the [Message](#schema_message)
-         */
-        delay?: number;
-    };
-}
-export type GetOrCreateMessageInput = GetOrCreateMessageRequestBody & GetOrCreateMessageRequestHeaders & GetOrCreateMessageRequestQuery & GetOrCreateMessageRequestParams;
-export type GetOrCreateMessageRequest = {
-    headers: GetOrCreateMessageRequestHeaders;
-    query: GetOrCreateMessageRequestQuery;
-    params: GetOrCreateMessageRequestParams;
-    body: GetOrCreateMessageRequestBody;
-};
-export declare const parseReq: (input: GetOrCreateMessageInput) => GetOrCreateMessageRequest & {
-    path: string;
-};
-export interface GetOrCreateMessageResponse {
-    /**
-     * 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;
-        /**
-         * Type of the [Message](#schema_message) represents the resource type that the message is related to
-         */
-        type: string;
-        /**
-         * Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location
-         */
-        payload: {
-            [k: string]: any;
-        };
-        /**
-         * Direction of the message (`incoming` or `outgoing`).
-         */
-        direction: "incoming" | "outgoing";
-        /**
-         * ID of the [User](#schema_user)
-         */
-        userId: string;
-        /**
-         * ID of the [Conversation](#schema_conversation)
-         */
-        conversationId: 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/getOrCreateTable.d.ts

@@ -1,164 +0,0 @@
-export interface GetOrCreateTableRequestHeaders {
-}
-export interface GetOrCreateTableRequestQuery {
-}
-export interface GetOrCreateTableRequestParams {
-    table: string;
-}
-export interface GetOrCreateTableRequestBody {
-    /**
-     * The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.
-     */
-    factor?: number;
-    /**
-     * A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
-     */
-    frozen?: boolean;
-    /**
-     * Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.
-     */
-    schema: {
-        [k: string]: any;
-    };
-    /**
-     * Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
-     */
-    tags?: {
-        [k: string]: string;
-    };
-    /**
-     * Indicates if the table is enabled for computation.
-     */
-    isComputeEnabled?: boolean;
-}
-export type GetOrCreateTableInput = GetOrCreateTableRequestBody & GetOrCreateTableRequestHeaders & GetOrCreateTableRequestQuery & GetOrCreateTableRequestParams;
-export type GetOrCreateTableRequest = {
-    headers: GetOrCreateTableRequestHeaders;
-    query: GetOrCreateTableRequestQuery;
-    params: GetOrCreateTableRequestParams;
-    body: GetOrCreateTableRequestBody;
-};
-export declare const parseReq: (input: GetOrCreateTableInput) => GetOrCreateTableRequest & {
-    path: string;
-};
-export interface GetOrCreateTableResponse {
-    table: {
-        /**
-         * Unique identifier for the table
-         */
-        id: string;
-        /**
-         * Required. This name is used to identify your table.
-         */
-        name: string;
-        /**
-         * The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.
-         */
-        factor?: number;
-        /**
-         * A table designated as "frozen" is immutable in terms of its name and schema structure; modifications to its schema or a renaming operation are not permitted. The only action that can be taken on such a table is deletion. The schema established at the time of creation is locked in as the final structure. To implement any changes, the table must be duplicated with the desired alterations.
-         */
-        frozen?: boolean;
-        schema: {
-            $schema: string;
-            /**
-             * List of keys/columns in the table.
-             */
-            properties: {
-                [k: string]: {
-                    type: "string" | "number" | "boolean" | "object" | "null";
-                    format?: "date-time";
-                    description?: string;
-                    nullable?: boolean;
-                    "x-zui": {
-                        index: number;
-                        /**
-                         * [deprecated] ID of the column.
-                         */
-                        id?: string;
-                        /**
-                         * Indicates if the column is vectorized and searchable.
-                         */
-                        searchable?: boolean;
-                        /**
-                         * Indicates if the field is hidden in the UI
-                         */
-                        hidden?: boolean;
-                        /**
-                         * Order of the column in the UI
-                         */
-                        order?: number;
-                        /**
-                         * Width of the column in the UI
-                         */
-                        width?: number;
-                        computed?: {
-                            action: "ai" | "code";
-                            dependencies?: string[];
-                            /**
-                             * Prompt when action is "ai"
-                             */
-                            prompt?: string;
-                            /**
-                             * Model to use when action is "ai"
-                             */
-                            model?: "gpt-3.5-turbo" | "gpt-3.5-turbo-0125" | "gpt-3.5-turbo-1106" | "gpt-3.5-turbo-16k" | "gpt-4o" | "gpt-4" | "gpt-4-turbo" | "gpt-4-0125-preview" | "gpt-4-1106-preview";
-                            /**
-                             * Code to execute when action is "code"
-                             */
-                            code?: string;
-                            enabled?: boolean;
-                        };
-                        /**
-                         * TypeScript typings for the column. Recommended if the type is "object", ex: "\{ foo: string; bar: number \}"
-                         */
-                        typings?: string;
-                    };
-                };
-            };
-            /**
-             * Additional properties can be provided, but they will be ignored if no column matches.
-             */
-            additionalProperties: true;
-            /**
-             * Array of required properties.
-             */
-            required?: string[];
-            type: "object";
-        };
-        /**
-         * Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.
-         */
-        tags?: {
-            [k: string]: string;
-        };
-        /**
-         * Indicates if the table is enabled for computation.
-         */
-        isComputeEnabled?: boolean;
-        /**
-         * Timestamp of table creation.
-         */
-        createdAt?: string;
-        /**
-         * Timestamp of the last table update.
-         */
-        updatedAt?: string;
-    };
-    /**
-     * Flag indicating if the table was newly created.
-     */
-    created: boolean;
-    /**
-     * The total number of rows present in the table.
-     */
-    rows: number;
-    /**
-     * The number of stale rows that are waiting to be processed
-     */
-    stale: number;
-    /**
-     * The number of rows that are waiting to be indexed (for search)
-     */
-    indexing: number;
-}

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

@@ -1,70 +0,0 @@
-export interface GetOrCreateUserRequestHeaders {
-}
-export interface GetOrCreateUserRequestQuery {
-}
-export interface GetOrCreateUserRequestParams {
-}
-export interface GetOrCreateUserRequestBody {
-    /**
-     * Tags for the [User](#schema_user)
-     */
-    tags: {
-        [k: string]: string;
-    };
-    /**
-     * @deprecated
-     * [DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.
-     */
-    integrationName?: string;
-    /**
-     * Name of the user
-     */
-    name?: string;
-    /**
-     * URI of the user picture
-     */
-    pictureUrl?: string;
-}
-export type GetOrCreateUserInput = GetOrCreateUserRequestBody & GetOrCreateUserRequestHeaders & GetOrCreateUserRequestQuery & GetOrCreateUserRequestParams;
-export type GetOrCreateUserRequest = {
-    headers: GetOrCreateUserRequestHeaders;
-    query: GetOrCreateUserRequestQuery;
-    params: GetOrCreateUserRequestParams;
-    body: GetOrCreateUserRequestBody;
-};
-export declare const parseReq: (input: GetOrCreateUserInput) => GetOrCreateUserRequest & {
-    path: string;
-};
-export interface GetOrCreateUserResponse {
-    /**
-     * 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: {
-        /**
-         * 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;
-        /**
-         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) 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;
-        };
-        /**
-         * Name of the [User](#schema_user)
-         */
-        name?: string;
-        /**
-         * Picture URL of the [User](#schema_user)
-         */
-        pictureUrl?: string;
-    };
-}

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

@@ -1,76 +0,0 @@
-export interface GetOrSetStateRequestHeaders {
-}
-export interface GetOrSetStateRequestQuery {
-}
-export interface GetOrSetStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
-    id: string;
-    name: string;
-}
-export interface GetOrSetStateRequestBody {
-    /**
-     * Payload is the content of the state defined by your bot.
-     */
-    payload: {
-        [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;
-}
-export type GetOrSetStateInput = GetOrSetStateRequestBody & GetOrSetStateRequestHeaders & GetOrSetStateRequestQuery & GetOrSetStateRequestParams;
-export type GetOrSetStateRequest = {
-    headers: GetOrSetStateRequestHeaders;
-    query: GetOrSetStateRequestQuery;
-    params: GetOrSetStateRequestParams;
-    body: GetOrSetStateRequestBody;
-};
-export declare const parseReq: (input: GetOrSetStateInput) => GetOrSetStateRequest & {
-    path: string;
-};
-export interface GetOrSetStateResponse {
-    /**
-     * The state object represents the current payload. A state is always linked to either a bot, a conversation or a user.
-     */
-    state: {
-        /**
-         * Id of the [State](#schema_state)
-         */
-        id: string;
-        /**
-         * Creation date of the [State](#schema_state) in ISO 8601 format
-         */
-        createdAt: string;
-        /**
-         * Updating date of the [State](#schema_state) in ISO 8601 format
-         */
-        updatedAt: string;
-        /**
-         * Id of the [Bot](#schema_bot)
-         */
-        botId: string;
-        /**
-         * Id of the [Conversation](#schema_conversation)
-         */
-        conversationId?: string;
-        /**
-         * Id of the [User](#schema_user)
-         */
-        userId?: string;
-        /**
-         * Name of the [State](#schema_state) which is declared inside the bot definition
-         */
-        name: string;
-        /**
-         * Type of the [State](#schema_state) represents the resource type (`conversation`, `user`, `bot`, `task` or `integration`) that the state is related to
-         */
-        type: "conversation" | "user" | "bot" | "task" | "integration";
-        /**
-         * Payload is the content of the state defined by your bot.
-         */
-        payload: {
-            [k: string]: any;
-        };
-    };
-}

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

@@ -1,53 +0,0 @@
-export interface GetParticipantRequestHeaders {
-}
-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: {
-        /**
-         * 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;
-        /**
-         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) 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;
-        };
-        /**
-         * Name of the [User](#schema_user)
-         */
-        name?: string;
-        /**
-         * Picture URL of the [User](#schema_user)
-         */
-        pictureUrl?: string;
-    };
-}