@botpress/api 0.3.0 → 0.3.1

package/src/gen/state.ts

@@ -2271,8 +2271,12 @@ export const state = {
             updatedAt: {
               type: "string",
             },
+            botCount: {
+              type: "number",
+            },
             accountType: {
               type: "string",
+              enum: ["free", "premium"],
             },
             blocked: {
               type: "boolean",
@@ -2287,6 +2291,7 @@ export const state = {
             "ownerId",
             "createdAt",
             "updatedAt",
+            "botCount",
             "accountType",
             "blocked",
             "spendingLimit",
@@ -2296,6 +2301,92 @@ export const 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: 1000,
+            },
+          },
+          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",
@@ -2337,8 +2428,23 @@ export const 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: {
@@ -3204,6 +3310,224 @@ export const 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",
@@ -3425,7 +3749,7 @@ export const 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: [
@@ -3537,8 +3861,11 @@ export const state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      updateWorkspaceBody: true,
       createIntegrationBody: true,
       updateIntegrationBody: true,
+      createWorkspaceMemberBody: true,
+      updateWorkspaceMemberBody: true,
       introspectBody: true,
       createFileBody: true,
     },
@@ -3582,6 +3909,7 @@ export const state = {
       getBotWebchatResponse: true,
       getBotAnalyticsResponse: true,
       getWorkspaceResponse: true,
+      updateWorkspaceResponse: true,
       listWorkspacesResponse: true,
       createIntegrationResponse: true,
       updateIntegrationResponse: true,
@@ -3590,6 +3918,10 @@ export const state = {
       getIntegrationLogsResponse: true,
       getIntegrationByNameResponse: true,
       deleteIntegrationResponse: true,
+      listWorkspaceMembersResponse: true,
+      deleteWorkspaceMemberResponse: true,
+      createWorkspaceMemberResponse: true,
+      updateWorkspaceMemberResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -4245,8 +4577,12 @@ export const state = {
           updatedAt: {
             type: "string",
           },
+          botCount: {
+            type: "number",
+          },
           accountType: {
             type: "string",
+            enum: ["free", "premium"],
           },
           blocked: {
             type: "boolean",
@@ -4261,6 +4597,7 @@ export const state = {
           "ownerId",
           "createdAt",
           "updatedAt",
+          "botCount",
           "accountType",
           "blocked",
           "spendingLimit",