@botpress/api 1.5.1 → 1.7.0

package/src/gen/runtime/state.ts

@@ -1753,6 +1753,7 @@ export const state = {
             "identifier": {
               "type": "string",
               "maxLength": 200,
+              "nullable": true,
               "description": "Unique identifier of the integration that was installed on the bot"
             },
             "scheduleRegisterCall": {
@@ -1777,7 +1778,7 @@ export const state = {
                 "additionalProperties": false
               },
               "nullable": true,
-              "description": "Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations."
+              "description": "**EXPERIMENTAL** Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual           sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations."
             }
           },
           "title": "configureIntegrationBody",
@@ -2607,7 +2608,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.5.1",
+    "version": "1.7.0",
     "prefix": "v1"
   },
   "errors": [

package/src/gen/state.ts

@@ -1753,6 +1753,7 @@ export const state = {
             "identifier": {
               "type": "string",
               "maxLength": 200,
+              "nullable": true,
               "description": "Unique identifier of the integration that was installed on the bot"
             },
             "scheduleRegisterCall": {
@@ -1777,7 +1778,7 @@ export const state = {
                 "additionalProperties": false
               },
               "nullable": true,
-              "description": "Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations."
+              "description": "**EXPERIMENTAL** Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual           sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations."
             }
           },
           "title": "configureIntegrationBody",
@@ -7380,7 +7381,7 @@ export const state = {
     },
     "createIntegrationShareableId": {
       "name": "createIntegrationShareableId",
-      "description": "(Experimental) Generate a shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
+      "description": "**EXPERIMENTAL** Generate a shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
       "method": "post",
       "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/shareable-id",
       "section": "bot",
@@ -7423,7 +7424,7 @@ export const state = {
     },
     "deleteIntegrationShareableId": {
       "name": "deleteIntegrationShareableId",
-      "description": "(Experimental) Delete a shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
+      "description": "**EXPERIMENTAL** Delete a shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
       "method": "delete",
       "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/shareable-id",
       "section": "bot",
@@ -7450,7 +7451,7 @@ export const state = {
     },
     "getIntegrationShareableId": {
       "name": "getIntegrationShareableId",
-      "description": "(Experimental) Get an existing shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
+      "description": "**EXPERIMENTAL** Get an existing shareable ID for an integration installed in a bot. This ID is meant to identify the crossover of a bot and an integration version, just like the webhook ID, but in a human-readable format. It is used for the integrations channel sandbox feature.",
       "method": "get",
       "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/shareable-id",
       "section": "bot",
@@ -7487,6 +7488,136 @@ export const state = {
         }
       }
     },
+    "listBotApiKeys": {
+      "name": "listBotApiKeys",
+      "description": "List BAKs (Bot Api Keys) of a bot",
+      "method": "get",
+      "section": "bot",
+      "path": "/v1/admin/bots/baks",
+      "parameters": {
+        "botId": {
+          "in": "query",
+          "description": "ID of the bot",
+          "type": "string",
+          "required": true
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "baks": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "createdAt": {
+                    "type": "string",
+                    "format": "date-time"
+                  },
+                  "note": {
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "createdAt",
+                  "note"
+                ]
+              }
+            }
+          },
+          "required": [
+            "baks"
+          ],
+          "title": "listBotApiKeysResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "createBotApiKey": {
+      "name": "createBotApiKey",
+      "description": "Create a BAK",
+      "method": "post",
+      "section": "bot",
+      "path": "/v1/admin/bots/baks",
+      "requestBody": {
+        "description": "BAK body",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "botId": {
+              "type": "string"
+            },
+            "note": {
+              "type": "string"
+            }
+          },
+          "required": [
+            "botId"
+          ],
+          "title": "createBotApiKeyBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "id": {
+              "type": "string"
+            },
+            "createdAt": {
+              "type": "string",
+              "format": "date-time"
+            },
+            "note": {
+              "type": "string"
+            },
+            "value": {
+              "type": "string",
+              "description": "The BAK value. This will only be returned here when created and cannot be retrieved later."
+            }
+          },
+          "required": [
+            "id",
+            "createdAt",
+            "note",
+            "value"
+          ],
+          "title": "createBotApiKeyResponse",
+          "additionalProperties": false
+        }
+      },
+      "parameters": {}
+    },
+    "deleteBotApiKey": {
+      "name": "deleteBotApiKey",
+      "description": "Delete a BAK",
+      "method": "delete",
+      "section": "bot",
+      "path": "/v1/admin/bots/baks/{id}",
+      "parameters": {
+        "id": {
+          "type": "string",
+          "description": "ID of Bot Api Key",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "deleteBotApiKeyResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listWorkspaceInvoices": {
       "name": "listWorkspaceInvoices",
       "description": "List invoices billed to workspace",
@@ -17009,7 +17140,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.5.1",
+    "version": "1.7.0",
     "prefix": "v1"
   },
   "errors": [
@@ -17170,6 +17301,7 @@ export const state = {
       "createBotVersionBody": true,
       "deployBotVersionBody": true,
       "createIntegrationShareableIdBody": true,
+      "createBotApiKeyBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -17286,6 +17418,9 @@ export const state = {
       "createIntegrationShareableIdResponse": true,
       "deleteIntegrationShareableIdResponse": true,
       "getIntegrationShareableIdResponse": true,
+      "listBotApiKeysResponse": true,
+      "createBotApiKeyResponse": true,
+      "deleteBotApiKeyResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -20775,7 +20910,10 @@ export const state = {
         "deployBotVersion",
         "createIntegrationShareableId",
         "deleteIntegrationShareableId",
-        "getIntegrationShareableId"
+        "getIntegrationShareableId",
+        "listBotApiKeys",
+        "createBotApiKey",
+        "deleteBotApiKey"
       ],
       "schema": "Bot"
     },