@botpress/api 1.4.0 → 1.5.1

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 (16) hide show
  1. package/dist/index.js +2425 -589
  2. package/dist/src/gen/admin/state.d.ts +787 -0
  3. package/dist/src/gen/state.d.ts +787 -0
  4. package/package.json +1 -1
  5. package/src/gen/admin/metadata.json +1 -1
  6. package/src/gen/admin/openapi.json +1 -1
  7. package/src/gen/admin/state.ts +920 -2
  8. package/src/gen/files/openapi.json +1 -1
  9. package/src/gen/files/state.ts +1 -1
  10. package/src/gen/metadata.json +1 -1
  11. package/src/gen/openapi.json +1 -1
  12. package/src/gen/runtime/openapi.json +1 -1
  13. package/src/gen/runtime/state.ts +1 -1
  14. package/src/gen/state.ts +920 -2
  15. package/src/gen/tables/openapi.json +1 -1
  16. package/src/gen/tables/state.ts +1 -1
package/src/gen/admin/state.ts CHANGED
@@ -2076,6 +2076,911 @@ export const state = {
2076
2076
  }
2077
2077
  }
2078
2078
  },
2079
+ "listPublicPlugins": {
2080
+ "name": "listPublicPlugins",
2081
+ "description": "List public plugin",
2082
+ "method": "get",
2083
+ "section": "hub",
2084
+ "path": "/v1/admin/hub/plugins",
2085
+ "disableDefaultParameters": {
2086
+ "x-workspace-id": true
2087
+ },
2088
+ "parameters": {
2089
+ "nextToken": {
2090
+ "in": "query",
2091
+ "description": "Provide the `meta.nextToken` value provided in the last API response to retrieve the next page of results",
2092
+ "type": "string"
2093
+ },
2094
+ "name": {
2095
+ "in": "query",
2096
+ "type": "string",
2097
+ "description": "Filter all versions of a plugin by name"
2098
+ },
2099
+ "version": {
2100
+ "in": "query",
2101
+ "type": "string",
2102
+ "description": "Filter a plugin by name and version"
2103
+ }
2104
+ },
2105
+ "response": {
2106
+ "description": "Success",
2107
+ "schema": {
2108
+ "type": "object",
2109
+ "properties": {
2110
+ "plugins": {
2111
+ "type": "array",
2112
+ "items": {
2113
+ "type": "object",
2114
+ "properties": {
2115
+ "id": {
2116
+ "type": "string",
2117
+ "minLength": 28,
2118
+ "maxLength": 36,
2119
+ "description": "ID of the [Plugin](#schema_plugin)"
2120
+ },
2121
+ "createdAt": {
2122
+ "type": "string",
2123
+ "format": "date-time",
2124
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
2125
+ },
2126
+ "updatedAt": {
2127
+ "type": "string",
2128
+ "format": "date-time",
2129
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
2130
+ },
2131
+ "name": {
2132
+ "type": "string",
2133
+ "maxLength": 200,
2134
+ "description": "Name of the [Plugin](#schema_plugin)"
2135
+ },
2136
+ "version": {
2137
+ "type": "string",
2138
+ "maxLength": 200,
2139
+ "description": "Version of the [Plugin](#schema_plugin)"
2140
+ },
2141
+ "title": {
2142
+ "type": "string",
2143
+ "minLength": 1,
2144
+ "maxLength": 64,
2145
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
2146
+ },
2147
+ "description": {
2148
+ "type": "string",
2149
+ "maxLength": 256,
2150
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
2151
+ },
2152
+ "iconUrl": {
2153
+ "type": "string",
2154
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
2155
+ },
2156
+ "readmeUrl": {
2157
+ "type": "string",
2158
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
2159
+ },
2160
+ "public": {
2161
+ "type": "boolean",
2162
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
2163
+ }
2164
+ },
2165
+ "required": [
2166
+ "id",
2167
+ "createdAt",
2168
+ "updatedAt",
2169
+ "name",
2170
+ "version",
2171
+ "title",
2172
+ "description",
2173
+ "iconUrl",
2174
+ "readmeUrl",
2175
+ "public"
2176
+ ]
2177
+ }
2178
+ },
2179
+ "meta": {
2180
+ "type": "object",
2181
+ "properties": {
2182
+ "nextToken": {
2183
+ "type": "string",
2184
+ "description": "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."
2185
+ }
2186
+ },
2187
+ "additionalProperties": false
2188
+ }
2189
+ },
2190
+ "required": [
2191
+ "plugins",
2192
+ "meta"
2193
+ ],
2194
+ "title": "listPublicPluginsResponse",
2195
+ "additionalProperties": false
2196
+ }
2197
+ }
2198
+ },
2199
+ "getPublicPluginById": {
2200
+ "name": "getPublicPluginById",
2201
+ "description": "Get public plugin by Id",
2202
+ "method": "get",
2203
+ "section": "hub",
2204
+ "path": "/v1/admin/hub/plugins/{id}",
2205
+ "disableDefaultParameters": {
2206
+ "x-workspace-id": true
2207
+ },
2208
+ "parameters": {
2209
+ "id": {
2210
+ "type": "string",
2211
+ "description": "Plugin ID",
2212
+ "in": "path"
2213
+ }
2214
+ },
2215
+ "response": {
2216
+ "description": "Success",
2217
+ "schema": {
2218
+ "type": "object",
2219
+ "properties": {
2220
+ "plugin": {
2221
+ "type": "object",
2222
+ "properties": {
2223
+ "id": {
2224
+ "type": "string",
2225
+ "minLength": 28,
2226
+ "maxLength": 36,
2227
+ "description": "ID of the [Plugin](#schema_plugin)"
2228
+ },
2229
+ "name": {
2230
+ "type": "string",
2231
+ "maxLength": 200,
2232
+ "description": "Name of the [Plugin](#schema_plugin)"
2233
+ },
2234
+ "version": {
2235
+ "type": "string",
2236
+ "maxLength": 200,
2237
+ "description": "Version of the [Plugin](#schema_plugin)"
2238
+ },
2239
+ "createdAt": {
2240
+ "type": "string",
2241
+ "format": "date-time",
2242
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
2243
+ },
2244
+ "updatedAt": {
2245
+ "type": "string",
2246
+ "format": "date-time",
2247
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
2248
+ },
2249
+ "configuration": {
2250
+ "type": "object",
2251
+ "properties": {
2252
+ "title": {
2253
+ "type": "string",
2254
+ "maxLength": 64,
2255
+ "description": "Title of the configuration"
2256
+ },
2257
+ "description": {
2258
+ "type": "string",
2259
+ "maxLength": 256,
2260
+ "description": "Description of the configuration"
2261
+ },
2262
+ "schema": {
2263
+ "type": "object",
2264
+ "additionalProperties": true,
2265
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
2266
+ }
2267
+ },
2268
+ "required": [
2269
+ "schema"
2270
+ ],
2271
+ "description": "Configuration definition",
2272
+ "additionalProperties": false
2273
+ },
2274
+ "states": {
2275
+ "type": "object",
2276
+ "additionalProperties": {
2277
+ "type": "object",
2278
+ "properties": {
2279
+ "type": {
2280
+ "type": "string",
2281
+ "enum": [
2282
+ "conversation",
2283
+ "user",
2284
+ "bot",
2285
+ "task"
2286
+ ],
2287
+ "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
2288
+ },
2289
+ "schema": {
2290
+ "type": "object",
2291
+ "additionalProperties": true,
2292
+ "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
2293
+ },
2294
+ "expiry": {
2295
+ "type": "number",
2296
+ "minimum": 1,
2297
+ "description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
2298
+ }
2299
+ },
2300
+ "required": [
2301
+ "type",
2302
+ "schema"
2303
+ ],
2304
+ "additionalProperties": false
2305
+ }
2306
+ },
2307
+ "events": {
2308
+ "type": "object",
2309
+ "additionalProperties": {
2310
+ "type": "object",
2311
+ "properties": {
2312
+ "title": {
2313
+ "type": "string",
2314
+ "maxLength": 64,
2315
+ "description": "Title of the event"
2316
+ },
2317
+ "description": {
2318
+ "type": "string",
2319
+ "maxLength": 256,
2320
+ "description": "Description of the event"
2321
+ },
2322
+ "schema": {
2323
+ "type": "object",
2324
+ "additionalProperties": true
2325
+ }
2326
+ },
2327
+ "required": [
2328
+ "schema"
2329
+ ],
2330
+ "description": "Event Definition",
2331
+ "additionalProperties": false
2332
+ }
2333
+ },
2334
+ "actions": {
2335
+ "type": "object",
2336
+ "additionalProperties": {
2337
+ "type": "object",
2338
+ "properties": {
2339
+ "title": {
2340
+ "type": "string",
2341
+ "maxLength": 64,
2342
+ "description": "Title of the action"
2343
+ },
2344
+ "description": {
2345
+ "type": "string",
2346
+ "maxLength": 256,
2347
+ "description": "Description of the action"
2348
+ },
2349
+ "billable": {
2350
+ "type": "boolean"
2351
+ },
2352
+ "cacheable": {
2353
+ "type": "boolean"
2354
+ },
2355
+ "input": {
2356
+ "type": "object",
2357
+ "properties": {
2358
+ "schema": {
2359
+ "type": "object",
2360
+ "additionalProperties": true
2361
+ }
2362
+ },
2363
+ "required": [
2364
+ "schema"
2365
+ ],
2366
+ "additionalProperties": false
2367
+ },
2368
+ "output": {
2369
+ "type": "object",
2370
+ "properties": {
2371
+ "schema": {
2372
+ "type": "object",
2373
+ "additionalProperties": true
2374
+ }
2375
+ },
2376
+ "required": [
2377
+ "schema"
2378
+ ],
2379
+ "additionalProperties": false
2380
+ }
2381
+ },
2382
+ "required": [
2383
+ "input",
2384
+ "output"
2385
+ ],
2386
+ "description": "Action definition",
2387
+ "additionalProperties": false
2388
+ }
2389
+ },
2390
+ "dependencies": {
2391
+ "type": "object",
2392
+ "properties": {
2393
+ "interfaces": {
2394
+ "type": "object",
2395
+ "additionalProperties": {
2396
+ "type": "object",
2397
+ "properties": {
2398
+ "id": {
2399
+ "type": "string",
2400
+ "minLength": 28,
2401
+ "maxLength": 36
2402
+ },
2403
+ "name": {
2404
+ "type": "string",
2405
+ "maxLength": 200
2406
+ },
2407
+ "version": {
2408
+ "type": "string",
2409
+ "maxLength": 200
2410
+ }
2411
+ },
2412
+ "required": [
2413
+ "id",
2414
+ "name",
2415
+ "version"
2416
+ ],
2417
+ "additionalProperties": false
2418
+ }
2419
+ },
2420
+ "integrations": {
2421
+ "type": "object",
2422
+ "additionalProperties": {
2423
+ "type": "object",
2424
+ "properties": {
2425
+ "id": {
2426
+ "type": "string",
2427
+ "minLength": 28,
2428
+ "maxLength": 36
2429
+ },
2430
+ "name": {
2431
+ "type": "string",
2432
+ "maxLength": 200
2433
+ },
2434
+ "version": {
2435
+ "type": "string",
2436
+ "maxLength": 200
2437
+ }
2438
+ },
2439
+ "required": [
2440
+ "id",
2441
+ "name",
2442
+ "version"
2443
+ ],
2444
+ "additionalProperties": false
2445
+ }
2446
+ }
2447
+ },
2448
+ "required": [
2449
+ "interfaces",
2450
+ "integrations"
2451
+ ],
2452
+ "additionalProperties": false
2453
+ },
2454
+ "user": {
2455
+ "type": "object",
2456
+ "properties": {
2457
+ "tags": {
2458
+ "type": "object",
2459
+ "additionalProperties": {
2460
+ "type": "object",
2461
+ "properties": {
2462
+ "title": {
2463
+ "type": "string",
2464
+ "maxLength": 64,
2465
+ "description": "Title of the tag"
2466
+ },
2467
+ "description": {
2468
+ "type": "string",
2469
+ "maxLength": 256,
2470
+ "description": "Description of the tag"
2471
+ }
2472
+ },
2473
+ "description": "Definition of a tag that can be provided on the object",
2474
+ "additionalProperties": false
2475
+ }
2476
+ }
2477
+ },
2478
+ "required": [
2479
+ "tags"
2480
+ ],
2481
+ "description": "User object configuration",
2482
+ "additionalProperties": false
2483
+ },
2484
+ "conversation": {
2485
+ "type": "object",
2486
+ "properties": {
2487
+ "tags": {
2488
+ "type": "object",
2489
+ "additionalProperties": {
2490
+ "type": "object",
2491
+ "properties": {
2492
+ "title": {
2493
+ "type": "string",
2494
+ "maxLength": 64,
2495
+ "description": "Title of the tag"
2496
+ },
2497
+ "description": {
2498
+ "type": "string",
2499
+ "maxLength": 256,
2500
+ "description": "Description of the tag"
2501
+ }
2502
+ },
2503
+ "description": "Definition of a tag that can be provided on the object",
2504
+ "additionalProperties": false
2505
+ }
2506
+ }
2507
+ },
2508
+ "required": [
2509
+ "tags"
2510
+ ],
2511
+ "description": "Conversation object configuration",
2512
+ "additionalProperties": false
2513
+ },
2514
+ "title": {
2515
+ "type": "string",
2516
+ "minLength": 1,
2517
+ "maxLength": 64,
2518
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
2519
+ },
2520
+ "description": {
2521
+ "type": "string",
2522
+ "maxLength": 256,
2523
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
2524
+ },
2525
+ "iconUrl": {
2526
+ "type": "string",
2527
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
2528
+ },
2529
+ "readmeUrl": {
2530
+ "type": "string",
2531
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
2532
+ },
2533
+ "public": {
2534
+ "type": "boolean",
2535
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
2536
+ }
2537
+ },
2538
+ "required": [
2539
+ "id",
2540
+ "name",
2541
+ "version",
2542
+ "createdAt",
2543
+ "updatedAt",
2544
+ "configuration",
2545
+ "states",
2546
+ "events",
2547
+ "actions",
2548
+ "dependencies",
2549
+ "user",
2550
+ "conversation",
2551
+ "title",
2552
+ "description",
2553
+ "iconUrl",
2554
+ "readmeUrl",
2555
+ "public"
2556
+ ],
2557
+ "additionalProperties": false
2558
+ }
2559
+ },
2560
+ "required": [
2561
+ "plugin"
2562
+ ],
2563
+ "title": "getPublicPluginByIdResponse",
2564
+ "additionalProperties": false
2565
+ }
2566
+ }
2567
+ },
2568
+ "getPublicPlugin": {
2569
+ "name": "getPublicPlugin",
2570
+ "description": "Get public plugin by name and version",
2571
+ "method": "get",
2572
+ "section": "hub",
2573
+ "path": "/v1/admin/hub/plugins/{name}/{version}",
2574
+ "disableDefaultParameters": {
2575
+ "x-workspace-id": true
2576
+ },
2577
+ "parameters": {
2578
+ "name": {
2579
+ "type": "string",
2580
+ "description": "Plugin Name",
2581
+ "in": "path"
2582
+ },
2583
+ "version": {
2584
+ "type": "string",
2585
+ "description": "Plugin version.",
2586
+ "in": "path"
2587
+ }
2588
+ },
2589
+ "response": {
2590
+ "description": "Success",
2591
+ "schema": {
2592
+ "type": "object",
2593
+ "properties": {
2594
+ "plugin": {
2595
+ "type": "object",
2596
+ "properties": {
2597
+ "id": {
2598
+ "type": "string",
2599
+ "minLength": 28,
2600
+ "maxLength": 36,
2601
+ "description": "ID of the [Plugin](#schema_plugin)"
2602
+ },
2603
+ "name": {
2604
+ "type": "string",
2605
+ "maxLength": 200,
2606
+ "description": "Name of the [Plugin](#schema_plugin)"
2607
+ },
2608
+ "version": {
2609
+ "type": "string",
2610
+ "maxLength": 200,
2611
+ "description": "Version of the [Plugin](#schema_plugin)"
2612
+ },
2613
+ "createdAt": {
2614
+ "type": "string",
2615
+ "format": "date-time",
2616
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
2617
+ },
2618
+ "updatedAt": {
2619
+ "type": "string",
2620
+ "format": "date-time",
2621
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
2622
+ },
2623
+ "configuration": {
2624
+ "type": "object",
2625
+ "properties": {
2626
+ "title": {
2627
+ "type": "string",
2628
+ "maxLength": 64,
2629
+ "description": "Title of the configuration"
2630
+ },
2631
+ "description": {
2632
+ "type": "string",
2633
+ "maxLength": 256,
2634
+ "description": "Description of the configuration"
2635
+ },
2636
+ "schema": {
2637
+ "type": "object",
2638
+ "additionalProperties": true,
2639
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
2640
+ }
2641
+ },
2642
+ "required": [
2643
+ "schema"
2644
+ ],
2645
+ "description": "Configuration definition",
2646
+ "additionalProperties": false
2647
+ },
2648
+ "states": {
2649
+ "type": "object",
2650
+ "additionalProperties": {
2651
+ "type": "object",
2652
+ "properties": {
2653
+ "type": {
2654
+ "type": "string",
2655
+ "enum": [
2656
+ "conversation",
2657
+ "user",
2658
+ "bot",
2659
+ "task"
2660
+ ],
2661
+ "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
2662
+ },
2663
+ "schema": {
2664
+ "type": "object",
2665
+ "additionalProperties": true,
2666
+ "description": "Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data."
2667
+ },
2668
+ "expiry": {
2669
+ "type": "number",
2670
+ "minimum": 1,
2671
+ "description": "Expiry of the [State](#schema_state) in milliseconds. The state will expire if it is idle for the configured value. By default, a state doesn't expire."
2672
+ }
2673
+ },
2674
+ "required": [
2675
+ "type",
2676
+ "schema"
2677
+ ],
2678
+ "additionalProperties": false
2679
+ }
2680
+ },
2681
+ "events": {
2682
+ "type": "object",
2683
+ "additionalProperties": {
2684
+ "type": "object",
2685
+ "properties": {
2686
+ "title": {
2687
+ "type": "string",
2688
+ "maxLength": 64,
2689
+ "description": "Title of the event"
2690
+ },
2691
+ "description": {
2692
+ "type": "string",
2693
+ "maxLength": 256,
2694
+ "description": "Description of the event"
2695
+ },
2696
+ "schema": {
2697
+ "type": "object",
2698
+ "additionalProperties": true
2699
+ }
2700
+ },
2701
+ "required": [
2702
+ "schema"
2703
+ ],
2704
+ "description": "Event Definition",
2705
+ "additionalProperties": false
2706
+ }
2707
+ },
2708
+ "actions": {
2709
+ "type": "object",
2710
+ "additionalProperties": {
2711
+ "type": "object",
2712
+ "properties": {
2713
+ "title": {
2714
+ "type": "string",
2715
+ "maxLength": 64,
2716
+ "description": "Title of the action"
2717
+ },
2718
+ "description": {
2719
+ "type": "string",
2720
+ "maxLength": 256,
2721
+ "description": "Description of the action"
2722
+ },
2723
+ "billable": {
2724
+ "type": "boolean"
2725
+ },
2726
+ "cacheable": {
2727
+ "type": "boolean"
2728
+ },
2729
+ "input": {
2730
+ "type": "object",
2731
+ "properties": {
2732
+ "schema": {
2733
+ "type": "object",
2734
+ "additionalProperties": true
2735
+ }
2736
+ },
2737
+ "required": [
2738
+ "schema"
2739
+ ],
2740
+ "additionalProperties": false
2741
+ },
2742
+ "output": {
2743
+ "type": "object",
2744
+ "properties": {
2745
+ "schema": {
2746
+ "type": "object",
2747
+ "additionalProperties": true
2748
+ }
2749
+ },
2750
+ "required": [
2751
+ "schema"
2752
+ ],
2753
+ "additionalProperties": false
2754
+ }
2755
+ },
2756
+ "required": [
2757
+ "input",
2758
+ "output"
2759
+ ],
2760
+ "description": "Action definition",
2761
+ "additionalProperties": false
2762
+ }
2763
+ },
2764
+ "dependencies": {
2765
+ "type": "object",
2766
+ "properties": {
2767
+ "interfaces": {
2768
+ "type": "object",
2769
+ "additionalProperties": {
2770
+ "type": "object",
2771
+ "properties": {
2772
+ "id": {
2773
+ "type": "string",
2774
+ "minLength": 28,
2775
+ "maxLength": 36
2776
+ },
2777
+ "name": {
2778
+ "type": "string",
2779
+ "maxLength": 200
2780
+ },
2781
+ "version": {
2782
+ "type": "string",
2783
+ "maxLength": 200
2784
+ }
2785
+ },
2786
+ "required": [
2787
+ "id",
2788
+ "name",
2789
+ "version"
2790
+ ],
2791
+ "additionalProperties": false
2792
+ }
2793
+ },
2794
+ "integrations": {
2795
+ "type": "object",
2796
+ "additionalProperties": {
2797
+ "type": "object",
2798
+ "properties": {
2799
+ "id": {
2800
+ "type": "string",
2801
+ "minLength": 28,
2802
+ "maxLength": 36
2803
+ },
2804
+ "name": {
2805
+ "type": "string",
2806
+ "maxLength": 200
2807
+ },
2808
+ "version": {
2809
+ "type": "string",
2810
+ "maxLength": 200
2811
+ }
2812
+ },
2813
+ "required": [
2814
+ "id",
2815
+ "name",
2816
+ "version"
2817
+ ],
2818
+ "additionalProperties": false
2819
+ }
2820
+ }
2821
+ },
2822
+ "required": [
2823
+ "interfaces",
2824
+ "integrations"
2825
+ ],
2826
+ "additionalProperties": false
2827
+ },
2828
+ "user": {
2829
+ "type": "object",
2830
+ "properties": {
2831
+ "tags": {
2832
+ "type": "object",
2833
+ "additionalProperties": {
2834
+ "type": "object",
2835
+ "properties": {
2836
+ "title": {
2837
+ "type": "string",
2838
+ "maxLength": 64,
2839
+ "description": "Title of the tag"
2840
+ },
2841
+ "description": {
2842
+ "type": "string",
2843
+ "maxLength": 256,
2844
+ "description": "Description of the tag"
2845
+ }
2846
+ },
2847
+ "description": "Definition of a tag that can be provided on the object",
2848
+ "additionalProperties": false
2849
+ }
2850
+ }
2851
+ },
2852
+ "required": [
2853
+ "tags"
2854
+ ],
2855
+ "description": "User object configuration",
2856
+ "additionalProperties": false
2857
+ },
2858
+ "conversation": {
2859
+ "type": "object",
2860
+ "properties": {
2861
+ "tags": {
2862
+ "type": "object",
2863
+ "additionalProperties": {
2864
+ "type": "object",
2865
+ "properties": {
2866
+ "title": {
2867
+ "type": "string",
2868
+ "maxLength": 64,
2869
+ "description": "Title of the tag"
2870
+ },
2871
+ "description": {
2872
+ "type": "string",
2873
+ "maxLength": 256,
2874
+ "description": "Description of the tag"
2875
+ }
2876
+ },
2877
+ "description": "Definition of a tag that can be provided on the object",
2878
+ "additionalProperties": false
2879
+ }
2880
+ }
2881
+ },
2882
+ "required": [
2883
+ "tags"
2884
+ ],
2885
+ "description": "Conversation object configuration",
2886
+ "additionalProperties": false
2887
+ },
2888
+ "title": {
2889
+ "type": "string",
2890
+ "minLength": 1,
2891
+ "maxLength": 64,
2892
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
2893
+ },
2894
+ "description": {
2895
+ "type": "string",
2896
+ "maxLength": 256,
2897
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
2898
+ },
2899
+ "iconUrl": {
2900
+ "type": "string",
2901
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
2902
+ },
2903
+ "readmeUrl": {
2904
+ "type": "string",
2905
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
2906
+ },
2907
+ "public": {
2908
+ "type": "boolean",
2909
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
2910
+ }
2911
+ },
2912
+ "required": [
2913
+ "id",
2914
+ "name",
2915
+ "version",
2916
+ "createdAt",
2917
+ "updatedAt",
2918
+ "configuration",
2919
+ "states",
2920
+ "events",
2921
+ "actions",
2922
+ "dependencies",
2923
+ "user",
2924
+ "conversation",
2925
+ "title",
2926
+ "description",
2927
+ "iconUrl",
2928
+ "readmeUrl",
2929
+ "public"
2930
+ ],
2931
+ "additionalProperties": false
2932
+ }
2933
+ },
2934
+ "required": [
2935
+ "plugin"
2936
+ ],
2937
+ "title": "getPublicPluginResponse",
2938
+ "additionalProperties": false
2939
+ }
2940
+ }
2941
+ },
2942
+ "getPublicPluginCode": {
2943
+ "name": "getPublicPluginCode",
2944
+ "description": "Get public plugin code",
2945
+ "method": "get",
2946
+ "path": "/v1/admin/hub/plugins/{id}/code/{platform}",
2947
+ "disableDefaultParameters": {
2948
+ "x-workspace-id": true
2949
+ },
2950
+ "section": "hub",
2951
+ "parameters": {
2952
+ "id": {
2953
+ "in": "path",
2954
+ "type": "string",
2955
+ "description": "Plugin id"
2956
+ },
2957
+ "platform": {
2958
+ "in": "path",
2959
+ "type": "string",
2960
+ "enum": [
2961
+ "node",
2962
+ "browser"
2963
+ ],
2964
+ "description": "Platform"
2965
+ }
2966
+ },
2967
+ "response": {
2968
+ "description": "Plugin code",
2969
+ "schema": {
2970
+ "type": "object",
2971
+ "properties": {
2972
+ "code": {
2973
+ "type": "string"
2974
+ }
2975
+ },
2976
+ "required": [
2977
+ "code"
2978
+ ],
2979
+ "title": "getPublicPluginCodeResponse",
2980
+ "additionalProperties": false
2981
+ }
2982
+ }
2983
+ },
2079
2984
  "createBot": {
2080
2985
  "name": "createBot",
2081
2986
  "description": "Create bot",
@@ -10094,6 +10999,11 @@ export const state = {
10094
10999
  "in": "query",
10095
11000
  "type": "string",
10096
11001
  "description": "Filter all versions of a plugin by name"
11002
+ },
11003
+ "version": {
11004
+ "in": "query",
11005
+ "type": "string",
11006
+ "description": "Filter a plugin by name and version"
10097
11007
  }
10098
11008
  },
