@botpress/api 0.16.0 → 0.16.3

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

@@ -1,5 +1,5 @@
 import * as opapi from "@bpinternal/opapi";
-export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File" | "Table" | "Column" | "Row", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "tables">;
+export type State = opapi.State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "Activity" | "User" | "Conversation" | "Event" | "Message" | "State" | "Task" | "File" | "Table" | "Column" | "Row", never, "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "task" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas" | "helper" | "activity" | "tables">;
 export declare const state: {
     operations: {
         createConversation: {
@@ -1404,6 +1404,282 @@ export declare const state: {
             };
             parameters: {};
         };
+        getTask: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "task";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        task: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        createTask: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        title: {
+                            type: "string";
+                            maxLength: number;
+                            description: string;
+                        };
+                        description: {
+                            type: "string";
+                            maxLength: number;
+                            description: string;
+                        };
+                        type: {
+                            type: "string";
+                            maxLength: number;
+                            description: string;
+                        };
+                        data: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        parentTaskId: {
+                            type: "string";
+                            description: string;
+                        };
+                        conversationId: {
+                            type: "string";
+                            description: string;
+                        };
+                        userId: {
+                            type: "string";
+                            description: string;
+                        };
+                        timeoutAt: {
+                            type: "string";
+                            format: string;
+                            description: string;
+                        };
+                        tags: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "string";
+                                maxLength: number;
+                            };
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "task";
+            response: {
+                description: string;
+                status: 201;
+                schema: {
+                    type: "object";
+                    properties: {
+                        task: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
+        updateTask: {
+            name: string;
+            description: string;
+            method: "put";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        title: {
+                            type: "string";
+                            description: string;
+                        };
+                        description: {
+                            type: "string";
+                            description: string;
+                        };
+                        data: {
+                            type: "object";
+                            additionalProperties: true;
+                            description: string;
+                        };
+                        timeoutAt: {
+                            type: "string";
+                            format: string;
+                            description: string;
+                        };
+                        status: {
+                            type: "string";
+                            enum: string[];
+                            description: string;
+                        };
+                        tags: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "string";
+                                maxLength: number;
+                            };
+                            description: string;
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "task";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        task: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deleteTask: {
+            name: string;
+            description: string;
+            method: "delete";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "task";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        listTasks: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+                tags: {
+                    in: "query";
+                    type: "object";
+                    schema: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "string";
+                        };
+                    };
+                    description: string;
+                };
+                conversationId: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
+                userId: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
+                parentTaskId: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
+                status: {
+                    in: "query";
+                    type: "string[]";
+                    description: string;
+                    enum: string[];
+                };
+                type: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "task";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        tasks: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         runVrl: {
             name: string;
             description: string;
@@ -3343,6 +3619,10 @@ export declare const state: {
                         isPublic: {
                             type: "boolean";
                         };
+                        handle: {
+                            default: string;
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -3434,6 +3714,10 @@ export declare const state: {
                         isPublic: {
                             type: "boolean";
                         };
+                        handle: {
+                            default: string;
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -3746,6 +4030,12 @@ export declare const state: {
                         isPublic: {
                             type: "boolean";
                         };
+                        handle: {
+                            type: "string";
+                            minLength: number;
+                            maxLength: number;
+                            pattern: string;
+                        };
                     };
                     additionalProperties: false;
                     title: string;
@@ -3818,12 +4108,67 @@ export declare const state: {
                         isPublic: {
                             type: "boolean";
                         };
+                        handle: {
+                            default: string;
+                            type: "string";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        checkHandleAvailability: {
+            name: string;
+            description: string;
+            section: "workspace";
+            method: "put";
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            path: string;
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        handle: {
+                            type: "string";
+                            minLength: number;
+                            maxLength: number;
+                            pattern: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        available: {
+                            type: "boolean";
+                        };
+                        suggestions: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                        };
+                        usedBy: {
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
                     additionalProperties: false;
                 };
             };
+            parameters: {};
         };
         listWorkspaces: {
             name: string;
@@ -3913,6 +4258,10 @@ export declare const state: {
                                     isPublic: {
                                         type: "boolean";
                                     };
+                                    handle: {
+                                        default: string;
+                                        type: "string";
+                                    };
                                 };
                                 required: string[];
                                 title: string;
@@ -4033,6 +4382,10 @@ export declare const state: {
                         isPublic: {
                             type: "boolean";
                         };
+                        handle: {
+                            default: string;
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -5378,32 +5731,97 @@ export declare const state: {
                 schema: {
                     type: "object";
                     properties: {
-                        usages: {
+                        usages: {
+                            type: "array";
+                            items: {
+                                $ref: string;
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        changeAISpendQuota: {
+            name: string;
+            path: string;
+            description: string;
+            method: "put";
+            section: "quotas";
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        monthlySpendingLimit: {
+                            type: "number";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
+        listActivities: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "activity";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+                taskId: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                botId: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        activities: {
                             type: "array";
                             items: {
                                 $ref: string;
                             };
                         };
-                    };
-                    required: string[];
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-        };
-        changeAISpendQuota: {
-            name: string;
-            path: string;
-            description: string;
-            method: "put";
-            section: "quotas";
-            requestBody: {
-                description: string;
-                schema: {
-                    type: "object";
-                    properties: {
-                        monthlySpendingLimit: {
-                            type: "number";
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
                         };
                     };
                     required: string[];
@@ -5411,15 +5829,6 @@ export declare const state: {
                     additionalProperties: false;
                 };
             };
-            response: {
-                description: string;
-                schema: {
-                    type: "object";
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-            parameters: {};
         };
         introspect: {
             name: string;
@@ -5705,6 +6114,8 @@ export declare const state: {
             patchStateBody: true;
             callActionBody: true;
             configureIntegrationBody: true;
+            createTaskBody: true;
+            updateTaskBody: true;
             runVrlBody: true;
             createPersonalAccessTokenBody: true;
             setAccountPreferenceBody: true;
@@ -5715,6 +6126,7 @@ export declare const state: {
             chargeWorkspaceUnpaidInvoicesBody: true;
             createWorkspaceBody: true;
             updateWorkspaceBody: true;
+            checkHandleAvailabilityBody: true;
             changeWorkspacePlanBody: true;
             createWorkspaceMemberBody: true;
             updateWorkspaceMemberBody: true;
@@ -5755,6 +6167,11 @@ export declare const state: {
             patchStateResponse: true;
             callActionResponse: true;
             configureIntegrationResponse: true;
+            getTaskResponse: true;
+            createTaskResponse: true;
+            updateTaskResponse: true;
+            deleteTaskResponse: true;
+            listTasksResponse: true;
             runVrlResponse: true;
             getAccountResponse: true;
             listPersonalAccessTokensResponse: true;
@@ -5789,6 +6206,7 @@ export declare const state: {
             getWorkspaceQuotaResponse: true;
             listWorkspaceQuotasResponse: true;
             updateWorkspaceResponse: true;
+            checkHandleAvailabilityResponse: true;
             listWorkspacesResponse: true;
             changeWorkspacePlanResponse: true;
             deleteWorkspaceResponse: true;
@@ -5807,6 +6225,7 @@ export declare const state: {
             getUsageResponse: true;
             listUsageHistoryResponse: true;
             changeAISpendQuotaResponse: true;
+            listActivitiesResponse: true;
             introspectResponse: true;
             createFileResponse: true;
             getFileResponse: true;
@@ -5823,11 +6242,13 @@ export declare const state: {
             Usage: true;
             Issue: true;
             IssueEvent: true;
+            Activity: true;
             User: true;
             Conversation: true;
             Event: true;
             Message: true;
             State: true;
+            Task: true;
             File: true;
             Table: true;
             Column: true;
@@ -6635,6 +7056,10 @@ export declare const state: {
                     isPublic: {
                         type: "boolean";
                     };
+                    handle: {
+                        default: string;
+                        type: "string";
+                    };
                 };
                 required: string[];
                 additionalProperties: false;
@@ -6809,6 +7234,38 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Activity: {
+            section: "activity";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    description: {
+                        type: "string";
+                    };
+                    taskId: {
+                        type: "string";
+                    };
+                    category: {
+                        type: "string";
+                        enum: string[];
+                    };
+                    data: {
+                        type: "object";
+                        additionalProperties: true;
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
         User: {
             section: "user";
             schema: {
@@ -6864,6 +7321,12 @@ export declare const state: {
                         maxLength: number;
                         description: string;
                     };
+                    currentTaskId: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
                     createdAt: {
                         type: "string";
                         format: string;
@@ -6941,7 +7404,13 @@ export declare const state: {
                     };
                     status: {
                         type: "string";
+                        enum: string[];
+                    };
+                    failureReason: {
+                        type: "string";
+                        maxLength: number;
                         description: string;
+                        nullable: true;
                     };
                 };
                 required: string[];
@@ -7065,6 +7534,92 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Task: {
+            section: "task";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    title: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                    };
+                    description: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                    };
+                    type: {
+                        type: "string";
+                        description: string;
+                    };
+                    data: {
+                        type: "object";
+                        additionalProperties: true;
+                        description: string;
+                    };
+                    status: {
+                        type: "string";
+                        enum: string[];
+                        description: string;
+                    };
+                    parentTaskId: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    conversationId: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    userId: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    timeoutAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                    updatedAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                    failureReason: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                    };
+                    tags: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "string";
+                        };
+                        description: string;
+                    };
+                };
+                required: string[];
+                description: string;
+                additionalProperties: false;
+            };
+        };
         File: {
             section: "file";
             schema: {
@@ -7125,53 +7680,75 @@ export declare const state: {
                         maximum: number;
                         description: string;
                     };
-                    columns: {
-                        type: "array";
-                        items: {
-                            type: "object";
+                    schema: {
+                        type: "object";
+                        properties: {
+                            $schema: {
+                                type: "string";
+                            };
                             properties: {
-                                id: {
-                                    type: "string";
-                                    description: string;
-                                };
-                                name: {
-                                    type: "string";
-                                    minLength: number;
-                                    maxLength: number;
-                                    description: string;
-                                };
-                                description: {
-                                    type: "string";
-                                    description: string;
-                                };
-                                searchable: {
-                                    type: "boolean";
-                                    description: string;
-                                };
-                                type: {
-                                    type: "string";
-                                    enum: string[];
-                                    description: string;
+                                type: "object";
+                                additionalProperties: {
+                                    type: "object";
+                                    properties: {
+                                        type: {
+                                            type: "string";
+                                            enum: string[];
+                                        };
+                                        format: {
+                                            type: "string";
+                                            enum: string[];
+                                        };
+                                        description: {
+                                            type: "string";
+                                        };
+                                        nullable: {
+                                            default: boolean;
+                                            type: "boolean";
+                                        };
+                                        "x-zui": {
+                                            type: "object";
+                                            properties: {
+                                                index: {
+                                                    type: "integer";
+                                                };
+                                                searchable: {
+                                                    type: "boolean";
+                                                    description: string;
+                                                };
+                                                typings: {
+                                                    type: "string";
+                                                    description: string;
+                                                };
+                                            };
+                                            required: string[];
+                                            additionalProperties: false;
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: false;
                                 };
-                                typings: {
+                                description: string;
+                            };
+                            additionalProperties: {
+                                type: "boolean";
+                                enum: boolean[];
+                                description: string;
+                            };
+                            required: {
+                                type: "array";
+                                items: {
                                     type: "string";
-                                    description: string;
-                                };
-                                schema: {
-                                    type: "object";
-                                    properties: {};
-                                    additionalProperties: true;
                                 };
+                                description: string;
+                            };
+                            type: {
+                                type: "string";
+                                enum: string[];
                             };
-                            required: string[];
                         };
-                        maxItems: number;
-                        description: string;
-                    };
-                    schema: {
-                        type: "object";
-                        additionalProperties: true;
-                        description: string;
+                        required: string[];
+                        additionalProperties: false;
                     };
                     tags: {
                         type: "object";
@@ -7309,6 +7886,12 @@ export declare const state: {
         name: "action";
         operations: string[];
         schema?: undefined;
+    } | {
+        description: string;
+        title: string;
+        name: "task";
+        operations: string[];
+        schema: string;
     } | {
         title: string;
         description: string;
@@ -7357,6 +7940,12 @@ export declare const state: {
         name: "helper";
         operations: string[];
         schema?: undefined;
+    } | {
+        title: string;
+        description: string;
+        name: "activity";
+        operations: string[];
+        schema: string;
     } | {
         title: string;
         description: string;