@botpress/api 1.25.0 → 1.26.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.
Files changed (16) hide show
  1. package/dist/index.js +1525 -615
  2. package/dist/src/gen/admin/state.d.ts +397 -0
  3. package/dist/src/gen/state.d.ts +397 -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 +456 -1
  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 +456 -1
  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
@@ -2664,6 +2664,413 @@ export const state = {
2664
2664
  }
2665
2665
  }
2666
2666
  },
2667
+ "getDereferencedPublicPluginById": {
2668
+ "name": "getDereferencedPublicPluginById",
2669
+ "description": "Get public plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
2670
+ "method": "get",
2671
+ "section": "hub",
2672
+ "path": "/v1/admin/hub/plugins/{id}/dereferenced",
2673
+ "disableDefaultParameters": {
2674
+ "x-workspace-id": true
2675
+ },
2676
+ "parameters": {
2677
+ "id": {
2678
+ "type": "string",
2679
+ "description": "Plugin ID",
2680
+ "in": "path"
2681
+ },
2682
+ "interfaces": {
2683
+ "in": "query",
2684
+ "type": "object",
2685
+ "schema": {
2686
+ "type": "object",
2687
+ "additionalProperties": {
2688
+ "type": "string",
2689
+ "description": "integration id"
2690
+ },
2691
+ "description": "Mapping of interface aliases to integration IDs"
2692
+ },
2693
+ "description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
2694
+ "required": true
2695
+ }
2696
+ },
2697
+ "response": {
2698
+ "description": "Success",
2699
+ "schema": {
2700
+ "type": "object",
2701
+ "properties": {
2702
+ "plugin": {
2703
+ "type": "object",
2704
+ "properties": {
2705
+ "id": {
2706
+ "type": "string",
2707
+ "minLength": 28,
2708
+ "maxLength": 36,
2709
+ "description": "ID of the [Plugin](#schema_plugin)"
2710
+ },
2711
+ "name": {
2712
+ "type": "string",
2713
+ "maxLength": 200,
2714
+ "description": "Name of the [Plugin](#schema_plugin)"
2715
+ },
2716
+ "version": {
2717
+ "type": "string",
2718
+ "maxLength": 200,
2719
+ "description": "Version of the [Plugin](#schema_plugin)"
2720
+ },
2721
+ "createdAt": {
2722
+ "type": "string",
2723
+ "format": "date-time",
2724
+ "description": "Creation date of the [Plugin](#schema_plugin) in ISO 8601 format"
2725
+ },
2726
+ "updatedAt": {
2727
+ "type": "string",
2728
+ "format": "date-time",
2729
+ "description": "Updating date of the [Plugin](#schema_plugin) in ISO 8601 format"
2730
+ },
2731
+ "configuration": {
2732
+ "type": "object",
2733
+ "properties": {
2734
+ "title": {
2735
+ "type": "string",
2736
+ "maxLength": 64,
2737
+ "description": "Title of the configuration"
2738
+ },
2739
+ "description": {
2740
+ "type": "string",
2741
+ "maxLength": 256,
2742
+ "description": "Description of the configuration"
2743
+ },
2744
+ "schema": {
2745
+ "type": "object",
2746
+ "additionalProperties": true,
2747
+ "description": "Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`."
2748
+ }
2749
+ },
2750
+ "required": [
2751
+ "schema"
2752
+ ],
2753
+ "description": "Configuration definition",
2754
+ "additionalProperties": false
2755
+ },
2756
+ "states": {
2757
+ "type": "object",
2758
+ "additionalProperties": {
2759
+ "type": "object",
2760
+ "properties": {
2761
+ "type": {
2762
+ "type": "string",
2763
+ "enum": [
2764
+ "conversation",
2765
+ "user",
2766
+ "bot",
2767
+ "task"
2768
+ ],
2769
+ "description": "Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)"
2770
+ },
2771
+ "schema": {
2772
+ "type": "object",
2773
+ "additionalProperties": true,
2774
+ "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."
2775
+ },
2776
+ "expiry": {
2777
+ "type": "number",
2778
+ "minimum": 1,
2779
+ "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."
2780
+ }
2781
+ },
2782
+ "required": [
2783
+ "type",
2784
+ "schema"
2785
+ ],
2786
+ "additionalProperties": false
2787
+ }
2788
+ },
2789
+ "events": {
2790
+ "type": "object",
2791
+ "additionalProperties": {
2792
+ "type": "object",
2793
+ "properties": {
2794
+ "title": {
2795
+ "type": "string",
2796
+ "maxLength": 64,
2797
+ "description": "Title of the event"
2798
+ },
2799
+ "description": {
2800
+ "type": "string",
2801
+ "maxLength": 256,
2802
+ "description": "Description of the event"
2803
+ },
2804
+ "schema": {
2805
+ "type": "object",
2806
+ "additionalProperties": true
2807
+ },
2808
+ "attributes": {
2809
+ "type": "object",
2810
+ "additionalProperties": {
2811
+ "type": "string",
2812
+ "maxLength": 200
2813
+ },
2814
+ "description": "Optional attributes"
2815
+ }
2816
+ },
2817
+ "required": [
2818
+ "schema"
2819
+ ],
2820
+ "description": "Event Definition",
2821
+ "additionalProperties": false
2822
+ }
2823
+ },
2824
+ "actions": {
2825
+ "type": "object",
2826
+ "additionalProperties": {
2827
+ "type": "object",
2828
+ "properties": {
2829
+ "title": {
2830
+ "type": "string",
2831
+ "maxLength": 64,
2832
+ "description": "Title of the action"
2833
+ },
2834
+ "description": {
2835
+ "type": "string",
2836
+ "maxLength": 256,
2837
+ "description": "Description of the action"
2838
+ },
2839
+ "billable": {
2840
+ "type": "boolean"
2841
+ },
2842
+ "cacheable": {
2843
+ "type": "boolean"
2844
+ },
2845
+ "input": {
2846
+ "type": "object",
2847
+ "properties": {
2848
+ "schema": {
2849
+ "type": "object",
2850
+ "additionalProperties": true
2851
+ }
2852
+ },
2853
+ "required": [
2854
+ "schema"
2855
+ ],
2856
+ "additionalProperties": false
2857
+ },
2858
+ "output": {
2859
+ "type": "object",
2860
+ "properties": {
2861
+ "schema": {
2862
+ "type": "object",
2863
+ "additionalProperties": true
2864
+ }
2865
+ },
2866
+ "required": [
2867
+ "schema"
2868
+ ],
2869
+ "additionalProperties": false
2870
+ },
2871
+ "attributes": {
2872
+ "type": "object",
2873
+ "additionalProperties": {
2874
+ "type": "string",
2875
+ "maxLength": 200
2876
+ },
2877
+ "description": "Optional attributes"
2878
+ }
2879
+ },
2880
+ "required": [
2881
+ "input",
2882
+ "output"
2883
+ ],
2884
+ "description": "Action definition",
2885
+ "additionalProperties": false
2886
+ }
2887
+ },
2888
+ "dependencies": {
2889
+ "type": "object",
2890
+ "properties": {
2891
+ "interfaces": {
2892
+ "type": "object",
2893
+ "additionalProperties": {
2894
+ "type": "object",
2895
+ "properties": {
2896
+ "id": {
2897
+ "type": "string",
2898
+ "minLength": 28,
2899
+ "maxLength": 36
2900
+ },
2901
+ "name": {
2902
+ "type": "string",
2903
+ "maxLength": 200
2904
+ },
2905
+ "version": {
2906
+ "type": "string",
2907
+ "maxLength": 200
2908
+ }
2909
+ },
2910
+ "required": [
2911
+ "id",
2912
+ "name",
2913
+ "version"
2914
+ ],
2915
+ "additionalProperties": false
2916
+ }
2917
+ },
2918
+ "integrations": {
2919
+ "type": "object",
2920
+ "additionalProperties": {
2921
+ "type": "object",
2922
+ "properties": {
2923
+ "id": {
2924
+ "type": "string",
2925
+ "minLength": 28,
2926
+ "maxLength": 36
2927
+ },
2928
+ "name": {
2929
+ "type": "string",
2930
+ "maxLength": 200
2931
+ },
2932
+ "version": {
2933
+ "type": "string",
2934
+ "maxLength": 200
2935
+ }
2936
+ },
2937
+ "required": [
2938
+ "id",
2939
+ "name",
2940
+ "version"
2941
+ ],
2942
+ "additionalProperties": false
2943
+ }
2944
+ }
2945
+ },
2946
+ "required": [
2947
+ "interfaces",
2948
+ "integrations"
2949
+ ],
2950
+ "additionalProperties": false
2951
+ },
2952
+ "user": {
2953
+ "type": "object",
2954
+ "properties": {
2955
+ "tags": {
2956
+ "type": "object",
2957
+ "additionalProperties": {
2958
+ "type": "object",
2959
+ "properties": {
2960
+ "title": {
2961
+ "type": "string",
2962
+ "maxLength": 64,
2963
+ "description": "Title of the tag"
2964
+ },
2965
+ "description": {
2966
+ "type": "string",
2967
+ "maxLength": 256,
2968
+ "description": "Description of the tag"
2969
+ }
2970
+ },
2971
+ "description": "Definition of a tag that can be provided on the object",
2972
+ "additionalProperties": false
2973
+ }
2974
+ }
2975
+ },
2976
+ "required": [
2977
+ "tags"
2978
+ ],
2979
+ "description": "User object configuration",
2980
+ "additionalProperties": false
2981
+ },
2982
+ "conversation": {
2983
+ "type": "object",
2984
+ "properties": {
2985
+ "tags": {
2986
+ "type": "object",
2987
+ "additionalProperties": {
2988
+ "type": "object",
2989
+ "properties": {
2990
+ "title": {
2991
+ "type": "string",
2992
+ "maxLength": 64,
2993
+ "description": "Title of the tag"
2994
+ },
2995
+ "description": {
2996
+ "type": "string",
2997
+ "maxLength": 256,
2998
+ "description": "Description of the tag"
2999
+ }
3000
+ },
3001
+ "description": "Definition of a tag that can be provided on the object",
3002
+ "additionalProperties": false
3003
+ }
3004
+ }
3005
+ },
3006
+ "required": [
3007
+ "tags"
3008
+ ],
3009
+ "description": "Conversation object configuration",
3010
+ "additionalProperties": false
3011
+ },
3012
+ "attributes": {
3013
+ "type": "object",
3014
+ "additionalProperties": {
3015
+ "type": "string",
3016
+ "maxLength": 200
3017
+ },
3018
+ "description": "Optional attributes"
3019
+ },
3020
+ "title": {
3021
+ "type": "string",
3022
+ "minLength": 1,
3023
+ "maxLength": 64,
3024
+ "description": "Title of the plugin. This is the name that will be displayed in the UI"
3025
+ },
3026
+ "description": {
3027
+ "type": "string",
3028
+ "maxLength": 256,
3029
+ "description": "Description of the plugin. This is the description that will be displayed in the UI"
3030
+ },
3031
+ "iconUrl": {
3032
+ "type": "string",
3033
+ "description": "URL of the icon of the plugin. This is the icon that will be displayed in the UI"
3034
+ },
3035
+ "readmeUrl": {
3036
+ "type": "string",
3037
+ "description": "URL of the readme of the plugin. This is the readme that will be displayed in the UI"
3038
+ },
3039
+ "public": {
3040
+ "type": "boolean",
3041
+ "description": "Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version."
3042
+ }
3043
+ },
3044
+ "required": [
3045
+ "id",
3046
+ "name",
3047
+ "version",
3048
+ "createdAt",
3049
+ "updatedAt",
3050
+ "configuration",
3051
+ "states",
3052
+ "events",
3053
+ "actions",
3054
+ "dependencies",
3055
+ "user",
3056
+ "conversation",
3057
+ "title",
3058
+ "description",
3059
+ "iconUrl",
3060
+ "readmeUrl",
3061
+ "public"
3062
+ ],
3063
+ "additionalProperties": false
3064
+ }
3065
+ },
3066
+ "required": [
3067
+ "plugin"
3068
+ ],
3069
+ "title": "getDereferencedPublicPluginByIdResponse",
3070
+ "additionalProperties": false
3071
+ }
3072
+ }
3073
+ },
2667
3074
  "getPublicPlugin": {
2668
3075
  "name": "getPublicPlugin",
2669
3076
  "description": "Get public plugin by name and version",
@@ -12103,6 +12510,50 @@ export const state = {
12103
12510
  }
12104
12511
  }
