@botpress/api 1.4.0 → 1.5.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.
@@ -1787,6 +1787,784 @@ export declare const state: {
1787
1787
  };
1788
1788
  };
1789
1789
  };
1790
+ listPublicPlugins: {
1791
+ name: string;
1792
+ description: string;
1793
+ method: "get";
1794
+ section: "hub";
1795
+ path: string;
1796
+ disableDefaultParameters: {
1797
+ "x-workspace-id": boolean;
1798
+ };
1799
+ parameters: {
1800
+ nextToken: {
1801
+ in: "query";
1802
+ description: string;
1803
+ type: "string";
1804
+ };
1805
+ name: {
1806
+ in: "query";
1807
+ type: "string";
1808
+ description: string;
1809
+ };
1810
+ version: {
1811
+ in: "query";
1812
+ type: "string";
1813
+ description: string;
1814
+ };
1815
+ };
1816
+ response: {
1817
+ description: string;
1818
+ schema: {
1819
+ type: "object";
1820
+ properties: {
1821
+ plugins: {
1822
+ type: "array";
1823
+ items: {
1824
+ type: "object";
1825
+ properties: {
1826
+ id: {
1827
+ type: "string";
1828
+ minLength: number;
1829
+ maxLength: number;
1830
+ description: string;
1831
+ };
1832
+ createdAt: {
1833
+ type: "string";
1834
+ format: string;
1835
+ description: string;
1836
+ };
1837
+ updatedAt: {
1838
+ type: "string";
1839
+ format: string;
1840
+ description: string;
1841
+ };
1842
+ name: {
1843
+ type: "string";
1844
+ maxLength: number;
1845
+ description: string;
1846
+ };
1847
+ version: {
1848
+ type: "string";
1849
+ maxLength: number;
1850
+ description: string;
1851
+ };
1852
+ title: {
1853
+ type: "string";
1854
+ minLength: number;
1855
+ maxLength: number;
1856
+ description: string;
1857
+ };
1858
+ description: {
1859
+ type: "string";
1860
+ maxLength: number;
1861
+ description: string;
1862
+ };
1863
+ iconUrl: {
1864
+ type: "string";
1865
+ description: string;
1866
+ };
1867
+ readmeUrl: {
1868
+ type: "string";
1869
+ description: string;
1870
+ };
1871
+ public: {
1872
+ type: "boolean";
1873
+ description: string;
1874
+ };
1875
+ };
1876
+ required: string[];
1877
+ };
1878
+ };
1879
+ meta: {
1880
+ type: "object";
1881
+ properties: {
1882
+ nextToken: {
1883
+ type: "string";
1884
+ description: string;
1885
+ };
1886
+ };
1887
+ additionalProperties: false;
1888
+ };
1889
+ };
1890
+ required: string[];
1891
+ title: string;
1892
+ additionalProperties: false;
1893
+ };
1894
+ };
1895
+ };
1896
+ getPublicPluginById: {
1897
+ name: string;
1898
+ description: string;
1899
+ method: "get";
1900
+ section: "hub";
1901
+ path: string;
1902
+ disableDefaultParameters: {
1903
+ "x-workspace-id": boolean;
1904
+ };
1905
+ parameters: {
1906
+ id: {
1907
+ type: "string";
1908
+ description: string;
1909
+ in: "path";
1910
+ };
1911
+ };
1912
+ response: {
1913
+ description: string;
1914
+ schema: {
1915
+ type: "object";
1916
+ properties: {
1917
+ plugin: {
1918
+ type: "object";
1919
+ properties: {
1920
+ id: {
1921
+ type: "string";
1922
+ minLength: number;
1923
+ maxLength: number;
1924
+ description: string;
1925
+ };
1926
+ name: {
1927
+ type: "string";
1928
+ maxLength: number;
1929
+ description: string;
1930
+ };
1931
+ version: {
1932
+ type: "string";
1933
+ maxLength: number;
1934
+ description: string;
1935
+ };
1936
+ createdAt: {
1937
+ type: "string";
1938
+ format: string;
1939
+ description: string;
1940
+ };
1941
+ updatedAt: {
1942
+ type: "string";
1943
+ format: string;
1944
+ description: string;
1945
+ };
1946
+ configuration: {
1947
+ type: "object";
1948
+ properties: {
1949
+ title: {
1950
+ type: "string";
1951
+ maxLength: number;
1952
+ description: string;
1953
+ };
1954
+ description: {
1955
+ type: "string";
1956
+ maxLength: number;
1957
+ description: string;
1958
+ };
1959
+ schema: {
1960
+ type: "object";
1961
+ additionalProperties: true;
1962
+ description: string;
1963
+ };
1964
+ };
1965
+ required: string[];
1966
+ description: string;
1967
+ additionalProperties: false;
1968
+ };
1969
+ states: {
1970
+ type: "object";
1971
+ additionalProperties: {
1972
+ type: "object";
1973
+ properties: {
1974
+ type: {
1975
+ type: "string";
1976
+ enum: string[];
1977
+ description: string;
1978
+ };
1979
+ schema: {
1980
+ type: "object";
1981
+ additionalProperties: true;
1982
+ description: string;
1983
+ };
1984
+ expiry: {
1985
+ type: "number";
1986
+ minimum: number;
1987
+ description: string;
1988
+ };
1989
+ };
1990
+ required: string[];
1991
+ additionalProperties: false;
1992
+ };
1993
+ };
1994
+ events: {
1995
+ type: "object";
1996
+ additionalProperties: {
1997
+ type: "object";
1998
+ properties: {
1999
+ title: {
2000
+ type: "string";
2001
+ maxLength: number;
2002
+ description: string;
2003
+ };
2004
+ description: {
2005
+ type: "string";
2006
+ maxLength: number;
2007
+ description: string;
2008
+ };
2009
+ schema: {
2010
+ type: "object";
2011
+ additionalProperties: true;
2012
+ };
2013
+ };
2014
+ required: string[];
2015
+ description: string;
2016
+ additionalProperties: false;
2017
+ };
2018
+ };
2019
+ actions: {
2020
+ type: "object";
2021
+ additionalProperties: {
2022
+ type: "object";
2023
+ properties: {
2024
+ title: {
2025
+ type: "string";
2026
+ maxLength: number;
2027
+ description: string;
2028
+ };
2029
+ description: {
2030
+ type: "string";
2031
+ maxLength: number;
2032
+ description: string;
2033
+ };
2034
+ billable: {
2035
+ type: "boolean";
2036
+ };
2037
+ cacheable: {
2038
+ type: "boolean";
2039
+ };
2040
+ input: {
2041
+ type: "object";
2042
+ properties: {
2043
+ schema: {
2044
+ type: "object";
2045
+ additionalProperties: true;
2046
+ };
2047
+ };
2048
+ required: string[];
2049
+ additionalProperties: false;
2050
+ };
2051
+ output: {
2052
+ type: "object";
2053
+ properties: {
2054
+ schema: {
2055
+ type: "object";
2056
+ additionalProperties: true;
2057
+ };
2058
+ };
2059
+ required: string[];
2060
+ additionalProperties: false;
2061
+ };
2062
+ };
2063
+ required: string[];
2064
+ description: string;
2065
+ additionalProperties: false;
2066
+ };
2067
+ };
2068
+ dependencies: {
2069
+ type: "object";
2070
+ properties: {
2071
+ interfaces: {
2072
+ type: "object";
2073
+ additionalProperties: {
2074
+ type: "object";
2075
+ properties: {
2076
+ id: {
2077
+ type: "string";
2078
+ minLength: number;
2079
+ maxLength: number;
2080
+ };
2081
+ name: {
2082
+ type: "string";
2083
+ maxLength: number;
2084
+ };
2085
+ version: {
2086
+ type: "string";
2087
+ maxLength: number;
2088
+ };
2089
+ };
2090
+ required: string[];
2091
+ additionalProperties: false;
2092
+ };
2093
+ };
2094
+ integrations: {
2095
+ type: "object";
2096
+ additionalProperties: {
2097
+ type: "object";
2098
+ properties: {
2099
+ id: {
2100
+ type: "string";
2101
+ minLength: number;
2102
+ maxLength: number;
2103
+ };
2104
+ name: {
2105
+ type: "string";
2106
+ maxLength: number;
2107
+ };
2108
+ version: {
2109
+ type: "string";
2110
+ maxLength: number;
2111
+ };
2112
+ };
2113
+ required: string[];
2114
+ additionalProperties: false;
2115
+ };
2116
+ };
2117
+ };
2118
+ required: string[];
2119
+ additionalProperties: false;
2120
+ };
2121
+ user: {
2122
+ type: "object";
2123
+ properties: {
2124
+ tags: {
2125
+ type: "object";
2126
+ additionalProperties: {
2127
+ type: "object";
2128
+ properties: {
2129
+ title: {
2130
+ type: "string";
2131
+ maxLength: number;
2132
+ description: string;
2133
+ };
2134
+ description: {
2135
+ type: "string";
2136
+ maxLength: number;
2137
+ description: string;
2138
+ };
2139
+ };
2140
+ description: string;
2141
+ additionalProperties: false;
2142
+ };
2143
+ };
2144
+ };
2145
+ required: string[];
2146
+ description: string;
2147
+ additionalProperties: false;
2148
+ };
2149
+ conversation: {
2150
+ type: "object";
2151
+ properties: {
2152
+ tags: {
2153
+ type: "object";
2154
+ additionalProperties: {
2155
+ type: "object";
2156
+ properties: {
2157
+ title: {
2158
+ type: "string";
2159
+ maxLength: number;
2160
+ description: string;
2161
+ };
2162
+ description: {
2163
+ type: "string";
2164
+ maxLength: number;
2165
+ description: string;
2166
+ };
2167
+ };
2168
+ description: string;
2169
+ additionalProperties: false;
2170
+ };
2171
+ };
2172
+ };
2173
+ required: string[];
2174
+ description: string;
2175
+ additionalProperties: false;
2176
+ };
2177
+ title: {
2178
+ type: "string";
2179
+ minLength: number;
2180
+ maxLength: number;
2181
+ description: string;
2182
+ };
2183
+ description: {
2184
+ type: "string";
2185
+ maxLength: number;
2186
+ description: string;
2187
+ };
2188
+ iconUrl: {
2189
+ type: "string";
2190
+ description: string;
2191
+ };
2192
+ readmeUrl: {
2193
+ type: "string";
2194
+ description: string;
2195
+ };
2196
+ public: {
2197
+ type: "boolean";
2198
+ description: string;
2199
+ };
2200
+ };
2201
+ required: string[];
2202
+ additionalProperties: false;
2203
+ };
2204
+ };
2205
+ required: string[];
2206
+ title: string;
2207
+ additionalProperties: false;
2208
+ };
2209
+ };
2210
+ };
2211
+ getPublicPlugin: {
2212
+ name: string;
2213
+ description: string;
2214
+ method: "get";
2215
+ section: "hub";
2216
+ path: string;
2217
+ disableDefaultParameters: {
2218
+ "x-workspace-id": boolean;
2219
+ };
2220
+ parameters: {
2221
+ name: {
2222
+ type: "string";
2223
+ description: string;
2224
+ in: "path";
2225
+ };
2226
+ version: {
2227
+ type: "string";
2228
+ description: string;
2229
+ in: "path";
2230
+ };
2231
+ };
2232
+ response: {
2233
+ description: string;
2234
+ schema: {
2235
+ type: "object";
2236
+ properties: {
2237
+ plugin: {
2238
+ type: "object";
2239
+ properties: {
2240
+ id: {
2241
+ type: "string";
2242
+ minLength: number;
2243
+ maxLength: number;
2244
+ description: string;
2245
+ };
2246
+ name: {
2247
+ type: "string";
2248
+ maxLength: number;
2249
+ description: string;
2250
+ };
2251
+ version: {
2252
+ type: "string";
2253
+ maxLength: number;
2254
+ description: string;
2255
+ };
2256
+ createdAt: {
2257
+ type: "string";
2258
+ format: string;
2259
+ description: string;
2260
+ };
2261
+ updatedAt: {
2262
+ type: "string";
2263
+ format: string;
2264
+ description: string;
2265
+ };
2266
+ configuration: {
2267
+ type: "object";
2268
+ properties: {
2269
+ title: {
2270
+ type: "string";
2271
+ maxLength: number;
2272
+ description: string;
2273
+ };
2274
+ description: {
2275
+ type: "string";
2276
+ maxLength: number;
2277
+ description: string;
2278
+ };
2279
+ schema: {
2280
+ type: "object";
2281
+ additionalProperties: true;
2282
+ description: string;
2283
+ };
2284
+ };
2285
+ required: string[];
2286
+ description: string;
2287
+ additionalProperties: false;
2288
+ };
2289
+ states: {
2290
+ type: "object";
2291
+ additionalProperties: {
2292
+ type: "object";
2293
+ properties: {
2294
+ type: {
2295
+ type: "string";
2296
+ enum: string[];
2297
+ description: string;
2298
+ };
2299
+ schema: {
2300
+ type: "object";
2301
+ additionalProperties: true;
2302
+ description: string;
2303
+ };
2304
+ expiry: {
2305
+ type: "number";
2306
+ minimum: number;
2307
+ description: string;
2308
+ };
2309
+ };
2310
+ required: string[];
2311
+ additionalProperties: false;
2312
+ };
2313
+ };
2314
+ events: {
2315
+ type: "object";
2316
+ additionalProperties: {
2317
+ type: "object";
2318
+ properties: {
2319
+ title: {
2320
+ type: "string";
2321
+ maxLength: number;
2322
+ description: string;
2323
+ };
2324
+ description: {
2325
+ type: "string";
2326
+ maxLength: number;
2327
+ description: string;
2328
+ };
2329
+ schema: {
2330
+ type: "object";
2331
+ additionalProperties: true;
2332
+ };
2333
+ };
2334
+ required: string[];
2335
+ description: string;
2336
+ additionalProperties: false;
2337
+ };
2338
+ };
2339
+ actions: {
2340
+ type: "object";
2341
+ additionalProperties: {
2342
+ type: "object";
2343
+ properties: {
2344
+ title: {
2345
+ type: "string";
2346
+ maxLength: number;
2347
+ description: string;
2348
+ };
2349
+ description: {
2350
+ type: "string";
2351
+ maxLength: number;
2352
+ description: string;
2353
+ };
2354
+ billable: {
2355
+ type: "boolean";
2356
+ };
2357
+ cacheable: {
2358
+ type: "boolean";
2359
+ };
2360
+ input: {
2361
+ type: "object";
2362
+ properties: {
2363
+ schema: {
2364
+ type: "object";
2365
+ additionalProperties: true;
2366
+ };
2367
+ };
2368
+ required: string[];
2369
+ additionalProperties: false;
2370
+ };
2371
+ output: {
2372
+ type: "object";
2373
+ properties: {
2374
+ schema: {
2375
+ type: "object";
2376
+ additionalProperties: true;
2377
+ };
2378
+ };
2379
+ required: string[];
2380
+ additionalProperties: false;
2381
+ };
2382
+ };
2383
+ required: string[];
2384
+ description: string;
2385
+ additionalProperties: false;
2386
+ };
2387
+ };
2388
+ dependencies: {
2389
+ type: "object";
2390
+ properties: {
2391
+ interfaces: {
2392
+ type: "object";
2393
+ additionalProperties: {
2394
+ type: "object";
2395
+ properties: {
2396
+ id: {
2397
+ type: "string";
2398
+ minLength: number;
2399
+ maxLength: number;
2400
+ };
2401
+ name: {
2402
+ type: "string";
2403
+ maxLength: number;
2404
+ };
2405
+ version: {
2406
+ type: "string";
2407
+ maxLength: number;
2408
+ };
2409
+ };
2410
+ required: string[];
2411
+ additionalProperties: false;
2412
+ };
2413
+ };
2414
+ integrations: {
2415
+ type: "object";
2416
+ additionalProperties: {
2417
+ type: "object";
2418
+ properties: {
2419
+ id: {
2420
+ type: "string";
2421
+ minLength: number;
2422
+ maxLength: number;
2423
+ };
2424
+ name: {
2425
+ type: "string";
2426
+ maxLength: number;
2427
+ };
2428
+ version: {
2429
+ type: "string";
2430
+ maxLength: number;
2431
+ };
2432
+ };
2433
+ required: string[];
2434
+ additionalProperties: false;
2435
+ };
2436
+ };
2437
+ };
2438
+ required: string[];
2439
+ additionalProperties: false;
2440
+ };
2441
+ user: {
2442
+ type: "object";
2443
+ properties: {
2444
+ tags: {
2445
+ type: "object";
2446
+ additionalProperties: {
2447
+ type: "object";
2448
+ properties: {
2449
+ title: {
2450
+ type: "string";
2451
+ maxLength: number;
2452
+ description: string;
2453
+ };
2454
+ description: {
2455
+ type: "string";
2456
+ maxLength: number;
2457
+ description: string;
2458
+ };
2459
+ };
2460
+ description: string;
2461
+ additionalProperties: false;
2462
+ };
2463
+ };
2464
+ };
2465
+ required: string[];
2466
+ description: string;
2467
+ additionalProperties: false;
2468
+ };
2469
+ conversation: {
2470
+ type: "object";
2471
+ properties: {
2472
+ tags: {
2473
+ type: "object";
2474
+ additionalProperties: {
2475
+ type: "object";
2476
+ properties: {
2477
+ title: {
2478
+ type: "string";
2479
+ maxLength: number;
2480
+ description: string;
2481
+ };
2482
+ description: {
2483
+ type: "string";
2484
+ maxLength: number;
2485
+ description: string;
2486
+ };
2487
+ };
2488
+ description: string;
2489
+ additionalProperties: false;
2490
+ };
2491
+ };
2492
+ };
2493
+ required: string[];
2494
+ description: string;
2495
+ additionalProperties: false;
2496
+ };
2497
+ title: {
2498
+ type: "string";
2499
+ minLength: number;
2500
+ maxLength: number;
2501
+ description: string;
2502
+ };
2503
+ description: {
2504
+ type: "string";
2505
+ maxLength: number;
2506
+ description: string;
2507
+ };
2508
+ iconUrl: {
2509
+ type: "string";
2510
+ description: string;
2511
+ };
2512
+ readmeUrl: {
2513
+ type: "string";
2514
+ description: string;
2515
+ };
2516
+ public: {
2517
+ type: "boolean";
2518
+ description: string;
2519
+ };
2520
+ };
2521
+ required: string[];
2522
+ additionalProperties: false;
2523
+ };
2524
+ };
2525
+ required: string[];
2526
+ title: string;
2527
+ additionalProperties: false;
2528
+ };
2529
+ };
2530
+ };
2531
+ getPublicPluginCode: {
2532
+ name: string;
2533
+ description: string;
2534
+ method: "get";
2535
+ path: string;
2536
+ disableDefaultParameters: {
2537
+ "x-workspace-id": boolean;
2538
+ };
2539
+ section: "hub";
2540
+ parameters: {
2541
+ id: {
2542
+ in: "path";
2543
+ type: "string";
2544
+ description: string;
2545
+ };
2546
+ platform: {
2547
+ in: "path";
2548
+ type: "string";
2549
+ enum: string[];
2550
+ description: string;
2551
+ };
2552
+ };
2553
+ response: {
2554
+ description: string;
2555
+ schema: {
2556
+ type: "object";
2557
+ properties: {
2558
+ code: {
2559
+ type: "string";
2560
+ };
2561
+ };
2562
+ required: string[];
2563
+ title: string;
2564
+ additionalProperties: false;
2565
+ };
2566
+ };
2567
+ };
1790
2568
  createBot: {
1791
2569
  name: string;
1792
2570
  description: string;
@@ -8903,6 +9681,11 @@ export declare const state: {
8903
9681
  type: "string";
8904
9682
  description: string;
8905
9683
  };
9684
+ version: {
9685
+ in: "query";
9686
+ type: "string";
9687
+ description: string;
9688
+ };
8906
9689
  };
8907
9690
  response: {
8908
9691
  description: string;
@@ -9520,6 +10303,10 @@ export declare const state: {
9520
10303
  listPublicIntegrationsResponse: true;
9521
10304
  getPublicIntegrationByIdResponse: true;
9522
10305
  getPublicIntegrationResponse: true;
10306
+ listPublicPluginsResponse: true;
10307
+ getPublicPluginByIdResponse: true;
10308
+ getPublicPluginResponse: true;
10309
+ getPublicPluginCodeResponse: true;
9523
10310
  createBotResponse: true;
9524
10311
  updateBotResponse: true;
9525
10312
  transferBotResponse: true;