@botpress/api 1.11.0 → 1.13.0

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

@@ -4978,6 +4978,617 @@ export declare const state: {
                 };
             };
         };
+        listPublicInterfaces: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "hub";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+                name: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
+                version: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        interfaces: {
+                            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;
+                                    };
+                                    title: {
+                                        type: "string";
+                                        minLength: number;
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    description: {
+                                        type: "string";
+                                        maxLength: number;
+                                        description: string;
+                                    };
+                                    iconUrl: {
+                                        type: "string";
+                                        description: string;
+                                    };
+                                    readmeUrl: {
+                                        type: "string";
+                                        description: string;
+                                    };
+                                    public: {
+                                        type: "boolean";
+                                        description: string;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getPublicInterfaceById: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "hub";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        interface: {
+                            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;
+                                };
+                                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;
+                                    };
+                                };
+                                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;
+                                            };
+                                            attributes: {
+                                                type: "object";
+                                                additionalProperties: {
+                                                    type: "string";
+                                                    maxLength: number;
+                                                };
+                                                description: string;
+                                            };
+                                        };
+                                        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;
+                                            };
+                                            attributes: {
+                                                type: "object";
+                                                additionalProperties: {
+                                                    type: "string";
+                                                    maxLength: number;
+                                                };
+                                                description: string;
+                                            };
+                                        };
+                                        required: string[];
+                                        description: string;
+                                        additionalProperties: false;
+                                    };
+                                };
+                                channels: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        type: "object";
+                                        properties: {
+                                            title: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                            description: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                            messages: {
+                                                type: "object";
+                                                additionalProperties: {
+                                                    type: "object";
+                                                    properties: {
+                                                        schema: {
+                                                            type: "object";
+                                                            additionalProperties: true;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                    description: string;
+                                                    additionalProperties: false;
+                                                };
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                };
+                                nameTemplate: {
+                                    type: "object";
+                                    properties: {
+                                        script: {
+                                            type: "string";
+                                            maxLength: number;
+                                        };
+                                        language: {
+                                            type: "string";
+                                            maxLength: number;
+                                        };
+                                    };
+                                    required: string[];
+                                    description: string;
+                                    additionalProperties: false;
+                                };
+                                title: {
+                                    type: "string";
+                                    minLength: number;
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                iconUrl: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                readmeUrl: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                public: {
+                                    type: "boolean";
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        getPublicInterface: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "hub";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                name: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                version: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        interface: {
+                            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;
+                                };
+                                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;
+                                    };
+                                };
+                                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;
+                                            };
+                                            attributes: {
+                                                type: "object";
+                                                additionalProperties: {
+                                                    type: "string";
+                                                    maxLength: number;
+                                                };
+                                                description: string;
+                                            };
+                                        };
+                                        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;
+                                            };
+                                            attributes: {
+                                                type: "object";
+                                                additionalProperties: {
+                                                    type: "string";
+                                                    maxLength: number;
+                                                };
+                                                description: string;
+                                            };
+                                        };
+                                        required: string[];
+                                        description: string;
+                                        additionalProperties: false;
+                                    };
+                                };
+                                channels: {
+                                    type: "object";
+                                    additionalProperties: {
+                                        type: "object";
+                                        properties: {
+                                            title: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                            description: {
+                                                type: "string";
+                                                maxLength: number;
+                                                description: string;
+                                            };
+                                            messages: {
+                                                type: "object";
+                                                additionalProperties: {
+                                                    type: "object";
+                                                    properties: {
+                                                        schema: {
+                                                            type: "object";
+                                                            additionalProperties: true;
+                                                        };
+                                                    };
+                                                    required: string[];
+                                                    description: string;
+                                                    additionalProperties: false;
+                                                };
+                                            };
+                                        };
+                                        required: string[];
+                                        additionalProperties: false;
+                                    };
+                                };
+                                nameTemplate: {
+                                    type: "object";
+                                    properties: {
+                                        script: {
+                                            type: "string";
+                                            maxLength: number;
+                                        };
+                                        language: {
+                                            type: "string";
+                                            maxLength: number;
+                                        };
+                                    };
+                                    required: string[];
+                                    description: string;
+                                    additionalProperties: false;
+                                };
+                                title: {
+                                    type: "string";
+                                    minLength: number;
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                description: {
+                                    type: "string";
+                                    maxLength: number;
+                                    description: string;
+                                };
+                                iconUrl: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                readmeUrl: {
+                                    type: "string";
+                                    description: string;
+                                };
+                                public: {
+                                    type: "boolean";
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         createBot: {
             name: string;
             description: string;
@@ -11646,6 +12257,11 @@ export declare const state: {
                     type: "string";
                     description: string;
                 };
+                version: {
+                    in: "query";
+                    type: "string";
+                    description: string;
+                };
             };
             response: {
                 description: string;
@@ -12810,12 +13426,34 @@ export declare const state: {
                             items: {
                                 type: "object";
                                 properties: {
+                                    key: {
+                                        type: "string";
+                                    };
                                     date: {
                                         type: "string";
                                     };
                                     value: {
                                         type: "number";
                                     };
+                                    metadata: {
+                                        type: "object";
+                                        properties: {
+                                            botId: {
+                                                type: "string";
+                                            };
+                                            type: {
+                                                type: "string";
+                                                enum: string[];
+                                            };
+                                            subtype: {
+                                                type: "string";
+                                            };
+                                            source: {
+                                                type: "string";
+                                            };
+                                        };
+                                        required: string[];
+                                    };
                                 };
                                 required: string[];
                             };
@@ -15558,6 +16196,9 @@ export declare const state: {
             getPublicPluginByIdResponse: true;
             getPublicPluginResponse: true;
             getPublicPluginCodeResponse: true;
+            listPublicInterfacesResponse: true;
+            getPublicInterfaceByIdResponse: true;
+            getPublicInterfaceResponse: true;
             createBotResponse: true;
             updateBotResponse: true;
             transferBotResponse: true;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "1.11.0",
+  "version": "1.13.0",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {