@botpress/api 1.31.0 → 1.32.0

package/.turbo/turbo-openapi.log

@@ -1,5 +1,5 @@
 
-> @botpress/api@1.31.0 openapi /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.32.0 openapi /home/runner/work/skynet/skynet/packages/public-api
 > es-node openapi/generator.ts && pnpm run build
 
 Generating openapi content
@@ -34,18 +34,18 @@ Saving openapi.json file
 
 info: Exit with code {"category":"system","code":0,"label":"Shutdown"}
 
-> @botpress/api@1.31.0 build /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.32.0 build /home/runner/work/skynet/skynet/packages/public-api
 > pnpm run build:type && pnpm run build:impl
 
 
-> @botpress/api@1.31.0 build:type /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.32.0 build:type /home/runner/work/skynet/skynet/packages/public-api
 > tsc -p tsconfig.package.json --emitDeclarationOnly
 
 
-> @botpress/api@1.31.0 build:impl /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.32.0 build:impl /home/runner/work/skynet/skynet/packages/public-api
 > esbuild --bundle --platform=node --outfile=dist/index.js src/index.ts
 
 
   dist/index.js  14.1mb ⚠️
 
-⚡ Done in 913ms
+⚡ Done in 930ms

package/dist/index.js

@@ -285334,7 +285334,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.31.0",
+    "version": "1.32.0",
     "prefix": "v1"
   },
   "errors": [
@@ -295837,6 +295837,109 @@ var state2 = {
         }
       }
     },
+    "getBotAllowlist": {
+      "name": "getBotAllowlist",
+      "description": "Get the Bot Allowlist",
+      "method": "get",
+      "section": "bot",
+      "path": "/v1/admin/bots/{botId}/allowlist",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "setting": {
+              "type": "string",
+              "enum": [
+                "ALL_WORKSPACE_USERS",
+                "SELECTED_USERS"
+              ],
+              "description": "Allowlist setting of the bot"
+            },
+            "users": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id"
+                ]
+              }
+            }
+          },
+          "required": [
+            "setting",
+            "users"
+          ],
+          "title": "getBotAllowlistResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "updateBotAllowlist": {
+      "name": "updateBotAllowlist",
+      "description": "Update the Bot Allowlist",
+      "method": "put",
+      "section": "bot",
+      "path": "/v1/admin/bots/{botId}/allowlist",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Allowlist body",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "setting": {
+              "type": "string",
+              "enum": [
+                "ALL_WORKSPACE_USERS",
+                "SELECTED_USERS"
+              ],
+              "description": "Allowlist setting of the bot"
+            },
+            "modifiedUsers": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "boolean",
+                  "description": "If `true`, the user should be added to the allowlist. If `false`, the user should be removed from the allowlist. This performs a partial update, so any existing users not included here will be kept in the allowlist"
+                }
+              }
+            }
+          },
+          "required": [
+            "modifiedUsers"
+          ],
+          "title": "updateBotAllowlistBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "updateBotAllowlistResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listWorkspaceInvoices": {
       "name": "listWorkspaceInvoices",
       "description": "List invoices billed to workspace",
@@ -303045,7 +303148,7 @@ var state2 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.31.0",
+    "version": "1.32.0",
     "prefix": "v1"
   },
   "errors": [
@@ -303186,6 +303289,7 @@ var state2 = {
       "deployBotVersionBody": true,
       "createIntegrationShareableIdBody": true,
       "createBotApiKeyBody": true,
+      "updateBotAllowlistBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -303254,6 +303358,8 @@ var state2 = {
       "listBotApiKeysResponse": true,
       "createBotApiKeyResponse": true,
       "deleteBotApiKeyResponse": true,
+      "getBotAllowlistResponse": true,
+      "updateBotAllowlistResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -306936,7 +307042,9 @@ var state2 = {
         "unlinkSandboxedConversations",
         "listBotApiKeys",
         "createBotApiKey",
-        "deleteBotApiKey"
+        "deleteBotApiKey",
+        "getBotAllowlist",
+        "updateBotAllowlist"
       ],
       "schema": "Bot"
     },
