purecloud-platform-client-v2 188.0.1 → 189.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1059 -113
- package/dist/web-amd/purecloud-platform-client-v2.js +1059 -113
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +340 -115
- package/dist/web-cjs/purecloud-platform-client-v2.js +359 -122
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +727 -7
- 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 +1 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +298 -6
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +13 -9
- 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/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -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 +1 -1
- 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 +240 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +187 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +161 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- 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/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- 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/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +48 -1
- 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 +27 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -3
- 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 +1 -1
- 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 +1 -1
- 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 +4 -3
- package/src/purecloud-platform-client-v2/index.js +1 -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 189.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -912,6 +912,57 @@ class IntegrationsApi {
|
|
|
912
912
|
);
|
|
913
913
|
}
|
|
914
914
|
|
|
915
|
+
/**
|
|
916
|
+
* Get details about a Dialogflow CX agent
|
|
917
|
+
*
|
|
918
|
+
* @param {String} agentId The agent ID
|
|
919
|
+
*/
|
|
920
|
+
getIntegrationsSpeechDialogflowcxAgent(agentId) {
|
|
921
|
+
// verify the required parameter 'agentId' is set
|
|
922
|
+
if (agentId === undefined || agentId === null) {
|
|
923
|
+
throw 'Missing the required parameter "agentId" when calling getIntegrationsSpeechDialogflowcxAgent';
|
|
924
|
+
}
|
|
925
|
+
|
|
926
|
+
return this.apiClient.callApi(
|
|
927
|
+
'/api/v2/integrations/speech/dialogflowcx/agents/{agentId}',
|
|
928
|
+
'GET',
|
|
929
|
+
{ 'agentId': agentId },
|
|
930
|
+
{ },
|
|
931
|
+
{ },
|
|
932
|
+
{ },
|
|
933
|
+
null,
|
|
934
|
+
['PureCloud OAuth'],
|
|
935
|
+
['application/json'],
|
|
936
|
+
['application/json']
|
|
937
|
+
);
|
|
938
|
+
}
|
|
939
|
+
|
|
940
|
+
/**
|
|
941
|
+
* Get a list of Dialogflow CX agents in the customers' Google accounts
|
|
942
|
+
*
|
|
943
|
+
* @param {Object} opts Optional parameters
|
|
944
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
945
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
946
|
+
* @param {String} opts.name Filter on agent name
|
|
947
|
+
*/
|
|
948
|
+
getIntegrationsSpeechDialogflowcxAgents(opts) {
|
|
949
|
+
opts = opts || {};
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
return this.apiClient.callApi(
|
|
953
|
+
'/api/v2/integrations/speech/dialogflowcx/agents',
|
|
954
|
+
'GET',
|
|
955
|
+
{ },
|
|
956
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
957
|
+
{ },
|
|
958
|
+
{ },
|
|
959
|
+
null,
|
|
960
|
+
['PureCloud OAuth'],
|
|
961
|
+
['application/json'],
|
|
962
|
+
['application/json']
|
|
963
|
+
);
|
|
964
|
+
}
|
|
965
|
+
|
|
915
966
|
/**
|
|
916
967
|
* Get details about a Lex bot alias
|
|
917
968
|
*
|
|
@@ -995,6 +1046,89 @@ class IntegrationsApi {
|
|
|
995
1046
|
);
|
|
996
1047
|
}
|
|
997
1048
|
|
|
1049
|
+
/**
|
|
1050
|
+
* Get details about a Lex V2 bot alias
|
|
1051
|
+
*
|
|
1052
|
+
* @param {String} aliasId The Alias ID
|
|
1053
|
+
*/
|
|
1054
|
+
getIntegrationsSpeechLexv2BotAlias(aliasId) {
|
|
1055
|
+
// verify the required parameter 'aliasId' is set
|
|
1056
|
+
if (aliasId === undefined || aliasId === null) {
|
|
1057
|
+
throw 'Missing the required parameter "aliasId" when calling getIntegrationsSpeechLexv2BotAlias';
|
|
1058
|
+
}
|
|
1059
|
+
|
|
1060
|
+
return this.apiClient.callApi(
|
|
1061
|
+
'/api/v2/integrations/speech/lexv2/bot/alias/{aliasId}',
|
|
1062
|
+
'GET',
|
|
1063
|
+
{ 'aliasId': aliasId },
|
|
1064
|
+
{ },
|
|
1065
|
+
{ },
|
|
1066
|
+
{ },
|
|
1067
|
+
null,
|
|
1068
|
+
['PureCloud OAuth'],
|
|
1069
|
+
['application/json'],
|
|
1070
|
+
['application/json']
|
|
1071
|
+
);
|
|
1072
|
+
}
|
|
1073
|
+
|
|
1074
|
+
/**
|
|
1075
|
+
* Get a list of aliases for a Lex V2 bot
|
|
1076
|
+
*
|
|
1077
|
+
* @param {String} botId The Bot ID
|
|
1078
|
+
* @param {Object} opts Optional parameters
|
|
1079
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1080
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1081
|
+
* @param {Object} opts.status Filter on alias status
|
|
1082
|
+
* @param {String} opts.name Filter on alias name
|
|
1083
|
+
*/
|
|
1084
|
+
getIntegrationsSpeechLexv2BotBotIdAliases(botId, opts) {
|
|
1085
|
+
opts = opts || {};
|
|
1086
|
+
|
|
1087
|
+
// verify the required parameter 'botId' is set
|
|
1088
|
+
if (botId === undefined || botId === null) {
|
|
1089
|
+
throw 'Missing the required parameter "botId" when calling getIntegrationsSpeechLexv2BotBotIdAliases';
|
|
1090
|
+
}
|
|
1091
|
+
|
|
1092
|
+
return this.apiClient.callApi(
|
|
1093
|
+
'/api/v2/integrations/speech/lexv2/bot/{botId}/aliases',
|
|
1094
|
+
'GET',
|
|
1095
|
+
{ 'botId': botId },
|
|
1096
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'status': opts['status'],'name': opts['name'] },
|
|
1097
|
+
{ },
|
|
1098
|
+
{ },
|
|
1099
|
+
null,
|
|
1100
|
+
['PureCloud OAuth'],
|
|
1101
|
+
['application/json'],
|
|
1102
|
+
['application/json']
|
|
1103
|
+
);
|
|
1104
|
+
}
|
|
1105
|
+
|
|
1106
|
+
/**
|
|
1107
|
+
* Get a list of Lex V2 bots
|
|
1108
|
+
*
|
|
1109
|
+
* @param {Object} opts Optional parameters
|
|
1110
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1111
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1112
|
+
* @param {String} opts.name Filter on bot name
|
|
1113
|
+
*/
|
|
1114
|
+
getIntegrationsSpeechLexv2Bots(opts) {
|
|
1115
|
+
opts = opts || {};
|
|
1116
|
+
|
|
1117
|
+
|
|
1118
|
+
return this.apiClient.callApi(
|
|
1119
|
+
'/api/v2/integrations/speech/lexv2/bots',
|
|
1120
|
+
'GET',
|
|
1121
|
+
{ },
|
|
1122
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
1123
|
+
{ },
|
|
1124
|
+
{ },
|
|
1125
|
+
null,
|
|
1126
|
+
['PureCloud OAuth'],
|
|
1127
|
+
['application/json'],
|
|
1128
|
+
['application/json']
|
|
1129
|
+
);
|
|
1130
|
+
}
|
|
1131
|
+
|
|
998
1132
|
/**
|
|
999
1133
|
* Get a Nuance bot in the specified Integration
|
|
1000
1134
|
*
|
|
@@ -1003,7 +1137,6 @@ class IntegrationsApi {
|
|
|
1003
1137
|
* @param {Object} opts Optional parameters
|
|
1004
1138
|
* @param {Array.<String>} opts.expand expand
|
|
1005
1139
|
* @param {Object} opts.targetChannel targetChannel
|
|
1006
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1007
1140
|
*/
|
|
1008
1141
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId, botId, opts) {
|
|
1009
1142
|
opts = opts || {};
|
|
@@ -1037,7 +1170,6 @@ class IntegrationsApi {
|
|
|
1037
1170
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1038
1171
|
* @param {String} botId The Nuance bot ID
|
|
1039
1172
|
* @param {String} jobId The asynchronous job ID
|
|
1040
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1041
1173
|
*/
|
|
1042
1174
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId, botId, jobId) {
|
|
1043
1175
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -1073,7 +1205,6 @@ class IntegrationsApi {
|
|
|
1073
1205
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1074
1206
|
* @param {String} botId The Nuance bot ID
|
|
1075
1207
|
* @param {String} jobId The asynchronous job ID
|
|
1076
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1077
1208
|
*/
|
|
1078
1209
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId, botId, jobId) {
|
|
1079
1210
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -1111,7 +1242,6 @@ class IntegrationsApi {
|
|
|
1111
1242
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1112
1243
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1113
1244
|
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
1114
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1115
1245
|
*/
|
|
1116
1246
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId, opts) {
|
|
1117
1247
|
opts = opts || {};
|
|
@@ -1140,7 +1270,6 @@ class IntegrationsApi {
|
|
|
1140
1270
|
*
|
|
1141
1271
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1142
1272
|
* @param {String} jobId The asynchronous job ID
|
|
1143
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1144
1273
|
*/
|
|
1145
1274
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId, jobId) {
|
|
1146
1275
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -1171,7 +1300,6 @@ class IntegrationsApi {
|
|
|
1171
1300
|
*
|
|
1172
1301
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1173
1302
|
* @param {String} jobId The asynchronous job ID
|
|
1174
|
-
* getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1175
1303
|
*/
|
|
1176
1304
|
getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId, jobId) {
|
|
1177
1305
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -1197,6 +1325,57 @@ class IntegrationsApi {
|
|
|
1197
1325
|
);
|
|
1198
1326
|
}
|
|
1199
1327
|
|
|
1328
|
+
/**
|
|
1329
|
+
* Get details about a STT engine
|
|
1330
|
+
*
|
|
1331
|
+
* @param {String} engineId The engine ID
|
|
1332
|
+
*/
|
|
1333
|
+
getIntegrationsSpeechSttEngine(engineId) {
|
|
1334
|
+
// verify the required parameter 'engineId' is set
|
|
1335
|
+
if (engineId === undefined || engineId === null) {
|
|
1336
|
+
throw 'Missing the required parameter "engineId" when calling getIntegrationsSpeechSttEngine';
|
|
1337
|
+
}
|
|
1338
|
+
|
|
1339
|
+
return this.apiClient.callApi(
|
|
1340
|
+
'/api/v2/integrations/speech/stt/engines/{engineId}',
|
|
1341
|
+
'GET',
|
|
1342
|
+
{ 'engineId': engineId },
|
|
1343
|
+
{ },
|
|
1344
|
+
{ },
|
|
1345
|
+
{ },
|
|
1346
|
+
null,
|
|
1347
|
+
['PureCloud OAuth'],
|
|
1348
|
+
['application/json'],
|
|
1349
|
+
['application/json']
|
|
1350
|
+
);
|
|
1351
|
+
}
|
|
1352
|
+
|
|
1353
|
+
/**
|
|
1354
|
+
* Get a list of STT engines enabled for org
|
|
1355
|
+
*
|
|
1356
|
+
* @param {Object} opts Optional parameters
|
|
1357
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1358
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1359
|
+
* @param {String} opts.name Filter on engine name
|
|
1360
|
+
*/
|
|
1361
|
+
getIntegrationsSpeechSttEngines(opts) {
|
|
1362
|
+
opts = opts || {};
|
|
1363
|
+
|
|
1364
|
+
|
|
1365
|
+
return this.apiClient.callApi(
|
|
1366
|
+
'/api/v2/integrations/speech/stt/engines',
|
|
1367
|
+
'GET',
|
|
1368
|
+
{ },
|
|
1369
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
1370
|
+
{ },
|
|
1371
|
+
{ },
|
|
1372
|
+
null,
|
|
1373
|
+
['PureCloud OAuth'],
|
|
1374
|
+
['application/json'],
|
|
1375
|
+
['application/json']
|
|
1376
|
+
);
|
|
1377
|
+
}
|
|
1378
|
+
|
|
1200
1379
|
/**
|
|
1201
1380
|
* Get details about a TTS engine
|
|
1202
1381
|
*
|
|
@@ -1418,6 +1597,60 @@ class IntegrationsApi {
|
|
|
1418
1597
|
);
|
|
1419
1598
|
}
|
|
1420
1599
|
|
|
1600
|
+
/**
|
|
1601
|
+
* UC integration client application configuration.
|
|
1602
|
+
* This endpoint returns basic UI configuration data for the specified Unified Communications integration client application.
|
|
1603
|
+
* @param {String} ucIntegrationId 3rd Party Service Type
|
|
1604
|
+
*/
|
|
1605
|
+
getIntegrationsUnifiedcommunicationsClientapp(ucIntegrationId) {
|
|
1606
|
+
// verify the required parameter 'ucIntegrationId' is set
|
|
1607
|
+
if (ucIntegrationId === undefined || ucIntegrationId === null) {
|
|
1608
|
+
throw 'Missing the required parameter "ucIntegrationId" when calling getIntegrationsUnifiedcommunicationsClientapp';
|
|
1609
|
+
}
|
|
1610
|
+
|
|
1611
|
+
return this.apiClient.callApi(
|
|
1612
|
+
'/api/v2/integrations/unifiedcommunications/clientapps/{ucIntegrationId}',
|
|
1613
|
+
'GET',
|
|
1614
|
+
{ 'ucIntegrationId': ucIntegrationId },
|
|
1615
|
+
{ },
|
|
1616
|
+
{ },
|
|
1617
|
+
{ },
|
|
1618
|
+
null,
|
|
1619
|
+
['PureCloud OAuth'],
|
|
1620
|
+
['application/json'],
|
|
1621
|
+
['application/json']
|
|
1622
|
+
);
|
|
1623
|
+
}
|
|
1624
|
+
|
|
1625
|
+
/**
|
|
1626
|
+
* List UC integration client application configurations.
|
|
1627
|
+
* This endpoint returns basic UI configuration data for all Unified Communications integrations client applications enabled.
|
|
1628
|
+
* @param {Object} opts Optional parameters
|
|
1629
|
+
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
1630
|
+
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
1631
|
+
* @param {String} opts.sortBy variable name requested to sort by
|
|
1632
|
+
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
1633
|
+
* @param {String} opts.nextPage next page token
|
|
1634
|
+
* @param {String} opts.previousPage Previous page token
|
|
1635
|
+
*/
|
|
1636
|
+
getIntegrationsUnifiedcommunicationsClientapps(opts) {
|
|
1637
|
+
opts = opts || {};
|
|
1638
|
+
|
|
1639
|
+
|
|
1640
|
+
return this.apiClient.callApi(
|
|
1641
|
+
'/api/v2/integrations/unifiedcommunications/clientapps',
|
|
1642
|
+
'GET',
|
|
1643
|
+
{ },
|
|
1644
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'] },
|
|
1645
|
+
{ },
|
|
1646
|
+
{ },
|
|
1647
|
+
null,
|
|
1648
|
+
['PureCloud OAuth'],
|
|
1649
|
+
['application/json'],
|
|
1650
|
+
['application/json']
|
|
1651
|
+
);
|
|
1652
|
+
}
|
|
1653
|
+
|
|
1421
1654
|
/**
|
|
1422
1655
|
* List permitted user app integrations for the logged in user
|
|
1423
1656
|
*
|
|
@@ -1825,7 +2058,6 @@ class IntegrationsApi {
|
|
|
1825
2058
|
* @param {Object} opts Optional parameters
|
|
1826
2059
|
* @param {Array.<String>} opts.expand expand
|
|
1827
2060
|
* @param {String} opts.body targetChannel
|
|
1828
|
-
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1829
2061
|
*/
|
|
1830
2062
|
postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId, botId, opts) {
|
|
1831
2063
|
opts = opts || {};
|
|
@@ -1861,7 +2093,6 @@ class IntegrationsApi {
|
|
|
1861
2093
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1862
2094
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1863
2095
|
* @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
|
|
1864
|
-
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1865
2096
|
*/
|
|
1866
2097
|
postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId, opts) {
|
|
1867
2098
|
opts = opts || {};
|
|
@@ -1890,7 +2121,6 @@ class IntegrationsApi {
|
|
|
1890
2121
|
*
|
|
1891
2122
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
1892
2123
|
* @param {Object} settings
|
|
1893
|
-
* postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1894
2124
|
*/
|
|
1895
2125
|
postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId, settings) {
|
|
1896
2126
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -2040,7 +2270,6 @@ class IntegrationsApi {
|
|
|
2040
2270
|
*
|
|
2041
2271
|
* @param {String} nuanceIntegrationId The integration ID for this group of bots
|
|
2042
2272
|
* @param {Object} settings
|
|
2043
|
-
* putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2044
2273
|
*/
|
|
2045
2274
|
putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId, settings) {
|
|
2046
2275
|
// verify the required parameter 'nuanceIntegrationId' is set
|
|
@@ -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 189.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -149,6 +149,32 @@ class JourneyApi {
|
|
|
149
149
|
);
|
|
150
150
|
}
|
|
151
151
|
|
|
152
|
+
/**
|
|
153
|
+
* Delete a Journey View by ID
|
|
154
|
+
* deletes all versions
|
|
155
|
+
* @param {String} viewId viewId
|
|
156
|
+
* deleteJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
157
|
+
*/
|
|
158
|
+
deleteJourneyView(viewId) {
|
|
159
|
+
// verify the required parameter 'viewId' is set
|
|
160
|
+
if (viewId === undefined || viewId === null) {
|
|
161
|
+
throw 'Missing the required parameter "viewId" when calling deleteJourneyView';
|
|
162
|
+
}
|
|
163
|
+
|
|
164
|
+
return this.apiClient.callApi(
|
|
165
|
+
'/api/v2/journey/views/{viewId}',
|
|
166
|
+
'DELETE',
|
|
167
|
+
{ 'viewId': viewId },
|
|
168
|
+
{ },
|
|
169
|
+
{ },
|
|
170
|
+
{ },
|
|
171
|
+
null,
|
|
172
|
+
['PureCloud OAuth'],
|
|
173
|
+
['application/json'],
|
|
174
|
+
['application/json']
|
|
175
|
+
);
|
|
176
|
+
}
|
|
177
|
+
|
|
152
178
|
/**
|
|
153
179
|
* Get status for async query for journey aggregates
|
|
154
180
|
*
|
|
@@ -772,6 +798,84 @@ class JourneyApi {
|
|
|
772
798
|
);
|
|
773
799
|
}
|
|
774
800
|
|
|
801
|
+
/**
|
|
802
|
+
* Get a Journey View by ID
|
|
803
|
+
* returns the latest version
|
|
804
|
+
* @param {String} viewId viewId
|
|
805
|
+
* getJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
806
|
+
*/
|
|
807
|
+
getJourneyView(viewId) {
|
|
808
|
+
// verify the required parameter 'viewId' is set
|
|
809
|
+
if (viewId === undefined || viewId === null) {
|
|
810
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyView';
|
|
811
|
+
}
|
|
812
|
+
|
|
813
|
+
return this.apiClient.callApi(
|
|
814
|
+
'/api/v2/journey/views/{viewId}',
|
|
815
|
+
'GET',
|
|
816
|
+
{ 'viewId': viewId },
|
|
817
|
+
{ },
|
|
818
|
+
{ },
|
|
819
|
+
{ },
|
|
820
|
+
null,
|
|
821
|
+
['PureCloud OAuth'],
|
|
822
|
+
['application/json'],
|
|
823
|
+
['application/json']
|
|
824
|
+
);
|
|
825
|
+
}
|
|
826
|
+
|
|
827
|
+
/**
|
|
828
|
+
* Get a Journey View by ID and version
|
|
829
|
+
*
|
|
830
|
+
* @param {String} viewId viewId
|
|
831
|
+
* @param {String} versionId versionId
|
|
832
|
+
* getJourneyViewVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
833
|
+
*/
|
|
834
|
+
getJourneyViewVersion(viewId, versionId) {
|
|
835
|
+
// verify the required parameter 'viewId' is set
|
|
836
|
+
if (viewId === undefined || viewId === null) {
|
|
837
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersion';
|
|
838
|
+
}
|
|
839
|
+
// verify the required parameter 'versionId' is set
|
|
840
|
+
if (versionId === undefined || versionId === null) {
|
|
841
|
+
throw 'Missing the required parameter "versionId" when calling getJourneyViewVersion';
|
|
842
|
+
}
|
|
843
|
+
|
|
844
|
+
return this.apiClient.callApi(
|
|
845
|
+
'/api/v2/journey/views/{viewId}/versions/{versionId}',
|
|
846
|
+
'GET',
|
|
847
|
+
{ 'viewId': viewId,'versionId': versionId },
|
|
848
|
+
{ },
|
|
849
|
+
{ },
|
|
850
|
+
{ },
|
|
851
|
+
null,
|
|
852
|
+
['PureCloud OAuth'],
|
|
853
|
+
['application/json'],
|
|
854
|
+
['application/json']
|
|
855
|
+
);
|
|
856
|
+
}
|
|
857
|
+
|
|
858
|
+
/**
|
|
859
|
+
* Get a list of Journey Views
|
|
860
|
+
*
|
|
861
|
+
* getJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
862
|
+
*/
|
|
863
|
+
getJourneyViews() {
|
|
864
|
+
|
|
865
|
+
return this.apiClient.callApi(
|
|
866
|
+
'/api/v2/journey/views',
|
|
867
|
+
'GET',
|
|
868
|
+
{ },
|
|
869
|
+
{ },
|
|
870
|
+
{ },
|
|
871
|
+
{ },
|
|
872
|
+
null,
|
|
873
|
+
['PureCloud OAuth'],
|
|
874
|
+
['application/json'],
|
|
875
|
+
['application/json']
|
|
876
|
+
);
|
|
877
|
+
}
|
|
878
|
+
|
|
775
879
|
/**
|
|
776
880
|
* Update single action map.
|
|
777
881
|
*
|
|
@@ -1100,6 +1204,31 @@ class JourneyApi {
|
|
|
1100
1204
|
);
|
|
1101
1205
|
}
|
|
1102
1206
|
|
|
1207
|
+
/**
|
|
1208
|
+
* Query for flow paths.
|
|
1209
|
+
*
|
|
1210
|
+
* @param {Object} opts Optional parameters
|
|
1211
|
+
* @param {Object} opts.body
|
|
1212
|
+
* postJourneyFlowsPathsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1213
|
+
*/
|
|
1214
|
+
postJourneyFlowsPathsQuery(opts) {
|
|
1215
|
+
opts = opts || {};
|
|
1216
|
+
|
|
1217
|
+
|
|
1218
|
+
return this.apiClient.callApi(
|
|
1219
|
+
'/api/v2/journey/flows/paths/query',
|
|
1220
|
+
'POST',
|
|
1221
|
+
{ },
|
|
1222
|
+
{ },
|
|
1223
|
+
{ },
|
|
1224
|
+
{ },
|
|
1225
|
+
opts['body'],
|
|
1226
|
+
['PureCloud OAuth'],
|
|
1227
|
+
['application/json'],
|
|
1228
|
+
['application/json']
|
|
1229
|
+
);
|
|
1230
|
+
}
|
|
1231
|
+
|
|
1103
1232
|
/**
|
|
1104
1233
|
* Create an outcome.
|
|
1105
1234
|
*
|
|
@@ -1197,6 +1326,63 @@ class JourneyApi {
|
|
|
1197
1326
|
);
|
|
1198
1327
|
}
|
|
1199
1328
|
|
|
1329
|
+
/**
|
|
1330
|
+
* Update a Journey View by ID
|
|
1331
|
+
* creates a new version
|
|
1332
|
+
* @param {String} viewId viewId
|
|
1333
|
+
* @param {Object} body JourneyView
|
|
1334
|
+
* postJourneyViewVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1335
|
+
*/
|
|
1336
|
+
postJourneyViewVersions(viewId, body) {
|
|
1337
|
+
// verify the required parameter 'viewId' is set
|
|
1338
|
+
if (viewId === undefined || viewId === null) {
|
|
1339
|
+
throw 'Missing the required parameter "viewId" when calling postJourneyViewVersions';
|
|
1340
|
+
}
|
|
1341
|
+
// verify the required parameter 'body' is set
|
|
1342
|
+
if (body === undefined || body === null) {
|
|
1343
|
+
throw 'Missing the required parameter "body" when calling postJourneyViewVersions';
|
|
1344
|
+
}
|
|
1345
|
+
|
|
1346
|
+
return this.apiClient.callApi(
|
|
1347
|
+
'/api/v2/journey/views/{viewId}/versions',
|
|
1348
|
+
'POST',
|
|
1349
|
+
{ 'viewId': viewId },
|
|
1350
|
+
{ },
|
|
1351
|
+
{ },
|
|
1352
|
+
{ },
|
|
1353
|
+
body,
|
|
1354
|
+
['PureCloud OAuth'],
|
|
1355
|
+
['application/json'],
|
|
1356
|
+
['application/json']
|
|
1357
|
+
);
|
|
1358
|
+
}
|
|
1359
|
+
|
|
1360
|
+
/**
|
|
1361
|
+
* Create a new Journey View
|
|
1362
|
+
*
|
|
1363
|
+
* @param {Object} body JourneyView
|
|
1364
|
+
* postJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1365
|
+
*/
|
|
1366
|
+
postJourneyViews(body) {
|
|
1367
|
+
// verify the required parameter 'body' is set
|
|
1368
|
+
if (body === undefined || body === null) {
|
|
1369
|
+
throw 'Missing the required parameter "body" when calling postJourneyViews';
|
|
1370
|
+
}
|
|
1371
|
+
|
|
1372
|
+
return this.apiClient.callApi(
|
|
1373
|
+
'/api/v2/journey/views',
|
|
1374
|
+
'POST',
|
|
1375
|
+
{ },
|
|
1376
|
+
{ },
|
|
1377
|
+
{ },
|
|
1378
|
+
{ },
|
|
1379
|
+
body,
|
|
1380
|
+
['PureCloud OAuth'],
|
|
1381
|
+
['application/json'],
|
|
1382
|
+
['application/json']
|
|
1383
|
+
);
|
|
1384
|
+
}
|
|
1385
|
+
|
|
1200
1386
|
}
|
|
1201
1387
|
|
|
1202
1388
|
|