@botpress/api 0.10.0 → 0.12.0

package/dist/index.js

@@ -428180,16 +428180,32 @@ var state = {
                     description: "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: [
@@ -428198,7 +428214,11 @@ var state = {
                   "returningUsers",
                   "newUsers",
                   "sessions",
-                  "messages"
+                  "messages",
+                  "userMessages",
+                  "botMessages",
+                  "events",
+                  "eventTypes"
                 ]
               }
             }
@@ -428381,6 +428401,356 @@ var 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",
@@ -428431,6 +428801,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"]
+            },
             blocked: {
               type: "boolean"
             },
@@ -428446,6 +428820,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit"
           ],
@@ -428498,6 +428873,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"]
+            },
             blocked: {
               type: "boolean"
             },
@@ -428513,6 +428892,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit"
           ],
@@ -428549,7 +428929,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -428606,7 +428988,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -428644,7 +429028,9 @@ var state = {
                     "bot_ratelimit",
                     "table_row_count",
                     "workspace_member_count",
-                    "integrations_owned_count"
+                    "integrations_owned_count",
+                    "cognitive_calls",
+                    "model_credit"
                   ],
                   description: "Usage type that can be used"
                 }
@@ -428710,7 +429096,9 @@ var state = {
                       "bot_ratelimit",
                       "table_row_count",
                       "workspace_member_count",
-                      "integrations_owned_count"
+                      "integrations_owned_count",
+                      "cognitive_calls",
+                      "model_credit"
                     ],
                     description: "Usage type that can be used"
                   }
@@ -428788,6 +429176,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"]
+            },
             blocked: {
               type: "boolean"
             },
@@ -428803,6 +429195,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit"
           ],
@@ -428859,6 +429252,10 @@ var state = {
                     type: "string",
                     enum: ["free", "premium"]
                   },
+                  plan: {
+                    type: "string",
+                    enum: ["community", "team", "enterprise"]
+                  },
                   blocked: {
                     type: "boolean"
                   },
@@ -428874,6 +429271,7 @@ var state = {
                   "updatedAt",
                   "botCount",
                   "accountType",
+                  "plan",
                   "blocked",
                   "spendingLimit"
                 ],
@@ -428955,6 +429353,10 @@ var state = {
               type: "string",
               enum: ["free", "premium"]
             },
+            plan: {
+              type: "string",
+              enum: ["community", "team", "enterprise"]
+            },
             blocked: {
               type: "boolean"
             },
@@ -428970,6 +429372,7 @@ var state = {
             "updatedAt",
             "botCount",
             "accountType",
+            "plan",
             "blocked",
             "spendingLimit"
           ],
@@ -429355,10 +429758,20 @@ var state = {
                   type: "object",
                   additionalProperties: true,
                   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: {
@@ -429450,6 +429863,15 @@ var state = {
                 additionalProperties: false
               }
             },
+            identifier: {
+              type: "object",
+              properties: {
+                extractScript: {
+                  type: "string"
+                }
+              },
+              additionalProperties: false
+            },
             channels: {
               type: "object",
               additionalProperties: {
@@ -429679,10 +430101,21 @@ var state = {
                   type: "object",
                   additionalProperties: true,
                   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: {
@@ -429794,6 +430227,16 @@ var state = {
                 additionalProperties: false
               }
             },
+            identifier: {
+              type: "object",
+              properties: {
+                extractScript: {
+                  type: "string",
+                  nullable: true
+                }
+              },
+              additionalProperties: false
+            },
             actions: {
               type: "object",
               additionalProperties: {
@@ -430246,7 +430689,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -430296,7 +430741,9 @@ var state = {
             "bot_ratelimit",
             "table_row_count",
             "workspace_member_count",
-            "integrations_owned_count"
+            "integrations_owned_count",
+            "cognitive_calls",
+            "model_credit"
           ],
           required: true
         },
@@ -430542,7 +430989,7 @@ var 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: [
@@ -430673,6 +431120,8 @@ var state = {
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
+      setWorkspacePaymentMethodBody: true,
+      chargeWorkspaceUnpaidInvoicesBody: true,
       createWorkspaceBody: true,
       updateWorkspaceBody: true,
       changeWorkspacePlanBody: true,
@@ -430729,6 +431178,10 @@ var state = {
       listBotIssuesResponse: true,
       deleteBotIssueResponse: true,
       listBotIssueEventsResponse: true,
+      getWorkspaceBillingDetailsResponse: true,
+      setWorkspacePaymentMethodResponse: true,
+      listWorkspaceInvoicesResponse: true,
+      chargeWorkspaceUnpaidInvoicesResponse: true,
       createWorkspaceResponse: true,
       getWorkspaceResponse: true,
       listWorkspaceUsagesResponse: true,
@@ -430820,6 +431273,9 @@ var state = {
                 webhookUrl: {
                   type: "string"
                 },
+                webhookId: {
+                  type: "string"
+                },
                 configuration: {
                   type: "object",
                   additionalProperties: true
@@ -430874,6 +431330,7 @@ var state = {
                 "name",
                 "version",
                 "webhookUrl",
+                "webhookId",
                 "configuration",
                 "status",
                 "statusReason",
@@ -431145,6 +431602,17 @@ var state = {
             format: "date-time",
             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)"
@@ -431156,13 +431624,27 @@ var 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,
                 description: "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
           },
@@ -431441,6 +431923,7 @@ var state = {
           "id",
           "createdAt",
           "updatedAt",
+          "identifier",
           "name",
           "version",
           "configuration",
@@ -431485,6 +431968,10 @@ var state = {
             type: "string",
             enum: ["free", "premium"]
           },
+          plan: {
+            type: "string",
+            enum: ["community", "team", "enterprise"]
+          },
           blocked: {
             type: "boolean"
           },
@@ -431500,6 +431987,7 @@ var state = {
           "updatedAt",
           "botCount",
           "accountType",
+          "plan",
           "blocked",
           "spendingLimit"
         ],
@@ -431590,7 +432078,9 @@ var state = {
               "bot_ratelimit",
               "table_row_count",
               "workspace_member_count",
-              "integrations_owned_count"
+              "integrations_owned_count",
+              "cognitive_calls",
+              "model_credit"
             ],
             description: "Usage type that can be used"
           }
@@ -431700,7 +432190,7 @@ var state = {
             additionalProperties: {
               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."
+            description: "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"],
@@ -431740,7 +432230,7 @@ var state = {
             additionalProperties: {
               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."
+            description: "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: [
@@ -431825,7 +432315,7 @@ var state = {
             additionalProperties: {
               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."
+            description: "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: [
@@ -432068,6 +432558,10 @@ var state = {
       title: "Workspace",
       name: "workspace",
       operations: [
+        "getWorkspaceBillingDetails",
+        "setWorkspacePaymentMethod",
+        "listWorkspaceInvoices",
+        "chargeWorkspaceUnpaidInvoices",
         "createWorkspace",
         "getWorkspace",
         "listWorkspaceUsages",