10099
11009
  "response": {
@@ -10726,7 +11636,7 @@ export const state = {
10726
11636
  "title": "Botpress API",
10727
11637
  "description": "API for Botpress Cloud",
10728
11638
  "server": "https://api.botpress.cloud",
10729
- "version": "1.4.0",
11639
+ "version": "1.5.1",
10730
11640
  "prefix": "v1"
10731
11641
  },
10732
11642
  "errors": [
@@ -10895,6 +11805,10 @@ export const state = {
10895
11805
  "listPublicIntegrationsResponse": true,
10896
11806
  "getPublicIntegrationByIdResponse": true,
10897
11807
  "getPublicIntegrationResponse": true,
11808
+ "listPublicPluginsResponse": true,
11809
+ "getPublicPluginByIdResponse": true,
11810
+ "getPublicPluginResponse": true,
11811
+ "getPublicPluginCodeResponse": true,
10898
11812
  "createBotResponse": true,
10899
11813
  "updateBotResponse": true,
10900
11814
  "transferBotResponse": true,
@@ -14262,7 +15176,11 @@ export const state = {
14262
15176
  "operations": [
14263
15177
  "listPublicIntegrations",
14264
15178
  "getPublicIntegrationById",
14265
- "getPublicIntegration"
15179
+ "getPublicIntegration",
15180
+ "listPublicPlugins",
15181
+ "getPublicPluginById",
15182
+ "getPublicPlugin",
15183
+ "getPublicPluginCode"
14266
15184
  ]
14267
15185
  },
14268
15186
  {