@@ -307225,9 +307333,10 @@ var state3 = {
                     "stack": {
                       "type": "string",
                       "enum": [
+                        "legacy",
                         "realtime-v1"
                       ],
-                      "description": "Internal setting, cannot be set manually."
+                      "description": "If not set, the default indexing stack will be used."
                     },
                     "vision": {
                       "type": "object",
@@ -308241,6 +308350,11 @@ var state3 = {
           "in": "query",
           "type": "boolean",
           "description": "Prepend a breadcrumb to each passage, containing the title and subtitle(s) the passage belongs to in the file. This option is ignored when the `consolidate` option is set to `true`."
+        },
+        "withContext": {
+          "in": "query",
+          "type": "boolean",
+          "description": "Include the surrounding context with each passage in the `context` property of each passage. Not supported when `consolidate` is set to `true`."
         }
       },
       "response": {
@@ -308353,7 +308467,8 @@ var state3 = {
                       "properties": {
                         "id": {
                           "type": "string",
-                          "format": "uuid"
+                          "format": "uuid",
+                          "description": "The ID of the vector that the context passage belongs to. Omitted for breadcrumbs."
                         },
                         "text": {
                           "type": "string"
@@ -308367,17 +308482,18 @@ var state3 = {
                           "enum": [
                             "preceding",
                             "subsequent",
+                            "current",
                             "breadcrumb"
                           ],
                           "description": "The type of context passage"
                         }
                       },
                       "required": [
-                        "id",
                         "text",
                         "type"
                       ]
-                    }
+                    },
+                    "description": "Surrounding passages including the current passage, based on the requested `contextDepth`. Only returned if the `withContext` parameter is set to `true`. Not supported when using the `consolidate` option."
                   }
                 },
                 "required": [
@@ -308883,7 +308999,7 @@ var state3 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.31.0",
+    "version": "1.32.0",
     "prefix": "v1"
   },
   "errors": [
@@ -313945,7 +314061,7 @@ var state4 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.31.0",
+    "version": "1.32.0",
     "prefix": "v1"
   },
   "errors": [
@@ -326972,6 +327088,109 @@ var state5 = {
         }
       }
     },
+    "getBotAllowlist": {
+      "name": "getBotAllowlist",
+      "description": "Get the Bot Allowlist",
+      "method": "get",
+      "section": "bot",
+      "path": "/v1/admin/bots/{botId}/allowlist",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "setting": {
+              "type": "string",
+              "enum": [
+                "ALL_WORKSPACE_USERS",
+                "SELECTED_USERS"
+              ],
+              "description": "Allowlist setting of the bot"
+            },
+            "users": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id"
+                ]
+              }
+            }
+          },
+          "required": [
+            "setting",
+            "users"
+          ],
+          "title": "getBotAllowlistResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "updateBotAllowlist": {
+      "name": "updateBotAllowlist",
+      "description": "Update the Bot Allowlist",
+      "method": "put",
+      "section": "bot",
+      "path": "/v1/admin/bots/{botId}/allowlist",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Allowlist body",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "setting": {
+              "type": "string",
+              "enum": [
+                "ALL_WORKSPACE_USERS",
+                "SELECTED_USERS"
+              ],
+              "description": "Allowlist setting of the bot"
+            },
+            "modifiedUsers": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "additionalProperties": {
+                  "type": "boolean",
+                  "description": "If `true`, the user should be added to the allowlist. If `false`, the user should be removed from the allowlist. This performs a partial update, so any existing users not included here will be kept in the allowlist"
+                }
+              }
+            }
+          },
+          "required": [
+            "modifiedUsers"
+          ],
+          "title": "updateBotAllowlistBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "updateBotAllowlistResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listWorkspaceInvoices": {
       "name": "listWorkspaceInvoices",
       "description": "List invoices billed to workspace",
