@botpress/client 1.12.0 → 1.13.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.
package/dist/index.d.ts CHANGED
@@ -5210,6 +5210,57 @@ interface CreateBotResponse$1 {
5210
5210
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
5211
5211
  };
5212
5212
  };
5213
+ /**
5214
+ * A mapping of plugin aliases to their configuration
5215
+ */
5216
+ plugins: {
5217
+ [k: string]: {
5218
+ enabled: boolean;
5219
+ /**
5220
+ * Name of the [Plugin](#schema_plugin)
5221
+ */
5222
+ name: string;
5223
+ /**
5224
+ * Version of the [Plugin](#schema_plugin)
5225
+ */
5226
+ version: string;
5227
+ configuration: {
5228
+ [k: string]: any;
5229
+ };
5230
+ /**
5231
+ * ID of the [Plugin](#schema_plugin)
5232
+ */
5233
+ id: string;
5234
+ /**
5235
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
5236
+ */
5237
+ createdAt: string;
5238
+ /**
5239
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
5240
+ */
5241
+ updatedAt: string;
5242
+ /**
5243
+ * Title of the plugin. This is the name that will be displayed in the UI
5244
+ */
5245
+ title: string;
5246
+ /**
5247
+ * Description of the plugin. This is the description that will be displayed in the UI
5248
+ */
5249
+ description: string;
5250
+ /**
5251
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
5252
+ */
5253
+ iconUrl: string;
5254
+ /**
5255
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
5256
+ */
5257
+ readmeUrl: string;
5258
+ /**
5259
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
5260
+ */
5261
+ public: boolean;
5262
+ };
5263
+ };
5213
5264
  /**
5214
5265
  * User object configuration
5215
5266
  */
@@ -5638,6 +5689,18 @@ interface UpdateBotRequestBody$1 {
5638
5689
  disabledChannels?: string[];
5639
5690
  } | null;
5640
5691
  };
5692
+ /**
5693
+ * A mapping of plugin aliases to their configuration
5694
+ */
5695
+ plugins?: {
5696
+ [k: string]: {
5697
+ id: string;
5698
+ enabled?: boolean;
5699
+ configuration?: {
5700
+ [k: string]: any;
5701
+ };
5702
+ } | null;
5703
+ };
5641
5704
  subscriptions?: {
5642
5705
  events: {
5643
5706
  [k: string]: {} | null;
@@ -5740,6 +5803,57 @@ interface UpdateBotResponse$1 {
5740
5803
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
5741
5804
  };
5742
5805
  };
5806
+ /**
5807
+ * A mapping of plugin aliases to their configuration
5808
+ */
5809
+ plugins: {
5810
+ [k: string]: {
5811
+ enabled: boolean;
5812
+ /**
5813
+ * Name of the [Plugin](#schema_plugin)
5814
+ */
5815
+ name: string;
5816
+ /**
5817
+ * Version of the [Plugin](#schema_plugin)
5818
+ */
5819
+ version: string;
5820
+ configuration: {
5821
+ [k: string]: any;
5822
+ };
5823
+ /**
5824
+ * ID of the [Plugin](#schema_plugin)
5825
+ */
5826
+ id: string;
5827
+ /**
5828
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
5829
+ */
5830
+ createdAt: string;
5831
+ /**
5832
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
5833
+ */
5834
+ updatedAt: string;
5835
+ /**
5836
+ * Title of the plugin. This is the name that will be displayed in the UI
5837
+ */
5838
+ title: string;
5839
+ /**
5840
+ * Description of the plugin. This is the description that will be displayed in the UI
5841
+ */
5842
+ description: string;
5843
+ /**
5844
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
5845
+ */
5846
+ iconUrl: string;
5847
+ /**
5848
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
5849
+ */
5850
+ readmeUrl: string;
5851
+ /**
5852
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
5853
+ */
5854
+ public: boolean;
5855
+ };
5856
+ };
5743
5857
  /**
5744
5858
  * User object configuration
5745
5859
  */
@@ -6133,6 +6247,57 @@ interface GetBotResponse$1 {
6133
6247
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
6134
6248
  };
6135
6249
  };
