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