purecloud-platform-client-v2 169.0.0 → 170.0.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/README.md +6 -4
- package/dist/node/purecloud-platform-client-v2.js +25367 -20288
- package/dist/web-amd/purecloud-platform-client-v2.js +25367 -20288
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +25367 -20288
- package/dist/web-cjs/purecloud-platform-client-v2.js +25367 -20288
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +2519 -31
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1418 -227
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +142 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +526 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +114 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +114 -4
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +363 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +224 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +200 -22
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +53 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +189 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +174 -10
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +199 -6
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +80 -2
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1286 -0
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +32 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +34 -3
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +47 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +172 -7
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -897,6 +897,208 @@ class IntegrationsApi {
|
|
|
897
897
|
);
|
|
898
898
|
}
|
|
899
899
|
|
|
900
|
+
/**
|
|
901
|
+
* Get a Nuance bot in the specified Integration
|
|
902
|
+
*
|
|
903
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
904
|
+
* @param {String} botId The Nuance bot ID to get
|
|
905
|
+
* @param {Object} opts Optional parameters
|
|
906
|
+
* @param {Array.<String>} opts.expand expand
|
|
907
|
+
* @param {Object} opts.targetChannel targetChannel
|
|
908
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
909
|
+
*/
|
|
910
|
+
getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId, botId, opts) {
|
|
911
|
+
opts = opts || {};
|
|
912
|
+
|
|
913
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
914
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
915
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';
|
|
916
|
+
}
|
|
917
|
+
// verify the required parameter 'botId' is set
|
|
918
|
+
if (botId === undefined || botId === null) {
|
|
919
|
+
throw 'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBot';
|
|
920
|
+
}
|
|
921
|
+
|
|
922
|
+
return this.apiClient.callApi(
|
|
923
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}',
|
|
924
|
+
'GET',
|
|
925
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId,'botId': botId },
|
|
926
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'targetChannel': opts['targetChannel'] },
|
|
927
|
+
{ },
|
|
928
|
+
{ },
|
|
929
|
+
null,
|
|
930
|
+
['PureCloud OAuth'],
|
|
931
|
+
['application/json'],
|
|
932
|
+
['application/json']
|
|
933
|
+
);
|
|
934
|
+
}
|
|
935
|
+
|
|
936
|
+
/**
|
|
937
|
+
* Get the status of an asynchronous Nuance bot GET job
|
|
938
|
+
*
|
|
939
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
940
|
+
* @param {String} botId The Nuance bot ID
|
|
941
|
+
* @param {String} jobId The asynchronous job ID
|
|
942
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
943
|
+
*/
|
|
944
|
+
getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId, botId, jobId) {
|
|
945
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
946
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
947
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';
|
|
948
|
+
}
|
|
949
|
+
// verify the required parameter 'botId' is set
|
|
950
|
+
if (botId === undefined || botId === null) {
|
|
951
|
+
throw 'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';
|
|
952
|
+
}
|
|
953
|
+
// verify the required parameter 'jobId' is set
|
|
954
|
+
if (jobId === undefined || jobId === null) {
|
|
955
|
+
throw 'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob';
|
|
956
|
+
}
|
|
957
|
+
|
|
958
|
+
return this.apiClient.callApi(
|
|
959
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}',
|
|
960
|
+
'GET',
|
|
961
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId,'botId': botId,'jobId': jobId },
|
|
962
|
+
{ },
|
|
963
|
+
{ },
|
|
964
|
+
{ },
|
|
965
|
+
null,
|
|
966
|
+
['PureCloud OAuth'],
|
|
967
|
+
['application/json'],
|
|
968
|
+
['application/json']
|
|
969
|
+
);
|
|
970
|
+
}
|
|
971
|
+
|
|
972
|
+
/**
|
|
973
|
+
* Get the result of an asynchronous Nuance bot GET job
|
|
974
|
+
*
|
|
975
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
976
|
+
* @param {String} botId The Nuance bot ID
|
|
977
|
+
* @param {String} jobId The asynchronous job ID
|
|
978
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
979
|
+
*/
|
|
980
|
+
getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId, botId, jobId) {
|
|
981
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
982
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
983
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';
|
|
984
|
+
}
|
|
985
|
+
// verify the required parameter 'botId' is set
|
|
986
|
+
if (botId === undefined || botId === null) {
|
|
987
|
+
throw 'Missing the required parameter "botId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';
|
|
988
|
+
}
|
|
989
|
+
// verify the required parameter 'jobId' is set
|
|
990
|
+
if (jobId === undefined || jobId === null) {
|
|
991
|
+
throw 'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults';
|
|
992
|
+
}
|
|
993
|
+
|
|
994
|
+
return this.apiClient.callApi(
|
|
995
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs/{jobId}/results',
|
|
996
|
+
'GET',
|
|
997
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId,'botId': botId,'jobId': jobId },
|
|
998
|
+
{ },
|
|
999
|
+
{ },
|
|
1000
|
+
{ },
|
|
1001
|
+
null,
|
|
1002
|
+
['PureCloud OAuth'],
|
|
1003
|
+
['application/json'],
|
|
1004
|
+
['application/json']
|
|
1005
|
+
);
|
|
1006
|
+
}
|
|
1007
|
+
|
|
1008
|
+
/**
|
|
1009
|
+
* Get a list of Nuance bots available in the specified Integration
|
|
1010
|
+
* If the onlyRegisteredBots param is set, the returned data will only include the Nuance bots which have configured client secrets within the Integration, otherwise all of the Nuance bots available to the Integrations configured discovery credentials are returned.
|
|
1011
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1012
|
+
* @param {Object} opts Optional parameters
|
|
1013
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1014
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1015
|
+
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
1016
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1017
|
+
*/
|
|
1018
|
+
getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId, opts) {
|
|
1019
|
+
opts = opts || {};
|
|
1020
|
+
|
|
1021
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
1022
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
1023
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBots';
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
return this.apiClient.callApi(
|
|
1027
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots',
|
|
1028
|
+
'GET',
|
|
1029
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId },
|
|
1030
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'onlyRegisteredBots': opts['onlyRegisteredBots'] },
|
|
1031
|
+
{ },
|
|
1032
|
+
{ },
|
|
1033
|
+
null,
|
|
1034
|
+
['PureCloud OAuth'],
|
|
1035
|
+
['application/json'],
|
|
1036
|
+
['application/json']
|
|
1037
|
+
);
|
|
1038
|
+
}
|
|
1039
|
+
|
|
1040
|
+
/**
|
|
1041
|
+
* Get the status of an asynchronous Nuance bots GET job
|
|
1042
|
+
*
|
|
1043
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1044
|
+
* @param {String} jobId The asynchronous job ID
|
|
1045
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1046
|
+
*/
|
|
1047
|
+
getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId, jobId) {
|
|
1048
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
1049
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
1050
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';
|
|
1051
|
+
}
|
|
1052
|
+
// verify the required parameter 'jobId' is set
|
|
1053
|
+
if (jobId === undefined || jobId === null) {
|
|
1054
|
+
throw 'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob';
|
|
1055
|
+
}
|
|
1056
|
+
|
|
1057
|
+
return this.apiClient.callApi(
|
|
1058
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}',
|
|
1059
|
+
'GET',
|
|
1060
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId,'jobId': jobId },
|
|
1061
|
+
{ },
|
|
1062
|
+
{ },
|
|
1063
|
+
{ },
|
|
1064
|
+
null,
|
|
1065
|
+
['PureCloud OAuth'],
|
|
1066
|
+
['application/json'],
|
|
1067
|
+
['application/json']
|
|
1068
|
+
);
|
|
1069
|
+
}
|
|
1070
|
+
|
|
1071
|
+
/**
|
|
1072
|
+
* Get the result of an asynchronous Nuance bots GET job
|
|
1073
|
+
*
|
|
1074
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1075
|
+
* @param {String} jobId The asynchronous job ID
|
|
1076
|
+
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1077
|
+
*/
|
|
1078
|
+
getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId, jobId) {
|
|
1079
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
1080
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
1081
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';
|
|
1082
|
+
}
|
|
1083
|
+
// verify the required parameter 'jobId' is set
|
|
1084
|
+
if (jobId === undefined || jobId === null) {
|
|
1085
|
+
throw 'Missing the required parameter "jobId" when calling getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults';
|
|
1086
|
+
}
|
|
1087
|
+
|
|
1088
|
+
return this.apiClient.callApi(
|
|
1089
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs/{jobId}/results',
|
|
1090
|
+
'GET',
|
|
1091
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId,'jobId': jobId },
|
|
1092
|
+
{ },
|
|
1093
|
+
{ },
|
|
1094
|
+
{ },
|
|
1095
|
+
null,
|
|
1096
|
+
['PureCloud OAuth'],
|
|
1097
|
+
['application/json'],
|
|
1098
|
+
['application/json']
|
|
1099
|
+
);
|
|
1100
|
+
}
|
|
1101
|
+
|
|
900
1102
|
/**
|
|
901
1103
|
* Get details about a TTS engine
|
|
902
1104
|
*
|
|
@@ -1486,6 +1688,105 @@ class IntegrationsApi {
|
|
|
1486
1688
|
);
|
|
1487
1689
|
}
|
|
1488
1690
|
|
|
1691
|
+
/**
|
|
1692
|
+
* Get a Nuance bot in the specified Integration asynchronously
|
|
1693
|
+
*
|
|
1694
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1695
|
+
* @param {String} botId The Nuance bot ID
|
|
1696
|
+
* @param {Object} opts Optional parameters
|
|
1697
|
+
* @param {Array.<String>} opts.expand expand
|
|
1698
|
+
* @param {String} opts.body targetChannel
|
|
1699
|
+
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1700
|
+
*/
|
|
1701
|
+
postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId, botId, opts) {
|
|
1702
|
+
opts = opts || {};
|
|
1703
|
+
|
|
1704
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
1705
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
1706
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';
|
|
1707
|
+
}
|
|
1708
|
+
// verify the required parameter 'botId' is set
|
|
1709
|
+
if (botId === undefined || botId === null) {
|
|
1710
|
+
throw 'Missing the required parameter "botId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs';
|
|
1711
|
+
}
|
|
1712
|
+
|
|
1713
|
+
return this.apiClient.callApi(
|
|
1714
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/{botId}/jobs',
|
|
1715
|
+
'POST',
|
|
1716
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId,'botId': botId },
|
|
1717
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
1718
|
+
{ },
|
|
1719
|
+
{ },
|
|
1720
|
+
opts['body'],
|
|
1721
|
+
['PureCloud OAuth'],
|
|
1722
|
+
['application/json'],
|
|
1723
|
+
['application/json']
|
|
1724
|
+
);
|
|
1725
|
+
}
|
|
1726
|
+
|
|
1727
|
+
/**
|
|
1728
|
+
* Get a list of Nuance bots in the specified Integration asynchronously
|
|
1729
|
+
*
|
|
1730
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1731
|
+
* @param {Object} opts Optional parameters
|
|
1732
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1733
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1734
|
+
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
1735
|
+
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1736
|
+
*/
|
|
1737
|
+
postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId, opts) {
|
|
1738
|
+
opts = opts || {};
|
|
1739
|
+
|
|
1740
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
1741
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
1742
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs';
|
|
1743
|
+
}
|
|
1744
|
+
|
|
1745
|
+
return this.apiClient.callApi(
|
|
1746
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/jobs',
|
|
1747
|
+
'POST',
|
|
1748
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId },
|
|
1749
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'onlyRegisteredBots': opts['onlyRegisteredBots'] },
|
|
1750
|
+
{ },
|
|
1751
|
+
{ },
|
|
1752
|
+
null,
|
|
1753
|
+
['PureCloud OAuth'],
|
|
1754
|
+
['application/json'],
|
|
1755
|
+
['application/json']
|
|
1756
|
+
);
|
|
1757
|
+
}
|
|
1758
|
+
|
|
1759
|
+
/**
|
|
1760
|
+
* Try out a single credential for a Nuance bot to know if the secret is correct
|
|
1761
|
+
*
|
|
1762
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1763
|
+
* @param {Object} settings
|
|
1764
|
+
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1765
|
+
*/
|
|
1766
|
+
postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId, settings) {
|
|
1767
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
1768
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
1769
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';
|
|
1770
|
+
}
|
|
1771
|
+
// verify the required parameter 'settings' is set
|
|
1772
|
+
if (settings === undefined || settings === null) {
|
|
1773
|
+
throw 'Missing the required parameter "settings" when calling postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate';
|
|
1774
|
+
}
|
|
1775
|
+
|
|
1776
|
+
return this.apiClient.callApi(
|
|
1777
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/validate',
|
|
1778
|
+
'POST',
|
|
1779
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId },
|
|
1780
|
+
{ },
|
|
1781
|
+
{ },
|
|
1782
|
+
{ },
|
|
1783
|
+
settings,
|
|
1784
|
+
['PureCloud OAuth'],
|
|
1785
|
+
['application/json'],
|
|
1786
|
+
['application/json']
|
|
1787
|
+
);
|
|
1788
|
+
}
|
|
1789
|
+
|
|
1489
1790
|
/**
|
|
1490
1791
|
* Update integration configuration.
|
|
1491
1792
|
*
|
|
@@ -1574,6 +1875,37 @@ class IntegrationsApi {
|
|
|
1574
1875
|
);
|
|
1575
1876
|
}
|
|
1576
1877
|
|
|
1878
|
+
/**
|
|
1879
|
+
* Update the Nuance bot list for the specific bots made available to Genesys Cloud in the specified Integration
|
|
1880
|
+
*
|
|
1881
|
+
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1882
|
+
* @param {Object} settings
|
|
1883
|
+
* putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1884
|
+
*/
|
|
1885
|
+
putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId, settings) {
|
|
1886
|
+
// verify the required parameter 'nuanceIntegrationId' is set
|
|
1887
|
+
if (nuanceIntegrationId === undefined || nuanceIntegrationId === null) {
|
|
1888
|
+
throw 'Missing the required parameter "nuanceIntegrationId" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';
|
|
1889
|
+
}
|
|
1890
|
+
// verify the required parameter 'settings' is set
|
|
1891
|
+
if (settings === undefined || settings === null) {
|
|
1892
|
+
throw 'Missing the required parameter "settings" when calling putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings';
|
|
1893
|
+
}
|
|
1894
|
+
|
|
1895
|
+
return this.apiClient.callApi(
|
|
1896
|
+
'/api/v2/integrations/speech/nuance/{nuanceIntegrationId}/bots/launch/settings',
|
|
1897
|
+
'PUT',
|
|
1898
|
+
{ 'nuanceIntegrationId': nuanceIntegrationId },
|
|
1899
|
+
{ },
|
|
1900
|
+
{ },
|
|
1901
|
+
{ },
|
|
1902
|
+
settings,
|
|
1903
|
+
['PureCloud OAuth'],
|
|
1904
|
+
['application/json'],
|
|
1905
|
+
['application/json']
|
|
1906
|
+
);
|
|
1907
|
+
}
|
|
1908
|
+
|
|
1577
1909
|
/**
|
|
1578
1910
|
* Update TTS settings for an org
|
|
1579
1911
|
*
|
|
@@ -1599,6 +1931,36 @@ class IntegrationsApi {
|
|
|
1599
1931
|
);
|
|
1600
1932
|
}
|
|
1601
1933
|
|
|
1934
|
+
/**
|
|
1935
|
+
* Bulk integration presence ingestion
|
|
1936
|
+
* This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.
|
|
1937
|
+
* @param {String} ucIntegrationId UC Integration ID
|
|
1938
|
+
* @param {Array.<Object>} body List of User presences
|
|
1939
|
+
*/
|
|
1940
|
+
putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body) {
|
|
1941
|
+
// verify the required parameter 'ucIntegrationId' is set
|
|
1942
|
+
if (ucIntegrationId === undefined || ucIntegrationId === null) {
|
|
1943
|
+
throw 'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
|
|
1944
|
+
}
|
|
1945
|
+
// verify the required parameter 'body' is set
|
|
1946
|
+
if (body === undefined || body === null) {
|
|
1947
|
+
throw 'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
|
|
1948
|
+
}
|
|
1949
|
+
|
|
1950
|
+
return this.apiClient.callApi(
|
|
1951
|
+
'/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences',
|
|
1952
|
+
'PUT',
|
|
1953
|
+
{ 'ucIntegrationId': ucIntegrationId },
|
|
1954
|
+
{ },
|
|
1955
|
+
{ },
|
|
1956
|
+
{ },
|
|
1957
|
+
body,
|
|
1958
|
+
['PureCloud OAuth'],
|
|
1959
|
+
['application/json'],
|
|
1960
|
+
['application/json']
|
|
1961
|
+
);
|
|
1962
|
+
}
|
|
1963
|
+
|
|
1602
1964
|
}
|
|
1603
1965
|
|
|
1604
1966
|
|
|
@@ -5,7 +5,7 @@ class JourneyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Journey service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -149,6 +149,62 @@ class JourneyApi {
|
|
|
149
149
|
);
|
|
150
150
|
}
|
|
151
151
|
|
|
152
|
+
/**
|
|
153
|
+
* Get status for async query for journey aggregates
|
|
154
|
+
*
|
|
155
|
+
* @param {String} jobId jobId
|
|
156
|
+
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
157
|
+
*/
|
|
158
|
+
getAnalyticsJourneysAggregatesJob(jobId) {
|
|
159
|
+
// verify the required parameter 'jobId' is set
|
|
160
|
+
if (jobId === undefined || jobId === null) {
|
|
161
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
return this.apiClient.callApi(
|
|
165
|
+
'/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
|
|
166
|
+
'GET',
|
|
167
|
+
{ 'jobId': jobId },
|
|
168
|
+
{ },
|
|
169
|
+
{ },
|
|
170
|
+
{ },
|
|
171
|
+
null,
|
|
172
|
+
['PureCloud OAuth'],
|
|
173
|
+
['application/json'],
|
|
174
|
+
['application/json']
|
|
175
|
+
);
|
|
176
|
+
}
|
|
177
|
+
|
|
178
|
+
/**
|
|
179
|
+
* Fetch a page of results for an async aggregates query
|
|
180
|
+
*
|
|
181
|
+
* @param {String} jobId jobId
|
|
182
|
+
* @param {Object} opts Optional parameters
|
|
183
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
184
|
+
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
185
|
+
*/
|
|
186
|
+
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
187
|
+
opts = opts || {};
|
|
188
|
+
|
|
189
|
+
// verify the required parameter 'jobId' is set
|
|
190
|
+
if (jobId === undefined || jobId === null) {
|
|
191
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';
|
|
192
|
+
}
|
|
193
|
+
|
|
194
|
+
return this.apiClient.callApi(
|
|
195
|
+
'/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results',
|
|
196
|
+
'GET',
|
|
197
|
+
{ 'jobId': jobId },
|
|
198
|
+
{ 'cursor': opts['cursor'] },
|
|
199
|
+
{ },
|
|
200
|
+
{ },
|
|
201
|
+
null,
|
|
202
|
+
['PureCloud OAuth'],
|
|
203
|
+
['application/json'],
|
|
204
|
+
['application/json']
|
|
205
|
+
);
|
|
206
|
+
}
|
|
207
|
+
|
|
152
208
|
/**
|
|
153
209
|
* Retrieve a single action map.
|
|
154
210
|
*
|
|
@@ -414,6 +470,58 @@ class JourneyApi {
|
|
|
414
470
|
);
|
|
415
471
|
}
|
|
416
472
|
|
|
473
|
+
/**
|
|
474
|
+
* Get job status.
|
|
475
|
+
*
|
|
476
|
+
* @param {String} jobId ID of the job.
|
|
477
|
+
* getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
478
|
+
*/
|
|
479
|
+
getJourneyOutcomesAttributionsJob(jobId) {
|
|
480
|
+
// verify the required parameter 'jobId' is set
|
|
481
|
+
if (jobId === undefined || jobId === null) {
|
|
482
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJob';
|
|
483
|
+
}
|
|
484
|
+
|
|
485
|
+
return this.apiClient.callApi(
|
|
486
|
+
'/api/v2/journey/outcomes/attributions/jobs/{jobId}',
|
|
487
|
+
'GET',
|
|
488
|
+
{ 'jobId': jobId },
|
|
489
|
+
{ },
|
|
490
|
+
{ },
|
|
491
|
+
{ },
|
|
492
|
+
null,
|
|
493
|
+
['PureCloud OAuth'],
|
|
494
|
+
['application/json'],
|
|
495
|
+
['application/json']
|
|
496
|
+
);
|
|
497
|
+
}
|
|
498
|
+
|
|
499
|
+
/**
|
|
500
|
+
* Get outcome attribution entities from completed job.
|
|
501
|
+
*
|
|
502
|
+
* @param {String} jobId ID of the job.
|
|
503
|
+
* getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
504
|
+
*/
|
|
505
|
+
getJourneyOutcomesAttributionsJobResults(jobId) {
|
|
506
|
+
// verify the required parameter 'jobId' is set
|
|
507
|
+
if (jobId === undefined || jobId === null) {
|
|
508
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJobResults';
|
|
509
|
+
}
|
|
510
|
+
|
|
511
|
+
return this.apiClient.callApi(
|
|
512
|
+
'/api/v2/journey/outcomes/attributions/jobs/{jobId}/results',
|
|
513
|
+
'GET',
|
|
514
|
+
{ 'jobId': jobId },
|
|
515
|
+
{ },
|
|
516
|
+
{ },
|
|
517
|
+
{ },
|
|
518
|
+
null,
|
|
519
|
+
['PureCloud OAuth'],
|
|
520
|
+
['application/json'],
|
|
521
|
+
['application/json']
|
|
522
|
+
);
|
|
523
|
+
}
|
|
524
|
+
|
|
417
525
|
/**
|
|
418
526
|
* Retrieve a single outcome predictor.
|
|
419
527
|
*
|
|
@@ -539,6 +647,37 @@ class JourneyApi {
|
|
|
539
647
|
);
|
|
540
648
|
}
|
|
541
649
|
|
|
650
|
+
/**
|
|
651
|
+
* Retrieve all events for a given session.
|
|
652
|
+
*
|
|
653
|
+
* @param {String} sessionId System-generated UUID that represents the session the event is a part of.
|
|
654
|
+
* @param {Object} opts Optional parameters
|
|
655
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
656
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
657
|
+
* getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
658
|
+
*/
|
|
659
|
+
getJourneySessionEvents(sessionId, opts) {
|
|
660
|
+
opts = opts || {};
|
|
661
|
+
|
|
662
|
+
// verify the required parameter 'sessionId' is set
|
|
663
|
+
if (sessionId === undefined || sessionId === null) {
|
|
664
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneySessionEvents';
|
|
665
|
+
}
|
|
666
|
+
|
|
667
|
+
return this.apiClient.callApi(
|
|
668
|
+
'/api/v2/journey/sessions/{sessionId}/events',
|
|
669
|
+
'GET',
|
|
670
|
+
{ 'sessionId': sessionId },
|
|
671
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
672
|
+
{ },
|
|
673
|
+
{ },
|
|
674
|
+
null,
|
|
675
|
+
['PureCloud OAuth'],
|
|
676
|
+
['application/json'],
|
|
677
|
+
['application/json']
|
|
678
|
+
);
|
|
679
|
+
}
|
|
680
|
+
|
|
542
681
|
/**
|
|
543
682
|
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
544
683
|
*
|
|
@@ -564,6 +703,39 @@ class JourneyApi {
|
|
|
564
703
|
);
|
|
565
704
|
}
|
|
566
705
|
|
|
706
|
+
/**
|
|
707
|
+
* Retrieve segment assignments by session ID.
|
|
708
|
+
*
|
|
709
|
+
* @param {String} sessionId ID of the session to query for segment assignments.
|
|
710
|
+
* @param {Object} opts Optional parameters
|
|
711
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
712
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
713
|
+
* @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
|
|
714
|
+
* @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
|
|
715
|
+
* getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
716
|
+
*/
|
|
717
|
+
getJourneySessionSegments(sessionId, opts) {
|
|
718
|
+
opts = opts || {};
|
|
719
|
+
|
|
720
|
+
// verify the required parameter 'sessionId' is set
|
|
721
|
+
if (sessionId === undefined || sessionId === null) {
|
|
722
|
+
throw 'Missing the required parameter "sessionId" when calling getJourneySessionSegments';
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
return this.apiClient.callApi(
|
|
726
|
+
'/api/v2/journey/sessions/{sessionId}/segments',
|
|
727
|
+
'GET',
|
|
728
|
+
{ 'sessionId': sessionId },
|
|
729
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'segmentScope': opts['segmentScope'],'assignmentState': opts['assignmentState'] },
|
|
730
|
+
{ },
|
|
731
|
+
{ },
|
|
732
|
+
null,
|
|
733
|
+
['PureCloud OAuth'],
|
|
734
|
+
['application/json'],
|
|
735
|
+
['application/json']
|
|
736
|
+
);
|
|
737
|
+
}
|
|
738
|
+
|
|
567
739
|
/**
|
|
568
740
|
* Update single action map.
|
|
569
741
|
*
|
|
@@ -709,6 +881,32 @@ class JourneyApi {
|
|
|
709
881
|
);
|
|
710
882
|
}
|
|
711
883
|
|
|
884
|
+
/**
|
|
885
|
+
* Query for journey aggregates asynchronously
|
|
886
|
+
*
|
|
887
|
+
* @param {Object} body query
|
|
888
|
+
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
889
|
+
*/
|
|
890
|
+
postAnalyticsJourneysAggregatesJobs(body) {
|
|
891
|
+
// verify the required parameter 'body' is set
|
|
892
|
+
if (body === undefined || body === null) {
|
|
893
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';
|
|
894
|
+
}
|
|
895
|
+
|
|
896
|
+
return this.apiClient.callApi(
|
|
897
|
+
'/api/v2/analytics/journeys/aggregates/jobs',
|
|
898
|
+
'POST',
|
|
899
|
+
{ },
|
|
900
|
+
{ },
|
|
901
|
+
{ },
|
|
902
|
+
{ },
|
|
903
|
+
body,
|
|
904
|
+
['PureCloud OAuth'],
|
|
905
|
+
['application/json'],
|
|
906
|
+
['application/json']
|
|
907
|
+
);
|
|
908
|
+
}
|
|
909
|
+
|
|
712
910
|
/**
|
|
713
911
|
* Query for journey aggregates
|
|
714
912
|
*
|
|
@@ -831,6 +1029,31 @@ class JourneyApi {
|
|
|
831
1029
|
);
|
|
832
1030
|
}
|
|
833
1031
|
|
|
1032
|
+
/**
|
|
1033
|
+
* Create Outcome Attributions
|
|
1034
|
+
*
|
|
1035
|
+
* @param {Object} opts Optional parameters
|
|
1036
|
+
* @param {Object} opts.body outcome attribution request
|
|
1037
|
+
* postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1038
|
+
*/
|
|
1039
|
+
postJourneyOutcomesAttributionsJobs(opts) {
|
|
1040
|
+
opts = opts || {};
|
|
1041
|
+
|
|
1042
|
+
|
|
1043
|
+
return this.apiClient.callApi(
|
|
1044
|
+
'/api/v2/journey/outcomes/attributions/jobs',
|
|
1045
|
+
'POST',
|
|
1046
|
+
{ },
|
|
1047
|
+
{ },
|
|
1048
|
+
{ },
|
|
1049
|
+
{ },
|
|
1050
|
+
opts['body'],
|
|
1051
|
+
['PureCloud OAuth'],
|
|
1052
|
+
['application/json'],
|
|
1053
|
+
['application/json']
|
|
1054
|
+
);
|
|
1055
|
+
}
|
|
1056
|
+
|
|
834
1057
|
/**
|
|
835
1058
|
* Create an outcome predictor.
|
|
836
1059
|
*
|