@botpress/api 1.28.1 → 1.29.0

package/.turbo/turbo-openapi.log

@@ -1,5 +1,5 @@
 
-> @botpress/api@1.28.1 openapi /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.29.0 openapi /home/runner/work/skynet/skynet/packages/public-api
 > es-node openapi/generator.ts && pnpm run build
 
 Generating openapi content
@@ -34,18 +34,18 @@ Saving openapi.json file
 
 info: Exit with code {"category":"system","code":0,"label":"Shutdown"}
 
-> @botpress/api@1.28.1 build /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.29.0 build /home/runner/work/skynet/skynet/packages/public-api
 > pnpm run build:type && pnpm run build:impl
 
 
-> @botpress/api@1.28.1 build:type /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.29.0 build:type /home/runner/work/skynet/skynet/packages/public-api
 > tsc -p tsconfig.package.json --emitDeclarationOnly
 
 
-> @botpress/api@1.28.1 build:impl /home/runner/work/skynet/skynet/packages/public-api
+> @botpress/api@1.29.0 build:impl /home/runner/work/skynet/skynet/packages/public-api
 > esbuild --bundle --platform=node --outfile=dist/index.js src/index.ts
 
 
-  dist/index.js  14.0mb ⚠️
+  dist/index.js  14.1mb ⚠️
 
-⚡ Done in 899ms
+⚡ Done in 904ms

package/dist/index.js

