@botpress/client 1.16.1 → 1.17.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.
- package/dist/bundle.cjs +11 -11
- package/dist/bundle.cjs.map +4 -4
- package/dist/index.cjs +3 -3
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +1047 -17
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -3317,6 +3317,10 @@ interface GetPublicIntegrationByIdResponse$1 {
|
|
|
3317
3317
|
*/
|
|
3318
3318
|
messageExtractScript?: string;
|
|
3319
3319
|
};
|
|
3320
|
+
/**
|
|
3321
|
+
* Maximum execution time of the integration (in seconds).
|
|
3322
|
+
*/
|
|
3323
|
+
maxExecutionTime?: number;
|
|
3320
3324
|
/**
|
|
3321
3325
|
* URL of the [Integration](#schema_integration)
|
|
3322
3326
|
*/
|
|
@@ -3720,6 +3724,10 @@ interface GetPublicIntegrationResponse$1 {
|
|
|
3720
3724
|
*/
|
|
3721
3725
|
messageExtractScript?: string;
|
|
3722
3726
|
};
|
|
3727
|
+
/**
|
|
3728
|
+
* Maximum execution time of the integration (in seconds).
|
|
3729
|
+
*/
|
|
3730
|
+
maxExecutionTime?: number;
|
|
3723
3731
|
/**
|
|
3724
3732
|
* URL of the [Integration](#schema_integration)
|
|
3725
3733
|
*/
|
|
@@ -4349,6 +4357,226 @@ interface GetPublicPluginByIdResponse$1 {
|
|
|
4349
4357
|
};
|
|
4350
4358
|
}
|
|
4351
4359
|
|
|
4360
|
+
interface GetDereferencedPublicPluginByIdRequestHeaders$1 {
|
|
4361
|
+
}
|
|
4362
|
+
interface GetDereferencedPublicPluginByIdRequestQuery$1 {
|
|
4363
|
+
/**
|
|
4364
|
+
* Mapping of interface aliases to integration IDs
|
|
4365
|
+
*/
|
|
4366
|
+
interfaces: {
|
|
4367
|
+
/**
|
|
4368
|
+
* integration id
|
|
4369
|
+
*/
|
|
4370
|
+
[k: string]: string;
|
|
4371
|
+
};
|
|
4372
|
+
}
|
|
4373
|
+
interface GetDereferencedPublicPluginByIdRequestParams$1 {
|
|
4374
|
+
id: string;
|
|
4375
|
+
}
|
|
4376
|
+
interface GetDereferencedPublicPluginByIdRequestBody$1 {
|
|
4377
|
+
}
|
|
4378
|
+
type GetDereferencedPublicPluginByIdInput$1 = GetDereferencedPublicPluginByIdRequestBody$1 & GetDereferencedPublicPluginByIdRequestHeaders$1 & GetDereferencedPublicPluginByIdRequestQuery$1 & GetDereferencedPublicPluginByIdRequestParams$1;
|
|
4379
|
+
interface GetDereferencedPublicPluginByIdResponse$1 {
|
|
4380
|
+
plugin: {
|
|
4381
|
+
/**
|
|
4382
|
+
* ID of the [Plugin](#schema_plugin)
|
|
4383
|
+
*/
|
|
4384
|
+
id: string;
|
|
4385
|
+
/**
|
|
4386
|
+
* Name of the [Plugin](#schema_plugin)
|
|
4387
|
+
*/
|
|
4388
|
+
name: string;
|
|
4389
|
+
/**
|
|
4390
|
+
* Version of the [Plugin](#schema_plugin)
|
|
4391
|
+
*/
|
|
4392
|
+
version: string;
|
|
4393
|
+
/**
|
|
4394
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4395
|
+
*/
|
|
4396
|
+
createdAt: string;
|
|
4397
|
+
/**
|
|
4398
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
4399
|
+
*/
|
|
4400
|
+
updatedAt: string;
|
|
4401
|
+
/**
|
|
4402
|
+
* Configuration definition
|
|
4403
|
+
*/
|
|
4404
|
+
configuration: {
|
|
4405
|
+
/**
|
|
4406
|
+
* Title of the configuration
|
|
4407
|
+
*/
|
|
4408
|
+
title?: string;
|
|
4409
|
+
/**
|
|
4410
|
+
* Description of the configuration
|
|
4411
|
+
*/
|
|
4412
|
+
description?: string;
|
|
4413
|
+
/**
|
|
4414
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
4415
|
+
*/
|
|
4416
|
+
schema: {
|
|
4417
|
+
[k: string]: any;
|
|
4418
|
+
};
|
|
4419
|
+
};
|
|
4420
|
+
states: {
|
|
4421
|
+
[k: string]: {
|
|
4422
|
+
/**
|
|
4423
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
4424
|
+
*/
|
|
4425
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
4426
|
+
/**
|
|
4427
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4428
|
+
*/
|
|
4429
|
+
schema: {
|
|
4430
|
+
[k: string]: any;
|
|
4431
|
+
};
|
|
4432
|
+
/**
|
|
4433
|
+
* 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.
|
|
4434
|
+
*/
|
|
4435
|
+
expiry?: number;
|
|
4436
|
+
};
|
|
4437
|
+
};
|
|
4438
|
+
events: {
|
|
4439
|
+
/**
|
|
4440
|
+
* Event Definition
|
|
4441
|
+
*/
|
|
4442
|
+
[k: string]: {
|
|
4443
|
+
/**
|
|
4444
|
+
* Title of the event
|
|
4445
|
+
*/
|
|
4446
|
+
title?: string;
|
|
4447
|
+
/**
|
|
4448
|
+
* Description of the event
|
|
4449
|
+
*/
|
|
4450
|
+
description?: string;
|
|
4451
|
+
schema: {
|
|
4452
|
+
[k: string]: any;
|
|
4453
|
+
};
|
|
4454
|
+
/**
|
|
4455
|
+
* Optional attributes
|
|
4456
|
+
*/
|
|
4457
|
+
attributes?: {
|
|
4458
|
+
[k: string]: string;
|
|
4459
|
+
};
|
|
4460
|
+
};
|
|
4461
|
+
};
|
|
4462
|
+
actions: {
|
|
4463
|
+
/**
|
|
4464
|
+
* Action definition
|
|
4465
|
+
*/
|
|
4466
|
+
[k: string]: {
|
|
4467
|
+
/**
|
|
4468
|
+
* Title of the action
|
|
4469
|
+
*/
|
|
4470
|
+
title?: string;
|
|
4471
|
+
/**
|
|
4472
|
+
* Description of the action
|
|
4473
|
+
*/
|
|
4474
|
+
description?: string;
|
|
4475
|
+
billable?: boolean;
|
|
4476
|
+
cacheable?: boolean;
|
|
4477
|
+
input: {
|
|
4478
|
+
schema: {
|
|
4479
|
+
[k: string]: any;
|
|
4480
|
+
};
|
|
4481
|
+
};
|
|
4482
|
+
output: {
|
|
4483
|
+
schema: {
|
|
4484
|
+
[k: string]: any;
|
|
4485
|
+
};
|
|
4486
|
+
};
|
|
4487
|
+
/**
|
|
4488
|
+
* Optional attributes
|
|
4489
|
+
*/
|
|
4490
|
+
attributes?: {
|
|
4491
|
+
[k: string]: string;
|
|
4492
|
+
};
|
|
4493
|
+
};
|
|
4494
|
+
};
|
|
4495
|
+
dependencies: {
|
|
4496
|
+
interfaces: {
|
|
4497
|
+
[k: string]: {
|
|
4498
|
+
id: string;
|
|
4499
|
+
name: string;
|
|
4500
|
+
version: string;
|
|
4501
|
+
};
|
|
4502
|
+
};
|
|
4503
|
+
integrations: {
|
|
4504
|
+
[k: string]: {
|
|
4505
|
+
id: string;
|
|
4506
|
+
name: string;
|
|
4507
|
+
version: string;
|
|
4508
|
+
};
|
|
4509
|
+
};
|
|
4510
|
+
};
|
|
4511
|
+
/**
|
|
4512
|
+
* User object configuration
|
|
4513
|
+
*/
|
|
4514
|
+
user: {
|
|
4515
|
+
tags: {
|
|
4516
|
+
/**
|
|
4517
|
+
* Definition of a tag that can be provided on the object
|
|
4518
|
+
*/
|
|
4519
|
+
[k: string]: {
|
|
4520
|
+
/**
|
|
4521
|
+
* Title of the tag
|
|
4522
|
+
*/
|
|
4523
|
+
title?: string;
|
|
4524
|
+
/**
|
|
4525
|
+
* Description of the tag
|
|
4526
|
+
*/
|
|
4527
|
+
description?: string;
|
|
4528
|
+
};
|
|
4529
|
+
};
|
|
4530
|
+
};
|
|
4531
|
+
/**
|
|
4532
|
+
* Conversation object configuration
|
|
4533
|
+
*/
|
|
4534
|
+
conversation: {
|
|
4535
|
+
tags: {
|
|
4536
|
+
/**
|
|
4537
|
+
* Definition of a tag that can be provided on the object
|
|
4538
|
+
*/
|
|
4539
|
+
[k: string]: {
|
|
4540
|
+
/**
|
|
4541
|
+
* Title of the tag
|
|
4542
|
+
*/
|
|
4543
|
+
title?: string;
|
|
4544
|
+
/**
|
|
4545
|
+
* Description of the tag
|
|
4546
|
+
*/
|
|
4547
|
+
description?: string;
|
|
4548
|
+
};
|
|
4549
|
+
};
|
|
4550
|
+
};
|
|
4551
|
+
/**
|
|
4552
|
+
* Optional attributes
|
|
4553
|
+
*/
|
|
4554
|
+
attributes?: {
|
|
4555
|
+
[k: string]: string;
|
|
4556
|
+
};
|
|
4557
|
+
/**
|
|
4558
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
4559
|
+
*/
|
|
4560
|
+
title: string;
|
|
4561
|
+
/**
|
|
4562
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
4563
|
+
*/
|
|
4564
|
+
description: string;
|
|
4565
|
+
/**
|
|
4566
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
4567
|
+
*/
|
|
4568
|
+
iconUrl: string;
|
|
4569
|
+
/**
|
|
4570
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
4571
|
+
*/
|
|
4572
|
+
readmeUrl: string;
|
|
4573
|
+
/**
|
|
4574
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
4575
|
+
*/
|
|
4576
|
+
public: boolean;
|
|
4577
|
+
};
|
|
4578
|
+
}
|
|
4579
|
+
|
|
4352
4580
|
interface GetPublicPluginRequestHeaders$1 {
|
|
4353
4581
|
}
|
|
4354
4582
|
interface GetPublicPluginRequestQuery$1 {
|
|
@@ -5317,6 +5545,10 @@ interface CreateBotResponse$1 {
|
|
|
5317
5545
|
public: boolean;
|
|
5318
5546
|
};
|
|
5319
5547
|
};
|
|
5548
|
+
/**
|
|
5549
|
+
* Maximum execution time of the bot (in seconds).
|
|
5550
|
+
*/
|
|
5551
|
+
maxExecutionTime?: number;
|
|
5320
5552
|
/**
|
|
5321
5553
|
* User object configuration
|
|
5322
5554
|
*/
|
|
@@ -5594,6 +5826,10 @@ interface UpdateBotRequestBody$1 {
|
|
|
5594
5826
|
[k: string]: string;
|
|
5595
5827
|
};
|
|
5596
5828
|
blocked?: boolean;
|
|
5829
|
+
/**
|
|
5830
|
+
* Maximum execution time (in seconds).
|
|
5831
|
+
*/
|
|
5832
|
+
maxExecutionTime?: number;
|
|
5597
5833
|
/**
|
|
5598
5834
|
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
5599
5835
|
*/
|
|
@@ -5732,6 +5968,10 @@ interface UpdateBotRequestBody$1 {
|
|
|
5732
5968
|
integrations?: {
|
|
5733
5969
|
[k: string]: {
|
|
5734
5970
|
enabled?: boolean;
|
|
5971
|
+
/**
|
|
5972
|
+
* Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance.
|
|
5973
|
+
*/
|
|
5974
|
+
integrationId?: string;
|
|
5735
5975
|
/**
|
|
5736
5976
|
* Integration's configuration type. Set to default if null.
|
|
5737
5977
|
*/
|
|
@@ -5930,6 +6170,10 @@ interface UpdateBotResponse$1 {
|
|
|
5930
6170
|
public: boolean;
|
|
5931
6171
|
};
|
|
5932
6172
|
};
|
|
6173
|
+
/**
|
|
6174
|
+
* Maximum execution time of the bot (in seconds).
|
|
6175
|
+
*/
|
|
6176
|
+
maxExecutionTime?: number;
|
|
5933
6177
|
/**
|
|
5934
6178
|
* User object configuration
|
|
5935
6179
|
*/
|
|
@@ -6237,6 +6481,7 @@ interface ListBotsResponse$1 {
|
|
|
6237
6481
|
interface GetBotRequestHeaders$1 {
|
|
6238
6482
|
}
|
|
6239
6483
|
interface GetBotRequestQuery$1 {
|
|
6484
|
+
shouldMergePlugins?: boolean;
|
|
6240
6485
|
}
|
|
6241
6486
|
interface GetBotRequestParams$1 {
|
|
6242
6487
|
id: string;
|
|
@@ -6382,6 +6627,10 @@ interface GetBotResponse$1 {
|
|
|
6382
6627
|
public: boolean;
|
|
6383
6628
|
};
|
|
6384
6629
|
};
|
|
6630
|
+
/**
|
|
6631
|
+
* Maximum execution time of the bot (in seconds).
|
|
6632
|
+
*/
|
|
6633
|
+
maxExecutionTime?: number;
|
|
6385
6634
|
/**
|
|
6386
6635
|
* User object configuration
|
|
6387
6636
|
*/
|
|
@@ -8084,9 +8333,13 @@ interface CreateIntegrationRequestBody$1 {
|
|
|
8084
8333
|
};
|
|
8085
8334
|
};
|
|
8086
8335
|
/**
|
|
8087
|
-
* **EXPERIMENTAL**
|
|
8336
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
8088
8337
|
*/
|
|
8089
|
-
|
|
8338
|
+
extraOperations?: {
|
|
8339
|
+
[k: string]: {
|
|
8340
|
+
enabled: boolean;
|
|
8341
|
+
};
|
|
8342
|
+
};
|
|
8090
8343
|
/**
|
|
8091
8344
|
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
8092
8345
|
*/
|
|
@@ -8165,6 +8418,10 @@ interface CreateIntegrationResponse$1 {
|
|
|
8165
8418
|
*/
|
|
8166
8419
|
messageExtractScript?: string;
|
|
8167
8420
|
};
|
|
8421
|
+
/**
|
|
8422
|
+
* Maximum execution time of the integration (in seconds).
|
|
8423
|
+
*/
|
|
8424
|
+
maxExecutionTime?: number;
|
|
8168
8425
|
/**
|
|
8169
8426
|
* URL of the [Integration](#schema_integration)
|
|
8170
8427
|
*/
|
|
@@ -8804,9 +9061,13 @@ interface ValidateIntegrationCreationRequestBody$1 {
|
|
|
8804
9061
|
};
|
|
8805
9062
|
};
|
|
8806
9063
|
/**
|
|
8807
|
-
* **EXPERIMENTAL**
|
|
9064
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
8808
9065
|
*/
|
|
8809
|
-
|
|
9066
|
+
extraOperations?: {
|
|
9067
|
+
[k: string]: {
|
|
9068
|
+
enabled: boolean;
|
|
9069
|
+
};
|
|
9070
|
+
};
|
|
8810
9071
|
/**
|
|
8811
9072
|
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
8812
9073
|
*/
|
|
@@ -8908,9 +9169,13 @@ interface UpdateIntegrationRequestBody$1 {
|
|
|
8908
9169
|
} | null;
|
|
8909
9170
|
};
|
|
8910
9171
|
/**
|
|
8911
|
-
* **EXPERIMENTAL**
|
|
9172
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
8912
9173
|
*/
|
|
8913
|
-
|
|
9174
|
+
extraOperations?: {
|
|
9175
|
+
[k: string]: {
|
|
9176
|
+
enabled: boolean;
|
|
9177
|
+
};
|
|
9178
|
+
};
|
|
8914
9179
|
channels?: {
|
|
8915
9180
|
[k: string]: {
|
|
8916
9181
|
/**
|
|
@@ -8980,6 +9245,10 @@ interface UpdateIntegrationRequestBody$1 {
|
|
|
8980
9245
|
};
|
|
8981
9246
|
} | null;
|
|
8982
9247
|
};
|
|
9248
|
+
/**
|
|
9249
|
+
* Maximum execution time of the integration (in seconds).
|
|
9250
|
+
*/
|
|
9251
|
+
maxExecutionTime?: number;
|
|
8983
9252
|
identifier?: {
|
|
8984
9253
|
extractScript?: string | null;
|
|
8985
9254
|
fallbackHandlerScript?: string | null;
|
|
@@ -9208,6 +9477,10 @@ interface UpdateIntegrationResponse$1 {
|
|
|
9208
9477
|
*/
|
|
9209
9478
|
messageExtractScript?: string;
|
|
9210
9479
|
};
|
|
9480
|
+
/**
|
|
9481
|
+
* Maximum execution time of the integration (in seconds).
|
|
9482
|
+
*/
|
|
9483
|
+
maxExecutionTime?: number;
|
|
9211
9484
|
/**
|
|
9212
9485
|
* URL of the [Integration](#schema_integration)
|
|
9213
9486
|
*/
|
|
@@ -9611,9 +9884,13 @@ interface ValidateIntegrationUpdateRequestBody$1 {
|
|
|
9611
9884
|
} | null;
|
|
9612
9885
|
};
|
|
9613
9886
|
/**
|
|
9614
|
-
* **EXPERIMENTAL**
|
|
9887
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
9615
9888
|
*/
|
|
9616
|
-
|
|
9889
|
+
extraOperations?: {
|
|
9890
|
+
[k: string]: {
|
|
9891
|
+
enabled: boolean;
|
|
9892
|
+
};
|
|
9893
|
+
};
|
|
9617
9894
|
channels?: {
|
|
9618
9895
|
[k: string]: {
|
|
9619
9896
|
/**
|
|
@@ -9683,6 +9960,10 @@ interface ValidateIntegrationUpdateRequestBody$1 {
|
|
|
9683
9960
|
};
|
|
9684
9961
|
} | null;
|
|
9685
9962
|
};
|
|
9963
|
+
/**
|
|
9964
|
+
* Maximum execution time of the integration (in seconds).
|
|
9965
|
+
*/
|
|
9966
|
+
maxExecutionTime?: number;
|
|
9686
9967
|
identifier?: {
|
|
9687
9968
|
extractScript?: string | null;
|
|
9688
9969
|
fallbackHandlerScript?: string | null;
|
|
@@ -10027,6 +10308,10 @@ interface GetIntegrationResponse$1 {
|
|
|
10027
10308
|
*/
|
|
10028
10309
|
messageExtractScript?: string;
|
|
10029
10310
|
};
|
|
10311
|
+
/**
|
|
10312
|
+
* Maximum execution time of the integration (in seconds).
|
|
10313
|
+
*/
|
|
10314
|
+
maxExecutionTime?: number;
|
|
10030
10315
|
/**
|
|
10031
10316
|
* URL of the [Integration](#schema_integration)
|
|
10032
10317
|
*/
|
|
@@ -10450,6 +10735,10 @@ interface GetIntegrationByNameResponse$1 {
|
|
|
10450
10735
|
*/
|
|
10451
10736
|
messageExtractScript?: string;
|
|
10452
10737
|
};
|
|
10738
|
+
/**
|
|
10739
|
+
* Maximum execution time of the integration (in seconds).
|
|
10740
|
+
*/
|
|
10741
|
+
maxExecutionTime?: number;
|
|
10453
10742
|
/**
|
|
10454
10743
|
* URL of the [Integration](#schema_integration)
|
|
10455
10744
|
*/
|
|
@@ -12431,7 +12720,227 @@ interface GetPluginResponse$1 {
|
|
|
12431
12720
|
};
|
|
12432
12721
|
}
|
|
12433
12722
|
|
|
12434
|
-
interface
|
|
12723
|
+
interface GetDereferencedPluginRequestHeaders$1 {
|
|
12724
|
+
}
|
|
12725
|
+
interface GetDereferencedPluginRequestQuery$1 {
|
|
12726
|
+
/**
|
|
12727
|
+
* Mapping of interface aliases to integration IDs
|
|
12728
|
+
*/
|
|
12729
|
+
interfaces: {
|
|
12730
|
+
/**
|
|
12731
|
+
* integration id
|
|
12732
|
+
*/
|
|
12733
|
+
[k: string]: string;
|
|
12734
|
+
};
|
|
12735
|
+
}
|
|
12736
|
+
interface GetDereferencedPluginRequestParams$1 {
|
|
12737
|
+
id: string;
|
|
12738
|
+
}
|
|
12739
|
+
interface GetDereferencedPluginRequestBody$1 {
|
|
12740
|
+
}
|
|
12741
|
+
type GetDereferencedPluginInput$1 = GetDereferencedPluginRequestBody$1 & GetDereferencedPluginRequestHeaders$1 & GetDereferencedPluginRequestQuery$1 & GetDereferencedPluginRequestParams$1;
|
|
12742
|
+
interface GetDereferencedPluginResponse$1 {
|
|
12743
|
+
plugin: {
|
|
12744
|
+
/**
|
|
12745
|
+
* ID of the [Plugin](#schema_plugin)
|
|
12746
|
+
*/
|
|
12747
|
+
id: string;
|
|
12748
|
+
/**
|
|
12749
|
+
* Name of the [Plugin](#schema_plugin)
|
|
12750
|
+
*/
|
|
12751
|
+
name: string;
|
|
12752
|
+
/**
|
|
12753
|
+
* Version of the [Plugin](#schema_plugin)
|
|
12754
|
+
*/
|
|
12755
|
+
version: string;
|
|
12756
|
+
/**
|
|
12757
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
12758
|
+
*/
|
|
12759
|
+
createdAt: string;
|
|
12760
|
+
/**
|
|
12761
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
12762
|
+
*/
|
|
12763
|
+
updatedAt: string;
|
|
12764
|
+
/**
|
|
12765
|
+
* Configuration definition
|
|
12766
|
+
*/
|
|
12767
|
+
configuration: {
|
|
12768
|
+
/**
|
|
12769
|
+
* Title of the configuration
|
|
12770
|
+
*/
|
|
12771
|
+
title?: string;
|
|
12772
|
+
/**
|
|
12773
|
+
* Description of the configuration
|
|
12774
|
+
*/
|
|
12775
|
+
description?: string;
|
|
12776
|
+
/**
|
|
12777
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
12778
|
+
*/
|
|
12779
|
+
schema: {
|
|
12780
|
+
[k: string]: any;
|
|
12781
|
+
};
|
|
12782
|
+
};
|
|
12783
|
+
states: {
|
|
12784
|
+
[k: string]: {
|
|
12785
|
+
/**
|
|
12786
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
12787
|
+
*/
|
|
12788
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
12789
|
+
/**
|
|
12790
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
12791
|
+
*/
|
|
12792
|
+
schema: {
|
|
12793
|
+
[k: string]: any;
|
|
12794
|
+
};
|
|
12795
|
+
/**
|
|
12796
|
+
* 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.
|
|
12797
|
+
*/
|
|
12798
|
+
expiry?: number;
|
|
12799
|
+
};
|
|
12800
|
+
};
|
|
12801
|
+
events: {
|
|
12802
|
+
/**
|
|
12803
|
+
* Event Definition
|
|
12804
|
+
*/
|
|
12805
|
+
[k: string]: {
|
|
12806
|
+
/**
|
|
12807
|
+
* Title of the event
|
|
12808
|
+
*/
|
|
12809
|
+
title?: string;
|
|
12810
|
+
/**
|
|
12811
|
+
* Description of the event
|
|
12812
|
+
*/
|
|
12813
|
+
description?: string;
|
|
12814
|
+
schema: {
|
|
12815
|
+
[k: string]: any;
|
|
12816
|
+
};
|
|
12817
|
+
/**
|
|
12818
|
+
* Optional attributes
|
|
12819
|
+
*/
|
|
12820
|
+
attributes?: {
|
|
12821
|
+
[k: string]: string;
|
|
12822
|
+
};
|
|
12823
|
+
};
|
|
12824
|
+
};
|
|
12825
|
+
actions: {
|
|
12826
|
+
/**
|
|
12827
|
+
* Action definition
|
|
12828
|
+
*/
|
|
12829
|
+
[k: string]: {
|
|
12830
|
+
/**
|
|
12831
|
+
* Title of the action
|
|
12832
|
+
*/
|
|
12833
|
+
title?: string;
|
|
12834
|
+
/**
|
|
12835
|
+
* Description of the action
|
|
12836
|
+
*/
|
|
12837
|
+
description?: string;
|
|
12838
|
+
billable?: boolean;
|
|
12839
|
+
cacheable?: boolean;
|
|
12840
|
+
input: {
|
|
12841
|
+
schema: {
|
|
12842
|
+
[k: string]: any;
|
|
12843
|
+
};
|
|
12844
|
+
};
|
|
12845
|
+
output: {
|
|
12846
|
+
schema: {
|
|
12847
|
+
[k: string]: any;
|
|
12848
|
+
};
|
|
12849
|
+
};
|
|
12850
|
+
/**
|
|
12851
|
+
* Optional attributes
|
|
12852
|
+
*/
|
|
12853
|
+
attributes?: {
|
|
12854
|
+
[k: string]: string;
|
|
12855
|
+
};
|
|
12856
|
+
};
|
|
12857
|
+
};
|
|
12858
|
+
dependencies: {
|
|
12859
|
+
interfaces: {
|
|
12860
|
+
[k: string]: {
|
|
12861
|
+
id: string;
|
|
12862
|
+
name: string;
|
|
12863
|
+
version: string;
|
|
12864
|
+
};
|
|
12865
|
+
};
|
|
12866
|
+
integrations: {
|
|
12867
|
+
[k: string]: {
|
|
12868
|
+
id: string;
|
|
12869
|
+
name: string;
|
|
12870
|
+
version: string;
|
|
12871
|
+
};
|
|
12872
|
+
};
|
|
12873
|
+
};
|
|
12874
|
+
/**
|
|
12875
|
+
* User object configuration
|
|
12876
|
+
*/
|
|
12877
|
+
user: {
|
|
12878
|
+
tags: {
|
|
12879
|
+
/**
|
|
12880
|
+
* Definition of a tag that can be provided on the object
|
|
12881
|
+
*/
|
|
12882
|
+
[k: string]: {
|
|
12883
|
+
/**
|
|
12884
|
+
* Title of the tag
|
|
12885
|
+
*/
|
|
12886
|
+
title?: string;
|
|
12887
|
+
/**
|
|
12888
|
+
* Description of the tag
|
|
12889
|
+
*/
|
|
12890
|
+
description?: string;
|
|
12891
|
+
};
|
|
12892
|
+
};
|
|
12893
|
+
};
|
|
12894
|
+
/**
|
|
12895
|
+
* Conversation object configuration
|
|
12896
|
+
*/
|
|
12897
|
+
conversation: {
|
|
12898
|
+
tags: {
|
|
12899
|
+
/**
|
|
12900
|
+
* Definition of a tag that can be provided on the object
|
|
12901
|
+
*/
|
|
12902
|
+
[k: string]: {
|
|
12903
|
+
/**
|
|
12904
|
+
* Title of the tag
|
|
12905
|
+
*/
|
|
12906
|
+
title?: string;
|
|
12907
|
+
/**
|
|
12908
|
+
* Description of the tag
|
|
12909
|
+
*/
|
|
12910
|
+
description?: string;
|
|
12911
|
+
};
|
|
12912
|
+
};
|
|
12913
|
+
};
|
|
12914
|
+
/**
|
|
12915
|
+
* Optional attributes
|
|
12916
|
+
*/
|
|
12917
|
+
attributes?: {
|
|
12918
|
+
[k: string]: string;
|
|
12919
|
+
};
|
|
12920
|
+
/**
|
|
12921
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
12922
|
+
*/
|
|
12923
|
+
title: string;
|
|
12924
|
+
/**
|
|
12925
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
12926
|
+
*/
|
|
12927
|
+
description: string;
|
|
12928
|
+
/**
|
|
12929
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
12930
|
+
*/
|
|
12931
|
+
iconUrl: string;
|
|
12932
|
+
/**
|
|
12933
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
12934
|
+
*/
|
|
12935
|
+
readmeUrl: string;
|
|
12936
|
+
/**
|
|
12937
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
12938
|
+
*/
|
|
12939
|
+
public: boolean;
|
|
12940
|
+
};
|
|
12941
|
+
}
|
|
12942
|
+
|
|
12943
|
+
interface GetPluginByNameRequestHeaders$1 {
|
|
12435
12944
|
}
|
|
12436
12945
|
interface GetPluginByNameRequestQuery$1 {
|
|
12437
12946
|
}
|
|
@@ -13369,6 +13878,7 @@ declare class Client$7 {
|
|
|
13369
13878
|
readonly getPublicIntegration: (input: GetPublicIntegrationInput$1) => Promise<GetPublicIntegrationResponse$1>;
|
|
13370
13879
|
readonly listPublicPlugins: (input: ListPublicPluginsInput$1) => Promise<ListPublicPluginsResponse$1>;
|
|
13371
13880
|
readonly getPublicPluginById: (input: GetPublicPluginByIdInput$1) => Promise<GetPublicPluginByIdResponse$1>;
|
|
13881
|
+
readonly getDereferencedPublicPluginById: (input: GetDereferencedPublicPluginByIdInput$1) => Promise<GetDereferencedPublicPluginByIdResponse$1>;
|
|
13372
13882
|
readonly getPublicPlugin: (input: GetPublicPluginInput$1) => Promise<GetPublicPluginResponse$1>;
|
|
13373
13883
|
readonly getPublicPluginCode: (input: GetPublicPluginCodeInput$1) => Promise<GetPublicPluginCodeResponse$1>;
|
|
13374
13884
|
readonly listPublicInterfaces: (input: ListPublicInterfacesInput$1) => Promise<ListPublicInterfacesResponse$1>;
|
|
@@ -13444,6 +13954,7 @@ declare class Client$7 {
|
|
|
13444
13954
|
readonly listInterfaces: (input: ListInterfacesInput$1) => Promise<ListInterfacesResponse$1>;
|
|
13445
13955
|
readonly createPlugin: (input: CreatePluginInput$1) => Promise<CreatePluginResponse$1>;
|
|
13446
13956
|
readonly getPlugin: (input: GetPluginInput$1) => Promise<GetPluginResponse$1>;
|
|
13957
|
+
readonly getDereferencedPlugin: (input: GetDereferencedPluginInput$1) => Promise<GetDereferencedPluginResponse$1>;
|
|
13447
13958
|
readonly getPluginByName: (input: GetPluginByNameInput$1) => Promise<GetPluginByNameResponse$1>;
|
|
13448
13959
|
readonly updatePlugin: (input: UpdatePluginInput$1) => Promise<UpdatePluginResponse$1>;
|
|
13449
13960
|
readonly deletePlugin: (input: DeletePluginInput$1) => Promise<DeletePluginResponse$1>;
|
|
@@ -19533,6 +20044,10 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
19533
20044
|
*/
|
|
19534
20045
|
messageExtractScript?: string;
|
|
19535
20046
|
};
|
|
20047
|
+
/**
|
|
20048
|
+
* Maximum execution time of the integration (in seconds).
|
|
20049
|
+
*/
|
|
20050
|
+
maxExecutionTime?: number;
|
|
19536
20051
|
/**
|
|
19537
20052
|
* URL of the [Integration](#schema_integration)
|
|
19538
20053
|
*/
|
|
@@ -19936,6 +20451,10 @@ interface GetPublicIntegrationResponse {
|
|
|
19936
20451
|
*/
|
|
19937
20452
|
messageExtractScript?: string;
|
|
19938
20453
|
};
|
|
20454
|
+
/**
|
|
20455
|
+
* Maximum execution time of the integration (in seconds).
|
|
20456
|
+
*/
|
|
20457
|
+
maxExecutionTime?: number;
|
|
19939
20458
|
/**
|
|
19940
20459
|
* URL of the [Integration](#schema_integration)
|
|
19941
20460
|
*/
|
|
@@ -20565,6 +21084,226 @@ interface GetPublicPluginByIdResponse {
|
|
|
20565
21084
|
};
|
|
20566
21085
|
}
|
|
20567
21086
|
|
|
21087
|
+
interface GetDereferencedPublicPluginByIdRequestHeaders {
|
|
21088
|
+
}
|
|
21089
|
+
interface GetDereferencedPublicPluginByIdRequestQuery {
|
|
21090
|
+
/**
|
|
21091
|
+
* Mapping of interface aliases to integration IDs
|
|
21092
|
+
*/
|
|
21093
|
+
interfaces: {
|
|
21094
|
+
/**
|
|
21095
|
+
* integration id
|
|
21096
|
+
*/
|
|
21097
|
+
[k: string]: string;
|
|
21098
|
+
};
|
|
21099
|
+
}
|
|
21100
|
+
interface GetDereferencedPublicPluginByIdRequestParams {
|
|
21101
|
+
id: string;
|
|
21102
|
+
}
|
|
21103
|
+
interface GetDereferencedPublicPluginByIdRequestBody {
|
|
21104
|
+
}
|
|
21105
|
+
type GetDereferencedPublicPluginByIdInput = GetDereferencedPublicPluginByIdRequestBody & GetDereferencedPublicPluginByIdRequestHeaders & GetDereferencedPublicPluginByIdRequestQuery & GetDereferencedPublicPluginByIdRequestParams;
|
|
21106
|
+
interface GetDereferencedPublicPluginByIdResponse {
|
|
21107
|
+
plugin: {
|
|
21108
|
+
/**
|
|
21109
|
+
* ID of the [Plugin](#schema_plugin)
|
|
21110
|
+
*/
|
|
21111
|
+
id: string;
|
|
21112
|
+
/**
|
|
21113
|
+
* Name of the [Plugin](#schema_plugin)
|
|
21114
|
+
*/
|
|
21115
|
+
name: string;
|
|
21116
|
+
/**
|
|
21117
|
+
* Version of the [Plugin](#schema_plugin)
|
|
21118
|
+
*/
|
|
21119
|
+
version: string;
|
|
21120
|
+
/**
|
|
21121
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
21122
|
+
*/
|
|
21123
|
+
createdAt: string;
|
|
21124
|
+
/**
|
|
21125
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
21126
|
+
*/
|
|
21127
|
+
updatedAt: string;
|
|
21128
|
+
/**
|
|
21129
|
+
* Configuration definition
|
|
21130
|
+
*/
|
|
21131
|
+
configuration: {
|
|
21132
|
+
/**
|
|
21133
|
+
* Title of the configuration
|
|
21134
|
+
*/
|
|
21135
|
+
title?: string;
|
|
21136
|
+
/**
|
|
21137
|
+
* Description of the configuration
|
|
21138
|
+
*/
|
|
21139
|
+
description?: string;
|
|
21140
|
+
/**
|
|
21141
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
21142
|
+
*/
|
|
21143
|
+
schema: {
|
|
21144
|
+
[k: string]: any;
|
|
21145
|
+
};
|
|
21146
|
+
};
|
|
21147
|
+
states: {
|
|
21148
|
+
[k: string]: {
|
|
21149
|
+
/**
|
|
21150
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
21151
|
+
*/
|
|
21152
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
21153
|
+
/**
|
|
21154
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
21155
|
+
*/
|
|
21156
|
+
schema: {
|
|
21157
|
+
[k: string]: any;
|
|
21158
|
+
};
|
|
21159
|
+
/**
|
|
21160
|
+
* 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.
|
|
21161
|
+
*/
|
|
21162
|
+
expiry?: number;
|
|
21163
|
+
};
|
|
21164
|
+
};
|
|
21165
|
+
events: {
|
|
21166
|
+
/**
|
|
21167
|
+
* Event Definition
|
|
21168
|
+
*/
|
|
21169
|
+
[k: string]: {
|
|
21170
|
+
/**
|
|
21171
|
+
* Title of the event
|
|
21172
|
+
*/
|
|
21173
|
+
title?: string;
|
|
21174
|
+
/**
|
|
21175
|
+
* Description of the event
|
|
21176
|
+
*/
|
|
21177
|
+
description?: string;
|
|
21178
|
+
schema: {
|
|
21179
|
+
[k: string]: any;
|
|
21180
|
+
};
|
|
21181
|
+
/**
|
|
21182
|
+
* Optional attributes
|
|
21183
|
+
*/
|
|
21184
|
+
attributes?: {
|
|
21185
|
+
[k: string]: string;
|
|
21186
|
+
};
|
|
21187
|
+
};
|
|
21188
|
+
};
|
|
21189
|
+
actions: {
|
|
21190
|
+
/**
|
|
21191
|
+
* Action definition
|
|
21192
|
+
*/
|
|
21193
|
+
[k: string]: {
|
|
21194
|
+
/**
|
|
21195
|
+
* Title of the action
|
|
21196
|
+
*/
|
|
21197
|
+
title?: string;
|
|
21198
|
+
/**
|
|
21199
|
+
* Description of the action
|
|
21200
|
+
*/
|
|
21201
|
+
description?: string;
|
|
21202
|
+
billable?: boolean;
|
|
21203
|
+
cacheable?: boolean;
|
|
21204
|
+
input: {
|
|
21205
|
+
schema: {
|
|
21206
|
+
[k: string]: any;
|
|
21207
|
+
};
|
|
21208
|
+
};
|
|
21209
|
+
output: {
|
|
21210
|
+
schema: {
|
|
21211
|
+
[k: string]: any;
|
|
21212
|
+
};
|
|
21213
|
+
};
|
|
21214
|
+
/**
|
|
21215
|
+
* Optional attributes
|
|
21216
|
+
*/
|
|
21217
|
+
attributes?: {
|
|
21218
|
+
[k: string]: string;
|
|
21219
|
+
};
|
|
21220
|
+
};
|
|
21221
|
+
};
|
|
21222
|
+
dependencies: {
|
|
21223
|
+
interfaces: {
|
|
21224
|
+
[k: string]: {
|
|
21225
|
+
id: string;
|
|
21226
|
+
name: string;
|
|
21227
|
+
version: string;
|
|
21228
|
+
};
|
|
21229
|
+
};
|
|
21230
|
+
integrations: {
|
|
21231
|
+
[k: string]: {
|
|
21232
|
+
id: string;
|
|
21233
|
+
name: string;
|
|
21234
|
+
version: string;
|
|
21235
|
+
};
|
|
21236
|
+
};
|
|
21237
|
+
};
|
|
21238
|
+
/**
|
|
21239
|
+
* User object configuration
|
|
21240
|
+
*/
|
|
21241
|
+
user: {
|
|
21242
|
+
tags: {
|
|
21243
|
+
/**
|
|
21244
|
+
* Definition of a tag that can be provided on the object
|
|
21245
|
+
*/
|
|
21246
|
+
[k: string]: {
|
|
21247
|
+
/**
|
|
21248
|
+
* Title of the tag
|
|
21249
|
+
*/
|
|
21250
|
+
title?: string;
|
|
21251
|
+
/**
|
|
21252
|
+
* Description of the tag
|
|
21253
|
+
*/
|
|
21254
|
+
description?: string;
|
|
21255
|
+
};
|
|
21256
|
+
};
|
|
21257
|
+
};
|
|
21258
|
+
/**
|
|
21259
|
+
* Conversation object configuration
|
|
21260
|
+
*/
|
|
21261
|
+
conversation: {
|
|
21262
|
+
tags: {
|
|
21263
|
+
/**
|
|
21264
|
+
* Definition of a tag that can be provided on the object
|
|
21265
|
+
*/
|
|
21266
|
+
[k: string]: {
|
|
21267
|
+
/**
|
|
21268
|
+
* Title of the tag
|
|
21269
|
+
*/
|
|
21270
|
+
title?: string;
|
|
21271
|
+
/**
|
|
21272
|
+
* Description of the tag
|
|
21273
|
+
*/
|
|
21274
|
+
description?: string;
|
|
21275
|
+
};
|
|
21276
|
+
};
|
|
21277
|
+
};
|
|
21278
|
+
/**
|
|
21279
|
+
* Optional attributes
|
|
21280
|
+
*/
|
|
21281
|
+
attributes?: {
|
|
21282
|
+
[k: string]: string;
|
|
21283
|
+
};
|
|
21284
|
+
/**
|
|
21285
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
21286
|
+
*/
|
|
21287
|
+
title: string;
|
|
21288
|
+
/**
|
|
21289
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
21290
|
+
*/
|
|
21291
|
+
description: string;
|
|
21292
|
+
/**
|
|
21293
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
21294
|
+
*/
|
|
21295
|
+
iconUrl: string;
|
|
21296
|
+
/**
|
|
21297
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
21298
|
+
*/
|
|
21299
|
+
readmeUrl: string;
|
|
21300
|
+
/**
|
|
21301
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
21302
|
+
*/
|
|
21303
|
+
public: boolean;
|
|
21304
|
+
};
|
|
21305
|
+
}
|
|
21306
|
+
|
|
20568
21307
|
interface GetPublicPluginRequestHeaders {
|
|
20569
21308
|
}
|
|
20570
21309
|
interface GetPublicPluginRequestQuery {
|
|
@@ -21533,6 +22272,10 @@ interface CreateBotResponse {
|
|
|
21533
22272
|
public: boolean;
|
|
21534
22273
|
};
|
|
21535
22274
|
};
|
|
22275
|
+
/**
|
|
22276
|
+
* Maximum execution time of the bot (in seconds).
|
|
22277
|
+
*/
|
|
22278
|
+
maxExecutionTime?: number;
|
|
21536
22279
|
/**
|
|
21537
22280
|
* User object configuration
|
|
21538
22281
|
*/
|
|
@@ -21810,6 +22553,10 @@ interface UpdateBotRequestBody {
|
|
|
21810
22553
|
[k: string]: string;
|
|
21811
22554
|
};
|
|
21812
22555
|
blocked?: boolean;
|
|
22556
|
+
/**
|
|
22557
|
+
* Maximum execution time (in seconds).
|
|
22558
|
+
*/
|
|
22559
|
+
maxExecutionTime?: number;
|
|
21813
22560
|
/**
|
|
21814
22561
|
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
21815
22562
|
*/
|
|
@@ -21948,6 +22695,10 @@ interface UpdateBotRequestBody {
|
|
|
21948
22695
|
integrations?: {
|
|
21949
22696
|
[k: string]: {
|
|
21950
22697
|
enabled?: boolean;
|
|
22698
|
+
/**
|
|
22699
|
+
* Integration's definition ID. If defined, the record's key is treated as an alias for the integration instance.
|
|
22700
|
+
*/
|
|
22701
|
+
integrationId?: string;
|
|
21951
22702
|
/**
|
|
21952
22703
|
* Integration's configuration type. Set to default if null.
|
|
21953
22704
|
*/
|
|
@@ -22146,6 +22897,10 @@ interface UpdateBotResponse {
|
|
|
22146
22897
|
public: boolean;
|
|
22147
22898
|
};
|
|
22148
22899
|
};
|
|
22900
|
+
/**
|
|
22901
|
+
* Maximum execution time of the bot (in seconds).
|
|
22902
|
+
*/
|
|
22903
|
+
maxExecutionTime?: number;
|
|
22149
22904
|
/**
|
|
22150
22905
|
* User object configuration
|
|
22151
22906
|
*/
|
|
@@ -22453,6 +23208,7 @@ interface ListBotsResponse {
|
|
|
22453
23208
|
interface GetBotRequestHeaders {
|
|
22454
23209
|
}
|
|
22455
23210
|
interface GetBotRequestQuery {
|
|
23211
|
+
shouldMergePlugins?: boolean;
|
|
22456
23212
|
}
|
|
22457
23213
|
interface GetBotRequestParams {
|
|
22458
23214
|
id: string;
|
|
@@ -22598,6 +23354,10 @@ interface GetBotResponse {
|
|
|
22598
23354
|
public: boolean;
|
|
22599
23355
|
};
|
|
22600
23356
|
};
|
|
23357
|
+
/**
|
|
23358
|
+
* Maximum execution time of the bot (in seconds).
|
|
23359
|
+
*/
|
|
23360
|
+
maxExecutionTime?: number;
|
|
22601
23361
|
/**
|
|
22602
23362
|
* User object configuration
|
|
22603
23363
|
*/
|
|
@@ -24301,9 +25061,13 @@ interface CreateIntegrationRequestBody {
|
|
|
24301
25061
|
};
|
|
24302
25062
|
};
|
|
24303
25063
|
/**
|
|
24304
|
-
* **EXPERIMENTAL**
|
|
25064
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
24305
25065
|
*/
|
|
24306
|
-
|
|
25066
|
+
extraOperations?: {
|
|
25067
|
+
[k: string]: {
|
|
25068
|
+
enabled: boolean;
|
|
25069
|
+
};
|
|
25070
|
+
};
|
|
24307
25071
|
/**
|
|
24308
25072
|
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
24309
25073
|
*/
|
|
@@ -24382,6 +25146,10 @@ interface CreateIntegrationResponse {
|
|
|
24382
25146
|
*/
|
|
24383
25147
|
messageExtractScript?: string;
|
|
24384
25148
|
};
|
|
25149
|
+
/**
|
|
25150
|
+
* Maximum execution time of the integration (in seconds).
|
|
25151
|
+
*/
|
|
25152
|
+
maxExecutionTime?: number;
|
|
24385
25153
|
/**
|
|
24386
25154
|
* URL of the [Integration](#schema_integration)
|
|
24387
25155
|
*/
|
|
@@ -25021,9 +25789,13 @@ interface ValidateIntegrationCreationRequestBody {
|
|
|
25021
25789
|
};
|
|
25022
25790
|
};
|
|
25023
25791
|
/**
|
|
25024
|
-
* **EXPERIMENTAL**
|
|
25792
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
25025
25793
|
*/
|
|
25026
|
-
|
|
25794
|
+
extraOperations?: {
|
|
25795
|
+
[k: string]: {
|
|
25796
|
+
enabled: boolean;
|
|
25797
|
+
};
|
|
25798
|
+
};
|
|
25027
25799
|
/**
|
|
25028
25800
|
* Secrets are integration-wide values available in the code via environment variables formatted with a SECRET_ prefix followed by your secret name. A secret name must respect SCREAMING_SNAKE casing.
|
|
25029
25801
|
*/
|
|
@@ -25125,9 +25897,13 @@ interface UpdateIntegrationRequestBody {
|
|
|
25125
25897
|
} | null;
|
|
25126
25898
|
};
|
|
25127
25899
|
/**
|
|
25128
|
-
* **EXPERIMENTAL**
|
|
25900
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
25129
25901
|
*/
|
|
25130
|
-
|
|
25902
|
+
extraOperations?: {
|
|
25903
|
+
[k: string]: {
|
|
25904
|
+
enabled: boolean;
|
|
25905
|
+
};
|
|
25906
|
+
};
|
|
25131
25907
|
channels?: {
|
|
25132
25908
|
[k: string]: {
|
|
25133
25909
|
/**
|
|
@@ -25197,6 +25973,10 @@ interface UpdateIntegrationRequestBody {
|
|
|
25197
25973
|
};
|
|
25198
25974
|
} | null;
|
|
25199
25975
|
};
|
|
25976
|
+
/**
|
|
25977
|
+
* Maximum execution time of the integration (in seconds).
|
|
25978
|
+
*/
|
|
25979
|
+
maxExecutionTime?: number;
|
|
25200
25980
|
identifier?: {
|
|
25201
25981
|
extractScript?: string | null;
|
|
25202
25982
|
fallbackHandlerScript?: string | null;
|
|
@@ -25425,6 +26205,10 @@ interface UpdateIntegrationResponse {
|
|
|
25425
26205
|
*/
|
|
25426
26206
|
messageExtractScript?: string;
|
|
25427
26207
|
};
|
|
26208
|
+
/**
|
|
26209
|
+
* Maximum execution time of the integration (in seconds).
|
|
26210
|
+
*/
|
|
26211
|
+
maxExecutionTime?: number;
|
|
25428
26212
|
/**
|
|
25429
26213
|
* URL of the [Integration](#schema_integration)
|
|
25430
26214
|
*/
|
|
@@ -25828,9 +26612,13 @@ interface ValidateIntegrationUpdateRequestBody {
|
|
|
25828
26612
|
} | null;
|
|
25829
26613
|
};
|
|
25830
26614
|
/**
|
|
25831
|
-
* **EXPERIMENTAL**
|
|
26615
|
+
* **EXPERIMENTAL** Extra integration operations that should be sent or not to the integration instances. The key is the operation name.
|
|
25832
26616
|
*/
|
|
25833
|
-
|
|
26617
|
+
extraOperations?: {
|
|
26618
|
+
[k: string]: {
|
|
26619
|
+
enabled: boolean;
|
|
26620
|
+
};
|
|
26621
|
+
};
|
|
25834
26622
|
channels?: {
|
|
25835
26623
|
[k: string]: {
|
|
25836
26624
|
/**
|
|
@@ -25900,6 +26688,10 @@ interface ValidateIntegrationUpdateRequestBody {
|
|
|
25900
26688
|
};
|
|
25901
26689
|
} | null;
|
|
25902
26690
|
};
|
|
26691
|
+
/**
|
|
26692
|
+
* Maximum execution time of the integration (in seconds).
|
|
26693
|
+
*/
|
|
26694
|
+
maxExecutionTime?: number;
|
|
25903
26695
|
identifier?: {
|
|
25904
26696
|
extractScript?: string | null;
|
|
25905
26697
|
fallbackHandlerScript?: string | null;
|
|
@@ -26244,6 +27036,10 @@ interface GetIntegrationResponse {
|
|
|
26244
27036
|
*/
|
|
26245
27037
|
messageExtractScript?: string;
|
|
26246
27038
|
};
|
|
27039
|
+
/**
|
|
27040
|
+
* Maximum execution time of the integration (in seconds).
|
|
27041
|
+
*/
|
|
27042
|
+
maxExecutionTime?: number;
|
|
26247
27043
|
/**
|
|
26248
27044
|
* URL of the [Integration](#schema_integration)
|
|
26249
27045
|
*/
|
|
@@ -26667,6 +27463,10 @@ interface GetIntegrationByNameResponse {
|
|
|
26667
27463
|
*/
|
|
26668
27464
|
messageExtractScript?: string;
|
|
26669
27465
|
};
|
|
27466
|
+
/**
|
|
27467
|
+
* Maximum execution time of the integration (in seconds).
|
|
27468
|
+
*/
|
|
27469
|
+
maxExecutionTime?: number;
|
|
26670
27470
|
/**
|
|
26671
27471
|
* URL of the [Integration](#schema_integration)
|
|
26672
27472
|
*/
|
|
@@ -28648,6 +29448,226 @@ interface GetPluginResponse {
|
|
|
28648
29448
|
};
|
|
28649
29449
|
}
|
|
28650
29450
|
|
|
29451
|
+
interface GetDereferencedPluginRequestHeaders {
|
|
29452
|
+
}
|
|
29453
|
+
interface GetDereferencedPluginRequestQuery {
|
|
29454
|
+
/**
|
|
29455
|
+
* Mapping of interface aliases to integration IDs
|
|
29456
|
+
*/
|
|
29457
|
+
interfaces: {
|
|
29458
|
+
/**
|
|
29459
|
+
* integration id
|
|
29460
|
+
*/
|
|
29461
|
+
[k: string]: string;
|
|
29462
|
+
};
|
|
29463
|
+
}
|
|
29464
|
+
interface GetDereferencedPluginRequestParams {
|
|
29465
|
+
id: string;
|
|
29466
|
+
}
|
|
29467
|
+
interface GetDereferencedPluginRequestBody {
|
|
29468
|
+
}
|
|
29469
|
+
type GetDereferencedPluginInput = GetDereferencedPluginRequestBody & GetDereferencedPluginRequestHeaders & GetDereferencedPluginRequestQuery & GetDereferencedPluginRequestParams;
|
|
29470
|
+
interface GetDereferencedPluginResponse {
|
|
29471
|
+
plugin: {
|
|
29472
|
+
/**
|
|
29473
|
+
* ID of the [Plugin](#schema_plugin)
|
|
29474
|
+
*/
|
|
29475
|
+
id: string;
|
|
29476
|
+
/**
|
|
29477
|
+
* Name of the [Plugin](#schema_plugin)
|
|
29478
|
+
*/
|
|
29479
|
+
name: string;
|
|
29480
|
+
/**
|
|
29481
|
+
* Version of the [Plugin](#schema_plugin)
|
|
29482
|
+
*/
|
|
29483
|
+
version: string;
|
|
29484
|
+
/**
|
|
29485
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
29486
|
+
*/
|
|
29487
|
+
createdAt: string;
|
|
29488
|
+
/**
|
|
29489
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
29490
|
+
*/
|
|
29491
|
+
updatedAt: string;
|
|
29492
|
+
/**
|
|
29493
|
+
* Configuration definition
|
|
29494
|
+
*/
|
|
29495
|
+
configuration: {
|
|
29496
|
+
/**
|
|
29497
|
+
* Title of the configuration
|
|
29498
|
+
*/
|
|
29499
|
+
title?: string;
|
|
29500
|
+
/**
|
|
29501
|
+
* Description of the configuration
|
|
29502
|
+
*/
|
|
29503
|
+
description?: string;
|
|
29504
|
+
/**
|
|
29505
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
29506
|
+
*/
|
|
29507
|
+
schema: {
|
|
29508
|
+
[k: string]: any;
|
|
29509
|
+
};
|
|
29510
|
+
};
|
|
29511
|
+
states: {
|
|
29512
|
+
[k: string]: {
|
|
29513
|
+
/**
|
|
29514
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
29515
|
+
*/
|
|
29516
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
29517
|
+
/**
|
|
29518
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
29519
|
+
*/
|
|
29520
|
+
schema: {
|
|
29521
|
+
[k: string]: any;
|
|
29522
|
+
};
|
|
29523
|
+
/**
|
|
29524
|
+
* 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.
|
|
29525
|
+
*/
|
|
29526
|
+
expiry?: number;
|
|
29527
|
+
};
|
|
29528
|
+
};
|
|
29529
|
+
events: {
|
|
29530
|
+
/**
|
|
29531
|
+
* Event Definition
|
|
29532
|
+
*/
|
|
29533
|
+
[k: string]: {
|
|
29534
|
+
/**
|
|
29535
|
+
* Title of the event
|
|
29536
|
+
*/
|
|
29537
|
+
title?: string;
|
|
29538
|
+
/**
|
|
29539
|
+
* Description of the event
|
|
29540
|
+
*/
|
|
29541
|
+
description?: string;
|
|
29542
|
+
schema: {
|
|
29543
|
+
[k: string]: any;
|
|
29544
|
+
};
|
|
29545
|
+
/**
|
|
29546
|
+
* Optional attributes
|
|
29547
|
+
*/
|
|
29548
|
+
attributes?: {
|
|
29549
|
+
[k: string]: string;
|
|
29550
|
+
};
|
|
29551
|
+
};
|
|
29552
|
+
};
|
|
29553
|
+
actions: {
|
|
29554
|
+
/**
|
|
29555
|
+
* Action definition
|
|
29556
|
+
*/
|
|
29557
|
+
[k: string]: {
|
|
29558
|
+
/**
|
|
29559
|
+
* Title of the action
|
|
29560
|
+
*/
|
|
29561
|
+
title?: string;
|
|
29562
|
+
/**
|
|
29563
|
+
* Description of the action
|
|
29564
|
+
*/
|
|
29565
|
+
description?: string;
|
|
29566
|
+
billable?: boolean;
|
|
29567
|
+
cacheable?: boolean;
|
|
29568
|
+
input: {
|
|
29569
|
+
schema: {
|
|
29570
|
+
[k: string]: any;
|
|
29571
|
+
};
|
|
29572
|
+
};
|
|
29573
|
+
output: {
|
|
29574
|
+
schema: {
|
|
29575
|
+
[k: string]: any;
|
|
29576
|
+
};
|
|
29577
|
+
};
|
|
29578
|
+
/**
|
|
29579
|
+
* Optional attributes
|
|
29580
|
+
*/
|
|
29581
|
+
attributes?: {
|
|
29582
|
+
[k: string]: string;
|
|
29583
|
+
};
|
|
29584
|
+
};
|
|
29585
|
+
};
|
|
29586
|
+
dependencies: {
|
|
29587
|
+
interfaces: {
|
|
29588
|
+
[k: string]: {
|
|
29589
|
+
id: string;
|
|
29590
|
+
name: string;
|
|
29591
|
+
version: string;
|
|
29592
|
+
};
|
|
29593
|
+
};
|
|
29594
|
+
integrations: {
|
|
29595
|
+
[k: string]: {
|
|
29596
|
+
id: string;
|
|
29597
|
+
name: string;
|
|
29598
|
+
version: string;
|
|
29599
|
+
};
|
|
29600
|
+
};
|
|
29601
|
+
};
|
|
29602
|
+
/**
|
|
29603
|
+
* User object configuration
|
|
29604
|
+
*/
|
|
29605
|
+
user: {
|
|
29606
|
+
tags: {
|
|
29607
|
+
/**
|
|
29608
|
+
* Definition of a tag that can be provided on the object
|
|
29609
|
+
*/
|
|
29610
|
+
[k: string]: {
|
|
29611
|
+
/**
|
|
29612
|
+
* Title of the tag
|
|
29613
|
+
*/
|
|
29614
|
+
title?: string;
|
|
29615
|
+
/**
|
|
29616
|
+
* Description of the tag
|
|
29617
|
+
*/
|
|
29618
|
+
description?: string;
|
|
29619
|
+
};
|
|
29620
|
+
};
|
|
29621
|
+
};
|
|
29622
|
+
/**
|
|
29623
|
+
* Conversation object configuration
|
|
29624
|
+
*/
|
|
29625
|
+
conversation: {
|
|
29626
|
+
tags: {
|
|
29627
|
+
/**
|
|
29628
|
+
* Definition of a tag that can be provided on the object
|
|
29629
|
+
*/
|
|
29630
|
+
[k: string]: {
|
|
29631
|
+
/**
|
|
29632
|
+
* Title of the tag
|
|
29633
|
+
*/
|
|
29634
|
+
title?: string;
|
|
29635
|
+
/**
|
|
29636
|
+
* Description of the tag
|
|
29637
|
+
*/
|
|
29638
|
+
description?: string;
|
|
29639
|
+
};
|
|
29640
|
+
};
|
|
29641
|
+
};
|
|
29642
|
+
/**
|
|
29643
|
+
* Optional attributes
|
|
29644
|
+
*/
|
|
29645
|
+
attributes?: {
|
|
29646
|
+
[k: string]: string;
|
|
29647
|
+
};
|
|
29648
|
+
/**
|
|
29649
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
29650
|
+
*/
|
|
29651
|
+
title: string;
|
|
29652
|
+
/**
|
|
29653
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
29654
|
+
*/
|
|
29655
|
+
description: string;
|
|
29656
|
+
/**
|
|
29657
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
29658
|
+
*/
|
|
29659
|
+
iconUrl: string;
|
|
29660
|
+
/**
|
|
29661
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
29662
|
+
*/
|
|
29663
|
+
readmeUrl: string;
|
|
29664
|
+
/**
|
|
29665
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
29666
|
+
*/
|
|
29667
|
+
public: boolean;
|
|
29668
|
+
};
|
|
29669
|
+
}
|
|
29670
|
+
|
|
28651
29671
|
interface GetPluginByNameRequestHeaders {
|
|
28652
29672
|
}
|
|
28653
29673
|
interface GetPluginByNameRequestQuery {
|
|
@@ -32336,6 +33356,10 @@ interface Bot {
|
|
|
32336
33356
|
public: boolean;
|
|
32337
33357
|
};
|
|
32338
33358
|
};
|
|
33359
|
+
/**
|
|
33360
|
+
* Maximum execution time of the bot (in seconds).
|
|
33361
|
+
*/
|
|
33362
|
+
maxExecutionTime?: number;
|
|
32339
33363
|
/**
|
|
32340
33364
|
* User object configuration
|
|
32341
33365
|
*/
|
|
@@ -32610,6 +33634,10 @@ interface Integration {
|
|
|
32610
33634
|
*/
|
|
32611
33635
|
messageExtractScript?: string;
|
|
32612
33636
|
};
|
|
33637
|
+
/**
|
|
33638
|
+
* Maximum execution time of the integration (in seconds).
|
|
33639
|
+
*/
|
|
33640
|
+
maxExecutionTime?: number;
|
|
32613
33641
|
/**
|
|
32614
33642
|
* URL of the [Integration](#schema_integration)
|
|
32615
33643
|
*/
|
|
@@ -34106,6 +35134,7 @@ declare class Client$1 {
|
|
|
34106
35134
|
readonly getPublicIntegration: (input: GetPublicIntegrationInput) => Promise<GetPublicIntegrationResponse>;
|
|
34107
35135
|
readonly listPublicPlugins: (input: ListPublicPluginsInput) => Promise<ListPublicPluginsResponse>;
|
|
34108
35136
|
readonly getPublicPluginById: (input: GetPublicPluginByIdInput) => Promise<GetPublicPluginByIdResponse>;
|
|
35137
|
+
readonly getDereferencedPublicPluginById: (input: GetDereferencedPublicPluginByIdInput) => Promise<GetDereferencedPublicPluginByIdResponse>;
|
|
34109
35138
|
readonly getPublicPlugin: (input: GetPublicPluginInput) => Promise<GetPublicPluginResponse>;
|
|
34110
35139
|
readonly getPublicPluginCode: (input: GetPublicPluginCodeInput) => Promise<GetPublicPluginCodeResponse>;
|
|
34111
35140
|
readonly listPublicInterfaces: (input: ListPublicInterfacesInput) => Promise<ListPublicInterfacesResponse>;
|
|
@@ -34181,6 +35210,7 @@ declare class Client$1 {
|
|
|
34181
35210
|
readonly listInterfaces: (input: ListInterfacesInput) => Promise<ListInterfacesResponse>;
|
|
34182
35211
|
readonly createPlugin: (input: CreatePluginInput) => Promise<CreatePluginResponse>;
|
|
34183
35212
|
readonly getPlugin: (input: GetPluginInput) => Promise<GetPluginResponse>;
|
|
35213
|
+
readonly getDereferencedPlugin: (input: GetDereferencedPluginInput) => Promise<GetDereferencedPluginResponse>;
|
|
34184
35214
|
readonly getPluginByName: (input: GetPluginByNameInput) => Promise<GetPluginByNameResponse>;
|
|
34185
35215
|
readonly updatePlugin: (input: UpdatePluginInput) => Promise<UpdatePluginResponse>;
|
|
34186
35216
|
readonly deletePlugin: (input: DeletePluginInput) => Promise<DeletePluginResponse>;
|