@botpress/client 0.17.0 → 0.18.2

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

@@ -0,0 +1,152 @@
+export interface UpdateTableRequestHeaders {
+}
+export interface UpdateTableRequestQuery {
+}
+export interface UpdateTableRequestParams {
+    table: string;
+}
+export interface UpdateTableRequestBody {
+    /**
+     * Required. This name is used to identify your table.
+     */
+    name?: string;
+    /**
+     * 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 UpdateTableInput = UpdateTableRequestBody & UpdateTableRequestHeaders & UpdateTableRequestQuery & UpdateTableRequestParams;
+export type UpdateTableRequest = {
+    headers: UpdateTableRequestHeaders;
+    query: UpdateTableRequestQuery;
+    params: UpdateTableRequestParams;
+    body: UpdateTableRequestBody;
+};
+export declare const parseReq: (input: UpdateTableInput) => UpdateTableRequest & {
+    path: string;
+};
+export interface UpdateTableResponse {
+    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;
+    };
+    /**
+     * List of columns that have become stale following the modification.
+     */
+    staleColumns?: string[];
+}

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

@@ -0,0 +1,74 @@
+export interface UpdateTableRowsRequestHeaders {
+}
+export interface UpdateTableRowsRequestQuery {
+}
+export interface UpdateTableRowsRequestParams {
+    table: string;
+}
+export interface UpdateTableRowsRequestBody {
+    /**
+     * Rows with updated data, identified by ID.
+     *
+     * @minItems 1
+     * @maxItems 1000
+     */
+    rows: {
+        id: number;
+        [k: string]: any;
+    }[];
+    /**
+     * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
+     */
+    waitComputed?: boolean;
+}
+export type UpdateTableRowsInput = UpdateTableRowsRequestBody & UpdateTableRowsRequestHeaders & UpdateTableRowsRequestQuery & UpdateTableRowsRequestParams;
+export type UpdateTableRowsRequest = {
+    headers: UpdateTableRowsRequestHeaders;
+    query: UpdateTableRowsRequestQuery;
+    params: UpdateTableRowsRequestParams;
+    body: UpdateTableRowsRequestBody;
+};
+export declare const parseReq: (input: UpdateTableRowsInput) => UpdateTableRowsRequest & {
+    path: string;
+};
+export interface UpdateTableRowsResponse {
+    rows: {
+        /**
+         * Unique identifier for the row.
+         */
+        id: number;
+        /**
+         * Timestamp of row creation.
+         */
+        createdAt?: string;
+        /**
+         * Timestamp of the last row update.
+         */
+        updatedAt?: string;
+        computed: {
+            [k: string]: {
+                status: string;
+                error?: string;
+                updatedBy?: string;
+                updatedAt?: string;
+            };
+        };
+        /**
+         * [Read-only] List of stale values that are waiting to be recomputed.
+         */
+        stale?: string[];
+        /**
+         * Optional numeric value indicating similarity, when using findTableRows.
+         */
+        similarity?: number;
+        [k: string]: any;
+    }[];
+    /**
+     * Alerts for minor issues that don't block the operation but suggest possible improvements.
+     */
+    warnings?: string[];
+    /**
+     * Critical issues in specific elements that prevent their successful processing, allowing partial operation success.
+     */
+    errors?: string[];
+}

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

@@ -0,0 +1,114 @@
+export interface UpdateTaskRequestHeaders {
+}
+export interface UpdateTaskRequestQuery {
+}
+export interface UpdateTaskRequestParams {
+    id: string;
+}
+export interface UpdateTaskRequestBody {
+    /**
+     * Title describing the task
+     */
+    title?: string;
+    /**
+     * All the notes related to the execution of the current task
+     */
+    description?: string;
+    /**
+     * Content related to the task
+     */
+    data?: {
+        [k: string]: any;
+    };
+    /**
+     * The timeout date where the task should be failed in the ISO 8601 format
+     */
+    timeoutAt?: string;
+    /**
+     * Status of the task
+     */
+    status?: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
+    /**
+     * Tags for the [Task](#schema_task)
+     */
+    tags?: {
+        [k: string]: string;
+    };
+}
+export type UpdateTaskInput = UpdateTaskRequestBody & UpdateTaskRequestHeaders & UpdateTaskRequestQuery & UpdateTaskRequestParams;
+export type UpdateTaskRequest = {
+    headers: UpdateTaskRequestHeaders;
+    query: UpdateTaskRequestQuery;
+    params: UpdateTaskRequestParams;
+    body: UpdateTaskRequestBody;
+};
+export declare const parseReq: (input: UpdateTaskInput) => UpdateTaskRequest & {
+    path: string;
+};
+export interface UpdateTaskResponse {
+    /**
+     * Task definition
+     */
+    task: {
+        /**
+         * Id of the [Task](#schema_task)
+         */
+        id: string;
+        /**
+         * Title describing the task
+         */
+        title: string;
+        /**
+         * All the notes related to the execution of the current task
+         */
+        description: string;
+        /**
+         * Type of the task
+         */
+        type: string;
+        /**
+         * Content related to the task
+         */
+        data: {
+            [k: string]: any;
+        };
+        /**
+         * Status of the task
+         */
+        status: "pending" | "in_progress" | "failed" | "completed" | "blocked" | "paused" | "timeout" | "cancelled";
+        /**
+         * Parent task id is the parent task that created this task
+         */
+        parentTaskId?: string;
+        /**
+         * Conversation id related to this task
+         */
+        conversationId?: string;
+        /**
+         * Specific user related to this task
+         */
+        userId?: string;
+        /**
+         * The timeout date where the task should be failed in the ISO 8601 format
+         */
+        timeoutAt: string;
+        /**
+         * Creation date of the task in ISO 8601 format
+         */
+        createdAt: string;
+        /**
+         * Updating date of the task in ISO 8601 format
+         */
+        updatedAt: string;
+        /**
+         * If the task fails this is the reason behind it
+         */
+        failureReason?: string;
+        /**
+         * Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Task](#schema_task). Individual keys can be unset by posting an empty value to them.
+         */
+        tags: {
+            [k: string]: string;
+        };
+    };
+}

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

