@chatbotkit/sdk 1.30.0 → 1.31.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.
- package/dist/cjs/space/index.cjs +2 -0
- package/dist/cjs/space/index.d.ts +2 -0
- package/dist/cjs/space/storage/index.cjs +30 -0
- package/dist/cjs/space/storage/index.d.ts +11 -0
- package/dist/cjs/space/storage/v1.cjs +52 -0
- package/dist/cjs/space/storage/v1.d.ts +20 -0
- package/dist/cjs/types/ability.d.ts +522 -36
- package/dist/cjs/types/api/v1.d.ts +420 -4
- package/dist/esm/space/index.d.ts +2 -0
- package/dist/esm/space/index.js +2 -0
- package/dist/esm/space/storage/index.d.ts +11 -0
- package/dist/esm/space/storage/index.js +26 -0
- package/dist/esm/space/storage/v1.d.ts +20 -0
- package/dist/esm/space/storage/v1.js +44 -0
- package/dist/esm/types/ability.d.ts +522 -36
- package/dist/esm/types/api/v1.d.ts +420 -4
- package/package.json +51 -1
|
@@ -111,7 +111,31 @@ export type CbkAbilityName = 'abort'
|
|
|
111
111
|
| 'pack/cbk/space/storage[read-only]'
|
|
112
112
|
| 'pack/file'
|
|
113
113
|
| 'pack/file[by-id]'
|
|
114
|
+
| 'pack/rating'
|
|
115
|
+
| 'pack/rating[by-bot-id]'
|
|
116
|
+
| 'pack/rating[contact]'
|
|
117
|
+
| 'pack/rating[contact][by-bot-id]'
|
|
114
118
|
| 'pack/shell'
|
|
119
|
+
| 'pack/task'
|
|
120
|
+
| 'pack/task[by-bot-id]'
|
|
121
|
+
| 'pack/task[contact]'
|
|
122
|
+
| 'pack/task[contact][by-bot-id]'
|
|
123
|
+
| 'rating/create'
|
|
124
|
+
| 'rating/create[by-bot-id]'
|
|
125
|
+
| 'rating/create[contact]'
|
|
126
|
+
| 'rating/create[contact][by-bot-id]'
|
|
127
|
+
| 'rating/delete'
|
|
128
|
+
| 'rating/delete[by-bot-id]'
|
|
129
|
+
| 'rating/delete[contact]'
|
|
130
|
+
| 'rating/delete[contact][by-bot-id]'
|
|
131
|
+
| 'rating/fetch'
|
|
132
|
+
| 'rating/fetch[by-bot-id]'
|
|
133
|
+
| 'rating/fetch[contact]'
|
|
134
|
+
| 'rating/fetch[contact][by-bot-id]'
|
|
135
|
+
| 'rating/list'
|
|
136
|
+
| 'rating/list[by-bot-id]'
|
|
137
|
+
| 'rating/list[contact]'
|
|
138
|
+
| 'rating/list[contact][by-bot-id]'
|
|
115
139
|
| 'search/images'
|
|
116
140
|
| 'search/news'
|
|
117
141
|
| 'search/videos'
|
|
@@ -164,17 +188,29 @@ export type CbkAbilityName = 'abort'
|
|
|
164
188
|
| 'space/update[by-id]'
|
|
165
189
|
| 'space/update[contact][by-id]'
|
|
166
190
|
| 'task/create'
|
|
191
|
+
| 'task/create[by-bot-id]'
|
|
167
192
|
| 'task/create[contact]'
|
|
168
|
-
| 'task/
|
|
169
|
-
| 'task/delete
|
|
170
|
-
| 'task/
|
|
171
|
-
| 'task/
|
|
193
|
+
| 'task/create[contact][by-bot-id]'
|
|
194
|
+
| 'task/delete'
|
|
195
|
+
| 'task/delete[by-bot-id]'
|
|
196
|
+
| 'task/delete[contact]'
|
|
197
|
+
| 'task/delete[contact][by-bot-id]'
|
|
198
|
+
| 'task/fetch'
|
|
199
|
+
| 'task/fetch[by-bot-id]'
|
|
200
|
+
| 'task/fetch[contact]'
|
|
201
|
+
| 'task/fetch[contact][by-bot-id]'
|
|
172
202
|
| 'task/list'
|
|
203
|
+
| 'task/list[by-bot-id]'
|
|
173
204
|
| 'task/list[contact]'
|
|
174
|
-
| 'task/
|
|
175
|
-
| 'task/run
|
|
176
|
-
| 'task/
|
|
177
|
-
| 'task/
|
|
205
|
+
| 'task/list[contact][by-bot-id]'
|
|
206
|
+
| 'task/run'
|
|
207
|
+
| 'task/run[by-bot-id]'
|
|
208
|
+
| 'task/run[contact]'
|
|
209
|
+
| 'task/run[contact][by-bot-id]'
|
|
210
|
+
| 'task/update'
|
|
211
|
+
| 'task/update[by-bot-id]'
|
|
212
|
+
| 'task/update[contact]'
|
|
213
|
+
| 'task/update[contact][by-bot-id]'
|
|
178
214
|
| 'telegram/conversation/start[by-id]'
|
|
179
215
|
| 'text/article/generate'
|
|
180
216
|
| 'text/email/generate'
|
|
@@ -221,6 +257,8 @@ export type AgentExecuteParameters = {
|
|
|
221
257
|
'@model'?: string
|
|
222
258
|
/** instructions for the task execution */
|
|
223
259
|
'@instructions'?: string
|
|
260
|
+
/** optional timeout in milliseconds */
|
|
261
|
+
timeout?: number
|
|
224
262
|
}
|
|
225
263
|
|
|
226
264
|
export type AgentTaskEvaluateParameters = {
|
|
@@ -230,6 +268,8 @@ export type AgentTaskEvaluateParameters = {
|
|
|
230
268
|
'@model'?: string
|
|
231
269
|
/** instructions for the evaluation */
|
|
232
270
|
'@instructions'?: string
|
|
271
|
+
/** optional timeout in milliseconds */
|
|
272
|
+
timeout?: number
|
|
233
273
|
}
|
|
234
274
|
|
|
235
275
|
export type AgentTaskPlanParameters = {
|
|
@@ -239,6 +279,8 @@ export type AgentTaskPlanParameters = {
|
|
|
239
279
|
'@model'?: string
|
|
240
280
|
/** instructions for the task plan */
|
|
241
281
|
'@instructions'?: string
|
|
282
|
+
/** optional timeout in milliseconds */
|
|
283
|
+
timeout?: number
|
|
242
284
|
}
|
|
243
285
|
|
|
244
286
|
export type AttachmentReadParameters = {
|
|
@@ -256,6 +298,8 @@ export type BlueprintResourceListParameters = {
|
|
|
256
298
|
export type BotAskParameters = {
|
|
257
299
|
/** the question to ask the bot */
|
|
258
300
|
question: string
|
|
301
|
+
/** optional timeout in milliseconds */
|
|
302
|
+
timeout?: number
|
|
259
303
|
}
|
|
260
304
|
|
|
261
305
|
export type BotAskByIdParameters = {
|
|
@@ -263,6 +307,8 @@ export type BotAskByIdParameters = {
|
|
|
263
307
|
botId: string
|
|
264
308
|
/** the question to ask the bot */
|
|
265
309
|
question: string
|
|
310
|
+
/** optional timeout in milliseconds */
|
|
311
|
+
timeout?: number
|
|
266
312
|
}
|
|
267
313
|
|
|
268
314
|
export type BotAskMultiParameters = {
|
|
@@ -270,6 +316,8 @@ export type BotAskMultiParameters = {
|
|
|
270
316
|
ids: string
|
|
271
317
|
/** the question to ask the bots */
|
|
272
318
|
question: string
|
|
319
|
+
/** optional timeout in milliseconds */
|
|
320
|
+
timeout?: number
|
|
273
321
|
}
|
|
274
322
|
|
|
275
323
|
export type BotBackstoryReadParameters = Record<string, never>
|
|
@@ -294,6 +342,8 @@ export type BotBackstoryWriteByIdParameters = {
|
|
|
294
342
|
export type BotCallParameters = {
|
|
295
343
|
/** detailed description of the action to be performed */
|
|
296
344
|
action: string
|
|
345
|
+
/** optional timeout in milliseconds */
|
|
346
|
+
timeout?: number
|
|
297
347
|
}
|
|
298
348
|
|
|
299
349
|
export type BotCallByIdParameters = {
|
|
@@ -301,6 +351,8 @@ export type BotCallByIdParameters = {
|
|
|
301
351
|
botId: string
|
|
302
352
|
/** detailed description of the action to be performed */
|
|
303
353
|
action: string
|
|
354
|
+
/** optional timeout in milliseconds */
|
|
355
|
+
timeout?: number
|
|
304
356
|
}
|
|
305
357
|
|
|
306
358
|
export type BotCallMultiParameters = {
|
|
@@ -308,6 +360,8 @@ export type BotCallMultiParameters = {
|
|
|
308
360
|
ids: string
|
|
309
361
|
/** detailed description of the action to be performed */
|
|
310
362
|
action: string
|
|
363
|
+
/** optional timeout in milliseconds */
|
|
364
|
+
timeout?: number
|
|
311
365
|
}
|
|
312
366
|
|
|
313
367
|
export type BotListParameters = {
|
|
@@ -837,8 +891,160 @@ export type PackFileParameters = Record<string, never>
|
|
|
837
891
|
|
|
838
892
|
export type PackFileByIdParameters = Record<string, never>
|
|
839
893
|
|
|
894
|
+
export type PackRatingParameters = Record<string, never>
|
|
895
|
+
|
|
896
|
+
export type PackRatingByBotIdParameters = Record<string, never>
|
|
897
|
+
|
|
898
|
+
export type PackRatingContactParameters = Record<string, never>
|
|
899
|
+
|
|
900
|
+
export type PackRatingContactByBotIdParameters = Record<string, never>
|
|
901
|
+
|
|
840
902
|
export type PackShellParameters = Record<string, never>
|
|
841
903
|
|
|
904
|
+
export type PackTaskParameters = Record<string, never>
|
|
905
|
+
|
|
906
|
+
export type PackTaskByBotIdParameters = Record<string, never>
|
|
907
|
+
|
|
908
|
+
export type PackTaskContactParameters = Record<string, never>
|
|
909
|
+
|
|
910
|
+
export type PackTaskContactByBotIdParameters = Record<string, never>
|
|
911
|
+
|
|
912
|
+
export type RatingCreateParameters = {
|
|
913
|
+
/** optional name of the rating */
|
|
914
|
+
name?: string
|
|
915
|
+
/** optional description of the rating */
|
|
916
|
+
description?: string
|
|
917
|
+
/** the numeric rating value */
|
|
918
|
+
value: number
|
|
919
|
+
/** optional reason for the rating */
|
|
920
|
+
reason?: string
|
|
921
|
+
/** optional conversation ID to associate with the rating */
|
|
922
|
+
conversationId?: string
|
|
923
|
+
/** optional message ID to associate with the rating */
|
|
924
|
+
messageId?: string
|
|
925
|
+
}
|
|
926
|
+
|
|
927
|
+
export type RatingCreateByBotIdParameters = {
|
|
928
|
+
/** optional bot ID to assign */
|
|
929
|
+
botId?: string
|
|
930
|
+
/** optional name of the rating */
|
|
931
|
+
name?: string
|
|
932
|
+
/** optional description of the rating */
|
|
933
|
+
description?: string
|
|
934
|
+
/** the numeric rating value */
|
|
935
|
+
value: number
|
|
936
|
+
/** optional reason for the rating */
|
|
937
|
+
reason?: string
|
|
938
|
+
/** optional conversation ID to associate with the rating */
|
|
939
|
+
conversationId?: string
|
|
940
|
+
/** optional message ID to associate with the rating */
|
|
941
|
+
messageId?: string
|
|
942
|
+
}
|
|
943
|
+
|
|
944
|
+
export type RatingCreateContactParameters = {
|
|
945
|
+
/** optional name of the rating */
|
|
946
|
+
name?: string
|
|
947
|
+
/** optional description of the rating */
|
|
948
|
+
description?: string
|
|
949
|
+
/** the numeric rating value */
|
|
950
|
+
value: number
|
|
951
|
+
/** optional reason for the rating */
|
|
952
|
+
reason?: string
|
|
953
|
+
/** optional conversation ID to associate with the rating */
|
|
954
|
+
conversationId?: string
|
|
955
|
+
/** optional message ID to associate with the rating */
|
|
956
|
+
messageId?: string
|
|
957
|
+
}
|
|
958
|
+
|
|
959
|
+
export type RatingCreateContactByBotIdParameters = {
|
|
960
|
+
/** optional bot ID to assign */
|
|
961
|
+
botId?: string
|
|
962
|
+
/** optional name of the rating */
|
|
963
|
+
name?: string
|
|
964
|
+
/** optional description of the rating */
|
|
965
|
+
description?: string
|
|
966
|
+
/** the numeric rating value */
|
|
967
|
+
value: number
|
|
968
|
+
/** optional reason for the rating */
|
|
969
|
+
reason?: string
|
|
970
|
+
/** optional conversation ID to associate with the rating */
|
|
971
|
+
conversationId?: string
|
|
972
|
+
/** optional message ID to associate with the rating */
|
|
973
|
+
messageId?: string
|
|
974
|
+
}
|
|
975
|
+
|
|
976
|
+
export type RatingDeleteParameters = {
|
|
977
|
+
/** the ID of the rating to delete */
|
|
978
|
+
ratingId: string
|
|
979
|
+
}
|
|
980
|
+
|
|
981
|
+
export type RatingDeleteByBotIdParameters = {
|
|
982
|
+
/** optional bot ID to scope by */
|
|
983
|
+
botId: string
|
|
984
|
+
/** the ID of the rating to delete */
|
|
985
|
+
ratingId: string
|
|
986
|
+
}
|
|
987
|
+
|
|
988
|
+
export type RatingDeleteContactParameters = {
|
|
989
|
+
/** the ID of the rating to delete */
|
|
990
|
+
ratingId: string
|
|
991
|
+
}
|
|
992
|
+
|
|
993
|
+
export type RatingDeleteContactByBotIdParameters = {
|
|
994
|
+
/** optional bot ID to scope by */
|
|
995
|
+
botId: string
|
|
996
|
+
/** the ID of the rating to delete */
|
|
997
|
+
ratingId: string
|
|
998
|
+
}
|
|
999
|
+
|
|
1000
|
+
export type RatingFetchParameters = {
|
|
1001
|
+
/** the ID of the rating to fetch */
|
|
1002
|
+
ratingId: string
|
|
1003
|
+
}
|
|
1004
|
+
|
|
1005
|
+
export type RatingFetchByBotIdParameters = {
|
|
1006
|
+
/** optional bot ID to scope by */
|
|
1007
|
+
botId: string
|
|
1008
|
+
/** the ID of the rating to fetch */
|
|
1009
|
+
ratingId: string
|
|
1010
|
+
}
|
|
1011
|
+
|
|
1012
|
+
export type RatingFetchContactParameters = {
|
|
1013
|
+
/** the ID of the rating to fetch */
|
|
1014
|
+
ratingId: string
|
|
1015
|
+
}
|
|
1016
|
+
|
|
1017
|
+
export type RatingFetchContactByBotIdParameters = {
|
|
1018
|
+
/** optional bot ID to scope by */
|
|
1019
|
+
botId: string
|
|
1020
|
+
/** the ID of the rating to fetch */
|
|
1021
|
+
ratingId: string
|
|
1022
|
+
}
|
|
1023
|
+
|
|
1024
|
+
export type RatingListParameters = {
|
|
1025
|
+
/** optional rating value to filter by */
|
|
1026
|
+
value?: number
|
|
1027
|
+
}
|
|
1028
|
+
|
|
1029
|
+
export type RatingListByBotIdParameters = {
|
|
1030
|
+
/** optional bot ID to scope by */
|
|
1031
|
+
botId: string
|
|
1032
|
+
/** optional rating value to filter by */
|
|
1033
|
+
value?: number
|
|
1034
|
+
}
|
|
1035
|
+
|
|
1036
|
+
export type RatingListContactParameters = {
|
|
1037
|
+
/** optional rating value to filter by */
|
|
1038
|
+
value?: number
|
|
1039
|
+
}
|
|
1040
|
+
|
|
1041
|
+
export type RatingListContactByBotIdParameters = {
|
|
1042
|
+
/** optional bot ID to scope by */
|
|
1043
|
+
botId: string
|
|
1044
|
+
/** optional rating value to filter by */
|
|
1045
|
+
value?: number
|
|
1046
|
+
}
|
|
1047
|
+
|
|
842
1048
|
export type SearchImagesParameters = {
|
|
843
1049
|
/** search query */
|
|
844
1050
|
query: string
|
|
@@ -1226,7 +1432,18 @@ export type TaskCreateParameters = {
|
|
|
1226
1432
|
name: string
|
|
1227
1433
|
/** a detailed description that captures all the necessary information to complete the task */
|
|
1228
1434
|
description: string
|
|
1229
|
-
/** optional schedule -
|
|
1435
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1436
|
+
schedule?: string
|
|
1437
|
+
}
|
|
1438
|
+
|
|
1439
|
+
export type TaskCreateByBotIdParameters = {
|
|
1440
|
+
/** optional bot ID to assign */
|
|
1441
|
+
botId?: string
|
|
1442
|
+
/** the name of the task */
|
|
1443
|
+
name: string
|
|
1444
|
+
/** a detailed description that captures all the necessary information to complete the task */
|
|
1445
|
+
description: string
|
|
1446
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1230
1447
|
schedule?: string
|
|
1231
1448
|
}
|
|
1232
1449
|
|
|
@@ -1235,63 +1452,152 @@ export type TaskCreateContactParameters = {
|
|
|
1235
1452
|
name: string
|
|
1236
1453
|
/** a detailed description that captures all the necessary information to complete the task */
|
|
1237
1454
|
description: string
|
|
1238
|
-
/** optional schedule -
|
|
1455
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1239
1456
|
schedule?: string
|
|
1240
1457
|
}
|
|
1241
1458
|
|
|
1242
|
-
export type
|
|
1459
|
+
export type TaskCreateContactByBotIdParameters = {
|
|
1460
|
+
/** optional bot ID to assign */
|
|
1461
|
+
botId?: string
|
|
1462
|
+
/** the name of the task */
|
|
1463
|
+
name: string
|
|
1464
|
+
/** a detailed description that captures all the necessary information to complete the task */
|
|
1465
|
+
description: string
|
|
1466
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1467
|
+
schedule?: string
|
|
1468
|
+
}
|
|
1469
|
+
|
|
1470
|
+
export type TaskDeleteParameters = {
|
|
1243
1471
|
/** the ID of the task to delete */
|
|
1244
1472
|
taskId: string
|
|
1245
1473
|
}
|
|
1246
1474
|
|
|
1247
|
-
export type
|
|
1475
|
+
export type TaskDeleteByBotIdParameters = {
|
|
1476
|
+
/** optional bot ID to scope by */
|
|
1477
|
+
botId: string
|
|
1248
1478
|
/** the ID of the task to delete */
|
|
1249
1479
|
taskId: string
|
|
1250
1480
|
}
|
|
1251
1481
|
|
|
1252
|
-
export type
|
|
1482
|
+
export type TaskDeleteContactParameters = {
|
|
1483
|
+
/** the ID of the task to delete */
|
|
1484
|
+
taskId: string
|
|
1485
|
+
}
|
|
1486
|
+
|
|
1487
|
+
export type TaskDeleteContactByBotIdParameters = {
|
|
1488
|
+
/** optional bot ID to scope by */
|
|
1489
|
+
botId: string
|
|
1490
|
+
/** the ID of the task to delete */
|
|
1491
|
+
taskId: string
|
|
1492
|
+
}
|
|
1493
|
+
|
|
1494
|
+
export type TaskFetchParameters = {
|
|
1495
|
+
/** the ID of the task to fetch */
|
|
1496
|
+
taskId: string
|
|
1497
|
+
}
|
|
1498
|
+
|
|
1499
|
+
export type TaskFetchByBotIdParameters = {
|
|
1500
|
+
/** optional bot ID to scope by */
|
|
1501
|
+
botId: string
|
|
1253
1502
|
/** the ID of the task to fetch */
|
|
1254
1503
|
taskId: string
|
|
1255
1504
|
}
|
|
1256
1505
|
|
|
1257
|
-
export type
|
|
1506
|
+
export type TaskFetchContactParameters = {
|
|
1507
|
+
/** the ID of the task to fetch */
|
|
1508
|
+
taskId: string
|
|
1509
|
+
}
|
|
1510
|
+
|
|
1511
|
+
export type TaskFetchContactByBotIdParameters = {
|
|
1512
|
+
/** optional bot ID to scope by */
|
|
1513
|
+
botId: string
|
|
1258
1514
|
/** the ID of the task to fetch */
|
|
1259
1515
|
taskId: string
|
|
1260
1516
|
}
|
|
1261
1517
|
|
|
1262
1518
|
export type TaskListParameters = Record<string, never>
|
|
1263
1519
|
|
|
1520
|
+
export type TaskListByBotIdParameters = {
|
|
1521
|
+
/** optional bot ID to scope by */
|
|
1522
|
+
botId: string
|
|
1523
|
+
}
|
|
1524
|
+
|
|
1264
1525
|
export type TaskListContactParameters = Record<string, never>
|
|
1265
1526
|
|
|
1266
|
-
export type
|
|
1527
|
+
export type TaskListContactByBotIdParameters = {
|
|
1528
|
+
/** optional bot ID to scope by */
|
|
1529
|
+
botId: string
|
|
1530
|
+
}
|
|
1531
|
+
|
|
1532
|
+
export type TaskRunParameters = {
|
|
1533
|
+
/** the ID of the task to run */
|
|
1534
|
+
taskId: string
|
|
1535
|
+
}
|
|
1536
|
+
|
|
1537
|
+
export type TaskRunByBotIdParameters = {
|
|
1538
|
+
/** optional bot ID to scope by */
|
|
1539
|
+
botId: string
|
|
1540
|
+
/** the ID of the task to run */
|
|
1541
|
+
taskId: string
|
|
1542
|
+
}
|
|
1543
|
+
|
|
1544
|
+
export type TaskRunContactParameters = {
|
|
1267
1545
|
/** the ID of the task to run */
|
|
1268
1546
|
taskId: string
|
|
1269
1547
|
}
|
|
1270
1548
|
|
|
1271
|
-
export type
|
|
1549
|
+
export type TaskRunContactByBotIdParameters = {
|
|
1550
|
+
/** optional bot ID to scope by */
|
|
1551
|
+
botId: string
|
|
1272
1552
|
/** the ID of the task to run */
|
|
1273
1553
|
taskId: string
|
|
1274
1554
|
}
|
|
1275
1555
|
|
|
1276
|
-
export type
|
|
1556
|
+
export type TaskUpdateParameters = {
|
|
1557
|
+
/** the ID of the task to update */
|
|
1558
|
+
taskId: string
|
|
1559
|
+
/** the updated name of the task */
|
|
1560
|
+
name: string
|
|
1561
|
+
/** an updated detailed description that captures all the necessary information to complete the task */
|
|
1562
|
+
description: string
|
|
1563
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1564
|
+
schedule?: string
|
|
1565
|
+
}
|
|
1566
|
+
|
|
1567
|
+
export type TaskUpdateByBotIdParameters = {
|
|
1568
|
+
/** optional bot ID to scope by */
|
|
1569
|
+
botId: string
|
|
1570
|
+
/** the ID of the task to update */
|
|
1571
|
+
taskId: string
|
|
1572
|
+
/** the updated name of the task */
|
|
1573
|
+
name: string
|
|
1574
|
+
/** an updated detailed description that captures all the necessary information to complete the task */
|
|
1575
|
+
description: string
|
|
1576
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1577
|
+
schedule?: string
|
|
1578
|
+
}
|
|
1579
|
+
|
|
1580
|
+
export type TaskUpdateContactParameters = {
|
|
1277
1581
|
/** the ID of the task to update */
|
|
1278
1582
|
taskId: string
|
|
1279
1583
|
/** the updated name of the task */
|
|
1280
1584
|
name: string
|
|
1281
1585
|
/** an updated detailed description that captures all the necessary information to complete the task */
|
|
1282
1586
|
description: string
|
|
1283
|
-
/** optional schedule -
|
|
1587
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1284
1588
|
schedule?: string
|
|
1285
1589
|
}
|
|
1286
1590
|
|
|
1287
|
-
export type
|
|
1591
|
+
export type TaskUpdateContactByBotIdParameters = {
|
|
1592
|
+
/** optional bot ID to scope by */
|
|
1593
|
+
botId: string
|
|
1288
1594
|
/** the ID of the task to update */
|
|
1289
1595
|
taskId: string
|
|
1290
1596
|
/** the updated name of the task */
|
|
1291
1597
|
name: string
|
|
1292
1598
|
/** an updated detailed description that captures all the necessary information to complete the task */
|
|
1293
1599
|
description: string
|
|
1294
|
-
/** optional schedule -
|
|
1600
|
+
/** optional schedule - now, 2027-12-31T23:59:59, quarterhourly, halfhourly, hourly, daily, weekly, monthly, 0 0 * * * */
|
|
1295
1601
|
schedule?: string
|
|
1296
1602
|
}
|
|
1297
1603
|
|
|
@@ -1932,11 +2238,131 @@ export interface CbkAbilityRegistry {
|
|
|
1932
2238
|
description: 'Installs file tools into the conversation to read, write, prepend, append, and replace content in files by specifying the file ID.'
|
|
1933
2239
|
parameters: PackFileByIdParameters
|
|
1934
2240
|
}
|
|
2241
|
+
'pack/rating': {
|
|
2242
|
+
name: 'Install Rating Tools'
|
|
2243
|
+
description: 'Installs rating tools scoped to the connected bot. You can list, create, fetch, and delete ratings.'
|
|
2244
|
+
parameters: PackRatingParameters
|
|
2245
|
+
}
|
|
2246
|
+
'pack/rating[by-bot-id]': {
|
|
2247
|
+
name: 'Install Rating Tools'
|
|
2248
|
+
description: 'Installs rating tools with dynamic bot scoping so ratings can be managed across accessible bots.'
|
|
2249
|
+
parameters: PackRatingByBotIdParameters
|
|
2250
|
+
}
|
|
2251
|
+
'pack/rating[contact]': {
|
|
2252
|
+
name: 'Install Contact Rating Tools'
|
|
2253
|
+
description: 'Installs rating tools scoped to the current contact and connected bot. Each contact can only access their own ratings.'
|
|
2254
|
+
parameters: PackRatingContactParameters
|
|
2255
|
+
}
|
|
2256
|
+
'pack/rating[contact][by-bot-id]': {
|
|
2257
|
+
name: 'Install Contact Rating Tools'
|
|
2258
|
+
description: 'Installs contact rating tools with dynamic bot scoping so a contact can work across accessible bots.'
|
|
2259
|
+
parameters: PackRatingContactByBotIdParameters
|
|
2260
|
+
}
|
|
1935
2261
|
'pack/shell': {
|
|
1936
2262
|
name: 'Install Shell Tools'
|
|
1937
2263
|
description: 'Installs shell tools into the conversation to execute commands and scripts.'
|
|
1938
2264
|
parameters: PackShellParameters
|
|
1939
2265
|
}
|
|
2266
|
+
'pack/task': {
|
|
2267
|
+
name: 'Install Task Management Tools'
|
|
2268
|
+
description: 'Installs all task management tools scoped to the connected bot. You can list, create, fetch, update, delete, and run tasks.'
|
|
2269
|
+
parameters: PackTaskParameters
|
|
2270
|
+
}
|
|
2271
|
+
'pack/task[by-bot-id]': {
|
|
2272
|
+
name: 'Install Task Management Tools'
|
|
2273
|
+
description: 'Installs all task management tools with dynamic bot scoping. You can manage tasks across any bot by specifying the bot ID.'
|
|
2274
|
+
parameters: PackTaskByBotIdParameters
|
|
2275
|
+
}
|
|
2276
|
+
'pack/task[contact]': {
|
|
2277
|
+
name: 'Install Contact Task Management Tools'
|
|
2278
|
+
description: 'Installs task management tools scoped to the current contact and connected bot. Each contact can only see and manage their own tasks.'
|
|
2279
|
+
parameters: PackTaskContactParameters
|
|
2280
|
+
}
|
|
2281
|
+
'pack/task[contact][by-bot-id]': {
|
|
2282
|
+
name: 'Install Contact Task Management Tools'
|
|
2283
|
+
description: 'Installs task management tools scoped to the current contact with dynamic bot scoping. Each contact can only see and manage their own tasks across any bot.'
|
|
2284
|
+
parameters: PackTaskContactByBotIdParameters
|
|
2285
|
+
}
|
|
2286
|
+
'rating/create': {
|
|
2287
|
+
name: 'Create Rating'
|
|
2288
|
+
description: 'Create a rating for the connected bot'
|
|
2289
|
+
parameters: RatingCreateParameters
|
|
2290
|
+
}
|
|
2291
|
+
'rating/create[by-bot-id]': {
|
|
2292
|
+
name: 'Create Rating'
|
|
2293
|
+
description: 'Create a rating with optional bot assignment'
|
|
2294
|
+
parameters: RatingCreateByBotIdParameters
|
|
2295
|
+
}
|
|
2296
|
+
'rating/create[contact]': {
|
|
2297
|
+
name: 'Create Contact Rating'
|
|
2298
|
+
description: 'Create a rating for the current contact and connected bot'
|
|
2299
|
+
parameters: RatingCreateContactParameters
|
|
2300
|
+
}
|
|
2301
|
+
'rating/create[contact][by-bot-id]': {
|
|
2302
|
+
name: 'Create Contact Rating'
|
|
2303
|
+
description: 'Create a contact rating with optional bot assignment'
|
|
2304
|
+
parameters: RatingCreateContactByBotIdParameters
|
|
2305
|
+
}
|
|
2306
|
+
'rating/delete': {
|
|
2307
|
+
name: 'Delete Rating'
|
|
2308
|
+
description: 'Delete a rating scoped to the connected bot'
|
|
2309
|
+
parameters: RatingDeleteParameters
|
|
2310
|
+
}
|
|
2311
|
+
'rating/delete[by-bot-id]': {
|
|
2312
|
+
name: 'Delete Rating'
|
|
2313
|
+
description: 'Delete a rating with optional bot scoping'
|
|
2314
|
+
parameters: RatingDeleteByBotIdParameters
|
|
2315
|
+
}
|
|
2316
|
+
'rating/delete[contact]': {
|
|
2317
|
+
name: 'Delete Contact Rating'
|
|
2318
|
+
description: 'Delete a rating for the current contact and connected bot'
|
|
2319
|
+
parameters: RatingDeleteContactParameters
|
|
2320
|
+
}
|
|
2321
|
+
'rating/delete[contact][by-bot-id]': {
|
|
2322
|
+
name: 'Delete Contact Rating'
|
|
2323
|
+
description: 'Delete a contact rating with optional bot scoping'
|
|
2324
|
+
parameters: RatingDeleteContactByBotIdParameters
|
|
2325
|
+
}
|
|
2326
|
+
'rating/fetch': {
|
|
2327
|
+
name: 'Fetch Rating'
|
|
2328
|
+
description: 'Fetch a rating scoped to the connected bot'
|
|
2329
|
+
parameters: RatingFetchParameters
|
|
2330
|
+
}
|
|
2331
|
+
'rating/fetch[by-bot-id]': {
|
|
2332
|
+
name: 'Fetch Rating'
|
|
2333
|
+
description: 'Fetch a rating with optional bot scoping'
|
|
2334
|
+
parameters: RatingFetchByBotIdParameters
|
|
2335
|
+
}
|
|
2336
|
+
'rating/fetch[contact]': {
|
|
2337
|
+
name: 'Fetch Contact Rating'
|
|
2338
|
+
description: 'Fetch a rating for the current contact and connected bot'
|
|
2339
|
+
parameters: RatingFetchContactParameters
|
|
2340
|
+
}
|
|
2341
|
+
'rating/fetch[contact][by-bot-id]': {
|
|
2342
|
+
name: 'Fetch Contact Rating'
|
|
2343
|
+
description: 'Fetch a contact rating with optional bot scoping'
|
|
2344
|
+
parameters: RatingFetchContactByBotIdParameters
|
|
2345
|
+
}
|
|
2346
|
+
'rating/list': {
|
|
2347
|
+
name: 'List Ratings'
|
|
2348
|
+
description: 'List ratings scoped to the connected bot'
|
|
2349
|
+
parameters: RatingListParameters
|
|
2350
|
+
}
|
|
2351
|
+
'rating/list[by-bot-id]': {
|
|
2352
|
+
name: 'List Ratings'
|
|
2353
|
+
description: 'List ratings with optional bot scoping'
|
|
2354
|
+
parameters: RatingListByBotIdParameters
|
|
2355
|
+
}
|
|
2356
|
+
'rating/list[contact]': {
|
|
2357
|
+
name: 'List Contact Ratings'
|
|
2358
|
+
description: 'List ratings for the current contact and connected bot'
|
|
2359
|
+
parameters: RatingListContactParameters
|
|
2360
|
+
}
|
|
2361
|
+
'rating/list[contact][by-bot-id]': {
|
|
2362
|
+
name: 'List Contact Ratings'
|
|
2363
|
+
description: 'List contact ratings with optional bot scoping'
|
|
2364
|
+
parameters: RatingListContactByBotIdParameters
|
|
2365
|
+
}
|
|
1940
2366
|
'search/images': {
|
|
1941
2367
|
name: 'Search Images'
|
|
1942
2368
|
description: 'Search the web for images based on specific keywords'
|
|
@@ -2197,60 +2623,120 @@ export interface CbkAbilityRegistry {
|
|
|
2197
2623
|
description: 'Create a task using details provided'
|
|
2198
2624
|
parameters: TaskCreateParameters
|
|
2199
2625
|
}
|
|
2626
|
+
'task/create[by-bot-id]': {
|
|
2627
|
+
name: 'Create Task'
|
|
2628
|
+
description: 'Create a task using details provided'
|
|
2629
|
+
parameters: TaskCreateByBotIdParameters
|
|
2630
|
+
}
|
|
2200
2631
|
'task/create[contact]': {
|
|
2201
2632
|
name: 'Create Task'
|
|
2202
2633
|
description: 'Create a task using details provided'
|
|
2203
2634
|
parameters: TaskCreateContactParameters
|
|
2204
2635
|
}
|
|
2205
|
-
'task/
|
|
2636
|
+
'task/create[contact][by-bot-id]': {
|
|
2637
|
+
name: 'Create Task'
|
|
2638
|
+
description: 'Create a task using details provided'
|
|
2639
|
+
parameters: TaskCreateContactByBotIdParameters
|
|
2640
|
+
}
|
|
2641
|
+
'task/delete': {
|
|
2642
|
+
name: 'Delete Task'
|
|
2643
|
+
description: 'Delete an existing task'
|
|
2644
|
+
parameters: TaskDeleteParameters
|
|
2645
|
+
}
|
|
2646
|
+
'task/delete[by-bot-id]': {
|
|
2647
|
+
name: 'Delete Task'
|
|
2648
|
+
description: 'Delete an existing task'
|
|
2649
|
+
parameters: TaskDeleteByBotIdParameters
|
|
2650
|
+
}
|
|
2651
|
+
'task/delete[contact]': {
|
|
2206
2652
|
name: 'Delete Task'
|
|
2207
2653
|
description: 'Delete an existing task'
|
|
2208
|
-
parameters:
|
|
2654
|
+
parameters: TaskDeleteContactParameters
|
|
2209
2655
|
}
|
|
2210
|
-
'task/delete[contact][by-id]': {
|
|
2656
|
+
'task/delete[contact][by-bot-id]': {
|
|
2211
2657
|
name: 'Delete Task'
|
|
2212
2658
|
description: 'Delete an existing task'
|
|
2213
|
-
parameters:
|
|
2659
|
+
parameters: TaskDeleteContactByBotIdParameters
|
|
2660
|
+
}
|
|
2661
|
+
'task/fetch': {
|
|
2662
|
+
name: 'Fetch Task'
|
|
2663
|
+
description: 'Fetch details of a specific task'
|
|
2664
|
+
parameters: TaskFetchParameters
|
|
2214
2665
|
}
|
|
2215
|
-
'task/fetch[by-id]': {
|
|
2666
|
+
'task/fetch[by-bot-id]': {
|
|
2216
2667
|
name: 'Fetch Task'
|
|
2217
2668
|
description: 'Fetch details of a specific task'
|
|
2218
|
-
parameters:
|
|
2669
|
+
parameters: TaskFetchByBotIdParameters
|
|
2219
2670
|
}
|
|
2220
|
-
'task/fetch[contact]
|
|
2671
|
+
'task/fetch[contact]': {
|
|
2221
2672
|
name: 'Fetch Task'
|
|
2222
2673
|
description: 'Fetch details of a specific task'
|
|
2223
|
-
parameters:
|
|
2674
|
+
parameters: TaskFetchContactParameters
|
|
2675
|
+
}
|
|
2676
|
+
'task/fetch[contact][by-bot-id]': {
|
|
2677
|
+
name: 'Fetch Task'
|
|
2678
|
+
description: 'Fetch details of a specific task'
|
|
2679
|
+
parameters: TaskFetchContactByBotIdParameters
|
|
2224
2680
|
}
|
|
2225
2681
|
'task/list': {
|
|
2226
2682
|
name: 'List Tasks'
|
|
2227
2683
|
description: 'List scheduled and one-time tasks'
|
|
2228
2684
|
parameters: TaskListParameters
|
|
2229
2685
|
}
|
|
2686
|
+
'task/list[by-bot-id]': {
|
|
2687
|
+
name: 'List Tasks'
|
|
2688
|
+
description: 'List scheduled and one-time tasks'
|
|
2689
|
+
parameters: TaskListByBotIdParameters
|
|
2690
|
+
}
|
|
2230
2691
|
'task/list[contact]': {
|
|
2231
2692
|
name: 'List Tasks'
|
|
2232
2693
|
description: 'List scheduled and one-time tasks'
|
|
2233
2694
|
parameters: TaskListContactParameters
|
|
2234
2695
|
}
|
|
2235
|
-
'task/
|
|
2696
|
+
'task/list[contact][by-bot-id]': {
|
|
2697
|
+
name: 'List Tasks'
|
|
2698
|
+
description: 'List scheduled and one-time tasks'
|
|
2699
|
+
parameters: TaskListContactByBotIdParameters
|
|
2700
|
+
}
|
|
2701
|
+
'task/run': {
|
|
2236
2702
|
name: 'Run Task'
|
|
2237
2703
|
description: 'Perform a single run of a task using the provided task ID'
|
|
2238
|
-
parameters:
|
|
2704
|
+
parameters: TaskRunParameters
|
|
2239
2705
|
}
|
|
2240
|
-
'task/run[
|
|
2706
|
+
'task/run[by-bot-id]': {
|
|
2241
2707
|
name: 'Run Task'
|
|
2242
2708
|
description: 'Perform a single run of a task using the provided task ID'
|
|
2243
|
-
parameters:
|
|
2709
|
+
parameters: TaskRunByBotIdParameters
|
|
2710
|
+
}
|
|
2711
|
+
'task/run[contact]': {
|
|
2712
|
+
name: 'Run Task'
|
|
2713
|
+
description: 'Perform a single run of a task using the provided task ID'
|
|
2714
|
+
parameters: TaskRunContactParameters
|
|
2715
|
+
}
|
|
2716
|
+
'task/run[contact][by-bot-id]': {
|
|
2717
|
+
name: 'Run Task'
|
|
2718
|
+
description: 'Perform a single run of a task using the provided task ID'
|
|
2719
|
+
parameters: TaskRunContactByBotIdParameters
|
|
2720
|
+
}
|
|
2721
|
+
'task/update': {
|
|
2722
|
+
name: 'Update Task'
|
|
2723
|
+
description: 'Update an existing task or to-do item'
|
|
2724
|
+
parameters: TaskUpdateParameters
|
|
2725
|
+
}
|
|
2726
|
+
'task/update[by-bot-id]': {
|
|
2727
|
+
name: 'Update Task'
|
|
2728
|
+
description: 'Update an existing task or to-do item'
|
|
2729
|
+
parameters: TaskUpdateByBotIdParameters
|
|
2244
2730
|
}
|
|
2245
|
-
'task/update[
|
|
2731
|
+
'task/update[contact]': {
|
|
2246
2732
|
name: 'Update Task'
|
|
2247
2733
|
description: 'Update an existing task or to-do item'
|
|
2248
|
-
parameters:
|
|
2734
|
+
parameters: TaskUpdateContactParameters
|
|
2249
2735
|
}
|
|
2250
|
-
'task/update[contact][by-id]': {
|
|
2736
|
+
'task/update[contact][by-bot-id]': {
|
|
2251
2737
|
name: 'Update Task'
|
|
2252
2738
|
description: 'Update an existing task or to-do item'
|
|
2253
|
-
parameters:
|
|
2739
|
+
parameters: TaskUpdateContactByBotIdParameters
|
|
2254
2740
|
}
|
|
2255
2741
|
'telegram/conversation/start[by-id]': {
|
|
2256
2742
|
name: 'Start Telegram Conversation'
|