@@ -285326,7 +285326,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.28.1",
+    "version": "1.29.0",
     "prefix": "v1"
   },
   "errors": [
@@ -285807,6 +285807,10 @@ var state = {
             },
             "description": "A mapping of plugin aliases to their configuration"
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the bot (in seconds)."
+          },
           "user": {
             "type": "object",
             "properties": {
@@ -286258,6 +286262,10 @@ var state = {
             },
             "additionalProperties": false
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the integration (in seconds)."
+          },
           "url": {
             "type": "string",
             "maxLength": 2e3,
@@ -289984,6 +289992,10 @@ var state2 = {
                   },
                   "additionalProperties": false
                 },
+                "maxExecutionTime": {
+                  "type": "number",
+                  "description": "Maximum execution time of the integration (in seconds)."
+                },
                 "url": {
                   "type": "string",
                   "maxLength": 2e3,
@@ -290725,6 +290737,10 @@ var state2 = {
                   },
                   "additionalProperties": false
                 },
+                "maxExecutionTime": {
+                  "type": "number",
+                  "description": "Maximum execution time of the integration (in seconds)."
+                },
                 "url": {
                   "type": "string",
                   "maxLength": 2e3,
@@ -293876,6 +293892,10 @@ var state2 = {
             "blocked": {
               "type": "boolean"
             },
+            "maxExecutionTime": {
+              "type": "integer",
+              "description": "Maximum execution time (in seconds)."
+            },
             "alwaysAlive": {
               "type": "boolean",
               "description": "Indicates if the [Bot](#schema_bot) should be in always alive mode"
@@ -297359,6 +297379,72 @@ var state2 = {
         }
       }
     },
+    "setWorkspacePreference": {
+      "name": "setWorkspacePreference",
+      "description": "Set a preference for the workspace",
+      "method": "post",
+      "path": "/v1/admin/workspaces/preferences/{key}",
+      "section": "workspace",
+      "disableDefaultParameters": {
+        "x-workspace-id": true
+      },
+      "parameters": {
+        "key": {
+          "type": "string",
+          "description": "Preference key",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Preference value",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "value": {}
+          },
+          "title": "setWorkspacePreferenceBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "setWorkspacePreferenceResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "getWorkspacePreference": {
+      "name": "getWorkspacePreference",
+      "description": "Get a preference of the workspace",
+      "method": "get",
+      "path": "/v1/admin/workspaces/preferences/{key}",
+      "section": "workspace",
+      "disableDefaultParameters": {
+        "x-workspace-id": true
+      },
+      "parameters": {
+        "key": {
+          "type": "string",
+          "description": "Preference key",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "value": {
+              "nullable": true
+            }
+          },
+          "title": "getWorkspacePreferenceResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listWorkspaceMembers": {
       "name": "listWorkspaceMembers",
       "description": "Lists all the members in a workspace",
@@ -298328,9 +298414,21 @@ var state2 = {
                 "additionalProperties": false
               }
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "secrets": {
               "type": "object",
@@ -298922,9 +299020,21 @@ var state2 = {
                 "additionalProperties": false
               }
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "secrets": {
               "type": "object",
@@ -299089,9 +299199,21 @@ var state2 = {
               },
               "description": "Additional configuration definitions of the integration"
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "channels": {
               "type": "object",
@@ -299207,6 +299329,10 @@ var state2 = {
                 "additionalProperties": false
               }
             },
+            "maxExecutionTime": {
+              "type": "integer",
+              "description": "Maximum execution time of the integration (in seconds)."
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -299685,9 +299811,21 @@ var state2 = {
               },
               "description": "Additional configuration definitions of the integration"
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "channels": {
               "type": "object",
@@ -299803,6 +299941,10 @@ var state2 = {
                 "additionalProperties": false
               }
             },
+            "maxExecutionTime": {
+              "type": "integer",
+              "description": "Maximum execution time of the integration (in seconds)."
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -302887,7 +303029,7 @@ var state2 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.28.1",
+    "version": "1.29.0",
     "prefix": "v1"
   },
   "errors": [
@@ -303032,6 +303174,7 @@ var state2 = {
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
       "checkHandleAvailabilityBody": true,
+      "setWorkspacePreferenceBody": true,
       "createWorkspaceMemberBody": true,
       "updateWorkspaceMemberBody": true,
       "createIntegrationApiKeyBody": true,
@@ -303112,6 +303255,8 @@ var state2 = {
       "listPublicWorkspacesResponse": true,
       "deleteWorkspaceResponse": true,
       "getAuditRecordsResponse": true,
+      "setWorkspacePreferenceResponse": true,
+      "getWorkspacePreferenceResponse": true,
       "listWorkspaceMembersResponse": true,
       "getWorkspaceMemberResponse": true,
       "deleteWorkspaceMemberResponse": true,
@@ -303435,6 +303580,10 @@ var state2 = {
             },
             "description": "A mapping of plugin aliases to their configuration"
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the bot (in seconds)."
+          },
           "user": {
             "type": "object",
             "properties": {
@@ -303886,6 +304035,10 @@ var state2 = {
             },
             "additionalProperties": false
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the integration (in seconds)."
+          },
           "url": {
             "type": "string",
             "maxLength": 2e3,
@@ -306835,7 +306988,9 @@ var state2 = {
         "listWorkspaces",
         "listPublicWorkspaces",
         "deleteWorkspace",
-        "getAuditRecords"
+        "getAuditRecords",
+        "setWorkspacePreference",
+        "getWorkspacePreference"
       ],
       "schema": "Workspace"
     },
@@ -308704,7 +308859,7 @@ var state3 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.28.1",
+    "version": "1.29.0",
     "prefix": "v1"
   },
   "errors": [
@@ -309138,6 +309293,10 @@ var state3 = {
             },
             "description": "A mapping of plugin aliases to their configuration"
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the bot (in seconds)."
+          },
           "user": {
             "type": "object",
             "properties": {
@@ -309589,6 +309748,10 @@ var state3 = {
             },
             "additionalProperties": false
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the integration (in seconds)."
+          },
           "url": {
             "type": "string",
             "maxLength": 2e3,
@@ -313750,7 +313913,7 @@ var state4 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.28.1",
+    "version": "1.29.0",
     "prefix": "v1"
   },
   "errors": [
@@ -314191,6 +314354,10 @@ var state4 = {
             },
             "description": "A mapping of plugin aliases to their configuration"
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the bot (in seconds)."
+          },
           "user": {
             "type": "object",
             "properties": {
@@ -314642,6 +314809,10 @@ var state4 = {
             },
             "additionalProperties": false
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the integration (in seconds)."
+          },
           "url": {
             "type": "string",
             "maxLength": 2e3,
@@ -320924,6 +321095,10 @@ var state5 = {
                   },
                   "additionalProperties": false
                 },
+                "maxExecutionTime": {
+                  "type": "number",
+                  "description": "Maximum execution time of the integration (in seconds)."
+                },
                 "url": {
                   "type": "string",
                   "maxLength": 2e3,
@@ -321665,6 +321840,10 @@ var state5 = {
                   },
                   "additionalProperties": false
                 },
+                "maxExecutionTime": {
+                  "type": "number",
+                  "description": "Maximum execution time of the integration (in seconds)."
+                },
                 "url": {
                   "type": "string",
                   "maxLength": 2e3,
@@ -324816,6 +324995,10 @@ var state5 = {
             "blocked": {
               "type": "boolean"
             },
+            "maxExecutionTime": {
+              "type": "integer",
+              "description": "Maximum execution time (in seconds)."
+            },
             "alwaysAlive": {
               "type": "boolean",
               "description": "Indicates if the [Bot](#schema_bot) should be in always alive mode"
@@ -328299,6 +328482,72 @@ var state5 = {
         }
       }
     },
+    "setWorkspacePreference": {
+      "name": "setWorkspacePreference",
+      "description": "Set a preference for the workspace",
+      "method": "post",
+      "path": "/v1/admin/workspaces/preferences/{key}",
+      "section": "workspace",
+      "disableDefaultParameters": {
+        "x-workspace-id": true
+      },
+      "parameters": {
+        "key": {
+          "type": "string",
+          "description": "Preference key",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Preference value",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "value": {}
+          },
+          "title": "setWorkspacePreferenceBody",
+          "additionalProperties": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "title": "setWorkspacePreferenceResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "getWorkspacePreference": {
+      "name": "getWorkspacePreference",
+      "description": "Get a preference of the workspace",
+      "method": "get",
+      "path": "/v1/admin/workspaces/preferences/{key}",
+      "section": "workspace",
+      "disableDefaultParameters": {
+        "x-workspace-id": true
+      },
+      "parameters": {
+        "key": {
+          "type": "string",
+          "description": "Preference key",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "value": {
+              "nullable": true
+            }
+          },
+          "title": "getWorkspacePreferenceResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listWorkspaceMembers": {
       "name": "listWorkspaceMembers",
       "description": "Lists all the members in a workspace",
@@ -329269,9 +329518,21 @@ var state5 = {
                 "additionalProperties": false
               }
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "secrets": {
               "type": "object",
@@ -329863,9 +330124,21 @@ var state5 = {
                 "additionalProperties": false
               }
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "secrets": {
               "type": "object",
@@ -330030,9 +330303,21 @@ var state5 = {
               },
               "description": "Additional configuration definitions of the integration"
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "channels": {
               "type": "object",
@@ -330148,6 +330433,10 @@ var state5 = {
                 "additionalProperties": false
               }
             },
+            "maxExecutionTime": {
+              "type": "integer",
+              "description": "Maximum execution time of the integration (in seconds)."
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -330626,9 +330915,21 @@ var state5 = {
               },
               "description": "Additional configuration definitions of the integration"
             },
-            "messageStatusChangeNotificationsEnabled": {
-              "type": "boolean",
-              "description": "**EXPERIMENTAL** Whether the integration should be notified when the message status changes"
+            "extraOperations": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "properties": {
+                  "enabled": {
+                    "type": "boolean"
+                  }
+                },
+                "required": [
+                  "enabled"
+                ],
+                "additionalProperties": false
+              },
+              "description": "**EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name."
             },
             "channels": {
               "type": "object",
@@ -330744,6 +331045,10 @@ var state5 = {
                 "additionalProperties": false
               }
             },
+            "maxExecutionTime": {
+              "type": "integer",
+              "description": "Maximum execution time of the integration (in seconds)."
+            },
             "identifier": {
               "type": "object",
               "properties": {
@@ -336802,7 +337107,7 @@ var state5 = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "1.28.1",
+    "version": "1.29.0",
     "prefix": "v1"
   },
   "errors": [
@@ -336970,6 +337275,7 @@ var state5 = {
       "createWorkspaceBody": true,
       "updateWorkspaceBody": true,
       "checkHandleAvailabilityBody": true,
+      "setWorkspacePreferenceBody": true,
       "createWorkspaceMemberBody": true,
       "updateWorkspaceMemberBody": true,
       "createIntegrationApiKeyBody": true,
@@ -337112,6 +337418,8 @@ var state5 = {
       "listPublicWorkspacesResponse": true,
       "deleteWorkspaceResponse": true,
       "getAuditRecordsResponse": true,
+      "setWorkspacePreferenceResponse": true,
+      "getWorkspacePreferenceResponse": true,
       "listWorkspaceMembersResponse": true,
       "getWorkspaceMemberResponse": true,
       "deleteWorkspaceMemberResponse": true,
@@ -337467,6 +337775,10 @@ var state5 = {
             },
             "description": "A mapping of plugin aliases to their configuration"
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the bot (in seconds)."
+          },
           "user": {
             "type": "object",
             "properties": {
@@ -337918,6 +338230,10 @@ var state5 = {
             },
             "additionalProperties": false
           },
+          "maxExecutionTime": {
+            "type": "number",
+            "description": "Maximum execution time of the integration (in seconds)."
+          },
           "url": {
             "type": "string",
             "maxLength": 2e3,
@@ -340921,7 +341237,9 @@ var state5 = {
         "listWorkspaces",
         "listPublicWorkspaces",
         "deleteWorkspace",
-        "getAuditRecords"
+        "getAuditRecords",
+        "setWorkspacePreference",
+        "getWorkspacePreference"
       ],
       "schema": "Workspace"
     },