@@ -0,0 +1,66 @@
+export interface UpdateUserRequestHeaders {
+}
+export interface UpdateUserRequestQuery {
+}
+export interface UpdateUserRequestParams {
+    id: string;
+}
+export interface UpdateUserRequestBody {
+    /**
+     * Tags for the [User](#schema_user)
+     */
+    tags?: {
+        [k: string]: string;
+    };
+    /**
+     * Name of the user
+     */
+    name?: string;
+    /**
+     * URI of the user picture
+     */
+    pictureUrl?: string | null;
+}
+export type UpdateUserInput = UpdateUserRequestBody & UpdateUserRequestHeaders & UpdateUserRequestQuery & UpdateUserRequestParams;
+export type UpdateUserRequest = {
+    headers: UpdateUserRequestHeaders;
+    query: UpdateUserRequestQuery;
+    params: UpdateUserRequestParams;
+    body: UpdateUserRequestBody;
+};
+export declare const parseReq: (input: UpdateUserInput) => UpdateUserRequest & {
+    path: string;
+};
+export interface UpdateUserResponse {
+    /**
+     * 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/updateWorkspace.d.ts

@@ -0,0 +1,50 @@
+export interface UpdateWorkspaceRequestHeaders {
+}
+export interface UpdateWorkspaceRequestQuery {
+}
+export interface UpdateWorkspaceRequestParams {
+    id: string;
+}
+export interface UpdateWorkspaceRequestBody {
+    name?: string;
+    spendingLimit?: number;
+    about?: string;
+    profilePicture?: string;
+    contactEmail?: string;
+    website?: string;
+    /**
+     * @maxItems 5
+     */
+    socialAccounts?: string[];
+    isPublic?: boolean;
+    handle?: string;
+}
+export type UpdateWorkspaceInput = UpdateWorkspaceRequestBody & UpdateWorkspaceRequestHeaders & UpdateWorkspaceRequestQuery & UpdateWorkspaceRequestParams;
+export type UpdateWorkspaceRequest = {
+    headers: UpdateWorkspaceRequestHeaders;
+    query: UpdateWorkspaceRequestQuery;
+    params: UpdateWorkspaceRequestParams;
+    body: UpdateWorkspaceRequestBody;
+};
+export declare const parseReq: (input: UpdateWorkspaceInput) => UpdateWorkspaceRequest & {
+    path: string;
+};
+export interface UpdateWorkspaceResponse {
+    id: string;
+    name: string;
+    ownerId: string;
+    createdAt: string;
+    updatedAt: string;
+    botCount: number;
+    billingVersion: "v1" | "v2";
+    plan: "community" | "team" | "enterprise";
+    blocked: boolean;
+    spendingLimit: number;
+    about?: string;
+    profilePicture?: string;
+    contactEmail?: string;
+    website?: string;
+    socialAccounts?: string[];
+    isPublic?: boolean;
+    handle?: string;
+}

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

