@lpextend/node-sdk 1.1.2 → 1.1.4
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/index.d.mts +1130 -10
- package/dist/index.d.ts +1130 -10
- package/dist/index.js +721 -6
- package/dist/index.js.map +1 -1
- package/dist/index.mjs +712 -7
- package/dist/index.mjs.map +1 -1
- package/package.json +1 -1
package/dist/index.d.ts
CHANGED
|
@@ -765,6 +765,722 @@ interface LPPromptsQueryParams {
|
|
|
765
765
|
status?: LPPromptStatus;
|
|
766
766
|
}
|
|
767
767
|
|
|
768
|
+
/**
|
|
769
|
+
* Conversation Builder Types
|
|
770
|
+
*
|
|
771
|
+
* Types for LivePerson Conversation Builder (CB) and Knowledge AI (KAI) APIs.
|
|
772
|
+
* Used for managing bots, dialogs, interactions, knowledge bases, and NLU domains.
|
|
773
|
+
*/
|
|
774
|
+
/**
|
|
775
|
+
* Standard CB API response wrapper
|
|
776
|
+
*/
|
|
777
|
+
interface CBApiResponse<T> {
|
|
778
|
+
success: boolean;
|
|
779
|
+
error?: string;
|
|
780
|
+
errorCode?: string;
|
|
781
|
+
message?: string;
|
|
782
|
+
successResult?: T;
|
|
783
|
+
}
|
|
784
|
+
/**
|
|
785
|
+
* Page context for paginated responses
|
|
786
|
+
*/
|
|
787
|
+
interface CBPageContext {
|
|
788
|
+
page: number;
|
|
789
|
+
size: number;
|
|
790
|
+
totalSize: number;
|
|
791
|
+
}
|
|
792
|
+
/**
|
|
793
|
+
* Paginated result wrapper
|
|
794
|
+
*/
|
|
795
|
+
interface CBPaginatedResult<T> {
|
|
796
|
+
pageContext: CBPageContext;
|
|
797
|
+
data: T[];
|
|
798
|
+
}
|
|
799
|
+
/**
|
|
800
|
+
* Bot group - logical grouping of bots
|
|
801
|
+
*/
|
|
802
|
+
interface CBBotGroup {
|
|
803
|
+
botGroupId: string;
|
|
804
|
+
botGroupName: string;
|
|
805
|
+
transferMessage: string;
|
|
806
|
+
channel: 'MESSAGING' | 'CHAT';
|
|
807
|
+
organizationId: string;
|
|
808
|
+
collaborationEnabled: boolean;
|
|
809
|
+
numberOfBots: number;
|
|
810
|
+
createdAt: number;
|
|
811
|
+
updatedAt: number;
|
|
812
|
+
createdBy: string | null;
|
|
813
|
+
createdByName: string | null;
|
|
814
|
+
updatedBy: string | null;
|
|
815
|
+
updatedByName: string | null;
|
|
816
|
+
}
|
|
817
|
+
/**
|
|
818
|
+
* Bot summary from bot-groups API
|
|
819
|
+
*/
|
|
820
|
+
interface CBBot {
|
|
821
|
+
botId: string;
|
|
822
|
+
botName: string;
|
|
823
|
+
botDescription: string | null;
|
|
824
|
+
botType: 'CUSTOMER_FACING_BOT' | 'POST_SURVEY_BOT' | 'AGENT_FACING_BOT';
|
|
825
|
+
channel: 'MESSAGING' | 'CHAT';
|
|
826
|
+
botLanguage: string;
|
|
827
|
+
agentAnnotationsEnabled: boolean;
|
|
828
|
+
debuggingEnabled: boolean;
|
|
829
|
+
botVersion: string;
|
|
830
|
+
entityDataSourceId: string | null;
|
|
831
|
+
skills: string[] | null;
|
|
832
|
+
publicBot: boolean;
|
|
833
|
+
organizationId: string;
|
|
834
|
+
botGroupId: string | null;
|
|
835
|
+
chatBotPlatformUserId: string;
|
|
836
|
+
createdAt: number;
|
|
837
|
+
updatedAt: number;
|
|
838
|
+
createdBy: string | null;
|
|
839
|
+
createdByName: string | null;
|
|
840
|
+
updatedBy: string | null;
|
|
841
|
+
updatedByName: string | null;
|
|
842
|
+
numberOfDialogs: number;
|
|
843
|
+
numberOfInteractions: number;
|
|
844
|
+
numberOfIntegrations: number;
|
|
845
|
+
numberOfActiveAgents: number;
|
|
846
|
+
numberOfInactiveAgents: number;
|
|
847
|
+
numberOfDomains: number;
|
|
848
|
+
numberOfIntents: number;
|
|
849
|
+
hasDisambiguation: boolean;
|
|
850
|
+
hasAutoescalation: boolean;
|
|
851
|
+
smallTalkEnabled: boolean;
|
|
852
|
+
}
|
|
853
|
+
/**
|
|
854
|
+
* Bot platform configuration
|
|
855
|
+
*/
|
|
856
|
+
interface CBBotPlatform {
|
|
857
|
+
id: string;
|
|
858
|
+
platform: string;
|
|
859
|
+
botId: string;
|
|
860
|
+
status: string;
|
|
861
|
+
integrationType: string;
|
|
862
|
+
}
|
|
863
|
+
/**
|
|
864
|
+
* Full chatbot details from chatbots API
|
|
865
|
+
*/
|
|
866
|
+
interface CBChatBot {
|
|
867
|
+
id: string;
|
|
868
|
+
name: string;
|
|
869
|
+
description: string | null;
|
|
870
|
+
personality: string | null;
|
|
871
|
+
status: string;
|
|
872
|
+
chatBotPlatformUserId: string;
|
|
873
|
+
platforms: CBBotPlatform[];
|
|
874
|
+
getStartedButtonPayload: string;
|
|
875
|
+
imageURL: string | null;
|
|
876
|
+
createdBy: string | null;
|
|
877
|
+
modifiedBy: string | null;
|
|
878
|
+
creationTime: number;
|
|
879
|
+
modificationTime: number;
|
|
880
|
+
entityDataSourceId: string | null;
|
|
881
|
+
demo: boolean;
|
|
882
|
+
language: string;
|
|
883
|
+
enterpriseIntegrations: unknown | null;
|
|
884
|
+
organizationId: string;
|
|
885
|
+
autoEscalation: unknown | null;
|
|
886
|
+
skipNLP: boolean;
|
|
887
|
+
environmentId: string | null;
|
|
888
|
+
sessionLength: number;
|
|
889
|
+
passThroughMode: boolean;
|
|
890
|
+
transcriptDisabled: boolean;
|
|
891
|
+
botTemplateId: string | null;
|
|
892
|
+
version: string;
|
|
893
|
+
defaultErrorMessage: string | null;
|
|
894
|
+
sessionExpiredMessage: string | null;
|
|
895
|
+
thankyouMessage: string | null;
|
|
896
|
+
shortenUrl: string | null;
|
|
897
|
+
chatBotType: string;
|
|
898
|
+
channel: string;
|
|
899
|
+
startDialog: string | null;
|
|
900
|
+
publicBot: boolean;
|
|
901
|
+
skillIds: string[] | null;
|
|
902
|
+
transferGroupId: string | null;
|
|
903
|
+
readOnlyBot: boolean;
|
|
904
|
+
enableDebug: boolean;
|
|
905
|
+
enableAgentAnnotations: boolean;
|
|
906
|
+
botAttributes: unknown | null;
|
|
907
|
+
voiceAttributes: unknown | null;
|
|
908
|
+
emailTranscriptId: string | null;
|
|
909
|
+
emailTranscriptSenderEmail: string | null;
|
|
910
|
+
emailTranscriptSenderName: string | null;
|
|
911
|
+
emailTranscriptEnabled: boolean | null;
|
|
912
|
+
thankYouMessageEnabled: boolean | null;
|
|
913
|
+
externalId: string | null;
|
|
914
|
+
surveyTargetingParameters: unknown | null;
|
|
915
|
+
fallbackLimit: number;
|
|
916
|
+
fallbackLimitMessage: string | null;
|
|
917
|
+
voiceType: string | null;
|
|
918
|
+
voiceGender: string | null;
|
|
919
|
+
voiceToneSetting: string | null;
|
|
920
|
+
voiceAudioCueSetting: string | null;
|
|
921
|
+
smallTalkEnabled: boolean;
|
|
922
|
+
chatBotTypeName: string;
|
|
923
|
+
voiceSupported: boolean;
|
|
924
|
+
messagingSupported: boolean;
|
|
925
|
+
}
|
|
926
|
+
/**
|
|
927
|
+
* Bot metrics
|
|
928
|
+
*/
|
|
929
|
+
interface CBChatBotMetrics {
|
|
930
|
+
chatBotId: string;
|
|
931
|
+
totalSubscribers: number;
|
|
932
|
+
totalMessages: number;
|
|
933
|
+
}
|
|
934
|
+
/**
|
|
935
|
+
* Bot summary with metrics
|
|
936
|
+
*/
|
|
937
|
+
interface CBChatBotSummary {
|
|
938
|
+
chatBot: CBChatBot;
|
|
939
|
+
chatBotMetrics: CBChatBotMetrics;
|
|
940
|
+
}
|
|
941
|
+
/**
|
|
942
|
+
* List of bot summaries
|
|
943
|
+
*/
|
|
944
|
+
interface CBChatBotSummaryList {
|
|
945
|
+
chatBotSummaryList: CBChatBotSummary[];
|
|
946
|
+
}
|
|
947
|
+
/**
|
|
948
|
+
* Dialog definition
|
|
949
|
+
*/
|
|
950
|
+
interface CBDialog {
|
|
951
|
+
chatBotId: string;
|
|
952
|
+
id: string;
|
|
953
|
+
name: string;
|
|
954
|
+
creationTime: string;
|
|
955
|
+
modificationTime: string;
|
|
956
|
+
description: string;
|
|
957
|
+
dialogType: 'DIALOG' | 'FALLBACK_DIALOG' | 'SURVEY_DIALOG';
|
|
958
|
+
status: 'ENABLED' | 'DISABLED';
|
|
959
|
+
disambiguteOnlySelectedDomains: boolean;
|
|
960
|
+
}
|
|
961
|
+
/**
|
|
962
|
+
* Dialog group container
|
|
963
|
+
*/
|
|
964
|
+
interface CBDialogGroup {
|
|
965
|
+
Group: CBDialog[];
|
|
966
|
+
}
|
|
967
|
+
/**
|
|
968
|
+
* Response match condition
|
|
969
|
+
*/
|
|
970
|
+
interface CBResponseMatch {
|
|
971
|
+
name?: string;
|
|
972
|
+
conditions: unknown[];
|
|
973
|
+
contextConditions: unknown[];
|
|
974
|
+
contextMatchConditionType?: string;
|
|
975
|
+
action: {
|
|
976
|
+
name: string;
|
|
977
|
+
value: string;
|
|
978
|
+
};
|
|
979
|
+
contextDataVariables: unknown[];
|
|
980
|
+
}
|
|
981
|
+
/**
|
|
982
|
+
* Tile data for interaction content
|
|
983
|
+
*/
|
|
984
|
+
interface CBTileData {
|
|
985
|
+
text?: string;
|
|
986
|
+
buttons: unknown[];
|
|
987
|
+
quickReplyList: unknown[];
|
|
988
|
+
sampleUserInput?: string;
|
|
989
|
+
escalation?: {
|
|
990
|
+
tangoContextEnabled: boolean;
|
|
991
|
+
};
|
|
992
|
+
}
|
|
993
|
+
/**
|
|
994
|
+
* Interaction content definition
|
|
995
|
+
*/
|
|
996
|
+
interface CBInteractionContent {
|
|
997
|
+
contentType: 'STATIC' | 'DYNAMIC';
|
|
998
|
+
results?: {
|
|
999
|
+
type: string;
|
|
1000
|
+
tile: {
|
|
1001
|
+
tileData: CBTileData[];
|
|
1002
|
+
};
|
|
1003
|
+
};
|
|
1004
|
+
responderName?: string;
|
|
1005
|
+
responderId?: string;
|
|
1006
|
+
}
|
|
1007
|
+
/**
|
|
1008
|
+
* Interaction definition
|
|
1009
|
+
*/
|
|
1010
|
+
interface CBInteraction {
|
|
1011
|
+
id: string;
|
|
1012
|
+
chatBotId: string;
|
|
1013
|
+
userInputRequired: boolean;
|
|
1014
|
+
name: string;
|
|
1015
|
+
pattern?: string[];
|
|
1016
|
+
type: string;
|
|
1017
|
+
content: CBInteractionContent;
|
|
1018
|
+
preProcessMessage?: string;
|
|
1019
|
+
postProcessMessage?: string;
|
|
1020
|
+
group: string;
|
|
1021
|
+
status: 'ACTIVE' | 'INACTIVE';
|
|
1022
|
+
required?: boolean;
|
|
1023
|
+
nextMessageId?: string;
|
|
1024
|
+
prevMessageId?: string;
|
|
1025
|
+
responseMatches: CBResponseMatch[];
|
|
1026
|
+
interactionType: string;
|
|
1027
|
+
changeResponse?: {
|
|
1028
|
+
enabled: boolean;
|
|
1029
|
+
};
|
|
1030
|
+
cancelResponse?: {
|
|
1031
|
+
enabled: boolean;
|
|
1032
|
+
};
|
|
1033
|
+
comment?: {
|
|
1034
|
+
content: string;
|
|
1035
|
+
lastCommenterName: string;
|
|
1036
|
+
lastCommenterId: string;
|
|
1037
|
+
lastModifiedDate: number;
|
|
1038
|
+
};
|
|
1039
|
+
}
|
|
1040
|
+
/**
|
|
1041
|
+
* List of interactions
|
|
1042
|
+
*/
|
|
1043
|
+
interface CBInteractionList {
|
|
1044
|
+
message: CBInteraction[];
|
|
1045
|
+
pcsSynchronizationWithAcChecked?: boolean;
|
|
1046
|
+
}
|
|
1047
|
+
/**
|
|
1048
|
+
* Duplicate phrase info
|
|
1049
|
+
*/
|
|
1050
|
+
interface CBDuplicatePhrase {
|
|
1051
|
+
normalizedPhrase: string;
|
|
1052
|
+
duplicatePhrases: {
|
|
1053
|
+
intentId: string;
|
|
1054
|
+
intentName: string;
|
|
1055
|
+
phrase: string;
|
|
1056
|
+
}[];
|
|
1057
|
+
}
|
|
1058
|
+
/**
|
|
1059
|
+
* Duplicate phrases container
|
|
1060
|
+
*/
|
|
1061
|
+
interface CBDuplicatePhrases {
|
|
1062
|
+
duplicates: CBDuplicatePhrase[];
|
|
1063
|
+
domainId: string;
|
|
1064
|
+
}
|
|
1065
|
+
/**
|
|
1066
|
+
* NLU Domain definition
|
|
1067
|
+
*/
|
|
1068
|
+
interface CBNLUDomain {
|
|
1069
|
+
id: string;
|
|
1070
|
+
name: string;
|
|
1071
|
+
chatBotPlatformUserId: string;
|
|
1072
|
+
organizationId: string;
|
|
1073
|
+
status: 'ACTIVE' | 'INACTIVE';
|
|
1074
|
+
creationTime: string;
|
|
1075
|
+
modificationTime: string;
|
|
1076
|
+
modifiedBy: string;
|
|
1077
|
+
enableKeyPhraseMatch: boolean;
|
|
1078
|
+
keyPhraseMatchThreshold: number;
|
|
1079
|
+
type: string;
|
|
1080
|
+
intentUploadFileName?: string;
|
|
1081
|
+
entityUploadFileName?: string;
|
|
1082
|
+
duplicatePhrases?: CBDuplicatePhrases;
|
|
1083
|
+
nluShareDataAgree: boolean;
|
|
1084
|
+
migrationNluShareDataAgreeTs: number;
|
|
1085
|
+
acceptMaskedMessages: boolean;
|
|
1086
|
+
language?: string;
|
|
1087
|
+
domainOrigin: 'USER' | 'GLOBAL';
|
|
1088
|
+
verticalType?: string;
|
|
1089
|
+
verticalName?: string;
|
|
1090
|
+
primary: boolean;
|
|
1091
|
+
intentAnalyzerEnabled: boolean;
|
|
1092
|
+
hasLiveIntents: boolean;
|
|
1093
|
+
}
|
|
1094
|
+
/**
|
|
1095
|
+
* NLU Domain list container
|
|
1096
|
+
*/
|
|
1097
|
+
interface CBDomainList {
|
|
1098
|
+
DomainList: CBNLUDomain[];
|
|
1099
|
+
}
|
|
1100
|
+
/**
|
|
1101
|
+
* Intent definition
|
|
1102
|
+
*/
|
|
1103
|
+
interface CBIntent {
|
|
1104
|
+
id: string;
|
|
1105
|
+
name: string;
|
|
1106
|
+
domainId: string;
|
|
1107
|
+
status: 'ACTIVE' | 'INACTIVE';
|
|
1108
|
+
trainingPhrases?: string[];
|
|
1109
|
+
creationTime?: string;
|
|
1110
|
+
modificationTime?: string;
|
|
1111
|
+
}
|
|
1112
|
+
/**
|
|
1113
|
+
* Knowledge base landing page metrics
|
|
1114
|
+
*/
|
|
1115
|
+
interface CBKBLandingPageMetrics {
|
|
1116
|
+
kbId: string;
|
|
1117
|
+
organizationId: string;
|
|
1118
|
+
numOfTotalArticles: number;
|
|
1119
|
+
numOfActiveArticles: number;
|
|
1120
|
+
numOfRedundantArticles?: number;
|
|
1121
|
+
numOfConflictingArticles?: number;
|
|
1122
|
+
numOfArticlesHaveIntents: number;
|
|
1123
|
+
lastContentUpdatedTime: number;
|
|
1124
|
+
connectedBots?: string[];
|
|
1125
|
+
connectedConvAssistSkills?: string[];
|
|
1126
|
+
modifiedTime: number;
|
|
1127
|
+
createdTime: number;
|
|
1128
|
+
}
|
|
1129
|
+
/**
|
|
1130
|
+
* Sync status details for knowledge base
|
|
1131
|
+
*/
|
|
1132
|
+
interface CBSyncStatusDetails {
|
|
1133
|
+
syncStatus: 'COMPLETED' | 'IN_PROGRESS' | 'FAILED';
|
|
1134
|
+
syncStatusMessage: string | null;
|
|
1135
|
+
syncTime: number;
|
|
1136
|
+
}
|
|
1137
|
+
/**
|
|
1138
|
+
* Knowledge base definition
|
|
1139
|
+
*/
|
|
1140
|
+
interface CBKnowledgeBase {
|
|
1141
|
+
createdByName: string;
|
|
1142
|
+
modifiedByName: string;
|
|
1143
|
+
id: string;
|
|
1144
|
+
name: string;
|
|
1145
|
+
type: 'KnowledgeBase';
|
|
1146
|
+
googleSheetUrl?: string;
|
|
1147
|
+
chatBotPlatformUserId: string;
|
|
1148
|
+
status: 'ACTIVE' | 'INACTIVE';
|
|
1149
|
+
modificationTime?: string;
|
|
1150
|
+
syncStatusDetails?: CBSyncStatusDetails;
|
|
1151
|
+
dataSourceConfiguration: {
|
|
1152
|
+
properties: Record<string, unknown>;
|
|
1153
|
+
};
|
|
1154
|
+
organizationId: string;
|
|
1155
|
+
privateAccess: boolean;
|
|
1156
|
+
language: string;
|
|
1157
|
+
langCode: string;
|
|
1158
|
+
entitiesAvailable: boolean;
|
|
1159
|
+
intentAssociationType?: string;
|
|
1160
|
+
entitiesDataSourceId?: string;
|
|
1161
|
+
publicKB: boolean;
|
|
1162
|
+
createdAt: number;
|
|
1163
|
+
modifiedAt: number;
|
|
1164
|
+
createdBy: string;
|
|
1165
|
+
modifiedBy: string;
|
|
1166
|
+
kbConfigProperties: {
|
|
1167
|
+
enableAssessments?: string;
|
|
1168
|
+
llmEnrichment: string;
|
|
1169
|
+
kms_secret?: string;
|
|
1170
|
+
type?: string;
|
|
1171
|
+
};
|
|
1172
|
+
domainType?: string;
|
|
1173
|
+
kBLandingPageMetrics?: CBKBLandingPageMetrics;
|
|
1174
|
+
}
|
|
1175
|
+
/**
|
|
1176
|
+
* Knowledge base list container
|
|
1177
|
+
*/
|
|
1178
|
+
interface CBKnowledgeBaseList {
|
|
1179
|
+
KnowledgeDataSource: CBKnowledgeBase[];
|
|
1180
|
+
}
|
|
1181
|
+
/**
|
|
1182
|
+
* Knowledge base detail container
|
|
1183
|
+
*/
|
|
1184
|
+
interface CBKnowledgeBaseDetail {
|
|
1185
|
+
KnowledgeDataSource: CBKnowledgeBase;
|
|
1186
|
+
}
|
|
1187
|
+
/**
|
|
1188
|
+
* Knowledge base article
|
|
1189
|
+
*/
|
|
1190
|
+
interface CBKBArticle {
|
|
1191
|
+
id: string;
|
|
1192
|
+
kbId: string;
|
|
1193
|
+
title: string;
|
|
1194
|
+
summary?: string;
|
|
1195
|
+
content?: string;
|
|
1196
|
+
status: 'ACTIVE' | 'INACTIVE';
|
|
1197
|
+
tags?: string[];
|
|
1198
|
+
intents?: string[];
|
|
1199
|
+
createdAt: number;
|
|
1200
|
+
modifiedAt: number;
|
|
1201
|
+
createdBy: string;
|
|
1202
|
+
modifiedBy: string;
|
|
1203
|
+
}
|
|
1204
|
+
/**
|
|
1205
|
+
* KAI search request
|
|
1206
|
+
*/
|
|
1207
|
+
interface CBKAISearchRequest {
|
|
1208
|
+
llmConfig?: {
|
|
1209
|
+
promptId?: string;
|
|
1210
|
+
promptName?: string;
|
|
1211
|
+
llmEnrichment?: boolean;
|
|
1212
|
+
promptTemplate?: string;
|
|
1213
|
+
};
|
|
1214
|
+
numberOfAnswers?: number;
|
|
1215
|
+
mode?: string;
|
|
1216
|
+
confidenceLevel?: string;
|
|
1217
|
+
status?: string;
|
|
1218
|
+
consumerQuery: string;
|
|
1219
|
+
isPreview?: boolean;
|
|
1220
|
+
kaiClient?: string;
|
|
1221
|
+
}
|
|
1222
|
+
/**
|
|
1223
|
+
* KAI search result item
|
|
1224
|
+
*/
|
|
1225
|
+
interface CBKAISearchResultItem {
|
|
1226
|
+
articleId: string;
|
|
1227
|
+
title: string;
|
|
1228
|
+
content: string;
|
|
1229
|
+
score: number;
|
|
1230
|
+
summary?: string;
|
|
1231
|
+
}
|
|
1232
|
+
/**
|
|
1233
|
+
* KAI search response
|
|
1234
|
+
*/
|
|
1235
|
+
interface CBKAISearchResponse {
|
|
1236
|
+
results: CBKAISearchResultItem[];
|
|
1237
|
+
generatedAnswer?: string;
|
|
1238
|
+
metadata?: Record<string, unknown>;
|
|
1239
|
+
}
|
|
1240
|
+
/**
|
|
1241
|
+
* KAI On-Demand configuration
|
|
1242
|
+
*/
|
|
1243
|
+
interface CBKAIOnDemandConfig {
|
|
1244
|
+
id: string;
|
|
1245
|
+
name: string;
|
|
1246
|
+
kbId: string;
|
|
1247
|
+
enabled: boolean;
|
|
1248
|
+
settings: Record<string, unknown>;
|
|
1249
|
+
}
|
|
1250
|
+
/**
|
|
1251
|
+
* Bot user (agent connector)
|
|
1252
|
+
*/
|
|
1253
|
+
interface CBBotUser {
|
|
1254
|
+
lpUserId: string;
|
|
1255
|
+
lpAccountId: string;
|
|
1256
|
+
lpAccountUser: string;
|
|
1257
|
+
botId: string;
|
|
1258
|
+
chatBotId: string;
|
|
1259
|
+
deploymentEnvironment: 'PRODUCTION' | 'STAGING';
|
|
1260
|
+
type: 'messaging' | 'chat';
|
|
1261
|
+
configurations: {
|
|
1262
|
+
lpUserRole: string;
|
|
1263
|
+
enableAccessibility: boolean;
|
|
1264
|
+
tileDisplay: string;
|
|
1265
|
+
};
|
|
1266
|
+
}
|
|
1267
|
+
/**
|
|
1268
|
+
* Bot instance status
|
|
1269
|
+
*/
|
|
1270
|
+
interface CBBotInstanceStatus {
|
|
1271
|
+
botId: string;
|
|
1272
|
+
status: 'RUNNING' | 'STOPPED' | 'ERROR';
|
|
1273
|
+
lpAccountId: string;
|
|
1274
|
+
lpAccountUser: string;
|
|
1275
|
+
}
|
|
1276
|
+
/**
|
|
1277
|
+
* Add bot agent request
|
|
1278
|
+
*/
|
|
1279
|
+
interface CBAddBotAgentRequest {
|
|
1280
|
+
lpAccountId: string;
|
|
1281
|
+
lpAccountUser: string;
|
|
1282
|
+
lpUserId: string;
|
|
1283
|
+
botId: string;
|
|
1284
|
+
deploymentEnvironment: 'PRODUCTION' | 'STAGING';
|
|
1285
|
+
type: 'messaging' | 'chat';
|
|
1286
|
+
configurations: {
|
|
1287
|
+
lpUserRole: string;
|
|
1288
|
+
enableAccessibility: boolean;
|
|
1289
|
+
tileDisplay: string;
|
|
1290
|
+
};
|
|
1291
|
+
}
|
|
1292
|
+
/**
|
|
1293
|
+
* Responder (API integration)
|
|
1294
|
+
*/
|
|
1295
|
+
interface CBResponder {
|
|
1296
|
+
id: string;
|
|
1297
|
+
chatBotId: string;
|
|
1298
|
+
name: string;
|
|
1299
|
+
type: string;
|
|
1300
|
+
url?: string;
|
|
1301
|
+
method?: string;
|
|
1302
|
+
headers?: Record<string, string>;
|
|
1303
|
+
body?: string;
|
|
1304
|
+
responseMapping?: Record<string, string>;
|
|
1305
|
+
}
|
|
1306
|
+
/**
|
|
1307
|
+
* Global functions code
|
|
1308
|
+
*/
|
|
1309
|
+
interface CBGlobalFunctions {
|
|
1310
|
+
chatBotId: string;
|
|
1311
|
+
code: string;
|
|
1312
|
+
lastModified: number;
|
|
1313
|
+
lastModifiedBy: string;
|
|
1314
|
+
}
|
|
1315
|
+
/**
|
|
1316
|
+
* Bot environment configuration
|
|
1317
|
+
*/
|
|
1318
|
+
interface CBBotEnvironment {
|
|
1319
|
+
id: string;
|
|
1320
|
+
name: string;
|
|
1321
|
+
description: string;
|
|
1322
|
+
variables: Record<string, string>;
|
|
1323
|
+
}
|
|
1324
|
+
/**
|
|
1325
|
+
* LivePerson app credentials for bot
|
|
1326
|
+
*/
|
|
1327
|
+
interface CBLPAppCredentials {
|
|
1328
|
+
chatBotId: string;
|
|
1329
|
+
appKey: string;
|
|
1330
|
+
appSecret: string;
|
|
1331
|
+
accessToken: string;
|
|
1332
|
+
accessTokenSecret: string;
|
|
1333
|
+
}
|
|
1334
|
+
/**
|
|
1335
|
+
* LP Skill from CB external integrations API
|
|
1336
|
+
*/
|
|
1337
|
+
interface CBLPSkill {
|
|
1338
|
+
id: number;
|
|
1339
|
+
name: string;
|
|
1340
|
+
description: string;
|
|
1341
|
+
maxWaitTime: number;
|
|
1342
|
+
defaultTimeToHold: number;
|
|
1343
|
+
}
|
|
1344
|
+
/**
|
|
1345
|
+
* Knowledge base content source
|
|
1346
|
+
*/
|
|
1347
|
+
interface CBKBContentSource {
|
|
1348
|
+
id: string;
|
|
1349
|
+
kbId: string;
|
|
1350
|
+
name: string;
|
|
1351
|
+
type: string;
|
|
1352
|
+
status: 'ACTIVE' | 'INACTIVE';
|
|
1353
|
+
url?: string;
|
|
1354
|
+
lastSyncTime?: number;
|
|
1355
|
+
settings?: Record<string, unknown>;
|
|
1356
|
+
}
|
|
1357
|
+
/**
|
|
1358
|
+
* Dialog template summary
|
|
1359
|
+
*/
|
|
1360
|
+
interface CBDialogTemplateSummary {
|
|
1361
|
+
id: string;
|
|
1362
|
+
name: string;
|
|
1363
|
+
description: string;
|
|
1364
|
+
category: string;
|
|
1365
|
+
preview?: string;
|
|
1366
|
+
}
|
|
1367
|
+
/**
|
|
1368
|
+
* CB credential entry
|
|
1369
|
+
*/
|
|
1370
|
+
interface CBCredential {
|
|
1371
|
+
id: string;
|
|
1372
|
+
name: string;
|
|
1373
|
+
type: string;
|
|
1374
|
+
organizationId: string;
|
|
1375
|
+
createdAt: number;
|
|
1376
|
+
updatedAt: number;
|
|
1377
|
+
}
|
|
1378
|
+
/**
|
|
1379
|
+
* Bot groups query parameters
|
|
1380
|
+
*/
|
|
1381
|
+
interface CBBotGroupsQueryParams {
|
|
1382
|
+
page?: number;
|
|
1383
|
+
size?: number;
|
|
1384
|
+
expandAll?: boolean;
|
|
1385
|
+
}
|
|
1386
|
+
/**
|
|
1387
|
+
* Bots by group query parameters
|
|
1388
|
+
*/
|
|
1389
|
+
interface CBBotsByGroupQueryParams {
|
|
1390
|
+
botGroupId?: string;
|
|
1391
|
+
sortBy?: string;
|
|
1392
|
+
page?: number;
|
|
1393
|
+
size?: number;
|
|
1394
|
+
}
|
|
1395
|
+
/**
|
|
1396
|
+
* KB articles query parameters
|
|
1397
|
+
*/
|
|
1398
|
+
interface CBKBArticlesQueryParams {
|
|
1399
|
+
page?: number;
|
|
1400
|
+
size?: number;
|
|
1401
|
+
sortAscByLastModificationTime?: boolean;
|
|
1402
|
+
articleIds?: string[];
|
|
1403
|
+
includeConflictingDetails?: boolean;
|
|
1404
|
+
}
|
|
1405
|
+
/**
|
|
1406
|
+
* All bot agents status query parameters
|
|
1407
|
+
*/
|
|
1408
|
+
interface CBAllBotAgentsStatusQueryParams {
|
|
1409
|
+
environment?: 'PRODUCTION' | 'STAGING';
|
|
1410
|
+
}
|
|
1411
|
+
/**
|
|
1412
|
+
* PCS bots status query parameters
|
|
1413
|
+
*/
|
|
1414
|
+
interface CBPCSBotsStatusQueryParams {
|
|
1415
|
+
showBotsData?: boolean;
|
|
1416
|
+
}
|
|
1417
|
+
/**
|
|
1418
|
+
* Event types for consumer query metrics
|
|
1419
|
+
*/
|
|
1420
|
+
type CBConsumerQueryEventType = 'EVENT_KB_ANSWERED' | 'EVENT_KB_UN_ANSWERED';
|
|
1421
|
+
/**
|
|
1422
|
+
* Consumer query metrics request parameters
|
|
1423
|
+
*/
|
|
1424
|
+
interface CBConsumerQueryMetricsParams {
|
|
1425
|
+
/** Start time in milliseconds since epoch */
|
|
1426
|
+
startTime: string | number;
|
|
1427
|
+
/** End time in milliseconds since epoch */
|
|
1428
|
+
endTime: string | number;
|
|
1429
|
+
/** Event types to retrieve */
|
|
1430
|
+
eventType: CBConsumerQueryEventType[];
|
|
1431
|
+
/** Knowledge Base ID */
|
|
1432
|
+
kbId: string;
|
|
1433
|
+
}
|
|
1434
|
+
/**
|
|
1435
|
+
* Individual consumer query metric record
|
|
1436
|
+
*/
|
|
1437
|
+
interface CBConsumerQueryMetric {
|
|
1438
|
+
/** Unique identifier for the metric */
|
|
1439
|
+
id?: string;
|
|
1440
|
+
/** The consumer's query */
|
|
1441
|
+
consumerQuery: string;
|
|
1442
|
+
/** Event type (answered or unanswered) */
|
|
1443
|
+
eventType: CBConsumerQueryEventType;
|
|
1444
|
+
/** Knowledge base ID */
|
|
1445
|
+
kbId: string;
|
|
1446
|
+
/** Timestamp of the query */
|
|
1447
|
+
timestamp: number;
|
|
1448
|
+
/** Article IDs that matched (for answered queries) */
|
|
1449
|
+
articleIds?: string[];
|
|
1450
|
+
/** Confidence score (for answered queries) */
|
|
1451
|
+
confidence?: number;
|
|
1452
|
+
/** Session/conversation ID */
|
|
1453
|
+
conversationId?: string;
|
|
1454
|
+
/** Additional metadata */
|
|
1455
|
+
metadata?: Record<string, unknown>;
|
|
1456
|
+
}
|
|
1457
|
+
/**
|
|
1458
|
+
* Response from consumer query metrics API
|
|
1459
|
+
*/
|
|
1460
|
+
interface CBConsumerQueryMetricsResponse {
|
|
1461
|
+
/** Array of query metrics */
|
|
1462
|
+
data: CBConsumerQueryMetric[];
|
|
1463
|
+
/** Total count of records */
|
|
1464
|
+
totalCount?: number;
|
|
1465
|
+
/** Whether more records exist */
|
|
1466
|
+
hasMore?: boolean;
|
|
1467
|
+
}
|
|
1468
|
+
/**
|
|
1469
|
+
* Extended query params for date ranges > 7 days
|
|
1470
|
+
*/
|
|
1471
|
+
interface CBConsumerQueryMetricsExtendedParams {
|
|
1472
|
+
/** Start date (Date object or timestamp) */
|
|
1473
|
+
startDate: Date | number;
|
|
1474
|
+
/** End date (Date object or timestamp) */
|
|
1475
|
+
endDate: Date | number;
|
|
1476
|
+
/** Event types to retrieve */
|
|
1477
|
+
eventType: CBConsumerQueryEventType[];
|
|
1478
|
+
/** Knowledge Base ID */
|
|
1479
|
+
kbId: string;
|
|
1480
|
+
/** Optional progress callback */
|
|
1481
|
+
onProgress?: (completed: number, total: number) => void;
|
|
1482
|
+
}
|
|
1483
|
+
|
|
768
1484
|
/**
|
|
769
1485
|
* AI Studio Types
|
|
770
1486
|
*
|
|
@@ -1436,11 +2152,20 @@ interface LPExtendSDKConfig {
|
|
|
1436
2152
|
* LP Access token (obtained from shell auth)
|
|
1437
2153
|
* This is the user's LP bearer token passed to the child app.
|
|
1438
2154
|
*
|
|
1439
|
-
* Either provide this directly OR provide extendToken OR provide shellToken.
|
|
2155
|
+
* Either provide this directly OR provide extendToken OR provide shellToken OR provide apiKey.
|
|
1440
2156
|
*/
|
|
1441
2157
|
accessToken?: string;
|
|
1442
2158
|
/**
|
|
1443
|
-
*
|
|
2159
|
+
* LP Extend API Key (RECOMMENDED for backend apps)
|
|
2160
|
+
* Your app's API key from LP Extend shell registration.
|
|
2161
|
+
* SDK will authenticate with shell and get LP access token.
|
|
2162
|
+
*
|
|
2163
|
+
* Set via environment variable: LPEXTEND_API_KEY
|
|
2164
|
+
* @example 'lpx_my-app_abc123...'
|
|
2165
|
+
*/
|
|
2166
|
+
apiKey?: string;
|
|
2167
|
+
/**
|
|
2168
|
+
* ExtendJWT token (for iframe apps receiving token from shell)
|
|
1444
2169
|
* Encrypted JWT from shell containing all auth data.
|
|
1445
2170
|
* SDK will verify with shell and get LP access token.
|
|
1446
2171
|
*
|
|
@@ -1453,13 +2178,13 @@ interface LPExtendSDKConfig {
|
|
|
1453
2178
|
* fetch the LP access token from the shell during initialization.
|
|
1454
2179
|
*
|
|
1455
2180
|
* @example Received via URL params: ?shellToken=xxx
|
|
1456
|
-
* @deprecated Use extendToken
|
|
2181
|
+
* @deprecated Use apiKey for backend apps or extendToken for iframe apps
|
|
1457
2182
|
*/
|
|
1458
2183
|
shellToken?: string;
|
|
1459
2184
|
/**
|
|
1460
2185
|
* Shell backend base URL
|
|
1461
|
-
* Required when using extendToken or shellToken for automatic token retrieval.
|
|
1462
|
-
* @default Derived from window.location.origin or
|
|
2186
|
+
* Required when using apiKey, extendToken, or shellToken for automatic token retrieval.
|
|
2187
|
+
* @default Derived from window.location.origin, parent frame, or LPEXTEND_SHELL_URL env var
|
|
1463
2188
|
* @example 'https://lp-extend.example.com'
|
|
1464
2189
|
*/
|
|
1465
2190
|
shellBaseUrl?: string;
|
|
@@ -1626,6 +2351,32 @@ interface ShellTokenResponse {
|
|
|
1626
2351
|
*/
|
|
1627
2352
|
cbOrg?: string;
|
|
1628
2353
|
}
|
|
2354
|
+
/**
|
|
2355
|
+
* Response from API key authentication
|
|
2356
|
+
* Child apps call shell's /api/v1/apps/auth endpoint with API key
|
|
2357
|
+
*/
|
|
2358
|
+
interface ApiKeyAuthResponse {
|
|
2359
|
+
/** Authentication success */
|
|
2360
|
+
authenticated: boolean;
|
|
2361
|
+
/** LP Bearer access token for API calls */
|
|
2362
|
+
lpAccessToken: string;
|
|
2363
|
+
/** LP User ID */
|
|
2364
|
+
lpUserId: string;
|
|
2365
|
+
/** LP Account ID */
|
|
2366
|
+
lpAccountId: string;
|
|
2367
|
+
/** Is LPA user */
|
|
2368
|
+
isLPA: boolean;
|
|
2369
|
+
/** APIs this app has access to */
|
|
2370
|
+
allowedApis: string[];
|
|
2371
|
+
/** App name from registration */
|
|
2372
|
+
appName: string;
|
|
2373
|
+
/** Conversation Builder token */
|
|
2374
|
+
cbToken?: string;
|
|
2375
|
+
/** Conversation Builder org */
|
|
2376
|
+
cbOrg?: string;
|
|
2377
|
+
/** Token expiration timestamp (Unix ms) */
|
|
2378
|
+
expiresAt: number;
|
|
2379
|
+
}
|
|
1629
2380
|
|
|
1630
2381
|
/**
|
|
1631
2382
|
* HTTP Client
|
|
@@ -2618,6 +3369,320 @@ declare class LPPromptsAPI {
|
|
|
2618
3369
|
getLLMProviders(): Promise<APIResponse<LPLLMProviderSubscription[]>>;
|
|
2619
3370
|
}
|
|
2620
3371
|
|
|
3372
|
+
/**
|
|
3373
|
+
* Conversation Builder API Module
|
|
3374
|
+
*
|
|
3375
|
+
* Provides access to LivePerson's Conversation Builder (CB) and Knowledge AI (KAI) APIs.
|
|
3376
|
+
* Manages bots, dialogs, interactions, knowledge bases, and NLU domains.
|
|
3377
|
+
*
|
|
3378
|
+
* CB APIs use a separate authentication mechanism (cbToken + organizationId) obtained
|
|
3379
|
+
* via sentinel.authenticateCB() or from ExtendJWT verification.
|
|
3380
|
+
*/
|
|
3381
|
+
|
|
3382
|
+
/**
|
|
3383
|
+
* CB Authentication credentials
|
|
3384
|
+
*/
|
|
3385
|
+
interface CBAuthCredentials {
|
|
3386
|
+
/** CB API access token */
|
|
3387
|
+
cbToken: string;
|
|
3388
|
+
/** CB organization ID */
|
|
3389
|
+
organizationId: string;
|
|
3390
|
+
}
|
|
3391
|
+
/**
|
|
3392
|
+
* Conversation Builder API
|
|
3393
|
+
*
|
|
3394
|
+
* Provides methods for interacting with CB/KAI APIs.
|
|
3395
|
+
* Requires CB authentication credentials (cbToken + organizationId).
|
|
3396
|
+
*
|
|
3397
|
+
* @example
|
|
3398
|
+
* ```typescript
|
|
3399
|
+
* // Get CB credentials from sentinel or ExtendJWT verification
|
|
3400
|
+
* const cbAuth = await sdk.sentinel.authenticateCB();
|
|
3401
|
+
* const cbCreds = {
|
|
3402
|
+
* cbToken: cbAuth.successResult.apiAccessToken,
|
|
3403
|
+
* organizationId: cbAuth.successResult.sessionOrganizationId,
|
|
3404
|
+
* };
|
|
3405
|
+
*
|
|
3406
|
+
* // Initialize CB API with credentials
|
|
3407
|
+
* sdk.conversationBuilder.setCredentials(cbCreds);
|
|
3408
|
+
*
|
|
3409
|
+
* // Now use CB APIs
|
|
3410
|
+
* const bots = await sdk.conversationBuilder.getBots();
|
|
3411
|
+
* const kbs = await sdk.conversationBuilder.knowledgeBases.getAll();
|
|
3412
|
+
* ```
|
|
3413
|
+
*/
|
|
3414
|
+
declare class ConversationBuilderAPI {
|
|
3415
|
+
private readonly accountId;
|
|
3416
|
+
private domainResolver;
|
|
3417
|
+
private credentials;
|
|
3418
|
+
private debug;
|
|
3419
|
+
private timeout;
|
|
3420
|
+
/** Bot Groups API */
|
|
3421
|
+
readonly botGroups: BotGroupsAPI;
|
|
3422
|
+
/** Bots API */
|
|
3423
|
+
readonly bots: BotsAPI;
|
|
3424
|
+
/** Dialogs API */
|
|
3425
|
+
readonly dialogs: DialogsAPI;
|
|
3426
|
+
/** Interactions API */
|
|
3427
|
+
readonly interactions: InteractionsAPI;
|
|
3428
|
+
/** NLU Domains API */
|
|
3429
|
+
readonly nluDomains: NLUDomainsAPI;
|
|
3430
|
+
/** Knowledge Bases API (KAI) */
|
|
3431
|
+
readonly knowledgeBases: KnowledgeBasesAPI;
|
|
3432
|
+
/** Bot Agents API */
|
|
3433
|
+
readonly botAgents: BotAgentsAPI;
|
|
3434
|
+
/** Integrations/Responders API */
|
|
3435
|
+
readonly integrations: IntegrationsAPI;
|
|
3436
|
+
constructor(accountId: string, debug?: boolean, timeout?: number);
|
|
3437
|
+
/**
|
|
3438
|
+
* Set CB authentication credentials
|
|
3439
|
+
* Must be called before making any CB API calls
|
|
3440
|
+
*/
|
|
3441
|
+
setCredentials(credentials: CBAuthCredentials): void;
|
|
3442
|
+
/**
|
|
3443
|
+
* Check if credentials are set
|
|
3444
|
+
*/
|
|
3445
|
+
hasCredentials(): boolean;
|
|
3446
|
+
/**
|
|
3447
|
+
* Get the current credentials
|
|
3448
|
+
* @throws If credentials not set
|
|
3449
|
+
*/
|
|
3450
|
+
getCredentials(): CBAuthCredentials;
|
|
3451
|
+
/**
|
|
3452
|
+
* Get the account ID
|
|
3453
|
+
*/
|
|
3454
|
+
getAccountId(): string;
|
|
3455
|
+
/**
|
|
3456
|
+
* Get domain for a CB service
|
|
3457
|
+
*/
|
|
3458
|
+
getDomain(service: string): Promise<string>;
|
|
3459
|
+
/**
|
|
3460
|
+
* Make authenticated request to CB API
|
|
3461
|
+
*/
|
|
3462
|
+
request<T>(service: string, path: string, options?: {
|
|
3463
|
+
method?: 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH';
|
|
3464
|
+
body?: unknown;
|
|
3465
|
+
params?: Record<string, string | number | boolean | undefined>;
|
|
3466
|
+
}): Promise<T>;
|
|
3467
|
+
/**
|
|
3468
|
+
* Debug logging
|
|
3469
|
+
*/
|
|
3470
|
+
private log;
|
|
3471
|
+
}
|
|
3472
|
+
/**
|
|
3473
|
+
* Bot Groups API
|
|
3474
|
+
*/
|
|
3475
|
+
declare class BotGroupsAPI {
|
|
3476
|
+
private readonly cb;
|
|
3477
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3478
|
+
/**
|
|
3479
|
+
* Get all bot groups
|
|
3480
|
+
*/
|
|
3481
|
+
getAll(params?: CBBotGroupsQueryParams): Promise<CBPaginatedResult<CBBotGroup> | CBBotGroup[]>;
|
|
3482
|
+
/**
|
|
3483
|
+
* Get bots by group
|
|
3484
|
+
*/
|
|
3485
|
+
getBots(params?: CBBotsByGroupQueryParams): Promise<CBPaginatedResult<CBBot>>;
|
|
3486
|
+
}
|
|
3487
|
+
/**
|
|
3488
|
+
* Bots API
|
|
3489
|
+
*/
|
|
3490
|
+
declare class BotsAPI {
|
|
3491
|
+
private readonly cb;
|
|
3492
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3493
|
+
/**
|
|
3494
|
+
* Get all bots (legacy chatbots endpoint)
|
|
3495
|
+
*/
|
|
3496
|
+
getAll(): Promise<CBChatBotSummaryList>;
|
|
3497
|
+
/**
|
|
3498
|
+
* Get chatbot by ID
|
|
3499
|
+
*/
|
|
3500
|
+
getById(chatBotId: string): Promise<CBChatBot>;
|
|
3501
|
+
/**
|
|
3502
|
+
* Get global functions for a bot
|
|
3503
|
+
*/
|
|
3504
|
+
getGlobalFunctions(botId: string): Promise<CBGlobalFunctions>;
|
|
3505
|
+
/**
|
|
3506
|
+
* Get LP app credentials for a bot
|
|
3507
|
+
*/
|
|
3508
|
+
getLPAppCredentials(chatBotId: string): Promise<CBLPAppCredentials>;
|
|
3509
|
+
/**
|
|
3510
|
+
* Get bot environment variables
|
|
3511
|
+
*/
|
|
3512
|
+
getEnvironment(): Promise<CBApiResponse<CBBotEnvironment[]>>;
|
|
3513
|
+
}
|
|
3514
|
+
/**
|
|
3515
|
+
* Dialogs API
|
|
3516
|
+
*/
|
|
3517
|
+
declare class DialogsAPI {
|
|
3518
|
+
private readonly cb;
|
|
3519
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3520
|
+
/**
|
|
3521
|
+
* Get all dialogs for a bot
|
|
3522
|
+
*/
|
|
3523
|
+
getByBotId(botId: string): Promise<CBDialogGroup>;
|
|
3524
|
+
/**
|
|
3525
|
+
* Get dialog template summaries
|
|
3526
|
+
*/
|
|
3527
|
+
getTemplateSummary(): Promise<CBDialogTemplateSummary[]>;
|
|
3528
|
+
}
|
|
3529
|
+
/**
|
|
3530
|
+
* Interactions API
|
|
3531
|
+
*/
|
|
3532
|
+
declare class InteractionsAPI {
|
|
3533
|
+
private readonly cb;
|
|
3534
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3535
|
+
/**
|
|
3536
|
+
* Get all interactions for a bot
|
|
3537
|
+
*/
|
|
3538
|
+
getByBotId(botId: string): Promise<CBInteractionList>;
|
|
3539
|
+
}
|
|
3540
|
+
/**
|
|
3541
|
+
* NLU Domains API
|
|
3542
|
+
*/
|
|
3543
|
+
declare class NLUDomainsAPI {
|
|
3544
|
+
private readonly cb;
|
|
3545
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3546
|
+
/**
|
|
3547
|
+
* Get all NLU domains for the organization
|
|
3548
|
+
*/
|
|
3549
|
+
getAll(): Promise<CBDomainList>;
|
|
3550
|
+
/**
|
|
3551
|
+
* Get intents for a domain
|
|
3552
|
+
*/
|
|
3553
|
+
getIntents(domainId: string): Promise<CBApiResponse<CBIntent[]>>;
|
|
3554
|
+
}
|
|
3555
|
+
/**
|
|
3556
|
+
* Knowledge Bases API (KAI)
|
|
3557
|
+
*/
|
|
3558
|
+
declare class KnowledgeBasesAPI {
|
|
3559
|
+
private readonly cb;
|
|
3560
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3561
|
+
/**
|
|
3562
|
+
* Get all knowledge bases
|
|
3563
|
+
*/
|
|
3564
|
+
getAll(includeMetrics?: boolean): Promise<CBKnowledgeBaseList>;
|
|
3565
|
+
/**
|
|
3566
|
+
* Get knowledge base by ID
|
|
3567
|
+
*/
|
|
3568
|
+
getById(kbId: string, includeMetrics?: boolean): Promise<CBKnowledgeBaseDetail>;
|
|
3569
|
+
/**
|
|
3570
|
+
* Get content sources for a knowledge base
|
|
3571
|
+
*/
|
|
3572
|
+
getContentSources(kbId: string, includeKmsRecipeDetails?: boolean): Promise<CBKBContentSource[]>;
|
|
3573
|
+
/**
|
|
3574
|
+
* Get articles for a knowledge base
|
|
3575
|
+
*/
|
|
3576
|
+
getArticles(kbId: string, params?: CBKBArticlesQueryParams): Promise<CBPaginatedResult<CBKBArticle>>;
|
|
3577
|
+
/**
|
|
3578
|
+
* Search knowledge base using KAI
|
|
3579
|
+
*/
|
|
3580
|
+
search(kbId: string, searchRequest: CBKAISearchRequest): Promise<CBKAISearchResponse>;
|
|
3581
|
+
/**
|
|
3582
|
+
* Get KAI On-Demand configurations
|
|
3583
|
+
*/
|
|
3584
|
+
getOnDemandConfigs(): Promise<CBKAIOnDemandConfig[]>;
|
|
3585
|
+
/**
|
|
3586
|
+
* Get default prompt for KAI
|
|
3587
|
+
*/
|
|
3588
|
+
getDefaultPrompt(): Promise<unknown>;
|
|
3589
|
+
/**
|
|
3590
|
+
* Get consumer query metrics for a knowledge base
|
|
3591
|
+
*
|
|
3592
|
+
* Retrieves answered and/or unanswered query metrics within a date range.
|
|
3593
|
+
* Note: The API only supports 7-day ranges. For longer ranges, use getConsumerQueryMetricsExtended().
|
|
3594
|
+
*
|
|
3595
|
+
* @param params - Query parameters including kbId, startTime, endTime, and eventType
|
|
3596
|
+
* @returns Promise resolving to consumer query metrics
|
|
3597
|
+
*
|
|
3598
|
+
* @example
|
|
3599
|
+
* ```typescript
|
|
3600
|
+
* const metrics = await sdk.conversationBuilder.knowledgeBases.getConsumerQueryMetrics({
|
|
3601
|
+
* kbId: 'kb-123',
|
|
3602
|
+
* startTime: Date.now() - 7 * 24 * 60 * 60 * 1000, // 7 days ago
|
|
3603
|
+
* endTime: Date.now(),
|
|
3604
|
+
* eventType: ['EVENT_KB_UN_ANSWERED'],
|
|
3605
|
+
* });
|
|
3606
|
+
* ```
|
|
3607
|
+
*/
|
|
3608
|
+
getConsumerQueryMetrics(params: CBConsumerQueryMetricsParams): Promise<CBConsumerQueryMetricsResponse>;
|
|
3609
|
+
/**
|
|
3610
|
+
* Get consumer query metrics for extended date ranges (up to 3 months)
|
|
3611
|
+
*
|
|
3612
|
+
* Automatically iterates through 7-day chunks to retrieve all metrics within
|
|
3613
|
+
* the specified date range. Useful for historical analysis beyond the 7-day API limit.
|
|
3614
|
+
*
|
|
3615
|
+
* @param params - Extended query parameters including startDate, endDate, kbId, and eventType
|
|
3616
|
+
* @returns Promise resolving to aggregated consumer query metrics from all chunks
|
|
3617
|
+
*
|
|
3618
|
+
* @example
|
|
3619
|
+
* ```typescript
|
|
3620
|
+
* const metrics = await sdk.conversationBuilder.knowledgeBases.getConsumerQueryMetricsExtended({
|
|
3621
|
+
* kbId: 'kb-123',
|
|
3622
|
+
* startDate: new Date('2024-01-01'),
|
|
3623
|
+
* endDate: new Date('2024-03-01'),
|
|
3624
|
+
* eventType: ['EVENT_KB_ANSWERED', 'EVENT_KB_UN_ANSWERED'],
|
|
3625
|
+
* onProgress: (completed, total) => console.log(`${completed}/${total} chunks processed`),
|
|
3626
|
+
* });
|
|
3627
|
+
* ```
|
|
3628
|
+
*/
|
|
3629
|
+
getConsumerQueryMetricsExtended(params: CBConsumerQueryMetricsExtendedParams): Promise<CBConsumerQueryMetric[]>;
|
|
3630
|
+
}
|
|
3631
|
+
/**
|
|
3632
|
+
* Bot Agents API
|
|
3633
|
+
*/
|
|
3634
|
+
declare class BotAgentsAPI {
|
|
3635
|
+
private readonly cb;
|
|
3636
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3637
|
+
/**
|
|
3638
|
+
* Get bot instance status
|
|
3639
|
+
*/
|
|
3640
|
+
getInstanceStatus(botId: string): Promise<CBBotInstanceStatus>;
|
|
3641
|
+
/**
|
|
3642
|
+
* Start a bot agent
|
|
3643
|
+
*/
|
|
3644
|
+
start(botId: string, lpAccountId: string, lpAccountUser: string): Promise<unknown>;
|
|
3645
|
+
/**
|
|
3646
|
+
* Stop a bot agent
|
|
3647
|
+
*/
|
|
3648
|
+
stop(botId: string, lpAccountId: string, lpAccountUser: string): Promise<unknown>;
|
|
3649
|
+
/**
|
|
3650
|
+
* Get all bot agents status
|
|
3651
|
+
*/
|
|
3652
|
+
getAllStatus(params?: CBAllBotAgentsStatusQueryParams): Promise<unknown>;
|
|
3653
|
+
/**
|
|
3654
|
+
* Get PCS bots status
|
|
3655
|
+
*/
|
|
3656
|
+
getPCSStatus(params?: CBPCSBotsStatusQueryParams): Promise<unknown>;
|
|
3657
|
+
/**
|
|
3658
|
+
* Get bot users
|
|
3659
|
+
*/
|
|
3660
|
+
getBotUsers(): Promise<CBBotUser[]>;
|
|
3661
|
+
/**
|
|
3662
|
+
* Add a bot agent
|
|
3663
|
+
*/
|
|
3664
|
+
addAgent(lpUserId: string, chatBotId: string, request: CBAddBotAgentRequest): Promise<CBBotUser>;
|
|
3665
|
+
}
|
|
3666
|
+
/**
|
|
3667
|
+
* Integrations/Responders API
|
|
3668
|
+
*/
|
|
3669
|
+
declare class IntegrationsAPI {
|
|
3670
|
+
private readonly cb;
|
|
3671
|
+
constructor(cb: ConversationBuilderAPI);
|
|
3672
|
+
/**
|
|
3673
|
+
* Get responders for a chatbot
|
|
3674
|
+
*/
|
|
3675
|
+
getResponders(chatBotId: string): Promise<CBResponder[]>;
|
|
3676
|
+
/**
|
|
3677
|
+
* Get LP skills
|
|
3678
|
+
*/
|
|
3679
|
+
getLPSkills(): Promise<CBLPSkill[]>;
|
|
3680
|
+
/**
|
|
3681
|
+
* Get credentials
|
|
3682
|
+
*/
|
|
3683
|
+
getCredentials(): Promise<CBCredential[]>;
|
|
3684
|
+
}
|
|
3685
|
+
|
|
2621
3686
|
/**
|
|
2622
3687
|
* LP Extend Client SDK
|
|
2623
3688
|
*
|
|
@@ -2717,6 +3782,22 @@ declare class LPExtendSDK {
|
|
|
2717
3782
|
readonly sentinel: SentinelAPI;
|
|
2718
3783
|
/** LP Prompts API - Manage prompts from LivePerson Prompt Library */
|
|
2719
3784
|
readonly prompts: LPPromptsAPI;
|
|
3785
|
+
/**
|
|
3786
|
+
* Conversation Builder API - Manage bots, dialogs, knowledge bases, NLU
|
|
3787
|
+
*
|
|
3788
|
+
* NOTE: CB APIs require separate authentication. After SDK init, call:
|
|
3789
|
+
* ```typescript
|
|
3790
|
+
* const cbAuth = await sdk.sentinel.authenticateCB();
|
|
3791
|
+
* sdk.conversationBuilder.setCredentials({
|
|
3792
|
+
* cbToken: cbAuth.successResult.apiAccessToken,
|
|
3793
|
+
* organizationId: cbAuth.successResult.sessionOrganizationId,
|
|
3794
|
+
* });
|
|
3795
|
+
* ```
|
|
3796
|
+
*
|
|
3797
|
+
* Or if using ExtendJWT (v2 auth), credentials may be set automatically
|
|
3798
|
+
* from the verification response.
|
|
3799
|
+
*/
|
|
3800
|
+
readonly conversationBuilder: ConversationBuilderAPI;
|
|
2720
3801
|
/** Scopes granted by app registration */
|
|
2721
3802
|
readonly grantedScopes: string[];
|
|
2722
3803
|
/** App name from registration */
|
|
@@ -2758,10 +3839,11 @@ declare class LPExtendSDK {
|
|
|
2758
3839
|
* This calls the shell backend to verify app registration and get granted scopes,
|
|
2759
3840
|
* then creates an SDK that calls LP APIs directly.
|
|
2760
3841
|
*
|
|
2761
|
-
* Supports
|
|
2762
|
-
* 1.
|
|
2763
|
-
* 2.
|
|
2764
|
-
* 3.
|
|
3842
|
+
* Supports four authentication modes (in order of preference):
|
|
3843
|
+
* 1. API Key (RECOMMENDED for backend apps): Provide `apiKey` - SDK authenticates with shell
|
|
3844
|
+
* 2. ExtendJWT token (for iframe apps): Provide `extendToken` - SDK verifies with shell and gets LP token
|
|
3845
|
+
* 3. Direct access token: Provide `accessToken` directly
|
|
3846
|
+
* 4. Shell token (LEGACY): Provide `shellToken` to fetch the LP token from the shell
|
|
2765
3847
|
*/
|
|
2766
3848
|
declare function createSDK(config: LPExtendSDKConfig): Promise<LPExtendSDK>;
|
|
2767
3849
|
|
|
@@ -2892,6 +3974,44 @@ declare function createSDK(config: LPExtendSDKConfig): Promise<LPExtendSDK>;
|
|
|
2892
3974
|
* ```
|
|
2893
3975
|
*/
|
|
2894
3976
|
declare function initializeSDK(config: LPExtendSDKConfig): Promise<LPExtendSDK>;
|
|
3977
|
+
/**
|
|
3978
|
+
* Initialize the SDK using environment variables + ExtendJWT
|
|
3979
|
+
*
|
|
3980
|
+
* Reads configuration from environment variables:
|
|
3981
|
+
* - LPEXTEND_API_KEY: Your app's API key (required)
|
|
3982
|
+
* - APP_ID: Your registered app ID (required)
|
|
3983
|
+
* - LP_ACCOUNT_ID: LivePerson account ID (required)
|
|
3984
|
+
* - LPEXTEND_SHELL_URL: Shell base URL (required)
|
|
3985
|
+
* - LPEXTEND_DEBUG: Enable debug logging (optional, default: false)
|
|
3986
|
+
*
|
|
3987
|
+
* The ExtendJWT is passed as a parameter since it comes from the shell at runtime.
|
|
3988
|
+
*
|
|
3989
|
+
* @param extendToken - The ExtendJWT received from the shell
|
|
3990
|
+
* @returns Promise resolving to initialized SDK instance
|
|
3991
|
+
* @throws LPExtendSDKError if required env vars are missing
|
|
3992
|
+
*
|
|
3993
|
+
* @example
|
|
3994
|
+
* ```typescript
|
|
3995
|
+
* // In your .env file:
|
|
3996
|
+
* // LPEXTEND_API_KEY=lpx_my-app_abc123...
|
|
3997
|
+
* // APP_ID=my-app
|
|
3998
|
+
* // LP_ACCOUNT_ID=12345678
|
|
3999
|
+
* // LPEXTEND_SHELL_URL=https://lp-extend.example.com
|
|
4000
|
+
*
|
|
4001
|
+
* import { createSDKFromEnv } from '@lpextend/node-sdk';
|
|
4002
|
+
*
|
|
4003
|
+
* // In your API route handler:
|
|
4004
|
+
* app.get('/api/skills', async (req, res) => {
|
|
4005
|
+
* // Get ExtendJWT from request (sent by frontend)
|
|
4006
|
+
* const extendToken = req.headers['x-extend-token'] as string;
|
|
4007
|
+
*
|
|
4008
|
+
* const sdk = await createSDKFromEnv(extendToken);
|
|
4009
|
+
* const { data: skills } = await sdk.skills.getAll();
|
|
4010
|
+
* res.json(skills);
|
|
4011
|
+
* });
|
|
4012
|
+
* ```
|
|
4013
|
+
*/
|
|
4014
|
+
declare function createSDKFromEnv(extendToken: string): Promise<LPExtendSDK>;
|
|
2895
4015
|
/**
|
|
2896
4016
|
* SDK Version
|
|
2897
4017
|
*/
|
|
@@ -2986,4 +4106,4 @@ type Scope = (typeof Scopes)[keyof typeof Scopes];
|
|
|
2986
4106
|
*/
|
|
2987
4107
|
declare function getShellToken(config: ShellTokenConfig): Promise<ShellTokenResponse>;
|
|
2988
4108
|
|
|
2989
|
-
export { type CreateConversationRequest$1 as AICreateConversationRequest, AIStudioAPI, type AIStudioCategory, type AIStudioConversation, type AIStudioFlow, type AIStudioMessage, type AIStudioSimulation, type AIStudioSummary, type AIStudioUser, AIStudioUsersAPI, type UpdateConversationRequest as AIUpdateConversationRequest, type APIResponse, type ActivityRecord, type AgentActivity, AgentActivityAPI, type AgentActivityQuery, AgentGroupsAPI, type AgentMetrics, AgentMetricsAPI, type AgentMetricsQuery, type AgentParticipant, type AgentStatus, AutomaticMessagesAPI, type BatchSummaryRequest, type CBAuthInfo, type CBChatBotPlatformUser, type CBSuccessResult, CampaignsAPI, CategoriesAPI, type CloseConversationRequest, type CoBrowseSession, ConnectToMessagingAPI, type ConsumerParticipant, type ConsumerProfile, type ContentToRetrieve, type ConversationContext, type ConversationInteraction, type ConversationParticipant, type ConversationQueryParams, type ConversationSummary, type ConversationTransfer, ConversationsAPI, type CreateAIStudioUserRequest, type CreateAgentGroupRequest, type CreateAutomaticMessageRequest, type CreateCampaignRequest, type CreateCategoryRequest, type CreateConversationResponse, type CreateEngagementRequest, type CreateLOBRequest, type CreateLPPromptRequest, type CreatePredefinedContentRequest, type CreateProfileRequest, type CreatePromptRequest, type CreateSimulationRequest, type CreateSkillRequest, type CreateSpecialOccasionRequest, type CreateTranscriptAnalysisRequest, type CreateUserRequest, type CreateWorkingHoursRequest, EngagementsAPI, type ErrorCode, ErrorCodes, EvaluatorsAPI, type FileMessage, FlowsAPI, type GeneratedQuestion, type GeneratedRoute, GeneratorsAPI, type GuidedRoute, type GuidedRoutingEvaluationRequest, type GuidedRoutingEvaluationResponse, type InvokeFlowRequest, type InvokeFlowResponse, type KAIRouteGenerationStatus, type KAIRouteGeneratorRequest, type KAIRouteGeneratorResponse, type Knowledgebase, type KnowledgebaseHealth, type KnowledgebaseItem, type KnowledgebaseSearchRequest, type KnowledgebaseSearchResult, type KnowledgebaseTextItem, KnowledgebasesAPI, type LLMModel, type LLMProvider, LOBsAPI, type LPAgentGroup, type LPAutomaticMessage, type LPAutomaticMessageData, type LPCampaign, type LPEngagement, LPExtendSDK, type LPExtendSDKConfig, LPExtendSDKError, type LPLLMProviderModels, type LPLLMProviderSubscription, type LPLLMType, type LPLOB, type LPPermission, type LPPredefinedContent, type LPPredefinedContentData, type LPProfile, type LPPrompt, type LPPromptClientConfig, type LPPromptClientType, type LPPromptConfiguration, type LPPromptGenericConfig, type LPPromptStatus, type LPPromptVariable, type LPPromptVariableSourceType, type LPPromptVersionDetail, LPPromptsAPI, type LPPromptsQueryParams, type LPShift, type LPSkill, type LPSkillRoutingConfig, type LPSpecialOccasion, type LPSpecialOccasionEvent, type LPUser, type LPWorkingDay, type LPWorkingHours, type MemberOf, type MessageData, type MessageRecord, MessagingAPI, type MessagingConversation, type CreateConversationRequest as MessagingCreateConversationRequest, MessagingHistoryAPI, type MessagingHistoryQuery, type MessagingHistoryResponse, type MessagingInteraction, MessagingOperationsAPI, type OutboundCampaignReport, type OutboundReportQuery, OutboundReportingAPI, type PaginatedResponse, PredefinedContentAPI, ProfilesAPI, type Prompt, PromptLibraryAPI, type PromptVariable, QueryAPI, type QueryGenerateRequest, type QueryGenerateResponse, type QuestionGeneratorRequest, type QuestionGeneratorResponse, type ResolutionEvaluationRequest, type ResolutionEvaluationResponse, type RichContentMessage, type SDEEvent, type SDERecord, type SDKInitResult, type Scope, Scopes, type SendMessageRequest, SentinelAPI, type SentinelAppSetting, type SentinelAppSettings, type SentinelAppUser, type SentinelAuthRequest, type SentinelCCUser, type SentinelDomainsResponse, type SentinelLoginUrlResponse, type SentinelLpToken, type SentinelLpUser, type SentinelManagerOf, type SentinelMemberOf, type SentinelProfile, type SentinelToken, type SentinelTokenExchange, type SentinelUserData, type SentinelUserSkill, type ShellTokenConfig, type ShellTokenResponse, type ShellTokenUser, type SimilarityEvaluationRequest, type SimilarityEvaluationResponse, type SimulationConfig, type SimulationJobResult, type SimulationQueryParams, type SimulationResults, type SimulationTestCase, SimulationsAPI, SkillsAPI, SpecialOccasionsAPI, SummaryAPI, type SummaryRequest, type SurveyRecord, type TextMessage, type TranscriptAnalysis, TranscriptAnalysisAPI, type TranscriptConversation, type TranscriptQuestion, type TransferConversationRequest, type UpdateAIStudioUserModelsRequest, type UpdateAIStudioUserRequest, type UpdateAgentGroupRequest, type UpdateAutomaticMessageRequest, type UpdateCampaignRequest, type UpdateCategoryRequest, type UpdateConversationAttributesRequest, type UpdateEngagementRequest, type UpdateLOBRequest, type UpdateLPPromptRequest, type UpdatePredefinedContentRequest, type UpdateProfileRequest, type UpdatePromptRequest, type UpdateSimulationRequest, type UpdateSkillRequest, type UpdateSpecialOccasionRequest, type UpdateTranscriptAnalysisRequest, type UpdateUserRequest, type UpdateWorkingHoursRequest, UsersAPI, VERSION, WorkingHoursAPI, createSDK, getShellToken, initializeSDK };
|
|
4109
|
+
export { type CreateConversationRequest$1 as AICreateConversationRequest, AIStudioAPI, type AIStudioCategory, type AIStudioConversation, type AIStudioFlow, type AIStudioMessage, type AIStudioSimulation, type AIStudioSummary, type AIStudioUser, AIStudioUsersAPI, type UpdateConversationRequest as AIUpdateConversationRequest, type APIResponse, type ActivityRecord, type AgentActivity, AgentActivityAPI, type AgentActivityQuery, AgentGroupsAPI, type AgentMetrics, AgentMetricsAPI, type AgentMetricsQuery, type AgentParticipant, type AgentStatus, type ApiKeyAuthResponse, AutomaticMessagesAPI, type BatchSummaryRequest, BotAgentsAPI, BotGroupsAPI, BotsAPI, type CBAddBotAgentRequest, type CBAllBotAgentsStatusQueryParams, type CBApiResponse, type CBAuthCredentials, type CBAuthInfo, type CBBot, type CBBotEnvironment, type CBBotGroup, type CBBotGroupsQueryParams, type CBBotInstanceStatus, type CBBotPlatform, type CBBotUser, type CBBotsByGroupQueryParams, type CBChatBot, type CBChatBotMetrics, type CBChatBotPlatformUser, type CBChatBotSummary, type CBChatBotSummaryList, type CBConsumerQueryEventType, type CBConsumerQueryMetric, type CBConsumerQueryMetricsExtendedParams, type CBConsumerQueryMetricsParams, type CBConsumerQueryMetricsResponse, type CBCredential, type CBDialog, type CBDialogGroup, type CBDialogTemplateSummary, type CBDomainList, type CBDuplicatePhrase, type CBDuplicatePhrases, type CBGlobalFunctions, type CBIntent, type CBInteraction, type CBInteractionContent, type CBInteractionList, type CBKAIOnDemandConfig, type CBKAISearchRequest, type CBKAISearchResponse, type CBKAISearchResultItem, type CBKBArticle, type CBKBArticlesQueryParams, type CBKBContentSource, type CBKBLandingPageMetrics, type CBKnowledgeBase, type CBKnowledgeBaseDetail, type CBKnowledgeBaseList, type CBLPAppCredentials, type CBLPSkill, type CBNLUDomain, type CBPCSBotsStatusQueryParams, type CBPageContext, type CBPaginatedResult, type CBResponder, type CBResponseMatch, type CBSuccessResult, type CBSyncStatusDetails, type CBTileData, CampaignsAPI, CategoriesAPI, type CloseConversationRequest, type CoBrowseSession, ConnectToMessagingAPI, type ConsumerParticipant, type ConsumerProfile, type ContentToRetrieve, ConversationBuilderAPI, type ConversationContext, type ConversationInteraction, type ConversationParticipant, type ConversationQueryParams, type ConversationSummary, type ConversationTransfer, ConversationsAPI, type CreateAIStudioUserRequest, type CreateAgentGroupRequest, type CreateAutomaticMessageRequest, type CreateCampaignRequest, type CreateCategoryRequest, type CreateConversationResponse, type CreateEngagementRequest, type CreateLOBRequest, type CreateLPPromptRequest, type CreatePredefinedContentRequest, type CreateProfileRequest, type CreatePromptRequest, type CreateSimulationRequest, type CreateSkillRequest, type CreateSpecialOccasionRequest, type CreateTranscriptAnalysisRequest, type CreateUserRequest, type CreateWorkingHoursRequest, DialogsAPI, EngagementsAPI, type ErrorCode, ErrorCodes, EvaluatorsAPI, type FileMessage, FlowsAPI, type GeneratedQuestion, type GeneratedRoute, GeneratorsAPI, type GuidedRoute, type GuidedRoutingEvaluationRequest, type GuidedRoutingEvaluationResponse, IntegrationsAPI, InteractionsAPI, type InvokeFlowRequest, type InvokeFlowResponse, type KAIRouteGenerationStatus, type KAIRouteGeneratorRequest, type KAIRouteGeneratorResponse, KnowledgeBasesAPI, type Knowledgebase, type KnowledgebaseHealth, type KnowledgebaseItem, type KnowledgebaseSearchRequest, type KnowledgebaseSearchResult, type KnowledgebaseTextItem, KnowledgebasesAPI, type LLMModel, type LLMProvider, LOBsAPI, type LPAgentGroup, type LPAutomaticMessage, type LPAutomaticMessageData, type LPCampaign, type LPEngagement, LPExtendSDK, type LPExtendSDKConfig, LPExtendSDKError, type LPLLMProviderModels, type LPLLMProviderSubscription, type LPLLMType, type LPLOB, type LPPermission, type LPPredefinedContent, type LPPredefinedContentData, type LPProfile, type LPPrompt, type LPPromptClientConfig, type LPPromptClientType, type LPPromptConfiguration, type LPPromptGenericConfig, type LPPromptStatus, type LPPromptVariable, type LPPromptVariableSourceType, type LPPromptVersionDetail, LPPromptsAPI, type LPPromptsQueryParams, type LPShift, type LPSkill, type LPSkillRoutingConfig, type LPSpecialOccasion, type LPSpecialOccasionEvent, type LPUser, type LPWorkingDay, type LPWorkingHours, type MemberOf, type MessageData, type MessageRecord, MessagingAPI, type MessagingConversation, type CreateConversationRequest as MessagingCreateConversationRequest, MessagingHistoryAPI, type MessagingHistoryQuery, type MessagingHistoryResponse, type MessagingInteraction, MessagingOperationsAPI, NLUDomainsAPI, type OutboundCampaignReport, type OutboundReportQuery, OutboundReportingAPI, type PaginatedResponse, PredefinedContentAPI, ProfilesAPI, type Prompt, PromptLibraryAPI, type PromptVariable, QueryAPI, type QueryGenerateRequest, type QueryGenerateResponse, type QuestionGeneratorRequest, type QuestionGeneratorResponse, type ResolutionEvaluationRequest, type ResolutionEvaluationResponse, type RichContentMessage, type SDEEvent, type SDERecord, type SDKInitResult, type Scope, Scopes, type SendMessageRequest, SentinelAPI, type SentinelAppSetting, type SentinelAppSettings, type SentinelAppUser, type SentinelAuthRequest, type SentinelCCUser, type SentinelDomainsResponse, type SentinelLoginUrlResponse, type SentinelLpToken, type SentinelLpUser, type SentinelManagerOf, type SentinelMemberOf, type SentinelProfile, type SentinelToken, type SentinelTokenExchange, type SentinelUserData, type SentinelUserSkill, type ShellTokenConfig, type ShellTokenResponse, type ShellTokenUser, type SimilarityEvaluationRequest, type SimilarityEvaluationResponse, type SimulationConfig, type SimulationJobResult, type SimulationQueryParams, type SimulationResults, type SimulationTestCase, SimulationsAPI, SkillsAPI, SpecialOccasionsAPI, SummaryAPI, type SummaryRequest, type SurveyRecord, type TextMessage, type TranscriptAnalysis, TranscriptAnalysisAPI, type TranscriptConversation, type TranscriptQuestion, type TransferConversationRequest, type UpdateAIStudioUserModelsRequest, type UpdateAIStudioUserRequest, type UpdateAgentGroupRequest, type UpdateAutomaticMessageRequest, type UpdateCampaignRequest, type UpdateCategoryRequest, type UpdateConversationAttributesRequest, type UpdateEngagementRequest, type UpdateLOBRequest, type UpdateLPPromptRequest, type UpdatePredefinedContentRequest, type UpdateProfileRequest, type UpdatePromptRequest, type UpdateSimulationRequest, type UpdateSkillRequest, type UpdateSpecialOccasionRequest, type UpdateTranscriptAnalysisRequest, type UpdateUserRequest, type UpdateWorkingHoursRequest, UsersAPI, VERSION, WorkingHoursAPI, createSDK, createSDKFromEnv, getShellToken, initializeSDK };
|