@botpress/api 1.5.1 → 1.7.0

package/dist/index.js

@@ -283789,6 +283789,7 @@ var state = {
             "identifier": {
               "type": "string",
               "maxLength": 200,
+              "nullable": true,
               "description": "Unique identifier of the integration that was installed on the bot"
             },
             "scheduleRegisterCall": {
@@ -283813,7 +283814,7 @@ var 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",
@@ -284643,7 +284644,7 @@ var 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": [
@@ -293089,7 +293090,7 @@ var state2 = {
     },
     "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",
@@ -293132,7 +293133,7 @@ var state2 = {
     },
     "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",
@@ -293159,7 +293160,7 @@ var state2 = {
     },
     "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",
@@ -293196,6 +293197,136 @@ var state2 = {
         }
       }
     },
+    "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",
@@ -299942,7 +300073,7 @@ var state2 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.5.1",
+    "version": "1.7.0",
     "prefix": "v1"
   },
   "errors": [
@@ -300080,6 +300211,7 @@ var state2 = {
       "createBotVersionBody": true,
       "deployBotVersionBody": true,
       "createIntegrationShareableIdBody": true,
+      "createBotApiKeyBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -300135,6 +300267,9 @@ var state2 = {
       "createIntegrationShareableIdResponse": true,
       "deleteIntegrationShareableIdResponse": true,
       "getIntegrationShareableIdResponse": true,
+      "listBotApiKeysResponse": true,
+      "createBotApiKeyResponse": true,
+      "deleteBotApiKeyResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -303539,7 +303674,10 @@ var state2 = {
         "deployBotVersion",
         "createIntegrationShareableId",
         "deleteIntegrationShareableId",
-        "getIntegrationShareableId"
+        "getIntegrationShareableId",
+        "listBotApiKeys",
+        "createBotApiKey",
+        "deleteBotApiKey"
       ],
       "schema": "Bot"
     },
@@ -305283,7 +305421,7 @@ var state3 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.5.1",
+    "version": "1.7.0",
     "prefix": "v1"
   },
   "errors": [
@@ -310078,7 +310216,7 @@ var state4 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.5.1",
+    "version": "1.7.0",
     "prefix": "v1"
   },
   "errors": [
@@ -315418,6 +315556,7 @@ var state5 = {
             "identifier": {
               "type": "string",
               "maxLength": 200,
+              "nullable": true,
               "description": "Unique identifier of the integration that was installed on the bot"
             },
             "scheduleRegisterCall": {
@@ -315442,7 +315581,7 @@ var state5 = {
                 "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",
@@ -321045,7 +321184,7 @@ var state5 = {
     },
     "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",
@@ -321088,7 +321227,7 @@ var state5 = {
     },
     "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",
@@ -321115,7 +321254,7 @@ var state5 = {
     },
     "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",
@@ -321152,6 +321291,136 @@ var state5 = {
         }
       }
     },
+    "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",
@@ -330674,7 +330943,7 @@ var state5 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.5.1",
+    "version": "1.7.0",
     "prefix": "v1"
   },
   "errors": [
@@ -330835,6 +331104,7 @@ var state5 = {
       "createBotVersionBody": true,
       "deployBotVersionBody": true,
       "createIntegrationShareableIdBody": true,
+      "createBotApiKeyBody": true,
       "chargeWorkspaceUnpaidInvoicesBody": true,
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
@@ -330951,6 +331221,9 @@ var state5 = {
       "createIntegrationShareableIdResponse": true,
       "deleteIntegrationShareableIdResponse": true,
       "getIntegrationShareableIdResponse": true,
+      "listBotApiKeysResponse": true,
+      "createBotApiKeyResponse": true,
+      "deleteBotApiKeyResponse": true,
       "listWorkspaceInvoicesResponse": true,
       "getUpcomingInvoiceResponse": true,
       "chargeWorkspaceUnpaidInvoicesResponse": true,
@@ -334440,7 +334713,10 @@ var state5 = {
         "deployBotVersion",
         "createIntegrationShareableId",
         "deleteIntegrationShareableId",
-        "getIntegrationShareableId"
+        "getIntegrationShareableId",
+        "listBotApiKeys",
+        "createBotApiKey",
+        "deleteBotApiKey"
       ],
       "schema": "Bot"
     },

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

@@ -4271,6 +4271,123 @@ export declare const state: {
                 };
             };
         };
+        listBotApiKeys: {
+            name: string;
+            description: string;
+            method: "get";
+            section: "bot";
+            path: string;
+            parameters: {
+                botId: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        baks: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    createdAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    note: {
+                                        type: "string";
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        createBotApiKey: {
+            name: string;
+            description: string;
+            method: "post";
+            section: "bot";
+            path: string;
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        botId: {
+                            type: "string";
+                        };
+                        note: {
+                            type: "string";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        id: {
+                            type: "string";
+                        };
+                        createdAt: {
+                            type: "string";
+                            format: string;
+                        };
+                        note: {
+                            type: "string";
+                        };
+                        value: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
+        deleteBotApiKey: {
+            name: string;
+            description: string;
+            method: "delete";
+            section: "bot";
+            path: string;
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         listWorkspaceInvoices: {
             name: string;
             description: string;
@@ -10272,6 +10389,7 @@ export declare const state: {
             createBotVersionBody: true;
             deployBotVersionBody: true;
             createIntegrationShareableIdBody: true;
+            createBotApiKeyBody: true;
             chargeWorkspaceUnpaidInvoicesBody: true;
             createWorkspaceBody: true;
             updateWorkspaceBody: true;
@@ -10327,6 +10445,9 @@ export declare const state: {
             createIntegrationShareableIdResponse: true;
             deleteIntegrationShareableIdResponse: true;
             getIntegrationShareableIdResponse: true;
+            listBotApiKeysResponse: true;
+            createBotApiKeyResponse: true;
+            deleteBotApiKeyResponse: true;
             listWorkspaceInvoicesResponse: true;
             getUpcomingInvoiceResponse: true;
             chargeWorkspaceUnpaidInvoicesResponse: true;

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

@@ -1595,6 +1595,7 @@ export declare const state: {
                         identifier: {
                             type: "string";
                             maxLength: number;
+                            nullable: true;
                             description: string;
                         };
                         scheduleRegisterCall: {