@botpress/api 0.7.0 → 0.7.2

package/dist/index.js

@@ -258872,7 +258872,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.3_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_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);
@@ -258916,7 +258916,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.3.3_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_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);
@@ -265905,7 +265905,7 @@ async function openapiTS(schema3, options = {}) {
 }
 var dist_default = openapiTS;
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.3_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_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);
@@ -269500,7 +269500,7 @@ var z = /* @__PURE__ */ Object.freeze({
   ZodError
 });
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.3_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.4_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);
@@ -425650,6 +425650,24 @@ var generateClient = async (state2, dir = ".", openApiGeneratorEndpoint, postPro
   removeLineFromFiles(dir, invalidLine);
   log_default.info("");
 };
+function generateErrorsFile(errors, dir = ".") {
+  initDirectory(dir);
+  log_default.info("Generating error types");
+  if (!errors || errors.length === 0) {
+    throw new import_verror.VError("No errors defined");
+  }
+  const errorCode = generateErrors(errors);
+  log_default.info("");
+  log_default.info("Saving generated files");
+  saveFile(dir, "errors.ts", errorCode);
+  log_default.info("");
+  log_default.info(`Appending header to typescript files in ${import_chalk.default.blue(dir)}`);
+  appendHeaders(dir, tsFileHeader);
+  log_default.info("");
+  log_default.info("Removing invalid line from typescript files");
+  removeLineFromFiles(dir, invalidLine);
+  log_default.info("");
+}
 function generateOpenapi(state2, dir = ".") {
   initDirectory(dir);
   log_default.info("Generating openapi content");
@@ -425824,7 +425842,8 @@ var createOpapiFromState = (state2) => {
     exportTypesBySection: (dir = ".") => generateTypesBySection(state2, dir),
     exportServer: (dir = ".", useExpressTypes) => generateServer(state2, dir, useExpressTypes),
     exportOpenapi: (dir = ".") => generateOpenapi(state2, dir),
-    exportState: (dir = ".") => exportStateAsTypescript(state2, dir)
+    exportState: (dir = ".") => exportStateAsTypescript(state2, dir),
+    exportErrors: (dir = ".") => generateErrorsFile(state2.errors ?? [], dir)
   };
 };
 function OpenApi(props) {
@@ -427035,6 +427054,130 @@ var state = {
       },
       parameters: {}
     },
+    listPersonalAccessTokens: {
+      name: "listPersonalAccessTokens",
+      description: "List PATs (Personal Access Tokens) of account.",
+      method: "get",
+      path: "/v1/admin/account/pats",
+      section: "account",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            pats: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string"
+                  },
+                  createdAt: {
+                    type: "string",
+                    format: "date-time"
+                  },
+                  note: {
+                    type: "string"
+                  }
+                },
+                required: ["id", "createdAt", "note"]
+              }
+            }
+          },
+          required: ["pats"],
+          title: "listPersonalAccessTokensResponse",
+          additionalProperties: false
+        }
+      },
+      parameters: {}
+    },
+    createPersonalAccessToken: {
+      name: "createPersonalAccessToken",
+      description: "Create a PAT",
+      method: "post",
+      path: "/v1/admin/account/pats",
+      section: "account",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      requestBody: {
+        description: "",
+        schema: {
+          type: "object",
+          properties: {
+            note: {
+              type: "string",
+              description: "Note to identify the PAT"
+            }
+          },
+          required: ["note"],
+          title: "createPersonalAccessTokenBody",
+          additionalProperties: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            pat: {
+              type: "object",
+              properties: {
+                id: {
+                  type: "string"
+                },
+                createdAt: {
+                  type: "string",
+                  format: "date-time"
+                },
+                note: {
+                  type: "string"
+                },
+                value: {
+                  type: "string",
+                  description: "The PAT value. This will only be returned here when created and cannot be retrieved later."
+                }
+              },
+              required: ["id", "createdAt", "note", "value"],
+              additionalProperties: false
+            }
+          },
+          required: ["pat"],
+          title: "createPersonalAccessTokenResponse",
+          additionalProperties: false
+        }
+      },
+      parameters: {}
+    },
+    deletePersonalAccessToken: {
+      name: "deletePersonalAccessToken",
+      description: "Delete a PAT",
+      method: "delete",
+      path: "/v1/admin/account/pats/{id}",
+      section: "account",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "ID of Personal Access Token",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          title: "deletePersonalAccessTokenResponse",
+          additionalProperties: false
+        }
+      }
+    },
     listPublicIntegrations: {
       name: "listPublicIntegrations",
       description: "List public integration",
@@ -428179,6 +428322,206 @@ var state = {
         }
       }
     },
