@botpress/client 0.17.0 → 0.18.2

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

@@ -0,0 +1,21 @@
+export interface DeleteFileRequestHeaders {
+}
+export interface DeleteFileRequestQuery {
+}
+export interface DeleteFileRequestParams {
+    id: string;
+}
+export interface DeleteFileRequestBody {
+}
+export type DeleteFileInput = DeleteFileRequestBody & DeleteFileRequestHeaders & DeleteFileRequestQuery & DeleteFileRequestParams;
+export type DeleteFileRequest = {
+    headers: DeleteFileRequestHeaders;
+    query: DeleteFileRequestQuery;
+    params: DeleteFileRequestParams;
+    body: DeleteFileRequestBody;
+};
+export declare const parseReq: (input: DeleteFileInput) => DeleteFileRequest & {
+    path: string;
+};
+export interface DeleteFileResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteIntegrationRequestHeaders {
+}
+export interface DeleteIntegrationRequestQuery {
+}
+export interface DeleteIntegrationRequestParams {
+    id: string;
+}
+export interface DeleteIntegrationRequestBody {
+}
+export type DeleteIntegrationInput = DeleteIntegrationRequestBody & DeleteIntegrationRequestHeaders & DeleteIntegrationRequestQuery & DeleteIntegrationRequestParams;
+export type DeleteIntegrationRequest = {
+    headers: DeleteIntegrationRequestHeaders;
+    query: DeleteIntegrationRequestQuery;
+    params: DeleteIntegrationRequestParams;
+    body: DeleteIntegrationRequestBody;
+};
+export declare const parseReq: (input: DeleteIntegrationInput) => DeleteIntegrationRequest & {
+    path: string;
+};
+export interface DeleteIntegrationResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteIntegrationApiKeyRequestHeaders {
+}
+export interface DeleteIntegrationApiKeyRequestQuery {
+}
+export interface DeleteIntegrationApiKeyRequestParams {
+    id: string;
+}
+export interface DeleteIntegrationApiKeyRequestBody {
+}
+export type DeleteIntegrationApiKeyInput = DeleteIntegrationApiKeyRequestBody & DeleteIntegrationApiKeyRequestHeaders & DeleteIntegrationApiKeyRequestQuery & DeleteIntegrationApiKeyRequestParams;
+export type DeleteIntegrationApiKeyRequest = {
+    headers: DeleteIntegrationApiKeyRequestHeaders;
+    query: DeleteIntegrationApiKeyRequestQuery;
+    params: DeleteIntegrationApiKeyRequestParams;
+    body: DeleteIntegrationApiKeyRequestBody;
+};
+export declare const parseReq: (input: DeleteIntegrationApiKeyInput) => DeleteIntegrationApiKeyRequest & {
+    path: string;
+};
+export interface DeleteIntegrationApiKeyResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteMessageRequestHeaders {
+}
+export interface DeleteMessageRequestQuery {
+}
+export interface DeleteMessageRequestParams {
+    id: string;
+}
+export interface DeleteMessageRequestBody {
+}
+export type DeleteMessageInput = DeleteMessageRequestBody & DeleteMessageRequestHeaders & DeleteMessageRequestQuery & DeleteMessageRequestParams;
+export type DeleteMessageRequest = {
+    headers: DeleteMessageRequestHeaders;
+    query: DeleteMessageRequestQuery;
+    params: DeleteMessageRequestParams;
+    body: DeleteMessageRequestBody;
+};
+export declare const parseReq: (input: DeleteMessageInput) => DeleteMessageRequest & {
+    path: string;
+};
+export interface DeleteMessageResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeletePersonalAccessTokenRequestHeaders {
+}
+export interface DeletePersonalAccessTokenRequestQuery {
+}
+export interface DeletePersonalAccessTokenRequestParams {
+    id: string;
+}
+export interface DeletePersonalAccessTokenRequestBody {
+}
+export type DeletePersonalAccessTokenInput = DeletePersonalAccessTokenRequestBody & DeletePersonalAccessTokenRequestHeaders & DeletePersonalAccessTokenRequestQuery & DeletePersonalAccessTokenRequestParams;
+export type DeletePersonalAccessTokenRequest = {
+    headers: DeletePersonalAccessTokenRequestHeaders;
+    query: DeletePersonalAccessTokenRequestQuery;
+    params: DeletePersonalAccessTokenRequestParams;
+    body: DeletePersonalAccessTokenRequestBody;
+};
+export declare const parseReq: (input: DeletePersonalAccessTokenInput) => DeletePersonalAccessTokenRequest & {
+    path: string;
+};
+export interface DeletePersonalAccessTokenResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteTableRequestHeaders {
+}
+export interface DeleteTableRequestQuery {
+}
+export interface DeleteTableRequestParams {
+    table: string;
+}
+export interface DeleteTableRequestBody {
+}
+export type DeleteTableInput = DeleteTableRequestBody & DeleteTableRequestHeaders & DeleteTableRequestQuery & DeleteTableRequestParams;
+export type DeleteTableRequest = {
+    headers: DeleteTableRequestHeaders;
+    query: DeleteTableRequestQuery;
+    params: DeleteTableRequestParams;
+    body: DeleteTableRequestBody;
+};
+export declare const parseReq: (input: DeleteTableInput) => DeleteTableRequest & {
+    path: string;
+};
+export interface DeleteTableResponse {
+}

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

