@botpress/api 0.15.6 → 0.15.8

package/src/gen/state.ts

@@ -1,7 +1,40 @@
 // This file was generated by the Opapi Generator
 /* eslint-disable */
 /* prettier-ignore */
-import { State } from '@bpinternal/opapi'
+import * as opapi from "@bpinternal/opapi";
+export type State = opapi.State<
+  | "Bot"
+  | "Integration"
+  | "Workspace"
+  | "WorkspaceMember"
+  | "Account"
+  | "Usage"
+  | "Issue"
+  | "IssueEvent"
+  | "User"
+  | "Conversation"
+  | "Event"
+  | "Message"
+  | "State"
+  | "File",
+  never,
+  | "user"
+  | "conversation"
+  | "event"
+  | "message"
+  | "file"
+  | "state"
+  | "hub"
+  | "action"
+  | "bot"
+  | "integration"
+  | "workspace"
+  | "workspaceMember"
+  | "account"
+  | "usage"
+  | "quotas"
+  | "helper"
+>;
 export const state = {
   operations: {
     createConversation: {
@@ -1496,6 +1529,51 @@ export const state = {
       },
       parameters: {},
     },
+    runVrl: {
+      name: "runVrl",
+      description: "Run a VRL script",
+      method: "post",
+      path: "/v1/admin/helper/vrl",
+      section: "helper",
+      requestBody: {
+        description: "VRL script",
+        schema: {
+          type: "object",
+          properties: {
+            data: {
+              type: "object",
+              additionalProperties: true,
+            },
+            script: {
+              type: "string",
+            },
+          },
+          required: ["data", "script"],
+          title: "runVrlBody",
+          additionalProperties: false,
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            data: {
+              type: "object",
+              additionalProperties: true,
+            },
+            result: {
+              type: "object",
+              additionalProperties: true,
+            },
+          },
+          required: ["data", "result"],
+          title: "runVrlResponse",
+          additionalProperties: false,
+        },
+      },
+      parameters: {},
+    },
     getAccount: {
       name: "getAccount",
       description:
@@ -2367,11 +2445,6 @@ export const state = {
               },
               description: "Media files associated with the [Bot](#schema_bot)",
             },
-            alwaysAlive: {
-              type: "boolean",
-              description:
-                "Indicates if the [Bot](#schema_bot) should be executed in accelerated mode",
-            },
           },
           title: "updateBotBody",
           additionalProperties: false,
@@ -3499,7 +3572,6 @@ export const state = {
             "ai_spend",
             "openai_spend",
             "bing_search_spend",
-            "always_alive",
           ],
           required: true,
         },
@@ -3560,7 +3632,6 @@ export const state = {
             "ai_spend",
             "openai_spend",
             "bing_search_spend",
-            "always_alive",
           ],
           required: true,
         },
@@ -3598,6 +3669,52 @@ export const state = {
         },
       },
     },
+    getAllWorkspaceQuotaCompletion: {
+      name: "getAllWorkspaceQuotaCompletion",
+      description:
+        "For a user, gets a map of workspace IDs to their highest quota completion rate",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/usages/quota-completion",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          additionalProperties: {
+            type: "object",
+            properties: {
+              type: {
+                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",
+                ],
+              },
+              completion: {
+                type: "number",
+              },
+            },
+            required: ["type", "completion"],
+            additionalProperties: false,
+          },
+          title: "getAllWorkspaceQuotaCompletionResponse",
+        },
+      },
+      parameters: {},
+    },
     getWorkspaceQuota: {
       name: "getWorkspaceQuota",
       description: "Get workspace quota",
@@ -3630,7 +3747,6 @@ export const state = {
             "ai_spend",
             "openai_spend",
             "bing_search_spend",
-            "always_alive",
           ],
           required: true,
         },
@@ -3672,7 +3788,6 @@ export const state = {
                     "ai_spend",
                     "openai_spend",
                     "bing_search_spend",
-                    "always_alive",
                   ],
                   description: "Usage type that can be used",
                 },