12105
12512
  },
12513
+ "getDereferencedPlugin": {
12514
+ "name": "getDereferencedPlugin",
12515
+ "description": "Get plugin by Id with all interface entity references resolved to the corresponding entities as extended by the backing integrations",
12516
+ "method": "get",
12517
+ "section": "plugin",
12518
+ "path": "/v1/admin/plugins/{id}/dereferenced",
12519
+ "parameters": {
12520
+ "id": {
12521
+ "type": "string",
12522
+ "description": "Plugin ID",
12523
+ "in": "path"
12524
+ },
12525
+ "interfaces": {
12526
+ "in": "query",
12527
+ "type": "object",
12528
+ "schema": {
12529
+ "type": "object",
12530
+ "additionalProperties": {
12531
+ "type": "string",
12532
+ "description": "integration id"
12533
+ },
12534
+ "description": "Mapping of interface aliases to integration IDs"
12535
+ },
12536
+ "description": "Interfaces and their backing integrations. The plugin will be returned with all entity references resolved to the corresponding entities as extended by the backing integrations.",
12537
+ "required": true
12538
+ }
12539
+ },
12540
+ "response": {
12541
+ "description": "Get a dereferenced plugin",
12542
+ "schema": {
12543
+ "type": "object",
12544
+ "properties": {
12545
+ "plugin": {
12546
+ "$ref": "#/components/schemas/Plugin"
12547
+ }
12548
+ },
12549
+ "required": [
12550
+ "plugin"
12551
+ ],
12552
+ "title": "getDereferencedPluginResponse",
12553
+ "additionalProperties": false
12554
+ }
12555
+ }
12556
+ },
12106
12557
  "getPluginByName": {
12107
12558
  "name": "getPluginByName",
12108
12559
  "description": "Get Plugin by name and version",
@@ -13189,7 +13640,7 @@ export const state = {
13189
13640
  "title": "Botpress API",
13190
13641
  "description": "API for Botpress Cloud",
13191
13642
  "server": "https://api.botpress.cloud",
13192
- "version": "1.25.0",
13643
+ "version": "1.26.0",
13193
13644
  "prefix": "v1"
13194
13645
  },
13195
13646
  "errors": [
@@ -13364,6 +13815,7 @@ export const state = {
13364
13815
  "getPublicIntegrationResponse": true,
13365
13816
  "listPublicPluginsResponse": true,
13366
13817
  "getPublicPluginByIdResponse": true,
13818
+ "getDereferencedPublicPluginByIdResponse": true,
13367
13819
  "getPublicPluginResponse": true,
13368
13820
  "getPublicPluginCodeResponse": true,
13369
13821
  "listPublicInterfacesResponse": true,
@@ -13439,6 +13891,7 @@ export const state = {
13439
13891
  "listInterfacesResponse": true,
13440
13892
  "createPluginResponse": true,
13441
13893
  "getPluginResponse": true,
13894
+ "getDereferencedPluginResponse": true,
13442
13895
  "getPluginByNameResponse": true,
13443
13896
  "updatePluginResponse": true,
13444
13897
  "deletePluginResponse": true,
@@ -16994,6 +17447,7 @@ export const state = {
16994
17447
  "getPublicIntegration",
16995
17448
  "listPublicPlugins",
16996
17449
  "getPublicPluginById",
17450
+ "getDereferencedPublicPluginById",
16997
17451
  "getPublicPlugin",
16998
17452
  "getPublicPluginCode",
16999
17453
  "listPublicInterfaces",
@@ -17104,6 +17558,7 @@ export const state = {
17104
17558
  "operations": [
17105
17559
  "createPlugin",
17106
17560
  "getPlugin",
17561
+ "getDereferencedPlugin",
17107
17562
  "getPluginByName",
17108
17563
  "updatePlugin",
17109
17564
  "deletePlugin",