@botpress/api 1.16.0 → 1.18.0

package/dist/index.js

@@ -284126,7 +284126,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.16.0",
+    "version": "1.18.0",
     "prefix": "v1"
   },
   "errors": [
@@ -285576,6 +285576,14 @@ var state = {
               "additionalProperties": false
             }
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "dev": {
             "type": "boolean",
             "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -285865,6 +285873,14 @@ var state = {
             "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -286220,6 +286236,14 @@ var state = {
             "description": "Conversation object configuration",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -289225,6 +289249,14 @@ var state2 = {
                     "additionalProperties": false
                   }
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "dev": {
                   "type": "boolean",
                   "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -289958,6 +289990,14 @@ var state2 = {
                     "additionalProperties": false
                   }
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "dev": {
                   "type": "boolean",
                   "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -290530,6 +290570,14 @@ var state2 = {
                   "description": "Conversation object configuration",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -290920,6 +290968,14 @@ var state2 = {
                   "description": "Conversation object configuration",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -291370,6 +291426,14 @@ var state2 = {
                   "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -291660,6 +291724,14 @@ var state2 = {
                   "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -292011,7 +292083,7 @@ var state2 = {
                 "type": "string",
                 "maxLength": 500
               },
-              "description": "Tags of the [Bot](#schema_bot)"
+              "description": "Optional attributes of the [Bot](#schema_bot)"
             },
             "code": {
               "type": "string",
@@ -292123,7 +292195,7 @@ var state2 = {
                 "type": "string",
                 "maxLength": 500
               },
-              "description": "Tags of the [Bot](#schema_bot)"
+              "description": "Optional attributes of the [Bot](#schema_bot)"
             },
             "blocked": {
               "type": "boolean"
@@ -293690,6 +293762,33 @@ var state2 = {
         }
       }
     },
+    "unlinkSandboxedConversations": {
+      "name": "unlinkSandboxedConversations",
+      "description": "**EXPERIMENTAL** Unlink all sandboxed conversations for an integration installed in a bot",
+      "method": "delete",
+      "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/sandboxed-conversations",
+      "section": "bot",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        },
+        "integrationId": {
+          "type": "string",
+          "description": "Integration Version ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "unlinkSandboxedConversationsResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listBotApiKeys": {
       "name": "listBotApiKeys",
       "description": "List BAKs (Bot Api Keys) of a bot",
@@ -296082,6 +296181,14 @@ var state2 = {
                 "additionalProperties": false
               }
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -296664,6 +296771,14 @@ var state2 = {
                 "additionalProperties": false
               }
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -297520,6 +297635,15 @@ var state2 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "secrets": {
               "type": "object",
               "additionalProperties": {
@@ -298119,6 +298243,15 @@ var state2 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "secrets": {
               "type": "object",
               "additionalProperties": {
@@ -298856,6 +298989,14 @@ var state2 = {
               "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "icon": {
               "type": "string",
               "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -299175,6 +299316,15 @@ var state2 = {
               "nullable": true,
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "icon": {
               "type": "string",
               "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -299634,6 +299784,14 @@ var state2 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "code": {
               "type": "object",
               "properties": {
@@ -300044,6 +300202,15 @@ var state2 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "code": {
               "type": "object",
               "properties": {
@@ -300809,7 +300976,7 @@ var state2 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.16.0",
+    "version": "1.18.0",
     "prefix": "v1"
   },
   "errors": [
@@ -301006,6 +301173,7 @@ var state2 = {
       "createIntegrationShareableIdResponse": true,
       "deleteIntegrationShareableIdResponse": true,
       "getIntegrationShareableIdResponse": true,
+      "unlinkSandboxedConversationsResponse": true,
       "listBotApiKeysResponse": true,
       "createBotApiKeyResponse": true,
       "deleteBotApiKeyResponse": true,
@@ -302317,6 +302485,14 @@ var state2 = {
               "additionalProperties": false
             }
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "dev": {
             "type": "boolean",
             "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -302606,6 +302782,14 @@ var state2 = {
             "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -302961,6 +303145,14 @@ var state2 = {
             "description": "Conversation object configuration",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -304599,6 +304791,7 @@ var state2 = {
         "createIntegrationShareableId",
         "deleteIntegrationShareableId",
         "getIntegrationShareableId",
+        "unlinkSandboxedConversations",
         "listBotApiKeys",
         "createBotApiKey",
         "deleteBotApiKey"
@@ -306415,7 +306608,7 @@ var state3 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.16.0",
+    "version": "1.18.0",
     "prefix": "v1"
   },
   "errors": [
@@ -307818,6 +308011,14 @@ var state3 = {
               "additionalProperties": false
             }
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "dev": {
             "type": "boolean",
             "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -308107,6 +308308,14 @@ var state3 = {
             "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -308462,6 +308671,14 @@ var state3 = {
             "description": "Conversation object configuration",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -311395,7 +311612,7 @@ var state4 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.16.0",
+    "version": "1.18.0",
     "prefix": "v1"
   },
   "errors": [
@@ -312805,6 +313022,14 @@ var state4 = {
               "additionalProperties": false
             }
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "dev": {
             "type": "boolean",
             "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -313094,6 +313319,14 @@ var state4 = {
             "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -313449,6 +313682,14 @@ var state4 = {
             "description": "Conversation object configuration",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -319012,6 +319253,14 @@ var state5 = {
                     "additionalProperties": false
                   }
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "dev": {
                   "type": "boolean",
                   "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -319745,6 +319994,14 @@ var state5 = {
                     "additionalProperties": false
                   }
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "dev": {
                   "type": "boolean",
                   "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -320317,6 +320574,14 @@ var state5 = {
                   "description": "Conversation object configuration",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -320707,6 +320972,14 @@ var state5 = {
                   "description": "Conversation object configuration",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -321157,6 +321430,14 @@ var state5 = {
                   "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -321447,6 +321728,14 @@ var state5 = {
                   "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
                   "additionalProperties": false
                 },
+                "attributes": {
+                  "type": "object",
+                  "additionalProperties": {
+                    "type": "string",
+                    "maxLength": 200
+                  },
+                  "description": "Optional attributes"
+                },
                 "title": {
                   "type": "string",
                   "minLength": 1,
@@ -321798,7 +322087,7 @@ var state5 = {
                 "type": "string",
                 "maxLength": 500
               },
-              "description": "Tags of the [Bot](#schema_bot)"
+              "description": "Optional attributes of the [Bot](#schema_bot)"
             },
             "code": {
               "type": "string",
@@ -321910,7 +322199,7 @@ var state5 = {
                 "type": "string",
                 "maxLength": 500
               },
-              "description": "Tags of the [Bot](#schema_bot)"
+              "description": "Optional attributes of the [Bot](#schema_bot)"
             },
             "blocked": {
               "type": "boolean"
@@ -323477,6 +323766,33 @@ var state5 = {
         }
       }
     },
+    "unlinkSandboxedConversations": {
+      "name": "unlinkSandboxedConversations",
+      "description": "**EXPERIMENTAL** Unlink all sandboxed conversations for an integration installed in a bot",
+      "method": "delete",
+      "path": "/v1/admin/bots/{botId}/integrations/{integrationId}/sandboxed-conversations",
+      "section": "bot",
+      "parameters": {
+        "botId": {
+          "type": "string",
+          "description": "Bot ID",
+          "in": "path"
+        },
+        "integrationId": {
+          "type": "string",
+          "description": "Integration Version ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "unlinkSandboxedConversationsResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listBotApiKeys": {
       "name": "listBotApiKeys",
       "description": "List BAKs (Bot Api Keys) of a bot",
@@ -325870,6 +326186,14 @@ var state5 = {
                 "additionalProperties": false
               }
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -326452,6 +326776,14 @@ var state5 = {
                 "additionalProperties": false
               }
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -327308,6 +327640,15 @@ var state5 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "secrets": {
               "type": "object",
               "additionalProperties": {
@@ -327907,6 +328248,15 @@ var state5 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "secrets": {
               "type": "object",
               "additionalProperties": {
@@ -328644,6 +328994,14 @@ var state5 = {
               "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "icon": {
               "type": "string",
               "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -328963,6 +329321,15 @@ var state5 = {
               "nullable": true,
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "icon": {
               "type": "string",
               "description": "Base64 encoded svg of the interface icon. This icon is global to the interface each versions will be updated when this changes."
@@ -329422,6 +329789,14 @@ var state5 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200
+              },
+              "description": "Optional attributes"
+            },
             "code": {
               "type": "object",
               "properties": {
@@ -329832,6 +330207,15 @@ var state5 = {
               },
               "additionalProperties": false
             },
+            "attributes": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "string",
+                "maxLength": 200,
+                "nullable": true
+              },
+              "description": "Optional attributes. Set attributes to null to remove them"
+            },
             "code": {
               "type": "object",
               "properties": {
@@ -333442,7 +333826,7 @@ var state5 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.16.0",
+    "version": "1.18.0",
     "prefix": "v1"
   },
   "errors": [
@@ -333724,6 +334108,7 @@ var state5 = {
       "createIntegrationShareableIdResponse": true,
       "deleteIntegrationShareableIdResponse": true,
       "getIntegrationShareableIdResponse": true,
+      "unlinkSandboxedConversationsResponse": true,
       "listBotApiKeysResponse": true,
       "createBotApiKeyResponse": true,
       "deleteBotApiKeyResponse": true,
@@ -335067,6 +335452,14 @@ var state5 = {
               "additionalProperties": false
             }
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "dev": {
             "type": "boolean",
             "description": "Indicates if the integration is a development integration; Dev integrations run locally"
@@ -335356,6 +335749,14 @@ var state5 = {
             "description": "Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -335711,6 +336112,14 @@ var state5 = {
             "description": "Conversation object configuration",
             "additionalProperties": false
           },
+          "attributes": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string",
+              "maxLength": 200
+            },
+            "description": "Optional attributes"
+          },
           "title": {
             "type": "string",
             "minLength": 1,
@@ -337403,6 +337812,7 @@ var state5 = {
         "createIntegrationShareableId",
         "deleteIntegrationShareableId",
         "getIntegrationShareableId",
+        "unlinkSandboxedConversations",
         "listBotApiKeys",
         "createBotApiKey",
         "deleteBotApiKey"