+    listWorkspaceUsages: {
+      name: "listWorkspaceUsages",
+      description: "List workspace usages",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/usages",
+      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_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usages: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Usage"
+              }
+            }
+          },
+          required: ["usages"],
+          title: "listWorkspaceUsagesResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    getWorkspaceQuota: {
+      name: "getWorkspaceQuota",
+      description: "Get workspace quota",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/quota",
+      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_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            quota: {
+              type: "object",
+              properties: {
+                period: {
+                  type: "string",
+                  description: "Period of the quota that it is applied to"
+                },
+                value: {
+                  type: "number",
+                  description: "Value of the quota that is used"
+                },
+                type: {
+                  type: "string",
+                  enum: [
+                    "invocation_timeout",
+                    "invocation_calls",
+                    "storage_count",
+                    "bot_count",
+                    "knowledgebase_vector_count",
+                    "bot_ratelimit",
+                    "table_row_count",
+                    "workspace_member_count"
+                  ],
+                  description: "Usage type that can be used"
+                }
+              },
+              required: ["period", "value", "type"],
+              additionalProperties: false
+            }
+          },
+          required: ["quota"],
+          title: "getWorkspaceQuotaResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listWorkspaceQuotas: {
+      name: "listWorkspaceQuotas",
+      description: "List workspace quotas",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/quotas",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            quotas: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  period: {
+                    type: "string",
+                    description: "Period of the quota that it is applied to"
+                  },
+                  value: {
+                    type: "number",
+                    description: "Value of the quota that is used"
+                  },
+                  type: {
+                    type: "string",
+                    enum: [
+                      "invocation_timeout",
+                      "invocation_calls",
+                      "storage_count",
+                      "bot_count",
+                      "knowledgebase_vector_count",
+                      "bot_ratelimit",
+                      "table_row_count",
+                      "workspace_member_count"
+                    ],
+                    description: "Usage type that can be used"
+                  }
+                },
+                required: ["period", "value", "type"]
+              }
+            }
+          },
+          required: ["quotas"],
+          title: "listWorkspaceQuotasResponse",
+          additionalProperties: false
+        }
+      }
+    },
     updateWorkspace: {
       name: "updateWorkspace",
       description: "Update workspace",
@@ -429682,6 +430025,102 @@ var state = {
         }
       }
     },
+    getUsage: {
+      name: "getUsage",
+      path: "/v1/admin/usages/{id}",
+      description: "Get usage",
+      method: "get",
+      section: "usage",
+      parameters: {
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        },
+        id: {
+          type: "string",
+          description: "id of a bot or a workspace depending on the usage type",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usage: {
+              $ref: "#/components/schemas/Usage"
+            }
+          },
+          required: ["usage"],
+          title: "getUsageResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listUsageHistory: {
+      name: "listUsageHistory",
+      path: "/v1/admin/usages/{id}/history",
+      method: "get",
+      description: "Get usage history",
+      parameters: {
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        id: {
+          type: "string",
+          description: "id of a bot or a workspace depending on the usage type",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usages: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Usage"
+              }
+            }
+          },
+          required: ["usages"],
+          title: "listUsageHistoryResponse",
+          additionalProperties: false
+        }
+      }
+    },
     introspect: {
       name: "introspect",
       description: "Introspect the API",
@@ -429900,7 +430339,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.7.0",
+    version: "0.7.2",
     prefix: "v1"
   },
   errors: [
@@ -429998,6 +430437,16 @@ var state = {
       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."
     }
   ],
   refs: {
@@ -430017,6 +430466,7 @@ var state = {
       patchStateBody: true,
       callActionBody: true,
       configureIntegrationBody: true,
+      createPersonalAccessTokenBody: true,
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
@@ -430058,6 +430508,9 @@ var state = {
       callActionResponse: true,
       configureIntegrationResponse: true,
       getAccountResponse: true,
+      listPersonalAccessTokensResponse: true,
+      createPersonalAccessTokenResponse: true,
+      deletePersonalAccessTokenResponse: true,
       listPublicIntegrationsResponse: true,
       getPublicIntegrationByIdResponse: true,
       getPublicIntegrationResponse: true,
@@ -430072,6 +430525,9 @@ var state = {
       getBotAnalyticsResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
+      listWorkspaceUsagesResponse: true,
+      getWorkspaceQuotaResponse: true,
+      listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
       listWorkspacesResponse: true,
       changeWorkspacePlanResponse: true,
@@ -430088,6 +430544,8 @@ var state = {
       getIntegrationLogsResponse: true,
       getIntegrationByNameResponse: true,
       deleteIntegrationResponse: true,
+      getUsageResponse: true,
+      listUsageHistoryResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -430101,6 +430559,7 @@ var state = {
       Workspace: true,
       WorkspaceMember: true,
       Account: true,
+      Usage: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -430891,6 +431350,46 @@ var state = {
         additionalProperties: false
       }
     },
+    Usage: {
+      section: "usage",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+            description: "Id of the usage that it is linked to. It can either be a workspace id or a bot id"
+          },
+          period: {
+            type: "string",
+            description: "Period of the quota that it is applied to"
+          },
+          value: {
+            type: "number",
+            description: "Value of the current usage"
+          },
+          quota: {
+            type: "number",
+            description: "Quota of the current usage"
+          },
+          type: {
+            type: "string",
+            enum: [
+              "invocation_timeout",
+              "invocation_calls",
+              "storage_count",
+              "bot_count",
+              "knowledgebase_vector_count",
+              "bot_ratelimit",
+              "table_row_count",
+              "workspace_member_count"
+            ],
+            description: "Usage type that can be used"
+          }
+        },
+        required: ["id", "period", "value", "quota", "type"],
+        additionalProperties: false
+      }
+    },
     User: {
       section: "user",
       schema: {
@@ -431282,6 +431781,9 @@ var state = {
       operations: [
         "createWorkspace",
         "getWorkspace",
+        "listWorkspaceUsages",
+        "getWorkspaceQuota",
+        "listWorkspaceQuotas",
         "updateWorkspace",
         "listWorkspaces",
         "changeWorkspacePlan",
@@ -431306,8 +431808,20 @@ var state = {
       description: "",
       title: "Account",
       name: "account",
-      operations: ["getAccount"],
+      operations: [
+        "getAccount",
+        "listPersonalAccessTokens",
+        "createPersonalAccessToken",
+        "deletePersonalAccessToken"
+      ],
       schema: "Account"
+    },
+    {
+      description: "",
+      title: "Usage",
+      name: "usage",
+      operations: ["getUsage"],
+      schema: "Usage"
     }
   ]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.7.0",
+  "version": "0.7.2",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -22,6 +22,6 @@
     "zod": "^3.20.6"
   },
   "dependencies": {
-    "@bpinternal/opapi": "0.3.3"
+    "@bpinternal/opapi": "0.3.4"
   }
 }