@botpress/api 0.29.6 → 0.30.1

package/src/gen/state.ts

@@ -5669,7 +5669,7 @@ export const state = {
         },
         "type": {
           "in": "query",
-          "description": "Type of usage",
+          "description": "Usage type",
           "type": "string",
           "enum": [
             "invocation_timeout",
@@ -5732,7 +5732,7 @@ export const state = {
         },
         "type": {
           "in": "query",
-          "description": "Type of usage",
+          "description": "Usage type",
           "type": "string",
           "enum": [
             "invocation_timeout",
@@ -5856,7 +5856,7 @@ export const state = {
         },
         "type": {
           "in": "query",
-          "description": "Type of usage",
+          "description": "Usage type",
           "type": "string",
           "enum": [
             "invocation_timeout",
@@ -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",
@@ -8180,7 +8287,7 @@ export const state = {
       "parameters": {
         "type": {
           "in": "query",
-          "description": "Type of usage",
+          "description": "Usage type",
           "type": "string",
           "enum": [
             "invocation_timeout",
@@ -8228,6 +8335,55 @@ export const state = {
         }
       }
     },
+    "getMultipleUsages": {
+      "name": "getMultipleUsages",
+      "path": "/v1/admin/usages/multiple",
+      "description": "Get multiple usages",
+      "method": "get",
+      "section": "usage",
+      "disableDefaultParameters": {
+        "x-workspace-id": true
+      },
+      "parameters": {
+        "types": {
+          "in": "query",
+          "description": "Usage types to retrieve. All types have to belong to the same type of entity (e.g. workspace or bot).",
+          "type": "string[]",
+          "required": true
+        },
+        "ids": {
+          "in": "query",
+          "type": "string[]",
+          "description": "IDs of either workspaces or bots to retrieve usages for.",
+          "required": true
+        },
+        "period": {
+          "in": "query",
+          "description": "Period to get",
+          "type": "string",
+          "required": false
+        }
+      },
+      "response": {
+        "description": "Success",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "usages": {
+              "type": "array",
+              "items": {
+                "$ref": "#/components/schemas/Usage"
+              }
+            }
+          },
+          "required": [
+            "usages"
+          ],
+          "title": "getMultipleUsagesResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listUsageHistory": {
       "name": "listUsageHistory",
       "path": "/v1/admin/usages/{id}/history",
@@ -8236,7 +8392,7 @@ export const state = {
       "parameters": {
         "type": {
           "in": "query",
-          "description": "Type of usage",
+          "description": "Usage type",
           "type": "string",
           "enum": [
             "invocation_timeout",
@@ -10033,7 +10189,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.29.6",
+    "version": "0.30.1",
     "prefix": "v1"
   },
   "errors": [
@@ -10284,6 +10440,7 @@ export const state = {
       "updateWorkspaceResponse": true,
       "checkHandleAvailabilityResponse": true,
       "listWorkspacesResponse": true,
+      "listPublicWorkspacesResponse": true,
       "deleteWorkspaceResponse": true,
       "getAuditRecordsResponse": true,
       "listWorkspaceMembersResponse": true,
@@ -10302,6 +10459,7 @@ export const state = {
       "getIntegrationByNameResponse": true,
       "deleteIntegrationResponse": true,
       "getUsageResponse": true,
+      "getMultipleUsagesResponse": true,
       "listUsageHistoryResponse": true,
       "changeAISpendQuotaResponse": true,
       "listActivitiesResponse": true,
@@ -12817,6 +12975,7 @@ export const state = {
         "updateWorkspace",
         "checkHandleAvailability",
         "listWorkspaces",
+        "listPublicWorkspaces",
         "deleteWorkspace",
         "getAuditRecords"
       ],
@@ -12855,7 +13014,8 @@ export const state = {
       "description": "",
       "name": "usage",
       "operations": [
-        "getUsage"
+        "getUsage",
+        "getMultipleUsages"
       ],
       "schema": "Usage"
     },