@@ -0,0 +1,36 @@
+export interface DeleteTableRowsRequestHeaders {
+}
+export interface DeleteTableRowsRequestQuery {
+}
+export interface DeleteTableRowsRequestParams {
+    table: string;
+}
+export interface DeleteTableRowsRequestBody {
+    /**
+     * @maxItems 1000
+     */
+    ids?: number[];
+    /**
+     * Filter to apply when deleting rows. Example: \{ "name": \{ "$eq": "John" \} \}
+     */
+    filter?: {
+        [k: string]: any;
+    };
+    /**
+     * Flag to delete all rows. Use with caution as this action is irreversible.
+     */
+    deleteAllRows?: boolean;
+}
+export type DeleteTableRowsInput = DeleteTableRowsRequestBody & DeleteTableRowsRequestHeaders & DeleteTableRowsRequestQuery & DeleteTableRowsRequestParams;
+export type DeleteTableRowsRequest = {
+    headers: DeleteTableRowsRequestHeaders;
+    query: DeleteTableRowsRequestQuery;
+    params: DeleteTableRowsRequestParams;
+    body: DeleteTableRowsRequestBody;
+};
+export declare const parseReq: (input: DeleteTableRowsInput) => DeleteTableRowsRequest & {
+    path: string;
+};
+export interface DeleteTableRowsResponse {
+    deletedRows: number;
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteTaskRequestHeaders {
+}
+export interface DeleteTaskRequestQuery {
+}
+export interface DeleteTaskRequestParams {
+    id: string;
+}
+export interface DeleteTaskRequestBody {
+}
+export type DeleteTaskInput = DeleteTaskRequestBody & DeleteTaskRequestHeaders & DeleteTaskRequestQuery & DeleteTaskRequestParams;
+export type DeleteTaskRequest = {
+    headers: DeleteTaskRequestHeaders;
+    query: DeleteTaskRequestQuery;
+    params: DeleteTaskRequestParams;
+    body: DeleteTaskRequestBody;
+};
+export declare const parseReq: (input: DeleteTaskInput) => DeleteTaskRequest & {
+    path: string;
+};
+export interface DeleteTaskResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteUserRequestHeaders {
+}
+export interface DeleteUserRequestQuery {
+}
+export interface DeleteUserRequestParams {
+    id: string;
+}
+export interface DeleteUserRequestBody {
+}
+export type DeleteUserInput = DeleteUserRequestBody & DeleteUserRequestHeaders & DeleteUserRequestQuery & DeleteUserRequestParams;
+export type DeleteUserRequest = {
+    headers: DeleteUserRequestHeaders;
+    query: DeleteUserRequestQuery;
+    params: DeleteUserRequestParams;
+    body: DeleteUserRequestBody;
+};
+export declare const parseReq: (input: DeleteUserInput) => DeleteUserRequest & {
+    path: string;
+};
+export interface DeleteUserResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteWorkspaceRequestHeaders {
+}
+export interface DeleteWorkspaceRequestQuery {
+}
+export interface DeleteWorkspaceRequestParams {
+    id: string;
+}
+export interface DeleteWorkspaceRequestBody {
+}
+export type DeleteWorkspaceInput = DeleteWorkspaceRequestBody & DeleteWorkspaceRequestHeaders & DeleteWorkspaceRequestQuery & DeleteWorkspaceRequestParams;
+export type DeleteWorkspaceRequest = {
+    headers: DeleteWorkspaceRequestHeaders;
+    query: DeleteWorkspaceRequestQuery;
+    params: DeleteWorkspaceRequestParams;
+    body: DeleteWorkspaceRequestBody;
+};
+export declare const parseReq: (input: DeleteWorkspaceInput) => DeleteWorkspaceRequest & {
+    path: string;
+};
+export interface DeleteWorkspaceResponse {
+}

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

@@ -0,0 +1,21 @@
+export interface DeleteWorkspaceMemberRequestHeaders {
+}
+export interface DeleteWorkspaceMemberRequestQuery {
+}
+export interface DeleteWorkspaceMemberRequestParams {
+    id: string;
+}
+export interface DeleteWorkspaceMemberRequestBody {
+}
+export type DeleteWorkspaceMemberInput = DeleteWorkspaceMemberRequestBody & DeleteWorkspaceMemberRequestHeaders & DeleteWorkspaceMemberRequestQuery & DeleteWorkspaceMemberRequestParams;
+export type DeleteWorkspaceMemberRequest = {
+    headers: DeleteWorkspaceMemberRequestHeaders;
+    query: DeleteWorkspaceMemberRequestQuery;
+    params: DeleteWorkspaceMemberRequestParams;
+    body: DeleteWorkspaceMemberRequestBody;
+};
+export declare const parseReq: (input: DeleteWorkspaceMemberInput) => DeleteWorkspaceMemberRequest & {
+    path: string;
+};
+export interface DeleteWorkspaceMemberResponse {
+}

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

@@ -0,0 +1,137 @@
+export interface DuplicateTableRequestHeaders {
+}
+export interface DuplicateTableRequestQuery {
+}
+export interface DuplicateTableRequestParams {
+    sourceTableId: string;
+}
+export interface DuplicateTableRequestBody {
+    tableName?: string;
+    /**
+     * Only duplicate the schema, not the content
+     */
+    schemaOnly?: boolean;
+    /**
+     * Use a different factor for the table. Leave empty to use the same as the duplicated table.
+     */
+    factor?: number;
+}
+export type DuplicateTableInput = DuplicateTableRequestBody & DuplicateTableRequestHeaders & DuplicateTableRequestQuery & DuplicateTableRequestParams;
+export type DuplicateTableRequest = {
+    headers: DuplicateTableRequestHeaders;
+    query: DuplicateTableRequestQuery;
+    params: DuplicateTableRequestParams;
+    body: DuplicateTableRequestBody;
+};
+export declare const parseReq: (input: DuplicateTableInput) => DuplicateTableRequest & {
+    path: string;
+};
+export interface DuplicateTableResponse {
+    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;
+    };
+    /**
+     * The total number of rows present in the table.
+     */
+    rows: number;
+}

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

