@botpress/api 0.30.0 → 0.30.2

package/src/gen/state.ts

@@ -6353,6 +6353,113 @@ export const state = {
         }
       }
     },
+    "listPublicWorkspaces": {
+      "name": "listPublicWorkspaces",
+      "description": "List public workspaces",
+      "section": "workspace",
+      "method": "get",
+      "path": "/v1/admin/workspaces/public",
+      "disableDefaultParameters": {
+        "x-workspace-id": true
+      },
+      "parameters": {
+        "nextToken": {
+          "in": "query",
+          "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          "type": "string"
+        },
+        "workspaceIds": {
+          "in": "query",
+          "description": "Ids of the workspaces to list",
+          "type": "string[]",
+          "required": false
+        },
+        "search": {
+          "in": "query",
+          "description": "Search query",
+          "type": "string",
+          "required": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "workspaces": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string"
+                  },
+                  "name": {
+                    "type": "string"
+                  },
+                  "createdAt": {
+                    "type": "string"
+                  },
+                  "updatedAt": {
+                    "type": "string"
+                  },
+                  "about": {
+                    "default": "",
+                    "type": "string"
+                  },
+                  "profilePicture": {
+                    "default": "",
+                    "type": "string"
+                  },
+                  "contactEmail": {
+                    "default": "",
+                    "type": "string"
+                  },
+                  "website": {
+                    "default": "",
+                    "type": "string"
+                  },
+                  "socialAccounts": {
+                    "default": [],
+                    "type": "array",
+                    "items": {
+                      "type": "string"
+                    }
+                  },
+                  "handle": {
+                    "default": "",
+                    "type": "string"
+                  }
+                },
+                "required": [
+                  "id",
+                  "name",
+                  "createdAt",
+                  "updatedAt"
+                ],
+                "title": "getPublicWorkspaceResponse"
+              }
+            },
+            "meta": {
+              "type": "object",
+              "properties": {
+                "nextToken": {
+                  "type": "string",
+                  "description": "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
+                }
+              },
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "workspaces",
+            "meta"
+          ],
+          "title": "listPublicWorkspacesResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "deleteWorkspace": {
       "name": "deleteWorkspace",
       "description": "Delete workspace",
@@ -8471,19 +8578,19 @@ export const state = {
       },
       "parameters": {}
     },
