@botpress/api 0.5.6 → 0.6.0

package/dist/gen/state.d.ts

@@ -1157,6 +1157,46 @@ export declare const state: {
             };
             parameters: {};
         };
+        getAccount: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "account";
+            disableDefaultParameters: {
+                "x-workspace-id": boolean;
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        account: {
+                            type: "object";
+                            properties: {
+                                id: {
+                                    type: "string";
+                                };
+                                email: {
+                                    type: "string";
+                                };
+                                createdAt: {
+                                    type: "string";
+                                    format: string;
+                                    description: string;
+                                };
+                            };
+                            required: string[];
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+            parameters: {};
+        };
         listPublicIntegrations: {
             name: string;
             description: string;
@@ -3949,6 +3989,7 @@ export declare const state: {
             patchStateResponse: true;
             callActionResponse: true;
             configureIntegrationResponse: true;
+            getAccountResponse: true;
             listPublicIntegrationsResponse: true;
             getPublicIntegrationByIdResponse: true;
             getPublicIntegrationResponse: true;
@@ -3991,6 +4032,7 @@ export declare const state: {
             Integration: true;
             Workspace: true;
             WorkspaceMember: true;
+            Account: true;
             User: true;
             Conversation: true;
             Event: true;
@@ -4689,6 +4731,27 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Account: {
+            section: "account";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    email: {
+                        type: "string";
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                        description: string;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
         User: {
             section: "user";
             schema: {
@@ -5003,5 +5066,11 @@ export declare const state: {
         name: "workspaceMember";
         operations: string[];
         schema: string;
+    } | {
+        description: string;
+        title: string;
+        name: "account";
+        operations: string[];
+        schema: string;
     })[];
 };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export declare const api: {
-    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "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", Path, "zod-schema">) => void;
+    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "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", 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

@@ -258872,7 +258872,7 @@ __export(src_exports, {
 });
 module.exports = __toCommonJS(src_exports);
 
-// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.3_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.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.3_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.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.3_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.2_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.3_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);
@@ -424926,18 +424926,23 @@ ${Object.entries(codes).map(([name, code]) => `  ${name}: ${code},`).join("\n")}
 type ErrorCode = typeof codes[keyof typeof codes]
 
 declare const window: any
-type CryptoLib = { getRandomValues(array: Uint8Array): number[] }
+type CryptoLib = { getRandomValues(array: Uint8Array): Uint8Array }
+
+const cryptoLibPolyfill: CryptoLib = {
+  // Fallback in case crypto isn't available.
+  getRandomValues: (array: Uint8Array) => new Uint8Array(array.map(() => Math.floor(Math.random() * 256))),
+}
 
 let cryptoLib: CryptoLib =
   typeof window !== 'undefined' && typeof window.document !== 'undefined'
-    ? window.crypto
-      ? window.crypto // Note: On browsers we need to use window.crypto instead of the imported crypto module as the latter is externalized and doesn't have getRandomValues().
-      : {
-          // Fallback in case crypto isn't available.
-          getRandomValues: (array: Uint8Array) => new Uint8Array(array.map(() => Math.floor(Math.random() * 256))),
-        }
+    ? window.crypto // Note: On browsers we need to use window.crypto instead of the imported crypto module as the latter is externalized and doesn't have getRandomValues().
     : crypto
 
+if (!cryptoLib.getRandomValues) {
+  // Use a polyfill in older environments that have a crypto implementaton missing getRandomValues()
+  cryptoLib = cryptoLibPolyfill
+}
+
 abstract class BaseApiError<Code extends ErrorCode, Type extends string, Description extends string> extends Error {
   public readonly isApiError = true
 
@@ -426990,6 +426995,46 @@ var state = {
       },
       parameters: {}
     },
+    getAccount: {
+      name: "getAccount",
+      description: "Get details of the account authenticating with this endpoint.",
+      method: "get",
+      path: "/v1/admin/account/me",
+      section: "account",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            account: {
+              type: "object",
+              properties: {
+                id: {
+                  type: "string"
+                },
+                email: {
+                  type: "string"
+                },
+                createdAt: {
+                  type: "string",
+                  format: "date-time",
+                  description: "Creation date of the [Account](#schema_account) in ISO 8601 format"
+                }
+              },
+              required: ["id", "email", "createdAt"],
+              additionalProperties: false
+            }
+          },
+          required: ["account"],
+          title: "getAccountResponse",
+          additionalProperties: false
+        }
+      },
+      parameters: {}
+    },
     listPublicIntegrations: {
       name: "listPublicIntegrations",
       description: "List public integration",
@@ -427041,12 +427086,12 @@ var state = {
                   createdAt: {
                     type: "string",
                     format: "date-time",
-                    description: "Creation date of the [Integration](#schema_integration) in the ISO 8601 format"
+                    description: "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
                   },
                   updatedAt: {
                     type: "string",
                     format: "date-time",
-                    description: "Updating date of the [Integration](#schema_integration) in the ISO 8601 format"
+                    description: "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
                   },
                   title: {
                     type: "string",
@@ -427737,12 +427782,12 @@ var state = {
                   createdAt: {
                     type: "string",
                     format: "date-time",
-                    description: "Creation date of the [Bot](#schema_bot) in the ISO 8601 format"
+                    description: "Creation date of the [Bot](#schema_bot) in ISO 8601 format"
                   },
                   updatedAt: {
                     type: "string",
                     format: "date-time",
-                    description: "Updating date of the [Bot](#schema_bot) in the ISO 8601 format"
+                    description: "Updating date of the [Bot](#schema_bot) in ISO 8601 format"
                   },
                   name: {
                     type: "string"
@@ -429417,12 +429462,12 @@ var state = {
                   createdAt: {
                     type: "string",
                     format: "date-time",
-                    description: "Creation date of the [Integration](#schema_integration) in the ISO 8601 format"
+                    description: "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
                   },
                   updatedAt: {
                     type: "string",
                     format: "date-time",
-                    description: "Updating date of the [Integration](#schema_integration) in the ISO 8601 format"
+                    description: "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
                   },
                   title: {
                     type: "string",
@@ -429813,7 +429858,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.5.6",
+    version: "0.6.0",
     prefix: "v1"
   },
   errors: [
@@ -429970,6 +430015,7 @@ var state = {
       patchStateResponse: true,
       callActionResponse: true,
       configureIntegrationResponse: true,
+      getAccountResponse: true,
       listPublicIntegrationsResponse: true,
       getPublicIntegrationByIdResponse: true,
       getPublicIntegrationResponse: true,
@@ -430012,6 +430058,7 @@ var state = {
       Integration: true,
       Workspace: true,
       WorkspaceMember: true,
+      Account: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -430034,12 +430081,12 @@ var state = {
           createdAt: {
             type: "string",
             format: "date-time",
-            description: "Creation date of the [Bot](#schema_bot) in the ISO 8601 format"
+            description: "Creation date of the [Bot](#schema_bot) in ISO 8601 format"
           },
           updatedAt: {
             type: "string",
             format: "date-time",
-            description: "Updating date of the [Bot](#schema_bot) in the ISO 8601 format"
+            description: "Updating date of the [Bot](#schema_bot) in ISO 8601 format"
           },
           signingSecret: {
             type: "string",
@@ -430090,12 +430137,12 @@ var state = {
                 createdAt: {
                   type: "string",
                   format: "date-time",
-                  description: "Creation date of the [Integration](#schema_integration) in the ISO 8601 format"
+                  description: "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
                 },
                 updatedAt: {
                   type: "string",
                   format: "date-time",
-                  description: "Updating date of the [Integration](#schema_integration) in the ISO 8601 format"
+                  description: "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
                 },
                 title: {
                   type: "string",
@@ -430382,12 +430429,12 @@ var state = {
           createdAt: {
             type: "string",
             format: "date-time",
-            description: "Creation date of the [Integration](#schema_integration) in the ISO 8601 format"
+            description: "Creation date of the [Integration](#schema_integration) in ISO 8601 format"
           },
           updatedAt: {
             type: "string",
             format: "date-time",
-            description: "Updating date of the [Integration](#schema_integration) in the ISO 8601 format"
+            description: "Updating date of the [Integration](#schema_integration) in ISO 8601 format"
           },
           name: {
             type: "string",
@@ -430781,6 +430828,27 @@ var state = {
         additionalProperties: false
       }
     },
+    Account: {
+      section: "account",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string"
+          },
+          email: {
+            type: "string"
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time",
+            description: "Creation date of the [Account](#schema_account) in ISO 8601 format"
+          }
+        },
+        required: ["id", "email", "createdAt"],
+        additionalProperties: false
+      }
+    },
     User: {
       section: "user",
       schema: {
@@ -430793,12 +430861,12 @@ var state = {
           createdAt: {
             type: "string",
             format: "date-time",
-            description: "Creation date of the [User](#schema_user) in the ISO 8601 format"
+            description: "Creation date of the [User](#schema_user) in ISO 8601 format"
           },
           updatedAt: {
             type: "string",
             format: "date-time",
-            description: "Updating date of the [User](#schema_user) in the ISO 8601 format"
+            description: "Updating date of the [User](#schema_user) in ISO 8601 format"
           },
           tags: {
             type: "object",
@@ -430825,12 +430893,12 @@ var state = {
           createdAt: {
             type: "string",
             format: "date-time",
-            description: "Creation date of the [Conversation](#schema_conversation) in the ISO 8601 format"
+            description: "Creation date of the [Conversation](#schema_conversation) in ISO 8601 format"
           },
           updatedAt: {
             type: "string",
             format: "date-time",
-            description: "Updating date of the [Conversation](#schema_conversation) in the ISO 8601 format"
+            description: "Updating date of the [Conversation](#schema_conversation) in ISO 8601 format"
           },
           channel: {
             type: "string",
@@ -430872,7 +430940,7 @@ var state = {
           createdAt: {
             type: "string",
             format: "date-time",
-            description: "Creation date of the [Event](#schema_event) in the ISO 8601 format"
+            description: "Creation date of the [Event](#schema_event) in ISO 8601 format"
           },
           type: {
             type: "string",
@@ -430901,7 +430969,7 @@ var state = {
           createdAt: {
             type: "string",
             format: "date-time",
-            description: "Creation date of the [Message](#schema_message) in the ISO 8601 format"
+            description: "Creation date of the [Message](#schema_message) in ISO 8601 format"
           },
           type: {
             type: "string",
@@ -430959,12 +431027,12 @@ var state = {
           createdAt: {
             type: "string",
             format: "date-time",
-            description: "Creation date of the [State](#schema_state) in the ISO 8601 format"
+            description: "Creation date of the [State](#schema_state) in ISO 8601 format"
           },
           updatedAt: {
             type: "string",
             format: "date-time",
-            description: "Updating date of the [State](#schema_state) in the ISO 8601 format"
+            description: "Updating date of the [State](#schema_state) in ISO 8601 format"
           },
           botId: {
             type: "string",
@@ -431191,6 +431259,13 @@ var state = {
         "updateWorkspaceMember"
       ],
       schema: "WorkspaceMember"
+    },
+    {
+      description: "",
+      title: "Account",
+      name: "account",
+      operations: ["getAccount"],
+      schema: "Account"
     }
   ]
 };

package/package.json

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

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