@@ -3742,7 +3857,6 @@ export const state = {
                       "ai_spend",
                       "openai_spend",
                       "bing_search_spend",
-                      "always_alive",
                     ],
                     description: "Usage type that can be used",
                   },
@@ -5435,7 +5549,6 @@ export const state = {
             "ai_spend",
             "openai_spend",
             "bing_search_spend",
-            "always_alive",
           ],
           required: true,
         },
@@ -5490,7 +5603,6 @@ export const state = {
             "ai_spend",
             "openai_spend",
             "bing_search_spend",
-            "always_alive",
           ],
           required: true,
         },
@@ -5770,7 +5882,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.15.6",
+    version: "0.15.8",
     prefix: "v1",
   },
   errors: [
@@ -5907,6 +6019,7 @@ export const state = {
       patchStateBody: true,
       callActionBody: true,
       configureIntegrationBody: true,
+      runVrlBody: true,
       createPersonalAccessTokenBody: true,
       createBotBody: true,
       updateBotBody: true,
@@ -5955,6 +6068,7 @@ export const state = {
       patchStateResponse: true,
       callActionResponse: true,
       configureIntegrationResponse: true,
+      runVrlResponse: true,
       getAccountResponse: true,
       listPersonalAccessTokensResponse: true,
       createPersonalAccessTokenResponse: true,
@@ -5982,6 +6096,7 @@ export const state = {
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
       breakDownWorkspaceUsageByBotResponse: true,
+      getAllWorkspaceQuotaCompletionResponse: true,
       getWorkspaceQuotaResponse: true,
       listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
@@ -6384,16 +6499,6 @@ export const state = {
             type: "string",
             description: "Id of the user that created the bot",
           },
-          alwaysAlive: {
-            type: "boolean",
-            description:
-              "Indicates if the [Bot](#schema_bot) should be executed in accelerated mode",
-          },
-          status: {
-            type: "string",
-            enum: ["active", "deploying"],
-            description: "Status of the bot",
-          },
           medias: {
             type: "array",
             items: {
@@ -6428,8 +6533,6 @@ export const state = {
           "recurringEvents",
           "name",
           "dev",
-          "alwaysAlive",
-          "status",
           "medias",
         ],
         additionalProperties: false,
@@ -6976,7 +7079,6 @@ export const state = {
               "ai_spend",
               "openai_spend",
               "bing_search_spend",
-              "always_alive",
             ],
             description: "Usage type that can be used",
           },
@@ -7570,6 +7672,7 @@ export const state = {
         "getWorkspace",
         "listWorkspaceUsages",
         "breakDownWorkspaceUsageByBot",
+        "getAllWorkspaceQuotaCompletion",
         "getWorkspaceQuota",
         "listWorkspaceQuotas",
         "updateWorkspace",
@@ -7617,39 +7720,14 @@ export const state = {
       name: "quotas",
       operations: ["changeAISpendQuota"],
     },
+    {
+      title: "Helper",
+      description: "",
+      name: "helper",
+      operations: ["runVrl"],
+    },
   ],
   options: {
     allowUnions: false,
   },
-} satisfies State<
-  | "Bot"
-  | "Integration"
-  | "Workspace"
-  | "WorkspaceMember"
-  | "Account"
-  | "Usage"
-  | "Issue"
-  | "IssueEvent"
-  | "User"
-  | "Conversation"
-  | "Event"
-  | "Message"
-  | "State"
-  | "File",
-  never,
-  | "user"
-  | "conversation"
-  | "event"
-  | "message"
-  | "file"
-  | "state"
-  | "hub"
-  | "action"
-  | "bot"
-  | "integration"
-  | "workspace"
-  | "workspaceMember"
-  | "account"
-  | "usage"
-  | "quotas"
->;
+} satisfies State;

package/src/index.ts

@@ -1,3 +1,4 @@
 import { OpenApi } from '@bpinternal/opapi'
 import { state } from './gen/state'
+export * from './gen/state'
 export const api = OpenApi.fromState(state)