@botpress/api 0.10.0 → 0.12.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",
@@ -2671,6 +3048,10 @@ export const state = {
               type: "string",
               enum: ["free", "premium"],
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"],
+            },
             blocked: {
               type: "boolean",
             },
@@ -2686,6 +3067,7 @@ export const state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit",
           ],
@@ -2738,6 +3120,10 @@ export const state = {
               type: "string",
               enum: ["free", "premium"],
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"],
+            },
             blocked: {
               type: "boolean",
             },
@@ -2753,6 +3139,7 @@ export const state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit",
           ],
@@ -2790,6 +3177,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -2847,6 +3236,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -2885,6 +3276,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 +3344,8 @@ export const state = {
                       "table_row_count",
                       "workspace_member_count",
                       "integrations_owned_count",
+                      "cognitive_calls",
+                      "model_credit",
                     ],
                     description: "Usage type that can be used",
                   },
@@ -3028,6 +3423,10 @@ export const state = {
               type: "string",
               enum: ["free", "premium"],
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"],
+            },
             blocked: {
               type: "boolean",
             },
@@ -3043,6 +3442,7 @@ export const state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit",
           ],
@@ -3100,6 +3500,10 @@ export const state = {
                     type: "string",
                     enum: ["free", "premium"],
                   },
+                  plan: {
+                    type: "string",
+                    enum: ["community", "team", "enterprise"],
+                  },
                   blocked: {
                     type: "boolean",
                   },
@@ -3115,6 +3519,7 @@ export const state = {
                   "updatedAt",
                   "botCount",
                   "accountType",
+                  "plan",
                   "blocked",
                   "spendingLimit",
                 ],
@@ -3197,6 +3602,10 @@ export const state = {
               type: "string",
               enum: ["free", "premium"],
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"],
+            },
             blocked: {
               type: "boolean",
             },
@@ -3212,6 +3621,7 @@ export const state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit",
           ],
@@ -3604,9 +4014,19 @@ export const state = {
                   description:
                     "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
                 },
+                identifier: {
+                  type: "object",
+                  properties: {
+                    required: {
+                      type: "boolean",
+                    },
+                    linkTemplateScript: {
+                      type: "string",
+                    },
+                  },
+                  additionalProperties: false,
+                },
               },
-              required: ["schema"],
-              description: "Configuration definition",
               additionalProperties: false,
             },
             states: {
@@ -3700,6 +4120,15 @@ export const state = {
                 additionalProperties: false,
               },
             },
+            identifier: {
+              type: "object",
+              properties: {
+                extractScript: {
+                  type: "string",
+                },
+              },
+              additionalProperties: false,
+            },
             channels: {
               type: "object",
               additionalProperties: {
@@ -3944,9 +4373,20 @@ export const state = {
                   description:
                     "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
                 },
+                identifier: {
+                  type: "object",
+                  properties: {
+                    linkTemplateScript: {
+                      type: "string",
+                      nullable: true,
+                    },
+                    required: {
+                      type: "boolean",
+                    },
+                  },
+                  additionalProperties: false,
+                },
               },
-              required: ["schema"],
-              description: "Configuration definition",
               additionalProperties: false,
             },
             channels: {
@@ -4062,6 +4502,16 @@ export const state = {
                 additionalProperties: false,
               },
             },
