@botpress/api 0.3.3 → 0.5.0

package/src/gen/state.ts

@@ -2267,6 +2267,79 @@ export const state = {
         },
       },
     },
+    createWorkspace: {
+      name: "createWorkspace",
+      description: "Create workspace",
+      method: "post",
+      path: "/v1/admin/workspaces",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      requestBody: {
+        description: "Workspace metadata",
+        schema: {
+          type: "object",
+          properties: {
+            name: {
+              type: "string",
+            },
+          },
+          required: ["name"],
+          title: "createWorkspaceBody",
+          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: "createWorkspaceResponse",
+          additionalProperties: false,
+        },
+      },
+      parameters: {},
+    },
     getWorkspace: {
       name: "getWorkspace",
       description: "Get workspace details",
@@ -2337,6 +2410,9 @@ export const state = {
       description: "Update workspace",
       method: "put",
       path: "/v1/admin/workspaces/{id}",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
       parameters: {
         id: {
           type: "string",
@@ -2354,10 +2430,6 @@ export const state = {
               minLength: 1,
               maxLength: 64,
             },
-            accountType: {
-              type: "string",
-              enum: ["free", "premium"],
-            },
             spendingLimit: {
               type: "number",
               minimum: 5,
@@ -2466,6 +2538,12 @@ export const state = {
                     type: "string",
                     enum: ["free", "premium"],
                   },
+                  blocked: {
+                    type: "boolean",
+                  },
+                  spendingLimit: {
+                    type: "number",
+                  },
                 },
                 required: [
                   "id",
@@ -2475,7 +2553,10 @@ export const state = {
                   "updatedAt",
                   "botCount",
                   "accountType",
+                  "blocked",
+                  "spendingLimit",
                 ],
+                title: "updateWorkspaceResponse",
               },
             },
             meta: {
@@ -2496,6 +2577,213 @@ export const state = {
         },
       },
     },
+    changeWorkspacePlan: {
+      name: "changeWorkspacePlan",
+      description: "Change workspace billing plan",
+      method: "put",
+      path: "/v1/admin/workspaces/{id}/change-plan",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+      },
+      requestBody: {
+        description: "Billing plan to change the workspace to",
+        schema: {
+          type: "object",
+          properties: {
+            plan: {
+              type: "string",
+              enum: ["free", "premium"],
+            },
+          },
+          required: ["plan"],
+          title: "changeWorkspacePlanBody",
+          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: "changeWorkspacePlanResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    deleteWorkspace: {
+      name: "deleteWorkspace",
+      description: "Delete workspace",
+      method: "delete",
+      path: "/v1/admin/workspaces/{id}",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          title: "deleteWorkspaceResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    getAuditRecords: {
+      name: "getAuditRecords",
+      description: "Get the audit records of a workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/audit-records",
+      parameters: {
+        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",
@@ -3853,7 +4141,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.3.3",
+    version: "0.5.0",
     prefix: "v1",
   },
   errors: [
@@ -3954,6 +4242,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: {},
@@ -3975,7 +4268,9 @@ export const state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      createWorkspaceBody: true,
       updateWorkspaceBody: true,
+      changeWorkspacePlanBody: true,
       createIntegrationBody: true,
       updateIntegrationBody: true,
       createWorkspaceMemberBody: true,
@@ -4022,9 +4317,13 @@ export const state = {
       getBotLogsResponse: true,
       getBotWebchatResponse: true,
       getBotAnalyticsResponse: true,
+      createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       updateWorkspaceResponse: true,
       listWorkspacesResponse: true,
+      changeWorkspacePlanResponse: true,
+      deleteWorkspaceResponse: true,
+      getAuditRecordsResponse: true,
       createIntegrationResponse: true,
       updateIntegrationResponse: true,
       listIntegrationsResponse: true,
@@ -4092,9 +4391,12 @@ export const state = {
                 },
                 name: {
                   type: "string",
+                  description: "Name of the [Integration](#schema_integration)",
                 },
                 version: {
                   type: "string",
+                  description:
+                    "Version of the [Integration](#schema_integration)",
                 },
                 webhookUrl: {
                   type: "string",
@@ -4118,6 +4420,40 @@ export const state = {
                   type: "string",
                   nullable: true,
                 },
+                id: {
+                  type: "string",
+                  description: "Id of the [Integration](#schema_integration)",
+                },
+                createdAt: {
+                  type: "string",
+                  format: "date-time",
+                  description:
+                    "Creation date of the [Integration](#schema_integration) in the ISO 8601 format",
+                },
+                updatedAt: {
+                  type: "string",
+                  format: "date-time",
+                  description:
+                    "Updating date of the [Integration](#schema_integration) in the ISO 8601 format",
+                },
+                title: {
+                  type: "string",
+                  minLength: 1,
+                  maxLength: 64,
+                  description:
+                    "Title of the integration. This is the name that will be displayed in the UI",
+                },
+                description: {
+                  type: "string",
+                  maxLength: 256,
+                  description:
+                    "Description of the integration. This is the description that will be displayed in the UI",
+                },
+                iconUrl: {
+                  type: "string",
+                  description:
+                    "URL of the icon of the integration. This is the icon that will be displayed in the UI",
+                },
               },
               required: [
                 "enabled",
@@ -4127,6 +4463,12 @@ export const state = {
                 "configuration",
                 "status",
                 "statusReason",
+                "id",
+                "createdAt",
+                "updatedAt",
+                "title",
+                "description",
+                "iconUrl",
               ],
               additionalProperties: false,
             },