purecloud-platform-client-v2 169.0.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.
Files changed (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +25367 -20288
  3. package/dist/web-amd/purecloud-platform-client-v2.js +25367 -20288
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +25367 -20288
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +25367 -20288
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +2519 -31
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1418 -227
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +142 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +526 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +114 -1
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +114 -4
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +363 -1
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +224 -1
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +200 -22
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +53 -1
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +189 -1
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +174 -10
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +199 -6
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +80 -2
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1286 -0
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +32 -1
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +34 -3
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +47 -1
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +172 -7
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class RoutingApi {
5
5
  /**
6
6
  * Routing service.
7
7
  * @module purecloud-platform-client-v2/api/RoutingApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -239,7 +239,7 @@ class RoutingApi {
239
239
  *
240
240
  * @param {String} queueId Queue ID
241
241
  * @param {String} memberId Member ID
242
- * @deprecated
242
+ * @deprecated
243
243
  */
244
244
  deleteRoutingQueueUser(queueId, memberId) {
245
245
  // verify the required parameter 'queueId' is set
@@ -460,6 +460,36 @@ class RoutingApi {
460
460
  );
461
461
  }
462
462
 
463
+ /**
464
+ * Delete an utilization tag
465
+ *
466
+ * @param {String} tagId Utilization Tag ID
467
+ * @param {Object} opts Optional parameters
468
+ * @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
469
+ * deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
470
+ */
471
+ deleteRoutingUtilizationTag(tagId, opts) {
472
+ opts = opts || {};
473
+
474
+ // verify the required parameter 'tagId' is set
475
+ if (tagId === undefined || tagId === null) {
476
+ throw 'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';
477
+ }
478
+
479
+ return this.apiClient.callApi(
480
+ '/api/v2/routing/utilization/tags/{tagId}',
481
+ 'DELETE',
482
+ { 'tagId': tagId },
483
+ { 'forceDelete': opts['forceDelete'] },
484
+ { },
485
+ { },
486
+ null,
487
+ ['PureCloud OAuth'],
488
+ ['application/json'],
489
+ ['application/json']
490
+ );
491
+ }
492
+
463
493
  /**
464
494
  * Delete wrap-up code
465
495
  *
@@ -1331,7 +1361,7 @@ class RoutingApi {
1331
1361
  * @param {Array.<String>} opts.languages Filter by language
1332
1362
  * @param {Array.<String>} opts.routingStatus Filter by routing status
1333
1363
  * @param {Array.<String>} opts.presence Filter by presence
1334
- * @deprecated
1364
+ * @deprecated
1335
1365
  */
1336
1366
  getRoutingQueueUsers(queueId, opts) {
1337
1367
  opts = opts || {};
@@ -1919,6 +1949,86 @@ class RoutingApi {
1919
1949
  );
1920
1950
  }
1921
1951
 
1952
+ /**
1953
+ * Get details about this utilization tag
1954
+ *
1955
+ * @param {String} tagId Utilization Tag ID
1956
+ * getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1957
+ */
1958
+ getRoutingUtilizationTag(tagId) {
1959
+ // verify the required parameter 'tagId' is set
1960
+ if (tagId === undefined || tagId === null) {
1961
+ throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';
1962
+ }
1963
+
1964
+ return this.apiClient.callApi(
1965
+ '/api/v2/routing/utilization/tags/{tagId}',
1966
+ 'GET',
1967
+ { 'tagId': tagId },
1968
+ { },
1969
+ { },
1970
+ { },
1971
+ null,
1972
+ ['PureCloud OAuth'],
1973
+ ['application/json'],
1974
+ ['application/json']
1975
+ );
1976
+ }
1977
+
1978
+ /**
1979
+ * Get list of agent ids associated with a utilization tag
1980
+ *
1981
+ * @param {String} tagId Utilization Tag ID
1982
+ * getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1983
+ */
1984
+ getRoutingUtilizationTagAgents(tagId) {
1985
+ // verify the required parameter 'tagId' is set
1986
+ if (tagId === undefined || tagId === null) {
1987
+ throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';
1988
+ }
1989
+
1990
+ return this.apiClient.callApi(
1991
+ '/api/v2/routing/utilization/tags/{tagId}/agents',
1992
+ 'GET',
1993
+ { 'tagId': tagId },
1994
+ { },
1995
+ { },
1996
+ { },
1997
+ null,
1998
+ ['PureCloud OAuth'],
1999
+ ['application/json'],
2000
+ ['application/json']
2001
+ );
2002
+ }
2003
+
2004
+ /**
2005
+ * Get list of utilization tags
2006
+ *
2007
+ * @param {Object} opts Optional parameters
2008
+ * @param {Number} opts.pageSize Page size (default to 25)
2009
+ * @param {Number} opts.pageNumber Page number (default to 1)
2010
+ * @param {Object} opts.sortOrder Sort order by name (default to ascending)
2011
+ * @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
2012
+ * getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2013
+ */
2014
+ getRoutingUtilizationTags(opts) {
2015
+ opts = opts || {};
2016
+
2017
+
2018
+ return this.apiClient.callApi(
2019
+ '/api/v2/routing/utilization/tags',
2020
+ 'GET',
2021
+ { },
2022
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
2023
+ { },
2024
+ { },
2025
+ null,
2026
+ ['PureCloud OAuth'],
2027
+ ['application/json'],
2028
+ ['application/json']
2029
+ );
2030
+ }
2031
+
1922
2032
  /**
1923
2033
  * Get details about this wrap-up code.
1924
2034
  *
@@ -2289,7 +2399,7 @@ class RoutingApi {
2289
2399
  * @param {String} queueId Queue ID
2290
2400
  * @param {String} memberId Member ID
2291
2401
  * @param {Object} body Queue Member
2292
- * @deprecated
2402
+ * @deprecated
2293
2403
  */
2294
2404
  patchRoutingQueueUser(queueId, memberId, body) {
2295
2405
  // verify the required parameter 'queueId' is set
@@ -2324,7 +2434,7 @@ class RoutingApi {
2324
2434
  *
2325
2435
  * @param {String} queueId Queue ID
2326
2436
  * @param {Array.<Object>} body Queue Members
2327
- * @deprecated
2437
+ * @deprecated
2328
2438
  */
2329
2439
  patchRoutingQueueUsers(queueId, body) {
2330
2440
  // verify the required parameter 'queueId' is set
@@ -2594,6 +2704,37 @@ class RoutingApi {
2594
2704
  );
2595
2705
  }
2596
2706
 
2707
+ /**
2708
+ * Query for user activity observations
2709
+ *
2710
+ * @param {Object} body query
2711
+ * @param {Object} opts Optional parameters
2712
+ * @param {Number} opts.pageSize The desired page size
2713
+ * @param {Number} opts.pageNumber The desired page number
2714
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2715
+ */
2716
+ postAnalyticsRoutingActivityQuery(body, opts) {
2717
+ opts = opts || {};
2718
+
2719
+ // verify the required parameter 'body' is set
2720
+ if (body === undefined || body === null) {
2721
+ throw 'Missing the required parameter "body" when calling postAnalyticsRoutingActivityQuery';
2722
+ }
2723
+
2724
+ return this.apiClient.callApi(
2725
+ '/api/v2/analytics/routing/activity/query',
2726
+ 'POST',
2727
+ { },
2728
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
2729
+ { },
2730
+ { },
2731
+ body,
2732
+ ['PureCloud OAuth'],
2733
+ ['application/json'],
2734
+ ['application/json']
2735
+ );
2736
+ }
2737
+
2597
2738
  /**
2598
2739
  * Create a benefit assessment.
2599
2740
  *
@@ -2866,7 +3007,7 @@ class RoutingApi {
2866
3007
  * @param {Array.<Object>} body Queue Members
2867
3008
  * @param {Object} opts Optional parameters
2868
3009
  * @param {Boolean} opts._delete True to delete queue members (default to false)
2869
- * @deprecated
3010
+ * @deprecated
2870
3011
  */
2871
3012
  postRoutingQueueUsers(queueId, body, opts) {
2872
3013
  opts = opts || {};
@@ -3078,6 +3219,58 @@ class RoutingApi {
3078
3219
  );
3079
3220
  }
3080
3221
 
3222
+ /**
3223
+ * Imports a phone number for SMS
3224
+ *
3225
+ * @param {Object} body SmsPhoneNumber
3226
+ * postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3227
+ */
3228
+ postRoutingSmsPhonenumbersImport(body) {
3229
+ // verify the required parameter 'body' is set
3230
+ if (body === undefined || body === null) {
3231
+ throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbersImport';
3232
+ }
3233
+
3234
+ return this.apiClient.callApi(
3235
+ '/api/v2/routing/sms/phonenumbers/import',
3236
+ 'POST',
3237
+ { },
3238
+ { },
3239
+ { },
3240
+ { },
3241
+ body,
3242
+ ['PureCloud OAuth'],
3243
+ ['application/json'],
3244
+ ['application/json']
3245
+ );
3246
+ }
3247
+
3248
+ /**
3249
+ * Create an utilization tag
3250
+ *
3251
+ * @param {Object} body UtilizationTag
3252
+ * postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3253
+ */
3254
+ postRoutingUtilizationTags(body) {
3255
+ // verify the required parameter 'body' is set
3256
+ if (body === undefined || body === null) {
3257
+ throw 'Missing the required parameter "body" when calling postRoutingUtilizationTags';
3258
+ }
3259
+
3260
+ return this.apiClient.callApi(
3261
+ '/api/v2/routing/utilization/tags',
3262
+ 'POST',
3263
+ { },
3264
+ { },
3265
+ { },
3266
+ { },
3267
+ body,
3268
+ ['PureCloud OAuth'],
3269
+ ['application/json'],
3270
+ ['application/json']
3271
+ );
3272
+ }
3273
+
3081
3274
  /**
3082
3275
  * Create a wrap-up code
3083
3276
  *
@@ -5,7 +5,7 @@ class SCIMApi {
5
5
  /**
6
6
  * SCIM service.
7
7
  * @module purecloud-platform-client-v2/api/SCIMApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ScriptsApi {
5
5
  /**
6
6
  * Scripts service.
7
7
  * @module purecloud-platform-client-v2/api/ScriptsApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SearchApi {
5
5
  /**
6
6
  * Search service.
7
7
  * @module purecloud-platform-client-v2/api/SearchApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -297,6 +297,32 @@ class SearchApi {
297
297
  );
298
298
  }
299
299
 
300
+ /**
301
+ * Search all documents
302
+ *
303
+ * @param {Object} body Search request options
304
+ * postDocumentationAllSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
305
+ */
306
+ postDocumentationAllSearch(body) {
307
+ // verify the required parameter 'body' is set
308
+ if (body === undefined || body === null) {
309
+ throw 'Missing the required parameter "body" when calling postDocumentationAllSearch';
310
+ }
311
+
312
+ return this.apiClient.callApi(
313
+ '/api/v2/documentation/all/search',
314
+ 'POST',
315
+ { },
316
+ { },
317
+ { },
318
+ { },
319
+ body,
320
+ ['PureCloud OAuth'],
321
+ ['application/json'],
322
+ ['application/json']
323
+ );
324
+ }
325
+
300
326
  /**
301
327
  * Search gkn documentation
302
328
  *
@@ -378,7 +404,7 @@ class SearchApi {
378
404
  * @param {String} knowledgeBaseId Knowledge base ID
379
405
  * @param {Object} opts Optional parameters
380
406
  * @param {Object} opts.body
381
- * @deprecated
407
+ * @deprecated
382
408
  */
383
409
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
384
410
  opts = opts || {};
@@ -560,6 +586,58 @@ class SearchApi {
560
586
  );
561
587
  }
562
588
 
589
+ /**
590
+ * Search users as conversation targets
591
+ *
592
+ * @param {Object} body Search request options
593
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
594
+ */
595
+ postUsersSearchConversationTarget(body) {
596
+ // verify the required parameter 'body' is set
597
+ if (body === undefined || body === null) {
598
+ throw 'Missing the required parameter "body" when calling postUsersSearchConversationTarget';
599
+ }
600
+
601
+ return this.apiClient.callApi(
602
+ '/api/v2/users/search/conversation/target',
603
+ 'POST',
604
+ { },
605
+ { },
606
+ { },
607
+ { },
608
+ body,
609
+ ['PureCloud OAuth'],
610
+ ['application/json'],
611
+ ['application/json']
612
+ );
613
+ }
614
+
615
+ /**
616
+ * Search manage queue member
617
+ *
618
+ * @param {Object} body Search request options
619
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
620
+ */
621
+ postUsersSearchQueuemembersManage(body) {
622
+ // verify the required parameter 'body' is set
623
+ if (body === undefined || body === null) {
624
+ throw 'Missing the required parameter "body" when calling postUsersSearchQueuemembersManage';
625
+ }
626
+
627
+ return this.apiClient.callApi(
628
+ '/api/v2/users/search/queuemembers/manage',
629
+ 'POST',
630
+ { },
631
+ { },
632
+ { },
633
+ { },
634
+ body,
635
+ ['PureCloud OAuth'],
636
+ ['application/json'],
637
+ ['application/json']
638
+ );
639
+ }
640
+
563
641
  /**
564
642
  * Search users assigned to teams
565
643
  *
@@ -5,7 +5,7 @@ class SpeechTextAnalyticsApi {
5
5
  /**
6
6
  * SpeechTextAnalytics service.
7
7
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class StationsApi {
5
5
  /**
6
6
  * Stations service.
7
7
  * @module purecloud-platform-client-v2/api/StationsApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class SuggestApi {
5
5
  /**
6
6
  * Suggest service.
7
7
  * @module purecloud-platform-client-v2/api/SuggestApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**