@@ -0,0 +1,27 @@
+export interface UpdateWorkspaceMemberRequestHeaders {
+}
+export interface UpdateWorkspaceMemberRequestQuery {
+}
+export interface UpdateWorkspaceMemberRequestParams {
+    id: string;
+}
+export interface UpdateWorkspaceMemberRequestBody {
+    role?: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
+}
+export type UpdateWorkspaceMemberInput = UpdateWorkspaceMemberRequestBody & UpdateWorkspaceMemberRequestHeaders & UpdateWorkspaceMemberRequestQuery & UpdateWorkspaceMemberRequestParams;
+export type UpdateWorkspaceMemberRequest = {
+    headers: UpdateWorkspaceMemberRequestHeaders;
+    query: UpdateWorkspaceMemberRequestQuery;
+    params: UpdateWorkspaceMemberRequestParams;
+    body: UpdateWorkspaceMemberRequestBody;
+};
+export declare const parseReq: (input: UpdateWorkspaceMemberInput) => UpdateWorkspaceMemberRequest & {
+    path: string;
+};
+export interface UpdateWorkspaceMemberResponse {
+    id: string;
+    userId?: string;
+    email: string;
+    createdAt: string;
+    role: "viewer" | "billing" | "developer" | "manager" | "administrator" | "owner";
+}

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

@@ -0,0 +1,107 @@
+export interface UpsertTableRowsRequestHeaders {
+}
+export interface UpsertTableRowsRequestQuery {
+}
+export interface UpsertTableRowsRequestParams {
+    table: string;
+}
+export interface UpsertTableRowsRequestBody {
+    /**
+     * @minItems 1
+     * @maxItems 1000
+     */
+    rows: {
+        id?: number;
+        [k: string]: any;
+    }[];
+    /**
+     * Determines if a row is inserted or updated. Defaults to "id".
+     */
+    keyColumn?: string;
+    /**
+     * Ensure computed columns are fully processed before returning the result. This is applicable only when the number of rows involved is fewer than 1.
+     */
+    waitComputed?: boolean;
+}
+export type UpsertTableRowsInput = UpsertTableRowsRequestBody & UpsertTableRowsRequestHeaders & UpsertTableRowsRequestQuery & UpsertTableRowsRequestParams;
+export type UpsertTableRowsRequest = {
+    headers: UpsertTableRowsRequestHeaders;
+    query: UpsertTableRowsRequestQuery;
+    params: UpsertTableRowsRequestParams;
+    body: UpsertTableRowsRequestBody;
+};
+export declare const parseReq: (input: UpsertTableRowsInput) => UpsertTableRowsRequest & {
+    path: string;
+};
+export interface UpsertTableRowsResponse {
+    inserted: {
+        /**
+         * Unique identifier for the row.
+         */
+        id: number;
+        /**
+         * Timestamp of row creation.
+         */
+        createdAt?: string;
+        /**
+         * Timestamp of the last row update.
+         */
+        updatedAt?: string;
+        computed: {
+            [k: string]: {
+                status: string;
+                error?: string;
+                updatedBy?: string;
+                updatedAt?: string;
+            };
+        };
+        /**
+         * [Read-only] List of stale values that are waiting to be recomputed.
+         */
+        stale?: string[];
+        /**
+         * Optional numeric value indicating similarity, when using findTableRows.
+         */
+        similarity?: number;
+        [k: string]: any;
+    }[];
+    updated: {
+        /**
+         * Unique identifier for the row.
+         */
+        id: number;
+        /**
+         * Timestamp of row creation.
+         */
+        createdAt?: string;
+        /**
+         * Timestamp of the last row update.
+         */
+        updatedAt?: string;
+        computed: {
+            [k: string]: {
+                status: string;
+                error?: string;
+                updatedBy?: string;
+                updatedAt?: string;
+            };
+        };
+        /**
+         * [Read-only] List of stale values that are waiting to be recomputed.
+         */
+        stale?: string[];
+        /**
+         * Optional numeric value indicating similarity, when using findTableRows.
+         */
+        similarity?: number;
+        [k: string]: any;
+    }[];
+    /**
+     * Alerts for minor issues that don't block the operation but suggest possible improvements.
+     */
+    warnings?: string[];
+    /**
+     * Critical issues in specific elements that prevent their successful processing, allowing partial operation success.
+     */
+    errors?: string[];
+}

package/dist/gen/to-axios.d.ts

@@ -0,0 +1,16 @@
+import { AxiosRequestConfig } from "axios";
+export type Primitive = string | number | boolean;
+export type Value<P extends Primitive> = P | P[] | Record<string, P>;
+export type QueryValue = Value<string> | Value<boolean> | Value<number> | undefined;
+export type AnyQueryParams = Record<string, QueryValue>;
+export type HeaderValue = string | undefined;
+export type AnyHeaderParams = Record<string, HeaderValue>;
+export type AnyBodyParams = Record<string, any>;
+export type ParsedRequest = {
+    method: string;
+    path: string;
+    query: AnyQueryParams;
+    headers: AnyHeaderParams;
+    body: AnyBodyParams;
+};
+export declare const toAxiosRequest: (req: ParsedRequest) => AxiosRequestConfig;