purecloud-platform-client-v2 169.1.0 → 170.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +774 -365
  3. package/dist/web-amd/purecloud-platform-client-v2.js +774 -365
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +774 -365
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +774 -365
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +211 -35
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +44 -44
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +6 -6
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +362 -7
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +5 -5
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +9 -9
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +41 -11
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +9 -45
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -29
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +3 -3
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +69 -16
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +16 -16
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +13 -13
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +5 -5
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +50 -46
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +2 -2
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +4 -4
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +3 -3
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +13 -13
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -2279,7 +2279,7 @@ class Configuration {
2279
2279
 
2280
2280
  /**
2281
2281
  * @module purecloud-platform-client-v2/ApiClient
2282
- * @version 169.1.0
2282
+ * @version 170.0.0
2283
2283
  */
2284
2284
  class ApiClient {
2285
2285
  /**
@@ -3358,7 +3358,7 @@ class AlertingApi {
3358
3358
  /**
3359
3359
  * Alerting service.
3360
3360
  * @module purecloud-platform-client-v2/api/AlertingApi
3361
- * @version 169.1.0
3361
+ * @version 170.0.0
3362
3362
  */
3363
3363
 
3364
3364
  /**
@@ -3672,7 +3672,7 @@ class AnalyticsApi {
3672
3672
  /**
3673
3673
  * Analytics service.
3674
3674
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3675
- * @version 169.1.0
3675
+ * @version 170.0.0
3676
3676
  */
3677
3677
 
3678
3678
  /**
@@ -3766,7 +3766,7 @@ class AnalyticsApi {
3766
3766
  * Get status for async query for action aggregates
3767
3767
  *
3768
3768
  * @param {String} jobId jobId
3769
- * Preview Endpoint
3769
+ * getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3770
3770
  */
3771
3771
  getAnalyticsActionsAggregatesJob(jobId) {
3772
3772
  // verify the required parameter 'jobId' is set
@@ -3794,7 +3794,7 @@ class AnalyticsApi {
3794
3794
  * @param {String} jobId jobId
3795
3795
  * @param {Object} opts Optional parameters
3796
3796
  * @param {String} opts.cursor Cursor token to retrieve next page
3797
- * Preview Endpoint
3797
+ * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3798
3798
  */
3799
3799
  getAnalyticsActionsAggregatesJobResults(jobId, opts) {
3800
3800
  opts = opts || {};
@@ -3856,7 +3856,7 @@ class AnalyticsApi {
3856
3856
  * Get status for async query for bot aggregates
3857
3857
  *
3858
3858
  * @param {String} jobId jobId
3859
- * Preview Endpoint
3859
+ * getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3860
3860
  */
3861
3861
  getAnalyticsBotsAggregatesJob(jobId) {
3862
3862
  // verify the required parameter 'jobId' is set
@@ -3884,7 +3884,7 @@ class AnalyticsApi {
3884
3884
  * @param {String} jobId jobId
3885
3885
  * @param {Object} opts Optional parameters
3886
3886
  * @param {String} opts.cursor Cursor token to retrieve next page
3887
- * Preview Endpoint
3887
+ * getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3888
3888
  */
3889
3889
  getAnalyticsBotsAggregatesJobResults(jobId, opts) {
3890
3890
  opts = opts || {};
@@ -3937,7 +3937,7 @@ class AnalyticsApi {
3937
3937
  * Get status for async query for conversation aggregates
3938
3938
  *
3939
3939
  * @param {String} jobId jobId
3940
- * Preview Endpoint
3940
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3941
3941
  */
3942
3942
  getAnalyticsConversationsAggregatesJob(jobId) {
3943
3943
  // verify the required parameter 'jobId' is set
@@ -3965,7 +3965,7 @@ class AnalyticsApi {
3965
3965
  * @param {String} jobId jobId
3966
3966
  * @param {Object} opts Optional parameters
3967
3967
  * @param {String} opts.cursor Cursor token to retrieve next page
3968
- * Preview Endpoint
3968
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
3969
3969
  */
3970
3970
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
3971
3971
  opts = opts || {};
@@ -4112,7 +4112,7 @@ class AnalyticsApi {
4112
4112
  * Get status for async query for evaluation aggregates
4113
4113
  *
4114
4114
  * @param {String} jobId jobId
4115
- * Preview Endpoint
4115
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4116
4116
  */
4117
4117
  getAnalyticsEvaluationsAggregatesJob(jobId) {
4118
4118
  // verify the required parameter 'jobId' is set
@@ -4140,7 +4140,7 @@ class AnalyticsApi {
4140
4140
  * @param {String} jobId jobId
4141
4141
  * @param {Object} opts Optional parameters
4142
4142
  * @param {String} opts.cursor Cursor token to retrieve next page
4143
- * Preview Endpoint
4143
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4144
4144
  */
4145
4145
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
4146
4146
  opts = opts || {};
@@ -4168,7 +4168,7 @@ class AnalyticsApi {
4168
4168
  * Get status for async query for Flow aggregates
4169
4169
  *
4170
4170
  * @param {String} jobId jobId
4171
- * Preview Endpoint
4171
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4172
4172
  */
4173
4173
  getAnalyticsFlowsAggregatesJob(jobId) {
4174
4174
  // verify the required parameter 'jobId' is set
@@ -4196,7 +4196,7 @@ class AnalyticsApi {
4196
4196
  * @param {String} jobId jobId
4197
4197
  * @param {Object} opts Optional parameters
4198
4198
  * @param {String} opts.cursor Cursor token to retrieve next page
4199
- * Preview Endpoint
4199
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4200
4200
  */
4201
4201
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
4202
4202
  opts = opts || {};
@@ -4224,7 +4224,7 @@ class AnalyticsApi {
4224
4224
  * Get status for async query for journey aggregates
4225
4225
  *
4226
4226
  * @param {String} jobId jobId
4227
- * Preview Endpoint
4227
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4228
4228
  */
4229
4229
  getAnalyticsJourneysAggregatesJob(jobId) {
4230
4230
  // verify the required parameter 'jobId' is set
@@ -4252,7 +4252,7 @@ class AnalyticsApi {
4252
4252
  * @param {String} jobId jobId
4253
4253
  * @param {Object} opts Optional parameters
4254
4254
  * @param {String} opts.cursor Cursor token to retrieve next page
4255
- * Preview Endpoint
4255
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4256
4256
  */
4257
4257
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
4258
4258
  opts = opts || {};
@@ -4280,7 +4280,7 @@ class AnalyticsApi {
4280
4280
  * Get status for async query for knowledge aggregates
4281
4281
  *
4282
4282
  * @param {String} jobId jobId
4283
- * Preview Endpoint
4283
+ * getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4284
4284
  */
4285
4285
  getAnalyticsKnowledgeAggregatesJob(jobId) {
4286
4286
  // verify the required parameter 'jobId' is set
@@ -4308,7 +4308,7 @@ class AnalyticsApi {
4308
4308
  * @param {String} jobId jobId
4309
4309
  * @param {Object} opts Optional parameters
4310
4310
  * @param {String} opts.cursor Cursor token to retrieve next page
4311
- * Preview Endpoint
4311
+ * getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4312
4312
  */
4313
4313
  getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
4314
4314
  opts = opts || {};
@@ -4631,7 +4631,7 @@ class AnalyticsApi {
4631
4631
  * Get status for async query for resolution aggregates
4632
4632
  *
4633
4633
  * @param {String} jobId jobId
4634
- * Preview Endpoint
4634
+ * getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4635
4635
  */
4636
4636
  getAnalyticsResolutionsAggregatesJob(jobId) {
4637
4637
  // verify the required parameter 'jobId' is set
@@ -4659,7 +4659,7 @@ class AnalyticsApi {
4659
4659
  * @param {String} jobId jobId
4660
4660
  * @param {Object} opts Optional parameters
4661
4661
  * @param {String} opts.cursor Cursor token to retrieve next page
4662
- * Preview Endpoint
4662
+ * getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4663
4663
  */
4664
4664
  getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
4665
4665
  opts = opts || {};
@@ -4687,7 +4687,7 @@ class AnalyticsApi {
4687
4687
  * Get status for async query for survey aggregates
4688
4688
  *
4689
4689
  * @param {String} jobId jobId
4690
- * Preview Endpoint
4690
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4691
4691
  */
4692
4692
  getAnalyticsSurveysAggregatesJob(jobId) {
4693
4693
  // verify the required parameter 'jobId' is set
@@ -4715,7 +4715,7 @@ class AnalyticsApi {
4715
4715
  * @param {String} jobId jobId
4716
4716
  * @param {Object} opts Optional parameters
4717
4717
  * @param {String} opts.cursor Cursor token to retrieve next page
4718
- * Preview Endpoint
4718
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4719
4719
  */
4720
4720
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
4721
4721
  opts = opts || {};
@@ -4743,7 +4743,7 @@ class AnalyticsApi {
4743
4743
  * Get status for async query for task management aggregates
4744
4744
  *
4745
4745
  * @param {String} jobId jobId
4746
- * Preview Endpoint
4746
+ * getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4747
4747
  */
4748
4748
  getAnalyticsTaskmanagementAggregatesJob(jobId) {
4749
4749
  // verify the required parameter 'jobId' is set
@@ -4771,7 +4771,7 @@ class AnalyticsApi {
4771
4771
  * @param {String} jobId jobId
4772
4772
  * @param {Object} opts Optional parameters
4773
4773
  * @param {String} opts.cursor Cursor token to retrieve next page
4774
- * Preview Endpoint
4774
+ * getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4775
4775
  */
4776
4776
  getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
4777
4777
  opts = opts || {};
@@ -4799,7 +4799,7 @@ class AnalyticsApi {
4799
4799
  * Get status for async query for transcript aggregates
4800
4800
  *
4801
4801
  * @param {String} jobId jobId
4802
- * Preview Endpoint
4802
+ * getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4803
4803
  */
4804
4804
  getAnalyticsTranscriptsAggregatesJob(jobId) {
4805
4805
  // verify the required parameter 'jobId' is set
@@ -4827,7 +4827,7 @@ class AnalyticsApi {
4827
4827
  * @param {String} jobId jobId
4828
4828
  * @param {Object} opts Optional parameters
4829
4829
  * @param {String} opts.cursor Cursor token to retrieve next page
4830
- * Preview Endpoint
4830
+ * getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4831
4831
  */
4832
4832
  getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
4833
4833
  opts = opts || {};
@@ -4855,7 +4855,7 @@ class AnalyticsApi {
4855
4855
  * Get status for async query for user aggregates
4856
4856
  *
4857
4857
  * @param {String} jobId jobId
4858
- * Preview Endpoint
4858
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4859
4859
  */
4860
4860
  getAnalyticsUsersAggregatesJob(jobId) {
4861
4861
  // verify the required parameter 'jobId' is set
@@ -4883,7 +4883,7 @@ class AnalyticsApi {
4883
4883
  * @param {String} jobId jobId
4884
4884
  * @param {Object} opts Optional parameters
4885
4885
  * @param {String} opts.cursor Cursor token to retrieve next page
4886
- * Preview Endpoint
4886
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4887
4887
  */
4888
4888
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
4889
4889
  opts = opts || {};
@@ -5011,7 +5011,7 @@ class AnalyticsApi {
5011
5011
  * Query for action aggregates asynchronously
5012
5012
  *
5013
5013
  * @param {Object} body query
5014
- * Preview Endpoint
5014
+ * postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5015
5015
  */
5016
5016
  postAnalyticsActionsAggregatesJobs(body) {
5017
5017
  // verify the required parameter 'body' is set
@@ -5062,7 +5062,7 @@ class AnalyticsApi {
5062
5062
  * Query for bot aggregates asynchronously
5063
5063
  *
5064
5064
  * @param {Object} body query
5065
- * Preview Endpoint
5065
+ * postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5066
5066
  */
5067
5067
  postAnalyticsBotsAggregatesJobs(body) {
5068
5068
  // verify the required parameter 'body' is set
@@ -5146,7 +5146,7 @@ class AnalyticsApi {
5146
5146
  * @param {Object} opts Optional parameters
5147
5147
  * @param {Number} opts.pageSize The desired page size
5148
5148
  * @param {Number} opts.pageNumber The desired page number
5149
- * Preview Endpoint
5149
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5150
5150
  */
5151
5151
  postAnalyticsConversationsActivityQuery(body, opts) {
5152
5152
  opts = opts || {};
@@ -5174,7 +5174,7 @@ class AnalyticsApi {
5174
5174
  * Query for conversation aggregates asynchronously
5175
5175
  *
5176
5176
  * @param {Object} body query
5177
- * Preview Endpoint
5177
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5178
5178
  */
5179
5179
  postAnalyticsConversationsAggregatesJobs(body) {
5180
5180
  // verify the required parameter 'body' is set
@@ -5300,7 +5300,7 @@ class AnalyticsApi {
5300
5300
  * Query for evaluation aggregates asynchronously
5301
5301
  *
5302
5302
  * @param {Object} body query
5303
- * Preview Endpoint
5303
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5304
5304
  */
5305
5305
  postAnalyticsEvaluationsAggregatesJobs(body) {
5306
5306
  // verify the required parameter 'body' is set
@@ -5354,7 +5354,7 @@ class AnalyticsApi {
5354
5354
  * @param {Object} opts Optional parameters
5355
5355
  * @param {Number} opts.pageSize The desired page size
5356
5356
  * @param {Number} opts.pageNumber The desired page number
5357
- * Preview Endpoint
5357
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5358
5358
  */
5359
5359
  postAnalyticsFlowsActivityQuery(body, opts) {
5360
5360
  opts = opts || {};
@@ -5382,7 +5382,7 @@ class AnalyticsApi {
5382
5382
  * Query for flow aggregates asynchronously
5383
5383
  *
5384
5384
  * @param {Object} body query
5385
- * Preview Endpoint
5385
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5386
5386
  */
5387
5387
  postAnalyticsFlowsAggregatesJobs(body) {
5388
5388
  // verify the required parameter 'body' is set
@@ -5458,7 +5458,7 @@ class AnalyticsApi {
5458
5458
  * Query for journey aggregates asynchronously
5459
5459
  *
5460
5460
  * @param {Object} body query
5461
- * Preview Endpoint
5461
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5462
5462
  */
5463
5463
  postAnalyticsJourneysAggregatesJobs(body) {
5464
5464
  // verify the required parameter 'body' is set
@@ -5509,7 +5509,7 @@ class AnalyticsApi {
5509
5509
  * Query for knowledge aggregates asynchronously
5510
5510
  *
5511
5511
  * @param {Object} body query
5512
- * Preview Endpoint
5512
+ * postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5513
5513
  */
5514
5514
  postAnalyticsKnowledgeAggregatesJobs(body) {
5515
5515
  // verify the required parameter 'body' is set
@@ -5535,7 +5535,7 @@ class AnalyticsApi {
5535
5535
  * Query for knowledge aggregates
5536
5536
  *
5537
5537
  * @param {Object} body query
5538
- * Preview Endpoint
5538
+ * postAnalyticsKnowledgeAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5539
5539
  */
5540
5540
  postAnalyticsKnowledgeAggregatesQuery(body) {
5541
5541
  // verify the required parameter 'body' is set
@@ -5661,7 +5661,7 @@ class AnalyticsApi {
5661
5661
  * Query for resolution aggregates asynchronously
5662
5662
  *
5663
5663
  * @param {Object} body query
5664
- * Preview Endpoint
5664
+ * postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5665
5665
  */
5666
5666
  postAnalyticsResolutionsAggregatesJobs(body) {
5667
5667
  // verify the required parameter 'body' is set
@@ -5690,7 +5690,7 @@ class AnalyticsApi {
5690
5690
  * @param {Object} opts Optional parameters
5691
5691
  * @param {Number} opts.pageSize The desired page size
5692
5692
  * @param {Number} opts.pageNumber The desired page number
5693
- * Preview Endpoint
5693
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5694
5694
  */
5695
5695
  postAnalyticsRoutingActivityQuery(body, opts) {
5696
5696
  opts = opts || {};
@@ -5718,7 +5718,7 @@ class AnalyticsApi {
5718
5718
  * Query for survey aggregates asynchronously
5719
5719
  *
5720
5720
  * @param {Object} body query
5721
- * Preview Endpoint
5721
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5722
5722
  */
5723
5723
  postAnalyticsSurveysAggregatesJobs(body) {
5724
5724
  // verify the required parameter 'body' is set
@@ -5769,7 +5769,7 @@ class AnalyticsApi {
5769
5769
  * Query for task management aggregates asynchronously
5770
5770
  *
5771
5771
  * @param {Object} body query
5772
- * Preview Endpoint
5772
+ * postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5773
5773
  */
5774
5774
  postAnalyticsTaskmanagementAggregatesJobs(body) {
5775
5775
  // verify the required parameter 'body' is set
@@ -5795,7 +5795,7 @@ class AnalyticsApi {
5795
5795
  * Query for task management aggregates
5796
5796
  *
5797
5797
  * @param {Object} body query
5798
- * Preview Endpoint
5798
+ * postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5799
5799
  */
5800
5800
  postAnalyticsTaskmanagementAggregatesQuery(body) {
5801
5801
  // verify the required parameter 'body' is set
@@ -5824,7 +5824,7 @@ class AnalyticsApi {
5824
5824
  * @param {Object} opts Optional parameters
5825
5825
  * @param {Number} opts.pageSize The desired page size
5826
5826
  * @param {Number} opts.pageNumber The desired page number
5827
- * Preview Endpoint
5827
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5828
5828
  */
5829
5829
  postAnalyticsTeamsActivityQuery(body, opts) {
5830
5830
  opts = opts || {};
@@ -5852,7 +5852,7 @@ class AnalyticsApi {
5852
5852
  * Query for transcript aggregates asynchronously
5853
5853
  *
5854
5854
  * @param {Object} body query
5855
- * Preview Endpoint
5855
+ * postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5856
5856
  */
5857
5857
  postAnalyticsTranscriptsAggregatesJobs(body) {
5858
5858
  // verify the required parameter 'body' is set
@@ -5906,7 +5906,7 @@ class AnalyticsApi {
5906
5906
  * @param {Object} opts Optional parameters
5907
5907
  * @param {Number} opts.pageSize The desired page size
5908
5908
  * @param {Number} opts.pageNumber The desired page number
5909
- * Preview Endpoint
5909
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5910
5910
  */
5911
5911
  postAnalyticsUsersActivityQuery(body, opts) {
5912
5912
  opts = opts || {};
@@ -5934,7 +5934,7 @@ class AnalyticsApi {
5934
5934
  * Query for user aggregates asynchronously
5935
5935
  *
5936
5936
  * @param {Object} body query
5937
- * Preview Endpoint
5937
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5938
5938
  */
5939
5939
  postAnalyticsUsersAggregatesJobs(body) {
5940
5940
  // verify the required parameter 'body' is set
@@ -6117,7 +6117,7 @@ class ArchitectApi {
6117
6117
  /**
6118
6118
  * Architect service.
6119
6119
  * @module purecloud-platform-client-v2/api/ArchitectApi
6120
- * @version 169.1.0
6120
+ * @version 170.0.0
6121
6121
  */
6122
6122
 
6123
6123
  /**
@@ -7890,7 +7890,7 @@ class ArchitectApi {
7890
7890
  * @param {String} instanceId Instance ID
7891
7891
  * @param {Object} opts Optional parameters
7892
7892
  * @param {Object} opts.expand Expand various details.
7893
- * Preview Endpoint
7893
+ * getFlowsInstance is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7894
7894
  */
7895
7895
  getFlowsInstance(instanceId, opts) {
7896
7896
  opts = opts || {};
@@ -7918,7 +7918,7 @@ class ArchitectApi {
7918
7918
  * Get the status and/or results of an asynchronous flow execution data retrieval job
7919
7919
  *
7920
7920
  * @param {String} jobId The asynchronous job ID
7921
- * Preview Endpoint
7921
+ * getFlowsInstancesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7922
7922
  */
7923
7923
  getFlowsInstancesJob(jobId) {
7924
7924
  // verify the required parameter 'jobId' is set
@@ -7945,7 +7945,7 @@ class ArchitectApi {
7945
7945
  * Returns the queryable parameters that can be used to build a query for execution data.
7946
7946
  * @param {Object} opts Optional parameters
7947
7947
  * @param {Object} opts.expand Expand various query types.
7948
- * Preview Endpoint
7948
+ * getFlowsInstancesQuerycapabilities is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7949
7949
  */
7950
7950
  getFlowsInstancesQuerycapabilities(opts) {
7951
7951
  opts = opts || {};
@@ -8802,7 +8802,7 @@ class ArchitectApi {
8802
8802
  * @param {Object} body Requested Flow Ids
8803
8803
  * @param {Object} opts Optional parameters
8804
8804
  * @param {Object} opts.expand Expand various query types.
8805
- * Preview Endpoint
8805
+ * postFlowsInstancesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8806
8806
  */
8807
8807
  postFlowsInstancesJobs(body, opts) {
8808
8808
  opts = opts || {};
@@ -8832,7 +8832,7 @@ class ArchitectApi {
8832
8832
  * @param {Object} body query
8833
8833
  * @param {Object} opts Optional parameters
8834
8834
  * @param {Boolean} opts.indexOnly indexes only
8835
- * Preview Endpoint
8835
+ * postFlowsInstancesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8836
8836
  */
8837
8837
  postFlowsInstancesQuery(body, opts) {
8838
8838
  opts = opts || {};
@@ -9306,7 +9306,7 @@ class AuditApi {
9306
9306
  /**
9307
9307
  * Audit service.
9308
9308
  * @module purecloud-platform-client-v2/api/AuditApi
9309
- * @version 169.1.0
9309
+ * @version 170.0.0
9310
9310
  */
9311
9311
 
9312
9312
  /**
@@ -9477,7 +9477,7 @@ class AuthorizationApi {
9477
9477
  /**
9478
9478
  * Authorization service.
9479
9479
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9480
- * @version 169.1.0
9480
+ * @version 170.0.0
9481
9481
  */
9482
9482
 
9483
9483
  /**
@@ -9718,7 +9718,7 @@ class AuthorizationApi {
9718
9718
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
9719
9719
  * @param {Object} opts Optional parameters
9720
9720
  * @param {String} opts.name Search term to filter by division name
9721
- * @deprecated
9721
+ * @deprecated
9722
9722
  */
9723
9723
  getAuthorizationDivisionspermittedMe(permission, opts) {
9724
9724
  opts = opts || {};
@@ -9780,7 +9780,7 @@ class AuthorizationApi {
9780
9780
  * @param {Object} opts Optional parameters
9781
9781
  * @param {Number} opts.pageNumber Page number (default to 1)
9782
9782
  * @param {Number} opts.pageSize Page size (default to 25)
9783
- * @deprecated
9783
+ * @deprecated
9784
9784
  */
9785
9785
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
9786
9786
  opts = opts || {};
@@ -10708,7 +10708,7 @@ class BillingApi {
10708
10708
  /**
10709
10709
  * Billing service.
10710
10710
  * @module purecloud-platform-client-v2/api/BillingApi
10711
- * @version 169.1.0
10711
+ * @version 170.0.0
10712
10712
  */
10713
10713
 
10714
10714
  /**
@@ -10788,7 +10788,7 @@ class CarrierServicesApi {
10788
10788
  /**
10789
10789
  * CarrierServices service.
10790
10790
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10791
- * @version 169.1.0
10791
+ * @version 170.0.0
10792
10792
  */
10793
10793
 
10794
10794
  /**
@@ -10858,7 +10858,7 @@ class ChatApi {
10858
10858
  /**
10859
10859
  * Chat service.
10860
10860
  * @module purecloud-platform-client-v2/api/ChatApi
10861
- * @version 169.1.0
10861
+ * @version 170.0.0
10862
10862
  */
10863
10863
 
10864
10864
  /**
@@ -10876,7 +10876,7 @@ class ChatApi {
10876
10876
  /**
10877
10877
  * Get Chat Settings.
10878
10878
  * This route is deprecated, please use /chats/settings instead
10879
- * @deprecated
10879
+ * @deprecated
10880
10880
  */
10881
10881
  getChatSettings() {
10882
10882
 
@@ -10918,7 +10918,7 @@ class ChatApi {
10918
10918
  * Patch Chat Settings.
10919
10919
  * This route is deprecated, please use /chats/settings instead
10920
10920
  * @param {Object} body Chat
10921
- * @deprecated
10921
+ * @deprecated
10922
10922
  */
10923
10923
  patchChatSettings(body) {
10924
10924
  // verify the required parameter 'body' is set
@@ -10969,7 +10969,7 @@ class ChatApi {
10969
10969
  * Update Chat Settings.
10970
10970
  * This route is deprecated, please use /chats/settings instead
10971
10971
  * @param {Object} body Chat
10972
- * @deprecated
10972
+ * @deprecated
10973
10973
  */
10974
10974
  putChatSettings(body) {
10975
10975
  // verify the required parameter 'body' is set
@@ -11022,7 +11022,7 @@ class CoachingApi {
11022
11022
  /**
11023
11023
  * Coaching service.
11024
11024
  * @module purecloud-platform-client-v2/api/CoachingApi
11025
- * @version 169.1.0
11025
+ * @version 170.0.0
11026
11026
  */
11027
11027
 
11028
11028
  /**
@@ -11599,7 +11599,7 @@ class ContentManagementApi {
11599
11599
  /**
11600
11600
  * ContentManagement service.
11601
11601
  * @module purecloud-platform-client-v2/api/ContentManagementApi
11602
- * @version 169.1.0
11602
+ * @version 170.0.0
11603
11603
  */
11604
11604
 
11605
11605
  /**
@@ -11813,7 +11813,7 @@ class ContentManagementApi {
11813
11813
 
11814
11814
  /**
11815
11815
  * Get a list of audits for a document.
11816
- *
11816
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
11817
11817
  * @param {String} documentId Document ID
11818
11818
  * @param {Object} opts Optional parameters
11819
11819
  * @param {Number} opts.pageSize Page size (default to 25)
@@ -11822,6 +11822,7 @@ class ContentManagementApi {
11822
11822
  * @param {String} opts.level level (default to USER)
11823
11823
  * @param {String} opts.sortBy Sort by
11824
11824
  * @param {String} opts.sortOrder Sort order (default to ascending)
11825
+ * @deprecated
11825
11826
  */
11826
11827
  getContentmanagementDocumentAudits(documentId, opts) {
11827
11828
  opts = opts || {};
@@ -11886,7 +11887,7 @@ class ContentManagementApi {
11886
11887
  * @param {Number} opts.pageNumber Page number (default to 1)
11887
11888
  * @param {String} opts.sortBy name or dateCreated
11888
11889
  * @param {String} opts.sortOrder ascending or descending (default to ascending)
11889
- * @deprecated
11890
+ * @deprecated
11890
11891
  */
11891
11892
  getContentmanagementDocuments(workspaceId, opts) {
11892
11893
  opts = opts || {};
@@ -12368,8 +12369,9 @@ class ContentManagementApi {
12368
12369
 
12369
12370
  /**
12370
12371
  * Query audits
12371
- *
12372
+ * This api is deprecated, use https://developer.genesys.cloud/platform/audit/ instead.
12372
12373
  * @param {Object} body Allows for a filtered query returning facet information
12374
+ * @deprecated
12373
12375
  */
12374
12376
  postContentmanagementAuditquery(body) {
12375
12377
  // verify the required parameter 'body' is set
@@ -12740,7 +12742,7 @@ class ConversationsApi {
12740
12742
  /**
12741
12743
  * Conversations service.
12742
12744
  * @module purecloud-platform-client-v2/api/ConversationsApi
12743
- * @version 169.1.0
12745
+ * @version 170.0.0
12744
12746
  */
12745
12747
 
12746
12748
  /**
@@ -12930,6 +12932,31 @@ class ConversationsApi {
12930
12932
  );
12931
12933
  }
12932
12934
 
12935
+ /**
12936
+ * Delete Instagram messaging integration
12937
+ *
12938
+ * @param {String} integrationId Integration ID
12939
+ */
12940
+ deleteConversationsMessagingIntegrationsInstagramIntegrationId(integrationId) {
12941
+ // verify the required parameter 'integrationId' is set
12942
+ if (integrationId === undefined || integrationId === null) {
12943
+ throw 'Missing the required parameter "integrationId" when calling deleteConversationsMessagingIntegrationsInstagramIntegrationId';
12944
+ }
12945
+
12946
+ return this.apiClient.callApi(
12947
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
12948
+ 'DELETE',
12949
+ { 'integrationId': integrationId },
12950
+ { },
12951
+ { },
12952
+ { },
12953
+ null,
12954
+ ['PureCloud OAuth'],
12955
+ ['application/json'],
12956
+ ['application/json']
12957
+ );
12958
+ }
12959
+
12933
12960
  /**
12934
12961
  * Delete a LINE messenger integration
12935
12962
  *
@@ -13084,7 +13111,7 @@ class ConversationsApi {
13084
13111
  * Get status for async query for conversation aggregates
13085
13112
  *
13086
13113
  * @param {String} jobId jobId
13087
- * Preview Endpoint
13114
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13088
13115
  */
13089
13116
  getAnalyticsConversationsAggregatesJob(jobId) {
13090
13117
  // verify the required parameter 'jobId' is set
@@ -13112,7 +13139,7 @@ class ConversationsApi {
13112
13139
  * @param {String} jobId jobId
13113
13140
  * @param {Object} opts Optional parameters
13114
13141
  * @param {String} opts.cursor Cursor token to retrieve next page
13115
- * Preview Endpoint
13142
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13116
13143
  */
13117
13144
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
13118
13145
  opts = opts || {};
@@ -14788,6 +14815,63 @@ class ConversationsApi {
14788
14815
  );
14789
14816
  }
14790
14817
 
14818
+ /**
14819
+ * Get a list of Instagram Integrations
14820
+ *
14821
+ * @param {Object} opts Optional parameters
14822
+ * @param {Number} opts.pageSize Page size (default to 25)
14823
+ * @param {Number} opts.pageNumber Page number (default to 1)
14824
+ * @param {Object} opts.expand Expand instructions for the return value.
14825
+ * @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
14826
+ * @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
14827
+ */
14828
+ getConversationsMessagingIntegrationsInstagram(opts) {
14829
+ opts = opts || {};
14830
+
14831
+
14832
+ return this.apiClient.callApi(
14833
+ '/api/v2/conversations/messaging/integrations/instagram',
14834
+ 'GET',
14835
+ { },
14836
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
14837
+ { },
14838
+ { },
14839
+ null,
14840
+ ['PureCloud OAuth'],
14841
+ ['application/json'],
14842
+ ['application/json']
14843
+ );
14844
+ }
14845
+
14846
+ /**
14847
+ * Get Instagram messaging integration
14848
+ *
14849
+ * @param {String} integrationId Integration ID
14850
+ * @param {Object} opts Optional parameters
14851
+ * @param {Object} opts.expand Expand instructions for the return value.
14852
+ */
14853
+ getConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, opts) {
14854
+ opts = opts || {};
14855
+
14856
+ // verify the required parameter 'integrationId' is set
14857
+ if (integrationId === undefined || integrationId === null) {
14858
+ throw 'Missing the required parameter "integrationId" when calling getConversationsMessagingIntegrationsInstagramIntegrationId';
14859
+ }
14860
+
14861
+ return this.apiClient.callApi(
14862
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
14863
+ 'GET',
14864
+ { 'integrationId': integrationId },
14865
+ { 'expand': opts['expand'] },
14866
+ { },
14867
+ { },
14868
+ null,
14869
+ ['PureCloud OAuth'],
14870
+ ['application/json'],
14871
+ ['application/json']
14872
+ );
14873
+ }
14874
+
14791
14875
  /**
14792
14876
  * Get a list of LINE messenger Integrations
14793
14877
  *
@@ -15238,7 +15322,7 @@ class ConversationsApi {
15238
15322
  * Get video conference details (e.g. the current number of active participants).
15239
15323
  *
15240
15324
  * @param {String} conferenceId conferenceId
15241
- * Preview Endpoint
15325
+ * getConversationsVideoDetails is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15242
15326
  */
15243
15327
  getConversationsVideoDetails(conferenceId) {
15244
15328
  // verify the required parameter 'conferenceId' is set
@@ -16396,6 +16480,36 @@ class ConversationsApi {
16396
16480
  );
16397
16481
  }
16398
16482
 
16483
+ /**
16484
+ * Update Instagram messaging integration
16485
+ *
16486
+ * @param {String} integrationId Integration ID
16487
+ * @param {Object} body InstagramIntegrationUpdateRequest
16488
+ */
16489
+ patchConversationsMessagingIntegrationsInstagramIntegrationId(integrationId, body) {
16490
+ // verify the required parameter 'integrationId' is set
16491
+ if (integrationId === undefined || integrationId === null) {
16492
+ throw 'Missing the required parameter "integrationId" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
16493
+ }
16494
+ // verify the required parameter 'body' is set
16495
+ if (body === undefined || body === null) {
16496
+ throw 'Missing the required parameter "body" when calling patchConversationsMessagingIntegrationsInstagramIntegrationId';
16497
+ }
16498
+
16499
+ return this.apiClient.callApi(
16500
+ '/api/v2/conversations/messaging/integrations/instagram/{integrationId}',
16501
+ 'PATCH',
16502
+ { 'integrationId': integrationId },
16503
+ { },
16504
+ { },
16505
+ { },
16506
+ body,
16507
+ ['PureCloud OAuth'],
16508
+ ['application/json'],
16509
+ ['application/json']
16510
+ );
16511
+ }
16512
+
16399
16513
  /**
16400
16514
  * Update an Open messaging integration
16401
16515
  * See https://developer.genesys.cloud/api/digital/openmessaging/ for more information.
@@ -16578,7 +16692,7 @@ class ConversationsApi {
16578
16692
  * @param {Object} opts Optional parameters
16579
16693
  * @param {Number} opts.pageSize The desired page size
16580
16694
  * @param {Number} opts.pageNumber The desired page number
16581
- * Preview Endpoint
16695
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16582
16696
  */
16583
16697
  postAnalyticsConversationsActivityQuery(body, opts) {
16584
16698
  opts = opts || {};
@@ -16606,7 +16720,7 @@ class ConversationsApi {
16606
16720
  * Query for conversation aggregates asynchronously
16607
16721
  *
16608
16722
  * @param {Object} body query
16609
- * Preview Endpoint
16723
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16610
16724
  */
16611
16725
  postAnalyticsConversationsAggregatesJobs(body) {
16612
16726
  // verify the required parameter 'body' is set
@@ -16857,6 +16971,7 @@ class ConversationsApi {
16857
16971
  * @param {String} conversationId conversation ID
16858
16972
  * @param {String} participantId participant ID
16859
16973
  * @param {Object} body Transfer request
16974
+ * @deprecated
16860
16975
  */
16861
16976
  postConversationParticipantReplace(conversationId, participantId, body) {
16862
16977
  // verify the required parameter 'conversationId' is set
@@ -16886,6 +17001,111 @@ class ConversationsApi {
16886
17001
  );
16887
17002
  }
16888
17003
 
17004
+ /**
17005
+ * Replace this participant with the specified agent
17006
+ *
17007
+ * @param {String} conversationId conversation ID
17008
+ * @param {String} participantId participant ID
17009
+ * @param {Object} body Transfer request
17010
+ */
17011
+ postConversationParticipantReplaceAgent(conversationId, participantId, body) {
17012
+ // verify the required parameter 'conversationId' is set
17013
+ if (conversationId === undefined || conversationId === null) {
17014
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceAgent';
17015
+ }
17016
+ // verify the required parameter 'participantId' is set
17017
+ if (participantId === undefined || participantId === null) {
17018
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceAgent';
17019
+ }
17020
+ // verify the required parameter 'body' is set
17021
+ if (body === undefined || body === null) {
17022
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceAgent';
17023
+ }
17024
+
17025
+ return this.apiClient.callApi(
17026
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/agent',
17027
+ 'POST',
17028
+ { 'conversationId': conversationId,'participantId': participantId },
17029
+ { },
17030
+ { },
17031
+ { },
17032
+ body,
17033
+ ['PureCloud OAuth'],
17034
+ ['application/json'],
17035
+ ['application/json']
17036
+ );
17037
+ }
17038
+
17039
+ /**
17040
+ * Replace this participant with the an external contact
17041
+ *
17042
+ * @param {String} conversationId conversation ID
17043
+ * @param {String} participantId participant ID
17044
+ * @param {Object} body Transfer request
17045
+ */
17046
+ postConversationParticipantReplaceExternal(conversationId, participantId, body) {
17047
+ // verify the required parameter 'conversationId' is set
17048
+ if (conversationId === undefined || conversationId === null) {
17049
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceExternal';
17050
+ }
17051
+ // verify the required parameter 'participantId' is set
17052
+ if (participantId === undefined || participantId === null) {
17053
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceExternal';
17054
+ }
17055
+ // verify the required parameter 'body' is set
17056
+ if (body === undefined || body === null) {
17057
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceExternal';
17058
+ }
17059
+
17060
+ return this.apiClient.callApi(
17061
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/external',
17062
+ 'POST',
17063
+ { 'conversationId': conversationId,'participantId': participantId },
17064
+ { },
17065
+ { },
17066
+ { },
17067
+ body,
17068
+ ['PureCloud OAuth'],
17069
+ ['application/json'],
17070
+ ['application/json']
17071
+ );
17072
+ }
17073
+
17074
+ /**
17075
+ * Replace this participant with the specified queue
17076
+ *
17077
+ * @param {String} conversationId conversation ID
17078
+ * @param {String} participantId participant ID
17079
+ * @param {Object} body Transfer request
17080
+ */
17081
+ postConversationParticipantReplaceQueue(conversationId, participantId, body) {
17082
+ // verify the required parameter 'conversationId' is set
17083
+ if (conversationId === undefined || conversationId === null) {
17084
+ throw 'Missing the required parameter "conversationId" when calling postConversationParticipantReplaceQueue';
17085
+ }
17086
+ // verify the required parameter 'participantId' is set
17087
+ if (participantId === undefined || participantId === null) {
17088
+ throw 'Missing the required parameter "participantId" when calling postConversationParticipantReplaceQueue';
17089
+ }
17090
+ // verify the required parameter 'body' is set
17091
+ if (body === undefined || body === null) {
17092
+ throw 'Missing the required parameter "body" when calling postConversationParticipantReplaceQueue';
17093
+ }
17094
+
17095
+ return this.apiClient.callApi(
17096
+ '/api/v2/conversations/{conversationId}/participants/{participantId}/replace/queue',
17097
+ 'POST',
17098
+ { 'conversationId': conversationId,'participantId': participantId },
17099
+ { },
17100
+ { },
17101
+ { },
17102
+ body,
17103
+ ['PureCloud OAuth'],
17104
+ ['application/json'],
17105
+ ['application/json']
17106
+ );
17107
+ }
17108
+
16889
17109
  /**
16890
17110
  * Create secure IVR session. Only a participant in the conversation can invoke a secure IVR.
16891
17111
  *
@@ -17025,6 +17245,7 @@ class ConversationsApi {
17025
17245
  * @param {String} conversationId conversationId
17026
17246
  * @param {String} participantId participantId
17027
17247
  * @param {Object} body Destination address and initial speak to
17248
+ * @deprecated
17028
17249
  */
17029
17250
  postConversationsCallParticipantConsult(conversationId, participantId, body) {
17030
17251
  // verify the required parameter 'conversationId' is set
@@ -17054,6 +17275,111 @@ class ConversationsApi {
17054
17275
  );
17055
17276
  }
17056
17277
 
17278
+ /**
17279
+ * Initiate a consult transfer to an agent
17280
+ *
17281
+ * @param {String} conversationId conversationId
17282
+ * @param {String} participantId participantId
17283
+ * @param {Object} body Destination agent and initial speak to
17284
+ */
17285
+ postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
17286
+ // verify the required parameter 'conversationId' is set
17287
+ if (conversationId === undefined || conversationId === null) {
17288
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultAgent';
17289
+ }
17290
+ // verify the required parameter 'participantId' is set
17291
+ if (participantId === undefined || participantId === null) {
17292
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultAgent';
17293
+ }
17294
+ // verify the required parameter 'body' is set
17295
+ if (body === undefined || body === null) {
17296
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultAgent';
17297
+ }
17298
+
17299
+ return this.apiClient.callApi(
17300
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/agent',
17301
+ 'POST',
17302
+ { 'conversationId': conversationId,'participantId': participantId },
17303
+ { },
17304
+ { },
17305
+ { },
17306
+ body,
17307
+ ['PureCloud OAuth'],
17308
+ ['application/json'],
17309
+ ['application/json']
17310
+ );
17311
+ }
17312
+
17313
+ /**
17314
+ * Initiate a consult transfer to an external contact
17315
+ *
17316
+ * @param {String} conversationId conversationId
17317
+ * @param {String} participantId participantId
17318
+ * @param {Object} body Destination address and initial speak to
17319
+ */
17320
+ postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
17321
+ // verify the required parameter 'conversationId' is set
17322
+ if (conversationId === undefined || conversationId === null) {
17323
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultExternal';
17324
+ }
17325
+ // verify the required parameter 'participantId' is set
17326
+ if (participantId === undefined || participantId === null) {
17327
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultExternal';
17328
+ }
17329
+ // verify the required parameter 'body' is set
17330
+ if (body === undefined || body === null) {
17331
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultExternal';
17332
+ }
17333
+
17334
+ return this.apiClient.callApi(
17335
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/external',
17336
+ 'POST',
17337
+ { 'conversationId': conversationId,'participantId': participantId },
17338
+ { },
17339
+ { },
17340
+ { },
17341
+ body,
17342
+ ['PureCloud OAuth'],
17343
+ ['application/json'],
17344
+ ['application/json']
17345
+ );
17346
+ }
17347
+
17348
+ /**
17349
+ * Initiate a consult transfer to a queue
17350
+ *
17351
+ * @param {String} conversationId conversationId
17352
+ * @param {String} participantId participantId
17353
+ * @param {Object} body Destination queue and initial speak to
17354
+ */
17355
+ postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
17356
+ // verify the required parameter 'conversationId' is set
17357
+ if (conversationId === undefined || conversationId === null) {
17358
+ throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantConsultQueue';
17359
+ }
17360
+ // verify the required parameter 'participantId' is set
17361
+ if (participantId === undefined || participantId === null) {
17362
+ throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantConsultQueue';
17363
+ }
17364
+ // verify the required parameter 'body' is set
17365
+ if (body === undefined || body === null) {
17366
+ throw 'Missing the required parameter "body" when calling postConversationsCallParticipantConsultQueue';
17367
+ }
17368
+
17369
+ return this.apiClient.callApi(
17370
+ '/api/v2/conversations/calls/{conversationId}/participants/{participantId}/consult/queue',
17371
+ 'POST',
17372
+ { 'conversationId': conversationId,'participantId': participantId },
17373
+ { },
17374
+ { },
17375
+ { },
17376
+ body,
17377
+ ['PureCloud OAuth'],
17378
+ ['application/json'],
17379
+ ['application/json']
17380
+ );
17381
+ }
17382
+
17057
17383
  /**
17058
17384
  * Listen in on the conversation from the point of view of a given participant.
17059
17385
  *
@@ -17090,6 +17416,7 @@ class ConversationsApi {
17090
17416
  * @param {String} conversationId conversationId
17091
17417
  * @param {String} participantId participantId
17092
17418
  * @param {Object} body Transfer request
17419
+ * @deprecated
17093
17420
  */
17094
17421
  postConversationsCallParticipantReplace(conversationId, participantId, body) {
17095
17422
  // verify the required parameter 'conversationId' is set
@@ -17194,6 +17521,7 @@ class ConversationsApi {
17194
17521
  * @param {String} conversationId conversationId
17195
17522
  * @param {String} participantId participantId
17196
17523
  * @param {Object} body Transfer request
17524
+ * @deprecated
17197
17525
  */
17198
17526
  postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
17199
17527
  // verify the required parameter 'conversationId' is set
@@ -17433,6 +17761,7 @@ class ConversationsApi {
17433
17761
  * @param {String} conversationId conversationId
17434
17762
  * @param {String} participantId participantId
17435
17763
  * @param {Object} body Transfer request
17764
+ * @deprecated
17436
17765
  */
17437
17766
  postConversationsChatParticipantReplace(conversationId, participantId, body) {
17438
17767
  // verify the required parameter 'conversationId' is set
@@ -17533,6 +17862,7 @@ class ConversationsApi {
17533
17862
  * @param {String} participantId participantId
17534
17863
  * @param {Object} opts Optional parameters
17535
17864
  * @param {Object} opts.body
17865
+ * @deprecated
17536
17866
  */
17537
17867
  postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
17538
17868
  opts = opts || {};
@@ -17695,6 +18025,7 @@ class ConversationsApi {
17695
18025
  * @param {String} conversationId conversationId
17696
18026
  * @param {String} participantId participantId
17697
18027
  * @param {Object} body Transfer request
18028
+ * @deprecated
17698
18029
  */
17699
18030
  postConversationsEmailParticipantReplace(conversationId, participantId, body) {
17700
18031
  // verify the required parameter 'conversationId' is set
@@ -18027,7 +18358,7 @@ class ConversationsApi {
18027
18358
  *
18028
18359
  * @param {String} conversationId conversationId
18029
18360
  * @param {String} participantId participantId
18030
- * Preview Endpoint
18361
+ * postConversationsMessageParticipantMonitor is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18031
18362
  */
18032
18363
  postConversationsMessageParticipantMonitor(conversationId, participantId) {
18033
18364
  // verify the required parameter 'conversationId' is set
@@ -18059,6 +18390,7 @@ class ConversationsApi {
18059
18390
  * @param {String} conversationId conversationId
18060
18391
  * @param {String} participantId participantId
18061
18392
  * @param {Object} body Transfer request
18393
+ * @deprecated
18062
18394
  */
18063
18395
  postConversationsMessageParticipantReplace(conversationId, participantId, body) {
18064
18396
  // verify the required parameter 'conversationId' is set
@@ -18188,6 +18520,31 @@ class ConversationsApi {
18188
18520
  );
18189
18521
  }
18190
18522
 
18523
+ /**
18524
+ * Create Instagram Integration
18525
+ *
18526
+ * @param {Object} body InstagramIntegrationRequest
18527
+ */
18528
+ postConversationsMessagingIntegrationsInstagram(body) {
18529
+ // verify the required parameter 'body' is set
18530
+ if (body === undefined || body === null) {
18531
+ throw 'Missing the required parameter "body" when calling postConversationsMessagingIntegrationsInstagram';
18532
+ }
18533
+
18534
+ return this.apiClient.callApi(
18535
+ '/api/v2/conversations/messaging/integrations/instagram',
18536
+ 'POST',
18537
+ { },
18538
+ { },
18539
+ { },
18540
+ { },
18541
+ body,
18542
+ ['PureCloud OAuth'],
18543
+ ['application/json'],
18544
+ ['application/json']
18545
+ );
18546
+ }
18547
+
18191
18548
  /**
18192
18549
  * Create a LINE messenger Integration
18193
18550
  *
@@ -19001,7 +19358,7 @@ class DataExtensionsApi {
19001
19358
  /**
19002
19359
  * DataExtensions service.
19003
19360
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
19004
- * @version 169.1.0
19361
+ * @version 170.0.0
19005
19362
  */
19006
19363
 
19007
19364
  /**
@@ -19087,7 +19444,7 @@ class DownloadsApi {
19087
19444
  /**
19088
19445
  * Downloads service.
19089
19446
  * @module purecloud-platform-client-v2/api/DownloadsApi
19090
- * @version 169.1.0
19447
+ * @version 170.0.0
19091
19448
  */
19092
19449
 
19093
19450
  /**
@@ -19139,7 +19496,7 @@ class EventsApi {
19139
19496
  /**
19140
19497
  * Events service.
19141
19498
  * @module purecloud-platform-client-v2/api/EventsApi
19142
- * @version 169.1.0
19499
+ * @version 170.0.0
19143
19500
  */
19144
19501
 
19145
19502
  /**
@@ -19235,7 +19592,7 @@ class ExternalContactsApi {
19235
19592
  /**
19236
19593
  * ExternalContacts service.
19237
19594
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
19238
- * @version 169.1.0
19595
+ * @version 170.0.0
19239
19596
  */
19240
19597
 
19241
19598
  /**
@@ -21193,7 +21550,7 @@ class FaxApi {
21193
21550
  /**
21194
21551
  * Fax service.
21195
21552
  * @module purecloud-platform-client-v2/api/FaxApi
21196
- * @version 169.1.0
21553
+ * @version 170.0.0
21197
21554
  */
21198
21555
 
21199
21556
  /**
@@ -21364,7 +21721,7 @@ class FlowsApi {
21364
21721
  /**
21365
21722
  * Flows service.
21366
21723
  * @module purecloud-platform-client-v2/api/FlowsApi
21367
- * @version 169.1.0
21724
+ * @version 170.0.0
21368
21725
  */
21369
21726
 
21370
21727
  /**
@@ -21383,7 +21740,7 @@ class FlowsApi {
21383
21740
  * Get status for async query for Flow aggregates
21384
21741
  *
21385
21742
  * @param {String} jobId jobId
21386
- * Preview Endpoint
21743
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21387
21744
  */
21388
21745
  getAnalyticsFlowsAggregatesJob(jobId) {
21389
21746
  // verify the required parameter 'jobId' is set
@@ -21411,7 +21768,7 @@ class FlowsApi {
21411
21768
  * @param {String} jobId jobId
21412
21769
  * @param {Object} opts Optional parameters
21413
21770
  * @param {String} opts.cursor Cursor token to retrieve next page
21414
- * Preview Endpoint
21771
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21415
21772
  */
21416
21773
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
21417
21774
  opts = opts || {};
@@ -21442,7 +21799,7 @@ class FlowsApi {
21442
21799
  * @param {Object} opts Optional parameters
21443
21800
  * @param {Number} opts.pageSize The desired page size
21444
21801
  * @param {Number} opts.pageNumber The desired page number
21445
- * Preview Endpoint
21802
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21446
21803
  */
21447
21804
  postAnalyticsFlowsActivityQuery(body, opts) {
21448
21805
  opts = opts || {};
@@ -21470,7 +21827,7 @@ class FlowsApi {
21470
21827
  * Query for flow aggregates asynchronously
21471
21828
  *
21472
21829
  * @param {Object} body query
21473
- * Preview Endpoint
21830
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21474
21831
  */
21475
21832
  postAnalyticsFlowsAggregatesJobs(body) {
21476
21833
  // verify the required parameter 'body' is set
@@ -21548,7 +21905,7 @@ class GamificationApi {
21548
21905
  /**
21549
21906
  * Gamification service.
21550
21907
  * @module purecloud-platform-client-v2/api/GamificationApi
21551
- * @version 169.1.0
21908
+ * @version 170.0.0
21552
21909
  */
21553
21910
 
21554
21911
  /**
@@ -23634,7 +23991,7 @@ class GeneralDataProtectionRegulationApi {
23634
23991
  /**
23635
23992
  * GeneralDataProtectionRegulation service.
23636
23993
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
23637
- * @version 169.1.0
23994
+ * @version 170.0.0
23638
23995
  */
23639
23996
 
23640
23997
  /**
@@ -23764,7 +24121,7 @@ class GeolocationApi {
23764
24121
  /**
23765
24122
  * Geolocation service.
23766
24123
  * @module purecloud-platform-client-v2/api/GeolocationApi
23767
- * @version 169.1.0
24124
+ * @version 170.0.0
23768
24125
  */
23769
24126
 
23770
24127
  /**
@@ -23895,7 +24252,7 @@ class GreetingsApi {
23895
24252
  /**
23896
24253
  * Greetings service.
23897
24254
  * @module purecloud-platform-client-v2/api/GreetingsApi
23898
- * @version 169.1.0
24255
+ * @version 170.0.0
23899
24256
  */
23900
24257
 
23901
24258
  /**
@@ -24350,7 +24707,7 @@ class GroupsApi {
24350
24707
  /**
24351
24708
  * Groups service.
24352
24709
  * @module purecloud-platform-client-v2/api/GroupsApi
24353
- * @version 169.1.0
24710
+ * @version 170.0.0
24354
24711
  */
24355
24712
 
24356
24713
  /**
@@ -24394,7 +24751,7 @@ class GroupsApi {
24394
24751
  * Remove dynamic group definition
24395
24752
  *
24396
24753
  * @param {String} groupId Group ID
24397
- * Preview Endpoint
24754
+ * deleteGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24398
24755
  */
24399
24756
  deleteGroupDynamicsettings(groupId) {
24400
24757
  // verify the required parameter 'groupId' is set
@@ -24450,7 +24807,7 @@ class GroupsApi {
24450
24807
  * Fetch field config for an entity type
24451
24808
  *
24452
24809
  * @param {Object} type Field type
24453
- * @deprecated
24810
+ * @deprecated
24454
24811
  */
24455
24812
  getFieldconfig(type) {
24456
24813
  // verify the required parameter 'type' is set
@@ -24501,7 +24858,7 @@ class GroupsApi {
24501
24858
  * Get dynamic group definition
24502
24859
  *
24503
24860
  * @param {String} groupId Group ID
24504
- * Preview Endpoint
24861
+ * getGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24505
24862
  */
24506
24863
  getGroupDynamicsettings(groupId) {
24507
24864
  // verify the required parameter 'groupId' is set
@@ -24586,7 +24943,7 @@ class GroupsApi {
24586
24943
  * @param {String} groupId groupId
24587
24944
  * @param {Object} opts Optional parameters
24588
24945
  * @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
24589
- * @deprecated
24946
+ * @deprecated
24590
24947
  */
24591
24948
  getGroupProfile(groupId, opts) {
24592
24949
  opts = opts || {};
@@ -24676,7 +25033,7 @@ class GroupsApi {
24676
25033
  * @param {Array.<String>} opts.id id
24677
25034
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
24678
25035
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
24679
- * @deprecated
25036
+ * @deprecated
24680
25037
  */
24681
25038
  getProfilesGroups(opts) {
24682
25039
  opts = opts || {};
@@ -24755,8 +25112,8 @@ class GroupsApi {
24755
25112
  * Preview the number of users selected for a dynamic group definition query
24756
25113
  *
24757
25114
  * @param {Object} body Group query to preview
24758
- * @deprecated
24759
- * Preview Endpoint
25115
+ * @deprecated
25116
+ * postGroupsDynamicsettingsPreview is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24760
25117
  */
24761
25118
  postGroupsDynamicsettingsPreview(body) {
24762
25119
  // verify the required parameter 'body' is set
@@ -24837,7 +25194,7 @@ class GroupsApi {
24837
25194
  *
24838
25195
  * @param {String} groupId Group ID
24839
25196
  * @param {Object} body Create/Update dynamic groups
24840
- * Preview Endpoint
25197
+ * putGroupDynamicsettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
24841
25198
  */
24842
25199
  putGroupDynamicsettings(groupId, body) {
24843
25200
  // verify the required parameter 'groupId' is set
@@ -24869,7 +25226,7 @@ class IdentityProviderApi {
24869
25226
  /**
24870
25227
  * IdentityProvider service.
24871
25228
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
24872
- * @version 169.1.0
25229
+ * @version 170.0.0
24873
25230
  */
24874
25231
 
24875
25232
  /**
@@ -25625,7 +25982,7 @@ class InfrastructureAsCodeApi {
25625
25982
  /**
25626
25983
  * InfrastructureAsCode service.
25627
25984
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
25628
- * @version 169.1.0
25985
+ * @version 170.0.0
25629
25986
  */
25630
25987
 
25631
25988
  /**
@@ -25792,7 +26149,7 @@ class IntegrationsApi {
25792
26149
  /**
25793
26150
  * Integrations service.
25794
26151
  * @module purecloud-platform-client-v2/api/IntegrationsApi
25795
- * @version 169.1.0
26152
+ * @version 170.0.0
25796
26153
  */
25797
26154
 
25798
26155
  /**
@@ -26692,7 +27049,7 @@ class IntegrationsApi {
26692
27049
  * @param {Object} opts Optional parameters
26693
27050
  * @param {Array.<String>} opts.expand expand
26694
27051
  * @param {Object} opts.targetChannel targetChannel
26695
- * Preview Endpoint
27052
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26696
27053
  */
26697
27054
  getIntegrationsSpeechNuanceNuanceIntegrationIdBot(nuanceIntegrationId, botId, opts) {
26698
27055
  opts = opts || {};
@@ -26726,7 +27083,7 @@ class IntegrationsApi {
26726
27083
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
26727
27084
  * @param {String} botId The Nuance bot ID
26728
27085
  * @param {String} jobId The asynchronous job ID
26729
- * Preview Endpoint
27086
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26730
27087
  */
26731
27088
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJob(nuanceIntegrationId, botId, jobId) {
26732
27089
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -26762,7 +27119,7 @@ class IntegrationsApi {
26762
27119
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
26763
27120
  * @param {String} botId The Nuance bot ID
26764
27121
  * @param {String} jobId The asynchronous job ID
26765
- * Preview Endpoint
27122
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26766
27123
  */
26767
27124
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotJobResults(nuanceIntegrationId, botId, jobId) {
26768
27125
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -26800,7 +27157,7 @@ class IntegrationsApi {
26800
27157
  * @param {Number} opts.pageNumber Page number (default to 1)
26801
27158
  * @param {Number} opts.pageSize Page size (default to 25)
26802
27159
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
26803
- * Preview Endpoint
27160
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26804
27161
  */
26805
27162
  getIntegrationsSpeechNuanceNuanceIntegrationIdBots(nuanceIntegrationId, opts) {
26806
27163
  opts = opts || {};
@@ -26829,7 +27186,7 @@ class IntegrationsApi {
26829
27186
  *
26830
27187
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
26831
27188
  * @param {String} jobId The asynchronous job ID
26832
- * Preview Endpoint
27189
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26833
27190
  */
26834
27191
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJob(nuanceIntegrationId, jobId) {
26835
27192
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -26860,7 +27217,7 @@ class IntegrationsApi {
26860
27217
  *
26861
27218
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
26862
27219
  * @param {String} jobId The asynchronous job ID
26863
- * Preview Endpoint
27220
+ * getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
26864
27221
  */
26865
27222
  getIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobResults(nuanceIntegrationId, jobId) {
26866
27223
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -27483,7 +27840,7 @@ class IntegrationsApi {
27483
27840
  * @param {Object} opts Optional parameters
27484
27841
  * @param {Array.<String>} opts.expand expand
27485
27842
  * @param {String} opts.body targetChannel
27486
- * Preview Endpoint
27843
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
27487
27844
  */
27488
27845
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotJobs(nuanceIntegrationId, botId, opts) {
27489
27846
  opts = opts || {};
@@ -27519,7 +27876,7 @@ class IntegrationsApi {
27519
27876
  * @param {Number} opts.pageNumber Page number (default to 1)
27520
27877
  * @param {Number} opts.pageSize Page size (default to 25)
27521
27878
  * @param {Boolean} opts.onlyRegisteredBots Limit bots to the ones configured for Genesys Cloud usage (default to true)
27522
- * Preview Endpoint
27879
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
27523
27880
  */
27524
27881
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsJobs(nuanceIntegrationId, opts) {
27525
27882
  opts = opts || {};
@@ -27548,7 +27905,7 @@ class IntegrationsApi {
27548
27905
  *
27549
27906
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
27550
27907
  * @param {Object} settings
27551
- * Preview Endpoint
27908
+ * postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
27552
27909
  */
27553
27910
  postIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchValidate(nuanceIntegrationId, settings) {
27554
27911
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -27667,7 +28024,7 @@ class IntegrationsApi {
27667
28024
  *
27668
28025
  * @param {String} nuanceIntegrationId The integration ID for this group of bots
27669
28026
  * @param {Object} settings
27670
- * Preview Endpoint
28027
+ * putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
27671
28028
  */
27672
28029
  putIntegrationsSpeechNuanceNuanceIntegrationIdBotsLaunchSettings(nuanceIntegrationId, settings) {
27673
28030
  // verify the required parameter 'nuanceIntegrationId' is set
@@ -27718,13 +28075,43 @@ class IntegrationsApi {
27718
28075
  );
27719
28076
  }
27720
28077
 
28078
+ /**
28079
+ * Bulk integration presence ingestion
28080
+ * 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.
28081
+ * @param {String} ucIntegrationId UC Integration ID
28082
+ * @param {Array.<Object>} body List of User presences
28083
+ */
28084
+ putIntegrationsUnifiedcommunicationThirdpartypresences(ucIntegrationId, body) {
28085
+ // verify the required parameter 'ucIntegrationId' is set
28086
+ if (ucIntegrationId === undefined || ucIntegrationId === null) {
28087
+ throw 'Missing the required parameter "ucIntegrationId" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
28088
+ }
28089
+ // verify the required parameter 'body' is set
28090
+ if (body === undefined || body === null) {
28091
+ throw 'Missing the required parameter "body" when calling putIntegrationsUnifiedcommunicationThirdpartypresences';
28092
+ }
28093
+
28094
+ return this.apiClient.callApi(
28095
+ '/api/v2/integrations/unifiedcommunications/{ucIntegrationId}/thirdpartypresences',
28096
+ 'PUT',
28097
+ { 'ucIntegrationId': ucIntegrationId },
28098
+ { },
28099
+ { },
28100
+ { },
28101
+ body,
28102
+ ['PureCloud OAuth'],
28103
+ ['application/json'],
28104
+ ['application/json']
28105
+ );
28106
+ }
28107
+
27721
28108
  }
27722
28109
 
27723
28110
  class JourneyApi {
27724
28111
  /**
27725
28112
  * Journey service.
27726
28113
  * @module purecloud-platform-client-v2/api/JourneyApi
27727
- * @version 169.1.0
28114
+ * @version 170.0.0
27728
28115
  */
27729
28116
 
27730
28117
  /**
@@ -27872,7 +28259,7 @@ class JourneyApi {
27872
28259
  * Get status for async query for journey aggregates
27873
28260
  *
27874
28261
  * @param {String} jobId jobId
27875
- * Preview Endpoint
28262
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
27876
28263
  */
27877
28264
  getAnalyticsJourneysAggregatesJob(jobId) {
27878
28265
  // verify the required parameter 'jobId' is set
@@ -27900,7 +28287,7 @@ class JourneyApi {
27900
28287
  * @param {String} jobId jobId
27901
28288
  * @param {Object} opts Optional parameters
27902
28289
  * @param {String} opts.cursor Cursor token to retrieve next page
27903
- * Preview Endpoint
28290
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
27904
28291
  */
27905
28292
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
27906
28293
  opts = opts || {};
@@ -28135,42 +28522,6 @@ class JourneyApi {
28135
28522
  );
28136
28523
  }
28137
28524
 
28138
- /**
28139
- * Retrieve all sessions for a given customer.
28140
- *
28141
- * @param {String} customerIdType Type of ID used to identify customer (e.g. email, cookie, and phone).
28142
- * @param {String} customerId Primary identifier of the customer in the source of the session.
28143
- * @param {Object} opts Optional parameters
28144
- * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28145
- * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
28146
- * Preview Endpoint
28147
- */
28148
- getJourneyCustomerCustomerIdSessions(customerIdType, customerId, opts) {
28149
- opts = opts || {};
28150
-
28151
- // verify the required parameter 'customerIdType' is set
28152
- if (customerIdType === undefined || customerIdType === null) {
28153
- throw 'Missing the required parameter "customerIdType" when calling getJourneyCustomerCustomerIdSessions';
28154
- }
28155
- // verify the required parameter 'customerId' is set
28156
- if (customerId === undefined || customerId === null) {
28157
- throw 'Missing the required parameter "customerId" when calling getJourneyCustomerCustomerIdSessions';
28158
- }
28159
-
28160
- return this.apiClient.callApi(
28161
- '/api/v2/journey/customers/{customerIdType}/{customerId}/sessions',
28162
- 'GET',
28163
- { 'customerIdType': customerIdType,'customerId': customerId },
28164
- { 'pageSize': opts['pageSize'],'after': opts['after'] },
28165
- { },
28166
- { },
28167
- null,
28168
- ['PureCloud OAuth'],
28169
- ['application/json'],
28170
- ['application/json']
28171
- );
28172
- }
28173
-
28174
28525
  /**
28175
28526
  * Retrieve a single outcome.
28176
28527
  *
@@ -28229,7 +28580,7 @@ class JourneyApi {
28229
28580
  * Get job status.
28230
28581
  *
28231
28582
  * @param {String} jobId ID of the job.
28232
- * Preview Endpoint
28583
+ * getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28233
28584
  */
28234
28585
  getJourneyOutcomesAttributionsJob(jobId) {
28235
28586
  // verify the required parameter 'jobId' is set
@@ -28255,7 +28606,7 @@ class JourneyApi {
28255
28606
  * Get outcome attribution entities from completed job.
28256
28607
  *
28257
28608
  * @param {String} jobId ID of the job.
28258
- * Preview Endpoint
28609
+ * getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28259
28610
  */
28260
28611
  getJourneyOutcomesAttributionsJobResults(jobId) {
28261
28612
  // verify the required parameter 'jobId' is set
@@ -28409,7 +28760,7 @@ class JourneyApi {
28409
28760
  * @param {Object} opts Optional parameters
28410
28761
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28411
28762
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
28412
- * Preview Endpoint
28763
+ * getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28413
28764
  */
28414
28765
  getJourneySessionEvents(sessionId, opts) {
28415
28766
  opts = opts || {};
@@ -28467,7 +28818,7 @@ class JourneyApi {
28467
28818
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
28468
28819
  * @param {Object} opts.segmentScope Scope to filter on. If not specified, both session-scoped and customer-scoped assignments are returned.
28469
28820
  * @param {Object} opts.assignmentState Assignment state to filter on. If not specified, both assigned and unassigned assignments are returned.
28470
- * Preview Endpoint
28821
+ * getJourneySessionSegments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28471
28822
  */
28472
28823
  getJourneySessionSegments(sessionId, opts) {
28473
28824
  opts = opts || {};
@@ -28640,7 +28991,7 @@ class JourneyApi {
28640
28991
  * Query for journey aggregates asynchronously
28641
28992
  *
28642
28993
  * @param {Object} body query
28643
- * Preview Endpoint
28994
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28644
28995
  */
28645
28996
  postAnalyticsJourneysAggregatesJobs(body) {
28646
28997
  // verify the required parameter 'body' is set
@@ -28789,7 +29140,7 @@ class JourneyApi {
28789
29140
  *
28790
29141
  * @param {Object} opts Optional parameters
28791
29142
  * @param {Object} opts.body outcome attribution request
28792
- * Preview Endpoint
29143
+ * postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28793
29144
  */
28794
29145
  postJourneyOutcomesAttributionsJobs(opts) {
28795
29146
  opts = opts || {};
@@ -28863,7 +29214,7 @@ class KnowledgeApi {
28863
29214
  /**
28864
29215
  * Knowledge service.
28865
29216
  * @module purecloud-platform-client-v2/api/KnowledgeApi
28866
- * @version 169.1.0
29217
+ * @version 170.0.0
28867
29218
  */
28868
29219
 
28869
29220
  /**
@@ -29094,7 +29445,7 @@ class KnowledgeApi {
29094
29445
  * @param {String} categoryId Category ID
29095
29446
  * @param {String} knowledgeBaseId Knowledge base ID
29096
29447
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29097
- * @deprecated
29448
+ * @deprecated
29098
29449
  */
29099
29450
  deleteKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
29100
29451
  // verify the required parameter 'categoryId' is set
@@ -29130,7 +29481,7 @@ class KnowledgeApi {
29130
29481
  * @param {String} documentId Document ID
29131
29482
  * @param {String} knowledgeBaseId Knowledge base ID
29132
29483
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29133
- * @deprecated
29484
+ * @deprecated
29134
29485
  */
29135
29486
  deleteKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
29136
29487
  // verify the required parameter 'documentId' is set
@@ -29166,7 +29517,7 @@ class KnowledgeApi {
29166
29517
  * @param {String} knowledgeBaseId Knowledge base ID
29167
29518
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29168
29519
  * @param {String} importId Import ID
29169
- * @deprecated
29520
+ * @deprecated
29170
29521
  */
29171
29522
  deleteKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
29172
29523
  // verify the required parameter 'knowledgeBaseId' is set
@@ -29668,6 +30019,7 @@ class KnowledgeApi {
29668
30019
  * @param {Boolean} opts.includeDrafts If includeDrafts is true, Documents in the draft state are also returned in the response.
29669
30020
  * @param {Array.<String>} opts.labelIds If specified, retrieves documents associated with label ids, comma separated values expected.
29670
30021
  * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
30022
+ * @param {Array.<String>} opts.externalIds If specified, retrieves documents associated with external ids, comma separated values expected.
29671
30023
  */
29672
30024
  getKnowledgeKnowledgebaseDocuments(knowledgeBaseId, opts) {
29673
30025
  opts = opts || {};
@@ -29681,7 +30033,7 @@ class KnowledgeApi {
29681
30033
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents',
29682
30034
  'GET',
29683
30035
  { 'knowledgeBaseId': knowledgeBaseId },
29684
- { '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') },
30036
+ { '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') },
29685
30037
  { },
29686
30038
  { },
29687
30039
  null,
@@ -29825,7 +30177,7 @@ class KnowledgeApi {
29825
30177
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
29826
30178
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
29827
30179
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
29828
- * @deprecated
30180
+ * @deprecated
29829
30181
  */
29830
30182
  getKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, opts) {
29831
30183
  opts = opts || {};
@@ -29859,7 +30211,7 @@ class KnowledgeApi {
29859
30211
  * @param {String} categoryId Category ID
29860
30212
  * @param {String} knowledgeBaseId Knowledge base ID
29861
30213
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29862
- * @deprecated
30214
+ * @deprecated
29863
30215
  */
29864
30216
  getKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode) {
29865
30217
  // verify the required parameter 'categoryId' is set
@@ -29895,7 +30247,7 @@ class KnowledgeApi {
29895
30247
  * @param {String} documentId Document ID
29896
30248
  * @param {String} knowledgeBaseId Knowledge base ID
29897
30249
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29898
- * @deprecated
30250
+ * @deprecated
29899
30251
  */
29900
30252
  getKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode) {
29901
30253
  // verify the required parameter 'documentId' is set
@@ -29932,8 +30284,8 @@ class KnowledgeApi {
29932
30284
  * @param {String} knowledgeBaseId Knowledge base ID
29933
30285
  * @param {Object} languageCode Language code, format: iso2-LOCALE
29934
30286
  * @param {String} uploadId UploadId
29935
- * @deprecated
29936
- * Preview Endpoint
30287
+ * @deprecated
30288
+ * getKnowledgeKnowledgebaseLanguageDocumentUpload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
29937
30289
  */
29938
30290
  getKnowledgeKnowledgebaseLanguageDocumentUpload(documentId, knowledgeBaseId, languageCode, uploadId) {
29939
30291
  // verify the required parameter 'documentId' is set
@@ -29982,7 +30334,7 @@ class KnowledgeApi {
29982
30334
  * @param {Object} opts.sortBy Sort by.
29983
30335
  * @param {Object} opts.sortOrder Sort Order.
29984
30336
  * @param {Array.<String>} opts.documentIds Comma-separated list of document identifiers to fetch by.
29985
- * @deprecated
30337
+ * @deprecated
29986
30338
  */
29987
30339
  getKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, opts) {
29988
30340
  opts = opts || {};
@@ -30016,7 +30368,7 @@ class KnowledgeApi {
30016
30368
  * @param {String} knowledgeBaseId Knowledge base ID
30017
30369
  * @param {Object} languageCode Language code, format: iso2-LOCALE
30018
30370
  * @param {String} importId Import ID
30019
- * @deprecated
30371
+ * @deprecated
30020
30372
  */
30021
30373
  getKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId) {
30022
30374
  // verify the required parameter 'knowledgeBaseId' is set
@@ -30052,7 +30404,7 @@ class KnowledgeApi {
30052
30404
  * @param {String} knowledgeBaseId Knowledge base ID
30053
30405
  * @param {Object} languageCode Language code, format: iso2-LOCALE
30054
30406
  * @param {String} trainingId Training ID
30055
- * @deprecated
30407
+ * @deprecated
30056
30408
  */
30057
30409
  getKnowledgeKnowledgebaseLanguageTraining(knowledgeBaseId, languageCode, trainingId) {
30058
30410
  // verify the required parameter 'knowledgeBaseId' is set
@@ -30093,7 +30445,7 @@ class KnowledgeApi {
30093
30445
  * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
30094
30446
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
30095
30447
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
30096
- * @deprecated
30448
+ * @deprecated
30097
30449
  */
30098
30450
  getKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode, opts) {
30099
30451
  opts = opts || {};
@@ -30541,7 +30893,7 @@ class KnowledgeApi {
30541
30893
  * @param {String} knowledgeBaseId Knowledge base ID
30542
30894
  * @param {Object} languageCode Language code, format: iso2-LOCALE
30543
30895
  * @param {Object} body
30544
- * @deprecated
30896
+ * @deprecated
30545
30897
  */
30546
30898
  patchKnowledgeKnowledgebaseLanguageCategory(categoryId, knowledgeBaseId, languageCode, body) {
30547
30899
  // verify the required parameter 'categoryId' is set
@@ -30582,7 +30934,7 @@ class KnowledgeApi {
30582
30934
  * @param {String} knowledgeBaseId Knowledge base ID
30583
30935
  * @param {Object} languageCode Language code, format: iso2-LOCALE
30584
30936
  * @param {Object} body
30585
- * @deprecated
30937
+ * @deprecated
30586
30938
  */
30587
30939
  patchKnowledgeKnowledgebaseLanguageDocument(documentId, knowledgeBaseId, languageCode, body) {
30588
30940
  // verify the required parameter 'documentId' is set
@@ -30622,7 +30974,7 @@ class KnowledgeApi {
30622
30974
  * @param {String} knowledgeBaseId Knowledge base ID
30623
30975
  * @param {Object} languageCode Language code, format: iso2-LOCALE
30624
30976
  * @param {Array.<Object>} body
30625
- * @deprecated
30977
+ * @deprecated
30626
30978
  */
30627
30979
  patchKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
30628
30980
  // verify the required parameter 'knowledgeBaseId' is set
@@ -30659,7 +31011,7 @@ class KnowledgeApi {
30659
31011
  * @param {Object} languageCode Language code, format: iso2-LOCALE
30660
31012
  * @param {String} importId Import ID
30661
31013
  * @param {Object} body
30662
- * @deprecated
31014
+ * @deprecated
30663
31015
  */
30664
31016
  patchKnowledgeKnowledgebaseLanguageDocumentsImport(knowledgeBaseId, languageCode, importId, body) {
30665
31017
  // verify the required parameter 'knowledgeBaseId' is set
@@ -30977,7 +31329,7 @@ class KnowledgeApi {
30977
31329
  *
30978
31330
  * @param {String} knowledgeBaseId Knowledge base ID
30979
31331
  * @param {Object} body
30980
- * Preview Endpoint
31332
+ * postKnowledgeKnowledgebaseDocumentsBulkRemove is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30981
31333
  */
30982
31334
  postKnowledgeKnowledgebaseDocumentsBulkRemove(knowledgeBaseId, body) {
30983
31335
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31008,7 +31360,7 @@ class KnowledgeApi {
31008
31360
  *
31009
31361
  * @param {String} knowledgeBaseId Knowledge base ID
31010
31362
  * @param {Object} body
31011
- * Preview Endpoint
31363
+ * postKnowledgeKnowledgebaseDocumentsBulkUpdate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31012
31364
  */
31013
31365
  postKnowledgeKnowledgebaseDocumentsBulkUpdate(knowledgeBaseId, body) {
31014
31366
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31098,7 +31450,7 @@ class KnowledgeApi {
31098
31450
  *
31099
31451
  * @param {String} knowledgeBaseId Knowledge base ID
31100
31452
  * @param {Object} body
31101
- * Preview Endpoint
31453
+ * postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31102
31454
  */
31103
31455
  postKnowledgeKnowledgebaseDocumentsVersionsBulkAdd(knowledgeBaseId, body) {
31104
31456
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31220,7 +31572,7 @@ class KnowledgeApi {
31220
31572
  * @param {String} knowledgeBaseId Knowledge base ID
31221
31573
  * @param {Object} languageCode Language code, format: iso2-LOCALE
31222
31574
  * @param {Object} body
31223
- * @deprecated
31575
+ * @deprecated
31224
31576
  */
31225
31577
  postKnowledgeKnowledgebaseLanguageCategories(knowledgeBaseId, languageCode, body) {
31226
31578
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31257,8 +31609,8 @@ class KnowledgeApi {
31257
31609
  * @param {String} knowledgeBaseId Knowledge base ID
31258
31610
  * @param {Object} languageCode Language code, format: iso2-LOCALE
31259
31611
  * @param {Object} body
31260
- * @deprecated
31261
- * Preview Endpoint
31612
+ * @deprecated
31613
+ * postKnowledgeKnowledgebaseLanguageDocumentUploads is a preview method and is subject to both breaking and non-breaking changes at any time without notice
31262
31614
  */
31263
31615
  postKnowledgeKnowledgebaseLanguageDocumentUploads(documentId, knowledgeBaseId, languageCode, body) {
31264
31616
  // verify the required parameter 'documentId' is set
@@ -31298,7 +31650,7 @@ class KnowledgeApi {
31298
31650
  * @param {String} knowledgeBaseId Knowledge base ID
31299
31651
  * @param {Object} languageCode Language code, format: iso2-LOCALE
31300
31652
  * @param {Object} body
31301
- * @deprecated
31653
+ * @deprecated
31302
31654
  */
31303
31655
  postKnowledgeKnowledgebaseLanguageDocuments(knowledgeBaseId, languageCode, body) {
31304
31656
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31334,7 +31686,7 @@ class KnowledgeApi {
31334
31686
  * @param {String} knowledgeBaseId Knowledge base ID
31335
31687
  * @param {Object} languageCode Language code, format: iso2-LOCALE
31336
31688
  * @param {Object} body
31337
- * @deprecated
31689
+ * @deprecated
31338
31690
  */
31339
31691
  postKnowledgeKnowledgebaseLanguageDocumentsImports(knowledgeBaseId, languageCode, body) {
31340
31692
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31370,7 +31722,7 @@ class KnowledgeApi {
31370
31722
  * @param {String} knowledgeBaseId Knowledge base ID
31371
31723
  * @param {Object} languageCode Language code, format: iso2-LOCALE
31372
31724
  * @param {String} trainingId Training ID
31373
- * @deprecated
31725
+ * @deprecated
31374
31726
  */
31375
31727
  postKnowledgeKnowledgebaseLanguageTrainingPromote(knowledgeBaseId, languageCode, trainingId) {
31376
31728
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31405,7 +31757,7 @@ class KnowledgeApi {
31405
31757
  *
31406
31758
  * @param {String} knowledgeBaseId Knowledge base ID
31407
31759
  * @param {Object} languageCode Language code, format: iso2-LOCALE
31408
- * @deprecated
31760
+ * @deprecated
31409
31761
  */
31410
31762
  postKnowledgeKnowledgebaseLanguageTrainings(knowledgeBaseId, languageCode) {
31411
31763
  // verify the required parameter 'knowledgeBaseId' is set
@@ -31437,7 +31789,7 @@ class KnowledgeApi {
31437
31789
  * @param {String} knowledgeBaseId Knowledge base ID
31438
31790
  * @param {Object} opts Optional parameters
31439
31791
  * @param {Object} opts.body
31440
- * @deprecated
31792
+ * @deprecated
31441
31793
  */
31442
31794
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
31443
31795
  opts = opts || {};
@@ -31492,7 +31844,7 @@ class LanguageUnderstandingApi {
31492
31844
  /**
31493
31845
  * LanguageUnderstanding service.
31494
31846
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
31495
- * @version 169.1.0
31847
+ * @version 170.0.0
31496
31848
  */
31497
31849
 
31498
31850
  /**
@@ -32505,7 +32857,7 @@ class LanguagesApi {
32505
32857
  /**
32506
32858
  * Languages service.
32507
32859
  * @module purecloud-platform-client-v2/api/LanguagesApi
32508
- * @version 169.1.0
32860
+ * @version 170.0.0
32509
32861
  */
32510
32862
 
32511
32863
  /**
@@ -32524,7 +32876,7 @@ class LanguagesApi {
32524
32876
  * Delete Language (Deprecated)
32525
32877
  * This endpoint is deprecated. Please see the Routing API (DELETE /api/v2/routing/languages/{languageId})
32526
32878
  * @param {String} languageId Language ID
32527
- * @deprecated
32879
+ * @deprecated
32528
32880
  */
32529
32881
  deleteLanguage(languageId) {
32530
32882
  // verify the required parameter 'languageId' is set
@@ -32550,7 +32902,7 @@ class LanguagesApi {
32550
32902
  * Get Language (Deprecated)
32551
32903
  * This endpoint is deprecated. Please see the Routing API (GET /api/v2/routing/languages/{languageId})
32552
32904
  * @param {String} languageId Language ID
32553
- * @deprecated
32905
+ * @deprecated
32554
32906
  */
32555
32907
  getLanguage(languageId) {
32556
32908
  // verify the required parameter 'languageId' is set
@@ -32580,7 +32932,7 @@ class LanguagesApi {
32580
32932
  * @param {Number} opts.pageNumber Page number (default to 1)
32581
32933
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
32582
32934
  * @param {String} opts.name Name
32583
- * @deprecated
32935
+ * @deprecated
32584
32936
  */
32585
32937
  getLanguages(opts) {
32586
32938
  opts = opts || {};
@@ -32699,7 +33051,7 @@ class LanguagesApi {
32699
33051
  * Create Language (Deprecated)
32700
33052
  * This endpoint is deprecated. Please see the Routing API. (POST /api/v2/routing/languages
32701
33053
  * @param {Object} body Language
32702
- * @deprecated
33054
+ * @deprecated
32703
33055
  */
32704
33056
  postLanguages(body) {
32705
33057
  // verify the required parameter 'body' is set
@@ -32727,7 +33079,7 @@ class LearningApi {
32727
33079
  /**
32728
33080
  * Learning service.
32729
33081
  * @module purecloud-platform-client-v2/api/LearningApi
32730
- * @version 169.1.0
33082
+ * @version 170.0.0
32731
33083
  */
32732
33084
 
32733
33085
  /**
@@ -33542,7 +33894,7 @@ class LicenseApi {
33542
33894
  /**
33543
33895
  * License service.
33544
33896
  * @module purecloud-platform-client-v2/api/LicenseApi
33545
- * @version 169.1.0
33897
+ * @version 170.0.0
33546
33898
  */
33547
33899
 
33548
33900
  /**
@@ -33780,7 +34132,7 @@ class LocationsApi {
33780
34132
  /**
33781
34133
  * Locations service.
33782
34134
  * @module purecloud-platform-client-v2/api/LocationsApi
33783
- * @version 169.1.0
34135
+ * @version 170.0.0
33784
34136
  */
33785
34137
 
33786
34138
  /**
@@ -34016,7 +34368,7 @@ class MessagingApi {
34016
34368
  /**
34017
34369
  * Messaging service.
34018
34370
  * @module purecloud-platform-client-v2/api/MessagingApi
34019
- * @version 169.1.0
34371
+ * @version 170.0.0
34020
34372
  */
34021
34373
 
34022
34374
  /**
@@ -34035,7 +34387,7 @@ class MessagingApi {
34035
34387
  * Delete a supported content profile
34036
34388
  * Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
34037
34389
  * @param {String} supportedContentId Supported Content ID
34038
- * @deprecated
34390
+ * @deprecated
34039
34391
  */
34040
34392
  deleteMessagingSupportedcontentSupportedContentId(supportedContentId) {
34041
34393
  // verify the required parameter 'supportedContentId' is set
@@ -34063,7 +34415,7 @@ class MessagingApi {
34063
34415
  * @param {Object} opts Optional parameters
34064
34416
  * @param {Number} opts.pageSize Page size (default to 25)
34065
34417
  * @param {Number} opts.pageNumber Page number (default to 1)
34066
- * @deprecated
34418
+ * @deprecated
34067
34419
  */
34068
34420
  getMessagingSupportedcontent(opts) {
34069
34421
  opts = opts || {};
@@ -34087,7 +34439,7 @@ class MessagingApi {
34087
34439
  * Get a supported content profile
34088
34440
  * Deprecated - use GET /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
34089
34441
  * @param {String} supportedContentId Supported Content ID
34090
- * @deprecated
34442
+ * @deprecated
34091
34443
  */
34092
34444
  getMessagingSupportedcontentSupportedContentId(supportedContentId) {
34093
34445
  // verify the required parameter 'supportedContentId' is set
@@ -34114,7 +34466,7 @@ class MessagingApi {
34114
34466
  * Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
34115
34467
  * @param {String} supportedContentId Supported Content ID
34116
34468
  * @param {Object} body SupportedContent
34117
- * @deprecated
34469
+ * @deprecated
34118
34470
  */
34119
34471
  patchMessagingSupportedcontentSupportedContentId(supportedContentId, body) {
34120
34472
  // verify the required parameter 'supportedContentId' is set
@@ -34144,7 +34496,7 @@ class MessagingApi {
34144
34496
  * Create a Supported Content profile
34145
34497
  * Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
34146
34498
  * @param {Object} body SupportedContent
34147
- * @deprecated
34499
+ * @deprecated
34148
34500
  */
34149
34501
  postMessagingSupportedcontent(body) {
34150
34502
  // verify the required parameter 'body' is set
@@ -34172,7 +34524,7 @@ class MobileDevicesApi {
34172
34524
  /**
34173
34525
  * MobileDevices service.
34174
34526
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
34175
- * @version 169.1.0
34527
+ * @version 170.0.0
34176
34528
  */
34177
34529
 
34178
34530
  /**
@@ -34323,7 +34675,7 @@ class NotificationsApi {
34323
34675
  /**
34324
34676
  * Notifications service.
34325
34677
  * @module purecloud-platform-client-v2/api/NotificationsApi
34326
- * @version 169.1.0
34678
+ * @version 170.0.0
34327
34679
  */
34328
34680
 
34329
34681
  /**
@@ -34556,7 +34908,7 @@ class OAuthApi {
34556
34908
  /**
34557
34909
  * OAuth service.
34558
34910
  * @module purecloud-platform-client-v2/api/OAuthApi
34559
- * @version 169.1.0
34911
+ * @version 170.0.0
34560
34912
  */
34561
34913
 
34562
34914
  /**
@@ -34922,7 +35274,7 @@ class ObjectsApi {
34922
35274
  /**
34923
35275
  * Objects service.
34924
35276
  * @module purecloud-platform-client-v2/api/ObjectsApi
34925
- * @version 169.1.0
35277
+ * @version 170.0.0
34926
35278
  */
34927
35279
 
34928
35280
  /**
@@ -35193,7 +35545,7 @@ class OrganizationApi {
35193
35545
  /**
35194
35546
  * Organization service.
35195
35547
  * @module purecloud-platform-client-v2/api/OrganizationApi
35196
- * @version 169.1.0
35548
+ * @version 170.0.0
35197
35549
  */
35198
35550
 
35199
35551
  /**
@@ -35212,7 +35564,7 @@ class OrganizationApi {
35212
35564
  * Fetch field config for an entity type
35213
35565
  *
35214
35566
  * @param {Object} type Field type
35215
- * @deprecated
35567
+ * @deprecated
35216
35568
  */
35217
35569
  getFieldconfig(type) {
35218
35570
  // verify the required parameter 'type' is set
@@ -35257,7 +35609,7 @@ class OrganizationApi {
35257
35609
  /**
35258
35610
  * Get the list of domains that will be allowed to embed PureCloud applications
35259
35611
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
35260
- * @deprecated
35612
+ * @deprecated
35261
35613
  */
35262
35614
  getOrganizationsEmbeddedintegration() {
35263
35615
 
@@ -35278,7 +35630,7 @@ class OrganizationApi {
35278
35630
  /**
35279
35631
  * Get organization IP address whitelist settings
35280
35632
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
35281
- * @deprecated
35633
+ * @deprecated
35282
35634
  */
35283
35635
  getOrganizationsIpaddressauthentication() {
35284
35636
 
@@ -35467,7 +35819,7 @@ class OrganizationApi {
35467
35819
  /**
35468
35820
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
35469
35821
  *
35470
- * @deprecated
35822
+ * @deprecated
35471
35823
  */
35472
35824
  getOrganizationsWhitelist() {
35473
35825
 
@@ -35544,7 +35896,7 @@ class OrganizationApi {
35544
35896
  * Update the list of domains that will be allowed to embed PureCloud applications
35545
35897
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
35546
35898
  * @param {Object} body Whitelist settings
35547
- * @deprecated
35899
+ * @deprecated
35548
35900
  */
35549
35901
  putOrganizationsEmbeddedintegration(body) {
35550
35902
  // verify the required parameter 'body' is set
@@ -35570,7 +35922,7 @@ class OrganizationApi {
35570
35922
  * Update organization IP address whitelist settings
35571
35923
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
35572
35924
  * @param {Object} body IP address Whitelist settings
35573
- * @deprecated
35925
+ * @deprecated
35574
35926
  */
35575
35927
  putOrganizationsIpaddressauthentication(body) {
35576
35928
  // verify the required parameter 'body' is set
@@ -35620,7 +35972,7 @@ class OrganizationApi {
35620
35972
  * This route is deprecated, please use /api/v2/organizations/authentication/settings instead
35621
35973
  *
35622
35974
  * @param {Object} body Whitelist settings
35623
- * @deprecated
35975
+ * @deprecated
35624
35976
  */
35625
35977
  putOrganizationsWhitelist(body) {
35626
35978
  // verify the required parameter 'body' is set
@@ -35648,7 +36000,7 @@ class OrganizationAuthorizationApi {
35648
36000
  /**
35649
36001
  * OrganizationAuthorization service.
35650
36002
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
35651
- * @version 169.1.0
36003
+ * @version 170.0.0
35652
36004
  */
35653
36005
 
35654
36006
  /**
@@ -35842,7 +36194,7 @@ class OrganizationAuthorizationApi {
35842
36194
  * Delete Bulk Org Trustees
35843
36195
  *
35844
36196
  * @param {Array.<String>} id Comma separated list of trustee ids to remove
35845
- * Preview Endpoint
36197
+ * deleteOrgauthorizationTrustees is a preview method and is subject to both breaking and non-breaking changes at any time without notice
35846
36198
  */
35847
36199
  deleteOrgauthorizationTrustees(id) {
35848
36200
  // verify the required parameter 'id' is set
@@ -35983,7 +36335,7 @@ class OrganizationAuthorizationApi {
35983
36335
  * Delete Bulk Org Trustors
35984
36336
  *
35985
36337
  * @param {Array.<String>} id Comma separated list of trustor ids to remove
35986
- * Preview Endpoint
36338
+ * deleteOrgauthorizationTrustors is a preview method and is subject to both breaking and non-breaking changes at any time without notice
35987
36339
  */
35988
36340
  deleteOrgauthorizationTrustors(id) {
35989
36341
  // verify the required parameter 'id' is set
@@ -36995,7 +37347,7 @@ class OutboundApi {
36995
37347
  /**
36996
37348
  * Outbound service.
36997
37349
  * @module purecloud-platform-client-v2/api/OutboundApi
36998
- * @version 169.1.0
37350
+ * @version 170.0.0
36999
37351
  */
37000
37352
 
37001
37353
  /**
@@ -39480,7 +39832,7 @@ class OutboundApi {
39480
39832
  * This endpoint is deprecated and may have unexpected results. Please use "/conversations/{conversationId}/participants/{participantId}/callbacks instead."
39481
39833
  * @param {String} campaignId Campaign ID
39482
39834
  * @param {Object} body ContactCallbackRequest
39483
- * @deprecated
39835
+ * @deprecated
39484
39836
  */
39485
39837
  postOutboundCampaignCallbackSchedule(campaignId, body) {
39486
39838
  // verify the required parameter 'campaignId' is set
@@ -40617,7 +40969,7 @@ class PresenceApi {
40617
40969
  /**
40618
40970
  * Presence service.
40619
40971
  * @module purecloud-platform-client-v2/api/PresenceApi
40620
- * @version 169.1.0
40972
+ * @version 170.0.0
40621
40973
  */
40622
40974
 
40623
40975
  /**
@@ -40636,12 +40988,12 @@ class PresenceApi {
40636
40988
  * Delete a Presence Definition
40637
40989
  *
40638
40990
  * @param {String} definitionId Presence Definition ID
40639
- * Preview Endpoint
40991
+ * deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
40640
40992
  */
40641
- deletePresenceDefinition(definitionId) {
40993
+ deletePresenceDefinition0(definitionId) {
40642
40994
  // verify the required parameter 'definitionId' is set
40643
40995
  if (definitionId === undefined || definitionId === null) {
40644
- throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition';
40996
+ throw 'Missing the required parameter "definitionId" when calling deletePresenceDefinition0';
40645
40997
  }
40646
40998
 
40647
40999
  return this.apiClient.callApi(
@@ -40712,12 +41064,12 @@ class PresenceApi {
40712
41064
  * Get a Presence Definition
40713
41065
  *
40714
41066
  * @param {String} definitionId Presence Definition ID
40715
- * Preview Endpoint
41067
+ * getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
40716
41068
  */
40717
- getPresenceDefinition(definitionId) {
41069
+ getPresenceDefinition0(definitionId) {
40718
41070
  // verify the required parameter 'definitionId' is set
40719
41071
  if (definitionId === undefined || definitionId === null) {
40720
- throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition';
41072
+ throw 'Missing the required parameter "definitionId" when calling getPresenceDefinition0';
40721
41073
  }
40722
41074
 
40723
41075
  return this.apiClient.callApi(
@@ -40740,9 +41092,9 @@ class PresenceApi {
40740
41092
  * @param {Object} opts Optional parameters
40741
41093
  * @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
40742
41094
  * @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.
40743
- * Preview Endpoint
41095
+ * getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
40744
41096
  */
40745
- getPresenceDefinitions(opts) {
41097
+ getPresenceDefinitions0(opts) {
40746
41098
  opts = opts || {};
40747
41099
 
40748
41100
 
@@ -40985,6 +41337,59 @@ class PresenceApi {
40985
41337
  );
40986
41338
  }
40987
41339
 
41340
+ /**
41341
+ * Get bulk user presences for a single presence source
41342
+ *
41343
+ * @param {String} sourceId The requested presence source ID.
41344
+ * @param {Object} opts Optional parameters
41345
+ * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
41346
+ */
41347
+ getUsersPresenceBulk(sourceId, opts) {
41348
+ opts = opts || {};
41349
+
41350
+ // verify the required parameter 'sourceId' is set
41351
+ if (sourceId === undefined || sourceId === null) {
41352
+ throw 'Missing the required parameter "sourceId" when calling getUsersPresenceBulk';
41353
+ }
41354
+
41355
+ return this.apiClient.callApi(
41356
+ '/api/v2/users/presences/{sourceId}/bulk',
41357
+ 'GET',
41358
+ { 'sourceId': sourceId },
41359
+ { 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
41360
+ { },
41361
+ { },
41362
+ null,
41363
+ ['PureCloud OAuth'],
41364
+ ['application/json'],
41365
+ ['application/json']
41366
+ );
41367
+ }
41368
+
41369
+ /**
41370
+ * Get bulk user presences for a Genesys Cloud (PURECLOUD) presence source
41371
+ *
41372
+ * @param {Object} opts Optional parameters
41373
+ * @param {Array.<String>} opts.id A comma separated list of user IDs to fetch their presence status in bulk. Limit 50.
41374
+ */
41375
+ getUsersPresencesPurecloudBulk(opts) {
41376
+ opts = opts || {};
41377
+
41378
+
41379
+ return this.apiClient.callApi(
41380
+ '/api/v2/users/presences/purecloud/bulk',
41381
+ 'GET',
41382
+ { },
41383
+ { 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
41384
+ { },
41385
+ { },
41386
+ null,
41387
+ ['PureCloud OAuth'],
41388
+ ['application/json'],
41389
+ ['application/json']
41390
+ );
41391
+ }
41392
+
40988
41393
  /**
40989
41394
  * Patch a user's Presence
40990
41395
  * 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.
@@ -41054,12 +41459,12 @@ class PresenceApi {
41054
41459
  * Create a Presence Definition
41055
41460
  *
41056
41461
  * @param {Object} body The Presence Definition to create
41057
- * Preview Endpoint
41462
+ * postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41058
41463
  */
41059
- postPresenceDefinitions(body) {
41464
+ postPresenceDefinitions0(body) {
41060
41465
  // verify the required parameter 'body' is set
41061
41466
  if (body === undefined || body === null) {
41062
- throw 'Missing the required parameter "body" when calling postPresenceDefinitions';
41467
+ throw 'Missing the required parameter "body" when calling postPresenceDefinitions0';
41063
41468
  }
41064
41469
 
41065
41470
  return this.apiClient.callApi(
@@ -41131,16 +41536,16 @@ class PresenceApi {
41131
41536
  *
41132
41537
  * @param {String} definitionId Presence Definition ID
41133
41538
  * @param {Object} body The updated Presence Definition
41134
- * Preview Endpoint
41539
+ * putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41135
41540
  */
41136
- putPresenceDefinition(definitionId, body) {
41541
+ putPresenceDefinition0(definitionId, body) {
41137
41542
  // verify the required parameter 'definitionId' is set
41138
41543
  if (definitionId === undefined || definitionId === null) {
41139
- throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition';
41544
+ throw 'Missing the required parameter "definitionId" when calling putPresenceDefinition0';
41140
41545
  }
41141
41546
  // verify the required parameter 'body' is set
41142
41547
  if (body === undefined || body === null) {
41143
- throw 'Missing the required parameter "body" when calling putPresenceDefinition';
41548
+ throw 'Missing the required parameter "body" when calling putPresenceDefinition0';
41144
41549
  }
41145
41550
 
41146
41551
  return this.apiClient.callApi(
@@ -41303,7 +41708,7 @@ class ProcessAutomationApi {
41303
41708
  /**
41304
41709
  * ProcessAutomation service.
41305
41710
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
41306
- * @version 169.1.0
41711
+ * @version 170.0.0
41307
41712
  */
41308
41713
 
41309
41714
  /**
@@ -41542,7 +41947,7 @@ class QualityApi {
41542
41947
  /**
41543
41948
  * Quality service.
41544
41949
  * @module purecloud-platform-client-v2/api/QualityApi
41545
- * @version 169.1.0
41950
+ * @version 170.0.0
41546
41951
  */
41547
41952
 
41548
41953
  /**
@@ -41625,7 +42030,7 @@ class QualityApi {
41625
42030
  * Delete an evaluation form.
41626
42031
  *
41627
42032
  * @param {String} formId Form ID
41628
- * @deprecated
42033
+ * @deprecated
41629
42034
  */
41630
42035
  deleteQualityForm(formId) {
41631
42036
  // verify the required parameter 'formId' is set
@@ -41701,7 +42106,7 @@ class QualityApi {
41701
42106
  * Get status for async query for evaluation aggregates
41702
42107
  *
41703
42108
  * @param {String} jobId jobId
41704
- * Preview Endpoint
42109
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41705
42110
  */
41706
42111
  getAnalyticsEvaluationsAggregatesJob(jobId) {
41707
42112
  // verify the required parameter 'jobId' is set
@@ -41729,7 +42134,7 @@ class QualityApi {
41729
42134
  * @param {String} jobId jobId
41730
42135
  * @param {Object} opts Optional parameters
41731
42136
  * @param {String} opts.cursor Cursor token to retrieve next page
41732
- * Preview Endpoint
42137
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41733
42138
  */
41734
42139
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
41735
42140
  opts = opts || {};
@@ -41757,7 +42162,7 @@ class QualityApi {
41757
42162
  * Get status for async query for survey aggregates
41758
42163
  *
41759
42164
  * @param {String} jobId jobId
41760
- * Preview Endpoint
42165
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41761
42166
  */
41762
42167
  getAnalyticsSurveysAggregatesJob(jobId) {
41763
42168
  // verify the required parameter 'jobId' is set
@@ -41785,7 +42190,7 @@ class QualityApi {
41785
42190
  * @param {String} jobId jobId
41786
42191
  * @param {Object} opts Optional parameters
41787
42192
  * @param {String} opts.cursor Cursor token to retrieve next page
41788
- * Preview Endpoint
42193
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
41789
42194
  */
41790
42195
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
41791
42196
  opts = opts || {};
@@ -42106,7 +42511,7 @@ class QualityApi {
42106
42511
  * Get an evaluation form
42107
42512
  *
42108
42513
  * @param {String} formId Form ID
42109
- * @deprecated
42514
+ * @deprecated
42110
42515
  */
42111
42516
  getQualityForm(formId) {
42112
42517
  // verify the required parameter 'formId' is set
@@ -42135,7 +42540,7 @@ class QualityApi {
42135
42540
  * @param {Object} opts Optional parameters
42136
42541
  * @param {Number} opts.pageSize Page size (default to 25)
42137
42542
  * @param {Number} opts.pageNumber Page number (default to 1)
42138
- * @deprecated
42543
+ * @deprecated
42139
42544
  */
42140
42545
  getQualityFormVersions(formId, opts) {
42141
42546
  opts = opts || {};
@@ -42171,7 +42576,7 @@ class QualityApi {
42171
42576
  * @param {Object} opts.expand If 'expand=publishHistory', then each unpublished evaluation form includes a listing of its published versions
42172
42577
  * @param {String} opts.name Name
42173
42578
  * @param {String} opts.sortOrder Order to sort results, either asc or desc
42174
- * @deprecated
42579
+ * @deprecated
42175
42580
  */
42176
42581
  getQualityForms(opts) {
42177
42582
  opts = opts || {};
@@ -42447,7 +42852,7 @@ class QualityApi {
42447
42852
  * Get the published evaluation forms.
42448
42853
  *
42449
42854
  * @param {String} formId Form ID
42450
- * @deprecated
42855
+ * @deprecated
42451
42856
  */
42452
42857
  getQualityPublishedform(formId) {
42453
42858
  // verify the required parameter 'formId' is set
@@ -42477,7 +42882,7 @@ class QualityApi {
42477
42882
  * @param {Number} opts.pageNumber Page number (default to 1)
42478
42883
  * @param {String} opts.name Name
42479
42884
  * @param {Boolean} opts.onlyLatestPerContext onlyLatestPerContext (default to false)
42480
- * @deprecated
42885
+ * @deprecated
42481
42886
  */
42482
42887
  getQualityPublishedforms(opts) {
42483
42888
  opts = opts || {};
@@ -42685,7 +43090,7 @@ class QualityApi {
42685
43090
  * Query for evaluation aggregates asynchronously
42686
43091
  *
42687
43092
  * @param {Object} body query
42688
- * Preview Endpoint
43093
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
42689
43094
  */
42690
43095
  postAnalyticsEvaluationsAggregatesJobs(body) {
42691
43096
  // verify the required parameter 'body' is set
@@ -42736,7 +43141,7 @@ class QualityApi {
42736
43141
  * Query for survey aggregates asynchronously
42737
43142
  *
42738
43143
  * @param {Object} body query
42739
- * Preview Endpoint
43144
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
42740
43145
  */
42741
43146
  postAnalyticsSurveysAggregatesJobs(body) {
42742
43147
  // verify the required parameter 'body' is set
@@ -42925,7 +43330,7 @@ class QualityApi {
42925
43330
  * Create an evaluation form.
42926
43331
  *
42927
43332
  * @param {Object} body Evaluation form
42928
- * @deprecated
43333
+ * @deprecated
42929
43334
  */
42930
43335
  postQualityForms(body) {
42931
43336
  // verify the required parameter 'body' is set
@@ -43001,7 +43406,7 @@ class QualityApi {
43001
43406
  * Publish an evaluation form.
43002
43407
  *
43003
43408
  * @param {Object} body Publish request containing id of form to publish
43004
- * @deprecated
43409
+ * @deprecated
43005
43410
  */
43006
43411
  postQualityPublishedforms(body) {
43007
43412
  // verify the required parameter 'body' is set
@@ -43172,7 +43577,7 @@ class QualityApi {
43172
43577
  *
43173
43578
  * @param {String} formId Form ID
43174
43579
  * @param {Object} body Evaluation form
43175
- * @deprecated
43580
+ * @deprecated
43176
43581
  */
43177
43582
  putQualityForm(formId, body) {
43178
43583
  // verify the required parameter 'formId' is set
@@ -43294,7 +43699,7 @@ class RecordingApi {
43294
43699
  /**
43295
43700
  * Recording service.
43296
43701
  * @module purecloud-platform-client-v2/api/RecordingApi
43297
- * @version 169.1.0
43702
+ * @version 170.0.0
43298
43703
  */
43299
43704
 
43300
43705
  /**
@@ -44931,7 +45336,7 @@ class ResponseManagementApi {
44931
45336
  /**
44932
45337
  * ResponseManagement service.
44933
45338
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
44934
- * @version 169.1.0
45339
+ * @version 170.0.0
44935
45340
  */
44936
45341
 
44937
45342
  /**
@@ -45416,7 +45821,7 @@ class RoutingApi {
45416
45821
  /**
45417
45822
  * Routing service.
45418
45823
  * @module purecloud-platform-client-v2/api/RoutingApi
45419
- * @version 169.1.0
45824
+ * @version 170.0.0
45420
45825
  */
45421
45826
 
45422
45827
  /**
@@ -45650,7 +46055,7 @@ class RoutingApi {
45650
46055
  *
45651
46056
  * @param {String} queueId Queue ID
45652
46057
  * @param {String} memberId Member ID
45653
- * @deprecated
46058
+ * @deprecated
45654
46059
  */
45655
46060
  deleteRoutingQueueUser(queueId, memberId) {
45656
46061
  // verify the required parameter 'queueId' is set
@@ -45877,7 +46282,7 @@ class RoutingApi {
45877
46282
  * @param {String} tagId Utilization Tag ID
45878
46283
  * @param {Object} opts Optional parameters
45879
46284
  * @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
45880
- * Preview Endpoint
46285
+ * deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
45881
46286
  */
45882
46287
  deleteRoutingUtilizationTag(tagId, opts) {
45883
46288
  opts = opts || {};
@@ -46772,7 +47177,7 @@ class RoutingApi {
46772
47177
  * @param {Array.<String>} opts.languages Filter by language
46773
47178
  * @param {Array.<String>} opts.routingStatus Filter by routing status
46774
47179
  * @param {Array.<String>} opts.presence Filter by presence
46775
- * @deprecated
47180
+ * @deprecated
46776
47181
  */
46777
47182
  getRoutingQueueUsers(queueId, opts) {
46778
47183
  opts = opts || {};
@@ -47364,7 +47769,7 @@ class RoutingApi {
47364
47769
  * Get details about this utilization tag
47365
47770
  *
47366
47771
  * @param {String} tagId Utilization Tag ID
47367
- * Preview Endpoint
47772
+ * getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47368
47773
  */
47369
47774
  getRoutingUtilizationTag(tagId) {
47370
47775
  // verify the required parameter 'tagId' is set
@@ -47390,7 +47795,7 @@ class RoutingApi {
47390
47795
  * Get list of agent ids associated with a utilization tag
47391
47796
  *
47392
47797
  * @param {String} tagId Utilization Tag ID
47393
- * Preview Endpoint
47798
+ * getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47394
47799
  */
47395
47800
  getRoutingUtilizationTagAgents(tagId) {
47396
47801
  // verify the required parameter 'tagId' is set
@@ -47420,7 +47825,7 @@ class RoutingApi {
47420
47825
  * @param {Number} opts.pageNumber Page number (default to 1)
47421
47826
  * @param {Object} opts.sortOrder Sort order by name (default to ascending)
47422
47827
  * @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
47423
- * Preview Endpoint
47828
+ * getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47424
47829
  */
47425
47830
  getRoutingUtilizationTags(opts) {
47426
47831
  opts = opts || {};
@@ -47810,7 +48215,7 @@ class RoutingApi {
47810
48215
  * @param {String} queueId Queue ID
47811
48216
  * @param {String} memberId Member ID
47812
48217
  * @param {Object} body Queue Member
47813
- * @deprecated
48218
+ * @deprecated
47814
48219
  */
47815
48220
  patchRoutingQueueUser(queueId, memberId, body) {
47816
48221
  // verify the required parameter 'queueId' is set
@@ -47845,7 +48250,7 @@ class RoutingApi {
47845
48250
  *
47846
48251
  * @param {String} queueId Queue ID
47847
48252
  * @param {Array.<Object>} body Queue Members
47848
- * @deprecated
48253
+ * @deprecated
47849
48254
  */
47850
48255
  patchRoutingQueueUsers(queueId, body) {
47851
48256
  // verify the required parameter 'queueId' is set
@@ -48122,7 +48527,7 @@ class RoutingApi {
48122
48527
  * @param {Object} opts Optional parameters
48123
48528
  * @param {Number} opts.pageSize The desired page size
48124
48529
  * @param {Number} opts.pageNumber The desired page number
48125
- * Preview Endpoint
48530
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48126
48531
  */
48127
48532
  postAnalyticsRoutingActivityQuery(body, opts) {
48128
48533
  opts = opts || {};
@@ -48418,7 +48823,7 @@ class RoutingApi {
48418
48823
  * @param {Array.<Object>} body Queue Members
48419
48824
  * @param {Object} opts Optional parameters
48420
48825
  * @param {Boolean} opts._delete True to delete queue members (default to false)
48421
- * @deprecated
48826
+ * @deprecated
48422
48827
  */
48423
48828
  postRoutingQueueUsers(queueId, body, opts) {
48424
48829
  opts = opts || {};
@@ -48634,7 +49039,7 @@ class RoutingApi {
48634
49039
  * Imports a phone number for SMS
48635
49040
  *
48636
49041
  * @param {Object} body SmsPhoneNumber
48637
- * Preview Endpoint
49042
+ * postRoutingSmsPhonenumbersImport is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48638
49043
  */
48639
49044
  postRoutingSmsPhonenumbersImport(body) {
48640
49045
  // verify the required parameter 'body' is set
@@ -48660,7 +49065,7 @@ class RoutingApi {
48660
49065
  * Create an utilization tag
48661
49066
  *
48662
49067
  * @param {Object} body UtilizationTag
48663
- * Preview Endpoint
49068
+ * postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48664
49069
  */
48665
49070
  postRoutingUtilizationTags(body) {
48666
49071
  // verify the required parameter 'body' is set
@@ -49123,7 +49528,7 @@ class SCIMApi {
49123
49528
  /**
49124
49529
  * SCIM service.
49125
49530
  * @module purecloud-platform-client-v2/api/SCIMApi
49126
- * @version 169.1.0
49531
+ * @version 170.0.0
49127
49532
  */
49128
49533
 
49129
49534
  /**
@@ -50000,7 +50405,7 @@ class ScriptsApi {
50000
50405
  /**
50001
50406
  * Scripts service.
50002
50407
  * @module purecloud-platform-client-v2/api/ScriptsApi
50003
- * @version 169.1.0
50408
+ * @version 170.0.0
50004
50409
  */
50005
50410
 
50006
50411
  /**
@@ -50419,7 +50824,7 @@ class SearchApi {
50419
50824
  /**
50420
50825
  * Search service.
50421
50826
  * @module purecloud-platform-client-v2/api/SearchApi
50422
- * @version 169.1.0
50827
+ * @version 170.0.0
50423
50828
  */
50424
50829
 
50425
50830
  /**
@@ -50715,7 +51120,7 @@ class SearchApi {
50715
51120
  * Search all documents
50716
51121
  *
50717
51122
  * @param {Object} body Search request options
50718
- * Preview Endpoint
51123
+ * postDocumentationAllSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
50719
51124
  */
50720
51125
  postDocumentationAllSearch(body) {
50721
51126
  // verify the required parameter 'body' is set
@@ -50818,7 +51223,7 @@ class SearchApi {
50818
51223
  * @param {String} knowledgeBaseId Knowledge base ID
50819
51224
  * @param {Object} opts Optional parameters
50820
51225
  * @param {Object} opts.body
50821
- * @deprecated
51226
+ * @deprecated
50822
51227
  */
50823
51228
  postKnowledgeKnowledgebaseSearch(knowledgeBaseId, opts) {
50824
51229
  opts = opts || {};
@@ -51004,7 +51409,7 @@ class SearchApi {
51004
51409
  * Search users as conversation targets
51005
51410
  *
51006
51411
  * @param {Object} body Search request options
51007
- * Preview Endpoint
51412
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51008
51413
  */
51009
51414
  postUsersSearchConversationTarget(body) {
51010
51415
  // verify the required parameter 'body' is set
@@ -51030,7 +51435,7 @@ class SearchApi {
51030
51435
  * Search manage queue member
51031
51436
  *
51032
51437
  * @param {Object} body Search request options
51033
- * Preview Endpoint
51438
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
51034
51439
  */
51035
51440
  postUsersSearchQueuemembersManage(body) {
51036
51441
  // verify the required parameter 'body' is set
@@ -51108,7 +51513,7 @@ class SpeechTextAnalyticsApi {
51108
51513
  /**
51109
51514
  * SpeechTextAnalytics service.
51110
51515
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
51111
- * @version 169.1.0
51516
+ * @version 170.0.0
51112
51517
  */
51113
51518
 
51114
51519
  /**
@@ -52061,7 +52466,7 @@ class StationsApi {
52061
52466
  /**
52062
52467
  * Stations service.
52063
52468
  * @module purecloud-platform-client-v2/api/StationsApi
52064
- * @version 169.1.0
52469
+ * @version 170.0.0
52065
52470
  */
52066
52471
 
52067
52472
  /**
@@ -52163,7 +52568,7 @@ class SuggestApi {
52163
52568
  /**
52164
52569
  * Suggest service.
52165
52570
  * @module purecloud-platform-client-v2/api/SuggestApi
52166
- * @version 169.1.0
52571
+ * @version 170.0.0
52167
52572
  */
52168
52573
 
52169
52574
  /**
@@ -52302,7 +52707,7 @@ class TaskManagementApi {
52302
52707
  /**
52303
52708
  * TaskManagement service.
52304
52709
  * @module purecloud-platform-client-v2/api/TaskManagementApi
52305
- * @version 169.1.0
52710
+ * @version 170.0.0
52306
52711
  */
52307
52712
 
52308
52713
  /**
@@ -52321,7 +52726,7 @@ class TaskManagementApi {
52321
52726
  * Delete a workbin
52322
52727
  *
52323
52728
  * @param {String} workbinId Workbin ID
52324
- * Preview Endpoint
52729
+ * deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52325
52730
  */
52326
52731
  deleteTaskmanagementWorkbin(workbinId) {
52327
52732
  // verify the required parameter 'workbinId' is set
@@ -52347,7 +52752,7 @@ class TaskManagementApi {
52347
52752
  * Delete a workitem
52348
52753
  *
52349
52754
  * @param {String} workitemId Workitem ID
52350
- * Preview Endpoint
52755
+ * deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52351
52756
  */
52352
52757
  deleteTaskmanagementWorkitem(workitemId) {
52353
52758
  // verify the required parameter 'workitemId' is set
@@ -52373,7 +52778,7 @@ class TaskManagementApi {
52373
52778
  * Delete a schema
52374
52779
  *
52375
52780
  * @param {String} schemaId Schema ID
52376
- * Preview Endpoint
52781
+ * deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52377
52782
  */
52378
52783
  deleteTaskmanagementWorkitemsSchema(schemaId) {
52379
52784
  // verify the required parameter 'schemaId' is set
@@ -52399,7 +52804,7 @@ class TaskManagementApi {
52399
52804
  * Delete a worktype
52400
52805
  *
52401
52806
  * @param {String} worktypeId Worktype id
52402
- * Preview Endpoint
52807
+ * deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52403
52808
  */
52404
52809
  deleteTaskmanagementWorktype(worktypeId) {
52405
52810
  // verify the required parameter 'worktypeId' is set
@@ -52426,7 +52831,7 @@ class TaskManagementApi {
52426
52831
  *
52427
52832
  * @param {String} worktypeId Worktype id
52428
52833
  * @param {String} statusId Status id
52429
- * Preview Endpoint
52834
+ * deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52430
52835
  */
52431
52836
  deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
52432
52837
  // verify the required parameter 'worktypeId' is set
@@ -52456,7 +52861,7 @@ class TaskManagementApi {
52456
52861
  * Get a workbin
52457
52862
  *
52458
52863
  * @param {String} workbinId Workbin ID
52459
- * Preview Endpoint
52864
+ * getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52460
52865
  */
52461
52866
  getTaskmanagementWorkbin(workbinId) {
52462
52867
  // verify the required parameter 'workbinId' is set
@@ -52486,7 +52891,7 @@ class TaskManagementApi {
52486
52891
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
52487
52892
  * @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)
52488
52893
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
52489
- * Preview Endpoint
52894
+ * getTaskmanagementWorkbinHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52490
52895
  */
52491
52896
  getTaskmanagementWorkbinHistory(workbinId, opts) {
52492
52897
  opts = opts || {};
@@ -52515,7 +52920,7 @@ class TaskManagementApi {
52515
52920
  *
52516
52921
  * @param {String} workbinId Workbin ID
52517
52922
  * @param {Number} entityVersion Workbin version
52518
- * Preview Endpoint
52923
+ * getTaskmanagementWorkbinVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52519
52924
  */
52520
52925
  getTaskmanagementWorkbinVersion(workbinId, entityVersion) {
52521
52926
  // verify the required parameter 'workbinId' is set
@@ -52549,7 +52954,7 @@ class TaskManagementApi {
52549
52954
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
52550
52955
  * @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)
52551
52956
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
52552
- * Preview Endpoint
52957
+ * getTaskmanagementWorkbinVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52553
52958
  */
52554
52959
  getTaskmanagementWorkbinVersions(workbinId, opts) {
52555
52960
  opts = opts || {};
@@ -52577,9 +52982,13 @@ class TaskManagementApi {
52577
52982
  * Get a workitem
52578
52983
  *
52579
52984
  * @param {String} workitemId Workitem ID
52580
- * Preview Endpoint
52985
+ * @param {Object} opts Optional parameters
52986
+ * @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
52987
+ * getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52581
52988
  */
52582
- getTaskmanagementWorkitem(workitemId) {
52989
+ getTaskmanagementWorkitem(workitemId, opts) {
52990
+ opts = opts || {};
52991
+
52583
52992
  // verify the required parameter 'workitemId' is set
52584
52993
  if (workitemId === undefined || workitemId === null) {
52585
52994
  throw 'Missing the required parameter "workitemId" when calling getTaskmanagementWorkitem';
@@ -52589,7 +52998,7 @@ class TaskManagementApi {
52589
52998
  '/api/v2/taskmanagement/workitems/{workitemId}',
52590
52999
  'GET',
52591
53000
  { 'workitemId': workitemId },
52592
- { },
53001
+ { 'expands': opts['expands'] },
52593
53002
  { },
52594
53003
  { },
52595
53004
  null,
@@ -52607,7 +53016,7 @@ class TaskManagementApi {
52607
53016
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
52608
53017
  * @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)
52609
53018
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
52610
- * Preview Endpoint
53019
+ * getTaskmanagementWorkitemHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52611
53020
  */
52612
53021
  getTaskmanagementWorkitemHistory(workitemId, opts) {
52613
53022
  opts = opts || {};
@@ -52641,7 +53050,7 @@ class TaskManagementApi {
52641
53050
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
52642
53051
  * @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)
52643
53052
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
52644
- * Preview Endpoint
53053
+ * getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52645
53054
  */
52646
53055
  getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
52647
53056
  opts = opts || {};
@@ -52674,7 +53083,7 @@ class TaskManagementApi {
52674
53083
  *
52675
53084
  * @param {String} workitemId Workitem ID
52676
53085
  * @param {Number} entityVersion Workitem version
52677
- * Preview Endpoint
53086
+ * getTaskmanagementWorkitemVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52678
53087
  */
52679
53088
  getTaskmanagementWorkitemVersion(workitemId, entityVersion) {
52680
53089
  // verify the required parameter 'workitemId' is set
@@ -52708,7 +53117,7 @@ class TaskManagementApi {
52708
53117
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
52709
53118
  * @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)
52710
53119
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
52711
- * Preview Endpoint
53120
+ * getTaskmanagementWorkitemVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52712
53121
  */
52713
53122
  getTaskmanagementWorkitemVersions(workitemId, opts) {
52714
53123
  opts = opts || {};
@@ -52741,7 +53150,7 @@ class TaskManagementApi {
52741
53150
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
52742
53151
  * @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)
52743
53152
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
52744
- * Preview Endpoint
53153
+ * getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52745
53154
  */
52746
53155
  getTaskmanagementWorkitemWrapups(workitemId, opts) {
52747
53156
  opts = opts || {};
@@ -52769,7 +53178,7 @@ class TaskManagementApi {
52769
53178
  * Get a schema
52770
53179
  *
52771
53180
  * @param {String} schemaId Schema ID
52772
- * Preview Endpoint
53181
+ * getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52773
53182
  */
52774
53183
  getTaskmanagementWorkitemsSchema(schemaId) {
52775
53184
  // verify the required parameter 'schemaId' is set
@@ -52796,7 +53205,7 @@ class TaskManagementApi {
52796
53205
  *
52797
53206
  * @param {String} schemaId Schema ID
52798
53207
  * @param {String} versionId Schema version
52799
- * Preview Endpoint
53208
+ * getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52800
53209
  */
52801
53210
  getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
52802
53211
  // verify the required parameter 'schemaId' is set
@@ -52826,7 +53235,7 @@ class TaskManagementApi {
52826
53235
  * Get all versions of a schema
52827
53236
  *
52828
53237
  * @param {String} schemaId Schema ID
52829
- * Preview Endpoint
53238
+ * getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52830
53239
  */
52831
53240
  getTaskmanagementWorkitemsSchemaVersions(schemaId) {
52832
53241
  // verify the required parameter 'schemaId' is set
@@ -52851,7 +53260,7 @@ class TaskManagementApi {
52851
53260
  /**
52852
53261
  * Get a list of schemas.
52853
53262
  *
52854
- * Preview Endpoint
53263
+ * getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52855
53264
  */
52856
53265
  getTaskmanagementWorkitemsSchemas() {
52857
53266
 
@@ -52875,7 +53284,7 @@ class TaskManagementApi {
52875
53284
  * @param {String} worktypeId Worktype id
52876
53285
  * @param {Object} opts Optional parameters
52877
53286
  * @param {Array.<String>} opts.expands Which fields, if any, to expand.
52878
- * Preview Endpoint
53287
+ * getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52879
53288
  */
52880
53289
  getTaskmanagementWorktype(worktypeId, opts) {
52881
53290
  opts = opts || {};
@@ -52907,7 +53316,7 @@ class TaskManagementApi {
52907
53316
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
52908
53317
  * @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)
52909
53318
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
52910
- * Preview Endpoint
53319
+ * getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52911
53320
  */
52912
53321
  getTaskmanagementWorktypeHistory(worktypeId, opts) {
52913
53322
  opts = opts || {};
@@ -52936,7 +53345,7 @@ class TaskManagementApi {
52936
53345
  *
52937
53346
  * @param {String} worktypeId Worktype id
52938
53347
  * @param {String} statusId Status id
52939
- * Preview Endpoint
53348
+ * getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52940
53349
  */
52941
53350
  getTaskmanagementWorktypeStatus(worktypeId, statusId) {
52942
53351
  // verify the required parameter 'worktypeId' is set
@@ -52967,7 +53376,7 @@ class TaskManagementApi {
52967
53376
  *
52968
53377
  * @param {String} worktypeId Worktype id
52969
53378
  * @param {Number} entityVersion Worktype version
52970
- * Preview Endpoint
53379
+ * getTaskmanagementWorktypeVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
52971
53380
  */
52972
53381
  getTaskmanagementWorktypeVersion(worktypeId, entityVersion) {
52973
53382
  // verify the required parameter 'worktypeId' is set
@@ -53001,7 +53410,7 @@ class TaskManagementApi {
53001
53410
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
53002
53411
  * @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)
53003
53412
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
53004
- * Preview Endpoint
53413
+ * getTaskmanagementWorktypeVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53005
53414
  */
53006
53415
  getTaskmanagementWorktypeVersions(worktypeId, opts) {
53007
53416
  opts = opts || {};
@@ -53030,7 +53439,7 @@ class TaskManagementApi {
53030
53439
  *
53031
53440
  * @param {String} workbinId Workbin ID
53032
53441
  * @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
53033
- * Preview Endpoint
53442
+ * patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53034
53443
  */
53035
53444
  patchTaskmanagementWorkbin(workbinId, body) {
53036
53445
  // verify the required parameter 'workbinId' is set
@@ -53061,7 +53470,7 @@ class TaskManagementApi {
53061
53470
  *
53062
53471
  * @param {String} workitemId Workitem ID
53063
53472
  * @param {Object} body Workitem
53064
- * Preview Endpoint
53473
+ * patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53065
53474
  */
53066
53475
  patchTaskmanagementWorkitem(workitemId, body) {
53067
53476
  // verify the required parameter 'workitemId' is set
@@ -53092,7 +53501,7 @@ class TaskManagementApi {
53092
53501
  *
53093
53502
  * @param {String} workitemId Workitem ID
53094
53503
  * @param {Object} body Targeted user
53095
- * Preview Endpoint
53504
+ * patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53096
53505
  */
53097
53506
  patchTaskmanagementWorkitemAssignment(workitemId, body) {
53098
53507
  // verify the required parameter 'workitemId' is set
@@ -53124,7 +53533,7 @@ class TaskManagementApi {
53124
53533
  * @param {String} workitemId The ID of the Workitem.
53125
53534
  * @param {String} userId The ID of the user
53126
53535
  * @param {Object} body Request body to add/remove a wrapup code for a workitem
53127
- * Preview Endpoint
53536
+ * patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53128
53537
  */
53129
53538
  patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
53130
53539
  // verify the required parameter 'workitemId' is set
@@ -53159,7 +53568,7 @@ class TaskManagementApi {
53159
53568
  *
53160
53569
  * @param {String} workitemId The ID of the Workitem.
53161
53570
  * @param {Object} body Request body to add/remove the wrapup code for workitem
53162
- * Preview Endpoint
53571
+ * patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53163
53572
  */
53164
53573
  patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
53165
53574
  // verify the required parameter 'workitemId' is set
@@ -53191,7 +53600,7 @@ class TaskManagementApi {
53191
53600
  * @param {String} worktypeId Worktype id
53192
53601
  * @param {Object} opts Optional parameters
53193
53602
  * @param {Object} opts.body body
53194
- * Preview Endpoint
53603
+ * patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53195
53604
  */
53196
53605
  patchTaskmanagementWorktype(worktypeId, opts) {
53197
53606
  opts = opts || {};
@@ -53222,7 +53631,7 @@ class TaskManagementApi {
53222
53631
  * @param {String} statusId Status id
53223
53632
  * @param {Object} opts Optional parameters
53224
53633
  * @param {Object} opts.body body
53225
- * Preview Endpoint
53634
+ * patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53226
53635
  */
53227
53636
  patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
53228
53637
  opts = opts || {};
@@ -53255,7 +53664,7 @@ class TaskManagementApi {
53255
53664
  *
53256
53665
  * @param {Object} opts Optional parameters
53257
53666
  * @param {Object} opts.body body
53258
- * Preview Endpoint
53667
+ * postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53259
53668
  */
53260
53669
  postTaskmanagementWorkbins(opts) {
53261
53670
  opts = opts || {};
@@ -53279,7 +53688,7 @@ class TaskManagementApi {
53279
53688
  * Query for workbins
53280
53689
  *
53281
53690
  * @param {Object} body QueryPostRequest
53282
- * Preview Endpoint
53691
+ * postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53283
53692
  */
53284
53693
  postTaskmanagementWorkbinsQuery(body) {
53285
53694
  // verify the required parameter 'body' is set
@@ -53305,7 +53714,7 @@ class TaskManagementApi {
53305
53714
  * Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
53306
53715
  *
53307
53716
  * @param {String} workitemId Workitem ID
53308
- * Preview Endpoint
53717
+ * postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53309
53718
  */
53310
53719
  postTaskmanagementWorkitemAcdCancel(workitemId) {
53311
53720
  // verify the required parameter 'workitemId' is set
@@ -53331,7 +53740,7 @@ class TaskManagementApi {
53331
53740
  * Disconnect the assignee of the workitem
53332
53741
  *
53333
53742
  * @param {String} workitemId Workitem ID
53334
- * Preview Endpoint
53743
+ * postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53335
53744
  */
53336
53745
  postTaskmanagementWorkitemDisconnect(workitemId) {
53337
53746
  // verify the required parameter 'workitemId' is set
@@ -53359,7 +53768,7 @@ class TaskManagementApi {
53359
53768
  * @param {String} workitemId Workitem ID
53360
53769
  * @param {Object} opts Optional parameters
53361
53770
  * @param {Object} opts.body Terminated request
53362
- * Preview Endpoint
53771
+ * postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53363
53772
  */
53364
53773
  postTaskmanagementWorkitemTerminate(workitemId, opts) {
53365
53774
  opts = opts || {};
@@ -53387,7 +53796,7 @@ class TaskManagementApi {
53387
53796
  * Create a workitem
53388
53797
  *
53389
53798
  * @param {Object} body Workitem
53390
- * Preview Endpoint
53799
+ * postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53391
53800
  */
53392
53801
  postTaskmanagementWorkitems(body) {
53393
53802
  // verify the required parameter 'body' is set
@@ -53413,7 +53822,7 @@ class TaskManagementApi {
53413
53822
  * Query for workitems
53414
53823
  * This query requires at least one EQ filter on the workbinId, assigneeId or typeId attributes.
53415
53824
  * @param {Object} body WorkitemQueryPostRequest
53416
- * Preview Endpoint
53825
+ * postTaskmanagementWorkitemsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53417
53826
  */
53418
53827
  postTaskmanagementWorkitemsQuery(body) {
53419
53828
  // verify the required parameter 'body' is set
@@ -53439,7 +53848,7 @@ class TaskManagementApi {
53439
53848
  * Create a schema
53440
53849
  *
53441
53850
  * @param {Object} body Schema
53442
- * Preview Endpoint
53851
+ * postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53443
53852
  */
53444
53853
  postTaskmanagementWorkitemsSchemas(body) {
53445
53854
  // verify the required parameter 'body' is set
@@ -53467,7 +53876,7 @@ class TaskManagementApi {
53467
53876
  * @param {String} worktypeId Worktype id
53468
53877
  * @param {Object} opts Optional parameters
53469
53878
  * @param {Object} opts.body body
53470
- * Preview Endpoint
53879
+ * postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53471
53880
  */
53472
53881
  postTaskmanagementWorktypeStatuses(worktypeId, opts) {
53473
53882
  opts = opts || {};
@@ -53496,7 +53905,7 @@ class TaskManagementApi {
53496
53905
  *
53497
53906
  * @param {Object} opts Optional parameters
53498
53907
  * @param {Object} opts.body body
53499
- * Preview Endpoint
53908
+ * postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53500
53909
  */
53501
53910
  postTaskmanagementWorktypes(opts) {
53502
53911
  opts = opts || {};
@@ -53520,7 +53929,7 @@ class TaskManagementApi {
53520
53929
  * Query for worktypes
53521
53930
  *
53522
53931
  * @param {Object} body QueryPostRequest
53523
- * Preview Endpoint
53932
+ * postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53524
53933
  */
53525
53934
  postTaskmanagementWorktypesQuery(body) {
53526
53935
  // verify the required parameter 'body' is set
@@ -53547,7 +53956,7 @@ class TaskManagementApi {
53547
53956
  *
53548
53957
  * @param {String} schemaId Schema ID
53549
53958
  * @param {Object} body Data Schema
53550
- * Preview Endpoint
53959
+ * putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53551
53960
  */
53552
53961
  putTaskmanagementWorkitemsSchema(schemaId, body) {
53553
53962
  // verify the required parameter 'schemaId' is set
@@ -53579,7 +53988,7 @@ class TeamsApi {
53579
53988
  /**
53580
53989
  * Teams service.
53581
53990
  * @module purecloud-platform-client-v2/api/TeamsApi
53582
- * @version 169.1.0
53991
+ * @version 170.0.0
53583
53992
  */
53584
53993
 
53585
53994
  /**
@@ -53771,7 +54180,7 @@ class TeamsApi {
53771
54180
  * @param {Object} opts Optional parameters
53772
54181
  * @param {Number} opts.pageSize The desired page size
53773
54182
  * @param {Number} opts.pageNumber The desired page number
53774
- * Preview Endpoint
54183
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53775
54184
  */
53776
54185
  postAnalyticsTeamsActivityQuery(body, opts) {
53777
54186
  opts = opts || {};
@@ -53881,7 +54290,7 @@ class TelephonyApi {
53881
54290
  /**
53882
54291
  * Telephony service.
53883
54292
  * @module purecloud-platform-client-v2/api/TelephonyApi
53884
- * @version 169.1.0
54293
+ * @version 170.0.0
53885
54294
  */
53886
54295
 
53887
54296
  /**
@@ -54009,7 +54418,7 @@ class TelephonyProvidersEdgeApi {
54009
54418
  /**
54010
54419
  * TelephonyProvidersEdge service.
54011
54420
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
54012
- * @version 169.1.0
54421
+ * @version 170.0.0
54013
54422
  */
54014
54423
 
54015
54424
  /**
@@ -55197,7 +55606,7 @@ class TelephonyProvidersEdgeApi {
55197
55606
  * @param {Array.<String>} opts.id ID of the Extension Pools to filter by.
55198
55607
  * @param {String} opts.name Name of the Extension Pools to filter by.
55199
55608
  * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
55200
- * Preview Endpoint
55609
+ * getTelephonyProvidersEdgesExtensionpoolsDivisionviews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
55201
55610
  */
55202
55611
  getTelephonyProvidersEdgesExtensionpoolsDivisionviews(opts) {
55203
55612
  opts = opts || {};
@@ -55434,7 +55843,7 @@ class TelephonyProvidersEdgeApi {
55434
55843
  * Get outbound route
55435
55844
  * This route is deprecated, use /telephony/providers/edges/sites/{siteId}/outboundroutes/{outboundRouteId} instead.
55436
55845
  * @param {String} outboundRouteId Outbound route ID
55437
- * @deprecated
55846
+ * @deprecated
55438
55847
  */
55439
55848
  getTelephonyProvidersEdgesOutboundroute(outboundRouteId) {
55440
55849
  // verify the required parameter 'outboundRouteId' is set
@@ -55630,7 +56039,7 @@ class TelephonyProvidersEdgeApi {
55630
56039
  * @param {String} opts.phoneHardwareId Filter by phone_hardwareId
55631
56040
  * @param {String} opts.linesId Filter by lines.id
55632
56041
  * @param {String} opts.linesName Filter by lines.name
55633
- * @param {String} opts.name Name of the Phone to filter by
56042
+ * @param {String} opts.name Name of the Phone to filter by, comma-separated
55634
56043
  * @param {String} opts.statusOperationalStatus The primary status to filter by
55635
56044
  * @param {String} opts.secondaryStatusOperationalStatus The secondary status to filter by
55636
56045
  * @param {Array.<String>} opts.expand Fields to expand in the response, comma-separated
@@ -57241,7 +57650,7 @@ class TextbotsApi {
57241
57650
  /**
57242
57651
  * Textbots service.
57243
57652
  * @module purecloud-platform-client-v2/api/TextbotsApi
57244
- * @version 169.1.0
57653
+ * @version 170.0.0
57245
57654
  */
57246
57655
 
57247
57656
  /**
@@ -57369,7 +57778,7 @@ class TokensApi {
57369
57778
  /**
57370
57779
  * Tokens service.
57371
57780
  * @module purecloud-platform-client-v2/api/TokensApi
57372
- * @version 169.1.0
57781
+ * @version 170.0.0
57373
57782
  */
57374
57783
 
57375
57784
  /**
@@ -57452,7 +57861,7 @@ class TokensApi {
57452
57861
  /**
57453
57862
  * Get the current Idle Token Timeout Value
57454
57863
  *
57455
- * Preview Endpoint
57864
+ * getTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57456
57865
  */
57457
57866
  getTokensTimeout() {
57458
57867
 
@@ -57495,7 +57904,7 @@ class TokensApi {
57495
57904
  *
57496
57905
  * @param {Object} opts Optional parameters
57497
57906
  * @param {Object} opts.body
57498
- * Preview Endpoint
57907
+ * putTokensTimeout is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57499
57908
  */
57500
57909
  putTokensTimeout(opts) {
57501
57910
  opts = opts || {};
@@ -57521,7 +57930,7 @@ class UploadsApi {
57521
57930
  /**
57522
57931
  * Uploads service.
57523
57932
  * @module purecloud-platform-client-v2/api/UploadsApi
57524
- * @version 169.1.0
57933
+ * @version 170.0.0
57525
57934
  */
57526
57935
 
57527
57936
  /**
@@ -57697,7 +58106,7 @@ class UsageApi {
57697
58106
  /**
57698
58107
  * Usage service.
57699
58108
  * @module purecloud-platform-client-v2/api/UsageApi
57700
- * @version 169.1.0
58109
+ * @version 170.0.0
57701
58110
  */
57702
58111
 
57703
58112
  /**
@@ -57907,7 +58316,7 @@ class UserRecordingsApi {
57907
58316
  /**
57908
58317
  * UserRecordings service.
57909
58318
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
57910
- * @version 169.1.0
58319
+ * @version 170.0.0
57911
58320
  */
57912
58321
 
57913
58322
  /**
@@ -58092,7 +58501,7 @@ class UsersApi {
58092
58501
  /**
58093
58502
  * Users service.
58094
58503
  * @module purecloud-platform-client-v2/api/UsersApi
58095
- * @version 169.1.0
58504
+ * @version 170.0.0
58096
58505
  */
58097
58506
 
58098
58507
  /**
@@ -58331,7 +58740,7 @@ class UsersApi {
58331
58740
  * Get status for async query for user aggregates
58332
58741
  *
58333
58742
  * @param {String} jobId jobId
58334
- * Preview Endpoint
58743
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58335
58744
  */
58336
58745
  getAnalyticsUsersAggregatesJob(jobId) {
58337
58746
  // verify the required parameter 'jobId' is set
@@ -58359,7 +58768,7 @@ class UsersApi {
58359
58768
  * @param {String} jobId jobId
58360
58769
  * @param {Object} opts Optional parameters
58361
58770
  * @param {String} opts.cursor Cursor token to retrieve next page
58362
- * Preview Endpoint
58771
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58363
58772
  */
58364
58773
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
58365
58774
  opts = opts || {};
@@ -58464,7 +58873,7 @@ class UsersApi {
58464
58873
  * @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
58465
58874
  * @param {Object} opts Optional parameters
58466
58875
  * @param {String} opts.name Search term to filter by division name
58467
- * @deprecated
58876
+ * @deprecated
58468
58877
  */
58469
58878
  getAuthorizationDivisionspermittedMe(permission, opts) {
58470
58879
  opts = opts || {};
@@ -58526,7 +58935,7 @@ class UsersApi {
58526
58935
  * @param {Object} opts Optional parameters
58527
58936
  * @param {Number} opts.pageNumber Page number (default to 1)
58528
58937
  * @param {Number} opts.pageSize Page size (default to 25)
58529
- * @deprecated
58938
+ * @deprecated
58530
58939
  */
58531
58940
  getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
58532
58941
  opts = opts || {};
@@ -58603,7 +59012,7 @@ class UsersApi {
58603
59012
  * Fetch field config for an entity type
58604
59013
  *
58605
59014
  * @param {Object} type Field type
58606
- * @deprecated
59015
+ * @deprecated
58607
59016
  */
58608
59017
  getFieldconfig(type) {
58609
59018
  // verify the required parameter 'type' is set
@@ -58636,7 +59045,7 @@ class UsersApi {
58636
59045
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
58637
59046
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
58638
59047
  * @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.
58639
- * @deprecated
59048
+ * @deprecated
58640
59049
  */
58641
59050
  getProfilesUsers(opts) {
58642
59051
  opts = opts || {};
@@ -58804,7 +59213,7 @@ class UsersApi {
58804
59213
  * @param {Number} opts.pageNumber Page number (default to 1)
58805
59214
  * @param {String} opts.sortOrder Sort order (default to ASC)
58806
59215
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
58807
- * @deprecated
59216
+ * @deprecated
58808
59217
  */
58809
59218
  getUserFavorites(userId, opts) {
58810
59219
  opts = opts || {};
@@ -58890,7 +59299,7 @@ class UsersApi {
58890
59299
  * @param {Object} opts Optional parameters
58891
59300
  * @param {Array.<String>} opts.expand Which fields, if any, to expand
58892
59301
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
58893
- * @deprecated
59302
+ * @deprecated
58894
59303
  */
58895
59304
  getUserProfile(userId, opts) {
58896
59305
  opts = opts || {};
@@ -59699,7 +60108,7 @@ class UsersApi {
59699
60108
  * @param {Object} opts Optional parameters
59700
60109
  * @param {Number} opts.pageSize The desired page size
59701
60110
  * @param {Number} opts.pageNumber The desired page number
59702
- * Preview Endpoint
60111
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
59703
60112
  */
59704
60113
  postAnalyticsUsersActivityQuery(body, opts) {
59705
60114
  opts = opts || {};
@@ -59727,7 +60136,7 @@ class UsersApi {
59727
60136
  * Query for user aggregates asynchronously
59728
60137
  *
59729
60138
  * @param {Object} body query
59730
- * Preview Endpoint
60139
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
59731
60140
  */
59732
60141
  postAnalyticsUsersAggregatesJobs(body) {
59733
60142
  // verify the required parameter 'body' is set
@@ -60239,7 +60648,7 @@ class UsersApi {
60239
60648
  * Search users as conversation targets
60240
60649
  *
60241
60650
  * @param {Object} body Search request options
60242
- * Preview Endpoint
60651
+ * postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
60243
60652
  */
60244
60653
  postUsersSearchConversationTarget(body) {
60245
60654
  // verify the required parameter 'body' is set
@@ -60265,7 +60674,7 @@ class UsersApi {
60265
60674
  * Search manage queue member
60266
60675
  *
60267
60676
  * @param {Object} body Search request options
60268
- * Preview Endpoint
60677
+ * postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
60269
60678
  */
60270
60679
  postUsersSearchQueuemembersManage(body) {
60271
60680
  // verify the required parameter 'body' is set
@@ -60653,7 +61062,7 @@ class UtilitiesApi {
60653
61062
  /**
60654
61063
  * Utilities service.
60655
61064
  * @module purecloud-platform-client-v2/api/UtilitiesApi
60656
- * @version 169.1.0
61065
+ * @version 170.0.0
60657
61066
  */
60658
61067
 
60659
61068
  /**
@@ -60764,7 +61173,7 @@ class VoicemailApi {
60764
61173
  /**
60765
61174
  * Voicemail service.
60766
61175
  * @module purecloud-platform-client-v2/api/VoicemailApi
60767
- * @version 169.1.0
61176
+ * @version 170.0.0
60768
61177
  */
60769
61178
 
60770
61179
  /**
@@ -61431,7 +61840,7 @@ class WebChatApi {
61431
61840
  /**
61432
61841
  * WebChat service.
61433
61842
  * @module purecloud-platform-client-v2/api/WebChatApi
61434
- * @version 169.1.0
61843
+ * @version 170.0.0
61435
61844
  */
61436
61845
 
61437
61846
  /**
@@ -61450,7 +61859,7 @@ class WebChatApi {
61450
61859
  * Delete a WebChat deployment
61451
61860
  *
61452
61861
  * @param {String} deploymentId Deployment Id
61453
- * @deprecated
61862
+ * @deprecated
61454
61863
  */
61455
61864
  deleteWebchatDeployment(deploymentId) {
61456
61865
  // verify the required parameter 'deploymentId' is set
@@ -61526,7 +61935,7 @@ class WebChatApi {
61526
61935
  * Get a WebChat deployment
61527
61936
  *
61528
61937
  * @param {String} deploymentId Deployment Id
61529
- * @deprecated
61938
+ * @deprecated
61530
61939
  */
61531
61940
  getWebchatDeployment(deploymentId) {
61532
61941
  // verify the required parameter 'deploymentId' is set
@@ -61551,7 +61960,7 @@ class WebChatApi {
61551
61960
  /**
61552
61961
  * List WebChat deployments
61553
61962
  *
61554
- * @deprecated
61963
+ * @deprecated
61555
61964
  */
61556
61965
  getWebchatDeployments() {
61557
61966
 
@@ -61806,7 +62215,7 @@ class WebChatApi {
61806
62215
  * Create WebChat deployment
61807
62216
  *
61808
62217
  * @param {Object} body Deployment
61809
- * @deprecated
62218
+ * @deprecated
61810
62219
  */
61811
62220
  postWebchatDeployments(body) {
61812
62221
  // verify the required parameter 'body' is set
@@ -61923,7 +62332,7 @@ class WebChatApi {
61923
62332
  *
61924
62333
  * @param {String} deploymentId Deployment Id
61925
62334
  * @param {Object} body Deployment
61926
- * @deprecated
62335
+ * @deprecated
61927
62336
  */
61928
62337
  putWebchatDeployment(deploymentId, body) {
61929
62338
  // verify the required parameter 'deploymentId' is set
@@ -61980,7 +62389,7 @@ class WebDeploymentsApi {
61980
62389
  /**
61981
62390
  * WebDeployments service.
61982
62391
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
61983
- * @version 169.1.0
62392
+ * @version 170.0.0
61984
62393
  */
61985
62394
 
61986
62395
  /**
@@ -62502,7 +62911,7 @@ class WebMessagingApi {
62502
62911
  /**
62503
62912
  * WebMessaging service.
62504
62913
  * @module purecloud-platform-client-v2/api/WebMessagingApi
62505
- * @version 169.1.0
62914
+ * @version 170.0.0
62506
62915
  */
62507
62916
 
62508
62917
  /**
@@ -62548,7 +62957,7 @@ class WidgetsApi {
62548
62957
  /**
62549
62958
  * Widgets service.
62550
62959
  * @module purecloud-platform-client-v2/api/WidgetsApi
62551
- * @version 169.1.0
62960
+ * @version 170.0.0
62552
62961
  */
62553
62962
 
62554
62963
  /**
@@ -62694,7 +63103,7 @@ class WorkforceManagementApi {
62694
63103
  /**
62695
63104
  * WorkforceManagement service.
62696
63105
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
62697
- * @version 169.1.0
63106
+ * @version 170.0.0
62698
63107
  */
62699
63108
 
62700
63109
  /**
@@ -64236,7 +64645,7 @@ class WorkforceManagementApi {
64236
64645
  * Get activity codes
64237
64646
  *
64238
64647
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
64239
- * @deprecated
64648
+ * @deprecated
64240
64649
  */
64241
64650
  getWorkforcemanagementManagementunitActivitycodes(managementUnitId) {
64242
64651
  // verify the required parameter 'managementUnitId' is set
@@ -64649,7 +65058,7 @@ class WorkforceManagementApi {
64649
65058
  * @param {Object} opts Optional parameters
64650
65059
  * @param {Object} opts.expand Which fields, if any, to expand
64651
65060
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
64652
- * @deprecated
65061
+ * @deprecated
64653
65062
  */
64654
65063
  getWorkforcemanagementManagementunitWeekSchedule(managementUnitId, weekId, scheduleId, opts) {
64655
65064
  opts = opts || {};
@@ -64690,7 +65099,7 @@ class WorkforceManagementApi {
64690
65099
  * @param {Boolean} opts.includeOnlyPublished Return only published schedules
64691
65100
  * @param {String} opts.earliestWeekDate The start date of the earliest week to query in yyyy-MM-dd format
64692
65101
  * @param {String} opts.latestWeekDate The start date of the latest week to query in yyyy-MM-dd format
64693
- * @deprecated
65102
+ * @deprecated
64694
65103
  */
64695
65104
  getWorkforcemanagementManagementunitWeekSchedules(managementUnitId, weekId, opts) {
64696
65105
  opts = opts || {};
@@ -66649,7 +67058,7 @@ class WorkforceManagementApi {
66649
67058
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
66650
67059
  * @param {Object} opts Optional parameters
66651
67060
  * @param {Object} opts.body body
66652
- * @deprecated
67061
+ * @deprecated
66653
67062
  */
66654
67063
  postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, opts) {
66655
67064
  opts = opts || {};
@@ -67310,7 +67719,7 @@ class WorkforceManagementApi {
67310
67719
  *
67311
67720
  * @param {Object} opts Optional parameters
67312
67721
  * @param {Object} opts.body body
67313
- * @deprecated
67722
+ * @deprecated
67314
67723
  */
67315
67724
  postWorkforcemanagementSchedules(opts) {
67316
67725
  opts = opts || {};
@@ -67501,7 +67910,7 @@ class WorkforceManagementApi {
67501
67910
  * </pre>
67502
67911
  * </p>
67503
67912
  * @module purecloud-platform-client-v2/index
67504
- * @version 169.1.0
67913
+ * @version 170.0.0
67505
67914
  */
67506
67915
  class platformClient {
67507
67916
  constructor() {