+            identifier: {
+              type: "object",
+              properties: {
+                extractScript: {
+                  type: "string",
+                  nullable: true,
+                },
+              },
+              additionalProperties: false,
+            },
             actions: {
               type: "object",
               additionalProperties: {
@@ -4536,6 +4986,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -4586,6 +5038,8 @@ export const state = {
             "table_row_count",
             "workspace_member_count",
             "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit",
           ],
           required: true,
         },
@@ -4834,7 +5288,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.10.0",
+    version: "0.12.0",
     prefix: "v1",
   },
   errors: [
@@ -4974,6 +5428,8 @@ export const state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      setWorkspacePaymentMethodBody: true,
+      chargeWorkspaceUnpaidInvoicesBody: true,
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
       changeWorkspacePlanBody: true,
@@ -5030,6 +5486,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 +5584,9 @@ export const state = {
                 webhookUrl: {
                   type: "string",
                 },
+                webhookId: {
+                  type: "string",
+                },
                 configuration: {
                   type: "object",
                   additionalProperties: true,
@@ -5183,6 +5646,7 @@ export const state = {
                 "name",
                 "version",
                 "webhookUrl",
+                "webhookId",
                 "configuration",
                 "status",
                 "statusReason",
@@ -5465,6 +5929,19 @@ export const state = {
             description:
               "Updating date of the [Integration](#schema_integration) in ISO 8601 format",
           },
+          identifier: {
+            type: "object",
+            properties: {
+              extractScript: {
+                type: "string",
+                description:
+                  "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth",
+              },
+            },
+            description:
+              "Global identifier configuration of the [Integration](#schema_integration)",
+            additionalProperties: false,
+          },
           name: {
             type: "string",
             description: "Name of the [Integration](#schema_integration)",
@@ -5476,6 +5953,21 @@ export const state = {
           configuration: {
             type: "object",
             properties: {
+              identifier: {
+                type: "object",
+                properties: {
+                  linkTemplateScript: {
+                    type: "string",
+                  },
+                  required: {
+                    type: "boolean",
+                  },
+                },
+                required: ["required"],
+                description:
+                  "Identifier configuration of the [Integration](#schema_integration)",
+                additionalProperties: false,
+              },
               schema: {
                 type: "object",
                 additionalProperties: true,
@@ -5483,7 +5975,7 @@ export const state = {
                   "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.",
               },
             },
-            required: ["schema"],
+            required: ["identifier"],
             description: "Configuration definition",
             additionalProperties: false,
           },
@@ -5776,6 +6268,7 @@ export const state = {
           "id",
           "createdAt",
           "updatedAt",
+          "identifier",
           "name",
           "version",
           "configuration",
@@ -5820,6 +6313,10 @@ export const state = {
             type: "string",
             enum: ["free", "premium"],
           },
+          plan: {
+            type: "string",
+            enum: ["community", "team", "enterprise"],
+          },
           blocked: {
             type: "boolean",
           },
@@ -5835,6 +6332,7 @@ export const state = {
           "updatedAt",
           "botCount",
           "accountType",
+          "plan",
           "blocked",
           "spendingLimit",
         ],
@@ -5928,6 +6426,8 @@ export const state = {
               "table_row_count",
               "workspace_member_count",
               "integrations_owned_count",
+              "cognitive_calls",
+              "model_credit",
             ],
             description: "Usage type that can be used",
           },
@@ -6040,7 +6540,7 @@ export const state = {
               type: "string",
             },
             description:
-              "Set of [Tags](#tags) that you can attach to a [User](#schema_user). The set of [Tags](#tags) available on a [User](#schema_user) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
+              "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [User](#schema_user). The set of [Tags](/docs/developers/concepts/tags) available on a [User](#schema_user) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
           },
         },
         required: ["id", "createdAt", "updatedAt", "tags"],
@@ -6086,7 +6586,7 @@ export const state = {
               type: "string",
             },
             description:
-              "Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
+              "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
           },
         },
         required: [
@@ -6178,7 +6678,7 @@ export const state = {
               type: "string",
             },
             description:
-              "Set of [Tags](#tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
+              "Set of [Tags](/docs/developers/concepts/tags) that you can attach to a [Conversation](#schema_conversation). The set of [Tags](/docs/developers/concepts/tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](/docs/developers/concepts/tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
           },
         },
         required: [
@@ -6431,6 +6931,10 @@ export const state = {
       title: "Workspace",
       name: "workspace",
       operations: [
+        "getWorkspaceBillingDetails",
+        "setWorkspacePaymentMethod",
+        "listWorkspaceInvoices",
+        "chargeWorkspaceUnpaidInvoices",
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",