@botpress/api 0.5.1 → 0.5.3

package/src/gen/state.ts

@@ -225,16 +225,8 @@ export const state = {
               },
               description: "Tags for the [Conversation](#schema_conversation)",
             },
-            participantIds: {
-              type: "array",
-              items: {
-                type: "string",
-              },
-              description:
-                "Ids of the [User]s(#schema_user) participating in the conversation",
-            },
           },
-          required: ["tags", "participantIds"],
+          required: ["tags"],
           title: "updateConversationBody",
           additionalProperties: false,
         },
@@ -2270,6 +2262,7 @@ export const state = {
     createWorkspace: {
       name: "createWorkspace",
       description: "Create workspace",
+      section: "workspace",
       method: "post",
       path: "/v1/admin/workspaces",
       disableDefaultParameters: {
@@ -2343,6 +2336,7 @@ export const state = {
     getWorkspace: {
       name: "getWorkspace",
       description: "Get workspace details",
+      section: "workspace",
       method: "get",
       path: "/v1/admin/workspaces/{id}",
       disableDefaultParameters: {
@@ -2408,6 +2402,7 @@ export const state = {
     updateWorkspace: {
       name: "updateWorkspace",
       description: "Update workspace",
+      section: "workspace",
       method: "put",
       path: "/v1/admin/workspaces/{id}",
       disableDefaultParameters: {
@@ -2493,6 +2488,7 @@ export const state = {
     listWorkspaces: {
       name: "listWorkspaces",
       description: "List workspaces the user has access to",
+      section: "workspace",
       method: "get",
       path: "/v1/admin/workspaces",
       disableDefaultParameters: {
@@ -2580,6 +2576,7 @@ export const state = {
     changeWorkspacePlan: {
       name: "changeWorkspacePlan",
       description: "Change workspace billing plan",
+      section: "workspace",
       method: "put",
       path: "/v1/admin/workspaces/{id}/change-plan",
       disableDefaultParameters: {
@@ -2660,6 +2657,7 @@ export const state = {
     deleteWorkspace: {
       name: "deleteWorkspace",
       description: "Delete workspace",
+      section: "workspace",
       method: "delete",
       path: "/v1/admin/workspaces/{id}",
       disableDefaultParameters: {
@@ -2685,6 +2683,7 @@ export const state = {
       name: "getAuditRecords",
       description:
         "Get the audit records of a workspace, sorted from most recent to oldest.",
+      section: "workspace",
       method: "get",
       path: "/v1/admin/workspaces/{id}/audit-records",
       parameters: {
@@ -2743,8 +2742,8 @@ export const state = {
                     type: "string",
                     enum: [
                       "UNKNOWN",
-                      "ADD_COLLABORATOR",
-                      "REMOVE_COLLABORATOR",
+                      "ADD_WORKSPACE_MEMBER",
+                      "REMOVE_WORKSPACE_MEMBER",
                       "UPDATE_WORKSPACE_MEMBER",
                       "CLOSE_WORKSPACE",
                       "CREATE_BOT",
@@ -2791,6 +2790,228 @@ export const state = {
         },
       },
     },
+    listWorkspaceMembers: {
+      name: "listWorkspaceMembers",
+      description: "Lists all the members in a workspace",
+      section: "workspaceMembers",
+      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",
+      section: "workspaceMembers",
+      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",
+      section: "workspaceMembers",
+      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",
+      section: "workspaceMembers",
+      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,
+        },
+      },
+    },
     createIntegration: {
       name: "createIntegration",
       description: "Create integration",
@@ -3709,224 +3930,6 @@ 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",
@@ -4148,7 +4151,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.5.1",
+    version: "0.5.3",
     prefix: "v1",
   },
   errors: [
@@ -4278,10 +4281,10 @@ export const state = {
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
       changeWorkspacePlanBody: true,
-      createIntegrationBody: true,
-      updateIntegrationBody: true,
       createWorkspaceMemberBody: true,
       updateWorkspaceMemberBody: true,
+      createIntegrationBody: true,
+      updateIntegrationBody: true,
       introspectBody: true,
       createFileBody: true,
     },
@@ -4331,6 +4334,10 @@ export const state = {
       changeWorkspacePlanResponse: true,
       deleteWorkspaceResponse: true,
       getAuditRecordsResponse: true,
+      listWorkspaceMembersResponse: true,
+      deleteWorkspaceMemberResponse: true,
+      createWorkspaceMemberResponse: true,
+      updateWorkspaceMemberResponse: true,
       createIntegrationResponse: true,
       updateIntegrationResponse: true,
       listIntegrationsResponse: true,
@@ -4338,10 +4345,6 @@ export const state = {
       getIntegrationLogsResponse: true,
       getIntegrationByNameResponse: true,
       deleteIntegrationResponse: true,
-      listWorkspaceMembersResponse: true,
-      deleteWorkspaceMemberResponse: true,
-      createWorkspaceMemberResponse: true,
-      updateWorkspaceMemberResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -5539,9 +5542,28 @@ export const state = {
       description: "",
       title: "Workspace",
       name: "workspace",
-      operations: [],
+      operations: [
+        "createWorkspace",
+        "getWorkspace",
+        "updateWorkspace",
+        "listWorkspaces",
+        "changeWorkspacePlan",
+        "deleteWorkspace",
+        "getAuditRecords",
+      ],
       schema: "Workspace",
     },
+    {
+      description: "",
+      title: "Workspace Members",
+      name: "workspaceMembers",
+      operations: [
+        "listWorkspaceMembers",
+        "deleteWorkspaceMember",
+        "createWorkspaceMember",
+        "updateWorkspaceMember",
+      ],
+    },
   ],
 } satisfies State<
   | "Bot"
@@ -5565,4 +5587,5 @@ export const state = {
   | "bot"
   | "integration"
   | "workspace"
+  | "workspaceMembers"
 >;