@botpress/api 0.7.1 → 0.7.2

package/dist/index.js

@@ -428322,6 +428322,206 @@ var state = {
         }
       }
     },
+    listWorkspaceUsages: {
+      name: "listWorkspaceUsages",
+      description: "List workspace usages",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/usages",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        },
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usages: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Usage"
+              }
+            }
+          },
+          required: ["usages"],
+          title: "listWorkspaceUsagesResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    getWorkspaceQuota: {
+      name: "getWorkspaceQuota",
+      description: "Get workspace quota",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/quota",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        },
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            quota: {
+              type: "object",
+              properties: {
+                period: {
+                  type: "string",
+                  description: "Period of the quota that it is applied to"
+                },
+                value: {
+                  type: "number",
+                  description: "Value of the quota that is used"
+                },
+                type: {
+                  type: "string",
+                  enum: [
+                    "invocation_timeout",
+                    "invocation_calls",
+                    "storage_count",
+                    "bot_count",
+                    "knowledgebase_vector_count",
+                    "bot_ratelimit",
+                    "table_row_count",
+                    "workspace_member_count"
+                  ],
+                  description: "Usage type that can be used"
+                }
+              },
+              required: ["period", "value", "type"],
+              additionalProperties: false
+            }
+          },
+          required: ["quota"],
+          title: "getWorkspaceQuotaResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listWorkspaceQuotas: {
+      name: "listWorkspaceQuotas",
+      description: "List workspace quotas",
+      section: "workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/quotas",
+      disableDefaultParameters: {
+        "x-workspace-id": true
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path"
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            quotas: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  period: {
+                    type: "string",
+                    description: "Period of the quota that it is applied to"
+                  },
+                  value: {
+                    type: "number",
+                    description: "Value of the quota that is used"
+                  },
+                  type: {
+                    type: "string",
+                    enum: [
+                      "invocation_timeout",
+                      "invocation_calls",
+                      "storage_count",
+                      "bot_count",
+                      "knowledgebase_vector_count",
+                      "bot_ratelimit",
+                      "table_row_count",
+                      "workspace_member_count"
+                    ],
+                    description: "Usage type that can be used"
+                  }
+                },
+                required: ["period", "value", "type"]
+              }
+            }
+          },
+          required: ["quotas"],
+          title: "listWorkspaceQuotasResponse",
+          additionalProperties: false
+        }
+      }
+    },
     updateWorkspace: {
       name: "updateWorkspace",
       description: "Update workspace",
@@ -429825,6 +430025,102 @@ var state = {
         }
       }
     },
