@botpress/api 0.14.0 → 0.15.0

package/dist/gen/state.d.ts

@@ -4936,6 +4936,36 @@ export declare const state: {
                 };
             };
         };
+        changeAISpendQuota: {
+            name: string;
+            path: string;
+            description: string;
+            method: "put";
+            section: "quotas";
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        monthlySpendingLimit: {
+                            type: "number";
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
         introspect: {
             name: string;
             description: string;
@@ -5233,6 +5263,7 @@ export declare const state: {
             updateWorkspaceMemberBody: true;
             createIntegrationBody: true;
             updateIntegrationBody: true;
+            changeAISpendQuotaBody: true;
             introspectBody: true;
             createFileBody: true;
         };
@@ -5313,6 +5344,7 @@ export declare const state: {
             deleteIntegrationResponse: true;
             getUsageResponse: true;
             listUsageHistoryResponse: true;
+            changeAISpendQuotaResponse: true;
             introspectResponse: true;
             createFileResponse: true;
             getFileResponse: true;
@@ -6564,8 +6596,8 @@ export declare const state: {
         operations: string[];
         schema: string;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "hub";
         operations: string[];
         schema?: undefined;
@@ -6576,41 +6608,47 @@ export declare const state: {
         operations: string[];
         schema?: undefined;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "bot";
         operations: string[];
         schema: string;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "integration";
         operations: string[];
         schema: string;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "workspace";
         operations: string[];
         schema: string;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "workspaceMember";
         operations: string[];
         schema: string;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "account";
         operations: string[];
         schema: string;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "usage";
         operations: string[];
         schema: string;
+    } | {
+        title: string;
+        description: string;
+        name: "quotas";
+        operations: string[];
+        schema?: undefined;
     })[];
     options: {
         allowUnions: false;

package/dist/index.d.ts

@@ -1,7 +1,7 @@
 export declare const api: {
-    getState: () => import("@bpinternal/opapi").State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File", "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage">;
+    getState: () => import("@bpinternal/opapi").State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File", "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas">;
     getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
-    addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage", Path, "zod-schema">) => void;
+    addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage" | "quotas", Path, "zod-schema">) => void;
     exportClient: (dir: string | undefined, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined) => Promise<void>;
     exportTypesBySection: (dir?: string | undefined) => Promise<void>;
     exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;

package/dist/index.js

@@ -430021,7 +430021,9 @@ var state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
-            "ai_spend"
+            "ai_spend",
+            "openai_spend",
+            "bing_search_spend"
           ],
           required: true
         },
@@ -430079,7 +430081,9 @@ var state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
-            "ai_spend"
+            "ai_spend",
+            "openai_spend",
+            "bing_search_spend"
           ],
           required: true
         },
@@ -430118,7 +430122,9 @@ var state = {
                     "table_row_count",
                     "workspace_member_count",
                     "integrations_owned_count",
-                    "ai_spend"
+                    "ai_spend",
+                    "openai_spend",
+                    "bing_search_spend"
                   ],
                   description: "Usage type that can be used"
                 }
@@ -430185,7 +430191,9 @@ var state = {
                       "table_row_count",
                       "workspace_member_count",
                       "integrations_owned_count",
-                      "ai_spend"
+                      "ai_spend",
+                      "openai_spend",
+                      "bing_search_spend"
                     ],
                     description: "Usage type that can be used"
                   }
@@ -431802,7 +431810,9 @@ var state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
-            "ai_spend"
+            "ai_spend",
+            "openai_spend",
+            "bing_search_spend"
           ],
           required: true
         },
@@ -431814,7 +431824,7 @@ var state = {
         },
         id: {
           type: "string",
-          description: "id of a bot or a workspace depending on the usage type",
+          description: 'ID of a bot or a workspace, depending on the "type" parameter',
           in: "path"
         }
       },
@@ -431853,13 +431863,15 @@ var state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
-            "ai_spend"
+            "ai_spend",
+            "openai_spend",
+            "bing_search_spend"
           ],
           required: true
         },
         id: {
           type: "string",
-          description: "id of a bot or a workspace depending on the usage type",
+          description: 'ID of a bot or a workspace, depending on the "type" parameter',
           in: "path"
         }
       },
