@botpress/api 0.15.6 → 0.15.7

package/dist/gen/state.d.ts

@@ -2226,10 +2226,6 @@ export declare const state: {
                             };
                             description: string;
                         };
-                        alwaysAlive: {
-                            type: "boolean";
-                            description: string;
-                        };
                     };
                     title: string;
                     additionalProperties: false;
@@ -3341,6 +3337,38 @@ export declare const state: {
                 };
             };
         };
+        getAllWorkspaceQuotaCompletion: {
+            name: string;
+            description: string;
+            section: "workspace";
+            method: "get";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    additionalProperties: {
+                        type: "object";
+                        properties: {
+                            type: {
+                                type: "string";
+                                enum: string[];
+                            };
+                            completion: {
+                                type: "number";
+                            };
+                        };
+                        required: string[];
+                        additionalProperties: false;
+                    };
+                    title: string;
+                };
+            };
+            parameters: {};
+        };
         getWorkspaceQuota: {
             name: string;
             description: string;
@@ -5421,6 +5449,7 @@ export declare const state: {
             getWorkspaceResponse: true;
             listWorkspaceUsagesResponse: true;
             breakDownWorkspaceUsageByBotResponse: true;
+            getAllWorkspaceQuotaCompletionResponse: true;
             getWorkspaceQuotaResponse: true;
             listWorkspaceQuotasResponse: true;
             updateWorkspaceResponse: true;
@@ -5780,15 +5809,6 @@ export declare const state: {
                         type: "string";
                         description: string;
                     };
-                    alwaysAlive: {
-                        type: "boolean";
-                        description: string;
-                    };
-                    status: {
-                        type: "string";
-                        enum: string[];
-                        description: string;
-                    };
                     medias: {
                         type: "array";
                         items: {

package/dist/index.js

@@ -428948,10 +428948,6 @@ var state = {
                 required: ["url", "name"]
               },
               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",
@@ -430061,8 +430057,7 @@ var state = {
             "integrations_owned_count",
             "ai_spend",
             "openai_spend",
-            "bing_search_spend",
-            "always_alive"
+            "bing_search_spend"
           ],
           required: true
         },
@@ -430122,8 +430117,7 @@ var state = {
             "integrations_owned_count",
             "ai_spend",
             "openai_spend",
-            "bing_search_spend",
-            "always_alive"
+            "bing_search_spend"
           ],
           required: true
         },
@@ -430161,6 +430155,51 @@ var 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",
@@ -430192,8 +430231,7 @@ var state = {
             "integrations_owned_count",
             "ai_spend",
             "openai_spend",
-            "bing_search_spend",
-            "always_alive"
+            "bing_search_spend"
           ],
           required: true
         },
@@ -430234,8 +430272,7 @@ var state = {
                     "integrations_owned_count",
                     "ai_spend",
                     "openai_spend",
-                    "bing_search_spend",
-                    "always_alive"
+                    "bing_search_spend"
                   ],
                   description: "Usage type that can be used"
                 }
@@ -430304,8 +430341,7 @@ var state = {
                       "integrations_owned_count",
                       "ai_spend",
                       "openai_spend",
-                      "bing_search_spend",
-                      "always_alive"
+                      "bing_search_spend"
                     ],
                     description: "Usage type that can be used"
                   }
@@ -431945,8 +431981,7 @@ var state = {
             "integrations_owned_count",
             "ai_spend",
             "openai_spend",
-            "bing_search_spend",
-            "always_alive"
+            "bing_search_spend"
           ],
           required: true
         },
@@ -431999,8 +432034,7 @@ var state = {
             "integrations_owned_count",
             "ai_spend",
             "openai_spend",
-            "bing_search_spend",
-            "always_alive"
+            "bing_search_spend"
           ],
           required: true
         },
@@ -432276,7 +432310,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.15.6",
+    version: "0.15.7",
     prefix: "v1"
   },
   errors: [
@@ -432479,6 +432513,7 @@ var state = {
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
       breakDownWorkspaceUsageByBotResponse: true,
+      getAllWorkspaceQuotaCompletionResponse: true,
       getWorkspaceQuotaResponse: true,
       listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
@@ -432860,15 +432895,6 @@ var 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: {
@@ -432903,8 +432929,6 @@ var state = {
           "recurringEvents",
           "name",
           "dev",
-          "alwaysAlive",
-          "status",
           "medias"
         ],
         additionalProperties: false
@@ -433425,8 +433449,7 @@ var state = {
               "integrations_owned_count",
               "ai_spend",
               "openai_spend",
-              "bing_search_spend",
-              "always_alive"
+              "bing_search_spend"
             ],
             description: "Usage type that can be used"
           }
@@ -433991,6 +434014,7 @@ var state = {
         "getWorkspace",
         "listWorkspaceUsages",
         "breakDownWorkspaceUsageByBot",
+        "getAllWorkspaceQuotaCompletion",
         "getWorkspaceQuota",
         "listWorkspaceQuotas",
         "updateWorkspace",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.15.6",
+  "version": "0.15.7",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/gen/metadata.json

@@ -1 +1 @@
-{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}
+{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation","listParticipants","addParticipant","getParticipant","removeParticipant"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","patchState"],"schema":"State"},{"title":"Hub","description":"","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"title":"Bot","description":"","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"title":"Integration","description":"","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"title":"Workspace","description":"","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","breakDownWorkspaceUsageByBot","getAllWorkspaceQuotaCompletion","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"title":"Workspace Member","description":"","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"title":"Account","description":"","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"},{"title":"Usage","description":"","name":"usage","operations":["getUsage"],"schema":"Usage"},{"title":"Quotas","description":"","name":"quotas","operations":["changeAISpendQuota"]}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}