@botpress/api 0.5.3 → 0.5.5

package/dist/gen/state.d.ts

@@ -2577,7 +2577,7 @@ export declare const state: {
         listWorkspaceMembers: {
             name: string;
             description: string;
-            section: "workspaceMembers";
+            section: "workspaceMember";
             method: "get";
             path: string;
             parameters: {
@@ -2635,7 +2635,7 @@ export declare const state: {
         deleteWorkspaceMember: {
             name: string;
             description: string;
-            section: "workspaceMembers";
+            section: "workspaceMember";
             method: "delete";
             path: string;
             parameters: {
@@ -2657,7 +2657,7 @@ export declare const state: {
         createWorkspaceMember: {
             name: string;
             description: string;
-            section: "workspaceMembers";
+            section: "workspaceMember";
             method: "post";
             path: string;
             requestBody: {
@@ -2709,7 +2709,7 @@ export declare const state: {
         updateWorkspaceMember: {
             name: string;
             description: string;
-            section: "workspaceMembers";
+            section: "workspaceMember";
             method: "put";
             path: string;
             parameters: {
@@ -3990,6 +3990,7 @@ export declare const state: {
             Bot: true;
             Integration: true;
             Workspace: true;
+            WorkspaceMember: true;
             User: true;
             Conversation: true;
             Event: true;
@@ -4664,6 +4665,30 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        WorkspaceMember: {
+            section: "workspaceMember";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    userId: {
+                        type: "string";
+                        format: string;
+                    };
+                    email: {
+                        type: "string";
+                    };
+                    role: {
+                        type: "string";
+                        enum: string[];
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
         User: {
             section: "user";
             schema: {
@@ -4975,8 +5000,8 @@ export declare const state: {
     } | {
         description: string;
         title: string;
-        name: "workspaceMembers";
+        name: "workspaceMember";
         operations: string[];
-        schema?: undefined;
+        schema: string;
     })[];
 };

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export declare const api: {
-    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "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" | "workspaceMembers", Path, "zod-schema">) => void;
+    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;
     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.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.1_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.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.1_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.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.1_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.0_openapi-types@12.1.0/node_modules/@bpinternal/opapi/dist/index.mjs
+// ../../node_modules/.pnpm/@bpinternal+opapi@0.3.1_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);
@@ -424710,10 +424710,9 @@ ${operations.map((operation) => generateMethod(operation)).join("\n")}
 ${operations.map((operation) => generatePropsType(operation)).join("\n")}
 
 function getError(err: Error) {
-  if (axios.isAxiosError(err)) {
-    return errorFrom(err.response?.data)
+  if (axios.isAxiosError(err) && err.response?.data) {
+    return errorFrom(err.response.data)
   }
-
   return errorFrom(err)
 }
 `;
@@ -424926,6 +424925,19 @@ ${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[] }
+
+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))),
+        }
+    : crypto
+
 abstract class BaseApiError<Code extends ErrorCode, Type extends string, Description extends string> extends Error {
   public readonly isApiError = true
 
@@ -428490,7 +428502,7 @@ var state = {
     listWorkspaceMembers: {
       name: "listWorkspaceMembers",
       description: "Lists all the members in a workspace",
-      section: "workspaceMembers",
+      section: "workspaceMember",
       method: "get",
       path: "/v1/admin/workspace-members",
       parameters: {
@@ -428555,7 +428567,7 @@ var state = {
     deleteWorkspaceMember: {
       name: "deleteWorkspaceMember",
       description: "Remove a member of a workspace",
-      section: "workspaceMembers",
+      section: "workspaceMember",
       method: "delete",
       path: "/v1/admin/workspace-members/{id}",
       parameters: {
@@ -428577,7 +428589,7 @@ var state = {
     createWorkspaceMember: {
       name: "createWorkspaceMember",
       description: "Add a member to the workspace",
-      section: "workspaceMembers",
+      section: "workspaceMember",
       method: "post",
       path: "/v1/admin/workspace-members",
       requestBody: {
@@ -428643,7 +428655,7 @@ var state = {
     updateWorkspaceMember: {
       name: "updateWorkspaceMember",
       description: "Update the member of a workspace",
-      section: "workspaceMembers",
+      section: "workspaceMember",
       method: "put",
       path: "/v1/admin/workspace-members/{id}",
       parameters: {
@@ -429801,7 +429813,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.5.3",
+    version: "0.5.5",
     prefix: "v1"
   },
   errors: [
@@ -429999,6 +430011,7 @@ var state = {
       Bot: true,
       Integration: true,
       Workspace: true,
+      WorkspaceMember: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -430737,6 +430750,37 @@ var state = {
         additionalProperties: false
       }
     },
+    WorkspaceMember: {
+      section: "workspaceMember",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string"
+          },
+          userId: {
+            type: "string",
+            format: "uuid"
+          },
+          email: {
+            type: "string"
+          },
+          role: {
+            type: "string",
+            enum: [
+              "viewer",
+              "billing",
+              "developer",
+              "manager",
+              "administrator",
+              "owner"
+            ]
+          }
+        },
+        required: ["id", "email", "role"],
+        additionalProperties: false
+      }
+    },
     User: {
       section: "user",
       schema: {
@@ -431138,14 +431182,15 @@ var state = {
     },
     {
       description: "",
-      title: "Workspace Members",
-      name: "workspaceMembers",
+      title: "Workspace Member",
+      name: "workspaceMember",
       operations: [
         "listWorkspaceMembers",
         "deleteWorkspaceMember",
         "createWorkspaceMember",
         "updateWorkspaceMember"
-      ]
+      ],
+      schema: "WorkspaceMember"
     }
   ]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.5.3",
+  "version": "0.5.5",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {
@@ -13,15 +13,15 @@
     "build": "pnpm run build:type && pnpm run build:impl"
   },
   "devDependencies": {
-    "esbuild": "^0.16.10",
-    "esb-node": "0.0.1",
-    "@botpress/common": "*",
     "@botpress/bridge": "*",
     "@botpress/cloud-manager": "*",
+    "@botpress/common": "*",
     "@botpress/storage": "*",
+    "esb-node": "0.0.1",
+    "esbuild": "^0.16.10",
     "zod": "^3.20.6"
   },
   "dependencies": {
-    "@bpinternal/opapi": "0.3.0"
+    "@bpinternal/opapi": "0.3.1"
   }
 }

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 Members","name":"workspaceMembers","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"]}],"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"}],"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."}]}