-    "createFile": {
-      "name": "createFile",
+    "upsertFile": {
+      "name": "upsertFile",
       "path": "/v1/files",
-      "description": "Creates a file. Once the file is created, use the uploadUrl from the response body to upload the file content, using a PUT request.",
-      "method": "post",
+      "description": "Creates or updates a file using the `key` parameter as unique identifier. Updating a file will erase the existing content of the file. Upload the file content by sending it in a PUT request to the `uploadUrl` returned in the response.",
+      "method": "put",
       "requestBody": {
-        "description": "The file to upload.",
+        "description": "Properties of the file to create or update.",
         "schema": {
           "type": "object",
           "properties": {
-            "name": {
+            "key": {
               "type": "string",
-              "description": "File name"
+              "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
             },
             "tags": {
               "type": "object",
@@ -8495,12 +8602,12 @@ export const state = {
             },
             "size": {
               "type": "number",
-              "description": "File size in bytes. This will count against your file storage quota. If the `index` parameter is set to `true`, this will also count against your vector database storage quota."
+              "description": "File size in bytes. This will count against your File Storage quota. If the `index` parameter is set to `true`, this will also count against your Vector DB Storage quota."
             },
             "index": {
               "default": false,
               "type": "boolean",
-              "description": "Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards the Vector Storage quota of the workspace rather than the File Storage quota."
+              "description": "Set to a value of 'true' to index the file in vector storage. Only PDFs, Office documents, and text-based files are currently supported. Note that if a file is indexed, it will count towards both the Vector DB Storage quota and the File Storage quota of the workspace."
             },
             "accessPolicies": {
               "type": "array",
@@ -8515,20 +8622,21 @@ export const state = {
             },
             "contentType": {
               "type": "string",
-              "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\"."
+              "description": "File content type. If omitted, the content type will be inferred from the file extension (if any) specified in `key`. If a content type cannot be inferred, the default is \"application/octet-stream\"."
             }
           },
           "required": [
+            "key",
             "size"
           ],
-          "title": "createFileBody",
+          "title": "upsertFileBody",
           "additionalProperties": false
         }
       },
       "contentType": "application/json",
       "section": "files",
       "response": {
-        "description": "The created file",
+        "description": "The created or updated file",
         "schema": {
           "type": "object",
           "properties": {
@@ -8543,10 +8651,9 @@ export const state = {
                   "type": "string",
                   "description": "The ID of the bot the file belongs to"
                 },
-                "name": {
+                "key": {
                   "type": "string",
-                  "description": "File name",
-                  "nullable": true
+                  "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                 },
                 "size": {
                   "type": "number",
@@ -8612,7 +8719,7 @@ export const state = {
               "required": [
                 "id",
                 "botId",
-                "name",
+                "key",
                 "size",
                 "contentType",
                 "tags",
@@ -8629,7 +8736,7 @@ export const state = {
           "required": [
             "file"
           ],
-          "title": "createFileResponse",
+          "title": "upsertFileResponse",
           "additionalProperties": false
         }
       },
@@ -8699,10 +8806,9 @@ export const state = {
                     "type": "string",
                     "description": "The ID of the bot the file belongs to"
                   },
-                  "name": {
+                  "key": {
                     "type": "string",
-                    "description": "File name",
-                    "nullable": true
+                    "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                   },
                   "url": {
                     "type": "string",
@@ -8769,7 +8875,7 @@ export const state = {
                 "required": [
                   "id",
                   "botId",
-                  "name",
+                  "key",
                   "url",
                   "size",
                   "contentType",
@@ -8831,10 +8937,9 @@ export const state = {
                   "type": "string",
                   "description": "The ID of the bot the file belongs to"
                 },
-                "name": {
+                "key": {
                   "type": "string",
-                  "description": "File name",
-                  "nullable": true
+                  "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                 },
                 "url": {
                   "type": "string",
@@ -8901,7 +9006,7 @@ export const state = {
               "required": [
                 "id",
                 "botId",
-                "name",
+                "key",
                 "url",
                 "size",
                 "contentType",
@@ -8923,10 +9028,10 @@ export const state = {
         }
       }
     },
-    "updateFile": {
-      "name": "updateFile",
+    "updateFileMetadata": {
+      "name": "updateFileMetadata",
       "path": "/v1/files/{id}",
-      "description": "Update file",
+      "description": "Update file metadata, without updating the file content.",
       "method": "put",
       "section": "files",
       "parameters": {
@@ -8962,7 +9067,7 @@ export const state = {
               "description": "New access policies to set for the file. Omit to keep existing policies intact."
             }
           },
-          "title": "updateFileBody",
+          "title": "updateFileMetadataBody",
           "additionalProperties": false
         }
       },
@@ -8982,10 +9087,9 @@ export const state = {
                   "type": "string",
                   "description": "The ID of the bot the file belongs to"
                 },
-                "name": {
+                "key": {
                   "type": "string",
-                  "description": "File name",
-                  "nullable": true
+                  "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
                 },
                 "url": {
                   "type": "string",
@@ -9052,7 +9156,7 @@ export const state = {
               "required": [
                 "id",
                 "botId",
-                "name",
+                "key",
                 "url",
                 "size",
                 "contentType",
@@ -9069,7 +9173,7 @@ export const state = {
           "required": [
             "file"
           ],
-          "title": "updateFileResponse",
+          "title": "updateFileMetadataResponse",
           "additionalProperties": false
         }
       }
@@ -9134,11 +9238,6 @@ export const state = {
                         "type": "string",
                         "description": "File ID"
                       },
-                      "name": {
-                        "type": "string",
-                        "description": "File name",
-                        "nullable": true
-                      },
                       "tags": {
                         "type": "object",
                         "additionalProperties": {
@@ -9158,7 +9257,6 @@ export const state = {
                     },
                     "required": [
                       "id",
-                      "name",
                       "tags",
                       "createdAt",
                       "updatedAt"
@@ -10082,7 +10180,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.30.0",
+    "version": "0.30.2",
     "prefix": "v1"
   },
   "errors": [
@@ -10156,6 +10254,11 @@ export const state = {
       "type": "ReferenceConstraint",
       "description": "The resource cannot be deleted because it's referenced by another resource"
     },
+    {
+      "status": 409,
+      "type": "ResourceLockedConflict",
+      "description": "The resource is current locked and cannot be operated on until the lock is released."
+    },
     {
       "status": 400,
       "type": "ReferenceNotFound",
@@ -10243,8 +10346,8 @@ export const state = {
       "updateIntegrationBody": true,
       "changeAISpendQuotaBody": true,
       "introspectBody": true,
-      "createFileBody": true,
-      "updateFileBody": true,
+      "upsertFileBody": true,
+      "updateFileMetadataBody": true,
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
@@ -10333,6 +10436,7 @@ export const state = {
       "updateWorkspaceResponse": true,
       "checkHandleAvailabilityResponse": true,
       "listWorkspacesResponse": true,
+      "listPublicWorkspacesResponse": true,
       "deleteWorkspaceResponse": true,
       "getAuditRecordsResponse": true,
       "listWorkspaceMembersResponse": true,
@@ -10356,11 +10460,11 @@ export const state = {
       "changeAISpendQuotaResponse": true,
       "listActivitiesResponse": true,
       "introspectResponse": true,
-      "createFileResponse": true,
+      "upsertFileResponse": true,
       "deleteFileResponse": true,
       "listFilesResponse": true,
       "getFileResponse": true,
-      "updateFileResponse": true,
+      "updateFileMetadataResponse": true,
       "searchFilesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
@@ -12616,10 +12720,9 @@ export const state = {
             "type": "string",
             "description": "The ID of the bot the file belongs to"
           },
-          "name": {
+          "key": {
             "type": "string",
-            "description": "File name",
-            "nullable": true
+            "description": "Unique key for the file. Must be unique across the bot (and the integration, when applicable)."
           },
           "url": {
             "type": "string",
@@ -12686,7 +12789,7 @@ export const state = {
         "required": [
           "id",
           "botId",
-          "name",
+          "key",
           "url",
           "size",
           "contentType",
@@ -12867,6 +12970,7 @@ export const state = {
         "updateWorkspace",
         "checkHandleAvailability",
         "listWorkspaces",
+        "listPublicWorkspaces",
         "deleteWorkspace",
         "getAuditRecords"
       ],
@@ -12962,11 +13066,11 @@ export const state = {
       "description": "The Files API allows you to create, manage, and index files that can be used by your bots and integrations. Files can be in any text or binary format, and documents (such as PDF, Microsoft Office, HTML, CSV, etc.) can be indexed to be used for semantic search in RAG (Retrieval Augmented Generation) implementations. Files are private by default but can be made publicly accessible through a permanent URL that's unique for each file.",
       "name": "files",
       "operations": [
-        "createFile",
+        "upsertFile",
         "deleteFile",
         "listFiles",
         "getFile",
-        "updateFile",
+        "updateFileMetadata",
         "searchFiles"
       ],
       "schema": "File"