@botpress/api 0.27.7 → 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.
- package/dist/index.js +18 -18
- package/package.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +18 -18
package/dist/index.js
CHANGED
|
@@ -273392,7 +273392,7 @@ var state = {
|
|
|
273392
273392
|
"type": "string",
|
|
273393
273393
|
"maxLength": 500
|
|
273394
273394
|
},
|
|
273395
|
-
"description": "Set of [Tags](
|
|
273395
|
+
"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."
|
|
273396
273396
|
},
|
|
273397
273397
|
"schedule": {
|
|
273398
273398
|
"type": "object",
|
|
@@ -273481,7 +273481,7 @@ var state = {
|
|
|
273481
273481
|
"type": "string",
|
|
273482
273482
|
"maxLength": 500
|
|
273483
273483
|
},
|
|
273484
|
-
"description": "Set of [Tags](
|
|
273484
|
+
"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."
|
|
273485
273485
|
},
|
|
273486
273486
|
"schedule": {
|
|
273487
273487
|
"type": "object",
|
|
@@ -273514,7 +273514,7 @@ var state = {
|
|
|
273514
273514
|
},
|
|
273515
273515
|
"section": "message",
|
|
273516
273516
|
"response": {
|
|
273517
|
-
"description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns
|
|
273517
|
+
"description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
273518
273518
|
"schema": {
|
|
273519
273519
|
"type": "object",
|
|
273520
273520
|
"properties": {
|
|
@@ -273545,7 +273545,7 @@ var state = {
|
|
|
273545
273545
|
},
|
|
273546
273546
|
"section": "message",
|
|
273547
273547
|
"response": {
|
|
273548
|
-
"description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns
|
|
273548
|
+
"description": "Returns a [Message](#schema_message) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
273549
273549
|
"schema": {
|
|
273550
273550
|
"type": "object",
|
|
273551
273551
|
"properties": {
|
|
@@ -273584,7 +273584,7 @@ var state = {
|
|
|
273584
273584
|
"additionalProperties": {
|
|
273585
273585
|
"type": "string"
|
|
273586
273586
|
},
|
|
273587
|
-
"description": "Set of [Tags](
|
|
273587
|
+
"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."
|
|
273588
273588
|
}
|
|
273589
273589
|
},
|
|
273590
273590
|
"required": [
|
|
@@ -273613,7 +273613,7 @@ var state = {
|
|
|
273613
273613
|
},
|
|
273614
273614
|
"listMessages": {
|
|
273615
273615
|
"name": "listMessages",
|
|
273616
|
-
"description": "Retrieves a list of [
|
|
273616
|
+
"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).",
|
|
273617
273617
|
"method": "get",
|
|
273618
273618
|
"path": "/v1/chat/messages",
|
|
273619
273619
|
"parameters": {
|
|
@@ -273641,7 +273641,7 @@ var state = {
|
|
|
273641
273641
|
},
|
|
273642
273642
|
"section": "message",
|
|
273643
273643
|
"response": {
|
|
273644
|
-
"description": "Returns a list of [
|
|
273644
|
+
"description": "Returns a list of [Message](#schema_message) objects.",
|
|
273645
273645
|
"schema": {
|
|
273646
273646
|
"type": "object",
|
|
273647
273647
|
"properties": {
|
|
@@ -273714,7 +273714,7 @@ var state = {
|
|
|
273714
273714
|
"integrationName": {
|
|
273715
273715
|
"type": "string",
|
|
273716
273716
|
"maxLength": 200,
|
|
273717
|
-
"description": "[DEPRECATED] To create a
|
|
273717
|
+
"description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
|
|
273718
273718
|
"deprecated": true
|
|
273719
273719
|
},
|
|
273720
273720
|
"name": {
|
|
@@ -273737,7 +273737,7 @@ var state = {
|
|
|
273737
273737
|
},
|
|
273738
273738
|
"section": "user",
|
|
273739
273739
|
"response": {
|
|
273740
|
-
"description": "Returns a [User](#schema_user) object if creation succeeds. Returns
|
|
273740
|
+
"description": "Returns a [User](#schema_user) object if creation succeeds. Returns an [Error](#errors) otherwise",
|
|
273741
273741
|
"status": 201,
|
|
273742
273742
|
"schema": {
|
|
273743
273743
|
"type": "object",
|
|
@@ -273769,7 +273769,7 @@ var state = {
|
|
|
273769
273769
|
},
|
|
273770
273770
|
"section": "user",
|
|
273771
273771
|
"response": {
|
|
273772
|
-
"description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns
|
|
273772
|
+
"description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
273773
273773
|
"schema": {
|
|
273774
273774
|
"type": "object",
|
|
273775
273775
|
"properties": {
|
|
@@ -273787,7 +273787,7 @@ var state = {
|
|
|
273787
273787
|
},
|
|
273788
273788
|
"listUsers": {
|
|
273789
273789
|
"name": "listUsers",
|
|
273790
|
-
"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](
|
|
273790
|
+
"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).",
|
|
273791
273791
|
"method": "get",
|
|
273792
273792
|
"path": "/v1/chat/users",
|
|
273793
273793
|
"parameters": {
|
|
@@ -273866,7 +273866,7 @@ var state = {
|
|
|
273866
273866
|
"integrationName": {
|
|
273867
273867
|
"type": "string",
|
|
273868
273868
|
"maxLength": 200,
|
|
273869
|
-
"description": "[DEPRECATED] To create a
|
|
273869
|
+
"description": "[DEPRECATED] To create a [User](#schema_user) from within a bot, call an action of the integration instead.",
|
|
273870
273870
|
"deprecated": true
|
|
273871
273871
|
},
|
|
273872
273872
|
"name": {
|
|
@@ -273889,7 +273889,7 @@ var state = {
|
|
|
273889
273889
|
},
|
|
273890
273890
|
"section": "user",
|
|
273891
273891
|
"response": {
|
|
273892
|
-
"description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns
|
|
273892
|
+
"description": "Returns a [User](#schema_user) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
273893
273893
|
"schema": {
|
|
273894
273894
|
"type": "object",
|
|
273895
273895
|
"properties": {
|
|
@@ -274339,7 +274339,7 @@ var state = {
|
|
|
274339
274339
|
},
|
|
274340
274340
|
"section": "task",
|
|
274341
274341
|
"response": {
|
|
274342
|
-
"description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns
|
|
274342
|
+
"description": "Returns a [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
274343
274343
|
"schema": {
|
|
274344
274344
|
"type": "object",
|
|
274345
274345
|
"properties": {
|
|
@@ -274421,7 +274421,7 @@ var state = {
|
|
|
274421
274421
|
},
|
|
274422
274422
|
"section": "task",
|
|
274423
274423
|
"response": {
|
|
274424
|
-
"description": "Returns a [Task](#schema_task) object if creation succeeds. Returns
|
|
274424
|
+
"description": "Returns a [Task](#schema_task) object if creation succeeds. Returns an [Error](#errors) otherwise",
|
|
274425
274425
|
"status": 201,
|
|
274426
274426
|
"schema": {
|
|
274427
274427
|
"type": "object",
|
|
@@ -274503,7 +274503,7 @@ var state = {
|
|
|
274503
274503
|
},
|
|
274504
274504
|
"section": "task",
|
|
274505
274505
|
"response": {
|
|
274506
|
-
"description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns
|
|
274506
|
+
"description": "Returns an updated [Task](#schema_task) object if a valid identifier was provided. Returns an [Error](#errors) otherwise",
|
|
274507
274507
|
"schema": {
|
|
274508
274508
|
"type": "object",
|
|
274509
274509
|
"properties": {
|
|
@@ -274543,7 +274543,7 @@ var state = {
|
|
|
274543
274543
|
},
|
|
274544
274544
|
"listTasks": {
|
|
274545
274545
|
"name": "listTasks",
|
|
274546
|
-
"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](
|
|
274546
|
+
"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).",
|
|
274547
274547
|
"method": "get",
|
|
274548
274548
|
"path": "/v1/chat/tasks",
|
|
274549
274549
|
"parameters": {
|
|
@@ -282329,7 +282329,7 @@ var state = {
|
|
|
282329
282329
|
"title": "Botpress API",
|
|
282330
282330
|
"description": "API for Botpress Cloud",
|
|
282331
282331
|
"server": "https://api.botpress.cloud",
|
|
282332
|
-
"version": "0.27.
|
|
282332
|
+
"version": "0.27.8",
|
|
282333
282333
|
"prefix": "v1"
|
|
282334
282334
|
},
|
|
282335
282335
|
"errors": [
|