@@ -0,0 +1,94 @@
+export interface FindTableRowsRequestHeaders {
+}
+export interface FindTableRowsRequestQuery {
+}
+export interface FindTableRowsRequestParams {
+    table: string;
+}
+export interface FindTableRowsRequestBody {
+    /**
+     * Limit for pagination, specifying the maximum number of rows to return.
+     */
+    limit?: number;
+    /**
+     * Offset for pagination, specifying where to start returning rows from.
+     */
+    offset?: number;
+    /**
+     * Provide a mongodb-like filter to apply to the query. Example: \{ "name": \{ "$eq": "John" \} \}
+     */
+    filter?: {
+        [k: string]: any;
+    };
+    /**
+     * Group the rows by a specific column and apply aggregations to them. Allowed values: key, avg, max, min, sum, count. Example: \{ "someId": "key", "orders": ["sum", "avg"] \}
+     */
+    group?: {
+        [k: string]: any;
+    };
+    /**
+     * Search term to apply to the row search. When using this parameter, some rows which doesn't match the search term will be returned, use the similarity field to know how much the row matches the search term.
+     */
+    search?: string;
+    /**
+     * Specifies the column by which to order the results. By default it is ordered by id. Build-in columns: id, createdAt, updatedAt
+     */
+    orderBy?: string;
+    /**
+     * Specifies the direction of sorting, either ascending or descending.
+     */
+    orderDirection?: "asc" | "desc";
+}
+export type FindTableRowsInput = FindTableRowsRequestBody & FindTableRowsRequestHeaders & FindTableRowsRequestQuery & FindTableRowsRequestParams;
+export type FindTableRowsRequest = {
+    headers: FindTableRowsRequestHeaders;
+    query: FindTableRowsRequestQuery;
+    params: FindTableRowsRequestParams;
+    body: FindTableRowsRequestBody;
+};
+export declare const parseReq: (input: FindTableRowsInput) => FindTableRowsRequest & {
+    path: string;
+};
+export interface FindTableRowsResponse {
+    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;
+    }[];
+    /**
+     * Flag indicating if there are more rows to fetch.
+     */
+    hasMore: boolean;
+    offset: number;
+    limit: number;
+    /**
+     * Alerts for minor issues that don't block the operation but suggest possible improvements.
+     */
+    warnings?: string[];
+}

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

