@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
  1. package/dist/index.js +55 -27
  2. package/dist/src/gen/state.d.ts +13 -1
  3. package/package.json +1 -1
  4. package/src/gen/openapi.json +1 -1
  5. package/src/gen/state.ts +55 -27
package/src/gen/state.ts CHANGED
@@ -668,7 +668,7 @@ export const state = {
668
668
  "type": "string",
669
669
  "maxLength": 500
670
670
  },
671
- "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."
671
+ "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."
672
672
  },
673
673
  "schedule": {
674
674
  "type": "object",
@@ -757,7 +757,7 @@ export const state = {
757
757
  "type": "string",
758
758
  "maxLength": 500
759
759
  },
760
- "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."
760
+ "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."
761
761
  },
762
762
  "schedule": {
763
763
  "type": "object",
@@ -790,7 +790,7 @@ export const state = {
790
790
  },
791
791
  "section": "message",
792
792
  "response": {
793
- "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
793
+ "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
794
794
  "schema": {
795
795
  "type": "object",
796
796
  "properties": {
@@ -821,7 +821,7 @@ export const state = {
821
821
  },
822
822
  "section": "message",
823
823
  "response": {
824
- "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
824
+ "description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
825
825
  "schema": {
826
826
  "type": "object",
827
827
  "properties": {
@@ -860,7 +860,7 @@ export const state = {
860
860
  "additionalProperties": {
861
861
  "type": "string"
862
862
  },
863
- "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."
863
+ "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."
864
864
  }
865
865
  },
866
866
  "required": [
@@ -889,7 +889,7 @@ export const state = {
889
889
  },
890
890
  "listMessages": {
891
891
  "name": "listMessages",
892
- "description": "Retrieves a list of [Messages](#schema_message) you’ve previously created. The messages are returned in sorted order, with the most recent appearing first. The list can be filtered using [Tags](#tags).",
892
+ "description": "Retrieves a list of [Message](#schema_message) you’ve 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).",
893
893
  "method": "get",
894
894
  "path": "/v1/chat/messages",
895
895
  "parameters": {
@@ -917,7 +917,7 @@ export const state = {
917
917
  },
918
918
  "section": "message",
919
919
  "response": {
920
- "description": "Returns a list of [Messages](#schema_message) objects.",
920
+ "description": "Returns a list of [Message](#schema_message) objects.",
921
921
  "schema": {
922
922
  "type": "object",
923
923
  "properties": {
@@ -990,7 +990,7 @@ export const state = {
990
990
  "integrationName": {
991
991
  "type": "string",
992
992
  "maxLength": 200,
993
- "description": "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
993
+ "description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
994
994
  "deprecated": true
995
995
  },
996
996
  "name": {
@@ -1013,7 +1013,7 @@ export const state = {
1013
1013
  },
1014
1014
  "section": "user",
1015
1015
  "response": {
1016
- "description": "Returns a [User](#schema_user) object if creation succeeds. Returns [an error](#errors) otherwise",
1016
+ "description": "Returns a [User](#schema_user) object if creation succeeds. Returns an [Error](#errors) otherwise",
1017
1017
  "status": 201,
1018
1018
  "schema": {
1019
1019
  "type": "object",
@@ -1045,7 +1045,7 @@ export const state = {
1045
1045
  },
1046
1046
  "section": "user",
1047
1047
  "response": {
1048
- "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
1048
+ "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
1049
1049
  "schema": {
1050
1050
  "type": "object",
1051
1051
  "properties": {
@@ -1063,7 +1063,7 @@ export const state = {
1063
1063
  },
1064
1064
  "listUsers": {
1065
1065
  "name": "listUsers",
1066
- "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).",
1066
+ "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).",
1067
1067
  "method": "get",
1068
1068
  "path": "/v1/chat/users",
1069
1069
  "parameters": {
@@ -1142,7 +1142,7 @@ export const state = {
1142
1142
  "integrationName": {
1143
1143
  "type": "string",
1144
1144
  "maxLength": 200,
1145
- "description": "[DEPRECATED] To create a user from within a bot, call an action of the integration instead.",
1145
+ "description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
1146
1146
  "deprecated": true
1147
1147
  },
1148
1148
  "name": {
@@ -1165,7 +1165,7 @@ export const state = {
1165
1165
  },
1166
1166
  "section": "user",
1167
1167
  "response": {
1168
- "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
1168
+ "description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
1169
1169
  "schema": {
1170
1170
  "type": "object",
1171
1171
  "properties": {
@@ -1615,7 +1615,7 @@ export const state = {
1615
1615
  },
1616
1616
  "section": "task",
1617
1617
  "response": {
1618
- "description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
1618
+ "description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
1619
1619
  "schema": {
1620
1620
  "type": "object",
1621
1621
  "properties": {
@@ -1697,7 +1697,7 @@ export const state = {
1697
1697
  },
1698
1698
  "section": "task",
1699
1699
  "response": {
1700
- "description": "Returns a [Task](#schema_task) object if creation succeeds. Returns [an error](#errors) otherwise",
1700
+ "description": "Returns a [Task](#schema_task) object if creation succeeds. Returns an [Error](#errors) otherwise",
1701
1701
  "status": 201,
1702
1702
  "schema": {
1703
1703
  "type": "object",
@@ -1779,7 +1779,7 @@ export const state = {
1779
1779
  },
1780
1780
  "section": "task",
1781
1781
  "response": {
1782
- "description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns [an error](#errors) otherwise",
1782
+ "description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
1783
1783
  "schema": {
1784
1784
  "type": "object",
1785
1785
  "properties": {
@@ -1819,7 +1819,7 @@ export const state = {
1819
1819
  },
1820
1820
  "listTasks": {
1821
1821
  "name": "listTasks",
1822
- "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).",
1822
+ "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).",
1823
1823
  "method": "get",
1824
1824
  "path": "/v1/chat/tasks",
1825
1825
  "parameters": {
@@ -8130,7 +8130,11 @@ export const state = {
8130
8130
  "accessPolicies": {
8131
8131
  "type": "array",
8132
8132
  "items": {
8133
- "type": "string"
8133
+ "type": "string",
8134
+ "enum": [
8135
+ "integrations",
8136
+ "public_content"
8137
+ ]
8134
8138
  },
8135
8139
  "description": "Access policies configured for the file."
8136
8140
  },
@@ -8292,7 +8296,11 @@ export const state = {
8292
8296
  "accessPolicies": {
8293
8297
  "type": "array",
8294
8298
  "items": {
8295
- "type": "string"
8299
+ "type": "string",
8300
+ "enum": [
8301
+ "integrations",
8302
+ "public_content"
8303
+ ]
8296
8304
  },
8297
8305
  "description": "Access policies configured for the file."
8298
8306
  },
@@ -8420,7 +8428,11 @@ export const state = {
8420
8428
  "accessPolicies": {
8421
8429
  "type": "array",
8422
8430
  "items": {
8423
- "type": "string"
8431
+ "type": "string",
8432
+ "enum": [
8433
+ "integrations",
8434
+ "public_content"
8435
+ ]
8424
8436
  },
8425
8437
  "description": "Access policies configured for the file."
8426
8438
  },
@@ -8495,12 +8507,20 @@ export const state = {
8495
8507
  "maxLength": 1000,
8496
8508
  "nullable": true
8497
8509
  },
8498
- "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`."
8510
+ "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`."
8511
+ },
8512
+ "accessPolicies": {
8513
+ "type": "array",
8514
+ "items": {
8515
+ "type": "string",
8516
+ "enum": [
8517
+ "integrations",
8518
+ "public_content"
8519
+ ]
8520
+ },
8521
+ "description": "New access policies to set for the file. Omit to keep existing policies intact."
8499
8522
  }
8500
8523
  },
8501
- "required": [
8502
- "tags"
8503
- ],
8504
8524
  "title": "updateFileBody",
8505
8525
  "additionalProperties": false
8506
8526
  }
@@ -8559,7 +8579,11 @@ export const state = {
8559
8579
  "accessPolicies": {
8560
8580
  "type": "array",
8561
8581
  "items": {
8562
- "type": "string"
8582
+ "type": "string",
8583
+ "enum": [
8584
+ "integrations",
8585
+ "public_content"
8586
+ ]
8563
8587
  },
8564
8588
  "description": "Access policies configured for the file."
8565
8589
  },
@@ -9581,7 +9605,7 @@ export const state = {
9581
9605
  "title": "Botpress API",
9582
9606
  "description": "API for Botpress Cloud",
9583
9607
  "server": "https://api.botpress.cloud",
9584
- "version": "0.27.6",
9608
+ "version": "0.27.8",
9585
9609
  "prefix": "v1"
9586
9610
  },
9587
9611
  "errors": [
@@ -11943,7 +11967,11 @@ export const state = {
11943
11967
  "accessPolicies": {
11944
11968
  "type": "array",
11945
11969
  "items": {
11946
- "type": "string"
11970
+ "type": "string",
11971
+ "enum": [
11972
+ "integrations",
11973
+ "public_content"
11974
+ ]
11947
11975
  },
11948
11976
  "description": "Access policies configured for the file."
11949
11977
  },