@botpress/api 1.31.0 → 1.32.0

package/src/gen/runtime/state.ts

@@ -2610,7 +2610,7 @@ export const 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": [

package/src/gen/state.ts

@@ -9176,6 +9176,109 @@ export const state = {
         }
       }
     },
+    "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",
@@ -16495,9 +16598,10 @@ export const state = {
                     "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",
@@ -17511,6 +17615,11 @@ export const state = {
           "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": {
@@ -17623,7 +17732,8 @@ export const state = {
                       "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"
@@ -17637,17 +17747,18 @@ export const state = {
                           "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": [
@@ -19359,7 +19470,7 @@ export const 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": [
@@ -19523,6 +19634,7 @@ export const state = {
       "deployBotVersionBody": true,
       "createIntegrationShareableIdBody": true,
       "createBotApiKeyBody": true,
+      "updateBotAllowlistBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -19653,6 +19765,8 @@ export const state = {
       "listBotApiKeysResponse": true,
       "createBotApiKeyResponse": true,
       "deleteBotApiKeyResponse": true,
+      "getBotAllowlistResponse": true,
+      "updateBotAllowlistResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -23421,7 +23535,9 @@ export const state = {
         "unlinkSandboxedConversations",
         "listBotApiKeys",
         "createBotApiKey",
-        "deleteBotApiKey"
+        "deleteBotApiKey",
+        "getBotAllowlist",
+        "updateBotAllowlist"
       ],
       "schema": "Bot"
     },