@botpress/api 0.17.0 → 0.18.1

package/dist/src/gen/state.d.ts

@@ -1275,6 +1275,67 @@ export declare const state: {
                 };
             };
         };
+        getOrSetState: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            parameters: {
+                type: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                    enum: string[];
+                };
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+                name: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        payload: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        expiry: {
+                            type: "number";
+                            minimum: number;
+                            maximum: number;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "state";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        state: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         patchState: {
             name: string;
             description: string;
@@ -6096,169 +6157,837 @@ export declare const state: {
                 };
             };
         };
-    };
-    metadata: {
-        title: string;
-        description: string;
-        server: string;
-        version: string;
-        prefix: string;
-    };
-    errors: ({
-        status: 500;
-        type: string;
-        description: string;
-    } | {
-        status: 401;
-        type: string;
-        description: string;
-    } | {
-        status: 403;
-        type: string;
-        description: string;
-    } | {
-        status: 413;
-        type: string;
-        description: string;
-    } | {
-        status: 400;
-        type: string;
-        description: string;
-    } | {
-        status: 415;
-        type: string;
-        description: string;
-    } | {
-        status: 405;
-        type: string;
-        description: string;
-    } | {
-        status: 404;
-        type: string;
-        description: string;
-    } | {
-        status: 409;
-        type: string;
-        description: string;
-    } | {
-        status: 429;
-        type: string;
-        description: string;
-    } | {
-        status: 402;
-        type: string;
-        description: string;
-    })[];
-    refs: {
-        parameters: {};
-        requestBodies: {
-            createConversationBody: true;
-            getOrCreateConversationBody: true;
-            updateConversationBody: true;
-            addParticipantBody: true;
-            createEventBody: true;
-            createMessageBody: true;
-            getOrCreateMessageBody: true;
-            updateMessageBody: true;
-            createUserBody: true;
-            getOrCreateUserBody: true;
-            updateUserBody: true;
-            setStateBody: true;
-            patchStateBody: true;
-            callActionBody: true;
-            configureIntegrationBody: true;
-            createTaskBody: true;
-            updateTaskBody: true;
-            runVrlBody: true;
-            createPersonalAccessTokenBody: true;
-            setAccountPreferenceBody: true;
-            createBotBody: true;
-            updateBotBody: true;
-            transferBotBody: true;
-            setWorkspacePaymentMethodBody: true;
-            chargeWorkspaceUnpaidInvoicesBody: true;
-            createWorkspaceBody: true;
-            updateWorkspaceBody: true;
-            checkHandleAvailabilityBody: true;
-            changeWorkspacePlanBody: true;
-            createWorkspaceMemberBody: true;
-            updateWorkspaceMemberBody: true;
-            createIntegrationBody: true;
-            updateIntegrationBody: true;
-            changeAISpendQuotaBody: true;
-            introspectBody: true;
-            createFileBody: true;
+        listTables: {
+            name: string;
+            path: string;
+            description: string;
+            method: "get";
+            parameters: {
+                tags: {
+                    in: "query";
+                    type: "object";
+                    schema: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "string";
+                        };
+                    };
+                    description: string;
+                };
+            };
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        tables: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
         };
