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
@@ -402,7 +402,7 @@ class Configuration {
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 169.1.0
405
+ * @version 170.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1488,7 +1488,7 @@ class AlertingApi {
1488
1488
  /**
1489
1489
  * Alerting service.
1490
1490
  * @module purecloud-platform-client-v2/api/AlertingApi
1491
- * @version 169.1.0
1491
+ * @version 170.0.0
1492
1492
  */
1493
1493
 
1494
1494
  /**
@@ -1802,7 +1802,7 @@ class AnalyticsApi {
1802
1802
  /**
1803
1803
  * Analytics service.
1804
1804
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1805
- * @version 169.1.0
1805
+ * @version 170.0.0
1806
1806
  */
1807
1807
 
1808
1808
  /**
@@ -1896,7 +1896,7 @@ class AnalyticsApi {
1896
1896
  * Get status for async query for action aggregates
1897
1897
  *
1898
1898
  * @param {String} jobId jobId
1899
- * Preview Endpoint
1899
+ * getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1900
1900
  */
1901
1901
  getAnalyticsActionsAggregatesJob(jobId) {
1902
1902
  // verify the required parameter 'jobId' is set
@@ -1924,7 +1924,7 @@ class AnalyticsApi {
1924
1924
  * @param {String} jobId jobId
1925
1925
  * @param {Object} opts Optional parameters
1926
1926
  * @param {String} opts.cursor Cursor token to retrieve next page
1927
- * Preview Endpoint
1927
+ * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1928
1928
  */
1929
1929
  getAnalyticsActionsAggregatesJobResults(jobId, opts) {
1930
1930
  opts = opts || {};
@@ -1986,7 +1986,7 @@ class AnalyticsApi {
1986
1986
  * Get status for async query for bot aggregates
1987
1987
  *
1988
1988
  * @param {String} jobId jobId
1989
- * Preview Endpoint
1989
+ * getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1990
1990
  */
1991
1991
  getAnalyticsBotsAggregatesJob(jobId) {
1992
1992
  // verify the required parameter 'jobId' is set
@@ -2014,7 +2014,7 @@ class AnalyticsApi {
2014
2014
  * @param {String} jobId jobId
2015
2015
  * @param {Object} opts Optional parameters
2016
2016
  * @param {String} opts.cursor Cursor token to retrieve next page
2017
- * Preview Endpoint
2017
+ * getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2018
2018
  */
2019
2019
  getAnalyticsBotsAggregatesJobResults(jobId, opts) {
2020
2020
  opts = opts || {};
@@ -2067,7 +2067,7 @@ class AnalyticsApi {
2067
2067
  * Get status for async query for conversation aggregates
2068
2068
  *
2069
2069
  * @param {String} jobId jobId
2070
- * Preview Endpoint
2070
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2071
2071
  */
2072
2072
  getAnalyticsConversationsAggregatesJob(jobId) {
2073
2073
  // verify the required parameter 'jobId' is set
@@ -2095,7 +2095,7 @@ class AnalyticsApi {
2095
2095
  * @param {String} jobId jobId
2096
2096
  * @param {Object} opts Optional parameters
2097
2097
  * @param {String} opts.cursor Cursor token to retrieve next page
2098
- * Preview Endpoint
2098
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2099
2099
  */
2100
2100
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
2101
2101
  opts = opts || {};
@@ -2242,7 +2242,7 @@ class AnalyticsApi {
2242
2242
  * Get status for async query for evaluation aggregates
2243
2243
  *
2244
2244
  * @param {String} jobId jobId
2245
- * Preview Endpoint
2245
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2246
2246
  */
2247
2247
  getAnalyticsEvaluationsAggregatesJob(jobId) {
2248
2248
  // verify the required parameter 'jobId' is set
@@ -2270,7 +2270,7 @@ class AnalyticsApi {
2270
2270
  * @param {String} jobId jobId
2271
2271
  * @param {Object} opts Optional parameters
2272
2272
  * @param {String} opts.cursor Cursor token to retrieve next page
2273
- * Preview Endpoint
2273
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2274
2274
  */
2275
2275
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
2276
2276
  opts = opts || {};
@@ -2298,7 +2298,7 @@ class AnalyticsApi {
2298
2298
  * Get status for async query for Flow aggregates
2299
2299
  *
2300
2300
  * @param {String} jobId jobId
2301
- * Preview Endpoint
2301
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2302
2302
  */
2303
2303
  getAnalyticsFlowsAggregatesJob(jobId) {
2304
2304
  // verify the required parameter 'jobId' is set
@@ -2326,7 +2326,7 @@ class AnalyticsApi {
2326
2326
  * @param {String} jobId jobId
2327
2327
  * @param {Object} opts Optional parameters
2328
2328
  * @param {String} opts.cursor Cursor token to retrieve next page
2329
- * Preview Endpoint
2329
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2330
2330
  */
2331
2331
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
2332
2332
  opts = opts || {};
@@ -2354,7 +2354,7 @@ class AnalyticsApi {
2354
2354
  * Get status for async query for journey aggregates
2355
2355
  *
2356
2356
  * @param {String} jobId jobId
2357
- * Preview Endpoint
2357
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2358
2358
  */
2359
2359
  getAnalyticsJourneysAggregatesJob(jobId) {
2360
2360
  // verify the required parameter 'jobId' is set
@@ -2382,7 +2382,7 @@ class AnalyticsApi {
2382
2382
  * @param {String} jobId jobId
2383
2383
  * @param {Object} opts Optional parameters
2384
2384
  * @param {String} opts.cursor Cursor token to retrieve next page
2385
- * Preview Endpoint
2385
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2386
2386
  */
2387
2387
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
2388
2388
  opts = opts || {};
@@ -2410,7 +2410,7 @@ class AnalyticsApi {
2410
2410
  * Get status for async query for knowledge aggregates
2411
2411
  *
2412
2412
  * @param {String} jobId jobId
2413
- * Preview Endpoint
2413
+ * getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2414
2414
  */
2415
2415
  getAnalyticsKnowledgeAggregatesJob(jobId) {
2416
2416
  // verify the required parameter 'jobId' is set
@@ -2438,7 +2438,7 @@ class AnalyticsApi {
2438
2438
  * @param {String} jobId jobId
2439
2439
  * @param {Object} opts Optional parameters
2440
2440
  * @param {String} opts.cursor Cursor token to retrieve next page
2441
- * Preview Endpoint
2441
+ * getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2442
2442
  */
2443
2443
  getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
2444
2444
  opts = opts || {};
@@ -2761,7 +2761,7 @@ class AnalyticsApi {
2761
2761
  * Get status for async query for resolution aggregates
2762
2762
  *
2763
2763
  * @param {String} jobId jobId
2764
- * Preview Endpoint
2764
+ * getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2765
2765
  */
2766
2766
  getAnalyticsResolutionsAggregatesJob(jobId) {
2767
2767
  // verify the required parameter 'jobId' is set
@@ -2789,7 +2789,7 @@ class AnalyticsApi {
2789
2789
  * @param {String} jobId jobId
2790
2790
  * @param {Object} opts Optional parameters
2791
2791
  * @param {String} opts.cursor Cursor token to retrieve next page
2792
- * Preview Endpoint
2792
+ * getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2793
2793
  */
2794
2794
  getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
2795
2795
  opts = opts || {};
@@ -2817,7 +2817,7 @@ class AnalyticsApi {
2817
2817
  * Get status for async query for survey aggregates
2818
2818
  *
2819
2819
  * @param {String} jobId jobId
2820
- * Preview Endpoint
2820
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2821
2821
  */
2822
2822
  getAnalyticsSurveysAggregatesJob(jobId) {
2823
2823
  // verify the required parameter 'jobId' is set
@@ -2845,7 +2845,7 @@ class AnalyticsApi {
2845
2845
  * @param {String} jobId jobId
2846
2846
  * @param {Object} opts Optional parameters
2847
2847
  * @param {String} opts.cursor Cursor token to retrieve next page
2848
- * Preview Endpoint
2848
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2849
2849
  */
2850
2850
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
2851
2851
  opts = opts || {};
@@ -2873,7 +2873,7 @@ class AnalyticsApi {
2873
2873
  * Get status for async query for task management aggregates
2874
2874
  *
2875
2875
  * @param {String} jobId jobId
2876
- * Preview Endpoint
2876
+ * getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2877
2877
  */
2878
2878
  getAnalyticsTaskmanagementAggregatesJob(jobId) {
2879
2879
  // verify the required parameter 'jobId' is set
@@ -2901,7 +2901,7 @@ class AnalyticsApi {
2901
2901
  * @param {String} jobId jobId
2902
2902
  * @param {Object} opts Optional parameters
2903
2903
  * @param {String} opts.cursor Cursor token to retrieve next page
2904
- * Preview Endpoint
2904
+ * getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2905
2905
  */
2906
2906
  getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
2907
2907
  opts = opts || {};
@@ -2929,7 +2929,7 @@ class AnalyticsApi {
2929
2929
  * Get status for async query for transcript aggregates
2930
2930
  *
2931
2931
  * @param {String} jobId jobId
2932
- * Preview Endpoint
2932
+ * getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2933
2933
  */
2934
2934
  getAnalyticsTranscriptsAggregatesJob(jobId) {
2935
2935
  // verify the required parameter 'jobId' is set
@@ -2957,7 +2957,7 @@ class AnalyticsApi {
2957
2957
  * @param {String} jobId jobId
2958
2958
  * @param {Object} opts Optional parameters
2959
2959
  * @param {String} opts.cursor Cursor token to retrieve next page
2960
- * Preview Endpoint
2960
+ * getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2961
2961
  */
2962
2962
  getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
2963
2963
  opts = opts || {};
@@ -2985,7 +2985,7 @@ class AnalyticsApi {
2985
2985
  * Get status for async query for user aggregates
2986
2986
  *
2987
2987
  * @param {String} jobId jobId
2988
- * Preview Endpoint
2988
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2989
2989
  */
2990
2990
  getAnalyticsUsersAggregatesJob(jobId) {
2991
2991
  // verify the required parameter 'jobId' is set
@@ -3013,7 +3013,7 @@ class AnalyticsApi {
3013
3013
  * @param {String} jobId jobId
3014
3014
  * @param {Object} opts Optional parameters
3015
3015
  * @param {String} opts.cursor Cursor token to retrieve next page
3016
- * Preview Endpoint
3016
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3017
3017
  */
3018
3018
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
3019
3019
  opts = opts || {};
@@ -3141,7 +3141,7 @@ class AnalyticsApi {
3141
3141
  * Query for action aggregates asynchronously
3142
3142
  *
3143
3143
  * @param {Object} body query
3144
- * Preview Endpoint
3144
+ * postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3145
3145
  */
3146
3146
  postAnalyticsActionsAggregatesJobs(body) {
3147
3147
  // verify the required parameter 'body' is set
@@ -3192,7 +3192,7 @@ class AnalyticsApi {
3192
3192
  * Query for bot aggregates asynchronously
3193
3193
  *
3194
3194
  * @param {Object} body query
3195
- * Preview Endpoint
3195
+ * postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3196
3196
  */
3197
3197
  postAnalyticsBotsAggregatesJobs(body) {
3198
3198
  // verify the required parameter 'body' is set
@@ -3276,7 +3276,7 @@ class AnalyticsApi {
3276
3276
  * @param {Object} opts Optional parameters
3277
3277
  * @param {Number} opts.pageSize The desired page size
3278
3278
  * @param {Number} opts.pageNumber The desired page number
3279
- * Preview Endpoint
3279
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3280
3280
  */
3281
3281
  postAnalyticsConversationsActivityQuery(body, opts) {
3282
3282
  opts = opts || {};
@@ -3304,7 +3304,7 @@ class AnalyticsApi {
3304
3304
  * Query for conversation aggregates asynchronously
3305
3305
  *
3306
3306
  * @param {Object} body query
3307
- * Preview Endpoint
3307
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3308
3308
  */
3309
3309
  postAnalyticsConversationsAggregatesJobs(body) {
3310
3310
  // verify the required parameter 'body' is set
@@ -3430,7 +3430,7 @@ class AnalyticsApi {
3430
3430
  * Query for evaluation aggregates asynchronously
3431
3431
  *
3432
3432
  * @param {Object} body query
3433
- * Preview Endpoint
3433
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3434
3434
  */
3435
3435
  postAnalyticsEvaluationsAggregatesJobs(body) {
3436
3436
  // verify the required parameter 'body' is set
@@ -3484,7 +3484,7 @@ class AnalyticsApi {
3484
3484
  * @param {Object} opts Optional parameters
3485
3485
  * @param {Number} opts.pageSize The desired page size
3486
3486
  * @param {Number} opts.pageNumber The desired page number
3487
- * Preview Endpoint
3487
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3488
3488
  */
3489
3489
  postAnalyticsFlowsActivityQuery(body, opts) {
3490
3490
  opts = opts || {};
@@ -3512,7 +3512,7 @@ class AnalyticsApi {
3512
3512
  * Query for flow aggregates asynchronously
3513
3513
  *
3514
3514
  * @param {Object} body query
3515
- * Preview Endpoint
3515
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3516
3516
  */
3517
3517
  postAnalyticsFlowsAggregatesJobs(body) {
3518
3518
  // verify the required parameter 'body' is set
@@ -3588,7 +3588,7 @@ class AnalyticsApi {
3588
3588
  * Query for journey aggregates asynchronously
3589
3589
  *
3590
3590
  * @param {Object} body query
3591
- * Preview Endpoint
3591
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3592
3592
  */
3593
3593
  postAnalyticsJourneysAggregatesJobs(body) {
3594
3594
  // verify the required parameter 'body' is set
@@ -3639,7 +3639,7 @@ class AnalyticsApi {
3639
3639
  * Query for knowledge aggregates asynchronously
3640
3640
  *
3641
3641
  * @param {Object} body query
3642
- * Preview Endpoint
3642
+ * postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3643
3643
  */
3644
3644
  postAnalyticsKnowledgeAggregatesJobs(body) {
3645
3645
  // verify the required parameter 'body' is set
@@ -3665,7 +3665,7 @@ class AnalyticsApi {
3665
3665
  * Query for knowledge aggregates
3666
3666
  *
3667
3667
  * @param {Object} body query
3668
- * Preview Endpoint
3668
+ * postAnalyticsKnowledgeAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3669
3669
  */
3670
3670
  postAnalyticsKnowledgeAggregatesQuery(body) {
3671
3671
  // verify the required parameter 'body' is set
@@ -3791,7 +3791,7 @@ class AnalyticsApi {
3791
3791
  * Query for resolution aggregates asynchronously
3792
3792
  *
3793
3793
  * @param {Object} body query
3794
- * Preview Endpoint
3794
+ * postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3795
3795
  */
3796
3796
  postAnalyticsResolutionsAggregatesJobs(body) {
3797
3797
  // verify the required parameter 'body' is set
@@ -3820,7 +3820,7 @@ class AnalyticsApi {
3820
3820
  * @param {Object} opts Optional parameters
3821
3821
  * @param {Number} opts.pageSize The desired page size
3822
3822
  * @param {Number} opts.pageNumber The desired page number
3823
- * Preview Endpoint
3823
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3824
3824
  */
3825
3825
  postAnalyticsRoutingActivityQuery(body, opts) {
3826
3826
  opts = opts || {};
@@ -3848,7 +3848,7 @@ class AnalyticsApi {
3848
3848
  * Query for survey aggregates asynchronously
3849
3849
  *
3850
3850
  * @param {Object} body query
3851
- * Preview Endpoint
3851
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3852
3852
  */
3853
3853
  postAnalyticsSurveysAggregatesJobs(body) {
3854
3854
  // verify the required parameter 'body' is set
@@ -3899,7 +3899,7 @@ class AnalyticsApi {
3899
3899
  * Query for task management aggregates asynchronously
3900
3900
  *
3901
3901
  * @param {Object} body query
3902
- * Preview Endpoint
3902
+ * postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3903
3903
  */
3904
3904
  postAnalyticsTaskmanagementAggregatesJobs(body) {
3905
3905
  // verify the required parameter 'body' is set
@@ -3925,7 +3925,7 @@ class AnalyticsApi {
3925
3925
  * Query for task management aggregates
3926
3926
  *
3927
3927
  * @param {Object} body query
3928
- * Preview Endpoint
3928
+ * postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3929
3929
  */
3930
3930
  postAnalyticsTaskmanagementAggregatesQuery(body) {
3931
3931
  // verify the required parameter 'body' is set
@@ -3954,7 +3954,7 @@ class AnalyticsApi {
3954
3954
  * @param {Object} opts Optional parameters
3955
3955
  * @param {Number} opts.pageSize The desired page size
3956
3956
  * @param {Number} opts.pageNumber The desired page number
3957
- * Preview Endpoint
3957
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3958
3958
  */
3959
3959
  postAnalyticsTeamsActivityQuery(body, opts) {
3960
3960
  opts = opts || {};
@@ -3982,7 +3982,7 @@ class AnalyticsApi {
3982
3982
  * Query for transcript aggregates asynchronously
3983
3983
  *
3984
3984
  * @param {Object} body query
3985
- * Preview Endpoint
3985
+ * postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3986
3986
  */
3987
3987
  postAnalyticsTranscriptsAggregatesJobs(body) {
3988
3988
  // verify the required parameter 'body' is set
@@ -4036,7 +4036,7 @@ class AnalyticsApi {
4036
4036
  * @param {Object} opts Optional parameters
4037
4037
  * @param {Number} opts.pageSize The desired page size
4038
4038
  * @param {Number} opts.pageNumber The desired page number
4039
- * Preview Endpoint
4039
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4040
4040
  */
4041
4041
  postAnalyticsUsersActivityQuery(body, opts) {
4042
4042
  opts = opts || {};
@@ -4064,7 +4064,7 @@ class AnalyticsApi {
4064
4064
  * Query for user aggregates asynchronously
4065
4065
  *
4066
4066
  * @param {Object} body query
4067
- * Preview Endpoint
4067
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4068
4068
  */
4069
4069
  postAnalyticsUsersAggregatesJobs(body) {
4070
4070
  // verify the required parameter 'body' is set
@@ -4247,7 +4247,7 @@ class ArchitectApi {
4247
4247
  /**
4248
4248
  * Architect service.
4249
4249
  * @module purecloud-platform-client-v2/api/ArchitectApi
4250
- * @version 169.1.0
4250
+ * @version 170.0.0
4251
4251
  */
4252
4252
 
4253
4253
  /**
@@ -6020,7 +6020,7 @@ class ArchitectApi {
6020
6020
  * @param {String} instanceId Instance ID
6021
6021
  * @param {Object} opts Optional parameters
6022
6022
  * @param {Object} opts.expand Expand various details.
6023
- * Preview Endpoint
6023
+ * getFlowsInstance is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6024
6024
  */
6025
6025
  getFlowsInstance(instanceId, opts) {
6026
6026
  opts = opts || {};
@@ -6048,7 +6048,7 @@ class ArchitectApi {
6048
6048
  * Get the status and/or results of an asynchronous flow execution data retrieval job
6049
6049
  *
6050
6050
  * @param {String} jobId The asynchronous job ID
6051
- * Preview Endpoint
6051
+ * getFlowsInstancesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6052
6052
  */
6053
6053
  getFlowsInstancesJob(jobId) {
6054
6054
  // verify the required parameter 'jobId' is set
@@ -6075,7 +6075,7 @@ class ArchitectApi {
6075
6075
  * Returns the queryable parameters that can be used to build a query for execution data.
6076
6076
  * @param {Object} opts Optional parameters
6077
6077
  * @param {Object} opts.expand Expand various query types.
6078
- * Preview Endpoint
6078
+ * getFlowsInstancesQuerycapabilities is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6079
6079
  */
6080
6080
  getFlowsInstancesQuerycapabilities(opts) {
6081
6081
  opts = opts || {};
@@ -6932,7 +6932,7 @@ class ArchitectApi {
6932
6932
  * @param {Object} body Requested Flow Ids
6933
6933
  * @param {Object} opts Optional parameters
6934
6934
  * @param {Object} opts.expand Expand various query types.
6935
- * Preview Endpoint
6935
+ * postFlowsInstancesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6936
6936
  */
6937
6937
  postFlowsInstancesJobs(body, opts) {
6938
6938
  opts = opts || {};
@@ -6962,7 +6962,7 @@ class ArchitectApi {
6962
6962
  * @param {Object} body query
6963
6963
  * @param {Object} opts Optional parameters
6964
6964
  * @param {Boolean} opts.indexOnly indexes only
6965
- * Preview Endpoint
6965
+ * postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6966
6966
  */
6967
6967
  postFlowsInstancesQuery(body, opts) {
6968
6968
  opts = opts || {};
@@ -7436,7 +7436,7 @@ class AuditApi {
7436
7436
  /**
7437
7437
  * Audit service.
7438
7438
  * @module purecloud-platform-client-v2/api/AuditApi
7439
- * @version 169.1.0
7439
+ * @version 170.0.0
7440
7440
  */
7441
7441
 
7442
7442
  /**
@@ -7607,7 +7607,7 @@ class AuthorizationApi {
7607
7607
  /**
7608
7608
  * Authorization service.
7609
7609
  * @module purecloud-platform-client-v2/api/AuthorizationApi
7610
- * @version 169.1.0
7610
+ * @version 170.0.0
7611
7611
  */
7612
7612
 
7613
7613
  /**
@@ -7848,7 +7848,7 @@ class AuthorizationApi {
7848
7848
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
7849
7849
  * @param {Object} opts Optional parameters
7850
7850
  * @param {String} opts.name Search term to filter by division name
7851
- * @deprecated
7851
+ * @deprecated
7852
7852
  */
7853
7853
  getAuthorizationDivisionspermittedMe(permission, opts) {
7854
7854
  opts = opts || {};
@@ -7910,7 +7910,7 @@ class AuthorizationApi {
7910
7910
  * @param {Object} opts Optional parameters
7911
7911
  * @param {Number} opts.pageNumber Page number (default to 1)
7912
7912
  * @param {Number} opts.pageSize Page size (default to 25)
7913
- * @deprecated
7913
+ * @deprecated
7914
7914
  */
7915
7915
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
7916
7916
  opts = opts || {};
@@ -8838,7 +8838,7 @@ class BillingApi {
8838
8838
  /**
8839
8839
  * Billing service.
8840
8840
  * @module purecloud-platform-client-v2/api/BillingApi
8841
- * @version 169.1.0
8841
+ * @version 170.0.0
8842
8842
  */
8843
8843
 
8844
8844
  /**
@@ -8918,7 +8918,7 @@ class CarrierServicesApi {
8918
8918
  /**
8919
8919
  * CarrierServices service.
8920
8920
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
8921
- * @version 169.1.0
8921
+ * @version 170.0.0
8922
8922
  */
8923
8923
 
8924
8924
  /**
@@ -8988,7 +8988,7 @@ class ChatApi {
8988
8988
  /**
8989
8989
  * Chat service.
8990
8990
  * @module purecloud-platform-client-v2/api/ChatApi
8991
- * @version 169.1.0
8991
+ * @version 170.0.0
8992
8992
  */
8993
8993
 
8994
8994
  /**
@@ -9006,7 +9006,7 @@ class ChatApi {
9006
9006
  /**
9007
9007
  * Get Chat Settings.
9008
9008
  * This route is deprecated, please use /chats/settings instead
9009
- * @deprecated
9009
+ * @deprecated
9010
9010
  */
9011
9011
  getChatSettings() {
9012
9012
 
@@ -9048,7 +9048,7 @@ class ChatApi {
9048
9048
  * Patch Chat Settings.
9049
9049
  * This route is deprecated, please use /chats/settings instead
9050
9050
  * @param {Object} body Chat
9051
- * @deprecated
9051
+ * @deprecated
9052
9052
  */
9053
9053
  patchChatSettings(body) {
9054
9054
  // verify the required parameter 'body' is set
@@ -9099,7 +9099,7 @@ class ChatApi {
9099
9099
  * Update Chat Settings.
9100
9100
  * This route is deprecated, please use /chats/settings instead
9101
9101
  * @param {Object} body Chat
9102
- * @deprecated
9102
+ * @deprecated
9103
9103
  */
9104
9104
  putChatSettings(body) {
9105
9105
  // verify the required parameter 'body' is set
@@ -9152,7 +9152,7 @@ class CoachingApi {
9152
9152
  /**
9153
9153
  * Coaching service.
9154
9154
  * @module purecloud-platform-client-v2/api/CoachingApi
9155
- * @version 169.1.0
9155
+ * @version 170.0.0
9156
9156
  */
9157
9157
 
9158
9158
  /**
@@ -9729,7 +9729,7 @@ class ContentManagementApi {
9729
9729
  /**
9730
9730
  * ContentManagement service.
9731
9731
  * @module purecloud-platform-client-v2/api/ContentManagementApi
9732
- * @version 169.1.0
9732
+ * @version 170.0.0
9733
9733
  */
9734
9734
 
9735
9735
  /**
@@ -9943,7 +9943,7 @@ class ContentManagementApi {
9943
9943
 
9944
9944
  /**
9945
9945
  * Get a list of audits for a document.
9946
- *
9946
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
9947
9947
  * @param {String} documentId Document ID
9948
9948
  * @param {Object} opts Optional parameters
9949
9949
  * @param {Number} opts.pageSize Page size (default to 25)
@@ -9952,6 +9952,7 @@ class ContentManagementApi {
9952
9952
  * @param {String} opts.level level (default to USER)
9953
9953
  * @param {String} opts.sortBy Sort by
9954
9954
  * @param {String} opts.sortOrder Sort order (default to ascending)
9955
+ * @deprecated
9955
9956
  */
9956
9957
  getContentmanagementDocumentAudits(documentId, opts) {
9957
9958
  opts = opts || {};
@@ -10016,7 +10017,7 @@ class ContentManagementApi {
10016
10017
  * @param {Number} opts.pageNumber Page number (default to 1)
10017
10018
  * @param {String} opts.sortBy name or dateCreated
10018
10019
  * @param {String} opts.sortOrder ascending or descending (default to ascending)
10019
- * @deprecated
10020
+ * @deprecated
10020
10021
  */
10021
10022
  getContentmanagementDocuments(workspaceId, opts) {
10022
10023
  opts = opts || {};
@@ -10498,8 +10499,9 @@ class ContentManagementApi {
10498
10499
 
10499
10500
  /**
10500
10501
  * Query audits
10501
- *
10502
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
10502
10503
  * @param {Object} body Allows for a filtered query returning facet information
10504
+ * @deprecated
10503
10505
  */
10504
10506
  postContentmanagementAuditquery(body) {
10505
10507
  // verify the required parameter 'body' is set
@@ -10870,7 +10872,7 @@ class ConversationsApi {
10870
10872
  /**
10871
10873
  * Conversations service.
10872
10874
  * @module purecloud-platform-client-v2/api/ConversationsApi
10873
- * @version 169.1.0
10875
+ * @version 170.0.0
10874
10876
  */
10875
10877
 
10876
10878
  /**
@@ -11060,6 +11062,31 @@ class ConversationsApi {
11060
11062
  );
11061
11063
  }
11062
11064
 
11065
+ /**
11066
+ * Delete Instagram messaging integration
11067
+ *
11068
+ * @param {String} integrationId Integration ID
11069
+ */
11070
+ deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId) {
11071
+ // verify the required parameter 'integrationId' is set
11072
+ if (integrationId === undefined || integrationId === null) {
11073
+ throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsInstagramIntegrationId';
11074
+ }
11075
+
11076
+ return this.apiClient.callApi(
11077
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
11078
+ 'DELETE',
11079
+ { 'integrationId': integrationId },
11080
+ { },
11081
+ { },
11082
+ { },
11083
+ null,
11084
+ ['PureCloud OAuth'],
11085
+ ['application/json'],
11086
+ ['application/json']
11087
+ );
11088
+ }
11089
+
11063
11090
  /**
11064
11091
  * Delete a LINE messenger integration
11065
11092
  *
@@ -11214,7 +11241,7 @@ class ConversationsApi {
11214
11241
  * Get status for async query for conversation aggregates
11215
11242
  *
11216
11243
  * @param {String} jobId jobId
11217
- * Preview Endpoint
11244
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11218
11245
  */
11219
11246
  getAnalyticsConversationsAggregatesJob(jobId) {
11220
11247
  // verify the required parameter 'jobId' is set
@@ -11242,7 +11269,7 @@ class ConversationsApi {
11242
11269
  * @param {String} jobId jobId
11243
11270
  * @param {Object} opts Optional parameters
11244
11271
  * @param {String} opts.cursor Cursor token to retrieve next page
11245
- * Preview Endpoint
11272
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11246
11273
  */
11247
11274
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
11248
11275
  opts = opts || {};
@@ -12918,6 +12945,63 @@ class ConversationsApi {
12918
12945
  );
12919
12946
  }
12920
12947
 
12948
+ /**
12949
+ * Get a list of Instagram Integrations
12950
+ *
12951
+ * @param {Object} opts Optional parameters
12952
+ * @param {Number} opts.pageSize Page size (default to 25)
12953
+ * @param {Number} opts.pageNumber Page number (default to 1)
12954
+ * @param {Object} opts.expand Expand instructions for the return value.
12955
+ * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
12956
+ * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
12957
+ */
12958
+ getConversationsMessagingIntegrationsInstagram(opts) {
12959
+ opts = opts || {};
12960
+
12961
+
12962
+ return this.apiClient.callApi(
12963
+ '/api/v2/conversations/messaging/integrations/instagram',
12964
+ 'GET',
12965
+ { },
12966
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
12967
+ { },
12968
+ { },
12969
+ null,
12970
+ ['PureCloud OAuth'],
12971
+ ['application/json'],
12972
+ ['application/json']
12973
+ );
12974
+ }
12975
+
12976
+ /**
12977
+ * Get Instagram messaging integration
12978
+ *
12979
+ * @param {String} integrationId Integration ID
12980
+ * @param {Object} opts Optional parameters
12981
+ * @param {Object} opts.expand Expand instructions for the return value.
12982
+ */
12983
+ getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, opts) {
12984
+ opts = opts || {};
12985
+
12986
+ // verify the required parameter 'integrationId' is set
12987
+ if (integrationId === undefined || integrationId === null) {
12988
+ throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsInstagramIntegrationId';
12989
+ }
12990
+
12991
+ return this.apiClient.callApi(
12992
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
12993
+ 'GET',
12994
+ { 'integrationId': integrationId },
12995
+ { 'expand': opts['expand'] },
12996
+ { },
12997
+ { },
12998
+ null,
12999
+ ['PureCloud OAuth'],
13000
+ ['application/json'],
13001
+ ['application/json']
13002
+ );
13003
+ }
13004
+
12921
13005
  /**
12922
13006
  * Get a list of LINE messenger Integrations
12923
13007
  *
@@ -13368,7 +13452,7 @@ class ConversationsApi {
13368
13452
  * Get video conference details (e.g. the current number of active participants).
13369
13453
  *
13370
13454
  * @param {String} conferenceId conferenceId
13371
- * Preview Endpoint
13455
+ * getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13372
13456
  */
13373
13457
  getConversationsVideoDetails(conferenceId) {
13374
13458
  // verify the required parameter 'conferenceId' is set
@@ -14526,6 +14610,36 @@ class ConversationsApi {
14526
14610
  );
14527
14611
  }
14528
14612
 
14613
+ /**
14614
+ * Update Instagram messaging integration
14615
+ *
14616
+ * @param {String} integrationId Integration ID
14617
+ * @param {Object} body InstagramIntegrationUpdateRequest
14618
+ */
14619
+ patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, body) {
14620
+ // verify the required parameter 'integrationId' is set
14621
+ if (integrationId === undefined || integrationId === null) {
14622
+ throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
14623
+ }
14624
+ // verify the required parameter 'body' is set
14625
+ if (body === undefined || body === null) {
14626
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
14627
+ }
14628
+
14629
+ return this.apiClient.callApi(
14630
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
14631
+ 'PATCH',
14632
+ { 'integrationId': integrationId },
14633
+ { },
14634
+ { },
14635
+ { },
14636
+ body,
14637
+ ['PureCloud OAuth'],
14638
+ ['application/json'],
14639
+ ['application/json']
14640
+ );
14641
+ }
14642
+
14529
14643
  /**
14530
14644
  * Update an Open messaging integration
14531
14645
  * See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
@@ -14708,7 +14822,7 @@ class ConversationsApi {
14708
14822
  * @param {Object} opts Optional parameters
14709
14823
  * @param {Number} opts.pageSize The desired page size
14710
14824
  * @param {Number} opts.pageNumber The desired page number
14711
- * Preview Endpoint
14825
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14712
14826
  */
14713
14827
  postAnalyticsConversationsActivityQuery(body, opts) {
14714
14828
  opts = opts || {};
@@ -14736,7 +14850,7 @@ class ConversationsApi {
14736
14850
  * Query for conversation aggregates asynchronously
14737
14851
  *
14738
14852
  * @param {Object} body query
14739
- * Preview Endpoint
14853
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14740
14854
  */
14741
14855
  postAnalyticsConversationsAggregatesJobs(body) {
14742
14856
  // verify the required parameter 'body' is set
@@ -14987,6 +15101,7 @@ class ConversationsApi {
14987
15101
  * @param {String} conversationId conversation ID
14988
15102
  * @param {String} participantId participant ID
14989
15103
  * @param {Object} body Transfer request
15104
+ * @deprecated
14990
15105
  */
14991
15106
  postConversationParticipantReplace(conversationId, participantId, body) {
14992
15107
  // verify the required parameter 'conversationId' is set
@@ -15016,6 +15131,111 @@ class ConversationsApi {
15016
15131
  );
15017
15132
  }
15018
15133
 
15134
+ /**
15135
+ * Replace this participant with the specified agent
15136
+ *
15137
+ * @param {String} conversationId conversation ID
15138
+ * @param {String} participantId participant ID
15139
+ * @param {Object} body Transfer request
15140
+ */
15141
+ postConversationParticipantReplaceAgent(conversationId, participantId, body) {
15142
+ // verify the required parameter 'conversationId' is set
15143
+ if (conversationId === undefined || conversationId === null) {
15144
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceAgent';
15145
+ }
15146
+ // verify the required parameter 'participantId' is set
15147
+ if (participantId === undefined || participantId === null) {
15148
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceAgent';
15149
+ }
15150
+ // verify the required parameter 'body' is set
15151
+ if (body === undefined || body === null) {
15152
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceAgent';
15153
+ }
15154
+
15155
+ return this.apiClient.callApi(
15156
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent',
15157
+ 'POST',
15158
+ { 'conversationId': conversationId,'participantId': participantId },
15159
+ { },
15160
+ { },
15161
+ { },
15162
+ body,
15163
+ ['PureCloud OAuth'],
15164
+ ['application/json'],
15165
+ ['application/json']
15166
+ );
15167
+ }
15168
+
15169
+ /**
15170
+ * Replace this participant with the an external contact
15171
+ *
15172
+ * @param {String} conversationId conversation ID
15173
+ * @param {String} participantId participant ID
15174
+ * @param {Object} body Transfer request
15175
+ */
15176
+ postConversationParticipantReplaceExternal(conversationId, participantId, body) {
15177
+ // verify the required parameter 'conversationId' is set
15178
+ if (conversationId === undefined || conversationId === null) {
15179
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';
15180
+ }
15181
+ // verify the required parameter 'participantId' is set
15182
+ if (participantId === undefined || participantId === null) {
15183
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';
15184
+ }
15185
+ // verify the required parameter 'body' is set
15186
+ if (body === undefined || body === null) {
15187
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceExternal';
15188
+ }
15189
+
15190
+ return this.apiClient.callApi(
15191
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external',
15192
+ 'POST',
15193
+ { 'conversationId': conversationId,'participantId': participantId },
15194
+ { },
15195
+ { },
15196
+ { },
15197
+ body,
15198
+ ['PureCloud OAuth'],
15199
+ ['application/json'],
15200
+ ['application/json']
15201
+ );
15202
+ }
15203
+
15204
+ /**
15205
+ * Replace this participant with the specified queue
15206
+ *
15207
+ * @param {String} conversationId conversation ID
15208
+ * @param {String} participantId participant ID
15209
+ * @param {Object} body Transfer request
15210
+ */
15211
+ postConversationParticipantReplaceQueue(conversationId, participantId, body) {
15212
+ // verify the required parameter 'conversationId' is set
15213
+ if (conversationId === undefined || conversationId === null) {
15214
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceQueue';
15215
+ }
15216
+ // verify the required parameter 'participantId' is set
15217
+ if (participantId === undefined || participantId === null) {
15218
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceQueue';
15219
+ }
15220
+ // verify the required parameter 'body' is set
15221
+ if (body === undefined || body === null) {
15222
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceQueue';
15223
+ }
15224
+
15225
+ return this.apiClient.callApi(
15226
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue',
15227
+ 'POST',
15228
+ { 'conversationId': conversationId,'participantId': participantId },
15229
+ { },
15230
+ { },
15231
+ { },
15232
+ body,
15233
+ ['PureCloud OAuth'],
15234
+ ['application/json'],
15235
+ ['application/json']
15236
+ );
15237
+ }
15238
+
15019
15239
  /**
15020
15240
  * Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
15021
15241
  *
@@ -15155,6 +15375,7 @@ class ConversationsApi {
15155
15375
  * @param {String} conversationId conversationId
15156
15376
  * @param {String} participantId participantId
15157
15377
  * @param {Object} body Destination address and initial speak to
15378
+ * @deprecated
15158
15379
  */
15159
15380
  postConversationsCallParticipantConsult(conversationId, participantId, body) {
15160
15381
  // verify the required parameter 'conversationId' is set
@@ -15184,6 +15405,111 @@ class ConversationsApi {
15184
15405
  );
15185
15406
  }
15186
15407
 
15408
+ /**
15409
+ * Initiate a consult transfer to an agent
15410
+ *
15411
+ * @param {String} conversationId conversationId
15412
+ * @param {String} participantId participantId
15413
+ * @param {Object} body Destination agent and initial speak to
15414
+ */
15415
+ postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
15416
+ // verify the required parameter 'conversationId' is set
15417
+ if (conversationId === undefined || conversationId === null) {
15418
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultAgent';
15419
+ }
15420
+ // verify the required parameter 'participantId' is set
15421
+ if (participantId === undefined || participantId === null) {
15422
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultAgent';
15423
+ }
15424
+ // verify the required parameter 'body' is set
15425
+ if (body === undefined || body === null) {
15426
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultAgent';
15427
+ }
15428
+
15429
+ return this.apiClient.callApi(
15430
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent',
15431
+ 'POST',
15432
+ { 'conversationId': conversationId,'participantId': participantId },
15433
+ { },
15434
+ { },
15435
+ { },
15436
+ body,
15437
+ ['PureCloud OAuth'],
15438
+ ['application/json'],
15439
+ ['application/json']
15440
+ );
15441
+ }
15442
+
15443
+ /**
15444
+ * Initiate a consult transfer to an external contact
15445
+ *
15446
+ * @param {String} conversationId conversationId
15447
+ * @param {String} participantId participantId
15448
+ * @param {Object} body Destination address and initial speak to
15449
+ */
15450
+ postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
15451
+ // verify the required parameter 'conversationId' is set
15452
+ if (conversationId === undefined || conversationId === null) {
15453
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';
15454
+ }
15455
+ // verify the required parameter 'participantId' is set
15456
+ if (participantId === undefined || participantId === null) {
15457
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';
15458
+ }
15459
+ // verify the required parameter 'body' is set
15460
+ if (body === undefined || body === null) {
15461
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultExternal';
15462
+ }
15463
+
15464
+ return this.apiClient.callApi(
15465
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external',
15466
+ 'POST',
15467
+ { 'conversationId': conversationId,'participantId': participantId },
15468
+ { },
15469
+ { },
15470
+ { },
15471
+ body,
15472
+ ['PureCloud OAuth'],
15473
+ ['application/json'],
15474
+ ['application/json']
15475
+ );
15476
+ }
15477
+
15478
+ /**
15479
+ * Initiate a consult transfer to a queue
15480
+ *
15481
+ * @param {String} conversationId conversationId
15482
+ * @param {String} participantId participantId
15483
+ * @param {Object} body Destination queue and initial speak to
15484
+ */
15485
+ postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
15486
+ // verify the required parameter 'conversationId' is set
15487
+ if (conversationId === undefined || conversationId === null) {
15488
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultQueue';
15489
+ }
15490
+ // verify the required parameter 'participantId' is set
15491
+ if (participantId === undefined || participantId === null) {
15492
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultQueue';
15493
+ }
15494
+ // verify the required parameter 'body' is set
15495
+ if (body === undefined || body === null) {
15496
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultQueue';
15497
+ }
15498
+
15499
+ return this.apiClient.callApi(
15500
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue',
15501
+ 'POST',
15502
+ { 'conversationId': conversationId,'participantId': participantId },
15503
+ { },
15504
+ { },
15505
+ { },
15506
+ body,
15507
+ ['PureCloud OAuth'],
15508
+ ['application/json'],
15509
+ ['application/json']
15510
+ );
15511
+ }
15512
+
15187
15513
  /**
15188
15514
  * Listen in on the conversation from the point of view of a given participant.
15189
15515
  *
@@ -15220,6 +15546,7 @@ class ConversationsApi {
15220
15546
  * @param {String} conversationId conversationId
15221
15547
  * @param {String} participantId participantId
15222
15548
  * @param {Object} body Transfer request
15549
+ * @deprecated
15223
15550
  */
15224
15551
  postConversationsCallParticipantReplace(conversationId, participantId, body) {
15225
15552
  // verify the required parameter 'conversationId' is set
@@ -15324,6 +15651,7 @@ class ConversationsApi {
15324
15651
  * @param {String} conversationId conversationId
15325
15652
  * @param {String} participantId participantId
15326
15653
  * @param {Object} body Transfer request
15654
+ * @deprecated
15327
15655
  */
15328
15656
  postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
15329
15657
  // verify the required parameter 'conversationId' is set
@@ -15563,6 +15891,7 @@ class ConversationsApi {
15563
15891
  * @param {String} conversationId conversationId
15564
15892
  * @param {String} participantId participantId
15565
15893
  * @param {Object} body Transfer request
15894
+ * @deprecated
15566
15895
  */
15567
15896
  postConversationsChatParticipantReplace(conversationId, participantId, body) {
15568
15897
  // verify the required parameter 'conversationId' is set
@@ -15663,6 +15992,7 @@ class ConversationsApi {
15663
15992
  * @param {String} participantId participantId
15664
15993
  * @param {Object} opts Optional parameters
15665
15994
  * @param {Object} opts.body
15995
+ * @deprecated
15666
15996
  */
15667
15997
  postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
15668
15998
  opts = opts || {};
@@ -15825,6 +16155,7 @@ class ConversationsApi {
15825
16155
  * @param {String} conversationId conversationId
15826
16156
  * @param {String} participantId participantId
15827
16157
  * @param {Object} body Transfer request
16158
+ * @deprecated
15828
16159
  */
15829
16160
  postConversationsEmailParticipantReplace(conversationId, participantId, body) {
15830
16161
  // verify the required parameter 'conversationId' is set
@@ -16157,7 +16488,7 @@ class ConversationsApi {
16157
16488
  *
16158
16489
  * @param {String} conversationId conversationId
16159
16490
  * @param {String} participantId participantId
16160
- * Preview Endpoint
16491
+ * postConversationsMessageParticipantMonitor is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16161
16492
  */
16162
16493
  postConversationsMessageParticipantMonitor(conversationId, participantId) {
16163
16494
  // verify the required parameter 'conversationId' is set
@@ -16189,6 +16520,7 @@ class ConversationsApi {
16189
16520
  * @param {String} conversationId conversationId
16190
16521
  * @param {String} participantId participantId
16191
16522
  * @param {Object} body Transfer request
16523
+ * @deprecated
16192
16524
  */
16193
16525
  postConversationsMessageParticipantReplace(conversationId, participantId, body) {
16194
16526
  // verify the required parameter 'conversationId' is set
@@ -16318,6 +16650,31 @@ class ConversationsApi {
16318
16650
  );
16319
16651
  }
16320
16652
 
16653
+ /**
16654
+ * Create Instagram Integration
16655
+ *
16656
+ * @param {Object} body InstagramIntegrationRequest
16657
+ */
16658
+ postConversationsMessagingIntegrationsInstagram(body) {
16659
+ // verify the required parameter 'body' is set
16660
+ if (body === undefined || body === null) {
16661
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsInstagram';
16662
+ }
16663
+
16664
+ return this.apiClient.callApi(
16665
+ '/api/v2/conversations/messaging/integrations/instagram',
16666
+ 'POST',
16667
+ { },
16668
+ { },
16669
+ { },
16670
+ { },
16671
+ body,
16672
+ ['PureCloud OAuth'],
16673
+ ['application/json'],
16674
+ ['application/json']
16675
+ );
16676
+ }
16677
+
16321
16678
  /**
16322
16679
  * Create a LINE messenger Integration
16323
16680
  *
@@ -17131,7 +17488,7 @@ class DataExtensionsApi {
17131
17488
  /**
17132
17489
  * DataExtensions service.
17133
17490
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
17134
- * @version 169.1.0
17491
+ * @version 170.0.0
17135
17492
  */
17136
17493
 
17137
17494
  /**
@@ -17217,7 +17574,7 @@ class DownloadsApi {
17217
17574
  /**
17218
17575
  * Downloads service.
17219
17576
  * @module purecloud-platform-client-v2/api/DownloadsApi
17220
- * @version 169.1.0
17577
+ * @version 170.0.0
17221
17578
  */
17222
17579
 
17223
17580
  /**
@@ -17269,7 +17626,7 @@ class EventsApi {
17269
17626
  /**
17270
17627
  * Events service.
17271
17628
  * @module purecloud-platform-client-v2/api/EventsApi
17272
- * @version 169.1.0
17629
+ * @version 170.0.0
17273
17630
  */
17274
17631
 
17275
17632
  /**
@@ -17365,7 +17722,7 @@ class ExternalContactsApi {
17365
17722
  /**
17366
17723
  * ExternalContacts service.
17367
17724
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
17368
- * @version 169.1.0
17725
+ * @version 170.0.0
17369
17726
  */
17370
17727
 
17371
17728
  /**
@@ -19323,7 +19680,7 @@ class FaxApi {
19323
19680
  /**
19324
19681
  * Fax service.
19325
19682
  * @module purecloud-platform-client-v2/api/FaxApi
19326
- * @version 169.1.0
19683
+ * @version 170.0.0
19327
19684
  */
19328
19685
 
19329
19686
  /**
@@ -19494,7 +19851,7 @@ class FlowsApi {
19494
19851
  /**
19495
19852
  * Flows service.
19496
19853
  * @module purecloud-platform-client-v2/api/FlowsApi
19497
- * @version 169.1.0
19854
+ * @version 170.0.0
19498
19855
  */
19499
19856
 
19500
19857
  /**
@@ -19513,7 +19870,7 @@ class FlowsApi {
19513
19870
  * Get status for async query for Flow aggregates
19514
19871
  *
19515
19872
  * @param {String} jobId jobId
19516
- * Preview Endpoint
19873
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19517
19874
  */
19518
19875
  getAnalyticsFlowsAggregatesJob(jobId) {
19519
19876
  // verify the required parameter 'jobId' is set
@@ -19541,7 +19898,7 @@ class FlowsApi {
19541
19898
  * @param {String} jobId jobId
19542
19899
  * @param {Object} opts Optional parameters
19543
19900
  * @param {String} opts.cursor Cursor token to retrieve next page
19544
- * Preview Endpoint
19901
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19545
19902
  */
19546
19903
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
19547
19904
  opts = opts || {};
@@ -19572,7 +19929,7 @@ class FlowsApi {
19572
19929
  * @param {Object} opts Optional parameters
19573
19930
  * @param {Number} opts.pageSize The desired page size
19574
19931
  * @param {Number} opts.pageNumber The desired page number
19575
- * Preview Endpoint
19932
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19576
19933
  */
19577
19934
  postAnalyticsFlowsActivityQuery(body, opts) {
19578
19935
  opts = opts || {};
@@ -19600,7 +19957,7 @@ class FlowsApi {
19600
19957
  * Query for flow aggregates asynchronously
19601
19958
  *
19602
19959
  * @param {Object} body query
19603
- * Preview Endpoint
19960
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19604
19961
  */
19605
19962
  postAnalyticsFlowsAggregatesJobs(body) {
19606
19963
  // verify the required parameter 'body' is set
@@ -19678,7 +20035,7 @@ class GamificationApi {
19678
20035
  /**
19679
20036
  * Gamification service.
19680
20037
  * @module purecloud-platform-client-v2/api/GamificationApi
19681
- * @version 169.1.0
20038
+ * @version 170.0.0
19682
20039
  */
19683
20040
 
19684
20041
  /**
@@ -21764,7 +22121,7 @@ class GeneralDataProtectionRegulationApi {
21764
22121
  /**
21765
22122
  * GeneralDataProtectionRegulation service.
21766
22123
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
21767
- * @version 169.1.0
22124
+ * @version 170.0.0
21768
22125
  */
21769
22126
 
21770
22127
  /**
@@ -21894,7 +22251,7 @@ class GeolocationApi {
21894
22251
  /**
21895
22252
  * Geolocation service.
21896
22253
  * @module purecloud-platform-client-v2/api/GeolocationApi
21897
- * @version 169.1.0
22254
+ * @version 170.0.0
21898
22255
  */
21899
22256
 
21900
22257
  /**
@@ -22025,7 +22382,7 @@ class GreetingsApi {
22025
22382
  /**
22026
22383
  * Greetings service.
22027
22384
  * @module purecloud-platform-client-v2/api/GreetingsApi
22028
- * @version 169.1.0
22385
+ * @version 170.0.0
22029
22386
  */
22030
22387
 
22031
22388
  /**
@@ -22480,7 +22837,7 @@ class GroupsApi {
22480
22837
  /**
22481
22838
  * Groups service.
22482
22839
  * @module purecloud-platform-client-v2/api/GroupsApi
22483
- * @version 169.1.0
22840
+ * @version 170.0.0
22484
22841
  */
22485
22842
 
22486
22843
  /**
@@ -22524,7 +22881,7 @@ class GroupsApi {
22524
22881
  * Remove dynamic group definition
22525
22882
  *
22526
22883
  * @param {String} groupId Group ID
22527
- * Preview Endpoint
22884
+ * deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22528
22885
  */
22529
22886
  deleteGroupDynamicsettings(groupId) {
22530
22887
  // verify the required parameter 'groupId' is set
@@ -22580,7 +22937,7 @@ class GroupsApi {
22580
22937
  * Fetch field config for an entity type
22581
22938
  *
22582
22939
  * @param {Object} type Field type
22583
- * @deprecated
22940
+ * @deprecated
22584
22941
  */
22585
22942
  getFieldconfig(type) {
22586
22943
  // verify the required parameter 'type' is set
@@ -22631,7 +22988,7 @@ class GroupsApi {
22631
22988
  * Get dynamic group definition
22632
22989
  *
22633
22990
  * @param {String} groupId Group ID
22634
- * Preview Endpoint
22991
+ * getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22635
22992
  */
22636
22993
  getGroupDynamicsettings(groupId) {
22637
22994
  // verify the required parameter 'groupId' is set
@@ -22716,7 +23073,7 @@ class GroupsApi {
22716
23073
  * @param {String} groupId groupId
22717
23074
  * @param {Object} opts Optional parameters
22718
23075
  * @param {String} opts.fields Comma separated fields to return. Allowable values can be found by querying /api/v2/fieldconfig?type=group and using the key for the elements returned by the fieldList
22719
- * @deprecated
23076
+ * @deprecated
22720
23077
  */
22721
23078
  getGroupProfile(groupId, opts) {
22722
23079
  opts = opts || {};
@@ -22806,7 +23163,7 @@ class GroupsApi {
22806
23163
  * @param {Array.<String>} opts.id id
22807
23164
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
22808
23165
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
22809
- * @deprecated
23166
+ * @deprecated
22810
23167
  */
22811
23168
  getProfilesGroups(opts) {
22812
23169
  opts = opts || {};
@@ -22885,8 +23242,8 @@ class GroupsApi {
22885
23242
  * Preview the number of users selected for a dynamic group definition query
22886
23243
  *
22887
23244
  * @param {Object} body Group query to preview
22888
- * @deprecated
22889
- * Preview Endpoint
23245
+ * @deprecated
23246
+ * postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22890
23247
  */
22891
23248
  postGroupsDynamicsettingsPreview(body) {
22892
23249
  // verify the required parameter 'body' is set
@@ -22967,7 +23324,7 @@ class GroupsApi {
22967
23324
  *
22968
23325
  * @param {String} groupId Group ID
22969
23326
  * @param {Object} body Create/Update dynamic groups
22970
- * Preview Endpoint
23327
+ * putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22971
23328
  */
22972
23329
  putGroupDynamicsettings(groupId, body) {
22973
23330
  // verify the required parameter 'groupId' is set
@@ -22999,7 +23356,7 @@ class IdentityProviderApi {
22999
23356
  /**
23000
23357
  * IdentityProvider service.
23001
23358
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
23002
- * @version 169.1.0
23359
+ * @version 170.0.0
23003
23360
  */
23004
23361
 
23005
23362
  /**
@@ -23755,7 +24112,7 @@ class InfrastructureAsCodeApi {
23755
24112
  /**
23756
24113
  * InfrastructureAsCode service.
23757
24114
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
23758
- * @version 169.1.0
24115
+ * @version 170.0.0
23759
24116
  */
23760
24117
 
23761
24118
  /**
@@ -23922,7 +24279,7 @@ class IntegrationsApi {
23922
24279
  /**
23923
24280
  * Integrations service.
23924
24281
  * @module purecloud-platform-client-v2/api/IntegrationsApi
23925
- * @version 169.1.0
24282
+ * @version 170.0.0
23926
24283
  */
23927
24284
 
23928
24285
  /**
@@ -24822,7 +25179,7 @@ class IntegrationsApi {
24822
25179
  * @param {Object} opts Optional parameters
24823
25180
  * @param {Array.<String>} opts.expand expand
24824
25181
  * @param {Object} opts.targetChannel targetChannel
24825
- * Preview Endpoint
25182
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24826
25183
  */
24827
25184
  getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId, botId, opts) {
24828
25185
  opts = opts || {};
@@ -24856,7 +25213,7 @@ class IntegrationsApi {
24856
25213
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24857
25214
  * @param {String} botId The Nuance bot ID
24858
25215
  * @param {String} jobId The asynchronous job ID
24859
- * Preview Endpoint
25216
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24860
25217
  */
24861
25218
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId, botId, jobId) {
24862
25219
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -24892,7 +25249,7 @@ class IntegrationsApi {
24892
25249
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24893
25250
  * @param {String} botId The Nuance bot ID
24894
25251
  * @param {String} jobId The asynchronous job ID
24895
- * Preview Endpoint
25252
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24896
25253
  */
24897
25254
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId, botId, jobId) {
24898
25255
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -24930,7 +25287,7 @@ class IntegrationsApi {
24930
25287
  * @param {Number} opts.pageNumber Page number (default to 1)
24931
25288
  * @param {Number} opts.pageSize Page size (default to 25)
24932
25289
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
24933
- * Preview Endpoint
25290
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24934
25291
  */
24935
25292
  getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId, opts) {
24936
25293
  opts = opts || {};
@@ -24959,7 +25316,7 @@ class IntegrationsApi {
24959
25316
  *
24960
25317
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24961
25318
  * @param {String} jobId The asynchronous job ID
24962
- * Preview Endpoint
25319
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24963
25320
  */
24964
25321
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId, jobId) {
24965
25322
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -24990,7 +25347,7 @@ class IntegrationsApi {
24990
25347
  *
24991
25348
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24992
25349
  * @param {String} jobId The asynchronous job ID
24993
- * Preview Endpoint
25350
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24994
25351
  */
24995
25352
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId, jobId) {
24996
25353
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -25613,7 +25970,7 @@ class IntegrationsApi {
25613
25970
  * @param {Object} opts Optional parameters
25614
25971
  * @param {Array.<String>} opts.expand expand
25615
25972
  * @param {String} opts.body targetChannel
25616
- * Preview Endpoint
25973
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25617
25974
  */
25618
25975
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId, botId, opts) {
25619
25976
  opts = opts || {};
@@ -25649,7 +26006,7 @@ class IntegrationsApi {
25649
26006
  * @param {Number} opts.pageNumber Page number (default to 1)
25650
26007
  * @param {Number} opts.pageSize Page size (default to 25)
25651
26008
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
25652
- * Preview Endpoint
26009
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25653
26010
  */
25654
26011
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId, opts) {
25655
26012
  opts = opts || {};
@@ -25678,7 +26035,7 @@ class IntegrationsApi {
25678
26035
  *
25679
26036
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
25680
26037
  * @param {Object} settings
25681
- * Preview Endpoint
26038
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25682
26039
  */
25683
26040
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId, settings) {
25684
26041
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -25797,7 +26154,7 @@ class IntegrationsApi {
25797
26154
  *
25798
26155
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
25799
26156
  * @param {Object} settings
25800
- * Preview Endpoint
26157
+ * putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25801
26158
  */
25802
26159
  putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId, settings) {
25803
26160
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -25848,13 +26205,43 @@ class IntegrationsApi {
25848
26205
  );
25849
26206
  }
25850
26207
 
26208
+ /**
26209
+ * Bulk integration presence ingestion
26210
+ * This endpoint accepts bulk presence updates from a 3rd-party presence integration and maps the 3rd-party user to a Genesys Cloud user via the matching email address. The 3rd-party presence value will be mapped to a Genesys Cloud organization presence definition value.
26211
+ * @param {String} ucIntegrationId UC Integration ID
26212
+ * @param {Array.<Object>} body List of User presences
26213
+ */
26214
+ putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body) {
26215
+ // verify the required parameter 'ucIntegrationId' is set
26216
+ if (ucIntegrationId === undefined || ucIntegrationId === null) {
26217
+ throw 'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
26218
+ }
26219
+ // verify the required parameter 'body' is set
26220
+ if (body === undefined || body === null) {
26221
+ throw 'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
26222
+ }
26223
+
26224
+ return this.apiClient.callApi(
26225
+ '/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences',
26226
+ 'PUT',
26227
+ { 'ucIntegrationId': ucIntegrationId },
26228
+ { },
26229
+ { },
26230
+ { },
26231
+ body,
26232
+ ['PureCloud OAuth'],
26233
+ ['application/json'],
26234
+ ['application/json']
26235
+ );
26236
+ }
26237
+
25851
26238
  }
25852
26239
 
25853
26240
  class JourneyApi {
25854
26241
  /**
25855
26242
  * Journey service.
25856
26243
  * @module purecloud-platform-client-v2/api/JourneyApi
25857
- * @version 169.1.0
26244
+ * @version 170.0.0
25858
26245
  */
25859
26246
 
25860
26247
  /**
@@ -26002,7 +26389,7 @@ class JourneyApi {
26002
26389
  * Get status for async query for journey aggregates
26003
26390
  *
26004
26391
  * @param {String} jobId jobId
26005
- * Preview Endpoint
26392
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26006
26393
  */
26007
26394
  getAnalyticsJourneysAggregatesJob(jobId) {
26008
26395
  // verify the required parameter 'jobId' is set
@@ -26030,7 +26417,7 @@ class JourneyApi {
26030
26417
  * @param {String} jobId jobId
26031
26418
  * @param {Object} opts Optional parameters
26032
26419
  * @param {String} opts.cursor Cursor token to retrieve next page
26033
- * Preview Endpoint
26420
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26034
26421
  */
26035
26422
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
26036
26423
  opts = opts || {};
@@ -26265,42 +26652,6 @@ class JourneyApi {
26265
26652
  );
26266
26653
  }
26267
26654
 
26268
- /**
26269
- * Retrieve all sessions for a given customer.
26270
- *
26271
- * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
26272
- * @param {String} customerId Primary identifier of the customer in the source of the session.
26273
- * @param {Object} opts Optional parameters
26274
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
26275
- * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
26276
- * Preview Endpoint
26277
- */
26278
- getJourneyCustomerCustomerIdSessions(customerIdType, customerId, opts) {
26279
- opts = opts || {};
26280
-
26281
- // verify the required parameter 'customerIdType' is set
26282
- if (customerIdType === undefined || customerIdType === null) {
26283
- throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSessions';
26284
- }
26285
- // verify the required parameter 'customerId' is set
26286
- if (customerId === undefined || customerId === null) {
26287
- throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSessions';
26288
- }
26289
-
26290
- return this.apiClient.callApi(
26291
- '/api/v2/journey/customers/{customerIdType}/{customerId}/sessions',
26292
- 'GET',
26293
- { 'customerIdType': customerIdType,'customerId': customerId },
26294
- { 'pageSize': opts['pageSize'],'after': opts['after'] },
26295
- { },
26296
- { },
26297
- null,
26298
- ['PureCloud OAuth'],
26299
- ['application/json'],
26300
- ['application/json']
26301
- );
26302
- }
26303
-
26304
26655
  /**
26305
26656
  * Retrieve a single outcome.
26306
26657
  *
@@ -26359,7 +26710,7 @@ class JourneyApi {
26359
26710
  * Get job status.
26360
26711
  *
26361
26712
  * @param {String} jobId ID of the job.
26362
- * Preview Endpoint
26713
+ * getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26363
26714
  */
26364
26715
  getJourneyOutcomesAttributionsJob(jobId) {
26365
26716
  // verify the required parameter 'jobId' is set
@@ -26385,7 +26736,7 @@ class JourneyApi {
26385
26736
  * Get outcome attribution entities from completed job.
26386
26737
  *
26387
26738
  * @param {String} jobId ID of the job.
26388
- * Preview Endpoint
26739
+ * getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26389
26740
  */
26390
26741
  getJourneyOutcomesAttributionsJobResults(jobId) {
26391
26742
  // verify the required parameter 'jobId' is set
@@ -26539,7 +26890,7 @@ class JourneyApi {
26539
26890
  * @param {Object} opts Optional parameters
26540
26891
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
26541
26892
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
26542
- * Preview Endpoint
26893
+ * getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26543
26894
  */
26544
26895
  getJourneySessionEvents(sessionId, opts) {
26545
26896
  opts = opts || {};
@@ -26597,7 +26948,7 @@ class JourneyApi {
26597
26948
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
26598
26949
  * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
26599
26950
  * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
26600
- * Preview Endpoint
26951
+ * getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26601
26952
  */
26602
26953
  getJourneySessionSegments(sessionId, opts) {
26603
26954
  opts = opts || {};
@@ -26770,7 +27121,7 @@ class JourneyApi {
26770
27121
  * Query for journey aggregates asynchronously
26771
27122
  *
26772
27123
  * @param {Object} body query
26773
- * Preview Endpoint
27124
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26774
27125
  */
26775
27126
  postAnalyticsJourneysAggregatesJobs(body) {
26776
27127
  // verify the required parameter 'body' is set
@@ -26919,7 +27270,7 @@ class JourneyApi {
26919
27270
  *
26920
27271
  * @param {Object} opts Optional parameters
26921
27272
  * @param {Object} opts.body outcome attribution request
26922
- * Preview Endpoint
27273
+ * postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26923
27274
  */
26924
27275
  postJourneyOutcomesAttributionsJobs(opts) {
26925
27276
  opts = opts || {};
@@ -26993,7 +27344,7 @@ class KnowledgeApi {
26993
27344
  /**
26994
27345
  * Knowledge service.
26995
27346
  * @module purecloud-platform-client-v2/api/KnowledgeApi
26996
- * @version 169.1.0
27347
+ * @version 170.0.0
26997
27348
  */
26998
27349
 
26999
27350
  /**
@@ -27224,7 +27575,7 @@ class KnowledgeApi {
27224
27575
  * @param {String} categoryId Category ID
27225
27576
  * @param {String} knowledgeBaseId Knowledge base ID
27226
27577
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27227
- * @deprecated
27578
+ * @deprecated
27228
27579
  */
27229
27580
  deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
27230
27581
  // verify the required parameter 'categoryId' is set
@@ -27260,7 +27611,7 @@ class KnowledgeApi {
27260
27611
  * @param {String} documentId Document ID
27261
27612
  * @param {String} knowledgeBaseId Knowledge base ID
27262
27613
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27263
- * @deprecated
27614
+ * @deprecated
27264
27615
  */
27265
27616
  deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
27266
27617
  // verify the required parameter 'documentId' is set
@@ -27296,7 +27647,7 @@ class KnowledgeApi {
27296
27647
  * @param {String} knowledgeBaseId Knowledge base ID
27297
27648
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27298
27649
  * @param {String} importId Import ID
27299
- * @deprecated
27650
+ * @deprecated
27300
27651
  */
27301
27652
  deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
27302
27653
  // verify the required parameter 'knowledgeBaseId' is set
@@ -27798,6 +28149,7 @@ class KnowledgeApi {
27798
28149
  * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
27799
28150
  * @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
27800
28151
  * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
28152
+ * @param {Array.<String>} opts.externalIds If specified, retrieves documents associated with external ids, comma separated values expected.
27801
28153
  */
27802
28154
  getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
27803
28155
  opts = opts || {};
@@ -27811,7 +28163,7 @@ class KnowledgeApi {
27811
28163
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
27812
28164
  'GET',
27813
28165
  { 'knowledgeBaseId': knowledgeBaseId },
27814
- { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
28166
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'documentId': this.apiClient.buildCollectionParam(opts['documentId'], 'multi'),'categoryId': this.apiClient.buildCollectionParam(opts['categoryId'], 'multi'),'includeSubcategories': opts['includeSubcategories'],'includeDrafts': opts['includeDrafts'],'labelIds': this.apiClient.buildCollectionParam(opts['labelIds'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
27815
28167
  { },
27816
28168
  { },
27817
28169
  null,
@@ -27955,7 +28307,7 @@ class KnowledgeApi {
27955
28307
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
27956
28308
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
27957
28309
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
27958
- * @deprecated
28310
+ * @deprecated
27959
28311
  */
27960
28312
  getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
27961
28313
  opts = opts || {};
@@ -27989,7 +28341,7 @@ class KnowledgeApi {
27989
28341
  * @param {String} categoryId Category ID
27990
28342
  * @param {String} knowledgeBaseId Knowledge base ID
27991
28343
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27992
- * @deprecated
28344
+ * @deprecated
27993
28345
  */
27994
28346
  getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
27995
28347
  // verify the required parameter 'categoryId' is set
@@ -28025,7 +28377,7 @@ class KnowledgeApi {
28025
28377
  * @param {String} documentId Document ID
28026
28378
  * @param {String} knowledgeBaseId Knowledge base ID
28027
28379
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28028
- * @deprecated
28380
+ * @deprecated
28029
28381
  */
28030
28382
  getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
28031
28383
  // verify the required parameter 'documentId' is set
@@ -28062,8 +28414,8 @@ class KnowledgeApi {
28062
28414
  * @param {String} knowledgeBaseId Knowledge base ID
28063
28415
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28064
28416
  * @param {String} uploadId UploadId
28065
- * @deprecated
28066
- * Preview Endpoint
28417
+ * @deprecated
28418
+ * getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28067
28419
  */
28068
28420
  getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
28069
28421
  // verify the required parameter 'documentId' is set
@@ -28112,7 +28464,7 @@ class KnowledgeApi {
28112
28464
  * @param {Object} opts.sortBy Sort by.
28113
28465
  * @param {Object} opts.sortOrder Sort Order.
28114
28466
  * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
28115
- * @deprecated
28467
+ * @deprecated
28116
28468
  */
28117
28469
  getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
28118
28470
  opts = opts || {};
@@ -28146,7 +28498,7 @@ class KnowledgeApi {
28146
28498
  * @param {String} knowledgeBaseId Knowledge base ID
28147
28499
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28148
28500
  * @param {String} importId Import ID
28149
- * @deprecated
28501
+ * @deprecated
28150
28502
  */
28151
28503
  getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
28152
28504
  // verify the required parameter 'knowledgeBaseId' is set
@@ -28182,7 +28534,7 @@ class KnowledgeApi {
28182
28534
  * @param {String} knowledgeBaseId Knowledge base ID
28183
28535
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28184
28536
  * @param {String} trainingId Training ID
28185
- * @deprecated
28537
+ * @deprecated
28186
28538
  */
28187
28539
  getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
28188
28540
  // verify the required parameter 'knowledgeBaseId' is set
@@ -28223,7 +28575,7 @@ class KnowledgeApi {
28223
28575
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
28224
28576
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28225
28577
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
28226
- * @deprecated
28578
+ * @deprecated
28227
28579
  */
28228
28580
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
28229
28581
  opts = opts || {};
@@ -28671,7 +29023,7 @@ class KnowledgeApi {
28671
29023
  * @param {String} knowledgeBaseId Knowledge base ID
28672
29024
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28673
29025
  * @param {Object} body
28674
- * @deprecated
29026
+ * @deprecated
28675
29027
  */
28676
29028
  patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
28677
29029
  // verify the required parameter 'categoryId' is set
@@ -28712,7 +29064,7 @@ class KnowledgeApi {
28712
29064
  * @param {String} knowledgeBaseId Knowledge base ID
28713
29065
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28714
29066
  * @param {Object} body
28715
- * @deprecated
29067
+ * @deprecated
28716
29068
  */
28717
29069
  patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
28718
29070
  // verify the required parameter 'documentId' is set
@@ -28752,7 +29104,7 @@ class KnowledgeApi {
28752
29104
  * @param {String} knowledgeBaseId Knowledge base ID
28753
29105
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28754
29106
  * @param {Array.<Object>} body
28755
- * @deprecated
29107
+ * @deprecated
28756
29108
  */
28757
29109
  patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
28758
29110
  // verify the required parameter 'knowledgeBaseId' is set
@@ -28789,7 +29141,7 @@ class KnowledgeApi {
28789
29141
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28790
29142
  * @param {String} importId Import ID
28791
29143
  * @param {Object} body
28792
- * @deprecated
29144
+ * @deprecated
28793
29145
  */
28794
29146
  patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
28795
29147
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29107,7 +29459,7 @@ class KnowledgeApi {
29107
29459
  *
29108
29460
  * @param {String} knowledgeBaseId Knowledge base ID
29109
29461
  * @param {Object} body
29110
- * Preview Endpoint
29462
+ * postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29111
29463
  */
29112
29464
  postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
29113
29465
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29138,7 +29490,7 @@ class KnowledgeApi {
29138
29490
  *
29139
29491
  * @param {String} knowledgeBaseId Knowledge base ID
29140
29492
  * @param {Object} body
29141
- * Preview Endpoint
29493
+ * postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29142
29494
  */
29143
29495
  postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
29144
29496
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29228,7 +29580,7 @@ class KnowledgeApi {
29228
29580
  *
29229
29581
  * @param {String} knowledgeBaseId Knowledge base ID
29230
29582
  * @param {Object} body
29231
- * Preview Endpoint
29583
+ * postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29232
29584
  */
29233
29585
  postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
29234
29586
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29350,7 +29702,7 @@ class KnowledgeApi {
29350
29702
  * @param {String} knowledgeBaseId Knowledge base ID
29351
29703
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29352
29704
  * @param {Object} body
29353
- * @deprecated
29705
+ * @deprecated
29354
29706
  */
29355
29707
  postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
29356
29708
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29387,8 +29739,8 @@ class KnowledgeApi {
29387
29739
  * @param {String} knowledgeBaseId Knowledge base ID
29388
29740
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29389
29741
  * @param {Object} body
29390
- * @deprecated
29391
- * Preview Endpoint
29742
+ * @deprecated
29743
+ * postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29392
29744
  */
29393
29745
  postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
29394
29746
  // verify the required parameter 'documentId' is set
@@ -29428,7 +29780,7 @@ class KnowledgeApi {
29428
29780
  * @param {String} knowledgeBaseId Knowledge base ID
29429
29781
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29430
29782
  * @param {Object} body
29431
- * @deprecated
29783
+ * @deprecated
29432
29784
  */
29433
29785
  postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
29434
29786
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29464,7 +29816,7 @@ class KnowledgeApi {
29464
29816
  * @param {String} knowledgeBaseId Knowledge base ID
29465
29817
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29466
29818
  * @param {Object} body
29467
- * @deprecated
29819
+ * @deprecated
29468
29820
  */
29469
29821
  postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
29470
29822
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29500,7 +29852,7 @@ class KnowledgeApi {
29500
29852
  * @param {String} knowledgeBaseId Knowledge base ID
29501
29853
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29502
29854
  * @param {String} trainingId Training ID
29503
- * @deprecated
29855
+ * @deprecated
29504
29856
  */
29505
29857
  postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
29506
29858
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29535,7 +29887,7 @@ class KnowledgeApi {
29535
29887
  *
29536
29888
  * @param {String} knowledgeBaseId Knowledge base ID
29537
29889
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29538
- * @deprecated
29890
+ * @deprecated
29539
29891
  */
29540
29892
  postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
29541
29893
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29567,7 +29919,7 @@ class KnowledgeApi {
29567
29919
  * @param {String} knowledgeBaseId Knowledge base ID
29568
29920
  * @param {Object} opts Optional parameters
29569
29921
  * @param {Object} opts.body
29570
- * @deprecated
29922
+ * @deprecated
29571
29923
  */
29572
29924
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
29573
29925
  opts = opts || {};
@@ -29622,7 +29974,7 @@ class LanguageUnderstandingApi {
29622
29974
  /**
29623
29975
  * LanguageUnderstanding service.
29624
29976
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
29625
- * @version 169.1.0
29977
+ * @version 170.0.0
29626
29978
  */
29627
29979
 
29628
29980
  /**
@@ -30635,7 +30987,7 @@ class LanguagesApi {
30635
30987
  /**
30636
30988
  * Languages service.
30637
30989
  * @module purecloud-platform-client-v2/api/LanguagesApi
30638
- * @version 169.1.0
30990
+ * @version 170.0.0
30639
30991
  */
30640
30992
 
30641
30993
  /**
@@ -30654,7 +31006,7 @@ class LanguagesApi {
30654
31006
  * Delete Language (Deprecated)
30655
31007
  * This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
30656
31008
  * @param {String} languageId Language ID
30657
- * @deprecated
31009
+ * @deprecated
30658
31010
  */
30659
31011
  deleteLanguage(languageId) {
30660
31012
  // verify the required parameter 'languageId' is set
@@ -30680,7 +31032,7 @@ class LanguagesApi {
30680
31032
  * Get Language (Deprecated)
30681
31033
  * This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
30682
31034
  * @param {String} languageId Language ID
30683
- * @deprecated
31035
+ * @deprecated
30684
31036
  */
30685
31037
  getLanguage(languageId) {
30686
31038
  // verify the required parameter 'languageId' is set
@@ -30710,7 +31062,7 @@ class LanguagesApi {
30710
31062
  * @param {Number} opts.pageNumber Page number (default to 1)
30711
31063
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
30712
31064
  * @param {String} opts.name Name
30713
- * @deprecated
31065
+ * @deprecated
30714
31066
  */
30715
31067
  getLanguages(opts) {
30716
31068
  opts = opts || {};
@@ -30829,7 +31181,7 @@ class LanguagesApi {
30829
31181
  * Create Language (Deprecated)
30830
31182
  * This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
30831
31183
  * @param {Object} body Language
30832
- * @deprecated
31184
+ * @deprecated
30833
31185
  */
30834
31186
  postLanguages(body) {
30835
31187
  // verify the required parameter 'body' is set
@@ -30857,7 +31209,7 @@ class LearningApi {
30857
31209
  /**
30858
31210
  * Learning service.
30859
31211
  * @module purecloud-platform-client-v2/api/LearningApi
30860
- * @version 169.1.0
31212
+ * @version 170.0.0
30861
31213
  */
30862
31214
 
30863
31215
  /**
@@ -31672,7 +32024,7 @@ class LicenseApi {
31672
32024
  /**
31673
32025
  * License service.
31674
32026
  * @module purecloud-platform-client-v2/api/LicenseApi
31675
- * @version 169.1.0
32027
+ * @version 170.0.0
31676
32028
  */
31677
32029
 
31678
32030
  /**
@@ -31910,7 +32262,7 @@ class LocationsApi {
31910
32262
  /**
31911
32263
  * Locations service.
31912
32264
  * @module purecloud-platform-client-v2/api/LocationsApi
31913
- * @version 169.1.0
32265
+ * @version 170.0.0
31914
32266
  */
31915
32267
 
31916
32268
  /**
@@ -32146,7 +32498,7 @@ class MessagingApi {
32146
32498
  /**
32147
32499
  * Messaging service.
32148
32500
  * @module purecloud-platform-client-v2/api/MessagingApi
32149
- * @version 169.1.0
32501
+ * @version 170.0.0
32150
32502
  */
32151
32503
 
32152
32504
  /**
@@ -32165,7 +32517,7 @@ class MessagingApi {
32165
32517
  * Delete a supported content profile
32166
32518
  * Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
32167
32519
  * @param {String} supportedContentId Supported Content ID
32168
- * @deprecated
32520
+ * @deprecated
32169
32521
  */
32170
32522
  deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
32171
32523
  // verify the required parameter 'supportedContentId' is set
@@ -32193,7 +32545,7 @@ class MessagingApi {
32193
32545
  * @param {Object} opts Optional parameters
32194
32546
  * @param {Number} opts.pageSize Page size (default to 25)
32195
32547
  * @param {Number} opts.pageNumber Page number (default to 1)
32196
- * @deprecated
32548
+ * @deprecated
32197
32549
  */
32198
32550
  getMessagingSupportedcontent(opts) {
32199
32551
  opts = opts || {};
@@ -32217,7 +32569,7 @@ class MessagingApi {
32217
32569
  * Get a supported content profile
32218
32570
  * Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
32219
32571
  * @param {String} supportedContentId Supported Content ID
32220
- * @deprecated
32572
+ * @deprecated
32221
32573
  */
32222
32574
  getMessagingSupportedcontentSupportedContentId(supportedContentId) {
32223
32575
  // verify the required parameter 'supportedContentId' is set
@@ -32244,7 +32596,7 @@ class MessagingApi {
32244
32596
  * Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
32245
32597
  * @param {String} supportedContentId Supported Content ID
32246
32598
  * @param {Object} body SupportedContent
32247
- * @deprecated
32599
+ * @deprecated
32248
32600
  */
32249
32601
  patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
32250
32602
  // verify the required parameter 'supportedContentId' is set
@@ -32274,7 +32626,7 @@ class MessagingApi {
32274
32626
  * Create a Supported Content profile
32275
32627
  * Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
32276
32628
  * @param {Object} body SupportedContent
32277
- * @deprecated
32629
+ * @deprecated
32278
32630
  */
32279
32631
  postMessagingSupportedcontent(body) {
32280
32632
  // verify the required parameter 'body' is set
@@ -32302,7 +32654,7 @@ class MobileDevicesApi {
32302
32654
  /**
32303
32655
  * MobileDevices service.
32304
32656
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
32305
- * @version 169.1.0
32657
+ * @version 170.0.0
32306
32658
  */
32307
32659
 
32308
32660
  /**
@@ -32453,7 +32805,7 @@ class NotificationsApi {
32453
32805
  /**
32454
32806
  * Notifications service.
32455
32807
  * @module purecloud-platform-client-v2/api/NotificationsApi
32456
- * @version 169.1.0
32808
+ * @version 170.0.0
32457
32809
  */
32458
32810
 
32459
32811
  /**
@@ -32686,7 +33038,7 @@ class OAuthApi {
32686
33038
  /**
32687
33039
  * OAuth service.
32688
33040
  * @module purecloud-platform-client-v2/api/OAuthApi
32689
- * @version 169.1.0
33041
+ * @version 170.0.0
32690
33042
  */
32691
33043
 
32692
33044
  /**
@@ -33052,7 +33404,7 @@ class ObjectsApi {
33052
33404
  /**
33053
33405
  * Objects service.
33054
33406
  * @module purecloud-platform-client-v2/api/ObjectsApi
33055
- * @version 169.1.0
33407
+ * @version 170.0.0
33056
33408
  */
33057
33409
 
33058
33410
  /**
@@ -33323,7 +33675,7 @@ class OrganizationApi {
33323
33675
  /**
33324
33676
  * Organization service.
33325
33677
  * @module purecloud-platform-client-v2/api/OrganizationApi
33326
- * @version 169.1.0
33678
+ * @version 170.0.0
33327
33679
  */
33328
33680
 
33329
33681
  /**
@@ -33342,7 +33694,7 @@ class OrganizationApi {
33342
33694
  * Fetch field config for an entity type
33343
33695
  *
33344
33696
  * @param {Object} type Field type
33345
- * @deprecated
33697
+ * @deprecated
33346
33698
  */
33347
33699
  getFieldconfig(type) {
33348
33700
  // verify the required parameter 'type' is set
@@ -33387,7 +33739,7 @@ class OrganizationApi {
33387
33739
  /**
33388
33740
  * Get the list of domains that will be allowed to embed PureCloud applications
33389
33741
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33390
- * @deprecated
33742
+ * @deprecated
33391
33743
  */
33392
33744
  getOrganizationsEmbeddedintegration() {
33393
33745
 
@@ -33408,7 +33760,7 @@ class OrganizationApi {
33408
33760
  /**
33409
33761
  * Get organization IP address whitelist settings
33410
33762
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33411
- * @deprecated
33763
+ * @deprecated
33412
33764
  */
33413
33765
  getOrganizationsIpaddressauthentication() {
33414
33766
 
@@ -33597,7 +33949,7 @@ class OrganizationApi {
33597
33949
  /**
33598
33950
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33599
33951
  *
33600
- * @deprecated
33952
+ * @deprecated
33601
33953
  */
33602
33954
  getOrganizationsWhitelist() {
33603
33955
 
@@ -33674,7 +34026,7 @@ class OrganizationApi {
33674
34026
  * Update the list of domains that will be allowed to embed PureCloud applications
33675
34027
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33676
34028
  * @param {Object} body Whitelist settings
33677
- * @deprecated
34029
+ * @deprecated
33678
34030
  */
33679
34031
  putOrganizationsEmbeddedintegration(body) {
33680
34032
  // verify the required parameter 'body' is set
@@ -33700,7 +34052,7 @@ class OrganizationApi {
33700
34052
  * Update organization IP address whitelist settings
33701
34053
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33702
34054
  * @param {Object} body IP address Whitelist settings
33703
- * @deprecated
34055
+ * @deprecated
33704
34056
  */
33705
34057
  putOrganizationsIpaddressauthentication(body) {
33706
34058
  // verify the required parameter 'body' is set
@@ -33750,7 +34102,7 @@ class OrganizationApi {
33750
34102
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33751
34103
  *
33752
34104
  * @param {Object} body Whitelist settings
33753
- * @deprecated
34105
+ * @deprecated
33754
34106
  */
33755
34107
  putOrganizationsWhitelist(body) {
33756
34108
  // verify the required parameter 'body' is set
@@ -33778,7 +34130,7 @@ class OrganizationAuthorizationApi {
33778
34130
  /**
33779
34131
  * OrganizationAuthorization service.
33780
34132
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
33781
- * @version 169.1.0
34133
+ * @version 170.0.0
33782
34134
  */
33783
34135
 
33784
34136
  /**
@@ -33972,7 +34324,7 @@ class OrganizationAuthorizationApi {
33972
34324
  * Delete Bulk Org Trustees
33973
34325
  *
33974
34326
  * @param {Array.<String>} id Comma separated list of trustee ids to remove
33975
- * Preview Endpoint
34327
+ * deleteOrgauthorizationTrustees is a preview method and is subject to both breaking and non-breaking changes at any time without notice
33976
34328
  */
33977
34329
  deleteOrgauthorizationTrustees(id) {
33978
34330
  // verify the required parameter 'id' is set
@@ -34113,7 +34465,7 @@ class OrganizationAuthorizationApi {
34113
34465
  * Delete Bulk Org Trustors
34114
34466
  *
34115
34467
  * @param {Array.<String>} id Comma separated list of trustor ids to remove
34116
- * Preview Endpoint
34468
+ * deleteOrgauthorizationTrustors is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34117
34469
  */
34118
34470
  deleteOrgauthorizationTrustors(id) {
34119
34471
  // verify the required parameter 'id' is set
@@ -35125,7 +35477,7 @@ class OutboundApi {
35125
35477
  /**
35126
35478
  * Outbound service.
35127
35479
  * @module purecloud-platform-client-v2/api/OutboundApi
35128
- * @version 169.1.0
35480
+ * @version 170.0.0
35129
35481
  */
35130
35482
 
35131
35483
  /**
@@ -37610,7 +37962,7 @@ class OutboundApi {
37610
37962
  * This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
37611
37963
  * @param {String} campaignId Campaign ID
37612
37964
  * @param {Object} body ContactCallbackRequest
37613
- * @deprecated
37965
+ * @deprecated
37614
37966
  */
37615
37967
  postOutboundCampaignCallbackSchedule(campaignId, body) {
37616
37968
  // verify the required parameter 'campaignId' is set
@@ -38747,7 +39099,7 @@ class PresenceApi {
38747
39099
  /**
38748
39100
  * Presence service.
38749
39101
  * @module purecloud-platform-client-v2/api/PresenceApi
38750
- * @version 169.1.0
39102
+ * @version 170.0.0
38751
39103
  */
38752
39104
 
38753
39105
  /**
@@ -38766,12 +39118,12 @@ class PresenceApi {
38766
39118
  * Delete a Presence Definition
38767
39119
  *
38768
39120
  * @param {String} definitionId Presence Definition ID
38769
- * Preview Endpoint
39121
+ * deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38770
39122
  */
38771
- deletePresenceDefinition(definitionId) {
39123
+ deletePresenceDefinition0(definitionId) {
38772
39124
  // verify the required parameter 'definitionId' is set
38773
39125
  if (definitionId === undefined || definitionId === null) {
38774
- throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition';
39126
+ throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
38775
39127
  }
38776
39128
 
38777
39129
  return this.apiClient.callApi(
@@ -38842,12 +39194,12 @@ class PresenceApi {
38842
39194
  * Get a Presence Definition
38843
39195
  *
38844
39196
  * @param {String} definitionId Presence Definition ID
38845
- * Preview Endpoint
39197
+ * getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38846
39198
  */
38847
- getPresenceDefinition(definitionId) {
39199
+ getPresenceDefinition0(definitionId) {
38848
39200
  // verify the required parameter 'definitionId' is set
38849
39201
  if (definitionId === undefined || definitionId === null) {
38850
- throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition';
39202
+ throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
38851
39203
  }
38852
39204
 
38853
39205
  return this.apiClient.callApi(
@@ -38870,9 +39222,9 @@ class PresenceApi {
38870
39222
  * @param {Object} opts Optional parameters
38871
39223
  * @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
38872
39224
  * @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
38873
- * Preview Endpoint
39225
+ * getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38874
39226
  */
38875
- getPresenceDefinitions(opts) {
39227
+ getPresenceDefinitions0(opts) {
38876
39228
  opts = opts || {};
38877
39229
 
38878
39230
 
@@ -39115,6 +39467,59 @@ class PresenceApi {
39115
39467
  );
39116
39468
  }
39117
39469
 
39470
+ /**
39471
+ * Get bulk user presences for a single presence source
39472
+ *
39473
+ * @param {String} sourceId The requested presence source ID.
39474
+ * @param {Object} opts Optional parameters
39475
+ * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
39476
+ */
39477
+ getUsersPresenceBulk(sourceId, opts) {
39478
+ opts = opts || {};
39479
+
39480
+ // verify the required parameter 'sourceId' is set
39481
+ if (sourceId === undefined || sourceId === null) {
39482
+ throw 'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';
39483
+ }
39484
+
39485
+ return this.apiClient.callApi(
39486
+ '/api/v2/users/presences/{sourceId}/bulk',
39487
+ 'GET',
39488
+ { 'sourceId': sourceId },
39489
+ { 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
39490
+ { },
39491
+ { },
39492
+ null,
39493
+ ['PureCloud OAuth'],
39494
+ ['application/json'],
39495
+ ['application/json']
39496
+ );
39497
+ }
39498
+
39499
+ /**
39500
+ * Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
39501
+ *
39502
+ * @param {Object} opts Optional parameters
39503
+ * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
39504
+ */
39505
+ getUsersPresencesPurecloudBulk(opts) {
39506
+ opts = opts || {};
39507
+
39508
+
39509
+ return this.apiClient.callApi(
39510
+ '/api/v2/users/presences/purecloud/bulk',
39511
+ 'GET',
39512
+ { },
39513
+ { 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
39514
+ { },
39515
+ { },
39516
+ null,
39517
+ ['PureCloud OAuth'],
39518
+ ['application/json'],
39519
+ ['application/json']
39520
+ );
39521
+ }
39522
+
39118
39523
  /**
39119
39524
  * Patch a user's Presence
39120
39525
  * Patch a users presence for the specified source that is not specifically listed. This endpoint does not support registered presence sources. The presence object can be patched one of three ways. Option 1: Set the primary property to true. This will set the source defined in the path as the users primary presence source. Option 2: Provide the presenceDefinition value. The id is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
@@ -39184,12 +39589,12 @@ class PresenceApi {
39184
39589
  * Create a Presence Definition
39185
39590
  *
39186
39591
  * @param {Object} body The Presence Definition to create
39187
- * Preview Endpoint
39592
+ * postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39188
39593
  */
39189
- postPresenceDefinitions(body) {
39594
+ postPresenceDefinitions0(body) {
39190
39595
  // verify the required parameter 'body' is set
39191
39596
  if (body === undefined || body === null) {
39192
- throw 'Missing the required parameter "body" when calling postPresenceDefinitions';
39597
+ throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
39193
39598
  }
39194
39599
 
39195
39600
  return this.apiClient.callApi(
@@ -39261,16 +39666,16 @@ class PresenceApi {
39261
39666
  *
39262
39667
  * @param {String} definitionId Presence Definition ID
39263
39668
  * @param {Object} body The updated Presence Definition
39264
- * Preview Endpoint
39669
+ * putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39265
39670
  */
39266
- putPresenceDefinition(definitionId, body) {
39671
+ putPresenceDefinition0(definitionId, body) {
39267
39672
  // verify the required parameter 'definitionId' is set
39268
39673
  if (definitionId === undefined || definitionId === null) {
39269
- throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition';
39674
+ throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
39270
39675
  }
39271
39676
  // verify the required parameter 'body' is set
39272
39677
  if (body === undefined || body === null) {
39273
- throw 'Missing the required parameter "body" when calling putPresenceDefinition';
39678
+ throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
39274
39679
  }
39275
39680
 
39276
39681
  return this.apiClient.callApi(
@@ -39433,7 +39838,7 @@ class ProcessAutomationApi {
39433
39838
  /**
39434
39839
  * ProcessAutomation service.
39435
39840
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
39436
- * @version 169.1.0
39841
+ * @version 170.0.0
39437
39842
  */
39438
39843
 
39439
39844
  /**
@@ -39672,7 +40077,7 @@ class QualityApi {
39672
40077
  /**
39673
40078
  * Quality service.
39674
40079
  * @module purecloud-platform-client-v2/api/QualityApi
39675
- * @version 169.1.0
40080
+ * @version 170.0.0
39676
40081
  */
39677
40082
 
39678
40083
  /**
@@ -39755,7 +40160,7 @@ class QualityApi {
39755
40160
  * Delete an evaluation form.
39756
40161
  *
39757
40162
  * @param {String} formId Form ID
39758
- * @deprecated
40163
+ * @deprecated
39759
40164
  */
39760
40165
  deleteQualityForm(formId) {
39761
40166
  // verify the required parameter 'formId' is set
@@ -39831,7 +40236,7 @@ class QualityApi {
39831
40236
  * Get status for async query for evaluation aggregates
39832
40237
  *
39833
40238
  * @param {String} jobId jobId
39834
- * Preview Endpoint
40239
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39835
40240
  */
39836
40241
  getAnalyticsEvaluationsAggregatesJob(jobId) {
39837
40242
  // verify the required parameter 'jobId' is set
@@ -39859,7 +40264,7 @@ class QualityApi {
39859
40264
  * @param {String} jobId jobId
39860
40265
  * @param {Object} opts Optional parameters
39861
40266
  * @param {String} opts.cursor Cursor token to retrieve next page
39862
- * Preview Endpoint
40267
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39863
40268
  */
39864
40269
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
39865
40270
  opts = opts || {};
@@ -39887,7 +40292,7 @@ class QualityApi {
39887
40292
  * Get status for async query for survey aggregates
39888
40293
  *
39889
40294
  * @param {String} jobId jobId
39890
- * Preview Endpoint
40295
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39891
40296
  */
39892
40297
  getAnalyticsSurveysAggregatesJob(jobId) {
39893
40298
  // verify the required parameter 'jobId' is set
@@ -39915,7 +40320,7 @@ class QualityApi {
39915
40320
  * @param {String} jobId jobId
39916
40321
  * @param {Object} opts Optional parameters
39917
40322
  * @param {String} opts.cursor Cursor token to retrieve next page
39918
- * Preview Endpoint
40323
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39919
40324
  */
39920
40325
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
39921
40326
  opts = opts || {};
@@ -40236,7 +40641,7 @@ class QualityApi {
40236
40641
  * Get an evaluation form
40237
40642
  *
40238
40643
  * @param {String} formId Form ID
40239
- * @deprecated
40644
+ * @deprecated
40240
40645
  */
40241
40646
  getQualityForm(formId) {
40242
40647
  // verify the required parameter 'formId' is set
@@ -40265,7 +40670,7 @@ class QualityApi {
40265
40670
  * @param {Object} opts Optional parameters
40266
40671
  * @param {Number} opts.pageSize Page size (default to 25)
40267
40672
  * @param {Number} opts.pageNumber Page number (default to 1)
40268
- * @deprecated
40673
+ * @deprecated
40269
40674
  */
40270
40675
  getQualityFormVersions(formId, opts) {
40271
40676
  opts = opts || {};
@@ -40301,7 +40706,7 @@ class QualityApi {
40301
40706
  * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
40302
40707
  * @param {String} opts.name Name
40303
40708
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
40304
- * @deprecated
40709
+ * @deprecated
40305
40710
  */
40306
40711
  getQualityForms(opts) {
40307
40712
  opts = opts || {};
@@ -40577,7 +40982,7 @@ class QualityApi {
40577
40982
  * Get the published evaluation forms.
40578
40983
  *
40579
40984
  * @param {String} formId Form ID
40580
- * @deprecated
40985
+ * @deprecated
40581
40986
  */
40582
40987
  getQualityPublishedform(formId) {
40583
40988
  // verify the required parameter 'formId' is set
@@ -40607,7 +41012,7 @@ class QualityApi {
40607
41012
  * @param {Number} opts.pageNumber Page number (default to 1)
40608
41013
  * @param {String} opts.name Name
40609
41014
  * @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
40610
- * @deprecated
41015
+ * @deprecated
40611
41016
  */
40612
41017
  getQualityPublishedforms(opts) {
40613
41018
  opts = opts || {};
@@ -40815,7 +41220,7 @@ class QualityApi {
40815
41220
  * Query for evaluation aggregates asynchronously
40816
41221
  *
40817
41222
  * @param {Object} body query
40818
- * Preview Endpoint
41223
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
40819
41224
  */
40820
41225
  postAnalyticsEvaluationsAggregatesJobs(body) {
40821
41226
  // verify the required parameter 'body' is set
@@ -40866,7 +41271,7 @@ class QualityApi {
40866
41271
  * Query for survey aggregates asynchronously
40867
41272
  *
40868
41273
  * @param {Object} body query
40869
- * Preview Endpoint
41274
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
40870
41275
  */
40871
41276
  postAnalyticsSurveysAggregatesJobs(body) {
40872
41277
  // verify the required parameter 'body' is set
@@ -41055,7 +41460,7 @@ class QualityApi {
41055
41460
  * Create an evaluation form.
41056
41461
  *
41057
41462
  * @param {Object} body Evaluation form
41058
- * @deprecated
41463
+ * @deprecated
41059
41464
  */
41060
41465
  postQualityForms(body) {
41061
41466
  // verify the required parameter 'body' is set
@@ -41131,7 +41536,7 @@ class QualityApi {
41131
41536
  * Publish an evaluation form.
41132
41537
  *
41133
41538
  * @param {Object} body Publish request containing id of form to publish
41134
- * @deprecated
41539
+ * @deprecated
41135
41540
  */
41136
41541
  postQualityPublishedforms(body) {
41137
41542
  // verify the required parameter 'body' is set
@@ -41302,7 +41707,7 @@ class QualityApi {
41302
41707
  *
41303
41708
  * @param {String} formId Form ID
41304
41709
  * @param {Object} body Evaluation form
41305
- * @deprecated
41710
+ * @deprecated
41306
41711
  */
41307
41712
  putQualityForm(formId, body) {
41308
41713
  // verify the required parameter 'formId' is set
@@ -41424,7 +41829,7 @@ class RecordingApi {
41424
41829
  /**
41425
41830
  * Recording service.
41426
41831
  * @module purecloud-platform-client-v2/api/RecordingApi
41427
- * @version 169.1.0
41832
+ * @version 170.0.0
41428
41833
  */
41429
41834
 
41430
41835
  /**
@@ -43061,7 +43466,7 @@ class ResponseManagementApi {
43061
43466
  /**
43062
43467
  * ResponseManagement service.
43063
43468
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
43064
- * @version 169.1.0
43469
+ * @version 170.0.0
43065
43470
  */
43066
43471
 
43067
43472
  /**
@@ -43546,7 +43951,7 @@ class RoutingApi {
43546
43951
  /**
43547
43952
  * Routing service.
43548
43953
  * @module purecloud-platform-client-v2/api/RoutingApi
43549
- * @version 169.1.0
43954
+ * @version 170.0.0
43550
43955
  */
43551
43956
 
43552
43957
  /**
@@ -43780,7 +44185,7 @@ class RoutingApi {
43780
44185
  *
43781
44186
  * @param {String} queueId Queue ID
43782
44187
  * @param {String} memberId Member ID
43783
- * @deprecated
44188
+ * @deprecated
43784
44189
  */
43785
44190
  deleteRoutingQueueUser(queueId, memberId) {
43786
44191
  // verify the required parameter 'queueId' is set
@@ -44007,7 +44412,7 @@ class RoutingApi {
44007
44412
  * @param {String} tagId Utilization Tag ID
44008
44413
  * @param {Object} opts Optional parameters
44009
44414
  * @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
44010
- * Preview Endpoint
44415
+ * deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
44011
44416
  */
44012
44417
  deleteRoutingUtilizationTag(tagId, opts) {
44013
44418
  opts = opts || {};
@@ -44902,7 +45307,7 @@ class RoutingApi {
44902
45307
  * @param {Array.<String>} opts.languages Filter by language
44903
45308
  * @param {Array.<String>} opts.routingStatus Filter by routing status
44904
45309
  * @param {Array.<String>} opts.presence Filter by presence
44905
- * @deprecated
45310
+ * @deprecated
44906
45311
  */
44907
45312
  getRoutingQueueUsers(queueId, opts) {
44908
45313
  opts = opts || {};
@@ -45494,7 +45899,7 @@ class RoutingApi {
45494
45899
  * Get details about this utilization tag
45495
45900
  *
45496
45901
  * @param {String} tagId Utilization Tag ID
45497
- * Preview Endpoint
45902
+ * getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45498
45903
  */
45499
45904
  getRoutingUtilizationTag(tagId) {
45500
45905
  // verify the required parameter 'tagId' is set
@@ -45520,7 +45925,7 @@ class RoutingApi {
45520
45925
  * Get list of agent ids associated with a utilization tag
45521
45926
  *
45522
45927
  * @param {String} tagId Utilization Tag ID
45523
- * Preview Endpoint
45928
+ * getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45524
45929
  */
45525
45930
  getRoutingUtilizationTagAgents(tagId) {
45526
45931
  // verify the required parameter 'tagId' is set
@@ -45550,7 +45955,7 @@ class RoutingApi {
45550
45955
  * @param {Number} opts.pageNumber Page number (default to 1)
45551
45956
  * @param {Object} opts.sortOrder Sort order by name (default to ascending)
45552
45957
  * @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
45553
- * Preview Endpoint
45958
+ * getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45554
45959
  */
45555
45960
  getRoutingUtilizationTags(opts) {
45556
45961
  opts = opts || {};
@@ -45940,7 +46345,7 @@ class RoutingApi {
45940
46345
  * @param {String} queueId Queue ID
45941
46346
  * @param {String} memberId Member ID
45942
46347
  * @param {Object} body Queue Member
45943
- * @deprecated
46348
+ * @deprecated
45944
46349
  */
45945
46350
  patchRoutingQueueUser(queueId, memberId, body) {
45946
46351
  // verify the required parameter 'queueId' is set
@@ -45975,7 +46380,7 @@ class RoutingApi {
45975
46380
  *
45976
46381
  * @param {String} queueId Queue ID
45977
46382
  * @param {Array.<Object>} body Queue Members
45978
- * @deprecated
46383
+ * @deprecated
45979
46384
  */
45980
46385
  patchRoutingQueueUsers(queueId, body) {
45981
46386
  // verify the required parameter 'queueId' is set
@@ -46252,7 +46657,7 @@ class RoutingApi {
46252
46657
  * @param {Object} opts Optional parameters
46253
46658
  * @param {Number} opts.pageSize The desired page size
46254
46659
  * @param {Number} opts.pageNumber The desired page number
46255
- * Preview Endpoint
46660
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
46256
46661
  */
46257
46662
  postAnalyticsRoutingActivityQuery(body, opts) {
46258
46663
  opts = opts || {};
@@ -46548,7 +46953,7 @@ class RoutingApi {
46548
46953
  * @param {Array.<Object>} body Queue Members
46549
46954
  * @param {Object} opts Optional parameters
46550
46955
  * @param {Boolean} opts._delete True to delete queue members (default to false)
46551
- * @deprecated
46956
+ * @deprecated
46552
46957
  */
46553
46958
  postRoutingQueueUsers(queueId, body, opts) {
46554
46959
  opts = opts || {};
@@ -46764,7 +47169,7 @@ class RoutingApi {
46764
47169
  * Imports a phone number for SMS
46765
47170
  *
46766
47171
  * @param {Object} body SmsPhoneNumber
46767
- * Preview Endpoint
47172
+ * postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
46768
47173
  */
46769
47174
  postRoutingSmsPhonenumbersImport(body) {
46770
47175
  // verify the required parameter 'body' is set
@@ -46790,7 +47195,7 @@ class RoutingApi {
46790
47195
  * Create an utilization tag
46791
47196
  *
46792
47197
  * @param {Object} body UtilizationTag
46793
- * Preview Endpoint
47198
+ * postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
46794
47199
  */
46795
47200
  postRoutingUtilizationTags(body) {
46796
47201
  // verify the required parameter 'body' is set
@@ -47253,7 +47658,7 @@ class SCIMApi {
47253
47658
  /**
47254
47659
  * SCIM service.
47255
47660
  * @module purecloud-platform-client-v2/api/SCIMApi
47256
- * @version 169.1.0
47661
+ * @version 170.0.0
47257
47662
  */
47258
47663
 
47259
47664
  /**
@@ -48130,7 +48535,7 @@ class ScriptsApi {
48130
48535
  /**
48131
48536
  * Scripts service.
48132
48537
  * @module purecloud-platform-client-v2/api/ScriptsApi
48133
- * @version 169.1.0
48538
+ * @version 170.0.0
48134
48539
  */
48135
48540
 
48136
48541
  /**
@@ -48549,7 +48954,7 @@ class SearchApi {
48549
48954
  /**
48550
48955
  * Search service.
48551
48956
  * @module purecloud-platform-client-v2/api/SearchApi
48552
- * @version 169.1.0
48957
+ * @version 170.0.0
48553
48958
  */
48554
48959
 
48555
48960
  /**
@@ -48845,7 +49250,7 @@ class SearchApi {
48845
49250
  * Search all documents
48846
49251
  *
48847
49252
  * @param {Object} body Search request options
48848
- * Preview Endpoint
49253
+ * postDocumentationAllSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48849
49254
  */
48850
49255
  postDocumentationAllSearch(body) {
48851
49256
  // verify the required parameter 'body' is set
@@ -48948,7 +49353,7 @@ class SearchApi {
48948
49353
  * @param {String} knowledgeBaseId Knowledge base ID
48949
49354
  * @param {Object} opts Optional parameters
48950
49355
  * @param {Object} opts.body
48951
- * @deprecated
49356
+ * @deprecated
48952
49357
  */
48953
49358
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
48954
49359
  opts = opts || {};
@@ -49134,7 +49539,7 @@ class SearchApi {
49134
49539
  * Search users as conversation targets
49135
49540
  *
49136
49541
  * @param {Object} body Search request options
49137
- * Preview Endpoint
49542
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49138
49543
  */
49139
49544
  postUsersSearchConversationTarget(body) {
49140
49545
  // verify the required parameter 'body' is set
@@ -49160,7 +49565,7 @@ class SearchApi {
49160
49565
  * Search manage queue member
49161
49566
  *
49162
49567
  * @param {Object} body Search request options
49163
- * Preview Endpoint
49568
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49164
49569
  */
49165
49570
  postUsersSearchQueuemembersManage(body) {
49166
49571
  // verify the required parameter 'body' is set
@@ -49238,7 +49643,7 @@ class SpeechTextAnalyticsApi {
49238
49643
  /**
49239
49644
  * SpeechTextAnalytics service.
49240
49645
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
49241
- * @version 169.1.0
49646
+ * @version 170.0.0
49242
49647
  */
49243
49648
 
49244
49649
  /**
@@ -50191,7 +50596,7 @@ class StationsApi {
50191
50596
  /**
50192
50597
  * Stations service.
50193
50598
  * @module purecloud-platform-client-v2/api/StationsApi
50194
- * @version 169.1.0
50599
+ * @version 170.0.0
50195
50600
  */
50196
50601
 
50197
50602
  /**
@@ -50293,7 +50698,7 @@ class SuggestApi {
50293
50698
  /**
50294
50699
  * Suggest service.
50295
50700
  * @module purecloud-platform-client-v2/api/SuggestApi
50296
- * @version 169.1.0
50701
+ * @version 170.0.0
50297
50702
  */
50298
50703
 
50299
50704
  /**
@@ -50432,7 +50837,7 @@ class TaskManagementApi {
50432
50837
  /**
50433
50838
  * TaskManagement service.
50434
50839
  * @module purecloud-platform-client-v2/api/TaskManagementApi
50435
- * @version 169.1.0
50840
+ * @version 170.0.0
50436
50841
  */
50437
50842
 
50438
50843
  /**
@@ -50451,7 +50856,7 @@ class TaskManagementApi {
50451
50856
  * Delete a workbin
50452
50857
  *
50453
50858
  * @param {String} workbinId Workbin ID
50454
- * Preview Endpoint
50859
+ * deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50455
50860
  */
50456
50861
  deleteTaskmanagementWorkbin(workbinId) {
50457
50862
  // verify the required parameter 'workbinId' is set
@@ -50477,7 +50882,7 @@ class TaskManagementApi {
50477
50882
  * Delete a workitem
50478
50883
  *
50479
50884
  * @param {String} workitemId Workitem ID
50480
- * Preview Endpoint
50885
+ * deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50481
50886
  */
50482
50887
  deleteTaskmanagementWorkitem(workitemId) {
50483
50888
  // verify the required parameter 'workitemId' is set
@@ -50503,7 +50908,7 @@ class TaskManagementApi {
50503
50908
  * Delete a schema
50504
50909
  *
50505
50910
  * @param {String} schemaId Schema ID
50506
- * Preview Endpoint
50911
+ * deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50507
50912
  */
50508
50913
  deleteTaskmanagementWorkitemsSchema(schemaId) {
50509
50914
  // verify the required parameter 'schemaId' is set
@@ -50529,7 +50934,7 @@ class TaskManagementApi {
50529
50934
  * Delete a worktype
50530
50935
  *
50531
50936
  * @param {String} worktypeId Worktype id
50532
- * Preview Endpoint
50937
+ * deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50533
50938
  */
50534
50939
  deleteTaskmanagementWorktype(worktypeId) {
50535
50940
  // verify the required parameter 'worktypeId' is set
@@ -50556,7 +50961,7 @@ class TaskManagementApi {
50556
50961
  *
50557
50962
  * @param {String} worktypeId Worktype id
50558
50963
  * @param {String} statusId Status id
50559
- * Preview Endpoint
50964
+ * deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50560
50965
  */
50561
50966
  deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
50562
50967
  // verify the required parameter 'worktypeId' is set
@@ -50586,7 +50991,7 @@ class TaskManagementApi {
50586
50991
  * Get a workbin
50587
50992
  *
50588
50993
  * @param {String} workbinId Workbin ID
50589
- * Preview Endpoint
50994
+ * getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50590
50995
  */
50591
50996
  getTaskmanagementWorkbin(workbinId) {
50592
50997
  // verify the required parameter 'workbinId' is set
@@ -50616,7 +51021,7 @@ class TaskManagementApi {
50616
51021
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50617
51022
  * @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)
50618
51023
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50619
- * Preview Endpoint
51024
+ * getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50620
51025
  */
50621
51026
  getTaskmanagementWorkbinHistory(workbinId, opts) {
50622
51027
  opts = opts || {};
@@ -50645,7 +51050,7 @@ class TaskManagementApi {
50645
51050
  *
50646
51051
  * @param {String} workbinId Workbin ID
50647
51052
  * @param {Number} entityVersion Workbin version
50648
- * Preview Endpoint
51053
+ * getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50649
51054
  */
50650
51055
  getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
50651
51056
  // verify the required parameter 'workbinId' is set
@@ -50679,7 +51084,7 @@ class TaskManagementApi {
50679
51084
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50680
51085
  * @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)
50681
51086
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50682
- * Preview Endpoint
51087
+ * getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50683
51088
  */
50684
51089
  getTaskmanagementWorkbinVersions(workbinId, opts) {
50685
51090
  opts = opts || {};
@@ -50707,9 +51112,13 @@ class TaskManagementApi {
50707
51112
  * Get a workitem
50708
51113
  *
50709
51114
  * @param {String} workitemId Workitem ID
50710
- * Preview Endpoint
51115
+ * @param {Object} opts Optional parameters
51116
+ * @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
51117
+ * getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50711
51118
  */
50712
- getTaskmanagementWorkitem(workitemId) {
51119
+ getTaskmanagementWorkitem(workitemId, opts) {
51120
+ opts = opts || {};
51121
+
50713
51122
  // verify the required parameter 'workitemId' is set
50714
51123
  if (workitemId === undefined || workitemId === null) {
50715
51124
  throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';
@@ -50719,7 +51128,7 @@ class TaskManagementApi {
50719
51128
  '/api/v2/taskmanagement/workitems/{workitemId}',
50720
51129
  'GET',
50721
51130
  { 'workitemId': workitemId },
50722
- { },
51131
+ { 'expands': opts['expands'] },
50723
51132
  { },
50724
51133
  { },
50725
51134
  null,
@@ -50737,7 +51146,7 @@ class TaskManagementApi {
50737
51146
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50738
51147
  * @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)
50739
51148
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50740
- * Preview Endpoint
51149
+ * getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50741
51150
  */
50742
51151
  getTaskmanagementWorkitemHistory(workitemId, opts) {
50743
51152
  opts = opts || {};
@@ -50771,7 +51180,7 @@ class TaskManagementApi {
50771
51180
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50772
51181
  * @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)
50773
51182
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50774
- * Preview Endpoint
51183
+ * getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50775
51184
  */
50776
51185
  getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
50777
51186
  opts = opts || {};
@@ -50804,7 +51213,7 @@ class TaskManagementApi {
50804
51213
  *
50805
51214
  * @param {String} workitemId Workitem ID
50806
51215
  * @param {Number} entityVersion Workitem version
50807
- * Preview Endpoint
51216
+ * getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50808
51217
  */
50809
51218
  getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
50810
51219
  // verify the required parameter 'workitemId' is set
@@ -50838,7 +51247,7 @@ class TaskManagementApi {
50838
51247
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50839
51248
  * @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)
50840
51249
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50841
- * Preview Endpoint
51250
+ * getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50842
51251
  */
50843
51252
  getTaskmanagementWorkitemVersions(workitemId, opts) {
50844
51253
  opts = opts || {};
@@ -50871,7 +51280,7 @@ class TaskManagementApi {
50871
51280
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50872
51281
  * @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)
50873
51282
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50874
- * Preview Endpoint
51283
+ * getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50875
51284
  */
50876
51285
  getTaskmanagementWorkitemWrapups(workitemId, opts) {
50877
51286
  opts = opts || {};
@@ -50899,7 +51308,7 @@ class TaskManagementApi {
50899
51308
  * Get a schema
50900
51309
  *
50901
51310
  * @param {String} schemaId Schema ID
50902
- * Preview Endpoint
51311
+ * getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50903
51312
  */
50904
51313
  getTaskmanagementWorkitemsSchema(schemaId) {
50905
51314
  // verify the required parameter 'schemaId' is set
@@ -50926,7 +51335,7 @@ class TaskManagementApi {
50926
51335
  *
50927
51336
  * @param {String} schemaId Schema ID
50928
51337
  * @param {String} versionId Schema version
50929
- * Preview Endpoint
51338
+ * getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50930
51339
  */
50931
51340
  getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
50932
51341
  // verify the required parameter 'schemaId' is set
@@ -50956,7 +51365,7 @@ class TaskManagementApi {
50956
51365
  * Get all versions of a schema
50957
51366
  *
50958
51367
  * @param {String} schemaId Schema ID
50959
- * Preview Endpoint
51368
+ * getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50960
51369
  */
50961
51370
  getTaskmanagementWorkitemsSchemaVersions(schemaId) {
50962
51371
  // verify the required parameter 'schemaId' is set
@@ -50981,7 +51390,7 @@ class TaskManagementApi {
50981
51390
  /**
50982
51391
  * Get a list of schemas.
50983
51392
  *
50984
- * Preview Endpoint
51393
+ * getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50985
51394
  */
50986
51395
  getTaskmanagementWorkitemsSchemas() {
50987
51396
 
@@ -51005,7 +51414,7 @@ class TaskManagementApi {
51005
51414
  * @param {String} worktypeId Worktype id
51006
51415
  * @param {Object} opts Optional parameters
51007
51416
  * @param {Array.<String>} opts.expands Which fields, if any, to expand.
51008
- * Preview Endpoint
51417
+ * getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51009
51418
  */
51010
51419
  getTaskmanagementWorktype(worktypeId, opts) {
51011
51420
  opts = opts || {};
@@ -51037,7 +51446,7 @@ class TaskManagementApi {
51037
51446
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
51038
51447
  * @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)
51039
51448
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
51040
- * Preview Endpoint
51449
+ * getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51041
51450
  */
51042
51451
  getTaskmanagementWorktypeHistory(worktypeId, opts) {
51043
51452
  opts = opts || {};
@@ -51066,7 +51475,7 @@ class TaskManagementApi {
51066
51475
  *
51067
51476
  * @param {String} worktypeId Worktype id
51068
51477
  * @param {String} statusId Status id
51069
- * Preview Endpoint
51478
+ * getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51070
51479
  */
51071
51480
  getTaskmanagementWorktypeStatus(worktypeId, statusId) {
51072
51481
  // verify the required parameter 'worktypeId' is set
@@ -51097,7 +51506,7 @@ class TaskManagementApi {
51097
51506
  *
51098
51507
  * @param {String} worktypeId Worktype id
51099
51508
  * @param {Number} entityVersion Worktype version
51100
- * Preview Endpoint
51509
+ * getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51101
51510
  */
51102
51511
  getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
51103
51512
  // verify the required parameter 'worktypeId' is set
@@ -51131,7 +51540,7 @@ class TaskManagementApi {
51131
51540
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
51132
51541
  * @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)
51133
51542
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
51134
- * Preview Endpoint
51543
+ * getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51135
51544
  */
51136
51545
  getTaskmanagementWorktypeVersions(worktypeId, opts) {
51137
51546
  opts = opts || {};
@@ -51160,7 +51569,7 @@ class TaskManagementApi {
51160
51569
  *
51161
51570
  * @param {String} workbinId Workbin ID
51162
51571
  * @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
51163
- * Preview Endpoint
51572
+ * patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51164
51573
  */
51165
51574
  patchTaskmanagementWorkbin(workbinId, body) {
51166
51575
  // verify the required parameter 'workbinId' is set
@@ -51191,7 +51600,7 @@ class TaskManagementApi {
51191
51600
  *
51192
51601
  * @param {String} workitemId Workitem ID
51193
51602
  * @param {Object} body Workitem
51194
- * Preview Endpoint
51603
+ * patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51195
51604
  */
51196
51605
  patchTaskmanagementWorkitem(workitemId, body) {
51197
51606
  // verify the required parameter 'workitemId' is set
@@ -51222,7 +51631,7 @@ class TaskManagementApi {
51222
51631
  *
51223
51632
  * @param {String} workitemId Workitem ID
51224
51633
  * @param {Object} body Targeted user
51225
- * Preview Endpoint
51634
+ * patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51226
51635
  */
51227
51636
  patchTaskmanagementWorkitemAssignment(workitemId, body) {
51228
51637
  // verify the required parameter 'workitemId' is set
@@ -51254,7 +51663,7 @@ class TaskManagementApi {
51254
51663
  * @param {String} workitemId The ID of the Workitem.
51255
51664
  * @param {String} userId The ID of the user
51256
51665
  * @param {Object} body Request body to add/remove a wrapup code for a workitem
51257
- * Preview Endpoint
51666
+ * patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51258
51667
  */
51259
51668
  patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
51260
51669
  // verify the required parameter 'workitemId' is set
@@ -51289,7 +51698,7 @@ class TaskManagementApi {
51289
51698
  *
51290
51699
  * @param {String} workitemId The ID of the Workitem.
51291
51700
  * @param {Object} body Request body to add/remove the wrapup code for workitem
51292
- * Preview Endpoint
51701
+ * patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51293
51702
  */
51294
51703
  patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
51295
51704
  // verify the required parameter 'workitemId' is set
@@ -51321,7 +51730,7 @@ class TaskManagementApi {
51321
51730
  * @param {String} worktypeId Worktype id
51322
51731
  * @param {Object} opts Optional parameters
51323
51732
  * @param {Object} opts.body body
51324
- * Preview Endpoint
51733
+ * patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51325
51734
  */
51326
51735
  patchTaskmanagementWorktype(worktypeId, opts) {
51327
51736
  opts = opts || {};
@@ -51352,7 +51761,7 @@ class TaskManagementApi {
51352
51761
  * @param {String} statusId Status id
51353
51762
  * @param {Object} opts Optional parameters
51354
51763
  * @param {Object} opts.body body
51355
- * Preview Endpoint
51764
+ * patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51356
51765
  */
51357
51766
  patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
51358
51767
  opts = opts || {};
@@ -51385,7 +51794,7 @@ class TaskManagementApi {
51385
51794
  *
51386
51795
  * @param {Object} opts Optional parameters
51387
51796
  * @param {Object} opts.body body
51388
- * Preview Endpoint
51797
+ * postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51389
51798
  */
51390
51799
  postTaskmanagementWorkbins(opts) {
51391
51800
  opts = opts || {};
@@ -51409,7 +51818,7 @@ class TaskManagementApi {
51409
51818
  * Query for workbins
51410
51819
  *
51411
51820
  * @param {Object} body QueryPostRequest
51412
- * Preview Endpoint
51821
+ * postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51413
51822
  */
51414
51823
  postTaskmanagementWorkbinsQuery(body) {
51415
51824
  // verify the required parameter 'body' is set
@@ -51435,7 +51844,7 @@ class TaskManagementApi {
51435
51844
  * Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
51436
51845
  *
51437
51846
  * @param {String} workitemId Workitem ID
51438
- * Preview Endpoint
51847
+ * postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51439
51848
  */
51440
51849
  postTaskmanagementWorkitemAcdCancel(workitemId) {
51441
51850
  // verify the required parameter 'workitemId' is set
@@ -51461,7 +51870,7 @@ class TaskManagementApi {
51461
51870
  * Disconnect the assignee of the workitem
51462
51871
  *
51463
51872
  * @param {String} workitemId Workitem ID
51464
- * Preview Endpoint
51873
+ * postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51465
51874
  */
51466
51875
  postTaskmanagementWorkitemDisconnect(workitemId) {
51467
51876
  // verify the required parameter 'workitemId' is set
@@ -51489,7 +51898,7 @@ class TaskManagementApi {
51489
51898
  * @param {String} workitemId Workitem ID
51490
51899
  * @param {Object} opts Optional parameters
51491
51900
  * @param {Object} opts.body Terminated request
51492
- * Preview Endpoint
51901
+ * postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51493
51902
  */
51494
51903
  postTaskmanagementWorkitemTerminate(workitemId, opts) {
51495
51904
  opts = opts || {};
@@ -51517,7 +51926,7 @@ class TaskManagementApi {
51517
51926
  * Create a workitem
51518
51927
  *
51519
51928
  * @param {Object} body Workitem
51520
- * Preview Endpoint
51929
+ * postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51521
51930
  */
51522
51931
  postTaskmanagementWorkitems(body) {
51523
51932
  // verify the required parameter 'body' is set
@@ -51543,7 +51952,7 @@ class TaskManagementApi {
51543
51952
  * Query for workitems
51544
51953
  * This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
51545
51954
  * @param {Object} body WorkitemQueryPostRequest
51546
- * Preview Endpoint
51955
+ * postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51547
51956
  */
51548
51957
  postTaskmanagementWorkitemsQuery(body) {
51549
51958
  // verify the required parameter 'body' is set
@@ -51569,7 +51978,7 @@ class TaskManagementApi {
51569
51978
  * Create a schema
51570
51979
  *
51571
51980
  * @param {Object} body Schema
51572
- * Preview Endpoint
51981
+ * postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51573
51982
  */
51574
51983
  postTaskmanagementWorkitemsSchemas(body) {
51575
51984
  // verify the required parameter 'body' is set
@@ -51597,7 +52006,7 @@ class TaskManagementApi {
51597
52006
  * @param {String} worktypeId Worktype id
51598
52007
  * @param {Object} opts Optional parameters
51599
52008
  * @param {Object} opts.body body
51600
- * Preview Endpoint
52009
+ * postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51601
52010
  */
51602
52011
  postTaskmanagementWorktypeStatuses(worktypeId, opts) {
51603
52012
  opts = opts || {};
@@ -51626,7 +52035,7 @@ class TaskManagementApi {
51626
52035
  *
51627
52036
  * @param {Object} opts Optional parameters
51628
52037
  * @param {Object} opts.body body
51629
- * Preview Endpoint
52038
+ * postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51630
52039
  */
51631
52040
  postTaskmanagementWorktypes(opts) {
51632
52041
  opts = opts || {};
@@ -51650,7 +52059,7 @@ class TaskManagementApi {
51650
52059
  * Query for worktypes
51651
52060
  *
51652
52061
  * @param {Object} body QueryPostRequest
51653
- * Preview Endpoint
52062
+ * postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51654
52063
  */
51655
52064
  postTaskmanagementWorktypesQuery(body) {
51656
52065
  // verify the required parameter 'body' is set
@@ -51677,7 +52086,7 @@ class TaskManagementApi {
51677
52086
  *
51678
52087
  * @param {String} schemaId Schema ID
51679
52088
  * @param {Object} body Data Schema
51680
- * Preview Endpoint
52089
+ * putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51681
52090
  */
51682
52091
  putTaskmanagementWorkitemsSchema(schemaId, body) {
51683
52092
  // verify the required parameter 'schemaId' is set
@@ -51709,7 +52118,7 @@ class TeamsApi {
51709
52118
  /**
51710
52119
  * Teams service.
51711
52120
  * @module purecloud-platform-client-v2/api/TeamsApi
51712
- * @version 169.1.0
52121
+ * @version 170.0.0
51713
52122
  */
51714
52123
 
51715
52124
  /**
@@ -51901,7 +52310,7 @@ class TeamsApi {
51901
52310
  * @param {Object} opts Optional parameters
51902
52311
  * @param {Number} opts.pageSize The desired page size
51903
52312
  * @param {Number} opts.pageNumber The desired page number
51904
- * Preview Endpoint
52313
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51905
52314
  */
51906
52315
  postAnalyticsTeamsActivityQuery(body, opts) {
51907
52316
  opts = opts || {};
@@ -52011,7 +52420,7 @@ class TelephonyApi {
52011
52420
  /**
52012
52421
  * Telephony service.
52013
52422
  * @module purecloud-platform-client-v2/api/TelephonyApi
52014
- * @version 169.1.0
52423
+ * @version 170.0.0
52015
52424
  */
52016
52425
 
52017
52426
  /**
@@ -52139,7 +52548,7 @@ class TelephonyProvidersEdgeApi {
52139
52548
  /**
52140
52549
  * TelephonyProvidersEdge service.
52141
52550
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
52142
- * @version 169.1.0
52551
+ * @version 170.0.0
52143
52552
  */
52144
52553
 
52145
52554
  /**
@@ -53327,7 +53736,7 @@ class TelephonyProvidersEdgeApi {
53327
53736
  * @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
53328
53737
  * @param {String} opts.name Name of the Extension Pools to filter by.
53329
53738
  * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
53330
- * Preview Endpoint
53739
+ * getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53331
53740
  */
53332
53741
  getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
53333
53742
  opts = opts || {};
@@ -53564,7 +53973,7 @@ class TelephonyProvidersEdgeApi {
53564
53973
  * Get outbound route
53565
53974
  * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
53566
53975
  * @param {String} outboundRouteId Outbound route ID
53567
- * @deprecated
53976
+ * @deprecated
53568
53977
  */
53569
53978
  getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
53570
53979
  // verify the required parameter 'outboundRouteId' is set
@@ -53760,7 +54169,7 @@ class TelephonyProvidersEdgeApi {
53760
54169
  * @param {String} opts.phoneHardwareId Filter by phone_hardwareId
53761
54170
  * @param {String} opts.linesId Filter by lines.id
53762
54171
  * @param {String} opts.linesName Filter by lines.name
53763
- * @param {String} opts.name Name of the Phone to filter by
54172
+ * @param {String} opts.name Name of the Phone to filter by, comma-separated
53764
54173
  * @param {String} opts.statusOperationalStatus The primary status to filter by
53765
54174
  * @param {String} opts.secondaryStatusOperationalStatus The secondary status to filter by
53766
54175
  * @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
@@ -55371,7 +55780,7 @@ class TextbotsApi {
55371
55780
  /**
55372
55781
  * Textbots service.
55373
55782
  * @module purecloud-platform-client-v2/api/TextbotsApi
55374
- * @version 169.1.0
55783
+ * @version 170.0.0
55375
55784
  */
55376
55785
 
55377
55786
  /**
@@ -55499,7 +55908,7 @@ class TokensApi {
55499
55908
  /**
55500
55909
  * Tokens service.
55501
55910
  * @module purecloud-platform-client-v2/api/TokensApi
55502
- * @version 169.1.0
55911
+ * @version 170.0.0
55503
55912
  */
55504
55913
 
55505
55914
  /**
@@ -55582,7 +55991,7 @@ class TokensApi {
55582
55991
  /**
55583
55992
  * Get the current Idle Token Timeout Value
55584
55993
  *
55585
- * Preview Endpoint
55994
+ * getTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
55586
55995
  */
55587
55996
  getTokensTimeout() {
55588
55997
 
@@ -55625,7 +56034,7 @@ class TokensApi {
55625
56034
  *
55626
56035
  * @param {Object} opts Optional parameters
55627
56036
  * @param {Object} opts.body
55628
- * Preview Endpoint
56037
+ * putTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
55629
56038
  */
55630
56039
  putTokensTimeout(opts) {
55631
56040
  opts = opts || {};
@@ -55651,7 +56060,7 @@ class UploadsApi {
55651
56060
  /**
55652
56061
  * Uploads service.
55653
56062
  * @module purecloud-platform-client-v2/api/UploadsApi
55654
- * @version 169.1.0
56063
+ * @version 170.0.0
55655
56064
  */
55656
56065
 
55657
56066
  /**
@@ -55827,7 +56236,7 @@ class UsageApi {
55827
56236
  /**
55828
56237
  * Usage service.
55829
56238
  * @module purecloud-platform-client-v2/api/UsageApi
55830
- * @version 169.1.0
56239
+ * @version 170.0.0
55831
56240
  */
55832
56241
 
55833
56242
  /**
@@ -56037,7 +56446,7 @@ class UserRecordingsApi {
56037
56446
  /**
56038
56447
  * UserRecordings service.
56039
56448
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
56040
- * @version 169.1.0
56449
+ * @version 170.0.0
56041
56450
  */
56042
56451
 
56043
56452
  /**
@@ -56222,7 +56631,7 @@ class UsersApi {
56222
56631
  /**
56223
56632
  * Users service.
56224
56633
  * @module purecloud-platform-client-v2/api/UsersApi
56225
- * @version 169.1.0
56634
+ * @version 170.0.0
56226
56635
  */
56227
56636
 
56228
56637
  /**
@@ -56461,7 +56870,7 @@ class UsersApi {
56461
56870
  * Get status for async query for user aggregates
56462
56871
  *
56463
56872
  * @param {String} jobId jobId
56464
- * Preview Endpoint
56873
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
56465
56874
  */
56466
56875
  getAnalyticsUsersAggregatesJob(jobId) {
56467
56876
  // verify the required parameter 'jobId' is set
@@ -56489,7 +56898,7 @@ class UsersApi {
56489
56898
  * @param {String} jobId jobId
56490
56899
  * @param {Object} opts Optional parameters
56491
56900
  * @param {String} opts.cursor Cursor token to retrieve next page
56492
- * Preview Endpoint
56901
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
56493
56902
  */
56494
56903
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
56495
56904
  opts = opts || {};
@@ -56594,7 +57003,7 @@ class UsersApi {
56594
57003
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
56595
57004
  * @param {Object} opts Optional parameters
56596
57005
  * @param {String} opts.name Search term to filter by division name
56597
- * @deprecated
57006
+ * @deprecated
56598
57007
  */
56599
57008
  getAuthorizationDivisionspermittedMe(permission, opts) {
56600
57009
  opts = opts || {};
@@ -56656,7 +57065,7 @@ class UsersApi {
56656
57065
  * @param {Object} opts Optional parameters
56657
57066
  * @param {Number} opts.pageNumber Page number (default to 1)
56658
57067
  * @param {Number} opts.pageSize Page size (default to 25)
56659
- * @deprecated
57068
+ * @deprecated
56660
57069
  */
56661
57070
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
56662
57071
  opts = opts || {};
@@ -56733,7 +57142,7 @@ class UsersApi {
56733
57142
  * Fetch field config for an entity type
56734
57143
  *
56735
57144
  * @param {Object} type Field type
56736
- * @deprecated
57145
+ * @deprecated
56737
57146
  */
56738
57147
  getFieldconfig(type) {
56739
57148
  // verify the required parameter 'type' is set
@@ -56766,7 +57175,7 @@ class UsersApi {
56766
57175
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
56767
57176
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
56768
57177
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand.
56769
- * @deprecated
57178
+ * @deprecated
56770
57179
  */
56771
57180
  getProfilesUsers(opts) {
56772
57181
  opts = opts || {};
@@ -56934,7 +57343,7 @@ class UsersApi {
56934
57343
  * @param {Number} opts.pageNumber Page number (default to 1)
56935
57344
  * @param {String} opts.sortOrder Sort order (default to ASC)
56936
57345
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
56937
- * @deprecated
57346
+ * @deprecated
56938
57347
  */
56939
57348
  getUserFavorites(userId, opts) {
56940
57349
  opts = opts || {};
@@ -57020,7 +57429,7 @@ class UsersApi {
57020
57429
  * @param {Object} opts Optional parameters
57021
57430
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
57022
57431
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
57023
- * @deprecated
57432
+ * @deprecated
57024
57433
  */
57025
57434
  getUserProfile(userId, opts) {
57026
57435
  opts = opts || {};
@@ -57829,7 +58238,7 @@ class UsersApi {
57829
58238
  * @param {Object} opts Optional parameters
57830
58239
  * @param {Number} opts.pageSize The desired page size
57831
58240
  * @param {Number} opts.pageNumber The desired page number
57832
- * Preview Endpoint
58241
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57833
58242
  */
57834
58243
  postAnalyticsUsersActivityQuery(body, opts) {
57835
58244
  opts = opts || {};
@@ -57857,7 +58266,7 @@ class UsersApi {
57857
58266
  * Query for user aggregates asynchronously
57858
58267
  *
57859
58268
  * @param {Object} body query
57860
- * Preview Endpoint
58269
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57861
58270
  */
57862
58271
  postAnalyticsUsersAggregatesJobs(body) {
57863
58272
  // verify the required parameter 'body' is set
@@ -58369,7 +58778,7 @@ class UsersApi {
58369
58778
  * Search users as conversation targets
58370
58779
  *
58371
58780
  * @param {Object} body Search request options
58372
- * Preview Endpoint
58781
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58373
58782
  */
58374
58783
  postUsersSearchConversationTarget(body) {
58375
58784
  // verify the required parameter 'body' is set
@@ -58395,7 +58804,7 @@ class UsersApi {
58395
58804
  * Search manage queue member
58396
58805
  *
58397
58806
  * @param {Object} body Search request options
58398
- * Preview Endpoint
58807
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58399
58808
  */
58400
58809
  postUsersSearchQueuemembersManage(body) {
58401
58810
  // verify the required parameter 'body' is set
@@ -58783,7 +59192,7 @@ class UtilitiesApi {
58783
59192
  /**
58784
59193
  * Utilities service.
58785
59194
  * @module purecloud-platform-client-v2/api/UtilitiesApi
58786
- * @version 169.1.0
59195
+ * @version 170.0.0
58787
59196
  */
58788
59197
 
58789
59198
  /**
@@ -58894,7 +59303,7 @@ class VoicemailApi {
58894
59303
  /**
58895
59304
  * Voicemail service.
58896
59305
  * @module purecloud-platform-client-v2/api/VoicemailApi
58897
- * @version 169.1.0
59306
+ * @version 170.0.0
58898
59307
  */
58899
59308
 
58900
59309
  /**
@@ -59561,7 +59970,7 @@ class WebChatApi {
59561
59970
  /**
59562
59971
  * WebChat service.
59563
59972
  * @module purecloud-platform-client-v2/api/WebChatApi
59564
- * @version 169.1.0
59973
+ * @version 170.0.0
59565
59974
  */
59566
59975
 
59567
59976
  /**
@@ -59580,7 +59989,7 @@ class WebChatApi {
59580
59989
  * Delete a WebChat deployment
59581
59990
  *
59582
59991
  * @param {String} deploymentId Deployment Id
59583
- * @deprecated
59992
+ * @deprecated
59584
59993
  */
59585
59994
  deleteWebchatDeployment(deploymentId) {
59586
59995
  // verify the required parameter 'deploymentId' is set
@@ -59656,7 +60065,7 @@ class WebChatApi {
59656
60065
  * Get a WebChat deployment
59657
60066
  *
59658
60067
  * @param {String} deploymentId Deployment Id
59659
- * @deprecated
60068
+ * @deprecated
59660
60069
  */
59661
60070
  getWebchatDeployment(deploymentId) {
59662
60071
  // verify the required parameter 'deploymentId' is set
@@ -59681,7 +60090,7 @@ class WebChatApi {
59681
60090
  /**
59682
60091
  * List WebChat deployments
59683
60092
  *
59684
- * @deprecated
60093
+ * @deprecated
59685
60094
  */
59686
60095
  getWebchatDeployments() {
59687
60096
 
@@ -59936,7 +60345,7 @@ class WebChatApi {
59936
60345
  * Create WebChat deployment
59937
60346
  *
59938
60347
  * @param {Object} body Deployment
59939
- * @deprecated
60348
+ * @deprecated
59940
60349
  */
59941
60350
  postWebchatDeployments(body) {
59942
60351
  // verify the required parameter 'body' is set
@@ -60053,7 +60462,7 @@ class WebChatApi {
60053
60462
  *
60054
60463
  * @param {String} deploymentId Deployment Id
60055
60464
  * @param {Object} body Deployment
60056
- * @deprecated
60465
+ * @deprecated
60057
60466
  */
60058
60467
  putWebchatDeployment(deploymentId, body) {
60059
60468
  // verify the required parameter 'deploymentId' is set
@@ -60110,7 +60519,7 @@ class WebDeploymentsApi {
60110
60519
  /**
60111
60520
  * WebDeployments service.
60112
60521
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
60113
- * @version 169.1.0
60522
+ * @version 170.0.0
60114
60523
  */
60115
60524
 
60116
60525
  /**
@@ -60632,7 +61041,7 @@ class WebMessagingApi {
60632
61041
  /**
60633
61042
  * WebMessaging service.
60634
61043
  * @module purecloud-platform-client-v2/api/WebMessagingApi
60635
- * @version 169.1.0
61044
+ * @version 170.0.0
60636
61045
  */
60637
61046
 
60638
61047
  /**
@@ -60678,7 +61087,7 @@ class WidgetsApi {
60678
61087
  /**
60679
61088
  * Widgets service.
60680
61089
  * @module purecloud-platform-client-v2/api/WidgetsApi
60681
- * @version 169.1.0
61090
+ * @version 170.0.0
60682
61091
  */
60683
61092
 
60684
61093
  /**
@@ -60824,7 +61233,7 @@ class WorkforceManagementApi {
60824
61233
  /**
60825
61234
  * WorkforceManagement service.
60826
61235
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
60827
- * @version 169.1.0
61236
+ * @version 170.0.0
60828
61237
  */
60829
61238
 
60830
61239
  /**
@@ -62366,7 +62775,7 @@ class WorkforceManagementApi {
62366
62775
  * Get activity codes
62367
62776
  *
62368
62777
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
62369
- * @deprecated
62778
+ * @deprecated
62370
62779
  */
62371
62780
  getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
62372
62781
  // verify the required parameter 'managementUnitId' is set
@@ -62779,7 +63188,7 @@ class WorkforceManagementApi {
62779
63188
  * @param {Object} opts Optional parameters
62780
63189
  * @param {Object} opts.expand Which fields, if any, to expand
62781
63190
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
62782
- * @deprecated
63191
+ * @deprecated
62783
63192
  */
62784
63193
  getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
62785
63194
  opts = opts || {};
@@ -62820,7 +63229,7 @@ class WorkforceManagementApi {
62820
63229
  * @param {Boolean} opts.includeOnlyPublished Return only published schedules
62821
63230
  * @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
62822
63231
  * @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
62823
- * @deprecated
63232
+ * @deprecated
62824
63233
  */
62825
63234
  getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
62826
63235
  opts = opts || {};
@@ -64779,7 +65188,7 @@ class WorkforceManagementApi {
64779
65188
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
64780
65189
  * @param {Object} opts Optional parameters
64781
65190
  * @param {Object} opts.body body
64782
- * @deprecated
65191
+ * @deprecated
64783
65192
  */
64784
65193
  postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
64785
65194
  opts = opts || {};
@@ -65440,7 +65849,7 @@ class WorkforceManagementApi {
65440
65849
  *
65441
65850
  * @param {Object} opts Optional parameters
65442
65851
  * @param {Object} opts.body body
65443
- * @deprecated
65852
+ * @deprecated
65444
65853
  */
65445
65854
  postWorkforcemanagementSchedules(opts) {
65446
65855
  opts = opts || {};
@@ -65631,7 +66040,7 @@ class WorkforceManagementApi {
65631
66040
  * </pre>
65632
66041
  * </p>
65633
66042
  * @module purecloud-platform-client-v2/index
65634
- * @version 169.1.0
66043
+ * @version 170.0.0
65635
66044
  */
65636
66045
  class platformClient {
65637
66046
  constructor() {