@botpress/client 1.16.0 → 1.17.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
@@ -4349,6 +4349,226 @@ interface GetPublicPluginByIdResponse$1 {
4349
4349
  };
4350
4350
  }
4351
4351
 
4352
+ interface GetDereferencedPublicPluginByIdRequestHeaders$1 {
4353
+ }
4354
+ interface GetDereferencedPublicPluginByIdRequestQuery$1 {
4355
+ /**
4356
+ * Mapping of interface aliases to integration IDs
4357
+ */
4358
+ interfaces: {
4359
+ /**
4360
+ * integration id
4361
+ */
4362
+ [k: string]: string;
4363
+ };
4364
+ }
4365
+ interface GetDereferencedPublicPluginByIdRequestParams$1 {
4366
+ id: string;
4367
+ }
4368
+ interface GetDereferencedPublicPluginByIdRequestBody$1 {
4369
+ }
4370
+ type GetDereferencedPublicPluginByIdInput$1 = GetDereferencedPublicPluginByIdRequestBody$1 & GetDereferencedPublicPluginByIdRequestHeaders$1 & GetDereferencedPublicPluginByIdRequestQuery$1 & GetDereferencedPublicPluginByIdRequestParams$1;
4371
+ interface GetDereferencedPublicPluginByIdResponse$1 {
4372
+ plugin: {
4373
+ /**
4374
+ * ID of the [Plugin](#schema_plugin)
4375
+ */
4376
+ id: string;
4377
+ /**
4378
+ * Name of the [Plugin](#schema_plugin)
4379
+ */
4380
+ name: string;
4381
+ /**
4382
+ * Version of the [Plugin](#schema_plugin)
4383
+ */
4384
+ version: string;
4385
+ /**
4386
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
4387
+ */
4388
+ createdAt: string;
4389
+ /**
4390
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
4391
+ */
4392
+ updatedAt: string;
4393
+ /**
4394
+ * Configuration definition
4395
+ */
4396
+ configuration: {
4397
+ /**
4398
+ * Title of the configuration
4399
+ */
4400
+ title?: string;
4401
+ /**
4402
+ * Description of the configuration
4403
+ */
4404
+ description?: string;
4405
+ /**
4406
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
4407
+ */
4408
+ schema: {
4409
+ [k: string]: any;
4410
+ };
4411
+ };
4412
+ states: {
4413
+ [k: string]: {
4414
+ /**
4415
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
4416
+ */
4417
+ type: "conversation" | "user" | "bot" | "task";
4418
+ /**
4419
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
4420
+ */
4421
+ schema: {
4422
+ [k: string]: any;
4423
+ };
4424
+ /**
4425
+ * 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.
4426
+ */
4427
+ expiry?: number;
4428
+ };
4429
+ };
4430
+ events: {
4431
+ /**
4432
+ * Event Definition
4433
+ */
4434
+ [k: string]: {
4435
+ /**
4436
+ * Title of the event
4437
+ */
4438
+ title?: string;
4439
+ /**
4440
+ * Description of the event
4441
+ */
4442
+ description?: string;
4443
+ schema: {
4444
+ [k: string]: any;
4445
+ };
4446
+ /**
4447
+ * Optional attributes
4448
+ */
4449
+ attributes?: {
4450
+ [k: string]: string;
4451
+ };
4452
+ };
4453
+ };
4454
+ actions: {
4455
+ /**
4456
+ * Action definition
4457
+ */
4458
+ [k: string]: {
4459
+ /**
4460
+ * Title of the action
4461
+ */
4462
+ title?: string;
4463
+ /**
4464
+ * Description of the action
4465
+ */
4466
+ description?: string;
4467
+ billable?: boolean;
4468
+ cacheable?: boolean;
4469
+ input: {
4470
+ schema: {
4471
+ [k: string]: any;
4472
+ };
4473
+ };
4474
+ output: {
4475
+ schema: {
4476
+ [k: string]: any;
4477
+ };
4478
+ };
4479
+ /**
4480
+ * Optional attributes
4481
+ */
4482
+ attributes?: {
4483
+ [k: string]: string;
4484
+ };
4485
+ };
4486
+ };
4487
+ dependencies: {
4488
+ interfaces: {
4489
+ [k: string]: {
4490
+ id: string;
4491
+ name: string;
4492
+ version: string;
4493
+ };
4494
+ };
4495
+ integrations: {
4496
+ [k: string]: {
4497
+ id: string;
4498
+ name: string;
4499
+ version: string;
4500
+ };
4501
+ };
4502
+ };
4503
+ /**
4504
+ * User object configuration
4505
+ */
4506
+ user: {
4507
+ tags: {
4508
+ /**
4509
+ * Definition of a tag that can be provided on the object
4510
+ */
4511
+ [k: string]: {
4512
+ /**
4513
+ * Title of the tag
4514
+ */
4515
+ title?: string;
4516
+ /**
4517
+ * Description of the tag
4518
+ */
4519
+ description?: string;
4520
+ };
4521
+ };
4522
+ };
4523
+ /**
4524
+ * Conversation object configuration
4525
+ */
4526
+ conversation: {
4527
+ tags: {
4528
+ /**
4529
+ * Definition of a tag that can be provided on the object
4530
+ */
4531
+ [k: string]: {
4532
+ /**
4533
+ * Title of the tag
4534
+ */
4535
+ title?: string;
4536
+ /**
4537
+ * Description of the tag
4538
+ */
4539
+ description?: string;
4540
+ };
4541
+ };
4542
+ };
4543
+ /**
4544
+ * Optional attributes
4545
+ */
4546
+ attributes?: {
4547
+ [k: string]: string;
4548
+ };
4549
+ /**
4550
+ * Title of the plugin. This is the name that will be displayed in the UI
4551
+ */
4552
+ title: string;
4553
+ /**
4554
+ * Description of the plugin. This is the description that will be displayed in the UI
4555
+ */
4556
+ description: string;
4557
+ /**
4558
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
4559
+ */
4560
+ iconUrl: string;
4561
+ /**
4562
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
4563
+ */
4564
+ readmeUrl: string;
4565
+ /**
4566
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
4567
+ */
4568
+ public: boolean;
4569
+ };
4570
+ }
4571
+
4352
4572
  interface GetPublicPluginRequestHeaders$1 {
4353
4573
  }
