@botpress/api 0.14.2 → 0.15.1

package/dist/gen/state.d.ts

@@ -2286,6 +2286,12 @@ export declare const state: {
             method: "get";
             path: string;
             parameters: {
+                dev: {
+                    in: "query";
+                    description: string;
+                    type: "boolean";
+                    required: false;
+                };
                 nextToken: {
                     in: "query";
                     description: string;
@@ -4638,6 +4644,12 @@ export declare const state: {
                     description: string;
                     in: "query";
                 };
+                dev: {
+                    in: "query";
+                    description: string;
+                    type: "boolean";
+                    required: false;
+                };
             };
             response: {
                 description: string;
@@ -4936,6 +4948,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 +5275,7 @@ export declare const state: {
             updateWorkspaceMemberBody: true;
             createIntegrationBody: true;
             updateIntegrationBody: true;
+            changeAISpendQuotaBody: true;
             introspectBody: true;
             createFileBody: true;
         };
@@ -5313,6 +5356,7 @@ export declare const state: {
             deleteIntegrationResponse: true;
             getUsageResponse: true;
             listUsageHistoryResponse: true;
+            changeAISpendQuotaResponse: true;
             introspectResponse: true;
             createFileResponse: true;
             getFileResponse: true;
@@ -6564,8 +6608,8 @@ export declare const state: {
         operations: string[];
         schema: string;
     } | {
-        description: string;
         title: string;
+        description: string;
         name: "hub";
         operations: string[];
         schema?: undefined;
@@ -6576,41 +6620,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

@@ -259676,7 +259676,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_zod_openapi = __toESM(require_src(), 1);
 var import_zod_openapi2 = __toESM(require_src(), 1);
 var import_chalk = __toESM(require_source(), 1);
@@ -259720,7 +259720,7 @@ var title = (str2) => {
   return str2.split(/(?=[A-Z])|[\.\-\s_]/).map((s) => s.trim()).filter((s) => !!s).map((s) => capitalize(s.toLowerCase())).join(" ");
 };
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_decompress = __toESM(require_decompress(), 1);
 var import_fs2 = __toESM(require("fs"), 1);
 var import_promises = __toESM(require("fs/promises"), 1);
@@ -266709,7 +266709,7 @@ async function openapiTS(schema3, options = {}) {
 }
 var dist_default = openapiTS;
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_zod_openapi3 = __toESM(require_src(), 1);
 var import_openapi3_ts = __toESM(require_dist3(), 1);
 var import_verror2 = __toESM(require_verror(), 1);
@@ -270304,7 +270304,7 @@ var z = /* @__PURE__ */ Object.freeze({
   ZodError
 });
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.6.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
 var import_openapi_parser = __toESM(require_lib11(), 1);
 var import_json_schema_to_typescript = __toESM(require_src3(), 1);
 var import_zod_openapi4 = __toESM(require_src(), 1);
@@ -425457,6 +425457,9 @@ var generateTypeAnnotation = (parameter, required) => {
     case "object":
       typeAnnotation += " any";
       break;
+    case "boolean":
+      typeAnnotation += " boolean";
+      break;
     default:
       throw new Error(`Unsupported parameter type: ${parameterType}`);
   }
@@ -425780,7 +425783,7 @@ abstract class BaseApiError<Code extends ErrorCode, Type extends string, Descrip
 
   static generateId() {
     const prefix = this.getPrefix();
-    const timestamp = new Date().toISOString().replace(/[:-TZ]/g, "").split(".")[0] // UTC time in YYMMDDHHMMSS format
+    const timestamp = new Date().toISOString().replace(/[\\-:TZ]/g, "").split(".")[0] // UTC time in YYMMDDHHMMSS format
 
     const randomSuffixByteLength = 4
     const randomHexSuffix = Array.from(cryptoLib.getRandomValues(new Uint8Array(randomSuffixByteLength)))
@@ -426119,7 +426122,7 @@ var createOpenapi = (state2) => {
     }
     if (operationObject.parameters) {
       objects.entries(operationObject.parameters).forEach(([parameterName, parameter]) => {
-        var _a, _b, _c;
+        var _a, _b, _c, _d;
         const parameterType = parameter.type;
         switch (parameterType) {
           case "string":
@@ -426158,6 +426161,17 @@ var createOpenapi = (state2) => {
               schema: parameter.schema
             });
             break;
+          case "boolean":
+            (_d = operation.parameters) == null ? void 0 : _d.push({
+              name: parameterName,
+              in: parameter.in,
+              description: parameter.description,
+              required: parameter.required,
+              schema: {
+                type: "boolean"
+              }
+            });
+            break;
           default:
             throw new import_verror2.default(`Parameter type ${parameterType} is not supported`);
         }
@@ -428995,6 +429009,12 @@ var state = {
       method: "get",
       path: "/v1/admin/bots",
       parameters: {
+        dev: {
+          in: "query",
+          description: "If true, only dev bots are returned. Otherwise, only production bots are returned.",
+          type: "boolean",
+          required: false
+        },
         nextToken: {
           in: "query",
           description: "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
@@ -431559,6 +431579,12 @@ var state = {
           type: "string",
           description: 'Integration version. Either a semver version or tag "latest"',
           in: "query"
+        },
+        dev: {
+          in: "query",
+          description: "If true, only dev integrations are returned. Otherwise, only production integrations are returned.",
+          type: "boolean",
+          required: false
         }
       },
       response: {
@@ -431824,7 +431850,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"
         }
       },
@@ -431871,7 +431897,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"
         }
       },
@@ -431893,6 +431919,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",
@@ -432111,7 +432167,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.14.2",
+    version: "0.15.1",
     prefix: "v1"
   },
   errors: [
@@ -432252,6 +432308,7 @@ var state = {
       updateWorkspaceMemberBody: true,
       createIntegrationBody: true,
       updateIntegrationBody: true,
+      changeAISpendQuotaBody: true,
       introspectBody: true,
       createFileBody: true
     },
@@ -432332,6 +432389,7 @@ var state = {
       deleteIntegrationResponse: true,
       getUsageResponse: true,
       listUsageHistoryResponse: true,
+      changeAISpendQuotaResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -433743,8 +433801,8 @@ var state = {
       schema: "State"
     },
     {
-      description: "",
       title: "Hub",
+      description: "",
       name: "hub",
       operations: [
         "listPublicIntegrations",
@@ -433759,8 +433817,8 @@ var state = {
       operations: ["callAction"]
     },
     {
-      description: "",
       title: "Bot",
+      description: "",
       name: "bot",
       operations: [
         "createBot",
@@ -433779,8 +433837,8 @@ var state = {
       schema: "Bot"
     },
     {
-      description: "",
       title: "Integration",
+      description: "",
       name: "integration",
       operations: [
         "createIntegration",
@@ -433794,8 +433852,8 @@ var state = {
       schema: "Integration"
     },
     {
-      description: "",
       title: "Workspace",
+      description: "",
       name: "workspace",
       operations: [
         "getWorkspaceBillingDetails",
@@ -433816,8 +433874,8 @@ var state = {
       schema: "Workspace"
     },
     {
-      description: "",
       title: "Workspace Member",
+      description: "",
       name: "workspaceMember",
       operations: [
         "listWorkspaceMembers",
@@ -433828,8 +433886,8 @@ var state = {
       schema: "WorkspaceMember"
     },
     {
-      description: "",
       title: "Account",
+      description: "",
       name: "account",
       operations: [
         "getAccount",
@@ -433840,11 +433898,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.2",
+  "version": "0.15.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -22,6 +22,6 @@
     "zod": "^3.20.6"
   },
   "dependencies": {
-    "@bpinternal/opapi": "^0.6.0"
+    "@bpinternal/opapi": "^0.6.2"
   }
 }

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."}]}