@botpress/client 1.8.0 → 1.10.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/dist/index.d.ts CHANGED
@@ -4540,391 +4540,279 @@ interface GetPublicPluginCodeResponse$1 {
4540
4540
  code: string;
4541
4541
  }
4542
4542
 
4543
- interface CreateBotRequestHeaders$1 {
4543
+ interface ListPublicInterfacesRequestHeaders$1 {
4544
4544
  }
4545
- interface CreateBotRequestQuery$1 {
4545
+ interface ListPublicInterfacesRequestQuery$1 {
4546
+ nextToken?: string;
4547
+ name?: string;
4548
+ version?: string;
4546
4549
  }
4547
- interface CreateBotRequestParams$1 {
4550
+ interface ListPublicInterfacesRequestParams$1 {
4548
4551
  }
4549
- interface CreateBotRequestBody$1 {
4550
- /**
4551
- * A mapping of states to their definition
4552
- */
4553
- states?: {
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
- * Event Definition
4558
+ * ID of the [Interface](#schema_interface)
4577
4559
  */
4578
- [k: string]: {
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
- * Events that the bot is currently subscribed on (ex: "slack:reactionAdded"). If null, the bot is subscribed to all events.
4562
+ * Creation date of the [Interface](#schema_interface) in ISO 8601 format
4615
4563
  */
4616
- events: {
4617
- [k: string]: {};
4618
- } | null;
4619
- };
4620
- /**
4621
- * Actions definition
4622
- */
4623
- actions?: {
4564
+ createdAt: string;
4624
4565
  /**
4625
- * Action definition
4566
+ * Updating date of the [Interface](#schema_interface) in ISO 8601 format
4626
4567
  */
4627
- [k: string]: {
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
- * Configuration data
4570
+ * Name of the [Interface](#schema_interface)
4659
4571
  */
4660
- data?: {
4661
- [k: string]: any;
4662
- };
4572
+ name: string;
4663
4573
  /**
4664
- * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
4574
+ * Version of the [Interface](#schema_interface)
4665
4575
  */
4666
- schema?: {
4667
- [k: string]: any;
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
- user?: {
4671
- tags?: {
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
- * Definition of a tag that can be provided on the object
4640
+ * Entity definition
4674
4641
  */
4675
4642
  [k: string]: {
4676
4643
  /**
4677
- * Title of the tag
4644
+ * Title of the entity
4678
4645
  */
4679
4646
  title?: string;
4680
4647
  /**
4681
- * Description of the tag
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 of a tag that can be provided on the object
4658
+ * Event Definition
4691
4659
  */
4692
4660
  [k: string]: {
4693
4661
  /**
4694
- * Title of the tag
4662
+ * Title of the event
4695
4663
  */
4696
4664
  title?: string;
4697
4665
  /**
4698
- * Description of the tag
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
- * Definition of a tag that can be provided on the object
4682
+ * Action definition
4708
4683
  */
4709
4684
  [k: string]: {
4710
4685
  /**
4711
- * Title of the tag
4686
+ * Title of the action
4712
4687
  */
4713
4688
  title?: string;
4714
4689
  /**
4715
- * Description of the tag
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
- * Id of the [Bot](#schema_bot)
4736
+ * Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
4756
4737
  */
4757
- id: string;
4738
+ nameTemplate?: {
4739
+ script: string;
4740
+ language: string;
4741
+ };
4758
4742
  /**
4759
- * Creation date of the [Bot](#schema_bot) in ISO 8601 format
4743
+ * Title of the interface. This is the name that will be displayed in the UI
4760
4744
  */
4761
- createdAt: string;
4745
+ title: string;
4762
4746
  /**
4763
- * Updating date of the [Bot](#schema_bot) in ISO 8601 format
4747
+ * Description of the interface. This is the description that will be displayed in the UI
4764
4748
  */
4765
- updatedAt: string;
4749
+ description: string;
4766
4750
  /**
4767
- * Signing secret of the [Bot](#schema_bot)
4751
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
4768
4752
  */
4769
- signingSecret: string;
4753
+ iconUrl: string;
4770
4754
  /**
4771
- * A mapping of integrations to their configuration
4755
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
4772
4756
  */
4773
- integrations: {
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
- * User object configuration
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
- user: {
4831
- tags: {
4832
- /**
4833
- * Definition of a tag that can be provided on the object
4834
- */
4835
- [k: string]: {
4836
- /**
4837
- * Title of the tag
4838
- */
4839
- title?: string;
4840
- /**
4841
- * Description of the tag
4842
- */
4843
- description?: string;
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
- * Conversation object configuration
4779
+ * ID of the [Interface](#schema_interface)
4849
4780
  */
4850
- conversation: {
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
- * Message object configuration
4783
+ * Creation date of the [Interface](#schema_interface) in ISO 8601 format
4869
4784
  */
4870
- message: {
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
- * A mapping of states to their definition
4787
+ * Updating date of the [Interface](#schema_interface) in ISO 8601 format
4889
4788
  */
4890
- states: {
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
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
4804
+ * Title of the entity
4894
4805
  */
4895
- type: "conversation" | "user" | "bot" | "task";
4806
+ title?: string;
4896
4807
  /**
4897
- * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
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
- * Recurring events
4954
- */
4955
- recurringEvents: {
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
- * The number of times the recurring event failed to run. This counter resets once the recurring event runs successfully.
4846
+ * Title of the action
4966
4847
  */
4967
- failedAttempts: number;
4848
+ title?: string;
4968
4849
  /**
4969
- * The reason why the recurring event failed to run in the last attempt.
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
- * Tags of [Bot](#schema_bot)
5023
- */
5024
- tags: {
5025
- [k: string]: string;
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
- * Name of the [Bot](#schema_bot)
4896
+ * Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
5029
4897
  */
5030
- name: string;
4898
+ nameTemplate?: {
4899
+ script: string;
4900
+ language: string;
4901
+ };
5031
4902
  /**
5032
- * Last deployment date of the [Bot](#schema_bot) in the ISO 8601 format
4903
+ * Title of the interface. This is the name that will be displayed in the UI
5033
4904
  */
5034
- deployedAt?: string;
4905
+ title: string;
5035
4906
  /**
5036
- * Indicates if the [Bot](#schema_bot) is a development bot; Development bots run locally and can install dev integrations
4907
+ * Description of the interface. This is the description that will be displayed in the UI
5037
4908
  */
5038
- dev: boolean;
4909
+ description: string;
5039
4910
  /**
5040
- * Id of the user that created the bot
4911
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
5041
4912
  */
5042
- createdBy?: string;
4913
+ iconUrl: string;
5043
4914
  /**
5044
- * Indicates if the [Bot](#schema_bot) should be in always alive mode
4915
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
5045
4916
  */
5046
- alwaysAlive: boolean;
4917
+ readmeUrl: string;
5047
4918
  /**
5048
- * Status of the bot
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
- status: "active" | "deploying";
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
- * Media files associated with the [Bot](#schema_bot)
4958
+ * Event Definition
5053
4959
  */
5054
- medias: {
4960
+ [k: string]: {
5055
4961
  /**
5056
- * URL of the media file
4962
+ * Title of the event
5057
4963
  */
5058
- url: string;
4964
+ title?: string;
5059
4965
  /**
5060
- * Name of the media file
4966
+ * Description of the event
5061
4967
  */
5062
- name: string;
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
- * URL of the [Bot](#schema_bot); Only available for dev bots
4992
+ * Subscriptions of the bot
5077
4993
  */
5078
- url?: string;
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
- * Type of the [Bot](#schema_bot) authentication (`iam`)
5003
+ * Actions definition
5081
5004
  */
5082
- authentication?: "iam";
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
- } | null;
5066
+ };
5123
5067
  };
5124
5068
  };
5125
- message?: {
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
- } | null;
5083
+ };
5140
5084
  };
5141
5085
  };
5142
- conversation?: {
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
- } | null;
5100
+ };
5157
5101
  };
5158
5102
  };
5159
- events?: {
5160
- [k: string]: {
5161
- /**
5162
- * Title of the event
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
- layers?: string[];
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 UpdateBotInput$1 = UpdateBotRequestBody$1 & UpdateBotRequestHeaders$1 & UpdateBotRequestQuery$1 & UpdateBotRequestParams$1;
5274
- interface UpdateBotResponse$1 {
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 TransferBotRequestHeaders$1 {
5449
+ interface UpdateBotRequestHeaders$1 {
5590
5450
  }
5591
- interface TransferBotRequestQuery$1 {
5451
+ interface UpdateBotRequestQuery$1 {
5592
5452
  }
5593
- interface TransferBotRequestParams$1 {
5453
+ interface UpdateBotRequestParams$1 {
5594
5454
  id: string;
5595
5455
  }
5596
- interface TransferBotRequestBody$1 {
5456
+ interface UpdateBotRequestBody$1 {
5597
5457
  /**
5598
- * The ID of the workspace you want to transfer the bot to.
5458
+ * URL of the [Bot](#schema_bot); Only available for dev bots
5599
5459
  */
5600
- targetWorkspaceId: string;
5601
- }
5602
- type TransferBotInput$1 = TransferBotRequestBody$1 & TransferBotRequestHeaders$1 & TransferBotRequestQuery$1 & TransferBotRequestParams$1;
5603
- interface TransferBotResponse$1 {
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
- * Tags of [Bot](#schema_bot)
5467
+ * Configuration data
5640
5468
  */
5641
- tags: {
5642
- [k: string]: string;
5469
+ data?: {
5470
+ [k: string]: any;
5643
5471
  };
5644
- }[];
5645
- meta: {
5646
5472
  /**
5647
- * 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.
5473
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
5648
5474
  */
5649
- nextToken?: string;
5475
+ schema?: {
5476
+ [k: string]: any;
5477
+ };
5650
5478
  };
5651
- }
5652
-
5653
- interface GetBotRequestHeaders$1 {
5654
- }
5655
- interface GetBotRequestQuery$1 {
5656
- }
5657
- interface GetBotRequestParams$1 {
5658
- id: string;
5659
- }
5660
- interface GetBotRequestBody$1 {
5661
- }
5662
- type GetBotInput$1 = GetBotRequestBody$1 & GetBotRequestHeaders$1 & GetBotRequestQuery$1 & GetBotRequestParams$1;
5663
- interface GetBotResponse$1 {
5664
- bot: {
5665
- /**
5666
- * Id of the [Bot](#schema_bot)
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
- * Name of the [Integration](#schema_integration)
5497
+ * Title of the tag
5689
5498
  */
5690
- name: string;
5499
+ title?: string;
5691
5500
  /**
5692
- * Version of the [Integration](#schema_integration)
5501
+ * Description of the tag
5693
5502
  */
5694
- version: string;
5695
- webhookUrl: string;
5696
- webhookId: string;
5697
- identifier?: string;
5698
- configurationType: string | null;
5699
- configuration: {
5700
- [k: string]: any;
5701
- };
5702
- status: "registration_pending" | "registered" | "registration_failed" | "unregistration_pending" | "unregistered" | "unregistration_failed";
5703
- statusReason: string | null;
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
- * ID of the [Integration](#schema_integration)
5514
+ * Title of the tag
5706
5515
  */
5707
- id: string;
5516
+ title?: string;
5708
5517
  /**
5709
- * Creation date of the [Integration](#schema_integration) in ISO 8601 format
5518
+ * Description of the tag
5710
5519
  */
5711
- createdAt: string;
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
- * Updating date of the [Integration](#schema_integration) in ISO 8601 format
5531
+ * Title of the tag
5714
5532
  */
5715
- updatedAt: string;
5533
+ title?: string;
5716
5534
  /**
5717
- * Title of the integration. This is the name that will be displayed in the UI
5535
+ * Description of the tag
5718
5536
  */
5719
- title: string;
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 DeleteBotRequestHeaders$1 {
5971
+ interface TransferBotRequestHeaders$1 {
5979
5972
  }
5980
- interface DeleteBotRequestQuery$1 {
5973
+ interface TransferBotRequestQuery$1 {
5981
5974
  }
5982
- interface DeleteBotRequestParams$1 {
5975
+ interface TransferBotRequestParams$1 {
5983
5976
  id: string;
5984
5977
  }
5985
- interface DeleteBotRequestBody$1 {
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 DeleteBotInput$1 = DeleteBotRequestBody$1 & DeleteBotRequestHeaders$1 & DeleteBotRequestQuery$1 & DeleteBotRequestParams$1;
5988
- interface DeleteBotResponse$1 {
5984
+ type TransferBotInput$1 = TransferBotRequestBody$1 & TransferBotRequestHeaders$1 & TransferBotRequestQuery$1 & TransferBotRequestParams$1;
5985
+ interface TransferBotResponse$1 {
5989
5986
  }
5990
5987
 
5991
- interface GetBotLogsRequestHeaders$1 {
5988
+ interface ListBotsRequestHeaders$1 {
5992
5989
  }
5993
- interface GetBotLogsRequestQuery$1 {
5994
- timeStart: string;
5995
- timeEnd?: string;
5996
- level?: string;
5997
- userId?: string;
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 GetBotLogsRequestParams$1 {
6003
- id: string;
5999
+ interface ListBotsRequestParams$1 {
6004
6000
  }
6005
- interface GetBotLogsRequestBody$1 {
6001
+ interface ListBotsRequestBody$1 {
6006
6002
  }
6007
- type GetBotLogsInput$1 = GetBotLogsRequestBody$1 & GetBotLogsRequestHeaders$1 & GetBotLogsRequestQuery$1 & GetBotLogsRequestParams$1;
6008
- interface GetBotLogsResponse$1 {
6009
- logs: {
6010
- timestamp: string;
6011
- level: string;
6012
- message: string;
6013
- workflowId?: string;
6014
- userId?: string;
6015
- conversationId?: string;
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
- nextToken?: string;
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 GetBotWebchatRequestHeaders$1 {
6035
+ interface GetBotRequestHeaders$1 {
6021
6036
  }
6022
- interface GetBotWebchatRequestQuery$1 {
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 GetBotAnalyticsRequestParams$1 {
6039
+ interface GetBotRequestParams$1 {
6042
6040
  id: string;
6043
6041
  }
6044
- interface GetBotAnalyticsRequestBody$1 {
6042
+ interface GetBotRequestBody$1 {
6045
6043
  }
6046
- type GetBotAnalyticsInput$1 = GetBotAnalyticsRequestBody$1 & GetBotAnalyticsRequestHeaders$1 & GetBotAnalyticsRequestQuery$1 & GetBotAnalyticsRequestParams$1;
6047
- interface GetBotAnalyticsResponse$1 {
6048
- records: {
6044
+ type GetBotInput$1 = GetBotRequestBody$1 & GetBotRequestHeaders$1 & GetBotRequestQuery$1 & GetBotRequestParams$1;
6045
+ interface GetBotResponse$1 {
6046
+ bot: {
6049
6047
  /**
6050
- * ISO 8601 date string of the beginning (inclusive) of the period
6048
+ * Id of the [Bot](#schema_bot)
6051
6049
  */
6052
- startDateTimeUtc: string;
6050
+ id: string;
6053
6051
  /**
6054
- * ISO 8601 date string of the end (exclusive) of the period
6052
+ * Creation date of the [Bot](#schema_bot) in ISO 8601 format
6055
6053
  */
6056
- endDateTimeUtc: string;
6057
- returningUsers: number;
6058
- newUsers: number;
6059
- sessions: number;
6054
+ createdAt: string;
6060
6055
  /**
6061
- * Deprecated. Use `userMessages` instead.
6056
+ * Updating date of the [Bot](#schema_bot) in ISO 8601 format
6062
6057
  */
6063
- messages: number;
6064
- userMessages: number;
6065
- botMessages: number;
6066
- events: number;
6067
- eventTypes: {
6068
- [k: string]: number;
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
- customEvents: {
6071
- [k: string]: number;
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
- llm: {
6074
- calls: number;
6075
- errors: number;
6076
- inputTokens: number;
6077
- outputTokens: number;
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
- * The time it took for the LLM to complete its response. Values are expressed in milliseconds
6206
+ * Configuration data
6080
6207
  */
6081
- latency: {
6082
- mean: number;
6083
- sd: number;
6084
- min: number;
6085
- max: number;
6208
+ data: {
6209
+ [k: string]: any;
6086
6210
  };
6087
6211
  /**
6088
- * LLM response generation speed expressed in output tokens per second.
6212
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
6089
6213
  */
6090
- tokensPerSecond: {
6091
- mean: number;
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
- * Values are expressed in U.S. dollars
6223
+ * Event Definition
6098
6224
  */
6099
- cost: {
6100
- sum: number;
6101
- mean: number;
6102
- sd: number;
6103
- min: number;
6104
- max: number;
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
- interface GetBotIssueRequestHeaders$1 {
6111
- }
6112
- interface GetBotIssueRequestQuery$1 {
6113
- }
6114
- interface GetBotIssueRequestParams$1 {
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
  }
@@ -18426,13 +18829,432 @@ interface ListPublicIntegrationsResponse {
18426
18829
  */
18427
18830
  version: string;
18428
18831
  /**
18429
- * Creation date of the [Integration](#schema_integration) in ISO 8601 format
18832
+ * Creation date of the [Integration](#schema_integration) in ISO 8601 format
18833
+ */
18834
+ createdAt: string;
18835
+ /**
18836
+ * Updating date of the [Integration](#schema_integration) in ISO 8601 format
18837
+ */
18838
+ updatedAt: string;
18839
+ /**
18840
+ * Title of the integration. This is the name that will be displayed in the UI
18841
+ */
18842
+ title: string;
18843
+ /**
18844
+ * Description of the integration. This is the description that will be displayed in the UI
18845
+ */
18846
+ description: string;
18847
+ /**
18848
+ * URL of the icon of the integration. This is the icon that will be displayed in the UI
18849
+ */
18850
+ iconUrl: string;
18851
+ /**
18852
+ * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
18853
+ */
18854
+ public: boolean;
18855
+ /**
18856
+ * Status of the integration version verification
18857
+ */
18858
+ verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
18859
+ ownerWorkspace: {
18860
+ id: string;
18861
+ handle: string | null;
18862
+ name: string;
18863
+ };
18864
+ meta: {
18865
+ installs: number;
18866
+ views: number;
18867
+ };
18868
+ /**
18869
+ * Metadata about which fields matched the search criteria
18870
+ */
18871
+ matchedOn?: {
18872
+ /**
18873
+ * Whether the integration name matched the search term
18874
+ */
18875
+ name?: boolean;
18876
+ /**
18877
+ * Whether the integration title matched the search term
18878
+ */
18879
+ title?: boolean;
18880
+ /**
18881
+ * Whether the integration description matched the search term
18882
+ */
18883
+ description?: boolean;
18884
+ /**
18885
+ * Action names that matched the search term
18886
+ */
18887
+ actions?: string[];
18888
+ /**
18889
+ * Interface names that matched the search term
18890
+ */
18891
+ interfaces?: string[];
18892
+ };
18893
+ }[];
18894
+ meta: {
18895
+ /**
18896
+ * 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.
18897
+ */
18898
+ nextToken?: string;
18899
+ };
18900
+ }
18901
+
18902
+ interface GetPublicIntegrationByIdRequestHeaders {
18903
+ }
18904
+ interface GetPublicIntegrationByIdRequestQuery {
18905
+ }
18906
+ interface GetPublicIntegrationByIdRequestParams {
18907
+ id: string;
18908
+ }
18909
+ interface GetPublicIntegrationByIdRequestBody {
18910
+ }
18911
+ type GetPublicIntegrationByIdInput = GetPublicIntegrationByIdRequestBody & GetPublicIntegrationByIdRequestHeaders & GetPublicIntegrationByIdRequestQuery & GetPublicIntegrationByIdRequestParams;
18912
+ interface GetPublicIntegrationByIdResponse {
18913
+ integration: {
18914
+ /**
18915
+ * ID of the [Integration](#schema_integration)
18916
+ */
18917
+ id: string;
18918
+ /**
18919
+ * Creation date of the [Integration](#schema_integration) in ISO 8601 format
18920
+ */
18921
+ createdAt: string;
18922
+ /**
18923
+ * Updating date of the [Integration](#schema_integration) in ISO 8601 format
18924
+ */
18925
+ updatedAt: string;
18926
+ /**
18927
+ * Global identifier configuration of the [Integration](#schema_integration)
18928
+ */
18929
+ identifier: {
18930
+ /**
18931
+ * VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
18932
+ */
18933
+ fallbackHandlerScript?: string;
18934
+ /**
18935
+ * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
18936
+ */
18937
+ extractScript?: string;
18938
+ };
18939
+ sandbox?: {
18940
+ /**
18941
+ * VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook used specifically for the sandbox
18942
+ */
18943
+ identifierExtractScript?: string;
18944
+ /**
18945
+ * VRL Script of the [Integration](#schema_integration) to extract the message from an incoming webhook used specifically for the sandbox
18946
+ */
18947
+ messageExtractScript?: string;
18948
+ };
18949
+ /**
18950
+ * URL of the [Integration](#schema_integration)
18951
+ */
18952
+ url: string;
18953
+ /**
18954
+ * Name of the [Integration](#schema_integration)
18955
+ */
18956
+ name: string;
18957
+ /**
18958
+ * Version of the [Integration](#schema_integration)
18959
+ */
18960
+ version: string;
18961
+ interfaces: {
18962
+ [k: string]: {
18963
+ /**
18964
+ * ID of the interface
18965
+ */
18966
+ id: string;
18967
+ /**
18968
+ * Name of the interface
18969
+ */
18970
+ name: string;
18971
+ /**
18972
+ * Version of the interface
18973
+ */
18974
+ version: string;
18975
+ entities: {
18976
+ [k: string]: {
18977
+ name: string;
18978
+ };
18979
+ };
18980
+ actions: {
18981
+ [k: string]: {
18982
+ name: string;
18983
+ };
18984
+ };
18985
+ events: {
18986
+ [k: string]: {
18987
+ name: string;
18988
+ };
18989
+ };
18990
+ channels: {
18991
+ [k: string]: {
18992
+ name: string;
18993
+ };
18994
+ };
18995
+ };
18996
+ };
18997
+ /**
18998
+ * Configuration definition
18999
+ */
19000
+ configuration: {
19001
+ /**
19002
+ * Title of the configuration
19003
+ */
19004
+ title?: string;
19005
+ /**
19006
+ * Description of the configuration
19007
+ */
19008
+ description?: string;
19009
+ /**
19010
+ * Identifier configuration of the [Integration](#schema_integration)
19011
+ */
19012
+ identifier: {
19013
+ linkTemplateScript?: string;
19014
+ required: boolean;
19015
+ };
19016
+ /**
19017
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
19018
+ */
19019
+ schema: {
19020
+ [k: string]: any;
19021
+ };
19022
+ };
19023
+ configurations: {
19024
+ /**
19025
+ * Configuration definition
19026
+ */
19027
+ [k: string]: {
19028
+ /**
19029
+ * Title of the configuration
19030
+ */
19031
+ title?: string;
19032
+ /**
19033
+ * Description of the configuration
19034
+ */
19035
+ description?: string;
19036
+ /**
19037
+ * Identifier configuration of the [Integration](#schema_integration)
19038
+ */
19039
+ identifier: {
19040
+ linkTemplateScript?: string;
19041
+ required: boolean;
19042
+ };
19043
+ /**
19044
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
19045
+ */
19046
+ schema: {
19047
+ [k: string]: any;
19048
+ };
19049
+ };
19050
+ };
19051
+ channels: {
19052
+ /**
19053
+ * Channel definition
19054
+ */
19055
+ [k: string]: {
19056
+ /**
19057
+ * Title of the channel
19058
+ */
19059
+ title?: string;
19060
+ /**
19061
+ * Description of the channel
19062
+ */
19063
+ description?: string;
19064
+ messages: {
19065
+ /**
19066
+ * Message definition
19067
+ */
19068
+ [k: string]: {
19069
+ schema: {
19070
+ [k: string]: any;
19071
+ };
19072
+ };
19073
+ };
19074
+ /**
19075
+ * Conversation object configuration
19076
+ */
19077
+ conversation: {
19078
+ tags: {
19079
+ /**
19080
+ * Definition of a tag that can be provided on the object
19081
+ */
19082
+ [k: string]: {
19083
+ /**
19084
+ * Title of the tag
19085
+ */
19086
+ title?: string;
19087
+ /**
19088
+ * Description of the tag
19089
+ */
19090
+ description?: string;
19091
+ };
19092
+ };
19093
+ /**
19094
+ * 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.
19095
+ */
19096
+ creation: {
19097
+ /**
19098
+ * Enable conversation creation
19099
+ */
19100
+ enabled: boolean;
19101
+ /**
19102
+ * The list of tags that are required to be specified when calling the API directly to create a conversation.
19103
+ */
19104
+ requiredTags: string[];
19105
+ };
19106
+ };
19107
+ /**
19108
+ * Message object configuration
19109
+ */
19110
+ message: {
19111
+ tags: {
19112
+ /**
19113
+ * Definition of a tag that can be provided on the object
19114
+ */
19115
+ [k: string]: {
19116
+ /**
19117
+ * Title of the tag
19118
+ */
19119
+ title?: string;
19120
+ /**
19121
+ * Description of the tag
19122
+ */
19123
+ description?: string;
19124
+ };
19125
+ };
19126
+ };
19127
+ };
19128
+ };
19129
+ states: {
19130
+ /**
19131
+ * State definition
19132
+ */
19133
+ [k: string]: {
19134
+ /**
19135
+ * Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
19136
+ */
19137
+ type: "conversation" | "user" | "integration";
19138
+ /**
19139
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
19140
+ */
19141
+ schema: {
19142
+ [k: string]: any;
19143
+ };
19144
+ };
19145
+ };
19146
+ events: {
19147
+ /**
19148
+ * Event Definition
19149
+ */
19150
+ [k: string]: {
19151
+ /**
19152
+ * Title of the event
19153
+ */
19154
+ title?: string;
19155
+ /**
19156
+ * Description of the event
19157
+ */
19158
+ description?: string;
19159
+ schema: {
19160
+ [k: string]: any;
19161
+ };
19162
+ /**
19163
+ * Optional attributes
19164
+ */
19165
+ attributes?: {
19166
+ [k: string]: string;
19167
+ };
19168
+ };
19169
+ };
19170
+ actions: {
19171
+ /**
19172
+ * Action definition
19173
+ */
19174
+ [k: string]: {
19175
+ /**
19176
+ * Title of the action
19177
+ */
19178
+ title?: string;
19179
+ /**
19180
+ * Description of the action
19181
+ */
19182
+ description?: string;
19183
+ billable?: boolean;
19184
+ cacheable?: boolean;
19185
+ input: {
19186
+ schema: {
19187
+ [k: string]: any;
19188
+ };
19189
+ };
19190
+ output: {
19191
+ schema: {
19192
+ [k: string]: any;
19193
+ };
19194
+ };
19195
+ /**
19196
+ * Optional attributes
19197
+ */
19198
+ attributes?: {
19199
+ [k: string]: string;
19200
+ };
19201
+ };
19202
+ };
19203
+ /**
19204
+ * User object configuration
18430
19205
  */
18431
- createdAt: string;
19206
+ user: {
19207
+ tags: {
19208
+ /**
19209
+ * Definition of a tag that can be provided on the object
19210
+ */
19211
+ [k: string]: {
19212
+ /**
19213
+ * Title of the tag
19214
+ */
19215
+ title?: string;
19216
+ /**
19217
+ * Description of the tag
19218
+ */
19219
+ description?: string;
19220
+ };
19221
+ };
19222
+ /**
19223
+ * 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.
19224
+ */
19225
+ creation: {
19226
+ /**
19227
+ * Enable user creation
19228
+ */
19229
+ enabled: boolean;
19230
+ /**
19231
+ * The list of tags that are required to be specified when calling the API directly to create a user.
19232
+ */
19233
+ requiredTags: string[];
19234
+ };
19235
+ };
19236
+ entities: {
19237
+ /**
19238
+ * Entity definition
19239
+ */
19240
+ [k: string]: {
19241
+ /**
19242
+ * Title of the entity
19243
+ */
19244
+ title?: string;
19245
+ /**
19246
+ * Description of the entity
19247
+ */
19248
+ description?: string;
19249
+ schema: {
19250
+ [k: string]: any;
19251
+ };
19252
+ };
19253
+ };
18432
19254
  /**
18433
- * Updating date of the [Integration](#schema_integration) in ISO 8601 format
19255
+ * Indicates if the integration is a development integration; Dev integrations run locally
18434
19256
  */
18435
- updatedAt: string;
19257
+ dev: boolean;
18436
19258
  /**
18437
19259
  * Title of the integration. This is the name that will be displayed in the UI
18438
19260
  */
@@ -18445,6 +19267,10 @@ interface ListPublicIntegrationsResponse {
18445
19267
  * URL of the icon of the integration. This is the icon that will be displayed in the UI
18446
19268
  */
18447
19269
  iconUrl: string;
19270
+ /**
19271
+ * URL of the readme of the integration. This is the readme that will be displayed in the UI
19272
+ */
19273
+ readmeUrl: string;
18448
19274
  /**
18449
19275
  * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
18450
19276
  */
@@ -18453,6 +19279,10 @@ interface ListPublicIntegrationsResponse {
18453
19279
  * Status of the integration version verification
18454
19280
  */
18455
19281
  verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
19282
+ /**
19283
+ * 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.
19284
+ */
19285
+ secrets: string[];
18456
19286
  ownerWorkspace: {
18457
19287
  id: string;
18458
19288
  handle: string | null;
@@ -18462,51 +19292,21 @@ interface ListPublicIntegrationsResponse {
18462
19292
  installs: number;
18463
19293
  views: number;
18464
19294
  };
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
19295
  };
18497
19296
  }
18498
19297
 
18499
- interface GetPublicIntegrationByIdRequestHeaders {
19298
+ interface GetPublicIntegrationRequestHeaders {
18500
19299
  }
18501
- interface GetPublicIntegrationByIdRequestQuery {
19300
+ interface GetPublicIntegrationRequestQuery {
18502
19301
  }
18503
- interface GetPublicIntegrationByIdRequestParams {
18504
- id: string;
19302
+ interface GetPublicIntegrationRequestParams {
19303
+ name: string;
19304
+ version: string;
18505
19305
  }
18506
- interface GetPublicIntegrationByIdRequestBody {
19306
+ interface GetPublicIntegrationRequestBody {
18507
19307
  }
18508
- type GetPublicIntegrationByIdInput = GetPublicIntegrationByIdRequestBody & GetPublicIntegrationByIdRequestHeaders & GetPublicIntegrationByIdRequestQuery & GetPublicIntegrationByIdRequestParams;
18509
- interface GetPublicIntegrationByIdResponse {
19308
+ type GetPublicIntegrationInput = GetPublicIntegrationRequestBody & GetPublicIntegrationRequestHeaders & GetPublicIntegrationRequestQuery & GetPublicIntegrationRequestParams;
19309
+ interface GetPublicIntegrationResponse {
18510
19310
  integration: {
18511
19311
  /**
18512
19312
  * ID of the [Integration](#schema_integration)
@@ -18892,102 +19692,101 @@ interface GetPublicIntegrationByIdResponse {
18892
19692
  };
18893
19693
  }
18894
19694
 
18895
- interface GetPublicIntegrationRequestHeaders {
19695
+ interface ListPublicPluginsRequestHeaders {
18896
19696
  }
18897
- interface GetPublicIntegrationRequestQuery {
19697
+ interface ListPublicPluginsRequestQuery {
19698
+ nextToken?: string;
19699
+ name?: string;
19700
+ version?: string;
18898
19701
  }
18899
- interface GetPublicIntegrationRequestParams {
18900
- name: string;
18901
- version: string;
19702
+ interface ListPublicPluginsRequestParams {
19703
+ }
19704
+ interface ListPublicPluginsRequestBody {
19705
+ }
19706
+ type ListPublicPluginsInput = ListPublicPluginsRequestBody & ListPublicPluginsRequestHeaders & ListPublicPluginsRequestQuery & ListPublicPluginsRequestParams;
19707
+ interface ListPublicPluginsResponse {
19708
+ plugins: {
19709
+ /**
19710
+ * ID of the [Plugin](#schema_plugin)
19711
+ */
19712
+ id: string;
19713
+ /**
19714
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
19715
+ */
19716
+ createdAt: string;
19717
+ /**
19718
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
19719
+ */
19720
+ updatedAt: string;
19721
+ /**
19722
+ * Name of the [Plugin](#schema_plugin)
19723
+ */
19724
+ name: string;
19725
+ /**
19726
+ * Version of the [Plugin](#schema_plugin)
19727
+ */
19728
+ version: string;
19729
+ /**
19730
+ * Title of the plugin. This is the name that will be displayed in the UI
19731
+ */
19732
+ title: string;
19733
+ /**
19734
+ * Description of the plugin. This is the description that will be displayed in the UI
19735
+ */
19736
+ description: string;
19737
+ /**
19738
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
19739
+ */
19740
+ iconUrl: string;
19741
+ /**
19742
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
19743
+ */
19744
+ readmeUrl: string;
19745
+ /**
19746
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
19747
+ */
19748
+ public: boolean;
19749
+ }[];
19750
+ meta: {
19751
+ /**
19752
+ * 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.
19753
+ */
19754
+ nextToken?: string;
19755
+ };
19756
+ }
19757
+
19758
+ interface GetPublicPluginByIdRequestHeaders {
19759
+ }
19760
+ interface GetPublicPluginByIdRequestQuery {
19761
+ }
19762
+ interface GetPublicPluginByIdRequestParams {
19763
+ id: string;
18902
19764
  }
18903
- interface GetPublicIntegrationRequestBody {
19765
+ interface GetPublicPluginByIdRequestBody {
18904
19766
  }
18905
- type GetPublicIntegrationInput = GetPublicIntegrationRequestBody & GetPublicIntegrationRequestHeaders & GetPublicIntegrationRequestQuery & GetPublicIntegrationRequestParams;
18906
- interface GetPublicIntegrationResponse {
18907
- integration: {
19767
+ type GetPublicPluginByIdInput = GetPublicPluginByIdRequestBody & GetPublicPluginByIdRequestHeaders & GetPublicPluginByIdRequestQuery & GetPublicPluginByIdRequestParams;
19768
+ interface GetPublicPluginByIdResponse {
19769
+ plugin: {
18908
19770
  /**
18909
- * ID of the [Integration](#schema_integration)
19771
+ * ID of the [Plugin](#schema_plugin)
18910
19772
  */
18911
19773
  id: string;
18912
19774
  /**
18913
- * Creation date of the [Integration](#schema_integration) in ISO 8601 format
18914
- */
18915
- createdAt: string;
18916
- /**
18917
- * Updating date of the [Integration](#schema_integration) in ISO 8601 format
18918
- */
18919
- updatedAt: string;
18920
- /**
18921
- * Global identifier configuration of the [Integration](#schema_integration)
19775
+ * Name of the [Plugin](#schema_plugin)
18922
19776
  */
18923
- identifier: {
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
- };
19777
+ name: string;
18943
19778
  /**
18944
- * URL of the [Integration](#schema_integration)
19779
+ * Version of the [Plugin](#schema_plugin)
18945
19780
  */
18946
- url: string;
19781
+ version: string;
18947
19782
  /**
18948
- * Name of the [Integration](#schema_integration)
19783
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
18949
19784
  */
18950
- name: string;
19785
+ createdAt: string;
18951
19786
  /**
18952
- * Version of the [Integration](#schema_integration)
19787
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
18953
19788
  */
18954
- version: string;
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
- };
19789
+ updatedAt: string;
18991
19790
  /**
18992
19791
  * Configuration definition
18993
19792
  */
@@ -19000,13 +19799,6 @@ interface GetPublicIntegrationResponse {
19000
19799
  * Description of the configuration
19001
19800
  */
19002
19801
  description?: string;
19003
- /**
19004
- * Identifier configuration of the [Integration](#schema_integration)
19005
- */
19006
- identifier: {
19007
- linkTemplateScript?: string;
19008
- required: boolean;
19009
- };
19010
19802
  /**
19011
19803
  * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
19012
19804
  */
@@ -19014,127 +19806,228 @@ interface GetPublicIntegrationResponse {
19014
19806
  [k: string]: any;
19015
19807
  };
19016
19808
  };
19017
- configurations: {
19809
+ states: {
19810
+ [k: string]: {
19811
+ /**
19812
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
19813
+ */
19814
+ type: "conversation" | "user" | "bot" | "task";
19815
+ /**
19816
+ * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
19817
+ */
19818
+ schema: {
19819
+ [k: string]: any;
19820
+ };
19821
+ /**
19822
+ * 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.
19823
+ */
19824
+ expiry?: number;
19825
+ };
19826
+ };
19827
+ events: {
19018
19828
  /**
19019
- * Configuration definition
19829
+ * Event Definition
19020
19830
  */
19021
19831
  [k: string]: {
19022
19832
  /**
19023
- * Title of the configuration
19833
+ * Title of the event
19024
19834
  */
19025
19835
  title?: string;
19026
19836
  /**
19027
- * Description of the configuration
19837
+ * Description of the event
19028
19838
  */
19029
19839
  description?: string;
19030
- /**
19031
- * Identifier configuration of the [Integration](#schema_integration)
19032
- */
19033
- identifier: {
19034
- linkTemplateScript?: string;
19035
- required: boolean;
19840
+ schema: {
19841
+ [k: string]: any;
19036
19842
  };
19037
19843
  /**
19038
- * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
19844
+ * Optional attributes
19039
19845
  */
19040
- schema: {
19041
- [k: string]: any;
19846
+ attributes?: {
19847
+ [k: string]: string;
19042
19848
  };
19043
19849
  };
19044
19850
  };
19045
- channels: {
19851
+ actions: {
19046
19852
  /**
19047
- * Channel definition
19853
+ * Action definition
19048
19854
  */
19049
19855
  [k: string]: {
19050
19856
  /**
19051
- * Title of the channel
19857
+ * Title of the action
19052
19858
  */
19053
19859
  title?: string;
19054
19860
  /**
19055
- * Description of the channel
19861
+ * Description of the action
19056
19862
  */
19057
19863
  description?: string;
19058
- messages: {
19059
- /**
19060
- * Message definition
19061
- */
19062
- [k: string]: {
19063
- schema: {
19064
- [k: string]: any;
19065
- };
19864
+ billable?: boolean;
19865
+ cacheable?: boolean;
19866
+ input: {
19867
+ schema: {
19868
+ [k: string]: any;
19869
+ };
19870
+ };
19871
+ output: {
19872
+ schema: {
19873
+ [k: string]: any;
19066
19874
  };
19067
19875
  };
19068
19876
  /**
19069
- * Conversation object configuration
19877
+ * Optional attributes
19070
19878
  */
19071
- conversation: {
19072
- tags: {
19073
- /**
19074
- * Definition of a tag that can be provided on the object
19075
- */
19076
- [k: string]: {
19077
- /**
19078
- * Title of the tag
19079
- */
19080
- title?: string;
19081
- /**
19082
- * Description of the tag
19083
- */
19084
- description?: string;
19085
- };
19086
- };
19879
+ attributes?: {
19880
+ [k: string]: string;
19881
+ };
19882
+ };
19883
+ };
19884
+ dependencies: {
19885
+ interfaces: {
19886
+ [k: string]: {
19887
+ id: string;
19888
+ name: string;
19889
+ version: string;
19890
+ };
19891
+ };
19892
+ integrations: {
19893
+ [k: string]: {
19894
+ id: string;
19895
+ name: string;
19896
+ version: string;
19897
+ };
19898
+ };
19899
+ };
19900
+ /**
19901
+ * User object configuration
19902
+ */
19903
+ user: {
19904
+ tags: {
19905
+ /**
19906
+ * Definition of a tag that can be provided on the object
19907
+ */
19908
+ [k: string]: {
19087
19909
  /**
19088
- * 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.
19910
+ * Title of the tag
19089
19911
  */
19090
- creation: {
19091
- /**
19092
- * Enable conversation creation
19093
- */
19094
- enabled: boolean;
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
- };
19912
+ title?: string;
19913
+ /**
19914
+ * Description of the tag
19915
+ */
19916
+ description?: string;
19100
19917
  };
19918
+ };
19919
+ };
19920
+ /**
19921
+ * Conversation object configuration
19922
+ */
19923
+ conversation: {
19924
+ tags: {
19101
19925
  /**
19102
- * Message object configuration
19926
+ * Definition of a tag that can be provided on the object
19103
19927
  */
19104
- message: {
19105
- tags: {
19106
- /**
19107
- * Definition of a tag that can be provided on the object
19108
- */
19109
- [k: string]: {
19110
- /**
19111
- * Title of the tag
19112
- */
19113
- title?: string;
19114
- /**
19115
- * Description of the tag
19116
- */
19117
- description?: string;
19118
- };
19119
- };
19928
+ [k: string]: {
19929
+ /**
19930
+ * Title of the tag
19931
+ */
19932
+ title?: string;
19933
+ /**
19934
+ * Description of the tag
19935
+ */
19936
+ description?: string;
19120
19937
  };
19121
19938
  };
19122
19939
  };
19123
- states: {
19940
+ /**
19941
+ * Title of the plugin. This is the name that will be displayed in the UI
19942
+ */
19943
+ title: string;
19944
+ /**
19945
+ * Description of the plugin. This is the description that will be displayed in the UI
19946
+ */
19947
+ description: string;
19948
+ /**
19949
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
19950
+ */
19951
+ iconUrl: string;
19952
+ /**
19953
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
19954
+ */
19955
+ readmeUrl: string;
19956
+ /**
19957
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
19958
+ */
19959
+ public: boolean;
19960
+ };
19961
+ }
19962
+
19963
+ interface GetPublicPluginRequestHeaders {
19964
+ }
19965
+ interface GetPublicPluginRequestQuery {
19966
+ }
19967
+ interface GetPublicPluginRequestParams {
19968
+ name: string;
19969
+ version: string;
19970
+ }
19971
+ interface GetPublicPluginRequestBody {
19972
+ }
19973
+ type GetPublicPluginInput = GetPublicPluginRequestBody & GetPublicPluginRequestHeaders & GetPublicPluginRequestQuery & GetPublicPluginRequestParams;
19974
+ interface GetPublicPluginResponse {
19975
+ plugin: {
19976
+ /**
19977
+ * ID of the [Plugin](#schema_plugin)
19978
+ */
19979
+ id: string;
19980
+ /**
19981
+ * Name of the [Plugin](#schema_plugin)
19982
+ */
19983
+ name: string;
19984
+ /**
19985
+ * Version of the [Plugin](#schema_plugin)
19986
+ */
19987
+ version: string;
19988
+ /**
19989
+ * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
19990
+ */
19991
+ createdAt: string;
19992
+ /**
19993
+ * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
19994
+ */
19995
+ updatedAt: string;
19996
+ /**
19997
+ * Configuration definition
19998
+ */
19999
+ configuration: {
19124
20000
  /**
19125
- * State definition
20001
+ * Title of the configuration
20002
+ */
20003
+ title?: string;
20004
+ /**
20005
+ * Description of the configuration
20006
+ */
20007
+ description?: string;
20008
+ /**
20009
+ * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
19126
20010
  */
20011
+ schema: {
20012
+ [k: string]: any;
20013
+ };
20014
+ };
20015
+ states: {
19127
20016
  [k: string]: {
19128
20017
  /**
19129
- * Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
20018
+ * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
19130
20019
  */
19131
- type: "conversation" | "user" | "integration";
20020
+ type: "conversation" | "user" | "bot" | "task";
19132
20021
  /**
19133
20022
  * 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
20023
  */
19135
20024
  schema: {
19136
20025
  [k: string]: any;
19137
20026
  };
20027
+ /**
20028
+ * 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.
20029
+ */
20030
+ expiry?: number;
19138
20031
  };
19139
20032
  };
19140
20033
  events: {
@@ -19194,6 +20087,22 @@ interface GetPublicIntegrationResponse {
19194
20087
  };
19195
20088
  };
19196
20089
  };
20090
+ dependencies: {
20091
+ interfaces: {
20092
+ [k: string]: {
20093
+ id: string;
20094
+ name: string;
20095
+ version: string;
20096
+ };
20097
+ };
20098
+ integrations: {
20099
+ [k: string]: {
20100
+ id: string;
20101
+ name: string;
20102
+ version: string;
20103
+ };
20104
+ };
20105
+ };
19197
20106
  /**
19198
20107
  * User object configuration
19199
20108
  */
@@ -19213,134 +20122,117 @@ interface GetPublicIntegrationResponse {
19213
20122
  description?: string;
19214
20123
  };
19215
20124
  };
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
20125
  };
19230
- entities: {
19231
- /**
19232
- * Entity definition
19233
- */
19234
- [k: string]: {
19235
- /**
19236
- * Title of the entity
19237
- */
19238
- title?: string;
20126
+ /**
20127
+ * Conversation object configuration
20128
+ */
20129
+ conversation: {
20130
+ tags: {
19239
20131
  /**
19240
- * Description of the entity
20132
+ * Definition of a tag that can be provided on the object
19241
20133
  */
19242
- description?: string;
19243
- schema: {
19244
- [k: string]: any;
20134
+ [k: string]: {
20135
+ /**
20136
+ * Title of the tag
20137
+ */
20138
+ title?: string;
20139
+ /**
20140
+ * Description of the tag
20141
+ */
20142
+ description?: string;
19245
20143
  };
19246
20144
  };
19247
20145
  };
19248
20146
  /**
19249
- * Indicates if the integration is a development integration; Dev integrations run locally
19250
- */
19251
- dev: boolean;
19252
- /**
19253
- * Title of the integration. This is the name that will be displayed in the UI
20147
+ * Title of the plugin. This is the name that will be displayed in the UI
19254
20148
  */
19255
20149
  title: string;
19256
20150
  /**
19257
- * Description of the integration. This is the description that will be displayed in the UI
20151
+ * Description of the plugin. This is the description that will be displayed in the UI
19258
20152
  */
19259
20153
  description: string;
19260
20154
  /**
19261
- * URL of the icon of the integration. This is the icon that will be displayed in the UI
20155
+ * URL of the icon of the plugin. This is the icon that will be displayed in the UI
19262
20156
  */
19263
20157
  iconUrl: string;
19264
20158
  /**
19265
- * URL of the readme of the integration. This is the readme that will be displayed in the UI
20159
+ * URL of the readme of the plugin. This is the readme that will be displayed in the UI
19266
20160
  */
19267
20161
  readmeUrl: string;
19268
20162
  /**
19269
- * Indicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
20163
+ * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
19270
20164
  */
19271
20165
  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
20166
  };
19290
20167
  }
19291
20168
 
19292
- interface ListPublicPluginsRequestHeaders {
20169
+ interface GetPublicPluginCodeRequestHeaders {
19293
20170
  }
19294
- interface ListPublicPluginsRequestQuery {
20171
+ interface GetPublicPluginCodeRequestQuery {
20172
+ }
20173
+ interface GetPublicPluginCodeRequestParams {
20174
+ id: string;
20175
+ platform: "node" | "browser";
20176
+ }
20177
+ interface GetPublicPluginCodeRequestBody {
20178
+ }
20179
+ type GetPublicPluginCodeInput = GetPublicPluginCodeRequestBody & GetPublicPluginCodeRequestHeaders & GetPublicPluginCodeRequestQuery & GetPublicPluginCodeRequestParams;
20180
+ interface GetPublicPluginCodeResponse {
20181
+ code: string;
20182
+ }
20183
+
20184
+ interface ListPublicInterfacesRequestHeaders {
20185
+ }
20186
+ interface ListPublicInterfacesRequestQuery {
19295
20187
  nextToken?: string;
19296
20188
  name?: string;
19297
20189
  version?: string;
19298
20190
  }
19299
- interface ListPublicPluginsRequestParams {
20191
+ interface ListPublicInterfacesRequestParams {
19300
20192
  }
19301
- interface ListPublicPluginsRequestBody {
20193
+ interface ListPublicInterfacesRequestBody {
19302
20194
  }
19303
- type ListPublicPluginsInput = ListPublicPluginsRequestBody & ListPublicPluginsRequestHeaders & ListPublicPluginsRequestQuery & ListPublicPluginsRequestParams;
19304
- interface ListPublicPluginsResponse {
19305
- plugins: {
20195
+ type ListPublicInterfacesInput = ListPublicInterfacesRequestBody & ListPublicInterfacesRequestHeaders & ListPublicInterfacesRequestQuery & ListPublicInterfacesRequestParams;
20196
+ interface ListPublicInterfacesResponse {
20197
+ interfaces: {
19306
20198
  /**
19307
- * ID of the [Plugin](#schema_plugin)
20199
+ * ID of the [Interface](#schema_interface)
19308
20200
  */
19309
20201
  id: string;
19310
20202
  /**
19311
- * Creation date of the [Plugin](#schema_plugin) in ISO 8601 format
20203
+ * Creation date of the [Interface](#schema_interface) in ISO 8601 format
19312
20204
  */
19313
20205
  createdAt: string;
19314
20206
  /**
19315
- * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
20207
+ * Updating date of the [Interface](#schema_interface) in ISO 8601 format
19316
20208
  */
19317
20209
  updatedAt: string;
19318
20210
  /**
19319
- * Name of the [Plugin](#schema_plugin)
20211
+ * Name of the [Interface](#schema_interface)
19320
20212
  */
19321
20213
  name: string;
19322
20214
  /**
19323
- * Version of the [Plugin](#schema_plugin)
20215
+ * Version of the [Interface](#schema_interface)
19324
20216
  */
19325
20217
  version: string;
19326
20218
  /**
19327
- * Title of the plugin. This is the name that will be displayed in the UI
20219
+ * Title of the interface. This is the name that will be displayed in the UI
19328
20220
  */
19329
20221
  title: string;
19330
20222
  /**
19331
- * Description of the plugin. This is the description that will be displayed in the UI
20223
+ * Description of the interface. This is the description that will be displayed in the UI
19332
20224
  */
19333
20225
  description: string;
19334
20226
  /**
19335
- * URL of the icon of the plugin. This is the icon that will be displayed in the UI
20227
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
19336
20228
  */
19337
20229
  iconUrl: string;
19338
20230
  /**
19339
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
20231
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
19340
20232
  */
19341
20233
  readmeUrl: string;
19342
20234
  /**
19343
- * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
20235
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
19344
20236
  */
19345
20237
  public: boolean;
19346
20238
  }[];
@@ -19352,73 +20244,54 @@ interface ListPublicPluginsResponse {
19352
20244
  };
19353
20245
  }
19354
20246
 
19355
- interface GetPublicPluginByIdRequestHeaders {
20247
+ interface GetPublicInterfaceByIdRequestHeaders {
19356
20248
  }
19357
- interface GetPublicPluginByIdRequestQuery {
20249
+ interface GetPublicInterfaceByIdRequestQuery {
19358
20250
  }
19359
- interface GetPublicPluginByIdRequestParams {
20251
+ interface GetPublicInterfaceByIdRequestParams {
19360
20252
  id: string;
19361
20253
  }
19362
- interface GetPublicPluginByIdRequestBody {
20254
+ interface GetPublicInterfaceByIdRequestBody {
19363
20255
  }
19364
- type GetPublicPluginByIdInput = GetPublicPluginByIdRequestBody & GetPublicPluginByIdRequestHeaders & GetPublicPluginByIdRequestQuery & GetPublicPluginByIdRequestParams;
19365
- interface GetPublicPluginByIdResponse {
19366
- plugin: {
20256
+ type GetPublicInterfaceByIdInput = GetPublicInterfaceByIdRequestBody & GetPublicInterfaceByIdRequestHeaders & GetPublicInterfaceByIdRequestQuery & GetPublicInterfaceByIdRequestParams;
20257
+ interface GetPublicInterfaceByIdResponse {
20258
+ interface: {
19367
20259
  /**
19368
- * ID of the [Plugin](#schema_plugin)
20260
+ * ID of the [Interface](#schema_interface)
19369
20261
  */
19370
20262
  id: string;
19371
20263
  /**
19372
- * Name of the [Plugin](#schema_plugin)
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
20264
+ * Creation date of the [Interface](#schema_interface) in ISO 8601 format
19381
20265
  */
19382
20266
  createdAt: string;
19383
20267
  /**
19384
- * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
20268
+ * Updating date of the [Interface](#schema_interface) in ISO 8601 format
19385
20269
  */
19386
20270
  updatedAt: string;
19387
- /**
19388
- * Configuration definition
19389
- */
19390
- configuration: {
19391
- /**
19392
- * Title of the configuration
19393
- */
19394
- title?: string;
19395
- /**
19396
- * Description of the configuration
19397
- */
19398
- description?: string;
20271
+ /**
20272
+ * Name of the [Interface](#schema_interface)
20273
+ */
20274
+ name: string;
20275
+ /**
20276
+ * Version of the [Interface](#schema_interface)
20277
+ */
20278
+ version: string;
20279
+ entities: {
19399
20280
  /**
19400
- * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
20281
+ * Entity definition
19401
20282
  */
19402
- schema: {
19403
- [k: string]: any;
19404
- };
19405
- };
19406
- states: {
19407
20283
  [k: string]: {
19408
20284
  /**
19409
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
20285
+ * Title of the entity
19410
20286
  */
19411
- type: "conversation" | "user" | "bot" | "task";
20287
+ title?: string;
19412
20288
  /**
19413
- * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
20289
+ * Description of the entity
19414
20290
  */
20291
+ description?: string;
19415
20292
  schema: {
19416
20293
  [k: string]: any;
19417
20294
  };
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
20295
  };
19423
20296
  };
19424
20297
  events: {
@@ -19478,153 +20351,107 @@ interface GetPublicPluginByIdResponse {
19478
20351
  };
19479
20352
  };
19480
20353
  };
19481
- dependencies: {
19482
- interfaces: {
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: {
20354
+ channels: {
20355
+ [k: string]: {
19502
20356
  /**
19503
- * Definition of a tag that can be provided on the object
20357
+ * Title of the channel
19504
20358
  */
19505
- [k: string]: {
19506
- /**
19507
- * Title of the tag
19508
- */
19509
- title?: string;
20359
+ title?: string;
20360
+ /**
20361
+ * Description of the channel
20362
+ */
20363
+ description?: string;
20364
+ messages: {
19510
20365
  /**
19511
- * Description of the tag
20366
+ * Message definition
19512
20367
  */
19513
- description?: string;
20368
+ [k: string]: {
20369
+ schema: {
20370
+ [k: string]: any;
20371
+ };
20372
+ };
19514
20373
  };
19515
20374
  };
19516
20375
  };
19517
20376
  /**
19518
- * Conversation object configuration
20377
+ * Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
19519
20378
  */
19520
- conversation: {
19521
- tags: {
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
- };
20379
+ nameTemplate?: {
20380
+ script: string;
20381
+ language: string;
19536
20382
  };
19537
20383
  /**
19538
- * Title of the plugin. This is the name that will be displayed in the UI
20384
+ * Title of the interface. This is the name that will be displayed in the UI
19539
20385
  */
19540
20386
  title: string;
19541
20387
  /**
19542
- * Description of the plugin. This is the description that will be displayed in the UI
20388
+ * Description of the interface. This is the description that will be displayed in the UI
19543
20389
  */
19544
20390
  description: string;
19545
20391
  /**
19546
- * URL of the icon of the plugin. This is the icon that will be displayed in the UI
20392
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
19547
20393
  */
19548
20394
  iconUrl: string;
19549
20395
  /**
19550
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
20396
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
19551
20397
  */
19552
20398
  readmeUrl: string;
19553
20399
  /**
19554
- * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
20400
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
19555
20401
  */
19556
20402
  public: boolean;
19557
20403
  };
19558
20404
  }
19559
20405
 
19560
- interface GetPublicPluginRequestHeaders {
20406
+ interface GetPublicInterfaceRequestHeaders {
19561
20407
  }
19562
- interface GetPublicPluginRequestQuery {
20408
+ interface GetPublicInterfaceRequestQuery {
19563
20409
  }
19564
- interface GetPublicPluginRequestParams {
20410
+ interface GetPublicInterfaceRequestParams {
19565
20411
  name: string;
19566
20412
  version: string;
19567
20413
  }
19568
- interface GetPublicPluginRequestBody {
20414
+ interface GetPublicInterfaceRequestBody {
19569
20415
  }
19570
- type GetPublicPluginInput = GetPublicPluginRequestBody & GetPublicPluginRequestHeaders & GetPublicPluginRequestQuery & GetPublicPluginRequestParams;
19571
- interface GetPublicPluginResponse {
19572
- plugin: {
20416
+ type GetPublicInterfaceInput = GetPublicInterfaceRequestBody & GetPublicInterfaceRequestHeaders & GetPublicInterfaceRequestQuery & GetPublicInterfaceRequestParams;
20417
+ interface GetPublicInterfaceResponse {
20418
+ interface: {
19573
20419
  /**
19574
- * ID of the [Plugin](#schema_plugin)
20420
+ * ID of the [Interface](#schema_interface)
19575
20421
  */
19576
20422
  id: string;
19577
20423
  /**
19578
- * Name of the [Plugin](#schema_plugin)
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
20424
+ * Creation date of the [Interface](#schema_interface) in ISO 8601 format
19587
20425
  */
19588
20426
  createdAt: string;
19589
20427
  /**
19590
- * Updating date of the [Plugin](#schema_plugin) in ISO 8601 format
20428
+ * Updating date of the [Interface](#schema_interface) in ISO 8601 format
19591
20429
  */
19592
20430
  updatedAt: string;
19593
20431
  /**
19594
- * Configuration definition
20432
+ * Name of the [Interface](#schema_interface)
19595
20433
  */
19596
- configuration: {
19597
- /**
19598
- * Title of the configuration
19599
- */
19600
- title?: string;
19601
- /**
19602
- * Description of the configuration
19603
- */
19604
- description?: string;
20434
+ name: string;
20435
+ /**
20436
+ * Version of the [Interface](#schema_interface)
20437
+ */
20438
+ version: string;
20439
+ entities: {
19605
20440
  /**
19606
- * Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
20441
+ * Entity definition
19607
20442
  */
19608
- schema: {
19609
- [k: string]: any;
19610
- };
19611
- };
19612
- states: {
19613
20443
  [k: string]: {
19614
20444
  /**
19615
- * Type of the [State](#schema_state) (`conversation`, `user`, `bot` or `task`)
20445
+ * Title of the entity
19616
20446
  */
19617
- type: "conversation" | "user" | "bot" | "task";
20447
+ title?: string;
19618
20448
  /**
19619
- * Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
20449
+ * Description of the entity
19620
20450
  */
20451
+ description?: string;
19621
20452
  schema: {
19622
20453
  [k: string]: any;
19623
20454
  };
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
20455
  };
19629
20456
  };
19630
20457
  events: {
@@ -19684,100 +20511,58 @@ interface GetPublicPluginResponse {
19684
20511
  };
19685
20512
  };
19686
20513
  };
19687
- dependencies: {
19688
- interfaces: {
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: {
20514
+ channels: {
20515
+ [k: string]: {
19708
20516
  /**
19709
- * Definition of a tag that can be provided on the object
20517
+ * Title of the channel
19710
20518
  */
19711
- [k: string]: {
19712
- /**
19713
- * Title of the tag
19714
- */
19715
- title?: string;
20519
+ title?: string;
20520
+ /**
20521
+ * Description of the channel
20522
+ */
20523
+ description?: string;
20524
+ messages: {
19716
20525
  /**
19717
- * Description of the tag
20526
+ * Message definition
19718
20527
  */
19719
- description?: string;
20528
+ [k: string]: {
20529
+ schema: {
20530
+ [k: string]: any;
20531
+ };
20532
+ };
19720
20533
  };
19721
20534
  };
19722
20535
  };
19723
20536
  /**
19724
- * Conversation object configuration
20537
+ * Template string optionaly used at build time by integrations implementing this interface to pick a name for actions and events.
19725
20538
  */
19726
- conversation: {
19727
- tags: {
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
- };
20539
+ nameTemplate?: {
20540
+ script: string;
20541
+ language: string;
19742
20542
  };
19743
20543
  /**
19744
- * Title of the plugin. This is the name that will be displayed in the UI
20544
+ * Title of the interface. This is the name that will be displayed in the UI
19745
20545
  */
19746
20546
  title: string;
19747
20547
  /**
19748
- * Description of the plugin. This is the description that will be displayed in the UI
20548
+ * Description of the interface. This is the description that will be displayed in the UI
19749
20549
  */
19750
20550
  description: string;
19751
20551
  /**
19752
- * URL of the icon of the plugin. This is the icon that will be displayed in the UI
20552
+ * URL of the icon of the interface. This is the icon that will be displayed in the UI
19753
20553
  */
19754
20554
  iconUrl: string;
19755
20555
  /**
19756
- * URL of the readme of the plugin. This is the readme that will be displayed in the UI
20556
+ * URL of the readme of the interface. This is the readme that will be displayed in the UI
19757
20557
  */
19758
20558
  readmeUrl: string;
19759
20559
  /**
19760
- * Indicates if the plugin is public. Public plugins are available to all and cannot be updated without creating a new version.
20560
+ * Indicates if the interface is public. Public interfaces are available to all and cannot be updated without creating a new version.
19761
20561
  */
19762
20562
  public: boolean;
19763
20563
  };
19764
20564
  }
19765
20565
 
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
20566
  interface CreateBotRequestHeaders {
19782
20567
  }
19783
20568
  interface CreateBotRequestQuery {
@@ -21235,6 +22020,7 @@ interface GetBotLogsRequestQuery {
21235
22020
  userId?: string;
21236
22021
  workflowId?: string;
21237
22022
  conversationId?: string;
22023
+ messageContains?: string;
21238
22024
  nextToken?: string;
21239
22025
  }
21240
22026
  interface GetBotLogsRequestParams {
@@ -24833,6 +25619,7 @@ interface GetIntegrationLogsRequestQuery {
24833
25619
  level?: string;
24834
25620
  userId?: string;
24835
25621
  conversationId?: string;
25622
+ messageContains?: string;
24836
25623
  nextToken?: string;
24837
25624
  }
24838
25625
  interface GetIntegrationLogsRequestParams {
@@ -26171,6 +26958,7 @@ interface ListInterfacesRequestHeaders {
26171
26958
  interface ListInterfacesRequestQuery {
26172
26959
  nextToken?: string;
26173
26960
  name?: string;
26961
+ version?: string;
26174
26962
  }
26175
26963
  interface ListInterfacesRequestParams {
26176
26964
  }
@@ -27641,8 +28429,15 @@ interface ListUsageActivityDailyRequestBody {
27641
28429
  type ListUsageActivityDailyInput = ListUsageActivityDailyRequestBody & ListUsageActivityDailyRequestHeaders & ListUsageActivityDailyRequestQuery & ListUsageActivityDailyRequestParams;
27642
28430
  interface ListUsageActivityDailyResponse {
27643
28431
  data: {
28432
+ key: string;
27644
28433
  date: string;
27645
28434
  value: number;
28435
+ metadata?: {
28436
+ botId: string;
28437
+ type: "IntegrationAction" | "FileIndexing";
28438
+ subtype: string;
28439
+ source?: string;
28440
+ };
27646
28441
  }[];
27647
28442
  meta: {
27648
28443
  nextToken?: string;
@@ -32081,6 +32876,9 @@ declare class Client$1 {
32081
32876
  readonly getPublicPluginById: (input: GetPublicPluginByIdInput) => Promise<GetPublicPluginByIdResponse>;
32082
32877
  readonly getPublicPlugin: (input: GetPublicPluginInput) => Promise<GetPublicPluginResponse>;
32083
32878
  readonly getPublicPluginCode: (input: GetPublicPluginCodeInput) => Promise<GetPublicPluginCodeResponse>;
32879
+ readonly listPublicInterfaces: (input: ListPublicInterfacesInput) => Promise<ListPublicInterfacesResponse>;
32880
+ readonly getPublicInterfaceById: (input: GetPublicInterfaceByIdInput) => Promise<GetPublicInterfaceByIdResponse>;
32881
+ readonly getPublicInterface: (input: GetPublicInterfaceInput) => Promise<GetPublicInterfaceResponse>;
32084
32882
  readonly createBot: (input: CreateBotInput) => Promise<CreateBotResponse>;
32085
32883
  readonly updateBot: (input: UpdateBotInput) => Promise<UpdateBotResponse>;
32086
32884
  readonly transferBot: (input: TransferBotInput) => Promise<TransferBotResponse>;
@@ -32448,6 +33246,7 @@ declare class Client extends Client$1 implements IClient {
32448
33246
  }>;
32449
33247
  interfaces: (props: {
32450
33248
  name?: string | undefined;
33249
+ version?: string | undefined;
32451
33250
  }) => AsyncCollection<{
32452
33251
  id: string;
32453
33252
  createdAt: string;
@@ -32532,8 +33331,15 @@ declare class Client extends Client$1 implements IClient {
32532
33331
  dateFrom?: string | undefined;
32533
33332
  dateUntil?: string | undefined;
32534
33333
  }) => AsyncCollection<{
33334
+ key: string;
32535
33335
  date: string;
32536
33336
  value: number;
33337
+ metadata?: {
33338
+ botId: string;
33339
+ type: "IntegrationAction" | "FileIndexing";
33340
+ subtype: string;
33341
+ source?: string;
33342
+ };
32537
33343
  }>;
32538
33344
  };
32539
33345
  /**