@@ -0,0 +1,31 @@
+export interface GetAccountRequestHeaders {
+}
+export interface GetAccountRequestQuery {
+}
+export interface GetAccountRequestParams {
+}
+export interface GetAccountRequestBody {
+}
+export type GetAccountInput = GetAccountRequestBody & GetAccountRequestHeaders & GetAccountRequestQuery & GetAccountRequestParams;
+export type GetAccountRequest = {
+    headers: GetAccountRequestHeaders;
+    query: GetAccountRequestQuery;
+    params: GetAccountRequestParams;
+    body: GetAccountRequestBody;
+};
+export declare const parseReq: (_: GetAccountInput) => GetAccountRequest & {
+    path: string;
+};
+export interface GetAccountResponse {
+    account: {
+        id: string;
+        email: string;
+        displayName?: string;
+        emailVerified: boolean;
+        profilePicture?: string;
+        /**
+         * Creation date of the [Account](#schema_account) in ISO 8601 format
+         */
+        createdAt: string;
+    };
+}

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

@@ -0,0 +1,22 @@
+export interface GetAccountPreferenceRequestHeaders {
+}
+export interface GetAccountPreferenceRequestQuery {
+}
+export interface GetAccountPreferenceRequestParams {
+    key: string;
+}
+export interface GetAccountPreferenceRequestBody {
+}
+export type GetAccountPreferenceInput = GetAccountPreferenceRequestBody & GetAccountPreferenceRequestHeaders & GetAccountPreferenceRequestQuery & GetAccountPreferenceRequestParams;
+export type GetAccountPreferenceRequest = {
+    headers: GetAccountPreferenceRequestHeaders;
+    query: GetAccountPreferenceRequestQuery;
+    params: GetAccountPreferenceRequestParams;
+    body: GetAccountPreferenceRequestBody;
+};
+export declare const parseReq: (input: GetAccountPreferenceInput) => GetAccountPreferenceRequest & {
+    path: string;
+};
+export interface GetAccountPreferenceResponse {
+    value?: any;
+}

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