6250
+ /**
6251
+ * A mapping of plugin aliases to their configuration
6252
+ */
6253
+ plugins: {
6254
+ [k: string]: {
6255
+ enabled: boolean;
6256
+ /**
6257
+ * Name of the [Plugin](#schema_plugin)
6258
+ */
6259
+ name: string;
6260
+ /**
6261
+ * Version of the [Plugin](#schema_plugin)
6262
+ */
6263
+ version: string;
6264
+ configuration: {
6265
+ [k: string]: any;
6266
+ };
6267
+ /**
6268
+ * ID of the [Plugin](#schema_plugin)
6269
+ */
6270
+ id: string;
6271
+ /**
6272
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
6273
+ */
6274
+ createdAt: string;
6275
+ /**
6276
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
6277
+ */
6278
+ updatedAt: string;
6279
+ /**
6280
+ * Title of the plugin. This is the name that will be displayed in the UI
6281
+ */
6282
+ title: string;
6283
+ /**
6284
+ * Description of the plugin. This is the description that will be displayed in the UI
6285
+ */
6286
+ description: string;
6287
+ /**
6288
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
6289
+ */
6290
+ iconUrl: string;
6291
+ /**
6292
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
6293
+ */
6294
+ readmeUrl: string;
6295
+ /**
6296
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
6297
+ */
6298
+ public: boolean;
6299
+ };
6300
+ };
6136
6301
  /**
6137
6302
  * User object configuration
6138
6303
  */
@@ -20895,6 +21060,57 @@ interface CreateBotResponse {
20895
21060
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
20896
21061
  };
20897
21062
  };
21063
+ /**
21064
+ * A mapping of plugin aliases to their configuration
21065
+ */
21066
+ plugins: {
21067
+ [k: string]: {
21068
+ enabled: boolean;
21069
+ /**
21070
+ * Name of the [Plugin](#schema_plugin)
21071
+ */
21072
+ name: string;
21073
+ /**
21074
+ * Version of the [Plugin](#schema_plugin)
21075
+ */
21076
+ version: string;
21077
+ configuration: {
21078
+ [k: string]: any;
21079
+ };
21080
+ /**
21081
+ * ID of the [Plugin](#schema_plugin)
21082
+ */
21083
+ id: string;
21084
+ /**
21085
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
21086
+ */
21087
+ createdAt: string;
21088
+ /**
21089
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
21090
+ */
21091
+ updatedAt: string;
21092
+ /**
21093
+ * Title of the plugin. This is the name that will be displayed in the UI
21094
+ */
21095
+ title: string;
21096
+ /**
21097
+ * Description of the plugin. This is the description that will be displayed in the UI
21098
+ */
21099
+ description: string;
21100
+ /**
21101
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
21102
+ */
21103
+ iconUrl: string;
21104
+ /**
21105
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
21106
+ */
21107
+ readmeUrl: string;
21108
+ /**
21109
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
21110
+ */
21111
+ public: boolean;
21112
+ };
21113
+ };
20898
21114
  /**
20899
21115
  * User object configuration
20900
21116
  */
@@ -21323,6 +21539,18 @@ interface UpdateBotRequestBody {
21323
21539
  disabledChannels?: string[];
21324
21540
  } | null;
21325
21541
  };
