@botpress/api 0.7.1 → 0.7.3

package/src/gen/state.ts

@@ -2587,6 +2587,206 @@ export const 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",
@@ -4139,6 +4339,102 @@ export const 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",
@@ -4360,7 +4656,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.7.1",
+    version: "0.7.3",
     prefix: "v1",
   },
   errors: [
@@ -4467,7 +4763,7 @@ export const 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.",
@@ -4555,6 +4851,9 @@ export const state = {
       getBotAnalyticsResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
+      listWorkspaceUsagesResponse: true,
+      getWorkspaceQuotaResponse: true,
+      listWorkspaceQuotasResponse: true,
       updateWorkspaceResponse: true,
       listWorkspacesResponse: true,
       changeWorkspacePlanResponse: true,
@@ -4571,6 +4870,8 @@ export const state = {
       getIntegrationLogsResponse: true,
       getIntegrationByNameResponse: true,
       deleteIntegrationResponse: true,
+      getUsageResponse: true,
+      listUsageHistoryResponse: true,
       introspectResponse: true,
       createFileResponse: true,
       getFileResponse: true,
@@ -4584,6 +4885,7 @@ export const state = {
       Workspace: true,
       WorkspaceMember: true,
       Account: true,
+      Usage: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -5409,6 +5711,47 @@ export const 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: {
@@ -5826,6 +6169,9 @@ export const state = {
       operations: [
         "createWorkspace",
         "getWorkspace",
+        "listWorkspaceUsages",
+        "getWorkspaceQuota",
+        "listWorkspaceQuotas",
         "updateWorkspace",
         "listWorkspaces",
         "changeWorkspacePlan",
@@ -5858,13 +6204,24 @@ export const state = {
       ],
       schema: "Account",
     },
+    {
+      description: "",
+      title: "Usage",
+      name: "usage",
+      operations: ["getUsage"],
+      schema: "Usage",
+    },
   ],
+  options: {
+    allowUnions: false,
+  },
 } satisfies State<
   | "Bot"
   | "Integration"
   | "Workspace"
   | "WorkspaceMember"
   | "Account"
+  | "Usage"
   | "User"
   | "Conversation"
   | "Event"
@@ -5885,4 +6242,5 @@ export const state = {
   | "workspace"
   | "workspaceMember"
   | "account"
+  | "usage"
 >;