@botpress/api 0.6.0 → 0.7.1

package/dist/gen/state.d.ts

@@ -1197,6 +1197,130 @@ export declare const state: {
             };
             parameters: {};
         };
+        listPersonalAccessTokens: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "account";
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        pats: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    createdAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    note: {
+                                        type: "string";
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
+        createPersonalAccessToken: {
+            name: string;
+            description: string;
+            method: "post";
+            path: string;
+            section: "account";
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            requestBody: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        note: {
+                            type: "string";
+                            description: string;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        pat: {
+                            type: "object";
+                            properties: {
+                                id: {
+                                    type: "string";
+                                };
+                                createdAt: {
+                                    type: "string";
+                                    format: string;
+                                };
+                                note: {
+                                    type: "string";
+                                };
+                                value: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
+        deletePersonalAccessToken: {
+            name: string;
+            description: string;
+            method: "delete";
+            path: string;
+            section: "account";
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         listPublicIntegrations: {
             name: string;
             description: string;
@@ -2032,6 +2156,24 @@ export declare const state: {
                     description: string;
                     in: "path";
                 };
+                timeStart: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                timeEnd: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: false;
+                };
             };
             response: {
                 description: string;
@@ -2056,6 +2198,9 @@ export declare const state: {
                                 required: string[];
                             };
                         };
+                        nextToken: {
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -3580,6 +3725,24 @@ export declare const state: {
                     description: string;
                     in: "path";
                 };
+                timeStart: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                timeEnd: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: true;
+                };
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                    required: false;
+                };
             };
             response: {
                 description: string;
@@ -3604,6 +3767,9 @@ export declare const state: {
                                 required: string[];
                             };
                         };
+                        nextToken: {
+                            type: "string";
+                        };
                     };
                     required: string[];
                     title: string;
@@ -3949,6 +4115,7 @@ export declare const state: {
             patchStateBody: true;
             callActionBody: true;
             configureIntegrationBody: true;
+            createPersonalAccessTokenBody: true;
             createBotBody: true;
             updateBotBody: true;
             transferBotBody: true;
@@ -3990,6 +4157,9 @@ export declare const state: {
             callActionResponse: true;
             configureIntegrationResponse: true;
             getAccountResponse: true;
+            listPersonalAccessTokensResponse: true;
+            createPersonalAccessTokenResponse: true;
+            deletePersonalAccessTokenResponse: true;
             listPublicIntegrationsResponse: true;
             getPublicIntegrationByIdResponse: true;
             getPublicIntegrationResponse: true;

package/dist/index.d.ts

@@ -6,4 +6,5 @@ export declare const api: {
     exportServer: (dir: string | undefined, useExpressTypes: boolean) => Promise<void>;
     exportOpenapi: (dir?: string | undefined) => void;
     exportState: (dir?: string | undefined) => void;
+    exportErrors: (dir?: string | undefined) => void;
 };

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",
@@ -427878,6 +428021,24 @@ var state = {
           type: "string",
           description: "Bot ID",
           in: "path"
+        },
+        timeStart: {
+          in: "query",
+          description: "Beginning of the time range to get logs from",
+          type: "string",
+          required: true
+        },
+        timeEnd: {
+          in: "query",
+          description: "End of the time range to get logs from",
+          type: "string",
+          required: true
+        },
+        nextToken: {
+          in: "query",
+          description: "Token to get the next page of logs",
+          type: "string",
+          required: false
         }
       },
       response: {
@@ -427902,6 +428063,9 @@ var state = {
                 },
                 required: ["timestamp", "level", "message"]
               }
+            },
+            nextToken: {
+              type: "string"
             }
           },
           required: ["logs"],
@@ -429553,6 +429717,24 @@ var state = {
           type: "string",
           description: "Integration Id",
           in: "path"
+        },
+        timeStart: {
+          in: "query",
+          description: "Beginning of the time range to get logs from",
+          type: "string",
+          required: true
+        },
+        timeEnd: {
+          in: "query",
+          description: "End of the time range to get logs from",
+          type: "string",
+          required: true
+        },
+        nextToken: {
+          in: "query",
+          description: "Token to get the next page of logs",
+          type: "string",
+          required: false
         }
       },
       response: {
@@ -429577,6 +429759,9 @@ var state = {
                 },
                 required: ["timestamp", "level", "message"]
               }
+            },
+            nextToken: {
+              type: "string"
             }
           },
           required: ["logs"],
@@ -429858,7 +430043,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.6.0",
+    version: "0.7.1",
     prefix: "v1"
   },
   errors: [
@@ -429956,6 +430141,16 @@ var state = {
       status: 402,
       type: "PaymentRequired",
       description: "A payment is required to perform this request."
+    },
+    {
+      status: 429,
+      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: {
@@ -429975,6 +430170,7 @@ var state = {
       patchStateBody: true,
       callActionBody: true,
       configureIntegrationBody: true,
+      createPersonalAccessTokenBody: true,
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
@@ -430016,6 +430212,9 @@ var state = {
       callActionResponse: true,
       configureIntegrationResponse: true,
       getAccountResponse: true,
+      listPersonalAccessTokensResponse: true,
+      createPersonalAccessTokenResponse: true,
+      deletePersonalAccessTokenResponse: true,
       listPublicIntegrationsResponse: true,
       getPublicIntegrationByIdResponse: true,
       getPublicIntegrationResponse: true,
@@ -431264,7 +431463,12 @@ var state = {
       description: "",
       title: "Account",
       name: "account",
-      operations: ["getAccount"],
+      operations: [
+        "getAccount",
+        "listPersonalAccessTokens",
+        "createPersonalAccessToken",
+        "deletePersonalAccessToken"
+      ],
       schema: "Account"
     }
   ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.6.0",
+  "version": "0.7.1",
   "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"
   }
 }

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"],"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"],"schema":"Bot"},{"description":"","title":"Integration","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"description":"","title":"Workspace","name":"workspace","operations":["createWorkspace","getWorkspace","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"],"schema":"Account"}],"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."}]}
+{"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"],"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"],"schema":"Bot"},{"description":"","title":"Integration","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"description":"","title":"Workspace","name":"workspace","operations":["createWorkspace","getWorkspace","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"}],"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":429,"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."}]}