-        responses: {
-            createConversationResponse: true;
-            getConversationResponse: true;
-            listConversationsResponse: true;
-            getOrCreateConversationResponse: true;
-            updateConversationResponse: true;
-            deleteConversationResponse: true;
-            listParticipantsResponse: true;
-            addParticipantResponse: true;
-            getParticipantResponse: true;
-            removeParticipantResponse: true;
-            createEventResponse: true;
-            getEventResponse: true;
-            listEventsResponse: true;
-            createMessageResponse: true;
-            getOrCreateMessageResponse: true;
-            getMessageResponse: true;
-            updateMessageResponse: true;
-            listMessagesResponse: true;
-            deleteMessageResponse: true;
-            createUserResponse: true;
-            getUserResponse: true;
-            listUsersResponse: true;
-            getOrCreateUserResponse: true;
-            updateUserResponse: true;
-            deleteUserResponse: true;
-            getStateResponse: true;
-            setStateResponse: true;
-            patchStateResponse: true;
-            callActionResponse: true;
-            configureIntegrationResponse: true;
-            getTaskResponse: true;
-            createTaskResponse: true;
-            updateTaskResponse: true;
-            deleteTaskResponse: true;
-            listTasksResponse: true;
-            runVrlResponse: true;
-            getAccountResponse: true;
-            listPersonalAccessTokensResponse: true;
-            createPersonalAccessTokenResponse: true;
-            deletePersonalAccessTokenResponse: true;
-            setAccountPreferenceResponse: true;
-            getAccountPreferenceResponse: true;
-            listPublicIntegrationsResponse: true;
-            getPublicIntegrationByIdResponse: true;
-            getPublicIntegrationResponse: true;
-            createBotResponse: true;
-            updateBotResponse: true;
-            transferBotResponse: true;
-            listBotsResponse: true;
-            getBotResponse: true;
-            deleteBotResponse: true;
-            getBotLogsResponse: true;
-            getBotWebchatResponse: true;
-            getBotAnalyticsResponse: true;
-            listBotIssuesResponse: true;
-            deleteBotIssueResponse: true;
-            listBotIssueEventsResponse: true;
-            getWorkspaceBillingDetailsResponse: true;
-            setWorkspacePaymentMethodResponse: true;
-            listWorkspaceInvoicesResponse: true;
-            chargeWorkspaceUnpaidInvoicesResponse: true;
-            createWorkspaceResponse: true;
-            getWorkspaceResponse: true;
-            listWorkspaceUsagesResponse: true;
-            breakDownWorkspaceUsageByBotResponse: true;
-            getAllWorkspaceQuotaCompletionResponse: true;
-            getWorkspaceQuotaResponse: true;
-            listWorkspaceQuotasResponse: true;
-            updateWorkspaceResponse: true;
+        getTable: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            method: "get";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        table: {
+                            $ref: string;
+                        };
+                        rows: {
+                            type: "number";
+                            description: string;
+                        };
+                        indexingCount: {
+                            type: "number";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        createTable: {
+            name: string;
+            path: string;
+            description: string;
+            method: "post";
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        name: {
+                            description: string;
+                            type: "string";
+                            minLength: number;
+                        };
+                        factor: {
+                            default: number;
+                            type: "number";
+                            minimum: number;
+                            maximum: number;
+                            description: string;
+                        };
+                        schema: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        tags: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        table: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
+        updateTable: {
+            name: string;
+            path: string;
+            description: string;
+            method: "put";
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        name: {
+                            description: string;
+                            type: "string";
+                            minLength: number;
+                        };
+                        schema: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        tags: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        table: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        renameTableColumn: {
+            name: string;
+            path: string;
+            description: string;
+            method: "put";
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        name: {
+                            type: "string";
+                            description: string;
+                        };
+                        newName: {
+                            description: string;
+                            type: "string";
+                            minLength: number;
+                            maxLength: number;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        table: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deleteTable: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            method: "delete";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getTableRow: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                id: {
+                    type: "object";
+                    description: string;
+                    in: "query";
+                    required: true;
+                    schema: {
+                        type: "integer";
+                    };
+                };
+            };
+            method: "get";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        row: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        findTableRows: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        limit: {
+                            default: number;
+                            type: "integer";
+                            minimum: number;
+                            maximum: number;
+                            description: string;
+                        };
+                        offset: {
+                            default: number;
+                            type: "integer";
+                            minimum: number;
+                            description: string;
+                        };
+                        filter: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        group: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        search: {
+                            type: "string";
+                            maxLength: number;
+                            description: string;
+                        };
+                        orderBy: {
+                            default: string;
+                            type: "string";
+                            description: string;
+                        };
+                        orderDirection: {
+                            default: string;
+                            type: "string";
+                            enum: string[];
+                            description: string;
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            method: "post";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        rows: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        count: {
+                            type: "integer";
+                            description: string;
+                        };
+                        offset: {
+                            type: "integer";
+                        };
+                        limit: {
+                            type: "integer";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        createTableRows: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        rows: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {};
+                                additionalProperties: true;
+                            };
+                            minItems: number;
+                            maxItems: number;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            method: "post";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        rows: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        warnings: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                        errors: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deleteTableRows: {
+            name: string;
+            path: string;
+            description: string;
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        ids: {
+                            type: "array";
+                            items: {
+                                type: "number";
+                            };
+                            maxItems: number;
+                        };
+                        filter: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        deleteAllRows: {
+                            type: "boolean";
+                            description: string;
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            method: "post";
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        deletedRows: {
+                            type: "number";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        updateTableRows: {
+            name: string;
+            path: string;
+            description: string;
+            method: "put";
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        rows: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "number";
+                                    };
+                                };
+                                required: string[];
+                                additionalProperties: true;
+                            };
+                            minItems: number;
+                            maxItems: number;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        rows: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        warnings: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                        errors: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        upsertTableRows: {
+            name: string;
+            path: string;
+            description: string;
+            method: "post";
+            parameters: {
+                table: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        rows: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "number";
+                                    };
+                                };
+                                additionalProperties: true;
+                            };
+                            minItems: number;
+                            maxItems: number;
+                        };
+                        keyColumn: {
+                            default: string;
+                            type: "string";
+                            minLength: number;
+                            maxLength: number;
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "tables";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        inserted: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        updated: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        warnings: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                        errors: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+    };
+    metadata: {
+        title: string;
+        description: string;
+        server: string;
+        version: string;
+        prefix: string;
+    };
+    errors: ({
+        status: 500;
+        type: string;
+        description: string;
+    } | {
+        status: 401;
+        type: string;
+        description: string;
+    } | {
+        status: 403;
+        type: string;
+        description: string;
+    } | {
+        status: 413;
+        type: string;
+        description: string;
+    } | {
+        status: 400;
+        type: string;
+        description: string;
+    } | {
+        status: 415;
+        type: string;
+        description: string;
+    } | {
+        status: 405;
+        type: string;
+        description: string;
+    } | {
+        status: 404;
+        type: string;
+        description: string;
+    } | {
+        status: 409;
+        type: string;
+        description: string;
+    } | {
+        status: 429;
+        type: string;
+        description: string;
+    } | {
+        status: 402;
+        type: string;
+        description: string;
+    })[];
+    refs: {
+        parameters: {};
+        requestBodies: {
+            createConversationBody: true;
+            getOrCreateConversationBody: true;
+            updateConversationBody: true;
+            addParticipantBody: true;
+            createEventBody: true;
+            createMessageBody: true;
+            getOrCreateMessageBody: true;
+            updateMessageBody: true;
+            createUserBody: true;
+            getOrCreateUserBody: true;
+            updateUserBody: true;
+            setStateBody: true;
+            getOrSetStateBody: true;
+            patchStateBody: true;
+            callActionBody: true;
+            configureIntegrationBody: true;
+            createTaskBody: true;
+            updateTaskBody: true;
+            runVrlBody: true;
+            createPersonalAccessTokenBody: true;
+            setAccountPreferenceBody: true;
+            createBotBody: true;
+            updateBotBody: true;
+            transferBotBody: true;
+            setWorkspacePaymentMethodBody: true;
+            chargeWorkspaceUnpaidInvoicesBody: true;
+            createWorkspaceBody: true;
+            updateWorkspaceBody: true;
+            checkHandleAvailabilityBody: true;
+            changeWorkspacePlanBody: true;
+            createWorkspaceMemberBody: true;
+            updateWorkspaceMemberBody: true;
+            createIntegrationBody: true;
+            updateIntegrationBody: true;
+            changeAISpendQuotaBody: true;
+            introspectBody: true;
+            createFileBody: true;
+            createTableBody: true;
+            updateTableBody: true;
+            renameTableColumnBody: true;
+            findTableRowsBody: true;
+            createTableRowsBody: true;
+            deleteTableRowsBody: true;
+            updateTableRowsBody: true;
+            upsertTableRowsBody: true;
+        };
+        responses: {
+            createConversationResponse: true;
+            getConversationResponse: true;
+            listConversationsResponse: true;
+            getOrCreateConversationResponse: true;
+            updateConversationResponse: true;
+            deleteConversationResponse: true;
+            listParticipantsResponse: true;
+            addParticipantResponse: true;
+            getParticipantResponse: true;
+            removeParticipantResponse: true;
+            createEventResponse: true;
+            getEventResponse: true;
+            listEventsResponse: true;
+            createMessageResponse: true;
+            getOrCreateMessageResponse: true;
+            getMessageResponse: true;
+            updateMessageResponse: true;
+            listMessagesResponse: true;
+            deleteMessageResponse: true;
+            createUserResponse: true;
+            getUserResponse: true;
+            listUsersResponse: true;
+            getOrCreateUserResponse: true;
+            updateUserResponse: true;
+            deleteUserResponse: true;
+            getStateResponse: true;
+            setStateResponse: true;
+            getOrSetStateResponse: true;
+            patchStateResponse: true;
+            callActionResponse: true;
+            configureIntegrationResponse: true;
+            getTaskResponse: true;
+            createTaskResponse: true;
+            updateTaskResponse: true;
+            deleteTaskResponse: true;
+            listTasksResponse: true;
+            runVrlResponse: true;
+            getAccountResponse: true;
+            listPersonalAccessTokensResponse: true;
+            createPersonalAccessTokenResponse: true;
+            deletePersonalAccessTokenResponse: true;
+            setAccountPreferenceResponse: true;
+            getAccountPreferenceResponse: true;
+            listPublicIntegrationsResponse: true;
+            getPublicIntegrationByIdResponse: true;
+            getPublicIntegrationResponse: true;
+            createBotResponse: true;
+            updateBotResponse: true;
+            transferBotResponse: true;
+            listBotsResponse: true;
+            getBotResponse: true;
+            deleteBotResponse: true;
+            getBotLogsResponse: true;
+            getBotWebchatResponse: true;
+            getBotAnalyticsResponse: true;
+            listBotIssuesResponse: true;
+            deleteBotIssueResponse: true;
+            listBotIssueEventsResponse: true;
+            getWorkspaceBillingDetailsResponse: true;
+            setWorkspacePaymentMethodResponse: true;
+            listWorkspaceInvoicesResponse: true;
+            chargeWorkspaceUnpaidInvoicesResponse: true;
+            createWorkspaceResponse: true;
+            getWorkspaceResponse: true;
+            listWorkspaceUsagesResponse: true;
+            breakDownWorkspaceUsageByBotResponse: true;
+            getAllWorkspaceQuotaCompletionResponse: true;
+            getWorkspaceQuotaResponse: true;
+            listWorkspaceQuotasResponse: true;
+            updateWorkspaceResponse: true;
             checkHandleAvailabilityResponse: true;
             listWorkspacesResponse: true;
             changeWorkspacePlanResponse: true;
@@ -6285,6 +7014,18 @@ export declare const state: {
             downloadFileResponse: true;
             deleteFileResponse: true;
             listFilesResponse: true;
+            listTablesResponse: true;
+            getTableResponse: true;
+            createTableResponse: true;
+            updateTableResponse: true;
+            renameTableColumnResponse: true;
+            deleteTableResponse: true;
+            getTableRowResponse: true;
+            findTableRowsResponse: true;
+            createTableRowsResponse: true;
+            deleteTableRowsResponse: true;
+            updateTableRowsResponse: true;
+            upsertTableRowsResponse: true;
         };
         schemas: {
             Bot: true;
@@ -7748,8 +8489,9 @@ export declare const state: {
                         description: string;
                     };
                     name: {
-                        type: "string";
                         description: string;
+                        type: "string";
+                        minLength: number;
                     };
                     factor: {
                         default: number;
@@ -8032,7 +8774,7 @@ export declare const state: {
         title: string;
         description: string;
         name: "tables";
-        operations: never[];
+        operations: string[];
         schema: string;
     })[];
     options: {