+    getUsage: {
+      name: "getUsage",
+      path: "/v1/admin/usages/{id}",
+      description: "Get usage",
+      method: "get",
+      section: "usage",
+      parameters: {
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        period: {
+          in: "query",
+          description: "Period to get",
+          type: "string",
+          required: false
+        },
+        id: {
+          type: "string",
+          description: "id of a bot or a workspace depending on the usage type",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usage: {
+              $ref: "#/components/schemas/Usage"
+            }
+          },
+          required: ["usage"],
+          title: "getUsageResponse",
+          additionalProperties: false
+        }
+      }
+    },
+    listUsageHistory: {
+      name: "listUsageHistory",
+      path: "/v1/admin/usages/{id}/history",
+      method: "get",
+      description: "Get usage history",
+      parameters: {
+        type: {
+          in: "query",
+          description: "Type of usage",
+          type: "string",
+          enum: [
+            "invocation_timeout",
+            "invocation_calls",
+            "storage_count",
+            "bot_count",
+            "knowledgebase_vector_count",
+            "bot_ratelimit",
+            "table_row_count",
+            "workspace_member_count"
+          ],
+          required: true
+        },
+        id: {
+          type: "string",
+          description: "id of a bot or a workspace depending on the usage type",
+          in: "path"
+        }
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            usages: {
+              type: "array",
+              items: {
+                $ref: "#/components/schemas/Usage"
+              }
+            }
+          },
+          required: ["usages"],
+          title: "listUsageHistoryResponse",
+          additionalProperties: false
+        }
+      }
+    },
     introspect: {
       name: "introspect",
       description: "Introspect the API",
@@ -430043,7 +430339,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.7.1",
+    version: "0.7.2",
     prefix: "v1"
   },
   errors: [
@@ -430143,7 +430439,7 @@ var state = {
       description: "A payment is required to perform this request."
     },
     {
-      status: 429,
+      status: 403,
       type: "QuotaExceeded",
       description: "The request exceeds the allowed quota. Quotas are a soft limit that can be increased."
     },
@@ -430229,6 +430525,9 @@ var state = {
       getBotAnalyticsResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
+      listWorkspaceUsagesResponse: true,
+      getWorkspaceQuotaResponse: true,
+      listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
       listWorkspacesResponse: true,
       changeWorkspacePlanResponse: true,
@@ -430245,6 +430544,8 @@ var state = {
       getIntegrationLogsResponse: true,
       getIntegrationByNameResponse: true,
       deleteIntegrationResponse: true,
+      getUsageResponse: true,
+      listUsageHistoryResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -430258,6 +430559,7 @@ var state = {
       Workspace: true,
       WorkspaceMember: true,
       Account: true,
+      Usage: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -431048,6 +431350,46 @@ var state = {
         additionalProperties: false
       }
     },
+    Usage: {
+      section: "usage",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+            description: "Id of the usage that it is linked to. It can either be a workspace id or a bot id"
+          },
+          period: {
+            type: "string",
+            description: "Period of the quota that it is applied to"
+          },
+          value: {
+            type: "number",
+            description: "Value of the current usage"
+          },
+          quota: {
+            type: "number",
+            description: "Quota of the current usage"
+          },
+          type: {
+            type: "string",
+            enum: [
+              "invocation_timeout",
+              "invocation_calls",
+              "storage_count",
+              "bot_count",
+              "knowledgebase_vector_count",
+              "bot_ratelimit",
+              "table_row_count",
+              "workspace_member_count"
+            ],
+            description: "Usage type that can be used"
+          }
+        },
+        required: ["id", "period", "value", "quota", "type"],
+        additionalProperties: false
+      }
+    },
     User: {
       section: "user",
       schema: {
@@ -431439,6 +431781,9 @@ var state = {
       operations: [
         "createWorkspace",
         "getWorkspace",
+        "listWorkspaceUsages",
+        "getWorkspaceQuota",
+        "listWorkspaceQuotas",
         "updateWorkspace",
         "listWorkspaces",
         "changeWorkspacePlan",
@@ -431470,6 +431815,13 @@ var state = {
         "deletePersonalAccessToken"
       ],
       schema: "Account"
+    },
+    {
+      description: "",
+      title: "Usage",
+      name: "usage",
+      operations: ["getUsage"],
+      schema: "Usage"
     }
   ]
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.7.1",
+  "version": "0.7.2",
   "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":["createWorkspace","getWorkspace","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"description":"","title":"Workspace Member","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"description":"","title":"Account","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"}],"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."},{"status":429,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}
+{"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":["createWorkspace","getWorkspace","listWorkspaceUsages","getWorkspaceQuota","listWorkspaceQuotas","updateWorkspace","listWorkspaces","changeWorkspacePlan","deleteWorkspace","getAuditRecords"],"schema":"Workspace"},{"description":"","title":"Workspace Member","name":"workspaceMember","operations":["listWorkspaceMembers","deleteWorkspaceMember","createWorkspaceMember","updateWorkspaceMember"],"schema":"WorkspaceMember"},{"description":"","title":"Account","name":"account","operations":["getAccount","listPersonalAccessTokens","createPersonalAccessToken","deletePersonalAccessToken"],"schema":"Account"},{"description":"","title":"Usage","name":"usage","operations":["getUsage"],"schema":"Usage"}],"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."},{"status":403,"type":"QuotaExceeded","description":"The request exceeds the allowed quota. Quotas are a soft limit that can be increased."},{"status":413,"type":"LimitExceeded","description":"The request exceeds the allowed limit. Limits are a hard limit that cannot be increased."}]}