@botpress/api 0.3.0 → 0.3.2
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/gen/state.d.ts +445 -0
- package/dist/index.js +1554 -2114
- package/package.json +1 -1
- package/src/gen/metadata.json +1 -1
- package/src/gen/openapi.json +1 -1
- package/src/gen/state.ts +513 -4
package/src/gen/state.ts
CHANGED
|
@@ -460,7 +460,7 @@ export const state = {
|
|
|
460
460
|
maxLength: 500,
|
|
461
461
|
},
|
|
462
462
|
description:
|
|
463
|
-
"Set of [Tags](#tags) that you can attach to a [
|
|
463
|
+
"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.",
|
|
464
464
|
},
|
|
465
465
|
schedule: {
|
|
466
466
|
type: "object",
|
|
@@ -542,7 +542,7 @@ export const state = {
|
|
|
542
542
|
maxLength: 500,
|
|
543
543
|
},
|
|
544
544
|
description:
|
|
545
|
-
"Set of [Tags](#tags) that you can attach to a [
|
|
545
|
+
"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.",
|
|
546
546
|
},
|
|
547
547
|
schedule: {
|
|
548
548
|
type: "object",
|
|
@@ -1471,6 +1471,16 @@ export const state = {
|
|
|
1471
1471
|
additionalProperties: {
|
|
1472
1472
|
type: "object",
|
|
1473
1473
|
properties: {
|
|
1474
|
+
title: {
|
|
1475
|
+
type: "string",
|
|
1476
|
+
maxLength: 64,
|
|
1477
|
+
description: "Title of the event",
|
|
1478
|
+
},
|
|
1479
|
+
description: {
|
|
1480
|
+
type: "string",
|
|
1481
|
+
maxLength: 256,
|
|
1482
|
+
description: "Description of the event",
|
|
1483
|
+
},
|
|
1474
1484
|
schema: {
|
|
1475
1485
|
type: "object",
|
|
1476
1486
|
additionalProperties: true,
|
|
@@ -1537,10 +1547,12 @@ export const state = {
|
|
|
1537
1547
|
properties: {
|
|
1538
1548
|
title: {
|
|
1539
1549
|
type: "string",
|
|
1550
|
+
maxLength: 64,
|
|
1540
1551
|
description: "Title of the tag",
|
|
1541
1552
|
},
|
|
1542
1553
|
description: {
|
|
1543
1554
|
type: "string",
|
|
1555
|
+
maxLength: 256,
|
|
1544
1556
|
description: "Description of the tag",
|
|
1545
1557
|
},
|
|
1546
1558
|
},
|
|
@@ -1562,10 +1574,12 @@ export const state = {
|
|
|
1562
1574
|
properties: {
|
|
1563
1575
|
title: {
|
|
1564
1576
|
type: "string",
|
|
1577
|
+
maxLength: 64,
|
|
1565
1578
|
description: "Title of the tag",
|
|
1566
1579
|
},
|
|
1567
1580
|
description: {
|
|
1568
1581
|
type: "string",
|
|
1582
|
+
maxLength: 256,
|
|
1569
1583
|
description: "Description of the tag",
|
|
1570
1584
|
},
|
|
1571
1585
|
},
|
|
@@ -1587,10 +1601,12 @@ export const state = {
|
|
|
1587
1601
|
properties: {
|
|
1588
1602
|
title: {
|
|
1589
1603
|
type: "string",
|
|
1604
|
+
maxLength: 64,
|
|
1590
1605
|
description: "Title of the tag",
|
|
1591
1606
|
},
|
|
1592
1607
|
description: {
|
|
1593
1608
|
type: "string",
|
|
1609
|
+
maxLength: 256,
|
|
1594
1610
|
description: "Description of the tag",
|
|
1595
1611
|
},
|
|
1596
1612
|
},
|
|
@@ -1718,10 +1734,12 @@ export const state = {
|
|
|
1718
1734
|
properties: {
|
|
1719
1735
|
title: {
|
|
1720
1736
|
type: "string",
|
|
1737
|
+
maxLength: 64,
|
|
1721
1738
|
description: "Title of the tag",
|
|
1722
1739
|
},
|
|
1723
1740
|
description: {
|
|
1724
1741
|
type: "string",
|
|
1742
|
+
maxLength: 256,
|
|
1725
1743
|
description: "Description of the tag",
|
|
1726
1744
|
},
|
|
1727
1745
|
},
|
|
@@ -1744,10 +1762,12 @@ export const state = {
|
|
|
1744
1762
|
properties: {
|
|
1745
1763
|
title: {
|
|
1746
1764
|
type: "string",
|
|
1765
|
+
maxLength: 64,
|
|
1747
1766
|
description: "Title of the tag",
|
|
1748
1767
|
},
|
|
1749
1768
|
description: {
|
|
1750
1769
|
type: "string",
|
|
1770
|
+
maxLength: 256,
|
|
1751
1771
|
description: "Description of the tag",
|
|
1752
1772
|
},
|
|
1753
1773
|
},
|
|
@@ -1770,10 +1790,12 @@ export const state = {
|
|
|
1770
1790
|
properties: {
|
|
1771
1791
|
title: {
|
|
1772
1792
|
type: "string",
|
|
1793
|
+
maxLength: 64,
|
|
1773
1794
|
description: "Title of the tag",
|
|
1774
1795
|
},
|
|
1775
1796
|
description: {
|
|
1776
1797
|
type: "string",
|
|
1798
|
+
maxLength: 256,
|
|
1777
1799
|
description: "Description of the tag",
|
|
1778
1800
|
},
|
|
1779
1801
|
},
|
|
@@ -1791,6 +1813,16 @@ export const state = {
|
|
|
1791
1813
|
additionalProperties: {
|
|
1792
1814
|
type: "object",
|
|
1793
1815
|
properties: {
|
|
1816
|
+
title: {
|
|
1817
|
+
type: "string",
|
|
1818
|
+
maxLength: 64,
|
|
1819
|
+
description: "Title of the event",
|
|
1820
|
+
},
|
|
1821
|
+
description: {
|
|
1822
|
+
type: "string",
|
|
1823
|
+
maxLength: 256,
|
|
1824
|
+
description: "Description of the event",
|
|
1825
|
+
},
|
|
1794
1826
|
schema: {
|
|
1795
1827
|
type: "object",
|
|
1796
1828
|
additionalProperties: true,
|
|
@@ -2271,8 +2303,12 @@ export const state = {
|
|
|
2271
2303
|
updatedAt: {
|
|
2272
2304
|
type: "string",
|
|
2273
2305
|
},
|
|
2306
|
+
botCount: {
|
|
2307
|
+
type: "number",
|
|
2308
|
+
},
|
|
2274
2309
|
accountType: {
|
|
2275
2310
|
type: "string",
|
|
2311
|
+
enum: ["free", "premium"],
|
|
2276
2312
|
},
|
|
2277
2313
|
blocked: {
|
|
2278
2314
|
type: "boolean",
|
|
@@ -2287,6 +2323,7 @@ export const state = {
|
|
|
2287
2323
|
"ownerId",
|
|
2288
2324
|
"createdAt",
|
|
2289
2325
|
"updatedAt",
|
|
2326
|
+
"botCount",
|
|
2290
2327
|
"accountType",
|
|
2291
2328
|
"blocked",
|
|
2292
2329
|
"spendingLimit",
|
|
@@ -2296,6 +2333,92 @@ export const state = {
|
|
|
2296
2333
|
},
|
|
2297
2334
|
},
|
|
2298
2335
|
},
|
|
2336
|
+
updateWorkspace: {
|
|
2337
|
+
name: "updateWorkspace",
|
|
2338
|
+
description: "Update workspace",
|
|
2339
|
+
method: "put",
|
|
2340
|
+
path: "/v1/admin/workspaces/{id}",
|
|
2341
|
+
parameters: {
|
|
2342
|
+
id: {
|
|
2343
|
+
type: "string",
|
|
2344
|
+
description: "Workspace ID",
|
|
2345
|
+
in: "path",
|
|
2346
|
+
},
|
|
2347
|
+
},
|
|
2348
|
+
requestBody: {
|
|
2349
|
+
description: "Workspace metadata",
|
|
2350
|
+
schema: {
|
|
2351
|
+
type: "object",
|
|
2352
|
+
properties: {
|
|
2353
|
+
name: {
|
|
2354
|
+
type: "string",
|
|
2355
|
+
minLength: 1,
|
|
2356
|
+
maxLength: 64,
|
|
2357
|
+
},
|
|
2358
|
+
accountType: {
|
|
2359
|
+
type: "string",
|
|
2360
|
+
enum: ["free", "premium"],
|
|
2361
|
+
},
|
|
2362
|
+
spendingLimit: {
|
|
2363
|
+
type: "number",
|
|
2364
|
+
minimum: 5,
|
|
2365
|
+
maximum: 1000,
|
|
2366
|
+
},
|
|
2367
|
+
},
|
|
2368
|
+
title: "updateWorkspaceBody",
|
|
2369
|
+
additionalProperties: false,
|
|
2370
|
+
},
|
|
2371
|
+
},
|
|
2372
|
+
response: {
|
|
2373
|
+
description: "Success",
|
|
2374
|
+
schema: {
|
|
2375
|
+
type: "object",
|
|
2376
|
+
properties: {
|
|
2377
|
+
id: {
|
|
2378
|
+
type: "string",
|
|
2379
|
+
},
|
|
2380
|
+
name: {
|
|
2381
|
+
type: "string",
|
|
2382
|
+
},
|
|
2383
|
+
ownerId: {
|
|
2384
|
+
type: "string",
|
|
2385
|
+
},
|
|
2386
|
+
createdAt: {
|
|
2387
|
+
type: "string",
|
|
2388
|
+
},
|
|
2389
|
+
updatedAt: {
|
|
2390
|
+
type: "string",
|
|
2391
|
+
},
|
|
2392
|
+
botCount: {
|
|
2393
|
+
type: "number",
|
|
2394
|
+
},
|
|
2395
|
+
accountType: {
|
|
2396
|
+
type: "string",
|
|
2397
|
+
enum: ["free", "premium"],
|
|
2398
|
+
},
|
|
2399
|
+
blocked: {
|
|
2400
|
+
type: "boolean",
|
|
2401
|
+
},
|
|
2402
|
+
spendingLimit: {
|
|
2403
|
+
type: "number",
|
|
2404
|
+
},
|
|
2405
|
+
},
|
|
2406
|
+
required: [
|
|
2407
|
+
"id",
|
|
2408
|
+
"name",
|
|
2409
|
+
"ownerId",
|
|
2410
|
+
"createdAt",
|
|
2411
|
+
"updatedAt",
|
|
2412
|
+
"botCount",
|
|
2413
|
+
"accountType",
|
|
2414
|
+
"blocked",
|
|
2415
|
+
"spendingLimit",
|
|
2416
|
+
],
|
|
2417
|
+
title: "updateWorkspaceResponse",
|
|
2418
|
+
additionalProperties: false,
|
|
2419
|
+
},
|
|
2420
|
+
},
|
|
2421
|
+
},
|
|
2299
2422
|
listWorkspaces: {
|
|
2300
2423
|
name: "listWorkspaces",
|
|
2301
2424
|
description: "List workspaces the user has access to",
|
|
@@ -2337,8 +2460,23 @@ export const state = {
|
|
|
2337
2460
|
updatedAt: {
|
|
2338
2461
|
type: "string",
|
|
2339
2462
|
},
|
|
2463
|
+
botCount: {
|
|
2464
|
+
type: "number",
|
|
2465
|
+
},
|
|
2466
|
+
accountType: {
|
|
2467
|
+
type: "string",
|
|
2468
|
+
enum: ["free", "premium"],
|
|
2469
|
+
},
|
|
2340
2470
|
},
|
|
2341
|
-
required: [
|
|
2471
|
+
required: [
|
|
2472
|
+
"id",
|
|
2473
|
+
"name",
|
|
2474
|
+
"ownerId",
|
|
2475
|
+
"createdAt",
|
|
2476
|
+
"updatedAt",
|
|
2477
|
+
"botCount",
|
|
2478
|
+
"accountType",
|
|
2479
|
+
],
|
|
2342
2480
|
},
|
|
2343
2481
|
},
|
|
2344
2482
|
meta: {
|
|
@@ -2420,6 +2558,16 @@ export const state = {
|
|
|
2420
2558
|
additionalProperties: {
|
|
2421
2559
|
type: "object",
|
|
2422
2560
|
properties: {
|
|
2561
|
+
title: {
|
|
2562
|
+
type: "string",
|
|
2563
|
+
maxLength: 64,
|
|
2564
|
+
description: "Title of the event",
|
|
2565
|
+
},
|
|
2566
|
+
description: {
|
|
2567
|
+
type: "string",
|
|
2568
|
+
maxLength: 256,
|
|
2569
|
+
description: "Description of the event",
|
|
2570
|
+
},
|
|
2423
2571
|
schema: {
|
|
2424
2572
|
type: "object",
|
|
2425
2573
|
additionalProperties: true,
|
|
@@ -2435,6 +2583,16 @@ export const state = {
|
|
|
2435
2583
|
additionalProperties: {
|
|
2436
2584
|
type: "object",
|
|
2437
2585
|
properties: {
|
|
2586
|
+
title: {
|
|
2587
|
+
type: "string",
|
|
2588
|
+
maxLength: 64,
|
|
2589
|
+
description: "Title of the action",
|
|
2590
|
+
},
|
|
2591
|
+
description: {
|
|
2592
|
+
type: "string",
|
|
2593
|
+
maxLength: 256,
|
|
2594
|
+
description: "Description of the action",
|
|
2595
|
+
},
|
|
2438
2596
|
input: {
|
|
2439
2597
|
type: "object",
|
|
2440
2598
|
properties: {
|
|
@@ -2468,6 +2626,16 @@ export const state = {
|
|
|
2468
2626
|
additionalProperties: {
|
|
2469
2627
|
type: "object",
|
|
2470
2628
|
properties: {
|
|
2629
|
+
title: {
|
|
2630
|
+
type: "string",
|
|
2631
|
+
maxLength: 64,
|
|
2632
|
+
description: "Title of the channel",
|
|
2633
|
+
},
|
|
2634
|
+
description: {
|
|
2635
|
+
type: "string",
|
|
2636
|
+
maxLength: 256,
|
|
2637
|
+
description: "Description of the channel",
|
|
2638
|
+
},
|
|
2471
2639
|
messages: {
|
|
2472
2640
|
type: "object",
|
|
2473
2641
|
additionalProperties: {
|
|
@@ -2514,10 +2682,12 @@ export const state = {
|
|
|
2514
2682
|
properties: {
|
|
2515
2683
|
title: {
|
|
2516
2684
|
type: "string",
|
|
2685
|
+
maxLength: 64,
|
|
2517
2686
|
description: "Title of the tag",
|
|
2518
2687
|
},
|
|
2519
2688
|
description: {
|
|
2520
2689
|
type: "string",
|
|
2690
|
+
maxLength: 256,
|
|
2521
2691
|
description: "Description of the tag",
|
|
2522
2692
|
},
|
|
2523
2693
|
},
|
|
@@ -2539,10 +2709,12 @@ export const state = {
|
|
|
2539
2709
|
properties: {
|
|
2540
2710
|
title: {
|
|
2541
2711
|
type: "string",
|
|
2712
|
+
maxLength: 64,
|
|
2542
2713
|
description: "Title of the tag",
|
|
2543
2714
|
},
|
|
2544
2715
|
description: {
|
|
2545
2716
|
type: "string",
|
|
2717
|
+
maxLength: 256,
|
|
2546
2718
|
description: "Description of the tag",
|
|
2547
2719
|
},
|
|
2548
2720
|
},
|
|
@@ -2590,10 +2762,12 @@ export const state = {
|
|
|
2590
2762
|
properties: {
|
|
2591
2763
|
title: {
|
|
2592
2764
|
type: "string",
|
|
2765
|
+
maxLength: 64,
|
|
2593
2766
|
description: "Title of the tag",
|
|
2594
2767
|
},
|
|
2595
2768
|
description: {
|
|
2596
2769
|
type: "string",
|
|
2770
|
+
maxLength: 256,
|
|
2597
2771
|
description: "Description of the tag",
|
|
2598
2772
|
},
|
|
2599
2773
|
},
|
|
@@ -2701,6 +2875,16 @@ export const state = {
|
|
|
2701
2875
|
additionalProperties: {
|
|
2702
2876
|
type: "object",
|
|
2703
2877
|
properties: {
|
|
2878
|
+
title: {
|
|
2879
|
+
type: "string",
|
|
2880
|
+
maxLength: 64,
|
|
2881
|
+
description: "Title of the channel",
|
|
2882
|
+
},
|
|
2883
|
+
description: {
|
|
2884
|
+
type: "string",
|
|
2885
|
+
maxLength: 256,
|
|
2886
|
+
description: "Description of the channel",
|
|
2887
|
+
},
|
|
2704
2888
|
messages: {
|
|
2705
2889
|
type: "object",
|
|
2706
2890
|
additionalProperties: {
|
|
@@ -2748,10 +2932,12 @@ export const state = {
|
|
|
2748
2932
|
properties: {
|
|
2749
2933
|
title: {
|
|
2750
2934
|
type: "string",
|
|
2935
|
+
maxLength: 64,
|
|
2751
2936
|
description: "Title of the tag",
|
|
2752
2937
|
},
|
|
2753
2938
|
description: {
|
|
2754
2939
|
type: "string",
|
|
2940
|
+
maxLength: 256,
|
|
2755
2941
|
description: "Description of the tag",
|
|
2756
2942
|
},
|
|
2757
2943
|
},
|
|
@@ -2774,10 +2960,12 @@ export const state = {
|
|
|
2774
2960
|
properties: {
|
|
2775
2961
|
title: {
|
|
2776
2962
|
type: "string",
|
|
2963
|
+
maxLength: 64,
|
|
2777
2964
|
description: "Title of the tag",
|
|
2778
2965
|
},
|
|
2779
2966
|
description: {
|
|
2780
2967
|
type: "string",
|
|
2968
|
+
maxLength: 256,
|
|
2781
2969
|
description: "Description of the tag",
|
|
2782
2970
|
},
|
|
2783
2971
|
},
|
|
@@ -2791,6 +2979,7 @@ export const state = {
|
|
|
2791
2979
|
additionalProperties: false,
|
|
2792
2980
|
},
|
|
2793
2981
|
},
|
|
2982
|
+
nullable: true,
|
|
2794
2983
|
additionalProperties: false,
|
|
2795
2984
|
},
|
|
2796
2985
|
},
|
|
@@ -2799,6 +2988,16 @@ export const state = {
|
|
|
2799
2988
|
additionalProperties: {
|
|
2800
2989
|
type: "object",
|
|
2801
2990
|
properties: {
|
|
2991
|
+
title: {
|
|
2992
|
+
type: "string",
|
|
2993
|
+
maxLength: 64,
|
|
2994
|
+
description: "Title of the action",
|
|
2995
|
+
},
|
|
2996
|
+
description: {
|
|
2997
|
+
type: "string",
|
|
2998
|
+
maxLength: 256,
|
|
2999
|
+
description: "Description of the action",
|
|
3000
|
+
},
|
|
2802
3001
|
input: {
|
|
2803
3002
|
type: "object",
|
|
2804
3003
|
properties: {
|
|
@@ -2833,6 +3032,16 @@ export const state = {
|
|
|
2833
3032
|
additionalProperties: {
|
|
2834
3033
|
type: "object",
|
|
2835
3034
|
properties: {
|
|
3035
|
+
title: {
|
|
3036
|
+
type: "string",
|
|
3037
|
+
maxLength: 64,
|
|
3038
|
+
description: "Title of the event",
|
|
3039
|
+
},
|
|
3040
|
+
description: {
|
|
3041
|
+
type: "string",
|
|
3042
|
+
maxLength: 256,
|
|
3043
|
+
description: "Description of the event",
|
|
3044
|
+
},
|
|
2836
3045
|
schema: {
|
|
2837
3046
|
type: "object",
|
|
2838
3047
|
additionalProperties: true,
|
|
@@ -2899,10 +3108,12 @@ export const state = {
|
|
|
2899
3108
|
properties: {
|
|
2900
3109
|
title: {
|
|
2901
3110
|
type: "string",
|
|
3111
|
+
maxLength: 64,
|
|
2902
3112
|
description: "Title of the tag",
|
|
2903
3113
|
},
|
|
2904
3114
|
description: {
|
|
2905
3115
|
type: "string",
|
|
3116
|
+
maxLength: 256,
|
|
2906
3117
|
description: "Description of the tag",
|
|
2907
3118
|
},
|
|
2908
3119
|
},
|
|
@@ -3204,6 +3415,224 @@ export const state = {
|
|
|
3204
3415
|
},
|
|
3205
3416
|
},
|
|
3206
3417
|
},
|
|
3418
|
+
listWorkspaceMembers: {
|
|
3419
|
+
name: "listWorkspaceMembers",
|
|
3420
|
+
description: "Lists all the members in a workspace",
|
|
3421
|
+
method: "get",
|
|
3422
|
+
path: "/v1/admin/workspace-members",
|
|
3423
|
+
parameters: {
|
|
3424
|
+
nextToken: {
|
|
3425
|
+
in: "query",
|
|
3426
|
+
description:
|
|
3427
|
+
"Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
|
|
3428
|
+
type: "string",
|
|
3429
|
+
},
|
|
3430
|
+
},
|
|
3431
|
+
response: {
|
|
3432
|
+
description: "Success",
|
|
3433
|
+
schema: {
|
|
3434
|
+
type: "object",
|
|
3435
|
+
properties: {
|
|
3436
|
+
members: {
|
|
3437
|
+
type: "array",
|
|
3438
|
+
items: {
|
|
3439
|
+
type: "object",
|
|
3440
|
+
properties: {
|
|
3441
|
+
id: {
|
|
3442
|
+
type: "string",
|
|
3443
|
+
},
|
|
3444
|
+
userId: {
|
|
3445
|
+
type: "string",
|
|
3446
|
+
format: "uuid",
|
|
3447
|
+
},
|
|
3448
|
+
email: {
|
|
3449
|
+
type: "string",
|
|
3450
|
+
},
|
|
3451
|
+
role: {
|
|
3452
|
+
type: "string",
|
|
3453
|
+
enum: [
|
|
3454
|
+
"viewer",
|
|
3455
|
+
"billing",
|
|
3456
|
+
"developer",
|
|
3457
|
+
"manager",
|
|
3458
|
+
"administrator",
|
|
3459
|
+
"owner",
|
|
3460
|
+
],
|
|
3461
|
+
},
|
|
3462
|
+
},
|
|
3463
|
+
required: ["id", "email", "role"],
|
|
3464
|
+
},
|
|
3465
|
+
},
|
|
3466
|
+
meta: {
|
|
3467
|
+
type: "object",
|
|
3468
|
+
properties: {
|
|
3469
|
+
nextToken: {
|
|
3470
|
+
type: "string",
|
|
3471
|
+
description:
|
|
3472
|
+
"The token to use to retrieve the next page of results, passed as a query string parameter (value should be URL-encoded) to this API endpoint.",
|
|
3473
|
+
},
|
|
3474
|
+
},
|
|
3475
|
+
additionalProperties: false,
|
|
3476
|
+
},
|
|
3477
|
+
},
|
|
3478
|
+
required: ["members", "meta"],
|
|
3479
|
+
title: "listWorkspaceMembersResponse",
|
|
3480
|
+
additionalProperties: false,
|
|
3481
|
+
},
|
|
3482
|
+
},
|
|
3483
|
+
},
|
|
3484
|
+
deleteWorkspaceMember: {
|
|
3485
|
+
name: "deleteWorkspaceMember",
|
|
3486
|
+
description: "Remove a member of a workspace",
|
|
3487
|
+
method: "delete",
|
|
3488
|
+
path: "/v1/admin/workspace-members/{id}",
|
|
3489
|
+
parameters: {
|
|
3490
|
+
id: {
|
|
3491
|
+
type: "string",
|
|
3492
|
+
description: "Workspace member ID",
|
|
3493
|
+
in: "path",
|
|
3494
|
+
},
|
|
3495
|
+
},
|
|
3496
|
+
response: {
|
|
3497
|
+
description: "Success",
|
|
3498
|
+
schema: {
|
|
3499
|
+
type: "object",
|
|
3500
|
+
title: "deleteWorkspaceMemberResponse",
|
|
3501
|
+
additionalProperties: false,
|
|
3502
|
+
},
|
|
3503
|
+
},
|
|
3504
|
+
},
|
|
3505
|
+
createWorkspaceMember: {
|
|
3506
|
+
name: "createWorkspaceMember",
|
|
3507
|
+
description: "Add a member to the workspace",
|
|
3508
|
+
method: "post",
|
|
3509
|
+
path: "/v1/admin/workspace-members",
|
|
3510
|
+
requestBody: {
|
|
3511
|
+
description: "Workspace member metadata",
|
|
3512
|
+
schema: {
|
|
3513
|
+
type: "object",
|
|
3514
|
+
properties: {
|
|
3515
|
+
email: {
|
|
3516
|
+
type: "string",
|
|
3517
|
+
format: "email",
|
|
3518
|
+
},
|
|
3519
|
+
role: {
|
|
3520
|
+
type: "string",
|
|
3521
|
+
enum: [
|
|
3522
|
+
"viewer",
|
|
3523
|
+
"billing",
|
|
3524
|
+
"developer",
|
|
3525
|
+
"manager",
|
|
3526
|
+
"administrator",
|
|
3527
|
+
"owner",
|
|
3528
|
+
],
|
|
3529
|
+
},
|
|
3530
|
+
},
|
|
3531
|
+
required: ["email", "role"],
|
|
3532
|
+
title: "createWorkspaceMemberBody",
|
|
3533
|
+
additionalProperties: false,
|
|
3534
|
+
},
|
|
3535
|
+
},
|
|
3536
|
+
response: {
|
|
3537
|
+
description: "Success",
|
|
3538
|
+
schema: {
|
|
3539
|
+
type: "object",
|
|
3540
|
+
properties: {
|
|
3541
|
+
id: {
|
|
3542
|
+
type: "string",
|
|
3543
|
+
},
|
|
3544
|
+
userId: {
|
|
3545
|
+
type: "string",
|
|
3546
|
+
format: "uuid",
|
|
3547
|
+
},
|
|
3548
|
+
email: {
|
|
3549
|
+
type: "string",
|
|
3550
|
+
},
|
|
3551
|
+
role: {
|
|
3552
|
+
type: "string",
|
|
3553
|
+
enum: [
|
|
3554
|
+
"viewer",
|
|
3555
|
+
"billing",
|
|
3556
|
+
"developer",
|
|
3557
|
+
"manager",
|
|
3558
|
+
"administrator",
|
|
3559
|
+
"owner",
|
|
3560
|
+
],
|
|
3561
|
+
},
|
|
3562
|
+
},
|
|
3563
|
+
required: ["id", "email", "role"],
|
|
3564
|
+
title: "createWorkspaceMemberResponse",
|
|
3565
|
+
additionalProperties: false,
|
|
3566
|
+
},
|
|
3567
|
+
},
|
|
3568
|
+
parameters: {},
|
|
3569
|
+
},
|
|
3570
|
+
updateWorkspaceMember: {
|
|
3571
|
+
name: "updateWorkspaceMember",
|
|
3572
|
+
description: "Update the member of a workspace",
|
|
3573
|
+
method: "put",
|
|
3574
|
+
path: "/v1/admin/workspace-members/{id}",
|
|
3575
|
+
parameters: {
|
|
3576
|
+
id: {
|
|
3577
|
+
type: "string",
|
|
3578
|
+
description: "Workspace member ID",
|
|
3579
|
+
in: "path",
|
|
3580
|
+
},
|
|
3581
|
+
},
|
|
3582
|
+
requestBody: {
|
|
3583
|
+
description: "Workspace member metadata",
|
|
3584
|
+
schema: {
|
|
3585
|
+
type: "object",
|
|
3586
|
+
properties: {
|
|
3587
|
+
role: {
|
|
3588
|
+
type: "string",
|
|
3589
|
+
enum: [
|
|
3590
|
+
"viewer",
|
|
3591
|
+
"billing",
|
|
3592
|
+
"developer",
|
|
3593
|
+
"manager",
|
|
3594
|
+
"administrator",
|
|
3595
|
+
"owner",
|
|
3596
|
+
],
|
|
3597
|
+
},
|
|
3598
|
+
},
|
|
3599
|
+
title: "updateWorkspaceMemberBody",
|
|
3600
|
+
additionalProperties: false,
|
|
3601
|
+
},
|
|
3602
|
+
},
|
|
3603
|
+
response: {
|
|
3604
|
+
description: "Success",
|
|
3605
|
+
schema: {
|
|
3606
|
+
type: "object",
|
|
3607
|
+
properties: {
|
|
3608
|
+
id: {
|
|
3609
|
+
type: "string",
|
|
3610
|
+
},
|
|
3611
|
+
userId: {
|
|
3612
|
+
type: "string",
|
|
3613
|
+
format: "uuid",
|
|
3614
|
+
},
|
|
3615
|
+
email: {
|
|
3616
|
+
type: "string",
|
|
3617
|
+
},
|
|
3618
|
+
role: {
|
|
3619
|
+
type: "string",
|
|
3620
|
+
enum: [
|
|
3621
|
+
"viewer",
|
|
3622
|
+
"billing",
|
|
3623
|
+
"developer",
|
|
3624
|
+
"manager",
|
|
3625
|
+
"administrator",
|
|
3626
|
+
"owner",
|
|
3627
|
+
],
|
|
3628
|
+
},
|
|
3629
|
+
},
|
|
3630
|
+
required: ["id", "email", "role"],
|
|
3631
|
+
title: "updateWorkspaceMemberResponse",
|
|
3632
|
+
additionalProperties: false,
|
|
3633
|
+
},
|
|
3634
|
+
},
|
|
3635
|
+
},
|
|
3207
3636
|
introspect: {
|
|
3208
3637
|
name: "introspect",
|
|
3209
3638
|
description: "Introspect the API",
|
|
@@ -3425,7 +3854,7 @@ export const state = {
|
|
|
3425
3854
|
title: "Botpress API",
|
|
3426
3855
|
description: "API for Botpress Cloud",
|
|
3427
3856
|
server: "https://api.botpress.cloud",
|
|
3428
|
-
version: "0.
|
|
3857
|
+
version: "0.3.2",
|
|
3429
3858
|
prefix: "v1",
|
|
3430
3859
|
},
|
|
3431
3860
|
errors: [
|
|
@@ -3516,6 +3945,16 @@ export const state = {
|
|
|
3516
3945
|
description:
|
|
3517
3946
|
"An error happened during the execution of a runtime (bot or integration).",
|
|
3518
3947
|
},
|
|
3948
|
+
{
|
|
3949
|
+
status: 409,
|
|
3950
|
+
type: "AlreadyExists",
|
|
3951
|
+
description: "The record attempted to be created already exists.",
|
|
3952
|
+
},
|
|
3953
|
+
{
|
|
3954
|
+
status: 429,
|
|
3955
|
+
type: "RateLimited",
|
|
3956
|
+
description: "The request has been rate limited.",
|
|
3957
|
+
},
|
|
3519
3958
|
],
|
|
3520
3959
|
refs: {
|
|
3521
3960
|
parameters: {},
|
|
@@ -3537,8 +3976,11 @@ export const state = {
|
|
|
3537
3976
|
createBotBody: true,
|
|
3538
3977
|
updateBotBody: true,
|
|
3539
3978
|
transferBotBody: true,
|
|
3979
|
+
updateWorkspaceBody: true,
|
|
3540
3980
|
createIntegrationBody: true,
|
|
3541
3981
|
updateIntegrationBody: true,
|
|
3982
|
+
createWorkspaceMemberBody: true,
|
|
3983
|
+
updateWorkspaceMemberBody: true,
|
|
3542
3984
|
introspectBody: true,
|
|
3543
3985
|
createFileBody: true,
|
|
3544
3986
|
},
|
|
@@ -3582,6 +4024,7 @@ export const state = {
|
|
|
3582
4024
|
getBotWebchatResponse: true,
|
|
3583
4025
|
getBotAnalyticsResponse: true,
|
|
3584
4026
|
getWorkspaceResponse: true,
|
|
4027
|
+
updateWorkspaceResponse: true,
|
|
3585
4028
|
listWorkspacesResponse: true,
|
|
3586
4029
|
createIntegrationResponse: true,
|
|
3587
4030
|
updateIntegrationResponse: true,
|
|
@@ -3590,6 +4033,10 @@ export const state = {
|
|
|
3590
4033
|
getIntegrationLogsResponse: true,
|
|
3591
4034
|
getIntegrationByNameResponse: true,
|
|
3592
4035
|
deleteIntegrationResponse: true,
|
|
4036
|
+
listWorkspaceMembersResponse: true,
|
|
4037
|
+
deleteWorkspaceMemberResponse: true,
|
|
4038
|
+
createWorkspaceMemberResponse: true,
|
|
4039
|
+
updateWorkspaceMemberResponse: true,
|
|
3593
4040
|
introspectResponse: true,
|
|
3594
4041
|
createFileResponse: true,
|
|
3595
4042
|
getFileResponse: true,
|
|
@@ -3668,6 +4115,10 @@ export const state = {
|
|
|
3668
4115
|
"unregistration_failed",
|
|
3669
4116
|
],
|
|
3670
4117
|
},
|
|
4118
|
+
statusReason: {
|
|
4119
|
+
type: "string",
|
|
4120
|
+
nullable: true,
|
|
4121
|
+
},
|
|
3671
4122
|
},
|
|
3672
4123
|
required: [
|
|
3673
4124
|
"enabled",
|
|
@@ -3676,6 +4127,7 @@ export const state = {
|
|
|
3676
4127
|
"webhookUrl",
|
|
3677
4128
|
"configuration",
|
|
3678
4129
|
"status",
|
|
4130
|
+
"statusReason",
|
|
3679
4131
|
],
|
|
3680
4132
|
additionalProperties: false,
|
|
3681
4133
|
},
|
|
@@ -3691,10 +4143,12 @@ export const state = {
|
|
|
3691
4143
|
properties: {
|
|
3692
4144
|
title: {
|
|
3693
4145
|
type: "string",
|
|
4146
|
+
maxLength: 64,
|
|
3694
4147
|
description: "Title of the tag",
|
|
3695
4148
|
},
|
|
3696
4149
|
description: {
|
|
3697
4150
|
type: "string",
|
|
4151
|
+
maxLength: 256,
|
|
3698
4152
|
description: "Description of the tag",
|
|
3699
4153
|
},
|
|
3700
4154
|
},
|
|
@@ -3718,10 +4172,12 @@ export const state = {
|
|
|
3718
4172
|
properties: {
|
|
3719
4173
|
title: {
|
|
3720
4174
|
type: "string",
|
|
4175
|
+
maxLength: 64,
|
|
3721
4176
|
description: "Title of the tag",
|
|
3722
4177
|
},
|
|
3723
4178
|
description: {
|
|
3724
4179
|
type: "string",
|
|
4180
|
+
maxLength: 256,
|
|
3725
4181
|
description: "Description of the tag",
|
|
3726
4182
|
},
|
|
3727
4183
|
},
|
|
@@ -3745,10 +4201,12 @@ export const state = {
|
|
|
3745
4201
|
properties: {
|
|
3746
4202
|
title: {
|
|
3747
4203
|
type: "string",
|
|
4204
|
+
maxLength: 64,
|
|
3748
4205
|
description: "Title of the tag",
|
|
3749
4206
|
},
|
|
3750
4207
|
description: {
|
|
3751
4208
|
type: "string",
|
|
4209
|
+
maxLength: 256,
|
|
3752
4210
|
description: "Description of the tag",
|
|
3753
4211
|
},
|
|
3754
4212
|
},
|
|
@@ -3815,6 +4273,16 @@ export const state = {
|
|
|
3815
4273
|
additionalProperties: {
|
|
3816
4274
|
type: "object",
|
|
3817
4275
|
properties: {
|
|
4276
|
+
title: {
|
|
4277
|
+
type: "string",
|
|
4278
|
+
maxLength: 64,
|
|
4279
|
+
description: "Title of the event",
|
|
4280
|
+
},
|
|
4281
|
+
description: {
|
|
4282
|
+
type: "string",
|
|
4283
|
+
maxLength: 256,
|
|
4284
|
+
description: "Description of the event",
|
|
4285
|
+
},
|
|
3818
4286
|
schema: {
|
|
3819
4287
|
type: "object",
|
|
3820
4288
|
additionalProperties: true,
|
|
@@ -3960,6 +4428,16 @@ export const state = {
|
|
|
3960
4428
|
additionalProperties: {
|
|
3961
4429
|
type: "object",
|
|
3962
4430
|
properties: {
|
|
4431
|
+
title: {
|
|
4432
|
+
type: "string",
|
|
4433
|
+
maxLength: 64,
|
|
4434
|
+
description: "Title of the channel",
|
|
4435
|
+
},
|
|
4436
|
+
description: {
|
|
4437
|
+
type: "string",
|
|
4438
|
+
maxLength: 256,
|
|
4439
|
+
description: "Description of the channel",
|
|
4440
|
+
},
|
|
3963
4441
|
messages: {
|
|
3964
4442
|
type: "object",
|
|
3965
4443
|
additionalProperties: {
|
|
@@ -3985,10 +4463,12 @@ export const state = {
|
|
|
3985
4463
|
properties: {
|
|
3986
4464
|
title: {
|
|
3987
4465
|
type: "string",
|
|
4466
|
+
maxLength: 64,
|
|
3988
4467
|
description: "Title of the tag",
|
|
3989
4468
|
},
|
|
3990
4469
|
description: {
|
|
3991
4470
|
type: "string",
|
|
4471
|
+
maxLength: 256,
|
|
3992
4472
|
description: "Description of the tag",
|
|
3993
4473
|
},
|
|
3994
4474
|
},
|
|
@@ -4033,10 +4513,12 @@ export const state = {
|
|
|
4033
4513
|
properties: {
|
|
4034
4514
|
title: {
|
|
4035
4515
|
type: "string",
|
|
4516
|
+
maxLength: 64,
|
|
4036
4517
|
description: "Title of the tag",
|
|
4037
4518
|
},
|
|
4038
4519
|
description: {
|
|
4039
4520
|
type: "string",
|
|
4521
|
+
maxLength: 256,
|
|
4040
4522
|
description: "Description of the tag",
|
|
4041
4523
|
},
|
|
4042
4524
|
},
|
|
@@ -4084,6 +4566,16 @@ export const state = {
|
|
|
4084
4566
|
additionalProperties: {
|
|
4085
4567
|
type: "object",
|
|
4086
4568
|
properties: {
|
|
4569
|
+
title: {
|
|
4570
|
+
type: "string",
|
|
4571
|
+
maxLength: 64,
|
|
4572
|
+
description: "Title of the event",
|
|
4573
|
+
},
|
|
4574
|
+
description: {
|
|
4575
|
+
type: "string",
|
|
4576
|
+
maxLength: 256,
|
|
4577
|
+
description: "Description of the event",
|
|
4578
|
+
},
|
|
4087
4579
|
schema: {
|
|
4088
4580
|
type: "object",
|
|
4089
4581
|
additionalProperties: true,
|
|
@@ -4099,6 +4591,16 @@ export const state = {
|
|
|
4099
4591
|
additionalProperties: {
|
|
4100
4592
|
type: "object",
|
|
4101
4593
|
properties: {
|
|
4594
|
+
title: {
|
|
4595
|
+
type: "string",
|
|
4596
|
+
maxLength: 64,
|
|
4597
|
+
description: "Title of the action",
|
|
4598
|
+
},
|
|
4599
|
+
description: {
|
|
4600
|
+
type: "string",
|
|
4601
|
+
maxLength: 256,
|
|
4602
|
+
description: "Description of the action",
|
|
4603
|
+
},
|
|
4102
4604
|
input: {
|
|
4103
4605
|
type: "object",
|
|
4104
4606
|
properties: {
|
|
@@ -4137,10 +4639,12 @@ export const state = {
|
|
|
4137
4639
|
properties: {
|
|
4138
4640
|
title: {
|
|
4139
4641
|
type: "string",
|
|
4642
|
+
maxLength: 64,
|
|
4140
4643
|
description: "Title of the tag",
|
|
4141
4644
|
},
|
|
4142
4645
|
description: {
|
|
4143
4646
|
type: "string",
|
|
4647
|
+
maxLength: 256,
|
|
4144
4648
|
description: "Description of the tag",
|
|
4145
4649
|
},
|
|
4146
4650
|
},
|
|
@@ -4245,8 +4749,12 @@ export const state = {
|
|
|
4245
4749
|
updatedAt: {
|
|
4246
4750
|
type: "string",
|
|
4247
4751
|
},
|
|
4752
|
+
botCount: {
|
|
4753
|
+
type: "number",
|
|
4754
|
+
},
|
|
4248
4755
|
accountType: {
|
|
4249
4756
|
type: "string",
|
|
4757
|
+
enum: ["free", "premium"],
|
|
4250
4758
|
},
|
|
4251
4759
|
blocked: {
|
|
4252
4760
|
type: "boolean",
|
|
@@ -4261,6 +4769,7 @@ export const state = {
|
|
|
4261
4769
|
"ownerId",
|
|
4262
4770
|
"createdAt",
|
|
4263
4771
|
"updatedAt",
|
|
4772
|
+
"botCount",
|
|
4264
4773
|
"accountType",
|
|
4265
4774
|
"blocked",
|
|
4266
4775
|
"spendingLimit",
|