@botpress/api 0.52.0 → 0.53.0

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

@@ -1,5 +1,5 @@
 import * as opapi from '@bpinternal/opapi';
-export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'bot' | 'integration' | 'interface' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
+export type State = opapi.State<'Bot' | 'Integration' | 'Interface' | 'Plugin' | 'Workspace' | 'WorkspaceMember' | 'Account' | 'Usage' | 'Issue' | 'IssueEvent' | 'Activity' | 'Version' | 'User' | 'Conversation' | 'Event' | 'Message' | 'State' | 'Task' | 'Workflow' | 'Table' | 'Column' | 'Row' | 'File', never, 'user' | 'conversation' | 'event' | 'message' | 'state' | 'hub' | 'action' | 'task' | 'workflow' | 'bot' | 'integration' | 'interface' | 'plugin' | 'workspace' | 'workspaceMember' | 'account' | 'usage' | 'quotas' | 'helper' | 'activity' | 'tables' | 'files'>;
 export declare const state: {
     operations: {
         createConversation: {
@@ -8917,6 +8917,556 @@ export declare const state: {
                 };
             };
         };
+        createPlugin: {
+            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;
+                        };
+                        configuration: {
+                            type: "object";
+                            properties: {
+                                title: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                schema: {
+                                    type: "object";
+                                    additionalProperties: true;
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                        states: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    type: {
+                                        type: "string";
+                                        enum: string[];
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                        description: string;
+                                    };
+                                    expiry: {
+                                        type: "number";
+                                        minimum: number;
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                                additionalProperties: false;
+                            };
+                        };
+                        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;
+                                    };
+                                    billable: {
+                                        type: "boolean";
+                                    };
+                                    cacheable: {
+                                        type: "boolean";
+                                    };
+                                    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;
+                            };
+                        };
+                        user: {
+                            type: "object";
+                            properties: {
+                                tags: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        type: "object";
+                                        properties: {
+                                            title: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                            description: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                        };
+                                        description: string;
+                                        additionalProperties: false;
+                                    };
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            additionalProperties: false;
+                        };
+                        code: {
+                            type: "string";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "plugin";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        plugin: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getPlugin: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "plugin";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        plugin: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getPluginByName: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            parameters: {
+                name: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+                version: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "plugin";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        plugin: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        updatePlugin: {
+            name: string;
+            description: string;
+            method: "put";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        configuration: {
+                            type: "object";
+                            properties: {
+                                title: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                schema: {
+                                    type: "object";
+                                    additionalProperties: true;
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            nullable: true;
+                            additionalProperties: false;
+                        };
+                        states: {
+                            type: "object";
+                            additionalProperties: {
+                                type: "object";
+                                properties: {
+                                    type: {
+                                        type: "string";
+                                        enum: string[];
+                                        description: string;
+                                    };
+                                    schema: {
+                                        type: "object";
+                                        additionalProperties: true;
+                                        description: string;
+                                    };
+                                    expiry: {
+                                        type: "number";
+                                        minimum: number;
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                                nullable: true;
+                                additionalProperties: false;
+                            };
+                        };
+                        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;
+                                    };
+                                    billable: {
+                                        type: "boolean";
+                                    };
+                                    cacheable: {
+                                        type: "boolean";
+                                    };
+                                    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;
+                            };
+                        };
+                        user: {
+                            type: "object";
+                            properties: {
+                                tags: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        type: "object";
+                                        properties: {
+                                            title: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                            description: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                        };
+                                        description: string;
+                                        additionalProperties: false;
+                                    };
+                                };
+                            };
+                            required: string[];
+                            description: string;
+                            nullable: true;
+                            additionalProperties: false;
+                        };
+                        code: {
+                            type: "string";
+                        };
+                    };
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            section: "plugin";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        plugin: {
+                            $ref: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deletePlugin: {
+            name: string;
+            description: string;
+            method: "delete";
+            path: string;
+            parameters: {
+                id: {
+                    in: "path";
+                    type: "string";
+                    description: string;
+                };
+            };
+            section: "plugin";
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        listPlugins: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "plugin";
+            parameters: {
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+                name: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        plugins: {
+                            type: "array";
+                            items: {
+                                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;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         getUsage: {
             name: string;
             path: string;
@@ -11050,6 +11600,8 @@ export declare const state: {
             requestIntegrationVerificationBody: true;
             createInterfaceBody: true;
             updateInterfaceBody: true;
+            createPluginBody: true;
+            updatePluginBody: true;
             changeAISpendQuotaBody: true;
             introspectBody: true;
             upsertFileBody: true;
@@ -11177,6 +11729,12 @@ export declare const state: {
             updateInterfaceResponse: true;
             deleteInterfaceResponse: true;
             listInterfacesResponse: true;
+            createPluginResponse: true;
+            getPluginResponse: true;
+            getPluginByNameResponse: true;
+            updatePluginResponse: true;
+            deletePluginResponse: true;
+            listPluginsResponse: true;
             getUsageResponse: true;
             getMultipleUsagesResponse: true;
             listUsageHistoryResponse: true;
@@ -11210,6 +11768,7 @@ export declare const state: {
             Bot: true;
             Integration: true;
             Interface: true;
+            Plugin: true;
             Workspace: true;
             WorkspaceMember: true;
             Account: true;
@@ -12384,6 +12943,196 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Plugin: {
+            section: "plugin";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                        minLength: number;
+                        maxLength: number;
+                        description: string;
+                    };
+                    name: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                    };
+                    version: {
+                        type: "string";
+                        maxLength: number;
+                        description: string;
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                    updatedAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                    configuration: {
+                        type: "object";
+                        properties: {
+                            title: {
+                                type: "string";
+                                maxLength: number;
+                                description: string;
+                            };
+                            description: {
+                                type: "string";
+                                maxLength: number;
+                                description: string;
+                            };
+                            schema: {
+                                type: "object";
+                                additionalProperties: true;
+                                description: string;
+                            };
+                        };
+                        required: string[];
+                        description: string;
+                        additionalProperties: false;
+                    };
+                    states: {
+                        type: "object";
+                        additionalProperties: {
+                            type: "object";
+                            properties: {
+                                type: {
+                                    type: "string";
+                                    enum: string[];
+                                    description: string;
+                                };
+                                schema: {
+                                    type: "object";
+                                    additionalProperties: true;
+                                    description: string;
+                                };
+                                expiry: {
+                                    type: "number";
+                                    minimum: number;
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                    };
+                    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;
+                                };
+                                billable: {
+                                    type: "boolean";
+                                };
+                                cacheable: {
+                                    type: "boolean";
+                                };
+                                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;
+                        };
+                    };
+                    user: {
+                        type: "object";
+                        properties: {
+                            tags: {
+                                type: "object";
+                                additionalProperties: {
+                                    type: "object";
+                                    properties: {
+                                        title: {
+                                            type: "string";
+                                            maxLength: number;
+                                            description: string;
+                                        };
+                                        description: {
+                                            type: "string";
+                                            maxLength: number;
+                                            description: string;
+                                        };
+                                    };
+                                    description: string;
+                                    additionalProperties: false;
+                                };
+                            };
+                        };
+                        required: string[];
+                        description: string;
+                        additionalProperties: false;
+                    };
+                    code: {
+                        type: "string";
+                    };
+                };
+                required: string[];
+                description: string;
+                additionalProperties: false;
+            };
+        };
         Workspace: {
             section: "workspace";
             schema: {
@@ -13652,6 +14401,12 @@ export declare const state: {
         name: "interface";
         operations: string[];
         schema: string;
+    } | {
+        title: string;
+        description: string;
+        name: "plugin";
+        operations: string[];
+        schema: string;
     } | {
         title: string;
         description: string;