@botpress/api 0.4.0 → 0.5.1

package/src/gen/state.ts

@@ -2681,6 +2681,116 @@ export const state = {
         },
       },
     },
+    getAuditRecords: {
+      name: "getAuditRecords",
+      description:
+        "Get the audit records of a workspace, sorted from most recent to oldest.",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/audit-records",
+      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",
+        },
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+      },
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      response: {
+        description: "List of audit records",
+        schema: {
+          type: "object",
+          properties: {
+            records: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string",
+                    format: "uuid",
+                  },
+                  recordedAt: {
+                    type: "string",
+                    format: "date-time",
+                  },
+                  userId: {
+                    type: "string",
+                    format: "uuid",
+                    nullable: true,
+                  },
+                  userEmail: {
+                    type: "string",
+                    nullable: true,
+                  },
+                  resourceId: {
+                    type: "string",
+                    format: "uuid",
+                    nullable: true,
+                  },
+                  resourceName: {
+                    type: "string",
+                    nullable: true,
+                  },
+                  action: {
+                    type: "string",
+                    enum: [
+                      "UNKNOWN",
+                      "ADD_COLLABORATOR",
+                      "REMOVE_COLLABORATOR",
+                      "UPDATE_WORKSPACE_MEMBER",
+                      "CLOSE_WORKSPACE",
+                      "CREATE_BOT",
+                      "CREATE_WORKSPACE",
+                      "DELETE_BOT",
+                      "DEPLOY_BOT",
+                      "TRANSFER_BOT",
+                      "DOWNGRADE_WORKSPACE_PLAN",
+                      "DOWNLOAD_BOT_ARCHIVE",
+                      "UPDATE_BOT",
+                      "UPDATE_BOT_CHANNEL",
+                      "UPDATE_BOT_CONFIG",
+                      "UPDATE_PAYMENT_METHOD",
+                      "UPDATE_WORKSPACE",
+                      "UPGRADE_WORKSPACE_PLAN",
+                      "SET_SPENDING_LIMIT",
+                    ],
+                  },
+                },
+                required: [
+                  "id",
+                  "recordedAt",
+                  "userId",
+                  "resourceId",
+                  "action",
+                ],
+              },
+            },
+            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: ["records", "meta"],
+          title: "getAuditRecordsResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     createIntegration: {
       name: "createIntegration",
       description: "Create integration",
@@ -4038,7 +4148,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.4.0",
+    version: "0.5.1",
     prefix: "v1",
   },
   errors: [
@@ -4139,6 +4249,11 @@ export const state = {
       type: "RateLimited",
       description: "The request has been rate limited.",
     },
+    {
+      status: 402,
+      type: "PaymentRequired",
+      description: "A payment is required to perform this request.",
+    },
   ],
   refs: {
     parameters: {},
@@ -4215,6 +4330,7 @@ export const state = {
       listWorkspacesResponse: true,
       changeWorkspacePlanResponse: true,
       deleteWorkspaceResponse: true,
+      getAuditRecordsResponse: true,
       createIntegrationResponse: true,
       updateIntegrationResponse: true,
       listIntegrationsResponse: true,