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.
Files changed (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +774 -365
  3. package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +774 -365
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +211 -35
  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 +44 -44
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
  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 +362 -7
  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 +5 -5
  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 +9 -9
  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 +41 -11
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
  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 +3 -3
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
  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 +13 -13
  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 +5 -5
  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 +50 -46
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -3
  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 +13 -13
  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 +1 -1
@@ -5,7 +5,7 @@ class AnalyticsApi {
5
5
  /**
6
6
  * Analytics service.
7
7
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -99,7 +99,7 @@ class AnalyticsApi {
99
99
  * Get status for async query for action aggregates
100
100
  *
101
101
  * @param {String} jobId jobId
102
- * Preview Endpoint
102
+ * getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
103
103
  */
104
104
  getAnalyticsActionsAggregatesJob(jobId) {
105
105
  // verify the required parameter 'jobId' is set
@@ -127,7 +127,7 @@ class AnalyticsApi {
127
127
  * @param {String} jobId jobId
128
128
  * @param {Object} opts Optional parameters
129
129
  * @param {String} opts.cursor Cursor token to retrieve next page
130
- * Preview Endpoint
130
+ * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
131
131
  */
132
132
  getAnalyticsActionsAggregatesJobResults(jobId, opts) {
133
133
  opts = opts || {};
@@ -189,7 +189,7 @@ class AnalyticsApi {
189
189
  * Get status for async query for bot aggregates
190
190
  *
191
191
  * @param {String} jobId jobId
192
- * Preview Endpoint
192
+ * getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
193
193
  */
194
194
  getAnalyticsBotsAggregatesJob(jobId) {
195
195
  // verify the required parameter 'jobId' is set
@@ -217,7 +217,7 @@ class AnalyticsApi {
217
217
  * @param {String} jobId jobId
218
218
  * @param {Object} opts Optional parameters
219
219
  * @param {String} opts.cursor Cursor token to retrieve next page
220
- * Preview Endpoint
220
+ * getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
221
221
  */
222
222
  getAnalyticsBotsAggregatesJobResults(jobId, opts) {
223
223
  opts = opts || {};
@@ -270,7 +270,7 @@ class AnalyticsApi {
270
270
  * Get status for async query for conversation aggregates
271
271
  *
272
272
  * @param {String} jobId jobId
273
- * Preview Endpoint
273
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
274
274
  */
275
275
  getAnalyticsConversationsAggregatesJob(jobId) {
276
276
  // verify the required parameter 'jobId' is set
@@ -298,7 +298,7 @@ class AnalyticsApi {
298
298
  * @param {String} jobId jobId
299
299
  * @param {Object} opts Optional parameters
300
300
  * @param {String} opts.cursor Cursor token to retrieve next page
301
- * Preview Endpoint
301
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
302
302
  */
303
303
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
304
304
  opts = opts || {};
@@ -445,7 +445,7 @@ class AnalyticsApi {
445
445
  * Get status for async query for evaluation aggregates
446
446
  *
447
447
  * @param {String} jobId jobId
448
- * Preview Endpoint
448
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
449
449
  */
450
450
  getAnalyticsEvaluationsAggregatesJob(jobId) {
451
451
  // verify the required parameter 'jobId' is set
@@ -473,7 +473,7 @@ class AnalyticsApi {
473
473
  * @param {String} jobId jobId
474
474
  * @param {Object} opts Optional parameters
475
475
  * @param {String} opts.cursor Cursor token to retrieve next page
476
- * Preview Endpoint
476
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
477
477
  */
478
478
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
479
479
  opts = opts || {};
@@ -501,7 +501,7 @@ class AnalyticsApi {
501
501
  * Get status for async query for Flow aggregates
502
502
  *
503
503
  * @param {String} jobId jobId
504
- * Preview Endpoint
504
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
505
505
  */
506
506
  getAnalyticsFlowsAggregatesJob(jobId) {
507
507
  // verify the required parameter 'jobId' is set
@@ -529,7 +529,7 @@ class AnalyticsApi {
529
529
  * @param {String} jobId jobId
530
530
  * @param {Object} opts Optional parameters
531
531
  * @param {String} opts.cursor Cursor token to retrieve next page
532
- * Preview Endpoint
532
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
533
533
  */
534
534
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
535
535
  opts = opts || {};
@@ -557,7 +557,7 @@ class AnalyticsApi {
557
557
  * Get status for async query for journey aggregates
558
558
  *
559
559
  * @param {String} jobId jobId
560
- * Preview Endpoint
560
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
561
561
  */
562
562
  getAnalyticsJourneysAggregatesJob(jobId) {
563
563
  // verify the required parameter 'jobId' is set
@@ -585,7 +585,7 @@ class AnalyticsApi {
585
585
  * @param {String} jobId jobId
586
586
  * @param {Object} opts Optional parameters
587
587
  * @param {String} opts.cursor Cursor token to retrieve next page
588
- * Preview Endpoint
588
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
589
589
  */
590
590
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
591
591
  opts = opts || {};
@@ -613,7 +613,7 @@ class AnalyticsApi {
613
613
  * Get status for async query for knowledge aggregates
614
614
  *
615
615
  * @param {String} jobId jobId
616
- * Preview Endpoint
616
+ * getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
617
617
  */
618
618
  getAnalyticsKnowledgeAggregatesJob(jobId) {
619
619
  // verify the required parameter 'jobId' is set
@@ -641,7 +641,7 @@ class AnalyticsApi {
641
641
  * @param {String} jobId jobId
642
642
  * @param {Object} opts Optional parameters
643
643
  * @param {String} opts.cursor Cursor token to retrieve next page
644
- * Preview Endpoint
644
+ * getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
645
645
  */
646
646
  getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
647
647
  opts = opts || {};
@@ -964,7 +964,7 @@ class AnalyticsApi {
964
964
  * Get status for async query for resolution aggregates
965
965
  *
966
966
  * @param {String} jobId jobId
967
- * Preview Endpoint
967
+ * getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
968
968
  */
969
969
  getAnalyticsResolutionsAggregatesJob(jobId) {
970
970
  // verify the required parameter 'jobId' is set
@@ -992,7 +992,7 @@ class AnalyticsApi {
992
992
  * @param {String} jobId jobId
993
993
  * @param {Object} opts Optional parameters
994
994
  * @param {String} opts.cursor Cursor token to retrieve next page
995
- * Preview Endpoint
995
+ * getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
996
996
  */
997
997
  getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
998
998
  opts = opts || {};
@@ -1020,7 +1020,7 @@ class AnalyticsApi {
1020
1020
  * Get status for async query for survey aggregates
1021
1021
  *
1022
1022
  * @param {String} jobId jobId
1023
- * Preview Endpoint
1023
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1024
1024
  */
1025
1025
  getAnalyticsSurveysAggregatesJob(jobId) {
1026
1026
  // verify the required parameter 'jobId' is set
@@ -1048,7 +1048,7 @@ class AnalyticsApi {
1048
1048
  * @param {String} jobId jobId
1049
1049
  * @param {Object} opts Optional parameters
1050
1050
  * @param {String} opts.cursor Cursor token to retrieve next page
1051
- * Preview Endpoint
1051
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1052
1052
  */
1053
1053
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
1054
1054
  opts = opts || {};
@@ -1076,7 +1076,7 @@ class AnalyticsApi {
1076
1076
  * Get status for async query for task management aggregates
1077
1077
  *
1078
1078
  * @param {String} jobId jobId
1079
- * Preview Endpoint
1079
+ * getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1080
1080
  */
1081
1081
  getAnalyticsTaskmanagementAggregatesJob(jobId) {
1082
1082
  // verify the required parameter 'jobId' is set
@@ -1104,7 +1104,7 @@ class AnalyticsApi {
1104
1104
  * @param {String} jobId jobId
1105
1105
  * @param {Object} opts Optional parameters
1106
1106
  * @param {String} opts.cursor Cursor token to retrieve next page
1107
- * Preview Endpoint
1107
+ * getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1108
1108
  */
1109
1109
  getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
1110
1110
  opts = opts || {};
@@ -1132,7 +1132,7 @@ class AnalyticsApi {
1132
1132
  * Get status for async query for transcript aggregates
1133
1133
  *
1134
1134
  * @param {String} jobId jobId
1135
- * Preview Endpoint
1135
+ * getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1136
1136
  */
1137
1137
  getAnalyticsTranscriptsAggregatesJob(jobId) {
1138
1138
  // verify the required parameter 'jobId' is set
@@ -1160,7 +1160,7 @@ class AnalyticsApi {
1160
1160
  * @param {String} jobId jobId
1161
1161
  * @param {Object} opts Optional parameters
1162
1162
  * @param {String} opts.cursor Cursor token to retrieve next page
1163
- * Preview Endpoint
1163
+ * getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1164
1164
  */
1165
1165
  getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
1166
1166
  opts = opts || {};
@@ -1188,7 +1188,7 @@ class AnalyticsApi {
1188
1188
  * Get status for async query for user aggregates
1189
1189
  *
1190
1190
  * @param {String} jobId jobId
1191
- * Preview Endpoint
1191
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1192
1192
  */
1193
1193
  getAnalyticsUsersAggregatesJob(jobId) {
1194
1194
  // verify the required parameter 'jobId' is set
@@ -1216,7 +1216,7 @@ class AnalyticsApi {
1216
1216
  * @param {String} jobId jobId
1217
1217
  * @param {Object} opts Optional parameters
1218
1218
  * @param {String} opts.cursor Cursor token to retrieve next page
1219
- * Preview Endpoint
1219
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1220
1220
  */
1221
1221
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
1222
1222
  opts = opts || {};
@@ -1344,7 +1344,7 @@ class AnalyticsApi {
1344
1344
  * Query for action aggregates asynchronously
1345
1345
  *
1346
1346
  * @param {Object} body query
1347
- * Preview Endpoint
1347
+ * postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1348
1348
  */
1349
1349
  postAnalyticsActionsAggregatesJobs(body) {
1350
1350
  // verify the required parameter 'body' is set
@@ -1395,7 +1395,7 @@ class AnalyticsApi {
1395
1395
  * Query for bot aggregates asynchronously
1396
1396
  *
1397
1397
  * @param {Object} body query
1398
- * Preview Endpoint
1398
+ * postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1399
1399
  */
1400
1400
  postAnalyticsBotsAggregatesJobs(body) {
1401
1401
  // verify the required parameter 'body' is set
@@ -1479,7 +1479,7 @@ class AnalyticsApi {
1479
1479
  * @param {Object} opts Optional parameters
1480
1480
  * @param {Number} opts.pageSize The desired page size
1481
1481
  * @param {Number} opts.pageNumber The desired page number
1482
- * Preview Endpoint
1482
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1483
1483
  */
1484
1484
  postAnalyticsConversationsActivityQuery(body, opts) {
1485
1485
  opts = opts || {};
@@ -1507,7 +1507,7 @@ class AnalyticsApi {
1507
1507
  * Query for conversation aggregates asynchronously
1508
1508
  *
1509
1509
  * @param {Object} body query
1510
- * Preview Endpoint
1510
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1511
1511
  */
1512
1512
  postAnalyticsConversationsAggregatesJobs(body) {
1513
1513
  // verify the required parameter 'body' is set
@@ -1633,7 +1633,7 @@ class AnalyticsApi {
1633
1633
  * Query for evaluation aggregates asynchronously
1634
1634
  *
1635
1635
  * @param {Object} body query
1636
- * Preview Endpoint
1636
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1637
1637
  */
1638
1638
  postAnalyticsEvaluationsAggregatesJobs(body) {
1639
1639
  // verify the required parameter 'body' is set
@@ -1687,7 +1687,7 @@ class AnalyticsApi {
1687
1687
  * @param {Object} opts Optional parameters
1688
1688
  * @param {Number} opts.pageSize The desired page size
1689
1689
  * @param {Number} opts.pageNumber The desired page number
1690
- * Preview Endpoint
1690
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1691
1691
  */
1692
1692
  postAnalyticsFlowsActivityQuery(body, opts) {
1693
1693
  opts = opts || {};
@@ -1715,7 +1715,7 @@ class AnalyticsApi {
1715
1715
  * Query for flow aggregates asynchronously
1716
1716
  *
1717
1717
  * @param {Object} body query
1718
- * Preview Endpoint
1718
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1719
1719
  */
1720
1720
  postAnalyticsFlowsAggregatesJobs(body) {
1721
1721
  // verify the required parameter 'body' is set
@@ -1791,7 +1791,7 @@ class AnalyticsApi {
1791
1791
  * Query for journey aggregates asynchronously
1792
1792
  *
1793
1793
  * @param {Object} body query
1794
- * Preview Endpoint
1794
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1795
1795
  */
1796
1796
  postAnalyticsJourneysAggregatesJobs(body) {
1797
1797
  // verify the required parameter 'body' is set
@@ -1842,7 +1842,7 @@ class AnalyticsApi {
1842
1842
  * Query for knowledge aggregates asynchronously
1843
1843
  *
1844
1844
  * @param {Object} body query
1845
- * Preview Endpoint
1845
+ * postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1846
1846
  */
1847
1847
  postAnalyticsKnowledgeAggregatesJobs(body) {
1848
1848
  // verify the required parameter 'body' is set
@@ -1868,7 +1868,7 @@ class AnalyticsApi {
1868
1868
  * Query for knowledge aggregates
1869
1869
  *
1870
1870
  * @param {Object} body query
1871
- * Preview Endpoint
1871
+ * postAnalyticsKnowledgeAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1872
1872
  */
1873
1873
  postAnalyticsKnowledgeAggregatesQuery(body) {
1874
1874
  // verify the required parameter 'body' is set
@@ -1994,7 +1994,7 @@ class AnalyticsApi {
1994
1994
  * Query for resolution aggregates asynchronously
1995
1995
  *
1996
1996
  * @param {Object} body query
1997
- * Preview Endpoint
1997
+ * postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1998
1998
  */
1999
1999
  postAnalyticsResolutionsAggregatesJobs(body) {
2000
2000
  // verify the required parameter 'body' is set
@@ -2023,7 +2023,7 @@ class AnalyticsApi {
2023
2023
  * @param {Object} opts Optional parameters
2024
2024
  * @param {Number} opts.pageSize The desired page size
2025
2025
  * @param {Number} opts.pageNumber The desired page number
2026
- * Preview Endpoint
2026
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2027
2027
  */
2028
2028
  postAnalyticsRoutingActivityQuery(body, opts) {
2029
2029
  opts = opts || {};
@@ -2051,7 +2051,7 @@ class AnalyticsApi {
2051
2051
  * Query for survey aggregates asynchronously
2052
2052
  *
2053
2053
  * @param {Object} body query
2054
- * Preview Endpoint
2054
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2055
2055
  */
2056
2056
  postAnalyticsSurveysAggregatesJobs(body) {
2057
2057
  // verify the required parameter 'body' is set
@@ -2102,7 +2102,7 @@ class AnalyticsApi {
2102
2102
  * Query for task management aggregates asynchronously
2103
2103
  *
2104
2104
  * @param {Object} body query
2105
- * Preview Endpoint
2105
+ * postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2106
2106
  */
2107
2107
  postAnalyticsTaskmanagementAggregatesJobs(body) {
2108
2108
  // verify the required parameter 'body' is set
@@ -2128,7 +2128,7 @@ class AnalyticsApi {
2128
2128
  * Query for task management aggregates
2129
2129
  *
2130
2130
  * @param {Object} body query
2131
- * Preview Endpoint
2131
+ * postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2132
2132
  */
2133
2133
  postAnalyticsTaskmanagementAggregatesQuery(body) {
2134
2134
  // verify the required parameter 'body' is set
@@ -2157,7 +2157,7 @@ class AnalyticsApi {
2157
2157
  * @param {Object} opts Optional parameters
2158
2158
  * @param {Number} opts.pageSize The desired page size
2159
2159
  * @param {Number} opts.pageNumber The desired page number
2160
- * Preview Endpoint
2160
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2161
2161
  */
2162
2162
  postAnalyticsTeamsActivityQuery(body, opts) {
2163
2163
  opts = opts || {};
@@ -2185,7 +2185,7 @@ class AnalyticsApi {
2185
2185
  * Query for transcript aggregates asynchronously
2186
2186
  *
2187
2187
  * @param {Object} body query
2188
- * Preview Endpoint
2188
+ * postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2189
2189
  */
2190
2190
  postAnalyticsTranscriptsAggregatesJobs(body) {
2191
2191
  // verify the required parameter 'body' is set
@@ -2239,7 +2239,7 @@ class AnalyticsApi {
2239
2239
  * @param {Object} opts Optional parameters
2240
2240
  * @param {Number} opts.pageSize The desired page size
2241
2241
  * @param {Number} opts.pageNumber The desired page number
2242
- * Preview Endpoint
2242
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2243
2243
  */
2244
2244
  postAnalyticsUsersActivityQuery(body, opts) {
2245
2245
  opts = opts || {};
@@ -2267,7 +2267,7 @@ class AnalyticsApi {
2267
2267
  * Query for user aggregates asynchronously
2268
2268
  *
2269
2269
  * @param {Object} body query
2270
- * Preview Endpoint
2270
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2271
2271
  */
2272
2272
  postAnalyticsUsersAggregatesJobs(body) {
2273
2273
  // verify the required parameter 'body' is set
@@ -5,7 +5,7 @@ class ArchitectApi {
5
5
  /**
6
6
  * Architect service.
7
7
  * @module purecloud-platform-client-v2/api/ArchitectApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -1778,7 +1778,7 @@ class ArchitectApi {
1778
1778
  * @param {String} instanceId Instance ID
1779
1779
  * @param {Object} opts Optional parameters
1780
1780
  * @param {Object} opts.expand Expand various details.
1781
- * Preview Endpoint
1781
+ * getFlowsInstance is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1782
1782
  */
1783
1783
  getFlowsInstance(instanceId, opts) {
1784
1784
  opts = opts || {};
@@ -1806,7 +1806,7 @@ class ArchitectApi {
1806
1806
  * Get the status and/or results of an asynchronous flow execution data retrieval job
1807
1807
  *
1808
1808
  * @param {String} jobId The asynchronous job ID
1809
- * Preview Endpoint
1809
+ * getFlowsInstancesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1810
1810
  */
1811
1811
  getFlowsInstancesJob(jobId) {
1812
1812
  // verify the required parameter 'jobId' is set
@@ -1833,7 +1833,7 @@ class ArchitectApi {
1833
1833
  * Returns the queryable parameters that can be used to build a query for execution data.
1834
1834
  * @param {Object} opts Optional parameters
1835
1835
  * @param {Object} opts.expand Expand various query types.
1836
- * Preview Endpoint
1836
+ * getFlowsInstancesQuerycapabilities is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1837
1837
  */
1838
1838
  getFlowsInstancesQuerycapabilities(opts) {
1839
1839
  opts = opts || {};
@@ -2690,7 +2690,7 @@ class ArchitectApi {
2690
2690
  * @param {Object} body Requested Flow Ids
2691
2691
  * @param {Object} opts Optional parameters
2692
2692
  * @param {Object} opts.expand Expand various query types.
2693
- * Preview Endpoint
2693
+ * postFlowsInstancesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2694
2694
  */
2695
2695
  postFlowsInstancesJobs(body, opts) {
2696
2696
  opts = opts || {};
@@ -2720,7 +2720,7 @@ class ArchitectApi {
2720
2720
  * @param {Object} body query
2721
2721
  * @param {Object} opts Optional parameters
2722
2722
  * @param {Boolean} opts.indexOnly indexes only
2723
- * Preview Endpoint
2723
+ * postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2724
2724
  */
2725
2725
  postFlowsInstancesQuery(body, opts) {
2726
2726
  opts = opts || {};
@@ -5,7 +5,7 @@ class AuditApi {
5
5
  /**
6
6
  * Audit service.
7
7
  * @module purecloud-platform-client-v2/api/AuditApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class AuthorizationApi {
5
5
  /**
6
6
  * Authorization service.
7
7
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -246,7 +246,7 @@ class AuthorizationApi {
246
246
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
247
247
  * @param {Object} opts Optional parameters
248
248
  * @param {String} opts.name Search term to filter by division name
249
- * @deprecated
249
+ * @deprecated
250
250
  */
251
251
  getAuthorizationDivisionspermittedMe(permission, opts) {
252
252
  opts = opts || {};
@@ -308,7 +308,7 @@ class AuthorizationApi {
308
308
  * @param {Object} opts Optional parameters
309
309
  * @param {Number} opts.pageNumber Page number (default to 1)
310
310
  * @param {Number} opts.pageSize Page size (default to 25)
311
- * @deprecated
311
+ * @deprecated
312
312
  */
313
313
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
314
314
  opts = opts || {};
@@ -5,7 +5,7 @@ class BillingApi {
5
5
  /**
6
6
  * Billing service.
7
7
  * @module purecloud-platform-client-v2/api/BillingApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class CarrierServicesApi {
5
5
  /**
6
6
  * CarrierServices service.
7
7
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ChatApi {
5
5
  /**
6
6
  * Chat service.
7
7
  * @module purecloud-platform-client-v2/api/ChatApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -23,7 +23,7 @@ class ChatApi {
23
23
  /**
24
24
  * Get Chat Settings.
25
25
  * This route is deprecated, please use /chats/settings instead
26
- * @deprecated
26
+ * @deprecated
27
27
  */
28
28
  getChatSettings() {
29
29
 
@@ -65,7 +65,7 @@ class ChatApi {
65
65
  * Patch Chat Settings.
66
66
  * This route is deprecated, please use /chats/settings instead
67
67
  * @param {Object} body Chat
68
- * @deprecated
68
+ * @deprecated
69
69
  */
70
70
  patchChatSettings(body) {
71
71
  // verify the required parameter 'body' is set
@@ -116,7 +116,7 @@ class ChatApi {
116
116
  * Update Chat Settings.
117
117
  * This route is deprecated, please use /chats/settings instead
118
118
  * @param {Object} body Chat
119
- * @deprecated
119
+ * @deprecated
120
120
  */
121
121
  putChatSettings(body) {
122
122
  // verify the required parameter 'body' is set
@@ -5,7 +5,7 @@ class CoachingApi {
5
5
  /**
6
6
  * Coaching service.
7
7
  * @module purecloud-platform-client-v2/api/CoachingApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -5,7 +5,7 @@ class ContentManagementApi {
5
5
  /**
6
6
  * ContentManagement service.
7
7
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8
- * @version 169.1.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -219,7 +219,7 @@ class ContentManagementApi {
219
219
 
220
220
  /**
221
221
  * Get a list of audits for a document.
222
- *
222
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
223
223
  * @param {String} documentId Document ID
224
224
  * @param {Object} opts Optional parameters
225
225
  * @param {Number} opts.pageSize Page size (default to 25)
@@ -228,6 +228,7 @@ class ContentManagementApi {
228
228
  * @param {String} opts.level level (default to USER)
229
229
  * @param {String} opts.sortBy Sort by
230
230
  * @param {String} opts.sortOrder Sort order (default to ascending)
231
+ * @deprecated
231
232
  */
232
233
  getContentmanagementDocumentAudits(documentId, opts) {
233
234
  opts = opts || {};
@@ -292,7 +293,7 @@ class ContentManagementApi {
292
293
  * @param {Number} opts.pageNumber Page number (default to 1)
293
294
  * @param {String} opts.sortBy name or dateCreated
294
295
  * @param {String} opts.sortOrder ascending or descending (default to ascending)
295
- * @deprecated
296
+ * @deprecated
296
297
  */
297
298
  getContentmanagementDocuments(workspaceId, opts) {
298
299
  opts = opts || {};
@@ -774,8 +775,9 @@ class ContentManagementApi {
774
775
 
775
776
  /**
776
777
  * Query audits
777
- *
778
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
778
779
  * @param {Object} body Allows for a filtered query returning facet information
780
+ * @deprecated
779
781
  */
780
782
  postContentmanagementAuditquery(body) {
781
783
  // verify the required parameter 'body' is set