@@ -431881,6 +431893,36 @@ var state = {
         }
       }
     },
+    changeAISpendQuota: {
+      name: "changeAISpendQuota",
+      path: "/v1/admin/quotas/ai-spend",
+      description: "Change AI Spend quota",
+      method: "put",
+      section: "quotas",
+      requestBody: {
+        description: "New AI Spend quota",
+        schema: {
+          type: "object",
+          properties: {
+            monthlySpendingLimit: {
+              type: "number"
+            }
+          },
+          required: ["monthlySpendingLimit"],
+          title: "changeAISpendQuotaBody",
+          additionalProperties: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          title: "changeAISpendQuotaResponse",
+          additionalProperties: false
+        }
+      },
+      parameters: {}
+    },
     introspect: {
       name: "introspect",
       description: "Introspect the API",
@@ -432099,7 +432141,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.14.0",
+    version: "0.15.0",
     prefix: "v1"
   },
   errors: [
@@ -432240,6 +432282,7 @@ var state = {
       updateWorkspaceMemberBody: true,
       createIntegrationBody: true,
       updateIntegrationBody: true,
+      changeAISpendQuotaBody: true,
       introspectBody: true,
       createFileBody: true
     },
@@ -432320,6 +432363,7 @@ var state = {
       deleteIntegrationResponse: true,
       getUsageResponse: true,
       listUsageHistoryResponse: true,
+      changeAISpendQuotaResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -433227,7 +433271,9 @@ var state = {
               "table_row_count",
               "workspace_member_count",
               "integrations_owned_count",
-              "ai_spend"
+              "ai_spend",
+              "openai_spend",
+              "bing_search_spend"
             ],
             description: "Usage type that can be used"
           }
@@ -433729,8 +433775,8 @@ var state = {
       schema: "State"
     },
     {
-      description: "",
       title: "Hub",
+      description: "",
       name: "hub",
       operations: [
         "listPublicIntegrations",
@@ -433745,8 +433791,8 @@ var state = {
       operations: ["callAction"]
     },
     {
-      description: "",
       title: "Bot",
+      description: "",
       name: "bot",
       operations: [
         "createBot",
@@ -433765,8 +433811,8 @@ var state = {
       schema: "Bot"
     },
     {
-      description: "",
       title: "Integration",
+      description: "",
       name: "integration",
       operations: [
         "createIntegration",
@@ -433780,8 +433826,8 @@ var state = {
       schema: "Integration"
     },
     {
-      description: "",
       title: "Workspace",
+      description: "",
       name: "workspace",
       operations: [
         "getWorkspaceBillingDetails",
@@ -433802,8 +433848,8 @@ var state = {
       schema: "Workspace"
     },
     {
-      description: "",
       title: "Workspace Member",
+      description: "",
       name: "workspaceMember",
       operations: [
         "listWorkspaceMembers",
@@ -433814,8 +433860,8 @@ var state = {
       schema: "WorkspaceMember"
     },
     {
-      description: "",
       title: "Account",
+      description: "",
       name: "account",
       operations: [
         "getAccount",
@@ -433826,11 +433872,17 @@ var state = {
       schema: "Account"
     },
     {
-      description: "",
       title: "Usage",
+      description: "",
       name: "usage",
       operations: ["getUsage"],
       schema: "Usage"
+    },
+    {
+      title: "Quotas",
+      description: "",
+      name: "quotas",
+      operations: ["changeAISpendQuota"]
     }
   ],
   options: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.14.0",
+  "version": "0.15.0",
   "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"},{"description":"","title":"Hub","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Bot","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics","listBotIssues","deleteBotIssue","listBotIssueEvents"],"schema":"Bot"},{"description":"","title":"Integration","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"description":"","title":"Workspace","name":"workspace","operations":["getWorkspaceBillingDetails","setWorkspacePaymentMethod","listWorkspaceInvoices","chargeWorkspaceUnpaidInvoices","createWorkspace","getWorkspace","listWorkspaceUsages","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"description":"","title":"Workspace Member","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"description":"","title":"Account","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"},{"description":"","title":"Usage","name":"usage","operations":["getUsage"],"schema":"Usage"}],"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","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."}]}