@botpress/api 0.15.9 → 0.15.11

package/src/gen/state.ts

@@ -16,7 +16,10 @@ export type State = opapi.State<
   | "Event"
   | "Message"
   | "State"
-  | "File",
+  | "File"
+  | "Table"
+  | "Column"
+  | "Row",
   never,
   | "user"
   | "conversation"
@@ -34,6 +37,7 @@ export type State = opapi.State<
   | "usage"
   | "quotas"
   | "helper"
+  | "tables"
 >;
 export const state = {
   operations: {
@@ -593,7 +597,7 @@ export const state = {
     listEvents: {
       name: "listEvents",
       description:
-        "Retreives a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.",
+        "Retrieves a list of [Event](#schema_event) you’ve previously created. The events are returned in sorted order, with the most recent appearing first.",
       method: "get",
       path: "/v1/chat/events",
       section: "event",
@@ -1563,11 +1567,10 @@ export const state = {
               additionalProperties: true,
             },
             result: {
-              type: "object",
-              additionalProperties: true,
+              nullable: true,
             },
           },
-          required: ["data", "result"],
+          required: ["data"],
           title: "runVrlResponse",
           additionalProperties: false,
         },
@@ -1741,6 +1744,74 @@ export const state = {
         },
       },
     },
+    setAccountPreference: {
+      name: "setAccountPreference",
+      description: "Set a preference for the account",
+      method: "post",
+      path: "/v1/admin/account/preferences/{key}",
+      section: "account",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        key: {
+          type: "string",
+          description: "Preference key",
+          in: "path",
+        },
+      },
+      requestBody: {
+        description: "Preference value",
+        schema: {
+          type: "object",
+          properties: {
+            value: {
+              nullable: true,
+            },
+          },
+          title: "setAccountPreferenceBody",
+          additionalProperties: false,
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          title: "setAccountPreferenceResponse",
+          additionalProperties: false,
+        },
+      },
+    },
+    getAccountPreference: {
+      name: "getAccountPreference",
+      description: "Get a preference of the account",
+      method: "get",
+      path: "/v1/admin/account/preferences/{key}",
+      section: "account",
+      disableDefaultParameters: {
+        "x-workspace-id": true,
+      },
+      parameters: {
+        key: {
+          type: "string",
+          description: "Preference key",
+          in: "path",
+        },
+      },
+      response: {
+        description: "Success",
+        schema: {
+          type: "object",
+          properties: {
+            value: {
+              nullable: true,
+            },
+          },
+          title: "getAccountPreferenceResponse",
+          additionalProperties: false,
+        },
+      },
+    },
     listPublicIntegrations: {
       name: "listPublicIntegrations",
       description: "List public integration",
@@ -2229,6 +2300,11 @@ export const state = {
             blocked: {
               type: "boolean",
             },
+            alwaysAlive: {
+              type: "boolean",
+              description:
+                "Indicates if the [Bot](#schema_bot) should be in always alive mode",
+            },
             user: {
               type: "object",
               properties: {
@@ -2445,11 +2521,6 @@ export const state = {
               },
               description: "Media files associated with the [Bot](#schema_bot)",
             },
-            alwaysAlive: {
-              type: "boolean",
-              description:
-                "Indicates if the [Bot](#schema_bot) should be in always alive mode",
-            },
           },
           title: "updateBotBody",
           additionalProperties: false,
@@ -4837,6 +4908,14 @@ export const state = {
               },
               additionalProperties: false,
             },
+            secrets: {
+              type: "object",
+              additionalProperties: {
+                type: "string",
+              },
+              description:
+                "Secrets are integration-wide values available in the code via environment variables formatted as SECRET_${YOUR_SECRET_NAME}. A secret name must respect SCREAMING_SNAKE casing.",
+            },
             code: {
               type: "string",
               description: "JavaScript code of the integration",
@@ -5215,6 +5294,15 @@ export const state = {
               },
               additionalProperties: false,
             },
+            secrets: {
+              type: "object",
+              additionalProperties: {
+                type: "string",
+                nullable: true,
+              },
+              description:
+                "Secrets are integration-wide values available in the code via environment variables formatted as SECRET_${YOUR_SECRET_NAME}. A secret name must respect SCREAMING_SNAKE casing.",
+            },
             code: {
               type: "string",
               description: "JavaScript code of the integration",
@@ -5895,7 +5983,7 @@ export const state = {
     title: "Botpress API",
     description: "API for Botpress Cloud",
     server: "https://api.botpress.cloud",
-    version: "0.15.9",
+    version: "0.15.11",
     prefix: "v1",
   },
   errors: [
@@ -6034,6 +6122,7 @@ export const state = {
       configureIntegrationBody: true,
       runVrlBody: true,
       createPersonalAccessTokenBody: true,
+      setAccountPreferenceBody: true,
       createBotBody: true,
       updateBotBody: true,
       transferBotBody: true,
@@ -6086,6 +6175,8 @@ export const state = {
       listPersonalAccessTokensResponse: true,
       createPersonalAccessTokenResponse: true,
       deletePersonalAccessTokenResponse: true,
+      setAccountPreferenceResponse: true,
+      getAccountPreferenceResponse: true,
       listPublicIntegrationsResponse: true,
       getPublicIntegrationByIdResponse: true,
       getPublicIntegrationResponse: true,
@@ -6153,6 +6244,9 @@ export const state = {
       Message: true,
       State: true,
       File: true,
+      Table: true,
+      Column: true,
+      Row: true,
     },
   },
   schemas: {
@@ -6933,6 +7027,14 @@ export const state = {
             description:
               "URL of the readme of the integration. This is the readme that will be displayed in the UI",
           },
+          secrets: {
+            type: "array",
+            items: {
+              type: "string",
+            },
+            description:
+              "Secrets are integration-wide values available in the code via environment variables formatted as SECRET_${YOUR_SECRET_NAME}. A secret name must respect SCREAMING_SNAKE casing.",
+          },
         },
         required: [
           "id",
@@ -6952,6 +7054,7 @@ export const state = {
           "description",
           "iconUrl",
           "readmeUrl",
+          "secrets",
         ],
         additionalProperties: false,
       },
@@ -7559,6 +7662,172 @@ export const state = {
         additionalProperties: false,
       },
     },
+    Table: {
+      section: "tables",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+            description: "Unique identifier for the table",
+          },
+          name: {
+            type: "string",
+            description: "Required. This name is used to identify your table.",
+          },
+          factor: {
+            default: 1,
+            type: "number",
+            minimum: 1,
+            maximum: 30,
+            description:
+              "The 'factor' multiplies the row's data storage limit by 4KB and its quota count, but can only be set at table creation and not modified later. For instance, a factor of 2 increases storage to 8KB but counts as 2 rows in your quota. The default factor is 1.",
+          },
+          columns: {
+            type: "array",
+            items: {
+              type: "object",
+              properties: {
+                id: {
+                  type: "string",
+                  description: "Unique identifier for the column.",
+                },
+                name: {
+                  type: "string",
+                  minLength: 1,
+                  maxLength: 30,
+                  description:
+                    "Name of the column, must be within length limits.",
+                },
+                description: {
+                  type: "string",
+                  description: "Optional descriptive text about the column.",
+                },
+                searchable: {
+                  type: "boolean",
+                  description:
+                    "Indicates if the column is vectorized and searchable.",
+                },
+                type: {
+                  type: "string",
+                  enum: ["string", "number", "boolean", "date", "object"],
+                  description:
+                    'Specifies the data type of the column. Use "object" for complex data structures.',
+                },
+                typings: {
+                  type: "string",
+                  description:
+                    'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"',
+                },
+                schema: {
+                  type: "object",
+                  properties: {},
+                  additionalProperties: true,
+                },
+              },
+              required: ["name", "type"],
+            },
+            maxItems: 20,
+            description: "Array of columns in the table.",
+          },
+          schema: {
+            type: "object",
+            additionalProperties: true,
+            description:
+              "Provide an object or a JSON schema to define the columns of the table. A maximum of 20 keys in the object/schema is allowed.",
+          },
+          tags: {
+            type: "object",
+            additionalProperties: {
+              type: "string",
+            },
+            description:
+              "Optional tags to help organize your tables. These should be passed here as an object representing key/value pairs.",
+          },
+          createdAt: {
+            type: "string",
+            description: "Timestamp of table creation.",
+          },
+          updatedAt: {
+            type: "string",
+            description: "Timestamp of the last table update.",
+          },
+        },
+        required: ["id", "name", "columns", "schema"],
+        additionalProperties: false,
+      },
+    },
+    Column: {
+      section: "tables",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "string",
+            description: "Unique identifier for the column.",
+          },
+          name: {
+            type: "string",
+            minLength: 1,
+            maxLength: 30,
+            description: "Name of the column, must be within length limits.",
+          },
+          description: {
+            type: "string",
+            description: "Optional descriptive text about the column.",
+          },
+          searchable: {
+            type: "boolean",
+            description:
+              "Indicates if the column is vectorized and searchable.",
+          },
+          type: {
+            type: "string",
+            enum: ["string", "number", "boolean", "date", "object"],
+            description:
+              'Specifies the data type of the column. Use "object" for complex data structures.',
+          },
+          typings: {
+            type: "string",
+            description:
+              'TypeScript typings for the column. Recommended if the type is "object", ex: "\\{ foo: string; bar: number \\}"',
+          },
+          schema: {
+            type: "object",
+            additionalProperties: true,
+          },
+        },
+        required: ["name", "type"],
+        additionalProperties: false,
+      },
+    },
+    Row: {
+      section: "tables",
+      schema: {
+        type: "object",
+        properties: {
+          id: {
+            type: "number",
+            description: "Unique identifier for the row.",
+          },
+          createdAt: {
+            type: "string",
+            description: "Timestamp of row creation.",
+          },
+          updatedAt: {
+            type: "string",
+            description: "Timestamp of the last row update.",
+          },
+          similarity: {
+            type: "number",
+            description:
+              "Optional numeric value indicating similarity, when using findTableRows.",
+          },
+        },
+        required: ["id"],
+        additionalProperties: true,
+      },
+    },
   },
   sections: [
     {
@@ -7730,6 +7999,8 @@ export const state = {
         "listPersonalAccessTokens",
         "createPersonalAccessToken",
         "deletePersonalAccessToken",
+        "setAccountPreference",
+        "getAccountPreference",
       ],
       schema: "Account",
     },
@@ -7752,6 +8023,13 @@ export const state = {
       name: "helper",
       operations: ["runVrl"],
     },
+    {
+      title: "Tables",
+      description: "Operations related to table management.",
+      name: "tables",
+      operations: [],
+      schema: "Table",
+    },
   ],
   options: {
     allowUnions: false,