@botpress/api 0.79.0 → 0.83.0

package/src/gen/state.ts

@@ -1763,6 +1763,16 @@ export const state = {
                 "yearly"
               ],
               "description": "Recurring schedule on which `register()` will be called on the integration"
+            },
+            "sandboxIdentifiers": {
+              "type": "object",
+              "additionalProperties": {
+                "type": "object",
+                "nullable": true,
+                "additionalProperties": false
+              },
+              "nullable": true,
+              "description": "Sandbox identifiers for the integration. Setting this to null will remove all sandbox identifiers. Setting an individual sandbox identifier to null will remove that sandbox identifier. This is an experimental feature meant to be used by specific integrations."
             }
           },
           "title": "configureIntegrationBody",
@@ -3195,6 +3205,22 @@ export const state = {
                   "description": "Global identifier configuration of the [Integration](#schema_integration)",
                   "additionalProperties": false
                 },
+                "sandbox": {
+                  "type": "object",
+                  "properties": {
+                    "identifierExtractScript": {
+                      "type": "string",
+                      "maxLength": 2000,
+                      "description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
+                    },
+                    "messageExtractScript": {
+                      "type": "string",
+                      "maxLength": 2000,
+                      "description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
+                    }
+                  },
+                  "additionalProperties": false
+                },
                 "url": {
                   "type": "string",
                   "maxLength": 2000,
@@ -3896,6 +3922,22 @@ export const state = {
                   "description": "Global identifier configuration of the [Integration](#schema_integration)",
                   "additionalProperties": false
                 },
+                "sandbox": {
+                  "type": "object",
+                  "properties": {
+                    "identifierExtractScript": {
+                      "type": "string",
+                      "maxLength": 2000,
+                      "description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
+                    },
+                    "messageExtractScript": {
+                      "type": "string",
+                      "maxLength": 2000,
+                      "description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
+                    }
+                  },
+                  "additionalProperties": false
+                },
                 "url": {
                   "type": "string",
                   "maxLength": 2000,
@@ -9969,6 +10011,22 @@ export const state = {
                 "additionalProperties": false
               }
             },
+            "sandbox": {
+              "type": "object",
+              "properties": {
+                "identifierExtractScript": {
+                  "type": "string",
+                  "maxLength": 2000,
+                  "nullable": true
+                },
+                "messageExtractScript": {
+                  "type": "string",
+                  "maxLength": 2000,
+                  "nullable": true
+                }
+              },
+              "additionalProperties": false
+            },
             "secrets": {
               "type": "object",
               "additionalProperties": {
@@ -10536,6 +10594,22 @@ export const state = {
                 "additionalProperties": false
               }
             },
+            "sandbox": {
+              "type": "object",
+              "properties": {
+                "identifierExtractScript": {
+                  "type": "string",
+                  "maxLength": 2000,
+                  "nullable": true
+                },
+                "messageExtractScript": {
+                  "type": "string",
+                  "maxLength": 2000,
+                  "nullable": true
+                }
+              },
+              "additionalProperties": false
+            },
             "secrets": {
               "type": "object",
               "additionalProperties": {
@@ -10599,7 +10673,7 @@ export const state = {
     },
     "listIntegrations": {
       "name": "listIntegrations",
-      "description": "List integrations",
+      "description": "List integrations, supports filtering and sorting capabilities",
       "method": "get",
       "section": "integration",
       "path": "/v1/admin/integrations",
@@ -10609,6 +10683,12 @@ export const state = {
           "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
           "type": "string"
         },
+        "limit": {
+          "in": "query",
+          "description": "Maximum number of results to return per page",
+          "type": "number",
+          "required": false
+        },
         "name": {
           "type": "string",
           "description": "Integration Name",
@@ -10619,6 +10699,68 @@ export const state = {
           "description": "Integration version. Either a semver version or tag \"latest\"",
           "in": "query"
         },
+        "interfaceId": {
+          "type": "string",
+          "description": "Filter integrations by implemented interface ID",
+          "in": "query"
+        },
+        "interfaceName": {
+          "type": "string",
+          "description": "Filter integrations by implemented interface name (strict match)",
+          "in": "query"
+        },
+        "visibility": {
+          "type": "string",
+          "description": "Filter integrations by visibility (public, private)",
+          "in": "query",
+          "enum": [
+            "public",
+            "private"
+          ]
+        },
+        "installedByBotId": {
+          "in": "query",
+          "description": "Bot ID. Required when filtering for installed integrations",
+          "type": "string",
+          "required": false
+        },
+        "verificationStatus": {
+          "type": "string",
+          "description": "Filter integrations by verification status",
+          "in": "query",
+          "enum": [
+            "unapproved",
+            "pending",
+            "approved",
+            "rejected"
+          ]
+        },
+        "search": {
+          "type": "string",
+          "description": "Search integrations by name, description, actions, and interfaces. Responses include a matchedOn field indicating which fields matched the search.",
+          "in": "query"
+        },
+        "sortBy": {
+          "type": "string",
+          "description": "Sort integrations by field",
+          "in": "query",
+          "enum": [
+            "popularity",
+            "name",
+            "createdAt",
+            "updatedAt",
+            "installCount"
+          ]
+        },
+        "direction": {
+          "type": "string",
+          "description": "Sort direction (asc or desc)",
+          "in": "query",
+          "enum": [
+            "asc",
+            "desc"
+          ]
+        },
         "dev": {
           "in": "query",
           "description": "If true, only dev integrations are returned. Otherwise, only production integrations are returned.",
@@ -10690,6 +10832,58 @@ export const state = {
                       "rejected"
                     ],
                     "description": "Status of the integration version verification"
+                  },
+                  "matchedOn": {
+                    "type": "object",
+                    "properties": {
+                      "name": {
+                        "type": "boolean",
+                        "description": "Whether the integration name matched the search term"
+                      },
+                      "title": {
+                        "type": "boolean",
+                        "description": "Whether the integration title matched the search term"
+                      },
+                      "description": {
+                        "type": "boolean",
+                        "description": "Whether the integration description matched the search term"
+                      },
+                      "actions": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        },
+                        "description": "Action names that matched the search term"
+                      },
+                      "interfaces": {
+                        "type": "array",
+                        "items": {
+                          "type": "string"
+                        },
+                        "description": "Interface names that matched the search term"
+                      }
+                    },
+                    "description": "Metadata about which fields matched the search criteria"
+                  },
+                  "ownerWorkspace": {
+                    "type": "object",
+                    "properties": {
+                      "id": {
+                        "type": "string"
+                      },
+                      "handle": {
+                        "type": "string",
+                        "nullable": true
+                      },
+                      "name": {
+                        "type": "string"
+                      }
+                    },
+                    "required": [
+                      "id",
+                      "handle",
+                      "name"
+                    ]
                   }
                 },
                 "required": [
@@ -14203,6 +14397,211 @@ export const state = {
         }
       }
     },
+    "createKnowledgeBase": {
+      "name": "createKnowledgeBase",
+      "path": "/v1/files/knowledge-bases",
+      "description": "Creates a knowledge base for grouping files.",
+      "method": "post",
+      "requestBody": {
+        "description": "Properties of the knowledge base.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "Name of the knowledge base."
+            }
+          },
+          "required": [
+            "name"
+          ],
+          "title": "createKnowledgeBaseBody",
+          "additionalProperties": false
+        }
+      },
+      "contentType": "application/json",
+      "section": "files",
+      "response": {
+        "description": "The created knowledge base",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "knowledgeBase": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Knowledge base ID"
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Name of the knowledge base."
+                }
+              },
+              "required": [
+                "id",
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "knowledgeBase"
+          ],
+          "title": "createKnowledgeBaseResponse",
+          "additionalProperties": false
+        }
+      },
+      "parameters": {}
+    },
+    "deleteKnowledgeBase": {
+      "name": "deleteKnowledgeBase",
+      "path": "/v1/files/knowledge-bases/{id}",
+      "description": "Deletes a knowledge base.",
+      "method": "delete",
+      "section": "files",
+      "parameters": {
+        "id": {
+          "type": "string",
+          "description": "Knowledge base ID",
+          "in": "path"
+        }
+      },
+      "response": {
+        "description": "Empty response.",
+        "schema": {
+          "type": "object",
+          "title": "deleteKnowledgeBaseResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "updateKnowledgeBase": {
+      "name": "updateKnowledgeBase",
+      "path": "/v1/files/knowledge-bases/{id}",
+      "description": "Updates a knowledge base.",
+      "method": "put",
+      "section": "files",
+      "parameters": {
+        "id": {
+          "type": "string",
+          "description": "Knowledge base ID",
+          "in": "path"
+        }
+      },
+      "requestBody": {
+        "description": "Properties of the knowledge base to update.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "name": {
+              "type": "string",
+              "description": "New name of the knowledge base."
+            }
+          },
+          "required": [
+            "name"
+          ],
+          "title": "updateKnowledgeBaseBody",
+          "additionalProperties": false
+        }
+      },
+      "contentType": "application/json",
+      "response": {
+        "description": "The updated knowledge base",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "knowledgeBase": {
+              "type": "object",
+              "properties": {
+                "id": {
+                  "type": "string",
+                  "description": "Knowledge base ID"
+                },
+                "name": {
+                  "type": "string",
+                  "description": "Name of the knowledge base."
+                }
+              },
+              "required": [
+                "id",
+                "name"
+              ],
+              "additionalProperties": false
+            }
+          },
+          "required": [
+            "knowledgeBase"
+          ],
+          "title": "updateKnowledgeBaseResponse",
+          "additionalProperties": false
+        }
+      }
+    },
+    "listKnowledgeBases": {
+      "name": "listKnowledgeBases",
+      "path": "/v1/files/knowledge-bases",
+      "description": "List knowledge bases for bot",
+      "method": "get",
+      "section": "files",
+      "parameters": {
+        "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": "Returns the list of knowledge bases for the bot.",
+        "schema": {
+          "type": "object",
+          "properties": {
+            "knowledgeBases": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "id": {
+                    "type": "string",
+                    "description": "Knowledge base ID"
+                  },
+                  "name": {
+                    "type": "string",
+                    "description": "Name of the knowledge base."
+                  },
+                  "createdAt": {
+                    "type": "string",
+                    "description": "Knowledge base creation timestamp in ISO 8601 format"
+                  }
+                },
+                "required": [
+                  "id",
+                  "name",
+                  "createdAt"
+                ]
+              }
+            },
+            "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": [
+            "knowledgeBases",
+            "meta"
+          ],
+          "title": "listKnowledgeBasesResponse",
+          "additionalProperties": false
+        }
+      }
+    },
     "listTables": {
       "name": "listTables",
       "path": "/v1/tables",
@@ -15414,7 +15813,7 @@ export const state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.79.0",
+    "version": "0.83.0",
     "prefix": "v1"
   },
   "errors": [
@@ -15595,6 +15994,8 @@ export const state = {
       "upsertFileBody": true,
       "updateFileMetadataBody": true,
       "copyFileBody": true,
+      "createKnowledgeBaseBody": true,
+      "updateKnowledgeBaseBody": true,
       "getOrCreateTableBody": true,
       "createTableBody": true,
       "duplicateTableBody": true,
@@ -15747,6 +16148,10 @@ export const state = {
       "listFilePassagesResponse": true,
       "listFileTagsResponse": true,
       "listFileTagValuesResponse": true,
+      "createKnowledgeBaseResponse": true,
+      "deleteKnowledgeBaseResponse": true,
+      "updateKnowledgeBaseResponse": true,
+      "listKnowledgeBasesResponse": true,
       "listTablesResponse": true,
       "getTableResponse": true,
       "getOrCreateTableResponse": true,
@@ -16360,6 +16765,22 @@ export const state = {
             "description": "Global identifier configuration of the [Integration](#schema_integration)",
             "additionalProperties": false
           },
+          "sandbox": {
+            "type": "object",
+            "properties": {
+              "identifierExtractScript": {
+                "type": "string",
+                "maxLength": 2000,
+                "description": "VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox"
+              },
+              "messageExtractScript": {
+                "type": "string",
+                "maxLength": 2000,
+                "description": "VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox"
+              }
+            },
+            "additionalProperties": false
+          },
           "url": {
             "type": "string",
             "maxLength": 2000,
@@ -19313,7 +19734,11 @@ export const state = {
         "searchFiles",
         "listFilePassages",
         "listFileTags",
-        "listFileTagValues"
+        "listFileTagValues",
+        "createKnowledgeBase",
+        "deleteKnowledgeBase",
+        "updateKnowledgeBase",
+        "listKnowledgeBases"
       ],
       "schema": "File"
     }