@botpress/client 0.23.2 → 0.24.1

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

@@ -1,72 +0,0 @@
-export interface PatchStateRequestHeaders {
-}
-export interface PatchStateRequestQuery {
-}
-export interface PatchStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
-    id: string;
-    name: string;
-}
-export interface PatchStateRequestBody {
-    /**
-     * Payload is the content of the state defined by your bot.
-     */
-    payload: {
-        [k: string]: any;
-    };
-}
-export type PatchStateInput = PatchStateRequestBody & PatchStateRequestHeaders & PatchStateRequestQuery & PatchStateRequestParams;
-export type PatchStateRequest = {
-    headers: PatchStateRequestHeaders;
-    query: PatchStateRequestQuery;
-    params: PatchStateRequestParams;
-    body: PatchStateRequestBody;
-};
-export declare const parseReq: (input: PatchStateInput) => PatchStateRequest & {
-    path: string;
-};
-export interface PatchStateResponse {
-    /**
-     * 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/removeParticipant.d.ts

@@ -1,22 +0,0 @@
-export interface RemoveParticipantRequestHeaders {
-}
-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 {
-}

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

@@ -1,132 +0,0 @@
-export interface RenameTableColumnRequestHeaders {
-}
-export interface RenameTableColumnRequestQuery {
-}
-export interface RenameTableColumnRequestParams {
-    table: string;
-}
-export interface RenameTableColumnRequestBody {
-    /**
-     * The existing name of the column.
-     */
-    name: string;
-    /**
-     * The new name to assign to the column.
-     */
-    newName: string;
-}
-export type RenameTableColumnInput = RenameTableColumnRequestBody & RenameTableColumnRequestHeaders & RenameTableColumnRequestQuery & RenameTableColumnRequestParams;
-export type RenameTableColumnRequest = {
-    headers: RenameTableColumnRequestHeaders;
-    query: RenameTableColumnRequestQuery;
-    params: RenameTableColumnRequestParams;
-    body: RenameTableColumnRequestBody;
-};
-export declare const parseReq: (input: RenameTableColumnInput) => RenameTableColumnRequest & {
-    path: string;
-};
-export interface RenameTableColumnResponse {
-    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;
-    };
-}

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

@@ -1,28 +0,0 @@
-export interface RunVrlRequestHeaders {
-}
-export interface RunVrlRequestQuery {
-}
-export interface RunVrlRequestParams {
-}
-export interface RunVrlRequestBody {
-    data: {
-        [k: string]: any;
-    };
-    script: string;
-}
-export type RunVrlInput = RunVrlRequestBody & RunVrlRequestHeaders & RunVrlRequestQuery & RunVrlRequestParams;
-export type RunVrlRequest = {
-    headers: RunVrlRequestHeaders;
-    query: RunVrlRequestQuery;
-    params: RunVrlRequestParams;
-    body: RunVrlRequestBody;
-};
-export declare const parseReq: (input: RunVrlInput) => RunVrlRequest & {
-    path: string;
-};
-export interface RunVrlResponse {
-    data: {
-        [k: string]: any;
-    };
-    result?: any;
-}

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

@@ -1,56 +0,0 @@
-export interface SearchFilesRequestHeaders {
-}
-export interface SearchFilesRequestQuery {
-    tags?: {
-        [k: string]: string;
-    };
-    query: string;
-    contextDepth?: number;
-    limit?: number;
-}
-export interface SearchFilesRequestParams {
-}
-export interface SearchFilesRequestBody {
-}
-export type SearchFilesInput = SearchFilesRequestBody & SearchFilesRequestHeaders & SearchFilesRequestQuery & SearchFilesRequestParams;
-export type SearchFilesRequest = {
-    headers: SearchFilesRequestHeaders;
-    query: SearchFilesRequestQuery;
-    params: SearchFilesRequestParams;
-    body: SearchFilesRequestBody;
-};
-export declare const parseReq: (input: SearchFilesInput) => SearchFilesRequest & {
-    path: string;
-};
-export interface SearchFilesResponse {
-    passages: {
-        /**
-         * The content of the matching passage in the file including surrounding context, if any.
-         */
-        content: string;
-        /**
-         * The score indicating the similarity of the passage to the query. A higher score indicates higher similarity.
-         */
-        score: number;
-        file: {
-            /**
-             * File ID
-             */
-            id: 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;
-        };
-    }[];
-}

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

@@ -1,22 +0,0 @@
-export interface SetAccountPreferenceRequestHeaders {
-}
-export interface SetAccountPreferenceRequestQuery {
-}
-export interface SetAccountPreferenceRequestParams {
-    key: string;
-}
-export interface SetAccountPreferenceRequestBody {
-    value?: any;
-}
-export type SetAccountPreferenceInput = SetAccountPreferenceRequestBody & SetAccountPreferenceRequestHeaders & SetAccountPreferenceRequestQuery & SetAccountPreferenceRequestParams;
-export type SetAccountPreferenceRequest = {
-    headers: SetAccountPreferenceRequestHeaders;
-    query: SetAccountPreferenceRequestQuery;
-    params: SetAccountPreferenceRequestParams;
-    body: SetAccountPreferenceRequestBody;
-};
-export declare const parseReq: (input: SetAccountPreferenceInput) => SetAccountPreferenceRequest & {
-    path: string;
-};
-export interface SetAccountPreferenceResponse {
-}

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

