@botpress/api 0.3.0 → 0.3.1

package/dist/index.js

@@ -228668,8 +228668,12 @@ var state = {
             updatedAt: {
               type: "string"
             },
+            botCount: {
+              type: "number"
+            },
             accountType: {
-              type: "string"
+              type: "string",
+              enum: ["free", "premium"]
             },
             blocked: {
               type: "boolean"
@@ -228684,6 +228688,7 @@ var state = {
             "ownerId",
             "createdAt",
             "updatedAt",
+            "botCount",
             "accountType",
             "blocked",
             "spendingLimit"
@@ -228693,6 +228698,92 @@ var state = {
         }
       }
     },
+    updateWorkspace: {
+      name: "updateWorkspace",
+      description: "Update workspace",
+      method: "put",
+      path: "/v1/admin/workspaces/{id}",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        }
+      },
+      requestBody: {
+        description: "Workspace metadata",
+        schema: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+              minLength: 1,
+              maxLength: 64
+            },
+            accountType: {
+              type: "string",
+              enum: ["free", "premium"]
+            },
+            spendingLimit: {
+              type: "number",
+              minimum: 5,
+              maximum: 1e3
+            }
+          },
+          title: "updateWorkspaceBody",
+          additionalProperties: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            id: {
+              type: "string"
+            },
+            name: {
+              type: "string"
+            },
+            ownerId: {
+              type: "string"
+            },
+            createdAt: {
+              type: "string"
+            },
+            updatedAt: {
+              type: "string"
+            },
+            botCount: {
+              type: "number"
+            },
+            accountType: {
+              type: "string",
+              enum: ["free", "premium"]
+            },
+            blocked: {
+              type: "boolean"
+            },
+            spendingLimit: {
+              type: "number"
+            }
+          },
+          required: [
+            "id",
+            "name",
+            "ownerId",
+            "createdAt",
+            "updatedAt",
+            "botCount",
+            "accountType",
+            "blocked",
+            "spendingLimit"
+          ],
+          title: "updateWorkspaceResponse",
+          additionalProperties: false
+        }
+      }
+    },
     listWorkspaces: {
       name: "listWorkspaces",
       description: "List workspaces the user has access to",
@@ -228732,9 +228823,24 @@ var state = {
                   },
                   updatedAt: {
                     type: "string"
+                  },
+                  botCount: {
+                    type: "number"
+                  },
+                  accountType: {
+                    type: "string",
+                    enum: ["free", "premium"]
                   }
                 },
-                required: ["id", "name", "ownerId", "createdAt", "updatedAt"]
+                required: [
+                  "id",
+                  "name",
+                  "ownerId",
+                  "createdAt",
+                  "updatedAt",
+                  "botCount",
+                  "accountType"
+                ]
               }
             },
             meta: {
@@ -229557,6 +229663,222 @@ var state = {
         }
       }
     },
