@botpress/api 0.9.0 → 0.11.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",
         },
       },
@@ -2418,16 +2418,32 @@ export const state = {
                       "ISO 8601 date string of the end (exclusive) of the period",
                   },
                   returningUsers: {
-                    type: "number",
+                    type: "integer",
                   },
                   newUsers: {
-                    type: "number",
+                    type: "integer",
                   },
                   sessions: {
-                    type: "number",
+                    type: "integer",
                   },
                   messages: {
-                    type: "number",
+                    type: "integer",
+                    description: "Deprecated. Use `userMessages` instead.",
+                  },
+                  userMessages: {
+                    type: "integer",
+                  },
+                  botMessages: {
+                    type: "integer",
+                  },
+                  events: {
+                    type: "integer",
+                  },
+                  eventTypes: {
+                    type: "object",
+                    additionalProperties: {
+                      type: "number",
+                    },
                   },
                 },
                 required: [
@@ -2437,6 +2453,10 @@ export const state = {
                   "newUsers",
                   "sessions",
                   "messages",
+                  "userMessages",
+                  "botMessages",
+                  "events",
+                  "eventTypes",
                 ],
               },
             },
@@ -2447,6 +2467,537 @@ 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,
+        },
+      },
+    },
+    getWorkspaceBillingDetails: {
+      name: "getWorkspaceBillingDetails",
+      description: "Get billing details of workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/billing/details",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+      },
+      section: "workspace",
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            currentPeriod: {
+              type: "object",
+              properties: {
+                start: {
+                  type: "string",
+                },
+                end: {
+                  type: "string",
+                },
+                usage: {
+                  type: "object",
+                  properties: {
+                    userMessages: {
+                      type: "object",
+                      properties: {
+                        status: {
+                          type: "string",
+                          enum: ["OK", "Warning", "LimitReached"],
+                        },
+                        quantity: {
+                          type: "number",
+                        },
+                        price: {
+                          type: "number",
+                        },
+                        minimum: {
+                          type: "number",
+                        },
+                        maximum: {
+                          type: "number",
+                        },
+                      },
+                      required: [
+                        "status",
+                        "quantity",
+                        "price",
+                        "minimum",
+                        "maximum",
+                      ],
+                      additionalProperties: false,
+                    },
+                  },
+                  required: ["userMessages"],
+                  additionalProperties: false,
+                },
+              },
+              required: ["start", "end", "usage"],
+              additionalProperties: false,
+            },
+            paymentMethod: {
+              type: "object",
+              properties: {
+                type: {
+                  type: "string",
+                },
+                lastDigits: {
+                  type: "string",
+                },
+              },
+              required: ["type", "lastDigits"],
+              nullable: true,
+              additionalProperties: false,
+            },
+          },
+          required: ["currentPeriod", "paymentMethod"],
+          title: "getWorkspaceBillingDetailsResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    setWorkspacePaymentMethod: {
+      name: "setWorkspacePaymentMethod",
+      description:
+        "Set the Stripe PaymentMethod to use for billing the workspace. To create a PaymentMethod, use the Stripe API or SDK with our Stripe Publishable Key which is listed in this documentation.",
+      method: "put",
+      path: "/v1/admin/workspaces/{id}/billing/payment-method",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+      },
+      section: "workspace",
+      requestBody: {
+        description: "",
+        schema: {
+          type: "object",
+          properties: {
+            stripePaymentMethodId: {
+              type: "string",
+              description:
+                "ID of the Stripe PaymentMethod to attach to the workspace.",
+            },
+          },
+          required: ["stripePaymentMethodId"],
+          title: "setWorkspacePaymentMethodBody",
+          additionalProperties: false,
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            stripePaymentMethodId: {
+              type: "string",
+            },
+            paymentMethod: {
+              type: "object",
+              properties: {
+                type: {
+                  type: "string",
+                },
+                lastDigits: {
+                  type: "string",
+                },
+              },
+              required: ["type", "lastDigits"],
+              nullable: true,
+              additionalProperties: false,
+            },
+            status: {
+              type: "string",
+              enum: [
+                "succeeded",
+                "processing",
+                "canceled",
+                "requires_confirmation",
+                "requires_action",
+                "requires_payment_method",
+              ],
+            },
+            nextAction: {
+              type: "object",
+              properties: {
+                redirectToUrl: {
+                  type: "string",
+                  format: "uri",
+                },
+              },
+              required: ["redirectToUrl"],
+              description:
+                "If the payment needs to be confirmed, this will contain a URL to redirect the user to so they can complete the verification process to confirm it.",
+              additionalProperties: false,
+            },
+          },
+          required: ["stripePaymentMethodId", "paymentMethod", "status"],
+          title: "setWorkspacePaymentMethodResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    listWorkspaceInvoices: {
+      name: "listWorkspaceInvoices",
+      description: "List invoices billed to workspace",
+      method: "get",
+      path: "/v1/admin/workspaces/{id}/billing/invoices",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+      },
+      section: "workspace",
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            invoices: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string",
+                  },
+                  period: {
+                    type: "object",
+                    properties: {
+                      month: {
+                        type: "number",
+                      },
+                      year: {
+                        type: "number",
+                      },
+                    },
+                    required: ["month", "year"],
+                  },
+                  date: {
+                    type: "string",
+                    format: "date-time",
+                    description: "Date on which the invoice was generated.",
+                  },
+                  amount: {
+                    type: "number",
+                    description: "Total amount to pay of the invoice.",
+                  },
+                  currency: {
+                    type: "string",
+                    maxLength: 3,
+                    description: "Currency of the invoice amount.",
+                  },
+                  paymentStatus: {
+                    type: "string",
+                    enum: ["paid", "unpaid"],
+                  },
+                  paymentAttemptCount: {
+                    type: "number",
+                    description:
+                      "Number of times payment has been unsuccessfully attempted on the invoice.",
+                    nullable: true,
+                  },
+                  nextPaymentAttemptDate: {
+                    type: "string",
+                    format: "date-time",
+                    description:
+                      "Date on which the next payment attempt will be made.",
+                    nullable: true,
+                  },
+                  pdfUrl: {
+                    type: "string",
+                    format: "uri",
+                    description: "URL to download the PDF file of the invoice.",
+                  },
+                },
+                required: [
+                  "id",
+                  "period",
+                  "date",
+                  "amount",
+                  "currency",
+                  "paymentStatus",
+                  "paymentAttemptCount",
+                  "nextPaymentAttemptDate",
+                  "pdfUrl",
+                ],
+              },
+            },
+          },
+          required: ["invoices"],
+          title: "listWorkspaceInvoicesResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    chargeWorkspaceUnpaidInvoices: {
+      name: "chargeWorkspaceUnpaidInvoices",
+      description: "Charge unpaid invoices of a workspace.",
+      method: "post",
+      path: "/v1/admin/workspaces/{id}/billing/invoices/charge-unpaid",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        id: {
+          type: "string",
+          description: "Workspace ID",
+          in: "path",
+        },
+      },
+      section: "workspace",
+      requestBody: {
+        description: "",
+        schema: {
+          type: "object",
+          properties: {
+            invoiceIds: {
+              type: "array",
+              items: {
+                type: "string",
+              },
+              minItems: 1,
+            },
+          },
+          title: "chargeWorkspaceUnpaidInvoicesBody",
+          additionalProperties: false,
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            chargedInvoices: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string",
+                  },
+                  amount: {
+                    type: "number",
+                  },
+                },
+                required: ["id", "amount"],
+              },
+              description:
+                "Invoices that were successfully charged by this request.",
+            },
+            failedInvoices: {
+              type: "array",
+              items: {
+                type: "object",
+                properties: {
+                  id: {
+                    type: "string",
+                  },
+                  amount: {
+                    type: "number",
+                  },
+                  failedReason: {
+                    type: "string",
+                  },
+                },
+                required: ["id", "amount", "failedReason"],
+              },
+              description:
+                "Invoices that failed to be charged by this request.",
+            },
+          },
+          required: ["chargedInvoices", "failedInvoices"],
+          title: "chargeWorkspaceUnpaidInvoicesResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     createWorkspace: {
       name: "createWorkspace",
       description: "Create workspace",
