@botpress/api 0.19.2 → 0.19.4

package/dist/index.js

@@ -273873,6 +273873,10 @@ var state = {
                     "type": "string",
                     "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
                   },
+                  "public": {
+                    "type": "boolean",
+                    "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+                  },
                   "ownerWorkspace": {
                     "type": "object",
                     "properties": {
@@ -273903,6 +273907,7 @@ var state = {
                   "title",
                   "description",
                   "iconUrl",
+                  "public",
                   "ownerWorkspace"
                 ]
               }
@@ -274360,6 +274365,10 @@ var state = {
                   "type": "string",
                   "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
                 },
+                "public": {
+                  "type": "boolean",
+                  "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+                },
                 "secrets": {
                   "type": "array",
                   "items": {
@@ -274408,6 +274417,7 @@ var state = {
                 "description",
                 "iconUrl",
                 "readmeUrl",
+                "public",
                 "secrets",
                 "ownerWorkspace"
               ],
@@ -274860,6 +274870,10 @@ var state = {
                   "type": "string",
                   "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
                 },
+                "public": {
+                  "type": "boolean",
+                  "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+                },
                 "secrets": {
                   "type": "array",
                   "items": {
@@ -274908,6 +274922,7 @@ var state = {
                 "description",
                 "iconUrl",
                 "readmeUrl",
+                "public",
                 "secrets",
                 "ownerWorkspace"
               ],
@@ -277383,7 +277398,7 @@ var state = {
               "type": "string",
               "minLength": 1,
               "maxLength": 64,
-              "pattern": "^[0-9a-z][a-z0-9-]+[0-9a-z]$"
+              "pattern": "^[0-9a-z][a-z0-9-_]+[0-9a-z]$"
             }
           },
           "additionalProperties": false,
@@ -278602,6 +278617,10 @@ var state = {
               "type": "string",
               "maxLength": 256,
               "description": "Description of the integration. This is the description that will be displayed in the UI"
+            },
+            "public": {
+              "type": "boolean",
+              "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
             }
           },
           "required": [
@@ -279025,6 +279044,10 @@ var state = {
             "url": {
               "type": "string",
               "description": "URL of the integration; Only available for dev integrations"
+            },
+            "public": {
+              "type": "boolean",
+              "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
             }
           },
           "title": "updateIntegrationBody",
@@ -279127,6 +279150,10 @@ var state = {
                   "iconUrl": {
                     "type": "string",
                     "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
+                  },
+                  "public": {
+                    "type": "boolean",
+                    "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
                   }
                 },
                 "required": [
@@ -279137,7 +279164,8 @@ var state = {
                   "updatedAt",
                   "title",
                   "description",
-                  "iconUrl"
+                  "iconUrl",
+                  "public"
                 ]
               }
             },
@@ -279589,7 +279617,7 @@ var state = {
         }
       },
       "parameters": {
-        "x-filename": {
+        "x-name": {
           "type": "string",
           "description": "File name",
           "in": "header",
@@ -279602,7 +279630,7 @@ var state = {
         },
         "x-access-policies": {
           "type": "string",
-          "description": "File access policies",
+          "description": 'File access policies, comma-separated. Add "public_content" to allow public access to the file content. Add "integrations" to allo read, search and list operations for any integration installed in the bot.',
           "in": "header"
         },
         "x-index": {
@@ -279612,37 +279640,13 @@ var state = {
         },
         "Content-Type": {
           "type": "string",
-          "description": "File content type",
+          "description": 'File content type. If omitted, the content type will be inferred from the file extension. If a type cannot be inferred, the default is "application/octet-stream".',
           "in": "header"
         },
         "Content-Length": {
           "type": "string",
           "description": "File content length",
           "in": "header"
-        },
-        "x-bot-id": {
-          "in": "header",
-          "description": "Bot id",
-          "type": "string",
-          "required": true
-        },
-        "x-integration-id": {
-          "in": "header",
-          "description": "Integration id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-id": {
-          "in": "header",
-          "description": "User id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-role": {
-          "in": "header",
-          "description": "User role",
-          "type": "string",
-          "required": false
         }
       },
       "contentType": "*/*",
@@ -279661,13 +279665,16 @@ var state = {
                 "botId": {
                   "type": "string"
                 },
-                "filename": {
+                "name": {
                   "type": "string"
                 },
-                "bytes": {
+                "size": {
                   "type": "number",
                   "nullable": true
                 },
+                "contentType": {
+                  "type": "string"
+                },
                 "tags": {
                   "type": "object",
                   "additionalProperties": {
@@ -279704,8 +279711,9 @@ var state = {
               "required": [
                 "id",
                 "botId",
-                "filename",
-                "bytes",
+                "name",
+                "size",
+                "contentType",
                 "tags",
                 "createdAt",
                 "updatedAt",
@@ -279733,30 +279741,6 @@ var state = {
           "type": "string",
           "description": "File ID",
           "in": "path"
-        },
-        "x-bot-id": {
-          "in": "header",
-          "description": "Bot id",
-          "type": "string",
-          "required": true
-        },
-        "x-integration-id": {
-          "in": "header",
-          "description": "Integration id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-id": {
-          "in": "header",
-          "description": "User id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-role": {
-          "in": "header",
-          "description": "User role",
-          "type": "string",
-          "required": false
         }
       },
       "response": {
@@ -279780,39 +279764,21 @@ var state = {
           "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
           "type": "string"
         },
-        "x-bot-id": {
-          "in": "header",
-          "description": "Bot id",
-          "type": "string",
-          "required": true
-        },
-        "x-integration-id": {
-          "in": "header",
-          "description": "Integration id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-id": {
-          "in": "header",
-          "description": "User id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-role": {
-          "in": "header",
-          "description": "User role",
-          "type": "string",
-          "required": false
-        },
         "botId": {
           "type": "string",
           "description": "Bot ID",
           "in": "path"
         },
         "tags": {
-          "type": "string",
           "in": "query",
-          "description": "Tags to filter files by as a JSON string representing an object of key-value pairs to match files' tags against."
+          "description": "Filter by tags",
+          "type": "object",
+          "schema": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          }
         }
       },
       "response": {
@@ -279831,13 +279797,24 @@ var state = {
                   "botId": {
                     "type": "string"
                   },
-                  "filename": {
+                  "name": {
                     "type": "string"
                   },
-                  "bytes": {
+                  "size": {
                     "type": "number",
                     "nullable": true
                   },
+                  "contentType": {
+                    "type": "string"
+                  },
+                  "tags": {
+                    "type": "object",
+                    "additionalProperties": {
+                      "type": "string",
+                      "maxLength": 1e3
+                    },
+                    "description": "Set of tags that you can attach to a file. Individual keys can be unset by setting them to a `null` value."
+                  },
                   "createdAt": {
                     "type": "string"
                   },
@@ -279866,8 +279843,10 @@ var state = {
                 "required": [
                   "id",
                   "botId",
-                  "filename",
-                  "bytes",
+                  "name",
+                  "size",
+                  "contentType",
+                  "tags",
                   "createdAt",
                   "updatedAt",
                   "accessPolicies"
@@ -279905,30 +279884,6 @@ var state = {
           "type": "string",
           "description": "File ID",
           "in": "path"
-        },
-        "x-bot-id": {
-          "in": "header",
-          "description": "Bot id",
-          "type": "string",
-          "required": true
-        },
-        "x-integration-id": {
-          "in": "header",
-          "description": "Integration id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-id": {
-          "in": "header",
-          "description": "User id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-role": {
-          "in": "header",
-          "description": "User role",
-          "type": "string",
-          "required": false
         }
       },
       "response": {
@@ -279945,13 +279900,16 @@ var state = {
                 "botId": {
                   "type": "string"
                 },
-                "filename": {
+                "name": {
                   "type": "string"
                 },
-                "bytes": {
+                "size": {
                   "type": "number",
                   "nullable": true
                 },
+                "contentType": {
+                  "type": "string"
+                },
                 "tags": {
                   "type": "object",
                   "additionalProperties": {
@@ -279988,8 +279946,9 @@ var state = {
               "required": [
                 "id",
                 "botId",
-                "filename",
-                "bytes",
+                "name",
+                "size",
+                "contentType",
                 "tags",
                 "createdAt",
                 "updatedAt",
@@ -280017,30 +279976,6 @@ var state = {
           "type": "string",
           "description": "File ID",
           "in": "path"
-        },
-        "x-bot-id": {
-          "in": "header",
-          "description": "Bot id",
-          "type": "string",
-          "required": true
-        },
-        "x-integration-id": {
-          "in": "header",
-          "description": "Integration id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-id": {
-          "in": "header",
-          "description": "User id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-role": {
-          "in": "header",
-          "description": "User role",
-          "type": "string",
-          "required": false
         }
       },
       "response": {
@@ -280072,30 +280007,6 @@ var state = {
           "type": "string",
           "description": "File ID",
           "in": "path"
-        },
-        "x-bot-id": {
-          "in": "header",
-          "description": "Bot id",
-          "type": "string",
-          "required": true
-        },
-        "x-integration-id": {
-          "in": "header",
-          "description": "Integration id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-id": {
-          "in": "header",
-          "description": "User id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-role": {
-          "in": "header",
-          "description": "User role",
-          "type": "string",
-          "required": false
         }
       },
       "requestBody": {
@@ -280148,39 +280059,21 @@ var state = {
       "method": "get",
       "section": "files",
       "parameters": {
-        "x-bot-id": {
-          "in": "header",
-          "description": "Bot id",
-          "type": "string",
-          "required": true
-        },
-        "x-integration-id": {
-          "in": "header",
-          "description": "Integration id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-id": {
-          "in": "header",
-          "description": "User id",
-          "type": "string",
-          "required": false
-        },
-        "x-user-role": {
-          "in": "header",
-          "description": "User role",
-          "type": "string",
-          "required": false
-        },
         "botId": {
           "type": "string",
           "description": "Bot ID",
           "in": "path"
         },
         "tags": {
-          "type": "string",
           "in": "query",
-          "description": "Tags to filter files by as a JSON string representing an object of key-value pairs to match files' tags against."
+          "description": "Filter by tags",
+          "type": "object",
+          "schema": {
+            "type": "object",
+            "additionalProperties": {
+              "type": "string"
+            }
+          }
         },
         "query": {
           "in": "query",
@@ -280947,7 +280840,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.19.2",
+    "version": "0.19.4",
     "prefix": "v1"
   },
   "errors": [
@@ -281060,6 +280953,11 @@ var state = {
       "status": 413,
       "type": "LimitExceeded",
       "description": "The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."
+    },
+    {
+      "status": 400,
+      "type": "BreakingChanges",
+      "description": "Request payload contains breaking changes which is not allowed for this resource without a version increment."
     }
   ],
   "refs": {
@@ -281361,6 +281259,10 @@ var state = {
                 "iconUrl": {
                   "type": "string",
                   "description": "URL of the icon of the integration. This is the icon that will be displayed in the UI"
+                },
+                "public": {
+                  "type": "boolean",
+                  "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
                 }
               },
               "required": [
@@ -281377,7 +281279,8 @@ var state = {
                 "updatedAt",
                 "title",
                 "description",
-                "iconUrl"
+                "iconUrl",
+                "public"
               ],
               "additionalProperties": false
             },
@@ -282167,6 +282070,10 @@ var state = {
             "type": "string",
             "description": "URL of the readme of the integration. This is the readme that will be displayed in the UI"
           },
+          "public": {
+            "type": "boolean",
+            "description": "Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version."
+          },
           "secrets": {
             "type": "array",
             "items": {
@@ -282194,6 +282101,7 @@ var state = {
           "description",
           "iconUrl",
           "readmeUrl",
+          "public",
           "secrets"
         ],
         "additionalProperties": false
@@ -283240,13 +283148,16 @@ var state = {
           "botId": {
             "type": "string"
           },
-          "filename": {
+          "name": {
             "type": "string"
           },
-          "bytes": {
+          "size": {
             "type": "number",
             "nullable": true
           },
+          "contentType": {
+            "type": "string"
+          },
           "tags": {
             "type": "object",
             "additionalProperties": {
@@ -283283,8 +283194,9 @@ var state = {
         "required": [
           "id",
           "botId",
-          "filename",
-          "bytes",
+          "name",
+          "size",
+          "contentType",
           "tags",
           "createdAt",
           "updatedAt",