4354
4574
  interface GetPublicPluginRequestQuery$1 {
@@ -5732,6 +5952,10 @@ interface UpdateBotRequestBody$1 {
5732
5952
  integrations?: {
5733
5953
  [k: string]: {
5734
5954
  enabled?: boolean;
5955
+ /**
5956
+ * Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance.
5957
+ */
5958
+ integrationId?: string;
5735
5959
  /**
5736
5960
  * Integration's configuration type. Set to default if null.
5737
5961
  */
@@ -6237,6 +6461,7 @@ interface ListBotsResponse$1 {
6237
6461
  interface GetBotRequestHeaders$1 {
6238
6462
  }
6239
6463
  interface GetBotRequestQuery$1 {
6464
+ shouldMergePlugins?: boolean;
6240
6465
  }
6241
6466
  interface GetBotRequestParams$1 {
6242
6467
  id: string;
@@ -12018,8 +12243,219 @@ interface CreatePluginRequestBody$1 {
12018
12243
  */
12019
12244
  public?: boolean;
12020
12245
  }
12021
- type CreatePluginInput$1 = CreatePluginRequestBody$1 & CreatePluginRequestHeaders$1 & CreatePluginRequestQuery$1 & CreatePluginRequestParams$1;
12022
- interface CreatePluginResponse$1 {
12246
+ type CreatePluginInput$1 = CreatePluginRequestBody$1 & CreatePluginRequestHeaders$1 & CreatePluginRequestQuery$1 & CreatePluginRequestParams$1;
12247
+ interface CreatePluginResponse$1 {
12248
+ plugin: {
12249
+ /**
12250
+ * ID of the [Plugin](#schema_plugin)
12251
+ */
12252
+ id: string;
12253
+ /**
12254
+ * Name of the [Plugin](#schema_plugin)
12255
+ */
12256
+ name: string;
12257
+ /**
12258
+ * Version of the [Plugin](#schema_plugin)
12259
+ */
12260
+ version: string;
12261
+ /**
12262
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
12263
+ */
12264
+ createdAt: string;
12265
+ /**
12266
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
12267
+ */
12268
+ updatedAt: string;
12269
+ /**
12270
+ * Configuration definition
12271
+ */
12272
+ configuration: {
12273
+ /**
12274
+ * Title of the configuration
12275
+ */
12276
+ title?: string;
12277
+ /**
12278
+ * Description of the configuration
12279
+ */
12280
+ description?: string;
12281
+ /**
12282
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
12283
+ */
12284
+ schema: {
12285
+ [k: string]: any;
12286
+ };
12287
+ };
12288
+ states: {
12289
+ [k: string]: {
12290
+ /**
12291
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
12292
+ */
12293
+ type: "conversation" | "user" | "bot" | "task";
12294
+ /**
12295
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
12296
+ */
12297
+ schema: {
12298
+ [k: string]: any;
12299
+ };
12300
+ /**
12301
+ * 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.
12302
+ */
12303
+ expiry?: number;
12304
+ };
12305
+ };
12306
+ events: {
12307
+ /**
12308
+ * Event Definition
12309
+ */
12310
+ [k: string]: {
12311
+ /**
12312
+ * Title of the event
12313
+ */
12314
+ title?: string;
12315
+ /**
12316
+ * Description of the event
12317
+ */
12318
+ description?: string;
12319
+ schema: {
12320
+ [k: string]: any;
12321
+ };
12322
+ /**
12323
+ * Optional attributes
12324
+ */
12325
+ attributes?: {
12326
+ [k: string]: string;
12327
+ };
12328
+ };
12329
+ };
12330
+ actions: {
12331
+ /**
12332
+ * Action definition
12333
+ */
12334
+ [k: string]: {
12335
+ /**
12336
+ * Title of the action
12337
+ */
12338
+ title?: string;
12339
+ /**
12340
+ * Description of the action
12341
+ */
12342
+ description?: string;
12343
+ billable?: boolean;
12344
+ cacheable?: boolean;
12345
+ input: {
12346
+ schema: {
12347
+ [k: string]: any;
12348
+ };
12349
+ };
12350
+ output: {
12351
+ schema: {
12352
+ [k: string]: any;
12353
+ };
12354
+ };
12355
+ /**
12356
+ * Optional attributes
12357
+ */
12358
+ attributes?: {
12359
+ [k: string]: string;
12360
+ };
12361
+ };
12362
+ };
12363
+ dependencies: {
12364
+ interfaces: {
12365
+ [k: string]: {
12366
+ id: string;
12367
+ name: string;
12368
+ version: string;
12369
+ };
12370
+ };
12371
+ integrations: {
12372
+ [k: string]: {
12373
+ id: string;
12374
+ name: string;
12375
+ version: string;
12376
+ };
12377
+ };
12378
+ };
12379
+ /**
12380
+ * User object configuration
12381
+ */
12382
+ user: {
12383
+ tags: {
12384
+ /**
12385
+ * Definition of a tag that can be provided on the object
12386
+ */
12387
+ [k: string]: {
12388
+ /**
12389
+ * Title of the tag
12390
+ */
12391
+ title?: string;
12392
+ /**
12393
+ * Description of the tag
12394
+ */
12395
+ description?: string;
12396
+ };
12397
+ };
12398
+ };
12399
+ /**
12400
+ * Conversation object configuration
12401
+ */
12402
+ conversation: {
12403
+ tags: {
12404
+ /**
12405
+ * Definition of a tag that can be provided on the object
12406
+ */
12407
+ [k: string]: {
12408
+ /**
12409
+ * Title of the tag
12410
+ */
12411
+ title?: string;
12412
+ /**
12413
+ * Description of the tag
12414
+ */
12415
+ description?: string;
12416
+ };
12417
+ };
12418
+ };
12419
+ /**
12420
+ * Optional attributes
12421
+ */
12422
+ attributes?: {
12423
+ [k: string]: string;
12424
+ };
12425
+ /**
12426
+ * Title of the plugin. This is the name that will be displayed in the UI
12427
+ */
12428
+ title: string;
12429
+ /**
12430
+ * Description of the plugin. This is the description that will be displayed in the UI
12431
+ */
12432
+ description: string;
12433
+ /**
12434
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
12435
+ */
12436
+ iconUrl: string;
12437
+ /**
12438
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
12439
+ */
12440
+ readmeUrl: string;
12441
+ /**
12442
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
12443
+ */
12444
+ public: boolean;
12445
+ };
12446
+ }
12447
+
12448
+ interface GetPluginRequestHeaders$1 {
12449
+ }
12450
+ interface GetPluginRequestQuery$1 {
12451
+ }
12452
+ interface GetPluginRequestParams$1 {
12453
+ id: string;
12454
+ }
12455
+ interface GetPluginRequestBody$1 {
12456
+ }
12457
+ type GetPluginInput$1 = GetPluginRequestBody$1 & GetPluginRequestHeaders$1 & GetPluginRequestQuery$1 & GetPluginRequestParams$1;
12458
+ interface GetPluginResponse$1 {
12023
12459
  plugin: {
12024
12460
  /**
12025
12461
  * ID of the [Plugin](#schema_plugin)
@@ -12220,17 +12656,26 @@ interface CreatePluginResponse$1 {
12220
12656
  };
12221
12657
  }
12222
12658
 
12223
- interface GetPluginRequestHeaders$1 {
12659
+ interface GetDereferencedPluginRequestHeaders$1 {
12224
12660
  }
12225
- interface GetPluginRequestQuery$1 {
12661
+ interface GetDereferencedPluginRequestQuery$1 {
12662
+ /**
12663
+ * Mapping of interface aliases to integration IDs
12664
+ */
12665
+ interfaces: {
12666
+ /**
12667
+ * integration id
12668
+ */
12669
+ [k: string]: string;
12670
+ };
12226
12671
  }
12227
- interface GetPluginRequestParams$1 {
12672
+ interface GetDereferencedPluginRequestParams$1 {
12228
12673
  id: string;
12229
12674
  }
12230
- interface GetPluginRequestBody$1 {
12675
+ interface GetDereferencedPluginRequestBody$1 {
12231
12676
  }
12232
- type GetPluginInput$1 = GetPluginRequestBody$1 & GetPluginRequestHeaders$1 & GetPluginRequestQuery$1 & GetPluginRequestParams$1;
12233
- interface GetPluginResponse$1 {
12677
+ type GetDereferencedPluginInput$1 = GetDereferencedPluginRequestBody$1 & GetDereferencedPluginRequestHeaders$1 & GetDereferencedPluginRequestQuery$1 & GetDereferencedPluginRequestParams$1;
12678
+ interface GetDereferencedPluginResponse$1 {
12234
12679
  plugin: {
12235
12680
  /**
12236
12681
  * ID of the [Plugin](#schema_plugin)
@@ -13369,6 +13814,7 @@ declare class Client$7 {
13369
13814
  readonly getPublicIntegration: (input: GetPublicIntegrationInput$1) => Promise<GetPublicIntegrationResponse$1>;
13370
13815
  readonly listPublicPlugins: (input: ListPublicPluginsInput$1) => Promise<ListPublicPluginsResponse$1>;
13371
13816
  readonly getPublicPluginById: (input: GetPublicPluginByIdInput$1) => Promise<GetPublicPluginByIdResponse$1>;
13817
+ readonly getDereferencedPublicPluginById: (input: GetDereferencedPublicPluginByIdInput$1) => Promise<GetDereferencedPublicPluginByIdResponse$1>;
13372
13818
  readonly getPublicPlugin: (input: GetPublicPluginInput$1) => Promise<GetPublicPluginResponse$1>;
13373
13819
  readonly getPublicPluginCode: (input: GetPublicPluginCodeInput$1) => Promise<GetPublicPluginCodeResponse$1>;
13374
13820
  readonly listPublicInterfaces: (input: ListPublicInterfacesInput$1) => Promise<ListPublicInterfacesResponse$1>;
@@ -13444,6 +13890,7 @@ declare class Client$7 {
13444
13890
  readonly listInterfaces: (input: ListInterfacesInput$1) => Promise<ListInterfacesResponse$1>;
13445
13891
  readonly createPlugin: (input: CreatePluginInput$1) => Promise<CreatePluginResponse$1>;
13446
13892
  readonly getPlugin: (input: GetPluginInput$1) => Promise<GetPluginResponse$1>;
13893
+ readonly getDereferencedPlugin: (input: GetDereferencedPluginInput$1) => Promise<GetDereferencedPluginResponse$1>;
13447
13894
  readonly getPluginByName: (input: GetPluginByNameInput$1) => Promise<GetPluginByNameResponse$1>;
13448
13895
  readonly updatePlugin: (input: UpdatePluginInput$1) => Promise<UpdatePluginResponse$1>;
13449
13896
  readonly deletePlugin: (input: DeletePluginInput$1) => Promise<DeletePluginResponse$1>;
@@ -20350,21 +20797,241 @@ interface ListPublicPluginsResponse {
20350
20797
  /**
20351
20798
  * 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.
20352
20799
  */
20353
- nextToken?: string;
20800
+ nextToken?: string;
20801
+ };
20802
+ }
20803
+
20804
+ interface GetPublicPluginByIdRequestHeaders {
20805
+ }
20806
+ interface GetPublicPluginByIdRequestQuery {
20807
+ }
20808
+ interface GetPublicPluginByIdRequestParams {
20809
+ id: string;
20810
+ }
20811
+ interface GetPublicPluginByIdRequestBody {
20812
+ }
20813
+ type GetPublicPluginByIdInput = GetPublicPluginByIdRequestBody & GetPublicPluginByIdRequestHeaders & GetPublicPluginByIdRequestQuery & GetPublicPluginByIdRequestParams;
20814
+ interface GetPublicPluginByIdResponse {
20815
+ plugin: {
20816
+ /**
20817
+ * ID of the [Plugin](#schema_plugin)
20818
+ */
20819
+ id: string;
20820
+ /**
20821
+ * Name of the [Plugin](#schema_plugin)
20822
+ */
20823
+ name: string;
20824
+ /**
20825
+ * Version of the [Plugin](#schema_plugin)
20826
+ */
20827
+ version: string;
20828
+ /**
20829
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
20830
+ */
20831
+ createdAt: string;
20832
+ /**
20833
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
20834
+ */
20835
+ updatedAt: string;
20836
+ /**
20837
+ * Configuration definition
20838
+ */
20839
+ configuration: {
20840
+ /**
20841
+ * Title of the configuration
20842
+ */
20843
+ title?: string;
20844
+ /**
20845
+ * Description of the configuration
20846
+ */
20847
+ description?: string;
20848
+ /**
20849
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
20850
+ */
20851
+ schema: {
20852
+ [k: string]: any;
20853
+ };
20854
+ };
20855
+ states: {
20856
+ [k: string]: {
20857
+ /**
20858
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
20859
+ */
20860
+ type: "conversation" | "user" | "bot" | "task";
20861
+ /**
20862
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
20863
+ */
20864
+ schema: {
20865
+ [k: string]: any;
20866
+ };
20867
+ /**
20868
+ * 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.
20869
+ */
20870
+ expiry?: number;
20871
+ };
20872
+ };
20873
+ events: {
20874
+ /**
20875
+ * Event Definition
20876
+ */
20877
+ [k: string]: {
20878
+ /**
20879
+ * Title of the event
20880
+ */
20881
+ title?: string;
20882
+ /**
20883
+ * Description of the event
20884
+ */
20885
+ description?: string;
20886
+ schema: {
20887
+ [k: string]: any;
20888
+ };
20889
+ /**
20890
+ * Optional attributes
20891
+ */
20892
+ attributes?: {
20893
+ [k: string]: string;
20894
+ };
20895
+ };
20896
+ };
20897
+ actions: {
20898
+ /**
20899
+ * Action definition
20900
+ */
20901
+ [k: string]: {
20902
+ /**
20903
+ * Title of the action
20904
+ */
20905
+ title?: string;
20906
+ /**
20907
+ * Description of the action
20908
+ */
20909
+ description?: string;
20910
+ billable?: boolean;
20911
+ cacheable?: boolean;
20912
+ input: {
20913
+ schema: {
20914
+ [k: string]: any;
20915
+ };
20916
+ };
20917
+ output: {
20918
+ schema: {
20919
+ [k: string]: any;
20920
+ };
20921
+ };
20922
+ /**
20923
+ * Optional attributes
20924
+ */
20925
+ attributes?: {
20926
+ [k: string]: string;
20927
+ };
20928
+ };
20929
+ };
20930
+ dependencies: {
20931
+ interfaces: {
20932
+ [k: string]: {
20933
+ id: string;
20934
+ name: string;
20935
+ version: string;
20936
+ };
20937
+ };
20938
+ integrations: {
20939
+ [k: string]: {
20940
+ id: string;
20941
+ name: string;
20942
+ version: string;
20943
+ };
20944
+ };
20945
+ };
20946
+ /**
20947
+ * User object configuration
20948
+ */
20949
+ user: {
20950
+ tags: {
20951
+ /**
20952
+ * Definition of a tag that can be provided on the object
20953
+ */
20954
+ [k: string]: {
20955
+ /**
20956
+ * Title of the tag
20957
+ */
20958
+ title?: string;
20959
+ /**
20960
+ * Description of the tag
20961
+ */
20962
+ description?: string;
20963
+ };
20964
+ };
20965
+ };
20966
+ /**
20967
+ * Conversation object configuration
20968
+ */
20969
+ conversation: {
20970
+ tags: {
20971
+ /**
20972
+ * Definition of a tag that can be provided on the object
20973
+ */
20974
+ [k: string]: {
20975
+ /**
20976
+ * Title of the tag
20977
+ */
20978
+ title?: string;
20979
+ /**
20980
+ * Description of the tag
20981
+ */
20982
+ description?: string;
20983
+ };
20984
+ };
20985
+ };
20986
+ /**
20987
+ * Optional attributes
20988
+ */
20989
+ attributes?: {
20990
+ [k: string]: string;
20991
+ };
20992
+ /**
20993
+ * Title of the plugin. This is the name that will be displayed in the UI
20994
+ */
20995
+ title: string;
20996
+ /**
20997
+ * Description of the plugin. This is the description that will be displayed in the UI
20998
+ */
20999
+ description: string;
21000
+ /**
21001
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
21002
+ */
21003
+ iconUrl: string;
21004
+ /**
21005
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
21006
+ */
21007
+ readmeUrl: string;
21008
+ /**
21009
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
21010
+ */
21011
+ public: boolean;
20354
21012
  };
20355
21013
  }
20356
21014
 
20357
- interface GetPublicPluginByIdRequestHeaders {
21015
+ interface GetDereferencedPublicPluginByIdRequestHeaders {
20358
21016
  }
20359
- interface GetPublicPluginByIdRequestQuery {
21017
+ interface GetDereferencedPublicPluginByIdRequestQuery {
21018
+ /**
21019
+ * Mapping of interface aliases to integration IDs
21020
+ */
21021
+ interfaces: {
21022
+ /**
21023
+ * integration id
21024
+ */
21025
+ [k: string]: string;
21026
+ };
20360
21027
  }
20361
- interface GetPublicPluginByIdRequestParams {
21028
+ interface GetDereferencedPublicPluginByIdRequestParams {
20362
21029
  id: string;
20363
21030
  }
20364
- interface GetPublicPluginByIdRequestBody {
21031
+ interface GetDereferencedPublicPluginByIdRequestBody {
20365
21032
  }
20366
- type GetPublicPluginByIdInput = GetPublicPluginByIdRequestBody & GetPublicPluginByIdRequestHeaders & GetPublicPluginByIdRequestQuery & GetPublicPluginByIdRequestParams;
20367
- interface GetPublicPluginByIdResponse {
21033
+ type GetDereferencedPublicPluginByIdInput = GetDereferencedPublicPluginByIdRequestBody & GetDereferencedPublicPluginByIdRequestHeaders & GetDereferencedPublicPluginByIdRequestQuery & GetDereferencedPublicPluginByIdRequestParams;
21034
+ interface GetDereferencedPublicPluginByIdResponse {
20368
21035
  plugin: {
20369
21036
  /**
20370
21037
  * ID of the [Plugin](#schema_plugin)
@@ -21948,6 +22615,10 @@ interface UpdateBotRequestBody {
21948
22615
  integrations?: {
21949
22616
  [k: string]: {
21950
22617
  enabled?: boolean;
22618
+ /**
22619
+ * Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance.
22620
+ */
22621
+ integrationId?: string;
21951
22622
  /**
21952
22623
  * Integration's configuration type. Set to default if null.
21953
22624
  */
@@ -22453,6 +23124,7 @@ interface ListBotsResponse {
22453
23124
  interface GetBotRequestHeaders {
22454
23125
  }
22455
23126
  interface GetBotRequestQuery {
23127
+ shouldMergePlugins?: boolean;
22456
23128
  }
22457
23129
  interface GetBotRequestParams {
22458
23130
  id: string;
@@ -28648,6 +29320,226 @@ interface GetPluginResponse {
28648
29320
  };
28649
29321
  }
28650
29322
 
29323
+ interface GetDereferencedPluginRequestHeaders {
29324
+ }
29325
+ interface GetDereferencedPluginRequestQuery {
29326
+ /**
29327
+ * Mapping of interface aliases to integration IDs
29328
+ */
29329
+ interfaces: {
29330
+ /**
29331
+ * integration id
29332
+ */
29333
+ [k: string]: string;
29334
+ };
29335
+ }
29336
+ interface GetDereferencedPluginRequestParams {
29337
+ id: string;
29338
+ }
29339
+ interface GetDereferencedPluginRequestBody {
29340
+ }
29341
+ type GetDereferencedPluginInput = GetDereferencedPluginRequestBody & GetDereferencedPluginRequestHeaders & GetDereferencedPluginRequestQuery & GetDereferencedPluginRequestParams;
29342
+ interface GetDereferencedPluginResponse {
29343
+ plugin: {
29344
+ /**
29345
+ * ID of the [Plugin](#schema_plugin)
29346
+ */
29347
+ id: string;
29348
+ /**
29349
+ * Name of the [Plugin](#schema_plugin)
29350
+ */
29351
+ name: string;
29352
+ /**
29353
+ * Version of the [Plugin](#schema_plugin)
29354
+ */
29355
+ version: string;
29356
+ /**
29357
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
29358
+ */
29359
+ createdAt: string;
29360
+ /**
29361
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
29362
+ */
29363
+ updatedAt: string;
29364
+ /**
29365
+ * Configuration definition
29366
+ */
29367
+ configuration: {
29368
+ /**
29369
+ * Title of the configuration
29370
+ */
29371
+ title?: string;
29372
+ /**
29373
+ * Description of the configuration
29374
+ */
29375
+ description?: string;
29376
+ /**
29377
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
29378
+ */
29379
+ schema: {
29380
+ [k: string]: any;
29381
+ };
29382
+ };
29383
+ states: {
29384
+ [k: string]: {
29385
+ /**
29386
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
29387
+ */
29388
+ type: "conversation" | "user" | "bot" | "task";
29389
+ /**
29390
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
29391
+ */
29392
+ schema: {
29393
+ [k: string]: any;
29394
+ };
29395
+ /**
29396
+ * 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.
29397
+ */
29398
+ expiry?: number;
29399
+ };
29400
+ };
29401
+ events: {
29402
+ /**
29403
+ * Event Definition
29404
+ */
29405
+ [k: string]: {
29406
+ /**
29407
+ * Title of the event
29408
+ */
29409
+ title?: string;
29410
+ /**
29411
+ * Description of the event
29412
+ */
29413
+ description?: string;
29414
+ schema: {
29415
+ [k: string]: any;
29416
+ };
29417
+ /**
29418
+ * Optional attributes
29419
+ */
29420
+ attributes?: {
29421
+ [k: string]: string;
29422
+ };
29423
+ };
29424
+ };
29425
+ actions: {
29426
+ /**
29427
+ * Action definition
29428
+ */
29429
+ [k: string]: {
29430
+ /**
29431
+ * Title of the action
29432
+ */
29433
+ title?: string;
29434
+ /**
29435
+ * Description of the action
29436
+ */
29437
+ description?: string;
29438
+ billable?: boolean;
29439
+ cacheable?: boolean;
29440
+ input: {
29441
+ schema: {
29442
+ [k: string]: any;
29443
+ };
29444
+ };
29445
+ output: {
29446
+ schema: {
29447
+ [k: string]: any;
29448
+ };
29449
+ };
29450
+ /**
29451
+ * Optional attributes
29452
+ */
29453
+ attributes?: {
29454
+ [k: string]: string;
29455
+ };
29456
+ };
29457
+ };
29458
+ dependencies: {
29459
+ interfaces: {
29460
+ [k: string]: {
29461
+ id: string;
29462
+ name: string;
29463
+ version: string;
29464
+ };
29465
+ };
29466
+ integrations: {
29467
+ [k: string]: {
29468
+ id: string;
29469
+ name: string;
29470
+ version: string;
29471
+ };
29472
+ };
29473
+ };
29474
+ /**
29475
+ * User object configuration
29476
+ */
29477
+ user: {
29478
+ tags: {
29479
+ /**
29480
+ * Definition of a tag that can be provided on the object
29481
+ */
29482
+ [k: string]: {
29483
+ /**
29484
+ * Title of the tag
29485
+ */
29486
+ title?: string;
29487
+ /**
29488
+ * Description of the tag
29489
+ */
29490
+ description?: string;
29491
+ };
29492
+ };
29493
+ };
29494
+ /**
29495
+ * Conversation object configuration
29496
+ */
29497
+ conversation: {
29498
+ tags: {
29499
+ /**
29500
+ * Definition of a tag that can be provided on the object
29501
+ */
29502
+ [k: string]: {
29503
+ /**
29504
+ * Title of the tag
29505
+ */
29506
+ title?: string;
29507
+ /**
29508
+ * Description of the tag
29509
+ */
29510
+ description?: string;
29511
+ };
29512
+ };
29513
+ };
29514
+ /**
29515
+ * Optional attributes
29516
+ */
29517
+ attributes?: {
29518
+ [k: string]: string;
29519
+ };
29520
+ /**
29521
+ * Title of the plugin. This is the name that will be displayed in the UI
29522
+ */
29523
+ title: string;
29524
+ /**
29525
+ * Description of the plugin. This is the description that will be displayed in the UI
29526
+ */
29527
+ description: string;
29528
+ /**
29529
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
29530
+ */
29531
+ iconUrl: string;
29532
+ /**
29533
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
29534
+ */
29535
+ readmeUrl: string;
29536
+ /**
29537
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
29538
+ */
29539
+ public: boolean;
29540
+ };
29541
+ }
29542
+
28651
29543
  interface GetPluginByNameRequestHeaders {
28652
29544
  }
28653
29545
  interface GetPluginByNameRequestQuery {
@@ -34106,6 +34998,7 @@ declare class Client$1 {
34106
34998
  readonly getPublicIntegration: (input: GetPublicIntegrationInput) => Promise<GetPublicIntegrationResponse>;
34107
34999
  readonly listPublicPlugins: (input: ListPublicPluginsInput) => Promise<ListPublicPluginsResponse>;
34108
35000
  readonly getPublicPluginById: (input: GetPublicPluginByIdInput) => Promise<GetPublicPluginByIdResponse>;
35001
+ readonly getDereferencedPublicPluginById: (input: GetDereferencedPublicPluginByIdInput) => Promise<GetDereferencedPublicPluginByIdResponse>;
34109
35002
  readonly getPublicPlugin: (input: GetPublicPluginInput) => Promise<GetPublicPluginResponse>;
34110
35003
  readonly getPublicPluginCode: (input: GetPublicPluginCodeInput) => Promise<GetPublicPluginCodeResponse>;
34111
35004
  readonly listPublicInterfaces: (input: ListPublicInterfacesInput) => Promise<ListPublicInterfacesResponse>;
@@ -34181,6 +35074,7 @@ declare class Client$1 {
34181
35074
  readonly listInterfaces: (input: ListInterfacesInput) => Promise<ListInterfacesResponse>;
34182
35075
  readonly createPlugin: (input: CreatePluginInput) => Promise<CreatePluginResponse>;
34183
35076
  readonly getPlugin: (input: GetPluginInput) => Promise<GetPluginResponse>;
35077
+ readonly getDereferencedPlugin: (input: GetDereferencedPluginInput) => Promise<GetDereferencedPluginResponse>;
34184
35078
  readonly getPluginByName: (input: GetPluginByNameInput) => Promise<GetPluginByNameResponse>;
34185
35079
  readonly updatePlugin: (input: UpdatePluginInput) => Promise<UpdatePluginResponse>;
34186
35080
  readonly deletePlugin: (input: DeletePluginInput) => Promise<DeletePluginResponse>;
@@ -34628,6 +35522,37 @@ declare class Client extends Client$1 implements IClient {
34628
35522
  source?: string;
34629
35523
  };
34630
35524
  }>;
35525
+ workflows: (props: {
35526
+ tags?: {
35527
+ [x: string]: string;
35528
+ } | undefined;
35529
+ userId?: string | undefined;
35530
+ conversationId?: string | undefined;
35531
+ name?: string | undefined;
35532
+ parentWorkflowId?: string | undefined;
35533
+ statuses?: ("pending" | "failed" | "in_progress" | "completed" | "paused" | "cancelled" | "listening" | "timedout")[] | undefined;
35534
+ }) => AsyncCollection<{
35535
+ id: string;
35536
+ name: string;
35537
+ status: "pending" | "in_progress" | "failed" | "completed" | "listening" | "paused" | "timedout" | "cancelled";
35538
+ input: {
35539
+ [k: string]: any;
35540
+ };
35541
+ output: {
35542
+ [k: string]: any;
35543
+ };
35544
+ parentWorkflowId?: string;
35545
+ conversationId?: string;
35546
+ userId?: string;
35547
+ createdAt: string;
35548
+ updatedAt: string;
35549
+ completedAt?: string;
35550
+ failureReason?: string;
35551
+ timeoutAt: string;
35552
+ tags: {
35553
+ [k: string]: string;
35554
+ };
35555
+ }>;
34631
35556
  };
34632
35557
  /**
34633
35558
  * Create/update and upload a file in a single step. Returns an object containing the file metadata and the URL to retrieve the file.