@botpress/api 0.3.3 → 0.5.0

package/dist/index.js

@@ -227597,6 +227597,79 @@ var 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",
@@ -227667,6 +227740,9 @@ var state = {
       description: "Update workspace",
       method: "put",
       path: "/v1/admin/workspaces/{id}",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
       parameters: {
         id: {
           type: "string",
@@ -227684,10 +227760,6 @@ var state = {
               minLength: 1,
               maxLength: 64
             },
-            accountType: {
-              type: "string",
-              enum: ["free", "premium"]
-            },
             spendingLimit: {
               type: "number",
               minimum: 5,
@@ -227794,6 +227866,12 @@ var state = {
                   accountType: {
                     type: "string",
                     enum: ["free", "premium"]
+                  },
+                  blocked: {
+                    type: "boolean"
+                  },
+                  spendingLimit: {
+                    type: "number"
                   }
                 },
                 required: [
@@ -227803,8 +227881,11 @@ var state = {
                   "createdAt",
                   "updatedAt",
                   "botCount",
-                  "accountType"
-                ]
+                  "accountType",
+                  "blocked",
+                  "spendingLimit"
+                ],
+                title: "updateWorkspaceResponse"
               }
             },
             meta: {
@@ -227824,6 +227905,212 @@ var 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",
@@ -229134,7 +229421,7 @@ var 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: [
@@ -229227,6 +229514,11 @@ var state = {
       status: 429,
       type: "RateLimited",
       description: "The request has been rate limited."
+    },
+    {
+      status: 402,
+      type: "PaymentRequired",
+      description: "A payment is required to perform this request."
     }
   ],
   refs: {
@@ -229249,7 +229541,9 @@ var state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      createWorkspaceBody: true,
       updateWorkspaceBody: true,
+      changeWorkspacePlanBody: true,
       createIntegrationBody: true,
       updateIntegrationBody: true,
       createWorkspaceMemberBody: true,
@@ -229296,9 +229590,13 @@ var 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,
@@ -229363,10 +229661,12 @@ var state = {
                   type: "boolean"
                 },
                 name: {
-                  type: "string"
+                  type: "string",
+                  description: "Name of the [Integration](#schema_integration)"
                 },
                 version: {
-                  type: "string"
+                  type: "string",
+                  description: "Version of the [Integration](#schema_integration)"
                 },
                 webhookUrl: {
                   type: "string"
@@ -229389,6 +229689,35 @@ var state = {
                 statusReason: {
                   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: [
@@ -229398,7 +229727,13 @@ var state = {
                 "webhookUrl",
                 "configuration",
                 "status",
-                "statusReason"
+                "statusReason",
+                "id",
+                "createdAt",
+                "updatedAt",
+                "title",
+                "description",
+                "iconUrl"
               ],
               additionalProperties: false
             },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.3.3",
+  "version": "0.5.0",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
   "scripts": {

package/src/gen/metadata.json

@@ -1 +1 @@
-{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","patchState"],"schema":"State"},{"description":"","title":"Hub","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Bot","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics"],"schema":"Bot"},{"description":"","title":"Integration","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"description":"","title":"Workspace","name":"workspace","operations":[],"schema":"Workspace"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."}]}
+{"sections":[{"description":"","title":"User","name":"user","operations":["createUser","getUser","listUsers","getOrCreateUser","updateUser","deleteUser"],"schema":"User"},{"description":"","title":"Conversation","name":"conversation","operations":["createConversation","getConversation","listConversations","getOrCreateConversation","updateConversation","deleteConversation"],"schema":"Conversation"},{"description":"","title":"Event","name":"event","operations":["createEvent","getEvent","listEvents"],"schema":"Event"},{"description":"","title":"Message","name":"message","operations":["createMessage","getOrCreateMessage","getMessage","updateMessage","listMessages","deleteMessage"],"schema":"Message"},{"description":"","title":"File","name":"file","operations":["createFile","getFile","downloadFile","deleteFile","listFiles"],"schema":"File"},{"description":"","title":"State","name":"state","operations":["getState","setState","patchState"],"schema":"State"},{"description":"","title":"Hub","name":"hub","operations":["listPublicIntegrations","getPublicIntegrationById","getPublicIntegration"]},{"description":"","title":"Action","name":"action","operations":["callAction"]},{"description":"","title":"Bot","name":"bot","operations":["createBot","updateBot","transferBot","listBots","getBot","deleteBot","getBotLogs","getBotWebchat","getBotAnalytics"],"schema":"Bot"},{"description":"","title":"Integration","name":"integration","operations":["createIntegration","updateIntegration","listIntegrations","getIntegration","getIntegrationLogs","getIntegrationByName","deleteIntegration"],"schema":"Integration"},{"description":"","title":"Workspace","name":"workspace","operations":[],"schema":"Workspace"}],"errors":[{"status":500,"type":"Unknown","description":"An unknown error occurred"},{"status":500,"type":"Internal","description":"An internal error occurred"},{"status":401,"type":"Unauthorized","description":"The request requires to be authenticated."},{"status":403,"type":"Forbidden","description":"The requested action can't be peform by this resource."},{"status":413,"type":"PayloadTooLarge","description":"The request payload is too large."},{"status":400,"type":"InvalidPayload","description":"The request payload is invalid."},{"status":415,"type":"UnsupportedMediaType","description":"The request is invalid because the content-type is not supported."},{"status":405,"type":"MethodNotFound","description":"The requested method does not exist."},{"status":404,"type":"ResourceNotFound","description":"The requested resource does not exist."},{"status":400,"type":"InvalidJsonSchema","description":"The provided JSON schema is invalid."},{"status":400,"type":"InvalidDataFormat","description":"The provided data doesn't respect the provided JSON schema."},{"status":400,"type":"InvalidIdentifier","description":"The provided identifier is not valid. An identifier must start with a lowercase letter, be between 2 and 100 characters long and use only alphanumeric characters."},{"status":409,"type":"RelationConflict","description":"The resource is not related with another resource. This is usually caused when providing two resources that aren't linked together."},{"status":400,"type":"ReferenceNotFound","description":"The provided resource reference is missing. This is usually caused when providing an invalid id inside the payload of a request."},{"status":400,"type":"InvalidQuery","description":"The provided query is invalid. This is usually caused when providing an invalid parameter for querying a resource."},{"status":400,"type":"Runtime","description":"An error happened during the execution of a runtime (bot or integration)."},{"status":409,"type":"AlreadyExists","description":"The record attempted to be created already exists."},{"status":429,"type":"RateLimited","description":"The request has been rate limited."},{"status":402,"type":"PaymentRequired","description":"A payment is required to perform this request."}]}