purecloud-platform-client-v2 238.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 +855 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +855 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +298 -119
- package/dist/web-cjs/purecloud-platform-client-v2.js +298 -119
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +563 -8
- 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 +30 -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 +3 -2
- 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
package/package.json
CHANGED
|
@@ -6,7 +6,7 @@ import { default as qs } from 'qs';
|
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
8
|
* @module purecloud-platform-client-v2/ApiClient
|
|
9
|
-
* @version
|
|
9
|
+
* @version 241.0.0
|
|
10
10
|
*/
|
|
11
11
|
class ApiClient {
|
|
12
12
|
/**
|
|
@@ -381,6 +381,7 @@ class ApiClient {
|
|
|
381
381
|
* @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.
|
|
382
382
|
* @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.
|
|
383
383
|
* @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.
|
|
384
|
+
* @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).
|
|
384
385
|
*/
|
|
385
386
|
loginImplicitGrant(clientId, redirectUri, opts) {
|
|
386
387
|
// Check for auth token in hash
|
|
@@ -422,6 +423,7 @@ class ApiClient {
|
|
|
422
423
|
if (opts.state) query.state = encodeURIComponent(opts.state);
|
|
423
424
|
if (opts.org) query.org = encodeURIComponent(opts.org);
|
|
424
425
|
if (opts.provider) query.provider = encodeURIComponent(opts.provider);
|
|
426
|
+
if (opts.prompt && opts.prompt == 'login') query.prompt = encodeURIComponent(opts.prompt);
|
|
425
427
|
|
|
426
428
|
var url = this._buildAuthUrl('oauth/authorize', query);
|
|
427
429
|
window.location.replace(url);
|
|
@@ -748,6 +750,7 @@ class ApiClient {
|
|
|
748
750
|
* @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.
|
|
749
751
|
* @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.
|
|
750
752
|
* @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.
|
|
753
|
+
* @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).
|
|
751
754
|
* @param {string} codeVerifier - (optional) code verifier used to generate the code challenge
|
|
752
755
|
*/
|
|
753
756
|
loginPKCEGrant(clientId, redirectUri, opts, codeVerifier) {
|
|
@@ -852,6 +855,7 @@ class ApiClient {
|
|
|
852
855
|
if (opts.state) tokenQuery.state = encodeURIComponent(opts.state);
|
|
853
856
|
if (opts.org) tokenQuery.org = encodeURIComponent(opts.org);
|
|
854
857
|
if (opts.provider) tokenQuery.provider = encodeURIComponent(opts.provider);
|
|
858
|
+
if (opts.prompt && opts.prompt == 'login') tokenQuery.prompt = encodeURIComponent(opts.prompt);
|
|
855
859
|
|
|
856
860
|
var url = this._buildAuthUrl('oauth/authorize', tokenQuery);
|
|
857
861
|
window.location.replace(url);
|
|
@@ -5,7 +5,7 @@ class AIStudioApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AIStudio service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 241.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -423,6 +423,41 @@ class AIStudioApi {
|
|
|
423
423
|
);
|
|
424
424
|
}
|
|
425
425
|
|
|
426
|
+
/**
|
|
427
|
+
* Add a turn to a guide session.
|
|
428
|
+
* 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.
|
|
429
|
+
* @param {String} guideId Guide ID
|
|
430
|
+
* @param {String} guideSessionId Guide Session ID
|
|
431
|
+
* @param {Object} body
|
|
432
|
+
*/
|
|
433
|
+
postGuideSessionTurns(guideId, guideSessionId, body) {
|
|
434
|
+
// verify the required parameter 'guideId' is set
|
|
435
|
+
if (guideId === undefined || guideId === null || guideId === '') {
|
|
436
|
+
throw 'Missing the required parameter "guideId" when calling postGuideSessionTurns';
|
|
437
|
+
}
|
|
438
|
+
// verify the required parameter 'guideSessionId' is set
|
|
439
|
+
if (guideSessionId === undefined || guideSessionId === null || guideSessionId === '') {
|
|
440
|
+
throw 'Missing the required parameter "guideSessionId" when calling postGuideSessionTurns';
|
|
441
|
+
}
|
|
442
|
+
// verify the required parameter 'body' is set
|
|
443
|
+
if (body === undefined || body === null) {
|
|
444
|
+
throw 'Missing the required parameter "body" when calling postGuideSessionTurns';
|
|
445
|
+
}
|
|
446
|
+
|
|
447
|
+
return this.apiClient.callApi(
|
|
448
|
+
'/api/v2/guides/{guideId}/sessions/{guideSessionId}/turns',
|
|
449
|
+
'POST',
|
|
450
|
+
{ 'guideId': guideId,'guideSessionId': guideSessionId },
|
|
451
|
+
{ },
|
|
452
|
+
{ },
|
|
453
|
+
{ },
|
|
454
|
+
body,
|
|
455
|
+
['PureCloud OAuth'],
|
|
456
|
+
['application/json'],
|
|
457
|
+
['application/json']
|
|
458
|
+
);
|
|
459
|
+
}
|
|
460
|
+
|
|
426
461
|
/**
|
|
427
462
|
* Start the publishing of a guide version.
|
|
428
463
|
*
|
|
@@ -5,7 +5,7 @@ class AgentAssistantsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* AgentAssistants service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 241.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -104,6 +104,31 @@ class AgentAssistantsApi {
|
|
|
104
104
|
);
|
|
105
105
|
}
|
|
106
106
|
|
|
107
|
+
/**
|
|
108
|
+
* Delete an agent checklist
|
|
109
|
+
*
|
|
110
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
111
|
+
*/
|
|
112
|
+
deleteAssistantsAgentchecklist(agentChecklistId) {
|
|
113
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
114
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
115
|
+
throw 'Missing the required parameter "agentChecklistId" when calling deleteAssistantsAgentchecklist';
|
|
116
|
+
}
|
|
117
|
+
|
|
118
|
+
return this.apiClient.callApi(
|
|
119
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
120
|
+
'DELETE',
|
|
121
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
122
|
+
{ },
|
|
123
|
+
{ },
|
|
124
|
+
{ },
|
|
125
|
+
null,
|
|
126
|
+
['PureCloud OAuth'],
|
|
127
|
+
['application/json'],
|
|
128
|
+
['application/json']
|
|
129
|
+
);
|
|
130
|
+
}
|
|
131
|
+
|
|
107
132
|
/**
|
|
108
133
|
* Get an assistant.
|
|
109
134
|
*
|
|
@@ -228,6 +253,81 @@ class AgentAssistantsApi {
|
|
|
228
253
|
);
|
|
229
254
|
}
|
|
230
255
|
|
|
256
|
+
/**
|
|
257
|
+
* Get an agent checklist
|
|
258
|
+
*
|
|
259
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
260
|
+
*/
|
|
261
|
+
getAssistantsAgentchecklist(agentChecklistId) {
|
|
262
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
263
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
264
|
+
throw 'Missing the required parameter "agentChecklistId" when calling getAssistantsAgentchecklist';
|
|
265
|
+
}
|
|
266
|
+
|
|
267
|
+
return this.apiClient.callApi(
|
|
268
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
269
|
+
'GET',
|
|
270
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
271
|
+
{ },
|
|
272
|
+
{ },
|
|
273
|
+
{ },
|
|
274
|
+
null,
|
|
275
|
+
['PureCloud OAuth'],
|
|
276
|
+
['application/json'],
|
|
277
|
+
['application/json']
|
|
278
|
+
);
|
|
279
|
+
}
|
|
280
|
+
|
|
281
|
+
/**
|
|
282
|
+
* Get the list of agent checklists
|
|
283
|
+
*
|
|
284
|
+
* @param {Object} opts Optional parameters
|
|
285
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
286
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
287
|
+
* @param {String} opts.pageSize The page size for the listing. The max that will be returned is 100. (default to 25)
|
|
288
|
+
* @param {String} opts.namePrefix The agent checklist name prefix filter applied to the listing.
|
|
289
|
+
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
290
|
+
* @param {Object} opts.sortOrder The sort order for the listing
|
|
291
|
+
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
292
|
+
*/
|
|
293
|
+
getAssistantsAgentchecklists(opts) {
|
|
294
|
+
opts = opts || {};
|
|
295
|
+
|
|
296
|
+
|
|
297
|
+
return this.apiClient.callApi(
|
|
298
|
+
'/api/v2/assistants/agentchecklists',
|
|
299
|
+
'GET',
|
|
300
|
+
{ },
|
|
301
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
302
|
+
{ },
|
|
303
|
+
{ },
|
|
304
|
+
null,
|
|
305
|
+
['PureCloud OAuth'],
|
|
306
|
+
['application/json'],
|
|
307
|
+
['application/json']
|
|
308
|
+
);
|
|
309
|
+
}
|
|
310
|
+
|
|
311
|
+
/**
|
|
312
|
+
* Get the list of supported languages
|
|
313
|
+
*
|
|
314
|
+
*/
|
|
315
|
+
getAssistantsAgentchecklistsLanguages() {
|
|
316
|
+
|
|
317
|
+
return this.apiClient.callApi(
|
|
318
|
+
'/api/v2/assistants/agentchecklists/languages',
|
|
319
|
+
'GET',
|
|
320
|
+
{ },
|
|
321
|
+
{ },
|
|
322
|
+
{ },
|
|
323
|
+
{ },
|
|
324
|
+
null,
|
|
325
|
+
['PureCloud OAuth'],
|
|
326
|
+
['application/json'],
|
|
327
|
+
['application/json']
|
|
328
|
+
);
|
|
329
|
+
}
|
|
330
|
+
|
|
231
331
|
/**
|
|
232
332
|
* Get all queues assigned to any assistant.
|
|
233
333
|
*
|
|
@@ -450,6 +550,31 @@ class AgentAssistantsApi {
|
|
|
450
550
|
);
|
|
451
551
|
}
|
|
452
552
|
|
|
553
|
+
/**
|
|
554
|
+
* Create an agent checklist
|
|
555
|
+
*
|
|
556
|
+
* @param {Object} body Request body containing details of checklist to be added
|
|
557
|
+
*/
|
|
558
|
+
postAssistantsAgentchecklists(body) {
|
|
559
|
+
// verify the required parameter 'body' is set
|
|
560
|
+
if (body === undefined || body === null) {
|
|
561
|
+
throw 'Missing the required parameter "body" when calling postAssistantsAgentchecklists';
|
|
562
|
+
}
|
|
563
|
+
|
|
564
|
+
return this.apiClient.callApi(
|
|
565
|
+
'/api/v2/assistants/agentchecklists',
|
|
566
|
+
'POST',
|
|
567
|
+
{ },
|
|
568
|
+
{ },
|
|
569
|
+
{ },
|
|
570
|
+
{ },
|
|
571
|
+
body,
|
|
572
|
+
['PureCloud OAuth'],
|
|
573
|
+
['application/json'],
|
|
574
|
+
['application/json']
|
|
575
|
+
);
|
|
576
|
+
}
|
|
577
|
+
|
|
453
578
|
/**
|
|
454
579
|
* Create a queue assistant association.
|
|
455
580
|
*
|
|
@@ -485,6 +610,36 @@ class AgentAssistantsApi {
|
|
|
485
610
|
);
|
|
486
611
|
}
|
|
487
612
|
|
|
613
|
+
/**
|
|
614
|
+
* Update an agent checklist
|
|
615
|
+
*
|
|
616
|
+
* @param {String} agentChecklistId Agent Checklist ID
|
|
617
|
+
* @param {Object} body Request body containing details of checklist to be updated
|
|
618
|
+
*/
|
|
619
|
+
putAssistantsAgentchecklist(agentChecklistId, body) {
|
|
620
|
+
// verify the required parameter 'agentChecklistId' is set
|
|
621
|
+
if (agentChecklistId === undefined || agentChecklistId === null || agentChecklistId === '') {
|
|
622
|
+
throw 'Missing the required parameter "agentChecklistId" when calling putAssistantsAgentchecklist';
|
|
623
|
+
}
|
|
624
|
+
// verify the required parameter 'body' is set
|
|
625
|
+
if (body === undefined || body === null) {
|
|
626
|
+
throw 'Missing the required parameter "body" when calling putAssistantsAgentchecklist';
|
|
627
|
+
}
|
|
628
|
+
|
|
629
|
+
return this.apiClient.callApi(
|
|
630
|
+
'/api/v2/assistants/agentchecklists/{agentChecklistId}',
|
|
631
|
+
'PUT',
|
|
632
|
+
{ 'agentChecklistId': agentChecklistId },
|
|
633
|
+
{ },
|
|
634
|
+
{ },
|
|
635
|
+
{ },
|
|
636
|
+
body,
|
|
637
|
+
['PureCloud OAuth'],
|
|
638
|
+
['application/json'],
|
|
639
|
+
['application/json']
|
|
640
|
+
);
|
|
641
|
+
}
|
|
642
|
+
|
|
488
643
|
}
|
|
489
644
|
|
|
490
645
|
|
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 241.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -98,6 +98,32 @@ class AnalyticsApi {
|
|
|
98
98
|
);
|
|
99
99
|
}
|
|
100
100
|
|
|
101
|
+
/**
|
|
102
|
+
* Delete/cancel an async request for case management aggregates
|
|
103
|
+
*
|
|
104
|
+
* @param {String} jobId jobId
|
|
105
|
+
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
106
|
+
*/
|
|
107
|
+
deleteAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
108
|
+
// verify the required parameter 'jobId' is set
|
|
109
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
110
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCasemanagementAggregatesJob';
|
|
111
|
+
}
|
|
112
|
+
|
|
113
|
+
return this.apiClient.callApi(
|
|
114
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
|
|
115
|
+
'DELETE',
|
|
116
|
+
{ 'jobId': jobId },
|
|
117
|
+
{ },
|
|
118
|
+
{ },
|
|
119
|
+
{ },
|
|
120
|
+
null,
|
|
121
|
+
['PureCloud OAuth'],
|
|
122
|
+
['application/json'],
|
|
123
|
+
['application/json']
|
|
124
|
+
);
|
|
125
|
+
}
|
|
126
|
+
|
|
101
127
|
/**
|
|
102
128
|
* Delete/cancel an async request for conversation aggregates
|
|
103
129
|
*
|
|
@@ -757,6 +783,62 @@ class AnalyticsApi {
|
|
|
757
783
|
);
|
|
758
784
|
}
|
|
759
785
|
|
|
786
|
+
/**
|
|
787
|
+
* Get status for async query for case management aggregates
|
|
788
|
+
*
|
|
789
|
+
* @param {String} jobId jobId
|
|
790
|
+
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
791
|
+
*/
|
|
792
|
+
getAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
793
|
+
// verify the required parameter 'jobId' is set
|
|
794
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
795
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJob';
|
|
796
|
+
}
|
|
797
|
+
|
|
798
|
+
return this.apiClient.callApi(
|
|
799
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}',
|
|
800
|
+
'GET',
|
|
801
|
+
{ 'jobId': jobId },
|
|
802
|
+
{ },
|
|
803
|
+
{ },
|
|
804
|
+
{ },
|
|
805
|
+
null,
|
|
806
|
+
['PureCloud OAuth'],
|
|
807
|
+
['application/json'],
|
|
808
|
+
['application/json']
|
|
809
|
+
);
|
|
810
|
+
}
|
|
811
|
+
|
|
812
|
+
/**
|
|
813
|
+
* Fetch a page of results for an async case management query
|
|
814
|
+
*
|
|
815
|
+
* @param {String} jobId jobId
|
|
816
|
+
* @param {Object} opts Optional parameters
|
|
817
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
818
|
+
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
819
|
+
*/
|
|
820
|
+
getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
|
|
821
|
+
opts = opts || {};
|
|
822
|
+
|
|
823
|
+
// verify the required parameter 'jobId' is set
|
|
824
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
825
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJobResults';
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
return this.apiClient.callApi(
|
|
829
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs/{jobId}/results',
|
|
830
|
+
'GET',
|
|
831
|
+
{ 'jobId': jobId },
|
|
832
|
+
{ 'cursor': opts['cursor'] },
|
|
833
|
+
{ },
|
|
834
|
+
{ },
|
|
835
|
+
null,
|
|
836
|
+
['PureCloud OAuth'],
|
|
837
|
+
['application/json'],
|
|
838
|
+
['application/json']
|
|
839
|
+
);
|
|
840
|
+
}
|
|
841
|
+
|
|
760
842
|
/**
|
|
761
843
|
* Get a conversation by id
|
|
762
844
|
*
|
|
@@ -2124,6 +2206,58 @@ class AnalyticsApi {
|
|
|
2124
2206
|
);
|
|
2125
2207
|
}
|
|
2126
2208
|
|
|
2209
|
+
/**
|
|
2210
|
+
* Query for case management aggregates asynchronously
|
|
2211
|
+
*
|
|
2212
|
+
* @param {Object} body query
|
|
2213
|
+
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2214
|
+
*/
|
|
2215
|
+
postAnalyticsCasemanagementAggregatesJobs(body) {
|
|
2216
|
+
// verify the required parameter 'body' is set
|
|
2217
|
+
if (body === undefined || body === null) {
|
|
2218
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesJobs';
|
|
2219
|
+
}
|
|
2220
|
+
|
|
2221
|
+
return this.apiClient.callApi(
|
|
2222
|
+
'/api/v2/analytics/casemanagement/aggregates/jobs',
|
|
2223
|
+
'POST',
|
|
2224
|
+
{ },
|
|
2225
|
+
{ },
|
|
2226
|
+
{ },
|
|
2227
|
+
{ },
|
|
2228
|
+
body,
|
|
2229
|
+
['PureCloud OAuth'],
|
|
2230
|
+
['application/json'],
|
|
2231
|
+
['application/json']
|
|
2232
|
+
);
|
|
2233
|
+
}
|
|
2234
|
+
|
|
2235
|
+
/**
|
|
2236
|
+
* Query for case management aggregates
|
|
2237
|
+
*
|
|
2238
|
+
* @param {Object} body query
|
|
2239
|
+
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2240
|
+
*/
|
|
2241
|
+
postAnalyticsCasemanagementAggregatesQuery(body) {
|
|
2242
|
+
// verify the required parameter 'body' is set
|
|
2243
|
+
if (body === undefined || body === null) {
|
|
2244
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesQuery';
|
|
2245
|
+
}
|
|
2246
|
+
|
|
2247
|
+
return this.apiClient.callApi(
|
|
2248
|
+
'/api/v2/analytics/casemanagement/aggregates/query',
|
|
2249
|
+
'POST',
|
|
2250
|
+
{ },
|
|
2251
|
+
{ },
|
|
2252
|
+
{ },
|
|
2253
|
+
{ },
|
|
2254
|
+
body,
|
|
2255
|
+
['PureCloud OAuth'],
|
|
2256
|
+
['application/json'],
|
|
2257
|
+
['application/json']
|
|
2258
|
+
);
|
|
2259
|
+
}
|
|
2260
|
+
|
|
2127
2261
|
/**
|
|
2128
2262
|
* Index conversation properties
|
|
2129
2263
|
*
|
|
@@ -5,7 +5,7 @@ class AuthorizationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Authorization service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 241.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -54,7 +54,6 @@ class AuthorizationApi {
|
|
|
54
54
|
*
|
|
55
55
|
* @param {String} targetName The domain:entity:action target to which the policy is applied
|
|
56
56
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
57
|
-
* deleteAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58
57
|
*/
|
|
59
58
|
deleteAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
60
59
|
// verify the required parameter 'targetName' is set
|
|
@@ -453,7 +452,6 @@ class AuthorizationApi {
|
|
|
453
452
|
* @param {Object} opts Optional parameters
|
|
454
453
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
455
454
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
456
|
-
* getAuthorizationPolicies is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
457
455
|
*/
|
|
458
456
|
getAuthorizationPolicies(opts) {
|
|
459
457
|
opts = opts || {};
|
|
@@ -480,7 +478,6 @@ class AuthorizationApi {
|
|
|
480
478
|
* @param {Object} opts Optional parameters
|
|
481
479
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
482
480
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
483
|
-
* getAuthorizationPoliciesSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
484
481
|
*/
|
|
485
482
|
getAuthorizationPoliciesSubjectSubjectId(subjectId, opts) {
|
|
486
483
|
opts = opts || {};
|
|
@@ -511,7 +508,6 @@ class AuthorizationApi {
|
|
|
511
508
|
* @param {Object} opts Optional parameters
|
|
512
509
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
513
510
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
514
|
-
* getAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
515
511
|
*/
|
|
516
512
|
getAuthorizationPoliciesTarget(targetName, opts) {
|
|
517
513
|
opts = opts || {};
|
|
@@ -540,7 +536,6 @@ class AuthorizationApi {
|
|
|
540
536
|
*
|
|
541
537
|
* @param {String} targetName The domain:entity:action resource target to which the policy is applied
|
|
542
538
|
* @param {String} subjectId The ID of the subject to which the policy is applied
|
|
543
|
-
* getAuthorizationPoliciesTargetSubjectSubjectId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
544
539
|
*/
|
|
545
540
|
getAuthorizationPoliciesTargetSubjectSubjectId(targetName, subjectId) {
|
|
546
541
|
// verify the required parameter 'targetName' is set
|
|
@@ -569,7 +564,6 @@ class AuthorizationApi {
|
|
|
569
564
|
/**
|
|
570
565
|
* Get a map of policy targets to valid attributes for those targets
|
|
571
566
|
*
|
|
572
|
-
* getAuthorizationPoliciesTargets is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
573
567
|
*/
|
|
574
568
|
getAuthorizationPoliciesTargets() {
|
|
575
569
|
|
|
@@ -591,7 +585,6 @@ class AuthorizationApi {
|
|
|
591
585
|
* Get an access control policy with the specified policy ID
|
|
592
586
|
*
|
|
593
587
|
* @param {String} policyId The ID of the policy to retrieve
|
|
594
|
-
* getAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
595
588
|
*/
|
|
596
589
|
getAuthorizationPolicy(policyId) {
|
|
597
590
|
// verify the required parameter 'policyId' is set
|
|
@@ -617,7 +610,6 @@ class AuthorizationApi {
|
|
|
617
610
|
* Get the list of attributes used to evaluate an access control policy with the specified policy ID
|
|
618
611
|
*
|
|
619
612
|
* @param {String} policyId The ID of the policy to retrieve attributes
|
|
620
|
-
* getAuthorizationPolicyAttributes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
621
613
|
*/
|
|
622
614
|
getAuthorizationPolicyAttributes(policyId) {
|
|
623
615
|
// verify the required parameter 'policyId' is set
|
|
@@ -1109,7 +1101,6 @@ class AuthorizationApi {
|
|
|
1109
1101
|
*
|
|
1110
1102
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
1111
1103
|
* @param {Object} body Access control policy
|
|
1112
|
-
* postAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1113
1104
|
*/
|
|
1114
1105
|
postAuthorizationPoliciesTarget(targetName, body) {
|
|
1115
1106
|
// verify the required parameter 'targetName' is set
|
|
@@ -1140,7 +1131,6 @@ class AuthorizationApi {
|
|
|
1140
1131
|
*
|
|
1141
1132
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
1142
1133
|
* @param {Object} body Access control policy
|
|
1143
|
-
* postAuthorizationPoliciesTargetValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1144
1134
|
*/
|
|
1145
1135
|
postAuthorizationPoliciesTargetValidate(targetName, body) {
|
|
1146
1136
|
// verify the required parameter 'targetName' is set
|
|
@@ -1171,7 +1161,6 @@ class AuthorizationApi {
|
|
|
1171
1161
|
*
|
|
1172
1162
|
* @param {String} policyId The ID of the policy to test the simulated data against
|
|
1173
1163
|
* @param {Object} body A map of attribute names to type and simulated data value
|
|
1174
|
-
* postAuthorizationPolicySimulate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1175
1164
|
*/
|
|
1176
1165
|
postAuthorizationPolicySimulate(policyId, body) {
|
|
1177
1166
|
// verify the required parameter 'policyId' is set
|
|
@@ -1487,7 +1476,6 @@ class AuthorizationApi {
|
|
|
1487
1476
|
*
|
|
1488
1477
|
* @param {String} targetName The domain:entity:action target to which the policy will be applied
|
|
1489
1478
|
* @param {Object} body Access control policy
|
|
1490
|
-
* putAuthorizationPoliciesTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1491
1479
|
*/
|
|
1492
1480
|
putAuthorizationPoliciesTarget(targetName, body) {
|
|
1493
1481
|
// verify the required parameter 'targetName' is set
|
|
@@ -1518,7 +1506,6 @@ class AuthorizationApi {
|
|
|
1518
1506
|
*
|
|
1519
1507
|
* @param {String} policyId The ID of the policy to update
|
|
1520
1508
|
* @param {Object} body Access control policy
|
|
1521
|
-
* putAuthorizationPolicy is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1522
1509
|
*/
|
|
1523
1510
|
putAuthorizationPolicy(policyId, body) {
|
|
1524
1511
|
// verify the required parameter 'policyId' is set
|