purecloud-platform-client-v2 239.0.0 → 241.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +824 -115
- package/dist/web-amd/purecloud-platform-client-v2.js +824 -115
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +286 -118
- package/dist/web-cjs/purecloud-platform-client-v2.js +286 -118
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1276 -752
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +5 -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
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 241.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -1120,6 +1120,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1120
1120
|
* @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.
|
|
1121
1121
|
* @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.
|
|
1122
1122
|
* @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.
|
|
1123
|
+
* @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).
|
|
1123
1124
|
*/
|
|
1124
1125
|
loginImplicitGrant(clientId, redirectUri, opts) {
|
|
1125
1126
|
// Check for auth token in hash
|
|
@@ -1161,6 +1162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1161
1162
|
if (opts.state) query.state = encodeURIComponent(opts.state);
|
|
1162
1163
|
if (opts.org) query.org = encodeURIComponent(opts.org);
|
|
1163
1164
|
if (opts.provider) query.provider = encodeURIComponent(opts.provider);
|
|
1165
|
+
if (opts.prompt && opts.prompt == 'login') query.prompt = encodeURIComponent(opts.prompt);
|
|
1164
1166
|
|
|
1165
1167
|
var url = this._buildAuthUrl('oauth/authorize', query);
|
|
1166
1168
|
window.location.replace(url);
|
|
@@ -1487,6 +1489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1487
1489
|
* @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.
|
|
1488
1490
|
* @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.
|
|
1489
1491
|
* @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.
|
|
1492
|
+
* @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).
|
|
1490
1493
|
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
1491
1494
|
*/
|
|
1492
1495
|
loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
|
|
@@ -1591,6 +1594,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1591
1594
|
if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
|
|
1592
1595
|
if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
|
|
1593
1596
|
if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
|
|
1597
|
+
if (opts.prompt && opts.prompt == 'login') tokenQuery.prompt = encodeURIComponent(opts.prompt);
|
|
1594
1598
|
|
|
1595
1599
|
var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
|
|
1596
1600
|
window.location.replace(url);
|
|
@@ -2358,7 +2362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2358
2362
|
/**
|
|
2359
2363
|
* AIStudio service.
|
|
2360
2364
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2361
|
-
* @version
|
|
2365
|
+
* @version 241.0.0
|
|
2362
2366
|
*/
|
|
2363
2367
|
|
|
2364
2368
|
/**
|
|
@@ -2776,6 +2780,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2776
2780
|
);
|
|
2777
2781
|
}
|
|
2778
2782
|
|
|
2783
|
+
/**
|
|
2784
|
+
* Add a turn to a guide session.
|
|
2785
|
+
* 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.
|
|
2786
|
+
* @param {String} guideId Guide ID
|
|
2787
|
+
* @param {String} guideSessionId Guide Session ID
|
|
2788
|
+
* @param {Object} body
|
|
2789
|
+
*/
|
|
2790
|
+
postGuideSessionTurns(guideId, guideSessionId, body) {
|
|
2791
|
+
// verify the required parameter 'guideId' is set
|
|
2792
|
+
if (guideId === undefined || guideId === null || guideId === '') {
|
|
2793
|
+
throw 'Missing the required parameter "guideId" when calling postGuideSessionTurns';
|
|
2794
|
+
}
|
|
2795
|
+
// verify the required parameter 'guideSessionId' is set
|
|
2796
|
+
if (guideSessionId === undefined || guideSessionId === null || guideSessionId === '') {
|
|
2797
|
+
throw 'Missing the required parameter "guideSessionId" when calling postGuideSessionTurns';
|
|
2798
|
+
}
|
|
2799
|
+
// verify the required parameter 'body' is set
|
|
2800
|
+
if (body === undefined || body === null) {
|
|
2801
|
+
throw 'Missing the required parameter "body" when calling postGuideSessionTurns';
|
|
2802
|
+
}
|
|
2803
|
+
|
|
2804
|
+
return this.apiClient.callApi(
|
|
2805
|
+
'/api/v2/guides/{guideId}/sessions/{guideSessionId}/turns',
|
|
2806
|
+
'POST',
|
|
2807
|
+
{ 'guideId': guideId,'guideSessionId': guideSessionId },
|
|
2808
|
+
{ },
|
|
2809
|
+
{ },
|
|
2810
|
+
{ },
|
|
2811
|
+
body,
|
|
2812
|
+
['PureCloud OAuth'],
|
|
2813
|
+
['application/json'],
|
|
2814
|
+
['application/json']
|
|
2815
|
+
);
|
|
2816
|
+
}
|
|
2817
|
+
|
|
2779
2818
|
/**
|
|
2780
2819
|
* Start the publishing of a guide version.
|
|
2781
2820
|
*
|
|
@@ -2930,7 +2969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2930
2969
|
/**
|
|
2931
2970
|
* AgentAssistants service.
|
|
2932
2971
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2933
|
-
* @version
|
|
2972
|
+
* @version 241.0.0
|
|
2934
2973
|
*/
|
|
2935
2974
|
|
|
2936
2975
|
/**
|
|
@@ -3029,6 +3068,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3029
3068
|
);
|
|
3030
3069
|
}
|
|
3031
3070
|
|
|
3071
|
+
/**
|
|
3072
|
+
* Delete an agent checklist
|
|
3073
|
+
*
|
|
3074
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
3075
|
+
*/
|
|
3076
|
+
deleteAssistantsAgentchecklist(agentChecklistId) {
|
|
3077
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
3078
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
3079
|
+
throw 'Missing the required parameter "agentChecklistId" when calling deleteAssistantsAgentchecklist';
|
|
3080
|
+
}
|
|
3081
|
+
|
|
3082
|
+
return this.apiClient.callApi(
|
|
3083
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
3084
|
+
'DELETE',
|
|
3085
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
3086
|
+
{ },
|
|
3087
|
+
{ },
|
|
3088
|
+
{ },
|
|
3089
|
+
null,
|
|
3090
|
+
['PureCloud OAuth'],
|
|
3091
|
+
['application/json'],
|
|
3092
|
+
['application/json']
|
|
3093
|
+
);
|
|
3094
|
+
}
|
|
3095
|
+
|
|
3032
3096
|
/**
|
|
3033
3097
|
* Get an assistant.
|
|
3034
3098
|
*
|
|
@@ -3153,6 +3217,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3153
3217
|
);
|
|
3154
3218
|
}
|
|
3155
3219
|
|
|
3220
|
+
/**
|
|
3221
|
+
* Get an agent checklist
|
|
3222
|
+
*
|
|
3223
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
3224
|
+
*/
|
|
3225
|
+
getAssistantsAgentchecklist(agentChecklistId) {
|
|
3226
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
3227
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
3228
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getAssistantsAgentchecklist';
|
|
3229
|
+
}
|
|
3230
|
+
|
|
3231
|
+
return this.apiClient.callApi(
|
|
3232
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
3233
|
+
'GET',
|
|
3234
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
3235
|
+
{ },
|
|
3236
|
+
{ },
|
|
3237
|
+
{ },
|
|
3238
|
+
null,
|
|
3239
|
+
['PureCloud OAuth'],
|
|
3240
|
+
['application/json'],
|
|
3241
|
+
['application/json']
|
|
3242
|
+
);
|
|
3243
|
+
}
|
|
3244
|
+
|
|
3245
|
+
/**
|
|
3246
|
+
* Get the list of agent checklists
|
|
3247
|
+
*
|
|
3248
|
+
* @param {Object} opts Optional parameters
|
|
3249
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
3250
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
3251
|
+
* @param {String} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 25)
|
|
3252
|
+
* @param {String} opts.namePrefix The agent checklist name prefix filter applied to the listing.
|
|
3253
|
+
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
3254
|
+
* @param {Object} opts.sortOrder The sort order for the listing
|
|
3255
|
+
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
3256
|
+
*/
|
|
3257
|
+
getAssistantsAgentchecklists(opts) {
|
|
3258
|
+
opts = opts || {};
|
|
3259
|
+
|
|
3260
|
+
|
|
3261
|
+
return this.apiClient.callApi(
|
|
3262
|
+
'/api/v2/assistants/agentchecklists',
|
|
3263
|
+
'GET',
|
|
3264
|
+
{ },
|
|
3265
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
3266
|
+
{ },
|
|
3267
|
+
{ },
|
|
3268
|
+
null,
|
|
3269
|
+
['PureCloud OAuth'],
|
|
3270
|
+
['application/json'],
|
|
3271
|
+
['application/json']
|
|
3272
|
+
);
|
|
3273
|
+
}
|
|
3274
|
+
|
|
3275
|
+
/**
|
|
3276
|
+
* Get the list of supported languages
|
|
3277
|
+
*
|
|
3278
|
+
*/
|
|
3279
|
+
getAssistantsAgentchecklistsLanguages() {
|
|
3280
|
+
|
|
3281
|
+
return this.apiClient.callApi(
|
|
3282
|
+
'/api/v2/assistants/agentchecklists/languages',
|
|
3283
|
+
'GET',
|
|
3284
|
+
{ },
|
|
3285
|
+
{ },
|
|
3286
|
+
{ },
|
|
3287
|
+
{ },
|
|
3288
|
+
null,
|
|
3289
|
+
['PureCloud OAuth'],
|
|
3290
|
+
['application/json'],
|
|
3291
|
+
['application/json']
|
|
3292
|
+
);
|
|
3293
|
+
}
|
|
3294
|
+
|
|
3156
3295
|
/**
|
|
3157
3296
|
* Get all queues assigned to any assistant.
|
|
3158
3297
|
*
|
|
@@ -3375,6 +3514,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3375
3514
|
);
|
|
3376
3515
|
}
|
|
3377
3516
|
|
|
3517
|
+
/**
|
|
3518
|
+
* Create an agent checklist
|
|
3519
|
+
*
|
|
3520
|
+
* @param {Object} body Request body containing details of checklist to be added
|
|
3521
|
+
*/
|
|
3522
|
+
postAssistantsAgentchecklists(body) {
|
|
3523
|
+
// verify the required parameter 'body' is set
|
|
3524
|
+
if (body === undefined || body === null) {
|
|
3525
|
+
throw 'Missing the required parameter "body" when calling postAssistantsAgentchecklists';
|
|
3526
|
+
}
|
|
3527
|
+
|
|
3528
|
+
return this.apiClient.callApi(
|
|
3529
|
+
'/api/v2/assistants/agentchecklists',
|
|
3530
|
+
'POST',
|
|
3531
|
+
{ },
|
|
3532
|
+
{ },
|
|
3533
|
+
{ },
|
|
3534
|
+
{ },
|
|
3535
|
+
body,
|
|
3536
|
+
['PureCloud OAuth'],
|
|
3537
|
+
['application/json'],
|
|
3538
|
+
['application/json']
|
|
3539
|
+
);
|
|
3540
|
+
}
|
|
3541
|
+
|
|
3378
3542
|
/**
|
|
3379
3543
|
* Create a queue assistant association.
|
|
3380
3544
|
*
|
|
@@ -3410,13 +3574,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3410
3574
|
);
|
|
3411
3575
|
}
|
|
3412
3576
|
|
|
3577
|
+
/**
|
|
3578
|
+
* Update an agent checklist
|
|
3579
|
+
*
|
|
3580
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
3581
|
+
* @param {Object} body Request body containing details of checklist to be updated
|
|
3582
|
+
*/
|
|
3583
|
+
putAssistantsAgentchecklist(agentChecklistId, body) {
|
|
3584
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
3585
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
3586
|
+
throw 'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';
|
|
3587
|
+
}
|
|
3588
|
+
// verify the required parameter 'body' is set
|
|
3589
|
+
if (body === undefined || body === null) {
|
|
3590
|
+
throw 'Missing the required parameter "body" when calling putAssistantsAgentchecklist';
|
|
3591
|
+
}
|
|
3592
|
+
|
|
3593
|
+
return this.apiClient.callApi(
|
|
3594
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
3595
|
+
'PUT',
|
|
3596
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
3597
|
+
{ },
|
|
3598
|
+
{ },
|
|
3599
|
+
{ },
|
|
3600
|
+
body,
|
|
3601
|
+
['PureCloud OAuth'],
|
|
3602
|
+
['application/json'],
|
|
3603
|
+
['application/json']
|
|
3604
|
+
);
|
|
3605
|
+
}
|
|
3606
|
+
|
|
3413
3607
|
}
|
|
3414
3608
|
|
|
3415
3609
|
class AgentCopilotApi {
|
|
3416
3610
|
/**
|
|
3417
3611
|
* AgentCopilot service.
|
|
3418
3612
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3419
|
-
* @version
|
|
3613
|
+
* @version 241.0.0
|
|
3420
3614
|
*/
|
|
3421
3615
|
|
|
3422
3616
|
/**
|
|
@@ -3516,7 +3710,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3516
3710
|
/**
|
|
3517
3711
|
* AgentUI service.
|
|
3518
3712
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3519
|
-
* @version
|
|
3713
|
+
* @version 241.0.0
|
|
3520
3714
|
*/
|
|
3521
3715
|
|
|
3522
3716
|
/**
|
|
@@ -3647,7 +3841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3647
3841
|
/**
|
|
3648
3842
|
* Alerting service.
|
|
3649
3843
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3650
|
-
* @version
|
|
3844
|
+
* @version 241.0.0
|
|
3651
3845
|
*/
|
|
3652
3846
|
|
|
3653
3847
|
/**
|
|
@@ -4048,7 +4242,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4048
4242
|
/**
|
|
4049
4243
|
* Analytics service.
|
|
4050
4244
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4051
|
-
* @version
|
|
4245
|
+
* @version 241.0.0
|
|
4052
4246
|
*/
|
|
4053
4247
|
|
|
4054
4248
|
/**
|
|
@@ -4141,6 +4335,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4141
4335
|
);
|
|
4142
4336
|
}
|
|
4143
4337
|
|
|
4338
|
+
/**
|
|
4339
|
+
* Delete/cancel an async request for case management aggregates
|
|
4340
|
+
*
|
|
4341
|
+
* @param {String} jobId jobId
|
|
4342
|
+
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4343
|
+
*/
|
|
4344
|
+
deleteAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
4345
|
+
// verify the required parameter 'jobId' is set
|
|
4346
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4347
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCasemanagementAggregatesJob';
|
|
4348
|
+
}
|
|
4349
|
+
|
|
4350
|
+
return this.apiClient.callApi(
|
|
4351
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
|
|
4352
|
+
'DELETE',
|
|
4353
|
+
{ 'jobId': jobId },
|
|
4354
|
+
{ },
|
|
4355
|
+
{ },
|
|
4356
|
+
{ },
|
|
4357
|
+
null,
|
|
4358
|
+
['PureCloud OAuth'],
|
|
4359
|
+
['application/json'],
|
|
4360
|
+
['application/json']
|
|
4361
|
+
);
|
|
4362
|
+
}
|
|
4363
|
+
|
|
4144
4364
|
/**
|
|
4145
4365
|
* Delete/cancel an async request for conversation aggregates
|
|
4146
4366
|
*
|
|
@@ -4800,6 +5020,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4800
5020
|
);
|
|
4801
5021
|
}
|
|
4802
5022
|
|
|
5023
|
+
/**
|
|
5024
|
+
* Get status for async query for case management aggregates
|
|
5025
|
+
*
|
|
5026
|
+
* @param {String} jobId jobId
|
|
5027
|
+
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5028
|
+
*/
|
|
5029
|
+
getAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
5030
|
+
// verify the required parameter 'jobId' is set
|
|
5031
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5032
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJob';
|
|
5033
|
+
}
|
|
5034
|
+
|
|
5035
|
+
return this.apiClient.callApi(
|
|
5036
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
|
|
5037
|
+
'GET',
|
|
5038
|
+
{ 'jobId': jobId },
|
|
5039
|
+
{ },
|
|
5040
|
+
{ },
|
|
5041
|
+
{ },
|
|
5042
|
+
null,
|
|
5043
|
+
['PureCloud OAuth'],
|
|
5044
|
+
['application/json'],
|
|
5045
|
+
['application/json']
|
|
5046
|
+
);
|
|
5047
|
+
}
|
|
5048
|
+
|
|
5049
|
+
/**
|
|
5050
|
+
* Fetch a page of results for an async case management query
|
|
5051
|
+
*
|
|
5052
|
+
* @param {String} jobId jobId
|
|
5053
|
+
* @param {Object} opts Optional parameters
|
|
5054
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5055
|
+
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5056
|
+
*/
|
|
5057
|
+
getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
|
|
5058
|
+
opts = opts || {};
|
|
5059
|
+
|
|
5060
|
+
// verify the required parameter 'jobId' is set
|
|
5061
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
5062
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJobResults';
|
|
5063
|
+
}
|
|
5064
|
+
|
|
5065
|
+
return this.apiClient.callApi(
|
|
5066
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results',
|
|
5067
|
+
'GET',
|
|
5068
|
+
{ 'jobId': jobId },
|
|
5069
|
+
{ 'cursor': opts['cursor'] },
|
|
5070
|
+
{ },
|
|
5071
|
+
{ },
|
|
5072
|
+
null,
|
|
5073
|
+
['PureCloud OAuth'],
|
|
5074
|
+
['application/json'],
|
|
5075
|
+
['application/json']
|
|
5076
|
+
);
|
|
5077
|
+
}
|
|
5078
|
+
|
|
4803
5079
|
/**
|
|
4804
5080
|
* Get a conversation by id
|
|
4805
5081
|
*
|
|
@@ -6167,6 +6443,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6167
6443
|
);
|
|
6168
6444
|
}
|
|
6169
6445
|
|
|
6446
|
+
/**
|
|
6447
|
+
* Query for case management aggregates asynchronously
|
|
6448
|
+
*
|
|
6449
|
+
* @param {Object} body query
|
|
6450
|
+
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6451
|
+
*/
|
|
6452
|
+
postAnalyticsCasemanagementAggregatesJobs(body) {
|
|
6453
|
+
// verify the required parameter 'body' is set
|
|
6454
|
+
if (body === undefined || body === null) {
|
|
6455
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesJobs';
|
|
6456
|
+
}
|
|
6457
|
+
|
|
6458
|
+
return this.apiClient.callApi(
|
|
6459
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs',
|
|
6460
|
+
'POST',
|
|
6461
|
+
{ },
|
|
6462
|
+
{ },
|
|
6463
|
+
{ },
|
|
6464
|
+
{ },
|
|
6465
|
+
body,
|
|
6466
|
+
['PureCloud OAuth'],
|
|
6467
|
+
['application/json'],
|
|
6468
|
+
['application/json']
|
|
6469
|
+
);
|
|
6470
|
+
}
|
|
6471
|
+
|
|
6472
|
+
/**
|
|
6473
|
+
* Query for case management aggregates
|
|
6474
|
+
*
|
|
6475
|
+
* @param {Object} body query
|
|
6476
|
+
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6477
|
+
*/
|
|
6478
|
+
postAnalyticsCasemanagementAggregatesQuery(body) {
|
|
6479
|
+
// verify the required parameter 'body' is set
|
|
6480
|
+
if (body === undefined || body === null) {
|
|
6481
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesQuery';
|
|
6482
|
+
}
|
|
6483
|
+
|
|
6484
|
+
return this.apiClient.callApi(
|
|
6485
|
+
'/api/v2/analytics/casemanagement/aggregates/query',
|
|
6486
|
+
'POST',
|
|
6487
|
+
{ },
|
|
6488
|
+
{ },
|
|
6489
|
+
{ },
|
|
6490
|
+
{ },
|
|
6491
|
+
body,
|
|
6492
|
+
['PureCloud OAuth'],
|
|
6493
|
+
['application/json'],
|
|
6494
|
+
['application/json']
|
|
6495
|
+
);
|
|
6496
|
+
}
|
|
6497
|
+
|
|
6170
6498
|
/**
|
|
6171
6499
|
* Index conversation properties
|
|
6172
6500
|
*
|
|
@@ -7316,7 +7644,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7316
7644
|
/**
|
|
7317
7645
|
* Architect service.
|
|
7318
7646
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
7319
|
-
* @version
|
|
7647
|
+
* @version 241.0.0
|
|
7320
7648
|
*/
|
|
7321
7649
|
|
|
7322
7650
|
/**
|
|
@@ -11611,7 +11939,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11611
11939
|
/**
|
|
11612
11940
|
* Audit service.
|
|
11613
11941
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
11614
|
-
* @version
|
|
11942
|
+
* @version 241.0.0
|
|
11615
11943
|
*/
|
|
11616
11944
|
|
|
11617
11945
|
/**
|
|
@@ -11812,7 +12140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11812
12140
|
/**
|
|
11813
12141
|
* Authorization service.
|
|
11814
12142
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
11815
|
-
* @version
|
|
12143
|
+
* @version 241.0.0
|
|
11816
12144
|
*/
|
|
11817
12145
|
|
|
11818
12146
|
/**
|
|
@@ -11861,7 +12189,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11861
12189
|
*
|
|
11862
12190
|
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
11863
12191
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
11864
|
-
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
11865
12192
|
*/
|
|
11866
12193
|
deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
11867
12194
|
// verify the required parameter 'targetName' is set
|
|
@@ -12260,7 +12587,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12260
12587
|
* @param {Object} opts Optional parameters
|
|
12261
12588
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12262
12589
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
12263
|
-
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12264
12590
|
*/
|
|
12265
12591
|
getAuthorizationPolicies(opts) {
|
|
12266
12592
|
opts = opts || {};
|
|
@@ -12287,7 +12613,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12287
12613
|
* @param {Object} opts Optional parameters
|
|
12288
12614
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12289
12615
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
12290
|
-
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12291
12616
|
*/
|
|
12292
12617
|
getAuthorizationPoliciesSubjectSubjectId(subjectId, opts) {
|
|
12293
12618
|
opts = opts || {};
|
|
@@ -12318,7 +12643,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12318
12643
|
* @param {Object} opts Optional parameters
|
|
12319
12644
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12320
12645
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
12321
|
-
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12322
12646
|
*/
|
|
12323
12647
|
getAuthorizationPoliciesTarget(targetName, opts) {
|
|
12324
12648
|
opts = opts || {};
|
|
@@ -12347,7 +12671,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12347
12671
|
*
|
|
12348
12672
|
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
12349
12673
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
12350
|
-
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12351
12674
|
*/
|
|
12352
12675
|
getAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
12353
12676
|
// verify the required parameter 'targetName' is set
|
|
@@ -12376,7 +12699,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12376
12699
|
/**
|
|
12377
12700
|
* Get a map of policy targets to valid attributes for those targets
|
|
12378
12701
|
*
|
|
12379
|
-
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12380
12702
|
*/
|
|
12381
12703
|
getAuthorizationPoliciesTargets() {
|
|
12382
12704
|
|
|
@@ -12398,7 +12720,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12398
12720
|
* Get an access control policy with the specified policy ID
|
|
12399
12721
|
*
|
|
12400
12722
|
* @param {String} policyId The ID of the policy to retrieve
|
|
12401
|
-
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12402
12723
|
*/
|
|
12403
12724
|
getAuthorizationPolicy(policyId) {
|
|
12404
12725
|
// verify the required parameter 'policyId' is set
|
|
@@ -12424,7 +12745,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12424
12745
|
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
12425
12746
|
*
|
|
12426
12747
|
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
12427
|
-
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12428
12748
|
*/
|
|
12429
12749
|
getAuthorizationPolicyAttributes(policyId) {
|
|
12430
12750
|
// verify the required parameter 'policyId' is set
|
|
@@ -12916,7 +13236,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12916
13236
|
*
|
|
12917
13237
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
12918
13238
|
* @param {Object} body Access control policy
|
|
12919
|
-
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12920
13239
|
*/
|
|
12921
13240
|
postAuthorizationPoliciesTarget(targetName, body) {
|
|
12922
13241
|
// verify the required parameter 'targetName' is set
|
|
@@ -12947,7 +13266,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12947
13266
|
*
|
|
12948
13267
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
12949
13268
|
* @param {Object} body Access control policy
|
|
12950
|
-
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12951
13269
|
*/
|
|
12952
13270
|
postAuthorizationPoliciesTargetValidate(targetName, body) {
|
|
12953
13271
|
// verify the required parameter 'targetName' is set
|
|
@@ -12978,7 +13296,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12978
13296
|
*
|
|
12979
13297
|
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
12980
13298
|
* @param {Object} body A map of attribute names to type and simulated data value
|
|
12981
|
-
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12982
13299
|
*/
|
|
12983
13300
|
postAuthorizationPolicySimulate(policyId, body) {
|
|
12984
13301
|
// verify the required parameter 'policyId' is set
|
|
@@ -13294,7 +13611,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13294
13611
|
*
|
|
13295
13612
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
13296
13613
|
* @param {Object} body Access control policy
|
|
13297
|
-
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13298
13614
|
*/
|
|
13299
13615
|
putAuthorizationPoliciesTarget(targetName, body) {
|
|
13300
13616
|
// verify the required parameter 'targetName' is set
|
|
@@ -13325,7 +13641,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13325
13641
|
*
|
|
13326
13642
|
* @param {String} policyId The ID of the policy to update
|
|
13327
13643
|
* @param {Object} body Access control policy
|
|
13328
|
-
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13329
13644
|
*/
|
|
13330
13645
|
putAuthorizationPolicy(policyId, body) {
|
|
13331
13646
|
// verify the required parameter 'policyId' is set
|
|
@@ -13527,7 +13842,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13527
13842
|
/**
|
|
13528
13843
|
* Billing service.
|
|
13529
13844
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
13530
|
-
* @version
|
|
13845
|
+
* @version 241.0.0
|
|
13531
13846
|
*/
|
|
13532
13847
|
|
|
13533
13848
|
/**
|
|
@@ -13783,7 +14098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13783
14098
|
/**
|
|
13784
14099
|
* BusinessRules service.
|
|
13785
14100
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
13786
|
-
* @version
|
|
14101
|
+
* @version 241.0.0
|
|
13787
14102
|
*/
|
|
13788
14103
|
|
|
13789
14104
|
/**
|
|
@@ -14670,7 +14985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14670
14985
|
/**
|
|
14671
14986
|
* CarrierServices service.
|
|
14672
14987
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
14673
|
-
* @version
|
|
14988
|
+
* @version 241.0.0
|
|
14674
14989
|
*/
|
|
14675
14990
|
|
|
14676
14991
|
/**
|
|
@@ -14740,7 +15055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14740
15055
|
/**
|
|
14741
15056
|
* Chat service.
|
|
14742
15057
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
14743
|
-
* @version
|
|
15058
|
+
* @version 241.0.0
|
|
14744
15059
|
*/
|
|
14745
15060
|
|
|
14746
15061
|
/**
|
|
@@ -15721,7 +16036,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15721
16036
|
/**
|
|
15722
16037
|
* Coaching service.
|
|
15723
16038
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
15724
|
-
* @version
|
|
16039
|
+
* @version 241.0.0
|
|
15725
16040
|
*/
|
|
15726
16041
|
|
|
15727
16042
|
/**
|
|
@@ -16348,7 +16663,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16348
16663
|
/**
|
|
16349
16664
|
* ContentManagement service.
|
|
16350
16665
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
16351
|
-
* @version
|
|
16666
|
+
* @version 241.0.0
|
|
16352
16667
|
*/
|
|
16353
16668
|
|
|
16354
16669
|
/**
|
|
@@ -17429,7 +17744,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17429
17744
|
/**
|
|
17430
17745
|
* Conversations service.
|
|
17431
17746
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
17432
|
-
* @version
|
|
17747
|
+
* @version 241.0.0
|
|
17433
17748
|
*/
|
|
17434
17749
|
|
|
17435
17750
|
/**
|
|
@@ -18095,6 +18410,111 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18095
18410
|
);
|
|
18096
18411
|
}
|
|
18097
18412
|
|
|
18413
|
+
/**
|
|
18414
|
+
* Get checklist info for a single checklist.
|
|
18415
|
+
*
|
|
18416
|
+
* @param {String} conversationId Conversation ID
|
|
18417
|
+
* @param {String} communicationId Communication ID
|
|
18418
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
18419
|
+
*/
|
|
18420
|
+
getConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId) {
|
|
18421
|
+
// verify the required parameter 'conversationId' is set
|
|
18422
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
18423
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklist';
|
|
18424
|
+
}
|
|
18425
|
+
// verify the required parameter 'communicationId' is set
|
|
18426
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
18427
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklist';
|
|
18428
|
+
}
|
|
18429
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
18430
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
18431
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklist';
|
|
18432
|
+
}
|
|
18433
|
+
|
|
18434
|
+
return this.apiClient.callApi(
|
|
18435
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
|
|
18436
|
+
'GET',
|
|
18437
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
18438
|
+
{ },
|
|
18439
|
+
{ },
|
|
18440
|
+
{ },
|
|
18441
|
+
null,
|
|
18442
|
+
['PureCloud OAuth'],
|
|
18443
|
+
['application/json'],
|
|
18444
|
+
['application/json']
|
|
18445
|
+
);
|
|
18446
|
+
}
|
|
18447
|
+
|
|
18448
|
+
/**
|
|
18449
|
+
* Get inference job status
|
|
18450
|
+
*
|
|
18451
|
+
* @param {String} conversationId Conversation ID
|
|
18452
|
+
* @param {String} communicationId Communication ID
|
|
18453
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
18454
|
+
* @param {String} jobId Inference Job ID
|
|
18455
|
+
*/
|
|
18456
|
+
getConversationCommunicationAgentchecklistJob(conversationId, communicationId, agentChecklistId, jobId) {
|
|
18457
|
+
// verify the required parameter 'conversationId' is set
|
|
18458
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
18459
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18460
|
+
}
|
|
18461
|
+
// verify the required parameter 'communicationId' is set
|
|
18462
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
18463
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18464
|
+
}
|
|
18465
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
18466
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
18467
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18468
|
+
}
|
|
18469
|
+
// verify the required parameter 'jobId' is set
|
|
18470
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
18471
|
+
throw 'Missing the required parameter "jobId" when calling getConversationCommunicationAgentchecklistJob';
|
|
18472
|
+
}
|
|
18473
|
+
|
|
18474
|
+
return this.apiClient.callApi(
|
|
18475
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs/{jobId}',
|
|
18476
|
+
'GET',
|
|
18477
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId,'jobId': jobId },
|
|
18478
|
+
{ },
|
|
18479
|
+
{ },
|
|
18480
|
+
{ },
|
|
18481
|
+
null,
|
|
18482
|
+
['PureCloud OAuth'],
|
|
18483
|
+
['application/json'],
|
|
18484
|
+
['application/json']
|
|
18485
|
+
);
|
|
18486
|
+
}
|
|
18487
|
+
|
|
18488
|
+
/**
|
|
18489
|
+
* Get information of all checklists associated with a conversation.
|
|
18490
|
+
*
|
|
18491
|
+
* @param {String} conversationId Conversation ID
|
|
18492
|
+
* @param {String} communicationId Communication ID
|
|
18493
|
+
*/
|
|
18494
|
+
getConversationCommunicationAgentchecklists(conversationId, communicationId) {
|
|
18495
|
+
// verify the required parameter 'conversationId' is set
|
|
18496
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
18497
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationCommunicationAgentchecklists';
|
|
18498
|
+
}
|
|
18499
|
+
// verify the required parameter 'communicationId' is set
|
|
18500
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
18501
|
+
throw 'Missing the required parameter "communicationId" when calling getConversationCommunicationAgentchecklists';
|
|
18502
|
+
}
|
|
18503
|
+
|
|
18504
|
+
return this.apiClient.callApi(
|
|
18505
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists',
|
|
18506
|
+
'GET',
|
|
18507
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
18508
|
+
{ },
|
|
18509
|
+
{ },
|
|
18510
|
+
{ },
|
|
18511
|
+
null,
|
|
18512
|
+
['PureCloud OAuth'],
|
|
18513
|
+
['application/json'],
|
|
18514
|
+
['application/json']
|
|
18515
|
+
);
|
|
18516
|
+
}
|
|
18517
|
+
|
|
18098
18518
|
/**
|
|
18099
18519
|
* Get message
|
|
18100
18520
|
*
|
|
@@ -22650,6 +23070,161 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22650
23070
|
);
|
|
22651
23071
|
}
|
|
22652
23072
|
|
|
23073
|
+
/**
|
|
23074
|
+
* Agent Checklist activation API
|
|
23075
|
+
*
|
|
23076
|
+
* @param {String} conversationId Conversation ID
|
|
23077
|
+
* @param {String} communicationId Communication ID
|
|
23078
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
23079
|
+
* @param {Object} body Agent checklist activation payload
|
|
23080
|
+
*/
|
|
23081
|
+
postConversationCommunicationAgentchecklist(conversationId, communicationId, agentChecklistId, body) {
|
|
23082
|
+
// verify the required parameter 'conversationId' is set
|
|
23083
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23084
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklist';
|
|
23085
|
+
}
|
|
23086
|
+
// verify the required parameter 'communicationId' is set
|
|
23087
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23088
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklist';
|
|
23089
|
+
}
|
|
23090
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
23091
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
23092
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklist';
|
|
23093
|
+
}
|
|
23094
|
+
// verify the required parameter 'body' is set
|
|
23095
|
+
if (body === undefined || body === null) {
|
|
23096
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklist';
|
|
23097
|
+
}
|
|
23098
|
+
|
|
23099
|
+
return this.apiClient.callApi(
|
|
23100
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}',
|
|
23101
|
+
'POST',
|
|
23102
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
23103
|
+
{ },
|
|
23104
|
+
{ },
|
|
23105
|
+
{ },
|
|
23106
|
+
body,
|
|
23107
|
+
['PureCloud OAuth'],
|
|
23108
|
+
['application/json'],
|
|
23109
|
+
['application/json']
|
|
23110
|
+
);
|
|
23111
|
+
}
|
|
23112
|
+
|
|
23113
|
+
/**
|
|
23114
|
+
* API invoked to capture an agent action.
|
|
23115
|
+
*
|
|
23116
|
+
* @param {String} conversationId Conversation ID
|
|
23117
|
+
* @param {String} communicationId Communication ID
|
|
23118
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
23119
|
+
* @param {Object} body Agent action payload
|
|
23120
|
+
*/
|
|
23121
|
+
postConversationCommunicationAgentchecklistAgentaction(conversationId, communicationId, agentChecklistId, body) {
|
|
23122
|
+
// verify the required parameter 'conversationId' is set
|
|
23123
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23124
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23125
|
+
}
|
|
23126
|
+
// verify the required parameter 'communicationId' is set
|
|
23127
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23128
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23129
|
+
}
|
|
23130
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
23131
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
23132
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23133
|
+
}
|
|
23134
|
+
// verify the required parameter 'body' is set
|
|
23135
|
+
if (body === undefined || body === null) {
|
|
23136
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistAgentaction';
|
|
23137
|
+
}
|
|
23138
|
+
|
|
23139
|
+
return this.apiClient.callApi(
|
|
23140
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/agentaction',
|
|
23141
|
+
'POST',
|
|
23142
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
23143
|
+
{ },
|
|
23144
|
+
{ },
|
|
23145
|
+
{ },
|
|
23146
|
+
body,
|
|
23147
|
+
['PureCloud OAuth'],
|
|
23148
|
+
['application/json'],
|
|
23149
|
+
['application/json']
|
|
23150
|
+
);
|
|
23151
|
+
}
|
|
23152
|
+
|
|
23153
|
+
/**
|
|
23154
|
+
* Create inference job
|
|
23155
|
+
*
|
|
23156
|
+
* @param {String} conversationId Conversation ID
|
|
23157
|
+
* @param {String} communicationId Communication ID
|
|
23158
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
23159
|
+
* @param {Object} body Agent checklist inference job payload
|
|
23160
|
+
*/
|
|
23161
|
+
postConversationCommunicationAgentchecklistJobs(conversationId, communicationId, agentChecklistId, body) {
|
|
23162
|
+
// verify the required parameter 'conversationId' is set
|
|
23163
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23164
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23165
|
+
}
|
|
23166
|
+
// verify the required parameter 'communicationId' is set
|
|
23167
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23168
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23169
|
+
}
|
|
23170
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
23171
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
23172
|
+
throw 'Missing the required parameter "agentChecklistId" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23173
|
+
}
|
|
23174
|
+
// verify the required parameter 'body' is set
|
|
23175
|
+
if (body === undefined || body === null) {
|
|
23176
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistJobs';
|
|
23177
|
+
}
|
|
23178
|
+
|
|
23179
|
+
return this.apiClient.callApi(
|
|
23180
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/{agentChecklistId}/jobs',
|
|
23181
|
+
'POST',
|
|
23182
|
+
{ 'conversationId': conversationId,'communicationId': communicationId,'agentChecklistId': agentChecklistId },
|
|
23183
|
+
{ },
|
|
23184
|
+
{ },
|
|
23185
|
+
{ },
|
|
23186
|
+
body,
|
|
23187
|
+
['PureCloud OAuth'],
|
|
23188
|
+
['application/json'],
|
|
23189
|
+
['application/json']
|
|
23190
|
+
);
|
|
23191
|
+
}
|
|
23192
|
+
|
|
23193
|
+
/**
|
|
23194
|
+
* API invoked to finalize agent checklist evaluation.
|
|
23195
|
+
*
|
|
23196
|
+
* @param {String} conversationId Conversation ID
|
|
23197
|
+
* @param {String} communicationId Communication ID
|
|
23198
|
+
* @param {Object} body Agent checklist finalize payload
|
|
23199
|
+
*/
|
|
23200
|
+
postConversationCommunicationAgentchecklistsFinalize(conversationId, communicationId, body) {
|
|
23201
|
+
// verify the required parameter 'conversationId' is set
|
|
23202
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
23203
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
23204
|
+
}
|
|
23205
|
+
// verify the required parameter 'communicationId' is set
|
|
23206
|
+
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
23207
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
23208
|
+
}
|
|
23209
|
+
// verify the required parameter 'body' is set
|
|
23210
|
+
if (body === undefined || body === null) {
|
|
23211
|
+
throw 'Missing the required parameter "body" when calling postConversationCommunicationAgentchecklistsFinalize';
|
|
23212
|
+
}
|
|
23213
|
+
|
|
23214
|
+
return this.apiClient.callApi(
|
|
23215
|
+
'/api/v2/conversations/{conversationId}/communications/{communicationId}/agentchecklists/finalize',
|
|
23216
|
+
'POST',
|
|
23217
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
23218
|
+
{ },
|
|
23219
|
+
{ },
|
|
23220
|
+
{ },
|
|
23221
|
+
body,
|
|
23222
|
+
['PureCloud OAuth'],
|
|
23223
|
+
['application/json'],
|
|
23224
|
+
['application/json']
|
|
23225
|
+
);
|
|
23226
|
+
}
|
|
23227
|
+
|
|
22653
23228
|
/**
|
|
22654
23229
|
* Send internal message
|
|
22655
23230
|
* Send a new internal message for an existing communication.
|
|
@@ -22814,11 +23389,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22814
23389
|
}
|
|
22815
23390
|
|
|
22816
23391
|
/**
|
|
22817
|
-
* Replace this participant
|
|
22818
|
-
*
|
|
23392
|
+
* Replace this participant (Deprecated)
|
|
23393
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /transfer, /replace/agent, /replace/queue, or /replace/contact/external.
|
|
22819
23394
|
* @param {String} conversationId conversation ID
|
|
22820
23395
|
* @param {String} participantId participant ID
|
|
22821
23396
|
* @param {Object} body Transfer request
|
|
23397
|
+
* @deprecated
|
|
22822
23398
|
*/
|
|
22823
23399
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
22824
23400
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22889,7 +23465,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22889
23465
|
* @param {String} conversationId conversation ID
|
|
22890
23466
|
* @param {String} participantId participant ID
|
|
22891
23467
|
* @param {Object} body Transfer request
|
|
22892
|
-
* postConversationParticipantReplaceContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22893
23468
|
*/
|
|
22894
23469
|
postConversationParticipantReplaceContactExternal(conversationId, participantId, body) {
|
|
22895
23470
|
// verify the required parameter 'conversationId' is set
|
|
@@ -22920,11 +23495,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22920
23495
|
}
|
|
22921
23496
|
|
|
22922
23497
|
/**
|
|
22923
|
-
* Replace this participant with the an external contact
|
|
22924
|
-
*
|
|
23498
|
+
* Replace this participant with the an external contact (Deprecated)
|
|
23499
|
+
* This endpoint is deprecated. Use /replace/contact/external endpoint instead.
|
|
22925
23500
|
* @param {String} conversationId conversation ID
|
|
22926
23501
|
* @param {String} participantId participant ID
|
|
22927
23502
|
* @param {Object} body Transfer request
|
|
23503
|
+
* @deprecated
|
|
22928
23504
|
*/
|
|
22929
23505
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
22930
23506
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23029,7 +23605,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23029
23605
|
* @param {String} conversationId conversation ID
|
|
23030
23606
|
* @param {String} participantId participant ID
|
|
23031
23607
|
* @param {Object} body Transfer request
|
|
23032
|
-
* postConversationParticipantTransfer is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23033
23608
|
*/
|
|
23034
23609
|
postConversationParticipantTransfer(conversationId, participantId, body) {
|
|
23035
23610
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23289,11 +23864,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23289
23864
|
}
|
|
23290
23865
|
|
|
23291
23866
|
/**
|
|
23292
|
-
* Initiate and update consult transfer
|
|
23293
|
-
*
|
|
23867
|
+
* Initiate and update consult transfer (Deprecated)
|
|
23868
|
+
* This endpoint is deprecated. Use one of the following endpoints instead: /voice/consult, /consult/agent, /consult/queue, or /consult/contact/external.
|
|
23294
23869
|
* @param {String} conversationId conversationId
|
|
23295
23870
|
* @param {String} participantId participantId
|
|
23296
23871
|
* @param {Object} body Destination address and initial speak to
|
|
23872
|
+
* @deprecated
|
|
23297
23873
|
*/
|
|
23298
23874
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
23299
23875
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23364,7 +23940,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23364
23940
|
* @param {String} conversationId conversationId
|
|
23365
23941
|
* @param {String} participantId participantId
|
|
23366
23942
|
* @param {Object} body Destination address and initial speak to
|
|
23367
|
-
* postConversationsCallParticipantConsultContactExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23368
23943
|
*/
|
|
23369
23944
|
postConversationsCallParticipantConsultContactExternal(conversationId, participantId, body) {
|
|
23370
23945
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23395,11 +23970,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23395
23970
|
}
|
|
23396
23971
|
|
|
23397
23972
|
/**
|
|
23398
|
-
* Initiate a consult transfer to an external contact
|
|
23399
|
-
*
|
|
23973
|
+
* Initiate a consult transfer to an external contact (Deprecated)
|
|
23974
|
+
* This endpoint is deprecated. Use /consult/contact/external endpoints instead.
|
|
23400
23975
|
* @param {String} conversationId conversationId
|
|
23401
23976
|
* @param {String} participantId participantId
|
|
23402
23977
|
* @param {Object} body Destination address and initial speak to
|
|
23978
|
+
* @deprecated
|
|
23403
23979
|
*/
|
|
23404
23980
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
23405
23981
|
// verify the required parameter 'conversationId' is set
|
|
@@ -23535,7 +24111,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23535
24111
|
* @param {String} conversationId conversationId
|
|
23536
24112
|
* @param {String} participantId participantId
|
|
23537
24113
|
* @param {Object} body Destination address and initial speak to
|
|
23538
|
-
* postConversationsCallParticipantVoiceConsult is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23539
24114
|
*/
|
|
23540
24115
|
postConversationsCallParticipantVoiceConsult(conversationId, participantId, body) {
|
|
23541
24116
|
// verify the required parameter 'conversationId' is set
|
|
@@ -26054,7 +26629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26054
26629
|
/**
|
|
26055
26630
|
* DataExtensions service.
|
|
26056
26631
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
26057
|
-
* @version
|
|
26632
|
+
* @version 241.0.0
|
|
26058
26633
|
*/
|
|
26059
26634
|
|
|
26060
26635
|
/**
|
|
@@ -26140,7 +26715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26140
26715
|
/**
|
|
26141
26716
|
* DataPrivacy service.
|
|
26142
26717
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
26143
|
-
* @version
|
|
26718
|
+
* @version 241.0.0
|
|
26144
26719
|
*/
|
|
26145
26720
|
|
|
26146
26721
|
/**
|
|
@@ -26310,7 +26885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26310
26885
|
/**
|
|
26311
26886
|
* Downloads service.
|
|
26312
26887
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
26313
|
-
* @version
|
|
26888
|
+
* @version 241.0.0
|
|
26314
26889
|
*/
|
|
26315
26890
|
|
|
26316
26891
|
/**
|
|
@@ -26362,7 +26937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26362
26937
|
/**
|
|
26363
26938
|
* Emails service.
|
|
26364
26939
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
26365
|
-
* @version
|
|
26940
|
+
* @version 241.0.0
|
|
26366
26941
|
*/
|
|
26367
26942
|
|
|
26368
26943
|
/**
|
|
@@ -26491,7 +27066,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26491
27066
|
/**
|
|
26492
27067
|
* EmployeeEngagement service.
|
|
26493
27068
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
26494
|
-
* @version
|
|
27069
|
+
* @version 241.0.0
|
|
26495
27070
|
*/
|
|
26496
27071
|
|
|
26497
27072
|
/**
|
|
@@ -26671,7 +27246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26671
27246
|
/**
|
|
26672
27247
|
* Events service.
|
|
26673
27248
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
26674
|
-
* @version
|
|
27249
|
+
* @version 241.0.0
|
|
26675
27250
|
*/
|
|
26676
27251
|
|
|
26677
27252
|
/**
|
|
@@ -26767,7 +27342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26767
27342
|
/**
|
|
26768
27343
|
* ExternalContacts service.
|
|
26769
27344
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
26770
|
-
* @version
|
|
27345
|
+
* @version 241.0.0
|
|
26771
27346
|
*/
|
|
26772
27347
|
|
|
26773
27348
|
/**
|
|
@@ -30014,7 +30589,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30014
30589
|
/**
|
|
30015
30590
|
* Fax service.
|
|
30016
30591
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
30017
|
-
* @version
|
|
30592
|
+
* @version 241.0.0
|
|
30018
30593
|
*/
|
|
30019
30594
|
|
|
30020
30595
|
/**
|
|
@@ -30229,7 +30804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30229
30804
|
/**
|
|
30230
30805
|
* Flows service.
|
|
30231
30806
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
30232
|
-
* @version
|
|
30807
|
+
* @version 241.0.0
|
|
30233
30808
|
*/
|
|
30234
30809
|
|
|
30235
30810
|
/**
|
|
@@ -30438,7 +31013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30438
31013
|
/**
|
|
30439
31014
|
* Gamification service.
|
|
30440
31015
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
30441
|
-
* @version
|
|
31016
|
+
* @version 241.0.0
|
|
30442
31017
|
*/
|
|
30443
31018
|
|
|
30444
31019
|
/**
|
|
@@ -32996,7 +33571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32996
33571
|
/**
|
|
32997
33572
|
* GeneralDataProtectionRegulation service.
|
|
32998
33573
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
32999
|
-
* @version
|
|
33574
|
+
* @version 241.0.0
|
|
33000
33575
|
*/
|
|
33001
33576
|
|
|
33002
33577
|
/**
|
|
@@ -33126,7 +33701,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33126
33701
|
/**
|
|
33127
33702
|
* Geolocation service.
|
|
33128
33703
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
33129
|
-
* @version
|
|
33704
|
+
* @version 241.0.0
|
|
33130
33705
|
*/
|
|
33131
33706
|
|
|
33132
33707
|
/**
|
|
@@ -33257,7 +33832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33257
33832
|
/**
|
|
33258
33833
|
* Greetings service.
|
|
33259
33834
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
33260
|
-
* @version
|
|
33835
|
+
* @version 241.0.0
|
|
33261
33836
|
*/
|
|
33262
33837
|
|
|
33263
33838
|
/**
|
|
@@ -33799,7 +34374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33799
34374
|
/**
|
|
33800
34375
|
* Groups service.
|
|
33801
34376
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
33802
|
-
* @version
|
|
34377
|
+
* @version 241.0.0
|
|
33803
34378
|
*/
|
|
33804
34379
|
|
|
33805
34380
|
/**
|
|
@@ -34318,7 +34893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34318
34893
|
/**
|
|
34319
34894
|
* IdentityProvider service.
|
|
34320
34895
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
34321
|
-
* @version
|
|
34896
|
+
* @version 241.0.0
|
|
34322
34897
|
*/
|
|
34323
34898
|
|
|
34324
34899
|
/**
|
|
@@ -35179,7 +35754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35179
35754
|
/**
|
|
35180
35755
|
* InfrastructureAsCode service.
|
|
35181
35756
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
35182
|
-
* @version
|
|
35757
|
+
* @version 241.0.0
|
|
35183
35758
|
*/
|
|
35184
35759
|
|
|
35185
35760
|
/**
|
|
@@ -35346,7 +35921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35346
35921
|
/**
|
|
35347
35922
|
* Integrations service.
|
|
35348
35923
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
35349
|
-
* @version
|
|
35924
|
+
* @version 241.0.0
|
|
35350
35925
|
*/
|
|
35351
35926
|
|
|
35352
35927
|
/**
|
|
@@ -37994,7 +38569,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37994
38569
|
/**
|
|
37995
38570
|
* Journey service.
|
|
37996
38571
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
37997
|
-
* @version
|
|
38572
|
+
* @version 241.0.0
|
|
37998
38573
|
*/
|
|
37999
38574
|
|
|
38000
38575
|
/**
|
|
@@ -38367,7 +38942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38367
38942
|
* @param {String} opts.filterValue Value to filter by. Requires 'filterValue' to also be set.
|
|
38368
38943
|
* @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.
|
|
38369
38944
|
* @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
|
|
38370
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
38945
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38371
38946
|
*/
|
|
38372
38947
|
getJourneyActionmaps(opts) {
|
|
38373
38948
|
opts = opts || {};
|
|
@@ -38522,7 +39097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38522
39097
|
* @param {Object} opts.mediaType Media type
|
|
38523
39098
|
* @param {Object} opts.state Action template state.
|
|
38524
39099
|
* @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
|
|
38525
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
39100
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38526
39101
|
*/
|
|
38527
39102
|
getJourneyActiontemplates(opts) {
|
|
38528
39103
|
opts = opts || {};
|
|
@@ -38614,7 +39189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38614
39189
|
* @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).
|
|
38615
39190
|
* @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.
|
|
38616
39191
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
38617
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
39192
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38618
39193
|
*/
|
|
38619
39194
|
getJourneyOutcomes(opts) {
|
|
38620
39195
|
opts = opts || {};
|
|
@@ -38766,7 +39341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38766
39341
|
* @param {Boolean} opts.isActive Determines whether or not to show only active segments.
|
|
38767
39342
|
* @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.
|
|
38768
39343
|
* @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
|
|
38769
|
-
* @param {String} opts.queryValue Value to query on. Requires 'queryFields' to also be set.
|
|
39344
|
+
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
38770
39345
|
*/
|
|
38771
39346
|
getJourneySegments(opts) {
|
|
38772
39347
|
opts = opts || {};
|
|
@@ -40091,7 +40666,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40091
40666
|
/**
|
|
40092
40667
|
* Knowledge service.
|
|
40093
40668
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
40094
|
-
* @version
|
|
40669
|
+
* @version 241.0.0
|
|
40095
40670
|
*/
|
|
40096
40671
|
|
|
40097
40672
|
/**
|
|
@@ -43174,7 +43749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43174
43749
|
/**
|
|
43175
43750
|
* LanguageUnderstanding service.
|
|
43176
43751
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
43177
|
-
* @version
|
|
43752
|
+
* @version 241.0.0
|
|
43178
43753
|
*/
|
|
43179
43754
|
|
|
43180
43755
|
/**
|
|
@@ -44393,7 +44968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44393
44968
|
/**
|
|
44394
44969
|
* Languages service.
|
|
44395
44970
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
44396
|
-
* @version
|
|
44971
|
+
* @version 241.0.0
|
|
44397
44972
|
*/
|
|
44398
44973
|
|
|
44399
44974
|
/**
|
|
@@ -44615,7 +45190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44615
45190
|
/**
|
|
44616
45191
|
* Learning service.
|
|
44617
45192
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
44618
|
-
* @version
|
|
45193
|
+
* @version 241.0.0
|
|
44619
45194
|
*/
|
|
44620
45195
|
|
|
44621
45196
|
/**
|
|
@@ -45724,7 +46299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45724
46299
|
/**
|
|
45725
46300
|
* License service.
|
|
45726
46301
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
45727
|
-
* @version
|
|
46302
|
+
* @version 241.0.0
|
|
45728
46303
|
*/
|
|
45729
46304
|
|
|
45730
46305
|
/**
|
|
@@ -45962,7 +46537,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45962
46537
|
/**
|
|
45963
46538
|
* Locations service.
|
|
45964
46539
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
45965
|
-
* @version
|
|
46540
|
+
* @version 241.0.0
|
|
45966
46541
|
*/
|
|
45967
46542
|
|
|
45968
46543
|
/**
|
|
@@ -46198,7 +46773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46198
46773
|
/**
|
|
46199
46774
|
* LogCapture service.
|
|
46200
46775
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
46201
|
-
* @version
|
|
46776
|
+
* @version 241.0.0
|
|
46202
46777
|
*/
|
|
46203
46778
|
|
|
46204
46779
|
/**
|
|
@@ -46397,7 +46972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46397
46972
|
/**
|
|
46398
46973
|
* Messaging service.
|
|
46399
46974
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
46400
|
-
* @version
|
|
46975
|
+
* @version 241.0.0
|
|
46401
46976
|
*/
|
|
46402
46977
|
|
|
46403
46978
|
/**
|
|
@@ -46756,7 +47331,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46756
47331
|
/**
|
|
46757
47332
|
* MobileDevices service.
|
|
46758
47333
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
46759
|
-
* @version
|
|
47334
|
+
* @version 241.0.0
|
|
46760
47335
|
*/
|
|
46761
47336
|
|
|
46762
47337
|
/**
|
|
@@ -46907,7 +47482,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46907
47482
|
/**
|
|
46908
47483
|
* Notifications service.
|
|
46909
47484
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
46910
|
-
* @version
|
|
47485
|
+
* @version 241.0.0
|
|
46911
47486
|
*/
|
|
46912
47487
|
|
|
46913
47488
|
/**
|
|
@@ -47140,7 +47715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47140
47715
|
/**
|
|
47141
47716
|
* OAuth service.
|
|
47142
47717
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
47143
|
-
* @version
|
|
47718
|
+
* @version 241.0.0
|
|
47144
47719
|
*/
|
|
47145
47720
|
|
|
47146
47721
|
/**
|
|
@@ -47506,7 +48081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47506
48081
|
/**
|
|
47507
48082
|
* Objects service.
|
|
47508
48083
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
47509
|
-
* @version
|
|
48084
|
+
* @version 241.0.0
|
|
47510
48085
|
*/
|
|
47511
48086
|
|
|
47512
48087
|
/**
|
|
@@ -47830,7 +48405,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47830
48405
|
/**
|
|
47831
48406
|
* OperationalEvents service.
|
|
47832
48407
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
47833
|
-
* @version
|
|
48408
|
+
* @version 241.0.0
|
|
47834
48409
|
*/
|
|
47835
48410
|
|
|
47836
48411
|
/**
|
|
@@ -47947,7 +48522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47947
48522
|
/**
|
|
47948
48523
|
* Organization service.
|
|
47949
48524
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
47950
|
-
* @version
|
|
48525
|
+
* @version 241.0.0
|
|
47951
48526
|
*/
|
|
47952
48527
|
|
|
47953
48528
|
/**
|
|
@@ -48422,7 +48997,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48422
48997
|
/**
|
|
48423
48998
|
* OrganizationAuthorization service.
|
|
48424
48999
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
48425
|
-
* @version
|
|
49000
|
+
* @version 241.0.0
|
|
48426
49001
|
*/
|
|
48427
49002
|
|
|
48428
49003
|
/**
|
|
@@ -49816,7 +50391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49816
50391
|
/**
|
|
49817
50392
|
* Outbound service.
|
|
49818
50393
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
49819
|
-
* @version
|
|
50394
|
+
* @version 241.0.0
|
|
49820
50395
|
*/
|
|
49821
50396
|
|
|
49822
50397
|
/**
|
|
@@ -54564,7 +55139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54564
55139
|
/**
|
|
54565
55140
|
* Presence service.
|
|
54566
55141
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
54567
|
-
* @version
|
|
55142
|
+
* @version 241.0.0
|
|
54568
55143
|
*/
|
|
54569
55144
|
|
|
54570
55145
|
/**
|
|
@@ -55308,7 +55883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55308
55883
|
/**
|
|
55309
55884
|
* ProcessAutomation service.
|
|
55310
55885
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
55311
|
-
* @version
|
|
55886
|
+
* @version 241.0.0
|
|
55312
55887
|
*/
|
|
55313
55888
|
|
|
55314
55889
|
/**
|
|
@@ -55547,7 +56122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55547
56122
|
/**
|
|
55548
56123
|
* Quality service.
|
|
55549
56124
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
55550
|
-
* @version
|
|
56125
|
+
* @version 241.0.0
|
|
55551
56126
|
*/
|
|
55552
56127
|
|
|
55553
56128
|
/**
|
|
@@ -57386,7 +57961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57386
57961
|
/**
|
|
57387
57962
|
* Recording service.
|
|
57388
57963
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
57389
|
-
* @version
|
|
57964
|
+
* @version 241.0.0
|
|
57390
57965
|
*/
|
|
57391
57966
|
|
|
57392
57967
|
/**
|
|
@@ -58991,7 +59566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58991
59566
|
/**
|
|
58992
59567
|
* ResponseManagement service.
|
|
58993
59568
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
58994
|
-
* @version
|
|
59569
|
+
* @version 241.0.0
|
|
58995
59570
|
*/
|
|
58996
59571
|
|
|
58997
59572
|
/**
|
|
@@ -59501,7 +60076,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59501
60076
|
/**
|
|
59502
60077
|
* Routing service.
|
|
59503
60078
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
59504
|
-
* @version
|
|
60079
|
+
* @version 241.0.0
|
|
59505
60080
|
*/
|
|
59506
60081
|
|
|
59507
60082
|
/**
|
|
@@ -59691,6 +60266,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59691
60266
|
);
|
|
59692
60267
|
}
|
|
59693
60268
|
|
|
60269
|
+
/**
|
|
60270
|
+
* Delete a custom Key Performance Indicator.
|
|
60271
|
+
*
|
|
60272
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
60273
|
+
* deleteRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
60274
|
+
*/
|
|
60275
|
+
deleteRoutingPredictorsKeyperformanceindicator(kpiId) {
|
|
60276
|
+
// verify the required parameter 'kpiId' is set
|
|
60277
|
+
if (kpiId === undefined || kpiId === null || kpiId === '') {
|
|
60278
|
+
throw 'Missing the required parameter "kpiId" when calling deleteRoutingPredictorsKeyperformanceindicator';
|
|
60279
|
+
}
|
|
60280
|
+
|
|
60281
|
+
return this.apiClient.callApi(
|
|
60282
|
+
'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
|
|
60283
|
+
'DELETE',
|
|
60284
|
+
{ 'kpiId': kpiId },
|
|
60285
|
+
{ },
|
|
60286
|
+
{ },
|
|
60287
|
+
{ },
|
|
60288
|
+
null,
|
|
60289
|
+
['PureCloud OAuth'],
|
|
60290
|
+
['application/json'],
|
|
60291
|
+
['application/json']
|
|
60292
|
+
);
|
|
60293
|
+
}
|
|
60294
|
+
|
|
59694
60295
|
/**
|
|
59695
60296
|
* Delete a queue
|
|
59696
60297
|
*
|
|
@@ -60831,6 +61432,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60831
61432
|
);
|
|
60832
61433
|
}
|
|
60833
61434
|
|
|
61435
|
+
/**
|
|
61436
|
+
* Retrieve a single Key Performance Indicator.
|
|
61437
|
+
*
|
|
61438
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
61439
|
+
* @param {Object} opts Optional parameters
|
|
61440
|
+
* @param {Array.<String>} opts.expand Parameter to request additional data to return in KPI payload
|
|
61441
|
+
* getRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61442
|
+
*/
|
|
61443
|
+
getRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
|
|
61444
|
+
opts = opts || {};
|
|
61445
|
+
|
|
61446
|
+
// verify the required parameter 'kpiId' is set
|
|
61447
|
+
if (kpiId === undefined || kpiId === null || kpiId === '') {
|
|
61448
|
+
throw 'Missing the required parameter "kpiId" when calling getRoutingPredictorsKeyperformanceindicator';
|
|
61449
|
+
}
|
|
61450
|
+
|
|
61451
|
+
return this.apiClient.callApi(
|
|
61452
|
+
'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
|
|
61453
|
+
'GET',
|
|
61454
|
+
{ 'kpiId': kpiId },
|
|
61455
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
61456
|
+
{ },
|
|
61457
|
+
{ },
|
|
61458
|
+
null,
|
|
61459
|
+
['PureCloud OAuth'],
|
|
61460
|
+
['application/json'],
|
|
61461
|
+
['application/json']
|
|
61462
|
+
);
|
|
61463
|
+
}
|
|
61464
|
+
|
|
60834
61465
|
/**
|
|
60835
61466
|
* Get a list of Key Performance Indicators
|
|
60836
61467
|
*
|
|
@@ -60856,6 +61487,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60856
61487
|
);
|
|
60857
61488
|
}
|
|
60858
61489
|
|
|
61490
|
+
/**
|
|
61491
|
+
* Get a list of Key Performance Indicators Types available.
|
|
61492
|
+
*
|
|
61493
|
+
* getRoutingPredictorsKeyperformanceindicatortypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61494
|
+
*/
|
|
61495
|
+
getRoutingPredictorsKeyperformanceindicatortypes() {
|
|
61496
|
+
|
|
61497
|
+
return this.apiClient.callApi(
|
|
61498
|
+
'/api/v2/routing/predictors/keyperformanceindicatortypes',
|
|
61499
|
+
'GET',
|
|
61500
|
+
{ },
|
|
61501
|
+
{ },
|
|
61502
|
+
{ },
|
|
61503
|
+
{ },
|
|
61504
|
+
null,
|
|
61505
|
+
['PureCloud OAuth'],
|
|
61506
|
+
['application/json'],
|
|
61507
|
+
['application/json']
|
|
61508
|
+
);
|
|
61509
|
+
}
|
|
61510
|
+
|
|
60859
61511
|
/**
|
|
60860
61512
|
* Get details about this queue.
|
|
60861
61513
|
*
|
|
@@ -62266,6 +62918,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62266
62918
|
);
|
|
62267
62919
|
}
|
|
62268
62920
|
|
|
62921
|
+
/**
|
|
62922
|
+
* Update a custom Key Performance Indicator.
|
|
62923
|
+
*
|
|
62924
|
+
* @param {String} kpiId Key Performance Indicator ID
|
|
62925
|
+
* @param {Object} opts Optional parameters
|
|
62926
|
+
* @param {Object} opts.body
|
|
62927
|
+
* patchRoutingPredictorsKeyperformanceindicator is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
62928
|
+
*/
|
|
62929
|
+
patchRoutingPredictorsKeyperformanceindicator(kpiId, opts) {
|
|
62930
|
+
opts = opts || {};
|
|
62931
|
+
|
|
62932
|
+
// verify the required parameter 'kpiId' is set
|
|
62933
|
+
if (kpiId === undefined || kpiId === null || kpiId === '') {
|
|
62934
|
+
throw 'Missing the required parameter "kpiId" when calling patchRoutingPredictorsKeyperformanceindicator';
|
|
62935
|
+
}
|
|
62936
|
+
|
|
62937
|
+
return this.apiClient.callApi(
|
|
62938
|
+
'/api/v2/routing/predictors/keyperformanceindicators/{kpiId}',
|
|
62939
|
+
'PATCH',
|
|
62940
|
+
{ 'kpiId': kpiId },
|
|
62941
|
+
{ },
|
|
62942
|
+
{ },
|
|
62943
|
+
{ },
|
|
62944
|
+
opts['body'],
|
|
62945
|
+
['PureCloud OAuth'],
|
|
62946
|
+
['application/json'],
|
|
62947
|
+
['application/json']
|
|
62948
|
+
);
|
|
62949
|
+
}
|
|
62950
|
+
|
|
62269
62951
|
/**
|
|
62270
62952
|
* Update the ring number OR joined status for a queue member.
|
|
62271
62953
|
*
|
|
@@ -63038,6 +63720,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63038
63720
|
);
|
|
63039
63721
|
}
|
|
63040
63722
|
|
|
63723
|
+
/**
|
|
63724
|
+
* Create a custom Key Performance Indicator.
|
|
63725
|
+
*
|
|
63726
|
+
* @param {Object} body request
|
|
63727
|
+
* postRoutingPredictorsKeyperformanceindicators is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
63728
|
+
*/
|
|
63729
|
+
postRoutingPredictorsKeyperformanceindicators(body) {
|
|
63730
|
+
// verify the required parameter 'body' is set
|
|
63731
|
+
if (body === undefined || body === null) {
|
|
63732
|
+
throw 'Missing the required parameter "body" when calling postRoutingPredictorsKeyperformanceindicators';
|
|
63733
|
+
}
|
|
63734
|
+
|
|
63735
|
+
return this.apiClient.callApi(
|
|
63736
|
+
'/api/v2/routing/predictors/keyperformanceindicators',
|
|
63737
|
+
'POST',
|
|
63738
|
+
{ },
|
|
63739
|
+
{ },
|
|
63740
|
+
{ },
|
|
63741
|
+
{ },
|
|
63742
|
+
body,
|
|
63743
|
+
['PureCloud OAuth'],
|
|
63744
|
+
['application/json'],
|
|
63745
|
+
['application/json']
|
|
63746
|
+
);
|
|
63747
|
+
}
|
|
63748
|
+
|
|
63041
63749
|
/**
|
|
63042
63750
|
* Bulk add or delete up to 100 queue members
|
|
63043
63751
|
*
|
|
@@ -63984,7 +64692,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63984
64692
|
/**
|
|
63985
64693
|
* SCIM service.
|
|
63986
64694
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
63987
|
-
* @version
|
|
64695
|
+
* @version 241.0.0
|
|
63988
64696
|
*/
|
|
63989
64697
|
|
|
63990
64698
|
/**
|
|
@@ -64861,7 +65569,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64861
65569
|
/**
|
|
64862
65570
|
* ScreenRecording service.
|
|
64863
65571
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
64864
|
-
* @version
|
|
65572
|
+
* @version 241.0.0
|
|
64865
65573
|
*/
|
|
64866
65574
|
|
|
64867
65575
|
/**
|
|
@@ -64906,7 +65614,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64906
65614
|
/**
|
|
64907
65615
|
* Scripts service.
|
|
64908
65616
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
64909
|
-
* @version
|
|
65617
|
+
* @version 241.0.0
|
|
64910
65618
|
*/
|
|
64911
65619
|
|
|
64912
65620
|
/**
|
|
@@ -65382,7 +66090,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65382
66090
|
/**
|
|
65383
66091
|
* Search service.
|
|
65384
66092
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
65385
|
-
* @version
|
|
66093
|
+
* @version 241.0.0
|
|
65386
66094
|
*/
|
|
65387
66095
|
|
|
65388
66096
|
/**
|
|
@@ -66070,7 +66778,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66070
66778
|
/**
|
|
66071
66779
|
* Settings service.
|
|
66072
66780
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
66073
|
-
* @version
|
|
66781
|
+
* @version 241.0.0
|
|
66074
66782
|
*/
|
|
66075
66783
|
|
|
66076
66784
|
/**
|
|
@@ -66418,7 +67126,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66418
67126
|
/**
|
|
66419
67127
|
* SocialMedia service.
|
|
66420
67128
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
66421
|
-
* @version
|
|
67129
|
+
* @version 241.0.0
|
|
66422
67130
|
*/
|
|
66423
67131
|
|
|
66424
67132
|
/**
|
|
@@ -67320,6 +68028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67320
68028
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
67321
68029
|
* @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.
|
|
67322
68030
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
68031
|
+
* @param {String} opts.name Search for topic by name that contains the given search string, search is case insensitive
|
|
67323
68032
|
*/
|
|
67324
68033
|
getSocialmediaTopics(opts) {
|
|
67325
68034
|
opts = opts || {};
|
|
@@ -67329,7 +68038,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67329
68038
|
'/api/v2/socialmedia/topics',
|
|
67330
68039
|
'GET',
|
|
67331
68040
|
{ },
|
|
67332
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'] },
|
|
68041
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'includeDeleted': opts['includeDeleted'],'name': opts['name'] },
|
|
67333
68042
|
{ },
|
|
67334
68043
|
{ },
|
|
67335
68044
|
null,
|
|
@@ -68013,7 +68722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68013
68722
|
/**
|
|
68014
68723
|
* SpeechTextAnalytics service.
|
|
68015
68724
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
68016
|
-
* @version
|
|
68725
|
+
* @version 241.0.0
|
|
68017
68726
|
*/
|
|
68018
68727
|
|
|
68019
68728
|
/**
|
|
@@ -69660,7 +70369,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69660
70369
|
/**
|
|
69661
70370
|
* Stations service.
|
|
69662
70371
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
69663
|
-
* @version
|
|
70372
|
+
* @version 241.0.0
|
|
69664
70373
|
*/
|
|
69665
70374
|
|
|
69666
70375
|
/**
|
|
@@ -69762,7 +70471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69762
70471
|
/**
|
|
69763
70472
|
* Suggest service.
|
|
69764
70473
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
69765
|
-
* @version
|
|
70474
|
+
* @version 241.0.0
|
|
69766
70475
|
*/
|
|
69767
70476
|
|
|
69768
70477
|
/**
|
|
@@ -69901,7 +70610,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69901
70610
|
/**
|
|
69902
70611
|
* TaskManagement service.
|
|
69903
70612
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
69904
|
-
* @version
|
|
70613
|
+
* @version 241.0.0
|
|
69905
70614
|
*/
|
|
69906
70615
|
|
|
69907
70616
|
/**
|
|
@@ -72063,7 +72772,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72063
72772
|
/**
|
|
72064
72773
|
* Teams service.
|
|
72065
72774
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
72066
|
-
* @version
|
|
72775
|
+
* @version 241.0.0
|
|
72067
72776
|
*/
|
|
72068
72777
|
|
|
72069
72778
|
/**
|
|
@@ -72368,7 +73077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72368
73077
|
/**
|
|
72369
73078
|
* Telephony service.
|
|
72370
73079
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
72371
|
-
* @version
|
|
73080
|
+
* @version 241.0.0
|
|
72372
73081
|
*/
|
|
72373
73082
|
|
|
72374
73083
|
/**
|
|
@@ -72654,7 +73363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72654
73363
|
/**
|
|
72655
73364
|
* TelephonyProvidersEdge service.
|
|
72656
73365
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
72657
|
-
* @version
|
|
73366
|
+
* @version 241.0.0
|
|
72658
73367
|
*/
|
|
72659
73368
|
|
|
72660
73369
|
/**
|
|
@@ -76147,7 +76856,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76147
76856
|
/**
|
|
76148
76857
|
* Textbots service.
|
|
76149
76858
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
76150
|
-
* @version
|
|
76859
|
+
* @version 241.0.0
|
|
76151
76860
|
*/
|
|
76152
76861
|
|
|
76153
76862
|
/**
|
|
@@ -76276,7 +76985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76276
76985
|
/**
|
|
76277
76986
|
* Tokens service.
|
|
76278
76987
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
76279
|
-
* @version
|
|
76988
|
+
* @version 241.0.0
|
|
76280
76989
|
*/
|
|
76281
76990
|
|
|
76282
76991
|
/**
|
|
@@ -76430,7 +77139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76430
77139
|
/**
|
|
76431
77140
|
* Uploads service.
|
|
76432
77141
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
76433
|
-
* @version
|
|
77142
|
+
* @version 241.0.0
|
|
76434
77143
|
*/
|
|
76435
77144
|
|
|
76436
77145
|
/**
|
|
@@ -76721,7 +77430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76721
77430
|
/**
|
|
76722
77431
|
* Usage service.
|
|
76723
77432
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
76724
|
-
* @version
|
|
77433
|
+
* @version 241.0.0
|
|
76725
77434
|
*/
|
|
76726
77435
|
|
|
76727
77436
|
/**
|
|
@@ -77056,7 +77765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77056
77765
|
/**
|
|
77057
77766
|
* UserRecordings service.
|
|
77058
77767
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
77059
|
-
* @version
|
|
77768
|
+
* @version 241.0.0
|
|
77060
77769
|
*/
|
|
77061
77770
|
|
|
77062
77771
|
/**
|
|
@@ -77240,7 +77949,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77240
77949
|
/**
|
|
77241
77950
|
* Users service.
|
|
77242
77951
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
77243
|
-
* @version
|
|
77952
|
+
* @version 241.0.0
|
|
77244
77953
|
*/
|
|
77245
77954
|
|
|
77246
77955
|
/**
|
|
@@ -80249,7 +80958,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80249
80958
|
/**
|
|
80250
80959
|
* UsersRules service.
|
|
80251
80960
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
80252
|
-
* @version
|
|
80961
|
+
* @version 241.0.0
|
|
80253
80962
|
*/
|
|
80254
80963
|
|
|
80255
80964
|
/**
|
|
@@ -80538,7 +81247,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80538
81247
|
/**
|
|
80539
81248
|
* Utilities service.
|
|
80540
81249
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
80541
|
-
* @version
|
|
81250
|
+
* @version 241.0.0
|
|
80542
81251
|
*/
|
|
80543
81252
|
|
|
80544
81253
|
/**
|
|
@@ -80649,7 +81358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80649
81358
|
/**
|
|
80650
81359
|
* Voicemail service.
|
|
80651
81360
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
80652
|
-
* @version
|
|
81361
|
+
* @version 241.0.0
|
|
80653
81362
|
*/
|
|
80654
81363
|
|
|
80655
81364
|
/**
|
|
@@ -81371,7 +82080,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81371
82080
|
/**
|
|
81372
82081
|
* WebChat service.
|
|
81373
82082
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
81374
|
-
* @version
|
|
82083
|
+
* @version 241.0.0
|
|
81375
82084
|
*/
|
|
81376
82085
|
|
|
81377
82086
|
/**
|
|
@@ -81934,7 +82643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81934
82643
|
/**
|
|
81935
82644
|
* WebDeployments service.
|
|
81936
82645
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
81937
|
-
* @version
|
|
82646
|
+
* @version 241.0.0
|
|
81938
82647
|
*/
|
|
81939
82648
|
|
|
81940
82649
|
/**
|
|
@@ -82516,7 +83225,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82516
83225
|
/**
|
|
82517
83226
|
* WebMessaging service.
|
|
82518
83227
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
82519
|
-
* @version
|
|
83228
|
+
* @version 241.0.0
|
|
82520
83229
|
*/
|
|
82521
83230
|
|
|
82522
83231
|
/**
|
|
@@ -82662,7 +83371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82662
83371
|
/**
|
|
82663
83372
|
* Widgets service.
|
|
82664
83373
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
82665
|
-
* @version
|
|
83374
|
+
* @version 241.0.0
|
|
82666
83375
|
*/
|
|
82667
83376
|
|
|
82668
83377
|
/**
|
|
@@ -82813,7 +83522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
82813
83522
|
/**
|
|
82814
83523
|
* WorkforceManagement service.
|
|
82815
83524
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
82816
|
-
* @version
|
|
83525
|
+
* @version 241.0.0
|
|
82817
83526
|
*/
|
|
82818
83527
|
|
|
82819
83528
|
/**
|
|
@@ -90864,7 +91573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
90864
91573
|
* </pre>
|
|
90865
91574
|
* </p>
|
|
90866
91575
|
* @module purecloud-platform-client-v2/index
|
|
90867
|
-
* @version
|
|
91576
|
+
* @version 241.0.0
|
|
90868
91577
|
*/
|
|
90869
91578
|
class platformClient {
|
|
90870
91579
|
constructor() {
|