@botpress/api 0.8.0 → 0.10.0

package/src/gen/state.ts

@@ -1530,7 +1530,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
       },
@@ -2134,7 +2134,7 @@ export const state = {
           properties: {
             targetWorkspaceId: {
               type: "string",
-              format: "uuid",
+              minLength: 28,
               description:
                 "The ID of the workspace you want to transfer the bot to.",
             },
@@ -2447,6 +2447,180 @@ export const state = {
         },
       },
     },
+    listBotIssues: {
+      name: "listBotIssues",
+      description: "List Bot Issues",
+      method: "get",
+      path: "/v1/admin/bots/{id}/issues",
+      section: "bot",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Bot ID",
+          in: "path",
+        },
+        nextToken: {
+          in: "query",
+          description:
+            "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
+          type: "string",
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            issues: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string",
+                  },
+                  code: {
+                    type: "string",
+                  },
+                  createdAt: {
+                    type: "string",
+                    format: "date-time",
+                  },
+                  lastSeenAt: {
+                    type: "string",
+                    format: "date-time",
+                  },
+                  title: {
+                    type: "string",
+                  },
+                  description: {
+                    type: "string",
+                  },
+                  groupedData: {
+                    type: "object",
+                    properties: {},
+                  },
+                  eventsCount: {
+                    type: "number",
+                  },
+                  category: {
+                    type: "string",
+                    enum: ["user_code", "limits", "configuration", "other"],
+                  },
+                  resolutionLink: {
+                    type: "string",
+                    nullable: true,
+                  },
+                },
+                required: [
+                  "id",
+                  "code",
+                  "createdAt",
+                  "lastSeenAt",
+                  "title",
+                  "description",
+                  "groupedData",
+                  "eventsCount",
+                  "category",
+                  "resolutionLink",
+                ],
+              },
+            },
+            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: ["issues", "meta"],
+          title: "listBotIssuesResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    deleteBotIssue: {
+      name: "deleteBotIssue",
+      description: "Delete Bot Issue",
+      method: "delete",
+      path: "/v1/admin/bots/{id}/issues/{issueId}",
+      section: "bot",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Bot ID",
+          in: "path",
+        },
+        issueId: {
+          in: "path",
+          description: "Issue ID",
+          type: "string",
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          title: "deleteBotIssueResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    listBotIssueEvents: {
+      name: "listBotIssueEvents",
+      description: "List Events for a Bot Issue",
+      method: "get",
+      path: "/v1/admin/bots/{id}/issues/{issueId}/events",
+      section: "bot",
+      parameters: {
+        id: {
+          type: "string",
+          description: "Bot ID",
+          in: "path",
+        },
+        issueId: {
+          in: "path",
+          description: "Issue ID",
+          type: "string",
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            issueEvents: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string",
+                  },
+                  createdAt: {
+                    type: "string",
+                    format: "date-time",
+                  },
+                  data: {
+                    type: "object",
+                    properties: {},
+                  },
+                },
+                required: ["id", "createdAt", "data"],
+              },
+            },
+          },
+          required: ["issueEvents"],
+          title: "listBotIssueEventsResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     createWorkspace: {
       name: "createWorkspace",
       description: "Create workspace",
@@ -3106,7 +3280,6 @@ export const state = {
                 properties: {
                   id: {
                     type: "string",
-                    format: "uuid",
                   },
                   recordedAt: {
                     type: "string",
@@ -3123,7 +3296,6 @@ export const state = {
                   },
                   resourceId: {
                     type: "string",
-                    format: "uuid",
                     nullable: true,
                   },
                   resourceName: {
@@ -3754,7 +3926,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
       },
@@ -4204,7 +4376,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
       },
@@ -4232,7 +4404,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
         timeStart: {
@@ -4330,7 +4502,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
       },
@@ -4662,7 +4834,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.8.0",
+    version: "0.10.0",
     prefix: "v1",
   },
   errors: [
@@ -4855,6 +5027,9 @@ export const state = {
       getBotLogsResponse: true,
       getBotWebchatResponse: true,
       getBotAnalyticsResponse: true,
+      listBotIssuesResponse: true,
+      deleteBotIssueResponse: true,
+      listBotIssueEventsResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
@@ -4892,6 +5067,8 @@ export const state = {
       WorkspaceMember: true,
       Account: true,
       Usage: true,
+      Issue: true,
+      IssueEvent: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -5759,6 +5936,83 @@ export const state = {
         additionalProperties: false,
       },
     },
+    Issue: {
+      section: "bot",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+          },
+          code: {
+            type: "string",
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time",
+          },
+          lastSeenAt: {
+            type: "string",
+            format: "date-time",
+          },
+          title: {
+            type: "string",
+          },
+          description: {
+            type: "string",
+          },
+          groupedData: {
+            type: "object",
+            additionalProperties: false,
+          },
+          eventsCount: {
+            type: "number",
+          },
+          category: {
+            type: "string",
+            enum: ["user_code", "limits", "configuration", "other"],
+          },
+          resolutionLink: {
+            type: "string",
+            nullable: true,
+          },
+        },
+        required: [
+          "id",
+          "code",
+          "createdAt",
+          "lastSeenAt",
+          "title",
+          "description",
+          "groupedData",
+          "eventsCount",
+          "category",
+          "resolutionLink",
+        ],
+        additionalProperties: false,
+      },
+    },
+    IssueEvent: {
+      section: "bot",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+          },
+          createdAt: {
+            type: "string",
+            format: "date-time",
+          },
+          data: {
+            type: "object",
+            additionalProperties: false,
+          },
+        },
+        required: ["id", "createdAt", "data"],
+        additionalProperties: false,
+      },
+    },
     User: {
       section: "user",
       schema: {
@@ -6151,6 +6405,9 @@ export const state = {
         "getBotLogs",
         "getBotWebchat",
         "getBotAnalytics",
+        "listBotIssues",
+        "deleteBotIssue",
+        "listBotIssueEvents",
       ],
       schema: "Bot",
     },
@@ -6229,6 +6486,8 @@ export const state = {
   | "WorkspaceMember"
   | "Account"
   | "Usage"
+  | "Issue"
+  | "IssueEvent"
   | "User"
   | "Conversation"
   | "Event"