purecloud-platform-client-v2 239.0.0 → 241.1.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +866 -115
- package/dist/web-amd/purecloud-platform-client-v2.js +866 -115
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +294 -118
- package/dist/web-cjs/purecloud-platform-client-v2.js +294 -118
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1281 -752
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +47 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +36 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +156 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +135 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -14
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.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 +273 -13
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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/EmployeeEngagementApi.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 +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 +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -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 +1 -1
- 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 +1 -1
- 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 +134 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +3 -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 +1 -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 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 241.1.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -943,6 +943,41 @@ class ApiClient {
|
|
|
943
943
|
this.authData.state = tempState;
|
|
944
944
|
}
|
|
945
945
|
|
|
946
|
+
/**
|
|
947
|
+
* @description Clears the auth token from local storage, if enabled.
|
|
948
|
+
*/
|
|
949
|
+
_clearSettings() {
|
|
950
|
+
try {
|
|
951
|
+
if (this.authData && this.authData.accessToken) this.authData.accessToken = null;
|
|
952
|
+
if (this.authentications['PureCloud OAuth'] && this.authentications['PureCloud OAuth'].accessToken) this.authentications['PureCloud OAuth'].accessToken = null;
|
|
953
|
+
|
|
954
|
+
if (this.authData && this.authData.state) this.authData.state = null;
|
|
955
|
+
|
|
956
|
+
if (this.authData && this.authData.error) this.authData.error = null;
|
|
957
|
+
if (this.authData && this.authData.error_description) this.authData.error_description = null;
|
|
958
|
+
|
|
959
|
+
if (this.authData && this.authData.tokenExpiryTime) this.authData.tokenExpiryTime = 0;
|
|
960
|
+
if (this.authData && this.authData.tokenExpiryTimeString) this.authData.tokenExpiryTimeString = null;
|
|
961
|
+
|
|
962
|
+
// Don't save settings if we aren't supposed to be persisting them
|
|
963
|
+
if (this.persistSettings !== true) return;
|
|
964
|
+
|
|
965
|
+
// Ensure we can access local storage
|
|
966
|
+
if (!this.hasLocalStorage) {
|
|
967
|
+
return;
|
|
968
|
+
}
|
|
969
|
+
|
|
970
|
+
// Remove state from data so it's not persisted
|
|
971
|
+
let tempData = JSON.parse(JSON.stringify(this.authData));
|
|
972
|
+
delete tempData.state;
|
|
973
|
+
|
|
974
|
+
// Save updated auth data
|
|
975
|
+
localStorage.setItem(`${this.settingsPrefix}_auth_data`, JSON.stringify(tempData));
|
|
976
|
+
} catch (e) {
|
|
977
|
+
console.error(e);
|
|
978
|
+
}
|
|
979
|
+
}
|
|
980
|
+
|
|
946
981
|
/**
|
|
947
982
|
* @description Sets the environment used by the session
|
|
948
983
|
* @param {string} environment - (Optional, default "mypurecloud.com") Environment the session use, e.g. mypurecloud.ie, mypurecloud.com.au, etc.
|
|
@@ -1123,6 +1158,7 @@ class ApiClient {
|
|
|
1123
1158
|
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
1124
1159
|
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
1125
1160
|
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
1161
|
+
* @param {string} opts.prompt - (optional) Use the prompt=login parameter to require that the user be prompted to enter credentials at the Gensys Cloud login screen and ignore any remembered sessions (auth cookies).
|
|
1126
1162
|
*/
|
|
1127
1163
|
loginImplicitGrant(clientId, redirectUri, opts) {
|
|
1128
1164
|
// Check for auth token in hash
|
|
@@ -1164,6 +1200,7 @@ class ApiClient {
|
|
|
1164
1200
|
if (opts.state) query.state = encodeURIComponent(opts.state);
|
|
1165
1201
|
if (opts.org) query.org = encodeURIComponent(opts.org);
|
|
1166
1202
|
if (opts.provider) query.provider = encodeURIComponent(opts.provider);
|
|
1203
|
+
if (opts.prompt && opts.prompt == 'login') query.prompt = encodeURIComponent(opts.prompt);
|
|
1167
1204
|
|
|
1168
1205
|
var url = this._buildAuthUrl('oauth/authorize', query);
|
|
1169
1206
|
window.location.replace(url);
|
|
@@ -1490,6 +1527,7 @@ class ApiClient {
|
|
|
1490
1527
|
* @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
|
|
1491
1528
|
* @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
|
|
1492
1529
|
* @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
|
|
1530
|
+
* @param {string} opts.prompt - (optional) Use the prompt=login parameter to require that the user be prompted to enter credentials at the Gensys Cloud login screen and ignore any remembered sessions (auth cookies).
|
|
1493
1531
|
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
1494
1532
|
*/
|
|
1495
1533
|
loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
|
|
@@ -1594,6 +1632,7 @@ class ApiClient {
|
|
|
1594
1632
|
if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
|
|
1595
1633
|
if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
|
|
1596
1634
|
if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
|
|
1635
|
+
if (opts.prompt && opts.prompt == 'login') tokenQuery.prompt = encodeURIComponent(opts.prompt);
|
|
1597
1636
|
|
|
1598
1637
|
var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
|
|
1599
1638
|
window.location.replace(url);
|
|
@@ -1931,6 +1970,13 @@ class ApiClient {
|
|
|
1931
1970
|
this._saveSettings({ accessToken: token });
|
|
1932
1971
|
}
|
|
1933
1972
|
|
|
1973
|
+
/**
|
|
1974
|
+
* @description Clears the access token to be used with requests
|
|
1975
|
+
*/
|
|
1976
|
+
clearAccessToken() {
|
|
1977
|
+
this._clearSettings();
|
|
1978
|
+
}
|
|
1979
|
+
|
|
1934
1980
|
/**
|
|
1935
1981
|
* @description Sets the storage key to use when persisting the access token
|
|
1936
1982
|
* @param {string} storageKey - The storage key name
|
|
@@ -2361,7 +2407,7 @@ class AIStudioApi {
|
|
|
2361
2407
|
/**
|
|
2362
2408
|
* AIStudio service.
|
|
2363
2409
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2364
|
-
* @version
|
|
2410
|
+
* @version 241.1.0
|
|
2365
2411
|
*/
|
|
2366
2412
|
|
|
2367
2413
|
/**
|
|
@@ -2779,6 +2825,41 @@ class AIStudioApi {
|
|
|
2779
2825
|
);
|
|
2780
2826
|
}
|
|
2781
2827
|
|
|
2828
|
+
/**
|
|
2829
|
+
* Add a turn to a guide session.
|
|
2830
|
+
* Creates a new turn in the specified guide session with the provided request data. If the session ID doesnt exist, a new session will be created automatically.
|
|
2831
|
+
* @param {String} guideId Guide ID
|
|
2832
|
+
* @param {String} guideSessionId Guide Session ID
|
|
2833
|
+
* @param {Object} body
|
|
2834
|
+
*/
|
|
2835
|
+
postGuideSessionTurns(guideId, guideSessionId, body) {
|
|
2836
|
+
// verify the required parameter 'guideId' is set
|
|
2837
|
+
if (guideId === undefined || guideId === null || guideId === '') {
|
|
2838
|
+
throw 'Missing the required parameter "guideId" when calling postGuideSessionTurns';
|
|
2839
|
+
}
|
|
2840
|
+
// verify the required parameter 'guideSessionId' is set
|
|
2841
|
+
if (guideSessionId === undefined || guideSessionId === null || guideSessionId === '') {
|
|
2842
|
+
throw 'Missing the required parameter "guideSessionId" when calling postGuideSessionTurns';
|
|
2843
|
+
}
|
|
2844
|
+
// verify the required parameter 'body' is set
|
|
2845
|
+
if (body === undefined || body === null) {
|
|
2846
|
+
throw 'Missing the required parameter "body" when calling postGuideSessionTurns';
|
|
2847
|
+
}
|
|
2848
|
+
|
|
2849
|
+
return this.apiClient.callApi(
|
|
2850
|
+
'/api/v2/guides/{guideId}/sessions/{guideSessionId}/turns',
|
|
2851
|
+
'POST',
|
|
2852
|
+
{ 'guideId': guideId,'guideSessionId': guideSessionId },
|
|
2853
|
+
{ },
|
|
2854
|
+
{ },
|
|
2855
|
+
{ },
|
|
2856
|
+
body,
|
|
2857
|
+
['PureCloud OAuth'],
|
|
2858
|
+
['application/json'],
|
|
2859
|
+
['application/json']
|
|
2860
|
+
);
|
|
2861
|
+
}
|
|
2862
|
+
|
|
2782
2863
|
/**
|
|
2783
2864
|
* Start the publishing of a guide version.
|
|
2784
2865
|
*
|
|
@@ -2933,7 +3014,7 @@ class AgentAssistantsApi {
|
|
|
2933
3014
|
/**
|
|
2934
3015
|
* AgentAssistants service.
|
|
2935
3016
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2936
|
-
* @version
|
|
3017
|
+
* @version 241.1.0
|
|
2937
3018
|
*/
|
|
2938
3019
|
|
|
2939
3020
|
/**
|
|
@@ -3032,6 +3113,31 @@ class AgentAssistantsApi {
|
|
|
3032
3113
|
);
|
|
3033
3114
|
}
|
|
3034
3115
|
|
|
3116
|
+
/**
|
|
3117
|
+
* Delete an agent checklist
|
|
3118
|
+
*
|
|
3119
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
3120
|
+
*/
|
|
3121
|
+
deleteAssistantsAgentchecklist(agentChecklistId) {
|
|
3122
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
3123
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
3124
|
+
throw 'Missing the required parameter "agentChecklistId" when calling deleteAssistantsAgentchecklist';
|
|
3125
|
+
}
|
|
3126
|
+
|
|
3127
|
+
return this.apiClient.callApi(
|
|
3128
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
3129
|
+
'DELETE',
|
|
3130
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
3131
|
+
{ },
|
|
3132
|
+
{ },
|
|
3133
|
+
{ },
|
|
3134
|
+
null,
|
|
3135
|
+
['PureCloud OAuth'],
|
|
3136
|
+
['application/json'],
|
|
3137
|
+
['application/json']
|
|
3138
|
+
);
|
|
3139
|
+
}
|
|
3140
|
+
|
|
3035
3141
|
/**
|
|
3036
3142
|
* Get an assistant.
|
|
3037
3143
|
*
|
|
@@ -3156,6 +3262,81 @@ class AgentAssistantsApi {
|
|
|
3156
3262
|
);
|
|
3157
3263
|
}
|
|
3158
3264
|
|
|
3265
|
+
/**
|
|
3266
|
+
* Get an agent checklist
|
|
3267
|
+
*
|
|
3268
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
3269
|
+
*/
|
|
3270
|
+
getAssistantsAgentchecklist(agentChecklistId) {
|
|
3271
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
3272
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
3273
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getAssistantsAgentchecklist';
|
|
3274
|
+
}
|
|
3275
|
+
|
|
3276
|
+
return this.apiClient.callApi(
|
|
3277
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
3278
|
+
'GET',
|
|
3279
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
3280
|
+
{ },
|
|
3281
|
+
{ },
|
|
3282
|
+
{ },
|
|
3283
|
+
null,
|
|
3284
|
+
['PureCloud OAuth'],
|
|
3285
|
+
['application/json'],
|
|
3286
|
+
['application/json']
|
|
3287
|
+
);
|
|
3288
|
+
}
|
|
3289
|
+
|
|
3290
|
+
/**
|
|
3291
|
+
* Get the list of agent checklists
|
|
3292
|
+
*
|
|
3293
|
+
* @param {Object} opts Optional parameters
|
|
3294
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
3295
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3296
|
+
* @param {String} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 25)
|
|
3297
|
+
* @param {String} opts.namePrefix The agent checklist name prefix filter applied to the listing.
|
|
3298
|
+
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
3299
|
+
* @param {Object} opts.sortOrder The sort order for the listing
|
|
3300
|
+
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
3301
|
+
*/
|
|
3302
|
+
getAssistantsAgentchecklists(opts) {
|
|
3303
|
+
opts = opts || {};
|
|
3304
|
+
|
|
3305
|
+
|
|
3306
|
+
return this.apiClient.callApi(
|
|
3307
|
+
'/api/v2/assistants/agentchecklists',
|
|
3308
|
+
'GET',
|
|
3309
|
+
{ },
|
|
3310
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
3311
|
+
{ },
|
|
3312
|
+
{ },
|
|
3313
|
+
null,
|
|
3314
|
+
['PureCloud OAuth'],
|
|
3315
|
+
['application/json'],
|
|
3316
|
+
['application/json']
|
|
3317
|
+
);
|
|
3318
|
+
}
|
|
3319
|
+
|
|
3320
|
+
/**
|
|
3321
|
+
* Get the list of supported languages
|
|
3322
|
+
*
|
|
3323
|
+
*/
|
|
3324
|
+
getAssistantsAgentchecklistsLanguages() {
|
|
3325
|
+
|
|
3326
|
+
return this.apiClient.callApi(
|
|
3327
|
+
'/api/v2/assistants/agentchecklists/languages',
|
|
3328
|
+
'GET',
|
|
3329
|
+
{ },
|
|
3330
|
+
{ },
|
|
3331
|
+
{ },
|
|
3332
|
+
{ },
|
|
3333
|
+
null,
|
|
3334
|
+
['PureCloud OAuth'],
|
|
3335
|
+
['application/json'],
|
|
3336
|
+
['application/json']
|
|
3337
|
+
);
|
|
3338
|
+
}
|
|
3339
|
+
|
|
3159
3340
|
/**
|
|
3160
3341
|
* Get all queues assigned to any assistant.
|
|
3161
3342
|
*
|
|
@@ -3378,6 +3559,31 @@ class AgentAssistantsApi {
|
|
|
3378
3559
|
);
|
|
3379
3560
|
}
|
|
3380
3561
|
|
|
3562
|
+
/**
|
|
3563
|
+
* Create an agent checklist
|
|
3564
|
+
*
|
|
3565
|
+
* @param {Object} body Request body containing details of checklist to be added
|
|
3566
|
+
*/
|
|
3567
|
+
postAssistantsAgentchecklists(body) {
|
|
3568
|
+
// verify the required parameter 'body' is set
|
|
3569
|
+
if (body === undefined || body === null) {
|
|
3570
|
+
throw 'Missing the required parameter "body" when calling postAssistantsAgentchecklists';
|
|
3571
|
+
}
|
|
3572
|
+
|
|
3573
|
+
return this.apiClient.callApi(
|
|
3574
|
+
'/api/v2/assistants/agentchecklists',
|
|
3575
|
+
'POST',
|
|
3576
|
+
{ },
|
|
3577
|
+
{ },
|
|
3578
|
+
{ },
|
|
3579
|
+
{ },
|
|
3580
|
+
body,
|
|
3581
|
+
['PureCloud OAuth'],
|
|
3582
|
+
['application/json'],
|
|
3583
|
+
['application/json']
|
|
3584
|
+
);
|
|
3585
|
+
}
|
|
3586
|
+
|
|
3381
3587
|
/**
|
|
3382
3588
|
* Create a queue assistant association.
|
|
3383
3589
|
*
|
|
@@ -3413,13 +3619,43 @@ class AgentAssistantsApi {
|
|
|
3413
3619
|
);
|
|
3414
3620
|
}
|
|
3415
3621
|
|
|
3622
|
+
/**
|
|
3623
|
+
* Update an agent checklist
|
|
3624
|
+
*
|
|
3625
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
3626
|
+
* @param {Object} body Request body containing details of checklist to be updated
|
|
3627
|
+
*/
|
|
3628
|
+
putAssistantsAgentchecklist(agentChecklistId, body) {
|
|
3629
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
3630
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
3631
|
+
throw 'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';
|
|
3632
|
+
}
|
|
3633
|
+
// verify the required parameter 'body' is set
|
|
3634
|
+
if (body === undefined || body === null) {
|
|
3635
|
+
throw 'Missing the required parameter "body" when calling putAssistantsAgentchecklist';
|
|
3636
|
+
}
|
|
3637
|
+
|
|
3638
|
+
return this.apiClient.callApi(
|
|
3639
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
3640
|
+
'PUT',
|
|
3641
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
3642
|
+
{ },
|
|
3643
|
+
{ },
|
|
3644
|
+
{ },
|
|
3645
|
+
body,
|
|
3646
|
+
['PureCloud OAuth'],
|
|
3647
|
+
['application/json'],
|
|
3648
|
+
['application/json']
|
|
3649
|
+
);
|
|
3650
|
+
}
|
|
3651
|
+
|
|
3416
3652
|
}
|
|
3417
3653
|
|
|
3418
3654
|
class AgentCopilotApi {
|
|
3419
3655
|
/**
|
|
3420
3656
|
* AgentCopilot service.
|
|
3421
3657
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3422
|
-
* @version
|
|
3658
|
+
* @version 241.1.0
|
|
3423
3659
|
*/
|
|
3424
3660
|
|
|
3425
3661
|
/**
|
|
@@ -3519,7 +3755,7 @@ class AgentUIApi {
|
|
|
3519
3755
|
/**
|
|
3520
3756
|
* AgentUI service.
|
|
3521
3757
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3522
|
-
* @version
|
|
3758
|
+
* @version 241.1.0
|
|
3523
3759
|
*/
|
|
3524
3760
|
|
|
3525
3761
|
/**
|
|
@@ -3650,7 +3886,7 @@ class AlertingApi {
|
|
|
3650
3886
|
/**
|
|
3651
3887
|
* Alerting service.
|
|
3652
3888
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3653
|
-
* @version
|
|
3889
|
+
* @version 241.1.0
|
|
3654
3890
|
*/
|
|
3655
3891
|
|
|
3656
3892
|
/**
|
|
@@ -4051,7 +4287,7 @@ class AnalyticsApi {
|
|
|
4051
4287
|
/**
|
|
4052
4288
|
* Analytics service.
|
|
4053
4289
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4054
|
-
* @version
|
|
4290
|
+
* @version 241.1.0
|
|
4055
4291
|
*/
|
|
4056
4292
|
|
|
4057
4293
|
/**
|
|
@@ -4144,6 +4380,32 @@ class AnalyticsApi {
|
|
|
4144
4380
|
);
|
|
4145
4381
|
}
|
|
4146
4382
|
|
|
4383
|
+
/**
|
|
4384
|
+
* Delete/cancel an async request for case management aggregates
|
|
4385
|
+
*
|
|
4386
|
+
* @param {String} jobId jobId
|
|
4387
|
+
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4388
|
+
*/
|
|
4389
|
+
deleteAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
4390
|
+
// verify the required parameter 'jobId' is set
|
|
4391
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4392
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCasemanagementAggregatesJob';
|
|
4393
|
+
}
|
|
4394
|
+
|
|
4395
|
+
return this.apiClient.callApi(
|
|
4396
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
|
|
4397
|
+
'DELETE',
|
|
4398
|
+
{ 'jobId': jobId },
|
|
4399
|
+
{ },
|
|
4400
|
+
{ },
|
|
4401
|
+
{ },
|
|
4402
|
+
null,
|
|
4403
|
+
['PureCloud OAuth'],
|
|
4404
|
+
['application/json'],
|
|
4405
|
+
['application/json']
|
|
4406
|
+
);
|
|
4407
|
+
}
|
|
4408
|
+
|
|
4147
4409
|
/**
|
|
4148
4410
|
* Delete/cancel an async request for conversation aggregates
|
|
4149
4411
|
*
|
|
@@ -4803,6 +5065,62 @@ class AnalyticsApi {
|
|
|
4803
5065
|
);
|
|
4804
5066
|
}
|
|
4805
5067
|
|
|
5068
|
+
/**
|
|
5069
|
+
* Get status for async query for case management aggregates
|
|
5070
|
+
*
|
|
5071
|
+
* @param {String} jobId jobId
|
|
5072
|
+
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5073
|
+
*/
|
|
5074
|
+
getAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
5075
|
+
// verify the required parameter 'jobId' is set
|
|
5076
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5077
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJob';
|
|
5078
|
+
}
|
|
5079
|
+
|
|
5080
|
+
return this.apiClient.callApi(
|
|
5081
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
|
|
5082
|
+
'GET',
|
|
5083
|
+
{ 'jobId': jobId },
|
|
5084
|
+
{ },
|
|
5085
|
+
{ },
|
|
5086
|
+
{ },
|
|
5087
|
+
null,
|
|
5088
|
+
['PureCloud OAuth'],
|
|
5089
|
+
['application/json'],
|
|
5090
|
+
['application/json']
|
|
5091
|
+
);
|
|
5092
|
+
}
|
|
5093
|
+
|
|
5094
|
+
/**
|
|
5095
|
+
* Fetch a page of results for an async case management query
|
|
5096
|
+
*
|
|
5097
|
+
* @param {String} jobId jobId
|
|
5098
|
+
* @param {Object} opts Optional parameters
|
|
5099
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5100
|
+
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5101
|
+
*/
|
|
5102
|
+
getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
|
|
5103
|
+
opts = opts || {};
|
|
5104
|
+
|
|
5105
|
+
// verify the required parameter 'jobId' is set
|
|
5106
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5107
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJobResults';
|
|
5108
|
+
}
|
|
5109
|
+
|
|
5110
|
+
return this.apiClient.callApi(
|
|
5111
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results',
|
|
5112
|
+
'GET',
|
|
5113
|
+
{ 'jobId': jobId },
|
|
5114
|
+
{ 'cursor': opts['cursor'] },
|
|
5115
|
+
{ },
|
|
5116
|
+
{ },
|
|
5117
|
+
null,
|
|
5118
|
+
['PureCloud OAuth'],
|
|
5119
|
+
['application/json'],
|
|
5120
|
+
['application/json']
|
|
5121
|
+
);
|
|
5122
|
+
}
|
|
5123
|
+
|
|
4806
5124
|
/**
|
|
4807
5125
|
* Get a conversation by id
|
|
4808
5126
|
*
|
|
@@ -6170,6 +6488,58 @@ class AnalyticsApi {
|
|
|
6170
6488
|
);
|
|
6171
6489
|
}
|
|
6172
6490
|
|
|
6491
|
+
/**
|
|
6492
|
+
* Query for case management aggregates asynchronously
|
|
6493
|
+
*
|
|
6494
|
+
* @param {Object} body query
|
|
6495
|
+
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6496
|
+
*/
|
|
6497
|
+
postAnalyticsCasemanagementAggregatesJobs(body) {
|
|
6498
|
+
// verify the required parameter 'body' is set
|
|
6499
|
+
if (body === undefined || body === null) {
|
|
6500
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesJobs';
|
|
6501
|
+
}
|
|
6502
|
+
|
|
6503
|
+
return this.apiClient.callApi(
|
|
6504
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs',
|
|
6505
|
+
'POST',
|
|
6506
|
+
{ },
|
|
6507
|
+
{ },
|
|
6508
|
+
{ },
|
|
6509
|
+
{ },
|
|
6510
|
+
body,
|
|
6511
|
+
['PureCloud OAuth'],
|
|
6512
|
+
['application/json'],
|
|
6513
|
+
['application/json']
|
|
6514
|
+
);
|
|
6515
|
+
}
|
|
6516
|
+
|
|
6517
|
+
/**
|
|
6518
|
+
* Query for case management aggregates
|
|
6519
|
+
*
|
|
6520
|
+
* @param {Object} body query
|
|
6521
|
+
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6522
|
+
*/
|
|
6523
|
+
postAnalyticsCasemanagementAggregatesQuery(body) {
|
|
6524
|
+
// verify the required parameter 'body' is set
|
|
6525
|
+
if (body === undefined || body === null) {
|
|
6526
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesQuery';
|
|
6527
|
+
}
|
|
6528
|
+
|
|
6529
|
+
return this.apiClient.callApi(
|
|
6530
|
+
'/api/v2/analytics/casemanagement/aggregates/query',
|
|
6531
|
+
'POST',
|
|
6532
|
+
{ },
|
|
6533
|
+
{ },
|
|
6534
|
+
{ },
|
|
6535
|
+
{ },
|
|
6536
|
+
body,
|
|
6537
|
+
['PureCloud OAuth'],
|
|
6538
|
+
['application/json'],
|
|
6539
|
+
['application/json']
|
|
6540
|
+
);
|
|
6541
|
+
}
|
|
6542
|
+
|
|
6173
6543
|
/**
|
|
6174
6544
|
* Index conversation properties
|
|
6175
6545
|
*
|
|
@@ -7319,7 +7689,7 @@ class ArchitectApi {
|
|
|
7319
7689
|
/**
|
|
7320
7690
|
* Architect service.
|
|
7321
7691
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7322
|
-
* @version
|
|
7692
|
+
* @version 241.1.0
|
|
7323
7693
|
*/
|
|
7324
7694
|
|
|
7325
7695
|
/**
|
|
@@ -11614,7 +11984,7 @@ class AuditApi {
|
|
|
11614
11984
|
/**
|
|
11615
11985
|
* Audit service.
|
|
11616
11986
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11617
|
-
* @version
|
|
11987
|
+
* @version 241.1.0
|
|
11618
11988
|
*/
|
|
11619
11989
|
|
|
11620
11990
|
/**
|
|
@@ -11815,7 +12185,7 @@ class AuthorizationApi {
|
|
|
11815
12185
|
/**
|
|
11816
12186
|
* Authorization service.
|
|
11817
12187
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11818
|
-
* @version
|
|
12188
|
+
* @version 241.1.0
|
|
11819
12189
|
*/
|
|
11820
12190
|
|
|
11821
12191
|
/**
|
|
@@ -11864,7 +12234,6 @@ class AuthorizationApi {
|
|
|
11864
12234
|
*
|
|
11865
12235
|
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
11866
12236
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
11867
|
-
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11868
12237
|
*/
|
|
11869
12238
|
deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
11870
12239
|
// verify the required parameter 'targetName' is set
|
|
@@ -12263,7 +12632,6 @@ class AuthorizationApi {
|
|
|
12263
12632
|
* @param {Object} opts Optional parameters
|
|
12264
12633
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12265
12634
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
12266
|
-
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12267
12635
|
*/
|
|
12268
12636
|
getAuthorizationPolicies(opts) {
|
|
12269
12637
|
opts = opts || {};
|
|
@@ -12290,7 +12658,6 @@ class AuthorizationApi {
|
|
|
12290
12658
|
* @param {Object} opts Optional parameters
|
|
12291
12659
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12292
12660
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
12293
|
-
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12294
12661
|
*/
|
|
12295
12662
|
getAuthorizationPoliciesSubjectSubjectId(subjectId, opts) {
|
|
12296
12663
|
opts = opts || {};
|
|
@@ -12321,7 +12688,6 @@ class AuthorizationApi {
|
|
|
12321
12688
|
* @param {Object} opts Optional parameters
|
|
12322
12689
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12323
12690
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
12324
|
-
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12325
12691
|
*/
|
|
12326
12692
|
getAuthorizationPoliciesTarget(targetName, opts) {
|
|
12327
12693
|
opts = opts || {};
|
|
@@ -12350,7 +12716,6 @@ class AuthorizationApi {
|
|
|
12350
12716
|
*
|
|
12351
12717
|
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
12352
12718
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
12353
|
-
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12354
12719
|
*/
|
|
12355
12720
|
getAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
12356
12721
|
// verify the required parameter 'targetName' is set
|
|
@@ -12379,7 +12744,6 @@ class AuthorizationApi {
|
|
|
12379
12744
|
/**
|
|
12380
12745
|
* Get a map of policy targets to valid attributes for those targets
|
|
12381
12746
|
*
|
|
12382
|
-
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12383
12747
|
*/
|
|
12384
12748
|
getAuthorizationPoliciesTargets() {
|
|
12385
12749
|
|
|
@@ -12401,7 +12765,6 @@ class AuthorizationApi {
|
|
|
12401
12765
|
* Get an access control policy with the specified policy ID
|
|
12402
12766
|
*
|
|
12403
12767
|
* @param {String} policyId The ID of the policy to retrieve
|
|
12404
|
-
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12405
12768
|
*/
|
|
12406
12769
|
getAuthorizationPolicy(policyId) {
|
|
12407
12770
|
// verify the required parameter 'policyId' is set
|
|
@@ -12427,7 +12790,6 @@ class AuthorizationApi {
|
|
|
12427
12790
|
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
12428
12791
|
*
|
|
12429
12792
|
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
12430
|
-
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12431
12793
|
*/
|
|
12432
12794
|
getAuthorizationPolicyAttributes(policyId) {
|
|
12433
12795
|
// verify the required parameter 'policyId' is set
|
|
@@ -12919,7 +13281,6 @@ class AuthorizationApi {
|
|
|
12919
13281
|
*
|
|
12920
13282
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
12921
13283
|
* @param {Object} body Access control policy
|
|
12922
|
-
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12923
13284
|
*/
|
|
12924
13285
|
postAuthorizationPoliciesTarget(targetName, body) {
|
|
12925
13286
|
// verify the required parameter 'targetName' is set
|
|
@@ -12950,7 +13311,6 @@ class AuthorizationApi {
|
|
|
12950
13311
|
*
|
|
12951
13312
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
12952
13313
|
* @param {Object} body Access control policy
|
|
12953
|
-
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12954
13314
|
*/
|
|
12955
13315
|
postAuthorizationPoliciesTargetValidate(targetName, body) {
|
|
12956
13316
|
// verify the required parameter 'targetName' is set
|
|
@@ -12981,7 +13341,6 @@ class AuthorizationApi {
|
|
|
12981
13341
|
*
|
|
12982
13342
|
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
12983
13343
|
* @param {Object} body A map of attribute names to type and simulated data value
|
|
12984
|
-
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12985
13344
|
*/
|
|
12986
13345
|
postAuthorizationPolicySimulate(policyId, body) {
|
|
12987
13346
|
// verify the required parameter 'policyId' is set
|
|
@@ -13297,7 +13656,6 @@ class AuthorizationApi {
|
|
|
13297
13656
|
*
|
|
13298
13657
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
13299
13658
|
* @param {Object} body Access control policy
|
|
13300
|
-
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13301
13659
|
*/
|
|
13302
13660
|
putAuthorizationPoliciesTarget(targetName, body) {
|
|
13303
13661
|
// verify the required parameter 'targetName' is set
|
|
@@ -13328,7 +13686,6 @@ class AuthorizationApi {
|
|
|
13328
13686
|
*
|
|
13329
13687
|
* @param {String} policyId The ID of the policy to update
|
|
13330
13688
|
* @param {Object} body Access control policy
|
|
13331
|
-
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13332
13689
|
*/
|
|
13333
13690
|
putAuthorizationPolicy(policyId, body) {
|
|
13334
13691
|
// verify the required parameter 'policyId' is set
|
|
@@ -13530,7 +13887,7 @@ class BillingApi {
|
|
|
13530
13887
|
/**
|
|
13531
13888
|
* Billing service.
|
|
13532
13889
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13533
|
-
* @version
|
|
13890
|
+
* @version 241.1.0
|
|
13534
13891
|
*/
|
|
13535
13892
|
|
|
13536
13893
|
/**
|
|
@@ -13786,7 +14143,7 @@ class BusinessRulesApi {
|
|
|
13786
14143
|
/**
|
|
13787
14144
|
* BusinessRules service.
|
|
13788
14145
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13789
|
-
* @version
|
|
14146
|
+
* @version 241.1.0
|
|
13790
14147
|
*/
|
|
13791
14148
|
|
|
13792
14149
|
/**
|
|
@@ -14673,7 +15030,7 @@ class CarrierServicesApi {
|
|
|
14673
15030
|
/**
|
|
14674
15031
|
* CarrierServices service.
|
|
14675
15032
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14676
|
-
* @version
|
|
15033
|
+
* @version 241.1.0
|
|
14677
15034
|
*/
|
|
14678
15035
|
|
|
14679
15036
|
/**
|
|
@@ -14743,7 +15100,7 @@ class ChatApi {
|
|
|
14743
15100
|
/**
|
|
14744
15101
|
* Chat service.
|
|
14745
15102
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14746
|
-
* @version
|
|
15103
|
+
* @version 241.1.0
|
|
14747
15104
|
*/
|
|
14748
15105
|
|
|
14749
15106
|
/**
|
|
@@ -15724,7 +16081,7 @@ class CoachingApi {
|
|
|
15724
16081
|
/**
|
|
15725
16082
|
* Coaching service.
|
|
15726
16083
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15727
|
-
* @version
|
|
16084
|
+
* @version 241.1.0
|
|
15728
16085
|
*/
|
|
15729
16086
|
|
|
15730
16087
|
/**
|
|
@@ -16351,7 +16708,7 @@ class ContentManagementApi {
|
|
|
16351
16708
|
/**
|
|
16352
16709
|
* ContentManagement service.
|
|
16353
16710
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16354
|
-
* @version
|
|
16711
|
+
* @version 241.1.0
|
|
16355
16712
|
*/
|
|
16356
16713
|
|
|
16357
16714
|
/**
|
|
@@ -17432,7 +17789,7 @@ class ConversationsApi {
|
|
|
17432
17789
|
/**
|
|
17433
17790
|
* Conversations service.
|
|
17434
17791
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17435
|
-
* @version
|
|
17792
|
+
* @version 241.1.0
|
|
17436
17793
|
*/
|
|
17437
17794
|
|
|
17438
17795
|
/**
|
|
@@ -18098,6 +18455,111 @@ class ConversationsApi {
|
|
|
18098
18455
|
);
|
|
18099
18456
|
}
|
|
18100
18457
|
|
|
18458
|
+
/**
|
|
18459
|
+
* Get checklist info for a single checklist.
|
|
18460
|
+
*
|
|
18461
|
+
* @param {String} conversationId Conversation ID
|
|
18462
|
+
* @param {String} communicationId Communication ID
|
|
18463
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
18464
|
+
*/
|
|
18465
|
+
getConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId) {
|
|
18466
|
+
// verify the required parameter 'conversationId' is set
|
|
18467
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
18468
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklist';
|
|
18469
|
+
}
|
|
18470
|
+
// verify the required parameter 'communicationId' is set
|
|
18471
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
18472
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklist';
|
|
18473
|
+
}
|
|
18474
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
18475
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
18476
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklist';
|
|
18477
|
+
}
|
|
18478
|
+
|
|
18479
|
+
return this.apiClient.callApi(
|
|
18480
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
|
|
18481
|
+
'GET',
|
|
18482
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
18483
|
+
{ },
|
|
18484
|
+
{ },
|
|
18485
|
+
{ },
|
|
18486
|
+
null,
|
|
18487
|
+
['PureCloud OAuth'],
|
|
18488
|
+
['application/json'],
|
|
18489
|
+
['application/json']
|
|
18490
|
+
);
|
|
18491
|
+
}
|
|
18492
|
+
|
|
18493
|
+
/**
|
|
18494
|
+
* Get inference job status
|
|
18495
|
+
*
|
|
18496
|
+
* @param {String} conversationId Conversation ID
|
|
18497
|
+
* @param {String} communicationId Communication ID
|
|
18498
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
18499
|
+
* @param {String} jobId Inference Job ID
|
|
18500
|
+
*/
|
|
18501
|
+
getConversationCommunicationAgentchecklistJob(conversationId, communicationId, agentChecklistId, jobId) {
|
|
18502
|
+
// verify the required parameter 'conversationId' is set
|
|
18503
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
18504
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18505
|
+
}
|
|
18506
|
+
// verify the required parameter 'communicationId' is set
|
|
18507
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
18508
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18509
|
+
}
|
|
18510
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
18511
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
18512
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18513
|
+
}
|
|
18514
|
+
// verify the required parameter 'jobId' is set
|
|
18515
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
18516
|
+
throw 'Missing the required parameter "jobId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18517
|
+
}
|
|
18518
|
+
|
|
18519
|
+
return this.apiClient.callApi(
|
|
18520
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId}',
|
|
18521
|
+
'GET',
|
|
18522
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId,'jobId': jobId },
|
|
18523
|
+
{ },
|
|
18524
|
+
{ },
|
|
18525
|
+
{ },
|
|
18526
|
+
null,
|
|
18527
|
+
['PureCloud OAuth'],
|
|
18528
|
+
['application/json'],
|
|
18529
|
+
['application/json']
|
|
18530
|
+
);
|
|
18531
|
+
}
|
|
18532
|
+
|
|
18533
|
+
/**
|
|
18534
|
+
* Get information of all checklists associated with a conversation.
|
|
18535
|
+
*
|
|
18536
|
+
* @param {String} conversationId Conversation ID
|
|
18537
|
+
* @param {String} communicationId Communication ID
|
|
18538
|
+
*/
|
|
18539
|
+
getConversationCommunicationAgentchecklists(conversationId, communicationId) {
|
|
18540
|
+
// verify the required parameter 'conversationId' is set
|
|
18541
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
18542
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklists';
|
|
18543
|
+
}
|
|
18544
|
+
// verify the required parameter 'communicationId' is set
|
|
18545
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
18546
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklists';
|
|
18547
|
+
}
|
|
18548
|
+
|
|
18549
|
+
return this.apiClient.callApi(
|
|
18550
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists',
|
|
18551
|
+
'GET',
|
|
18552
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
18553
|
+
{ },
|
|
18554
|
+
{ },
|
|
18555
|
+
{ },
|
|
18556
|
+
null,
|
|
18557
|
+
['PureCloud OAuth'],
|
|
18558
|
+
['application/json'],
|
|
18559
|
+
['application/json']
|
|
18560
|
+
);
|
|
18561
|
+
}
|
|
18562
|
+
|
|
18101
18563
|
/**
|
|
18102
18564
|
* Get message
|
|
18103
18565
|
*
|
|
@@ -22653,6 +23115,161 @@ class ConversationsApi {
|
|
|
22653
23115
|
);
|
|
22654
23116
|
}
|
|
22655
23117
|
|
|
23118
|
+
/**
|
|
23119
|
+
* Agent Checklist activation API
|
|
23120
|
+
*
|
|
23121
|
+
* @param {String} conversationId Conversation ID
|
|
23122
|
+
* @param {String} communicationId Communication ID
|
|
23123
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
23124
|
+
* @param {Object} body Agent checklist activation payload
|
|
23125
|
+
*/
|
|
23126
|
+
postConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId, body) {
|
|
23127
|
+
// verify the required parameter 'conversationId' is set
|
|
23128
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23129
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklist';
|
|
23130
|
+
}
|
|
23131
|
+
// verify the required parameter 'communicationId' is set
|
|
23132
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23133
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklist';
|
|
23134
|
+
}
|
|
23135
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
23136
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
23137
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklist';
|
|
23138
|
+
}
|
|
23139
|
+
// verify the required parameter 'body' is set
|
|
23140
|
+
if (body === undefined || body === null) {
|
|
23141
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklist';
|
|
23142
|
+
}
|
|
23143
|
+
|
|
23144
|
+
return this.apiClient.callApi(
|
|
23145
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
|
|
23146
|
+
'POST',
|
|
23147
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
23148
|
+
{ },
|
|
23149
|
+
{ },
|
|
23150
|
+
{ },
|
|
23151
|
+
body,
|
|
23152
|
+
['PureCloud OAuth'],
|
|
23153
|
+
['application/json'],
|
|
23154
|
+
['application/json']
|
|
23155
|
+
);
|
|
23156
|
+
}
|
|
23157
|
+
|
|
23158
|
+
/**
|
|
23159
|
+
* API invoked to capture an agent action.
|
|
23160
|
+
*
|
|
23161
|
+
* @param {String} conversationId Conversation ID
|
|
23162
|
+
* @param {String} communicationId Communication ID
|
|
23163
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
23164
|
+
* @param {Object} body Agent action payload
|
|
23165
|
+
*/
|
|
23166
|
+
postConversationCommunicationAgentchecklistAgentaction(conversationId, communicationId, agentChecklistId, body) {
|
|
23167
|
+
// verify the required parameter 'conversationId' is set
|
|
23168
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23169
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23170
|
+
}
|
|
23171
|
+
// verify the required parameter 'communicationId' is set
|
|
23172
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23173
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23174
|
+
}
|
|
23175
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
23176
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
23177
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23178
|
+
}
|
|
23179
|
+
// verify the required parameter 'body' is set
|
|
23180
|
+
if (body === undefined || body === null) {
|
|
23181
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23182
|
+
}
|
|
23183
|
+
|
|
23184
|
+
return this.apiClient.callApi(
|
|
23185
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction',
|
|
23186
|
+
'POST',
|
|
23187
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
23188
|
+
{ },
|
|
23189
|
+
{ },
|
|
23190
|
+
{ },
|
|
23191
|
+
body,
|
|
23192
|
+
['PureCloud OAuth'],
|
|
23193
|
+
['application/json'],
|
|
23194
|
+
['application/json']
|
|
23195
|
+
);
|
|
23196
|
+
}
|
|
23197
|
+
|
|
23198
|
+
/**
|
|
23199
|
+
* Create inference job
|
|
23200
|
+
*
|
|
23201
|
+
* @param {String} conversationId Conversation ID
|
|
23202
|
+
* @param {String} communicationId Communication ID
|
|
23203
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
23204
|
+
* @param {Object} body Agent checklist inference job payload
|
|
23205
|
+
*/
|
|
23206
|
+
postConversationCommunicationAgentchecklistJobs(conversationId, communicationId, agentChecklistId, body) {
|
|
23207
|
+
// verify the required parameter 'conversationId' is set
|
|
23208
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23209
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23210
|
+
}
|
|
23211
|
+
// verify the required parameter 'communicationId' is set
|
|
23212
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23213
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23214
|
+
}
|
|
23215
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
23216
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
23217
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23218
|
+
}
|
|
23219
|
+
// verify the required parameter 'body' is set
|
|
23220
|
+
if (body === undefined || body === null) {
|
|
23221
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23222
|
+
}
|
|
23223
|
+
|
|
23224
|
+
return this.apiClient.callApi(
|
|
23225
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs',
|
|
23226
|
+
'POST',
|
|
23227
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
23228
|
+
{ },
|
|
23229
|
+
{ },
|
|
23230
|
+
{ },
|
|
23231
|
+
body,
|
|
23232
|
+
['PureCloud OAuth'],
|
|
23233
|
+
['application/json'],
|
|
23234
|
+
['application/json']
|
|
23235
|
+
);
|
|
23236
|
+
}
|
|
23237
|
+
|
|
23238
|
+
/**
|
|
23239
|
+
* API invoked to finalize agent checklist evaluation.
|
|
23240
|
+
*
|
|
23241
|
+
* @param {String} conversationId Conversation ID
|
|
23242
|
+
* @param {String} communicationId Communication ID
|
|
23243
|
+
* @param {Object} body Agent checklist finalize payload
|
|
23244
|
+
*/
|
|
23245
|
+
postConversationCommunicationAgentchecklistsFinalize(conversationId, communicationId, body) {
|
|
23246
|
+
// verify the required parameter 'conversationId' is set
|
|
23247
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23248
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
23249
|
+
}
|
|
23250
|
+
// verify the required parameter 'communicationId' is set
|
|
23251
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23252
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
23253
|
+
}
|
|
23254
|
+
// verify the required parameter 'body' is set
|
|
23255
|
+
if (body === undefined || body === null) {
|
|
23256
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
23257
|
+
}
|
|
23258
|
+
|
|
23259
|
+
return this.apiClient.callApi(
|
|
23260
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize',
|
|
23261
|
+
'POST',
|
|
23262
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
23263
|
+
{ },
|
|
23264
|
+
{ },
|
|
23265
|
+
{ },
|
|
23266
|
+
body,
|
|
23267
|
+
['PureCloud OAuth'],
|
|
23268
|
+
['application/json'],
|
|
23269
|
+
['application/json']
|
|
23270
|
+
);
|
|
23271
|
+
}
|
|
23272
|
+
|
|
22656
23273
|
/**
|
|
22657
23274
|
* Send internal message
|
|
22658
23275
|
* Send a new internal message for an existing communication.
|
|
@@ -22817,11 +23434,12 @@ class ConversationsApi {
|
|
|
22817
23434
|
}
|
|
22818
23435
|
|
|
22819
23436
|
/**
|
|
22820
|
-
* Replace this participant
|
|
22821
|
-
*
|
|
23437
|
+
* Replace this participant (Deprecated)
|
|
23438
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
|
|
22822
23439
|
* @param {String} conversationId conversation ID
|
|
22823
23440
|
* @param {String} participantId participant ID
|
|
22824
23441
|
* @param {Object} body Transfer request
|
|
23442
|
+
* @deprecated
|
|
22825
23443
|
*/
|
|
22826
23444
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
22827
23445
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22892,7 +23510,6 @@ class ConversationsApi {
|
|
|
22892
23510
|
* @param {String} conversationId conversation ID
|
|
22893
23511
|
* @param {String} participantId participant ID
|
|
22894
23512
|
* @param {Object} body Transfer request
|
|
22895
|
-
* postConversationParticipantReplaceContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22896
23513
|
*/
|
|
22897
23514
|
postConversationParticipantReplaceContactExternal(conversationId, participantId, body) {
|
|
22898
23515
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22923,11 +23540,12 @@ class ConversationsApi {
|
|
|
22923
23540
|
}
|
|
22924
23541
|
|
|
22925
23542
|
/**
|
|
22926
|
-
* Replace this participant with the an external contact
|
|
22927
|
-
*
|
|
23543
|
+
* Replace this participant with the an external contact (Deprecated)
|
|
23544
|
+
* This endpoint is deprecated. Use /replace/contact/external endpoint instead.
|
|
22928
23545
|
* @param {String} conversationId conversation ID
|
|
22929
23546
|
* @param {String} participantId participant ID
|
|
22930
23547
|
* @param {Object} body Transfer request
|
|
23548
|
+
* @deprecated
|
|
22931
23549
|
*/
|
|
22932
23550
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
22933
23551
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23032,7 +23650,6 @@ class ConversationsApi {
|
|
|
23032
23650
|
* @param {String} conversationId conversation ID
|
|
23033
23651
|
* @param {String} participantId participant ID
|
|
23034
23652
|
* @param {Object} body Transfer request
|
|
23035
|
-
* postConversationParticipantTransfer is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23036
23653
|
*/
|
|
23037
23654
|
postConversationParticipantTransfer(conversationId, participantId, body) {
|
|
23038
23655
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23292,11 +23909,12 @@ class ConversationsApi {
|
|
|
23292
23909
|
}
|
|
23293
23910
|
|
|
23294
23911
|
/**
|
|
23295
|
-
* Initiate and update consult transfer
|
|
23296
|
-
*
|
|
23912
|
+
* Initiate and update consult transfer (Deprecated)
|
|
23913
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
|
|
23297
23914
|
* @param {String} conversationId conversationId
|
|
23298
23915
|
* @param {String} participantId participantId
|
|
23299
23916
|
* @param {Object} body Destination address and initial speak to
|
|
23917
|
+
* @deprecated
|
|
23300
23918
|
*/
|
|
23301
23919
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
23302
23920
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23367,7 +23985,6 @@ class ConversationsApi {
|
|
|
23367
23985
|
* @param {String} conversationId conversationId
|
|
23368
23986
|
* @param {String} participantId participantId
|
|
23369
23987
|
* @param {Object} body Destination address and initial speak to
|
|
23370
|
-
* postConversationsCallParticipantConsultContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23371
23988
|
*/
|
|
23372
23989
|
postConversationsCallParticipantConsultContactExternal(conversationId, participantId, body) {
|
|
23373
23990
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23398,11 +24015,12 @@ class ConversationsApi {
|
|
|
23398
24015
|
}
|
|
23399
24016
|
|
|
23400
24017
|
/**
|
|
23401
|
-
* Initiate a consult transfer to an external contact
|
|
23402
|
-
*
|
|
24018
|
+
* Initiate a consult transfer to an external contact (Deprecated)
|
|
24019
|
+
* This endpoint is deprecated. Use /consult/contact/external endpoints instead.
|
|
23403
24020
|
* @param {String} conversationId conversationId
|
|
23404
24021
|
* @param {String} participantId participantId
|
|
23405
24022
|
* @param {Object} body Destination address and initial speak to
|
|
24023
|
+
* @deprecated
|
|
23406
24024
|
*/
|
|
23407
24025
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
23408
24026
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23538,7 +24156,6 @@ class ConversationsApi {
|
|
|
23538
24156
|
* @param {String} conversationId conversationId
|
|
23539
24157
|
* @param {String} participantId participantId
|
|
23540
24158
|
* @param {Object} body Destination address and initial speak to
|
|
23541
|
-
* postConversationsCallParticipantVoiceConsult is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23542
24159
|
*/
|
|
23543
24160
|
postConversationsCallParticipantVoiceConsult(conversationId, participantId, body) {
|
|
23544
24161
|
// verify the required parameter 'conversationId' is set
|
|
@@ -26057,7 +26674,7 @@ class DataExtensionsApi {
|
|
|
26057
26674
|
/**
|
|
26058
26675
|
* DataExtensions service.
|
|
26059
26676
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
26060
|
-
* @version
|
|
26677
|
+
* @version 241.1.0
|
|
26061
26678
|
*/
|
|
26062
26679
|
|
|
26063
26680
|
/**
|
|
@@ -26143,7 +26760,7 @@ class DataPrivacyApi {
|
|
|
26143
26760
|
/**
|
|
26144
26761
|
* DataPrivacy service.
|
|
26145
26762
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26146
|
-
* @version
|
|
26763
|
+
* @version 241.1.0
|
|
26147
26764
|
*/
|
|
26148
26765
|
|
|
26149
26766
|
/**
|
|
@@ -26313,7 +26930,7 @@ class DownloadsApi {
|
|
|
26313
26930
|
/**
|
|
26314
26931
|
* Downloads service.
|
|
26315
26932
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26316
|
-
* @version
|
|
26933
|
+
* @version 241.1.0
|
|
26317
26934
|
*/
|
|
26318
26935
|
|
|
26319
26936
|
/**
|
|
@@ -26365,7 +26982,7 @@ class EmailsApi {
|
|
|
26365
26982
|
/**
|
|
26366
26983
|
* Emails service.
|
|
26367
26984
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26368
|
-
* @version
|
|
26985
|
+
* @version 241.1.0
|
|
26369
26986
|
*/
|
|
26370
26987
|
|
|
26371
26988
|
/**
|
|
@@ -26494,7 +27111,7 @@ class EmployeeEngagementApi {
|
|
|
26494
27111
|
/**
|
|
26495
27112
|
* EmployeeEngagement service.
|
|
26496
27113
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26497
|
-
* @version
|
|
27114
|
+
* @version 241.1.0
|
|
26498
27115
|
*/
|
|
26499
27116
|
|
|
26500
27117
|
/**
|
|
@@ -26674,7 +27291,7 @@ class EventsApi {
|
|
|
26674
27291
|
/**
|
|
26675
27292
|
* Events service.
|
|
26676
27293
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26677
|
-
* @version
|
|
27294
|
+
* @version 241.1.0
|
|
26678
27295
|
*/
|
|
26679
27296
|
|
|
26680
27297
|
/**
|
|
@@ -26770,7 +27387,7 @@ class ExternalContactsApi {
|
|
|
26770
27387
|
/**
|
|
26771
27388
|
* ExternalContacts service.
|
|
26772
27389
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26773
|
-
* @version
|
|
27390
|
+
* @version 241.1.0
|
|
26774
27391
|
*/
|
|
26775
27392
|
|
|
26776
27393
|
/**
|
|
@@ -30017,7 +30634,7 @@ class FaxApi {
|
|
|
30017
30634
|
/**
|
|
30018
30635
|
* Fax service.
|
|
30019
30636
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
30020
|
-
* @version
|
|
30637
|
+
* @version 241.1.0
|
|
30021
30638
|
*/
|
|
30022
30639
|
|
|
30023
30640
|
/**
|
|
@@ -30232,7 +30849,7 @@ class FlowsApi {
|
|
|
30232
30849
|
/**
|
|
30233
30850
|
* Flows service.
|
|
30234
30851
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30235
|
-
* @version
|
|
30852
|
+
* @version 241.1.0
|
|
30236
30853
|
*/
|
|
30237
30854
|
|
|
30238
30855
|
/**
|
|
@@ -30441,7 +31058,7 @@ class GamificationApi {
|
|
|
30441
31058
|
/**
|
|
30442
31059
|
* Gamification service.
|
|
30443
31060
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30444
|
-
* @version
|
|
31061
|
+
* @version 241.1.0
|
|
30445
31062
|
*/
|
|
30446
31063
|
|
|
30447
31064
|
/**
|
|
@@ -32999,7 +33616,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
32999
33616
|
/**
|
|
33000
33617
|
* GeneralDataProtectionRegulation service.
|
|
33001
33618
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
33002
|
-
* @version
|
|
33619
|
+
* @version 241.1.0
|
|
33003
33620
|
*/
|
|
33004
33621
|
|
|
33005
33622
|
/**
|
|
@@ -33129,7 +33746,7 @@ class GeolocationApi {
|
|
|
33129
33746
|
/**
|
|
33130
33747
|
* Geolocation service.
|
|
33131
33748
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
33132
|
-
* @version
|
|
33749
|
+
* @version 241.1.0
|
|
33133
33750
|
*/
|
|
33134
33751
|
|
|
33135
33752
|
/**
|
|
@@ -33260,7 +33877,7 @@ class GreetingsApi {
|
|
|
33260
33877
|
/**
|
|
33261
33878
|
* Greetings service.
|
|
33262
33879
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33263
|
-
* @version
|
|
33880
|
+
* @version 241.1.0
|
|
33264
33881
|
*/
|
|
33265
33882
|
|
|
33266
33883
|
/**
|
|
@@ -33802,7 +34419,7 @@ class GroupsApi {
|
|
|
33802
34419
|
/**
|
|
33803
34420
|
* Groups service.
|
|
33804
34421
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33805
|
-
* @version
|
|
34422
|
+
* @version 241.1.0
|
|
33806
34423
|
*/
|
|
33807
34424
|
|
|
33808
34425
|
/**
|
|
@@ -34321,7 +34938,7 @@ class IdentityProviderApi {
|
|
|
34321
34938
|
/**
|
|
34322
34939
|
* IdentityProvider service.
|
|
34323
34940
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34324
|
-
* @version
|
|
34941
|
+
* @version 241.1.0
|
|
34325
34942
|
*/
|
|
34326
34943
|
|
|
34327
34944
|
/**
|
|
@@ -35182,7 +35799,7 @@ class InfrastructureAsCodeApi {
|
|
|
35182
35799
|
/**
|
|
35183
35800
|
* InfrastructureAsCode service.
|
|
35184
35801
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
35185
|
-
* @version
|
|
35802
|
+
* @version 241.1.0
|
|
35186
35803
|
*/
|
|
35187
35804
|
|
|
35188
35805
|
/**
|
|
@@ -35349,7 +35966,7 @@ class IntegrationsApi {
|
|
|
35349
35966
|
/**
|
|
35350
35967
|
* Integrations service.
|
|
35351
35968
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35352
|
-
* @version
|
|
35969
|
+
* @version 241.1.0
|
|
35353
35970
|
*/
|
|
35354
35971
|
|
|
35355
35972
|
/**
|
|
@@ -37997,7 +38614,7 @@ class JourneyApi {
|
|
|
37997
38614
|
/**
|
|
37998
38615
|
* Journey service.
|
|
37999
38616
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
38000
|
-
* @version
|
|
38617
|
+
* @version 241.1.0
|
|
38001
38618
|
*/
|
|
38002
38619
|
|
|
38003
38620
|
/**
|
|
@@ -38370,7 +38987,7 @@ class JourneyApi {
|
|
|
38370
38987
|
* @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
|
|
38371
38988
|
* @param {Array.<String>} opts.actionMapIds IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
|
|
38372
38989
|
* @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
|
|
38373
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
38990
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38374
38991
|
*/
|
|
38375
38992
|
getJourneyActionmaps(opts) {
|
|
38376
38993
|
opts = opts || {};
|
|
@@ -38525,7 +39142,7 @@ class JourneyApi {
|
|
|
38525
39142
|
* @param {Object} opts.mediaType Media type
|
|
38526
39143
|
* @param {Object} opts.state Action template state.
|
|
38527
39144
|
* @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
|
|
38528
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
39145
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38529
39146
|
*/
|
|
38530
39147
|
getJourneyActiontemplates(opts) {
|
|
38531
39148
|
opts = opts || {};
|
|
@@ -38617,7 +39234,7 @@ class JourneyApi {
|
|
|
38617
39234
|
* @param {String} opts.sortBy Field(s) to sort by. The response can be sorted by any first level property on the Outcome response. Prefix with '-' for descending (e.g. sortBy=displayName,-createdDate).
|
|
38618
39235
|
* @param {Array.<String>} opts.outcomeIds IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
|
|
38619
39236
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
38620
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
39237
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38621
39238
|
*/
|
|
38622
39239
|
getJourneyOutcomes(opts) {
|
|
38623
39240
|
opts = opts || {};
|
|
@@ -38769,7 +39386,7 @@ class JourneyApi {
|
|
|
38769
39386
|
* @param {Boolean} opts.isActive Determines whether or not to show only active segments.
|
|
38770
39387
|
* @param {Array.<String>} opts.segmentIds IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
|
|
38771
39388
|
* @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
|
|
38772
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
39389
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38773
39390
|
*/
|
|
38774
39391
|
getJourneySegments(opts) {
|
|
38775
39392
|
opts = opts || {};
|
|
@@ -40094,7 +40711,7 @@ class KnowledgeApi {
|
|
|
40094
40711
|
/**
|
|
40095
40712
|
* Knowledge service.
|
|
40096
40713
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
40097
|
-
* @version
|
|
40714
|
+
* @version 241.1.0
|
|
40098
40715
|
*/
|
|
40099
40716
|
|
|
40100
40717
|
/**
|
|
@@ -43177,7 +43794,7 @@ class LanguageUnderstandingApi {
|
|
|
43177
43794
|
/**
|
|
43178
43795
|
* LanguageUnderstanding service.
|
|
43179
43796
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43180
|
-
* @version
|
|
43797
|
+
* @version 241.1.0
|
|
43181
43798
|
*/
|
|
43182
43799
|
|
|
43183
43800
|
/**
|
|
@@ -44396,7 +45013,7 @@ class LanguagesApi {
|
|
|
44396
45013
|
/**
|
|
44397
45014
|
* Languages service.
|
|
44398
45015
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44399
|
-
* @version
|
|
45016
|
+
* @version 241.1.0
|
|
44400
45017
|
*/
|
|
44401
45018
|
|
|
44402
45019
|
/**
|
|
@@ -44618,7 +45235,7 @@ class LearningApi {
|
|
|
44618
45235
|
/**
|
|
44619
45236
|
* Learning service.
|
|
44620
45237
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44621
|
-
* @version
|
|
45238
|
+
* @version 241.1.0
|
|
44622
45239
|
*/
|
|
44623
45240
|
|
|
44624
45241
|
/**
|
|
@@ -45727,7 +46344,7 @@ class LicenseApi {
|
|
|
45727
46344
|
/**
|
|
45728
46345
|
* License service.
|
|
45729
46346
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45730
|
-
* @version
|
|
46347
|
+
* @version 241.1.0
|
|
45731
46348
|
*/
|
|
45732
46349
|
|
|
45733
46350
|
/**
|
|
@@ -45965,7 +46582,7 @@ class LocationsApi {
|
|
|
45965
46582
|
/**
|
|
45966
46583
|
* Locations service.
|
|
45967
46584
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45968
|
-
* @version
|
|
46585
|
+
* @version 241.1.0
|
|
45969
46586
|
*/
|
|
45970
46587
|
|
|
45971
46588
|
/**
|
|
@@ -46201,7 +46818,7 @@ class LogCaptureApi {
|
|
|
46201
46818
|
/**
|
|
46202
46819
|
* LogCapture service.
|
|
46203
46820
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
46204
|
-
* @version
|
|
46821
|
+
* @version 241.1.0
|
|
46205
46822
|
*/
|
|
46206
46823
|
|
|
46207
46824
|
/**
|
|
@@ -46400,7 +47017,7 @@ class MessagingApi {
|
|
|
46400
47017
|
/**
|
|
46401
47018
|
* Messaging service.
|
|
46402
47019
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46403
|
-
* @version
|
|
47020
|
+
* @version 241.1.0
|
|
46404
47021
|
*/
|
|
46405
47022
|
|
|
46406
47023
|
/**
|
|
@@ -46759,7 +47376,7 @@ class MobileDevicesApi {
|
|
|
46759
47376
|
/**
|
|
46760
47377
|
* MobileDevices service.
|
|
46761
47378
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46762
|
-
* @version
|
|
47379
|
+
* @version 241.1.0
|
|
46763
47380
|
*/
|
|
46764
47381
|
|
|
46765
47382
|
/**
|
|
@@ -46910,7 +47527,7 @@ class NotificationsApi {
|
|
|
46910
47527
|
/**
|
|
46911
47528
|
* Notifications service.
|
|
46912
47529
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46913
|
-
* @version
|
|
47530
|
+
* @version 241.1.0
|
|
46914
47531
|
*/
|
|
46915
47532
|
|
|
46916
47533
|
/**
|
|
@@ -47143,7 +47760,7 @@ class OAuthApi {
|
|
|
47143
47760
|
/**
|
|
47144
47761
|
* OAuth service.
|
|
47145
47762
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
47146
|
-
* @version
|
|
47763
|
+
* @version 241.1.0
|
|
47147
47764
|
*/
|
|
47148
47765
|
|
|
47149
47766
|
/**
|
|
@@ -47509,7 +48126,7 @@ class ObjectsApi {
|
|
|
47509
48126
|
/**
|
|
47510
48127
|
* Objects service.
|
|
47511
48128
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47512
|
-
* @version
|
|
48129
|
+
* @version 241.1.0
|
|
47513
48130
|
*/
|
|
47514
48131
|
|
|
47515
48132
|
/**
|
|
@@ -47833,7 +48450,7 @@ class OperationalEventsApi {
|
|
|
47833
48450
|
/**
|
|
47834
48451
|
* OperationalEvents service.
|
|
47835
48452
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47836
|
-
* @version
|
|
48453
|
+
* @version 241.1.0
|
|
47837
48454
|
*/
|
|
47838
48455
|
|
|
47839
48456
|
/**
|
|
@@ -47950,7 +48567,7 @@ class OrganizationApi {
|
|
|
47950
48567
|
/**
|
|
47951
48568
|
* Organization service.
|
|
47952
48569
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47953
|
-
* @version
|
|
48570
|
+
* @version 241.1.0
|
|
47954
48571
|
*/
|
|
47955
48572
|
|
|
47956
48573
|
/**
|
|
@@ -48425,7 +49042,7 @@ class OrganizationAuthorizationApi {
|
|
|
48425
49042
|
/**
|
|
48426
49043
|
* OrganizationAuthorization service.
|
|
48427
49044
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48428
|
-
* @version
|
|
49045
|
+
* @version 241.1.0
|
|
48429
49046
|
*/
|
|
48430
49047
|
|
|
48431
49048
|
/**
|
|
@@ -49819,7 +50436,7 @@ class OutboundApi {
|
|
|
49819
50436
|
/**
|
|
49820
50437
|
* Outbound service.
|
|
49821
50438
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49822
|
-
* @version
|
|
50439
|
+
* @version 241.1.0
|
|
49823
50440
|
*/
|
|
49824
50441
|
|
|
49825
50442
|
/**
|
|
@@ -54567,7 +55184,7 @@ class PresenceApi {
|
|
|
54567
55184
|
/**
|
|
54568
55185
|
* Presence service.
|
|
54569
55186
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54570
|
-
* @version
|
|
55187
|
+
* @version 241.1.0
|
|
54571
55188
|
*/
|
|
54572
55189
|
|
|
54573
55190
|
/**
|
|
@@ -55311,7 +55928,7 @@ class ProcessAutomationApi {
|
|
|
55311
55928
|
/**
|
|
55312
55929
|
* ProcessAutomation service.
|
|
55313
55930
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55314
|
-
* @version
|
|
55931
|
+
* @version 241.1.0
|
|
55315
55932
|
*/
|
|
55316
55933
|
|
|
55317
55934
|
/**
|
|
@@ -55550,7 +56167,7 @@ class QualityApi {
|
|
|
55550
56167
|
/**
|
|
55551
56168
|
* Quality service.
|
|
55552
56169
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55553
|
-
* @version
|
|
56170
|
+
* @version 241.1.0
|
|
55554
56171
|
*/
|
|
55555
56172
|
|
|
55556
56173
|
/**
|
|
@@ -57389,7 +58006,7 @@ class RecordingApi {
|
|
|
57389
58006
|
/**
|
|
57390
58007
|
* Recording service.
|
|
57391
58008
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57392
|
-
* @version
|
|
58009
|
+
* @version 241.1.0
|
|
57393
58010
|
*/
|
|
57394
58011
|
|
|
57395
58012
|
/**
|
|
@@ -58994,7 +59611,7 @@ class ResponseManagementApi {
|
|
|
58994
59611
|
/**
|
|
58995
59612
|
* ResponseManagement service.
|
|
58996
59613
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58997
|
-
* @version
|
|
59614
|
+
* @version 241.1.0
|
|
58998
59615
|
*/
|
|
58999
59616
|
|
|
59000
59617
|
/**
|
|
@@ -59504,7 +60121,7 @@ class RoutingApi {
|
|
|
59504
60121
|
/**
|
|
59505
60122
|
* Routing service.
|
|
59506
60123
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59507
|
-
* @version
|
|
60124
|
+
* @version 241.1.0
|
|
59508
60125
|
*/
|
|
59509
60126
|
|
|
59510
60127
|
/**
|
|
@@ -59694,6 +60311,32 @@ class RoutingApi {
|
|
|
59694
60311
|
);
|
|
59695
60312
|
}
|
|
59696
60313
|
|
|
60314
|
+
/**
|
|
60315
|
+
* Delete a custom Key Performance Indicator.
|
|
60316
|
+
*
|
|
60317
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
60318
|
+
* deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60319
|
+
*/
|
|
60320
|
+
deleteRoutingPredictorsKeyperformanceindicator(kpiId) {
|
|
60321
|
+
// verify the required parameter 'kpiId' is set
|
|
60322
|
+
if (kpiId === undefined || kpiId === null || kpiId === '') {
|
|
60323
|
+
throw 'Missing the required parameter "kpiId" when calling deleteRoutingPredictorsKeyperformanceindicator';
|
|
60324
|
+
}
|
|
60325
|
+
|
|
60326
|
+
return this.apiClient.callApi(
|
|
60327
|
+
'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
|
|
60328
|
+
'DELETE',
|
|
60329
|
+
{ 'kpiId': kpiId },
|
|
60330
|
+
{ },
|
|
60331
|
+
{ },
|
|
60332
|
+
{ },
|
|
60333
|
+
null,
|
|
60334
|
+
['PureCloud OAuth'],
|
|
60335
|
+
['application/json'],
|
|
60336
|
+
['application/json']
|
|
60337
|
+
);
|
|
60338
|
+
}
|
|
60339
|
+
|
|
59697
60340
|
/**
|
|
59698
60341
|
* Delete a queue
|
|
59699
60342
|
*
|
|
@@ -60834,6 +61477,36 @@ class RoutingApi {
|
|
|
60834
61477
|
);
|
|
60835
61478
|
}
|
|
60836
61479
|
|
|
61480
|
+
/**
|
|
61481
|
+
* Retrieve a single Key Performance Indicator.
|
|
61482
|
+
*
|
|
61483
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
61484
|
+
* @param {Object} opts Optional parameters
|
|
61485
|
+
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
61486
|
+
* getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61487
|
+
*/
|
|
61488
|
+
getRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
|
|
61489
|
+
opts = opts || {};
|
|
61490
|
+
|
|
61491
|
+
// verify the required parameter 'kpiId' is set
|
|
61492
|
+
if (kpiId === undefined || kpiId === null || kpiId === '') {
|
|
61493
|
+
throw 'Missing the required parameter "kpiId" when calling getRoutingPredictorsKeyperformanceindicator';
|
|
61494
|
+
}
|
|
61495
|
+
|
|
61496
|
+
return this.apiClient.callApi(
|
|
61497
|
+
'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
|
|
61498
|
+
'GET',
|
|
61499
|
+
{ 'kpiId': kpiId },
|
|
61500
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61501
|
+
{ },
|
|
61502
|
+
{ },
|
|
61503
|
+
null,
|
|
61504
|
+
['PureCloud OAuth'],
|
|
61505
|
+
['application/json'],
|
|
61506
|
+
['application/json']
|
|
61507
|
+
);
|
|
61508
|
+
}
|
|
61509
|
+
|
|
60837
61510
|
/**
|
|
60838
61511
|
* Get a list of Key Performance Indicators
|
|
60839
61512
|
*
|
|
@@ -60859,6 +61532,27 @@ class RoutingApi {
|
|
|
60859
61532
|
);
|
|
60860
61533
|
}
|
|
60861
61534
|
|
|
61535
|
+
/**
|
|
61536
|
+
* Get a list of Key Performance Indicators Types available.
|
|
61537
|
+
*
|
|
61538
|
+
* getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61539
|
+
*/
|
|
61540
|
+
getRoutingPredictorsKeyperformanceindicatortypes() {
|
|
61541
|
+
|
|
61542
|
+
return this.apiClient.callApi(
|
|
61543
|
+
'/api/v2/routing/predictors/keyperformanceindicatortypes',
|
|
61544
|
+
'GET',
|
|
61545
|
+
{ },
|
|
61546
|
+
{ },
|
|
61547
|
+
{ },
|
|
61548
|
+
{ },
|
|
61549
|
+
null,
|
|
61550
|
+
['PureCloud OAuth'],
|
|
61551
|
+
['application/json'],
|
|
61552
|
+
['application/json']
|
|
61553
|
+
);
|
|
61554
|
+
}
|
|
61555
|
+
|
|
60862
61556
|
/**
|
|
60863
61557
|
* Get details about this queue.
|
|
60864
61558
|
*
|
|
@@ -62269,6 +62963,36 @@ class RoutingApi {
|
|
|
62269
62963
|
);
|
|
62270
62964
|
}
|
|
62271
62965
|
|
|
62966
|
+
/**
|
|
62967
|
+
* Update a custom Key Performance Indicator.
|
|
62968
|
+
*
|
|
62969
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
62970
|
+
* @param {Object} opts Optional parameters
|
|
62971
|
+
* @param {Object} opts.body
|
|
62972
|
+
* patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
62973
|
+
*/
|
|
62974
|
+
patchRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
|
|
62975
|
+
opts = opts || {};
|
|
62976
|
+
|
|
62977
|
+
// verify the required parameter 'kpiId' is set
|
|
62978
|
+
if (kpiId === undefined || kpiId === null || kpiId === '') {
|
|
62979
|
+
throw 'Missing the required parameter "kpiId" when calling patchRoutingPredictorsKeyperformanceindicator';
|
|
62980
|
+
}
|
|
62981
|
+
|
|
62982
|
+
return this.apiClient.callApi(
|
|
62983
|
+
'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
|
|
62984
|
+
'PATCH',
|
|
62985
|
+
{ 'kpiId': kpiId },
|
|
62986
|
+
{ },
|
|
62987
|
+
{ },
|
|
62988
|
+
{ },
|
|
62989
|
+
opts['body'],
|
|
62990
|
+
['PureCloud OAuth'],
|
|
62991
|
+
['application/json'],
|
|
62992
|
+
['application/json']
|
|
62993
|
+
);
|
|
62994
|
+
}
|
|
62995
|
+
|
|
62272
62996
|
/**
|
|
62273
62997
|
* Update the ring number OR joined status for a queue member.
|
|
62274
62998
|
*
|
|
@@ -63041,6 +63765,32 @@ class RoutingApi {
|
|
|
63041
63765
|
);
|
|
63042
63766
|
}
|
|
63043
63767
|
|
|
63768
|
+
/**
|
|
63769
|
+
* Create a custom Key Performance Indicator.
|
|
63770
|
+
*
|
|
63771
|
+
* @param {Object} body request
|
|
63772
|
+
* postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
63773
|
+
*/
|
|
63774
|
+
postRoutingPredictorsKeyperformanceindicators(body) {
|
|
63775
|
+
// verify the required parameter 'body' is set
|
|
63776
|
+
if (body === undefined || body === null) {
|
|
63777
|
+
throw 'Missing the required parameter "body" when calling postRoutingPredictorsKeyperformanceindicators';
|
|
63778
|
+
}
|
|
63779
|
+
|
|
63780
|
+
return this.apiClient.callApi(
|
|
63781
|
+
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
63782
|
+
'POST',
|
|
63783
|
+
{ },
|
|
63784
|
+
{ },
|
|
63785
|
+
{ },
|
|
63786
|
+
{ },
|
|
63787
|
+
body,
|
|
63788
|
+
['PureCloud OAuth'],
|
|
63789
|
+
['application/json'],
|
|
63790
|
+
['application/json']
|
|
63791
|
+
);
|
|
63792
|
+
}
|
|
63793
|
+
|
|
63044
63794
|
/**
|
|
63045
63795
|
* Bulk add or delete up to 100 queue members
|
|
63046
63796
|
*
|
|
@@ -63987,7 +64737,7 @@ class SCIMApi {
|
|
|
63987
64737
|
/**
|
|
63988
64738
|
* SCIM service.
|
|
63989
64739
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63990
|
-
* @version
|
|
64740
|
+
* @version 241.1.0
|
|
63991
64741
|
*/
|
|
63992
64742
|
|
|
63993
64743
|
/**
|
|
@@ -64864,7 +65614,7 @@ class ScreenRecordingApi {
|
|
|
64864
65614
|
/**
|
|
64865
65615
|
* ScreenRecording service.
|
|
64866
65616
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64867
|
-
* @version
|
|
65617
|
+
* @version 241.1.0
|
|
64868
65618
|
*/
|
|
64869
65619
|
|
|
64870
65620
|
/**
|
|
@@ -64909,7 +65659,7 @@ class ScriptsApi {
|
|
|
64909
65659
|
/**
|
|
64910
65660
|
* Scripts service.
|
|
64911
65661
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64912
|
-
* @version
|
|
65662
|
+
* @version 241.1.0
|
|
64913
65663
|
*/
|
|
64914
65664
|
|
|
64915
65665
|
/**
|
|
@@ -65385,7 +66135,7 @@ class SearchApi {
|
|
|
65385
66135
|
/**
|
|
65386
66136
|
* Search service.
|
|
65387
66137
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65388
|
-
* @version
|
|
66138
|
+
* @version 241.1.0
|
|
65389
66139
|
*/
|
|
65390
66140
|
|
|
65391
66141
|
/**
|
|
@@ -66073,7 +66823,7 @@ class SettingsApi {
|
|
|
66073
66823
|
/**
|
|
66074
66824
|
* Settings service.
|
|
66075
66825
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
66076
|
-
* @version
|
|
66826
|
+
* @version 241.1.0
|
|
66077
66827
|
*/
|
|
66078
66828
|
|
|
66079
66829
|
/**
|
|
@@ -66421,7 +67171,7 @@ class SocialMediaApi {
|
|
|
66421
67171
|
/**
|
|
66422
67172
|
* SocialMedia service.
|
|
66423
67173
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66424
|
-
* @version
|
|
67174
|
+
* @version 241.1.0
|
|
66425
67175
|
*/
|
|
66426
67176
|
|
|
66427
67177
|
/**
|
|
@@ -67323,6 +68073,7 @@ class SocialMediaApi {
|
|
|
67323
68073
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
67324
68074
|
* @param {Array.<String>} opts.divisionIds One or more division IDs. If nothing is provided, the social topics associated withthe list of divisions that the user has access to will be returned.
|
|
67325
68075
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
68076
|
+
* @param {String} opts.name Search for topic by name that contains the given search string, search is case insensitive
|
|
67326
68077
|
*/
|
|
67327
68078
|
getSocialmediaTopics(opts) {
|
|
67328
68079
|
opts = opts || {};
|
|
@@ -67332,7 +68083,7 @@ class SocialMediaApi {
|
|
|
67332
68083
|
'/api/v2/socialmedia/topics',
|
|
67333
68084
|
'GET',
|
|
67334
68085
|
{ },
|
|
67335
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
|
|
68086
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'],'name': opts['name'] },
|
|
67336
68087
|
{ },
|
|
67337
68088
|
{ },
|
|
67338
68089
|
null,
|
|
@@ -68016,7 +68767,7 @@ class SpeechTextAnalyticsApi {
|
|
|
68016
68767
|
/**
|
|
68017
68768
|
* SpeechTextAnalytics service.
|
|
68018
68769
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
68019
|
-
* @version
|
|
68770
|
+
* @version 241.1.0
|
|
68020
68771
|
*/
|
|
68021
68772
|
|
|
68022
68773
|
/**
|
|
@@ -69663,7 +70414,7 @@ class StationsApi {
|
|
|
69663
70414
|
/**
|
|
69664
70415
|
* Stations service.
|
|
69665
70416
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69666
|
-
* @version
|
|
70417
|
+
* @version 241.1.0
|
|
69667
70418
|
*/
|
|
69668
70419
|
|
|
69669
70420
|
/**
|
|
@@ -69765,7 +70516,7 @@ class SuggestApi {
|
|
|
69765
70516
|
/**
|
|
69766
70517
|
* Suggest service.
|
|
69767
70518
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69768
|
-
* @version
|
|
70519
|
+
* @version 241.1.0
|
|
69769
70520
|
*/
|
|
69770
70521
|
|
|
69771
70522
|
/**
|
|
@@ -69904,7 +70655,7 @@ class TaskManagementApi {
|
|
|
69904
70655
|
/**
|
|
69905
70656
|
* TaskManagement service.
|
|
69906
70657
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69907
|
-
* @version
|
|
70658
|
+
* @version 241.1.0
|
|
69908
70659
|
*/
|
|
69909
70660
|
|
|
69910
70661
|
/**
|
|
@@ -72066,7 +72817,7 @@ class TeamsApi {
|
|
|
72066
72817
|
/**
|
|
72067
72818
|
* Teams service.
|
|
72068
72819
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
72069
|
-
* @version
|
|
72820
|
+
* @version 241.1.0
|
|
72070
72821
|
*/
|
|
72071
72822
|
|
|
72072
72823
|
/**
|
|
@@ -72371,7 +73122,7 @@ class TelephonyApi {
|
|
|
72371
73122
|
/**
|
|
72372
73123
|
* Telephony service.
|
|
72373
73124
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72374
|
-
* @version
|
|
73125
|
+
* @version 241.1.0
|
|
72375
73126
|
*/
|
|
72376
73127
|
|
|
72377
73128
|
/**
|
|
@@ -72657,7 +73408,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
72657
73408
|
/**
|
|
72658
73409
|
* TelephonyProvidersEdge service.
|
|
72659
73410
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72660
|
-
* @version
|
|
73411
|
+
* @version 241.1.0
|
|
72661
73412
|
*/
|
|
72662
73413
|
|
|
72663
73414
|
/**
|
|
@@ -76150,7 +76901,7 @@ class TextbotsApi {
|
|
|
76150
76901
|
/**
|
|
76151
76902
|
* Textbots service.
|
|
76152
76903
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
76153
|
-
* @version
|
|
76904
|
+
* @version 241.1.0
|
|
76154
76905
|
*/
|
|
76155
76906
|
|
|
76156
76907
|
/**
|
|
@@ -76279,7 +77030,7 @@ class TokensApi {
|
|
|
76279
77030
|
/**
|
|
76280
77031
|
* Tokens service.
|
|
76281
77032
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76282
|
-
* @version
|
|
77033
|
+
* @version 241.1.0
|
|
76283
77034
|
*/
|
|
76284
77035
|
|
|
76285
77036
|
/**
|
|
@@ -76433,7 +77184,7 @@ class UploadsApi {
|
|
|
76433
77184
|
/**
|
|
76434
77185
|
* Uploads service.
|
|
76435
77186
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76436
|
-
* @version
|
|
77187
|
+
* @version 241.1.0
|
|
76437
77188
|
*/
|
|
76438
77189
|
|
|
76439
77190
|
/**
|
|
@@ -76724,7 +77475,7 @@ class UsageApi {
|
|
|
76724
77475
|
/**
|
|
76725
77476
|
* Usage service.
|
|
76726
77477
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76727
|
-
* @version
|
|
77478
|
+
* @version 241.1.0
|
|
76728
77479
|
*/
|
|
76729
77480
|
|
|
76730
77481
|
/**
|
|
@@ -77059,7 +77810,7 @@ class UserRecordingsApi {
|
|
|
77059
77810
|
/**
|
|
77060
77811
|
* UserRecordings service.
|
|
77061
77812
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
77062
|
-
* @version
|
|
77813
|
+
* @version 241.1.0
|
|
77063
77814
|
*/
|
|
77064
77815
|
|
|
77065
77816
|
/**
|
|
@@ -77243,7 +77994,7 @@ class UsersApi {
|
|
|
77243
77994
|
/**
|
|
77244
77995
|
* Users service.
|
|
77245
77996
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77246
|
-
* @version
|
|
77997
|
+
* @version 241.1.0
|
|
77247
77998
|
*/
|
|
77248
77999
|
|
|
77249
78000
|
/**
|
|
@@ -80252,7 +81003,7 @@ class UsersRulesApi {
|
|
|
80252
81003
|
/**
|
|
80253
81004
|
* UsersRules service.
|
|
80254
81005
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
80255
|
-
* @version
|
|
81006
|
+
* @version 241.1.0
|
|
80256
81007
|
*/
|
|
80257
81008
|
|
|
80258
81009
|
/**
|
|
@@ -80541,7 +81292,7 @@ class UtilitiesApi {
|
|
|
80541
81292
|
/**
|
|
80542
81293
|
* Utilities service.
|
|
80543
81294
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80544
|
-
* @version
|
|
81295
|
+
* @version 241.1.0
|
|
80545
81296
|
*/
|
|
80546
81297
|
|
|
80547
81298
|
/**
|
|
@@ -80652,7 +81403,7 @@ class VoicemailApi {
|
|
|
80652
81403
|
/**
|
|
80653
81404
|
* Voicemail service.
|
|
80654
81405
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80655
|
-
* @version
|
|
81406
|
+
* @version 241.1.0
|
|
80656
81407
|
*/
|
|
80657
81408
|
|
|
80658
81409
|
/**
|
|
@@ -81374,7 +82125,7 @@ class WebChatApi {
|
|
|
81374
82125
|
/**
|
|
81375
82126
|
* WebChat service.
|
|
81376
82127
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
81377
|
-
* @version
|
|
82128
|
+
* @version 241.1.0
|
|
81378
82129
|
*/
|
|
81379
82130
|
|
|
81380
82131
|
/**
|
|
@@ -81937,7 +82688,7 @@ class WebDeploymentsApi {
|
|
|
81937
82688
|
/**
|
|
81938
82689
|
* WebDeployments service.
|
|
81939
82690
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81940
|
-
* @version
|
|
82691
|
+
* @version 241.1.0
|
|
81941
82692
|
*/
|
|
81942
82693
|
|
|
81943
82694
|
/**
|
|
@@ -82519,7 +83270,7 @@ class WebMessagingApi {
|
|
|
82519
83270
|
/**
|
|
82520
83271
|
* WebMessaging service.
|
|
82521
83272
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82522
|
-
* @version
|
|
83273
|
+
* @version 241.1.0
|
|
82523
83274
|
*/
|
|
82524
83275
|
|
|
82525
83276
|
/**
|
|
@@ -82665,7 +83416,7 @@ class WidgetsApi {
|
|
|
82665
83416
|
/**
|
|
82666
83417
|
* Widgets service.
|
|
82667
83418
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82668
|
-
* @version
|
|
83419
|
+
* @version 241.1.0
|
|
82669
83420
|
*/
|
|
82670
83421
|
|
|
82671
83422
|
/**
|
|
@@ -82816,7 +83567,7 @@ class WorkforceManagementApi {
|
|
|
82816
83567
|
/**
|
|
82817
83568
|
* WorkforceManagement service.
|
|
82818
83569
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
82819
|
-
* @version
|
|
83570
|
+
* @version 241.1.0
|
|
82820
83571
|
*/
|
|
82821
83572
|
|
|
82822
83573
|
/**
|
|
@@ -90867,7 +91618,7 @@ class WorkforceManagementApi {
|
|
|
90867
91618
|
* </pre>
|
|
90868
91619
|
* </p>
|
|
90869
91620
|
* @module purecloud-platform-client-v2/index
|
|
90870
|
-
* @version
|
|
91621
|
+
* @version 241.1.0
|
|
90871
91622
|
*/
|
|
90872
91623
|
class platformClient {
|
|
90873
91624
|
constructor() {
|