purecloud-platform-client-v2 169.1.0 → 171.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 +856 -365
  3. package/dist/web-amd/purecloud-platform-client-v2.js +856 -365
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +856 -365
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +856 -365
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +413 -66
  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 +26 -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 +61 -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
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
399
399
 
400
400
  /**
401
401
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 169.1.0
402
+ * @version 171.0.0
403
403
  */
404
404
  class ApiClient {
405
405
  /**
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1485
1485
  /**
1486
1486
  * Alerting service.
1487
1487
  * @module purecloud-platform-client-v2/api/AlertingApi
1488
- * @version 169.1.0
1488
+ * @version 171.0.0
1489
1489
  */
1490
1490
 
1491
1491
  /**
@@ -1799,7 +1799,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1799
1799
  /**
1800
1800
  * Analytics service.
1801
1801
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1802
- * @version 169.1.0
1802
+ * @version 171.0.0
1803
1803
  */
1804
1804
 
1805
1805
  /**
@@ -1893,7 +1893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1893
1893
  * Get status for async query for action aggregates
1894
1894
  *
1895
1895
  * @param {String} jobId jobId
1896
- * Preview Endpoint
1896
+ * getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1897
1897
  */
1898
1898
  getAnalyticsActionsAggregatesJob(jobId) {
1899
1899
  // verify the required parameter 'jobId' is set
@@ -1921,7 +1921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1921
1921
  * @param {String} jobId jobId
1922
1922
  * @param {Object} opts Optional parameters
1923
1923
  * @param {String} opts.cursor Cursor token to retrieve next page
1924
- * Preview Endpoint
1924
+ * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1925
1925
  */
1926
1926
  getAnalyticsActionsAggregatesJobResults(jobId, opts) {
1927
1927
  opts = opts || {};
@@ -1983,7 +1983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1983
1983
  * Get status for async query for bot aggregates
1984
1984
  *
1985
1985
  * @param {String} jobId jobId
1986
- * Preview Endpoint
1986
+ * getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1987
1987
  */
1988
1988
  getAnalyticsBotsAggregatesJob(jobId) {
1989
1989
  // verify the required parameter 'jobId' is set
@@ -2011,7 +2011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2011
2011
  * @param {String} jobId jobId
2012
2012
  * @param {Object} opts Optional parameters
2013
2013
  * @param {String} opts.cursor Cursor token to retrieve next page
2014
- * Preview Endpoint
2014
+ * getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2015
2015
  */
2016
2016
  getAnalyticsBotsAggregatesJobResults(jobId, opts) {
2017
2017
  opts = opts || {};
@@ -2064,7 +2064,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2064
2064
  * Get status for async query for conversation aggregates
2065
2065
  *
2066
2066
  * @param {String} jobId jobId
2067
- * Preview Endpoint
2067
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2068
2068
  */
2069
2069
  getAnalyticsConversationsAggregatesJob(jobId) {
2070
2070
  // verify the required parameter 'jobId' is set
@@ -2092,7 +2092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2092
2092
  * @param {String} jobId jobId
2093
2093
  * @param {Object} opts Optional parameters
2094
2094
  * @param {String} opts.cursor Cursor token to retrieve next page
2095
- * Preview Endpoint
2095
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2096
2096
  */
2097
2097
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
2098
2098
  opts = opts || {};
@@ -2239,7 +2239,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2239
2239
  * Get status for async query for evaluation aggregates
2240
2240
  *
2241
2241
  * @param {String} jobId jobId
2242
- * Preview Endpoint
2242
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2243
2243
  */
2244
2244
  getAnalyticsEvaluationsAggregatesJob(jobId) {
2245
2245
  // verify the required parameter 'jobId' is set
@@ -2267,7 +2267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2267
2267
  * @param {String} jobId jobId
2268
2268
  * @param {Object} opts Optional parameters
2269
2269
  * @param {String} opts.cursor Cursor token to retrieve next page
2270
- * Preview Endpoint
2270
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2271
2271
  */
2272
2272
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
2273
2273
  opts = opts || {};
@@ -2295,7 +2295,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2295
2295
  * Get status for async query for Flow aggregates
2296
2296
  *
2297
2297
  * @param {String} jobId jobId
2298
- * Preview Endpoint
2298
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2299
2299
  */
2300
2300
  getAnalyticsFlowsAggregatesJob(jobId) {
2301
2301
  // verify the required parameter 'jobId' is set
@@ -2323,7 +2323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2323
2323
  * @param {String} jobId jobId
2324
2324
  * @param {Object} opts Optional parameters
2325
2325
  * @param {String} opts.cursor Cursor token to retrieve next page
2326
- * Preview Endpoint
2326
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2327
2327
  */
2328
2328
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
2329
2329
  opts = opts || {};
@@ -2351,7 +2351,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2351
2351
  * Get status for async query for journey aggregates
2352
2352
  *
2353
2353
  * @param {String} jobId jobId
2354
- * Preview Endpoint
2354
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2355
2355
  */
2356
2356
  getAnalyticsJourneysAggregatesJob(jobId) {
2357
2357
  // verify the required parameter 'jobId' is set
@@ -2379,7 +2379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2379
2379
  * @param {String} jobId jobId
2380
2380
  * @param {Object} opts Optional parameters
2381
2381
  * @param {String} opts.cursor Cursor token to retrieve next page
2382
- * Preview Endpoint
2382
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2383
2383
  */
2384
2384
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
2385
2385
  opts = opts || {};
@@ -2407,7 +2407,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2407
2407
  * Get status for async query for knowledge aggregates
2408
2408
  *
2409
2409
  * @param {String} jobId jobId
2410
- * Preview Endpoint
2410
+ * getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2411
2411
  */
2412
2412
  getAnalyticsKnowledgeAggregatesJob(jobId) {
2413
2413
  // verify the required parameter 'jobId' is set
@@ -2435,7 +2435,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2435
2435
  * @param {String} jobId jobId
2436
2436
  * @param {Object} opts Optional parameters
2437
2437
  * @param {String} opts.cursor Cursor token to retrieve next page
2438
- * Preview Endpoint
2438
+ * getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2439
2439
  */
2440
2440
  getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
2441
2441
  opts = opts || {};
@@ -2758,7 +2758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2758
2758
  * Get status for async query for resolution aggregates
2759
2759
  *
2760
2760
  * @param {String} jobId jobId
2761
- * Preview Endpoint
2761
+ * getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2762
2762
  */
2763
2763
  getAnalyticsResolutionsAggregatesJob(jobId) {
2764
2764
  // verify the required parameter 'jobId' is set
@@ -2786,7 +2786,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2786
2786
  * @param {String} jobId jobId
2787
2787
  * @param {Object} opts Optional parameters
2788
2788
  * @param {String} opts.cursor Cursor token to retrieve next page
2789
- * Preview Endpoint
2789
+ * getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2790
2790
  */
2791
2791
  getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
2792
2792
  opts = opts || {};
@@ -2814,7 +2814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2814
2814
  * Get status for async query for survey aggregates
2815
2815
  *
2816
2816
  * @param {String} jobId jobId
2817
- * Preview Endpoint
2817
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2818
2818
  */
2819
2819
  getAnalyticsSurveysAggregatesJob(jobId) {
2820
2820
  // verify the required parameter 'jobId' is set
@@ -2842,7 +2842,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2842
2842
  * @param {String} jobId jobId
2843
2843
  * @param {Object} opts Optional parameters
2844
2844
  * @param {String} opts.cursor Cursor token to retrieve next page
2845
- * Preview Endpoint
2845
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2846
2846
  */
2847
2847
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
2848
2848
  opts = opts || {};
@@ -2870,7 +2870,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2870
2870
  * Get status for async query for task management aggregates
2871
2871
  *
2872
2872
  * @param {String} jobId jobId
2873
- * Preview Endpoint
2873
+ * getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2874
2874
  */
2875
2875
  getAnalyticsTaskmanagementAggregatesJob(jobId) {
2876
2876
  // verify the required parameter 'jobId' is set
@@ -2898,7 +2898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2898
2898
  * @param {String} jobId jobId
2899
2899
  * @param {Object} opts Optional parameters
2900
2900
  * @param {String} opts.cursor Cursor token to retrieve next page
2901
- * Preview Endpoint
2901
+ * getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2902
2902
  */
2903
2903
  getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
2904
2904
  opts = opts || {};
@@ -2926,7 +2926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2926
2926
  * Get status for async query for transcript aggregates
2927
2927
  *
2928
2928
  * @param {String} jobId jobId
2929
- * Preview Endpoint
2929
+ * getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2930
2930
  */
2931
2931
  getAnalyticsTranscriptsAggregatesJob(jobId) {
2932
2932
  // verify the required parameter 'jobId' is set
@@ -2954,7 +2954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2954
2954
  * @param {String} jobId jobId
2955
2955
  * @param {Object} opts Optional parameters
2956
2956
  * @param {String} opts.cursor Cursor token to retrieve next page
2957
- * Preview Endpoint
2957
+ * getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2958
2958
  */
2959
2959
  getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
2960
2960
  opts = opts || {};
@@ -2982,7 +2982,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2982
2982
  * Get status for async query for user aggregates
2983
2983
  *
2984
2984
  * @param {String} jobId jobId
2985
- * Preview Endpoint
2985
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
2986
2986
  */
2987
2987
  getAnalyticsUsersAggregatesJob(jobId) {
2988
2988
  // verify the required parameter 'jobId' is set
@@ -3010,7 +3010,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3010
3010
  * @param {String} jobId jobId
3011
3011
  * @param {Object} opts Optional parameters
3012
3012
  * @param {String} opts.cursor Cursor token to retrieve next page
3013
- * Preview Endpoint
3013
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3014
3014
  */
3015
3015
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
3016
3016
  opts = opts || {};
@@ -3138,7 +3138,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3138
3138
  * Query for action aggregates asynchronously
3139
3139
  *
3140
3140
  * @param {Object} body query
3141
- * Preview Endpoint
3141
+ * postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3142
3142
  */
3143
3143
  postAnalyticsActionsAggregatesJobs(body) {
3144
3144
  // verify the required parameter 'body' is set
@@ -3189,7 +3189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3189
3189
  * Query for bot aggregates asynchronously
3190
3190
  *
3191
3191
  * @param {Object} body query
3192
- * Preview Endpoint
3192
+ * postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3193
3193
  */
3194
3194
  postAnalyticsBotsAggregatesJobs(body) {
3195
3195
  // verify the required parameter 'body' is set
@@ -3273,7 +3273,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3273
3273
  * @param {Object} opts Optional parameters
3274
3274
  * @param {Number} opts.pageSize The desired page size
3275
3275
  * @param {Number} opts.pageNumber The desired page number
3276
- * Preview Endpoint
3276
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3277
3277
  */
3278
3278
  postAnalyticsConversationsActivityQuery(body, opts) {
3279
3279
  opts = opts || {};
@@ -3301,7 +3301,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3301
3301
  * Query for conversation aggregates asynchronously
3302
3302
  *
3303
3303
  * @param {Object} body query
3304
- * Preview Endpoint
3304
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3305
3305
  */
3306
3306
  postAnalyticsConversationsAggregatesJobs(body) {
3307
3307
  // verify the required parameter 'body' is set
@@ -3427,7 +3427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3427
3427
  * Query for evaluation aggregates asynchronously
3428
3428
  *
3429
3429
  * @param {Object} body query
3430
- * Preview Endpoint
3430
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3431
3431
  */
3432
3432
  postAnalyticsEvaluationsAggregatesJobs(body) {
3433
3433
  // verify the required parameter 'body' is set
@@ -3481,7 +3481,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3481
3481
  * @param {Object} opts Optional parameters
3482
3482
  * @param {Number} opts.pageSize The desired page size
3483
3483
  * @param {Number} opts.pageNumber The desired page number
3484
- * Preview Endpoint
3484
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3485
3485
  */
3486
3486
  postAnalyticsFlowsActivityQuery(body, opts) {
3487
3487
  opts = opts || {};
@@ -3509,7 +3509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3509
3509
  * Query for flow aggregates asynchronously
3510
3510
  *
3511
3511
  * @param {Object} body query
3512
- * Preview Endpoint
3512
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3513
3513
  */
3514
3514
  postAnalyticsFlowsAggregatesJobs(body) {
3515
3515
  // verify the required parameter 'body' is set
@@ -3585,7 +3585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3585
3585
  * Query for journey aggregates asynchronously
3586
3586
  *
3587
3587
  * @param {Object} body query
3588
- * Preview Endpoint
3588
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3589
3589
  */
3590
3590
  postAnalyticsJourneysAggregatesJobs(body) {
3591
3591
  // verify the required parameter 'body' is set
@@ -3636,7 +3636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3636
3636
  * Query for knowledge aggregates asynchronously
3637
3637
  *
3638
3638
  * @param {Object} body query
3639
- * Preview Endpoint
3639
+ * postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3640
3640
  */
3641
3641
  postAnalyticsKnowledgeAggregatesJobs(body) {
3642
3642
  // verify the required parameter 'body' is set
@@ -3662,7 +3662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3662
3662
  * Query for knowledge aggregates
3663
3663
  *
3664
3664
  * @param {Object} body query
3665
- * Preview Endpoint
3665
+ * postAnalyticsKnowledgeAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3666
3666
  */
3667
3667
  postAnalyticsKnowledgeAggregatesQuery(body) {
3668
3668
  // verify the required parameter 'body' is set
@@ -3788,7 +3788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3788
3788
  * Query for resolution aggregates asynchronously
3789
3789
  *
3790
3790
  * @param {Object} body query
3791
- * Preview Endpoint
3791
+ * postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3792
3792
  */
3793
3793
  postAnalyticsResolutionsAggregatesJobs(body) {
3794
3794
  // verify the required parameter 'body' is set
@@ -3817,7 +3817,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3817
3817
  * @param {Object} opts Optional parameters
3818
3818
  * @param {Number} opts.pageSize The desired page size
3819
3819
  * @param {Number} opts.pageNumber The desired page number
3820
- * Preview Endpoint
3820
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3821
3821
  */
3822
3822
  postAnalyticsRoutingActivityQuery(body, opts) {
3823
3823
  opts = opts || {};
@@ -3845,7 +3845,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3845
3845
  * Query for survey aggregates asynchronously
3846
3846
  *
3847
3847
  * @param {Object} body query
3848
- * Preview Endpoint
3848
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3849
3849
  */
3850
3850
  postAnalyticsSurveysAggregatesJobs(body) {
3851
3851
  // verify the required parameter 'body' is set
@@ -3896,7 +3896,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3896
3896
  * Query for task management aggregates asynchronously
3897
3897
  *
3898
3898
  * @param {Object} body query
3899
- * Preview Endpoint
3899
+ * postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3900
3900
  */
3901
3901
  postAnalyticsTaskmanagementAggregatesJobs(body) {
3902
3902
  // verify the required parameter 'body' is set
@@ -3922,7 +3922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3922
3922
  * Query for task management aggregates
3923
3923
  *
3924
3924
  * @param {Object} body query
3925
- * Preview Endpoint
3925
+ * postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3926
3926
  */
3927
3927
  postAnalyticsTaskmanagementAggregatesQuery(body) {
3928
3928
  // verify the required parameter 'body' is set
@@ -3951,7 +3951,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3951
3951
  * @param {Object} opts Optional parameters
3952
3952
  * @param {Number} opts.pageSize The desired page size
3953
3953
  * @param {Number} opts.pageNumber The desired page number
3954
- * Preview Endpoint
3954
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3955
3955
  */
3956
3956
  postAnalyticsTeamsActivityQuery(body, opts) {
3957
3957
  opts = opts || {};
@@ -3979,7 +3979,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3979
3979
  * Query for transcript aggregates asynchronously
3980
3980
  *
3981
3981
  * @param {Object} body query
3982
- * Preview Endpoint
3982
+ * postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3983
3983
  */
3984
3984
  postAnalyticsTranscriptsAggregatesJobs(body) {
3985
3985
  // verify the required parameter 'body' is set
@@ -4033,7 +4033,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4033
4033
  * @param {Object} opts Optional parameters
4034
4034
  * @param {Number} opts.pageSize The desired page size
4035
4035
  * @param {Number} opts.pageNumber The desired page number
4036
- * Preview Endpoint
4036
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4037
4037
  */
4038
4038
  postAnalyticsUsersActivityQuery(body, opts) {
4039
4039
  opts = opts || {};
@@ -4061,7 +4061,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4061
4061
  * Query for user aggregates asynchronously
4062
4062
  *
4063
4063
  * @param {Object} body query
4064
- * Preview Endpoint
4064
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4065
4065
  */
4066
4066
  postAnalyticsUsersAggregatesJobs(body) {
4067
4067
  // verify the required parameter 'body' is set
@@ -4244,7 +4244,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4244
4244
  /**
4245
4245
  * Architect service.
4246
4246
  * @module purecloud-platform-client-v2/api/ArchitectApi
4247
- * @version 169.1.0
4247
+ * @version 171.0.0
4248
4248
  */
4249
4249
 
4250
4250
  /**
@@ -6017,7 +6017,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6017
6017
  * @param {String} instanceId Instance ID
6018
6018
  * @param {Object} opts Optional parameters
6019
6019
  * @param {Object} opts.expand Expand various details.
6020
- * Preview Endpoint
6020
+ * getFlowsInstance is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6021
6021
  */
6022
6022
  getFlowsInstance(instanceId, opts) {
6023
6023
  opts = opts || {};
@@ -6045,7 +6045,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6045
6045
  * Get the status and/or results of an asynchronous flow execution data retrieval job
6046
6046
  *
6047
6047
  * @param {String} jobId The asynchronous job ID
6048
- * Preview Endpoint
6048
+ * getFlowsInstancesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6049
6049
  */
6050
6050
  getFlowsInstancesJob(jobId) {
6051
6051
  // verify the required parameter 'jobId' is set
@@ -6072,7 +6072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6072
6072
  * Returns the queryable parameters that can be used to build a query for execution data.
6073
6073
  * @param {Object} opts Optional parameters
6074
6074
  * @param {Object} opts.expand Expand various query types.
6075
- * Preview Endpoint
6075
+ * getFlowsInstancesQuerycapabilities is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6076
6076
  */
6077
6077
  getFlowsInstancesQuerycapabilities(opts) {
6078
6078
  opts = opts || {};
@@ -6929,7 +6929,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6929
6929
  * @param {Object} body Requested Flow Ids
6930
6930
  * @param {Object} opts Optional parameters
6931
6931
  * @param {Object} opts.expand Expand various query types.
6932
- * Preview Endpoint
6932
+ * postFlowsInstancesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6933
6933
  */
6934
6934
  postFlowsInstancesJobs(body, opts) {
6935
6935
  opts = opts || {};
@@ -6959,7 +6959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6959
6959
  * @param {Object} body query
6960
6960
  * @param {Object} opts Optional parameters
6961
6961
  * @param {Boolean} opts.indexOnly indexes only
6962
- * Preview Endpoint
6962
+ * postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6963
6963
  */
6964
6964
  postFlowsInstancesQuery(body, opts) {
6965
6965
  opts = opts || {};
@@ -7433,7 +7433,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7433
7433
  /**
7434
7434
  * Audit service.
7435
7435
  * @module purecloud-platform-client-v2/api/AuditApi
7436
- * @version 169.1.0
7436
+ * @version 171.0.0
7437
7437
  */
7438
7438
 
7439
7439
  /**
@@ -7604,7 +7604,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7604
7604
  /**
7605
7605
  * Authorization service.
7606
7606
  * @module purecloud-platform-client-v2/api/AuthorizationApi
7607
- * @version 169.1.0
7607
+ * @version 171.0.0
7608
7608
  */
7609
7609
 
7610
7610
  /**
@@ -7845,7 +7845,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7845
7845
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
7846
7846
  * @param {Object} opts Optional parameters
7847
7847
  * @param {String} opts.name Search term to filter by division name
7848
- * @deprecated
7848
+ * @deprecated
7849
7849
  */
7850
7850
  getAuthorizationDivisionspermittedMe(permission, opts) {
7851
7851
  opts = opts || {};
@@ -7907,7 +7907,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7907
7907
  * @param {Object} opts Optional parameters
7908
7908
  * @param {Number} opts.pageNumber Page number (default to 1)
7909
7909
  * @param {Number} opts.pageSize Page size (default to 25)
7910
- * @deprecated
7910
+ * @deprecated
7911
7911
  */
7912
7912
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
7913
7913
  opts = opts || {};
@@ -8835,7 +8835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8835
8835
  /**
8836
8836
  * Billing service.
8837
8837
  * @module purecloud-platform-client-v2/api/BillingApi
8838
- * @version 169.1.0
8838
+ * @version 171.0.0
8839
8839
  */
8840
8840
 
8841
8841
  /**
@@ -8915,7 +8915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8915
8915
  /**
8916
8916
  * CarrierServices service.
8917
8917
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
8918
- * @version 169.1.0
8918
+ * @version 171.0.0
8919
8919
  */
8920
8920
 
8921
8921
  /**
@@ -8985,7 +8985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8985
8985
  /**
8986
8986
  * Chat service.
8987
8987
  * @module purecloud-platform-client-v2/api/ChatApi
8988
- * @version 169.1.0
8988
+ * @version 171.0.0
8989
8989
  */
8990
8990
 
8991
8991
  /**
@@ -9003,7 +9003,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9003
9003
  /**
9004
9004
  * Get Chat Settings.
9005
9005
  * This route is deprecated, please use /chats/settings instead
9006
- * @deprecated
9006
+ * @deprecated
9007
9007
  */
9008
9008
  getChatSettings() {
9009
9009
 
@@ -9045,7 +9045,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9045
9045
  * Patch Chat Settings.
9046
9046
  * This route is deprecated, please use /chats/settings instead
9047
9047
  * @param {Object} body Chat
9048
- * @deprecated
9048
+ * @deprecated
9049
9049
  */
9050
9050
  patchChatSettings(body) {
9051
9051
  // verify the required parameter 'body' is set
@@ -9096,7 +9096,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9096
9096
  * Update Chat Settings.
9097
9097
  * This route is deprecated, please use /chats/settings instead
9098
9098
  * @param {Object} body Chat
9099
- * @deprecated
9099
+ * @deprecated
9100
9100
  */
9101
9101
  putChatSettings(body) {
9102
9102
  // verify the required parameter 'body' is set
@@ -9149,7 +9149,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9149
9149
  /**
9150
9150
  * Coaching service.
9151
9151
  * @module purecloud-platform-client-v2/api/CoachingApi
9152
- * @version 169.1.0
9152
+ * @version 171.0.0
9153
9153
  */
9154
9154
 
9155
9155
  /**
@@ -9726,7 +9726,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9726
9726
  /**
9727
9727
  * ContentManagement service.
9728
9728
  * @module purecloud-platform-client-v2/api/ContentManagementApi
9729
- * @version 169.1.0
9729
+ * @version 171.0.0
9730
9730
  */
9731
9731
 
9732
9732
  /**
@@ -9940,7 +9940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9940
9940
 
9941
9941
  /**
9942
9942
  * Get a list of audits for a document.
9943
- *
9943
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
9944
9944
  * @param {String} documentId Document ID
9945
9945
  * @param {Object} opts Optional parameters
9946
9946
  * @param {Number} opts.pageSize Page size (default to 25)
@@ -9949,6 +9949,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9949
9949
  * @param {String} opts.level level (default to USER)
9950
9950
  * @param {String} opts.sortBy Sort by
9951
9951
  * @param {String} opts.sortOrder Sort order (default to ascending)
9952
+ * @deprecated
9952
9953
  */
9953
9954
  getContentmanagementDocumentAudits(documentId, opts) {
9954
9955
  opts = opts || {};
@@ -10013,7 +10014,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10013
10014
  * @param {Number} opts.pageNumber Page number (default to 1)
10014
10015
  * @param {String} opts.sortBy name or dateCreated
10015
10016
  * @param {String} opts.sortOrder ascending or descending (default to ascending)
10016
- * @deprecated
10017
+ * @deprecated
10017
10018
  */
10018
10019
  getContentmanagementDocuments(workspaceId, opts) {
10019
10020
  opts = opts || {};
@@ -10495,8 +10496,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10495
10496
 
10496
10497
  /**
10497
10498
  * Query audits
10498
- *
10499
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
10499
10500
  * @param {Object} body Allows for a filtered query returning facet information
10501
+ * @deprecated
10500
10502
  */
10501
10503
  postContentmanagementAuditquery(body) {
10502
10504
  // verify the required parameter 'body' is set
@@ -10867,7 +10869,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10867
10869
  /**
10868
10870
  * Conversations service.
10869
10871
  * @module purecloud-platform-client-v2/api/ConversationsApi
10870
- * @version 169.1.0
10872
+ * @version 171.0.0
10871
10873
  */
10872
10874
 
10873
10875
  /**
@@ -11057,6 +11059,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11057
11059
  );
11058
11060
  }
11059
11061
 
11062
+ /**
11063
+ * Delete Instagram messaging integration
11064
+ *
11065
+ * @param {String} integrationId Integration ID
11066
+ */
11067
+ deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId) {
11068
+ // verify the required parameter 'integrationId' is set
11069
+ if (integrationId === undefined || integrationId === null) {
11070
+ throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsInstagramIntegrationId';
11071
+ }
11072
+
11073
+ return this.apiClient.callApi(
11074
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
11075
+ 'DELETE',
11076
+ { 'integrationId': integrationId },
11077
+ { },
11078
+ { },
11079
+ { },
11080
+ null,
11081
+ ['PureCloud OAuth'],
11082
+ ['application/json'],
11083
+ ['application/json']
11084
+ );
11085
+ }
11086
+
11060
11087
  /**
11061
11088
  * Delete a LINE messenger integration
11062
11089
  *
@@ -11211,7 +11238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11211
11238
  * Get status for async query for conversation aggregates
11212
11239
  *
11213
11240
  * @param {String} jobId jobId
11214
- * Preview Endpoint
11241
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11215
11242
  */
11216
11243
  getAnalyticsConversationsAggregatesJob(jobId) {
11217
11244
  // verify the required parameter 'jobId' is set
@@ -11239,7 +11266,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11239
11266
  * @param {String} jobId jobId
11240
11267
  * @param {Object} opts Optional parameters
11241
11268
  * @param {String} opts.cursor Cursor token to retrieve next page
11242
- * Preview Endpoint
11269
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11243
11270
  */
11244
11271
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
11245
11272
  opts = opts || {};
@@ -12915,6 +12942,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12915
12942
  );
12916
12943
  }
12917
12944
 
12945
+ /**
12946
+ * Get a list of Instagram Integrations
12947
+ *
12948
+ * @param {Object} opts Optional parameters
12949
+ * @param {Number} opts.pageSize Page size (default to 25)
12950
+ * @param {Number} opts.pageNumber Page number (default to 1)
12951
+ * @param {Object} opts.expand Expand instructions for the return value.
12952
+ * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
12953
+ * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
12954
+ */
12955
+ getConversationsMessagingIntegrationsInstagram(opts) {
12956
+ opts = opts || {};
12957
+
12958
+
12959
+ return this.apiClient.callApi(
12960
+ '/api/v2/conversations/messaging/integrations/instagram',
12961
+ 'GET',
12962
+ { },
12963
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
12964
+ { },
12965
+ { },
12966
+ null,
12967
+ ['PureCloud OAuth'],
12968
+ ['application/json'],
12969
+ ['application/json']
12970
+ );
12971
+ }
12972
+
12973
+ /**
12974
+ * Get Instagram messaging integration
12975
+ *
12976
+ * @param {String} integrationId Integration ID
12977
+ * @param {Object} opts Optional parameters
12978
+ * @param {Object} opts.expand Expand instructions for the return value.
12979
+ */
12980
+ getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, opts) {
12981
+ opts = opts || {};
12982
+
12983
+ // verify the required parameter 'integrationId' is set
12984
+ if (integrationId === undefined || integrationId === null) {
12985
+ throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsInstagramIntegrationId';
12986
+ }
12987
+
12988
+ return this.apiClient.callApi(
12989
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
12990
+ 'GET',
12991
+ { 'integrationId': integrationId },
12992
+ { 'expand': opts['expand'] },
12993
+ { },
12994
+ { },
12995
+ null,
12996
+ ['PureCloud OAuth'],
12997
+ ['application/json'],
12998
+ ['application/json']
12999
+ );
13000
+ }
13001
+
12918
13002
  /**
12919
13003
  * Get a list of LINE messenger Integrations
12920
13004
  *
@@ -13365,7 +13449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13365
13449
  * Get video conference details (e.g. the current number of active participants).
13366
13450
  *
13367
13451
  * @param {String} conferenceId conferenceId
13368
- * Preview Endpoint
13452
+ * getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13369
13453
  */
13370
13454
  getConversationsVideoDetails(conferenceId) {
13371
13455
  // verify the required parameter 'conferenceId' is set
@@ -14523,6 +14607,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14523
14607
  );
14524
14608
  }
14525
14609
 
14610
+ /**
14611
+ * Update Instagram messaging integration
14612
+ *
14613
+ * @param {String} integrationId Integration ID
14614
+ * @param {Object} body InstagramIntegrationUpdateRequest
14615
+ */
14616
+ patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, body) {
14617
+ // verify the required parameter 'integrationId' is set
14618
+ if (integrationId === undefined || integrationId === null) {
14619
+ throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
14620
+ }
14621
+ // verify the required parameter 'body' is set
14622
+ if (body === undefined || body === null) {
14623
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
14624
+ }
14625
+
14626
+ return this.apiClient.callApi(
14627
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
14628
+ 'PATCH',
14629
+ { 'integrationId': integrationId },
14630
+ { },
14631
+ { },
14632
+ { },
14633
+ body,
14634
+ ['PureCloud OAuth'],
14635
+ ['application/json'],
14636
+ ['application/json']
14637
+ );
14638
+ }
14639
+
14526
14640
  /**
14527
14641
  * Update an Open messaging integration
14528
14642
  * See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
@@ -14705,7 +14819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14705
14819
  * @param {Object} opts Optional parameters
14706
14820
  * @param {Number} opts.pageSize The desired page size
14707
14821
  * @param {Number} opts.pageNumber The desired page number
14708
- * Preview Endpoint
14822
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14709
14823
  */
14710
14824
  postAnalyticsConversationsActivityQuery(body, opts) {
14711
14825
  opts = opts || {};
@@ -14733,7 +14847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14733
14847
  * Query for conversation aggregates asynchronously
14734
14848
  *
14735
14849
  * @param {Object} body query
14736
- * Preview Endpoint
14850
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14737
14851
  */
14738
14852
  postAnalyticsConversationsAggregatesJobs(body) {
14739
14853
  // verify the required parameter 'body' is set
@@ -14984,6 +15098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
14984
15098
  * @param {String} conversationId conversation ID
14985
15099
  * @param {String} participantId participant ID
14986
15100
  * @param {Object} body Transfer request
15101
+ * @deprecated
14987
15102
  */
14988
15103
  postConversationParticipantReplace(conversationId, participantId, body) {
14989
15104
  // verify the required parameter 'conversationId' is set
@@ -15013,6 +15128,111 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15013
15128
  );
15014
15129
  }
15015
15130
 
15131
+ /**
15132
+ * Replace this participant with the specified agent
15133
+ *
15134
+ * @param {String} conversationId conversation ID
15135
+ * @param {String} participantId participant ID
15136
+ * @param {Object} body Transfer request
15137
+ */
15138
+ postConversationParticipantReplaceAgent(conversationId, participantId, body) {
15139
+ // verify the required parameter 'conversationId' is set
15140
+ if (conversationId === undefined || conversationId === null) {
15141
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceAgent';
15142
+ }
15143
+ // verify the required parameter 'participantId' is set
15144
+ if (participantId === undefined || participantId === null) {
15145
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceAgent';
15146
+ }
15147
+ // verify the required parameter 'body' is set
15148
+ if (body === undefined || body === null) {
15149
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceAgent';
15150
+ }
15151
+
15152
+ return this.apiClient.callApi(
15153
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent',
15154
+ 'POST',
15155
+ { 'conversationId': conversationId,'participantId': participantId },
15156
+ { },
15157
+ { },
15158
+ { },
15159
+ body,
15160
+ ['PureCloud OAuth'],
15161
+ ['application/json'],
15162
+ ['application/json']
15163
+ );
15164
+ }
15165
+
15166
+ /**
15167
+ * Replace this participant with the an external contact
15168
+ *
15169
+ * @param {String} conversationId conversation ID
15170
+ * @param {String} participantId participant ID
15171
+ * @param {Object} body Transfer request
15172
+ */
15173
+ postConversationParticipantReplaceExternal(conversationId, participantId, body) {
15174
+ // verify the required parameter 'conversationId' is set
15175
+ if (conversationId === undefined || conversationId === null) {
15176
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';
15177
+ }
15178
+ // verify the required parameter 'participantId' is set
15179
+ if (participantId === undefined || participantId === null) {
15180
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';
15181
+ }
15182
+ // verify the required parameter 'body' is set
15183
+ if (body === undefined || body === null) {
15184
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceExternal';
15185
+ }
15186
+
15187
+ return this.apiClient.callApi(
15188
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external',
15189
+ 'POST',
15190
+ { 'conversationId': conversationId,'participantId': participantId },
15191
+ { },
15192
+ { },
15193
+ { },
15194
+ body,
15195
+ ['PureCloud OAuth'],
15196
+ ['application/json'],
15197
+ ['application/json']
15198
+ );
15199
+ }
15200
+
15201
+ /**
15202
+ * Replace this participant with the specified queue
15203
+ *
15204
+ * @param {String} conversationId conversation ID
15205
+ * @param {String} participantId participant ID
15206
+ * @param {Object} body Transfer request
15207
+ */
15208
+ postConversationParticipantReplaceQueue(conversationId, participantId, body) {
15209
+ // verify the required parameter 'conversationId' is set
15210
+ if (conversationId === undefined || conversationId === null) {
15211
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceQueue';
15212
+ }
15213
+ // verify the required parameter 'participantId' is set
15214
+ if (participantId === undefined || participantId === null) {
15215
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceQueue';
15216
+ }
15217
+ // verify the required parameter 'body' is set
15218
+ if (body === undefined || body === null) {
15219
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceQueue';
15220
+ }
15221
+
15222
+ return this.apiClient.callApi(
15223
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue',
15224
+ 'POST',
15225
+ { 'conversationId': conversationId,'participantId': participantId },
15226
+ { },
15227
+ { },
15228
+ { },
15229
+ body,
15230
+ ['PureCloud OAuth'],
15231
+ ['application/json'],
15232
+ ['application/json']
15233
+ );
15234
+ }
15235
+
15016
15236
  /**
15017
15237
  * Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
15018
15238
  *
@@ -15152,6 +15372,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15152
15372
  * @param {String} conversationId conversationId
15153
15373
  * @param {String} participantId participantId
15154
15374
  * @param {Object} body Destination address and initial speak to
15375
+ * @deprecated
15155
15376
  */
15156
15377
  postConversationsCallParticipantConsult(conversationId, participantId, body) {
15157
15378
  // verify the required parameter 'conversationId' is set
@@ -15181,6 +15402,111 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15181
15402
  );
15182
15403
  }
15183
15404
 
15405
+ /**
15406
+ * Initiate a consult transfer to an agent
15407
+ *
15408
+ * @param {String} conversationId conversationId
15409
+ * @param {String} participantId participantId
15410
+ * @param {Object} body Destination agent and initial speak to
15411
+ */
15412
+ postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
15413
+ // verify the required parameter 'conversationId' is set
15414
+ if (conversationId === undefined || conversationId === null) {
15415
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultAgent';
15416
+ }
15417
+ // verify the required parameter 'participantId' is set
15418
+ if (participantId === undefined || participantId === null) {
15419
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultAgent';
15420
+ }
15421
+ // verify the required parameter 'body' is set
15422
+ if (body === undefined || body === null) {
15423
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultAgent';
15424
+ }
15425
+
15426
+ return this.apiClient.callApi(
15427
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent',
15428
+ 'POST',
15429
+ { 'conversationId': conversationId,'participantId': participantId },
15430
+ { },
15431
+ { },
15432
+ { },
15433
+ body,
15434
+ ['PureCloud OAuth'],
15435
+ ['application/json'],
15436
+ ['application/json']
15437
+ );
15438
+ }
15439
+
15440
+ /**
15441
+ * Initiate a consult transfer to an external contact
15442
+ *
15443
+ * @param {String} conversationId conversationId
15444
+ * @param {String} participantId participantId
15445
+ * @param {Object} body Destination address and initial speak to
15446
+ */
15447
+ postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
15448
+ // verify the required parameter 'conversationId' is set
15449
+ if (conversationId === undefined || conversationId === null) {
15450
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';
15451
+ }
15452
+ // verify the required parameter 'participantId' is set
15453
+ if (participantId === undefined || participantId === null) {
15454
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';
15455
+ }
15456
+ // verify the required parameter 'body' is set
15457
+ if (body === undefined || body === null) {
15458
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultExternal';
15459
+ }
15460
+
15461
+ return this.apiClient.callApi(
15462
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external',
15463
+ 'POST',
15464
+ { 'conversationId': conversationId,'participantId': participantId },
15465
+ { },
15466
+ { },
15467
+ { },
15468
+ body,
15469
+ ['PureCloud OAuth'],
15470
+ ['application/json'],
15471
+ ['application/json']
15472
+ );
15473
+ }
15474
+
15475
+ /**
15476
+ * Initiate a consult transfer to a queue
15477
+ *
15478
+ * @param {String} conversationId conversationId
15479
+ * @param {String} participantId participantId
15480
+ * @param {Object} body Destination queue and initial speak to
15481
+ */
15482
+ postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
15483
+ // verify the required parameter 'conversationId' is set
15484
+ if (conversationId === undefined || conversationId === null) {
15485
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultQueue';
15486
+ }
15487
+ // verify the required parameter 'participantId' is set
15488
+ if (participantId === undefined || participantId === null) {
15489
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultQueue';
15490
+ }
15491
+ // verify the required parameter 'body' is set
15492
+ if (body === undefined || body === null) {
15493
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultQueue';
15494
+ }
15495
+
15496
+ return this.apiClient.callApi(
15497
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue',
15498
+ 'POST',
15499
+ { 'conversationId': conversationId,'participantId': participantId },
15500
+ { },
15501
+ { },
15502
+ { },
15503
+ body,
15504
+ ['PureCloud OAuth'],
15505
+ ['application/json'],
15506
+ ['application/json']
15507
+ );
15508
+ }
15509
+
15184
15510
  /**
15185
15511
  * Listen in on the conversation from the point of view of a given participant.
15186
15512
  *
@@ -15217,6 +15543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15217
15543
  * @param {String} conversationId conversationId
15218
15544
  * @param {String} participantId participantId
15219
15545
  * @param {Object} body Transfer request
15546
+ * @deprecated
15220
15547
  */
15221
15548
  postConversationsCallParticipantReplace(conversationId, participantId, body) {
15222
15549
  // verify the required parameter 'conversationId' is set
@@ -15321,6 +15648,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15321
15648
  * @param {String} conversationId conversationId
15322
15649
  * @param {String} participantId participantId
15323
15650
  * @param {Object} body Transfer request
15651
+ * @deprecated
15324
15652
  */
15325
15653
  postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
15326
15654
  // verify the required parameter 'conversationId' is set
@@ -15560,6 +15888,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15560
15888
  * @param {String} conversationId conversationId
15561
15889
  * @param {String} participantId participantId
15562
15890
  * @param {Object} body Transfer request
15891
+ * @deprecated
15563
15892
  */
15564
15893
  postConversationsChatParticipantReplace(conversationId, participantId, body) {
15565
15894
  // verify the required parameter 'conversationId' is set
@@ -15660,6 +15989,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15660
15989
  * @param {String} participantId participantId
15661
15990
  * @param {Object} opts Optional parameters
15662
15991
  * @param {Object} opts.body
15992
+ * @deprecated
15663
15993
  */
15664
15994
  postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
15665
15995
  opts = opts || {};
@@ -15822,6 +16152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15822
16152
  * @param {String} conversationId conversationId
15823
16153
  * @param {String} participantId participantId
15824
16154
  * @param {Object} body Transfer request
16155
+ * @deprecated
15825
16156
  */
15826
16157
  postConversationsEmailParticipantReplace(conversationId, participantId, body) {
15827
16158
  // verify the required parameter 'conversationId' is set
@@ -16154,7 +16485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16154
16485
  *
16155
16486
  * @param {String} conversationId conversationId
16156
16487
  * @param {String} participantId participantId
16157
- * Preview Endpoint
16488
+ * postConversationsMessageParticipantMonitor is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16158
16489
  */
16159
16490
  postConversationsMessageParticipantMonitor(conversationId, participantId) {
16160
16491
  // verify the required parameter 'conversationId' is set
@@ -16186,6 +16517,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16186
16517
  * @param {String} conversationId conversationId
16187
16518
  * @param {String} participantId participantId
16188
16519
  * @param {Object} body Transfer request
16520
+ * @deprecated
16189
16521
  */
16190
16522
  postConversationsMessageParticipantReplace(conversationId, participantId, body) {
16191
16523
  // verify the required parameter 'conversationId' is set
@@ -16315,6 +16647,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
16315
16647
  );
16316
16648
  }
16317
16649
 
16650
+ /**
16651
+ * Create Instagram Integration
16652
+ *
16653
+ * @param {Object} body InstagramIntegrationRequest
16654
+ */
16655
+ postConversationsMessagingIntegrationsInstagram(body) {
16656
+ // verify the required parameter 'body' is set
16657
+ if (body === undefined || body === null) {
16658
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsInstagram';
16659
+ }
16660
+
16661
+ return this.apiClient.callApi(
16662
+ '/api/v2/conversations/messaging/integrations/instagram',
16663
+ 'POST',
16664
+ { },
16665
+ { },
16666
+ { },
16667
+ { },
16668
+ body,
16669
+ ['PureCloud OAuth'],
16670
+ ['application/json'],
16671
+ ['application/json']
16672
+ );
16673
+ }
16674
+
16318
16675
  /**
16319
16676
  * Create a LINE messenger Integration
16320
16677
  *
@@ -17128,7 +17485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17128
17485
  /**
17129
17486
  * DataExtensions service.
17130
17487
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
17131
- * @version 169.1.0
17488
+ * @version 171.0.0
17132
17489
  */
17133
17490
 
17134
17491
  /**
@@ -17214,7 +17571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17214
17571
  /**
17215
17572
  * Downloads service.
17216
17573
  * @module purecloud-platform-client-v2/api/DownloadsApi
17217
- * @version 169.1.0
17574
+ * @version 171.0.0
17218
17575
  */
17219
17576
 
17220
17577
  /**
@@ -17266,7 +17623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17266
17623
  /**
17267
17624
  * Events service.
17268
17625
  * @module purecloud-platform-client-v2/api/EventsApi
17269
- * @version 169.1.0
17626
+ * @version 171.0.0
17270
17627
  */
17271
17628
 
17272
17629
  /**
@@ -17362,7 +17719,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17362
17719
  /**
17363
17720
  * ExternalContacts service.
17364
17721
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
17365
- * @version 169.1.0
17722
+ * @version 171.0.0
17366
17723
  */
17367
17724
 
17368
17725
  /**
@@ -19320,7 +19677,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19320
19677
  /**
19321
19678
  * Fax service.
19322
19679
  * @module purecloud-platform-client-v2/api/FaxApi
19323
- * @version 169.1.0
19680
+ * @version 171.0.0
19324
19681
  */
19325
19682
 
19326
19683
  /**
@@ -19491,7 +19848,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19491
19848
  /**
19492
19849
  * Flows service.
19493
19850
  * @module purecloud-platform-client-v2/api/FlowsApi
19494
- * @version 169.1.0
19851
+ * @version 171.0.0
19495
19852
  */
19496
19853
 
19497
19854
  /**
@@ -19510,7 +19867,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19510
19867
  * Get status for async query for Flow aggregates
19511
19868
  *
19512
19869
  * @param {String} jobId jobId
19513
- * Preview Endpoint
19870
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19514
19871
  */
19515
19872
  getAnalyticsFlowsAggregatesJob(jobId) {
19516
19873
  // verify the required parameter 'jobId' is set
@@ -19538,7 +19895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19538
19895
  * @param {String} jobId jobId
19539
19896
  * @param {Object} opts Optional parameters
19540
19897
  * @param {String} opts.cursor Cursor token to retrieve next page
19541
- * Preview Endpoint
19898
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19542
19899
  */
19543
19900
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
19544
19901
  opts = opts || {};
@@ -19569,7 +19926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19569
19926
  * @param {Object} opts Optional parameters
19570
19927
  * @param {Number} opts.pageSize The desired page size
19571
19928
  * @param {Number} opts.pageNumber The desired page number
19572
- * Preview Endpoint
19929
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19573
19930
  */
19574
19931
  postAnalyticsFlowsActivityQuery(body, opts) {
19575
19932
  opts = opts || {};
@@ -19597,7 +19954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19597
19954
  * Query for flow aggregates asynchronously
19598
19955
  *
19599
19956
  * @param {Object} body query
19600
- * Preview Endpoint
19957
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
19601
19958
  */
19602
19959
  postAnalyticsFlowsAggregatesJobs(body) {
19603
19960
  // verify the required parameter 'body' is set
@@ -19675,7 +20032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19675
20032
  /**
19676
20033
  * Gamification service.
19677
20034
  * @module purecloud-platform-client-v2/api/GamificationApi
19678
- * @version 169.1.0
20035
+ * @version 171.0.0
19679
20036
  */
19680
20037
 
19681
20038
  /**
@@ -21761,7 +22118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21761
22118
  /**
21762
22119
  * GeneralDataProtectionRegulation service.
21763
22120
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
21764
- * @version 169.1.0
22121
+ * @version 171.0.0
21765
22122
  */
21766
22123
 
21767
22124
  /**
@@ -21891,7 +22248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21891
22248
  /**
21892
22249
  * Geolocation service.
21893
22250
  * @module purecloud-platform-client-v2/api/GeolocationApi
21894
- * @version 169.1.0
22251
+ * @version 171.0.0
21895
22252
  */
21896
22253
 
21897
22254
  /**
@@ -22022,7 +22379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22022
22379
  /**
22023
22380
  * Greetings service.
22024
22381
  * @module purecloud-platform-client-v2/api/GreetingsApi
22025
- * @version 169.1.0
22382
+ * @version 171.0.0
22026
22383
  */
22027
22384
 
22028
22385
  /**
@@ -22477,7 +22834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22477
22834
  /**
22478
22835
  * Groups service.
22479
22836
  * @module purecloud-platform-client-v2/api/GroupsApi
22480
- * @version 169.1.0
22837
+ * @version 171.0.0
22481
22838
  */
22482
22839
 
22483
22840
  /**
@@ -22521,7 +22878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22521
22878
  * Remove dynamic group definition
22522
22879
  *
22523
22880
  * @param {String} groupId Group ID
22524
- * Preview Endpoint
22881
+ * deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22525
22882
  */
22526
22883
  deleteGroupDynamicsettings(groupId) {
22527
22884
  // verify the required parameter 'groupId' is set
@@ -22577,7 +22934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22577
22934
  * Fetch field config for an entity type
22578
22935
  *
22579
22936
  * @param {Object} type Field type
22580
- * @deprecated
22937
+ * @deprecated
22581
22938
  */
22582
22939
  getFieldconfig(type) {
22583
22940
  // verify the required parameter 'type' is set
@@ -22628,7 +22985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22628
22985
  * Get dynamic group definition
22629
22986
  *
22630
22987
  * @param {String} groupId Group ID
22631
- * Preview Endpoint
22988
+ * getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22632
22989
  */
22633
22990
  getGroupDynamicsettings(groupId) {
22634
22991
  // verify the required parameter 'groupId' is set
@@ -22713,7 +23070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22713
23070
  * @param {String} groupId groupId
22714
23071
  * @param {Object} opts Optional parameters
22715
23072
  * @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
22716
- * @deprecated
23073
+ * @deprecated
22717
23074
  */
22718
23075
  getGroupProfile(groupId, opts) {
22719
23076
  opts = opts || {};
@@ -22803,7 +23160,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22803
23160
  * @param {Array.<String>} opts.id id
22804
23161
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
22805
23162
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
22806
- * @deprecated
23163
+ * @deprecated
22807
23164
  */
22808
23165
  getProfilesGroups(opts) {
22809
23166
  opts = opts || {};
@@ -22882,8 +23239,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22882
23239
  * Preview the number of users selected for a dynamic group definition query
22883
23240
  *
22884
23241
  * @param {Object} body Group query to preview
22885
- * @deprecated
22886
- * Preview Endpoint
23242
+ * @deprecated
23243
+ * postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22887
23244
  */
22888
23245
  postGroupsDynamicsettingsPreview(body) {
22889
23246
  // verify the required parameter 'body' is set
@@ -22964,7 +23321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22964
23321
  *
22965
23322
  * @param {String} groupId Group ID
22966
23323
  * @param {Object} body Create/Update dynamic groups
22967
- * Preview Endpoint
23324
+ * putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22968
23325
  */
22969
23326
  putGroupDynamicsettings(groupId, body) {
22970
23327
  // verify the required parameter 'groupId' is set
@@ -22996,7 +23353,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22996
23353
  /**
22997
23354
  * IdentityProvider service.
22998
23355
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
22999
- * @version 169.1.0
23356
+ * @version 171.0.0
23000
23357
  */
23001
23358
 
23002
23359
  /**
@@ -23752,7 +24109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23752
24109
  /**
23753
24110
  * InfrastructureAsCode service.
23754
24111
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
23755
- * @version 169.1.0
24112
+ * @version 171.0.0
23756
24113
  */
23757
24114
 
23758
24115
  /**
@@ -23919,7 +24276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23919
24276
  /**
23920
24277
  * Integrations service.
23921
24278
  * @module purecloud-platform-client-v2/api/IntegrationsApi
23922
- * @version 169.1.0
24279
+ * @version 171.0.0
23923
24280
  */
23924
24281
 
23925
24282
  /**
@@ -24819,7 +25176,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24819
25176
  * @param {Object} opts Optional parameters
24820
25177
  * @param {Array.<String>} opts.expand expand
24821
25178
  * @param {Object} opts.targetChannel targetChannel
24822
- * Preview Endpoint
25179
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24823
25180
  */
24824
25181
  getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId, botId, opts) {
24825
25182
  opts = opts || {};
@@ -24853,7 +25210,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24853
25210
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24854
25211
  * @param {String} botId The Nuance bot ID
24855
25212
  * @param {String} jobId The asynchronous job ID
24856
- * Preview Endpoint
25213
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24857
25214
  */
24858
25215
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId, botId, jobId) {
24859
25216
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -24889,7 +25246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24889
25246
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24890
25247
  * @param {String} botId The Nuance bot ID
24891
25248
  * @param {String} jobId The asynchronous job ID
24892
- * Preview Endpoint
25249
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24893
25250
  */
24894
25251
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId, botId, jobId) {
24895
25252
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -24927,7 +25284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24927
25284
  * @param {Number} opts.pageNumber Page number (default to 1)
24928
25285
  * @param {Number} opts.pageSize Page size (default to 25)
24929
25286
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
24930
- * Preview Endpoint
25287
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24931
25288
  */
24932
25289
  getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId, opts) {
24933
25290
  opts = opts || {};
@@ -24956,7 +25313,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24956
25313
  *
24957
25314
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24958
25315
  * @param {String} jobId The asynchronous job ID
24959
- * Preview Endpoint
25316
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24960
25317
  */
24961
25318
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId, jobId) {
24962
25319
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -24987,7 +25344,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24987
25344
  *
24988
25345
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
24989
25346
  * @param {String} jobId The asynchronous job ID
24990
- * Preview Endpoint
25347
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24991
25348
  */
24992
25349
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId, jobId) {
24993
25350
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -25610,7 +25967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25610
25967
  * @param {Object} opts Optional parameters
25611
25968
  * @param {Array.<String>} opts.expand expand
25612
25969
  * @param {String} opts.body targetChannel
25613
- * Preview Endpoint
25970
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25614
25971
  */
25615
25972
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId, botId, opts) {
25616
25973
  opts = opts || {};
@@ -25646,7 +26003,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25646
26003
  * @param {Number} opts.pageNumber Page number (default to 1)
25647
26004
  * @param {Number} opts.pageSize Page size (default to 25)
25648
26005
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
25649
- * Preview Endpoint
26006
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25650
26007
  */
25651
26008
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId, opts) {
25652
26009
  opts = opts || {};
@@ -25675,7 +26032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25675
26032
  *
25676
26033
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
25677
26034
  * @param {Object} settings
25678
- * Preview Endpoint
26035
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25679
26036
  */
25680
26037
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId, settings) {
25681
26038
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -25794,7 +26151,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25794
26151
  *
25795
26152
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
25796
26153
  * @param {Object} settings
25797
- * Preview Endpoint
26154
+ * putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
25798
26155
  */
25799
26156
  putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId, settings) {
25800
26157
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -25845,13 +26202,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25845
26202
  );
25846
26203
  }
25847
26204
 
26205
+ /**
26206
+ * Bulk integration presence ingestion
26207
+ * 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.
26208
+ * @param {String} ucIntegrationId UC Integration ID
26209
+ * @param {Array.<Object>} body List of User presences
26210
+ */
26211
+ putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body) {
26212
+ // verify the required parameter 'ucIntegrationId' is set
26213
+ if (ucIntegrationId === undefined || ucIntegrationId === null) {
26214
+ throw 'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
26215
+ }
26216
+ // verify the required parameter 'body' is set
26217
+ if (body === undefined || body === null) {
26218
+ throw 'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
26219
+ }
26220
+
26221
+ return this.apiClient.callApi(
26222
+ '/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences',
26223
+ 'PUT',
26224
+ { 'ucIntegrationId': ucIntegrationId },
26225
+ { },
26226
+ { },
26227
+ { },
26228
+ body,
26229
+ ['PureCloud OAuth'],
26230
+ ['application/json'],
26231
+ ['application/json']
26232
+ );
26233
+ }
26234
+
25848
26235
  }
25849
26236
 
25850
26237
  class JourneyApi {
25851
26238
  /**
25852
26239
  * Journey service.
25853
26240
  * @module purecloud-platform-client-v2/api/JourneyApi
25854
- * @version 169.1.0
26241
+ * @version 171.0.0
25855
26242
  */
25856
26243
 
25857
26244
  /**
@@ -25999,7 +26386,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25999
26386
  * Get status for async query for journey aggregates
26000
26387
  *
26001
26388
  * @param {String} jobId jobId
26002
- * Preview Endpoint
26389
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26003
26390
  */
26004
26391
  getAnalyticsJourneysAggregatesJob(jobId) {
26005
26392
  // verify the required parameter 'jobId' is set
@@ -26027,7 +26414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26027
26414
  * @param {String} jobId jobId
26028
26415
  * @param {Object} opts Optional parameters
26029
26416
  * @param {String} opts.cursor Cursor token to retrieve next page
26030
- * Preview Endpoint
26417
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26031
26418
  */
26032
26419
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
26033
26420
  opts = opts || {};
@@ -26262,42 +26649,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26262
26649
  );
26263
26650
  }
26264
26651
 
26265
- /**
26266
- * Retrieve all sessions for a given customer.
26267
- *
26268
- * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
26269
- * @param {String} customerId Primary identifier of the customer in the source of the session.
26270
- * @param {Object} opts Optional parameters
26271
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
26272
- * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
26273
- * Preview Endpoint
26274
- */
26275
- getJourneyCustomerCustomerIdSessions(customerIdType, customerId, opts) {
26276
- opts = opts || {};
26277
-
26278
- // verify the required parameter 'customerIdType' is set
26279
- if (customerIdType === undefined || customerIdType === null) {
26280
- throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSessions';
26281
- }
26282
- // verify the required parameter 'customerId' is set
26283
- if (customerId === undefined || customerId === null) {
26284
- throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSessions';
26285
- }
26286
-
26287
- return this.apiClient.callApi(
26288
- '/api/v2/journey/customers/{customerIdType}/{customerId}/sessions',
26289
- 'GET',
26290
- { 'customerIdType': customerIdType,'customerId': customerId },
26291
- { 'pageSize': opts['pageSize'],'after': opts['after'] },
26292
- { },
26293
- { },
26294
- null,
26295
- ['PureCloud OAuth'],
26296
- ['application/json'],
26297
- ['application/json']
26298
- );
26299
- }
26300
-
26301
26652
  /**
26302
26653
  * Retrieve a single outcome.
26303
26654
  *
@@ -26356,7 +26707,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26356
26707
  * Get job status.
26357
26708
  *
26358
26709
  * @param {String} jobId ID of the job.
26359
- * Preview Endpoint
26710
+ * getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26360
26711
  */
26361
26712
  getJourneyOutcomesAttributionsJob(jobId) {
26362
26713
  // verify the required parameter 'jobId' is set
@@ -26382,7 +26733,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26382
26733
  * Get outcome attribution entities from completed job.
26383
26734
  *
26384
26735
  * @param {String} jobId ID of the job.
26385
- * Preview Endpoint
26736
+ * getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26386
26737
  */
26387
26738
  getJourneyOutcomesAttributionsJobResults(jobId) {
26388
26739
  // verify the required parameter 'jobId' is set
@@ -26536,7 +26887,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26536
26887
  * @param {Object} opts Optional parameters
26537
26888
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
26538
26889
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
26539
- * Preview Endpoint
26890
+ * getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26540
26891
  */
26541
26892
  getJourneySessionEvents(sessionId, opts) {
26542
26893
  opts = opts || {};
@@ -26594,7 +26945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26594
26945
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
26595
26946
  * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
26596
26947
  * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
26597
- * Preview Endpoint
26948
+ * getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26598
26949
  */
26599
26950
  getJourneySessionSegments(sessionId, opts) {
26600
26951
  opts = opts || {};
@@ -26767,7 +27118,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26767
27118
  * Query for journey aggregates asynchronously
26768
27119
  *
26769
27120
  * @param {Object} body query
26770
- * Preview Endpoint
27121
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26771
27122
  */
26772
27123
  postAnalyticsJourneysAggregatesJobs(body) {
26773
27124
  // verify the required parameter 'body' is set
@@ -26916,7 +27267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26916
27267
  *
26917
27268
  * @param {Object} opts Optional parameters
26918
27269
  * @param {Object} opts.body outcome attribution request
26919
- * Preview Endpoint
27270
+ * postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26920
27271
  */
26921
27272
  postJourneyOutcomesAttributionsJobs(opts) {
26922
27273
  opts = opts || {};
@@ -26990,7 +27341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26990
27341
  /**
26991
27342
  * Knowledge service.
26992
27343
  * @module purecloud-platform-client-v2/api/KnowledgeApi
26993
- * @version 169.1.0
27344
+ * @version 171.0.0
26994
27345
  */
26995
27346
 
26996
27347
  /**
@@ -27221,7 +27572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27221
27572
  * @param {String} categoryId Category ID
27222
27573
  * @param {String} knowledgeBaseId Knowledge base ID
27223
27574
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27224
- * @deprecated
27575
+ * @deprecated
27225
27576
  */
27226
27577
  deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
27227
27578
  // verify the required parameter 'categoryId' is set
@@ -27257,7 +27608,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27257
27608
  * @param {String} documentId Document ID
27258
27609
  * @param {String} knowledgeBaseId Knowledge base ID
27259
27610
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27260
- * @deprecated
27611
+ * @deprecated
27261
27612
  */
27262
27613
  deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
27263
27614
  // verify the required parameter 'documentId' is set
@@ -27293,7 +27644,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27293
27644
  * @param {String} knowledgeBaseId Knowledge base ID
27294
27645
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27295
27646
  * @param {String} importId Import ID
27296
- * @deprecated
27647
+ * @deprecated
27297
27648
  */
27298
27649
  deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
27299
27650
  // verify the required parameter 'knowledgeBaseId' is set
@@ -27795,6 +28146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27795
28146
  * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
27796
28147
  * @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
27797
28148
  * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
28149
+ * @param {Array.<String>} opts.externalIds If specified, retrieves documents associated with external ids, comma separated values expected.
27798
28150
  */
27799
28151
  getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
27800
28152
  opts = opts || {};
@@ -27808,7 +28160,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27808
28160
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
27809
28161
  'GET',
27810
28162
  { 'knowledgeBaseId': knowledgeBaseId },
27811
- { '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') },
28163
+ { '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') },
27812
28164
  { },
27813
28165
  { },
27814
28166
  null,
@@ -27952,7 +28304,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27952
28304
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
27953
28305
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
27954
28306
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
27955
- * @deprecated
28307
+ * @deprecated
27956
28308
  */
27957
28309
  getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
27958
28310
  opts = opts || {};
@@ -27986,7 +28338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27986
28338
  * @param {String} categoryId Category ID
27987
28339
  * @param {String} knowledgeBaseId Knowledge base ID
27988
28340
  * @param {Object} languageCode Language code, format: iso2-LOCALE
27989
- * @deprecated
28341
+ * @deprecated
27990
28342
  */
27991
28343
  getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
27992
28344
  // verify the required parameter 'categoryId' is set
@@ -28022,7 +28374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28022
28374
  * @param {String} documentId Document ID
28023
28375
  * @param {String} knowledgeBaseId Knowledge base ID
28024
28376
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28025
- * @deprecated
28377
+ * @deprecated
28026
28378
  */
28027
28379
  getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
28028
28380
  // verify the required parameter 'documentId' is set
@@ -28059,8 +28411,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28059
28411
  * @param {String} knowledgeBaseId Knowledge base ID
28060
28412
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28061
28413
  * @param {String} uploadId UploadId
28062
- * @deprecated
28063
- * Preview Endpoint
28414
+ * @deprecated
28415
+ * getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28064
28416
  */
28065
28417
  getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
28066
28418
  // verify the required parameter 'documentId' is set
@@ -28109,7 +28461,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28109
28461
  * @param {Object} opts.sortBy Sort by.
28110
28462
  * @param {Object} opts.sortOrder Sort Order.
28111
28463
  * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
28112
- * @deprecated
28464
+ * @deprecated
28113
28465
  */
28114
28466
  getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
28115
28467
  opts = opts || {};
@@ -28143,7 +28495,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28143
28495
  * @param {String} knowledgeBaseId Knowledge base ID
28144
28496
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28145
28497
  * @param {String} importId Import ID
28146
- * @deprecated
28498
+ * @deprecated
28147
28499
  */
28148
28500
  getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
28149
28501
  // verify the required parameter 'knowledgeBaseId' is set
@@ -28179,7 +28531,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28179
28531
  * @param {String} knowledgeBaseId Knowledge base ID
28180
28532
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28181
28533
  * @param {String} trainingId Training ID
28182
- * @deprecated
28534
+ * @deprecated
28183
28535
  */
28184
28536
  getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
28185
28537
  // verify the required parameter 'knowledgeBaseId' is set
@@ -28220,7 +28572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28220
28572
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
28221
28573
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28222
28574
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
28223
- * @deprecated
28575
+ * @deprecated
28224
28576
  */
28225
28577
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
28226
28578
  opts = opts || {};
@@ -28668,7 +29020,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28668
29020
  * @param {String} knowledgeBaseId Knowledge base ID
28669
29021
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28670
29022
  * @param {Object} body
28671
- * @deprecated
29023
+ * @deprecated
28672
29024
  */
28673
29025
  patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
28674
29026
  // verify the required parameter 'categoryId' is set
@@ -28709,7 +29061,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28709
29061
  * @param {String} knowledgeBaseId Knowledge base ID
28710
29062
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28711
29063
  * @param {Object} body
28712
- * @deprecated
29064
+ * @deprecated
28713
29065
  */
28714
29066
  patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
28715
29067
  // verify the required parameter 'documentId' is set
@@ -28749,7 +29101,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28749
29101
  * @param {String} knowledgeBaseId Knowledge base ID
28750
29102
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28751
29103
  * @param {Array.<Object>} body
28752
- * @deprecated
29104
+ * @deprecated
28753
29105
  */
28754
29106
  patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
28755
29107
  // verify the required parameter 'knowledgeBaseId' is set
@@ -28786,7 +29138,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
28786
29138
  * @param {Object} languageCode Language code, format: iso2-LOCALE
28787
29139
  * @param {String} importId Import ID
28788
29140
  * @param {Object} body
28789
- * @deprecated
29141
+ * @deprecated
28790
29142
  */
28791
29143
  patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
28792
29144
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29104,7 +29456,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29104
29456
  *
29105
29457
  * @param {String} knowledgeBaseId Knowledge base ID
29106
29458
  * @param {Object} body
29107
- * Preview Endpoint
29459
+ * postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29108
29460
  */
29109
29461
  postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
29110
29462
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29135,7 +29487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29135
29487
  *
29136
29488
  * @param {String} knowledgeBaseId Knowledge base ID
29137
29489
  * @param {Object} body
29138
- * Preview Endpoint
29490
+ * postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29139
29491
  */
29140
29492
  postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
29141
29493
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29225,7 +29577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29225
29577
  *
29226
29578
  * @param {String} knowledgeBaseId Knowledge base ID
29227
29579
  * @param {Object} body
29228
- * Preview Endpoint
29580
+ * postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29229
29581
  */
29230
29582
  postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
29231
29583
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29347,7 +29699,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29347
29699
  * @param {String} knowledgeBaseId Knowledge base ID
29348
29700
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29349
29701
  * @param {Object} body
29350
- * @deprecated
29702
+ * @deprecated
29351
29703
  */
29352
29704
  postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
29353
29705
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29384,8 +29736,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29384
29736
  * @param {String} knowledgeBaseId Knowledge base ID
29385
29737
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29386
29738
  * @param {Object} body
29387
- * @deprecated
29388
- * Preview Endpoint
29739
+ * @deprecated
29740
+ * postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29389
29741
  */
29390
29742
  postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
29391
29743
  // verify the required parameter 'documentId' is set
@@ -29425,7 +29777,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29425
29777
  * @param {String} knowledgeBaseId Knowledge base ID
29426
29778
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29427
29779
  * @param {Object} body
29428
- * @deprecated
29780
+ * @deprecated
29429
29781
  */
29430
29782
  postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
29431
29783
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29461,7 +29813,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29461
29813
  * @param {String} knowledgeBaseId Knowledge base ID
29462
29814
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29463
29815
  * @param {Object} body
29464
- * @deprecated
29816
+ * @deprecated
29465
29817
  */
29466
29818
  postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
29467
29819
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29497,7 +29849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29497
29849
  * @param {String} knowledgeBaseId Knowledge base ID
29498
29850
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29499
29851
  * @param {String} trainingId Training ID
29500
- * @deprecated
29852
+ * @deprecated
29501
29853
  */
29502
29854
  postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
29503
29855
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29532,7 +29884,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29532
29884
  *
29533
29885
  * @param {String} knowledgeBaseId Knowledge base ID
29534
29886
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29535
- * @deprecated
29887
+ * @deprecated
29536
29888
  */
29537
29889
  postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
29538
29890
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29564,7 +29916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29564
29916
  * @param {String} knowledgeBaseId Knowledge base ID
29565
29917
  * @param {Object} opts Optional parameters
29566
29918
  * @param {Object} opts.body
29567
- * @deprecated
29919
+ * @deprecated
29568
29920
  */
29569
29921
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
29570
29922
  opts = opts || {};
@@ -29619,7 +29971,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29619
29971
  /**
29620
29972
  * LanguageUnderstanding service.
29621
29973
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
29622
- * @version 169.1.0
29974
+ * @version 171.0.0
29623
29975
  */
29624
29976
 
29625
29977
  /**
@@ -30632,7 +30984,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30632
30984
  /**
30633
30985
  * Languages service.
30634
30986
  * @module purecloud-platform-client-v2/api/LanguagesApi
30635
- * @version 169.1.0
30987
+ * @version 171.0.0
30636
30988
  */
30637
30989
 
30638
30990
  /**
@@ -30651,7 +31003,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30651
31003
  * Delete Language (Deprecated)
30652
31004
  * This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
30653
31005
  * @param {String} languageId Language ID
30654
- * @deprecated
31006
+ * @deprecated
30655
31007
  */
30656
31008
  deleteLanguage(languageId) {
30657
31009
  // verify the required parameter 'languageId' is set
@@ -30677,7 +31029,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30677
31029
  * Get Language (Deprecated)
30678
31030
  * This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
30679
31031
  * @param {String} languageId Language ID
30680
- * @deprecated
31032
+ * @deprecated
30681
31033
  */
30682
31034
  getLanguage(languageId) {
30683
31035
  // verify the required parameter 'languageId' is set
@@ -30707,7 +31059,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30707
31059
  * @param {Number} opts.pageNumber Page number (default to 1)
30708
31060
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
30709
31061
  * @param {String} opts.name Name
30710
- * @deprecated
31062
+ * @deprecated
30711
31063
  */
30712
31064
  getLanguages(opts) {
30713
31065
  opts = opts || {};
@@ -30826,7 +31178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30826
31178
  * Create Language (Deprecated)
30827
31179
  * This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
30828
31180
  * @param {Object} body Language
30829
- * @deprecated
31181
+ * @deprecated
30830
31182
  */
30831
31183
  postLanguages(body) {
30832
31184
  // verify the required parameter 'body' is set
@@ -30854,7 +31206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30854
31206
  /**
30855
31207
  * Learning service.
30856
31208
  * @module purecloud-platform-client-v2/api/LearningApi
30857
- * @version 169.1.0
31209
+ * @version 171.0.0
30858
31210
  */
30859
31211
 
30860
31212
  /**
@@ -31669,7 +32021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31669
32021
  /**
31670
32022
  * License service.
31671
32023
  * @module purecloud-platform-client-v2/api/LicenseApi
31672
- * @version 169.1.0
32024
+ * @version 171.0.0
31673
32025
  */
31674
32026
 
31675
32027
  /**
@@ -31907,7 +32259,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31907
32259
  /**
31908
32260
  * Locations service.
31909
32261
  * @module purecloud-platform-client-v2/api/LocationsApi
31910
- * @version 169.1.0
32262
+ * @version 171.0.0
31911
32263
  */
31912
32264
 
31913
32265
  /**
@@ -32143,7 +32495,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32143
32495
  /**
32144
32496
  * Messaging service.
32145
32497
  * @module purecloud-platform-client-v2/api/MessagingApi
32146
- * @version 169.1.0
32498
+ * @version 171.0.0
32147
32499
  */
32148
32500
 
32149
32501
  /**
@@ -32162,7 +32514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32162
32514
  * Delete a supported content profile
32163
32515
  * Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
32164
32516
  * @param {String} supportedContentId Supported Content ID
32165
- * @deprecated
32517
+ * @deprecated
32166
32518
  */
32167
32519
  deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
32168
32520
  // verify the required parameter 'supportedContentId' is set
@@ -32190,7 +32542,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32190
32542
  * @param {Object} opts Optional parameters
32191
32543
  * @param {Number} opts.pageSize Page size (default to 25)
32192
32544
  * @param {Number} opts.pageNumber Page number (default to 1)
32193
- * @deprecated
32545
+ * @deprecated
32194
32546
  */
32195
32547
  getMessagingSupportedcontent(opts) {
32196
32548
  opts = opts || {};
@@ -32214,7 +32566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32214
32566
  * Get a supported content profile
32215
32567
  * Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
32216
32568
  * @param {String} supportedContentId Supported Content ID
32217
- * @deprecated
32569
+ * @deprecated
32218
32570
  */
32219
32571
  getMessagingSupportedcontentSupportedContentId(supportedContentId) {
32220
32572
  // verify the required parameter 'supportedContentId' is set
@@ -32241,7 +32593,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32241
32593
  * Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
32242
32594
  * @param {String} supportedContentId Supported Content ID
32243
32595
  * @param {Object} body SupportedContent
32244
- * @deprecated
32596
+ * @deprecated
32245
32597
  */
32246
32598
  patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
32247
32599
  // verify the required parameter 'supportedContentId' is set
@@ -32271,7 +32623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32271
32623
  * Create a Supported Content profile
32272
32624
  * Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
32273
32625
  * @param {Object} body SupportedContent
32274
- * @deprecated
32626
+ * @deprecated
32275
32627
  */
32276
32628
  postMessagingSupportedcontent(body) {
32277
32629
  // verify the required parameter 'body' is set
@@ -32299,7 +32651,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32299
32651
  /**
32300
32652
  * MobileDevices service.
32301
32653
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
32302
- * @version 169.1.0
32654
+ * @version 171.0.0
32303
32655
  */
32304
32656
 
32305
32657
  /**
@@ -32450,7 +32802,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32450
32802
  /**
32451
32803
  * Notifications service.
32452
32804
  * @module purecloud-platform-client-v2/api/NotificationsApi
32453
- * @version 169.1.0
32805
+ * @version 171.0.0
32454
32806
  */
32455
32807
 
32456
32808
  /**
@@ -32683,7 +33035,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32683
33035
  /**
32684
33036
  * OAuth service.
32685
33037
  * @module purecloud-platform-client-v2/api/OAuthApi
32686
- * @version 169.1.0
33038
+ * @version 171.0.0
32687
33039
  */
32688
33040
 
32689
33041
  /**
@@ -33049,7 +33401,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33049
33401
  /**
33050
33402
  * Objects service.
33051
33403
  * @module purecloud-platform-client-v2/api/ObjectsApi
33052
- * @version 169.1.0
33404
+ * @version 171.0.0
33053
33405
  */
33054
33406
 
33055
33407
  /**
@@ -33320,7 +33672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33320
33672
  /**
33321
33673
  * Organization service.
33322
33674
  * @module purecloud-platform-client-v2/api/OrganizationApi
33323
- * @version 169.1.0
33675
+ * @version 171.0.0
33324
33676
  */
33325
33677
 
33326
33678
  /**
@@ -33339,7 +33691,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33339
33691
  * Fetch field config for an entity type
33340
33692
  *
33341
33693
  * @param {Object} type Field type
33342
- * @deprecated
33694
+ * @deprecated
33343
33695
  */
33344
33696
  getFieldconfig(type) {
33345
33697
  // verify the required parameter 'type' is set
@@ -33384,7 +33736,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33384
33736
  /**
33385
33737
  * Get the list of domains that will be allowed to embed PureCloud applications
33386
33738
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33387
- * @deprecated
33739
+ * @deprecated
33388
33740
  */
33389
33741
  getOrganizationsEmbeddedintegration() {
33390
33742
 
@@ -33405,7 +33757,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33405
33757
  /**
33406
33758
  * Get organization IP address whitelist settings
33407
33759
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33408
- * @deprecated
33760
+ * @deprecated
33409
33761
  */
33410
33762
  getOrganizationsIpaddressauthentication() {
33411
33763
 
@@ -33594,7 +33946,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33594
33946
  /**
33595
33947
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33596
33948
  *
33597
- * @deprecated
33949
+ * @deprecated
33598
33950
  */
33599
33951
  getOrganizationsWhitelist() {
33600
33952
 
@@ -33671,7 +34023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33671
34023
  * Update the list of domains that will be allowed to embed PureCloud applications
33672
34024
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33673
34025
  * @param {Object} body Whitelist settings
33674
- * @deprecated
34026
+ * @deprecated
33675
34027
  */
33676
34028
  putOrganizationsEmbeddedintegration(body) {
33677
34029
  // verify the required parameter 'body' is set
@@ -33697,7 +34049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33697
34049
  * Update organization IP address whitelist settings
33698
34050
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33699
34051
  * @param {Object} body IP address Whitelist settings
33700
- * @deprecated
34052
+ * @deprecated
33701
34053
  */
33702
34054
  putOrganizationsIpaddressauthentication(body) {
33703
34055
  // verify the required parameter 'body' is set
@@ -33747,7 +34099,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33747
34099
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
33748
34100
  *
33749
34101
  * @param {Object} body Whitelist settings
33750
- * @deprecated
34102
+ * @deprecated
33751
34103
  */
33752
34104
  putOrganizationsWhitelist(body) {
33753
34105
  // verify the required parameter 'body' is set
@@ -33775,7 +34127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33775
34127
  /**
33776
34128
  * OrganizationAuthorization service.
33777
34129
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
33778
- * @version 169.1.0
34130
+ * @version 171.0.0
33779
34131
  */
33780
34132
 
33781
34133
  /**
@@ -33969,7 +34321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33969
34321
  * Delete Bulk Org Trustees
33970
34322
  *
33971
34323
  * @param {Array.<String>} id Comma separated list of trustee ids to remove
33972
- * Preview Endpoint
34324
+ * deleteOrgauthorizationTrustees is a preview method and is subject to both breaking and non-breaking changes at any time without notice
33973
34325
  */
33974
34326
  deleteOrgauthorizationTrustees(id) {
33975
34327
  // verify the required parameter 'id' is set
@@ -34110,7 +34462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34110
34462
  * Delete Bulk Org Trustors
34111
34463
  *
34112
34464
  * @param {Array.<String>} id Comma separated list of trustor ids to remove
34113
- * Preview Endpoint
34465
+ * deleteOrgauthorizationTrustors is a preview method and is subject to both breaking and non-breaking changes at any time without notice
34114
34466
  */
34115
34467
  deleteOrgauthorizationTrustors(id) {
34116
34468
  // verify the required parameter 'id' is set
@@ -35122,7 +35474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35122
35474
  /**
35123
35475
  * Outbound service.
35124
35476
  * @module purecloud-platform-client-v2/api/OutboundApi
35125
- * @version 169.1.0
35477
+ * @version 171.0.0
35126
35478
  */
35127
35479
 
35128
35480
  /**
@@ -37607,7 +37959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37607
37959
  * This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
37608
37960
  * @param {String} campaignId Campaign ID
37609
37961
  * @param {Object} body ContactCallbackRequest
37610
- * @deprecated
37962
+ * @deprecated
37611
37963
  */
37612
37964
  postOutboundCampaignCallbackSchedule(campaignId, body) {
37613
37965
  // verify the required parameter 'campaignId' is set
@@ -38744,7 +39096,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38744
39096
  /**
38745
39097
  * Presence service.
38746
39098
  * @module purecloud-platform-client-v2/api/PresenceApi
38747
- * @version 169.1.0
39099
+ * @version 171.0.0
38748
39100
  */
38749
39101
 
38750
39102
  /**
@@ -38763,12 +39115,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38763
39115
  * Delete a Presence Definition
38764
39116
  *
38765
39117
  * @param {String} definitionId Presence Definition ID
38766
- * Preview Endpoint
39118
+ * deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38767
39119
  */
38768
- deletePresenceDefinition(definitionId) {
39120
+ deletePresenceDefinition0(definitionId) {
38769
39121
  // verify the required parameter 'definitionId' is set
38770
39122
  if (definitionId === undefined || definitionId === null) {
38771
- throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition';
39123
+ throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
38772
39124
  }
38773
39125
 
38774
39126
  return this.apiClient.callApi(
@@ -38839,12 +39191,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38839
39191
  * Get a Presence Definition
38840
39192
  *
38841
39193
  * @param {String} definitionId Presence Definition ID
38842
- * Preview Endpoint
39194
+ * getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38843
39195
  */
38844
- getPresenceDefinition(definitionId) {
39196
+ getPresenceDefinition0(definitionId) {
38845
39197
  // verify the required parameter 'definitionId' is set
38846
39198
  if (definitionId === undefined || definitionId === null) {
38847
- throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition';
39199
+ throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
38848
39200
  }
38849
39201
 
38850
39202
  return this.apiClient.callApi(
@@ -38867,9 +39219,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38867
39219
  * @param {Object} opts Optional parameters
38868
39220
  * @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
38869
39221
  * @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.
38870
- * Preview Endpoint
39222
+ * getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38871
39223
  */
38872
- getPresenceDefinitions(opts) {
39224
+ getPresenceDefinitions0(opts) {
38873
39225
  opts = opts || {};
38874
39226
 
38875
39227
 
@@ -39112,6 +39464,59 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39112
39464
  );
39113
39465
  }
39114
39466
 
39467
+ /**
39468
+ * Get bulk user presences for a single presence source
39469
+ *
39470
+ * @param {String} sourceId The requested presence source ID.
39471
+ * @param {Object} opts Optional parameters
39472
+ * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
39473
+ */
39474
+ getUsersPresenceBulk(sourceId, opts) {
39475
+ opts = opts || {};
39476
+
39477
+ // verify the required parameter 'sourceId' is set
39478
+ if (sourceId === undefined || sourceId === null) {
39479
+ throw 'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';
39480
+ }
39481
+
39482
+ return this.apiClient.callApi(
39483
+ '/api/v2/users/presences/{sourceId}/bulk',
39484
+ 'GET',
39485
+ { 'sourceId': sourceId },
39486
+ { 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
39487
+ { },
39488
+ { },
39489
+ null,
39490
+ ['PureCloud OAuth'],
39491
+ ['application/json'],
39492
+ ['application/json']
39493
+ );
39494
+ }
39495
+
39496
+ /**
39497
+ * Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
39498
+ *
39499
+ * @param {Object} opts Optional parameters
39500
+ * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
39501
+ */
39502
+ getUsersPresencesPurecloudBulk(opts) {
39503
+ opts = opts || {};
39504
+
39505
+
39506
+ return this.apiClient.callApi(
39507
+ '/api/v2/users/presences/purecloud/bulk',
39508
+ 'GET',
39509
+ { },
39510
+ { 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
39511
+ { },
39512
+ { },
39513
+ null,
39514
+ ['PureCloud OAuth'],
39515
+ ['application/json'],
39516
+ ['application/json']
39517
+ );
39518
+ }
39519
+
39115
39520
  /**
39116
39521
  * Patch a user's Presence
39117
39522
  * 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.
@@ -39181,12 +39586,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39181
39586
  * Create a Presence Definition
39182
39587
  *
39183
39588
  * @param {Object} body The Presence Definition to create
39184
- * Preview Endpoint
39589
+ * postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39185
39590
  */
39186
- postPresenceDefinitions(body) {
39591
+ postPresenceDefinitions0(body) {
39187
39592
  // verify the required parameter 'body' is set
39188
39593
  if (body === undefined || body === null) {
39189
- throw 'Missing the required parameter "body" when calling postPresenceDefinitions';
39594
+ throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
39190
39595
  }
39191
39596
 
39192
39597
  return this.apiClient.callApi(
@@ -39258,16 +39663,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39258
39663
  *
39259
39664
  * @param {String} definitionId Presence Definition ID
39260
39665
  * @param {Object} body The updated Presence Definition
39261
- * Preview Endpoint
39666
+ * putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39262
39667
  */
39263
- putPresenceDefinition(definitionId, body) {
39668
+ putPresenceDefinition0(definitionId, body) {
39264
39669
  // verify the required parameter 'definitionId' is set
39265
39670
  if (definitionId === undefined || definitionId === null) {
39266
- throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition';
39671
+ throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
39267
39672
  }
39268
39673
  // verify the required parameter 'body' is set
39269
39674
  if (body === undefined || body === null) {
39270
- throw 'Missing the required parameter "body" when calling putPresenceDefinition';
39675
+ throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
39271
39676
  }
39272
39677
 
39273
39678
  return this.apiClient.callApi(
@@ -39430,7 +39835,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39430
39835
  /**
39431
39836
  * ProcessAutomation service.
39432
39837
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
39433
- * @version 169.1.0
39838
+ * @version 171.0.0
39434
39839
  */
39435
39840
 
39436
39841
  /**
@@ -39669,7 +40074,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39669
40074
  /**
39670
40075
  * Quality service.
39671
40076
  * @module purecloud-platform-client-v2/api/QualityApi
39672
- * @version 169.1.0
40077
+ * @version 171.0.0
39673
40078
  */
39674
40079
 
39675
40080
  /**
@@ -39752,7 +40157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39752
40157
  * Delete an evaluation form.
39753
40158
  *
39754
40159
  * @param {String} formId Form ID
39755
- * @deprecated
40160
+ * @deprecated
39756
40161
  */
39757
40162
  deleteQualityForm(formId) {
39758
40163
  // verify the required parameter 'formId' is set
@@ -39828,7 +40233,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39828
40233
  * Get status for async query for evaluation aggregates
39829
40234
  *
39830
40235
  * @param {String} jobId jobId
39831
- * Preview Endpoint
40236
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39832
40237
  */
39833
40238
  getAnalyticsEvaluationsAggregatesJob(jobId) {
39834
40239
  // verify the required parameter 'jobId' is set
@@ -39856,7 +40261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39856
40261
  * @param {String} jobId jobId
39857
40262
  * @param {Object} opts Optional parameters
39858
40263
  * @param {String} opts.cursor Cursor token to retrieve next page
39859
- * Preview Endpoint
40264
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39860
40265
  */
39861
40266
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
39862
40267
  opts = opts || {};
@@ -39884,7 +40289,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39884
40289
  * Get status for async query for survey aggregates
39885
40290
  *
39886
40291
  * @param {String} jobId jobId
39887
- * Preview Endpoint
40292
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39888
40293
  */
39889
40294
  getAnalyticsSurveysAggregatesJob(jobId) {
39890
40295
  // verify the required parameter 'jobId' is set
@@ -39912,7 +40317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39912
40317
  * @param {String} jobId jobId
39913
40318
  * @param {Object} opts Optional parameters
39914
40319
  * @param {String} opts.cursor Cursor token to retrieve next page
39915
- * Preview Endpoint
40320
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
39916
40321
  */
39917
40322
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
39918
40323
  opts = opts || {};
@@ -40233,7 +40638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40233
40638
  * Get an evaluation form
40234
40639
  *
40235
40640
  * @param {String} formId Form ID
40236
- * @deprecated
40641
+ * @deprecated
40237
40642
  */
40238
40643
  getQualityForm(formId) {
40239
40644
  // verify the required parameter 'formId' is set
@@ -40262,7 +40667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40262
40667
  * @param {Object} opts Optional parameters
40263
40668
  * @param {Number} opts.pageSize Page size (default to 25)
40264
40669
  * @param {Number} opts.pageNumber Page number (default to 1)
40265
- * @deprecated
40670
+ * @deprecated
40266
40671
  */
40267
40672
  getQualityFormVersions(formId, opts) {
40268
40673
  opts = opts || {};
@@ -40298,7 +40703,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40298
40703
  * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
40299
40704
  * @param {String} opts.name Name
40300
40705
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
40301
- * @deprecated
40706
+ * @deprecated
40302
40707
  */
40303
40708
  getQualityForms(opts) {
40304
40709
  opts = opts || {};
@@ -40574,7 +40979,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40574
40979
  * Get the published evaluation forms.
40575
40980
  *
40576
40981
  * @param {String} formId Form ID
40577
- * @deprecated
40982
+ * @deprecated
40578
40983
  */
40579
40984
  getQualityPublishedform(formId) {
40580
40985
  // verify the required parameter 'formId' is set
@@ -40604,7 +41009,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40604
41009
  * @param {Number} opts.pageNumber Page number (default to 1)
40605
41010
  * @param {String} opts.name Name
40606
41011
  * @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
40607
- * @deprecated
41012
+ * @deprecated
40608
41013
  */
40609
41014
  getQualityPublishedforms(opts) {
40610
41015
  opts = opts || {};
@@ -40812,7 +41217,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40812
41217
  * Query for evaluation aggregates asynchronously
40813
41218
  *
40814
41219
  * @param {Object} body query
40815
- * Preview Endpoint
41220
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
40816
41221
  */
40817
41222
  postAnalyticsEvaluationsAggregatesJobs(body) {
40818
41223
  // verify the required parameter 'body' is set
@@ -40863,7 +41268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40863
41268
  * Query for survey aggregates asynchronously
40864
41269
  *
40865
41270
  * @param {Object} body query
40866
- * Preview Endpoint
41271
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
40867
41272
  */
40868
41273
  postAnalyticsSurveysAggregatesJobs(body) {
40869
41274
  // verify the required parameter 'body' is set
@@ -41052,7 +41457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41052
41457
  * Create an evaluation form.
41053
41458
  *
41054
41459
  * @param {Object} body Evaluation form
41055
- * @deprecated
41460
+ * @deprecated
41056
41461
  */
41057
41462
  postQualityForms(body) {
41058
41463
  // verify the required parameter 'body' is set
@@ -41128,7 +41533,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41128
41533
  * Publish an evaluation form.
41129
41534
  *
41130
41535
  * @param {Object} body Publish request containing id of form to publish
41131
- * @deprecated
41536
+ * @deprecated
41132
41537
  */
41133
41538
  postQualityPublishedforms(body) {
41134
41539
  // verify the required parameter 'body' is set
@@ -41299,7 +41704,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41299
41704
  *
41300
41705
  * @param {String} formId Form ID
41301
41706
  * @param {Object} body Evaluation form
41302
- * @deprecated
41707
+ * @deprecated
41303
41708
  */
41304
41709
  putQualityForm(formId, body) {
41305
41710
  // verify the required parameter 'formId' is set
@@ -41421,7 +41826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41421
41826
  /**
41422
41827
  * Recording service.
41423
41828
  * @module purecloud-platform-client-v2/api/RecordingApi
41424
- * @version 169.1.0
41829
+ * @version 171.0.0
41425
41830
  */
41426
41831
 
41427
41832
  /**
@@ -43058,7 +43463,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43058
43463
  /**
43059
43464
  * ResponseManagement service.
43060
43465
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
43061
- * @version 169.1.0
43466
+ * @version 171.0.0
43062
43467
  */
43063
43468
 
43064
43469
  /**
@@ -43543,7 +43948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43543
43948
  /**
43544
43949
  * Routing service.
43545
43950
  * @module purecloud-platform-client-v2/api/RoutingApi
43546
- * @version 169.1.0
43951
+ * @version 171.0.0
43547
43952
  */
43548
43953
 
43549
43954
  /**
@@ -43777,7 +44182,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43777
44182
  *
43778
44183
  * @param {String} queueId Queue ID
43779
44184
  * @param {String} memberId Member ID
43780
- * @deprecated
44185
+ * @deprecated
43781
44186
  */
43782
44187
  deleteRoutingQueueUser(queueId, memberId) {
43783
44188
  // verify the required parameter 'queueId' is set
@@ -44004,7 +44409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44004
44409
  * @param {String} tagId Utilization Tag ID
44005
44410
  * @param {Object} opts Optional parameters
44006
44411
  * @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
44007
- * Preview Endpoint
44412
+ * deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
44008
44413
  */
44009
44414
  deleteRoutingUtilizationTag(tagId, opts) {
44010
44415
  opts = opts || {};
@@ -44899,7 +45304,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44899
45304
  * @param {Array.<String>} opts.languages Filter by language
44900
45305
  * @param {Array.<String>} opts.routingStatus Filter by routing status
44901
45306
  * @param {Array.<String>} opts.presence Filter by presence
44902
- * @deprecated
45307
+ * @deprecated
44903
45308
  */
44904
45309
  getRoutingQueueUsers(queueId, opts) {
44905
45310
  opts = opts || {};
@@ -45491,7 +45896,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45491
45896
  * Get details about this utilization tag
45492
45897
  *
45493
45898
  * @param {String} tagId Utilization Tag ID
45494
- * Preview Endpoint
45899
+ * getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45495
45900
  */
45496
45901
  getRoutingUtilizationTag(tagId) {
45497
45902
  // verify the required parameter 'tagId' is set
@@ -45517,7 +45922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45517
45922
  * Get list of agent ids associated with a utilization tag
45518
45923
  *
45519
45924
  * @param {String} tagId Utilization Tag ID
45520
- * Preview Endpoint
45925
+ * getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45521
45926
  */
45522
45927
  getRoutingUtilizationTagAgents(tagId) {
45523
45928
  // verify the required parameter 'tagId' is set
@@ -45547,7 +45952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45547
45952
  * @param {Number} opts.pageNumber Page number (default to 1)
45548
45953
  * @param {Object} opts.sortOrder Sort order by name (default to ascending)
45549
45954
  * @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
45550
- * Preview Endpoint
45955
+ * getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45551
45956
  */
45552
45957
  getRoutingUtilizationTags(opts) {
45553
45958
  opts = opts || {};
@@ -45937,7 +46342,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45937
46342
  * @param {String} queueId Queue ID
45938
46343
  * @param {String} memberId Member ID
45939
46344
  * @param {Object} body Queue Member
45940
- * @deprecated
46345
+ * @deprecated
45941
46346
  */
45942
46347
  patchRoutingQueueUser(queueId, memberId, body) {
45943
46348
  // verify the required parameter 'queueId' is set
@@ -45972,7 +46377,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45972
46377
  *
45973
46378
  * @param {String} queueId Queue ID
45974
46379
  * @param {Array.<Object>} body Queue Members
45975
- * @deprecated
46380
+ * @deprecated
45976
46381
  */
45977
46382
  patchRoutingQueueUsers(queueId, body) {
45978
46383
  // verify the required parameter 'queueId' is set
@@ -46249,7 +46654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46249
46654
  * @param {Object} opts Optional parameters
46250
46655
  * @param {Number} opts.pageSize The desired page size
46251
46656
  * @param {Number} opts.pageNumber The desired page number
46252
- * Preview Endpoint
46657
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
46253
46658
  */
46254
46659
  postAnalyticsRoutingActivityQuery(body, opts) {
46255
46660
  opts = opts || {};
@@ -46545,7 +46950,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46545
46950
  * @param {Array.<Object>} body Queue Members
46546
46951
  * @param {Object} opts Optional parameters
46547
46952
  * @param {Boolean} opts._delete True to delete queue members (default to false)
46548
- * @deprecated
46953
+ * @deprecated
46549
46954
  */
46550
46955
  postRoutingQueueUsers(queueId, body, opts) {
46551
46956
  opts = opts || {};
@@ -46761,7 +47166,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46761
47166
  * Imports a phone number for SMS
46762
47167
  *
46763
47168
  * @param {Object} body SmsPhoneNumber
46764
- * Preview Endpoint
47169
+ * postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
46765
47170
  */
46766
47171
  postRoutingSmsPhonenumbersImport(body) {
46767
47172
  // verify the required parameter 'body' is set
@@ -46787,7 +47192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46787
47192
  * Create an utilization tag
46788
47193
  *
46789
47194
  * @param {Object} body UtilizationTag
46790
- * Preview Endpoint
47195
+ * postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
46791
47196
  */
46792
47197
  postRoutingUtilizationTags(body) {
46793
47198
  // verify the required parameter 'body' is set
@@ -47250,7 +47655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47250
47655
  /**
47251
47656
  * SCIM service.
47252
47657
  * @module purecloud-platform-client-v2/api/SCIMApi
47253
- * @version 169.1.0
47658
+ * @version 171.0.0
47254
47659
  */
47255
47660
 
47256
47661
  /**
@@ -48127,7 +48532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48127
48532
  /**
48128
48533
  * Scripts service.
48129
48534
  * @module purecloud-platform-client-v2/api/ScriptsApi
48130
- * @version 169.1.0
48535
+ * @version 171.0.0
48131
48536
  */
48132
48537
 
48133
48538
  /**
@@ -48540,13 +48945,38 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48540
48945
  );
48541
48946
  }
48542
48947
 
48948
+ /**
48949
+ * Publish a script.
48950
+ *
48951
+ * @param {Object} opts Optional parameters
48952
+ * @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
48953
+ * @param {Object} opts.body body
48954
+ */
48955
+ postScriptsPublished(opts) {
48956
+ opts = opts || {};
48957
+
48958
+
48959
+ return this.apiClient.callApi(
48960
+ '/api/v2/scripts/published',
48961
+ 'POST',
48962
+ { },
48963
+ { 'scriptDataVersion': opts['scriptDataVersion'] },
48964
+ { },
48965
+ { },
48966
+ opts['body'],
48967
+ ['PureCloud OAuth'],
48968
+ ['application/json'],
48969
+ ['application/json']
48970
+ );
48971
+ }
48972
+
48543
48973
  }
48544
48974
 
48545
48975
  class SearchApi {
48546
48976
  /**
48547
48977
  * Search service.
48548
48978
  * @module purecloud-platform-client-v2/api/SearchApi
48549
- * @version 169.1.0
48979
+ * @version 171.0.0
48550
48980
  */
48551
48981
 
48552
48982
  /**
@@ -48842,7 +49272,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48842
49272
  * Search all documents
48843
49273
  *
48844
49274
  * @param {Object} body Search request options
48845
- * Preview Endpoint
49275
+ * postDocumentationAllSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48846
49276
  */
48847
49277
  postDocumentationAllSearch(body) {
48848
49278
  // verify the required parameter 'body' is set
@@ -48945,7 +49375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48945
49375
  * @param {String} knowledgeBaseId Knowledge base ID
48946
49376
  * @param {Object} opts Optional parameters
48947
49377
  * @param {Object} opts.body
48948
- * @deprecated
49378
+ * @deprecated
48949
49379
  */
48950
49380
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
48951
49381
  opts = opts || {};
@@ -49131,7 +49561,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49131
49561
  * Search users as conversation targets
49132
49562
  *
49133
49563
  * @param {Object} body Search request options
49134
- * Preview Endpoint
49564
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49135
49565
  */
49136
49566
  postUsersSearchConversationTarget(body) {
49137
49567
  // verify the required parameter 'body' is set
@@ -49157,7 +49587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49157
49587
  * Search manage queue member
49158
49588
  *
49159
49589
  * @param {Object} body Search request options
49160
- * Preview Endpoint
49590
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49161
49591
  */
49162
49592
  postUsersSearchQueuemembersManage(body) {
49163
49593
  // verify the required parameter 'body' is set
@@ -49235,7 +49665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49235
49665
  /**
49236
49666
  * SpeechTextAnalytics service.
49237
49667
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
49238
- * @version 169.1.0
49668
+ * @version 171.0.0
49239
49669
  */
49240
49670
 
49241
49671
  /**
@@ -50188,7 +50618,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50188
50618
  /**
50189
50619
  * Stations service.
50190
50620
  * @module purecloud-platform-client-v2/api/StationsApi
50191
- * @version 169.1.0
50621
+ * @version 171.0.0
50192
50622
  */
50193
50623
 
50194
50624
  /**
@@ -50290,7 +50720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50290
50720
  /**
50291
50721
  * Suggest service.
50292
50722
  * @module purecloud-platform-client-v2/api/SuggestApi
50293
- * @version 169.1.0
50723
+ * @version 171.0.0
50294
50724
  */
50295
50725
 
50296
50726
  /**
@@ -50429,7 +50859,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50429
50859
  /**
50430
50860
  * TaskManagement service.
50431
50861
  * @module purecloud-platform-client-v2/api/TaskManagementApi
50432
- * @version 169.1.0
50862
+ * @version 171.0.0
50433
50863
  */
50434
50864
 
50435
50865
  /**
@@ -50448,7 +50878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50448
50878
  * Delete a workbin
50449
50879
  *
50450
50880
  * @param {String} workbinId Workbin ID
50451
- * Preview Endpoint
50881
+ * deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50452
50882
  */
50453
50883
  deleteTaskmanagementWorkbin(workbinId) {
50454
50884
  // verify the required parameter 'workbinId' is set
@@ -50474,7 +50904,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50474
50904
  * Delete a workitem
50475
50905
  *
50476
50906
  * @param {String} workitemId Workitem ID
50477
- * Preview Endpoint
50907
+ * deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50478
50908
  */
50479
50909
  deleteTaskmanagementWorkitem(workitemId) {
50480
50910
  // verify the required parameter 'workitemId' is set
@@ -50500,7 +50930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50500
50930
  * Delete a schema
50501
50931
  *
50502
50932
  * @param {String} schemaId Schema ID
50503
- * Preview Endpoint
50933
+ * deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50504
50934
  */
50505
50935
  deleteTaskmanagementWorkitemsSchema(schemaId) {
50506
50936
  // verify the required parameter 'schemaId' is set
@@ -50526,7 +50956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50526
50956
  * Delete a worktype
50527
50957
  *
50528
50958
  * @param {String} worktypeId Worktype id
50529
- * Preview Endpoint
50959
+ * deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50530
50960
  */
50531
50961
  deleteTaskmanagementWorktype(worktypeId) {
50532
50962
  // verify the required parameter 'worktypeId' is set
@@ -50553,7 +50983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50553
50983
  *
50554
50984
  * @param {String} worktypeId Worktype id
50555
50985
  * @param {String} statusId Status id
50556
- * Preview Endpoint
50986
+ * deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50557
50987
  */
50558
50988
  deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
50559
50989
  // verify the required parameter 'worktypeId' is set
@@ -50583,7 +51013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50583
51013
  * Get a workbin
50584
51014
  *
50585
51015
  * @param {String} workbinId Workbin ID
50586
- * Preview Endpoint
51016
+ * getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50587
51017
  */
50588
51018
  getTaskmanagementWorkbin(workbinId) {
50589
51019
  // verify the required parameter 'workbinId' is set
@@ -50613,7 +51043,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50613
51043
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50614
51044
  * @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)
50615
51045
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50616
- * Preview Endpoint
51046
+ * getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50617
51047
  */
50618
51048
  getTaskmanagementWorkbinHistory(workbinId, opts) {
50619
51049
  opts = opts || {};
@@ -50642,7 +51072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50642
51072
  *
50643
51073
  * @param {String} workbinId Workbin ID
50644
51074
  * @param {Number} entityVersion Workbin version
50645
- * Preview Endpoint
51075
+ * getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50646
51076
  */
50647
51077
  getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
50648
51078
  // verify the required parameter 'workbinId' is set
@@ -50676,7 +51106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50676
51106
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50677
51107
  * @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)
50678
51108
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50679
- * Preview Endpoint
51109
+ * getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50680
51110
  */
50681
51111
  getTaskmanagementWorkbinVersions(workbinId, opts) {
50682
51112
  opts = opts || {};
@@ -50704,9 +51134,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50704
51134
  * Get a workitem
50705
51135
  *
50706
51136
  * @param {String} workitemId Workitem ID
50707
- * Preview Endpoint
51137
+ * @param {Object} opts Optional parameters
51138
+ * @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
51139
+ * getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50708
51140
  */
50709
- getTaskmanagementWorkitem(workitemId) {
51141
+ getTaskmanagementWorkitem(workitemId, opts) {
51142
+ opts = opts || {};
51143
+
50710
51144
  // verify the required parameter 'workitemId' is set
50711
51145
  if (workitemId === undefined || workitemId === null) {
50712
51146
  throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';
@@ -50716,7 +51150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50716
51150
  '/api/v2/taskmanagement/workitems/{workitemId}',
50717
51151
  'GET',
50718
51152
  { 'workitemId': workitemId },
50719
- { },
51153
+ { 'expands': opts['expands'] },
50720
51154
  { },
50721
51155
  { },
50722
51156
  null,
@@ -50734,7 +51168,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50734
51168
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50735
51169
  * @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)
50736
51170
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50737
- * Preview Endpoint
51171
+ * getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50738
51172
  */
50739
51173
  getTaskmanagementWorkitemHistory(workitemId, opts) {
50740
51174
  opts = opts || {};
@@ -50768,7 +51202,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50768
51202
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50769
51203
  * @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)
50770
51204
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50771
- * Preview Endpoint
51205
+ * getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50772
51206
  */
50773
51207
  getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
50774
51208
  opts = opts || {};
@@ -50801,7 +51235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50801
51235
  *
50802
51236
  * @param {String} workitemId Workitem ID
50803
51237
  * @param {Number} entityVersion Workitem version
50804
- * Preview Endpoint
51238
+ * getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50805
51239
  */
50806
51240
  getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
50807
51241
  // verify the required parameter 'workitemId' is set
@@ -50835,7 +51269,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50835
51269
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50836
51270
  * @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)
50837
51271
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50838
- * Preview Endpoint
51272
+ * getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50839
51273
  */
50840
51274
  getTaskmanagementWorkitemVersions(workitemId, opts) {
50841
51275
  opts = opts || {};
@@ -50868,7 +51302,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50868
51302
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
50869
51303
  * @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)
50870
51304
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
50871
- * Preview Endpoint
51305
+ * getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50872
51306
  */
50873
51307
  getTaskmanagementWorkitemWrapups(workitemId, opts) {
50874
51308
  opts = opts || {};
@@ -50896,7 +51330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50896
51330
  * Get a schema
50897
51331
  *
50898
51332
  * @param {String} schemaId Schema ID
50899
- * Preview Endpoint
51333
+ * getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50900
51334
  */
50901
51335
  getTaskmanagementWorkitemsSchema(schemaId) {
50902
51336
  // verify the required parameter 'schemaId' is set
@@ -50923,7 +51357,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50923
51357
  *
50924
51358
  * @param {String} schemaId Schema ID
50925
51359
  * @param {String} versionId Schema version
50926
- * Preview Endpoint
51360
+ * getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50927
51361
  */
50928
51362
  getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
50929
51363
  // verify the required parameter 'schemaId' is set
@@ -50953,7 +51387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50953
51387
  * Get all versions of a schema
50954
51388
  *
50955
51389
  * @param {String} schemaId Schema ID
50956
- * Preview Endpoint
51390
+ * getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50957
51391
  */
50958
51392
  getTaskmanagementWorkitemsSchemaVersions(schemaId) {
50959
51393
  // verify the required parameter 'schemaId' is set
@@ -50978,7 +51412,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50978
51412
  /**
50979
51413
  * Get a list of schemas.
50980
51414
  *
50981
- * Preview Endpoint
51415
+ * getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50982
51416
  */
50983
51417
  getTaskmanagementWorkitemsSchemas() {
50984
51418
 
@@ -51002,7 +51436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51002
51436
  * @param {String} worktypeId Worktype id
51003
51437
  * @param {Object} opts Optional parameters
51004
51438
  * @param {Array.<String>} opts.expands Which fields, if any, to expand.
51005
- * Preview Endpoint
51439
+ * getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51006
51440
  */
51007
51441
  getTaskmanagementWorktype(worktypeId, opts) {
51008
51442
  opts = opts || {};
@@ -51034,7 +51468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51034
51468
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
51035
51469
  * @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)
51036
51470
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
51037
- * Preview Endpoint
51471
+ * getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51038
51472
  */
51039
51473
  getTaskmanagementWorktypeHistory(worktypeId, opts) {
51040
51474
  opts = opts || {};
@@ -51063,7 +51497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51063
51497
  *
51064
51498
  * @param {String} worktypeId Worktype id
51065
51499
  * @param {String} statusId Status id
51066
- * Preview Endpoint
51500
+ * getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51067
51501
  */
51068
51502
  getTaskmanagementWorktypeStatus(worktypeId, statusId) {
51069
51503
  // verify the required parameter 'worktypeId' is set
@@ -51094,7 +51528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51094
51528
  *
51095
51529
  * @param {String} worktypeId Worktype id
51096
51530
  * @param {Number} entityVersion Worktype version
51097
- * Preview Endpoint
51531
+ * getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51098
51532
  */
51099
51533
  getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
51100
51534
  // verify the required parameter 'worktypeId' is set
@@ -51128,7 +51562,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51128
51562
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
51129
51563
  * @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)
51130
51564
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
51131
- * Preview Endpoint
51565
+ * getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51132
51566
  */
51133
51567
  getTaskmanagementWorktypeVersions(worktypeId, opts) {
51134
51568
  opts = opts || {};
@@ -51157,7 +51591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51157
51591
  *
51158
51592
  * @param {String} workbinId Workbin ID
51159
51593
  * @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
51160
- * Preview Endpoint
51594
+ * patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51161
51595
  */
51162
51596
  patchTaskmanagementWorkbin(workbinId, body) {
51163
51597
  // verify the required parameter 'workbinId' is set
@@ -51188,7 +51622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51188
51622
  *
51189
51623
  * @param {String} workitemId Workitem ID
51190
51624
  * @param {Object} body Workitem
51191
- * Preview Endpoint
51625
+ * patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51192
51626
  */
51193
51627
  patchTaskmanagementWorkitem(workitemId, body) {
51194
51628
  // verify the required parameter 'workitemId' is set
@@ -51219,7 +51653,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51219
51653
  *
51220
51654
  * @param {String} workitemId Workitem ID
51221
51655
  * @param {Object} body Targeted user
51222
- * Preview Endpoint
51656
+ * patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51223
51657
  */
51224
51658
  patchTaskmanagementWorkitemAssignment(workitemId, body) {
51225
51659
  // verify the required parameter 'workitemId' is set
@@ -51251,7 +51685,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51251
51685
  * @param {String} workitemId The ID of the Workitem.
51252
51686
  * @param {String} userId The ID of the user
51253
51687
  * @param {Object} body Request body to add/remove a wrapup code for a workitem
51254
- * Preview Endpoint
51688
+ * patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51255
51689
  */
51256
51690
  patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
51257
51691
  // verify the required parameter 'workitemId' is set
@@ -51286,7 +51720,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51286
51720
  *
51287
51721
  * @param {String} workitemId The ID of the Workitem.
51288
51722
  * @param {Object} body Request body to add/remove the wrapup code for workitem
51289
- * Preview Endpoint
51723
+ * patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51290
51724
  */
51291
51725
  patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
51292
51726
  // verify the required parameter 'workitemId' is set
@@ -51318,7 +51752,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51318
51752
  * @param {String} worktypeId Worktype id
51319
51753
  * @param {Object} opts Optional parameters
51320
51754
  * @param {Object} opts.body body
51321
- * Preview Endpoint
51755
+ * patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51322
51756
  */
51323
51757
  patchTaskmanagementWorktype(worktypeId, opts) {
51324
51758
  opts = opts || {};
@@ -51349,7 +51783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51349
51783
  * @param {String} statusId Status id
51350
51784
  * @param {Object} opts Optional parameters
51351
51785
  * @param {Object} opts.body body
51352
- * Preview Endpoint
51786
+ * patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51353
51787
  */
51354
51788
  patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
51355
51789
  opts = opts || {};
@@ -51382,7 +51816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51382
51816
  *
51383
51817
  * @param {Object} opts Optional parameters
51384
51818
  * @param {Object} opts.body body
51385
- * Preview Endpoint
51819
+ * postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51386
51820
  */
51387
51821
  postTaskmanagementWorkbins(opts) {
51388
51822
  opts = opts || {};
@@ -51406,7 +51840,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51406
51840
  * Query for workbins
51407
51841
  *
51408
51842
  * @param {Object} body QueryPostRequest
51409
- * Preview Endpoint
51843
+ * postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51410
51844
  */
51411
51845
  postTaskmanagementWorkbinsQuery(body) {
51412
51846
  // verify the required parameter 'body' is set
@@ -51432,7 +51866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51432
51866
  * Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
51433
51867
  *
51434
51868
  * @param {String} workitemId Workitem ID
51435
- * Preview Endpoint
51869
+ * postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51436
51870
  */
51437
51871
  postTaskmanagementWorkitemAcdCancel(workitemId) {
51438
51872
  // verify the required parameter 'workitemId' is set
@@ -51458,7 +51892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51458
51892
  * Disconnect the assignee of the workitem
51459
51893
  *
51460
51894
  * @param {String} workitemId Workitem ID
51461
- * Preview Endpoint
51895
+ * postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51462
51896
  */
51463
51897
  postTaskmanagementWorkitemDisconnect(workitemId) {
51464
51898
  // verify the required parameter 'workitemId' is set
@@ -51486,7 +51920,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51486
51920
  * @param {String} workitemId Workitem ID
51487
51921
  * @param {Object} opts Optional parameters
51488
51922
  * @param {Object} opts.body Terminated request
51489
- * Preview Endpoint
51923
+ * postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51490
51924
  */
51491
51925
  postTaskmanagementWorkitemTerminate(workitemId, opts) {
51492
51926
  opts = opts || {};
@@ -51514,7 +51948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51514
51948
  * Create a workitem
51515
51949
  *
51516
51950
  * @param {Object} body Workitem
51517
- * Preview Endpoint
51951
+ * postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51518
51952
  */
51519
51953
  postTaskmanagementWorkitems(body) {
51520
51954
  // verify the required parameter 'body' is set
@@ -51540,7 +51974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51540
51974
  * Query for workitems
51541
51975
  * This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
51542
51976
  * @param {Object} body WorkitemQueryPostRequest
51543
- * Preview Endpoint
51977
+ * postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51544
51978
  */
51545
51979
  postTaskmanagementWorkitemsQuery(body) {
51546
51980
  // verify the required parameter 'body' is set
@@ -51566,7 +52000,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51566
52000
  * Create a schema
51567
52001
  *
51568
52002
  * @param {Object} body Schema
51569
- * Preview Endpoint
52003
+ * postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51570
52004
  */
51571
52005
  postTaskmanagementWorkitemsSchemas(body) {
51572
52006
  // verify the required parameter 'body' is set
@@ -51594,7 +52028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51594
52028
  * @param {String} worktypeId Worktype id
51595
52029
  * @param {Object} opts Optional parameters
51596
52030
  * @param {Object} opts.body body
51597
- * Preview Endpoint
52031
+ * postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51598
52032
  */
51599
52033
  postTaskmanagementWorktypeStatuses(worktypeId, opts) {
51600
52034
  opts = opts || {};
@@ -51623,7 +52057,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51623
52057
  *
51624
52058
  * @param {Object} opts Optional parameters
51625
52059
  * @param {Object} opts.body body
51626
- * Preview Endpoint
52060
+ * postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51627
52061
  */
51628
52062
  postTaskmanagementWorktypes(opts) {
51629
52063
  opts = opts || {};
@@ -51647,7 +52081,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51647
52081
  * Query for worktypes
51648
52082
  *
51649
52083
  * @param {Object} body QueryPostRequest
51650
- * Preview Endpoint
52084
+ * postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51651
52085
  */
51652
52086
  postTaskmanagementWorktypesQuery(body) {
51653
52087
  // verify the required parameter 'body' is set
@@ -51674,7 +52108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51674
52108
  *
51675
52109
  * @param {String} schemaId Schema ID
51676
52110
  * @param {Object} body Data Schema
51677
- * Preview Endpoint
52111
+ * putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51678
52112
  */
51679
52113
  putTaskmanagementWorkitemsSchema(schemaId, body) {
51680
52114
  // verify the required parameter 'schemaId' is set
@@ -51706,7 +52140,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51706
52140
  /**
51707
52141
  * Teams service.
51708
52142
  * @module purecloud-platform-client-v2/api/TeamsApi
51709
- * @version 169.1.0
52143
+ * @version 171.0.0
51710
52144
  */
51711
52145
 
51712
52146
  /**
@@ -51898,7 +52332,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
51898
52332
  * @param {Object} opts Optional parameters
51899
52333
  * @param {Number} opts.pageSize The desired page size
51900
52334
  * @param {Number} opts.pageNumber The desired page number
51901
- * Preview Endpoint
52335
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51902
52336
  */
51903
52337
  postAnalyticsTeamsActivityQuery(body, opts) {
51904
52338
  opts = opts || {};
@@ -52008,7 +52442,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52008
52442
  /**
52009
52443
  * Telephony service.
52010
52444
  * @module purecloud-platform-client-v2/api/TelephonyApi
52011
- * @version 169.1.0
52445
+ * @version 171.0.0
52012
52446
  */
52013
52447
 
52014
52448
  /**
@@ -52136,7 +52570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52136
52570
  /**
52137
52571
  * TelephonyProvidersEdge service.
52138
52572
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
52139
- * @version 169.1.0
52573
+ * @version 171.0.0
52140
52574
  */
52141
52575
 
52142
52576
  /**
@@ -53324,7 +53758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53324
53758
  * @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
53325
53759
  * @param {String} opts.name Name of the Extension Pools to filter by.
53326
53760
  * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
53327
- * Preview Endpoint
53761
+ * getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53328
53762
  */
53329
53763
  getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
53330
53764
  opts = opts || {};
@@ -53532,6 +53966,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53532
53966
  );
53533
53967
  }
53534
53968
 
53969
+ /**
53970
+ * Get media endpoint statistics events.
53971
+ *
53972
+ * @param {String} conversationId Identifier of the conversation
53973
+ * getTelephonyProvidersEdgesMediastatisticsConversation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53974
+ */
53975
+ getTelephonyProvidersEdgesMediastatisticsConversation(conversationId) {
53976
+ // verify the required parameter 'conversationId' is set
53977
+ if (conversationId === undefined || conversationId === null) {
53978
+ throw 'Missing the required parameter "conversationId" when calling getTelephonyProvidersEdgesMediastatisticsConversation';
53979
+ }
53980
+
53981
+ return this.apiClient.callApi(
53982
+ '/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}',
53983
+ 'GET',
53984
+ { 'conversationId': conversationId },
53985
+ { },
53986
+ { },
53987
+ { },
53988
+ null,
53989
+ ['PureCloud OAuth'],
53990
+ ['application/json'],
53991
+ ['application/json']
53992
+ );
53993
+ }
53994
+
53995
+ /**
53996
+ * Get media endpoint statistics event.
53997
+ *
53998
+ * @param {String} conversationId Identifier of the conversation
53999
+ * @param {String} communicationId Identifier of the media session
54000
+ * getTelephonyProvidersEdgesMediastatisticsConversationCommunication is a preview method and is subject to both breaking and non-breaking changes at any time without notice
54001
+ */
54002
+ getTelephonyProvidersEdgesMediastatisticsConversationCommunication(conversationId, communicationId) {
54003
+ // verify the required parameter 'conversationId' is set
54004
+ if (conversationId === undefined || conversationId === null) {
54005
+ throw 'Missing the required parameter "conversationId" when calling getTelephonyProvidersEdgesMediastatisticsConversationCommunication';
54006
+ }
54007
+ // verify the required parameter 'communicationId' is set
54008
+ if (communicationId === undefined || communicationId === null) {
54009
+ throw 'Missing the required parameter "communicationId" when calling getTelephonyProvidersEdgesMediastatisticsConversationCommunication';
54010
+ }
54011
+
54012
+ return this.apiClient.callApi(
54013
+ '/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}',
54014
+ 'GET',
54015
+ { 'conversationId': conversationId,'communicationId': communicationId },
54016
+ { },
54017
+ { },
54018
+ { },
54019
+ null,
54020
+ ['PureCloud OAuth'],
54021
+ ['application/json'],
54022
+ ['application/json']
54023
+ );
54024
+ }
54025
+
53535
54026
  /**
53536
54027
  * Get the metrics for a list of edges.
53537
54028
  *
@@ -53561,7 +54052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53561
54052
  * Get outbound route
53562
54053
  * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
53563
54054
  * @param {String} outboundRouteId Outbound route ID
53564
- * @deprecated
54055
+ * @deprecated
53565
54056
  */
53566
54057
  getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
53567
54058
  // verify the required parameter 'outboundRouteId' is set
@@ -53757,7 +54248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53757
54248
  * @param {String} opts.phoneHardwareId Filter by phone_hardwareId
53758
54249
  * @param {String} opts.linesId Filter by lines.id
53759
54250
  * @param {String} opts.linesName Filter by lines.name
53760
- * @param {String} opts.name Name of the Phone to filter by
54251
+ * @param {String} opts.name Name of the Phone to filter by, comma-separated
53761
54252
  * @param {String} opts.statusOperationalStatus The primary status to filter by
53762
54253
  * @param {String} opts.secondaryStatusOperationalStatus The secondary status to filter by
53763
54254
  * @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
@@ -55368,7 +55859,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55368
55859
  /**
55369
55860
  * Textbots service.
55370
55861
  * @module purecloud-platform-client-v2/api/TextbotsApi
55371
- * @version 169.1.0
55862
+ * @version 171.0.0
55372
55863
  */
55373
55864
 
55374
55865
  /**
@@ -55496,7 +55987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55496
55987
  /**
55497
55988
  * Tokens service.
55498
55989
  * @module purecloud-platform-client-v2/api/TokensApi
55499
- * @version 169.1.0
55990
+ * @version 171.0.0
55500
55991
  */
55501
55992
 
55502
55993
  /**
@@ -55579,7 +56070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55579
56070
  /**
55580
56071
  * Get the current Idle Token Timeout Value
55581
56072
  *
55582
- * Preview Endpoint
56073
+ * getTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
55583
56074
  */
55584
56075
  getTokensTimeout() {
55585
56076
 
@@ -55622,7 +56113,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55622
56113
  *
55623
56114
  * @param {Object} opts Optional parameters
55624
56115
  * @param {Object} opts.body
55625
- * Preview Endpoint
56116
+ * putTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
55626
56117
  */
55627
56118
  putTokensTimeout(opts) {
55628
56119
  opts = opts || {};
@@ -55648,7 +56139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55648
56139
  /**
55649
56140
  * Uploads service.
55650
56141
  * @module purecloud-platform-client-v2/api/UploadsApi
55651
- * @version 169.1.0
56142
+ * @version 171.0.0
55652
56143
  */
55653
56144
 
55654
56145
  /**
@@ -55824,7 +56315,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55824
56315
  /**
55825
56316
  * Usage service.
55826
56317
  * @module purecloud-platform-client-v2/api/UsageApi
55827
- * @version 169.1.0
56318
+ * @version 171.0.0
55828
56319
  */
55829
56320
 
55830
56321
  /**
@@ -56034,7 +56525,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56034
56525
  /**
56035
56526
  * UserRecordings service.
56036
56527
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
56037
- * @version 169.1.0
56528
+ * @version 171.0.0
56038
56529
  */
56039
56530
 
56040
56531
  /**
@@ -56219,7 +56710,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56219
56710
  /**
56220
56711
  * Users service.
56221
56712
  * @module purecloud-platform-client-v2/api/UsersApi
56222
- * @version 169.1.0
56713
+ * @version 171.0.0
56223
56714
  */
56224
56715
 
56225
56716
  /**
@@ -56458,7 +56949,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56458
56949
  * Get status for async query for user aggregates
56459
56950
  *
56460
56951
  * @param {String} jobId jobId
56461
- * Preview Endpoint
56952
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
56462
56953
  */
56463
56954
  getAnalyticsUsersAggregatesJob(jobId) {
56464
56955
  // verify the required parameter 'jobId' is set
@@ -56486,7 +56977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56486
56977
  * @param {String} jobId jobId
56487
56978
  * @param {Object} opts Optional parameters
56488
56979
  * @param {String} opts.cursor Cursor token to retrieve next page
56489
- * Preview Endpoint
56980
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
56490
56981
  */
56491
56982
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
56492
56983
  opts = opts || {};
@@ -56591,7 +57082,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56591
57082
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
56592
57083
  * @param {Object} opts Optional parameters
56593
57084
  * @param {String} opts.name Search term to filter by division name
56594
- * @deprecated
57085
+ * @deprecated
56595
57086
  */
56596
57087
  getAuthorizationDivisionspermittedMe(permission, opts) {
56597
57088
  opts = opts || {};
@@ -56653,7 +57144,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56653
57144
  * @param {Object} opts Optional parameters
56654
57145
  * @param {Number} opts.pageNumber Page number (default to 1)
56655
57146
  * @param {Number} opts.pageSize Page size (default to 25)
56656
- * @deprecated
57147
+ * @deprecated
56657
57148
  */
56658
57149
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
56659
57150
  opts = opts || {};
@@ -56730,7 +57221,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56730
57221
  * Fetch field config for an entity type
56731
57222
  *
56732
57223
  * @param {Object} type Field type
56733
- * @deprecated
57224
+ * @deprecated
56734
57225
  */
56735
57226
  getFieldconfig(type) {
56736
57227
  // verify the required parameter 'type' is set
@@ -56763,7 +57254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56763
57254
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
56764
57255
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
56765
57256
  * @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.
56766
- * @deprecated
57257
+ * @deprecated
56767
57258
  */
56768
57259
  getProfilesUsers(opts) {
56769
57260
  opts = opts || {};
@@ -56931,7 +57422,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56931
57422
  * @param {Number} opts.pageNumber Page number (default to 1)
56932
57423
  * @param {String} opts.sortOrder Sort order (default to ASC)
56933
57424
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
56934
- * @deprecated
57425
+ * @deprecated
56935
57426
  */
56936
57427
  getUserFavorites(userId, opts) {
56937
57428
  opts = opts || {};
@@ -57017,7 +57508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57017
57508
  * @param {Object} opts Optional parameters
57018
57509
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
57019
57510
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
57020
- * @deprecated
57511
+ * @deprecated
57021
57512
  */
57022
57513
  getUserProfile(userId, opts) {
57023
57514
  opts = opts || {};
@@ -57826,7 +58317,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57826
58317
  * @param {Object} opts Optional parameters
57827
58318
  * @param {Number} opts.pageSize The desired page size
57828
58319
  * @param {Number} opts.pageNumber The desired page number
57829
- * Preview Endpoint
58320
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57830
58321
  */
57831
58322
  postAnalyticsUsersActivityQuery(body, opts) {
57832
58323
  opts = opts || {};
@@ -57854,7 +58345,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57854
58345
  * Query for user aggregates asynchronously
57855
58346
  *
57856
58347
  * @param {Object} body query
57857
- * Preview Endpoint
58348
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57858
58349
  */
57859
58350
  postAnalyticsUsersAggregatesJobs(body) {
57860
58351
  // verify the required parameter 'body' is set
@@ -58366,7 +58857,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58366
58857
  * Search users as conversation targets
58367
58858
  *
58368
58859
  * @param {Object} body Search request options
58369
- * Preview Endpoint
58860
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58370
58861
  */
58371
58862
  postUsersSearchConversationTarget(body) {
58372
58863
  // verify the required parameter 'body' is set
@@ -58392,7 +58883,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58392
58883
  * Search manage queue member
58393
58884
  *
58394
58885
  * @param {Object} body Search request options
58395
- * Preview Endpoint
58886
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58396
58887
  */
58397
58888
  postUsersSearchQueuemembersManage(body) {
58398
58889
  // verify the required parameter 'body' is set
@@ -58780,7 +59271,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58780
59271
  /**
58781
59272
  * Utilities service.
58782
59273
  * @module purecloud-platform-client-v2/api/UtilitiesApi
58783
- * @version 169.1.0
59274
+ * @version 171.0.0
58784
59275
  */
58785
59276
 
58786
59277
  /**
@@ -58891,7 +59382,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58891
59382
  /**
58892
59383
  * Voicemail service.
58893
59384
  * @module purecloud-platform-client-v2/api/VoicemailApi
58894
- * @version 169.1.0
59385
+ * @version 171.0.0
58895
59386
  */
58896
59387
 
58897
59388
  /**
@@ -59558,7 +60049,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59558
60049
  /**
59559
60050
  * WebChat service.
59560
60051
  * @module purecloud-platform-client-v2/api/WebChatApi
59561
- * @version 169.1.0
60052
+ * @version 171.0.0
59562
60053
  */
59563
60054
 
59564
60055
  /**
@@ -59577,7 +60068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59577
60068
  * Delete a WebChat deployment
59578
60069
  *
59579
60070
  * @param {String} deploymentId Deployment Id
59580
- * @deprecated
60071
+ * @deprecated
59581
60072
  */
59582
60073
  deleteWebchatDeployment(deploymentId) {
59583
60074
  // verify the required parameter 'deploymentId' is set
@@ -59653,7 +60144,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59653
60144
  * Get a WebChat deployment
59654
60145
  *
59655
60146
  * @param {String} deploymentId Deployment Id
59656
- * @deprecated
60147
+ * @deprecated
59657
60148
  */
59658
60149
  getWebchatDeployment(deploymentId) {
59659
60150
  // verify the required parameter 'deploymentId' is set
@@ -59678,7 +60169,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59678
60169
  /**
59679
60170
  * List WebChat deployments
59680
60171
  *
59681
- * @deprecated
60172
+ * @deprecated
59682
60173
  */
59683
60174
  getWebchatDeployments() {
59684
60175
 
@@ -59933,7 +60424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59933
60424
  * Create WebChat deployment
59934
60425
  *
59935
60426
  * @param {Object} body Deployment
59936
- * @deprecated
60427
+ * @deprecated
59937
60428
  */
59938
60429
  postWebchatDeployments(body) {
59939
60430
  // verify the required parameter 'body' is set
@@ -60050,7 +60541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60050
60541
  *
60051
60542
  * @param {String} deploymentId Deployment Id
60052
60543
  * @param {Object} body Deployment
60053
- * @deprecated
60544
+ * @deprecated
60054
60545
  */
60055
60546
  putWebchatDeployment(deploymentId, body) {
60056
60547
  // verify the required parameter 'deploymentId' is set
@@ -60107,7 +60598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60107
60598
  /**
60108
60599
  * WebDeployments service.
60109
60600
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
60110
- * @version 169.1.0
60601
+ * @version 171.0.0
60111
60602
  */
60112
60603
 
60113
60604
  /**
@@ -60629,7 +61120,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60629
61120
  /**
60630
61121
  * WebMessaging service.
60631
61122
  * @module purecloud-platform-client-v2/api/WebMessagingApi
60632
- * @version 169.1.0
61123
+ * @version 171.0.0
60633
61124
  */
60634
61125
 
60635
61126
  /**
@@ -60675,7 +61166,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60675
61166
  /**
60676
61167
  * Widgets service.
60677
61168
  * @module purecloud-platform-client-v2/api/WidgetsApi
60678
- * @version 169.1.0
61169
+ * @version 171.0.0
60679
61170
  */
60680
61171
 
60681
61172
  /**
@@ -60821,7 +61312,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60821
61312
  /**
60822
61313
  * WorkforceManagement service.
60823
61314
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
60824
- * @version 169.1.0
61315
+ * @version 171.0.0
60825
61316
  */
60826
61317
 
60827
61318
  /**
@@ -62363,7 +62854,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62363
62854
  * Get activity codes
62364
62855
  *
62365
62856
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
62366
- * @deprecated
62857
+ * @deprecated
62367
62858
  */
62368
62859
  getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
62369
62860
  // verify the required parameter 'managementUnitId' is set
@@ -62776,7 +63267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62776
63267
  * @param {Object} opts Optional parameters
62777
63268
  * @param {Object} opts.expand Which fields, if any, to expand
62778
63269
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
62779
- * @deprecated
63270
+ * @deprecated
62780
63271
  */
62781
63272
  getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
62782
63273
  opts = opts || {};
@@ -62817,7 +63308,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62817
63308
  * @param {Boolean} opts.includeOnlyPublished Return only published schedules
62818
63309
  * @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
62819
63310
  * @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
62820
- * @deprecated
63311
+ * @deprecated
62821
63312
  */
62822
63313
  getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
62823
63314
  opts = opts || {};
@@ -64776,7 +65267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64776
65267
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
64777
65268
  * @param {Object} opts Optional parameters
64778
65269
  * @param {Object} opts.body body
64779
- * @deprecated
65270
+ * @deprecated
64780
65271
  */
64781
65272
  postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
64782
65273
  opts = opts || {};
@@ -65437,7 +65928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65437
65928
  *
65438
65929
  * @param {Object} opts Optional parameters
65439
65930
  * @param {Object} opts.body body
65440
- * @deprecated
65931
+ * @deprecated
65441
65932
  */
65442
65933
  postWorkforcemanagementSchedules(opts) {
65443
65934
  opts = opts || {};
@@ -65628,7 +66119,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65628
66119
  * </pre>
65629
66120
  * </p>
65630
66121
  * @module purecloud-platform-client-v2/index
65631
- * @version 169.1.0
66122
+ * @version 171.0.0
65632
66123
  */
65633
66124
  class platformClient {
65634
66125
  constructor() {