@botpress/api 0.15.3 → 0.15.5

package/src/gen/state.ts

@@ -34,6 +34,7 @@ export const state = {
               maxLength: 200,
               description:
                 "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.",
+              deprecated: true,
             },
           },
           required: ["channel", "tags"],
@@ -181,6 +182,7 @@ export const state = {
               maxLength: 200,
               description:
                 "[DEPRECATED] To create a conversation from within a bot, call an action of the integration instead.",
+              deprecated: true,
             },
           },
           required: ["channel", "tags"],
@@ -981,6 +983,7 @@ export const state = {
               maxLength: 200,
               description:
                 "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
+              deprecated: true,
             },
             name: {
               type: "string",
@@ -1132,6 +1135,7 @@ export const state = {
               maxLength: 200,
               description:
                 "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
+              deprecated: true,
             },
             name: {
               type: "string",
@@ -3518,6 +3522,75 @@ export const state = {
         },
       },
     },
+    breakDownWorkspaceUsageByBot: {
+      name: "breakDownWorkspaceUsageByBot",
+      description: "Break down workspace usage by bot",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/usages/by-bot",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_storage",
+            "workspace_ratelimit",
+            "table_row_count",
+            "workspace_member_count",
+            "integrations_owned_count",
+            "ai_spend",
+            "openai_spend",
+            "bing_search_spend",
+          ],
+          required: true,
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false,
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            data: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  botId: {
+                    type: "string",
+                  },
+                  value: {
+                    type: "number",
+                  },
+                },
+                required: ["botId", "value"],
+              },
+            },
+          },
+          required: ["data"],
+          title: "breakDownWorkspaceUsageByBotResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     getWorkspaceQuota: {
       name: "getWorkspaceQuota",
       description: "Get workspace quota",
@@ -5685,7 +5758,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.15.3",
+    version: "0.15.5",
     prefix: "v1",
   },
   errors: [
@@ -5896,6 +5969,7 @@ export const state = {
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
+      breakDownWorkspaceUsageByBotResponse: true,
       getWorkspaceQuotaResponse: true,
       listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
@@ -7470,6 +7544,7 @@ export const state = {
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",
+        "breakDownWorkspaceUsageByBot",
         "getWorkspaceQuota",
         "listWorkspaceQuotas",
         "updateWorkspace",