@@ -0,0 +1,24 @@
+export interface GetAllWorkspaceQuotaCompletionRequestHeaders {
+}
+export interface GetAllWorkspaceQuotaCompletionRequestQuery {
+}
+export interface GetAllWorkspaceQuotaCompletionRequestParams {
+}
+export interface GetAllWorkspaceQuotaCompletionRequestBody {
+}
+export type GetAllWorkspaceQuotaCompletionInput = GetAllWorkspaceQuotaCompletionRequestBody & GetAllWorkspaceQuotaCompletionRequestHeaders & GetAllWorkspaceQuotaCompletionRequestQuery & GetAllWorkspaceQuotaCompletionRequestParams;
+export type GetAllWorkspaceQuotaCompletionRequest = {
+    headers: GetAllWorkspaceQuotaCompletionRequestHeaders;
+    query: GetAllWorkspaceQuotaCompletionRequestQuery;
+    params: GetAllWorkspaceQuotaCompletionRequestParams;
+    body: GetAllWorkspaceQuotaCompletionRequestBody;
+};
+export declare const parseReq: (_: GetAllWorkspaceQuotaCompletionInput) => GetAllWorkspaceQuotaCompletionRequest & {
+    path: string;
+};
+export interface GetAllWorkspaceQuotaCompletionResponse {
+    [k: string]: {
+        type: "invocation_timeout" | "invocation_calls" | "storage_count" | "bot_count" | "knowledgebase_vector_storage" | "workspace_ratelimit" | "table_row_count" | "workspace_member_count" | "integrations_owned_count" | "ai_spend" | "openai_spend" | "bing_search_spend" | "always_alive";
+        completion: number;
+    };
+}

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

@@ -0,0 +1,38 @@
+export interface GetAuditRecordsRequestHeaders {
+}
+export interface GetAuditRecordsRequestQuery {
+    nextToken?: string;
+}
+export interface GetAuditRecordsRequestParams {
+    id: string;
+}
+export interface GetAuditRecordsRequestBody {
+}
+export type GetAuditRecordsInput = GetAuditRecordsRequestBody & GetAuditRecordsRequestHeaders & GetAuditRecordsRequestQuery & GetAuditRecordsRequestParams;
+export type GetAuditRecordsRequest = {
+    headers: GetAuditRecordsRequestHeaders;
+    query: GetAuditRecordsRequestQuery;
+    params: GetAuditRecordsRequestParams;
+    body: GetAuditRecordsRequestBody;
+};
+export declare const parseReq: (input: GetAuditRecordsInput) => GetAuditRecordsRequest & {
+    path: string;
+};
+export interface GetAuditRecordsResponse {
+    records: {
+        id: string;
+        recordedAt: string;
+        userId: string | null;
+        userEmail?: string | null;
+        resourceId: string | null;
+        resourceName?: string | null;
+        value?: string | null;
+        action: "UNKNOWN" | "ADD_WORKSPACE_MEMBER" | "REMOVE_WORKSPACE_MEMBER" | "UPDATE_WORKSPACE_MEMBER" | "CLOSE_WORKSPACE" | "CREATE_BOT" | "CREATE_WORKSPACE" | "DELETE_BOT" | "DEPLOY_BOT" | "TRANSFER_BOT" | "DOWNLOAD_BOT_ARCHIVE" | "UPDATE_BOT" | "UPDATE_BOT_CHANNEL" | "UPDATE_BOT_CONFIG" | "UPDATE_PAYMENT_METHOD" | "UPDATE_WORKSPACE" | "SET_SPENDING_LIMIT" | "SET_AI_SPENDING_LIMIT";
+    }[];
+    meta: {
+        /**
+         * The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.
+         */
+        nextToken?: string;
+    };
+}