@botpress/api 0.15.12 → 0.16.2

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" | "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" | "tables">;
 export declare const state: {
     operations: {
         createConversation: {
@@ -1404,6 +1404,279 @@ 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";
+                            description: string;
+                        };
+                        instruction: {
+                            type: "string";
+                            description: string;
+                        };
+                        type: {
+                            type: "string";
+                            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;
+                        };
+                        instruction: {
+                            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;
@@ -1939,6 +2212,25 @@ export declare const state: {
                                 additionalProperties: false;
                             };
                         };
+                        subscriptions: {
+                            type: "object";
+                            properties: {
+                                events: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        type: "object";
+                                        additionalProperties: {
+                                            readOnly: true;
+                                        };
+                                    };
+                                    nullable: true;
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
                         configuration: {
                             type: "object";
                             properties: {
@@ -2319,6 +2611,24 @@ export declare const state: {
                                 additionalProperties: false;
                             };
                         };
+                        subscriptions: {
+                            type: "object";
+                            properties: {
+                                events: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        type: "object";
+                                        additionalProperties: {
+                                            readOnly: true;
+                                        };
+                                        nullable: true;
+                                    };
+                                    nullable: true;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
                         code: {
                             type: "string";
                             description: string;
@@ -3280,6 +3590,36 @@ export declare const state: {
                         spendingLimit: {
                             type: "number";
                         };
+                        about: {
+                            default: string;
+                            type: "string";
+                        };
+                        profilePicture: {
+                            default: string;
+                            type: "string";
+                        };
+                        contactEmail: {
+                            default: string;
+                            type: "string";
+                        };
+                        website: {
+                            default: string;
+                            type: "string";
+                        };
+                        socialAccounts: {
+                            default: never[];
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                        };
+                        isPublic: {
+                            type: "boolean";
+                        };
+                        handle: {
+                            default: string;
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -3345,6 +3685,36 @@ export declare const state: {
                         spendingLimit: {
                             type: "number";
                         };
+                        about: {
+                            default: string;
+                            type: "string";
+                        };
+                        profilePicture: {
+                            default: string;
+                            type: "string";
+                        };
+                        contactEmail: {
+                            default: string;
+                            type: "string";
+                        };
+                        website: {
+                            default: string;
+                            type: "string";
+                        };
+                        socialAccounts: {
+                            default: never[];
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                        };
+                        isPublic: {
+                            type: "boolean";
+                        };
+                        handle: {
+                            default: string;
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -3635,9 +4005,37 @@ export declare const state: {
                             minimum: number;
                             maximum: number;
                         };
+                        about: {
+                            type: "string";
+                        };
+                        profilePicture: {
+                            type: "string";
+                        };
+                        contactEmail: {
+                            type: "string";
+                        };
+                        website: {
+                            type: "string";
+                        };
+                        socialAccounts: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                            maxItems: number;
+                        };
+                        isPublic: {
+                            type: "boolean";
+                        };
+                        handle: {
+                            type: "string";
+                            minLength: number;
+                            maxLength: number;
+                            pattern: string;
+                        };
                     };
-                    title: string;
                     additionalProperties: false;
+                    title: string;
                 };
             };
             response: {
@@ -3681,12 +4079,93 @@ export declare const state: {
                         spendingLimit: {
                             type: "number";
                         };
+                        about: {
+                            default: string;
+                            type: "string";
+                        };
+                        profilePicture: {
+                            default: string;
+                            type: "string";
+                        };
+                        contactEmail: {
+                            default: string;
+                            type: "string";
+                        };
+                        website: {
+                            default: string;
+                            type: "string";
+                        };
+                        socialAccounts: {
+                            default: never[];
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                        };
+                        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;
@@ -3744,11 +4223,41 @@ export declare const state: {
                                         type: "string";
                                         enum: string[];
                                     };
-                                    blocked: {
+                                    blocked: {
+                                        type: "boolean";
+                                    };
+                                    spendingLimit: {
+                                        type: "number";
+                                    };
+                                    about: {
+                                        default: string;
+                                        type: "string";
+                                    };
+                                    profilePicture: {
+                                        default: string;
+                                        type: "string";
+                                    };
+                                    contactEmail: {
+                                        default: string;
+                                        type: "string";
+                                    };
+                                    website: {
+                                        default: string;
+                                        type: "string";
+                                    };
+                                    socialAccounts: {
+                                        default: never[];
+                                        type: "array";
+                                        items: {
+                                            type: "string";
+                                        };
+                                    };
+                                    isPublic: {
                                         type: "boolean";
                                     };
-                                    spendingLimit: {
-                                        type: "number";
+                                    handle: {
+                                        default: string;
+                                        type: "string";
                                     };
                                 };
                                 required: string[];
@@ -3844,6 +4353,36 @@ export declare const state: {
                         spendingLimit: {
                             type: "number";
                         };
+                        about: {
+                            default: string;
+                            type: "string";
+                        };
+                        profilePicture: {
+                            default: string;
+                            type: "string";
+                        };
+                        contactEmail: {
+                            default: string;
+                            type: "string";
+                        };
+                        website: {
+                            default: string;
+                            type: "string";
+                        };
+                        socialAccounts: {
+                            default: never[];
+                            type: "array";
+                            items: {
+                                type: "string";
+                            };
+                        };
+                        isPublic: {
+                            type: "boolean";
+                        };
+                        handle: {
+                            default: string;
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -3989,6 +4528,9 @@ export declare const state: {
                                     email: {
                                         type: "string";
                                     };
+                                    createdAt: {
+                                        type: "string";
+                                    };
                                     role: {
                                         type: "string";
                                         enum: string[];
@@ -4076,6 +4618,9 @@ export declare const state: {
                         email: {
                             type: "string";
                         };
+                        createdAt: {
+                            type: "string";
+                        };
                         role: {
                             type: "string";
                             enum: string[];
@@ -4130,6 +4675,9 @@ export declare const state: {
                         email: {
                             type: "string";
                         };
+                        createdAt: {
+                            type: "string";
+                        };
                         role: {
                             type: "string";
                             enum: string[];
@@ -5507,6 +6055,8 @@ export declare const state: {
             patchStateBody: true;
             callActionBody: true;
             configureIntegrationBody: true;
+            createTaskBody: true;
+            updateTaskBody: true;
             runVrlBody: true;
             createPersonalAccessTokenBody: true;
             setAccountPreferenceBody: true;
@@ -5517,6 +6067,7 @@ export declare const state: {
             chargeWorkspaceUnpaidInvoicesBody: true;
             createWorkspaceBody: true;
             updateWorkspaceBody: true;
+            checkHandleAvailabilityBody: true;
             changeWorkspacePlanBody: true;
             createWorkspaceMemberBody: true;
             updateWorkspaceMemberBody: true;
@@ -5557,6 +6108,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;
@@ -5591,6 +6147,7 @@ export declare const state: {
             getWorkspaceQuotaResponse: true;
             listWorkspaceQuotasResponse: true;
             updateWorkspaceResponse: true;
+            checkHandleAvailabilityResponse: true;
             listWorkspacesResponse: true;
             changeWorkspacePlanResponse: true;
             deleteWorkspaceResponse: true;
@@ -5630,6 +6187,7 @@ export declare const state: {
             Event: true;
             Message: true;
             State: true;
+            Task: true;
             File: true;
             Table: true;
             Column: true;
@@ -5927,12 +6485,41 @@ export declare const state: {
                                     type: "object";
                                     additionalProperties: true;
                                 };
+                                failedAttempts: {
+                                    type: "number";
+                                    description: string;
+                                };
+                                lastFailureReason: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                    nullable: true;
+                                };
                             };
                             required: string[];
                             additionalProperties: false;
                         };
                         description: string;
                     };
+                    subscriptions: {
+                        type: "object";
+                        properties: {
+                            events: {
+                                type: "object";
+                                additionalProperties: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        readOnly: true;
+                                    };
+                                };
+                                nullable: true;
+                                description: string;
+                            };
+                        };
+                        required: string[];
+                        description: string;
+                        additionalProperties: false;
+                    };
                     name: {
                         type: "string";
                         description: string;
@@ -6382,6 +6969,36 @@ export declare const state: {
                     spendingLimit: {
                         type: "number";
                     };
+                    about: {
+                        default: string;
+                        type: "string";
+                    };
+                    profilePicture: {
+                        default: string;
+                        type: "string";
+                    };
+                    contactEmail: {
+                        default: string;
+                        type: "string";
+                    };
+                    website: {
+                        default: string;
+                        type: "string";
+                    };
+                    socialAccounts: {
+                        default: never[];
+                        type: "array";
+                        items: {
+                            type: "string";
+                        };
+                    };
+                    isPublic: {
+                        type: "boolean";
+                    };
+                    handle: {
+                        default: string;
+                        type: "string";
+                    };
                 };
                 required: string[];
                 additionalProperties: false;
@@ -6402,6 +7019,9 @@ export declare const state: {
                     email: {
                         type: "string";
                     };
+                    createdAt: {
+                        type: "string";
+                    };
                     role: {
                         type: "string";
                         enum: string[];
@@ -6608,6 +7228,12 @@ export declare const state: {
                         maxLength: number;
                         description: string;
                     };
+                    currentTaskId: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
                     createdAt: {
                         type: "string";
                         format: string;
@@ -6683,6 +7309,16 @@ export declare const state: {
                         maxLength: number;
                         description: string;
                     };
+                    status: {
+                        type: "string";
+                        enum: string[];
+                    };
+                    failureReason: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                        nullable: true;
+                    };
                 };
                 required: string[];
                 description: string;
@@ -6805,6 +7441,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;
+                    };
+                    instruction: {
+                        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: {
@@ -6865,53 +7587,74 @@ 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[];
+                            };
+                            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";
@@ -7049,6 +7792,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;