@botpress/client 1.9.0 → 1.11.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/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 +2042 -1180
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +4 -4
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -4540,391 +4540,279 @@ interface GetPublicPluginCodeResponse$1 {
|
|
|
4540
4540
|
code: string;
|
|
4541
4541
|
}
|
|
4542
4542
|
|
|
4543
|
-
interface
|
|
4543
|
+
interface ListPublicInterfacesRequestHeaders$1 {
|
|
4544
4544
|
}
|
|
4545
|
-
interface
|
|
4545
|
+
interface ListPublicInterfacesRequestQuery$1 {
|
|
4546
|
+
nextToken?: string;
|
|
4547
|
+
name?: string;
|
|
4548
|
+
version?: string;
|
|
4546
4549
|
}
|
|
4547
|
-
interface
|
|
4550
|
+
interface ListPublicInterfacesRequestParams$1 {
|
|
4548
4551
|
}
|
|
4549
|
-
interface
|
|
4550
|
-
|
|
4551
|
-
|
|
4552
|
-
|
|
4553
|
-
|
|
4554
|
-
[k: string]: {
|
|
4555
|
-
/**
|
|
4556
|
-
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
4557
|
-
*/
|
|
4558
|
-
type: "conversation" | "user" | "bot" | "task";
|
|
4559
|
-
/**
|
|
4560
|
-
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4561
|
-
*/
|
|
4562
|
-
schema: {
|
|
4563
|
-
[k: string]: any;
|
|
4564
|
-
};
|
|
4565
|
-
/**
|
|
4566
|
-
* 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.
|
|
4567
|
-
*/
|
|
4568
|
-
expiry?: number;
|
|
4569
|
-
};
|
|
4570
|
-
};
|
|
4571
|
-
/**
|
|
4572
|
-
* Events definition
|
|
4573
|
-
*/
|
|
4574
|
-
events?: {
|
|
4552
|
+
interface ListPublicInterfacesRequestBody$1 {
|
|
4553
|
+
}
|
|
4554
|
+
type ListPublicInterfacesInput$1 = ListPublicInterfacesRequestBody$1 & ListPublicInterfacesRequestHeaders$1 & ListPublicInterfacesRequestQuery$1 & ListPublicInterfacesRequestParams$1;
|
|
4555
|
+
interface ListPublicInterfacesResponse$1 {
|
|
4556
|
+
interfaces: {
|
|
4575
4557
|
/**
|
|
4576
|
-
*
|
|
4558
|
+
* ID of the [Interface](#schema_interface)
|
|
4577
4559
|
*/
|
|
4578
|
-
|
|
4579
|
-
/**
|
|
4580
|
-
* Title of the event
|
|
4581
|
-
*/
|
|
4582
|
-
title?: string;
|
|
4583
|
-
/**
|
|
4584
|
-
* Description of the event
|
|
4585
|
-
*/
|
|
4586
|
-
description?: string;
|
|
4587
|
-
schema: {
|
|
4588
|
-
[k: string]: any;
|
|
4589
|
-
};
|
|
4590
|
-
/**
|
|
4591
|
-
* Optional attributes
|
|
4592
|
-
*/
|
|
4593
|
-
attributes?: {
|
|
4594
|
-
[k: string]: string;
|
|
4595
|
-
};
|
|
4596
|
-
};
|
|
4597
|
-
};
|
|
4598
|
-
recurringEvents?: {
|
|
4599
|
-
[k: string]: {
|
|
4600
|
-
schedule: {
|
|
4601
|
-
cron: string;
|
|
4602
|
-
};
|
|
4603
|
-
type: string;
|
|
4604
|
-
payload: {
|
|
4605
|
-
[k: string]: any;
|
|
4606
|
-
};
|
|
4607
|
-
};
|
|
4608
|
-
};
|
|
4609
|
-
/**
|
|
4610
|
-
* Subscriptions of the bot
|
|
4611
|
-
*/
|
|
4612
|
-
subscriptions?: {
|
|
4560
|
+
id: string;
|
|
4613
4561
|
/**
|
|
4614
|
-
*
|
|
4562
|
+
* Creation date of the [Interface](#schema_interface) in ISO 8601 format
|
|
4615
4563
|
*/
|
|
4616
|
-
|
|
4617
|
-
[k: string]: {};
|
|
4618
|
-
} | null;
|
|
4619
|
-
};
|
|
4620
|
-
/**
|
|
4621
|
-
* Actions definition
|
|
4622
|
-
*/
|
|
4623
|
-
actions?: {
|
|
4564
|
+
createdAt: string;
|
|
4624
4565
|
/**
|
|
4625
|
-
*
|
|
4566
|
+
* Updating date of the [Interface](#schema_interface) in ISO 8601 format
|
|
4626
4567
|
*/
|
|
4627
|
-
|
|
4628
|
-
/**
|
|
4629
|
-
* Title of the action
|
|
4630
|
-
*/
|
|
4631
|
-
title?: string;
|
|
4632
|
-
/**
|
|
4633
|
-
* Description of the action
|
|
4634
|
-
*/
|
|
4635
|
-
description?: string;
|
|
4636
|
-
billable?: boolean;
|
|
4637
|
-
cacheable?: boolean;
|
|
4638
|
-
input: {
|
|
4639
|
-
schema: {
|
|
4640
|
-
[k: string]: any;
|
|
4641
|
-
};
|
|
4642
|
-
};
|
|
4643
|
-
output: {
|
|
4644
|
-
schema: {
|
|
4645
|
-
[k: string]: any;
|
|
4646
|
-
};
|
|
4647
|
-
};
|
|
4648
|
-
/**
|
|
4649
|
-
* Optional attributes
|
|
4650
|
-
*/
|
|
4651
|
-
attributes?: {
|
|
4652
|
-
[k: string]: string;
|
|
4653
|
-
};
|
|
4654
|
-
};
|
|
4655
|
-
};
|
|
4656
|
-
configuration?: {
|
|
4568
|
+
updatedAt: string;
|
|
4657
4569
|
/**
|
|
4658
|
-
*
|
|
4570
|
+
* Name of the [Interface](#schema_interface)
|
|
4659
4571
|
*/
|
|
4660
|
-
|
|
4661
|
-
[k: string]: any;
|
|
4662
|
-
};
|
|
4572
|
+
name: string;
|
|
4663
4573
|
/**
|
|
4664
|
-
*
|
|
4574
|
+
* Version of the [Interface](#schema_interface)
|
|
4665
4575
|
*/
|
|
4666
|
-
|
|
4667
|
-
|
|
4668
|
-
|
|
4576
|
+
version: string;
|
|
4577
|
+
/**
|
|
4578
|
+
* Title of the interface. This is the name that will be displayed in the UI
|
|
4579
|
+
*/
|
|
4580
|
+
title: string;
|
|
4581
|
+
/**
|
|
4582
|
+
* Description of the interface. This is the description that will be displayed in the UI
|
|
4583
|
+
*/
|
|
4584
|
+
description: string;
|
|
4585
|
+
/**
|
|
4586
|
+
* URL of the icon of the interface. This is the icon that will be displayed in the UI
|
|
4587
|
+
*/
|
|
4588
|
+
iconUrl: string;
|
|
4589
|
+
/**
|
|
4590
|
+
* URL of the readme of the interface. This is the readme that will be displayed in the UI
|
|
4591
|
+
*/
|
|
4592
|
+
readmeUrl: string;
|
|
4593
|
+
/**
|
|
4594
|
+
* Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
|
|
4595
|
+
*/
|
|
4596
|
+
public: boolean;
|
|
4597
|
+
}[];
|
|
4598
|
+
meta: {
|
|
4599
|
+
/**
|
|
4600
|
+
* 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.
|
|
4601
|
+
*/
|
|
4602
|
+
nextToken?: string;
|
|
4669
4603
|
};
|
|
4670
|
-
|
|
4671
|
-
|
|
4604
|
+
}
|
|
4605
|
+
|
|
4606
|
+
interface GetPublicInterfaceByIdRequestHeaders$1 {
|
|
4607
|
+
}
|
|
4608
|
+
interface GetPublicInterfaceByIdRequestQuery$1 {
|
|
4609
|
+
}
|
|
4610
|
+
interface GetPublicInterfaceByIdRequestParams$1 {
|
|
4611
|
+
id: string;
|
|
4612
|
+
}
|
|
4613
|
+
interface GetPublicInterfaceByIdRequestBody$1 {
|
|
4614
|
+
}
|
|
4615
|
+
type GetPublicInterfaceByIdInput$1 = GetPublicInterfaceByIdRequestBody$1 & GetPublicInterfaceByIdRequestHeaders$1 & GetPublicInterfaceByIdRequestQuery$1 & GetPublicInterfaceByIdRequestParams$1;
|
|
4616
|
+
interface GetPublicInterfaceByIdResponse$1 {
|
|
4617
|
+
interface: {
|
|
4618
|
+
/**
|
|
4619
|
+
* ID of the [Interface](#schema_interface)
|
|
4620
|
+
*/
|
|
4621
|
+
id: string;
|
|
4622
|
+
/**
|
|
4623
|
+
* Creation date of the [Interface](#schema_interface) in ISO 8601 format
|
|
4624
|
+
*/
|
|
4625
|
+
createdAt: string;
|
|
4626
|
+
/**
|
|
4627
|
+
* Updating date of the [Interface](#schema_interface) in ISO 8601 format
|
|
4628
|
+
*/
|
|
4629
|
+
updatedAt: string;
|
|
4630
|
+
/**
|
|
4631
|
+
* Name of the [Interface](#schema_interface)
|
|
4632
|
+
*/
|
|
4633
|
+
name: string;
|
|
4634
|
+
/**
|
|
4635
|
+
* Version of the [Interface](#schema_interface)
|
|
4636
|
+
*/
|
|
4637
|
+
version: string;
|
|
4638
|
+
entities: {
|
|
4672
4639
|
/**
|
|
4673
|
-
*
|
|
4640
|
+
* Entity definition
|
|
4674
4641
|
*/
|
|
4675
4642
|
[k: string]: {
|
|
4676
4643
|
/**
|
|
4677
|
-
* Title of the
|
|
4644
|
+
* Title of the entity
|
|
4678
4645
|
*/
|
|
4679
4646
|
title?: string;
|
|
4680
4647
|
/**
|
|
4681
|
-
* Description of the
|
|
4648
|
+
* Description of the entity
|
|
4682
4649
|
*/
|
|
4683
4650
|
description?: string;
|
|
4651
|
+
schema: {
|
|
4652
|
+
[k: string]: any;
|
|
4653
|
+
};
|
|
4684
4654
|
};
|
|
4685
4655
|
};
|
|
4686
|
-
|
|
4687
|
-
conversation?: {
|
|
4688
|
-
tags?: {
|
|
4656
|
+
events: {
|
|
4689
4657
|
/**
|
|
4690
|
-
* Definition
|
|
4658
|
+
* Event Definition
|
|
4691
4659
|
*/
|
|
4692
4660
|
[k: string]: {
|
|
4693
4661
|
/**
|
|
4694
|
-
* Title of the
|
|
4662
|
+
* Title of the event
|
|
4695
4663
|
*/
|
|
4696
4664
|
title?: string;
|
|
4697
4665
|
/**
|
|
4698
|
-
* Description of the
|
|
4666
|
+
* Description of the event
|
|
4699
4667
|
*/
|
|
4700
4668
|
description?: string;
|
|
4669
|
+
schema: {
|
|
4670
|
+
[k: string]: any;
|
|
4671
|
+
};
|
|
4672
|
+
/**
|
|
4673
|
+
* Optional attributes
|
|
4674
|
+
*/
|
|
4675
|
+
attributes?: {
|
|
4676
|
+
[k: string]: string;
|
|
4677
|
+
};
|
|
4701
4678
|
};
|
|
4702
4679
|
};
|
|
4703
|
-
|
|
4704
|
-
message?: {
|
|
4705
|
-
tags?: {
|
|
4680
|
+
actions: {
|
|
4706
4681
|
/**
|
|
4707
|
-
*
|
|
4682
|
+
* Action definition
|
|
4708
4683
|
*/
|
|
4709
4684
|
[k: string]: {
|
|
4710
4685
|
/**
|
|
4711
|
-
* Title of the
|
|
4686
|
+
* Title of the action
|
|
4712
4687
|
*/
|
|
4713
4688
|
title?: string;
|
|
4714
4689
|
/**
|
|
4715
|
-
* Description of the
|
|
4690
|
+
* Description of the action
|
|
4716
4691
|
*/
|
|
4717
4692
|
description?: string;
|
|
4693
|
+
billable?: boolean;
|
|
4694
|
+
cacheable?: boolean;
|
|
4695
|
+
input: {
|
|
4696
|
+
schema: {
|
|
4697
|
+
[k: string]: any;
|
|
4698
|
+
};
|
|
4699
|
+
};
|
|
4700
|
+
output: {
|
|
4701
|
+
schema: {
|
|
4702
|
+
[k: string]: any;
|
|
4703
|
+
};
|
|
4704
|
+
};
|
|
4705
|
+
/**
|
|
4706
|
+
* Optional attributes
|
|
4707
|
+
*/
|
|
4708
|
+
attributes?: {
|
|
4709
|
+
[k: string]: string;
|
|
4710
|
+
};
|
|
4711
|
+
};
|
|
4712
|
+
};
|
|
4713
|
+
channels: {
|
|
4714
|
+
[k: string]: {
|
|
4715
|
+
/**
|
|
4716
|
+
* Title of the channel
|
|
4717
|
+
*/
|
|
4718
|
+
title?: string;
|
|
4719
|
+
/**
|
|
4720
|
+
* Description of the channel
|
|
4721
|
+
*/
|
|
4722
|
+
description?: string;
|
|
4723
|
+
messages: {
|
|
4724
|
+
/**
|
|
4725
|
+
* Message definition
|
|
4726
|
+
*/
|
|
4727
|
+
[k: string]: {
|
|
4728
|
+
schema: {
|
|
4729
|
+
[k: string]: any;
|
|
4730
|
+
};
|
|
4731
|
+
};
|
|
4732
|
+
};
|
|
4718
4733
|
};
|
|
4719
4734
|
};
|
|
4720
|
-
};
|
|
4721
|
-
/**
|
|
4722
|
-
* Tags of the [Bot](#schema_bot)
|
|
4723
|
-
*/
|
|
4724
|
-
tags?: {
|
|
4725
|
-
[k: string]: string;
|
|
4726
|
-
};
|
|
4727
|
-
/**
|
|
4728
|
-
* JavaScript code of the bot
|
|
4729
|
-
*/
|
|
4730
|
-
code?: string;
|
|
4731
|
-
/**
|
|
4732
|
-
* Optional name for the bot, if not provided will be auto-generated
|
|
4733
|
-
*/
|
|
4734
|
-
name?: string;
|
|
4735
|
-
/**
|
|
4736
|
-
* Media files associated with the [Bot](#schema_bot)
|
|
4737
|
-
*/
|
|
4738
|
-
medias?: {
|
|
4739
|
-
url: string;
|
|
4740
|
-
name: string;
|
|
4741
|
-
}[];
|
|
4742
|
-
/**
|
|
4743
|
-
* URL of the [Bot](#schema_bot); Only available for dev bots
|
|
4744
|
-
*/
|
|
4745
|
-
url?: string;
|
|
4746
|
-
/**
|
|
4747
|
-
* Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
|
|
4748
|
-
*/
|
|
4749
|
-
dev?: boolean;
|
|
4750
|
-
}
|
|
4751
|
-
type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
|
|
4752
|
-
interface CreateBotResponse$1 {
|
|
4753
|
-
bot: {
|
|
4754
4735
|
/**
|
|
4755
|
-
*
|
|
4736
|
+
* Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
|
|
4756
4737
|
*/
|
|
4757
|
-
|
|
4738
|
+
nameTemplate?: {
|
|
4739
|
+
script: string;
|
|
4740
|
+
language: string;
|
|
4741
|
+
};
|
|
4758
4742
|
/**
|
|
4759
|
-
*
|
|
4743
|
+
* Title of the interface. This is the name that will be displayed in the UI
|
|
4760
4744
|
*/
|
|
4761
|
-
|
|
4745
|
+
title: string;
|
|
4762
4746
|
/**
|
|
4763
|
-
*
|
|
4747
|
+
* Description of the interface. This is the description that will be displayed in the UI
|
|
4764
4748
|
*/
|
|
4765
|
-
|
|
4749
|
+
description: string;
|
|
4766
4750
|
/**
|
|
4767
|
-
*
|
|
4751
|
+
* URL of the icon of the interface. This is the icon that will be displayed in the UI
|
|
4768
4752
|
*/
|
|
4769
|
-
|
|
4753
|
+
iconUrl: string;
|
|
4770
4754
|
/**
|
|
4771
|
-
*
|
|
4755
|
+
* URL of the readme of the interface. This is the readme that will be displayed in the UI
|
|
4772
4756
|
*/
|
|
4773
|
-
|
|
4774
|
-
[k: string]: {
|
|
4775
|
-
enabled: boolean;
|
|
4776
|
-
/**
|
|
4777
|
-
* Name of the [Integration](#schema_integration)
|
|
4778
|
-
*/
|
|
4779
|
-
name: string;
|
|
4780
|
-
/**
|
|
4781
|
-
* Version of the [Integration](#schema_integration)
|
|
4782
|
-
*/
|
|
4783
|
-
version: string;
|
|
4784
|
-
webhookUrl: string;
|
|
4785
|
-
webhookId: string;
|
|
4786
|
-
identifier?: string;
|
|
4787
|
-
configurationType: string | null;
|
|
4788
|
-
configuration: {
|
|
4789
|
-
[k: string]: any;
|
|
4790
|
-
};
|
|
4791
|
-
status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
|
|
4792
|
-
statusReason: string | null;
|
|
4793
|
-
/**
|
|
4794
|
-
* ID of the [Integration](#schema_integration)
|
|
4795
|
-
*/
|
|
4796
|
-
id: string;
|
|
4797
|
-
/**
|
|
4798
|
-
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
4799
|
-
*/
|
|
4800
|
-
createdAt: string;
|
|
4801
|
-
/**
|
|
4802
|
-
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
4803
|
-
*/
|
|
4804
|
-
updatedAt: string;
|
|
4805
|
-
/**
|
|
4806
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
4807
|
-
*/
|
|
4808
|
-
title: string;
|
|
4809
|
-
/**
|
|
4810
|
-
* Description of the integration. This is the description that will be displayed in the UI
|
|
4811
|
-
*/
|
|
4812
|
-
description: string;
|
|
4813
|
-
/**
|
|
4814
|
-
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
4815
|
-
*/
|
|
4816
|
-
iconUrl: string;
|
|
4817
|
-
/**
|
|
4818
|
-
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
4819
|
-
*/
|
|
4820
|
-
public: boolean;
|
|
4821
|
-
/**
|
|
4822
|
-
* Status of the integration version verification
|
|
4823
|
-
*/
|
|
4824
|
-
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
4825
|
-
};
|
|
4826
|
-
};
|
|
4757
|
+
readmeUrl: string;
|
|
4827
4758
|
/**
|
|
4828
|
-
*
|
|
4759
|
+
* Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
|
|
4829
4760
|
*/
|
|
4830
|
-
|
|
4831
|
-
|
|
4832
|
-
|
|
4833
|
-
|
|
4834
|
-
|
|
4835
|
-
|
|
4836
|
-
|
|
4837
|
-
|
|
4838
|
-
|
|
4839
|
-
|
|
4840
|
-
|
|
4841
|
-
|
|
4842
|
-
|
|
4843
|
-
|
|
4844
|
-
|
|
4845
|
-
|
|
4846
|
-
|
|
4761
|
+
public: boolean;
|
|
4762
|
+
};
|
|
4763
|
+
}
|
|
4764
|
+
|
|
4765
|
+
interface GetPublicInterfaceRequestHeaders$1 {
|
|
4766
|
+
}
|
|
4767
|
+
interface GetPublicInterfaceRequestQuery$1 {
|
|
4768
|
+
}
|
|
4769
|
+
interface GetPublicInterfaceRequestParams$1 {
|
|
4770
|
+
name: string;
|
|
4771
|
+
version: string;
|
|
4772
|
+
}
|
|
4773
|
+
interface GetPublicInterfaceRequestBody$1 {
|
|
4774
|
+
}
|
|
4775
|
+
type GetPublicInterfaceInput$1 = GetPublicInterfaceRequestBody$1 & GetPublicInterfaceRequestHeaders$1 & GetPublicInterfaceRequestQuery$1 & GetPublicInterfaceRequestParams$1;
|
|
4776
|
+
interface GetPublicInterfaceResponse$1 {
|
|
4777
|
+
interface: {
|
|
4847
4778
|
/**
|
|
4848
|
-
*
|
|
4779
|
+
* ID of the [Interface](#schema_interface)
|
|
4849
4780
|
*/
|
|
4850
|
-
|
|
4851
|
-
tags: {
|
|
4852
|
-
/**
|
|
4853
|
-
* Definition of a tag that can be provided on the object
|
|
4854
|
-
*/
|
|
4855
|
-
[k: string]: {
|
|
4856
|
-
/**
|
|
4857
|
-
* Title of the tag
|
|
4858
|
-
*/
|
|
4859
|
-
title?: string;
|
|
4860
|
-
/**
|
|
4861
|
-
* Description of the tag
|
|
4862
|
-
*/
|
|
4863
|
-
description?: string;
|
|
4864
|
-
};
|
|
4865
|
-
};
|
|
4866
|
-
};
|
|
4781
|
+
id: string;
|
|
4867
4782
|
/**
|
|
4868
|
-
*
|
|
4783
|
+
* Creation date of the [Interface](#schema_interface) in ISO 8601 format
|
|
4869
4784
|
*/
|
|
4870
|
-
|
|
4871
|
-
tags: {
|
|
4872
|
-
/**
|
|
4873
|
-
* Definition of a tag that can be provided on the object
|
|
4874
|
-
*/
|
|
4875
|
-
[k: string]: {
|
|
4876
|
-
/**
|
|
4877
|
-
* Title of the tag
|
|
4878
|
-
*/
|
|
4879
|
-
title?: string;
|
|
4880
|
-
/**
|
|
4881
|
-
* Description of the tag
|
|
4882
|
-
*/
|
|
4883
|
-
description?: string;
|
|
4884
|
-
};
|
|
4885
|
-
};
|
|
4886
|
-
};
|
|
4785
|
+
createdAt: string;
|
|
4887
4786
|
/**
|
|
4888
|
-
*
|
|
4787
|
+
* Updating date of the [Interface](#schema_interface) in ISO 8601 format
|
|
4889
4788
|
*/
|
|
4890
|
-
|
|
4789
|
+
updatedAt: string;
|
|
4790
|
+
/**
|
|
4791
|
+
* Name of the [Interface](#schema_interface)
|
|
4792
|
+
*/
|
|
4793
|
+
name: string;
|
|
4794
|
+
/**
|
|
4795
|
+
* Version of the [Interface](#schema_interface)
|
|
4796
|
+
*/
|
|
4797
|
+
version: string;
|
|
4798
|
+
entities: {
|
|
4799
|
+
/**
|
|
4800
|
+
* Entity definition
|
|
4801
|
+
*/
|
|
4891
4802
|
[k: string]: {
|
|
4892
4803
|
/**
|
|
4893
|
-
*
|
|
4804
|
+
* Title of the entity
|
|
4894
4805
|
*/
|
|
4895
|
-
|
|
4806
|
+
title?: string;
|
|
4896
4807
|
/**
|
|
4897
|
-
*
|
|
4808
|
+
* Description of the entity
|
|
4898
4809
|
*/
|
|
4810
|
+
description?: string;
|
|
4899
4811
|
schema: {
|
|
4900
4812
|
[k: string]: any;
|
|
4901
4813
|
};
|
|
4902
|
-
/**
|
|
4903
|
-
* 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.
|
|
4904
|
-
*/
|
|
4905
|
-
expiry?: number;
|
|
4906
|
-
};
|
|
4907
|
-
};
|
|
4908
|
-
/**
|
|
4909
|
-
* Configuration of the bot
|
|
4910
|
-
*/
|
|
4911
|
-
configuration: {
|
|
4912
|
-
/**
|
|
4913
|
-
* Configuration data
|
|
4914
|
-
*/
|
|
4915
|
-
data: {
|
|
4916
|
-
[k: string]: any;
|
|
4917
|
-
};
|
|
4918
|
-
/**
|
|
4919
|
-
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
4920
|
-
*/
|
|
4921
|
-
schema: {
|
|
4922
|
-
[k: string]: any;
|
|
4923
4814
|
};
|
|
4924
4815
|
};
|
|
4925
|
-
/**
|
|
4926
|
-
* Events definition
|
|
4927
|
-
*/
|
|
4928
4816
|
events: {
|
|
4929
4817
|
/**
|
|
4930
4818
|
* Event Definition
|
|
@@ -4949,53 +4837,17 @@ interface CreateBotResponse$1 {
|
|
|
4949
4837
|
};
|
|
4950
4838
|
};
|
|
4951
4839
|
};
|
|
4952
|
-
|
|
4953
|
-
|
|
4954
|
-
|
|
4955
|
-
|
|
4840
|
+
actions: {
|
|
4841
|
+
/**
|
|
4842
|
+
* Action definition
|
|
4843
|
+
*/
|
|
4956
4844
|
[k: string]: {
|
|
4957
|
-
schedule: {
|
|
4958
|
-
cron: string;
|
|
4959
|
-
};
|
|
4960
|
-
type: string;
|
|
4961
|
-
payload: {
|
|
4962
|
-
[k: string]: any;
|
|
4963
|
-
};
|
|
4964
4845
|
/**
|
|
4965
|
-
*
|
|
4846
|
+
* Title of the action
|
|
4966
4847
|
*/
|
|
4967
|
-
|
|
4848
|
+
title?: string;
|
|
4968
4849
|
/**
|
|
4969
|
-
*
|
|
4970
|
-
*/
|
|
4971
|
-
lastFailureReason: string | null;
|
|
4972
|
-
};
|
|
4973
|
-
};
|
|
4974
|
-
/**
|
|
4975
|
-
* Subscriptions of the bot
|
|
4976
|
-
*/
|
|
4977
|
-
subscriptions: {
|
|
4978
|
-
/**
|
|
4979
|
-
* Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
|
|
4980
|
-
*/
|
|
4981
|
-
events: {
|
|
4982
|
-
[k: string]: {};
|
|
4983
|
-
} | null;
|
|
4984
|
-
};
|
|
4985
|
-
/**
|
|
4986
|
-
* Actions definition
|
|
4987
|
-
*/
|
|
4988
|
-
actions: {
|
|
4989
|
-
/**
|
|
4990
|
-
* Action definition
|
|
4991
|
-
*/
|
|
4992
|
-
[k: string]: {
|
|
4993
|
-
/**
|
|
4994
|
-
* Title of the action
|
|
4995
|
-
*/
|
|
4996
|
-
title?: string;
|
|
4997
|
-
/**
|
|
4998
|
-
* Description of the action
|
|
4850
|
+
* Description of the action
|
|
4999
4851
|
*/
|
|
5000
4852
|
description?: string;
|
|
5001
4853
|
billable?: boolean;
|
|
@@ -5018,68 +4870,171 @@ interface CreateBotResponse$1 {
|
|
|
5018
4870
|
};
|
|
5019
4871
|
};
|
|
5020
4872
|
};
|
|
5021
|
-
|
|
5022
|
-
|
|
5023
|
-
|
|
5024
|
-
|
|
5025
|
-
|
|
4873
|
+
channels: {
|
|
4874
|
+
[k: string]: {
|
|
4875
|
+
/**
|
|
4876
|
+
* Title of the channel
|
|
4877
|
+
*/
|
|
4878
|
+
title?: string;
|
|
4879
|
+
/**
|
|
4880
|
+
* Description of the channel
|
|
4881
|
+
*/
|
|
4882
|
+
description?: string;
|
|
4883
|
+
messages: {
|
|
4884
|
+
/**
|
|
4885
|
+
* Message definition
|
|
4886
|
+
*/
|
|
4887
|
+
[k: string]: {
|
|
4888
|
+
schema: {
|
|
4889
|
+
[k: string]: any;
|
|
4890
|
+
};
|
|
4891
|
+
};
|
|
4892
|
+
};
|
|
4893
|
+
};
|
|
5026
4894
|
};
|
|
5027
4895
|
/**
|
|
5028
|
-
*
|
|
4896
|
+
* Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
|
|
5029
4897
|
*/
|
|
5030
|
-
|
|
4898
|
+
nameTemplate?: {
|
|
4899
|
+
script: string;
|
|
4900
|
+
language: string;
|
|
4901
|
+
};
|
|
5031
4902
|
/**
|
|
5032
|
-
*
|
|
4903
|
+
* Title of the interface. This is the name that will be displayed in the UI
|
|
5033
4904
|
*/
|
|
5034
|
-
|
|
4905
|
+
title: string;
|
|
5035
4906
|
/**
|
|
5036
|
-
*
|
|
4907
|
+
* Description of the interface. This is the description that will be displayed in the UI
|
|
5037
4908
|
*/
|
|
5038
|
-
|
|
4909
|
+
description: string;
|
|
5039
4910
|
/**
|
|
5040
|
-
*
|
|
4911
|
+
* URL of the icon of the interface. This is the icon that will be displayed in the UI
|
|
5041
4912
|
*/
|
|
5042
|
-
|
|
4913
|
+
iconUrl: string;
|
|
5043
4914
|
/**
|
|
5044
|
-
*
|
|
4915
|
+
* URL of the readme of the interface. This is the readme that will be displayed in the UI
|
|
5045
4916
|
*/
|
|
5046
|
-
|
|
4917
|
+
readmeUrl: string;
|
|
5047
4918
|
/**
|
|
5048
|
-
*
|
|
4919
|
+
* Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
|
|
5049
4920
|
*/
|
|
5050
|
-
|
|
4921
|
+
public: boolean;
|
|
4922
|
+
};
|
|
4923
|
+
}
|
|
4924
|
+
|
|
4925
|
+
interface CreateBotRequestHeaders$1 {
|
|
4926
|
+
}
|
|
4927
|
+
interface CreateBotRequestQuery$1 {
|
|
4928
|
+
}
|
|
4929
|
+
interface CreateBotRequestParams$1 {
|
|
4930
|
+
}
|
|
4931
|
+
interface CreateBotRequestBody$1 {
|
|
4932
|
+
/**
|
|
4933
|
+
* A mapping of states to their definition
|
|
4934
|
+
*/
|
|
4935
|
+
states?: {
|
|
4936
|
+
[k: string]: {
|
|
4937
|
+
/**
|
|
4938
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
4939
|
+
*/
|
|
4940
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
4941
|
+
/**
|
|
4942
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
4943
|
+
*/
|
|
4944
|
+
schema: {
|
|
4945
|
+
[k: string]: any;
|
|
4946
|
+
};
|
|
4947
|
+
/**
|
|
4948
|
+
* 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.
|
|
4949
|
+
*/
|
|
4950
|
+
expiry?: number;
|
|
4951
|
+
};
|
|
4952
|
+
};
|
|
4953
|
+
/**
|
|
4954
|
+
* Events definition
|
|
4955
|
+
*/
|
|
4956
|
+
events?: {
|
|
5051
4957
|
/**
|
|
5052
|
-
*
|
|
4958
|
+
* Event Definition
|
|
5053
4959
|
*/
|
|
5054
|
-
|
|
4960
|
+
[k: string]: {
|
|
5055
4961
|
/**
|
|
5056
|
-
*
|
|
4962
|
+
* Title of the event
|
|
5057
4963
|
*/
|
|
5058
|
-
|
|
4964
|
+
title?: string;
|
|
5059
4965
|
/**
|
|
5060
|
-
*
|
|
4966
|
+
* Description of the event
|
|
5061
4967
|
*/
|
|
5062
|
-
|
|
5063
|
-
|
|
4968
|
+
description?: string;
|
|
4969
|
+
schema: {
|
|
4970
|
+
[k: string]: any;
|
|
4971
|
+
};
|
|
4972
|
+
/**
|
|
4973
|
+
* Optional attributes
|
|
4974
|
+
*/
|
|
4975
|
+
attributes?: {
|
|
4976
|
+
[k: string]: string;
|
|
4977
|
+
};
|
|
4978
|
+
};
|
|
4979
|
+
};
|
|
4980
|
+
recurringEvents?: {
|
|
4981
|
+
[k: string]: {
|
|
4982
|
+
schedule: {
|
|
4983
|
+
cron: string;
|
|
4984
|
+
};
|
|
4985
|
+
type: string;
|
|
4986
|
+
payload: {
|
|
4987
|
+
[k: string]: any;
|
|
4988
|
+
};
|
|
4989
|
+
};
|
|
5064
4990
|
};
|
|
5065
|
-
}
|
|
5066
|
-
|
|
5067
|
-
interface UpdateBotRequestHeaders$1 {
|
|
5068
|
-
}
|
|
5069
|
-
interface UpdateBotRequestQuery$1 {
|
|
5070
|
-
}
|
|
5071
|
-
interface UpdateBotRequestParams$1 {
|
|
5072
|
-
id: string;
|
|
5073
|
-
}
|
|
5074
|
-
interface UpdateBotRequestBody$1 {
|
|
5075
4991
|
/**
|
|
5076
|
-
*
|
|
4992
|
+
* Subscriptions of the bot
|
|
5077
4993
|
*/
|
|
5078
|
-
|
|
4994
|
+
subscriptions?: {
|
|
4995
|
+
/**
|
|
4996
|
+
* Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
|
|
4997
|
+
*/
|
|
4998
|
+
events: {
|
|
4999
|
+
[k: string]: {};
|
|
5000
|
+
} | null;
|
|
5001
|
+
};
|
|
5079
5002
|
/**
|
|
5080
|
-
*
|
|
5003
|
+
* Actions definition
|
|
5081
5004
|
*/
|
|
5082
|
-
|
|
5005
|
+
actions?: {
|
|
5006
|
+
/**
|
|
5007
|
+
* Action definition
|
|
5008
|
+
*/
|
|
5009
|
+
[k: string]: {
|
|
5010
|
+
/**
|
|
5011
|
+
* Title of the action
|
|
5012
|
+
*/
|
|
5013
|
+
title?: string;
|
|
5014
|
+
/**
|
|
5015
|
+
* Description of the action
|
|
5016
|
+
*/
|
|
5017
|
+
description?: string;
|
|
5018
|
+
billable?: boolean;
|
|
5019
|
+
cacheable?: boolean;
|
|
5020
|
+
input: {
|
|
5021
|
+
schema: {
|
|
5022
|
+
[k: string]: any;
|
|
5023
|
+
};
|
|
5024
|
+
};
|
|
5025
|
+
output: {
|
|
5026
|
+
schema: {
|
|
5027
|
+
[k: string]: any;
|
|
5028
|
+
};
|
|
5029
|
+
};
|
|
5030
|
+
/**
|
|
5031
|
+
* Optional attributes
|
|
5032
|
+
*/
|
|
5033
|
+
attributes?: {
|
|
5034
|
+
[k: string]: string;
|
|
5035
|
+
};
|
|
5036
|
+
};
|
|
5037
|
+
};
|
|
5083
5038
|
configuration?: {
|
|
5084
5039
|
/**
|
|
5085
5040
|
* Configuration data
|
|
@@ -5094,17 +5049,6 @@ interface UpdateBotRequestBody$1 {
|
|
|
5094
5049
|
[k: string]: any;
|
|
5095
5050
|
};
|
|
5096
5051
|
};
|
|
5097
|
-
/**
|
|
5098
|
-
* Tags of the [Bot](#schema_bot)
|
|
5099
|
-
*/
|
|
5100
|
-
tags?: {
|
|
5101
|
-
[k: string]: string;
|
|
5102
|
-
};
|
|
5103
|
-
blocked?: boolean;
|
|
5104
|
-
/**
|
|
5105
|
-
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
5106
|
-
*/
|
|
5107
|
-
alwaysAlive?: boolean;
|
|
5108
5052
|
user?: {
|
|
5109
5053
|
tags?: {
|
|
5110
5054
|
/**
|
|
@@ -5119,10 +5063,10 @@ interface UpdateBotRequestBody$1 {
|
|
|
5119
5063
|
* Description of the tag
|
|
5120
5064
|
*/
|
|
5121
5065
|
description?: string;
|
|
5122
|
-
}
|
|
5066
|
+
};
|
|
5123
5067
|
};
|
|
5124
5068
|
};
|
|
5125
|
-
|
|
5069
|
+
conversation?: {
|
|
5126
5070
|
tags?: {
|
|
5127
5071
|
/**
|
|
5128
5072
|
* Definition of a tag that can be provided on the object
|
|
@@ -5136,10 +5080,10 @@ interface UpdateBotRequestBody$1 {
|
|
|
5136
5080
|
* Description of the tag
|
|
5137
5081
|
*/
|
|
5138
5082
|
description?: string;
|
|
5139
|
-
}
|
|
5083
|
+
};
|
|
5140
5084
|
};
|
|
5141
5085
|
};
|
|
5142
|
-
|
|
5086
|
+
message?: {
|
|
5143
5087
|
tags?: {
|
|
5144
5088
|
/**
|
|
5145
5089
|
* Definition of a tag that can be provided on the object
|
|
@@ -5153,105 +5097,14 @@ interface UpdateBotRequestBody$1 {
|
|
|
5153
5097
|
* Description of the tag
|
|
5154
5098
|
*/
|
|
5155
5099
|
description?: string;
|
|
5156
|
-
}
|
|
5100
|
+
};
|
|
5157
5101
|
};
|
|
5158
5102
|
};
|
|
5159
|
-
|
|
5160
|
-
|
|
5161
|
-
|
|
5162
|
-
|
|
5163
|
-
|
|
5164
|
-
title?: string;
|
|
5165
|
-
/**
|
|
5166
|
-
* Description of the event
|
|
5167
|
-
*/
|
|
5168
|
-
description?: string;
|
|
5169
|
-
schema: {
|
|
5170
|
-
[k: string]: any;
|
|
5171
|
-
};
|
|
5172
|
-
/**
|
|
5173
|
-
* Optional attributes. Set attributes to null to remove them
|
|
5174
|
-
*/
|
|
5175
|
-
attributes?: {
|
|
5176
|
-
[k: string]: string | null;
|
|
5177
|
-
};
|
|
5178
|
-
} | null;
|
|
5179
|
-
};
|
|
5180
|
-
actions?: {
|
|
5181
|
-
[k: string]: {
|
|
5182
|
-
/**
|
|
5183
|
-
* Title of the action
|
|
5184
|
-
*/
|
|
5185
|
-
title?: string;
|
|
5186
|
-
/**
|
|
5187
|
-
* Description of the action
|
|
5188
|
-
*/
|
|
5189
|
-
description?: string;
|
|
5190
|
-
billable?: boolean;
|
|
5191
|
-
cacheable?: boolean;
|
|
5192
|
-
input: {
|
|
5193
|
-
schema: {
|
|
5194
|
-
[k: string]: any;
|
|
5195
|
-
};
|
|
5196
|
-
};
|
|
5197
|
-
output: {
|
|
5198
|
-
schema: {
|
|
5199
|
-
[k: string]: any;
|
|
5200
|
-
};
|
|
5201
|
-
};
|
|
5202
|
-
/**
|
|
5203
|
-
* Optional attributes. Set attributes to null to remove them
|
|
5204
|
-
*/
|
|
5205
|
-
attributes?: {
|
|
5206
|
-
[k: string]: string | null;
|
|
5207
|
-
};
|
|
5208
|
-
} | null;
|
|
5209
|
-
};
|
|
5210
|
-
states?: {
|
|
5211
|
-
[k: string]: {
|
|
5212
|
-
/**
|
|
5213
|
-
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
5214
|
-
*/
|
|
5215
|
-
type: "conversation" | "user" | "bot" | "task";
|
|
5216
|
-
/**
|
|
5217
|
-
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
5218
|
-
*/
|
|
5219
|
-
schema: {
|
|
5220
|
-
[k: string]: any;
|
|
5221
|
-
};
|
|
5222
|
-
/**
|
|
5223
|
-
* 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.
|
|
5224
|
-
*/
|
|
5225
|
-
expiry?: number;
|
|
5226
|
-
} | null;
|
|
5227
|
-
};
|
|
5228
|
-
recurringEvents?: {
|
|
5229
|
-
[k: string]: {
|
|
5230
|
-
schedule: {
|
|
5231
|
-
cron: string;
|
|
5232
|
-
};
|
|
5233
|
-
type: string;
|
|
5234
|
-
payload: {
|
|
5235
|
-
[k: string]: any;
|
|
5236
|
-
};
|
|
5237
|
-
} | null;
|
|
5238
|
-
};
|
|
5239
|
-
integrations?: {
|
|
5240
|
-
[k: string]: {
|
|
5241
|
-
enabled?: boolean;
|
|
5242
|
-
/**
|
|
5243
|
-
* Integration's configuration type. Set to default if null.
|
|
5244
|
-
*/
|
|
5245
|
-
configurationType?: string | null;
|
|
5246
|
-
configuration?: {
|
|
5247
|
-
[k: string]: any;
|
|
5248
|
-
};
|
|
5249
|
-
} | null;
|
|
5250
|
-
};
|
|
5251
|
-
subscriptions?: {
|
|
5252
|
-
events: {
|
|
5253
|
-
[k: string]: {} | null;
|
|
5254
|
-
} | null;
|
|
5103
|
+
/**
|
|
5104
|
+
* Tags of the [Bot](#schema_bot)
|
|
5105
|
+
*/
|
|
5106
|
+
tags?: {
|
|
5107
|
+
[k: string]: string;
|
|
5255
5108
|
};
|
|
5256
5109
|
/**
|
|
5257
5110
|
* JavaScript code of the bot
|
|
@@ -5268,10 +5121,17 @@ interface UpdateBotRequestBody$1 {
|
|
|
5268
5121
|
url: string;
|
|
5269
5122
|
name: string;
|
|
5270
5123
|
}[];
|
|
5271
|
-
|
|
5124
|
+
/**
|
|
5125
|
+
* URL of the [Bot](#schema_bot); Only available for dev bots
|
|
5126
|
+
*/
|
|
5127
|
+
url?: string;
|
|
5128
|
+
/**
|
|
5129
|
+
* Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
|
|
5130
|
+
*/
|
|
5131
|
+
dev?: boolean;
|
|
5272
5132
|
}
|
|
5273
|
-
type
|
|
5274
|
-
interface
|
|
5133
|
+
type CreateBotInput$1 = CreateBotRequestBody$1 & CreateBotRequestHeaders$1 & CreateBotRequestQuery$1 & CreateBotRequestParams$1;
|
|
5134
|
+
interface CreateBotResponse$1 {
|
|
5275
5135
|
bot: {
|
|
5276
5136
|
/**
|
|
5277
5137
|
* Id of the [Bot](#schema_bot)
|
|
@@ -5586,138 +5446,271 @@ interface UpdateBotResponse$1 {
|
|
|
5586
5446
|
};
|
|
5587
5447
|
}
|
|
5588
5448
|
|
|
5589
|
-
interface
|
|
5449
|
+
interface UpdateBotRequestHeaders$1 {
|
|
5590
5450
|
}
|
|
5591
|
-
interface
|
|
5451
|
+
interface UpdateBotRequestQuery$1 {
|
|
5592
5452
|
}
|
|
5593
|
-
interface
|
|
5453
|
+
interface UpdateBotRequestParams$1 {
|
|
5594
5454
|
id: string;
|
|
5595
5455
|
}
|
|
5596
|
-
interface
|
|
5456
|
+
interface UpdateBotRequestBody$1 {
|
|
5597
5457
|
/**
|
|
5598
|
-
*
|
|
5458
|
+
* URL of the [Bot](#schema_bot); Only available for dev bots
|
|
5599
5459
|
*/
|
|
5600
|
-
|
|
5601
|
-
|
|
5602
|
-
|
|
5603
|
-
|
|
5604
|
-
|
|
5605
|
-
|
|
5606
|
-
interface ListBotsRequestHeaders$1 {
|
|
5607
|
-
}
|
|
5608
|
-
interface ListBotsRequestQuery$1 {
|
|
5609
|
-
dev?: boolean;
|
|
5610
|
-
tags?: {
|
|
5611
|
-
[k: string]: string;
|
|
5612
|
-
};
|
|
5613
|
-
nextToken?: string;
|
|
5614
|
-
sortField?: "createdAt" | "updatedAt";
|
|
5615
|
-
sortDirection?: "asc" | "desc";
|
|
5616
|
-
}
|
|
5617
|
-
interface ListBotsRequestParams$1 {
|
|
5618
|
-
}
|
|
5619
|
-
interface ListBotsRequestBody$1 {
|
|
5620
|
-
}
|
|
5621
|
-
type ListBotsInput$1 = ListBotsRequestBody$1 & ListBotsRequestHeaders$1 & ListBotsRequestQuery$1 & ListBotsRequestParams$1;
|
|
5622
|
-
interface ListBotsResponse$1 {
|
|
5623
|
-
bots: {
|
|
5624
|
-
/**
|
|
5625
|
-
* Id of the [Bot](#schema_bot)
|
|
5626
|
-
*/
|
|
5627
|
-
id: string;
|
|
5628
|
-
/**
|
|
5629
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5630
|
-
*/
|
|
5631
|
-
createdAt: string;
|
|
5632
|
-
/**
|
|
5633
|
-
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5634
|
-
*/
|
|
5635
|
-
updatedAt: string;
|
|
5636
|
-
name: string;
|
|
5637
|
-
deployedAt?: string;
|
|
5460
|
+
url?: string;
|
|
5461
|
+
/**
|
|
5462
|
+
* Type of the [Bot](#schema_bot) authentication (`iam`)
|
|
5463
|
+
*/
|
|
5464
|
+
authentication?: "iam";
|
|
5465
|
+
configuration?: {
|
|
5638
5466
|
/**
|
|
5639
|
-
*
|
|
5467
|
+
* Configuration data
|
|
5640
5468
|
*/
|
|
5641
|
-
|
|
5642
|
-
[k: string]:
|
|
5469
|
+
data?: {
|
|
5470
|
+
[k: string]: any;
|
|
5643
5471
|
};
|
|
5644
|
-
}[];
|
|
5645
|
-
meta: {
|
|
5646
5472
|
/**
|
|
5647
|
-
*
|
|
5473
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
5648
5474
|
*/
|
|
5649
|
-
|
|
5475
|
+
schema?: {
|
|
5476
|
+
[k: string]: any;
|
|
5477
|
+
};
|
|
5650
5478
|
};
|
|
5651
|
-
|
|
5652
|
-
|
|
5653
|
-
|
|
5654
|
-
|
|
5655
|
-
|
|
5656
|
-
}
|
|
5657
|
-
|
|
5658
|
-
|
|
5659
|
-
|
|
5660
|
-
|
|
5661
|
-
|
|
5662
|
-
|
|
5663
|
-
|
|
5664
|
-
|
|
5665
|
-
|
|
5666
|
-
|
|
5667
|
-
*/
|
|
5668
|
-
id: string;
|
|
5669
|
-
/**
|
|
5670
|
-
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5671
|
-
*/
|
|
5672
|
-
createdAt: string;
|
|
5673
|
-
/**
|
|
5674
|
-
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5675
|
-
*/
|
|
5676
|
-
updatedAt: string;
|
|
5677
|
-
/**
|
|
5678
|
-
* Signing secret of the [Bot](#schema_bot)
|
|
5679
|
-
*/
|
|
5680
|
-
signingSecret: string;
|
|
5681
|
-
/**
|
|
5682
|
-
* A mapping of integrations to their configuration
|
|
5683
|
-
*/
|
|
5684
|
-
integrations: {
|
|
5479
|
+
/**
|
|
5480
|
+
* Tags of the [Bot](#schema_bot)
|
|
5481
|
+
*/
|
|
5482
|
+
tags?: {
|
|
5483
|
+
[k: string]: string;
|
|
5484
|
+
};
|
|
5485
|
+
blocked?: boolean;
|
|
5486
|
+
/**
|
|
5487
|
+
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
5488
|
+
*/
|
|
5489
|
+
alwaysAlive?: boolean;
|
|
5490
|
+
user?: {
|
|
5491
|
+
tags?: {
|
|
5492
|
+
/**
|
|
5493
|
+
* Definition of a tag that can be provided on the object
|
|
5494
|
+
*/
|
|
5685
5495
|
[k: string]: {
|
|
5686
|
-
enabled: boolean;
|
|
5687
5496
|
/**
|
|
5688
|
-
*
|
|
5497
|
+
* Title of the tag
|
|
5689
5498
|
*/
|
|
5690
|
-
|
|
5499
|
+
title?: string;
|
|
5691
5500
|
/**
|
|
5692
|
-
*
|
|
5501
|
+
* Description of the tag
|
|
5693
5502
|
*/
|
|
5694
|
-
|
|
5695
|
-
|
|
5696
|
-
|
|
5697
|
-
|
|
5698
|
-
|
|
5699
|
-
|
|
5700
|
-
|
|
5701
|
-
|
|
5702
|
-
|
|
5703
|
-
|
|
5503
|
+
description?: string;
|
|
5504
|
+
} | null;
|
|
5505
|
+
};
|
|
5506
|
+
};
|
|
5507
|
+
message?: {
|
|
5508
|
+
tags?: {
|
|
5509
|
+
/**
|
|
5510
|
+
* Definition of a tag that can be provided on the object
|
|
5511
|
+
*/
|
|
5512
|
+
[k: string]: {
|
|
5704
5513
|
/**
|
|
5705
|
-
*
|
|
5514
|
+
* Title of the tag
|
|
5706
5515
|
*/
|
|
5707
|
-
|
|
5516
|
+
title?: string;
|
|
5708
5517
|
/**
|
|
5709
|
-
*
|
|
5518
|
+
* Description of the tag
|
|
5710
5519
|
*/
|
|
5711
|
-
|
|
5520
|
+
description?: string;
|
|
5521
|
+
} | null;
|
|
5522
|
+
};
|
|
5523
|
+
};
|
|
5524
|
+
conversation?: {
|
|
5525
|
+
tags?: {
|
|
5526
|
+
/**
|
|
5527
|
+
* Definition of a tag that can be provided on the object
|
|
5528
|
+
*/
|
|
5529
|
+
[k: string]: {
|
|
5712
5530
|
/**
|
|
5713
|
-
*
|
|
5531
|
+
* Title of the tag
|
|
5714
5532
|
*/
|
|
5715
|
-
|
|
5533
|
+
title?: string;
|
|
5716
5534
|
/**
|
|
5717
|
-
*
|
|
5535
|
+
* Description of the tag
|
|
5718
5536
|
*/
|
|
5719
|
-
|
|
5720
|
-
|
|
5537
|
+
description?: string;
|
|
5538
|
+
} | null;
|
|
5539
|
+
};
|
|
5540
|
+
};
|
|
5541
|
+
events?: {
|
|
5542
|
+
[k: string]: {
|
|
5543
|
+
/**
|
|
5544
|
+
* Title of the event
|
|
5545
|
+
*/
|
|
5546
|
+
title?: string;
|
|
5547
|
+
/**
|
|
5548
|
+
* Description of the event
|
|
5549
|
+
*/
|
|
5550
|
+
description?: string;
|
|
5551
|
+
schema: {
|
|
5552
|
+
[k: string]: any;
|
|
5553
|
+
};
|
|
5554
|
+
/**
|
|
5555
|
+
* Optional attributes. Set attributes to null to remove them
|
|
5556
|
+
*/
|
|
5557
|
+
attributes?: {
|
|
5558
|
+
[k: string]: string | null;
|
|
5559
|
+
};
|
|
5560
|
+
} | null;
|
|
5561
|
+
};
|
|
5562
|
+
actions?: {
|
|
5563
|
+
[k: string]: {
|
|
5564
|
+
/**
|
|
5565
|
+
* Title of the action
|
|
5566
|
+
*/
|
|
5567
|
+
title?: string;
|
|
5568
|
+
/**
|
|
5569
|
+
* Description of the action
|
|
5570
|
+
*/
|
|
5571
|
+
description?: string;
|
|
5572
|
+
billable?: boolean;
|
|
5573
|
+
cacheable?: boolean;
|
|
5574
|
+
input: {
|
|
5575
|
+
schema: {
|
|
5576
|
+
[k: string]: any;
|
|
5577
|
+
};
|
|
5578
|
+
};
|
|
5579
|
+
output: {
|
|
5580
|
+
schema: {
|
|
5581
|
+
[k: string]: any;
|
|
5582
|
+
};
|
|
5583
|
+
};
|
|
5584
|
+
/**
|
|
5585
|
+
* Optional attributes. Set attributes to null to remove them
|
|
5586
|
+
*/
|
|
5587
|
+
attributes?: {
|
|
5588
|
+
[k: string]: string | null;
|
|
5589
|
+
};
|
|
5590
|
+
} | null;
|
|
5591
|
+
};
|
|
5592
|
+
states?: {
|
|
5593
|
+
[k: string]: {
|
|
5594
|
+
/**
|
|
5595
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
5596
|
+
*/
|
|
5597
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
5598
|
+
/**
|
|
5599
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
5600
|
+
*/
|
|
5601
|
+
schema: {
|
|
5602
|
+
[k: string]: any;
|
|
5603
|
+
};
|
|
5604
|
+
/**
|
|
5605
|
+
* 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.
|
|
5606
|
+
*/
|
|
5607
|
+
expiry?: number;
|
|
5608
|
+
} | null;
|
|
5609
|
+
};
|
|
5610
|
+
recurringEvents?: {
|
|
5611
|
+
[k: string]: {
|
|
5612
|
+
schedule: {
|
|
5613
|
+
cron: string;
|
|
5614
|
+
};
|
|
5615
|
+
type: string;
|
|
5616
|
+
payload: {
|
|
5617
|
+
[k: string]: any;
|
|
5618
|
+
};
|
|
5619
|
+
} | null;
|
|
5620
|
+
};
|
|
5621
|
+
integrations?: {
|
|
5622
|
+
[k: string]: {
|
|
5623
|
+
enabled?: boolean;
|
|
5624
|
+
/**
|
|
5625
|
+
* Integration's configuration type. Set to default if null.
|
|
5626
|
+
*/
|
|
5627
|
+
configurationType?: string | null;
|
|
5628
|
+
configuration?: {
|
|
5629
|
+
[k: string]: any;
|
|
5630
|
+
};
|
|
5631
|
+
} | null;
|
|
5632
|
+
};
|
|
5633
|
+
subscriptions?: {
|
|
5634
|
+
events: {
|
|
5635
|
+
[k: string]: {} | null;
|
|
5636
|
+
} | null;
|
|
5637
|
+
};
|
|
5638
|
+
/**
|
|
5639
|
+
* JavaScript code of the bot
|
|
5640
|
+
*/
|
|
5641
|
+
code?: string;
|
|
5642
|
+
/**
|
|
5643
|
+
* Optional name for the bot, if not provided will be auto-generated
|
|
5644
|
+
*/
|
|
5645
|
+
name?: string;
|
|
5646
|
+
/**
|
|
5647
|
+
* Media files associated with the [Bot](#schema_bot)
|
|
5648
|
+
*/
|
|
5649
|
+
medias?: {
|
|
5650
|
+
url: string;
|
|
5651
|
+
name: string;
|
|
5652
|
+
}[];
|
|
5653
|
+
layers?: string[];
|
|
5654
|
+
}
|
|
5655
|
+
type UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
|
|
5656
|
+
interface UpdateBotResponse$1 {
|
|
5657
|
+
bot: {
|
|
5658
|
+
/**
|
|
5659
|
+
* Id of the [Bot](#schema_bot)
|
|
5660
|
+
*/
|
|
5661
|
+
id: string;
|
|
5662
|
+
/**
|
|
5663
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5664
|
+
*/
|
|
5665
|
+
createdAt: string;
|
|
5666
|
+
/**
|
|
5667
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
5668
|
+
*/
|
|
5669
|
+
updatedAt: string;
|
|
5670
|
+
/**
|
|
5671
|
+
* Signing secret of the [Bot](#schema_bot)
|
|
5672
|
+
*/
|
|
5673
|
+
signingSecret: string;
|
|
5674
|
+
/**
|
|
5675
|
+
* A mapping of integrations to their configuration
|
|
5676
|
+
*/
|
|
5677
|
+
integrations: {
|
|
5678
|
+
[k: string]: {
|
|
5679
|
+
enabled: boolean;
|
|
5680
|
+
/**
|
|
5681
|
+
* Name of the [Integration](#schema_integration)
|
|
5682
|
+
*/
|
|
5683
|
+
name: string;
|
|
5684
|
+
/**
|
|
5685
|
+
* Version of the [Integration](#schema_integration)
|
|
5686
|
+
*/
|
|
5687
|
+
version: string;
|
|
5688
|
+
webhookUrl: string;
|
|
5689
|
+
webhookId: string;
|
|
5690
|
+
identifier?: string;
|
|
5691
|
+
configurationType: string | null;
|
|
5692
|
+
configuration: {
|
|
5693
|
+
[k: string]: any;
|
|
5694
|
+
};
|
|
5695
|
+
status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
|
|
5696
|
+
statusReason: string | null;
|
|
5697
|
+
/**
|
|
5698
|
+
* ID of the [Integration](#schema_integration)
|
|
5699
|
+
*/
|
|
5700
|
+
id: string;
|
|
5701
|
+
/**
|
|
5702
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
5703
|
+
*/
|
|
5704
|
+
createdAt: string;
|
|
5705
|
+
/**
|
|
5706
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
5707
|
+
*/
|
|
5708
|
+
updatedAt: string;
|
|
5709
|
+
/**
|
|
5710
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
5711
|
+
*/
|
|
5712
|
+
title: string;
|
|
5713
|
+
/**
|
|
5721
5714
|
* Description of the integration. This is the description that will be displayed in the UI
|
|
5722
5715
|
*/
|
|
5723
5716
|
description: string;
|
|
@@ -5975,143 +5968,533 @@ interface GetBotResponse$1 {
|
|
|
5975
5968
|
};
|
|
5976
5969
|
}
|
|
5977
5970
|
|
|
5978
|
-
interface
|
|
5971
|
+
interface TransferBotRequestHeaders$1 {
|
|
5979
5972
|
}
|
|
5980
|
-
interface
|
|
5973
|
+
interface TransferBotRequestQuery$1 {
|
|
5981
5974
|
}
|
|
5982
|
-
interface
|
|
5975
|
+
interface TransferBotRequestParams$1 {
|
|
5983
5976
|
id: string;
|
|
5984
5977
|
}
|
|
5985
|
-
interface
|
|
5978
|
+
interface TransferBotRequestBody$1 {
|
|
5979
|
+
/**
|
|
5980
|
+
* The ID of the workspace you want to transfer the bot to.
|
|
5981
|
+
*/
|
|
5982
|
+
targetWorkspaceId: string;
|
|
5986
5983
|
}
|
|
5987
|
-
type
|
|
5988
|
-
interface
|
|
5984
|
+
type TransferBotInput$1 = TransferBotRequestBody$1 & TransferBotRequestHeaders$1 & TransferBotRequestQuery$1 & TransferBotRequestParams$1;
|
|
5985
|
+
interface TransferBotResponse$1 {
|
|
5989
5986
|
}
|
|
5990
5987
|
|
|
5991
|
-
interface
|
|
5988
|
+
interface ListBotsRequestHeaders$1 {
|
|
5992
5989
|
}
|
|
5993
|
-
interface
|
|
5994
|
-
|
|
5995
|
-
|
|
5996
|
-
|
|
5997
|
-
|
|
5998
|
-
workflowId?: string;
|
|
5999
|
-
conversationId?: string;
|
|
5990
|
+
interface ListBotsRequestQuery$1 {
|
|
5991
|
+
dev?: boolean;
|
|
5992
|
+
tags?: {
|
|
5993
|
+
[k: string]: string;
|
|
5994
|
+
};
|
|
6000
5995
|
nextToken?: string;
|
|
5996
|
+
sortField?: "createdAt" | "updatedAt";
|
|
5997
|
+
sortDirection?: "asc" | "desc";
|
|
6001
5998
|
}
|
|
6002
|
-
interface
|
|
6003
|
-
id: string;
|
|
5999
|
+
interface ListBotsRequestParams$1 {
|
|
6004
6000
|
}
|
|
6005
|
-
interface
|
|
6001
|
+
interface ListBotsRequestBody$1 {
|
|
6006
6002
|
}
|
|
6007
|
-
type
|
|
6008
|
-
interface
|
|
6009
|
-
|
|
6010
|
-
|
|
6011
|
-
|
|
6012
|
-
|
|
6013
|
-
|
|
6014
|
-
|
|
6015
|
-
|
|
6003
|
+
type ListBotsInput$1 = ListBotsRequestBody$1 & ListBotsRequestHeaders$1 & ListBotsRequestQuery$1 & ListBotsRequestParams$1;
|
|
6004
|
+
interface ListBotsResponse$1 {
|
|
6005
|
+
bots: {
|
|
6006
|
+
/**
|
|
6007
|
+
* Id of the [Bot](#schema_bot)
|
|
6008
|
+
*/
|
|
6009
|
+
id: string;
|
|
6010
|
+
/**
|
|
6011
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
6012
|
+
*/
|
|
6013
|
+
createdAt: string;
|
|
6014
|
+
/**
|
|
6015
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
6016
|
+
*/
|
|
6017
|
+
updatedAt: string;
|
|
6018
|
+
name: string;
|
|
6019
|
+
deployedAt?: string;
|
|
6020
|
+
/**
|
|
6021
|
+
* Tags of [Bot](#schema_bot)
|
|
6022
|
+
*/
|
|
6023
|
+
tags: {
|
|
6024
|
+
[k: string]: string;
|
|
6025
|
+
};
|
|
6016
6026
|
}[];
|
|
6017
|
-
|
|
6027
|
+
meta: {
|
|
6028
|
+
/**
|
|
6029
|
+
* 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.
|
|
6030
|
+
*/
|
|
6031
|
+
nextToken?: string;
|
|
6032
|
+
};
|
|
6018
6033
|
}
|
|
6019
6034
|
|
|
6020
|
-
interface
|
|
6035
|
+
interface GetBotRequestHeaders$1 {
|
|
6021
6036
|
}
|
|
6022
|
-
interface
|
|
6023
|
-
type: "preconfigured" | "configurable" | "fullscreen" | "sharableUrl";
|
|
6024
|
-
}
|
|
6025
|
-
interface GetBotWebchatRequestParams$1 {
|
|
6026
|
-
id: string;
|
|
6027
|
-
}
|
|
6028
|
-
interface GetBotWebchatRequestBody$1 {
|
|
6029
|
-
}
|
|
6030
|
-
type GetBotWebchatInput$1 = GetBotWebchatRequestBody$1 & GetBotWebchatRequestHeaders$1 & GetBotWebchatRequestQuery$1 & GetBotWebchatRequestParams$1;
|
|
6031
|
-
interface GetBotWebchatResponse$1 {
|
|
6032
|
-
code: string;
|
|
6033
|
-
}
|
|
6034
|
-
|
|
6035
|
-
interface GetBotAnalyticsRequestHeaders$1 {
|
|
6036
|
-
}
|
|
6037
|
-
interface GetBotAnalyticsRequestQuery$1 {
|
|
6038
|
-
startDate: string;
|
|
6039
|
-
endDate: string;
|
|
6037
|
+
interface GetBotRequestQuery$1 {
|
|
6040
6038
|
}
|
|
6041
|
-
interface
|
|
6039
|
+
interface GetBotRequestParams$1 {
|
|
6042
6040
|
id: string;
|
|
6043
6041
|
}
|
|
6044
|
-
interface
|
|
6042
|
+
interface GetBotRequestBody$1 {
|
|
6045
6043
|
}
|
|
6046
|
-
type
|
|
6047
|
-
interface
|
|
6048
|
-
|
|
6044
|
+
type GetBotInput$1 = GetBotRequestBody$1 & GetBotRequestHeaders$1 & GetBotRequestQuery$1 & GetBotRequestParams$1;
|
|
6045
|
+
interface GetBotResponse$1 {
|
|
6046
|
+
bot: {
|
|
6049
6047
|
/**
|
|
6050
|
-
*
|
|
6048
|
+
* Id of the [Bot](#schema_bot)
|
|
6051
6049
|
*/
|
|
6052
|
-
|
|
6050
|
+
id: string;
|
|
6053
6051
|
/**
|
|
6054
|
-
*
|
|
6052
|
+
* Creation date of the [Bot](#schema_bot) in ISO 8601 format
|
|
6055
6053
|
*/
|
|
6056
|
-
|
|
6057
|
-
returningUsers: number;
|
|
6058
|
-
newUsers: number;
|
|
6059
|
-
sessions: number;
|
|
6054
|
+
createdAt: string;
|
|
6060
6055
|
/**
|
|
6061
|
-
*
|
|
6056
|
+
* Updating date of the [Bot](#schema_bot) in ISO 8601 format
|
|
6062
6057
|
*/
|
|
6063
|
-
|
|
6064
|
-
|
|
6065
|
-
|
|
6066
|
-
|
|
6067
|
-
|
|
6068
|
-
|
|
6058
|
+
updatedAt: string;
|
|
6059
|
+
/**
|
|
6060
|
+
* Signing secret of the [Bot](#schema_bot)
|
|
6061
|
+
*/
|
|
6062
|
+
signingSecret: string;
|
|
6063
|
+
/**
|
|
6064
|
+
* A mapping of integrations to their configuration
|
|
6065
|
+
*/
|
|
6066
|
+
integrations: {
|
|
6067
|
+
[k: string]: {
|
|
6068
|
+
enabled: boolean;
|
|
6069
|
+
/**
|
|
6070
|
+
* Name of the [Integration](#schema_integration)
|
|
6071
|
+
*/
|
|
6072
|
+
name: string;
|
|
6073
|
+
/**
|
|
6074
|
+
* Version of the [Integration](#schema_integration)
|
|
6075
|
+
*/
|
|
6076
|
+
version: string;
|
|
6077
|
+
webhookUrl: string;
|
|
6078
|
+
webhookId: string;
|
|
6079
|
+
identifier?: string;
|
|
6080
|
+
configurationType: string | null;
|
|
6081
|
+
configuration: {
|
|
6082
|
+
[k: string]: any;
|
|
6083
|
+
};
|
|
6084
|
+
status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
|
|
6085
|
+
statusReason: string | null;
|
|
6086
|
+
/**
|
|
6087
|
+
* ID of the [Integration](#schema_integration)
|
|
6088
|
+
*/
|
|
6089
|
+
id: string;
|
|
6090
|
+
/**
|
|
6091
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
6092
|
+
*/
|
|
6093
|
+
createdAt: string;
|
|
6094
|
+
/**
|
|
6095
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
6096
|
+
*/
|
|
6097
|
+
updatedAt: string;
|
|
6098
|
+
/**
|
|
6099
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
6100
|
+
*/
|
|
6101
|
+
title: string;
|
|
6102
|
+
/**
|
|
6103
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
6104
|
+
*/
|
|
6105
|
+
description: string;
|
|
6106
|
+
/**
|
|
6107
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
6108
|
+
*/
|
|
6109
|
+
iconUrl: string;
|
|
6110
|
+
/**
|
|
6111
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
6112
|
+
*/
|
|
6113
|
+
public: boolean;
|
|
6114
|
+
/**
|
|
6115
|
+
* Status of the integration version verification
|
|
6116
|
+
*/
|
|
6117
|
+
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
6118
|
+
};
|
|
6069
6119
|
};
|
|
6070
|
-
|
|
6071
|
-
|
|
6120
|
+
/**
|
|
6121
|
+
* User object configuration
|
|
6122
|
+
*/
|
|
6123
|
+
user: {
|
|
6124
|
+
tags: {
|
|
6125
|
+
/**
|
|
6126
|
+
* Definition of a tag that can be provided on the object
|
|
6127
|
+
*/
|
|
6128
|
+
[k: string]: {
|
|
6129
|
+
/**
|
|
6130
|
+
* Title of the tag
|
|
6131
|
+
*/
|
|
6132
|
+
title?: string;
|
|
6133
|
+
/**
|
|
6134
|
+
* Description of the tag
|
|
6135
|
+
*/
|
|
6136
|
+
description?: string;
|
|
6137
|
+
};
|
|
6138
|
+
};
|
|
6072
6139
|
};
|
|
6073
|
-
|
|
6074
|
-
|
|
6075
|
-
|
|
6076
|
-
|
|
6077
|
-
|
|
6140
|
+
/**
|
|
6141
|
+
* Conversation object configuration
|
|
6142
|
+
*/
|
|
6143
|
+
conversation: {
|
|
6144
|
+
tags: {
|
|
6145
|
+
/**
|
|
6146
|
+
* Definition of a tag that can be provided on the object
|
|
6147
|
+
*/
|
|
6148
|
+
[k: string]: {
|
|
6149
|
+
/**
|
|
6150
|
+
* Title of the tag
|
|
6151
|
+
*/
|
|
6152
|
+
title?: string;
|
|
6153
|
+
/**
|
|
6154
|
+
* Description of the tag
|
|
6155
|
+
*/
|
|
6156
|
+
description?: string;
|
|
6157
|
+
};
|
|
6158
|
+
};
|
|
6159
|
+
};
|
|
6160
|
+
/**
|
|
6161
|
+
* Message object configuration
|
|
6162
|
+
*/
|
|
6163
|
+
message: {
|
|
6164
|
+
tags: {
|
|
6165
|
+
/**
|
|
6166
|
+
* Definition of a tag that can be provided on the object
|
|
6167
|
+
*/
|
|
6168
|
+
[k: string]: {
|
|
6169
|
+
/**
|
|
6170
|
+
* Title of the tag
|
|
6171
|
+
*/
|
|
6172
|
+
title?: string;
|
|
6173
|
+
/**
|
|
6174
|
+
* Description of the tag
|
|
6175
|
+
*/
|
|
6176
|
+
description?: string;
|
|
6177
|
+
};
|
|
6178
|
+
};
|
|
6179
|
+
};
|
|
6180
|
+
/**
|
|
6181
|
+
* A mapping of states to their definition
|
|
6182
|
+
*/
|
|
6183
|
+
states: {
|
|
6184
|
+
[k: string]: {
|
|
6185
|
+
/**
|
|
6186
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
6187
|
+
*/
|
|
6188
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
6189
|
+
/**
|
|
6190
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6191
|
+
*/
|
|
6192
|
+
schema: {
|
|
6193
|
+
[k: string]: any;
|
|
6194
|
+
};
|
|
6195
|
+
/**
|
|
6196
|
+
* 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.
|
|
6197
|
+
*/
|
|
6198
|
+
expiry?: number;
|
|
6199
|
+
};
|
|
6200
|
+
};
|
|
6201
|
+
/**
|
|
6202
|
+
* Configuration of the bot
|
|
6203
|
+
*/
|
|
6204
|
+
configuration: {
|
|
6078
6205
|
/**
|
|
6079
|
-
*
|
|
6206
|
+
* Configuration data
|
|
6080
6207
|
*/
|
|
6081
|
-
|
|
6082
|
-
|
|
6083
|
-
sd: number;
|
|
6084
|
-
min: number;
|
|
6085
|
-
max: number;
|
|
6208
|
+
data: {
|
|
6209
|
+
[k: string]: any;
|
|
6086
6210
|
};
|
|
6087
6211
|
/**
|
|
6088
|
-
*
|
|
6212
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
6089
6213
|
*/
|
|
6090
|
-
|
|
6091
|
-
|
|
6092
|
-
sd: number;
|
|
6093
|
-
min: number;
|
|
6094
|
-
max: number;
|
|
6214
|
+
schema: {
|
|
6215
|
+
[k: string]: any;
|
|
6095
6216
|
};
|
|
6217
|
+
};
|
|
6218
|
+
/**
|
|
6219
|
+
* Events definition
|
|
6220
|
+
*/
|
|
6221
|
+
events: {
|
|
6096
6222
|
/**
|
|
6097
|
-
*
|
|
6223
|
+
* Event Definition
|
|
6098
6224
|
*/
|
|
6099
|
-
|
|
6100
|
-
|
|
6101
|
-
|
|
6102
|
-
|
|
6103
|
-
|
|
6104
|
-
|
|
6225
|
+
[k: string]: {
|
|
6226
|
+
/**
|
|
6227
|
+
* Title of the event
|
|
6228
|
+
*/
|
|
6229
|
+
title?: string;
|
|
6230
|
+
/**
|
|
6231
|
+
* Description of the event
|
|
6232
|
+
*/
|
|
6233
|
+
description?: string;
|
|
6234
|
+
schema: {
|
|
6235
|
+
[k: string]: any;
|
|
6236
|
+
};
|
|
6237
|
+
/**
|
|
6238
|
+
* Optional attributes
|
|
6239
|
+
*/
|
|
6240
|
+
attributes?: {
|
|
6241
|
+
[k: string]: string;
|
|
6242
|
+
};
|
|
6105
6243
|
};
|
|
6106
6244
|
};
|
|
6107
|
-
|
|
6108
|
-
|
|
6109
|
-
|
|
6110
|
-
|
|
6111
|
-
|
|
6112
|
-
|
|
6113
|
-
|
|
6114
|
-
|
|
6245
|
+
/**
|
|
6246
|
+
* Recurring events
|
|
6247
|
+
*/
|
|
6248
|
+
recurringEvents: {
|
|
6249
|
+
[k: string]: {
|
|
6250
|
+
schedule: {
|
|
6251
|
+
cron: string;
|
|
6252
|
+
};
|
|
6253
|
+
type: string;
|
|
6254
|
+
payload: {
|
|
6255
|
+
[k: string]: any;
|
|
6256
|
+
};
|
|
6257
|
+
/**
|
|
6258
|
+
* The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
|
|
6259
|
+
*/
|
|
6260
|
+
failedAttempts: number;
|
|
6261
|
+
/**
|
|
6262
|
+
* The reason why the recurring event failed to run in the last attempt.
|
|
6263
|
+
*/
|
|
6264
|
+
lastFailureReason: string | null;
|
|
6265
|
+
};
|
|
6266
|
+
};
|
|
6267
|
+
/**
|
|
6268
|
+
* Subscriptions of the bot
|
|
6269
|
+
*/
|
|
6270
|
+
subscriptions: {
|
|
6271
|
+
/**
|
|
6272
|
+
* Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
|
|
6273
|
+
*/
|
|
6274
|
+
events: {
|
|
6275
|
+
[k: string]: {};
|
|
6276
|
+
} | null;
|
|
6277
|
+
};
|
|
6278
|
+
/**
|
|
6279
|
+
* Actions definition
|
|
6280
|
+
*/
|
|
6281
|
+
actions: {
|
|
6282
|
+
/**
|
|
6283
|
+
* Action definition
|
|
6284
|
+
*/
|
|
6285
|
+
[k: string]: {
|
|
6286
|
+
/**
|
|
6287
|
+
* Title of the action
|
|
6288
|
+
*/
|
|
6289
|
+
title?: string;
|
|
6290
|
+
/**
|
|
6291
|
+
* Description of the action
|
|
6292
|
+
*/
|
|
6293
|
+
description?: string;
|
|
6294
|
+
billable?: boolean;
|
|
6295
|
+
cacheable?: boolean;
|
|
6296
|
+
input: {
|
|
6297
|
+
schema: {
|
|
6298
|
+
[k: string]: any;
|
|
6299
|
+
};
|
|
6300
|
+
};
|
|
6301
|
+
output: {
|
|
6302
|
+
schema: {
|
|
6303
|
+
[k: string]: any;
|
|
6304
|
+
};
|
|
6305
|
+
};
|
|
6306
|
+
/**
|
|
6307
|
+
* Optional attributes
|
|
6308
|
+
*/
|
|
6309
|
+
attributes?: {
|
|
6310
|
+
[k: string]: string;
|
|
6311
|
+
};
|
|
6312
|
+
};
|
|
6313
|
+
};
|
|
6314
|
+
/**
|
|
6315
|
+
* Tags of [Bot](#schema_bot)
|
|
6316
|
+
*/
|
|
6317
|
+
tags: {
|
|
6318
|
+
[k: string]: string;
|
|
6319
|
+
};
|
|
6320
|
+
/**
|
|
6321
|
+
* Name of the [Bot](#schema_bot)
|
|
6322
|
+
*/
|
|
6323
|
+
name: string;
|
|
6324
|
+
/**
|
|
6325
|
+
* Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
|
|
6326
|
+
*/
|
|
6327
|
+
deployedAt?: string;
|
|
6328
|
+
/**
|
|
6329
|
+
* Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
|
|
6330
|
+
*/
|
|
6331
|
+
dev: boolean;
|
|
6332
|
+
/**
|
|
6333
|
+
* Id of the user that created the bot
|
|
6334
|
+
*/
|
|
6335
|
+
createdBy?: string;
|
|
6336
|
+
/**
|
|
6337
|
+
* Indicates if the [Bot](#schema_bot) should be in always alive mode
|
|
6338
|
+
*/
|
|
6339
|
+
alwaysAlive: boolean;
|
|
6340
|
+
/**
|
|
6341
|
+
* Status of the bot
|
|
6342
|
+
*/
|
|
6343
|
+
status: "active" | "deploying";
|
|
6344
|
+
/**
|
|
6345
|
+
* Media files associated with the [Bot](#schema_bot)
|
|
6346
|
+
*/
|
|
6347
|
+
medias: {
|
|
6348
|
+
/**
|
|
6349
|
+
* URL of the media file
|
|
6350
|
+
*/
|
|
6351
|
+
url: string;
|
|
6352
|
+
/**
|
|
6353
|
+
* Name of the media file
|
|
6354
|
+
*/
|
|
6355
|
+
name: string;
|
|
6356
|
+
}[];
|
|
6357
|
+
};
|
|
6358
|
+
}
|
|
6359
|
+
|
|
6360
|
+
interface DeleteBotRequestHeaders$1 {
|
|
6361
|
+
}
|
|
6362
|
+
interface DeleteBotRequestQuery$1 {
|
|
6363
|
+
}
|
|
6364
|
+
interface DeleteBotRequestParams$1 {
|
|
6365
|
+
id: string;
|
|
6366
|
+
}
|
|
6367
|
+
interface DeleteBotRequestBody$1 {
|
|
6368
|
+
}
|
|
6369
|
+
type DeleteBotInput$1 = DeleteBotRequestBody$1 & DeleteBotRequestHeaders$1 & DeleteBotRequestQuery$1 & DeleteBotRequestParams$1;
|
|
6370
|
+
interface DeleteBotResponse$1 {
|
|
6371
|
+
}
|
|
6372
|
+
|
|
6373
|
+
interface GetBotLogsRequestHeaders$1 {
|
|
6374
|
+
}
|
|
6375
|
+
interface GetBotLogsRequestQuery$1 {
|
|
6376
|
+
timeStart: string;
|
|
6377
|
+
timeEnd?: string;
|
|
6378
|
+
level?: string;
|
|
6379
|
+
userId?: string;
|
|
6380
|
+
workflowId?: string;
|
|
6381
|
+
conversationId?: string;
|
|
6382
|
+
messageContains?: string;
|
|
6383
|
+
nextToken?: string;
|
|
6384
|
+
}
|
|
6385
|
+
interface GetBotLogsRequestParams$1 {
|
|
6386
|
+
id: string;
|
|
6387
|
+
}
|
|
6388
|
+
interface GetBotLogsRequestBody$1 {
|
|
6389
|
+
}
|
|
6390
|
+
type GetBotLogsInput$1 = GetBotLogsRequestBody$1 & GetBotLogsRequestHeaders$1 & GetBotLogsRequestQuery$1 & GetBotLogsRequestParams$1;
|
|
6391
|
+
interface GetBotLogsResponse$1 {
|
|
6392
|
+
logs: {
|
|
6393
|
+
timestamp: string;
|
|
6394
|
+
level: string;
|
|
6395
|
+
message: string;
|
|
6396
|
+
workflowId?: string;
|
|
6397
|
+
userId?: string;
|
|
6398
|
+
conversationId?: string;
|
|
6399
|
+
}[];
|
|
6400
|
+
nextToken?: string;
|
|
6401
|
+
}
|
|
6402
|
+
|
|
6403
|
+
interface GetBotWebchatRequestHeaders$1 {
|
|
6404
|
+
}
|
|
6405
|
+
interface GetBotWebchatRequestQuery$1 {
|
|
6406
|
+
type: "preconfigured" | "configurable" | "fullscreen" | "sharableUrl";
|
|
6407
|
+
}
|
|
6408
|
+
interface GetBotWebchatRequestParams$1 {
|
|
6409
|
+
id: string;
|
|
6410
|
+
}
|
|
6411
|
+
interface GetBotWebchatRequestBody$1 {
|
|
6412
|
+
}
|
|
6413
|
+
type GetBotWebchatInput$1 = GetBotWebchatRequestBody$1 & GetBotWebchatRequestHeaders$1 & GetBotWebchatRequestQuery$1 & GetBotWebchatRequestParams$1;
|
|
6414
|
+
interface GetBotWebchatResponse$1 {
|
|
6415
|
+
code: string;
|
|
6416
|
+
}
|
|
6417
|
+
|
|
6418
|
+
interface GetBotAnalyticsRequestHeaders$1 {
|
|
6419
|
+
}
|
|
6420
|
+
interface GetBotAnalyticsRequestQuery$1 {
|
|
6421
|
+
startDate: string;
|
|
6422
|
+
endDate: string;
|
|
6423
|
+
}
|
|
6424
|
+
interface GetBotAnalyticsRequestParams$1 {
|
|
6425
|
+
id: string;
|
|
6426
|
+
}
|
|
6427
|
+
interface GetBotAnalyticsRequestBody$1 {
|
|
6428
|
+
}
|
|
6429
|
+
type GetBotAnalyticsInput$1 = GetBotAnalyticsRequestBody$1 & GetBotAnalyticsRequestHeaders$1 & GetBotAnalyticsRequestQuery$1 & GetBotAnalyticsRequestParams$1;
|
|
6430
|
+
interface GetBotAnalyticsResponse$1 {
|
|
6431
|
+
records: {
|
|
6432
|
+
/**
|
|
6433
|
+
* ISO 8601 date string of the beginning (inclusive) of the period
|
|
6434
|
+
*/
|
|
6435
|
+
startDateTimeUtc: string;
|
|
6436
|
+
/**
|
|
6437
|
+
* ISO 8601 date string of the end (exclusive) of the period
|
|
6438
|
+
*/
|
|
6439
|
+
endDateTimeUtc: string;
|
|
6440
|
+
returningUsers: number;
|
|
6441
|
+
newUsers: number;
|
|
6442
|
+
sessions: number;
|
|
6443
|
+
/**
|
|
6444
|
+
* Deprecated. Use `userMessages` instead.
|
|
6445
|
+
*/
|
|
6446
|
+
messages: number;
|
|
6447
|
+
userMessages: number;
|
|
6448
|
+
botMessages: number;
|
|
6449
|
+
events: number;
|
|
6450
|
+
eventTypes: {
|
|
6451
|
+
[k: string]: number;
|
|
6452
|
+
};
|
|
6453
|
+
customEvents: {
|
|
6454
|
+
[k: string]: number;
|
|
6455
|
+
};
|
|
6456
|
+
llm: {
|
|
6457
|
+
calls: number;
|
|
6458
|
+
errors: number;
|
|
6459
|
+
inputTokens: number;
|
|
6460
|
+
outputTokens: number;
|
|
6461
|
+
/**
|
|
6462
|
+
* The time it took for the LLM to complete its response. Values are expressed in milliseconds
|
|
6463
|
+
*/
|
|
6464
|
+
latency: {
|
|
6465
|
+
mean: number;
|
|
6466
|
+
sd: number;
|
|
6467
|
+
min: number;
|
|
6468
|
+
max: number;
|
|
6469
|
+
};
|
|
6470
|
+
/**
|
|
6471
|
+
* LLM response generation speed expressed in output tokens per second.
|
|
6472
|
+
*/
|
|
6473
|
+
tokensPerSecond: {
|
|
6474
|
+
mean: number;
|
|
6475
|
+
sd: number;
|
|
6476
|
+
min: number;
|
|
6477
|
+
max: number;
|
|
6478
|
+
};
|
|
6479
|
+
/**
|
|
6480
|
+
* Values are expressed in U.S. dollars
|
|
6481
|
+
*/
|
|
6482
|
+
cost: {
|
|
6483
|
+
sum: number;
|
|
6484
|
+
mean: number;
|
|
6485
|
+
sd: number;
|
|
6486
|
+
min: number;
|
|
6487
|
+
max: number;
|
|
6488
|
+
};
|
|
6489
|
+
};
|
|
6490
|
+
}[];
|
|
6491
|
+
}
|
|
6492
|
+
|
|
6493
|
+
interface GetBotIssueRequestHeaders$1 {
|
|
6494
|
+
}
|
|
6495
|
+
interface GetBotIssueRequestQuery$1 {
|
|
6496
|
+
}
|
|
6497
|
+
interface GetBotIssueRequestParams$1 {
|
|
6115
6498
|
id: string;
|
|
6116
6499
|
issueId: string;
|
|
6117
6500
|
}
|
|
@@ -9594,6 +9977,7 @@ interface GetIntegrationLogsRequestQuery$1 {
|
|
|
9594
9977
|
level?: string;
|
|
9595
9978
|
userId?: string;
|
|
9596
9979
|
conversationId?: string;
|
|
9980
|
+
messageContains?: string;
|
|
9597
9981
|
nextToken?: string;
|
|
9598
9982
|
}
|
|
9599
9983
|
interface GetIntegrationLogsRequestParams$1 {
|
|
@@ -10932,6 +11316,7 @@ interface ListInterfacesRequestHeaders$1 {
|
|
|
10932
11316
|
interface ListInterfacesRequestQuery$1 {
|
|
10933
11317
|
nextToken?: string;
|
|
10934
11318
|
name?: string;
|
|
11319
|
+
version?: string;
|
|
10935
11320
|
}
|
|
10936
11321
|
interface ListInterfacesRequestParams$1 {
|
|
10937
11322
|
}
|
|
@@ -12402,8 +12787,15 @@ interface ListUsageActivityDailyRequestBody$1 {
|
|
|
12402
12787
|
type ListUsageActivityDailyInput$1 = ListUsageActivityDailyRequestBody$1 & ListUsageActivityDailyRequestHeaders$1 & ListUsageActivityDailyRequestQuery$1 & ListUsageActivityDailyRequestParams$1;
|
|
12403
12788
|
interface ListUsageActivityDailyResponse$1 {
|
|
12404
12789
|
data: {
|
|
12790
|
+
key: string;
|
|
12405
12791
|
date: string;
|
|
12406
12792
|
value: number;
|
|
12793
|
+
metadata?: {
|
|
12794
|
+
botId: string;
|
|
12795
|
+
type: "IntegrationAction" | "FileIndexing";
|
|
12796
|
+
subtype: string;
|
|
12797
|
+
source?: string;
|
|
12798
|
+
};
|
|
12407
12799
|
}[];
|
|
12408
12800
|
meta: {
|
|
12409
12801
|
nextToken?: string;
|
|
@@ -12496,6 +12888,9 @@ declare class Client$7 {
|
|
|
12496
12888
|
readonly getPublicPluginById: (input: GetPublicPluginByIdInput$1) => Promise<GetPublicPluginByIdResponse$1>;
|
|
12497
12889
|
readonly getPublicPlugin: (input: GetPublicPluginInput$1) => Promise<GetPublicPluginResponse$1>;
|
|
12498
12890
|
readonly getPublicPluginCode: (input: GetPublicPluginCodeInput$1) => Promise<GetPublicPluginCodeResponse$1>;
|
|
12891
|
+
readonly listPublicInterfaces: (input: ListPublicInterfacesInput$1) => Promise<ListPublicInterfacesResponse$1>;
|
|
12892
|
+
readonly getPublicInterfaceById: (input: GetPublicInterfaceByIdInput$1) => Promise<GetPublicInterfaceByIdResponse$1>;
|
|
12893
|
+
readonly getPublicInterface: (input: GetPublicInterfaceInput$1) => Promise<GetPublicInterfaceResponse$1>;
|
|
12499
12894
|
readonly createBot: (input: CreateBotInput$1) => Promise<CreateBotResponse$1>;
|
|
12500
12895
|
readonly updateBot: (input: UpdateBotInput$1) => Promise<UpdateBotResponse$1>;
|
|
12501
12896
|
readonly transferBot: (input: TransferBotInput$1) => Promise<TransferBotResponse$1>;
|
|
@@ -12720,6 +13115,7 @@ declare class Client$6 extends Client$7 {
|
|
|
12720
13115
|
}>;
|
|
12721
13116
|
interfaces: (props: {
|
|
12722
13117
|
name?: string | undefined;
|
|
13118
|
+
version?: string | undefined;
|
|
12723
13119
|
}) => AsyncCollection<{
|
|
12724
13120
|
id: string;
|
|
12725
13121
|
createdAt: string;
|
|
@@ -12764,8 +13160,15 @@ declare class Client$6 extends Client$7 {
|
|
|
12764
13160
|
dateFrom?: string | undefined;
|
|
12765
13161
|
dateUntil?: string | undefined;
|
|
12766
13162
|
}) => AsyncCollection<{
|
|
13163
|
+
key: string;
|
|
12767
13164
|
date: string;
|
|
12768
13165
|
value: number;
|
|
13166
|
+
metadata?: {
|
|
13167
|
+
botId: string;
|
|
13168
|
+
type: "IntegrationAction" | "FileIndexing";
|
|
13169
|
+
subtype: string;
|
|
13170
|
+
source?: string;
|
|
13171
|
+
};
|
|
12769
13172
|
}>;
|
|
12770
13173
|
};
|
|
12771
13174
|
}
|
|
@@ -13577,6 +13980,33 @@ interface ListFilePassagesResponse$1 {
|
|
|
13577
13980
|
};
|
|
13578
13981
|
}
|
|
13579
13982
|
|
|
13983
|
+
interface SetFilePassagesRequestHeaders$1 {
|
|
13984
|
+
}
|
|
13985
|
+
interface SetFilePassagesRequestQuery$1 {
|
|
13986
|
+
}
|
|
13987
|
+
interface SetFilePassagesRequestParams$1 {
|
|
13988
|
+
id: string;
|
|
13989
|
+
}
|
|
13990
|
+
interface SetFilePassagesRequestBody$1 {
|
|
13991
|
+
/**
|
|
13992
|
+
* Note: The passages should appear in the array in the same order as they appear in the original document.
|
|
13993
|
+
*/
|
|
13994
|
+
passages: {
|
|
13995
|
+
/**
|
|
13996
|
+
* The content of the passage, supports Markdown formatting.
|
|
13997
|
+
*/
|
|
13998
|
+
content: string;
|
|
13999
|
+
/**
|
|
14000
|
+
* The type should match the Markdown format used for the passage content.
|
|
14001
|
+
*/
|
|
14002
|
+
type?: "title" | "subtitle" | "paragraph" | "blockquote" | "list" | "table" | "code" | "image";
|
|
14003
|
+
pageNumber?: number;
|
|
14004
|
+
}[];
|
|
14005
|
+
}
|
|
14006
|
+
type SetFilePassagesInput$1 = SetFilePassagesRequestBody$1 & SetFilePassagesRequestHeaders$1 & SetFilePassagesRequestQuery$1 & SetFilePassagesRequestParams$1;
|
|
14007
|
+
interface SetFilePassagesResponse$1 {
|
|
14008
|
+
}
|
|
14009
|
+
|
|
13580
14010
|
interface ListFileTagsRequestHeaders$1 {
|
|
13581
14011
|
}
|
|
13582
14012
|
interface ListFileTagsRequestQuery$1 {
|
|
@@ -13733,6 +14163,7 @@ declare class Client$5 {
|
|
|
13733
14163
|
readonly copyFile: (input: CopyFileInput$1) => Promise<CopyFileResponse$1>;
|
|
13734
14164
|
readonly searchFiles: (input: SearchFilesInput$1) => Promise<SearchFilesResponse$1>;
|
|
13735
14165
|
readonly listFilePassages: (input: ListFilePassagesInput$1) => Promise<ListFilePassagesResponse$1>;
|
|
14166
|
+
readonly setFilePassages: (input: SetFilePassagesInput$1) => Promise<SetFilePassagesResponse$1>;
|
|
13736
14167
|
readonly listFileTags: (input: ListFileTagsInput$1) => Promise<ListFileTagsResponse$1>;
|
|
13737
14168
|
readonly listFileTagValues: (input: ListFileTagValuesInput$1) => Promise<ListFileTagValuesResponse$1>;
|
|
13738
14169
|
readonly createKnowledgeBase: (input: CreateKnowledgeBaseInput$1) => Promise<CreateKnowledgeBaseResponse$1>;
|
|
@@ -18426,13 +18857,432 @@ interface ListPublicIntegrationsResponse {
|
|
|
18426
18857
|
*/
|
|
18427
18858
|
version: string;
|
|
18428
18859
|
/**
|
|
18429
|
-
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
18860
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
18861
|
+
*/
|
|
18862
|
+
createdAt: string;
|
|
18863
|
+
/**
|
|
18864
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
18865
|
+
*/
|
|
18866
|
+
updatedAt: string;
|
|
18867
|
+
/**
|
|
18868
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
18869
|
+
*/
|
|
18870
|
+
title: string;
|
|
18871
|
+
/**
|
|
18872
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
18873
|
+
*/
|
|
18874
|
+
description: string;
|
|
18875
|
+
/**
|
|
18876
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
18877
|
+
*/
|
|
18878
|
+
iconUrl: string;
|
|
18879
|
+
/**
|
|
18880
|
+
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
18881
|
+
*/
|
|
18882
|
+
public: boolean;
|
|
18883
|
+
/**
|
|
18884
|
+
* Status of the integration version verification
|
|
18885
|
+
*/
|
|
18886
|
+
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
18887
|
+
ownerWorkspace: {
|
|
18888
|
+
id: string;
|
|
18889
|
+
handle: string | null;
|
|
18890
|
+
name: string;
|
|
18891
|
+
};
|
|
18892
|
+
meta: {
|
|
18893
|
+
installs: number;
|
|
18894
|
+
views: number;
|
|
18895
|
+
};
|
|
18896
|
+
/**
|
|
18897
|
+
* Metadata about which fields matched the search criteria
|
|
18898
|
+
*/
|
|
18899
|
+
matchedOn?: {
|
|
18900
|
+
/**
|
|
18901
|
+
* Whether the integration name matched the search term
|
|
18902
|
+
*/
|
|
18903
|
+
name?: boolean;
|
|
18904
|
+
/**
|
|
18905
|
+
* Whether the integration title matched the search term
|
|
18906
|
+
*/
|
|
18907
|
+
title?: boolean;
|
|
18908
|
+
/**
|
|
18909
|
+
* Whether the integration description matched the search term
|
|
18910
|
+
*/
|
|
18911
|
+
description?: boolean;
|
|
18912
|
+
/**
|
|
18913
|
+
* Action names that matched the search term
|
|
18914
|
+
*/
|
|
18915
|
+
actions?: string[];
|
|
18916
|
+
/**
|
|
18917
|
+
* Interface names that matched the search term
|
|
18918
|
+
*/
|
|
18919
|
+
interfaces?: string[];
|
|
18920
|
+
};
|
|
18921
|
+
}[];
|
|
18922
|
+
meta: {
|
|
18923
|
+
/**
|
|
18924
|
+
* 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.
|
|
18925
|
+
*/
|
|
18926
|
+
nextToken?: string;
|
|
18927
|
+
};
|
|
18928
|
+
}
|
|
18929
|
+
|
|
18930
|
+
interface GetPublicIntegrationByIdRequestHeaders {
|
|
18931
|
+
}
|
|
18932
|
+
interface GetPublicIntegrationByIdRequestQuery {
|
|
18933
|
+
}
|
|
18934
|
+
interface GetPublicIntegrationByIdRequestParams {
|
|
18935
|
+
id: string;
|
|
18936
|
+
}
|
|
18937
|
+
interface GetPublicIntegrationByIdRequestBody {
|
|
18938
|
+
}
|
|
18939
|
+
type GetPublicIntegrationByIdInput = GetPublicIntegrationByIdRequestBody & GetPublicIntegrationByIdRequestHeaders & GetPublicIntegrationByIdRequestQuery & GetPublicIntegrationByIdRequestParams;
|
|
18940
|
+
interface GetPublicIntegrationByIdResponse {
|
|
18941
|
+
integration: {
|
|
18942
|
+
/**
|
|
18943
|
+
* ID of the [Integration](#schema_integration)
|
|
18944
|
+
*/
|
|
18945
|
+
id: string;
|
|
18946
|
+
/**
|
|
18947
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
18948
|
+
*/
|
|
18949
|
+
createdAt: string;
|
|
18950
|
+
/**
|
|
18951
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
18952
|
+
*/
|
|
18953
|
+
updatedAt: string;
|
|
18954
|
+
/**
|
|
18955
|
+
* Global identifier configuration of the [Integration](#schema_integration)
|
|
18956
|
+
*/
|
|
18957
|
+
identifier: {
|
|
18958
|
+
/**
|
|
18959
|
+
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
|
|
18960
|
+
*/
|
|
18961
|
+
fallbackHandlerScript?: string;
|
|
18962
|
+
/**
|
|
18963
|
+
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
18964
|
+
*/
|
|
18965
|
+
extractScript?: string;
|
|
18966
|
+
};
|
|
18967
|
+
sandbox?: {
|
|
18968
|
+
/**
|
|
18969
|
+
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
|
|
18970
|
+
*/
|
|
18971
|
+
identifierExtractScript?: string;
|
|
18972
|
+
/**
|
|
18973
|
+
* VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
|
|
18974
|
+
*/
|
|
18975
|
+
messageExtractScript?: string;
|
|
18976
|
+
};
|
|
18977
|
+
/**
|
|
18978
|
+
* URL of the [Integration](#schema_integration)
|
|
18979
|
+
*/
|
|
18980
|
+
url: string;
|
|
18981
|
+
/**
|
|
18982
|
+
* Name of the [Integration](#schema_integration)
|
|
18983
|
+
*/
|
|
18984
|
+
name: string;
|
|
18985
|
+
/**
|
|
18986
|
+
* Version of the [Integration](#schema_integration)
|
|
18987
|
+
*/
|
|
18988
|
+
version: string;
|
|
18989
|
+
interfaces: {
|
|
18990
|
+
[k: string]: {
|
|
18991
|
+
/**
|
|
18992
|
+
* ID of the interface
|
|
18993
|
+
*/
|
|
18994
|
+
id: string;
|
|
18995
|
+
/**
|
|
18996
|
+
* Name of the interface
|
|
18997
|
+
*/
|
|
18998
|
+
name: string;
|
|
18999
|
+
/**
|
|
19000
|
+
* Version of the interface
|
|
19001
|
+
*/
|
|
19002
|
+
version: string;
|
|
19003
|
+
entities: {
|
|
19004
|
+
[k: string]: {
|
|
19005
|
+
name: string;
|
|
19006
|
+
};
|
|
19007
|
+
};
|
|
19008
|
+
actions: {
|
|
19009
|
+
[k: string]: {
|
|
19010
|
+
name: string;
|
|
19011
|
+
};
|
|
19012
|
+
};
|
|
19013
|
+
events: {
|
|
19014
|
+
[k: string]: {
|
|
19015
|
+
name: string;
|
|
19016
|
+
};
|
|
19017
|
+
};
|
|
19018
|
+
channels: {
|
|
19019
|
+
[k: string]: {
|
|
19020
|
+
name: string;
|
|
19021
|
+
};
|
|
19022
|
+
};
|
|
19023
|
+
};
|
|
19024
|
+
};
|
|
19025
|
+
/**
|
|
19026
|
+
* Configuration definition
|
|
19027
|
+
*/
|
|
19028
|
+
configuration: {
|
|
19029
|
+
/**
|
|
19030
|
+
* Title of the configuration
|
|
19031
|
+
*/
|
|
19032
|
+
title?: string;
|
|
19033
|
+
/**
|
|
19034
|
+
* Description of the configuration
|
|
19035
|
+
*/
|
|
19036
|
+
description?: string;
|
|
19037
|
+
/**
|
|
19038
|
+
* Identifier configuration of the [Integration](#schema_integration)
|
|
19039
|
+
*/
|
|
19040
|
+
identifier: {
|
|
19041
|
+
linkTemplateScript?: string;
|
|
19042
|
+
required: boolean;
|
|
19043
|
+
};
|
|
19044
|
+
/**
|
|
19045
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
19046
|
+
*/
|
|
19047
|
+
schema: {
|
|
19048
|
+
[k: string]: any;
|
|
19049
|
+
};
|
|
19050
|
+
};
|
|
19051
|
+
configurations: {
|
|
19052
|
+
/**
|
|
19053
|
+
* Configuration definition
|
|
19054
|
+
*/
|
|
19055
|
+
[k: string]: {
|
|
19056
|
+
/**
|
|
19057
|
+
* Title of the configuration
|
|
19058
|
+
*/
|
|
19059
|
+
title?: string;
|
|
19060
|
+
/**
|
|
19061
|
+
* Description of the configuration
|
|
19062
|
+
*/
|
|
19063
|
+
description?: string;
|
|
19064
|
+
/**
|
|
19065
|
+
* Identifier configuration of the [Integration](#schema_integration)
|
|
19066
|
+
*/
|
|
19067
|
+
identifier: {
|
|
19068
|
+
linkTemplateScript?: string;
|
|
19069
|
+
required: boolean;
|
|
19070
|
+
};
|
|
19071
|
+
/**
|
|
19072
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
19073
|
+
*/
|
|
19074
|
+
schema: {
|
|
19075
|
+
[k: string]: any;
|
|
19076
|
+
};
|
|
19077
|
+
};
|
|
19078
|
+
};
|
|
19079
|
+
channels: {
|
|
19080
|
+
/**
|
|
19081
|
+
* Channel definition
|
|
19082
|
+
*/
|
|
19083
|
+
[k: string]: {
|
|
19084
|
+
/**
|
|
19085
|
+
* Title of the channel
|
|
19086
|
+
*/
|
|
19087
|
+
title?: string;
|
|
19088
|
+
/**
|
|
19089
|
+
* Description of the channel
|
|
19090
|
+
*/
|
|
19091
|
+
description?: string;
|
|
19092
|
+
messages: {
|
|
19093
|
+
/**
|
|
19094
|
+
* Message definition
|
|
19095
|
+
*/
|
|
19096
|
+
[k: string]: {
|
|
19097
|
+
schema: {
|
|
19098
|
+
[k: string]: any;
|
|
19099
|
+
};
|
|
19100
|
+
};
|
|
19101
|
+
};
|
|
19102
|
+
/**
|
|
19103
|
+
* Conversation object configuration
|
|
19104
|
+
*/
|
|
19105
|
+
conversation: {
|
|
19106
|
+
tags: {
|
|
19107
|
+
/**
|
|
19108
|
+
* Definition of a tag that can be provided on the object
|
|
19109
|
+
*/
|
|
19110
|
+
[k: string]: {
|
|
19111
|
+
/**
|
|
19112
|
+
* Title of the tag
|
|
19113
|
+
*/
|
|
19114
|
+
title?: string;
|
|
19115
|
+
/**
|
|
19116
|
+
* Description of the tag
|
|
19117
|
+
*/
|
|
19118
|
+
description?: string;
|
|
19119
|
+
};
|
|
19120
|
+
};
|
|
19121
|
+
/**
|
|
19122
|
+
* The conversation creation setting determines how to create a conversation through the API directly. The integration will have to implement the `createConversation` functionality to support this setting.
|
|
19123
|
+
*/
|
|
19124
|
+
creation: {
|
|
19125
|
+
/**
|
|
19126
|
+
* Enable conversation creation
|
|
19127
|
+
*/
|
|
19128
|
+
enabled: boolean;
|
|
19129
|
+
/**
|
|
19130
|
+
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
19131
|
+
*/
|
|
19132
|
+
requiredTags: string[];
|
|
19133
|
+
};
|
|
19134
|
+
};
|
|
19135
|
+
/**
|
|
19136
|
+
* Message object configuration
|
|
19137
|
+
*/
|
|
19138
|
+
message: {
|
|
19139
|
+
tags: {
|
|
19140
|
+
/**
|
|
19141
|
+
* Definition of a tag that can be provided on the object
|
|
19142
|
+
*/
|
|
19143
|
+
[k: string]: {
|
|
19144
|
+
/**
|
|
19145
|
+
* Title of the tag
|
|
19146
|
+
*/
|
|
19147
|
+
title?: string;
|
|
19148
|
+
/**
|
|
19149
|
+
* Description of the tag
|
|
19150
|
+
*/
|
|
19151
|
+
description?: string;
|
|
19152
|
+
};
|
|
19153
|
+
};
|
|
19154
|
+
};
|
|
19155
|
+
};
|
|
19156
|
+
};
|
|
19157
|
+
states: {
|
|
19158
|
+
/**
|
|
19159
|
+
* State definition
|
|
19160
|
+
*/
|
|
19161
|
+
[k: string]: {
|
|
19162
|
+
/**
|
|
19163
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
19164
|
+
*/
|
|
19165
|
+
type: "conversation" | "user" | "integration";
|
|
19166
|
+
/**
|
|
19167
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
19168
|
+
*/
|
|
19169
|
+
schema: {
|
|
19170
|
+
[k: string]: any;
|
|
19171
|
+
};
|
|
19172
|
+
};
|
|
19173
|
+
};
|
|
19174
|
+
events: {
|
|
19175
|
+
/**
|
|
19176
|
+
* Event Definition
|
|
19177
|
+
*/
|
|
19178
|
+
[k: string]: {
|
|
19179
|
+
/**
|
|
19180
|
+
* Title of the event
|
|
19181
|
+
*/
|
|
19182
|
+
title?: string;
|
|
19183
|
+
/**
|
|
19184
|
+
* Description of the event
|
|
19185
|
+
*/
|
|
19186
|
+
description?: string;
|
|
19187
|
+
schema: {
|
|
19188
|
+
[k: string]: any;
|
|
19189
|
+
};
|
|
19190
|
+
/**
|
|
19191
|
+
* Optional attributes
|
|
19192
|
+
*/
|
|
19193
|
+
attributes?: {
|
|
19194
|
+
[k: string]: string;
|
|
19195
|
+
};
|
|
19196
|
+
};
|
|
19197
|
+
};
|
|
19198
|
+
actions: {
|
|
19199
|
+
/**
|
|
19200
|
+
* Action definition
|
|
19201
|
+
*/
|
|
19202
|
+
[k: string]: {
|
|
19203
|
+
/**
|
|
19204
|
+
* Title of the action
|
|
19205
|
+
*/
|
|
19206
|
+
title?: string;
|
|
19207
|
+
/**
|
|
19208
|
+
* Description of the action
|
|
19209
|
+
*/
|
|
19210
|
+
description?: string;
|
|
19211
|
+
billable?: boolean;
|
|
19212
|
+
cacheable?: boolean;
|
|
19213
|
+
input: {
|
|
19214
|
+
schema: {
|
|
19215
|
+
[k: string]: any;
|
|
19216
|
+
};
|
|
19217
|
+
};
|
|
19218
|
+
output: {
|
|
19219
|
+
schema: {
|
|
19220
|
+
[k: string]: any;
|
|
19221
|
+
};
|
|
19222
|
+
};
|
|
19223
|
+
/**
|
|
19224
|
+
* Optional attributes
|
|
19225
|
+
*/
|
|
19226
|
+
attributes?: {
|
|
19227
|
+
[k: string]: string;
|
|
19228
|
+
};
|
|
19229
|
+
};
|
|
19230
|
+
};
|
|
19231
|
+
/**
|
|
19232
|
+
* User object configuration
|
|
18430
19233
|
*/
|
|
18431
|
-
|
|
19234
|
+
user: {
|
|
19235
|
+
tags: {
|
|
19236
|
+
/**
|
|
19237
|
+
* Definition of a tag that can be provided on the object
|
|
19238
|
+
*/
|
|
19239
|
+
[k: string]: {
|
|
19240
|
+
/**
|
|
19241
|
+
* Title of the tag
|
|
19242
|
+
*/
|
|
19243
|
+
title?: string;
|
|
19244
|
+
/**
|
|
19245
|
+
* Description of the tag
|
|
19246
|
+
*/
|
|
19247
|
+
description?: string;
|
|
19248
|
+
};
|
|
19249
|
+
};
|
|
19250
|
+
/**
|
|
19251
|
+
* The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
|
|
19252
|
+
*/
|
|
19253
|
+
creation: {
|
|
19254
|
+
/**
|
|
19255
|
+
* Enable user creation
|
|
19256
|
+
*/
|
|
19257
|
+
enabled: boolean;
|
|
19258
|
+
/**
|
|
19259
|
+
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
19260
|
+
*/
|
|
19261
|
+
requiredTags: string[];
|
|
19262
|
+
};
|
|
19263
|
+
};
|
|
19264
|
+
entities: {
|
|
19265
|
+
/**
|
|
19266
|
+
* Entity definition
|
|
19267
|
+
*/
|
|
19268
|
+
[k: string]: {
|
|
19269
|
+
/**
|
|
19270
|
+
* Title of the entity
|
|
19271
|
+
*/
|
|
19272
|
+
title?: string;
|
|
19273
|
+
/**
|
|
19274
|
+
* Description of the entity
|
|
19275
|
+
*/
|
|
19276
|
+
description?: string;
|
|
19277
|
+
schema: {
|
|
19278
|
+
[k: string]: any;
|
|
19279
|
+
};
|
|
19280
|
+
};
|
|
19281
|
+
};
|
|
18432
19282
|
/**
|
|
18433
|
-
*
|
|
19283
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
18434
19284
|
*/
|
|
18435
|
-
|
|
19285
|
+
dev: boolean;
|
|
18436
19286
|
/**
|
|
18437
19287
|
* Title of the integration. This is the name that will be displayed in the UI
|
|
18438
19288
|
*/
|
|
@@ -18445,6 +19295,10 @@ interface ListPublicIntegrationsResponse {
|
|
|
18445
19295
|
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
18446
19296
|
*/
|
|
18447
19297
|
iconUrl: string;
|
|
19298
|
+
/**
|
|
19299
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
19300
|
+
*/
|
|
19301
|
+
readmeUrl: string;
|
|
18448
19302
|
/**
|
|
18449
19303
|
* Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
18450
19304
|
*/
|
|
@@ -18453,6 +19307,10 @@ interface ListPublicIntegrationsResponse {
|
|
|
18453
19307
|
* Status of the integration version verification
|
|
18454
19308
|
*/
|
|
18455
19309
|
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
19310
|
+
/**
|
|
19311
|
+
* 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.
|
|
19312
|
+
*/
|
|
19313
|
+
secrets: string[];
|
|
18456
19314
|
ownerWorkspace: {
|
|
18457
19315
|
id: string;
|
|
18458
19316
|
handle: string | null;
|
|
@@ -18462,51 +19320,21 @@ interface ListPublicIntegrationsResponse {
|
|
|
18462
19320
|
installs: number;
|
|
18463
19321
|
views: number;
|
|
18464
19322
|
};
|
|
18465
|
-
/**
|
|
18466
|
-
* Metadata about which fields matched the search criteria
|
|
18467
|
-
*/
|
|
18468
|
-
matchedOn?: {
|
|
18469
|
-
/**
|
|
18470
|
-
* Whether the integration name matched the search term
|
|
18471
|
-
*/
|
|
18472
|
-
name?: boolean;
|
|
18473
|
-
/**
|
|
18474
|
-
* Whether the integration title matched the search term
|
|
18475
|
-
*/
|
|
18476
|
-
title?: boolean;
|
|
18477
|
-
/**
|
|
18478
|
-
* Whether the integration description matched the search term
|
|
18479
|
-
*/
|
|
18480
|
-
description?: boolean;
|
|
18481
|
-
/**
|
|
18482
|
-
* Action names that matched the search term
|
|
18483
|
-
*/
|
|
18484
|
-
actions?: string[];
|
|
18485
|
-
/**
|
|
18486
|
-
* Interface names that matched the search term
|
|
18487
|
-
*/
|
|
18488
|
-
interfaces?: string[];
|
|
18489
|
-
};
|
|
18490
|
-
}[];
|
|
18491
|
-
meta: {
|
|
18492
|
-
/**
|
|
18493
|
-
* 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.
|
|
18494
|
-
*/
|
|
18495
|
-
nextToken?: string;
|
|
18496
19323
|
};
|
|
18497
19324
|
}
|
|
18498
19325
|
|
|
18499
|
-
interface
|
|
19326
|
+
interface GetPublicIntegrationRequestHeaders {
|
|
18500
19327
|
}
|
|
18501
|
-
interface
|
|
19328
|
+
interface GetPublicIntegrationRequestQuery {
|
|
18502
19329
|
}
|
|
18503
|
-
interface
|
|
18504
|
-
|
|
19330
|
+
interface GetPublicIntegrationRequestParams {
|
|
19331
|
+
name: string;
|
|
19332
|
+
version: string;
|
|
18505
19333
|
}
|
|
18506
|
-
interface
|
|
19334
|
+
interface GetPublicIntegrationRequestBody {
|
|
18507
19335
|
}
|
|
18508
|
-
type
|
|
18509
|
-
interface
|
|
19336
|
+
type GetPublicIntegrationInput = GetPublicIntegrationRequestBody & GetPublicIntegrationRequestHeaders & GetPublicIntegrationRequestQuery & GetPublicIntegrationRequestParams;
|
|
19337
|
+
interface GetPublicIntegrationResponse {
|
|
18510
19338
|
integration: {
|
|
18511
19339
|
/**
|
|
18512
19340
|
* ID of the [Integration](#schema_integration)
|
|
@@ -18892,102 +19720,101 @@ interface GetPublicIntegrationByIdResponse {
|
|
|
18892
19720
|
};
|
|
18893
19721
|
}
|
|
18894
19722
|
|
|
18895
|
-
interface
|
|
19723
|
+
interface ListPublicPluginsRequestHeaders {
|
|
18896
19724
|
}
|
|
18897
|
-
interface
|
|
19725
|
+
interface ListPublicPluginsRequestQuery {
|
|
19726
|
+
nextToken?: string;
|
|
19727
|
+
name?: string;
|
|
19728
|
+
version?: string;
|
|
18898
19729
|
}
|
|
18899
|
-
interface
|
|
18900
|
-
name: string;
|
|
18901
|
-
version: string;
|
|
19730
|
+
interface ListPublicPluginsRequestParams {
|
|
18902
19731
|
}
|
|
18903
|
-
interface
|
|
19732
|
+
interface ListPublicPluginsRequestBody {
|
|
18904
19733
|
}
|
|
18905
|
-
type
|
|
18906
|
-
interface
|
|
18907
|
-
|
|
19734
|
+
type ListPublicPluginsInput = ListPublicPluginsRequestBody & ListPublicPluginsRequestHeaders & ListPublicPluginsRequestQuery & ListPublicPluginsRequestParams;
|
|
19735
|
+
interface ListPublicPluginsResponse {
|
|
19736
|
+
plugins: {
|
|
18908
19737
|
/**
|
|
18909
|
-
* ID of the [
|
|
19738
|
+
* ID of the [Plugin](#schema_plugin)
|
|
18910
19739
|
*/
|
|
18911
19740
|
id: string;
|
|
18912
19741
|
/**
|
|
18913
|
-
* Creation date of the [
|
|
19742
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
18914
19743
|
*/
|
|
18915
19744
|
createdAt: string;
|
|
18916
19745
|
/**
|
|
18917
|
-
* Updating date of the [
|
|
19746
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
19747
|
+
*/
|
|
19748
|
+
updatedAt: string;
|
|
19749
|
+
/**
|
|
19750
|
+
* Name of the [Plugin](#schema_plugin)
|
|
19751
|
+
*/
|
|
19752
|
+
name: string;
|
|
19753
|
+
/**
|
|
19754
|
+
* Version of the [Plugin](#schema_plugin)
|
|
19755
|
+
*/
|
|
19756
|
+
version: string;
|
|
19757
|
+
/**
|
|
19758
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
19759
|
+
*/
|
|
19760
|
+
title: string;
|
|
19761
|
+
/**
|
|
19762
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
19763
|
+
*/
|
|
19764
|
+
description: string;
|
|
19765
|
+
/**
|
|
19766
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
19767
|
+
*/
|
|
19768
|
+
iconUrl: string;
|
|
19769
|
+
/**
|
|
19770
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
19771
|
+
*/
|
|
19772
|
+
readmeUrl: string;
|
|
19773
|
+
/**
|
|
19774
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
19775
|
+
*/
|
|
19776
|
+
public: boolean;
|
|
19777
|
+
}[];
|
|
19778
|
+
meta: {
|
|
19779
|
+
/**
|
|
19780
|
+
* 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.
|
|
19781
|
+
*/
|
|
19782
|
+
nextToken?: string;
|
|
19783
|
+
};
|
|
19784
|
+
}
|
|
19785
|
+
|
|
19786
|
+
interface GetPublicPluginByIdRequestHeaders {
|
|
19787
|
+
}
|
|
19788
|
+
interface GetPublicPluginByIdRequestQuery {
|
|
19789
|
+
}
|
|
19790
|
+
interface GetPublicPluginByIdRequestParams {
|
|
19791
|
+
id: string;
|
|
19792
|
+
}
|
|
19793
|
+
interface GetPublicPluginByIdRequestBody {
|
|
19794
|
+
}
|
|
19795
|
+
type GetPublicPluginByIdInput = GetPublicPluginByIdRequestBody & GetPublicPluginByIdRequestHeaders & GetPublicPluginByIdRequestQuery & GetPublicPluginByIdRequestParams;
|
|
19796
|
+
interface GetPublicPluginByIdResponse {
|
|
19797
|
+
plugin: {
|
|
19798
|
+
/**
|
|
19799
|
+
* ID of the [Plugin](#schema_plugin)
|
|
18918
19800
|
*/
|
|
18919
|
-
|
|
19801
|
+
id: string;
|
|
18920
19802
|
/**
|
|
18921
|
-
*
|
|
19803
|
+
* Name of the [Plugin](#schema_plugin)
|
|
18922
19804
|
*/
|
|
18923
|
-
|
|
18924
|
-
/**
|
|
18925
|
-
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
|
|
18926
|
-
*/
|
|
18927
|
-
fallbackHandlerScript?: string;
|
|
18928
|
-
/**
|
|
18929
|
-
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
18930
|
-
*/
|
|
18931
|
-
extractScript?: string;
|
|
18932
|
-
};
|
|
18933
|
-
sandbox?: {
|
|
18934
|
-
/**
|
|
18935
|
-
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
|
|
18936
|
-
*/
|
|
18937
|
-
identifierExtractScript?: string;
|
|
18938
|
-
/**
|
|
18939
|
-
* VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
|
|
18940
|
-
*/
|
|
18941
|
-
messageExtractScript?: string;
|
|
18942
|
-
};
|
|
19805
|
+
name: string;
|
|
18943
19806
|
/**
|
|
18944
|
-
*
|
|
19807
|
+
* Version of the [Plugin](#schema_plugin)
|
|
18945
19808
|
*/
|
|
18946
|
-
|
|
19809
|
+
version: string;
|
|
18947
19810
|
/**
|
|
18948
|
-
*
|
|
19811
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
18949
19812
|
*/
|
|
18950
|
-
|
|
19813
|
+
createdAt: string;
|
|
18951
19814
|
/**
|
|
18952
|
-
*
|
|
19815
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
18953
19816
|
*/
|
|
18954
|
-
|
|
18955
|
-
interfaces: {
|
|
18956
|
-
[k: string]: {
|
|
18957
|
-
/**
|
|
18958
|
-
* ID of the interface
|
|
18959
|
-
*/
|
|
18960
|
-
id: string;
|
|
18961
|
-
/**
|
|
18962
|
-
* Name of the interface
|
|
18963
|
-
*/
|
|
18964
|
-
name: string;
|
|
18965
|
-
/**
|
|
18966
|
-
* Version of the interface
|
|
18967
|
-
*/
|
|
18968
|
-
version: string;
|
|
18969
|
-
entities: {
|
|
18970
|
-
[k: string]: {
|
|
18971
|
-
name: string;
|
|
18972
|
-
};
|
|
18973
|
-
};
|
|
18974
|
-
actions: {
|
|
18975
|
-
[k: string]: {
|
|
18976
|
-
name: string;
|
|
18977
|
-
};
|
|
18978
|
-
};
|
|
18979
|
-
events: {
|
|
18980
|
-
[k: string]: {
|
|
18981
|
-
name: string;
|
|
18982
|
-
};
|
|
18983
|
-
};
|
|
18984
|
-
channels: {
|
|
18985
|
-
[k: string]: {
|
|
18986
|
-
name: string;
|
|
18987
|
-
};
|
|
18988
|
-
};
|
|
18989
|
-
};
|
|
18990
|
-
};
|
|
19817
|
+
updatedAt: string;
|
|
18991
19818
|
/**
|
|
18992
19819
|
* Configuration definition
|
|
18993
19820
|
*/
|
|
@@ -19000,13 +19827,6 @@ interface GetPublicIntegrationResponse {
|
|
|
19000
19827
|
* Description of the configuration
|
|
19001
19828
|
*/
|
|
19002
19829
|
description?: string;
|
|
19003
|
-
/**
|
|
19004
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
19005
|
-
*/
|
|
19006
|
-
identifier: {
|
|
19007
|
-
linkTemplateScript?: string;
|
|
19008
|
-
required: boolean;
|
|
19009
|
-
};
|
|
19010
19830
|
/**
|
|
19011
19831
|
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
19012
19832
|
*/
|
|
@@ -19014,127 +19834,228 @@ interface GetPublicIntegrationResponse {
|
|
|
19014
19834
|
[k: string]: any;
|
|
19015
19835
|
};
|
|
19016
19836
|
};
|
|
19017
|
-
|
|
19837
|
+
states: {
|
|
19838
|
+
[k: string]: {
|
|
19839
|
+
/**
|
|
19840
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
19841
|
+
*/
|
|
19842
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
19843
|
+
/**
|
|
19844
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
19845
|
+
*/
|
|
19846
|
+
schema: {
|
|
19847
|
+
[k: string]: any;
|
|
19848
|
+
};
|
|
19849
|
+
/**
|
|
19850
|
+
* 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.
|
|
19851
|
+
*/
|
|
19852
|
+
expiry?: number;
|
|
19853
|
+
};
|
|
19854
|
+
};
|
|
19855
|
+
events: {
|
|
19018
19856
|
/**
|
|
19019
|
-
*
|
|
19857
|
+
* Event Definition
|
|
19020
19858
|
*/
|
|
19021
19859
|
[k: string]: {
|
|
19022
19860
|
/**
|
|
19023
|
-
* Title of the
|
|
19861
|
+
* Title of the event
|
|
19024
19862
|
*/
|
|
19025
19863
|
title?: string;
|
|
19026
19864
|
/**
|
|
19027
|
-
* Description of the
|
|
19865
|
+
* Description of the event
|
|
19028
19866
|
*/
|
|
19029
19867
|
description?: string;
|
|
19030
|
-
|
|
19031
|
-
|
|
19032
|
-
*/
|
|
19033
|
-
identifier: {
|
|
19034
|
-
linkTemplateScript?: string;
|
|
19035
|
-
required: boolean;
|
|
19868
|
+
schema: {
|
|
19869
|
+
[k: string]: any;
|
|
19036
19870
|
};
|
|
19037
19871
|
/**
|
|
19038
|
-
*
|
|
19872
|
+
* Optional attributes
|
|
19039
19873
|
*/
|
|
19040
|
-
|
|
19041
|
-
[k: string]:
|
|
19874
|
+
attributes?: {
|
|
19875
|
+
[k: string]: string;
|
|
19042
19876
|
};
|
|
19043
19877
|
};
|
|
19044
19878
|
};
|
|
19045
|
-
|
|
19879
|
+
actions: {
|
|
19046
19880
|
/**
|
|
19047
|
-
*
|
|
19881
|
+
* Action definition
|
|
19048
19882
|
*/
|
|
19049
19883
|
[k: string]: {
|
|
19050
19884
|
/**
|
|
19051
|
-
* Title of the
|
|
19885
|
+
* Title of the action
|
|
19052
19886
|
*/
|
|
19053
19887
|
title?: string;
|
|
19054
19888
|
/**
|
|
19055
|
-
* Description of the
|
|
19889
|
+
* Description of the action
|
|
19056
19890
|
*/
|
|
19057
19891
|
description?: string;
|
|
19058
|
-
|
|
19059
|
-
|
|
19060
|
-
|
|
19061
|
-
|
|
19062
|
-
|
|
19063
|
-
|
|
19064
|
-
|
|
19065
|
-
|
|
19892
|
+
billable?: boolean;
|
|
19893
|
+
cacheable?: boolean;
|
|
19894
|
+
input: {
|
|
19895
|
+
schema: {
|
|
19896
|
+
[k: string]: any;
|
|
19897
|
+
};
|
|
19898
|
+
};
|
|
19899
|
+
output: {
|
|
19900
|
+
schema: {
|
|
19901
|
+
[k: string]: any;
|
|
19066
19902
|
};
|
|
19067
19903
|
};
|
|
19068
19904
|
/**
|
|
19069
|
-
*
|
|
19905
|
+
* Optional attributes
|
|
19070
19906
|
*/
|
|
19071
|
-
|
|
19072
|
-
|
|
19073
|
-
|
|
19074
|
-
|
|
19075
|
-
|
|
19076
|
-
|
|
19077
|
-
|
|
19078
|
-
|
|
19079
|
-
|
|
19080
|
-
|
|
19081
|
-
|
|
19082
|
-
|
|
19083
|
-
|
|
19084
|
-
|
|
19085
|
-
|
|
19086
|
-
|
|
19907
|
+
attributes?: {
|
|
19908
|
+
[k: string]: string;
|
|
19909
|
+
};
|
|
19910
|
+
};
|
|
19911
|
+
};
|
|
19912
|
+
dependencies: {
|
|
19913
|
+
interfaces: {
|
|
19914
|
+
[k: string]: {
|
|
19915
|
+
id: string;
|
|
19916
|
+
name: string;
|
|
19917
|
+
version: string;
|
|
19918
|
+
};
|
|
19919
|
+
};
|
|
19920
|
+
integrations: {
|
|
19921
|
+
[k: string]: {
|
|
19922
|
+
id: string;
|
|
19923
|
+
name: string;
|
|
19924
|
+
version: string;
|
|
19925
|
+
};
|
|
19926
|
+
};
|
|
19927
|
+
};
|
|
19928
|
+
/**
|
|
19929
|
+
* User object configuration
|
|
19930
|
+
*/
|
|
19931
|
+
user: {
|
|
19932
|
+
tags: {
|
|
19933
|
+
/**
|
|
19934
|
+
* Definition of a tag that can be provided on the object
|
|
19935
|
+
*/
|
|
19936
|
+
[k: string]: {
|
|
19087
19937
|
/**
|
|
19088
|
-
*
|
|
19938
|
+
* Title of the tag
|
|
19089
19939
|
*/
|
|
19090
|
-
|
|
19091
|
-
|
|
19092
|
-
|
|
19093
|
-
|
|
19094
|
-
|
|
19095
|
-
/**
|
|
19096
|
-
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
19097
|
-
*/
|
|
19098
|
-
requiredTags: string[];
|
|
19099
|
-
};
|
|
19940
|
+
title?: string;
|
|
19941
|
+
/**
|
|
19942
|
+
* Description of the tag
|
|
19943
|
+
*/
|
|
19944
|
+
description?: string;
|
|
19100
19945
|
};
|
|
19946
|
+
};
|
|
19947
|
+
};
|
|
19948
|
+
/**
|
|
19949
|
+
* Conversation object configuration
|
|
19950
|
+
*/
|
|
19951
|
+
conversation: {
|
|
19952
|
+
tags: {
|
|
19101
19953
|
/**
|
|
19102
|
-
*
|
|
19954
|
+
* Definition of a tag that can be provided on the object
|
|
19103
19955
|
*/
|
|
19104
|
-
|
|
19105
|
-
|
|
19106
|
-
|
|
19107
|
-
|
|
19108
|
-
|
|
19109
|
-
|
|
19110
|
-
|
|
19111
|
-
|
|
19112
|
-
|
|
19113
|
-
title?: string;
|
|
19114
|
-
/**
|
|
19115
|
-
* Description of the tag
|
|
19116
|
-
*/
|
|
19117
|
-
description?: string;
|
|
19118
|
-
};
|
|
19119
|
-
};
|
|
19956
|
+
[k: string]: {
|
|
19957
|
+
/**
|
|
19958
|
+
* Title of the tag
|
|
19959
|
+
*/
|
|
19960
|
+
title?: string;
|
|
19961
|
+
/**
|
|
19962
|
+
* Description of the tag
|
|
19963
|
+
*/
|
|
19964
|
+
description?: string;
|
|
19120
19965
|
};
|
|
19121
19966
|
};
|
|
19122
19967
|
};
|
|
19968
|
+
/**
|
|
19969
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
19970
|
+
*/
|
|
19971
|
+
title: string;
|
|
19972
|
+
/**
|
|
19973
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
19974
|
+
*/
|
|
19975
|
+
description: string;
|
|
19976
|
+
/**
|
|
19977
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
19978
|
+
*/
|
|
19979
|
+
iconUrl: string;
|
|
19980
|
+
/**
|
|
19981
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
19982
|
+
*/
|
|
19983
|
+
readmeUrl: string;
|
|
19984
|
+
/**
|
|
19985
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
19986
|
+
*/
|
|
19987
|
+
public: boolean;
|
|
19988
|
+
};
|
|
19989
|
+
}
|
|
19990
|
+
|
|
19991
|
+
interface GetPublicPluginRequestHeaders {
|
|
19992
|
+
}
|
|
19993
|
+
interface GetPublicPluginRequestQuery {
|
|
19994
|
+
}
|
|
19995
|
+
interface GetPublicPluginRequestParams {
|
|
19996
|
+
name: string;
|
|
19997
|
+
version: string;
|
|
19998
|
+
}
|
|
19999
|
+
interface GetPublicPluginRequestBody {
|
|
20000
|
+
}
|
|
20001
|
+
type GetPublicPluginInput = GetPublicPluginRequestBody & GetPublicPluginRequestHeaders & GetPublicPluginRequestQuery & GetPublicPluginRequestParams;
|
|
20002
|
+
interface GetPublicPluginResponse {
|
|
20003
|
+
plugin: {
|
|
20004
|
+
/**
|
|
20005
|
+
* ID of the [Plugin](#schema_plugin)
|
|
20006
|
+
*/
|
|
20007
|
+
id: string;
|
|
20008
|
+
/**
|
|
20009
|
+
* Name of the [Plugin](#schema_plugin)
|
|
20010
|
+
*/
|
|
20011
|
+
name: string;
|
|
20012
|
+
/**
|
|
20013
|
+
* Version of the [Plugin](#schema_plugin)
|
|
20014
|
+
*/
|
|
20015
|
+
version: string;
|
|
20016
|
+
/**
|
|
20017
|
+
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
20018
|
+
*/
|
|
20019
|
+
createdAt: string;
|
|
20020
|
+
/**
|
|
20021
|
+
* Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
20022
|
+
*/
|
|
20023
|
+
updatedAt: string;
|
|
20024
|
+
/**
|
|
20025
|
+
* Configuration definition
|
|
20026
|
+
*/
|
|
20027
|
+
configuration: {
|
|
20028
|
+
/**
|
|
20029
|
+
* Title of the configuration
|
|
20030
|
+
*/
|
|
20031
|
+
title?: string;
|
|
20032
|
+
/**
|
|
20033
|
+
* Description of the configuration
|
|
20034
|
+
*/
|
|
20035
|
+
description?: string;
|
|
20036
|
+
/**
|
|
20037
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
20038
|
+
*/
|
|
20039
|
+
schema: {
|
|
20040
|
+
[k: string]: any;
|
|
20041
|
+
};
|
|
20042
|
+
};
|
|
19123
20043
|
states: {
|
|
19124
|
-
/**
|
|
19125
|
-
* State definition
|
|
19126
|
-
*/
|
|
19127
20044
|
[k: string]: {
|
|
19128
20045
|
/**
|
|
19129
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `
|
|
20046
|
+
* Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
|
|
19130
20047
|
*/
|
|
19131
|
-
type: "conversation" | "user" | "
|
|
20048
|
+
type: "conversation" | "user" | "bot" | "task";
|
|
19132
20049
|
/**
|
|
19133
20050
|
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
19134
20051
|
*/
|
|
19135
20052
|
schema: {
|
|
19136
20053
|
[k: string]: any;
|
|
19137
20054
|
};
|
|
20055
|
+
/**
|
|
20056
|
+
* 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.
|
|
20057
|
+
*/
|
|
20058
|
+
expiry?: number;
|
|
19138
20059
|
};
|
|
19139
20060
|
};
|
|
19140
20061
|
events: {
|
|
@@ -19194,6 +20115,22 @@ interface GetPublicIntegrationResponse {
|
|
|
19194
20115
|
};
|
|
19195
20116
|
};
|
|
19196
20117
|
};
|
|
20118
|
+
dependencies: {
|
|
20119
|
+
interfaces: {
|
|
20120
|
+
[k: string]: {
|
|
20121
|
+
id: string;
|
|
20122
|
+
name: string;
|
|
20123
|
+
version: string;
|
|
20124
|
+
};
|
|
20125
|
+
};
|
|
20126
|
+
integrations: {
|
|
20127
|
+
[k: string]: {
|
|
20128
|
+
id: string;
|
|
20129
|
+
name: string;
|
|
20130
|
+
version: string;
|
|
20131
|
+
};
|
|
20132
|
+
};
|
|
20133
|
+
};
|
|
19197
20134
|
/**
|
|
19198
20135
|
* User object configuration
|
|
19199
20136
|
*/
|
|
@@ -19213,134 +20150,117 @@ interface GetPublicIntegrationResponse {
|
|
|
19213
20150
|
description?: string;
|
|
19214
20151
|
};
|
|
19215
20152
|
};
|
|
19216
|
-
/**
|
|
19217
|
-
* The user creation setting determines how to create a user through the API directly. The integration will have to implement the `createUser` functionality to support this setting.
|
|
19218
|
-
*/
|
|
19219
|
-
creation: {
|
|
19220
|
-
/**
|
|
19221
|
-
* Enable user creation
|
|
19222
|
-
*/
|
|
19223
|
-
enabled: boolean;
|
|
19224
|
-
/**
|
|
19225
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
19226
|
-
*/
|
|
19227
|
-
requiredTags: string[];
|
|
19228
|
-
};
|
|
19229
20153
|
};
|
|
19230
|
-
|
|
19231
|
-
|
|
19232
|
-
|
|
19233
|
-
|
|
19234
|
-
|
|
19235
|
-
/**
|
|
19236
|
-
* Title of the entity
|
|
19237
|
-
*/
|
|
19238
|
-
title?: string;
|
|
20154
|
+
/**
|
|
20155
|
+
* Conversation object configuration
|
|
20156
|
+
*/
|
|
20157
|
+
conversation: {
|
|
20158
|
+
tags: {
|
|
19239
20159
|
/**
|
|
19240
|
-
*
|
|
20160
|
+
* Definition of a tag that can be provided on the object
|
|
19241
20161
|
*/
|
|
19242
|
-
|
|
19243
|
-
|
|
19244
|
-
|
|
20162
|
+
[k: string]: {
|
|
20163
|
+
/**
|
|
20164
|
+
* Title of the tag
|
|
20165
|
+
*/
|
|
20166
|
+
title?: string;
|
|
20167
|
+
/**
|
|
20168
|
+
* Description of the tag
|
|
20169
|
+
*/
|
|
20170
|
+
description?: string;
|
|
19245
20171
|
};
|
|
19246
20172
|
};
|
|
19247
20173
|
};
|
|
19248
20174
|
/**
|
|
19249
|
-
*
|
|
19250
|
-
*/
|
|
19251
|
-
dev: boolean;
|
|
19252
|
-
/**
|
|
19253
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
20175
|
+
* Title of the plugin. This is the name that will be displayed in the UI
|
|
19254
20176
|
*/
|
|
19255
20177
|
title: string;
|
|
19256
20178
|
/**
|
|
19257
|
-
* Description of the
|
|
20179
|
+
* Description of the plugin. This is the description that will be displayed in the UI
|
|
19258
20180
|
*/
|
|
19259
20181
|
description: string;
|
|
19260
20182
|
/**
|
|
19261
|
-
* URL of the icon of the
|
|
20183
|
+
* URL of the icon of the plugin. This is the icon that will be displayed in the UI
|
|
19262
20184
|
*/
|
|
19263
20185
|
iconUrl: string;
|
|
19264
20186
|
/**
|
|
19265
|
-
* URL of the readme of the
|
|
20187
|
+
* URL of the readme of the plugin. This is the readme that will be displayed in the UI
|
|
19266
20188
|
*/
|
|
19267
20189
|
readmeUrl: string;
|
|
19268
20190
|
/**
|
|
19269
|
-
* Indicates if the
|
|
20191
|
+
* Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
|
|
19270
20192
|
*/
|
|
19271
20193
|
public: boolean;
|
|
19272
|
-
/**
|
|
19273
|
-
* Status of the integration version verification
|
|
19274
|
-
*/
|
|
19275
|
-
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
19276
|
-
/**
|
|
19277
|
-
* 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.
|
|
19278
|
-
*/
|
|
19279
|
-
secrets: string[];
|
|
19280
|
-
ownerWorkspace: {
|
|
19281
|
-
id: string;
|
|
19282
|
-
handle: string | null;
|
|
19283
|
-
name: string;
|
|
19284
|
-
};
|
|
19285
|
-
meta: {
|
|
19286
|
-
installs: number;
|
|
19287
|
-
views: number;
|
|
19288
|
-
};
|
|
19289
20194
|
};
|
|
19290
20195
|
}
|
|
19291
20196
|
|
|
19292
|
-
interface
|
|
20197
|
+
interface GetPublicPluginCodeRequestHeaders {
|
|
19293
20198
|
}
|
|
19294
|
-
interface
|
|
20199
|
+
interface GetPublicPluginCodeRequestQuery {
|
|
20200
|
+
}
|
|
20201
|
+
interface GetPublicPluginCodeRequestParams {
|
|
20202
|
+
id: string;
|
|
20203
|
+
platform: "node" | "browser";
|
|
20204
|
+
}
|
|
20205
|
+
interface GetPublicPluginCodeRequestBody {
|
|
20206
|
+
}
|
|
20207
|
+
type GetPublicPluginCodeInput = GetPublicPluginCodeRequestBody & GetPublicPluginCodeRequestHeaders & GetPublicPluginCodeRequestQuery & GetPublicPluginCodeRequestParams;
|
|
20208
|
+
interface GetPublicPluginCodeResponse {
|
|
20209
|
+
code: string;
|
|
20210
|
+
}
|
|
20211
|
+
|
|
20212
|
+
interface ListPublicInterfacesRequestHeaders {
|
|
20213
|
+
}
|
|
20214
|
+
interface ListPublicInterfacesRequestQuery {
|
|
19295
20215
|
nextToken?: string;
|
|
19296
20216
|
name?: string;
|
|
19297
20217
|
version?: string;
|
|
19298
20218
|
}
|
|
19299
|
-
interface
|
|
20219
|
+
interface ListPublicInterfacesRequestParams {
|
|
19300
20220
|
}
|
|
19301
|
-
interface
|
|
20221
|
+
interface ListPublicInterfacesRequestBody {
|
|
19302
20222
|
}
|
|
19303
|
-
type
|
|
19304
|
-
interface
|
|
19305
|
-
|
|
20223
|
+
type ListPublicInterfacesInput = ListPublicInterfacesRequestBody & ListPublicInterfacesRequestHeaders & ListPublicInterfacesRequestQuery & ListPublicInterfacesRequestParams;
|
|
20224
|
+
interface ListPublicInterfacesResponse {
|
|
20225
|
+
interfaces: {
|
|
19306
20226
|
/**
|
|
19307
|
-
* ID of the [
|
|
20227
|
+
* ID of the [Interface](#schema_interface)
|
|
19308
20228
|
*/
|
|
19309
20229
|
id: string;
|
|
19310
20230
|
/**
|
|
19311
|
-
* Creation date of the [
|
|
20231
|
+
* Creation date of the [Interface](#schema_interface) in ISO 8601 format
|
|
19312
20232
|
*/
|
|
19313
20233
|
createdAt: string;
|
|
19314
20234
|
/**
|
|
19315
|
-
* Updating date of the [
|
|
20235
|
+
* Updating date of the [Interface](#schema_interface) in ISO 8601 format
|
|
19316
20236
|
*/
|
|
19317
20237
|
updatedAt: string;
|
|
19318
20238
|
/**
|
|
19319
|
-
* Name of the [
|
|
20239
|
+
* Name of the [Interface](#schema_interface)
|
|
19320
20240
|
*/
|
|
19321
20241
|
name: string;
|
|
19322
20242
|
/**
|
|
19323
|
-
* Version of the [
|
|
20243
|
+
* Version of the [Interface](#schema_interface)
|
|
19324
20244
|
*/
|
|
19325
20245
|
version: string;
|
|
19326
20246
|
/**
|
|
19327
|
-
* Title of the
|
|
20247
|
+
* Title of the interface. This is the name that will be displayed in the UI
|
|
19328
20248
|
*/
|
|
19329
20249
|
title: string;
|
|
19330
20250
|
/**
|
|
19331
|
-
* Description of the
|
|
20251
|
+
* Description of the interface. This is the description that will be displayed in the UI
|
|
19332
20252
|
*/
|
|
19333
20253
|
description: string;
|
|
19334
20254
|
/**
|
|
19335
|
-
* URL of the icon of the
|
|
20255
|
+
* URL of the icon of the interface. This is the icon that will be displayed in the UI
|
|
19336
20256
|
*/
|
|
19337
20257
|
iconUrl: string;
|
|
19338
20258
|
/**
|
|
19339
|
-
* URL of the readme of the
|
|
20259
|
+
* URL of the readme of the interface. This is the readme that will be displayed in the UI
|
|
19340
20260
|
*/
|
|
19341
20261
|
readmeUrl: string;
|
|
19342
20262
|
/**
|
|
19343
|
-
* Indicates if the
|
|
20263
|
+
* Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
|
|
19344
20264
|
*/
|
|
19345
20265
|
public: boolean;
|
|
19346
20266
|
}[];
|
|
@@ -19352,73 +20272,54 @@ interface ListPublicPluginsResponse {
|
|
|
19352
20272
|
};
|
|
19353
20273
|
}
|
|
19354
20274
|
|
|
19355
|
-
interface
|
|
20275
|
+
interface GetPublicInterfaceByIdRequestHeaders {
|
|
19356
20276
|
}
|
|
19357
|
-
interface
|
|
20277
|
+
interface GetPublicInterfaceByIdRequestQuery {
|
|
19358
20278
|
}
|
|
19359
|
-
interface
|
|
20279
|
+
interface GetPublicInterfaceByIdRequestParams {
|
|
19360
20280
|
id: string;
|
|
19361
20281
|
}
|
|
19362
|
-
interface
|
|
20282
|
+
interface GetPublicInterfaceByIdRequestBody {
|
|
19363
20283
|
}
|
|
19364
|
-
type
|
|
19365
|
-
interface
|
|
19366
|
-
|
|
20284
|
+
type GetPublicInterfaceByIdInput = GetPublicInterfaceByIdRequestBody & GetPublicInterfaceByIdRequestHeaders & GetPublicInterfaceByIdRequestQuery & GetPublicInterfaceByIdRequestParams;
|
|
20285
|
+
interface GetPublicInterfaceByIdResponse {
|
|
20286
|
+
interface: {
|
|
19367
20287
|
/**
|
|
19368
|
-
* ID of the [
|
|
20288
|
+
* ID of the [Interface](#schema_interface)
|
|
19369
20289
|
*/
|
|
19370
20290
|
id: string;
|
|
19371
20291
|
/**
|
|
19372
|
-
*
|
|
19373
|
-
*/
|
|
19374
|
-
name: string;
|
|
19375
|
-
/**
|
|
19376
|
-
* Version of the [Plugin](#schema_plugin)
|
|
19377
|
-
*/
|
|
19378
|
-
version: string;
|
|
19379
|
-
/**
|
|
19380
|
-
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
20292
|
+
* Creation date of the [Interface](#schema_interface) in ISO 8601 format
|
|
19381
20293
|
*/
|
|
19382
20294
|
createdAt: string;
|
|
19383
20295
|
/**
|
|
19384
|
-
* Updating date of the [
|
|
20296
|
+
* Updating date of the [Interface](#schema_interface) in ISO 8601 format
|
|
19385
20297
|
*/
|
|
19386
20298
|
updatedAt: string;
|
|
19387
20299
|
/**
|
|
19388
|
-
*
|
|
20300
|
+
* Name of the [Interface](#schema_interface)
|
|
19389
20301
|
*/
|
|
19390
|
-
|
|
19391
|
-
|
|
19392
|
-
|
|
19393
|
-
|
|
19394
|
-
|
|
19395
|
-
|
|
19396
|
-
* Description of the configuration
|
|
19397
|
-
*/
|
|
19398
|
-
description?: string;
|
|
20302
|
+
name: string;
|
|
20303
|
+
/**
|
|
20304
|
+
* Version of the [Interface](#schema_interface)
|
|
20305
|
+
*/
|
|
20306
|
+
version: string;
|
|
20307
|
+
entities: {
|
|
19399
20308
|
/**
|
|
19400
|
-
*
|
|
20309
|
+
* Entity definition
|
|
19401
20310
|
*/
|
|
19402
|
-
schema: {
|
|
19403
|
-
[k: string]: any;
|
|
19404
|
-
};
|
|
19405
|
-
};
|
|
19406
|
-
states: {
|
|
19407
20311
|
[k: string]: {
|
|
19408
20312
|
/**
|
|
19409
|
-
*
|
|
20313
|
+
* Title of the entity
|
|
19410
20314
|
*/
|
|
19411
|
-
|
|
20315
|
+
title?: string;
|
|
19412
20316
|
/**
|
|
19413
|
-
*
|
|
20317
|
+
* Description of the entity
|
|
19414
20318
|
*/
|
|
20319
|
+
description?: string;
|
|
19415
20320
|
schema: {
|
|
19416
20321
|
[k: string]: any;
|
|
19417
20322
|
};
|
|
19418
|
-
/**
|
|
19419
|
-
* 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.
|
|
19420
|
-
*/
|
|
19421
|
-
expiry?: number;
|
|
19422
20323
|
};
|
|
19423
20324
|
};
|
|
19424
20325
|
events: {
|
|
@@ -19478,153 +20379,107 @@ interface GetPublicPluginByIdResponse {
|
|
|
19478
20379
|
};
|
|
19479
20380
|
};
|
|
19480
20381
|
};
|
|
19481
|
-
|
|
19482
|
-
|
|
19483
|
-
[k: string]: {
|
|
19484
|
-
id: string;
|
|
19485
|
-
name: string;
|
|
19486
|
-
version: string;
|
|
19487
|
-
};
|
|
19488
|
-
};
|
|
19489
|
-
integrations: {
|
|
19490
|
-
[k: string]: {
|
|
19491
|
-
id: string;
|
|
19492
|
-
name: string;
|
|
19493
|
-
version: string;
|
|
19494
|
-
};
|
|
19495
|
-
};
|
|
19496
|
-
};
|
|
19497
|
-
/**
|
|
19498
|
-
* User object configuration
|
|
19499
|
-
*/
|
|
19500
|
-
user: {
|
|
19501
|
-
tags: {
|
|
20382
|
+
channels: {
|
|
20383
|
+
[k: string]: {
|
|
19502
20384
|
/**
|
|
19503
|
-
*
|
|
20385
|
+
* Title of the channel
|
|
19504
20386
|
*/
|
|
19505
|
-
|
|
19506
|
-
|
|
19507
|
-
|
|
19508
|
-
|
|
19509
|
-
|
|
20387
|
+
title?: string;
|
|
20388
|
+
/**
|
|
20389
|
+
* Description of the channel
|
|
20390
|
+
*/
|
|
20391
|
+
description?: string;
|
|
20392
|
+
messages: {
|
|
19510
20393
|
/**
|
|
19511
|
-
*
|
|
20394
|
+
* Message definition
|
|
19512
20395
|
*/
|
|
19513
|
-
|
|
20396
|
+
[k: string]: {
|
|
20397
|
+
schema: {
|
|
20398
|
+
[k: string]: any;
|
|
20399
|
+
};
|
|
20400
|
+
};
|
|
19514
20401
|
};
|
|
19515
20402
|
};
|
|
19516
20403
|
};
|
|
19517
20404
|
/**
|
|
19518
|
-
*
|
|
20405
|
+
* Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
|
|
19519
20406
|
*/
|
|
19520
|
-
|
|
19521
|
-
|
|
19522
|
-
|
|
19523
|
-
* Definition of a tag that can be provided on the object
|
|
19524
|
-
*/
|
|
19525
|
-
[k: string]: {
|
|
19526
|
-
/**
|
|
19527
|
-
* Title of the tag
|
|
19528
|
-
*/
|
|
19529
|
-
title?: string;
|
|
19530
|
-
/**
|
|
19531
|
-
* Description of the tag
|
|
19532
|
-
*/
|
|
19533
|
-
description?: string;
|
|
19534
|
-
};
|
|
19535
|
-
};
|
|
20407
|
+
nameTemplate?: {
|
|
20408
|
+
script: string;
|
|
20409
|
+
language: string;
|
|
19536
20410
|
};
|
|
19537
20411
|
/**
|
|
19538
|
-
* Title of the
|
|
20412
|
+
* Title of the interface. This is the name that will be displayed in the UI
|
|
19539
20413
|
*/
|
|
19540
20414
|
title: string;
|
|
19541
20415
|
/**
|
|
19542
|
-
* Description of the
|
|
20416
|
+
* Description of the interface. This is the description that will be displayed in the UI
|
|
19543
20417
|
*/
|
|
19544
20418
|
description: string;
|
|
19545
20419
|
/**
|
|
19546
|
-
* URL of the icon of the
|
|
20420
|
+
* URL of the icon of the interface. This is the icon that will be displayed in the UI
|
|
19547
20421
|
*/
|
|
19548
20422
|
iconUrl: string;
|
|
19549
20423
|
/**
|
|
19550
|
-
* URL of the readme of the
|
|
20424
|
+
* URL of the readme of the interface. This is the readme that will be displayed in the UI
|
|
19551
20425
|
*/
|
|
19552
20426
|
readmeUrl: string;
|
|
19553
20427
|
/**
|
|
19554
|
-
* Indicates if the
|
|
20428
|
+
* Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
|
|
19555
20429
|
*/
|
|
19556
20430
|
public: boolean;
|
|
19557
20431
|
};
|
|
19558
20432
|
}
|
|
19559
20433
|
|
|
19560
|
-
interface
|
|
20434
|
+
interface GetPublicInterfaceRequestHeaders {
|
|
19561
20435
|
}
|
|
19562
|
-
interface
|
|
20436
|
+
interface GetPublicInterfaceRequestQuery {
|
|
19563
20437
|
}
|
|
19564
|
-
interface
|
|
20438
|
+
interface GetPublicInterfaceRequestParams {
|
|
19565
20439
|
name: string;
|
|
19566
20440
|
version: string;
|
|
19567
20441
|
}
|
|
19568
|
-
interface
|
|
20442
|
+
interface GetPublicInterfaceRequestBody {
|
|
19569
20443
|
}
|
|
19570
|
-
type
|
|
19571
|
-
interface
|
|
19572
|
-
|
|
20444
|
+
type GetPublicInterfaceInput = GetPublicInterfaceRequestBody & GetPublicInterfaceRequestHeaders & GetPublicInterfaceRequestQuery & GetPublicInterfaceRequestParams;
|
|
20445
|
+
interface GetPublicInterfaceResponse {
|
|
20446
|
+
interface: {
|
|
19573
20447
|
/**
|
|
19574
|
-
* ID of the [
|
|
20448
|
+
* ID of the [Interface](#schema_interface)
|
|
19575
20449
|
*/
|
|
19576
20450
|
id: string;
|
|
19577
20451
|
/**
|
|
19578
|
-
*
|
|
19579
|
-
*/
|
|
19580
|
-
name: string;
|
|
19581
|
-
/**
|
|
19582
|
-
* Version of the [Plugin](#schema_plugin)
|
|
19583
|
-
*/
|
|
19584
|
-
version: string;
|
|
19585
|
-
/**
|
|
19586
|
-
* Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
|
|
20452
|
+
* Creation date of the [Interface](#schema_interface) in ISO 8601 format
|
|
19587
20453
|
*/
|
|
19588
20454
|
createdAt: string;
|
|
19589
20455
|
/**
|
|
19590
|
-
* Updating date of the [
|
|
20456
|
+
* Updating date of the [Interface](#schema_interface) in ISO 8601 format
|
|
19591
20457
|
*/
|
|
19592
20458
|
updatedAt: string;
|
|
19593
20459
|
/**
|
|
19594
|
-
*
|
|
20460
|
+
* Name of the [Interface](#schema_interface)
|
|
19595
20461
|
*/
|
|
19596
|
-
|
|
19597
|
-
|
|
19598
|
-
|
|
19599
|
-
|
|
19600
|
-
|
|
19601
|
-
|
|
19602
|
-
* Description of the configuration
|
|
19603
|
-
*/
|
|
19604
|
-
description?: string;
|
|
20462
|
+
name: string;
|
|
20463
|
+
/**
|
|
20464
|
+
* Version of the [Interface](#schema_interface)
|
|
20465
|
+
*/
|
|
20466
|
+
version: string;
|
|
20467
|
+
entities: {
|
|
19605
20468
|
/**
|
|
19606
|
-
*
|
|
20469
|
+
* Entity definition
|
|
19607
20470
|
*/
|
|
19608
|
-
schema: {
|
|
19609
|
-
[k: string]: any;
|
|
19610
|
-
};
|
|
19611
|
-
};
|
|
19612
|
-
states: {
|
|
19613
20471
|
[k: string]: {
|
|
19614
20472
|
/**
|
|
19615
|
-
*
|
|
20473
|
+
* Title of the entity
|
|
19616
20474
|
*/
|
|
19617
|
-
|
|
20475
|
+
title?: string;
|
|
19618
20476
|
/**
|
|
19619
|
-
*
|
|
20477
|
+
* Description of the entity
|
|
19620
20478
|
*/
|
|
20479
|
+
description?: string;
|
|
19621
20480
|
schema: {
|
|
19622
20481
|
[k: string]: any;
|
|
19623
20482
|
};
|
|
19624
|
-
/**
|
|
19625
|
-
* 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.
|
|
19626
|
-
*/
|
|
19627
|
-
expiry?: number;
|
|
19628
20483
|
};
|
|
19629
20484
|
};
|
|
19630
20485
|
events: {
|
|
@@ -19684,100 +20539,58 @@ interface GetPublicPluginResponse {
|
|
|
19684
20539
|
};
|
|
19685
20540
|
};
|
|
19686
20541
|
};
|
|
19687
|
-
|
|
19688
|
-
|
|
19689
|
-
[k: string]: {
|
|
19690
|
-
id: string;
|
|
19691
|
-
name: string;
|
|
19692
|
-
version: string;
|
|
19693
|
-
};
|
|
19694
|
-
};
|
|
19695
|
-
integrations: {
|
|
19696
|
-
[k: string]: {
|
|
19697
|
-
id: string;
|
|
19698
|
-
name: string;
|
|
19699
|
-
version: string;
|
|
19700
|
-
};
|
|
19701
|
-
};
|
|
19702
|
-
};
|
|
19703
|
-
/**
|
|
19704
|
-
* User object configuration
|
|
19705
|
-
*/
|
|
19706
|
-
user: {
|
|
19707
|
-
tags: {
|
|
20542
|
+
channels: {
|
|
20543
|
+
[k: string]: {
|
|
19708
20544
|
/**
|
|
19709
|
-
*
|
|
20545
|
+
* Title of the channel
|
|
19710
20546
|
*/
|
|
19711
|
-
|
|
19712
|
-
|
|
19713
|
-
|
|
19714
|
-
|
|
19715
|
-
|
|
20547
|
+
title?: string;
|
|
20548
|
+
/**
|
|
20549
|
+
* Description of the channel
|
|
20550
|
+
*/
|
|
20551
|
+
description?: string;
|
|
20552
|
+
messages: {
|
|
19716
20553
|
/**
|
|
19717
|
-
*
|
|
20554
|
+
* Message definition
|
|
19718
20555
|
*/
|
|
19719
|
-
|
|
20556
|
+
[k: string]: {
|
|
20557
|
+
schema: {
|
|
20558
|
+
[k: string]: any;
|
|
20559
|
+
};
|
|
20560
|
+
};
|
|
19720
20561
|
};
|
|
19721
20562
|
};
|
|
19722
20563
|
};
|
|
19723
20564
|
/**
|
|
19724
|
-
*
|
|
20565
|
+
* Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
|
|
19725
20566
|
*/
|
|
19726
|
-
|
|
19727
|
-
|
|
19728
|
-
|
|
19729
|
-
* Definition of a tag that can be provided on the object
|
|
19730
|
-
*/
|
|
19731
|
-
[k: string]: {
|
|
19732
|
-
/**
|
|
19733
|
-
* Title of the tag
|
|
19734
|
-
*/
|
|
19735
|
-
title?: string;
|
|
19736
|
-
/**
|
|
19737
|
-
* Description of the tag
|
|
19738
|
-
*/
|
|
19739
|
-
description?: string;
|
|
19740
|
-
};
|
|
19741
|
-
};
|
|
20567
|
+
nameTemplate?: {
|
|
20568
|
+
script: string;
|
|
20569
|
+
language: string;
|
|
19742
20570
|
};
|
|
19743
20571
|
/**
|
|
19744
|
-
* Title of the
|
|
20572
|
+
* Title of the interface. This is the name that will be displayed in the UI
|
|
19745
20573
|
*/
|
|
19746
20574
|
title: string;
|
|
19747
20575
|
/**
|
|
19748
|
-
* Description of the
|
|
20576
|
+
* Description of the interface. This is the description that will be displayed in the UI
|
|
19749
20577
|
*/
|
|
19750
20578
|
description: string;
|
|
19751
20579
|
/**
|
|
19752
|
-
* URL of the icon of the
|
|
20580
|
+
* URL of the icon of the interface. This is the icon that will be displayed in the UI
|
|
19753
20581
|
*/
|
|
19754
20582
|
iconUrl: string;
|
|
19755
20583
|
/**
|
|
19756
|
-
* URL of the readme of the
|
|
20584
|
+
* URL of the readme of the interface. This is the readme that will be displayed in the UI
|
|
19757
20585
|
*/
|
|
19758
20586
|
readmeUrl: string;
|
|
19759
20587
|
/**
|
|
19760
|
-
* Indicates if the
|
|
20588
|
+
* Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
|
|
19761
20589
|
*/
|
|
19762
20590
|
public: boolean;
|
|
19763
20591
|
};
|
|
19764
20592
|
}
|
|
19765
20593
|
|
|
19766
|
-
interface GetPublicPluginCodeRequestHeaders {
|
|
19767
|
-
}
|
|
19768
|
-
interface GetPublicPluginCodeRequestQuery {
|
|
19769
|
-
}
|
|
19770
|
-
interface GetPublicPluginCodeRequestParams {
|
|
19771
|
-
id: string;
|
|
19772
|
-
platform: "node" | "browser";
|
|
19773
|
-
}
|
|
19774
|
-
interface GetPublicPluginCodeRequestBody {
|
|
19775
|
-
}
|
|
19776
|
-
type GetPublicPluginCodeInput = GetPublicPluginCodeRequestBody & GetPublicPluginCodeRequestHeaders & GetPublicPluginCodeRequestQuery & GetPublicPluginCodeRequestParams;
|
|
19777
|
-
interface GetPublicPluginCodeResponse {
|
|
19778
|
-
code: string;
|
|
19779
|
-
}
|
|
19780
|
-
|
|
19781
20594
|
interface CreateBotRequestHeaders {
|
|
19782
20595
|
}
|
|
19783
20596
|
interface CreateBotRequestQuery {
|
|
@@ -21235,6 +22048,7 @@ interface GetBotLogsRequestQuery {
|
|
|
21235
22048
|
userId?: string;
|
|
21236
22049
|
workflowId?: string;
|
|
21237
22050
|
conversationId?: string;
|
|
22051
|
+
messageContains?: string;
|
|
21238
22052
|
nextToken?: string;
|
|
21239
22053
|
}
|
|
21240
22054
|
interface GetBotLogsRequestParams {
|
|
@@ -24833,6 +25647,7 @@ interface GetIntegrationLogsRequestQuery {
|
|
|
24833
25647
|
level?: string;
|
|
24834
25648
|
userId?: string;
|
|
24835
25649
|
conversationId?: string;
|
|
25650
|
+
messageContains?: string;
|
|
24836
25651
|
nextToken?: string;
|
|
24837
25652
|
}
|
|
24838
25653
|
interface GetIntegrationLogsRequestParams {
|
|
@@ -26171,6 +26986,7 @@ interface ListInterfacesRequestHeaders {
|
|
|
26171
26986
|
interface ListInterfacesRequestQuery {
|
|
26172
26987
|
nextToken?: string;
|
|
26173
26988
|
name?: string;
|
|
26989
|
+
version?: string;
|
|
26174
26990
|
}
|
|
26175
26991
|
interface ListInterfacesRequestParams {
|
|
26176
26992
|
}
|
|
@@ -27641,8 +28457,15 @@ interface ListUsageActivityDailyRequestBody {
|
|
|
27641
28457
|
type ListUsageActivityDailyInput = ListUsageActivityDailyRequestBody & ListUsageActivityDailyRequestHeaders & ListUsageActivityDailyRequestQuery & ListUsageActivityDailyRequestParams;
|
|
27642
28458
|
interface ListUsageActivityDailyResponse {
|
|
27643
28459
|
data: {
|
|
28460
|
+
key: string;
|
|
27644
28461
|
date: string;
|
|
27645
28462
|
value: number;
|
|
28463
|
+
metadata?: {
|
|
28464
|
+
botId: string;
|
|
28465
|
+
type: "IntegrationAction" | "FileIndexing";
|
|
28466
|
+
subtype: string;
|
|
28467
|
+
source?: string;
|
|
28468
|
+
};
|
|
27646
28469
|
}[];
|
|
27647
28470
|
meta: {
|
|
27648
28471
|
nextToken?: string;
|
|
@@ -28499,6 +29322,33 @@ interface ListFilePassagesResponse {
|
|
|
28499
29322
|
};
|
|
28500
29323
|
}
|
|
28501
29324
|
|
|
29325
|
+
interface SetFilePassagesRequestHeaders {
|
|
29326
|
+
}
|
|
29327
|
+
interface SetFilePassagesRequestQuery {
|
|
29328
|
+
}
|
|
29329
|
+
interface SetFilePassagesRequestParams {
|
|
29330
|
+
id: string;
|
|
29331
|
+
}
|
|
29332
|
+
interface SetFilePassagesRequestBody {
|
|
29333
|
+
/**
|
|
29334
|
+
* Note: The passages should appear in the array in the same order as they appear in the original document.
|
|
29335
|
+
*/
|
|
29336
|
+
passages: {
|
|
29337
|
+
/**
|
|
29338
|
+
* The content of the passage, supports Markdown formatting.
|
|
29339
|
+
*/
|
|
29340
|
+
content: string;
|
|
29341
|
+
/**
|
|
29342
|
+
* The type should match the Markdown format used for the passage content.
|
|
29343
|
+
*/
|
|
29344
|
+
type?: "title" | "subtitle" | "paragraph" | "blockquote" | "list" | "table" | "code" | "image";
|
|
29345
|
+
pageNumber?: number;
|
|
29346
|
+
}[];
|
|
29347
|
+
}
|
|
29348
|
+
type SetFilePassagesInput = SetFilePassagesRequestBody & SetFilePassagesRequestHeaders & SetFilePassagesRequestQuery & SetFilePassagesRequestParams;
|
|
29349
|
+
interface SetFilePassagesResponse {
|
|
29350
|
+
}
|
|
29351
|
+
|
|
28502
29352
|
interface ListFileTagsRequestHeaders {
|
|
28503
29353
|
}
|
|
28504
29354
|
interface ListFileTagsRequestQuery {
|
|
@@ -32081,6 +32931,9 @@ declare class Client$1 {
|
|
|
32081
32931
|
readonly getPublicPluginById: (input: GetPublicPluginByIdInput) => Promise<GetPublicPluginByIdResponse>;
|
|
32082
32932
|
readonly getPublicPlugin: (input: GetPublicPluginInput) => Promise<GetPublicPluginResponse>;
|
|
32083
32933
|
readonly getPublicPluginCode: (input: GetPublicPluginCodeInput) => Promise<GetPublicPluginCodeResponse>;
|
|
32934
|
+
readonly listPublicInterfaces: (input: ListPublicInterfacesInput) => Promise<ListPublicInterfacesResponse>;
|
|
32935
|
+
readonly getPublicInterfaceById: (input: GetPublicInterfaceByIdInput) => Promise<GetPublicInterfaceByIdResponse>;
|
|
32936
|
+
readonly getPublicInterface: (input: GetPublicInterfaceInput) => Promise<GetPublicInterfaceResponse>;
|
|
32084
32937
|
readonly createBot: (input: CreateBotInput) => Promise<CreateBotResponse>;
|
|
32085
32938
|
readonly updateBot: (input: UpdateBotInput) => Promise<UpdateBotResponse>;
|
|
32086
32939
|
readonly transferBot: (input: TransferBotInput) => Promise<TransferBotResponse>;
|
|
@@ -32168,6 +33021,7 @@ declare class Client$1 {
|
|
|
32168
33021
|
readonly copyFile: (input: CopyFileInput) => Promise<CopyFileResponse>;
|
|
32169
33022
|
readonly searchFiles: (input: SearchFilesInput) => Promise<SearchFilesResponse>;
|
|
32170
33023
|
readonly listFilePassages: (input: ListFilePassagesInput) => Promise<ListFilePassagesResponse>;
|
|
33024
|
+
readonly setFilePassages: (input: SetFilePassagesInput) => Promise<SetFilePassagesResponse>;
|
|
32171
33025
|
readonly listFileTags: (input: ListFileTagsInput) => Promise<ListFileTagsResponse>;
|
|
32172
33026
|
readonly listFileTagValues: (input: ListFileTagValuesInput) => Promise<ListFileTagValuesResponse>;
|
|
32173
33027
|
readonly createKnowledgeBase: (input: CreateKnowledgeBaseInput) => Promise<CreateKnowledgeBaseResponse>;
|
|
@@ -32448,6 +33302,7 @@ declare class Client extends Client$1 implements IClient {
|
|
|
32448
33302
|
}>;
|
|
32449
33303
|
interfaces: (props: {
|
|
32450
33304
|
name?: string | undefined;
|
|
33305
|
+
version?: string | undefined;
|
|
32451
33306
|
}) => AsyncCollection<{
|
|
32452
33307
|
id: string;
|
|
32453
33308
|
createdAt: string;
|
|
@@ -32532,8 +33387,15 @@ declare class Client extends Client$1 implements IClient {
|
|
|
32532
33387
|
dateFrom?: string | undefined;
|
|
32533
33388
|
dateUntil?: string | undefined;
|
|
32534
33389
|
}) => AsyncCollection<{
|
|
33390
|
+
key: string;
|
|
32535
33391
|
date: string;
|
|
32536
33392
|
value: number;
|
|
33393
|
+
metadata?: {
|
|
33394
|
+
botId: string;
|
|
33395
|
+
type: "IntegrationAction" | "FileIndexing";
|
|
33396
|
+
subtype: string;
|
|
33397
|
+
source?: string;
|
|
33398
|
+
};
|
|
32537
33399
|
}>;
|
|
32538
33400
|
};
|
|
32539
33401
|
/**
|