@botpress/api 1.64.0 → 1.66.0

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 (4) hide show
  1. package/dist/index.js +245 -8
  2. package/dist/src/gen/runtime/state.d.ts +113 -0
  3. package/dist/src/gen/state.d.ts +94 -0
  4. package/package.json +3 -3
package/dist/index.js CHANGED
@@ -276890,6 +276890,131 @@ var state = {
276890
276890
  "documented"
276891
276891
  ]
276892
276892
  },
276893
+ "importMessages": {
276894
+ "name": "importMessages",
276895
+ "description": "Imports messages if no matching messages already exist. Returns the list of messages that were either created or retrieved.",
276896
+ "method": "post",
276897
+ "path": "/v1/chat/messages/import-messages",
276898
+ "requestBody": {
276899
+ "description": "Data for the list of messages to import",
276900
+ "schema": {
276901
+ "type": "object",
276902
+ "properties": {
276903
+ "messages": {
276904
+ "type": "array",
276905
+ "items": {
276906
+ "type": "object",
276907
+ "properties": {
276908
+ "payload": {
276909
+ "type": "object",
276910
+ "properties": {},
276911
+ "additionalProperties": true,
276912
+ "description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
276913
+ },
276914
+ "userId": {
276915
+ "type": "string",
276916
+ "minLength": 28,
276917
+ "maxLength": 36,
276918
+ "description": "ID of the [User](#schema_user)"
276919
+ },
276920
+ "conversationId": {
276921
+ "type": "string",
276922
+ "minLength": 28,
276923
+ "maxLength": 36,
276924
+ "description": "ID of the [Conversation](#schema_conversation)"
276925
+ },
276926
+ "type": {
276927
+ "type": "string",
276928
+ "maxLength": 200,
276929
+ "description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
276930
+ },
276931
+ "tags": {
276932
+ "type": "object",
276933
+ "additionalProperties": {
276934
+ "type": "string",
276935
+ "maxLength": 500
276936
+ },
276937
+ "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."
276938
+ },
276939
+ "createdAt": {
276940
+ "type": "string",
276941
+ "format": "date-time",
276942
+ "description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
276943
+ },
276944
+ "discriminateByTags": {
276945
+ "type": "array",
276946
+ "items": {
276947
+ "type": "string",
276948
+ "maxLength": 500
276949
+ },
276950
+ "description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
276951
+ }
276952
+ },
276953
+ "required": [
276954
+ "payload",
276955
+ "userId",
276956
+ "conversationId",
276957
+ "type",
276958
+ "tags",
276959
+ "createdAt",
276960
+ "discriminateByTags"
276961
+ ],
276962
+ "description": "Setting empty tags or discriminateByTags will always result in the creation of a new message"
276963
+ },
276964
+ "maxItems": 100
276965
+ }
276966
+ },
276967
+ "required": [
276968
+ "messages"
276969
+ ],
276970
+ "title": "importMessagesBody",
276971
+ "additionalProperties": false
276972
+ }
276973
+ },
276974
+ "section": "message",
276975
+ "response": {
276976
+ "description": "Returns the list of [Message](#schema_message) objects that were retrieved or created. Returns an [Error](#errors) otherwise",
276977
+ "schema": {
276978
+ "type": "object",
276979
+ "properties": {
276980
+ "messages": {
276981
+ "type": "array",
276982
+ "items": {
276983
+ "$ref": "#/components/schemas/Message"
276984
+ }
276985
+ }
276986
+ },
276987
+ "required": [
276988
+ "messages"
276989
+ ],
276990
+ "title": "importMessagesResponse",
276991
+ "additionalProperties": false
276992
+ }
276993
+ },
276994
+ "tags": [
276995
+ "experimental"
276996
+ ],
276997
+ "parameters": {
276998
+ "x-bot-id": {
276999
+ "in": "header",
277000
+ "description": "Bot id",
277001
+ "type": "string",
277002
+ "required": true
277003
+ },
277004
+ "x-integration-id": {
277005
+ "in": "header",
277006
+ "description": "Integration id",
277007
+ "type": "string",
277008
+ "required": false
277009
+ },
277010
+ "x-integration-alias": {
277011
+ "in": "header",
277012
+ "description": "Integration alias",
277013
+ "type": "string",
277014
+ "required": false
277015
+ }
277016
+ }
277017
+ },
276893
277018
  "createUser": {
276894
277019
  "name": "createUser",
276895
277020
  "description": "Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.",
@@ -279045,7 +279170,7 @@ var state = {
279045
279170
  "title": "Botpress Runtime API",
279046
279171
  "description": "API for Botpress Runtime",
279047
279172
  "server": "https://api.botpress.cloud",
279048
- "version": "1.64.0",
279173
+ "version": "1.66.0",
279049
279174
  "prefix": "v1"
279050
279175
  },
279051
279176
  "defaultParameters": {
@@ -279206,6 +279331,7 @@ var state = {
279206
279331
  "createMessageBody": true,
279207
279332
  "getOrCreateMessageBody": true,
279208
279333
  "updateMessageBody": true,
279334
+ "importMessagesBody": true,
279209
279335
  "createUserBody": true,
279210
279336
  "getOrCreateUserBody": true,
279211
279337
  "updateUserBody": true,
@@ -279243,6 +279369,7 @@ var state = {
279243
279369
  "updateMessageResponse": true,
279244
279370
  "listMessagesResponse": true,
279245
279371
  "deleteMessageResponse": true,
279372
+ "importMessagesResponse": true,
279246
279373
  "createUserResponse": true,
279247
279374
  "getUserResponse": true,
279248
279375
  "listUsersResponse": true,
@@ -279889,7 +280016,8 @@ var state = {
279889
280016
  "getMessage",
279890
280017
  "updateMessage",
279891
280018
  "listMessages",
279892
- "deleteMessage"
280019
+ "deleteMessage",
280020
+ "importMessages"
279893
280021
  ],
279894
280022
  "schema": "Message"
279895
280023
  },
@@ -295450,7 +295578,7 @@ var state2 = {
295450
295578
  "title": "Botpress Admin API",
295451
295579
  "description": "API for Botpress Cloud Manager",
295452
295580
  "server": "https://api.botpress.cloud",
295453
- "version": "1.64.0",
295581
+ "version": "1.66.0",
295454
295582
  "prefix": "v1"
295455
295583
  },
295456
295584
  "defaultParameters": {
@@ -300953,7 +301081,7 @@ var state3 = {
300953
301081
  "title": "Botpress Files API",
300954
301082
  "description": "API for Botpress Files",
300955
301083
  "server": "https://api.botpress.cloud",
300956
- "version": "1.64.0",
301084
+ "version": "1.66.0",
300957
301085
  "prefix": "v1"
300958
301086
  },
300959
301087
  "defaultParameters": {
@@ -303244,7 +303372,7 @@ var state4 = {
303244
303372
  "title": "Botpress Tables API",
303245
303373
  "description": "API for Botpress Tables",
303246
303374
  "server": "https://api.botpress.cloud",
303247
- "version": "1.64.0",
303375
+ "version": "1.66.0",
303248
303376
  "prefix": "v1"
303249
303377
  },
303250
303378
  "defaultParameters": {
@@ -305063,6 +305191,112 @@ var state5 = {
305063
305191
  "documented"
305064
305192
  ]
305065
305193
  },
305194
+ "importMessages": {
305195
+ "name": "importMessages",
305196
+ "description": "Imports messages if no matching messages already exist. Returns the list of messages that were either created or retrieved.",
305197
+ "method": "post",
305198
+ "path": "/v1/chat/messages/import-messages",
305199
+ "requestBody": {
305200
+ "description": "Data for the list of messages to import",
305201
+ "schema": {
305202
+ "type": "object",
305203
+ "properties": {
305204
+ "messages": {
305205
+ "type": "array",
305206
+ "items": {
305207
+ "type": "object",
305208
+ "properties": {
305209
+ "payload": {
305210
+ "type": "object",
305211
+ "properties": {},
305212
+ "additionalProperties": true,
305213
+ "description": "Payload is the content type of the message. Accepted payload options: Text, Image, Choice, Dropdown, Card, Carousel, File, Audio, Video, Location"
305214
+ },
305215
+ "userId": {
305216
+ "type": "string",
305217
+ "minLength": 28,
305218
+ "maxLength": 36,
305219
+ "description": "ID of the [User](#schema_user)"
305220
+ },
305221
+ "conversationId": {
305222
+ "type": "string",
305223
+ "minLength": 28,
305224
+ "maxLength": 36,
305225
+ "description": "ID of the [Conversation](#schema_conversation)"
305226
+ },
305227
+ "type": {
305228
+ "type": "string",
305229
+ "maxLength": 200,
305230
+ "description": "Type of the [Message](#schema_message) represents the resource type that the message is related to"
305231
+ },
305232
+ "tags": {
305233
+ "type": "object",
305234
+ "additionalProperties": {
305235
+ "type": "string",
305236
+ "maxLength": 500
305237
+ },
305238
+ "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."
305239
+ },
305240
+ "createdAt": {
305241
+ "type": "string",
305242
+ "format": "date-time",
305243
+ "description": "Creation date of the [Message](#schema_message) in ISO 8601 format"
305244
+ },
305245
+ "discriminateByTags": {
305246
+ "type": "array",
305247
+ "items": {
305248
+ "type": "string",
305249
+ "maxLength": 500
305250
+ },
305251
+ "description": 'Optional list of tag names to use for strict matching when looking up existing messages. If provided, all specified tags must match exactly for a message to be considered a match. For example, with an existing message whose tags are {"foo": "a", "bar": "b", baz: "c"}: Without this parameter, ALL tags must match exactly. With ["bar","baz"], all listed tags must match their values, and other tags are not considered.'
305252
+ }
305253
+ },
305254
+ "required": [
305255
+ "payload",
305256
+ "userId",
305257
+ "conversationId",
305258
+ "type",
305259
+ "tags",
305260
+ "createdAt",
305261
+ "discriminateByTags"
305262
+ ],
305263
+ "description": "Setting empty tags or discriminateByTags will always result in the creation of a new message"
305264
+ },
305265
+ "maxItems": 100
305266
+ }
305267
+ },
305268
+ "required": [
305269
+ "messages"
305270
+ ],
305271
+ "title": "importMessagesBody",
305272
+ "additionalProperties": false
305273
+ }
305274
+ },
305275
+ "section": "message",
305276
+ "response": {
305277
+ "description": "Returns the list of [Message](#schema_message) objects that were retrieved or created. Returns an [Error](#errors) otherwise",
305278
+ "schema": {
305279
+ "type": "object",
305280
+ "properties": {
305281
+ "messages": {
305282
+ "type": "array",
305283
+ "items": {
305284
+ "$ref": "#/components/schemas/Message"
305285
+ }
305286
+ }
305287
+ },
305288
+ "required": [
305289
+ "messages"
305290
+ ],
305291
+ "title": "importMessagesResponse",
305292
+ "additionalProperties": false
305293
+ }
305294
+ },
305295
+ "tags": [
305296
+ "experimental"
305297
+ ],
305298
+ "parameters": {}
305299
+ },
305066
305300
  "createUser": {
305067
305301
  "name": "createUser",
305068
305302
  "description": "Creates a new [User](#schema_user). When creating a new [User](#schema_user), the required tags must be provided. See the specific integration for more details.",
@@ -324356,7 +324590,7 @@ var state5 = {
324356
324590
  "title": "Botpress API",
324357
324591
  "description": "API for Botpress Cloud",
324358
324592
  "server": "https://api.botpress.cloud",
324359
- "version": "1.64.0",
324593
+ "version": "1.66.0",
324360
324594
  "prefix": "v1"
324361
324595
  },
324362
324596
  "errors": [
@@ -324497,6 +324731,7 @@ var state5 = {
324497
324731
  "createMessageBody": true,
324498
324732
  "getOrCreateMessageBody": true,
324499
324733
  "updateMessageBody": true,
324734
+ "importMessagesBody": true,
324500
324735
  "createUserBody": true,
324501
324736
  "getOrCreateUserBody": true,
324502
324737
  "updateUserBody": true,
@@ -324584,6 +324819,7 @@ var state5 = {
324584
324819
  "updateMessageResponse": true,
324585
324820
  "listMessagesResponse": true,
324586
324821
  "deleteMessageResponse": true,
324822
+ "importMessagesResponse": true,
324587
324823
  "createUserResponse": true,
324588
324824
  "getUserResponse": true,
324589
324825
  "listUsersResponse": true,
@@ -328468,7 +328704,8 @@ var state5 = {
328468
328704
  "getMessage",
328469
328705
  "updateMessage",
328470
328706
  "listMessages",
328471
- "deleteMessage"
328707
+ "deleteMessage",
328708
+ "importMessages"
328472
328709
  ],
328473
328710
  "schema": "Message"
328474
328711
  },
@@ -329598,7 +329835,7 @@ var state6 = {
329598
329835
  "title": "Botpress Billing Public API",
329599
329836
  "description": "API for Botpress Billing",
329600
329837
  "server": "https://api.botpress.cloud",
329601
- "version": "1.64.0",
329838
+ "version": "1.66.0",
329602
329839
  "prefix": "v2"
329603
329840
  },
329604
329841
  "defaultParameters": {
package/dist/src/gen/runtime/state.d.ts CHANGED
@@ -1390,6 +1390,117 @@ export declare const state: {
1390
1390
  };
1391
1391
  tags: string[];
1392
1392
  };
1393
+ importMessages: {
1394
+ name: string;
1395
+ description: string;
1396
+ method: "post";
1397
+ path: string;
1398
+ requestBody: {
1399
+ description: string;
1400
+ schema: {
1401
+ type: "object";
1402
+ properties: {
1403
+ messages: {
1404
+ type: "array";
1405
+ items: {
1406
+ type: "object";
1407
+ properties: {
1408
+ payload: {
1409
+ type: "object";
1410
+ properties: {};
1411
+ additionalProperties: true;
1412
+ description: string;
1413
+ };
1414
+ userId: {
1415
+ type: "string";
1416
+ minLength: number;
1417
+ maxLength: number;
1418
+ description: string;
1419
+ };
1420
+ conversationId: {
1421
+ type: "string";
1422
+ minLength: number;
1423
+ maxLength: number;
1424
+ description: string;
1425
+ };
1426
+ type: {
1427
+ type: "string";
1428
+ maxLength: number;
1429
+ description: string;
1430
+ };
1431
+ tags: {
1432
+ type: "object";
1433
+ additionalProperties: {
1434
+ type: "string";
1435
+ maxLength: number;
1436
+ };
1437
+ description: string;
1438
+ };
1439
+ createdAt: {
1440
+ type: "string";
1441
+ format: string;
1442
+ description: string;
1443
+ };
1444
+ discriminateByTags: {
1445
+ type: "array";
1446
+ items: {
1447
+ type: "string";
1448
+ maxLength: number;
1449
+ };
1450
+ description: string;
1451
+ };
1452
+ };
1453
+ required: string[];
1454
+ description: string;
1455
+ };
1456
+ maxItems: number;
1457
+ };
1458
+ };
1459
+ required: string[];
1460
+ title: string;
1461
+ additionalProperties: false;
1462
+ };
1463
+ };
1464
+ section: "message";
1465
+ response: {
1466
+ description: string;
1467
+ schema: {
1468
+ type: "object";
1469
+ properties: {
1470
+ messages: {
1471
+ type: "array";
1472
+ items: {
1473
+ $ref: string;
1474
+ };
1475
+ };
1476
+ };
1477
+ required: string[];
1478
+ title: string;
1479
+ additionalProperties: false;
1480
+ };
1481
+ };
1482
+ tags: string[];
1483
+ parameters: {
1484
+ "x-bot-id": {
1485
+ in: "header";
1486
+ description: string;
1487
+ type: "string";
1488
+ required: true;
1489
+ };
1490
+ "x-integration-id": {
1491
+ in: "header";
1492
+ description: string;
1493
+ type: "string";
1494
+ required: false;
1495
+ };
1496
+ "x-integration-alias": {
1497
+ in: "header";
1498
+ description: string;
1499
+ type: "string";
1500
+ required: false;
1501
+ };
1502
+ };
1503
+ };
1393
1504
  createUser: {
1394
1505
  name: string;
1395
1506
  description: string;
@@ -3414,6 +3525,7 @@ export declare const state: {
3414
3525
  createMessageBody: true;
3415
3526
  getOrCreateMessageBody: true;
3416
3527
  updateMessageBody: true;
3528
+ importMessagesBody: true;
3417
3529
  createUserBody: true;
3418
3530
  getOrCreateUserBody: true;
3419
3531
  updateUserBody: true;
@@ -3451,6 +3563,7 @@ export declare const state: {
3451
3563
  updateMessageResponse: true;
3452
3564
  listMessagesResponse: true;
3453
3565
  deleteMessageResponse: true;
3566
+ importMessagesResponse: true;
3454
3567
  createUserResponse: true;
3455
3568
  getUserResponse: true;
3456
3569
  listUsersResponse: true;
package/dist/src/gen/state.d.ts CHANGED
@@ -1025,6 +1025,98 @@ export declare const state: {
1025
1025
  };
1026
1026
  tags: string[];
1027
1027
  };
1028
+ importMessages: {
1029
+ name: string;
1030
+ description: string;
1031
+ method: "post";
1032
+ path: string;
1033
+ requestBody: {
1034
+ description: string;
1035
+ schema: {
1036
+ type: "object";
1037
+ properties: {
1038
+ messages: {
1039
+ type: "array";
1040
+ items: {
1041
+ type: "object";
1042
+ properties: {
1043
+ payload: {
1044
+ type: "object";
1045
+ properties: {};
1046
+ additionalProperties: true;
1047
+ description: string;
1048
+ };
1049
+ userId: {
1050
+ type: "string";
1051
+ minLength: number;
1052
+ maxLength: number;
1053
+ description: string;
1054
+ };
1055
+ conversationId: {
1056
+ type: "string";
1057
+ minLength: number;
1058
+ maxLength: number;
1059
+ description: string;
1060
+ };
1061
+ type: {
1062
+ type: "string";
1063
+ maxLength: number;
1064
+ description: string;
1065
+ };
1066
+ tags: {
1067
+ type: "object";
1068
+ additionalProperties: {
1069
+ type: "string";
1070
+ maxLength: number;
1071
+ };
1072
+ description: string;
1073
+ };
1074
+ createdAt: {
1075
+ type: "string";
1076
+ format: string;
1077
+ description: string;
1078
+ };
1079
+ discriminateByTags: {
1080
+ type: "array";
1081
+ items: {
1082
+ type: "string";
1083
+ maxLength: number;
1084
+ };
1085
+ description: string;
1086
+ };
1087
+ };
1088
+ required: string[];
1089
+ description: string;
1090
+ };
1091
+ maxItems: number;
1092
+ };
1093
+ };
1094
+ required: string[];
1095
+ title: string;
1096
+ additionalProperties: false;
1097
+ };
1098
+ };
1099
+ section: "message";
1100
+ response: {
1101
+ description: string;
1102
+ schema: {
1103
+ type: "object";
1104
+ properties: {
1105
+ messages: {
1106
+ type: "array";
1107
+ items: {
1108
+ $ref: string;
1109
+ };
1110
+ };
1111
+ };
1112
+ required: string[];
1113
+ title: string;
1114
+ additionalProperties: false;
1115
+ };
1116
+ };
1117
+ tags: string[];
1118
+ parameters: {};
1119
+ };
1028
1120
  createUser: {
1029
1121
  name: string;
1030
1122
  description: string;
@@ -17835,6 +17927,7 @@ export declare const state: {
17835
17927
  createMessageBody: true;
17836
17928
  getOrCreateMessageBody: true;
17837
17929
  updateMessageBody: true;
17930
+ importMessagesBody: true;
17838
17931
  createUserBody: true;
17839
17932
  getOrCreateUserBody: true;
17840
17933
  updateUserBody: true;
@@ -17922,6 +18015,7 @@ export declare const state: {
17922
18015
  updateMessageResponse: true;
17923
18016
  listMessagesResponse: true;
17924
18017
  deleteMessageResponse: true;
18018
+ importMessagesResponse: true;
17925
18019
  createUserResponse: true;
17926
18020
  getUserResponse: true;
17927
18021
  listUsersResponse: true;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@botpress/api",
3
- "version": "1.64.0",
3
+ "version": "1.66.0",
4
4
  "main": "dist/index.js",
5
5
  "types": "dist/src/index.d.ts",
6
6
  "devDependencies": {
@@ -13,8 +13,8 @@
13
13
  "@botpress/common": "0.5.0",
14
14
  "@botpress/files-api": "0.18.0",
15
15
  "@bpinternal/const": "0.4.1",
16
- "@bpinternal/tables-api": "0.17.2",
17
- "@botpress/smaug": "1.0.0"
16
+ "@botpress/smaug": "1.0.0",
17
+ "@bpinternal/tables-api": "0.17.2"
18
18
  },
19
19
  "dependencies": {
20
20
  "@bpinternal/opapi": "1.0.0"