@botpress/api 0.31.0 → 0.32.1

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' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
+export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'file' | 'state' | 'hub' | 'action' | 'task' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
 export declare const state: {
     operations: {
         createConversation: {
@@ -3942,6 +3942,18 @@ export declare const state: {
                     description: string;
                     type: "string";
                 };
+                sortField: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    enum: string[];
+                };
+                sortDirection: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    enum: string[];
+                };
             };
             section: "bot";
             response: {
@@ -7174,63 +7186,517 @@ export declare const state: {
                 };
             };
         };
-        getIntegration: {
+        getIntegration: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "integration";
+            path: string;
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        integration: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getIntegrationLogs: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "integration";
+            path: string;
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                timeStart: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                timeEnd: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        logs: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    timestamp: {
+                                        type: "string";
+                                    };
+                                    level: {
+                                        type: "string";
+                                    };
+                                    message: {
+                                        type: "string";
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        nextToken: {
+                            type: "string";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getIntegrationByName: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "integration";
+            path: string;
+            parameters: {
+                name: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                version: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        integration: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deleteIntegration: {
+            name: string;
+            description: string;
+            method: "delete";
+            section: "integration";
+            path: string;
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        createInterface: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            parameters: {};
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        name: {
+                            type: "string";
+                            maxLength: number;
+                            description: string;
+                        };
+                        version: {
+                            type: "string";
+                            maxLength: number;
+                            description: string;
+                        };
+                        events: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                additionalProperties: false;
+                            };
+                        };
+                        actions: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    input: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                    output: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                additionalProperties: false;
+                            };
+                        };
+                        entities: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                additionalProperties: false;
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "interface";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        interface: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getInterface: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "interface";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        interface: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getInterfaceByName: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                name: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+                version: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "interface";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        interface: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        updateInterface: {
+            name: string;
+            description: string;
+            method: "put";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        events: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                nullable: true;
+                                additionalProperties: false;
+                            };
+                        };
+                        actions: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    input: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                    output: {
+                                        type: "object";
+                                        properties: {
+                                            schema: {
+                                                type: "object";
+                                                additionalProperties: true;
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                nullable: true;
+                                additionalProperties: false;
+                            };
+                        };
+                        entities: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    title: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                    };
+                                };
+                                required: string[];
+                                description: string;
+                                nullable: true;
+                                additionalProperties: false;
+                            };
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "interface";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        interface: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deleteInterface: {
             name: string;
             description: string;
-            method: "get";
-            section: "integration";
+            method: "delete";
             path: string;
             parameters: {
                 id: {
+                    in: "path";
                     type: "string";
                     description: string;
-                    in: "path";
                 };
             };
+            section: "interface";
             response: {
                 description: string;
                 schema: {
                     type: "object";
-                    properties: {
-                        integration: {
-                            $ref: string;
-                        };
-                    };
-                    required: string[];
                     title: string;
                     additionalProperties: false;
                 };
             };
         };
