purecloud-platform-client-v2 169.1.0 → 170.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +6 -4
- package/dist/node/purecloud-platform-client-v2.js +774 -365
- package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +774 -365
- package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +211 -35
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +44 -44
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +362 -7
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +5 -5
- 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 +9 -9
- 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 +41 -11
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
- 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 +13 -13
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +5 -5
- 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 +50 -46
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -13
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class SearchApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Search service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -301,7 +301,7 @@ class SearchApi {
|
|
|
301
301
|
* Search all documents
|
|
302
302
|
*
|
|
303
303
|
* @param {Object} body Search request options
|
|
304
|
-
*
|
|
304
|
+
* postDocumentationAllSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
305
305
|
*/
|
|
306
306
|
postDocumentationAllSearch(body) {
|
|
307
307
|
// verify the required parameter 'body' is set
|
|
@@ -404,7 +404,7 @@ class SearchApi {
|
|
|
404
404
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
405
405
|
* @param {Object} opts Optional parameters
|
|
406
406
|
* @param {Object} opts.body
|
|
407
|
-
|
|
407
|
+
* @deprecated
|
|
408
408
|
*/
|
|
409
409
|
postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
|
|
410
410
|
opts = opts || {};
|
|
@@ -590,7 +590,7 @@ class SearchApi {
|
|
|
590
590
|
* Search users as conversation targets
|
|
591
591
|
*
|
|
592
592
|
* @param {Object} body Search request options
|
|
593
|
-
*
|
|
593
|
+
* postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
594
594
|
*/
|
|
595
595
|
postUsersSearchConversationTarget(body) {
|
|
596
596
|
// verify the required parameter 'body' is set
|
|
@@ -616,7 +616,7 @@ class SearchApi {
|
|
|
616
616
|
* Search manage queue member
|
|
617
617
|
*
|
|
618
618
|
* @param {Object} body Search request options
|
|
619
|
-
*
|
|
619
|
+
* postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
620
620
|
*/
|
|
621
621
|
postUsersSearchQueuemembersManage(body) {
|
|
622
622
|
// verify the required parameter 'body' is set
|
|
@@ -5,7 +5,7 @@ class TaskManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TaskManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,7 +24,7 @@ class TaskManagementApi {
|
|
|
24
24
|
* Delete a workbin
|
|
25
25
|
*
|
|
26
26
|
* @param {String} workbinId Workbin ID
|
|
27
|
-
*
|
|
27
|
+
* deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
28
|
*/
|
|
29
29
|
deleteTaskmanagementWorkbin(workbinId) {
|
|
30
30
|
// verify the required parameter 'workbinId' is set
|
|
@@ -50,7 +50,7 @@ class TaskManagementApi {
|
|
|
50
50
|
* Delete a workitem
|
|
51
51
|
*
|
|
52
52
|
* @param {String} workitemId Workitem ID
|
|
53
|
-
*
|
|
53
|
+
* deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54
54
|
*/
|
|
55
55
|
deleteTaskmanagementWorkitem(workitemId) {
|
|
56
56
|
// verify the required parameter 'workitemId' is set
|
|
@@ -76,7 +76,7 @@ class TaskManagementApi {
|
|
|
76
76
|
* Delete a schema
|
|
77
77
|
*
|
|
78
78
|
* @param {String} schemaId Schema ID
|
|
79
|
-
*
|
|
79
|
+
* deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80
80
|
*/
|
|
81
81
|
deleteTaskmanagementWorkitemsSchema(schemaId) {
|
|
82
82
|
// verify the required parameter 'schemaId' is set
|
|
@@ -102,7 +102,7 @@ class TaskManagementApi {
|
|
|
102
102
|
* Delete a worktype
|
|
103
103
|
*
|
|
104
104
|
* @param {String} worktypeId Worktype id
|
|
105
|
-
*
|
|
105
|
+
* deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
106
106
|
*/
|
|
107
107
|
deleteTaskmanagementWorktype(worktypeId) {
|
|
108
108
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -129,7 +129,7 @@ class TaskManagementApi {
|
|
|
129
129
|
*
|
|
130
130
|
* @param {String} worktypeId Worktype id
|
|
131
131
|
* @param {String} statusId Status id
|
|
132
|
-
*
|
|
132
|
+
* deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
133
133
|
*/
|
|
134
134
|
deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
135
135
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -159,7 +159,7 @@ class TaskManagementApi {
|
|
|
159
159
|
* Get a workbin
|
|
160
160
|
*
|
|
161
161
|
* @param {String} workbinId Workbin ID
|
|
162
|
-
*
|
|
162
|
+
* getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
163
163
|
*/
|
|
164
164
|
getTaskmanagementWorkbin(workbinId) {
|
|
165
165
|
// verify the required parameter 'workbinId' is set
|
|
@@ -189,7 +189,7 @@ class TaskManagementApi {
|
|
|
189
189
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
190
190
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
191
191
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
192
|
-
*
|
|
192
|
+
* getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
193
193
|
*/
|
|
194
194
|
getTaskmanagementWorkbinHistory(workbinId, opts) {
|
|
195
195
|
opts = opts || {};
|
|
@@ -218,7 +218,7 @@ class TaskManagementApi {
|
|
|
218
218
|
*
|
|
219
219
|
* @param {String} workbinId Workbin ID
|
|
220
220
|
* @param {Number} entityVersion Workbin version
|
|
221
|
-
*
|
|
221
|
+
* getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
222
222
|
*/
|
|
223
223
|
getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
|
|
224
224
|
// verify the required parameter 'workbinId' is set
|
|
@@ -252,7 +252,7 @@ class TaskManagementApi {
|
|
|
252
252
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
253
253
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
254
254
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
255
|
-
*
|
|
255
|
+
* getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
256
256
|
*/
|
|
257
257
|
getTaskmanagementWorkbinVersions(workbinId, opts) {
|
|
258
258
|
opts = opts || {};
|
|
@@ -280,9 +280,13 @@ class TaskManagementApi {
|
|
|
280
280
|
* Get a workitem
|
|
281
281
|
*
|
|
282
282
|
* @param {String} workitemId Workitem ID
|
|
283
|
-
*
|
|
283
|
+
* @param {Object} opts Optional parameters
|
|
284
|
+
* @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
|
|
285
|
+
* getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
284
286
|
*/
|
|
285
|
-
getTaskmanagementWorkitem(workitemId) {
|
|
287
|
+
getTaskmanagementWorkitem(workitemId, opts) {
|
|
288
|
+
opts = opts || {};
|
|
289
|
+
|
|
286
290
|
// verify the required parameter 'workitemId' is set
|
|
287
291
|
if (workitemId === undefined || workitemId === null) {
|
|
288
292
|
throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';
|
|
@@ -292,7 +296,7 @@ class TaskManagementApi {
|
|
|
292
296
|
'/api/v2/taskmanagement/workitems/{workitemId}',
|
|
293
297
|
'GET',
|
|
294
298
|
{ 'workitemId': workitemId },
|
|
295
|
-
{
|
|
299
|
+
{ 'expands': opts['expands'] },
|
|
296
300
|
{ },
|
|
297
301
|
{ },
|
|
298
302
|
null,
|
|
@@ -310,7 +314,7 @@ class TaskManagementApi {
|
|
|
310
314
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
311
315
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
312
316
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
313
|
-
*
|
|
317
|
+
* getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
314
318
|
*/
|
|
315
319
|
getTaskmanagementWorkitemHistory(workitemId, opts) {
|
|
316
320
|
opts = opts || {};
|
|
@@ -344,7 +348,7 @@ class TaskManagementApi {
|
|
|
344
348
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
345
349
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
|
|
346
350
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
347
|
-
*
|
|
351
|
+
* getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
348
352
|
*/
|
|
349
353
|
getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
|
|
350
354
|
opts = opts || {};
|
|
@@ -377,7 +381,7 @@ class TaskManagementApi {
|
|
|
377
381
|
*
|
|
378
382
|
* @param {String} workitemId Workitem ID
|
|
379
383
|
* @param {Number} entityVersion Workitem version
|
|
380
|
-
*
|
|
384
|
+
* getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
381
385
|
*/
|
|
382
386
|
getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
|
|
383
387
|
// verify the required parameter 'workitemId' is set
|
|
@@ -411,7 +415,7 @@ class TaskManagementApi {
|
|
|
411
415
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
412
416
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
413
417
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
414
|
-
*
|
|
418
|
+
* getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
415
419
|
*/
|
|
416
420
|
getTaskmanagementWorkitemVersions(workitemId, opts) {
|
|
417
421
|
opts = opts || {};
|
|
@@ -444,7 +448,7 @@ class TaskManagementApi {
|
|
|
444
448
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
445
449
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 50. (default to 25)
|
|
446
450
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
447
|
-
*
|
|
451
|
+
* getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
448
452
|
*/
|
|
449
453
|
getTaskmanagementWorkitemWrapups(workitemId, opts) {
|
|
450
454
|
opts = opts || {};
|
|
@@ -472,7 +476,7 @@ class TaskManagementApi {
|
|
|
472
476
|
* Get a schema
|
|
473
477
|
*
|
|
474
478
|
* @param {String} schemaId Schema ID
|
|
475
|
-
*
|
|
479
|
+
* getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
476
480
|
*/
|
|
477
481
|
getTaskmanagementWorkitemsSchema(schemaId) {
|
|
478
482
|
// verify the required parameter 'schemaId' is set
|
|
@@ -499,7 +503,7 @@ class TaskManagementApi {
|
|
|
499
503
|
*
|
|
500
504
|
* @param {String} schemaId Schema ID
|
|
501
505
|
* @param {String} versionId Schema version
|
|
502
|
-
*
|
|
506
|
+
* getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
503
507
|
*/
|
|
504
508
|
getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
|
|
505
509
|
// verify the required parameter 'schemaId' is set
|
|
@@ -529,7 +533,7 @@ class TaskManagementApi {
|
|
|
529
533
|
* Get all versions of a schema
|
|
530
534
|
*
|
|
531
535
|
* @param {String} schemaId Schema ID
|
|
532
|
-
*
|
|
536
|
+
* getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
533
537
|
*/
|
|
534
538
|
getTaskmanagementWorkitemsSchemaVersions(schemaId) {
|
|
535
539
|
// verify the required parameter 'schemaId' is set
|
|
@@ -554,7 +558,7 @@ class TaskManagementApi {
|
|
|
554
558
|
/**
|
|
555
559
|
* Get a list of schemas.
|
|
556
560
|
*
|
|
557
|
-
*
|
|
561
|
+
* getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
558
562
|
*/
|
|
559
563
|
getTaskmanagementWorkitemsSchemas() {
|
|
560
564
|
|
|
@@ -578,7 +582,7 @@ class TaskManagementApi {
|
|
|
578
582
|
* @param {String} worktypeId Worktype id
|
|
579
583
|
* @param {Object} opts Optional parameters
|
|
580
584
|
* @param {Array.<String>} opts.expands Which fields, if any, to expand.
|
|
581
|
-
*
|
|
585
|
+
* getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
582
586
|
*/
|
|
583
587
|
getTaskmanagementWorktype(worktypeId, opts) {
|
|
584
588
|
opts = opts || {};
|
|
@@ -610,7 +614,7 @@ class TaskManagementApi {
|
|
|
610
614
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
611
615
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
612
616
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
613
|
-
*
|
|
617
|
+
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
614
618
|
*/
|
|
615
619
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
616
620
|
opts = opts || {};
|
|
@@ -639,7 +643,7 @@ class TaskManagementApi {
|
|
|
639
643
|
*
|
|
640
644
|
* @param {String} worktypeId Worktype id
|
|
641
645
|
* @param {String} statusId Status id
|
|
642
|
-
*
|
|
646
|
+
* getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
643
647
|
*/
|
|
644
648
|
getTaskmanagementWorktypeStatus(worktypeId, statusId) {
|
|
645
649
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -670,7 +674,7 @@ class TaskManagementApi {
|
|
|
670
674
|
*
|
|
671
675
|
* @param {String} worktypeId Worktype id
|
|
672
676
|
* @param {Number} entityVersion Worktype version
|
|
673
|
-
*
|
|
677
|
+
* getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
674
678
|
*/
|
|
675
679
|
getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
|
|
676
680
|
// verify the required parameter 'worktypeId' is set
|
|
@@ -704,7 +708,7 @@ class TaskManagementApi {
|
|
|
704
708
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
705
709
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
706
710
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
707
|
-
*
|
|
711
|
+
* getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
708
712
|
*/
|
|
709
713
|
getTaskmanagementWorktypeVersions(worktypeId, opts) {
|
|
710
714
|
opts = opts || {};
|
|
@@ -733,7 +737,7 @@ class TaskManagementApi {
|
|
|
733
737
|
*
|
|
734
738
|
* @param {String} workbinId Workbin ID
|
|
735
739
|
* @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
|
|
736
|
-
*
|
|
740
|
+
* patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
737
741
|
*/
|
|
738
742
|
patchTaskmanagementWorkbin(workbinId, body) {
|
|
739
743
|
// verify the required parameter 'workbinId' is set
|
|
@@ -764,7 +768,7 @@ class TaskManagementApi {
|
|
|
764
768
|
*
|
|
765
769
|
* @param {String} workitemId Workitem ID
|
|
766
770
|
* @param {Object} body Workitem
|
|
767
|
-
*
|
|
771
|
+
* patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
768
772
|
*/
|
|
769
773
|
patchTaskmanagementWorkitem(workitemId, body) {
|
|
770
774
|
// verify the required parameter 'workitemId' is set
|
|
@@ -795,7 +799,7 @@ class TaskManagementApi {
|
|
|
795
799
|
*
|
|
796
800
|
* @param {String} workitemId Workitem ID
|
|
797
801
|
* @param {Object} body Targeted user
|
|
798
|
-
*
|
|
802
|
+
* patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
799
803
|
*/
|
|
800
804
|
patchTaskmanagementWorkitemAssignment(workitemId, body) {
|
|
801
805
|
// verify the required parameter 'workitemId' is set
|
|
@@ -827,7 +831,7 @@ class TaskManagementApi {
|
|
|
827
831
|
* @param {String} workitemId The ID of the Workitem.
|
|
828
832
|
* @param {String} userId The ID of the user
|
|
829
833
|
* @param {Object} body Request body to add/remove a wrapup code for a workitem
|
|
830
|
-
*
|
|
834
|
+
* patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
831
835
|
*/
|
|
832
836
|
patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
|
|
833
837
|
// verify the required parameter 'workitemId' is set
|
|
@@ -862,7 +866,7 @@ class TaskManagementApi {
|
|
|
862
866
|
*
|
|
863
867
|
* @param {String} workitemId The ID of the Workitem.
|
|
864
868
|
* @param {Object} body Request body to add/remove the wrapup code for workitem
|
|
865
|
-
*
|
|
869
|
+
* patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
866
870
|
*/
|
|
867
871
|
patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
|
|
868
872
|
// verify the required parameter 'workitemId' is set
|
|
@@ -894,7 +898,7 @@ class TaskManagementApi {
|
|
|
894
898
|
* @param {String} worktypeId Worktype id
|
|
895
899
|
* @param {Object} opts Optional parameters
|
|
896
900
|
* @param {Object} opts.body body
|
|
897
|
-
*
|
|
901
|
+
* patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
898
902
|
*/
|
|
899
903
|
patchTaskmanagementWorktype(worktypeId, opts) {
|
|
900
904
|
opts = opts || {};
|
|
@@ -925,7 +929,7 @@ class TaskManagementApi {
|
|
|
925
929
|
* @param {String} statusId Status id
|
|
926
930
|
* @param {Object} opts Optional parameters
|
|
927
931
|
* @param {Object} opts.body body
|
|
928
|
-
*
|
|
932
|
+
* patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
929
933
|
*/
|
|
930
934
|
patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
|
|
931
935
|
opts = opts || {};
|
|
@@ -958,7 +962,7 @@ class TaskManagementApi {
|
|
|
958
962
|
*
|
|
959
963
|
* @param {Object} opts Optional parameters
|
|
960
964
|
* @param {Object} opts.body body
|
|
961
|
-
*
|
|
965
|
+
* postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
962
966
|
*/
|
|
963
967
|
postTaskmanagementWorkbins(opts) {
|
|
964
968
|
opts = opts || {};
|
|
@@ -982,7 +986,7 @@ class TaskManagementApi {
|
|
|
982
986
|
* Query for workbins
|
|
983
987
|
*
|
|
984
988
|
* @param {Object} body QueryPostRequest
|
|
985
|
-
*
|
|
989
|
+
* postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
986
990
|
*/
|
|
987
991
|
postTaskmanagementWorkbinsQuery(body) {
|
|
988
992
|
// verify the required parameter 'body' is set
|
|
@@ -1008,7 +1012,7 @@ class TaskManagementApi {
|
|
|
1008
1012
|
* Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
|
|
1009
1013
|
*
|
|
1010
1014
|
* @param {String} workitemId Workitem ID
|
|
1011
|
-
*
|
|
1015
|
+
* postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1012
1016
|
*/
|
|
1013
1017
|
postTaskmanagementWorkitemAcdCancel(workitemId) {
|
|
1014
1018
|
// verify the required parameter 'workitemId' is set
|
|
@@ -1034,7 +1038,7 @@ class TaskManagementApi {
|
|
|
1034
1038
|
* Disconnect the assignee of the workitem
|
|
1035
1039
|
*
|
|
1036
1040
|
* @param {String} workitemId Workitem ID
|
|
1037
|
-
*
|
|
1041
|
+
* postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1038
1042
|
*/
|
|
1039
1043
|
postTaskmanagementWorkitemDisconnect(workitemId) {
|
|
1040
1044
|
// verify the required parameter 'workitemId' is set
|
|
@@ -1062,7 +1066,7 @@ class TaskManagementApi {
|
|
|
1062
1066
|
* @param {String} workitemId Workitem ID
|
|
1063
1067
|
* @param {Object} opts Optional parameters
|
|
1064
1068
|
* @param {Object} opts.body Terminated request
|
|
1065
|
-
*
|
|
1069
|
+
* postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1066
1070
|
*/
|
|
1067
1071
|
postTaskmanagementWorkitemTerminate(workitemId, opts) {
|
|
1068
1072
|
opts = opts || {};
|
|
@@ -1090,7 +1094,7 @@ class TaskManagementApi {
|
|
|
1090
1094
|
* Create a workitem
|
|
1091
1095
|
*
|
|
1092
1096
|
* @param {Object} body Workitem
|
|
1093
|
-
*
|
|
1097
|
+
* postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1094
1098
|
*/
|
|
1095
1099
|
postTaskmanagementWorkitems(body) {
|
|
1096
1100
|
// verify the required parameter 'body' is set
|
|
@@ -1116,7 +1120,7 @@ class TaskManagementApi {
|
|
|
1116
1120
|
* Query for workitems
|
|
1117
1121
|
* This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
|
|
1118
1122
|
* @param {Object} body WorkitemQueryPostRequest
|
|
1119
|
-
*
|
|
1123
|
+
* postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1120
1124
|
*/
|
|
1121
1125
|
postTaskmanagementWorkitemsQuery(body) {
|
|
1122
1126
|
// verify the required parameter 'body' is set
|
|
@@ -1142,7 +1146,7 @@ class TaskManagementApi {
|
|
|
1142
1146
|
* Create a schema
|
|
1143
1147
|
*
|
|
1144
1148
|
* @param {Object} body Schema
|
|
1145
|
-
*
|
|
1149
|
+
* postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1146
1150
|
*/
|
|
1147
1151
|
postTaskmanagementWorkitemsSchemas(body) {
|
|
1148
1152
|
// verify the required parameter 'body' is set
|
|
@@ -1170,7 +1174,7 @@ class TaskManagementApi {
|
|
|
1170
1174
|
* @param {String} worktypeId Worktype id
|
|
1171
1175
|
* @param {Object} opts Optional parameters
|
|
1172
1176
|
* @param {Object} opts.body body
|
|
1173
|
-
*
|
|
1177
|
+
* postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1174
1178
|
*/
|
|
1175
1179
|
postTaskmanagementWorktypeStatuses(worktypeId, opts) {
|
|
1176
1180
|
opts = opts || {};
|
|
@@ -1199,7 +1203,7 @@ class TaskManagementApi {
|
|
|
1199
1203
|
*
|
|
1200
1204
|
* @param {Object} opts Optional parameters
|
|
1201
1205
|
* @param {Object} opts.body body
|
|
1202
|
-
*
|
|
1206
|
+
* postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1203
1207
|
*/
|
|
1204
1208
|
postTaskmanagementWorktypes(opts) {
|
|
1205
1209
|
opts = opts || {};
|
|
@@ -1223,7 +1227,7 @@ class TaskManagementApi {
|
|
|
1223
1227
|
* Query for worktypes
|
|
1224
1228
|
*
|
|
1225
1229
|
* @param {Object} body QueryPostRequest
|
|
1226
|
-
*
|
|
1230
|
+
* postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1227
1231
|
*/
|
|
1228
1232
|
postTaskmanagementWorktypesQuery(body) {
|
|
1229
1233
|
// verify the required parameter 'body' is set
|
|
@@ -1250,7 +1254,7 @@ class TaskManagementApi {
|
|
|
1250
1254
|
*
|
|
1251
1255
|
* @param {String} schemaId Schema ID
|
|
1252
1256
|
* @param {Object} body Data Schema
|
|
1253
|
-
*
|
|
1257
|
+
* putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1254
1258
|
*/
|
|
1255
1259
|
putTaskmanagementWorkitemsSchema(schemaId, body) {
|
|
1256
1260
|
// verify the required parameter 'schemaId' is set
|
|
@@ -5,7 +5,7 @@ class TeamsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Teams service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -197,7 +197,7 @@ class TeamsApi {
|
|
|
197
197
|
* @param {Object} opts Optional parameters
|
|
198
198
|
* @param {Number} opts.pageSize The desired page size
|
|
199
199
|
* @param {Number} opts.pageNumber The desired page number
|
|
200
|
-
*
|
|
200
|
+
* postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
201
201
|
*/
|
|
202
202
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
203
203
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TelephonyProvidersEdge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1193,7 +1193,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
1193
1193
|
* @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
|
|
1194
1194
|
* @param {String} opts.name Name of the Extension Pools to filter by.
|
|
1195
1195
|
* @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
|
|
1196
|
-
*
|
|
1196
|
+
* getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1197
1197
|
*/
|
|
1198
1198
|
getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
|
|
1199
1199
|
opts = opts || {};
|
|
@@ -1430,7 +1430,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
1430
1430
|
* Get outbound route
|
|
1431
1431
|
* This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
|
|
1432
1432
|
* @param {String} outboundRouteId Outbound route ID
|
|
1433
|
-
|
|
1433
|
+
* @deprecated
|
|
1434
1434
|
*/
|
|
1435
1435
|
getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
|
|
1436
1436
|
// verify the required parameter 'outboundRouteId' is set
|
|
@@ -1626,7 +1626,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
1626
1626
|
* @param {String} opts.phoneHardwareId Filter by phone_hardwareId
|
|
1627
1627
|
* @param {String} opts.linesId Filter by lines.id
|
|
1628
1628
|
* @param {String} opts.linesName Filter by lines.name
|
|
1629
|
-
* @param {String} opts.name Name of the Phone to filter by
|
|
1629
|
+
* @param {String} opts.name Name of the Phone to filter by, comma-separated
|
|
1630
1630
|
* @param {String} opts.statusOperationalStatus The primary status to filter by
|
|
1631
1631
|
* @param {String} opts.secondaryStatusOperationalStatus The secondary status to filter by
|
|
1632
1632
|
* @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
|
|
@@ -5,7 +5,7 @@ class TokensApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Tokens service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 170.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -88,7 +88,7 @@ class TokensApi {
|
|
|
88
88
|
/**
|
|
89
89
|
* Get the current Idle Token Timeout Value
|
|
90
90
|
*
|
|
91
|
-
*
|
|
91
|
+
* getTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
92
92
|
*/
|
|
93
93
|
getTokensTimeout() {
|
|
94
94
|
|
|
@@ -131,7 +131,7 @@ class TokensApi {
|
|
|
131
131
|
*
|
|
132
132
|
* @param {Object} opts Optional parameters
|
|
133
133
|
* @param {Object} opts.body
|
|
134
|
-
*
|
|
134
|
+
* putTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
135
135
|
*/
|
|
136
136
|
putTokensTimeout(opts) {
|
|
137
137
|
opts = opts || {};
|