@botpress/api 0.9.0 → 0.10.0

package/dist/gen/state.d.ts

@@ -2309,6 +2309,167 @@ export declare const state: {
                 };
             };
         };
+        listBotIssues: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "bot";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                nextToken: {
+                    in: "query";
+                    description: string;
+                    type: "string";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        issues: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    code: {
+                                        type: "string";
+                                    };
+                                    createdAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    lastSeenAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    title: {
+                                        type: "string";
+                                    };
+                                    description: {
+                                        type: "string";
+                                    };
+                                    groupedData: {
+                                        type: "object";
+                                        properties: {};
+                                    };
+                                    eventsCount: {
+                                        type: "number";
+                                    };
+                                    category: {
+                                        type: "string";
+                                        enum: string[];
+                                    };
+                                    resolutionLink: {
+                                        type: "string";
+                                        nullable: true;
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                        meta: {
+                            type: "object";
+                            properties: {
+                                nextToken: {
+                                    type: "string";
+                                    description: string;
+                                };
+                            };
+                            additionalProperties: false;
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        deleteBotIssue: {
+            name: string;
+            description: string;
+            method: "delete";
+            path: string;
+            section: "bot";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                issueId: {
+                    in: "path";
+                    description: string;
+                    type: "string";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
+        listBotIssueEvents: {
+            name: string;
+            description: string;
+            method: "get";
+            path: string;
+            section: "bot";
+            parameters: {
+                id: {
+                    type: "string";
+                    description: string;
+                    in: "path";
+                };
+                issueId: {
+                    in: "path";
+                    description: string;
+                    type: "string";
+                };
+            };
+            response: {
+                description: string;
+                schema: {
+                    type: "object";
+                    properties: {
+                        issueEvents: {
+                            type: "array";
+                            items: {
+                                type: "object";
+                                properties: {
+                                    id: {
+                                        type: "string";
+                                    };
+                                    createdAt: {
+                                        type: "string";
+                                        format: string;
+                                    };
+                                    data: {
+                                        type: "object";
+                                        properties: {};
+                                    };
+                                };
+                                required: string[];
+                            };
+                        };
+                    };
+                    required: string[];
+                    title: string;
+                    additionalProperties: false;
+                };
+            };
+        };
         createWorkspace: {
             name: string;
             description: string;
@@ -4412,6 +4573,9 @@ export declare const state: {
             getBotLogsResponse: true;
             getBotWebchatResponse: true;
             getBotAnalyticsResponse: true;
+            listBotIssuesResponse: true;
+            deleteBotIssueResponse: true;
+            listBotIssueEventsResponse: true;
             createWorkspaceResponse: true;
             getWorkspaceResponse: true;
             listWorkspaceUsagesResponse: true;
@@ -4449,6 +4613,8 @@ export declare const state: {
             WorkspaceMember: true;
             Account: true;
             Usage: true;
+            Issue: true;
+            IssueEvent: true;
             User: true;
             Conversation: true;
             Event: true;
@@ -5199,6 +5365,72 @@ export declare const state: {
                 additionalProperties: false;
             };
         };
+        Issue: {
+            section: "bot";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    code: {
+                        type: "string";
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                    };
+                    lastSeenAt: {
+                        type: "string";
+                        format: string;
+                    };
+                    title: {
+                        type: "string";
+                    };
+                    description: {
+                        type: "string";
+                    };
+                    groupedData: {
+                        type: "object";
+                        additionalProperties: false;
+                    };
+                    eventsCount: {
+                        type: "number";
+                    };
+                    category: {
+                        type: "string";
+                        enum: string[];
+                    };
+                    resolutionLink: {
+                        type: "string";
+                        nullable: true;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
+        IssueEvent: {
+            section: "bot";
+            schema: {
+                type: "object";
+                properties: {
+                    id: {
+                        type: "string";
+                    };
+                    createdAt: {
+                        type: "string";
+                        format: string;
+                    };
+                    data: {
+                        type: "object";
+                        additionalProperties: false;
+                    };
+                };
+                required: string[];
+                additionalProperties: false;
+            };
+        };
         User: {
             section: "user";
             schema: {

package/dist/index.d.ts

@@ -1,6 +1,6 @@
 export declare const api: {
-    getState: () => import("@bpinternal/opapi").State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "User" | "Conversation" | "Event" | "Message" | "State" | "File", "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage">;
-    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
+    getState: () => import("@bpinternal/opapi").State<"Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File", "x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage">;
+    getModelRef: (name: "Bot" | "Integration" | "Workspace" | "WorkspaceMember" | "Account" | "Usage" | "Issue" | "IssueEvent" | "User" | "Conversation" | "Event" | "Message" | "State" | "File") => import("@bpinternal/opapi").OpenApiZodAny;
     addOperation: <Path extends string>(operationProps: import("@bpinternal/opapi").Operation<"x-workspace-id", "user" | "conversation" | "event" | "message" | "file" | "state" | "hub" | "action" | "bot" | "integration" | "workspace" | "workspaceMember" | "account" | "usage", Path, "zod-schema">) => void;
     exportClient: (dir: string | undefined, openapiGeneratorEndpoint: string, postProcessors?: import("@bpinternal/opapi").OpenApiPostProcessors | undefined) => Promise<void>;
     exportTypesBySection: (dir?: string | undefined) => Promise<void>;

package/dist/index.js

@@ -427321,7 +427321,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -428209,6 +428209,178 @@ var 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",
@@ -429491,7 +429663,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -429916,7 +430088,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -429944,7 +430116,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         },
         timeStart: {
@@ -430041,7 +430213,7 @@ var state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path"
         }
       },
@@ -430370,7 +430542,7 @@ var state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.9.0",
+    version: "0.10.0",
     prefix: "v1"
   },
   errors: [
@@ -430554,6 +430726,9 @@ var state = {
       getBotLogsResponse: true,
       getBotWebchatResponse: true,
       getBotAnalyticsResponse: true,
+      listBotIssuesResponse: true,
+      deleteBotIssueResponse: true,
+      listBotIssueEventsResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
@@ -430591,6 +430766,8 @@ var state = {
       WorkspaceMember: true,
       Account: true,
       Usage: true,
+      Issue: true,
+      IssueEvent: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -431422,6 +431599,83 @@ var 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: {
@@ -431787,7 +432041,10 @@ var state = {
         "deleteBot",
         "getBotLogs",
         "getBotWebchat",
-        "getBotAnalytics"
+        "getBotAnalytics",
+        "listBotIssues",
+        "deleteBotIssue",
+        "listBotIssueEvents"
       ],
       schema: "Bot"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.9.0",
+  "version": "0.10.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":["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."}]}
+{"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","listBotIssues","deleteBotIssue","listBotIssueEvents"],"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."}]}