@botpress/api 0.10.0 → 0.11.0

package/src/gen/state.ts

@@ -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",
                 ],
               },
             },
@@ -2621,6 +2641,363 @@ export const state = {
         },
       },
     },
+    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",
@@ -2790,6 +3167,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -2847,6 +3226,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -2885,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",
                 },
@@ -2951,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",
                   },
@@ -4536,6 +4921,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -4586,6 +4973,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -4834,7 +5223,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.10.0",
+    version: "0.11.0",
     prefix: "v1",
   },
   errors: [
@@ -4974,6 +5363,8 @@ export const state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      setWorkspacePaymentMethodBody: true,
+      chargeWorkspaceUnpaidInvoicesBody: true,
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
       changeWorkspacePlanBody: true,
@@ -5030,6 +5421,10 @@ export const state = {
       listBotIssuesResponse: true,
       deleteBotIssueResponse: true,
       listBotIssueEventsResponse: true,
+      getWorkspaceBillingDetailsResponse: true,
+      setWorkspacePaymentMethodResponse: true,
+      listWorkspaceInvoicesResponse: true,
+      chargeWorkspaceUnpaidInvoicesResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
@@ -5124,6 +5519,9 @@ export const state = {
                 webhookUrl: {
                   type: "string",
                 },
+                webhookId: {
+                  type: "string",
+                },
                 configuration: {
                   type: "object",
                   additionalProperties: true,
@@ -5183,6 +5581,7 @@ export const state = {
                 "name",
                 "version",
                 "webhookUrl",
+                "webhookId",
                 "configuration",
                 "status",
                 "statusReason",
@@ -5928,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",
           },
@@ -6431,6 +6832,10 @@ export const state = {
       title: "Workspace",
       name: "workspace",
       operations: [
+        "getWorkspaceBillingDetails",
+        "setWorkspacePaymentMethod",
+        "listWorkspaceInvoices",
+        "chargeWorkspaceUnpaidInvoices",
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",