@botpress/api 0.3.1 → 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.
Files changed (6) hide show
  1. package/dist/gen/state.d.ts +165 -0
  2. package/dist/index.js +1216 -2111
  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 -3
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,
@@ -2526,6 +2558,16 @@ export const state = {
2526
2558
  additionalProperties: {
2527
2559
  type: "object",
2528
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
+ },
2529
2571
  schema: {
2530
2572
  type: "object",
2531
2573
  additionalProperties: true,
@@ -2541,6 +2583,16 @@ export const state = {
2541
2583
  additionalProperties: {
2542
2584
  type: "object",
2543
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
+ },
2544
2596
  input: {
2545
2597
  type: "object",
2546
2598
  properties: {
@@ -2574,6 +2626,16 @@ export const state = {
2574
2626
  additionalProperties: {
2575
2627
  type: "object",
2576
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
+ },
2577
2639
  messages: {
2578
2640
  type: "object",
2579
2641
  additionalProperties: {
@@ -2620,10 +2682,12 @@ export const state = {
2620
2682
  properties: {
2621
2683
  title: {
2622
2684
  type: "string",
2685
+ maxLength: 64,
2623
2686
  description: "Title of the tag",
2624
2687
  },
2625
2688
  description: {
2626
2689
  type: "string",
2690
+ maxLength: 256,
2627
2691
  description: "Description of the tag",
2628
2692
  },
2629
2693
  },
@@ -2645,10 +2709,12 @@ export const state = {
2645
2709
  properties: {
2646
2710
  title: {
2647
2711
  type: "string",
2712
+ maxLength: 64,
2648
2713
  description: "Title of the tag",
2649
2714
  },
2650
2715
  description: {
2651
2716
  type: "string",
2717
+ maxLength: 256,
2652
2718
  description: "Description of the tag",
2653
2719
  },
2654
2720
  },
@@ -2696,10 +2762,12 @@ export const state = {
2696
2762
  properties: {
2697
2763
  title: {
2698
2764
  type: "string",
2765
+ maxLength: 64,
2699
2766
  description: "Title of the tag",
2700
2767
  },
2701
2768
  description: {
2702
2769
  type: "string",
2770
+ maxLength: 256,
2703
2771
  description: "Description of the tag",
2704
2772
  },
2705
2773
  },
@@ -2807,6 +2875,16 @@ export const state = {
2807
2875
  additionalProperties: {
2808
2876
  type: "object",
2809
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
+ },
2810
2888
  messages: {
2811
2889
  type: "object",
2812
2890
  additionalProperties: {
@@ -2854,10 +2932,12 @@ export const state = {
2854
2932
  properties: {
2855
2933
  title: {
2856
2934
  type: "string",
2935
+ maxLength: 64,
2857
2936
  description: "Title of the tag",
2858
2937
  },
2859
2938
  description: {
2860
2939
  type: "string",
2940
+ maxLength: 256,
2861
2941
  description: "Description of the tag",
2862
2942
  },
2863
2943
  },
@@ -2880,10 +2960,12 @@ export const state = {
2880
2960
  properties: {
2881
2961
  title: {
2882
2962
  type: "string",
2963
+ maxLength: 64,
2883
2964
  description: "Title of the tag",
2884
2965
  },
2885
2966
  description: {
2886
2967
  type: "string",
2968
+ maxLength: 256,
2887
2969
  description: "Description of the tag",
2888
2970
  },
2889
2971
  },
@@ -2897,6 +2979,7 @@ export const state = {
2897
2979
  additionalProperties: false,
2898
2980
  },
2899
2981
  },
2982
+ nullable: true,
2900
2983
  additionalProperties: false,
2901
2984
  },
2902
2985
  },
@@ -2905,6 +2988,16 @@ export const state = {
2905
2988
  additionalProperties: {
2906
2989
  type: "object",
2907
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
+ },
2908
3001
  input: {
2909
3002
  type: "object",
2910
3003
  properties: {
@@ -2939,6 +3032,16 @@ export const state = {
2939
3032
  additionalProperties: {
2940
3033
  type: "object",
2941
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
+ },
2942
3045
  schema: {
2943
3046
  type: "object",
2944
3047
  additionalProperties: true,
@@ -3005,10 +3108,12 @@ export const state = {
3005
3108
  properties: {
3006
3109
  title: {
3007
3110
  type: "string",
3111
+ maxLength: 64,
3008
3112
  description: "Title of the tag",
3009
3113
  },
3010
3114
  description: {
3011
3115
  type: "string",
3116
+ maxLength: 256,
3012
3117
  description: "Description of the tag",
3013
3118
  },
3014
3119
  },
@@ -3749,7 +3854,7 @@ export const state = {
3749
3854
  title: "Botpress API",
3750
3855
  description: "API for Botpress Cloud",
3751
3856
  server: "https://api.botpress.cloud",
3752
- version: "0.3.1",
3857
+ version: "0.3.2",
3753
3858
  prefix: "v1",
3754
3859
  },
3755
3860
  errors: [
@@ -3840,6 +3945,16 @@ export const state = {
3840
3945
  description:
3841
3946
  "An error happened during the execution of a runtime (bot or integration).",
3842
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
+ },
3843
3958
  ],
3844
3959
  refs: {
3845
3960
  parameters: {},
@@ -4000,6 +4115,10 @@ export const state = {
4000
4115
  "unregistration_failed",
4001
4116
  ],
4002
4117
  },
4118
+ statusReason: {
4119
+ type: "string",
4120
+ nullable: true,
4121
+ },
4003
4122
  },
4004
4123
  required: [
4005
4124
  "enabled",
@@ -4008,6 +4127,7 @@ export const state = {
4008
4127
  "webhookUrl",
4009
4128
  "configuration",
4010
4129
  "status",
4130
+ "statusReason",
4011
4131
  ],
4012
4132
  additionalProperties: false,
4013
4133
  },
@@ -4023,10 +4143,12 @@ export const state = {
4023
4143
  properties: {
4024
4144
  title: {
4025
4145
  type: "string",
4146
+ maxLength: 64,
4026
4147
  description: "Title of the tag",
4027
4148
  },
4028
4149
  description: {
4029
4150
  type: "string",
4151
+ maxLength: 256,
4030
4152
  description: "Description of the tag",
4031
4153
  },
4032
4154
  },
@@ -4050,10 +4172,12 @@ export const state = {
4050
4172
  properties: {
4051
4173
  title: {
4052
4174
  type: "string",
4175
+ maxLength: 64,
4053
4176
  description: "Title of the tag",
4054
4177
  },
4055
4178
  description: {
4056
4179
  type: "string",
4180
+ maxLength: 256,
4057
4181
  description: "Description of the tag",
4058
4182
  },
4059
4183
  },
@@ -4077,10 +4201,12 @@ export const state = {
4077
4201
  properties: {
4078
4202
  title: {
4079
4203
  type: "string",
4204
+ maxLength: 64,
4080
4205
  description: "Title of the tag",
4081
4206
  },
4082
4207
  description: {
4083
4208
  type: "string",
4209
+ maxLength: 256,
4084
4210
  description: "Description of the tag",
4085
4211
  },
4086
4212
  },
@@ -4147,6 +4273,16 @@ export const state = {
4147
4273
  additionalProperties: {
4148
4274
  type: "object",
4149
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
+ },
4150
4286
  schema: {
4151
4287
  type: "object",
4152
4288
  additionalProperties: true,
@@ -4292,6 +4428,16 @@ export const state = {
4292
4428
  additionalProperties: {
4293
4429
  type: "object",
4294
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
+ },
4295
4441
  messages: {
4296
4442
  type: "object",
4297
4443
  additionalProperties: {
@@ -4317,10 +4463,12 @@ export const state = {
4317
4463
  properties: {
4318
4464
  title: {
4319
4465
  type: "string",
4466
+ maxLength: 64,
4320
4467
  description: "Title of the tag",
4321
4468
  },
4322
4469
  description: {
4323
4470
  type: "string",
4471
+ maxLength: 256,
4324
4472
  description: "Description of the tag",
4325
4473
  },
4326
4474
  },
@@ -4365,10 +4513,12 @@ export const state = {
4365
4513
  properties: {
4366
4514
  title: {
4367
4515
  type: "string",
4516
+ maxLength: 64,
4368
4517
  description: "Title of the tag",
4369
4518
  },
4370
4519
  description: {
4371
4520
  type: "string",
4521
+ maxLength: 256,
4372
4522
  description: "Description of the tag",
4373
4523
  },
4374
4524
  },
@@ -4416,6 +4566,16 @@ export const state = {
4416
4566
  additionalProperties: {
4417
4567
  type: "object",
4418
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
+ },
4419
4579
  schema: {
4420
4580
  type: "object",
4421
4581
  additionalProperties: true,
@@ -4431,6 +4591,16 @@ export const state = {
4431
4591
  additionalProperties: {
4432
4592
  type: "object",
4433
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
+ },
4434
4604
  input: {
4435
4605
  type: "object",
4436
4606
  properties: {
@@ -4469,10 +4639,12 @@ export const state = {
4469
4639
  properties: {
4470
4640
  title: {
4471
4641
  type: "string",
4642
+ maxLength: 64,
4472
4643
  description: "Title of the tag",
4473
4644
  },
4474
4645
  description: {
4475
4646
  type: "string",
4647
+ maxLength: 256,
4476
4648
  description: "Description of the tag",
4477
4649
  },
4478
4650
  },