-        getIntegrationLogs: {
+        listInterfaces: {
             name: string;
             description: string;
             method: "get";
-            section: "integration";
             path: string;
+            section: "interface";
             parameters: {
-                id: {
-                    type: "string";
-                    description: string;
-                    in: "path";
-                };
-                timeStart: {
-                    in: "query";
-                    description: string;
-                    type: "string";
-                    required: true;
-                };
-                timeEnd: {
-                    in: "query";
-                    description: string;
-                    type: "string";
-                    required: true;
-                };
                 nextToken: {
                     in: "query";
                     description: string;
                     type: "string";
-                    required: false;
                 };
             };
             response: {
@@ -7238,59 +7704,50 @@ export declare const state: {
                 schema: {
                     type: "object";
                     properties: {
-                        logs: {
+                        interfaces: {
                             type: "array";
                             items: {
                                 type: "object";
                                 properties: {
-                                    timestamp: {
+                                    id: {
                                         type: "string";
+                                        minLength: number;
+                                        maxLength: number;
+                                        description: string;
                                     };
-                                    level: {
+                                    createdAt: {
                                         type: "string";
+                                        format: string;
+                                        description: string;
                                     };
-                                    message: {
+                                    updatedAt: {
+                                        type: "string";
+                                        format: string;
+                                        description: string;
+                                    };
+                                    name: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    version: {
                                         type: "string";
+                                        maxLength: number;
+                                        description: string;
                                     };
                                 };
                                 required: string[];
                             };
                         };
-                        nextToken: {
-                            type: "string";
-                        };
-                    };
-                    required: string[];
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-        };
-        getIntegrationByName: {
-            name: string;
-            description: string;
-            method: "get";
-            section: "integration";
-            path: string;
-            parameters: {
-                name: {
-                    type: "string";
-                    description: string;
-                    in: "path";
-                };
-                version: {
-                    type: "string";
-                    description: string;
-                    in: "path";
-                };
-            };
-            response: {
-                description: string;
-                schema: {
-                    type: "object";
-                    properties: {
-                        integration: {
-                            $ref: string;
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
                         };
                     };
                     required: string[];
@@ -7299,28 +7756,6 @@ export declare const state: {
                 };
             };
         };
-        deleteIntegration: {
-            name: string;
-            description: string;
-            method: "delete";
-            section: "integration";
-            path: string;
-            parameters: {
-                id: {
-                    type: "string";
-                    description: string;
-                    in: "path";
-                };
-            };
-            response: {
-                description: string;
-                schema: {
-                    type: "object";
-                    title: string;
-                    additionalProperties: false;
-                };
-            };
-        };
         getUsage: {
             name: string;
             path: string;
@@ -9087,6 +9522,8 @@ export declare const state: {
             createIntegrationApiKeyBody: true;
             createIntegrationBody: true;
             updateIntegrationBody: true;
+            createInterfaceBody: true;
+            updateInterfaceBody: true;
             changeAISpendQuotaBody: true;
             introspectBody: true;
             upsertFileBody: true;
@@ -9197,6 +9634,12 @@ export declare const state: {
             getIntegrationLogsResponse: true;
             getIntegrationByNameResponse: true;
             deleteIntegrationResponse: true;
+            createInterfaceResponse: true;
+            getInterfaceResponse: true;
+            getInterfaceByNameResponse: true;
+            updateInterfaceResponse: true;
+            deleteInterfaceResponse: true;
+            listInterfacesResponse: true;
             getUsageResponse: true;
             getMultipleUsagesResponse: true;
             listUsageHistoryResponse: true;
@@ -9227,6 +9670,7 @@ export declare const state: {
         schemas: {
             Bot: true;
             Integration: true;
+            Interface: true;
             Workspace: true;
             WorkspaceMember: true;
             Account: true;
@@ -10110,6 +10554,135 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Interface: {
+            section: "interface";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                    updatedAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                    name: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                    };
+                    version: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                    };
+                    events: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "object";
+                            properties: {
+                                title: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                schema: {
+                                    type: "object";
+                                    additionalProperties: true;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                    };
+                    actions: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "object";
+                            properties: {
+                                title: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                input: {
+                                    type: "object";
+                                    properties: {
+                                        schema: {
+                                            type: "object";
+                                            additionalProperties: true;
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: false;
+                                };
+                                output: {
+                                    type: "object";
+                                    properties: {
+                                        schema: {
+                                            type: "object";
+                                            additionalProperties: true;
+                                        };
+                                    };
+                                    required: string[];
+                                    additionalProperties: false;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                    };
+                    entities: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "object";
+                            properties: {
+                                title: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                schema: {
+                                    type: "object";
+                                    additionalProperties: true;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
         Workspace: {
             section: "workspace";
             schema: {
@@ -11199,6 +11772,12 @@ export declare const state: {
         name: "integration";
         operations: string[];
         schema: string;
+    } | {
+        title: string;
+        description: string;
+        name: "interface";
+        operations: string[];
+        schema: string;
     } | {
         title: string;
         description: string;