@botpress/api 0.15.1 → 0.15.4

package/dist/gen/state.d.ts

@@ -3144,6 +3144,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        billingVersion: {
+                            type: "string";
+                            enum: string[];
+                        };
                         plan: {
                             type: "string";
                             enum: string[];
@@ -3205,6 +3209,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        billingVersion: {
+                            type: "string";
+                            enum: string[];
+                        };
                         plan: {
                             type: "string";
                             enum: string[];
@@ -3269,6 +3277,62 @@ export declare const state: {
                 };
             };
         };
+        breakDownWorkspaceUsageByBot: {
+            name: string;
+            description: string;
+            section: "workspace";
+            method: "get";
+            path: string;
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                type: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    enum: string[];
+                    required: true;
+                };
+                period: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        data: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    botId: {
+                                        type: "string";
+                                    };
+                                    value: {
+                                        type: "number";
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         getWorkspaceQuota: {
             name: string;
             description: string;
@@ -3449,6 +3513,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        billingVersion: {
+                            type: "string";
+                            enum: string[];
+                        };
                         plan: {
                             type: "string";
                             enum: string[];
@@ -3514,6 +3582,10 @@ export declare const state: {
                                         type: "string";
                                         enum: string[];
                                     };
+                                    billingVersion: {
+                                        type: "string";
+                                        enum: string[];
+                                    };
                                     plan: {
                                         type: "string";
                                         enum: string[];
@@ -3604,6 +3676,10 @@ export declare const state: {
                             type: "string";
                             enum: string[];
                         };
+                        billingVersion: {
+                            type: "string";
+                            enum: string[];
+                        };
                         plan: {
                             type: "string";
                             enum: string[];
@@ -5336,6 +5412,7 @@ export declare const state: {
             createWorkspaceResponse: true;
             getWorkspaceResponse: true;
             listWorkspaceUsagesResponse: true;
+            breakDownWorkspaceUsageByBotResponse: true;
             getWorkspaceQuotaResponse: true;
             listWorkspaceQuotasResponse: true;
             updateWorkspaceResponse: true;
@@ -6097,6 +6174,10 @@ export declare const state: {
                         type: "string";
                         enum: string[];
                     };
+                    billingVersion: {
+                        type: "string";
+                        enum: string[];
+                    };
                     plan: {
                         type: "string";
                         enum: string[];

package/dist/index.js

@@ -429912,6 +429912,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            billingVersion: {
+              type: "string",
+              enum: ["v1", "v2"]
+            },
             plan: {
               type: "string",
               enum: ["community", "team", "enterprise"]
@@ -429931,6 +429935,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "billingVersion",
             "plan",
             "blocked",
             "spendingLimit"
@@ -429984,6 +429989,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            billingVersion: {
+              type: "string",
+              enum: ["v1", "v2"]
+            },
             plan: {
               type: "string",
               enum: ["community", "team", "enterprise"]
@@ -430003,6 +430012,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "billingVersion",
             "plan",
             "blocked",
             "spendingLimit"
@@ -430072,6 +430082,75 @@ var 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",
@@ -430291,6 +430370,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            billingVersion: {
+              type: "string",
+              enum: ["v1", "v2"]
+            },
             plan: {
               type: "string",
               enum: ["community", "team", "enterprise"]
@@ -430310,6 +430393,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "billingVersion",
             "plan",
             "blocked",
             "spendingLimit"
@@ -430367,6 +430451,10 @@ var state = {
                     type: "string",
                     enum: ["free", "premium"]
                   },
+                  billingVersion: {
+                    type: "string",
+                    enum: ["v1", "v2"]
+                  },
                   plan: {
                     type: "string",
                     enum: ["community", "team", "enterprise"]
@@ -430386,6 +430474,7 @@ var state = {
                   "updatedAt",
                   "botCount",
                   "accountType",
+                  "billingVersion",
                   "plan",
                   "blocked",
                   "spendingLimit"
@@ -430468,6 +430557,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            billingVersion: {
+              type: "string",
+              enum: ["v1", "v2"]
+            },
             plan: {
               type: "string",
               enum: ["community", "team", "enterprise"]
@@ -430487,6 +430580,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "billingVersion",
             "plan",
             "blocked",
             "spendingLimit"
@@ -432167,7 +432261,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.15.1",
+    version: "0.15.4",
     prefix: "v1"
   },
   errors: [
@@ -432369,6 +432463,7 @@ var state = {
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
+      breakDownWorkspaceUsageByBotResponse: true,
       getWorkspaceQuotaResponse: true,
       listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
@@ -433186,6 +433281,10 @@ var state = {
             type: "string",
             enum: ["free", "premium"]
           },
+          billingVersion: {
+            type: "string",
+            enum: ["v1", "v2"]
+          },
           plan: {
             type: "string",
             enum: ["community", "team", "enterprise"]
@@ -433205,6 +433304,7 @@ var state = {
           "updatedAt",
           "botCount",
           "accountType",
+          "billingVersion",
           "plan",
           "blocked",
           "spendingLimit"
@@ -433863,6 +433963,7 @@ var state = {
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",
+        "breakDownWorkspaceUsageByBot",
         "getWorkspaceQuota",
         "listWorkspaceQuotas",
         "updateWorkspace",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.15.1",
+  "version": "0.15.4",
   "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","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","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."}]}