21542
+ /**
21543
+ * A mapping of plugin aliases to their configuration
21544
+ */
21545
+ plugins?: {
21546
+ [k: string]: {
21547
+ id: string;
21548
+ enabled?: boolean;
21549
+ configuration?: {
21550
+ [k: string]: any;
21551
+ };
21552
+ } | null;
21553
+ };
21326
21554
  subscriptions?: {
21327
21555
  events: {
21328
21556
  [k: string]: {} | null;
@@ -21425,6 +21653,57 @@ interface UpdateBotResponse {
21425
21653
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
21426
21654
  };
21427
21655
  };
21656
+ /**
21657
+ * A mapping of plugin aliases to their configuration
21658
+ */
21659
+ plugins: {
21660
+ [k: string]: {
21661
+ enabled: boolean;
21662
+ /**
21663
+ * Name of the [Plugin](#schema_plugin)
21664
+ */
21665
+ name: string;
21666
+ /**
21667
+ * Version of the [Plugin](#schema_plugin)
21668
+ */
21669
+ version: string;
21670
+ configuration: {
21671
+ [k: string]: any;
21672
+ };
21673
+ /**
21674
+ * ID of the [Plugin](#schema_plugin)
21675
+ */
21676
+ id: string;
21677
+ /**
21678
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
21679
+ */
21680
+ createdAt: string;
21681
+ /**
21682
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
21683
+ */
21684
+ updatedAt: string;
21685
+ /**
21686
+ * Title of the plugin. This is the name that will be displayed in the UI
21687
+ */
21688
+ title: string;
21689
+ /**
21690
+ * Description of the plugin. This is the description that will be displayed in the UI
21691
+ */
21692
+ description: string;
21693
+ /**
21694
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
21695
+ */
21696
+ iconUrl: string;
21697
+ /**
21698
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
21699
+ */
21700
+ readmeUrl: string;
21701
+ /**
21702
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
21703
+ */
21704
+ public: boolean;
21705
+ };
21706
+ };
21428
21707
  /**
21429
21708
  * User object configuration
21430
21709
  */
@@ -21818,6 +22097,57 @@ interface GetBotResponse {
21818
22097
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
21819
22098
  };
21820
22099
  };
22100
+ /**
22101
+ * A mapping of plugin aliases to their configuration
22102
+ */
22103
+ plugins: {
22104
+ [k: string]: {
22105
+ enabled: boolean;
22106
+ /**
22107
+ * Name of the [Plugin](#schema_plugin)
22108
+ */
22109
+ name: string;
22110
+ /**
22111
+ * Version of the [Plugin](#schema_plugin)
22112
+ */
22113
+ version: string;
22114
+ configuration: {
22115
+ [k: string]: any;
22116
+ };
22117
+ /**
22118
+ * ID of the [Plugin](#schema_plugin)
22119
+ */
22120
+ id: string;
22121
+ /**
22122
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
22123
+ */
22124
+ createdAt: string;
22125
+ /**
22126
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
22127
+ */
22128
+ updatedAt: string;
22129
+ /**
22130
+ * Title of the plugin. This is the name that will be displayed in the UI
22131
+ */
22132
+ title: string;
22133
+ /**
22134
+ * Description of the plugin. This is the description that will be displayed in the UI
22135
+ */
22136
+ description: string;
22137
+ /**
22138
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
22139
+ */
22140
+ iconUrl: string;
22141
+ /**
22142
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
22143
+ */
22144
+ readmeUrl: string;
22145
+ /**
22146
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
22147
+ */
22148
+ public: boolean;
22149
+ };
22150
+ };
21821
22151
  /**
21822
22152
  * User object configuration
21823
22153
  */
@@ -31225,6 +31555,57 @@ interface Bot {
31225
31555
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
31226
31556
  };
31227
31557
  };
31558
+ /**
31559
+ * A mapping of plugin aliases to their configuration
31560
+ */
31561
+ plugins: {
31562
+ [k: string]: {
31563
+ enabled: boolean;
31564
+ /**
31565
+ * Name of the [Plugin](#schema_plugin)
31566
+ */
31567
+ name: string;
31568
+ /**
31569
+ * Version of the [Plugin](#schema_plugin)
31570
+ */
31571
+ version: string;
31572
+ configuration: {
31573
+ [k: string]: any;
31574
+ };
31575
+ /**
31576
+ * ID of the [Plugin](#schema_plugin)
31577
+ */
31578
+ id: string;
31579
+ /**
31580
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
31581
+ */
31582
+ createdAt: string;
31583
+ /**
31584
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
31585
+ */
31586
+ updatedAt: string;
31587
+ /**
31588
+ * Title of the plugin. This is the name that will be displayed in the UI
31589
+ */
31590
+ title: string;
31591
+ /**
31592
+ * Description of the plugin. This is the description that will be displayed in the UI
31593
+ */
31594
+ description: string;
31595
+ /**
31596
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
31597
+ */
31598
+ iconUrl: string;
31599
+ /**
31600
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
31601
+ */
31602
+ readmeUrl: string;
31603
+ /**
31604
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
31605
+ */
31606
+ public: boolean;
31607
+ };
31608
+ };
31228
31609
  /**
31229
31610
  * User object configuration
31230
31611
  */