@botpress/api 0.3.1 → 0.3.3

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 (6) hide show
  1. package/dist/gen/state.d.ts +165 -1
  2. package/dist/index.js +1216 -2112
  3. package/package.json +10 -10
  4. package/src/gen/metadata.json +1 -1
  5. package/src/gen/openapi.json +1 -1
  6. package/src/gen/state.ts +175 -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 [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
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 [Conversation](#schema_conversation). The set of [Tags](#tags) available on a [Conversation](#schema_conversation) is restricted by the list of [Tags](#tags) defined previously by the [Bot](#schema_bot). Individual keys can be unset by posting an empty value to them.",
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,
@@ -1872,7 +1904,6 @@ export const state = {
1872
1904
  additionalProperties: true,
1873
1905
  },
1874
1906
  },
1875
- required: ["enabled", "configuration"],
1876
1907
  nullable: true,
1877
1908
  additionalProperties: false,
1878
1909
  },
@@ -2526,6 +2557,16 @@ export const state = {
2526
2557
  additionalProperties: {
2527
2558
  type: "object",
2528
2559
  properties: {
2560
+ title: {
2561
+ type: "string",
2562
+ maxLength: 64,
2563
+ description: "Title of the event",
2564
+ },
2565
+ description: {
2566
+ type: "string",
2567
+ maxLength: 256,
2568
+ description: "Description of the event",
2569
+ },
2529
2570
  schema: {
2530
2571
  type: "object",
2531
2572
  additionalProperties: true,
@@ -2541,6 +2582,16 @@ export const state = {
2541
2582
  additionalProperties: {
2542
2583
  type: "object",
2543
2584
  properties: {
2585
+ title: {
2586
+ type: "string",
2587
+ maxLength: 64,
2588
+ description: "Title of the action",
2589
+ },
2590
+ description: {
2591
+ type: "string",
2592
+ maxLength: 256,
2593
+ description: "Description of the action",
2594
+ },
2544
2595
  input: {
2545
2596
  type: "object",
2546
2597
  properties: {
@@ -2574,6 +2625,16 @@ export const state = {
2574
2625
  additionalProperties: {
2575
2626
  type: "object",
2576
2627
  properties: {
2628
+ title: {
2629
+ type: "string",
2630
+ maxLength: 64,
2631
+ description: "Title of the channel",
2632
+ },
2633
+ description: {
2634
+ type: "string",
2635
+ maxLength: 256,
2636
+ description: "Description of the channel",
2637
+ },
2577
2638
  messages: {
2578
2639
  type: "object",
2579
2640
  additionalProperties: {
@@ -2620,10 +2681,12 @@ export const state = {
2620
2681
  properties: {
2621
2682
  title: {
2622
2683
  type: "string",
2684
+ maxLength: 64,
2623
2685
  description: "Title of the tag",
2624
2686
  },
2625
2687
  description: {
2626
2688
  type: "string",
2689
+ maxLength: 256,
2627
2690
  description: "Description of the tag",
2628
2691
  },
2629
2692
  },
@@ -2645,10 +2708,12 @@ export const state = {
2645
2708
  properties: {
2646
2709
  title: {
2647
2710
  type: "string",
2711
+ maxLength: 64,
2648
2712
  description: "Title of the tag",
2649
2713
  },
2650
2714
  description: {
2651
2715
  type: "string",
2716
+ maxLength: 256,
2652
2717
  description: "Description of the tag",
2653
2718
  },
2654
2719
  },
@@ -2696,10 +2761,12 @@ export const state = {
2696
2761
  properties: {
2697
2762
  title: {
2698
2763
  type: "string",
2764
+ maxLength: 64,
2699
2765
  description: "Title of the tag",
2700
2766
  },
2701
2767
  description: {
2702
2768
  type: "string",
2769
+ maxLength: 256,
2703
2770
  description: "Description of the tag",
2704
2771
  },
2705
2772
  },
@@ -2807,6 +2874,16 @@ export const state = {
2807
2874
  additionalProperties: {
2808
2875
  type: "object",
2809
2876
  properties: {
2877
+ title: {
2878
+ type: "string",
2879
+ maxLength: 64,
2880
+ description: "Title of the channel",
2881
+ },
2882
+ description: {
2883
+ type: "string",
2884
+ maxLength: 256,
2885
+ description: "Description of the channel",
2886
+ },
2810
2887
  messages: {
2811
2888
  type: "object",
2812
2889
  additionalProperties: {
@@ -2854,10 +2931,12 @@ export const state = {
2854
2931
  properties: {
2855
2932
  title: {
2856
2933
  type: "string",
2934
+ maxLength: 64,
2857
2935
  description: "Title of the tag",
2858
2936
  },
2859
2937
  description: {
2860
2938
  type: "string",
2939
+ maxLength: 256,
2861
2940
  description: "Description of the tag",
2862
2941
  },
2863
2942
  },
@@ -2880,10 +2959,12 @@ export const state = {
2880
2959
  properties: {
2881
2960
  title: {
2882
2961
  type: "string",
2962
+ maxLength: 64,
2883
2963
  description: "Title of the tag",
2884
2964
  },
2885
2965
  description: {
2886
2966
  type: "string",
2967
+ maxLength: 256,
2887
2968
  description: "Description of the tag",
2888
2969
  },
2889
2970
  },
@@ -2897,6 +2978,7 @@ export const state = {
2897
2978
  additionalProperties: false,
2898
2979
  },
2899
2980
  },
2981
+ nullable: true,
2900
2982
  additionalProperties: false,
2901
2983
  },
2902
2984
  },
@@ -2905,6 +2987,16 @@ export const state = {
2905
2987
  additionalProperties: {
2906
2988
  type: "object",
2907
2989
  properties: {
2990
+ title: {
2991
+ type: "string",
2992
+ maxLength: 64,
2993
+ description: "Title of the action",
2994
+ },
2995
+ description: {
2996
+ type: "string",
2997
+ maxLength: 256,
2998
+ description: "Description of the action",
2999
+ },
2908
3000
  input: {
2909
3001
  type: "object",
2910
3002
  properties: {
@@ -2939,6 +3031,16 @@ export const state = {
2939
3031
  additionalProperties: {
2940
3032
  type: "object",
2941
3033
  properties: {
3034
+ title: {
3035
+ type: "string",
3036
+ maxLength: 64,
3037
+ description: "Title of the event",
3038
+ },
3039
+ description: {
3040
+ type: "string",
3041
+ maxLength: 256,
3042
+ description: "Description of the event",
3043
+ },
2942
3044
  schema: {
2943
3045
  type: "object",
2944
3046
  additionalProperties: true,
@@ -3005,10 +3107,12 @@ export const state = {
3005
3107
  properties: {
3006
3108
  title: {
3007
3109
  type: "string",
3110
+ maxLength: 64,
3008
3111
  description: "Title of the tag",
3009
3112
  },
3010
3113
  description: {
3011
3114
  type: "string",
3115
+ maxLength: 256,
3012
3116
  description: "Description of the tag",
3013
3117
  },
3014
3118
  },
@@ -3749,7 +3853,7 @@ export const state = {
3749
3853
  title: "Botpress API",
3750
3854
  description: "API for Botpress Cloud",
3751
3855
  server: "https://api.botpress.cloud",
3752
- version: "0.3.1",
3856
+ version: "0.3.3",
3753
3857
  prefix: "v1",
3754
3858
  },
3755
3859
  errors: [
@@ -3840,6 +3944,16 @@ export const state = {
3840
3944
  description:
3841
3945
  "An error happened during the execution of a runtime (bot or integration).",
3842
3946
  },
3947
+ {
3948
+ status: 409,
3949
+ type: "AlreadyExists",
3950
+ description: "The record attempted to be created already exists.",
3951
+ },
3952
+ {
3953
+ status: 429,
3954
+ type: "RateLimited",
3955
+ description: "The request has been rate limited.",
3956
+ },
3843
3957
  ],
3844
3958
  refs: {
3845
3959
  parameters: {},
@@ -4000,6 +4114,10 @@ export const state = {
4000
4114
  "unregistration_failed",
4001
4115
  ],
4002
4116
  },
4117
+ statusReason: {
4118
+ type: "string",
4119
+ nullable: true,
4120
+ },
4003
4121
  },
4004
4122
  required: [
4005
4123
  "enabled",
@@ -4008,6 +4126,7 @@ export const state = {
4008
4126
  "webhookUrl",
4009
4127
  "configuration",
4010
4128
  "status",
4129
+ "statusReason",
4011
4130
  ],
4012
4131
  additionalProperties: false,
4013
4132
  },
@@ -4023,10 +4142,12 @@ export const state = {
4023
4142
  properties: {
4024
4143
  title: {
4025
4144
  type: "string",
4145
+ maxLength: 64,
4026
4146
  description: "Title of the tag",
4027
4147
  },
4028
4148
  description: {
4029
4149
  type: "string",
4150
+ maxLength: 256,
4030
4151
  description: "Description of the tag",
4031
4152
  },
4032
4153
  },
@@ -4050,10 +4171,12 @@ export const state = {
4050
4171
  properties: {
4051
4172
  title: {
4052
4173
  type: "string",
4174
+ maxLength: 64,
4053
4175
  description: "Title of the tag",
4054
4176
  },
4055
4177
  description: {
4056
4178
  type: "string",
4179
+ maxLength: 256,
4057
4180
  description: "Description of the tag",
4058
4181
  },
4059
4182
  },
@@ -4077,10 +4200,12 @@ export const state = {
4077
4200
  properties: {
4078
4201
  title: {
4079
4202
  type: "string",
4203
+ maxLength: 64,
4080
4204
  description: "Title of the tag",
4081
4205
  },
4082
4206
  description: {
4083
4207
  type: "string",
4208
+ maxLength: 256,
4084
4209
  description: "Description of the tag",
4085
4210
  },
4086
4211
  },
@@ -4147,6 +4272,16 @@ export const state = {
4147
4272
  additionalProperties: {
4148
4273
  type: "object",
4149
4274
  properties: {
4275
+ title: {
4276
+ type: "string",
4277
+ maxLength: 64,
4278
+ description: "Title of the event",
4279
+ },
4280
+ description: {
4281
+ type: "string",
4282
+ maxLength: 256,
4283
+ description: "Description of the event",
4284
+ },
4150
4285
  schema: {
4151
4286
  type: "object",
4152
4287
  additionalProperties: true,
@@ -4292,6 +4427,16 @@ export const state = {
4292
4427
  additionalProperties: {
4293
4428
  type: "object",
4294
4429
  properties: {
4430
+ title: {
4431
+ type: "string",
4432
+ maxLength: 64,
4433
+ description: "Title of the channel",
4434
+ },
4435
+ description: {
4436
+ type: "string",
4437
+ maxLength: 256,
4438
+ description: "Description of the channel",
4439
+ },
4295
4440
  messages: {
4296
4441
  type: "object",
4297
4442
  additionalProperties: {
@@ -4317,10 +4462,12 @@ export const state = {
4317
4462
  properties: {
4318
4463
  title: {
4319
4464
  type: "string",
4465
+ maxLength: 64,
4320
4466
  description: "Title of the tag",
4321
4467
  },
4322
4468
  description: {
4323
4469
  type: "string",
4470
+ maxLength: 256,
4324
4471
  description: "Description of the tag",
4325
4472
  },
4326
4473
  },
@@ -4365,10 +4512,12 @@ export const state = {
4365
4512
  properties: {
4366
4513
  title: {
4367
4514
  type: "string",
4515
+ maxLength: 64,
4368
4516
  description: "Title of the tag",
4369
4517
  },
4370
4518
  description: {
4371
4519
  type: "string",
4520
+ maxLength: 256,
4372
4521
  description: "Description of the tag",
4373
4522
  },
4374
4523
  },
@@ -4416,6 +4565,16 @@ export const state = {
4416
4565
  additionalProperties: {
4417
4566
  type: "object",
4418
4567
  properties: {
4568
+ title: {
4569
+ type: "string",
4570
+ maxLength: 64,
4571
+ description: "Title of the event",
4572
+ },
4573
+ description: {
4574
+ type: "string",
4575
+ maxLength: 256,
4576
+ description: "Description of the event",
4577
+ },
4419
4578
  schema: {
4420
4579
  type: "object",
4421
4580
  additionalProperties: true,
@@ -4431,6 +4590,16 @@ export const state = {
4431
4590
  additionalProperties: {
4432
4591
  type: "object",
4433
4592
  properties: {
4593
+ title: {
4594
+ type: "string",
4595
+ maxLength: 64,
4596
+ description: "Title of the action",
4597
+ },
4598
+ description: {
4599
+ type: "string",
4600
+ maxLength: 256,
4601
+ description: "Description of the action",
4602
+ },
4434
4603
  input: {
4435
4604
  type: "object",
4436
4605
  properties: {
@@ -4469,10 +4638,12 @@ export const state = {
4469
4638
  properties: {
4470
4639
  title: {
4471
4640
  type: "string",
4641
+ maxLength: 64,
4472
4642
  description: "Title of the tag",
4473
4643
  },
4474
4644
  description: {
4475
4645
  type: "string",
4646
+ maxLength: 256,
4476
4647
  description: "Description of the tag",
4477
4648
  },
4478
4649
  },