@@ -1,76 +0,0 @@
-export interface SetStateRequestHeaders {
-}
-export interface SetStateRequestQuery {
-}
-export interface SetStateRequestParams {
-    type: "conversation" | "user" | "bot" | "integration" | "task";
-    id: string;
-    name: string;
-}
-export interface SetStateRequestBody {
-    /**
-     * Payload is the content of the state defined by your bot.
-     */
-    payload: {
-        [k: string]: any;
-    } | null;
-    /**
-     * 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 SetStateInput = SetStateRequestBody & SetStateRequestHeaders & SetStateRequestQuery & SetStateRequestParams;
-export type SetStateRequest = {
-    headers: SetStateRequestHeaders;
-    query: SetStateRequestQuery;
-    params: SetStateRequestParams;
-    body: SetStateRequestBody;
-};
-export declare const parseReq: (input: SetStateInput) => SetStateRequest & {
-    path: string;
-};
-export interface SetStateResponse {
-    /**
-     * 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/setWorkspacePaymentMethod.d.ts

@@ -1,37 +0,0 @@
-export interface SetWorkspacePaymentMethodRequestHeaders {
-}
-export interface SetWorkspacePaymentMethodRequestQuery {
-}
-export interface SetWorkspacePaymentMethodRequestParams {
-    id: string;
-}
-export interface SetWorkspacePaymentMethodRequestBody {
-    /**
-     * ID of the Stripe PaymentMethod to attach to the workspace.
-     */
-    stripePaymentMethodId: string;
-}
-export type SetWorkspacePaymentMethodInput = SetWorkspacePaymentMethodRequestBody & SetWorkspacePaymentMethodRequestHeaders & SetWorkspacePaymentMethodRequestQuery & SetWorkspacePaymentMethodRequestParams;
-export type SetWorkspacePaymentMethodRequest = {
-    headers: SetWorkspacePaymentMethodRequestHeaders;
-    query: SetWorkspacePaymentMethodRequestQuery;
-    params: SetWorkspacePaymentMethodRequestParams;
-    body: SetWorkspacePaymentMethodRequestBody;
-};
-export declare const parseReq: (input: SetWorkspacePaymentMethodInput) => SetWorkspacePaymentMethodRequest & {
-    path: string;
-};
-export interface SetWorkspacePaymentMethodResponse {
-    stripePaymentMethodId: string;
-    paymentMethod: {
-        type: string;
-        lastDigits: string;
-    } | null;
-    status: "succeeded" | "processing" | "canceled" | "requires_confirmation" | "requires_action" | "requires_payment_method";
-    /**
-     * If the payment needs to be confirmed, this will contain a URL to redirect the user to so they can complete the verification process to confirm it.
-     */
-    nextAction?: {
-        redirectToUrl: string;
-    };
-}

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

@@ -1,22 +0,0 @@
-export interface TrackAnalyticsRequestHeaders {
-}
-export interface TrackAnalyticsRequestQuery {
-}
-export interface TrackAnalyticsRequestParams {
-}
-export interface TrackAnalyticsRequestBody {
-    name: string;
-    count: number;
-}
-export type TrackAnalyticsInput = TrackAnalyticsRequestBody & TrackAnalyticsRequestHeaders & TrackAnalyticsRequestQuery & TrackAnalyticsRequestParams;
-export type TrackAnalyticsRequest = {
-    headers: TrackAnalyticsRequestHeaders;
-    query: TrackAnalyticsRequestQuery;
-    params: TrackAnalyticsRequestParams;
-    body: TrackAnalyticsRequestBody;
-};
-export declare const parseReq: (input: TrackAnalyticsInput) => TrackAnalyticsRequest & {
-    path: string;
-};
-export interface TrackAnalyticsResponse {
-}

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

@@ -1,25 +0,0 @@
-export interface TransferBotRequestHeaders {
-}
-export interface TransferBotRequestQuery {
-}
-export interface TransferBotRequestParams {
-    id: string;
-}
-export interface TransferBotRequestBody {
-    /**
-     * The ID of the workspace you want to transfer the bot to.
-     */
-    targetWorkspaceId: string;
-}
-export type TransferBotInput = TransferBotRequestBody & TransferBotRequestHeaders & TransferBotRequestQuery & TransferBotRequestParams;
-export type TransferBotRequest = {
-    headers: TransferBotRequestHeaders;
-    query: TransferBotRequestQuery;
-    params: TransferBotRequestParams;
-    body: TransferBotRequestBody;
-};
-export declare const parseReq: (input: TransferBotInput) => TransferBotRequest & {
-    path: string;
-};
-export interface TransferBotResponse {
-}

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

@@ -1,34 +0,0 @@
-export interface UpdateAccountRequestHeaders {
-}
-export interface UpdateAccountRequestQuery {
-}
-export interface UpdateAccountRequestParams {
-}
-export interface UpdateAccountRequestBody {
-    displayName?: string;
-    profilePicture?: string;
-    refresh?: boolean;
-}
-export type UpdateAccountInput = UpdateAccountRequestBody & UpdateAccountRequestHeaders & UpdateAccountRequestQuery & UpdateAccountRequestParams;
-export type UpdateAccountRequest = {
-    headers: UpdateAccountRequestHeaders;
-    query: UpdateAccountRequestQuery;
-    params: UpdateAccountRequestParams;
-    body: UpdateAccountRequestBody;
-};
-export declare const parseReq: (input: UpdateAccountInput) => UpdateAccountRequest & {
-    path: string;
-};
-export interface UpdateAccountResponse {
-    account: {
-        id: string;
-        email: string;
-        displayName?: string;
-        emailVerified: boolean;
-        profilePicture?: string;
-        /**
-         * Creation date of the [Account](#schema_account) in ISO 8601 format
-         */
-        createdAt: string;
-    };
-}