@botpress/api 1.12.0 → 1.13.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.
@@ -2629,6 +2629,617 @@ export declare const state: {
2629
2629
  };
2630
2630
  };
2631
2631
  };
2632
+ listPublicInterfaces: {
2633
+ name: string;
2634
+ description: string;
2635
+ method: "get";
2636
+ section: "hub";
2637
+ path: string;
2638
+ disableDefaultParameters: {
2639
+ "x-workspace-id": boolean;
2640
+ };
2641
+ parameters: {
2642
+ nextToken: {
2643
+ in: "query";
2644
+ description: string;
2645
+ type: "string";
2646
+ };
2647
+ name: {
2648
+ in: "query";
2649
+ type: "string";
2650
+ description: string;
2651
+ };
2652
+ version: {
2653
+ in: "query";
2654
+ type: "string";
2655
+ description: string;
2656
+ };
2657
+ };
2658
+ response: {
2659
+ description: string;
2660
+ schema: {
2661
+ type: "object";
2662
+ properties: {
2663
+ interfaces: {
2664
+ type: "array";
2665
+ items: {
2666
+ type: "object";
2667
+ properties: {
2668
+ id: {
2669
+ type: "string";
2670
+ minLength: number;
2671
+ maxLength: number;
2672
+ description: string;
2673
+ };
2674
+ createdAt: {
2675
+ type: "string";
2676
+ format: string;
2677
+ description: string;
2678
+ };
2679
+ updatedAt: {
2680
+ type: "string";
2681
+ format: string;
2682
+ description: string;
2683
+ };
2684
+ name: {
2685
+ type: "string";
2686
+ maxLength: number;
2687
+ description: string;
2688
+ };
2689
+ version: {
2690
+ type: "string";
2691
+ maxLength: number;
2692
+ description: string;
2693
+ };
2694
+ title: {
2695
+ type: "string";
2696
+ minLength: number;
2697
+ maxLength: number;
2698
+ description: string;
2699
+ };
2700
+ description: {
2701
+ type: "string";
2702
+ maxLength: number;
2703
+ description: string;
2704
+ };
2705
+ iconUrl: {
2706
+ type: "string";
2707
+ description: string;
2708
+ };
2709
+ readmeUrl: {
2710
+ type: "string";
2711
+ description: string;
2712
+ };
2713
+ public: {
2714
+ type: "boolean";
2715
+ description: string;
2716
+ };
2717
+ };
2718
+ required: string[];
2719
+ };
2720
+ };
2721
+ meta: {
2722
+ type: "object";
2723
+ properties: {
2724
+ nextToken: {
2725
+ type: "string";
2726
+ description: string;
2727
+ };
2728
+ };
2729
+ additionalProperties: false;
2730
+ };
2731
+ };
2732
+ required: string[];
2733
+ title: string;
2734
+ additionalProperties: false;
2735
+ };
2736
+ };
2737
+ };
2738
+ getPublicInterfaceById: {
2739
+ name: string;
2740
+ description: string;
2741
+ method: "get";
2742
+ section: "hub";
2743
+ path: string;
2744
+ disableDefaultParameters: {
2745
+ "x-workspace-id": boolean;
2746
+ };
2747
+ parameters: {
2748
+ id: {
2749
+ type: "string";
2750
+ description: string;
2751
+ in: "path";
2752
+ };
2753
+ };
2754
+ response: {
2755
+ description: string;
2756
+ schema: {
2757
+ type: "object";
2758
+ properties: {
2759
+ interface: {
2760
+ type: "object";
2761
+ properties: {
2762
+ id: {
2763
+ type: "string";
2764
+ minLength: number;
2765
+ maxLength: number;
2766
+ description: string;
2767
+ };
2768
+ createdAt: {
2769
+ type: "string";
2770
+ format: string;
2771
+ description: string;
2772
+ };
2773
+ updatedAt: {
2774
+ type: "string";
2775
+ format: string;
2776
+ description: string;
2777
+ };
2778
+ name: {
2779
+ type: "string";
2780
+ maxLength: number;
2781
+ description: string;
2782
+ };
2783
+ version: {
2784
+ type: "string";
2785
+ maxLength: number;
2786
+ description: string;
2787
+ };
2788
+ entities: {
2789
+ type: "object";
2790
+ additionalProperties: {
2791
+ type: "object";
2792
+ properties: {
2793
+ title: {
2794
+ type: "string";
2795
+ maxLength: number;
2796
+ description: string;
2797
+ };
2798
+ description: {
2799
+ type: "string";
2800
+ maxLength: number;
2801
+ description: string;
2802
+ };
2803
+ schema: {
2804
+ type: "object";
2805
+ additionalProperties: true;
2806
+ };
2807
+ };
2808
+ required: string[];
2809
+ description: string;
2810
+ additionalProperties: false;
2811
+ };
2812
+ };
2813
+ events: {
2814
+ type: "object";
2815
+ additionalProperties: {
2816
+ type: "object";
2817
+ properties: {
2818
+ title: {
2819
+ type: "string";
2820
+ maxLength: number;
2821
+ description: string;
2822
+ };
2823
+ description: {
2824
+ type: "string";
2825
+ maxLength: number;
2826
+ description: string;
2827
+ };
2828
+ schema: {
2829
+ type: "object";
2830
+ additionalProperties: true;
2831
+ };
2832
+ attributes: {
2833
+ type: "object";
2834
+ additionalProperties: {
2835
+ type: "string";
2836
+ maxLength: number;
2837
+ };
2838
+ description: string;
2839
+ };
2840
+ };
2841
+ required: string[];
2842
+ description: string;
2843
+ additionalProperties: false;
2844
+ };
2845
+ };
2846
+ actions: {
2847
+ type: "object";
2848
+ additionalProperties: {
2849
+ type: "object";
2850
+ properties: {
2851
+ title: {
2852
+ type: "string";
2853
+ maxLength: number;
2854
+ description: string;
2855
+ };
2856
+ description: {
2857
+ type: "string";
2858
+ maxLength: number;
2859
+ description: string;
2860
+ };
2861
+ billable: {
2862
+ type: "boolean";
2863
+ };
2864
+ cacheable: {
2865
+ type: "boolean";
2866
+ };
2867
+ input: {
2868
+ type: "object";
2869
+ properties: {
2870
+ schema: {
2871
+ type: "object";
2872
+ additionalProperties: true;
2873
+ };
2874
+ };
2875
+ required: string[];
2876
+ additionalProperties: false;
2877
+ };
2878
+ output: {
2879
+ type: "object";
2880
+ properties: {
2881
+ schema: {
2882
+ type: "object";
2883
+ additionalProperties: true;
2884
+ };
2885
+ };
2886
+ required: string[];
2887
+ additionalProperties: false;
2888
+ };
2889
+ attributes: {
2890
+ type: "object";
2891
+ additionalProperties: {
2892
+ type: "string";
2893
+ maxLength: number;
2894
+ };
2895
+ description: string;
2896
+ };
2897
+ };
2898
+ required: string[];
2899
+ description: string;
2900
+ additionalProperties: false;
2901
+ };
2902
+ };
2903
+ channels: {
2904
+ type: "object";
2905
+ additionalProperties: {
2906
+ type: "object";
2907
+ properties: {
2908
+ title: {
2909
+ type: "string";
2910
+ maxLength: number;
2911
+ description: string;
2912
+ };
2913
+ description: {
2914
+ type: "string";
2915
+ maxLength: number;
2916
+ description: string;
2917
+ };
2918
+ messages: {
2919
+ type: "object";
2920
+ additionalProperties: {
2921
+ type: "object";
2922
+ properties: {
2923
+ schema: {
2924
+ type: "object";
2925
+ additionalProperties: true;
2926
+ };
2927
+ };
2928
+ required: string[];
2929
+ description: string;
2930
+ additionalProperties: false;
2931
+ };
2932
+ };
2933
+ };
2934
+ required: string[];
2935
+ additionalProperties: false;
2936
+ };
2937
+ };
2938
+ nameTemplate: {
2939
+ type: "object";
2940
+ properties: {
2941
+ script: {
2942
+ type: "string";
2943
+ maxLength: number;
2944
+ };
2945
+ language: {
2946
+ type: "string";
2947
+ maxLength: number;
2948
+ };
2949
+ };
2950
+ required: string[];
2951
+ description: string;
2952
+ additionalProperties: false;
2953
+ };
2954
+ title: {
2955
+ type: "string";
2956
+ minLength: number;
2957
+ maxLength: number;
2958
+ description: string;
2959
+ };
2960
+ description: {
2961
+ type: "string";
2962
+ maxLength: number;
2963
+ description: string;
2964
+ };
2965
+ iconUrl: {
2966
+ type: "string";
2967
+ description: string;
2968
+ };
2969
+ readmeUrl: {
2970
+ type: "string";
2971
+ description: string;
2972
+ };
2973
+ public: {
2974
+ type: "boolean";
2975
+ description: string;
2976
+ };
2977
+ };
2978
+ required: string[];
2979
+ additionalProperties: false;
2980
+ };
2981
+ };
2982
+ required: string[];
2983
+ title: string;
2984
+ additionalProperties: false;
2985
+ };
2986
+ };
2987
+ };
2988
+ getPublicInterface: {
2989
+ name: string;
2990
+ description: string;
2991
+ method: "get";
2992
+ section: "hub";
2993
+ path: string;
2994
+ disableDefaultParameters: {
2995
+ "x-workspace-id": boolean;
2996
+ };
2997
+ parameters: {
2998
+ name: {
2999
+ type: "string";
3000
+ description: string;
3001
+ in: "path";
3002
+ };
3003
+ version: {
3004
+ type: "string";
3005
+ description: string;
3006
+ in: "path";
3007
+ };
3008
+ };
3009
+ response: {
3010
+ description: string;
3011
+ schema: {
3012
+ type: "object";
3013
+ properties: {
3014
+ interface: {
3015
+ type: "object";
3016
+ properties: {
3017
+ id: {
3018
+ type: "string";
3019
+ minLength: number;
3020
+ maxLength: number;
3021
+ description: string;
3022
+ };
3023
+ createdAt: {
3024
+ type: "string";
3025
+ format: string;
3026
+ description: string;
3027
+ };
3028
+ updatedAt: {
3029
+ type: "string";
3030
+ format: string;
3031
+ description: string;
3032
+ };
3033
+ name: {
3034
+ type: "string";
3035
+ maxLength: number;
3036
+ description: string;
3037
+ };
3038
+ version: {
3039
+ type: "string";
3040
+ maxLength: number;
3041
+ description: string;
3042
+ };
3043
+ entities: {
3044
+ type: "object";
3045
+ additionalProperties: {
3046
+ type: "object";
3047
+ properties: {
3048
+ title: {
3049
+ type: "string";
3050
+ maxLength: number;
3051
+ description: string;
3052
+ };
3053
+ description: {
3054
+ type: "string";
3055
+ maxLength: number;
3056
+ description: string;
3057
+ };
3058
+ schema: {
3059
+ type: "object";
3060
+ additionalProperties: true;
3061
+ };
3062
+ };
3063
+ required: string[];
3064
+ description: string;
3065
+ additionalProperties: false;
3066
+ };
3067
+ };
3068
+ events: {
3069
+ type: "object";
3070
+ additionalProperties: {
3071
+ type: "object";
3072
+ properties: {
3073
+ title: {
3074
+ type: "string";
3075
+ maxLength: number;
3076
+ description: string;
3077
+ };
3078
+ description: {
3079
+ type: "string";
3080
+ maxLength: number;
3081
+ description: string;
3082
+ };
3083
+ schema: {
3084
+ type: "object";
3085
+ additionalProperties: true;
3086
+ };
3087
+ attributes: {
3088
+ type: "object";
3089
+ additionalProperties: {
3090
+ type: "string";
3091
+ maxLength: number;
3092
+ };
3093
+ description: string;
3094
+ };
3095
+ };
3096
+ required: string[];
3097
+ description: string;
3098
+ additionalProperties: false;
3099
+ };
3100
+ };
3101
+ actions: {
3102
+ type: "object";
3103
+ additionalProperties: {
3104
+ type: "object";
3105
+ properties: {
3106
+ title: {
3107
+ type: "string";
3108
+ maxLength: number;
3109
+ description: string;
3110
+ };
3111
+ description: {
3112
+ type: "string";
3113
+ maxLength: number;
3114
+ description: string;
3115
+ };
3116
+ billable: {
3117
+ type: "boolean";
3118
+ };
3119
+ cacheable: {
3120
+ type: "boolean";
3121
+ };
3122
+ input: {
3123
+ type: "object";
3124
+ properties: {
3125
+ schema: {
3126
+ type: "object";
3127
+ additionalProperties: true;
3128
+ };
3129
+ };
3130
+ required: string[];
3131
+ additionalProperties: false;
3132
+ };
3133
+ output: {
3134
+ type: "object";
3135
+ properties: {
3136
+ schema: {
3137
+ type: "object";
3138
+ additionalProperties: true;
3139
+ };
3140
+ };
3141
+ required: string[];
3142
+ additionalProperties: false;
3143
+ };
3144
+ attributes: {
3145
+ type: "object";
3146
+ additionalProperties: {
3147
+ type: "string";
3148
+ maxLength: number;
3149
+ };
3150
+ description: string;
3151
+ };
3152
+ };
3153
+ required: string[];
3154
+ description: string;
3155
+ additionalProperties: false;
3156
+ };
3157
+ };
3158
+ channels: {
3159
+ type: "object";
3160
+ additionalProperties: {
3161
+ type: "object";
3162
+ properties: {
3163
+ title: {
3164
+ type: "string";
3165
+ maxLength: number;
3166
+ description: string;
3167
+ };
3168
+ description: {
3169
+ type: "string";
3170
+ maxLength: number;
3171
+ description: string;
3172
+ };
3173
+ messages: {
3174
+ type: "object";
3175
+ additionalProperties: {
3176
+ type: "object";
3177
+ properties: {
3178
+ schema: {
3179
+ type: "object";
3180
+ additionalProperties: true;
3181
+ };
3182
+ };
3183
+ required: string[];
3184
+ description: string;
3185
+ additionalProperties: false;
3186
+ };
3187
+ };
3188
+ };
3189
+ required: string[];
3190
+ additionalProperties: false;
3191
+ };
3192
+ };
3193
+ nameTemplate: {
3194
+ type: "object";
3195
+ properties: {
3196
+ script: {
3197
+ type: "string";
3198
+ maxLength: number;
3199
+ };
3200
+ language: {
3201
+ type: "string";
3202
+ maxLength: number;
3203
+ };
3204
+ };
3205
+ required: string[];
3206
+ description: string;
3207
+ additionalProperties: false;
3208
+ };
3209
+ title: {
3210
+ type: "string";
3211
+ minLength: number;
3212
+ maxLength: number;
3213
+ description: string;
3214
+ };
3215
+ description: {
3216
+ type: "string";
3217
+ maxLength: number;
3218
+ description: string;
3219
+ };
3220
+ iconUrl: {
3221
+ type: "string";
3222
+ description: string;
3223
+ };
3224
+ readmeUrl: {
3225
+ type: "string";
3226
+ description: string;
3227
+ };
3228
+ public: {
3229
+ type: "boolean";
3230
+ description: string;
3231
+ };
3232
+ };
3233
+ required: string[];
3234
+ additionalProperties: false;
3235
+ };
3236
+ };
3237
+ required: string[];
3238
+ title: string;
3239
+ additionalProperties: false;
3240
+ };
3241
+ };
3242
+ };
2632
3243
  createBot: {
2633
3244
  name: string;
2634
3245
  description: string;
@@ -3575,6 +4186,12 @@ export declare const state: {
3575
4186
  type: "string";
3576
4187
  required: false;
3577
4188
  };
4189
+ messageContains: {
4190
+ in: "query";
4191
+ description: string;
4192
+ type: "string";
4193
+ required: false;
4194
+ };
3578
4195
  nextToken: {
3579
4196
  in: "query";
3580
4197
  description: string;
@@ -8598,6 +9215,12 @@ export declare const state: {
8598
9215
  type: "string";
8599
9216
  required: false;
8600
9217
  };
9218
+ messageContains: {
9219
+ in: "query";
9220
+ description: string;
9221
+ type: "string";
9222
+ required: false;
9223
+ };
8601
9224
  nextToken: {
8602
9225
  in: "query";
8603
9226
  description: string;
@@ -9296,6 +9919,11 @@ export declare const state: {
9296
9919
  type: "string";
9297
9920
  description: string;
9298
9921
  };
9922
+ version: {
9923
+ in: "query";
9924
+ type: "string";
9925
+ description: string;
9926
+ };
9299
9927
  };
9300
9928
  response: {
9301
9929
  description: string;
@@ -10740,6 +11368,9 @@ export declare const state: {
10740
11368
  getPublicPluginByIdResponse: true;
10741
11369
  getPublicPluginResponse: true;
10742
11370
  getPublicPluginCodeResponse: true;
11371
+ listPublicInterfacesResponse: true;
11372
+ getPublicInterfaceByIdResponse: true;
11373
+ getPublicInterfaceResponse: true;
10743
11374
  createBotResponse: true;
10744
11375
  updateBotResponse: true;
10745
11376
  transferBotResponse: true;