npm - @botpress/api - Versions diffs - 0.27.6 → 0.27.8 - Mend

@botpress/api 0.27.6 → 0.27.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (5) hide show

package/dist/index.js CHANGED Viewed

@@ -273392,7 +273392,7 @@ var state = {
                 "type": "string",
                 "maxLength": 500
               },
-              "description": "Set of [Tags](#tags) that you can attach to a [Message](#schema_message). The set of [Tags](#tags) available on a [Message](#schema_message) 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 [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) 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."
             },
             "schedule": {
               "type": "object",
@@ -273481,7 +273481,7 @@ var state = {
                 "type": "string",
                 "maxLength": 500
               },
-              "description": "Set of [Tags](#tags) that you can attach to a [Message](#schema_message). The set of [Tags](#tags) available on a [Message](#schema_message) 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 [Message](#schema_message). The set of [Tags](/docs/developers/concepts/tags) available on a [Message](#schema_message) 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."
             },
             "schedule": {
               "type": "object",
@@ -273514,7 +273514,7 @@ var state = {
       },
       "section": "message",
       "response": {
-        "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
         "schema": {
           "type": "object",
           "properties": {
@@ -273545,7 +273545,7 @@ var state = {
       },
       "section": "message",
       "response": {
-        "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
         "schema": {
           "type": "object",
           "properties": {
@@ -273584,7 +273584,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": [
@@ -273613,7 +273613,7 @@ var state = {
     },
     "listMessages": {
       "name": "listMessages",
-      "description": "Retrieves a list of [Messages](#schema_message) you\u2019ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).",
+      "description": "Retrieves a list of [Message](#schema_message) you\u2019ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).",
       "method": "get",
       "path": "/v1/chat/messages",
       "parameters": {
@@ -273641,7 +273641,7 @@ var state = {
       },
       "section": "message",
       "response": {
-        "description": "Returns a list of [Messages](#schema_message) objects.",
+        "description": "Returns a list of [Message](#schema_message) objects.",
         "schema": {
           "type": "object",
           "properties": {
@@ -273714,7 +273714,7 @@ var state = {
             "integrationName": {
               "type": "string",
               "maxLength": 200,
-              "description": "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
+              "description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
               "deprecated": true
             },
             "name": {
@@ -273737,7 +273737,7 @@ var state = {
       },
       "section": "user",
       "response": {
-        "description": "Returns a [User](#schema_user) object if creation succeeds. Returns [an error](#errors) otherwise",
+        "description": "Returns a [User](#schema_user) object if creation succeeds. Returns an [Error](#errors) otherwise",
         "status": 201,
         "schema": {
           "type": "object",
@@ -273769,7 +273769,7 @@ var state = {
       },
       "section": "user",
       "response": {
-        "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
         "schema": {
           "type": "object",
           "properties": {
@@ -273787,7 +273787,7 @@ var state = {
     },
     "listUsers": {
       "name": "listUsers",
-      "description": "Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).",
+      "description": "Retrieves a list of [User](#schema_user) previously created. The users are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).",
       "method": "get",
       "path": "/v1/chat/users",
       "parameters": {
@@ -273866,7 +273866,7 @@ var state = {
             "integrationName": {
               "type": "string",
               "maxLength": 200,
-              "description": "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
+              "description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
               "deprecated": true
             },
             "name": {
@@ -273889,7 +273889,7 @@ var state = {
       },
       "section": "user",
       "response": {
-        "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
         "schema": {
           "type": "object",
           "properties": {
@@ -274339,7 +274339,7 @@ var state = {
       },
       "section": "task",
       "response": {
-        "description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        "description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
         "schema": {
           "type": "object",
           "properties": {
@@ -274421,7 +274421,7 @@ var state = {
       },
       "section": "task",
       "response": {
-        "description": "Returns a [Task](#schema_task) object if creation succeeds. Returns [an error](#errors) otherwise",
+        "description": "Returns a [Task](#schema_task) object if creation succeeds. Returns an [Error](#errors) otherwise",
         "status": 201,
         "schema": {
           "type": "object",
@@ -274503,7 +274503,7 @@ var state = {
       },
       "section": "task",
       "response": {
-        "description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
+        "description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
         "schema": {
           "type": "object",
           "properties": {
@@ -274543,7 +274543,7 @@ var state = {
     },
     "listTasks": {
       "name": "listTasks",
-      "description": "Retrieves a list of [Task](#schema_task) you've previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).",
+      "description": "Retrieves a list of [Task](#schema_task) you've previously created. The tasks are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](/docs/developers/concepts/tags).",
       "method": "get",
       "path": "/v1/chat/tasks",
       "parameters": {
@@ -280854,7 +280854,11 @@ var state = {
                 "accessPolicies": {
                   "type": "array",
                   "items": {
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                      "integrations",
+                      "public_content"
+                    ]
                   },
                   "description": "Access policies configured for the file."
                 },
@@ -281016,7 +281020,11 @@ var state = {
                   "accessPolicies": {
                     "type": "array",
                     "items": {
-                      "type": "string"
+                      "type": "string",
+                      "enum": [
+                        "integrations",
+                        "public_content"
+                      ]
                     },
                     "description": "Access policies configured for the file."
                   },
@@ -281144,7 +281152,11 @@ var state = {
                 "accessPolicies": {
                   "type": "array",
                   "items": {
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                      "integrations",
+                      "public_content"
+                    ]
                   },
                   "description": "Access policies configured for the file."
                 },
@@ -281219,12 +281231,20 @@ var state = {
                 "maxLength": 1e3,
                 "nullable": true
               },
-              "description": "The file tags to update as an object of key/value pairs with string (text) values. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`."
+              "description": "The file tags to update as an object of key/value pairs with string (text) values. Omit to keep existing tags intact. Any existing tags not included will be preserved. New tags will be added. To delete a tag, set its value to `null`."
+            },
+            "accessPolicies": {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "enum": [
+                  "integrations",
+                  "public_content"
+                ]
+              },
+              "description": "New access policies to set for the file. Omit to keep existing policies intact."
             }
           },
-          "required": [
-            "tags"
-          ],
           "title": "updateFileBody",
           "additionalProperties": false
         }
@@ -281283,7 +281303,11 @@ var state = {
                 "accessPolicies": {
                   "type": "array",
                   "items": {
-                    "type": "string"
+                    "type": "string",
+                    "enum": [
+                      "integrations",
+                      "public_content"
+                    ]
                   },
                   "description": "Access policies configured for the file."
                 },
@@ -282305,7 +282329,7 @@ var state = {
     "title": "Botpress API",
     "description": "API for Botpress Cloud",
     "server": "https://api.botpress.cloud",
-    "version": "0.27.6",
+    "version": "0.27.8",
     "prefix": "v1"
   },
   "errors": [
@@ -284667,7 +284691,11 @@ var state = {
           "accessPolicies": {
             "type": "array",
             "items": {
-              "type": "string"
+              "type": "string",
+              "enum": [
+                "integrations",
+                "public_content"
+              ]
             },
             "description": "Access policies configured for the file."
           },

package/dist/src/gen/state.d.ts CHANGED Viewed

@@ -7165,6 +7165,7 @@ export declare const state: {
                                     type: "array";
                                     items: {
                                         type: "string";
+                                        enum: string[];
                                     };
                                     description: string;
                                 };
@@ -7305,6 +7306,7 @@ export declare const state: {
                                         type: "array";
                                         items: {
                                             type: "string";
+                                            enum: string[];
                                         };
                                         description: string;
                                     };
@@ -7410,6 +7412,7 @@ export declare const state: {
                                     type: "array";
                                     items: {
                                         type: "string";
+                                        enum: string[];
                                     };
                                     description: string;
                                 };
@@ -7464,8 +7467,15 @@ export declare const state: {
                             };
                             description: string;
                         };
+                        accessPolicies: {
+                            type: "array";
+                            items: {
+                                type: "string";
+                                enum: string[];
+                            };
+                            description: string;
+                        };
                     };
-                    required: string[];
                     title: string;
                     additionalProperties: false;
                 };
@@ -7525,6 +7535,7 @@ export declare const state: {
                                     type: "array";
                                     items: {
                                         type: "string";
+                                        enum: string[];
                                     };
                                     description: string;
                                 };
@@ -10392,6 +10403,7 @@ export declare const state: {
                         type: "array";
                         items: {
                             type: "string";
+                            enum: string[];
                         };
                         description: string;
                     };

package/package.json CHANGED Viewed

@@ -1,6 +1,6 @@
 {
   "name": "@botpress/api",
-  "version": "0.27.6",
+  "version": "0.27.8",
   "main": "dist/index.js",
   "types": "dist/src/index.d.ts",
   "scripts": {