@@ -2616,6 +3167,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -2673,6 +3226,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -2711,6 +3266,8 @@ export const state = {
                     "table_row_count",
                     "workspace_member_count",
                     "integrations_owned_count",
+                    "cognitive_calls",
+                    "model_credit",
                   ],
                   description: "Usage type that can be used",
                 },
@@ -2777,6 +3334,8 @@ export const state = {
                       "table_row_count",
                       "workspace_member_count",
                       "integrations_owned_count",
+                      "cognitive_calls",
+                      "model_credit",
                     ],
                     description: "Usage type that can be used",
                   },
@@ -3752,7 +4311,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
       },
@@ -4202,7 +4761,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
       },
@@ -4230,7 +4789,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
         timeStart: {
@@ -4328,7 +4887,7 @@ export const state = {
       parameters: {
         id: {
           type: "string",
-          description: "Integration Id",
+          description: "Integration ID",
           in: "path",
         },
       },
@@ -4362,6 +4921,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -4412,6 +4973,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -4660,7 +5223,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.9.0",
+    version: "0.11.0",
     prefix: "v1",
   },
   errors: [
@@ -4800,6 +5363,8 @@ export const state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      setWorkspacePaymentMethodBody: true,
+      chargeWorkspaceUnpaidInvoicesBody: true,
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
       changeWorkspacePlanBody: true,
@@ -4853,6 +5418,13 @@ export const state = {
       getBotLogsResponse: true,
       getBotWebchatResponse: true,
       getBotAnalyticsResponse: true,
+      listBotIssuesResponse: true,
+      deleteBotIssueResponse: true,
+      listBotIssueEventsResponse: true,
+      getWorkspaceBillingDetailsResponse: true,
+      setWorkspacePaymentMethodResponse: true,
+      listWorkspaceInvoicesResponse: true,
+      chargeWorkspaceUnpaidInvoicesResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
@@ -4890,6 +5462,8 @@ export const state = {
       WorkspaceMember: true,
       Account: true,
       Usage: true,
+      Issue: true,
+      IssueEvent: true,
       User: true,
       Conversation: true,
       Event: true,
@@ -4945,6 +5519,9 @@ export const state = {
                 webhookUrl: {
                   type: "string",
                 },
+                webhookId: {
+                  type: "string",
+                },
                 configuration: {
                   type: "object",
                   additionalProperties: true,
@@ -5004,6 +5581,7 @@ export const state = {
                 "name",
                 "version",
                 "webhookUrl",
+                "webhookId",
                 "configuration",
                 "status",
                 "statusReason",
@@ -5749,6 +6327,8 @@ export const state = {
               "table_row_count",
               "workspace_member_count",
               "integrations_owned_count",
+              "cognitive_calls",
+              "model_credit",
             ],
             description: "Usage type that can be used",
           },
@@ -5757,6 +6337,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: {
@@ -6149,6 +6806,9 @@ export const state = {
         "getBotLogs",
         "getBotWebchat",
         "getBotAnalytics",
+        "listBotIssues",
+        "deleteBotIssue",
+        "listBotIssueEvents",
       ],
       schema: "Bot",
     },
@@ -6172,6 +6832,10 @@ export const state = {
       title: "Workspace",
       name: "workspace",
       operations: [
+        "getWorkspaceBillingDetails",
+        "setWorkspacePaymentMethod",
+        "listWorkspaceInvoices",
+        "chargeWorkspaceUnpaidInvoices",
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",
@@ -6227,6 +6891,8 @@ export const state = {
   | "WorkspaceMember"
   | "Account"
   | "Usage"
+  | "Issue"
+  | "IssueEvent"
   | "User"
   | "Conversation"
   | "Event"