@@ -334291,9 +334510,10 @@ var state5 = {
                     "stack": {
                       "type": "string",
                       "enum": [
+                        "legacy",
                         "realtime-v1"
                       ],
-                      "description": "Internal setting, cannot be set manually."
+                      "description": "If not set, the default indexing stack will be used."
                     },
                     "vision": {
                       "type": "object",
@@ -335307,6 +335527,11 @@ var state5 = {
           "in": "query",
           "type": "boolean",
           "description": "Prepend a breadcrumb to each passage, containing the title and subtitle(s) the passage belongs to in the file. This option is ignored when the `consolidate` option is set to `true`."
+        },
+        "withContext": {
+          "in": "query",
+          "type": "boolean",
+          "description": "Include the surrounding context with each passage in the `context` property of each passage. Not supported when `consolidate` is set to `true`."
         }
       },
       "response": {
@@ -335419,7 +335644,8 @@ var state5 = {
                       "properties": {
                         "id": {
                           "type": "string",
-                          "format": "uuid"
+                          "format": "uuid",
+                          "description": "The ID of the vector that the context passage belongs to. Omitted for breadcrumbs."
                         },
                         "text": {
                           "type": "string"
@@ -335433,17 +335659,18 @@ var state5 = {
                           "enum": [
                             "preceding",
                             "subsequent",
+                            "current",
                             "breadcrumb"
                           ],
                           "description": "The type of context passage"
                         }
                       },
                       "required": [
-                        "id",
                         "text",
                         "type"
                       ]
-                    }
+                    },
+                    "description": "Surrounding passages including the current passage, based on the requested `contextDepth`. Only returned if the `withContext` parameter is set to `true`. Not supported when using the `consolidate` option."
                   }
                 },
                 "required": [
@@ -337155,7 +337382,7 @@ var state5 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.31.0",
+    "version": "1.32.0",
     "prefix": "v1"
   },
   "errors": [
@@ -337319,6 +337546,7 @@ var state5 = {
       "deployBotVersionBody": true,
       "createIntegrationShareableIdBody": true,
       "createBotApiKeyBody": true,
+      "updateBotAllowlistBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -337449,6 +337677,8 @@ var state5 = {
       "listBotApiKeysResponse": true,
       "createBotApiKeyResponse": true,
       "deleteBotApiKeyResponse": true,
+      "getBotAllowlistResponse": true,
+      "updateBotAllowlistResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -341217,7 +341447,9 @@ var state5 = {
         "unlinkSandboxedConversations",
         "listBotApiKeys",
         "createBotApiKey",
-        "deleteBotApiKey"
+        "deleteBotApiKey",
+        "getBotAllowlist",
+        "updateBotAllowlist"
       ],
       "schema": "Bot"
     },

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

@@ -5786,6 +5786,96 @@ export declare const state: {
                 };
             };
         };
+        getBotAllowlist: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "bot";
+            path: string;
+            parameters: {
+                botId: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        setting: {
+                            type: "string";
+                            enum: string[];
+                            description: string;
+                        };
+                        users: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        updateBotAllowlist: {
+            name: string;
+            description: string;
+            method: "put";
+            section: "bot";
+            path: string;
+            parameters: {
+                botId: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        setting: {
+                            type: "string";
+                            enum: string[];
+                            description: string;
+                        };
+                        modifiedUsers: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                additionalProperties: {
+                                    type: "boolean";
+                                    description: string;
+                                };
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         listWorkspaceInvoices: {
             name: string;
             description: string;
@@ -12228,6 +12318,7 @@ export declare const state: {
             deployBotVersionBody: true;
             createIntegrationShareableIdBody: true;
             createBotApiKeyBody: true;
+            updateBotAllowlistBody: true;
             chargeWorkspaceUnpaidInvoicesBody: true;
             createWorkspaceBody: true;
             updateWorkspaceBody: true;
@@ -12296,6 +12387,8 @@ export declare const state: {
             listBotApiKeysResponse: true;
             createBotApiKeyResponse: true;
             deleteBotApiKeyResponse: true;
+            getBotAllowlistResponse: true;
+            updateBotAllowlistResponse: true;
             listWorkspaceInvoicesResponse: true;
             getUpcomingInvoiceResponse: true;
             chargeWorkspaceUnpaidInvoicesResponse: true;

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

@@ -941,6 +941,11 @@ export declare const state: {
                     type: "boolean";
                     description: string;
                 };
+                withContext: {
+                    in: "query";
+                    type: "boolean";
+                    description: string;
+                };
             };
             response: {
                 description: string;
@@ -1031,6 +1036,7 @@ export declare const state: {
                                                 id: {
                                                     type: "string";
                                                     format: string;
+                                                    description: string;
                                                 };
                                                 text: {
                                                     type: "string";
@@ -1047,6 +1053,7 @@ export declare const state: {
                                             };
                                             required: string[];
                                         };
+                                        description: string;
                                     };
                                 };
                                 required: string[];