+    listWorkspaceMembers: {
+      name: "listWorkspaceMembers",
+      description: "Lists all the members in a workspace",
+      method: "get",
+      path: "/v1/admin/workspace-members",
+      parameters: {
+        nextToken: {
+          in: "query",
+          description: "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          type: "string"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            members: {
+              type: "array",
+              items: {
+                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"]
+              }
+            },
+            meta: {
+              type: "object",
+              properties: {
+                nextToken: {
+                  type: "string",
+                  description: "The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint."
+                }
+              },
+              additionalProperties: false
+            }
+          },
+          required: ["members", "meta"],
+          title: "listWorkspaceMembersResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    deleteWorkspaceMember: {
+      name: "deleteWorkspaceMember",
+      description: "Remove a member of a workspace",
+      method: "delete",
+      path: "/v1/admin/workspace-members/{id}",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace member ID",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          title: "deleteWorkspaceMemberResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    createWorkspaceMember: {
+      name: "createWorkspaceMember",
+      description: "Add a member to the workspace",
+      method: "post",
+      path: "/v1/admin/workspace-members",
+      requestBody: {
+        description: "Workspace member metadata",
+        schema: {
+          type: "object",
+          properties: {
+            email: {
+              type: "string",
+              format: "email"
+            },
+            role: {
+              type: "string",
+              enum: [
+                "viewer",
+                "billing",
+                "developer",
+                "manager",
+                "administrator",
+                "owner"
+              ]
+            }
+          },
+          required: ["email", "role"],
+          title: "createWorkspaceMemberBody",
+          additionalProperties: false
+        }
+      },
+      response: {
+        description: "Success",
+        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"],
+          title: "createWorkspaceMemberResponse",
+          additionalProperties: false
+        }
+      },
+      parameters: {}
+    },
+    updateWorkspaceMember: {
+      name: "updateWorkspaceMember",
+      description: "Update the member of a workspace",
+      method: "put",
+      path: "/v1/admin/workspace-members/{id}",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace member ID",
+          in: "path"
+        }
+      },
+      requestBody: {
+        description: "Workspace member metadata",
+        schema: {
+          type: "object",
+          properties: {
+            role: {
+              type: "string",
+              enum: [
+                "viewer",
+                "billing",
+                "developer",
+                "manager",
+                "administrator",
+                "owner"
+              ]
+            }
+          },
+          title: "updateWorkspaceMemberBody",
+          additionalProperties: false
+        }
+      },
+      response: {
+        description: "Success",
+        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"],
+          title: "updateWorkspaceMemberResponse",
+          additionalProperties: false
+        }
+      }
+    },
     introspect: {
       name: "introspect",
       description: "Introspect the API",
@@ -229775,7 +230097,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.2.2",
+    version: "0.3.1",
     prefix: "v1"
   },
   errors: [
@@ -229880,8 +230202,11 @@ var state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      updateWorkspaceBody: true,
       createIntegrationBody: true,
       updateIntegrationBody: true,
+      createWorkspaceMemberBody: true,
+      updateWorkspaceMemberBody: true,
       introspectBody: true,
       createFileBody: true
     },
@@ -229925,6 +230250,7 @@ var state = {
       getBotWebchatResponse: true,
       getBotAnalyticsResponse: true,
       getWorkspaceResponse: true,
+      updateWorkspaceResponse: true,
       listWorkspacesResponse: true,
       createIntegrationResponse: true,
       updateIntegrationResponse: true,
@@ -229933,6 +230259,10 @@ var state = {
       getIntegrationLogsResponse: true,
       getIntegrationByNameResponse: true,
       deleteIntegrationResponse: true,
+      listWorkspaceMembersResponse: true,
+      deleteWorkspaceMemberResponse: true,
+      createWorkspaceMemberResponse: true,
+      updateWorkspaceMemberResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -230560,8 +230890,12 @@ var state = {
           updatedAt: {
             type: "string"
           },
+          botCount: {
+            type: "number"
+          },
           accountType: {
-            type: "string"
+            type: "string",
+            enum: ["free", "premium"]
           },
           blocked: {
             type: "boolean"
@@ -230576,6 +230910,7 @@ var state = {
           "ownerId",
           "createdAt",
           "updatedAt",
+          "botCount",
           "accountType",
           "blocked",
           "spendingLimit"

package/package.json

@@ -1,16 +1,8 @@
 {
   "name": "@botpress/api",
-  "version": "0.3.0",
+  "version": "0.3.1",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
-  "scripts": {
-    "openapi": "es-node openapi/generator.ts && pnpm run build",
-    "openapi:lint": "spectral lint --fail-severity warn --ruleset ../../.spectral.yaml src/gen/openapi.json",
-    "type-check": "tsc --noEmit",
-    "build:type": "tsc -p tsconfig.package.json --emitDeclarationOnly",
-    "build:impl": "esbuild --bundle --platform=node --outfile=dist/index.js src/index.ts",
-    "build": "pnpm run build:type && pnpm run build:impl"
-  },
   "devDependencies": {
     "esbuild": "^0.16.10",
     "esb-node": "0.0.1",
@@ -22,5 +14,13 @@
   },
   "dependencies": {
     "@bpinternal/opapi": "0.2.1"
+  },
+  "scripts": {
+    "openapi": "es-node openapi/generator.ts && pnpm run build",
+    "openapi:lint": "spectral lint --fail-severity warn --ruleset ../../.spectral.yaml src/gen/openapi.json",
+    "type-check": "tsc --noEmit",
+    "build:type": "tsc -p tsconfig.package.json --emitDeclarationOnly",
+    "build:impl": "esbuild --bundle --platform=node --outfile=dist/index.js src/index.ts",
+    "build": "pnpm run build:type && pnpm run build:impl"
   }
-}
+}