@botpress/client 0.41.2 → 0.43.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/.turbo/turbo-build.log +7 -7
- package/.turbo/turbo-generate.log +1 -1
- package/dist/bundle.cjs +11 -11
- package/dist/bundle.cjs.map +4 -4
- package/dist/index.cjs +3 -3
- package/dist/index.cjs.map +4 -4
- package/dist/index.d.ts +1007 -365
- package/dist/index.mjs +3 -3
- package/dist/index.mjs.map +4 -4
- package/package.json +2 -2
package/dist/index.d.ts
CHANGED
|
@@ -4697,6 +4697,9 @@ interface ListBotsRequestHeaders {
|
|
|
4697
4697
|
}
|
|
4698
4698
|
interface ListBotsRequestQuery {
|
|
4699
4699
|
dev?: boolean;
|
|
4700
|
+
tags?: {
|
|
4701
|
+
[k: string]: string;
|
|
4702
|
+
};
|
|
4700
4703
|
nextToken?: string;
|
|
4701
4704
|
sortField?: "createdAt" | "updatedAt";
|
|
4702
4705
|
sortDirection?: "asc" | "desc";
|
|
@@ -4722,6 +4725,12 @@ interface ListBotsResponse {
|
|
|
4722
4725
|
updatedAt: string;
|
|
4723
4726
|
name: string;
|
|
4724
4727
|
deployedAt?: string;
|
|
4728
|
+
/**
|
|
4729
|
+
* Tags of [Bot](#schema_bot)
|
|
4730
|
+
*/
|
|
4731
|
+
tags: {
|
|
4732
|
+
[k: string]: string;
|
|
4733
|
+
};
|
|
4725
4734
|
}[];
|
|
4726
4735
|
meta: {
|
|
4727
4736
|
/**
|
|
@@ -5721,6 +5730,7 @@ interface ListWorkspacesRequestHeaders {
|
|
|
5721
5730
|
}
|
|
5722
5731
|
interface ListWorkspacesRequestQuery {
|
|
5723
5732
|
nextToken?: string;
|
|
5733
|
+
handle?: string;
|
|
5724
5734
|
}
|
|
5725
5735
|
interface ListWorkspacesRequestParams {
|
|
5726
5736
|
}
|
|
@@ -6657,14 +6667,21 @@ interface CreateIntegrationResponse {
|
|
|
6657
6667
|
};
|
|
6658
6668
|
}
|
|
6659
6669
|
|
|
6660
|
-
interface
|
|
6670
|
+
interface ValidateIntegrationCreationRequestHeaders {
|
|
6661
6671
|
}
|
|
6662
|
-
interface
|
|
6672
|
+
interface ValidateIntegrationCreationRequestQuery {
|
|
6663
6673
|
}
|
|
6664
|
-
interface
|
|
6665
|
-
id: string;
|
|
6674
|
+
interface ValidateIntegrationCreationRequestParams {
|
|
6666
6675
|
}
|
|
6667
|
-
interface
|
|
6676
|
+
interface ValidateIntegrationCreationRequestBody {
|
|
6677
|
+
/**
|
|
6678
|
+
* Name of the [Integration](#schema_integration)
|
|
6679
|
+
*/
|
|
6680
|
+
name: string;
|
|
6681
|
+
/**
|
|
6682
|
+
* Version of the [Integration](#schema_integration)
|
|
6683
|
+
*/
|
|
6684
|
+
version: string;
|
|
6668
6685
|
/**
|
|
6669
6686
|
* Default configuration definition of the integration
|
|
6670
6687
|
*/
|
|
@@ -6684,8 +6701,8 @@ interface UpdateIntegrationRequestBody {
|
|
|
6684
6701
|
[k: string]: any;
|
|
6685
6702
|
};
|
|
6686
6703
|
identifier?: {
|
|
6687
|
-
linkTemplateScript?: string | null;
|
|
6688
6704
|
required?: boolean;
|
|
6705
|
+
linkTemplateScript?: string;
|
|
6689
6706
|
};
|
|
6690
6707
|
};
|
|
6691
6708
|
/**
|
|
@@ -6708,10 +6725,94 @@ interface UpdateIntegrationRequestBody {
|
|
|
6708
6725
|
[k: string]: any;
|
|
6709
6726
|
};
|
|
6710
6727
|
identifier?: {
|
|
6711
|
-
linkTemplateScript?: string | null;
|
|
6712
6728
|
required?: boolean;
|
|
6729
|
+
linkTemplateScript?: string;
|
|
6713
6730
|
};
|
|
6714
|
-
}
|
|
6731
|
+
};
|
|
6732
|
+
};
|
|
6733
|
+
states?: {
|
|
6734
|
+
/**
|
|
6735
|
+
* State definition
|
|
6736
|
+
*/
|
|
6737
|
+
[k: string]: {
|
|
6738
|
+
/**
|
|
6739
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
6740
|
+
*/
|
|
6741
|
+
type: "conversation" | "user" | "integration";
|
|
6742
|
+
/**
|
|
6743
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6744
|
+
*/
|
|
6745
|
+
schema: {
|
|
6746
|
+
[k: string]: any;
|
|
6747
|
+
};
|
|
6748
|
+
};
|
|
6749
|
+
};
|
|
6750
|
+
events?: {
|
|
6751
|
+
/**
|
|
6752
|
+
* Event Definition
|
|
6753
|
+
*/
|
|
6754
|
+
[k: string]: {
|
|
6755
|
+
/**
|
|
6756
|
+
* Title of the event
|
|
6757
|
+
*/
|
|
6758
|
+
title?: string;
|
|
6759
|
+
/**
|
|
6760
|
+
* Description of the event
|
|
6761
|
+
*/
|
|
6762
|
+
description?: string;
|
|
6763
|
+
schema: {
|
|
6764
|
+
[k: string]: any;
|
|
6765
|
+
};
|
|
6766
|
+
};
|
|
6767
|
+
};
|
|
6768
|
+
actions?: {
|
|
6769
|
+
/**
|
|
6770
|
+
* Action definition
|
|
6771
|
+
*/
|
|
6772
|
+
[k: string]: {
|
|
6773
|
+
/**
|
|
6774
|
+
* Title of the action
|
|
6775
|
+
*/
|
|
6776
|
+
title?: string;
|
|
6777
|
+
/**
|
|
6778
|
+
* Description of the action
|
|
6779
|
+
*/
|
|
6780
|
+
description?: string;
|
|
6781
|
+
billable?: boolean;
|
|
6782
|
+
cacheable?: boolean;
|
|
6783
|
+
input: {
|
|
6784
|
+
schema: {
|
|
6785
|
+
[k: string]: any;
|
|
6786
|
+
};
|
|
6787
|
+
};
|
|
6788
|
+
output: {
|
|
6789
|
+
schema: {
|
|
6790
|
+
[k: string]: any;
|
|
6791
|
+
};
|
|
6792
|
+
};
|
|
6793
|
+
};
|
|
6794
|
+
};
|
|
6795
|
+
entities?: {
|
|
6796
|
+
/**
|
|
6797
|
+
* Entity definition
|
|
6798
|
+
*/
|
|
6799
|
+
[k: string]: {
|
|
6800
|
+
/**
|
|
6801
|
+
* Title of the entity
|
|
6802
|
+
*/
|
|
6803
|
+
title?: string;
|
|
6804
|
+
/**
|
|
6805
|
+
* Description of the entity
|
|
6806
|
+
*/
|
|
6807
|
+
description?: string;
|
|
6808
|
+
schema: {
|
|
6809
|
+
[k: string]: any;
|
|
6810
|
+
};
|
|
6811
|
+
};
|
|
6812
|
+
};
|
|
6813
|
+
identifier?: {
|
|
6814
|
+
fallbackHandlerScript?: string;
|
|
6815
|
+
extractScript?: string;
|
|
6715
6816
|
};
|
|
6716
6817
|
channels?: {
|
|
6717
6818
|
[k: string]: {
|
|
@@ -6723,7 +6824,7 @@ interface UpdateIntegrationRequestBody {
|
|
|
6723
6824
|
* Description of the channel
|
|
6724
6825
|
*/
|
|
6725
6826
|
description?: string;
|
|
6726
|
-
messages
|
|
6827
|
+
messages: {
|
|
6727
6828
|
/**
|
|
6728
6829
|
* Message definition
|
|
6729
6830
|
*/
|
|
@@ -6731,7 +6832,7 @@ interface UpdateIntegrationRequestBody {
|
|
|
6731
6832
|
schema: {
|
|
6732
6833
|
[k: string]: any;
|
|
6733
6834
|
};
|
|
6734
|
-
}
|
|
6835
|
+
};
|
|
6735
6836
|
};
|
|
6736
6837
|
conversation?: {
|
|
6737
6838
|
/**
|
|
@@ -6760,7 +6861,7 @@ interface UpdateIntegrationRequestBody {
|
|
|
6760
6861
|
* Description of the tag
|
|
6761
6862
|
*/
|
|
6762
6863
|
description?: string;
|
|
6763
|
-
}
|
|
6864
|
+
};
|
|
6764
6865
|
};
|
|
6765
6866
|
};
|
|
6766
6867
|
message?: {
|
|
@@ -6777,76 +6878,10 @@ interface UpdateIntegrationRequestBody {
|
|
|
6777
6878
|
* Description of the tag
|
|
6778
6879
|
*/
|
|
6779
6880
|
description?: string;
|
|
6780
|
-
}
|
|
6781
|
-
};
|
|
6782
|
-
};
|
|
6783
|
-
} | null;
|
|
6784
|
-
};
|
|
6785
|
-
identifier?: {
|
|
6786
|
-
extractScript?: string | null;
|
|
6787
|
-
fallbackHandlerScript?: string | null;
|
|
6788
|
-
};
|
|
6789
|
-
actions?: {
|
|
6790
|
-
/**
|
|
6791
|
-
* Action definition
|
|
6792
|
-
*/
|
|
6793
|
-
[k: string]: {
|
|
6794
|
-
/**
|
|
6795
|
-
* Title of the action
|
|
6796
|
-
*/
|
|
6797
|
-
title?: string;
|
|
6798
|
-
/**
|
|
6799
|
-
* Description of the action
|
|
6800
|
-
*/
|
|
6801
|
-
description?: string;
|
|
6802
|
-
billable?: boolean;
|
|
6803
|
-
cacheable?: boolean;
|
|
6804
|
-
input: {
|
|
6805
|
-
schema: {
|
|
6806
|
-
[k: string]: any;
|
|
6807
|
-
};
|
|
6808
|
-
};
|
|
6809
|
-
output: {
|
|
6810
|
-
schema: {
|
|
6811
|
-
[k: string]: any;
|
|
6881
|
+
};
|
|
6812
6882
|
};
|
|
6813
6883
|
};
|
|
6814
|
-
}
|
|
6815
|
-
};
|
|
6816
|
-
events?: {
|
|
6817
|
-
/**
|
|
6818
|
-
* Event Definition
|
|
6819
|
-
*/
|
|
6820
|
-
[k: string]: {
|
|
6821
|
-
/**
|
|
6822
|
-
* Title of the event
|
|
6823
|
-
*/
|
|
6824
|
-
title?: string;
|
|
6825
|
-
/**
|
|
6826
|
-
* Description of the event
|
|
6827
|
-
*/
|
|
6828
|
-
description?: string;
|
|
6829
|
-
schema: {
|
|
6830
|
-
[k: string]: any;
|
|
6831
|
-
};
|
|
6832
|
-
} | null;
|
|
6833
|
-
};
|
|
6834
|
-
states?: {
|
|
6835
|
-
/**
|
|
6836
|
-
* State definition
|
|
6837
|
-
*/
|
|
6838
|
-
[k: string]: {
|
|
6839
|
-
/**
|
|
6840
|
-
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
6841
|
-
*/
|
|
6842
|
-
type: "conversation" | "user" | "integration";
|
|
6843
|
-
/**
|
|
6844
|
-
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
6845
|
-
*/
|
|
6846
|
-
schema: {
|
|
6847
|
-
[k: string]: any;
|
|
6848
|
-
};
|
|
6849
|
-
} | null;
|
|
6884
|
+
};
|
|
6850
6885
|
};
|
|
6851
6886
|
user?: {
|
|
6852
6887
|
/**
|
|
@@ -6875,26 +6910,8 @@ interface UpdateIntegrationRequestBody {
|
|
|
6875
6910
|
* Description of the tag
|
|
6876
6911
|
*/
|
|
6877
6912
|
description?: string;
|
|
6878
|
-
} | null;
|
|
6879
|
-
};
|
|
6880
|
-
};
|
|
6881
|
-
entities?: {
|
|
6882
|
-
/**
|
|
6883
|
-
* Entity definition
|
|
6884
|
-
*/
|
|
6885
|
-
[k: string]: {
|
|
6886
|
-
/**
|
|
6887
|
-
* Title of the entity
|
|
6888
|
-
*/
|
|
6889
|
-
title?: string;
|
|
6890
|
-
/**
|
|
6891
|
-
* Description of the entity
|
|
6892
|
-
*/
|
|
6893
|
-
description?: string;
|
|
6894
|
-
schema: {
|
|
6895
|
-
[k: string]: any;
|
|
6896
6913
|
};
|
|
6897
|
-
}
|
|
6914
|
+
};
|
|
6898
6915
|
};
|
|
6899
6916
|
interfaces?: {
|
|
6900
6917
|
[k: string]: {
|
|
@@ -6922,18 +6939,26 @@ interface UpdateIntegrationRequestBody {
|
|
|
6922
6939
|
name: string;
|
|
6923
6940
|
};
|
|
6924
6941
|
};
|
|
6925
|
-
}
|
|
6942
|
+
};
|
|
6926
6943
|
};
|
|
6927
6944
|
/**
|
|
6928
6945
|
* 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.
|
|
6929
6946
|
*/
|
|
6930
6947
|
secrets?: {
|
|
6931
|
-
[k: string]: string
|
|
6948
|
+
[k: string]: string;
|
|
6932
6949
|
};
|
|
6933
6950
|
/**
|
|
6934
6951
|
* JavaScript code of the integration
|
|
6935
6952
|
*/
|
|
6936
6953
|
code?: string;
|
|
6954
|
+
/**
|
|
6955
|
+
* URL of the integration
|
|
6956
|
+
*/
|
|
6957
|
+
url?: string;
|
|
6958
|
+
/**
|
|
6959
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
6960
|
+
*/
|
|
6961
|
+
dev?: boolean;
|
|
6937
6962
|
/**
|
|
6938
6963
|
* Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
|
|
6939
6964
|
*/
|
|
@@ -6950,96 +6975,711 @@ interface UpdateIntegrationRequestBody {
|
|
|
6950
6975
|
* Description of the integration. This is the description that will be displayed in the UI
|
|
6951
6976
|
*/
|
|
6952
6977
|
description?: string;
|
|
6953
|
-
/**
|
|
6954
|
-
* URL of the integration
|
|
6955
|
-
*/
|
|
6956
|
-
url?: string | null;
|
|
6957
6978
|
/**
|
|
6958
6979
|
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
6959
6980
|
*/
|
|
6960
6981
|
public?: boolean;
|
|
6961
6982
|
layers?: string[];
|
|
6962
6983
|
}
|
|
6963
|
-
type
|
|
6964
|
-
interface
|
|
6965
|
-
|
|
6966
|
-
|
|
6967
|
-
|
|
6968
|
-
|
|
6969
|
-
|
|
6984
|
+
type ValidateIntegrationCreationInput = ValidateIntegrationCreationRequestBody & ValidateIntegrationCreationRequestHeaders & ValidateIntegrationCreationRequestQuery & ValidateIntegrationCreationRequestParams;
|
|
6985
|
+
interface ValidateIntegrationCreationResponse {
|
|
6986
|
+
}
|
|
6987
|
+
|
|
6988
|
+
interface UpdateIntegrationRequestHeaders {
|
|
6989
|
+
}
|
|
6990
|
+
interface UpdateIntegrationRequestQuery {
|
|
6991
|
+
}
|
|
6992
|
+
interface UpdateIntegrationRequestParams {
|
|
6993
|
+
id: string;
|
|
6994
|
+
}
|
|
6995
|
+
interface UpdateIntegrationRequestBody {
|
|
6996
|
+
/**
|
|
6997
|
+
* Default configuration definition of the integration
|
|
6998
|
+
*/
|
|
6999
|
+
configuration?: {
|
|
6970
7000
|
/**
|
|
6971
|
-
*
|
|
7001
|
+
* Title of the configuration
|
|
6972
7002
|
*/
|
|
6973
|
-
|
|
7003
|
+
title?: string;
|
|
6974
7004
|
/**
|
|
6975
|
-
*
|
|
7005
|
+
* Description of the configuration
|
|
6976
7006
|
*/
|
|
6977
|
-
|
|
7007
|
+
description?: string;
|
|
6978
7008
|
/**
|
|
6979
|
-
*
|
|
7009
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
6980
7010
|
*/
|
|
6981
|
-
|
|
7011
|
+
schema?: {
|
|
7012
|
+
[k: string]: any;
|
|
7013
|
+
};
|
|
7014
|
+
identifier?: {
|
|
7015
|
+
linkTemplateScript?: string | null;
|
|
7016
|
+
required?: boolean;
|
|
7017
|
+
};
|
|
7018
|
+
};
|
|
7019
|
+
/**
|
|
7020
|
+
* Additional configuration definitions of the integration
|
|
7021
|
+
*/
|
|
7022
|
+
configurations?: {
|
|
7023
|
+
[k: string]: {
|
|
6982
7024
|
/**
|
|
6983
|
-
*
|
|
7025
|
+
* Title of the configuration
|
|
6984
7026
|
*/
|
|
6985
|
-
|
|
7027
|
+
title?: string;
|
|
6986
7028
|
/**
|
|
6987
|
-
*
|
|
7029
|
+
* Description of the configuration
|
|
6988
7030
|
*/
|
|
6989
|
-
|
|
6990
|
-
|
|
7031
|
+
description?: string;
|
|
7032
|
+
/**
|
|
7033
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
7034
|
+
*/
|
|
7035
|
+
schema?: {
|
|
7036
|
+
[k: string]: any;
|
|
7037
|
+
};
|
|
7038
|
+
identifier?: {
|
|
7039
|
+
linkTemplateScript?: string | null;
|
|
7040
|
+
required?: boolean;
|
|
7041
|
+
};
|
|
7042
|
+
} | null;
|
|
7043
|
+
};
|
|
7044
|
+
channels?: {
|
|
7045
|
+
[k: string]: {
|
|
7046
|
+
/**
|
|
7047
|
+
* Title of the channel
|
|
7048
|
+
*/
|
|
7049
|
+
title?: string;
|
|
7050
|
+
/**
|
|
7051
|
+
* Description of the channel
|
|
7052
|
+
*/
|
|
7053
|
+
description?: string;
|
|
7054
|
+
messages?: {
|
|
7055
|
+
/**
|
|
7056
|
+
* Message definition
|
|
7057
|
+
*/
|
|
7058
|
+
[k: string]: {
|
|
7059
|
+
schema: {
|
|
7060
|
+
[k: string]: any;
|
|
7061
|
+
};
|
|
7062
|
+
} | null;
|
|
7063
|
+
};
|
|
7064
|
+
conversation?: {
|
|
7065
|
+
/**
|
|
7066
|
+
* 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.
|
|
7067
|
+
*/
|
|
7068
|
+
creation?: {
|
|
7069
|
+
/**
|
|
7070
|
+
* Enable conversation creation
|
|
7071
|
+
*/
|
|
7072
|
+
enabled: boolean;
|
|
7073
|
+
/**
|
|
7074
|
+
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
7075
|
+
*/
|
|
7076
|
+
requiredTags: string[];
|
|
7077
|
+
};
|
|
7078
|
+
tags?: {
|
|
7079
|
+
/**
|
|
7080
|
+
* Definition of a tag that can be provided on the object
|
|
7081
|
+
*/
|
|
7082
|
+
[k: string]: {
|
|
7083
|
+
/**
|
|
7084
|
+
* Title of the tag
|
|
7085
|
+
*/
|
|
7086
|
+
title?: string;
|
|
7087
|
+
/**
|
|
7088
|
+
* Description of the tag
|
|
7089
|
+
*/
|
|
7090
|
+
description?: string;
|
|
7091
|
+
} | null;
|
|
7092
|
+
};
|
|
7093
|
+
};
|
|
7094
|
+
message?: {
|
|
7095
|
+
tags?: {
|
|
7096
|
+
/**
|
|
7097
|
+
* Definition of a tag that can be provided on the object
|
|
7098
|
+
*/
|
|
7099
|
+
[k: string]: {
|
|
7100
|
+
/**
|
|
7101
|
+
* Title of the tag
|
|
7102
|
+
*/
|
|
7103
|
+
title?: string;
|
|
7104
|
+
/**
|
|
7105
|
+
* Description of the tag
|
|
7106
|
+
*/
|
|
7107
|
+
description?: string;
|
|
7108
|
+
} | null;
|
|
7109
|
+
};
|
|
7110
|
+
};
|
|
7111
|
+
} | null;
|
|
7112
|
+
};
|
|
7113
|
+
identifier?: {
|
|
7114
|
+
extractScript?: string | null;
|
|
7115
|
+
fallbackHandlerScript?: string | null;
|
|
7116
|
+
};
|
|
7117
|
+
actions?: {
|
|
6991
7118
|
/**
|
|
6992
|
-
*
|
|
7119
|
+
* Action definition
|
|
6993
7120
|
*/
|
|
6994
|
-
|
|
7121
|
+
[k: string]: {
|
|
7122
|
+
/**
|
|
7123
|
+
* Title of the action
|
|
7124
|
+
*/
|
|
7125
|
+
title?: string;
|
|
7126
|
+
/**
|
|
7127
|
+
* Description of the action
|
|
7128
|
+
*/
|
|
7129
|
+
description?: string;
|
|
7130
|
+
billable?: boolean;
|
|
7131
|
+
cacheable?: boolean;
|
|
7132
|
+
input: {
|
|
7133
|
+
schema: {
|
|
7134
|
+
[k: string]: any;
|
|
7135
|
+
};
|
|
7136
|
+
};
|
|
7137
|
+
output: {
|
|
7138
|
+
schema: {
|
|
7139
|
+
[k: string]: any;
|
|
7140
|
+
};
|
|
7141
|
+
};
|
|
7142
|
+
} | null;
|
|
7143
|
+
};
|
|
7144
|
+
events?: {
|
|
6995
7145
|
/**
|
|
6996
|
-
*
|
|
7146
|
+
* Event Definition
|
|
6997
7147
|
*/
|
|
6998
|
-
|
|
7148
|
+
[k: string]: {
|
|
7149
|
+
/**
|
|
7150
|
+
* Title of the event
|
|
7151
|
+
*/
|
|
7152
|
+
title?: string;
|
|
7153
|
+
/**
|
|
7154
|
+
* Description of the event
|
|
7155
|
+
*/
|
|
7156
|
+
description?: string;
|
|
7157
|
+
schema: {
|
|
7158
|
+
[k: string]: any;
|
|
7159
|
+
};
|
|
7160
|
+
} | null;
|
|
7161
|
+
};
|
|
7162
|
+
states?: {
|
|
6999
7163
|
/**
|
|
7000
|
-
*
|
|
7164
|
+
* State definition
|
|
7001
7165
|
*/
|
|
7002
|
-
|
|
7003
|
-
|
|
7166
|
+
[k: string]: {
|
|
7167
|
+
/**
|
|
7168
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
7169
|
+
*/
|
|
7170
|
+
type: "conversation" | "user" | "integration";
|
|
7171
|
+
/**
|
|
7172
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
7173
|
+
*/
|
|
7174
|
+
schema: {
|
|
7175
|
+
[k: string]: any;
|
|
7176
|
+
};
|
|
7177
|
+
} | null;
|
|
7178
|
+
};
|
|
7179
|
+
user?: {
|
|
7180
|
+
/**
|
|
7181
|
+
* 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.
|
|
7182
|
+
*/
|
|
7183
|
+
creation?: {
|
|
7184
|
+
/**
|
|
7185
|
+
* Enable user creation
|
|
7186
|
+
*/
|
|
7187
|
+
enabled: boolean;
|
|
7188
|
+
/**
|
|
7189
|
+
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
7190
|
+
*/
|
|
7191
|
+
requiredTags: string[];
|
|
7192
|
+
};
|
|
7193
|
+
tags?: {
|
|
7194
|
+
/**
|
|
7195
|
+
* Definition of a tag that can be provided on the object
|
|
7196
|
+
*/
|
|
7197
|
+
[k: string]: {
|
|
7198
|
+
/**
|
|
7199
|
+
* Title of the tag
|
|
7200
|
+
*/
|
|
7201
|
+
title?: string;
|
|
7202
|
+
/**
|
|
7203
|
+
* Description of the tag
|
|
7204
|
+
*/
|
|
7205
|
+
description?: string;
|
|
7206
|
+
} | null;
|
|
7207
|
+
};
|
|
7208
|
+
};
|
|
7209
|
+
entities?: {
|
|
7210
|
+
/**
|
|
7211
|
+
* Entity definition
|
|
7212
|
+
*/
|
|
7213
|
+
[k: string]: {
|
|
7214
|
+
/**
|
|
7215
|
+
* Title of the entity
|
|
7216
|
+
*/
|
|
7217
|
+
title?: string;
|
|
7218
|
+
/**
|
|
7219
|
+
* Description of the entity
|
|
7220
|
+
*/
|
|
7221
|
+
description?: string;
|
|
7222
|
+
schema: {
|
|
7223
|
+
[k: string]: any;
|
|
7224
|
+
};
|
|
7225
|
+
} | null;
|
|
7226
|
+
};
|
|
7227
|
+
interfaces?: {
|
|
7228
|
+
[k: string]: {
|
|
7229
|
+
/**
|
|
7230
|
+
* ID of the interface
|
|
7231
|
+
*/
|
|
7232
|
+
id: string;
|
|
7233
|
+
entities?: {
|
|
7234
|
+
[k: string]: {
|
|
7235
|
+
name: string;
|
|
7236
|
+
};
|
|
7237
|
+
};
|
|
7238
|
+
actions?: {
|
|
7239
|
+
[k: string]: {
|
|
7240
|
+
name: string;
|
|
7241
|
+
};
|
|
7242
|
+
};
|
|
7243
|
+
events?: {
|
|
7244
|
+
[k: string]: {
|
|
7245
|
+
name: string;
|
|
7246
|
+
};
|
|
7247
|
+
};
|
|
7248
|
+
channels?: {
|
|
7249
|
+
[k: string]: {
|
|
7250
|
+
name: string;
|
|
7251
|
+
};
|
|
7252
|
+
};
|
|
7253
|
+
} | null;
|
|
7254
|
+
};
|
|
7255
|
+
/**
|
|
7256
|
+
* 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.
|
|
7257
|
+
*/
|
|
7258
|
+
secrets?: {
|
|
7259
|
+
[k: string]: string | null;
|
|
7260
|
+
};
|
|
7261
|
+
/**
|
|
7262
|
+
* JavaScript code of the integration
|
|
7263
|
+
*/
|
|
7264
|
+
code?: string;
|
|
7265
|
+
/**
|
|
7266
|
+
* Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
|
|
7267
|
+
*/
|
|
7268
|
+
icon?: string;
|
|
7269
|
+
/**
|
|
7270
|
+
* Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
|
|
7271
|
+
*/
|
|
7272
|
+
readme?: string;
|
|
7273
|
+
/**
|
|
7274
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
7275
|
+
*/
|
|
7276
|
+
title?: string;
|
|
7277
|
+
/**
|
|
7278
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
7279
|
+
*/
|
|
7280
|
+
description?: string;
|
|
7281
|
+
/**
|
|
7282
|
+
* URL of the integration
|
|
7283
|
+
*/
|
|
7284
|
+
url?: string | null;
|
|
7285
|
+
/**
|
|
7286
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
7287
|
+
*/
|
|
7288
|
+
public?: boolean;
|
|
7289
|
+
layers?: string[];
|
|
7290
|
+
}
|
|
7291
|
+
type UpdateIntegrationInput = UpdateIntegrationRequestBody & UpdateIntegrationRequestHeaders & UpdateIntegrationRequestQuery & UpdateIntegrationRequestParams;
|
|
7292
|
+
interface UpdateIntegrationResponse {
|
|
7293
|
+
integration: {
|
|
7294
|
+
/**
|
|
7295
|
+
* ID of the [Integration](#schema_integration)
|
|
7296
|
+
*/
|
|
7297
|
+
id: string;
|
|
7298
|
+
/**
|
|
7299
|
+
* Creation date of the [Integration](#schema_integration) in ISO 8601 format
|
|
7300
|
+
*/
|
|
7301
|
+
createdAt: string;
|
|
7302
|
+
/**
|
|
7303
|
+
* Updating date of the [Integration](#schema_integration) in ISO 8601 format
|
|
7304
|
+
*/
|
|
7305
|
+
updatedAt: string;
|
|
7306
|
+
/**
|
|
7307
|
+
* Global identifier configuration of the [Integration](#schema_integration)
|
|
7308
|
+
*/
|
|
7309
|
+
identifier: {
|
|
7310
|
+
/**
|
|
7311
|
+
* VRL Script of the [Integration](#schema_integration) to handle incoming requests for a request that doesn't have an identifier
|
|
7312
|
+
*/
|
|
7313
|
+
fallbackHandlerScript?: string;
|
|
7314
|
+
/**
|
|
7315
|
+
* VRL Script of the [Integration](#schema_integration) to extract the identifier from an incoming webhook often use for OAuth
|
|
7316
|
+
*/
|
|
7317
|
+
extractScript?: string;
|
|
7318
|
+
};
|
|
7319
|
+
/**
|
|
7320
|
+
* URL of the [Integration](#schema_integration)
|
|
7321
|
+
*/
|
|
7322
|
+
url: string;
|
|
7323
|
+
/**
|
|
7324
|
+
* Name of the [Integration](#schema_integration)
|
|
7325
|
+
*/
|
|
7326
|
+
name: string;
|
|
7327
|
+
/**
|
|
7328
|
+
* Version of the [Integration](#schema_integration)
|
|
7329
|
+
*/
|
|
7330
|
+
version: string;
|
|
7331
|
+
interfaces: {
|
|
7332
|
+
[k: string]: {
|
|
7333
|
+
/**
|
|
7334
|
+
* ID of the interface
|
|
7335
|
+
*/
|
|
7336
|
+
id: string;
|
|
7337
|
+
/**
|
|
7338
|
+
* Name of the interface
|
|
7339
|
+
*/
|
|
7340
|
+
name: string;
|
|
7341
|
+
/**
|
|
7342
|
+
* Version of the interface
|
|
7343
|
+
*/
|
|
7344
|
+
version: string;
|
|
7345
|
+
entities: {
|
|
7346
|
+
[k: string]: {
|
|
7347
|
+
name: string;
|
|
7348
|
+
};
|
|
7349
|
+
};
|
|
7350
|
+
actions: {
|
|
7351
|
+
[k: string]: {
|
|
7352
|
+
name: string;
|
|
7353
|
+
};
|
|
7354
|
+
};
|
|
7355
|
+
events: {
|
|
7356
|
+
[k: string]: {
|
|
7357
|
+
name: string;
|
|
7358
|
+
};
|
|
7359
|
+
};
|
|
7360
|
+
channels: {
|
|
7361
|
+
[k: string]: {
|
|
7362
|
+
name: string;
|
|
7363
|
+
};
|
|
7364
|
+
};
|
|
7365
|
+
};
|
|
7366
|
+
};
|
|
7367
|
+
/**
|
|
7368
|
+
* Configuration definition
|
|
7369
|
+
*/
|
|
7370
|
+
configuration: {
|
|
7371
|
+
/**
|
|
7372
|
+
* Title of the configuration
|
|
7373
|
+
*/
|
|
7374
|
+
title?: string;
|
|
7375
|
+
/**
|
|
7376
|
+
* Description of the configuration
|
|
7377
|
+
*/
|
|
7378
|
+
description?: string;
|
|
7379
|
+
/**
|
|
7380
|
+
* Identifier configuration of the [Integration](#schema_integration)
|
|
7381
|
+
*/
|
|
7382
|
+
identifier: {
|
|
7383
|
+
linkTemplateScript?: string;
|
|
7384
|
+
required: boolean;
|
|
7385
|
+
};
|
|
7386
|
+
/**
|
|
7387
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
7388
|
+
*/
|
|
7389
|
+
schema: {
|
|
7390
|
+
[k: string]: any;
|
|
7391
|
+
};
|
|
7392
|
+
};
|
|
7393
|
+
configurations: {
|
|
7394
|
+
/**
|
|
7395
|
+
* Configuration definition
|
|
7396
|
+
*/
|
|
7397
|
+
[k: string]: {
|
|
7398
|
+
/**
|
|
7399
|
+
* Title of the configuration
|
|
7400
|
+
*/
|
|
7401
|
+
title?: string;
|
|
7402
|
+
/**
|
|
7403
|
+
* Description of the configuration
|
|
7404
|
+
*/
|
|
7405
|
+
description?: string;
|
|
7406
|
+
/**
|
|
7407
|
+
* Identifier configuration of the [Integration](#schema_integration)
|
|
7408
|
+
*/
|
|
7409
|
+
identifier: {
|
|
7410
|
+
linkTemplateScript?: string;
|
|
7411
|
+
required: boolean;
|
|
7412
|
+
};
|
|
7413
|
+
/**
|
|
7414
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
7415
|
+
*/
|
|
7416
|
+
schema: {
|
|
7417
|
+
[k: string]: any;
|
|
7418
|
+
};
|
|
7419
|
+
};
|
|
7420
|
+
};
|
|
7421
|
+
channels: {
|
|
7422
|
+
/**
|
|
7423
|
+
* Channel definition
|
|
7424
|
+
*/
|
|
7425
|
+
[k: string]: {
|
|
7426
|
+
/**
|
|
7427
|
+
* Title of the channel
|
|
7428
|
+
*/
|
|
7429
|
+
title?: string;
|
|
7430
|
+
/**
|
|
7431
|
+
* Description of the channel
|
|
7432
|
+
*/
|
|
7433
|
+
description?: string;
|
|
7434
|
+
messages: {
|
|
7435
|
+
/**
|
|
7436
|
+
* Message definition
|
|
7437
|
+
*/
|
|
7438
|
+
[k: string]: {
|
|
7439
|
+
schema: {
|
|
7440
|
+
[k: string]: any;
|
|
7441
|
+
};
|
|
7442
|
+
};
|
|
7443
|
+
};
|
|
7444
|
+
/**
|
|
7445
|
+
* Conversation object configuration
|
|
7446
|
+
*/
|
|
7447
|
+
conversation: {
|
|
7448
|
+
tags: {
|
|
7449
|
+
/**
|
|
7450
|
+
* Definition of a tag that can be provided on the object
|
|
7451
|
+
*/
|
|
7452
|
+
[k: string]: {
|
|
7453
|
+
/**
|
|
7454
|
+
* Title of the tag
|
|
7455
|
+
*/
|
|
7456
|
+
title?: string;
|
|
7457
|
+
/**
|
|
7458
|
+
* Description of the tag
|
|
7459
|
+
*/
|
|
7460
|
+
description?: string;
|
|
7461
|
+
};
|
|
7462
|
+
};
|
|
7463
|
+
/**
|
|
7464
|
+
* 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.
|
|
7465
|
+
*/
|
|
7466
|
+
creation: {
|
|
7467
|
+
/**
|
|
7468
|
+
* Enable conversation creation
|
|
7469
|
+
*/
|
|
7470
|
+
enabled: boolean;
|
|
7471
|
+
/**
|
|
7472
|
+
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
7473
|
+
*/
|
|
7474
|
+
requiredTags: string[];
|
|
7475
|
+
};
|
|
7476
|
+
};
|
|
7477
|
+
/**
|
|
7478
|
+
* Message object configuration
|
|
7479
|
+
*/
|
|
7480
|
+
message: {
|
|
7481
|
+
tags: {
|
|
7482
|
+
/**
|
|
7483
|
+
* Definition of a tag that can be provided on the object
|
|
7484
|
+
*/
|
|
7485
|
+
[k: string]: {
|
|
7486
|
+
/**
|
|
7487
|
+
* Title of the tag
|
|
7488
|
+
*/
|
|
7489
|
+
title?: string;
|
|
7490
|
+
/**
|
|
7491
|
+
* Description of the tag
|
|
7492
|
+
*/
|
|
7493
|
+
description?: string;
|
|
7494
|
+
};
|
|
7495
|
+
};
|
|
7496
|
+
};
|
|
7497
|
+
};
|
|
7498
|
+
};
|
|
7499
|
+
states: {
|
|
7500
|
+
/**
|
|
7501
|
+
* State definition
|
|
7502
|
+
*/
|
|
7503
|
+
[k: string]: {
|
|
7504
|
+
/**
|
|
7505
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
7506
|
+
*/
|
|
7507
|
+
type: "conversation" | "user" | "integration";
|
|
7508
|
+
/**
|
|
7509
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
7510
|
+
*/
|
|
7511
|
+
schema: {
|
|
7512
|
+
[k: string]: any;
|
|
7513
|
+
};
|
|
7514
|
+
};
|
|
7515
|
+
};
|
|
7516
|
+
events: {
|
|
7517
|
+
/**
|
|
7518
|
+
* Event Definition
|
|
7519
|
+
*/
|
|
7520
|
+
[k: string]: {
|
|
7521
|
+
/**
|
|
7522
|
+
* Title of the event
|
|
7523
|
+
*/
|
|
7524
|
+
title?: string;
|
|
7525
|
+
/**
|
|
7526
|
+
* Description of the event
|
|
7527
|
+
*/
|
|
7528
|
+
description?: string;
|
|
7529
|
+
schema: {
|
|
7530
|
+
[k: string]: any;
|
|
7531
|
+
};
|
|
7532
|
+
};
|
|
7533
|
+
};
|
|
7534
|
+
actions: {
|
|
7535
|
+
/**
|
|
7536
|
+
* Action definition
|
|
7537
|
+
*/
|
|
7538
|
+
[k: string]: {
|
|
7539
|
+
/**
|
|
7540
|
+
* Title of the action
|
|
7541
|
+
*/
|
|
7542
|
+
title?: string;
|
|
7543
|
+
/**
|
|
7544
|
+
* Description of the action
|
|
7545
|
+
*/
|
|
7546
|
+
description?: string;
|
|
7547
|
+
billable?: boolean;
|
|
7548
|
+
cacheable?: boolean;
|
|
7549
|
+
input: {
|
|
7550
|
+
schema: {
|
|
7551
|
+
[k: string]: any;
|
|
7552
|
+
};
|
|
7553
|
+
};
|
|
7554
|
+
output: {
|
|
7555
|
+
schema: {
|
|
7556
|
+
[k: string]: any;
|
|
7557
|
+
};
|
|
7558
|
+
};
|
|
7559
|
+
};
|
|
7560
|
+
};
|
|
7561
|
+
/**
|
|
7562
|
+
* User object configuration
|
|
7563
|
+
*/
|
|
7564
|
+
user: {
|
|
7565
|
+
tags: {
|
|
7566
|
+
/**
|
|
7567
|
+
* Definition of a tag that can be provided on the object
|
|
7568
|
+
*/
|
|
7569
|
+
[k: string]: {
|
|
7570
|
+
/**
|
|
7571
|
+
* Title of the tag
|
|
7572
|
+
*/
|
|
7573
|
+
title?: string;
|
|
7574
|
+
/**
|
|
7575
|
+
* Description of the tag
|
|
7576
|
+
*/
|
|
7577
|
+
description?: string;
|
|
7578
|
+
};
|
|
7579
|
+
};
|
|
7580
|
+
/**
|
|
7581
|
+
* 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.
|
|
7582
|
+
*/
|
|
7583
|
+
creation: {
|
|
7584
|
+
/**
|
|
7585
|
+
* Enable user creation
|
|
7586
|
+
*/
|
|
7587
|
+
enabled: boolean;
|
|
7588
|
+
/**
|
|
7589
|
+
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
7590
|
+
*/
|
|
7591
|
+
requiredTags: string[];
|
|
7592
|
+
};
|
|
7593
|
+
};
|
|
7594
|
+
entities: {
|
|
7595
|
+
/**
|
|
7596
|
+
* Entity definition
|
|
7597
|
+
*/
|
|
7004
7598
|
[k: string]: {
|
|
7005
7599
|
/**
|
|
7006
|
-
*
|
|
7007
|
-
*/
|
|
7008
|
-
id: string;
|
|
7009
|
-
/**
|
|
7010
|
-
* Name of the interface
|
|
7600
|
+
* Title of the entity
|
|
7011
7601
|
*/
|
|
7012
|
-
|
|
7602
|
+
title?: string;
|
|
7013
7603
|
/**
|
|
7014
|
-
*
|
|
7604
|
+
* Description of the entity
|
|
7015
7605
|
*/
|
|
7016
|
-
|
|
7017
|
-
|
|
7018
|
-
[k: string]:
|
|
7019
|
-
name: string;
|
|
7020
|
-
};
|
|
7021
|
-
};
|
|
7022
|
-
actions: {
|
|
7023
|
-
[k: string]: {
|
|
7024
|
-
name: string;
|
|
7025
|
-
};
|
|
7026
|
-
};
|
|
7027
|
-
events: {
|
|
7028
|
-
[k: string]: {
|
|
7029
|
-
name: string;
|
|
7030
|
-
};
|
|
7031
|
-
};
|
|
7032
|
-
channels: {
|
|
7033
|
-
[k: string]: {
|
|
7034
|
-
name: string;
|
|
7035
|
-
};
|
|
7606
|
+
description?: string;
|
|
7607
|
+
schema: {
|
|
7608
|
+
[k: string]: any;
|
|
7036
7609
|
};
|
|
7037
7610
|
};
|
|
7038
7611
|
};
|
|
7039
7612
|
/**
|
|
7040
|
-
*
|
|
7613
|
+
* Indicates if the integration is a development integration; Dev integrations run locally
|
|
7041
7614
|
*/
|
|
7042
|
-
|
|
7615
|
+
dev: boolean;
|
|
7616
|
+
/**
|
|
7617
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
7618
|
+
*/
|
|
7619
|
+
title: string;
|
|
7620
|
+
/**
|
|
7621
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
7622
|
+
*/
|
|
7623
|
+
description: string;
|
|
7624
|
+
/**
|
|
7625
|
+
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
7626
|
+
*/
|
|
7627
|
+
iconUrl: string;
|
|
7628
|
+
/**
|
|
7629
|
+
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
7630
|
+
*/
|
|
7631
|
+
readmeUrl: string;
|
|
7632
|
+
/**
|
|
7633
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
7634
|
+
*/
|
|
7635
|
+
public: boolean;
|
|
7636
|
+
/**
|
|
7637
|
+
* Status of the integration version verification
|
|
7638
|
+
*/
|
|
7639
|
+
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
7640
|
+
/**
|
|
7641
|
+
* 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.
|
|
7642
|
+
*/
|
|
7643
|
+
secrets: string[];
|
|
7644
|
+
};
|
|
7645
|
+
}
|
|
7646
|
+
|
|
7647
|
+
interface ValidateIntegrationUpdateRequestHeaders {
|
|
7648
|
+
}
|
|
7649
|
+
interface ValidateIntegrationUpdateRequestQuery {
|
|
7650
|
+
}
|
|
7651
|
+
interface ValidateIntegrationUpdateRequestParams {
|
|
7652
|
+
id: string;
|
|
7653
|
+
}
|
|
7654
|
+
interface ValidateIntegrationUpdateRequestBody {
|
|
7655
|
+
/**
|
|
7656
|
+
* Default configuration definition of the integration
|
|
7657
|
+
*/
|
|
7658
|
+
configuration?: {
|
|
7659
|
+
/**
|
|
7660
|
+
* Title of the configuration
|
|
7661
|
+
*/
|
|
7662
|
+
title?: string;
|
|
7663
|
+
/**
|
|
7664
|
+
* Description of the configuration
|
|
7665
|
+
*/
|
|
7666
|
+
description?: string;
|
|
7667
|
+
/**
|
|
7668
|
+
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
7669
|
+
*/
|
|
7670
|
+
schema?: {
|
|
7671
|
+
[k: string]: any;
|
|
7672
|
+
};
|
|
7673
|
+
identifier?: {
|
|
7674
|
+
linkTemplateScript?: string | null;
|
|
7675
|
+
required?: boolean;
|
|
7676
|
+
};
|
|
7677
|
+
};
|
|
7678
|
+
/**
|
|
7679
|
+
* Additional configuration definitions of the integration
|
|
7680
|
+
*/
|
|
7681
|
+
configurations?: {
|
|
7682
|
+
[k: string]: {
|
|
7043
7683
|
/**
|
|
7044
7684
|
* Title of the configuration
|
|
7045
7685
|
*/
|
|
@@ -7048,272 +7688,267 @@ interface UpdateIntegrationResponse {
|
|
|
7048
7688
|
* Description of the configuration
|
|
7049
7689
|
*/
|
|
7050
7690
|
description?: string;
|
|
7051
|
-
/**
|
|
7052
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
7053
|
-
*/
|
|
7054
|
-
identifier: {
|
|
7055
|
-
linkTemplateScript?: string;
|
|
7056
|
-
required: boolean;
|
|
7057
|
-
};
|
|
7058
7691
|
/**
|
|
7059
7692
|
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
7060
7693
|
*/
|
|
7061
|
-
schema
|
|
7694
|
+
schema?: {
|
|
7062
7695
|
[k: string]: any;
|
|
7063
7696
|
};
|
|
7064
|
-
|
|
7065
|
-
|
|
7697
|
+
identifier?: {
|
|
7698
|
+
linkTemplateScript?: string | null;
|
|
7699
|
+
required?: boolean;
|
|
7700
|
+
};
|
|
7701
|
+
} | null;
|
|
7702
|
+
};
|
|
7703
|
+
channels?: {
|
|
7704
|
+
[k: string]: {
|
|
7066
7705
|
/**
|
|
7067
|
-
*
|
|
7706
|
+
* Title of the channel
|
|
7068
7707
|
*/
|
|
7069
|
-
|
|
7070
|
-
/**
|
|
7071
|
-
* Title of the configuration
|
|
7072
|
-
*/
|
|
7073
|
-
title?: string;
|
|
7074
|
-
/**
|
|
7075
|
-
* Description of the configuration
|
|
7076
|
-
*/
|
|
7077
|
-
description?: string;
|
|
7078
|
-
/**
|
|
7079
|
-
* Identifier configuration of the [Integration](#schema_integration)
|
|
7080
|
-
*/
|
|
7081
|
-
identifier: {
|
|
7082
|
-
linkTemplateScript?: string;
|
|
7083
|
-
required: boolean;
|
|
7084
|
-
};
|
|
7085
|
-
/**
|
|
7086
|
-
* Schema of the configuration in the `JSON schema` format. The configuration data is validated against this `JSON schema`.
|
|
7087
|
-
*/
|
|
7088
|
-
schema: {
|
|
7089
|
-
[k: string]: any;
|
|
7090
|
-
};
|
|
7091
|
-
};
|
|
7092
|
-
};
|
|
7093
|
-
channels: {
|
|
7708
|
+
title?: string;
|
|
7094
7709
|
/**
|
|
7095
|
-
*
|
|
7710
|
+
* Description of the channel
|
|
7096
7711
|
*/
|
|
7097
|
-
|
|
7712
|
+
description?: string;
|
|
7713
|
+
messages?: {
|
|
7098
7714
|
/**
|
|
7099
|
-
*
|
|
7715
|
+
* Message definition
|
|
7100
7716
|
*/
|
|
7101
|
-
|
|
7717
|
+
[k: string]: {
|
|
7718
|
+
schema: {
|
|
7719
|
+
[k: string]: any;
|
|
7720
|
+
};
|
|
7721
|
+
} | null;
|
|
7722
|
+
};
|
|
7723
|
+
conversation?: {
|
|
7102
7724
|
/**
|
|
7103
|
-
*
|
|
7725
|
+
* 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.
|
|
7104
7726
|
*/
|
|
7105
|
-
|
|
7106
|
-
messages: {
|
|
7727
|
+
creation?: {
|
|
7107
7728
|
/**
|
|
7108
|
-
*
|
|
7729
|
+
* Enable conversation creation
|
|
7109
7730
|
*/
|
|
7110
|
-
|
|
7111
|
-
|
|
7112
|
-
|
|
7113
|
-
|
|
7114
|
-
|
|
7731
|
+
enabled: boolean;
|
|
7732
|
+
/**
|
|
7733
|
+
* The list of tags that are required to be specified when calling the API directly to create a conversation.
|
|
7734
|
+
*/
|
|
7735
|
+
requiredTags: string[];
|
|
7115
7736
|
};
|
|
7116
|
-
|
|
7117
|
-
* Conversation object configuration
|
|
7118
|
-
*/
|
|
7119
|
-
conversation: {
|
|
7120
|
-
tags: {
|
|
7121
|
-
/**
|
|
7122
|
-
* Definition of a tag that can be provided on the object
|
|
7123
|
-
*/
|
|
7124
|
-
[k: string]: {
|
|
7125
|
-
/**
|
|
7126
|
-
* Title of the tag
|
|
7127
|
-
*/
|
|
7128
|
-
title?: string;
|
|
7129
|
-
/**
|
|
7130
|
-
* Description of the tag
|
|
7131
|
-
*/
|
|
7132
|
-
description?: string;
|
|
7133
|
-
};
|
|
7134
|
-
};
|
|
7737
|
+
tags?: {
|
|
7135
7738
|
/**
|
|
7136
|
-
*
|
|
7739
|
+
* Definition of a tag that can be provided on the object
|
|
7137
7740
|
*/
|
|
7138
|
-
|
|
7741
|
+
[k: string]: {
|
|
7139
7742
|
/**
|
|
7140
|
-
*
|
|
7743
|
+
* Title of the tag
|
|
7141
7744
|
*/
|
|
7142
|
-
|
|
7745
|
+
title?: string;
|
|
7143
7746
|
/**
|
|
7144
|
-
*
|
|
7747
|
+
* Description of the tag
|
|
7145
7748
|
*/
|
|
7146
|
-
|
|
7147
|
-
};
|
|
7749
|
+
description?: string;
|
|
7750
|
+
} | null;
|
|
7148
7751
|
};
|
|
7149
|
-
|
|
7150
|
-
|
|
7151
|
-
|
|
7152
|
-
|
|
7153
|
-
|
|
7752
|
+
};
|
|
7753
|
+
message?: {
|
|
7754
|
+
tags?: {
|
|
7755
|
+
/**
|
|
7756
|
+
* Definition of a tag that can be provided on the object
|
|
7757
|
+
*/
|
|
7758
|
+
[k: string]: {
|
|
7154
7759
|
/**
|
|
7155
|
-
*
|
|
7760
|
+
* Title of the tag
|
|
7156
7761
|
*/
|
|
7157
|
-
|
|
7158
|
-
|
|
7159
|
-
|
|
7160
|
-
|
|
7161
|
-
|
|
7162
|
-
|
|
7163
|
-
* Description of the tag
|
|
7164
|
-
*/
|
|
7165
|
-
description?: string;
|
|
7166
|
-
};
|
|
7167
|
-
};
|
|
7762
|
+
title?: string;
|
|
7763
|
+
/**
|
|
7764
|
+
* Description of the tag
|
|
7765
|
+
*/
|
|
7766
|
+
description?: string;
|
|
7767
|
+
} | null;
|
|
7168
7768
|
};
|
|
7169
7769
|
};
|
|
7170
|
-
};
|
|
7171
|
-
|
|
7770
|
+
} | null;
|
|
7771
|
+
};
|
|
7772
|
+
identifier?: {
|
|
7773
|
+
extractScript?: string | null;
|
|
7774
|
+
fallbackHandlerScript?: string | null;
|
|
7775
|
+
};
|
|
7776
|
+
actions?: {
|
|
7777
|
+
/**
|
|
7778
|
+
* Action definition
|
|
7779
|
+
*/
|
|
7780
|
+
[k: string]: {
|
|
7172
7781
|
/**
|
|
7173
|
-
*
|
|
7782
|
+
* Title of the action
|
|
7174
7783
|
*/
|
|
7175
|
-
|
|
7176
|
-
|
|
7177
|
-
|
|
7178
|
-
|
|
7179
|
-
|
|
7180
|
-
|
|
7181
|
-
|
|
7182
|
-
|
|
7784
|
+
title?: string;
|
|
7785
|
+
/**
|
|
7786
|
+
* Description of the action
|
|
7787
|
+
*/
|
|
7788
|
+
description?: string;
|
|
7789
|
+
billable?: boolean;
|
|
7790
|
+
cacheable?: boolean;
|
|
7791
|
+
input: {
|
|
7183
7792
|
schema: {
|
|
7184
7793
|
[k: string]: any;
|
|
7185
7794
|
};
|
|
7186
7795
|
};
|
|
7187
|
-
|
|
7188
|
-
events: {
|
|
7189
|
-
/**
|
|
7190
|
-
* Event Definition
|
|
7191
|
-
*/
|
|
7192
|
-
[k: string]: {
|
|
7193
|
-
/**
|
|
7194
|
-
* Title of the event
|
|
7195
|
-
*/
|
|
7196
|
-
title?: string;
|
|
7197
|
-
/**
|
|
7198
|
-
* Description of the event
|
|
7199
|
-
*/
|
|
7200
|
-
description?: string;
|
|
7796
|
+
output: {
|
|
7201
7797
|
schema: {
|
|
7202
7798
|
[k: string]: any;
|
|
7203
7799
|
};
|
|
7204
7800
|
};
|
|
7205
|
-
};
|
|
7206
|
-
|
|
7801
|
+
} | null;
|
|
7802
|
+
};
|
|
7803
|
+
events?: {
|
|
7804
|
+
/**
|
|
7805
|
+
* Event Definition
|
|
7806
|
+
*/
|
|
7807
|
+
[k: string]: {
|
|
7207
7808
|
/**
|
|
7208
|
-
*
|
|
7809
|
+
* Title of the event
|
|
7209
7810
|
*/
|
|
7210
|
-
|
|
7211
|
-
|
|
7212
|
-
|
|
7213
|
-
|
|
7214
|
-
|
|
7215
|
-
|
|
7216
|
-
|
|
7217
|
-
*/
|
|
7218
|
-
description?: string;
|
|
7219
|
-
billable?: boolean;
|
|
7220
|
-
cacheable?: boolean;
|
|
7221
|
-
input: {
|
|
7222
|
-
schema: {
|
|
7223
|
-
[k: string]: any;
|
|
7224
|
-
};
|
|
7225
|
-
};
|
|
7226
|
-
output: {
|
|
7227
|
-
schema: {
|
|
7228
|
-
[k: string]: any;
|
|
7229
|
-
};
|
|
7230
|
-
};
|
|
7811
|
+
title?: string;
|
|
7812
|
+
/**
|
|
7813
|
+
* Description of the event
|
|
7814
|
+
*/
|
|
7815
|
+
description?: string;
|
|
7816
|
+
schema: {
|
|
7817
|
+
[k: string]: any;
|
|
7231
7818
|
};
|
|
7232
|
-
};
|
|
7819
|
+
} | null;
|
|
7820
|
+
};
|
|
7821
|
+
states?: {
|
|
7233
7822
|
/**
|
|
7234
|
-
*
|
|
7823
|
+
* State definition
|
|
7235
7824
|
*/
|
|
7236
|
-
|
|
7237
|
-
tags: {
|
|
7238
|
-
/**
|
|
7239
|
-
* Definition of a tag that can be provided on the object
|
|
7240
|
-
*/
|
|
7241
|
-
[k: string]: {
|
|
7242
|
-
/**
|
|
7243
|
-
* Title of the tag
|
|
7244
|
-
*/
|
|
7245
|
-
title?: string;
|
|
7246
|
-
/**
|
|
7247
|
-
* Description of the tag
|
|
7248
|
-
*/
|
|
7249
|
-
description?: string;
|
|
7250
|
-
};
|
|
7251
|
-
};
|
|
7825
|
+
[k: string]: {
|
|
7252
7826
|
/**
|
|
7253
|
-
*
|
|
7827
|
+
* Type of the [State](#schema_state) (`conversation`, `user` or `integration`)
|
|
7254
7828
|
*/
|
|
7255
|
-
|
|
7256
|
-
|
|
7257
|
-
|
|
7258
|
-
|
|
7259
|
-
|
|
7260
|
-
|
|
7261
|
-
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
7262
|
-
*/
|
|
7263
|
-
requiredTags: string[];
|
|
7829
|
+
type: "conversation" | "user" | "integration";
|
|
7830
|
+
/**
|
|
7831
|
+
* Schema of the [State](#schema_state) in the `JSON schema` format. This `JSON schema` is going to be used for validating the state data.
|
|
7832
|
+
*/
|
|
7833
|
+
schema: {
|
|
7834
|
+
[k: string]: any;
|
|
7264
7835
|
};
|
|
7836
|
+
} | null;
|
|
7837
|
+
};
|
|
7838
|
+
user?: {
|
|
7839
|
+
/**
|
|
7840
|
+
* 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.
|
|
7841
|
+
*/
|
|
7842
|
+
creation?: {
|
|
7843
|
+
/**
|
|
7844
|
+
* Enable user creation
|
|
7845
|
+
*/
|
|
7846
|
+
enabled: boolean;
|
|
7847
|
+
/**
|
|
7848
|
+
* The list of tags that are required to be specified when calling the API directly to create a user.
|
|
7849
|
+
*/
|
|
7850
|
+
requiredTags: string[];
|
|
7265
7851
|
};
|
|
7266
|
-
|
|
7852
|
+
tags?: {
|
|
7267
7853
|
/**
|
|
7268
|
-
*
|
|
7854
|
+
* Definition of a tag that can be provided on the object
|
|
7269
7855
|
*/
|
|
7270
7856
|
[k: string]: {
|
|
7271
7857
|
/**
|
|
7272
|
-
* Title of the
|
|
7858
|
+
* Title of the tag
|
|
7273
7859
|
*/
|
|
7274
7860
|
title?: string;
|
|
7275
7861
|
/**
|
|
7276
|
-
* Description of the
|
|
7862
|
+
* Description of the tag
|
|
7277
7863
|
*/
|
|
7278
7864
|
description?: string;
|
|
7279
|
-
|
|
7280
|
-
[k: string]: any;
|
|
7281
|
-
};
|
|
7282
|
-
};
|
|
7865
|
+
} | null;
|
|
7283
7866
|
};
|
|
7867
|
+
};
|
|
7868
|
+
entities?: {
|
|
7284
7869
|
/**
|
|
7285
|
-
*
|
|
7286
|
-
*/
|
|
7287
|
-
dev: boolean;
|
|
7288
|
-
/**
|
|
7289
|
-
* Title of the integration. This is the name that will be displayed in the UI
|
|
7290
|
-
*/
|
|
7291
|
-
title: string;
|
|
7292
|
-
/**
|
|
7293
|
-
* Description of the integration. This is the description that will be displayed in the UI
|
|
7294
|
-
*/
|
|
7295
|
-
description: string;
|
|
7296
|
-
/**
|
|
7297
|
-
* URL of the icon of the integration. This is the icon that will be displayed in the UI
|
|
7298
|
-
*/
|
|
7299
|
-
iconUrl: string;
|
|
7300
|
-
/**
|
|
7301
|
-
* URL of the readme of the integration. This is the readme that will be displayed in the UI
|
|
7302
|
-
*/
|
|
7303
|
-
readmeUrl: string;
|
|
7304
|
-
/**
|
|
7305
|
-
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
7306
|
-
*/
|
|
7307
|
-
public: boolean;
|
|
7308
|
-
/**
|
|
7309
|
-
* Status of the integration version verification
|
|
7310
|
-
*/
|
|
7311
|
-
verificationStatus: "unapproved" | "pending" | "approved" | "rejected";
|
|
7312
|
-
/**
|
|
7313
|
-
* 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.
|
|
7870
|
+
* Entity definition
|
|
7314
7871
|
*/
|
|
7315
|
-
|
|
7872
|
+
[k: string]: {
|
|
7873
|
+
/**
|
|
7874
|
+
* Title of the entity
|
|
7875
|
+
*/
|
|
7876
|
+
title?: string;
|
|
7877
|
+
/**
|
|
7878
|
+
* Description of the entity
|
|
7879
|
+
*/
|
|
7880
|
+
description?: string;
|
|
7881
|
+
schema: {
|
|
7882
|
+
[k: string]: any;
|
|
7883
|
+
};
|
|
7884
|
+
} | null;
|
|
7885
|
+
};
|
|
7886
|
+
interfaces?: {
|
|
7887
|
+
[k: string]: {
|
|
7888
|
+
/**
|
|
7889
|
+
* ID of the interface
|
|
7890
|
+
*/
|
|
7891
|
+
id: string;
|
|
7892
|
+
entities?: {
|
|
7893
|
+
[k: string]: {
|
|
7894
|
+
name: string;
|
|
7895
|
+
};
|
|
7896
|
+
};
|
|
7897
|
+
actions?: {
|
|
7898
|
+
[k: string]: {
|
|
7899
|
+
name: string;
|
|
7900
|
+
};
|
|
7901
|
+
};
|
|
7902
|
+
events?: {
|
|
7903
|
+
[k: string]: {
|
|
7904
|
+
name: string;
|
|
7905
|
+
};
|
|
7906
|
+
};
|
|
7907
|
+
channels?: {
|
|
7908
|
+
[k: string]: {
|
|
7909
|
+
name: string;
|
|
7910
|
+
};
|
|
7911
|
+
};
|
|
7912
|
+
} | null;
|
|
7316
7913
|
};
|
|
7914
|
+
/**
|
|
7915
|
+
* 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.
|
|
7916
|
+
*/
|
|
7917
|
+
secrets?: {
|
|
7918
|
+
[k: string]: string | null;
|
|
7919
|
+
};
|
|
7920
|
+
/**
|
|
7921
|
+
* JavaScript code of the integration
|
|
7922
|
+
*/
|
|
7923
|
+
code?: string;
|
|
7924
|
+
/**
|
|
7925
|
+
* Base64 encoded svg of the integration icon. This icon is global to the integration each versions will be updated when this changes.
|
|
7926
|
+
*/
|
|
7927
|
+
icon?: string;
|
|
7928
|
+
/**
|
|
7929
|
+
* Base64 encoded markdown of the integration readme. The readme is specific to each integration versions.
|
|
7930
|
+
*/
|
|
7931
|
+
readme?: string;
|
|
7932
|
+
/**
|
|
7933
|
+
* Title of the integration. This is the name that will be displayed in the UI
|
|
7934
|
+
*/
|
|
7935
|
+
title?: string;
|
|
7936
|
+
/**
|
|
7937
|
+
* Description of the integration. This is the description that will be displayed in the UI
|
|
7938
|
+
*/
|
|
7939
|
+
description?: string;
|
|
7940
|
+
/**
|
|
7941
|
+
* URL of the integration
|
|
7942
|
+
*/
|
|
7943
|
+
url?: string | null;
|
|
7944
|
+
/**
|
|
7945
|
+
* Idicates if the integration is public. Public integrations are available to all and cannot be updated without creating a new version.
|
|
7946
|
+
*/
|
|
7947
|
+
public?: boolean;
|
|
7948
|
+
layers?: string[];
|
|
7949
|
+
}
|
|
7950
|
+
type ValidateIntegrationUpdateInput = ValidateIntegrationUpdateRequestBody & ValidateIntegrationUpdateRequestHeaders & ValidateIntegrationUpdateRequestQuery & ValidateIntegrationUpdateRequestParams;
|
|
7951
|
+
interface ValidateIntegrationUpdateResponse {
|
|
7317
7952
|
}
|
|
7318
7953
|
|
|
7319
7954
|
interface ListIntegrationsRequestHeaders {
|
|
@@ -10458,6 +11093,8 @@ interface ListFilesRequestHeaders {
|
|
|
10458
11093
|
}
|
|
10459
11094
|
interface ListFilesRequestQuery {
|
|
10460
11095
|
nextToken?: string;
|
|
11096
|
+
sortField?: "key" | "size" | "createdAt" | "updatedAt" | "status";
|
|
11097
|
+
sortDirection?: "asc" | "desc";
|
|
10461
11098
|
tags?: any;
|
|
10462
11099
|
/**
|
|
10463
11100
|
* @maxItems 50
|
|
@@ -14312,7 +14949,9 @@ declare class Client$1 {
|
|
|
14312
14949
|
readonly createIntegrationApiKey: (input: CreateIntegrationApiKeyInput) => Promise<CreateIntegrationApiKeyResponse>;
|
|
14313
14950
|
readonly deleteIntegrationApiKey: (input: DeleteIntegrationApiKeyInput) => Promise<DeleteIntegrationApiKeyResponse>;
|
|
14314
14951
|
readonly createIntegration: (input: CreateIntegrationInput) => Promise<CreateIntegrationResponse>;
|
|
14952
|
+
readonly validateIntegrationCreation: (input: ValidateIntegrationCreationInput) => Promise<ValidateIntegrationCreationResponse>;
|
|
14315
14953
|
readonly updateIntegration: (input: UpdateIntegrationInput) => Promise<UpdateIntegrationResponse>;
|
|
14954
|
+
readonly validateIntegrationUpdate: (input: ValidateIntegrationUpdateInput) => Promise<ValidateIntegrationUpdateResponse>;
|
|
14316
14955
|
readonly listIntegrations: (input: ListIntegrationsInput) => Promise<ListIntegrationsResponse>;
|
|
14317
14956
|
readonly getIntegration: (input: GetIntegrationInput) => Promise<GetIntegrationResponse>;
|
|
14318
14957
|
readonly getIntegrationLogs: (input: GetIntegrationLogsInput) => Promise<GetIntegrationLogsResponse>;
|
|
@@ -14770,6 +15409,9 @@ declare class Lister {
|
|
|
14770
15409
|
updatedAt: string;
|
|
14771
15410
|
name: string;
|
|
14772
15411
|
deployedAt?: string;
|
|
15412
|
+
tags: {
|
|
15413
|
+
[k: string]: string;
|
|
15414
|
+
};
|
|
14773
15415
|
}>;
|
|
14774
15416
|
readonly botIssues: (props: ListInputs["listBotIssues"]) => AsyncCollection<{
|
|
14775
15417
|
id: string;
|