purecloud-platform-client-v2 252.1.0 → 254.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 (97) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1979 -556
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1979 -556
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +686 -393
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +686 -393
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1094 -117
  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/AIStudioApi.js +6 -6
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -62
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
  18. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +435 -1
  24. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
  26. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -6
  30. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -5
  39. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -11
  49. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +42 -1
  50. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -9
  68. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/RoutingApi.js +333 -158
  71. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +268 -1
  82. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -47
  83. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -5
  89. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  90. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  95. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  96. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +481 -43
  97. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -748,7 +748,7 @@ class Configuration {
748
748
 
749
749
  /**
750
750
  * @module purecloud-platform-client-v2/ApiClient
751
- * @version 252.1.0
751
+ * @version 254.0.0
752
752
  */
753
753
  class ApiClient {
754
754
  /**
@@ -2439,7 +2439,7 @@ class AIStudioApi {
2439
2439
  /**
2440
2440
  * AIStudio service.
2441
2441
  * @module purecloud-platform-client-v2/api/AIStudioApi
2442
- * @version 252.1.0
2442
+ * @version 254.0.0
2443
2443
  */
2444
2444
 
2445
2445
  /**
@@ -2548,12 +2548,12 @@ class AIStudioApi {
2548
2548
  * Get all summary settings.
2549
2549
  *
2550
2550
  * @param {Object} opts Optional parameters
2551
- * @param {String} opts.language Filter by matching language - case insensitive.
2552
- * @param {String} opts.name Filter by partially matching name - case insensitive.
2553
- * @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
2554
- * @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
2555
2551
  * @param {Number} opts.pageNumber Page number. (default to 1)
2556
2552
  * @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
2553
+ * @param {String} opts.name Filter by partially matching name - case insensitive.
2554
+ * @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
2555
+ * @param {String} opts.language Filter by matching language - case insensitive.
2556
+ * @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
2557
2557
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
2558
2558
  */
2559
2559
  getConversationsSummariesSettings(opts) {
@@ -2564,7 +2564,7 @@ class AIStudioApi {
2564
2564
  '/api/v2/conversations/summaries/settings',
2565
2565
  'GET',
2566
2566
  { },
2567
- { 'language': opts['language'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
2567
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'],'sortOrder': opts['sortOrder'],'language': opts['language'],'sortBy': opts['sortBy'] },
2568
2568
  { },
2569
2569
  { },
2570
2570
  null,
@@ -3154,7 +3154,7 @@ class AgentAssistantsApi {
3154
3154
  /**
3155
3155
  * AgentAssistants service.
3156
3156
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
3157
- * @version 252.1.0
3157
+ * @version 254.0.0
3158
3158
  */
3159
3159
 
3160
3160
  /**
@@ -3510,6 +3510,7 @@ class AgentAssistantsApi {
3510
3510
  * @param {String} opts.language The agent checklist language filter applied to the listing.
3511
3511
  * @param {Object} opts.sortOrder The sort order for the listing
3512
3512
  * @param {Object} opts.sortBy The field to sort by for the listing.
3513
+ * @param {Array.<String>} opts.agentChecklistIds Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
3513
3514
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
3514
3515
  */
3515
3516
  getAssistantsAgentchecklists(opts) {
@@ -3520,7 +3521,7 @@ class AgentAssistantsApi {
3520
3521
  '/api/v2/assistants/agentchecklists',
3521
3522
  'GET',
3522
3523
  { },
3523
- { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
3524
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'agentChecklistIds': this.apiClient.buildCollectionParam(opts['agentChecklistIds'], 'multi') },
3524
3525
  { },
3525
3526
  { },
3526
3527
  null,
@@ -3958,7 +3959,7 @@ class AgentCopilotApi {
3958
3959
  /**
3959
3960
  * AgentCopilot service.
3960
3961
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3961
- * @version 252.1.0
3962
+ * @version 254.0.0
3962
3963
  */
3963
3964
 
3964
3965
  /**
@@ -4070,7 +4071,7 @@ class AgentUIApi {
4070
4071
  /**
4071
4072
  * AgentUI service.
4072
4073
  * @module purecloud-platform-client-v2/api/AgentUIApi
4073
- * @version 252.1.0
4074
+ * @version 254.0.0
4074
4075
  */
4075
4076
 
4076
4077
  /**
@@ -4221,7 +4222,7 @@ class AlertingApi {
4221
4222
  /**
4222
4223
  * Alerting service.
4223
4224
  * @module purecloud-platform-client-v2/api/AlertingApi
4224
- * @version 252.1.0
4225
+ * @version 254.0.0
4225
4226
  */
4226
4227
 
4227
4228
  /**
@@ -4682,7 +4683,7 @@ class AnalyticsApi {
4682
4683
  /**
4683
4684
  * Analytics service.
4684
4685
  * @module purecloud-platform-client-v2/api/AnalyticsApi
4685
- * @version 252.1.0
4686
+ * @version 254.0.0
4686
4687
  */
4687
4688
 
4688
4689
  /**
@@ -4703,7 +4704,6 @@ class AnalyticsApi {
4703
4704
  * @param {String} jobId jobId
4704
4705
  * @param {Object} opts Optional parameters
4705
4706
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4706
- * deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4707
4707
  */
4708
4708
  deleteAnalyticsActionsAggregatesJob(jobId, opts) {
4709
4709
  opts = opts || {};
@@ -4796,7 +4796,6 @@ class AnalyticsApi {
4796
4796
  * @param {String} jobId jobId
4797
4797
  * @param {Object} opts Optional parameters
4798
4798
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4799
- * deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4800
4799
  */
4801
4800
  deleteAnalyticsBotsAggregatesJob(jobId, opts) {
4802
4801
  opts = opts || {};
@@ -4827,7 +4826,6 @@ class AnalyticsApi {
4827
4826
  * @param {String} jobId jobId
4828
4827
  * @param {Object} opts Optional parameters
4829
4828
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4830
- * deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4831
4829
  */
4832
4830
  deleteAnalyticsCasemanagementAggregatesJob(jobId, opts) {
4833
4831
  opts = opts || {};
@@ -4858,7 +4856,6 @@ class AnalyticsApi {
4858
4856
  * @param {String} jobId jobId
4859
4857
  * @param {Object} opts Optional parameters
4860
4858
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4861
- * deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4862
4859
  */
4863
4860
  deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
4864
4861
  opts = opts || {};
@@ -4950,7 +4947,6 @@ class AnalyticsApi {
4950
4947
  * @param {String} jobId jobId
4951
4948
  * @param {Object} opts Optional parameters
4952
4949
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4953
- * deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4954
4950
  */
4955
4951
  deleteAnalyticsEvaluationsAggregatesJob(jobId, opts) {
4956
4952
  opts = opts || {};
@@ -4981,7 +4977,6 @@ class AnalyticsApi {
4981
4977
  * @param {String} jobId jobId
4982
4978
  * @param {Object} opts Optional parameters
4983
4979
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4984
- * deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4985
4980
  */
4986
4981
  deleteAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
4987
4982
  opts = opts || {};
@@ -5012,7 +5007,6 @@ class AnalyticsApi {
5012
5007
  * @param {String} jobId jobId
5013
5008
  * @param {Object} opts Optional parameters
5014
5009
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5015
- * deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5016
5010
  */
5017
5011
  deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
5018
5012
  opts = opts || {};
@@ -5043,7 +5037,6 @@ class AnalyticsApi {
5043
5037
  * @param {String} jobId jobId
5044
5038
  * @param {Object} opts Optional parameters
5045
5039
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5046
- * deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5047
5040
  */
5048
5041
  deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
5049
5042
  opts = opts || {};
@@ -5074,7 +5067,6 @@ class AnalyticsApi {
5074
5067
  * @param {String} jobId jobId
5075
5068
  * @param {Object} opts Optional parameters
5076
5069
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5077
- * deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5078
5070
  */
5079
5071
  deleteAnalyticsKnowledgeAggregatesJob(jobId, opts) {
5080
5072
  opts = opts || {};
@@ -5105,7 +5097,6 @@ class AnalyticsApi {
5105
5097
  * @param {String} jobId jobId
5106
5098
  * @param {Object} opts Optional parameters
5107
5099
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5108
- * deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5109
5100
  */
5110
5101
  deleteAnalyticsResolutionsAggregatesJob(jobId, opts) {
5111
5102
  opts = opts || {};
@@ -5136,7 +5127,6 @@ class AnalyticsApi {
5136
5127
  * @param {String} jobId jobId
5137
5128
  * @param {Object} opts Optional parameters
5138
5129
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5139
- * deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5140
5130
  */
5141
5131
  deleteAnalyticsSummariesAggregatesJob(jobId, opts) {
5142
5132
  opts = opts || {};
@@ -5167,7 +5157,6 @@ class AnalyticsApi {
5167
5157
  * @param {String} jobId jobId
5168
5158
  * @param {Object} opts Optional parameters
5169
5159
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5170
- * deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5171
5160
  */
5172
5161
  deleteAnalyticsSurveysAggregatesJob(jobId, opts) {
5173
5162
  opts = opts || {};
@@ -5198,7 +5187,6 @@ class AnalyticsApi {
5198
5187
  * @param {String} jobId jobId
5199
5188
  * @param {Object} opts Optional parameters
5200
5189
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5201
- * deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5202
5190
  */
5203
5191
  deleteAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
5204
5192
  opts = opts || {};
@@ -5229,7 +5217,6 @@ class AnalyticsApi {
5229
5217
  * @param {String} jobId jobId
5230
5218
  * @param {Object} opts Optional parameters
5231
5219
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5232
- * deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5233
5220
  */
5234
5221
  deleteAnalyticsTranscriptsAggregatesJob(jobId, opts) {
5235
5222
  opts = opts || {};
@@ -5260,7 +5247,6 @@ class AnalyticsApi {
5260
5247
  * @param {String} jobId jobId
5261
5248
  * @param {Object} opts Optional parameters
5262
5249
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5263
- * deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5264
5250
  */
5265
5251
  deleteAnalyticsUsersAggregatesJob(jobId, opts) {
5266
5252
  opts = opts || {};
@@ -5321,7 +5307,6 @@ class AnalyticsApi {
5321
5307
  * @param {String} jobId jobId
5322
5308
  * @param {Object} opts Optional parameters
5323
5309
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5324
- * getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5325
5310
  */
5326
5311
  getAnalyticsActionsAggregatesJob(jobId, opts) {
5327
5312
  opts = opts || {};
@@ -5353,7 +5338,6 @@ class AnalyticsApi {
5353
5338
  * @param {Object} opts Optional parameters
5354
5339
  * @param {String} opts.cursor Cursor token to retrieve next page
5355
5340
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5356
- * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5357
5341
  */
5358
5342
  getAnalyticsActionsAggregatesJobResults(jobId, opts) {
5359
5343
  opts = opts || {};
@@ -5650,7 +5634,6 @@ class AnalyticsApi {
5650
5634
  * @param {String} jobId jobId
5651
5635
  * @param {Object} opts Optional parameters
5652
5636
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5653
- * getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5654
5637
  */
5655
5638
  getAnalyticsBotsAggregatesJob(jobId, opts) {
5656
5639
  opts = opts || {};
@@ -5682,7 +5665,6 @@ class AnalyticsApi {
5682
5665
  * @param {Object} opts Optional parameters
5683
5666
  * @param {String} opts.cursor Cursor token to retrieve next page
5684
5667
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5685
- * getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5686
5668
  */
5687
5669
  getAnalyticsBotsAggregatesJobResults(jobId, opts) {
5688
5670
  opts = opts || {};
@@ -5713,7 +5695,6 @@ class AnalyticsApi {
5713
5695
  * @param {String} jobId jobId
5714
5696
  * @param {Object} opts Optional parameters
5715
5697
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5716
- * getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5717
5698
  */
5718
5699
  getAnalyticsCasemanagementAggregatesJob(jobId, opts) {
5719
5700
  opts = opts || {};
@@ -5745,7 +5726,6 @@ class AnalyticsApi {
5745
5726
  * @param {Object} opts Optional parameters
5746
5727
  * @param {String} opts.cursor Cursor token to retrieve next page
5747
5728
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5748
- * getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5749
5729
  */
5750
5730
  getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
5751
5731
  opts = opts || {};
@@ -5806,7 +5786,6 @@ class AnalyticsApi {
5806
5786
  * @param {String} jobId jobId
5807
5787
  * @param {Object} opts Optional parameters
5808
5788
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5809
- * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5810
5789
  */
5811
5790
  getAnalyticsConversationsAggregatesJob(jobId, opts) {
5812
5791
  opts = opts || {};
@@ -5838,7 +5817,6 @@ class AnalyticsApi {
5838
5817
  * @param {Object} opts Optional parameters
5839
5818
  * @param {String} opts.cursor Cursor token to retrieve next page
5840
5819
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5841
- * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5842
5820
  */
5843
5821
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
5844
5822
  opts = opts || {};
@@ -6133,7 +6111,6 @@ class AnalyticsApi {
6133
6111
  * @param {String} jobId jobId
6134
6112
  * @param {Object} opts Optional parameters
6135
6113
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6136
- * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6137
6114
  */
6138
6115
  getAnalyticsEvaluationsAggregatesJob(jobId, opts) {
6139
6116
  opts = opts || {};
@@ -6165,7 +6142,6 @@ class AnalyticsApi {
6165
6142
  * @param {Object} opts Optional parameters
6166
6143
  * @param {String} opts.cursor Cursor token to retrieve next page
6167
6144
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6168
- * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6169
6145
  */
6170
6146
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
6171
6147
  opts = opts || {};
@@ -6196,7 +6172,6 @@ class AnalyticsApi {
6196
6172
  * @param {String} jobId jobId
6197
6173
  * @param {Object} opts Optional parameters
6198
6174
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6199
- * getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6200
6175
  */
6201
6176
  getAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
6202
6177
  opts = opts || {};
@@ -6228,7 +6203,6 @@ class AnalyticsApi {
6228
6203
  * @param {Object} opts Optional parameters
6229
6204
  * @param {String} opts.cursor Cursor token to retrieve next page
6230
6205
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6231
- * getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6232
6206
  */
6233
6207
  getAnalyticsFlowexecutionsAggregatesJobResults(jobId, opts) {
6234
6208
  opts = opts || {};
@@ -6259,7 +6233,6 @@ class AnalyticsApi {
6259
6233
  * @param {String} jobId jobId
6260
6234
  * @param {Object} opts Optional parameters
6261
6235
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6262
- * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6263
6236
  */
6264
6237
  getAnalyticsFlowsAggregatesJob(jobId, opts) {
6265
6238
  opts = opts || {};
@@ -6291,7 +6264,6 @@ class AnalyticsApi {
6291
6264
  * @param {Object} opts Optional parameters
6292
6265
  * @param {String} opts.cursor Cursor token to retrieve next page
6293
6266
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6294
- * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6295
6267
  */
6296
6268
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
6297
6269
  opts = opts || {};
@@ -6322,7 +6294,6 @@ class AnalyticsApi {
6322
6294
  * @param {String} jobId jobId
6323
6295
  * @param {Object} opts Optional parameters
6324
6296
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6325
- * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6326
6297
  */
6327
6298
  getAnalyticsJourneysAggregatesJob(jobId, opts) {
6328
6299
  opts = opts || {};
@@ -6354,7 +6325,6 @@ class AnalyticsApi {
6354
6325
  * @param {Object} opts Optional parameters
6355
6326
  * @param {String} opts.cursor Cursor token to retrieve next page
6356
6327
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6357
- * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6358
6328
  */
6359
6329
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
6360
6330
  opts = opts || {};
@@ -6385,7 +6355,6 @@ class AnalyticsApi {
6385
6355
  * @param {String} jobId jobId
6386
6356
  * @param {Object} opts Optional parameters
6387
6357
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6388
- * getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6389
6358
  */
6390
6359
  getAnalyticsKnowledgeAggregatesJob(jobId, opts) {
6391
6360
  opts = opts || {};
@@ -6417,7 +6386,6 @@ class AnalyticsApi {
6417
6386
  * @param {Object} opts Optional parameters
6418
6387
  * @param {String} opts.cursor Cursor token to retrieve next page
6419
6388
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6420
- * getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6421
6389
  */
6422
6390
  getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
6423
6391
  opts = opts || {};
@@ -6663,7 +6631,6 @@ class AnalyticsApi {
6663
6631
  * @param {String} jobId jobId
6664
6632
  * @param {Object} opts Optional parameters
6665
6633
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6666
- * getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6667
6634
  */
6668
6635
  getAnalyticsResolutionsAggregatesJob(jobId, opts) {
6669
6636
  opts = opts || {};
@@ -6695,7 +6662,6 @@ class AnalyticsApi {
6695
6662
  * @param {Object} opts Optional parameters
6696
6663
  * @param {String} opts.cursor Cursor token to retrieve next page
6697
6664
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6698
- * getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6699
6665
  */
6700
6666
  getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
6701
6667
  opts = opts || {};
@@ -6726,7 +6692,6 @@ class AnalyticsApi {
6726
6692
  * @param {String} jobId jobId
6727
6693
  * @param {Object} opts Optional parameters
6728
6694
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6729
- * getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6730
6695
  */
6731
6696
  getAnalyticsSummariesAggregatesJob(jobId, opts) {
6732
6697
  opts = opts || {};
@@ -6758,7 +6723,6 @@ class AnalyticsApi {
6758
6723
  * @param {Object} opts Optional parameters
6759
6724
  * @param {String} opts.cursor Cursor token to retrieve next page
6760
6725
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6761
- * getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6762
6726
  */
6763
6727
  getAnalyticsSummariesAggregatesJobResults(jobId, opts) {
6764
6728
  opts = opts || {};
@@ -6789,7 +6753,6 @@ class AnalyticsApi {
6789
6753
  * @param {String} jobId jobId
6790
6754
  * @param {Object} opts Optional parameters
6791
6755
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6792
- * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6793
6756
  */
6794
6757
  getAnalyticsSurveysAggregatesJob(jobId, opts) {
6795
6758
  opts = opts || {};
@@ -6821,7 +6784,6 @@ class AnalyticsApi {
6821
6784
  * @param {Object} opts Optional parameters
6822
6785
  * @param {String} opts.cursor Cursor token to retrieve next page
6823
6786
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6824
- * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6825
6787
  */
6826
6788
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
6827
6789
  opts = opts || {};
@@ -6852,7 +6814,6 @@ class AnalyticsApi {
6852
6814
  * @param {String} jobId jobId
6853
6815
  * @param {Object} opts Optional parameters
6854
6816
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6855
- * getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6856
6817
  */
6857
6818
  getAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
6858
6819
  opts = opts || {};
@@ -6884,7 +6845,6 @@ class AnalyticsApi {
6884
6845
  * @param {Object} opts Optional parameters
6885
6846
  * @param {String} opts.cursor Cursor token to retrieve next page
6886
6847
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6887
- * getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6888
6848
  */
6889
6849
  getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
6890
6850
  opts = opts || {};
@@ -6915,7 +6875,6 @@ class AnalyticsApi {
6915
6875
  * @param {String} jobId jobId
6916
6876
  * @param {Object} opts Optional parameters
6917
6877
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6918
- * getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6919
6878
  */
6920
6879
  getAnalyticsTranscriptsAggregatesJob(jobId, opts) {
6921
6880
  opts = opts || {};
@@ -6947,7 +6906,6 @@ class AnalyticsApi {
6947
6906
  * @param {Object} opts Optional parameters
6948
6907
  * @param {String} opts.cursor Cursor token to retrieve next page
6949
6908
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6950
- * getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6951
6909
  */
6952
6910
  getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
6953
6911
  opts = opts || {};
@@ -6978,7 +6936,6 @@ class AnalyticsApi {
6978
6936
  * @param {String} jobId jobId
6979
6937
  * @param {Object} opts Optional parameters
6980
6938
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6981
- * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6982
6939
  */
6983
6940
  getAnalyticsUsersAggregatesJob(jobId, opts) {
6984
6941
  opts = opts || {};
@@ -7010,7 +6967,6 @@ class AnalyticsApi {
7010
6967
  * @param {Object} opts Optional parameters
7011
6968
  * @param {String} opts.cursor Cursor token to retrieve next page
7012
6969
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7013
- * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7014
6970
  */
7015
6971
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
7016
6972
  opts = opts || {};
@@ -7158,7 +7114,6 @@ class AnalyticsApi {
7158
7114
  * @param {Object} body query
7159
7115
  * @param {Object} opts Optional parameters
7160
7116
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7161
- * postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7162
7117
  */
7163
7118
  postAnalyticsActionsAggregatesJobs(body, opts) {
7164
7119
  opts = opts || {};
@@ -7403,7 +7358,6 @@ class AnalyticsApi {
7403
7358
  * @param {Object} body query
7404
7359
  * @param {Object} opts Optional parameters
7405
7360
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7406
- * postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7407
7361
  */
7408
7362
  postAnalyticsBotsAggregatesJobs(body, opts) {
7409
7363
  opts = opts || {};
@@ -7464,7 +7418,6 @@ class AnalyticsApi {
7464
7418
  * @param {Object} body query
7465
7419
  * @param {Object} opts Optional parameters
7466
7420
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7467
- * postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7468
7421
  */
7469
7422
  postAnalyticsCasemanagementAggregatesJobs(body, opts) {
7470
7423
  opts = opts || {};
@@ -7495,7 +7448,6 @@ class AnalyticsApi {
7495
7448
  * @param {Object} body query
7496
7449
  * @param {Object} opts Optional parameters
7497
7450
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7498
- * postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7499
7451
  */
7500
7452
  postAnalyticsCasemanagementAggregatesQuery(body, opts) {
7501
7453
  opts = opts || {};
@@ -7593,7 +7545,6 @@ class AnalyticsApi {
7593
7545
  * @param {Object} body query
7594
7546
  * @param {Object} opts Optional parameters
7595
7547
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7596
- * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7597
7548
  */
7598
7549
  postAnalyticsConversationsAggregatesJobs(body, opts) {
7599
7550
  opts = opts || {};
@@ -7807,7 +7758,6 @@ class AnalyticsApi {
7807
7758
  * @param {Object} body query
7808
7759
  * @param {Object} opts Optional parameters
7809
7760
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7810
- * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7811
7761
  */
7812
7762
  postAnalyticsEvaluationsAggregatesJobs(body, opts) {
7813
7763
  opts = opts || {};
@@ -7868,7 +7818,6 @@ class AnalyticsApi {
7868
7818
  * @param {Object} body query
7869
7819
  * @param {Object} opts Optional parameters
7870
7820
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7871
- * postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7872
7821
  */
7873
7822
  postAnalyticsFlowexecutionsAggregatesJobs(body, opts) {
7874
7823
  opts = opts || {};
@@ -7961,7 +7910,6 @@ class AnalyticsApi {
7961
7910
  * @param {Object} body query
7962
7911
  * @param {Object} opts Optional parameters
7963
7912
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7964
- * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7965
7913
  */
7966
7914
  postAnalyticsFlowsAggregatesJobs(body, opts) {
7967
7915
  opts = opts || {};
@@ -8052,7 +8000,6 @@ class AnalyticsApi {
8052
8000
  * @param {Object} body query
8053
8001
  * @param {Object} opts Optional parameters
8054
8002
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8055
- * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8056
8003
  */
8057
8004
  postAnalyticsJourneysAggregatesJobs(body, opts) {
8058
8005
  opts = opts || {};
@@ -8113,7 +8060,6 @@ class AnalyticsApi {
8113
8060
  * @param {Object} body query
8114
8061
  * @param {Object} opts Optional parameters
8115
8062
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8116
- * postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8117
8063
  */
8118
8064
  postAnalyticsKnowledgeAggregatesJobs(body, opts) {
8119
8065
  opts = opts || {};
@@ -8354,7 +8300,6 @@ class AnalyticsApi {
8354
8300
  * @param {Object} body query
8355
8301
  * @param {Object} opts Optional parameters
8356
8302
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8357
- * postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8358
8303
  */
8359
8304
  postAnalyticsResolutionsAggregatesJobs(body, opts) {
8360
8305
  opts = opts || {};
@@ -8447,7 +8392,6 @@ class AnalyticsApi {
8447
8392
  * @param {Object} body query
8448
8393
  * @param {Object} opts Optional parameters
8449
8394
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8450
- * postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8451
8395
  */
8452
8396
  postAnalyticsSummariesAggregatesJobs(body, opts) {
8453
8397
  opts = opts || {};
@@ -8508,7 +8452,6 @@ class AnalyticsApi {
8508
8452
  * @param {Object} body query
8509
8453
  * @param {Object} opts Optional parameters
8510
8454
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8511
- * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8512
8455
  */
8513
8456
  postAnalyticsSurveysAggregatesJobs(body, opts) {
8514
8457
  opts = opts || {};
@@ -8569,7 +8512,6 @@ class AnalyticsApi {
8569
8512
  * @param {Object} body query
8570
8513
  * @param {Object} opts Optional parameters
8571
8514
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8572
- * postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8573
8515
  */
8574
8516
  postAnalyticsTaskmanagementAggregatesJobs(body, opts) {
8575
8517
  opts = opts || {};
@@ -8694,7 +8636,6 @@ class AnalyticsApi {
8694
8636
  * @param {Object} body query
8695
8637
  * @param {Object} opts Optional parameters
8696
8638
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8697
- * postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8698
8639
  */
8699
8640
  postAnalyticsTranscriptsAggregatesJobs(body, opts) {
8700
8641
  opts = opts || {};
@@ -8787,7 +8728,6 @@ class AnalyticsApi {
8787
8728
  * @param {Object} body query
8788
8729
  * @param {Object} opts Optional parameters
8789
8730
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8790
- * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8791
8731
  */
8792
8732
  postAnalyticsUsersAggregatesJobs(body, opts) {
8793
8733
  opts = opts || {};
@@ -8968,7 +8908,7 @@ class ArchitectApi {
8968
8908
  /**
8969
8909
  * Architect service.
8970
8910
  * @module purecloud-platform-client-v2/api/ArchitectApi
8971
- * @version 252.1.0
8911
+ * @version 254.0.0
8972
8912
  */
8973
8913
 
8974
8914
  /**
@@ -13222,6 +13162,7 @@ class ArchitectApi {
13222
13162
  * Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
13223
13163
  *
13224
13164
  * @param {Object} opts Optional parameters
13165
+ * @param {Object} opts.body
13225
13166
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
13226
13167
  */
13227
13168
  postFlowsJobs(opts) {
@@ -13235,7 +13176,7 @@ class ArchitectApi {
13235
13176
  { },
13236
13177
  { },
13237
13178
  { },
13238
- null,
13179
+ opts['body'],
13239
13180
  ['PureCloud OAuth'],
13240
13181
  ['application/json'],
13241
13182
  ['application/json'],
@@ -13827,7 +13768,7 @@ class AssistantCopilotVariationsApi {
13827
13768
  /**
13828
13769
  * AssistantCopilotVariations service.
13829
13770
  * @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
13830
- * @version 252.1.0
13771
+ * @version 254.0.0
13831
13772
  */
13832
13773
 
13833
13774
  /**
@@ -14023,7 +13964,7 @@ class AuditApi {
14023
13964
  /**
14024
13965
  * Audit service.
14025
13966
  * @module purecloud-platform-client-v2/api/AuditApi
14026
- * @version 252.1.0
13967
+ * @version 254.0.0
14027
13968
  */
14028
13969
 
14029
13970
  /**
@@ -14250,7 +14191,7 @@ class AuthorizationApi {
14250
14191
  /**
14251
14192
  * Authorization service.
14252
14193
  * @module purecloud-platform-client-v2/api/AuthorizationApi
14253
- * @version 252.1.0
14194
+ * @version 254.0.0
14254
14195
  */
14255
14196
 
14256
14197
  /**
@@ -16175,7 +16116,7 @@ class BackgroundAssistantApi {
16175
16116
  /**
16176
16117
  * BackgroundAssistant service.
16177
16118
  * @module purecloud-platform-client-v2/api/BackgroundAssistantApi
16178
- * @version 252.1.0
16119
+ * @version 254.0.0
16179
16120
  */
16180
16121
 
16181
16122
  /**
@@ -16249,7 +16190,7 @@ class BillingApi {
16249
16190
  /**
16250
16191
  * Billing service.
16251
16192
  * @module purecloud-platform-client-v2/api/BillingApi
16252
- * @version 252.1.0
16193
+ * @version 254.0.0
16253
16194
  */
16254
16195
 
16255
16196
  /**
@@ -16533,7 +16474,7 @@ class BusinessRulesApi {
16533
16474
  /**
16534
16475
  * BusinessRules service.
16535
16476
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
16536
- * @version 252.1.0
16477
+ * @version 254.0.0
16537
16478
  */
16538
16479
 
16539
16480
  /**
@@ -16579,6 +16520,76 @@ class BusinessRulesApi {
16579
16520
  );
16580
16521
  }
16581
16522
 
16523
+ /**
16524
+ * Delete an export job for a decision table
16525
+ *
16526
+ * @param {String} tableId Table ID
16527
+ * @param {String} exportJobId Export Job ID
16528
+ * @param {Object} opts Optional parameters
16529
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16530
+ */
16531
+ deleteBusinessrulesDecisiontableExport(tableId, exportJobId, opts) {
16532
+ opts = opts || {};
16533
+
16534
+ // verify the required parameter 'tableId' is set
16535
+ if (tableId === undefined || tableId === null || tableId === '') {
16536
+ throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableExport';
16537
+ }
16538
+ // verify the required parameter 'exportJobId' is set
16539
+ if (exportJobId === undefined || exportJobId === null || exportJobId === '') {
16540
+ throw 'Missing the required parameter "exportJobId" when calling deleteBusinessrulesDecisiontableExport';
16541
+ }
16542
+
16543
+ return this.apiClient.callApi(
16544
+ '/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}',
16545
+ 'DELETE',
16546
+ { 'tableId': tableId,'exportJobId': exportJobId },
16547
+ { },
16548
+ { },
16549
+ { },
16550
+ null,
16551
+ ['PureCloud OAuth'],
16552
+ ['application/json'],
16553
+ ['application/json'],
16554
+ opts['customHeaders']
16555
+ );
16556
+ }
16557
+
16558
+ /**
16559
+ * Delete decision table row import job
16560
+ *
16561
+ * @param {String} tableId Table ID
16562
+ * @param {String} importJobId Import job ID
16563
+ * @param {Object} opts Optional parameters
16564
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16565
+ */
16566
+ deleteBusinessrulesDecisiontableImport(tableId, importJobId, opts) {
16567
+ opts = opts || {};
16568
+
16569
+ // verify the required parameter 'tableId' is set
16570
+ if (tableId === undefined || tableId === null || tableId === '') {
16571
+ throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableImport';
16572
+ }
16573
+ // verify the required parameter 'importJobId' is set
16574
+ if (importJobId === undefined || importJobId === null || importJobId === '') {
16575
+ throw 'Missing the required parameter "importJobId" when calling deleteBusinessrulesDecisiontableImport';
16576
+ }
16577
+
16578
+ return this.apiClient.callApi(
16579
+ '/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
16580
+ 'DELETE',
16581
+ { 'tableId': tableId,'importJobId': importJobId },
16582
+ { },
16583
+ { },
16584
+ { },
16585
+ null,
16586
+ ['PureCloud OAuth'],
16587
+ ['application/json'],
16588
+ ['application/json'],
16589
+ opts['customHeaders']
16590
+ );
16591
+ }
16592
+
16582
16593
  /**
16583
16594
  * Delete a decision table version
16584
16595
  *
@@ -16714,6 +16725,140 @@ class BusinessRulesApi {
16714
16725
  );
16715
16726
  }
16716
16727
 
16728
+ /**
16729
+ * Get an export job for a decision table
16730
+ *
16731
+ * @param {String} tableId Table ID
16732
+ * @param {String} exportJobId Export Job ID
16733
+ * @param {Object} opts Optional parameters
16734
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16735
+ */
16736
+ getBusinessrulesDecisiontableExport(tableId, exportJobId, opts) {
16737
+ opts = opts || {};
16738
+
16739
+ // verify the required parameter 'tableId' is set
16740
+ if (tableId === undefined || tableId === null || tableId === '') {
16741
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExport';
16742
+ }
16743
+ // verify the required parameter 'exportJobId' is set
16744
+ if (exportJobId === undefined || exportJobId === null || exportJobId === '') {
16745
+ throw 'Missing the required parameter "exportJobId" when calling getBusinessrulesDecisiontableExport';
16746
+ }
16747
+
16748
+ return this.apiClient.callApi(
16749
+ '/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}',
16750
+ 'GET',
16751
+ { 'tableId': tableId,'exportJobId': exportJobId },
16752
+ { },
16753
+ { },
16754
+ { },
16755
+ null,
16756
+ ['PureCloud OAuth'],
16757
+ ['application/json'],
16758
+ ['application/json'],
16759
+ opts['customHeaders']
16760
+ );
16761
+ }
16762
+
16763
+ /**
16764
+ * List export jobs for a decision table
16765
+ *
16766
+ * @param {String} tableId Table ID
16767
+ * @param {Object} opts Optional parameters
16768
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
16769
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 100.
16770
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16771
+ */
16772
+ getBusinessrulesDecisiontableExports(tableId, opts) {
16773
+ opts = opts || {};
16774
+
16775
+ // verify the required parameter 'tableId' is set
16776
+ if (tableId === undefined || tableId === null || tableId === '') {
16777
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExports';
16778
+ }
16779
+
16780
+ return this.apiClient.callApi(
16781
+ '/api/v2/businessrules/decisiontables/{tableId}/exports',
16782
+ 'GET',
16783
+ { 'tableId': tableId },
16784
+ { 'after': opts['after'],'pageSize': opts['pageSize'] },
16785
+ { },
16786
+ { },
16787
+ null,
16788
+ ['PureCloud OAuth'],
16789
+ ['application/json'],
16790
+ ['application/json'],
16791
+ opts['customHeaders']
16792
+ );
16793
+ }
16794
+
16795
+ /**
16796
+ * Get decision table row import job
16797
+ *
16798
+ * @param {String} tableId Table ID
16799
+ * @param {String} importJobId Import job ID
16800
+ * @param {Object} opts Optional parameters
16801
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16802
+ */
16803
+ getBusinessrulesDecisiontableImport(tableId, importJobId, opts) {
16804
+ opts = opts || {};
16805
+
16806
+ // verify the required parameter 'tableId' is set
16807
+ if (tableId === undefined || tableId === null || tableId === '') {
16808
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImport';
16809
+ }
16810
+ // verify the required parameter 'importJobId' is set
16811
+ if (importJobId === undefined || importJobId === null || importJobId === '') {
16812
+ throw 'Missing the required parameter "importJobId" when calling getBusinessrulesDecisiontableImport';
16813
+ }
16814
+
16815
+ return this.apiClient.callApi(
16816
+ '/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
16817
+ 'GET',
16818
+ { 'tableId': tableId,'importJobId': importJobId },
16819
+ { },
16820
+ { },
16821
+ { },
16822
+ null,
16823
+ ['PureCloud OAuth'],
16824
+ ['application/json'],
16825
+ ['application/json'],
16826
+ opts['customHeaders']
16827
+ );
16828
+ }
16829
+
16830
+ /**
16831
+ * List decision table row import jobs
16832
+ *
16833
+ * @param {String} tableId Table ID
16834
+ * @param {Object} opts Optional parameters
16835
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
16836
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 100.
16837
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16838
+ */
16839
+ getBusinessrulesDecisiontableImports(tableId, opts) {
16840
+ opts = opts || {};
16841
+
16842
+ // verify the required parameter 'tableId' is set
16843
+ if (tableId === undefined || tableId === null || tableId === '') {
16844
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImports';
16845
+ }
16846
+
16847
+ return this.apiClient.callApi(
16848
+ '/api/v2/businessrules/decisiontables/{tableId}/imports',
16849
+ 'GET',
16850
+ { 'tableId': tableId },
16851
+ { 'after': opts['after'],'pageSize': opts['pageSize'] },
16852
+ { },
16853
+ { },
16854
+ null,
16855
+ ['PureCloud OAuth'],
16856
+ ['application/json'],
16857
+ ['application/json'],
16858
+ opts['customHeaders']
16859
+ );
16860
+ }
16861
+
16717
16862
  /**
16718
16863
  * Get a decision table version
16719
16864
  *
@@ -17064,6 +17209,46 @@ class BusinessRulesApi {
17064
17209
  );
17065
17210
  }
17066
17211
 
17212
+ /**
17213
+ * Update decision table row import job
17214
+ *
17215
+ * @param {String} tableId Table ID
17216
+ * @param {String} importJobId Import job ID
17217
+ * @param {Object} body Import job update request
17218
+ * @param {Object} opts Optional parameters
17219
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17220
+ */
17221
+ patchBusinessrulesDecisiontableImport(tableId, importJobId, body, opts) {
17222
+ opts = opts || {};
17223
+
17224
+ // verify the required parameter 'tableId' is set
17225
+ if (tableId === undefined || tableId === null || tableId === '') {
17226
+ throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableImport';
17227
+ }
17228
+ // verify the required parameter 'importJobId' is set
17229
+ if (importJobId === undefined || importJobId === null || importJobId === '') {
17230
+ throw 'Missing the required parameter "importJobId" when calling patchBusinessrulesDecisiontableImport';
17231
+ }
17232
+ // verify the required parameter 'body' is set
17233
+ if (body === undefined || body === null) {
17234
+ throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableImport';
17235
+ }
17236
+
17237
+ return this.apiClient.callApi(
17238
+ '/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
17239
+ 'PATCH',
17240
+ { 'tableId': tableId,'importJobId': importJobId },
17241
+ { },
17242
+ { },
17243
+ { },
17244
+ body,
17245
+ ['PureCloud OAuth'],
17246
+ ['application/json'],
17247
+ ['application/json'],
17248
+ opts['customHeaders']
17249
+ );
17250
+ }
17251
+
17067
17252
  /**
17068
17253
  * Update a decision table version
17069
17254
  *
@@ -17139,6 +17324,76 @@ class BusinessRulesApi {
17139
17324
  );
17140
17325
  }
17141
17326
 
17327
+ /**
17328
+ * Create an export job for a decision table version
17329
+ *
17330
+ * @param {String} tableId Table ID
17331
+ * @param {Object} body Export job request
17332
+ * @param {Object} opts Optional parameters
17333
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17334
+ */
17335
+ postBusinessrulesDecisiontableExports(tableId, body, opts) {
17336
+ opts = opts || {};
17337
+
17338
+ // verify the required parameter 'tableId' is set
17339
+ if (tableId === undefined || tableId === null || tableId === '') {
17340
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExports';
17341
+ }
17342
+ // verify the required parameter 'body' is set
17343
+ if (body === undefined || body === null) {
17344
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExports';
17345
+ }
17346
+
17347
+ return this.apiClient.callApi(
17348
+ '/api/v2/businessrules/decisiontables/{tableId}/exports',
17349
+ 'POST',
17350
+ { 'tableId': tableId },
17351
+ { },
17352
+ { },
17353
+ { },
17354
+ body,
17355
+ ['PureCloud OAuth'],
17356
+ ['application/json'],
17357
+ ['application/json'],
17358
+ opts['customHeaders']
17359
+ );
17360
+ }
17361
+
17362
+ /**
17363
+ * Create a decision table row import job
17364
+ *
17365
+ * @param {String} tableId Table ID
17366
+ * @param {Object} body Import job create request
17367
+ * @param {Object} opts Optional parameters
17368
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17369
+ */
17370
+ postBusinessrulesDecisiontableImports(tableId, body, opts) {
17371
+ opts = opts || {};
17372
+
17373
+ // verify the required parameter 'tableId' is set
17374
+ if (tableId === undefined || tableId === null || tableId === '') {
17375
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableImports';
17376
+ }
17377
+ // verify the required parameter 'body' is set
17378
+ if (body === undefined || body === null) {
17379
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableImports';
17380
+ }
17381
+
17382
+ return this.apiClient.callApi(
17383
+ '/api/v2/businessrules/decisiontables/{tableId}/imports',
17384
+ 'POST',
17385
+ { 'tableId': tableId },
17386
+ { },
17387
+ { },
17388
+ { },
17389
+ body,
17390
+ ['PureCloud OAuth'],
17391
+ ['application/json'],
17392
+ ['application/json'],
17393
+ opts['customHeaders']
17394
+ );
17395
+ }
17396
+
17142
17397
  /**
17143
17398
  * Copy a decision table version
17144
17399
  *
@@ -17259,6 +17514,126 @@ class BusinessRulesApi {
17259
17514
  );
17260
17515
  }
17261
17516
 
17517
+ /**
17518
+ * Bulk add decision table rows
17519
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
17520
+ * @param {String} tableId Table ID
17521
+ * @param {Number} tableVersion Table Version
17522
+ * @param {Object} body Bulk add decision table rows request
17523
+ * @param {Object} opts Optional parameters
17524
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17525
+ */
17526
+ postBusinessrulesDecisiontableVersionRowsBulkAdd(tableId, tableVersion, body, opts) {
17527
+ opts = opts || {};
17528
+
17529
+ // verify the required parameter 'tableId' is set
17530
+ if (tableId === undefined || tableId === null || tableId === '') {
17531
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
17532
+ }
17533
+ // verify the required parameter 'tableVersion' is set
17534
+ if (tableVersion === undefined || tableVersion === null) {
17535
+ throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
17536
+ }
17537
+ // verify the required parameter 'body' is set
17538
+ if (body === undefined || body === null) {
17539
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
17540
+ }
17541
+
17542
+ return this.apiClient.callApi(
17543
+ '/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/add',
17544
+ 'POST',
17545
+ { 'tableId': tableId,'tableVersion': tableVersion },
17546
+ { },
17547
+ { },
17548
+ { },
17549
+ body,
17550
+ ['PureCloud OAuth'],
17551
+ ['application/json'],
17552
+ ['application/json'],
17553
+ opts['customHeaders']
17554
+ );
17555
+ }
17556
+
17557
+ /**
17558
+ * Bulk delete decision table rows
17559
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
17560
+ * @param {String} tableId Table ID
17561
+ * @param {Number} tableVersion Table Version
17562
+ * @param {Object} body
17563
+ * @param {Object} opts Optional parameters
17564
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17565
+ */
17566
+ postBusinessrulesDecisiontableVersionRowsBulkRemove(tableId, tableVersion, body, opts) {
17567
+ opts = opts || {};
17568
+
17569
+ // verify the required parameter 'tableId' is set
17570
+ if (tableId === undefined || tableId === null || tableId === '') {
17571
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
17572
+ }
17573
+ // verify the required parameter 'tableVersion' is set
17574
+ if (tableVersion === undefined || tableVersion === null) {
17575
+ throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
17576
+ }
17577
+ // verify the required parameter 'body' is set
17578
+ if (body === undefined || body === null) {
17579
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
17580
+ }
17581
+
17582
+ return this.apiClient.callApi(
17583
+ '/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/remove',
17584
+ 'POST',
17585
+ { 'tableId': tableId,'tableVersion': tableVersion },
17586
+ { },
17587
+ { },
17588
+ { },
17589
+ body,
17590
+ ['PureCloud OAuth'],
17591
+ ['application/json'],
17592
+ ['application/json'],
17593
+ opts['customHeaders']
17594
+ );
17595
+ }
17596
+
17597
+ /**
17598
+ * Bulk update decision table rows
17599
+ * Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
17600
+ * @param {String} tableId Table ID
17601
+ * @param {Number} tableVersion Table Version
17602
+ * @param {Object} body Bulk update decision table rows request
17603
+ * @param {Object} opts Optional parameters
17604
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17605
+ */
17606
+ postBusinessrulesDecisiontableVersionRowsBulkUpdate(tableId, tableVersion, body, opts) {
17607
+ opts = opts || {};
17608
+
17609
+ // verify the required parameter 'tableId' is set
17610
+ if (tableId === undefined || tableId === null || tableId === '') {
17611
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
17612
+ }
17613
+ // verify the required parameter 'tableVersion' is set
17614
+ if (tableVersion === undefined || tableVersion === null) {
17615
+ throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
17616
+ }
17617
+ // verify the required parameter 'body' is set
17618
+ if (body === undefined || body === null) {
17619
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
17620
+ }
17621
+
17622
+ return this.apiClient.callApi(
17623
+ '/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/update',
17624
+ 'POST',
17625
+ { 'tableId': tableId,'tableVersion': tableVersion },
17626
+ { },
17627
+ { },
17628
+ { },
17629
+ body,
17630
+ ['PureCloud OAuth'],
17631
+ ['application/json'],
17632
+ ['application/json'],
17633
+ opts['customHeaders']
17634
+ );
17635
+ }
17636
+
17262
17637
  /**
17263
17638
  * Search for decision table rows
17264
17639
  *
@@ -17547,7 +17922,7 @@ class CarrierServicesApi {
17547
17922
  /**
17548
17923
  * CarrierServices service.
17549
17924
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
17550
- * @version 252.1.0
17925
+ * @version 254.0.0
17551
17926
  */
17552
17927
 
17553
17928
  /**
@@ -17624,7 +17999,7 @@ class CaseManagementApi {
17624
17999
  /**
17625
18000
  * CaseManagement service.
17626
18001
  * @module purecloud-platform-client-v2/api/CaseManagementApi
17627
- * @version 252.1.0
18002
+ * @version 254.0.0
17628
18003
  */
17629
18004
 
17630
18005
  /**
@@ -17642,10 +18017,9 @@ class CaseManagementApi {
17642
18017
  /**
17643
18018
  * Delete a Case.
17644
18019
  *
17645
- * @param {String} caseId Case ID
18020
+ * @param {String} caseId Case identifier.
17646
18021
  * @param {Object} opts Optional parameters
17647
18022
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17648
- * deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17649
18023
  */
17650
18024
  deleteCasemanagementCase(caseId, opts) {
17651
18025
  opts = opts || {};
@@ -17673,10 +18047,9 @@ class CaseManagementApi {
17673
18047
  /**
17674
18048
  * Delete a Caseplan.
17675
18049
  *
17676
- * @param {String} caseplanId Caseplan ID
18050
+ * @param {String} caseplanId Caseplan identifier.
17677
18051
  * @param {Object} opts Optional parameters
17678
18052
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17679
- * deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17680
18053
  */
17681
18054
  deleteCasemanagementCaseplan(caseplanId, opts) {
17682
18055
  opts = opts || {};
@@ -17701,14 +18074,48 @@ class CaseManagementApi {
17701
18074
  );
17702
18075
  }
17703
18076
 
18077
+ /**
18078
+ * Remove a data schema from a draft Caseplan.
18079
+ *
18080
+ * @param {String} caseplanId Caseplan identifier.
18081
+ * @param {String} schemaKeyName Schema key (for example default).
18082
+ * @param {Object} opts Optional parameters
18083
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18084
+ */
18085
+ deleteCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, opts) {
18086
+ opts = opts || {};
18087
+
18088
+ // verify the required parameter 'caseplanId' is set
18089
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
18090
+ throw 'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplanDataschema';
18091
+ }
18092
+ // verify the required parameter 'schemaKeyName' is set
18093
+ if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
18094
+ throw 'Missing the required parameter "schemaKeyName" when calling deleteCasemanagementCaseplanDataschema';
18095
+ }
18096
+
18097
+ return this.apiClient.callApi(
18098
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
18099
+ 'DELETE',
18100
+ { 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
18101
+ { },
18102
+ { },
18103
+ { },
18104
+ null,
18105
+ ['PureCloud OAuth'],
18106
+ ['application/json'],
18107
+ ['application/json'],
18108
+ opts['customHeaders']
18109
+ );
18110
+ }
18111
+
17704
18112
  /**
17705
18113
  * Get a Case.
17706
18114
  *
17707
- * @param {String} caseId Case ID
18115
+ * @param {String} caseId Case identifier.
17708
18116
  * @param {Object} opts Optional parameters
17709
- * @param {Object} opts.expands Which fields to expand.
18117
+ * @param {Object} opts.expands Fields to expand.
17710
18118
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17711
- * getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17712
18119
  */
17713
18120
  getCasemanagementCase(caseId, opts) {
17714
18121
  opts = opts || {};
@@ -17736,11 +18143,10 @@ class CaseManagementApi {
17736
18143
  /**
17737
18144
  * Get a Case Association.
17738
18145
  *
17739
- * @param {String} caseId Case ID
17740
- * @param {String} associationId Case Association ID
18146
+ * @param {String} caseId Case identifier.
18147
+ * @param {String} associationId Case association identifier.
17741
18148
  * @param {Object} opts Optional parameters
17742
18149
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17743
- * getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17744
18150
  */
17745
18151
  getCasemanagementCaseAssociation(caseId, associationId, opts) {
17746
18152
  opts = opts || {};
@@ -17770,15 +18176,14 @@ class CaseManagementApi {
17770
18176
  }
17771
18177
 
17772
18178
  /**
17773
- * Get a list of case associations for a provided case.
18179
+ * Get a list of Case associations for the Case.
17774
18180
  *
17775
- * @param {String} caseId Case ID.
18181
+ * @param {String} caseId Case identifier.
17776
18182
  * @param {Object} opts Optional parameters
17777
18183
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
17778
18184
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17779
18185
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17780
18186
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17781
- * getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17782
18187
  */
17783
18188
  getCasemanagementCaseAssociations(caseId, opts) {
17784
18189
  opts = opts || {};
@@ -17806,11 +18211,10 @@ class CaseManagementApi {
17806
18211
  /**
17807
18212
  * Get a Stage.
17808
18213
  *
17809
- * @param {String} caseId Case ID
17810
- * @param {String} stageId Stage ID
18214
+ * @param {String} caseId Case identifier.
18215
+ * @param {String} stageId Stage identifier.
17811
18216
  * @param {Object} opts Optional parameters
17812
18217
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17813
- * getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17814
18218
  */
17815
18219
  getCasemanagementCaseStage(caseId, stageId, opts) {
17816
18220
  opts = opts || {};
@@ -17842,12 +18246,11 @@ class CaseManagementApi {
17842
18246
  /**
17843
18247
  * Get a Step.
17844
18248
  *
17845
- * @param {String} caseId Case ID
17846
- * @param {String} stageId Stage ID
17847
- * @param {String} stepId Step ID
18249
+ * @param {String} caseId Case identifier.
18250
+ * @param {String} stageId Stage identifier.
18251
+ * @param {String} stepId Step identifier.
17848
18252
  * @param {Object} opts Optional parameters
17849
18253
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17850
- * getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17851
18254
  */
17852
18255
  getCasemanagementCaseStageStep(caseId, stageId, stepId, opts) {
17853
18256
  opts = opts || {};
@@ -17883,14 +18286,13 @@ class CaseManagementApi {
17883
18286
  /**
17884
18287
  * Get a list of Steps.
17885
18288
  *
17886
- * @param {String} caseId Case ID
17887
- * @param {String} stageId Stage ID
18289
+ * @param {String} caseId Case identifier.
18290
+ * @param {String} stageId Stage identifier.
17888
18291
  * @param {Object} opts Optional parameters
17889
18292
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
17890
18293
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17891
18294
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17892
18295
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17893
- * getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17894
18296
  */
17895
18297
  getCasemanagementCaseStageSteps(caseId, stageId, opts) {
17896
18298
  opts = opts || {};
@@ -17922,13 +18324,12 @@ class CaseManagementApi {
17922
18324
  /**
17923
18325
  * Get a list of Stages.
17924
18326
  *
17925
- * @param {String} caseId Case ID
18327
+ * @param {String} caseId Case identifier.
17926
18328
  * @param {Object} opts Optional parameters
17927
18329
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
17928
18330
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17929
18331
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17930
18332
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17931
- * getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17932
18333
  */
17933
18334
  getCasemanagementCaseStages(caseId, opts) {
17934
18335
  opts = opts || {};
@@ -17956,11 +18357,10 @@ class CaseManagementApi {
17956
18357
  /**
17957
18358
  * Get a Terminate Job for a Case.
17958
18359
  *
17959
- * @param {String} caseId Case ID
17960
- * @param {String} jobId Job ID
18360
+ * @param {String} caseId Case identifier.
18361
+ * @param {String} jobId Terminate Job identifier.
17961
18362
  * @param {Object} opts Optional parameters
17962
18363
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17963
- * getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17964
18364
  */
17965
18365
  getCasemanagementCaseTerminateJob(caseId, jobId, opts) {
17966
18366
  opts = opts || {};
@@ -17992,10 +18392,9 @@ class CaseManagementApi {
17992
18392
  /**
17993
18393
  * Get a Caseplan.
17994
18394
  *
17995
- * @param {String} caseplanId Caseplan ID
18395
+ * @param {String} caseplanId Caseplan identifier.
17996
18396
  * @param {Object} opts Optional parameters
17997
18397
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17998
- * getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17999
18398
  */
18000
18399
  getCasemanagementCaseplan(caseplanId, opts) {
18001
18400
  opts = opts || {};
@@ -18023,11 +18422,10 @@ class CaseManagementApi {
18023
18422
  /**
18024
18423
  * Get a Caseplan version.
18025
18424
  *
18026
- * @param {String} caseplanId Caseplan ID
18027
- * @param {String} versionId Version of the caseplan
18425
+ * @param {String} caseplanId Caseplan identifier.
18426
+ * @param {String} versionId Caseplan version identifier.
18028
18427
  * @param {Object} opts Optional parameters
18029
18428
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18030
- * getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18031
18429
  */
18032
18430
  getCasemanagementCaseplanVersion(caseplanId, versionId, opts) {
18033
18431
  opts = opts || {};
@@ -18057,13 +18455,12 @@ class CaseManagementApi {
18057
18455
  }
18058
18456
 
18059
18457
  /**
18060
- * Get the dataSchemas for a caseplan version.
18458
+ * Get the data schemas for a Caseplan version.
18061
18459
  *
18062
- * @param {String} caseplanId Caseplan ID
18063
- * @param {String} versionId Version of the caseplan
18460
+ * @param {String} caseplanId Caseplan identifier.
18461
+ * @param {String} versionId Caseplan version identifier.
18064
18462
  * @param {Object} opts Optional parameters
18065
18463
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18066
- * getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18067
18464
  */
18068
18465
  getCasemanagementCaseplanVersionDataschemas(caseplanId, versionId, opts) {
18069
18466
  opts = opts || {};
@@ -18095,11 +18492,10 @@ class CaseManagementApi {
18095
18492
  /**
18096
18493
  * Get the intake settings for a Caseplan version.
18097
18494
  *
18098
- * @param {String} caseplanId Caseplan ID
18099
- * @param {String} versionId Version of the caseplan
18495
+ * @param {String} caseplanId Caseplan identifier.
18496
+ * @param {String} versionId Caseplan version identifier.
18100
18497
  * @param {Object} opts Optional parameters
18101
18498
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18102
- * getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18103
18499
  */
18104
18500
  getCasemanagementCaseplanVersionIntakesettings(caseplanId, versionId, opts) {
18105
18501
  opts = opts || {};
@@ -18131,13 +18527,12 @@ class CaseManagementApi {
18131
18527
  /**
18132
18528
  * Get a Stageplan.
18133
18529
  *
18134
- * @param {String} caseplanId Caseplan ID
18135
- * @param {String} versionId Version ID
18136
- * @param {String} stageplanId Stageplan ID
18530
+ * @param {String} caseplanId Caseplan identifier.
18531
+ * @param {String} versionId Caseplan version identifier.
18532
+ * @param {String} stageplanId Stageplan identifier.
18137
18533
  * @param {Object} opts Optional parameters
18138
- * @param {Array.<String>} opts.expands Which fields to expand.
18534
+ * @param {Array.<String>} opts.expands Fields to expand.
18139
18535
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18140
- * getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18141
18536
  */
18142
18537
  getCasemanagementCaseplanVersionStageplan(caseplanId, versionId, stageplanId, opts) {
18143
18538
  opts = opts || {};
@@ -18173,14 +18568,13 @@ class CaseManagementApi {
18173
18568
  /**
18174
18569
  * Get a Stepplan.
18175
18570
  *
18176
- * @param {String} caseplanId Caseplan ID
18177
- * @param {String} versionId Version ID
18178
- * @param {String} stageplanId Stageplan ID
18179
- * @param {String} stepplanId Stepplan ID
18571
+ * @param {String} caseplanId Caseplan identifier.
18572
+ * @param {String} versionId Caseplan version identifier.
18573
+ * @param {String} stageplanId Stageplan identifier.
18574
+ * @param {String} stepplanId Stepplan identifier.
18180
18575
  * @param {Object} opts Optional parameters
18181
- * @param {Array.<String>} opts.expands Which fields to expand.
18576
+ * @param {Array.<String>} opts.expands Fields to expand.
18182
18577
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18183
- * getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18184
18578
  */
18185
18579
  getCasemanagementCaseplanVersionStageplanStepplan(caseplanId, versionId, stageplanId, stepplanId, opts) {
18186
18580
  opts = opts || {};
@@ -18220,16 +18614,15 @@ class CaseManagementApi {
18220
18614
  /**
18221
18615
  * Get a list of Stepplans.
18222
18616
  *
18223
- * @param {String} caseplanId Caseplan ID
18224
- * @param {String} versionId Version ID
18225
- * @param {String} stageplanId Stageplan ID
18617
+ * @param {String} caseplanId Caseplan identifier.
18618
+ * @param {String} versionId Caseplan version identifier.
18619
+ * @param {String} stageplanId Stageplan identifier.
18226
18620
  * @param {Object} opts Optional parameters
18227
18621
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
18228
18622
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
18229
18623
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
18230
- * @param {Array.<String>} opts.expands Which fields to expand.
18624
+ * @param {Array.<String>} opts.expands Fields to expand.
18231
18625
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18232
- * getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18233
18626
  */
18234
18627
  getCasemanagementCaseplanVersionStageplanStepplans(caseplanId, versionId, stageplanId, opts) {
18235
18628
  opts = opts || {};
@@ -18265,15 +18658,14 @@ class CaseManagementApi {
18265
18658
  /**
18266
18659
  * Get a list of Stageplans.
18267
18660
  *
18268
- * @param {String} caseplanId Caseplan ID
18269
- * @param {String} versionId Version ID
18661
+ * @param {String} caseplanId Caseplan identifier.
18662
+ * @param {String} versionId Caseplan version identifier.
18270
18663
  * @param {Object} opts Optional parameters
18271
18664
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
18272
18665
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
18273
18666
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
18274
- * @param {Array.<String>} opts.expands Which fields to expand.
18667
+ * @param {Array.<String>} opts.expands Fields to expand.
18275
18668
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18276
- * getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18277
18669
  */
18278
18670
  getCasemanagementCaseplanVersionStageplans(caseplanId, versionId, opts) {
18279
18671
  opts = opts || {};
@@ -18306,12 +18698,11 @@ class CaseManagementApi {
18306
18698
  * Get a list of Caseplans.
18307
18699
  *
18308
18700
  * @param {Object} opts Optional parameters
18309
- * @param {String} opts.after The cursor that points to the end of the set of caseplans that has been returned.
18310
- * @param {Number} opts.pageSize Number of caseplans to return. Maximum of 200.
18311
- * @param {String} opts.customerIntentId Filter by Customer Intent.
18312
- * @param {String} opts.divisionIds Filter by Divisions.
18701
+ * @param {String} opts.after Cursor that points to the end of the previously returned set of Caseplans.
18702
+ * @param {Number} opts.pageSize Number of Caseplans to return. Maximum is 200.
18703
+ * @param {String} opts.customerIntentId Filter by customer intent.
18704
+ * @param {String} opts.divisionIds Filter by divisions.
18313
18705
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18314
- * getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18315
18706
  */
18316
18707
  getCasemanagementCaseplans(opts) {
18317
18708
  opts = opts || {};
@@ -18333,16 +18724,15 @@ class CaseManagementApi {
18333
18724
  }
18334
18725
 
18335
18726
  /**
18336
- * Get a list of cases for provided external contact id.
18727
+ * Get a list of Cases for an External Contact.
18337
18728
  *
18338
- * @param {String} externalContactId External Contact ID
18729
+ * @param {String} externalContactId External contact identifier.
18339
18730
  * @param {Object} opts Optional parameters
18340
- * @param {String} opts.after The cursor that points to the end of the set of cases that has been returned.
18341
- * @param {Number} opts.pageSize Number of cases to return. Maximum of 200.
18342
- * @param {String} opts.divisionIds Filter by Divisions
18343
- * @param {Array.<String>} opts.expands Which fields to expand.
18731
+ * @param {String} opts.after Cursor pointing to the end of the previously returned page of Cases.
18732
+ * @param {Number} opts.pageSize Number of Cases to return (maximum 200).
18733
+ * @param {String} opts.divisionIds Filter by divisions.
18734
+ * @param {Array.<String>} opts.expands Fields to expand.
18344
18735
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18345
- * getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18346
18736
  */
18347
18737
  getCasemanagementCasesExternalcontact(externalContactId, opts) {
18348
18738
  opts = opts || {};
@@ -18370,11 +18760,10 @@ class CaseManagementApi {
18370
18760
  /**
18371
18761
  * Get a Case by reference.
18372
18762
  *
18373
- * @param {String} referenceId Reference
18763
+ * @param {String} referenceId Case reference.
18374
18764
  * @param {Object} opts Optional parameters
18375
- * @param {Object} opts.expands Which fields to expand.
18765
+ * @param {Object} opts.expands Fields to expand.
18376
18766
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18377
- * getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18378
18767
  */
18379
18768
  getCasemanagementCasesReference(referenceId, opts) {
18380
18769
  opts = opts || {};
@@ -18400,13 +18789,12 @@ class CaseManagementApi {
18400
18789
  }
18401
18790
 
18402
18791
  /**
18403
- * Update date due of a Case.
18792
+ * Update the due date of a Case.
18404
18793
  *
18405
- * @param {String} caseId Case ID
18406
- * @param {Object} body Date due
18794
+ * @param {String} caseId Case identifier.
18795
+ * @param {Object} body Due date update.
18407
18796
  * @param {Object} opts Optional parameters
18408
18797
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18409
- * patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18410
18798
  */
18411
18799
  patchCasemanagementCaseDatedue(caseId, body, opts) {
18412
18800
  opts = opts || {};
@@ -18438,11 +18826,10 @@ class CaseManagementApi {
18438
18826
  /**
18439
18827
  * Update priority of a Case.
18440
18828
  *
18441
- * @param {String} caseId Case ID
18442
- * @param {Object} body Priority
18829
+ * @param {String} caseId Case identifier.
18830
+ * @param {Object} body Priority update.
18443
18831
  * @param {Object} opts Optional parameters
18444
18832
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18445
- * patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18446
18833
  */
18447
18834
  patchCasemanagementCasePriority(caseId, body, opts) {
18448
18835
  opts = opts || {};
@@ -18474,11 +18861,10 @@ class CaseManagementApi {
18474
18861
  /**
18475
18862
  * Update summary of a Case.
18476
18863
  *
18477
- * @param {String} caseId Case ID
18478
- * @param {Object} body Summary
18864
+ * @param {String} caseId Case identifier.
18865
+ * @param {Object} body Summary update.
18479
18866
  * @param {Object} opts Optional parameters
18480
18867
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18481
- * patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18482
18868
  */
18483
18869
  patchCasemanagementCaseSummary(caseId, body, opts) {
18484
18870
  opts = opts || {};
@@ -18510,11 +18896,10 @@ class CaseManagementApi {
18510
18896
  /**
18511
18897
  * Update the attributes of a Caseplan.
18512
18898
  *
18513
- * @param {String} caseplanId Caseplan ID
18514
- * @param {Object} body Caseplan
18899
+ * @param {String} caseplanId Caseplan identifier.
18900
+ * @param {Object} body Caseplan update.
18515
18901
  * @param {Object} opts Optional parameters
18516
18902
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18517
- * patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18518
18903
  */
18519
18904
  patchCasemanagementCaseplan(caseplanId, body, opts) {
18520
18905
  opts = opts || {};
@@ -18546,12 +18931,11 @@ class CaseManagementApi {
18546
18931
  /**
18547
18932
  * Update the attributes of a Stageplan.
18548
18933
  *
18549
- * @param {String} caseplanId Caseplan ID
18550
- * @param {String} stageplanId Stageplan ID
18551
- * @param {Object} body Stageplan
18934
+ * @param {String} caseplanId Caseplan identifier.
18935
+ * @param {String} stageplanId Stageplan identifier.
18936
+ * @param {Object} body Stageplan update.
18552
18937
  * @param {Object} opts Optional parameters
18553
18938
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18554
- * patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18555
18939
  */
18556
18940
  patchCasemanagementCaseplanStageplan(caseplanId, stageplanId, body, opts) {
18557
18941
  opts = opts || {};
@@ -18587,13 +18971,12 @@ class CaseManagementApi {
18587
18971
  /**
18588
18972
  * Update the attributes of a Stepplan.
18589
18973
  *
18590
- * @param {String} caseplanId Caseplan ID
18591
- * @param {String} stageplanId Stageplan ID
18592
- * @param {String} stepplanId Stepplan ID
18593
- * @param {Object} body Stepplan
18974
+ * @param {String} caseplanId Caseplan identifier.
18975
+ * @param {String} stageplanId Stageplan identifier.
18976
+ * @param {String} stepplanId Stepplan identifier.
18977
+ * @param {Object} body Stepplan update.
18594
18978
  * @param {Object} opts Optional parameters
18595
18979
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18596
- * patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18597
18980
  */
18598
18981
  patchCasemanagementCaseplanStageplanStepplan(caseplanId, stageplanId, stepplanId, body, opts) {
18599
18982
  opts = opts || {};
@@ -18631,21 +19014,24 @@ class CaseManagementApi {
18631
19014
  }
18632
19015
 
18633
19016
  /**
18634
- * Create a case association.
19017
+ * Create a Case association.
18635
19018
  *
18636
- * @param {String} caseId Case ID.
19019
+ * @param {String} caseId Case identifier.
19020
+ * @param {Object} body Case association create request.
18637
19021
  * @param {Object} opts Optional parameters
18638
- * @param {Object} opts.body Case Association
18639
19022
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18640
- * postCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18641
19023
  */
18642
- postCasemanagementCaseAssociations(caseId, opts) {
19024
+ postCasemanagementCaseAssociations(caseId, body, opts) {
18643
19025
  opts = opts || {};
18644
19026
 
18645
19027
  // verify the required parameter 'caseId' is set
18646
19028
  if (caseId === undefined || caseId === null || caseId === '') {
18647
19029
  throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';
18648
19030
  }
19031
+ // verify the required parameter 'body' is set
19032
+ if (body === undefined || body === null) {
19033
+ throw 'Missing the required parameter "body" when calling postCasemanagementCaseAssociations';
19034
+ }
18649
19035
 
18650
19036
  return this.apiClient.callApi(
18651
19037
  '/api/v2/casemanagement/cases/{caseId}/associations',
@@ -18654,7 +19040,7 @@ class CaseManagementApi {
18654
19040
  { },
18655
19041
  { },
18656
19042
  { },
18657
- opts['body'],
19043
+ body,
18658
19044
  ['PureCloud OAuth'],
18659
19045
  ['application/json'],
18660
19046
  ['application/json'],
@@ -18665,10 +19051,9 @@ class CaseManagementApi {
18665
19051
  /**
18666
19052
  * Create a Terminate Job for a Case.
18667
19053
  *
18668
- * @param {String} caseId Case ID
19054
+ * @param {String} caseId Case identifier.
18669
19055
  * @param {Object} opts Optional parameters
18670
19056
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18671
- * postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18672
19057
  */
18673
19058
  postCasemanagementCaseTerminateJobs(caseId, opts) {
18674
19059
  opts = opts || {};
@@ -18693,13 +19078,47 @@ class CaseManagementApi {
18693
19078
  );
18694
19079
  }
18695
19080
 
19081
+ /**
19082
+ * Add a data schema to a draft Caseplan.
19083
+ *
19084
+ * @param {String} caseplanId Caseplan identifier.
19085
+ * @param {Object} body Data schema reference.
19086
+ * @param {Object} opts Optional parameters
19087
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
19088
+ */
19089
+ postCasemanagementCaseplanDataschemas(caseplanId, body, opts) {
19090
+ opts = opts || {};
19091
+
19092
+ // verify the required parameter 'caseplanId' is set
19093
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
19094
+ throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanDataschemas';
19095
+ }
19096
+ // verify the required parameter 'body' is set
19097
+ if (body === undefined || body === null) {
19098
+ throw 'Missing the required parameter "body" when calling postCasemanagementCaseplanDataschemas';
19099
+ }
19100
+
19101
+ return this.apiClient.callApi(
19102
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas',
19103
+ 'POST',
19104
+ { 'caseplanId': caseplanId },
19105
+ { },
19106
+ { },
19107
+ { },
19108
+ body,
19109
+ ['PureCloud OAuth'],
19110
+ ['application/json'],
19111
+ ['application/json'],
19112
+ opts['customHeaders']
19113
+ );
19114
+ }
19115
+
18696
19116
  /**
18697
19117
  * Publish Caseplan.
18698
19118
  *
18699
- * @param {String} caseplanId Caseplan ID
19119
+ * @param {String} caseplanId Caseplan identifier.
18700
19120
  * @param {Object} opts Optional parameters
18701
19121
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18702
- * postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18703
19122
  */
18704
19123
  postCasemanagementCaseplanPublish(caseplanId, opts) {
18705
19124
  opts = opts || {};
@@ -18727,10 +19146,9 @@ class CaseManagementApi {
18727
19146
  /**
18728
19147
  * Create Caseplan version.
18729
19148
  *
18730
- * @param {String} caseplanId Caseplan ID
19149
+ * @param {String} caseplanId Caseplan identifier.
18731
19150
  * @param {Object} opts Optional parameters
18732
19151
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18733
- * postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18734
19152
  */
18735
19153
  postCasemanagementCaseplanVersions(caseplanId, opts) {
18736
19154
  opts = opts || {};
@@ -18758,10 +19176,9 @@ class CaseManagementApi {
18758
19176
  /**
18759
19177
  * Create a Caseplan.
18760
19178
  *
18761
- * @param {Object} body Caseplan
19179
+ * @param {Object} body Caseplan create request.
18762
19180
  * @param {Object} opts Optional parameters
18763
19181
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18764
- * postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18765
19182
  */
18766
19183
  postCasemanagementCaseplans(body, opts) {
18767
19184
  opts = opts || {};
@@ -18787,12 +19204,11 @@ class CaseManagementApi {
18787
19204
  }
18788
19205
 
18789
19206
  /**
18790
- * Query for caseplans
19207
+ * Query for Caseplans.
18791
19208
  *
18792
- * @param {Object} body CaseplanQueryRequest
19209
+ * @param {Object} body Caseplan query request.
18793
19210
  * @param {Object} opts Optional parameters
18794
19211
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18795
- * postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18796
19212
  */
18797
19213
  postCasemanagementCaseplansQuery(body, opts) {
18798
19214
  opts = opts || {};
@@ -18820,10 +19236,9 @@ class CaseManagementApi {
18820
19236
  /**
18821
19237
  * Create a Case.
18822
19238
  *
18823
- * @param {Object} body Case
19239
+ * @param {Object} body Case create request.
18824
19240
  * @param {Object} opts Optional parameters
18825
19241
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18826
- * postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18827
19242
  */
18828
19243
  postCasemanagementCases(body, opts) {
18829
19244
  opts = opts || {};
@@ -18849,16 +19264,19 @@ class CaseManagementApi {
18849
19264
  }
18850
19265
 
18851
19266
  /**
18852
- * Query for case associations
19267
+ * Query for Case associations by interaction.
18853
19268
  *
19269
+ * @param {Object} body Case association query request.
18854
19270
  * @param {Object} opts Optional parameters
18855
- * @param {Object} opts.body Case Association
18856
19271
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18857
- * postCasemanagementCasesAssociationsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18858
19272
  */
18859
- postCasemanagementCasesAssociationsQuery(opts) {
19273
+ postCasemanagementCasesAssociationsQuery(body, opts) {
18860
19274
  opts = opts || {};
18861
19275
 
19276
+ // verify the required parameter 'body' is set
19277
+ if (body === undefined || body === null) {
19278
+ throw 'Missing the required parameter "body" when calling postCasemanagementCasesAssociationsQuery';
19279
+ }
18862
19280
 
18863
19281
  return this.apiClient.callApi(
18864
19282
  '/api/v2/casemanagement/cases/associations/query',
@@ -18867,7 +19285,47 @@ class CaseManagementApi {
18867
19285
  { },
18868
19286
  { },
18869
19287
  { },
18870
- opts['body'],
19288
+ body,
19289
+ ['PureCloud OAuth'],
19290
+ ['application/json'],
19291
+ ['application/json'],
19292
+ opts['customHeaders']
19293
+ );
19294
+ }
19295
+
19296
+ /**
19297
+ * Update a data schema on a draft Caseplan.
19298
+ *
19299
+ * @param {String} caseplanId Caseplan identifier.
19300
+ * @param {String} schemaKeyName Schema key (for example default).
19301
+ * @param {Object} body Data schema reference.
19302
+ * @param {Object} opts Optional parameters
19303
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
19304
+ */
19305
+ putCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, body, opts) {
19306
+ opts = opts || {};
19307
+
19308
+ // verify the required parameter 'caseplanId' is set
19309
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
19310
+ throw 'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanDataschema';
19311
+ }
19312
+ // verify the required parameter 'schemaKeyName' is set
19313
+ if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
19314
+ throw 'Missing the required parameter "schemaKeyName" when calling putCasemanagementCaseplanDataschema';
19315
+ }
19316
+ // verify the required parameter 'body' is set
19317
+ if (body === undefined || body === null) {
19318
+ throw 'Missing the required parameter "body" when calling putCasemanagementCaseplanDataschema';
19319
+ }
19320
+
19321
+ return this.apiClient.callApi(
19322
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
19323
+ 'PUT',
19324
+ { 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
19325
+ { },
19326
+ { },
19327
+ { },
19328
+ body,
18871
19329
  ['PureCloud OAuth'],
18872
19330
  ['application/json'],
18873
19331
  ['application/json'],
@@ -18878,11 +19336,10 @@ class CaseManagementApi {
18878
19336
  /**
18879
19337
  * Update the intake settings for a Caseplan.
18880
19338
  *
18881
- * @param {String} caseplanId Caseplan ID
18882
- * @param {Object} body Intake Settings
19339
+ * @param {String} caseplanId Caseplan identifier.
19340
+ * @param {Object} body Intake settings update.
18883
19341
  * @param {Object} opts Optional parameters
18884
19342
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18885
- * putCasemanagementCaseplanIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18886
19343
  */
18887
19344
  putCasemanagementCaseplanIntakesettings(caseplanId, body, opts) {
18888
19345
  opts = opts || {};
@@ -18917,7 +19374,7 @@ class ChatApi {
18917
19374
  /**
18918
19375
  * Chat service.
18919
19376
  * @module purecloud-platform-client-v2/api/ChatApi
18920
- * @version 252.1.0
19377
+ * @version 254.0.0
18921
19378
  */
18922
19379
 
18923
19380
  /**
@@ -20056,7 +20513,7 @@ class CoachingApi {
20056
20513
  /**
20057
20514
  * Coaching service.
20058
20515
  * @module purecloud-platform-client-v2/api/CoachingApi
20059
- * @version 252.1.0
20516
+ * @version 254.0.0
20060
20517
  */
20061
20518
 
20062
20519
  /**
@@ -20770,7 +21227,7 @@ class ContentManagementApi {
20770
21227
  /**
20771
21228
  * ContentManagement service.
20772
21229
  * @module purecloud-platform-client-v2/api/ContentManagementApi
20773
- * @version 252.1.0
21230
+ * @version 254.0.0
20774
21231
  */
20775
21232
 
20776
21233
  /**
@@ -21965,7 +22422,7 @@ class ConversationsApi {
21965
22422
  /**
21966
22423
  * Conversations service.
21967
22424
  * @module purecloud-platform-client-v2/api/ConversationsApi
21968
- * @version 252.1.0
22425
+ * @version 254.0.0
21969
22426
  */
21970
22427
 
21971
22428
  /**
@@ -21986,7 +22443,6 @@ class ConversationsApi {
21986
22443
  * @param {String} jobId jobId
21987
22444
  * @param {Object} opts Optional parameters
21988
22445
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
21989
- * deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21990
22446
  */
21991
22447
  deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
21992
22448
  opts = opts || {};
@@ -22653,7 +23109,6 @@ class ConversationsApi {
22653
23109
  * @param {String} jobId jobId
22654
23110
  * @param {Object} opts Optional parameters
22655
23111
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
22656
- * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22657
23112
  */
22658
23113
  getAnalyticsConversationsAggregatesJob(jobId, opts) {
22659
23114
  opts = opts || {};
@@ -22685,7 +23140,6 @@ class ConversationsApi {
22685
23140
  * @param {Object} opts Optional parameters
22686
23141
  * @param {String} opts.cursor Cursor token to retrieve next page
22687
23142
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
22688
- * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22689
23143
  */
22690
23144
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
22691
23145
  opts = opts || {};
@@ -28532,7 +28986,6 @@ class ConversationsApi {
28532
28986
  * @param {Object} body query
28533
28987
  * @param {Object} opts Optional parameters
28534
28988
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
28535
- * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28536
28989
  */
28537
28990
  postAnalyticsConversationsAggregatesJobs(body, opts) {
28538
28991
  opts = opts || {};
@@ -31517,7 +31970,7 @@ class ConversationsApi {
31517
31970
 
31518
31971
  /**
31519
31972
  * Send an agentless outbound message
31520
- * Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and toAddress specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
31973
+ * Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and recipient specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
31521
31974
  * @param {Object} body Create agentless outbound messaging request
31522
31975
  * @param {Object} opts Optional parameters
31523
31976
  * @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, messagingTemplate) (default to false)
@@ -33071,7 +33524,7 @@ class DataExtensionsApi {
33071
33524
  /**
33072
33525
  * DataExtensions service.
33073
33526
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
33074
- * @version 252.1.0
33527
+ * @version 254.0.0
33075
33528
  */
33076
33529
 
33077
33530
  /**
@@ -33172,7 +33625,7 @@ class DataPrivacyApi {
33172
33625
  /**
33173
33626
  * DataPrivacy service.
33174
33627
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
33175
- * @version 252.1.0
33628
+ * @version 254.0.0
33176
33629
  */
33177
33630
 
33178
33631
  /**
@@ -33369,7 +33822,7 @@ class DownloadsApi {
33369
33822
  /**
33370
33823
  * Downloads service.
33371
33824
  * @module purecloud-platform-client-v2/api/DownloadsApi
33372
- * @version 252.1.0
33825
+ * @version 254.0.0
33373
33826
  */
33374
33827
 
33375
33828
  /**
@@ -33423,7 +33876,7 @@ class EmailsApi {
33423
33876
  /**
33424
33877
  * Emails service.
33425
33878
  * @module purecloud-platform-client-v2/api/EmailsApi
33426
- * @version 252.1.0
33879
+ * @version 254.0.0
33427
33880
  */
33428
33881
 
33429
33882
  /**
@@ -33571,7 +34024,7 @@ class EmployeeEngagementApi {
33571
34024
  /**
33572
34025
  * EmployeeEngagement service.
33573
34026
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
33574
- * @version 252.1.0
34027
+ * @version 254.0.0
33575
34028
  */
33576
34029
 
33577
34030
  /**
@@ -33775,7 +34228,7 @@ class EventsApi {
33775
34228
  /**
33776
34229
  * Events service.
33777
34230
  * @module purecloud-platform-client-v2/api/EventsApi
33778
- * @version 252.1.0
34231
+ * @version 254.0.0
33779
34232
  */
33780
34233
 
33781
34234
  /**
@@ -33917,7 +34370,7 @@ class ExternalContactsApi {
33917
34370
  /**
33918
34371
  * ExternalContacts service.
33919
34372
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
33920
- * @version 252.1.0
34373
+ * @version 254.0.0
33921
34374
  */
33922
34375
 
33923
34376
  /**
@@ -37688,7 +38141,7 @@ class FaxApi {
37688
38141
  /**
37689
38142
  * Fax service.
37690
38143
  * @module purecloud-platform-client-v2/api/FaxApi
37691
- * @version 252.1.0
38144
+ * @version 254.0.0
37692
38145
  */
37693
38146
 
37694
38147
  /**
@@ -37937,7 +38390,7 @@ class FlowsApi {
37937
38390
  /**
37938
38391
  * Flows service.
37939
38392
  * @module purecloud-platform-client-v2/api/FlowsApi
37940
- * @version 252.1.0
38393
+ * @version 254.0.0
37941
38394
  */
37942
38395
 
37943
38396
  /**
@@ -37958,7 +38411,6 @@ class FlowsApi {
37958
38411
  * @param {String} jobId jobId
37959
38412
  * @param {Object} opts Optional parameters
37960
38413
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
37961
- * deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37962
38414
  */
37963
38415
  deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
37964
38416
  opts = opts || {};
@@ -37989,7 +38441,6 @@ class FlowsApi {
37989
38441
  * @param {String} jobId jobId
37990
38442
  * @param {Object} opts Optional parameters
37991
38443
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
37992
- * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37993
38444
  */
37994
38445
  getAnalyticsFlowsAggregatesJob(jobId, opts) {
37995
38446
  opts = opts || {};
@@ -38021,7 +38472,6 @@ class FlowsApi {
38021
38472
  * @param {Object} opts Optional parameters
38022
38473
  * @param {String} opts.cursor Cursor token to retrieve next page
38023
38474
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
38024
- * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38025
38475
  */
38026
38476
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
38027
38477
  opts = opts || {};
@@ -38084,7 +38534,6 @@ class FlowsApi {
38084
38534
  * @param {Object} body query
38085
38535
  * @param {Object} opts Optional parameters
38086
38536
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
38087
- * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38088
38537
  */
38089
38538
  postAnalyticsFlowsAggregatesJobs(body, opts) {
38090
38539
  opts = opts || {};
@@ -38175,7 +38624,7 @@ class GamificationApi {
38175
38624
  /**
38176
38625
  * Gamification service.
38177
38626
  * @module purecloud-platform-client-v2/api/GamificationApi
38178
- * @version 252.1.0
38627
+ * @version 254.0.0
38179
38628
  */
38180
38629
 
38181
38630
  /**
@@ -41027,7 +41476,7 @@ class GeneralDataProtectionRegulationApi {
41027
41476
  /**
41028
41477
  * GeneralDataProtectionRegulation service.
41029
41478
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
41030
- * @version 252.1.0
41479
+ * @version 254.0.0
41031
41480
  */
41032
41481
 
41033
41482
  /**
@@ -41171,7 +41620,7 @@ class GeolocationApi {
41171
41620
  /**
41172
41621
  * Geolocation service.
41173
41622
  * @module purecloud-platform-client-v2/api/GeolocationApi
41174
- * @version 252.1.0
41623
+ * @version 254.0.0
41175
41624
  */
41176
41625
 
41177
41626
  /**
@@ -41322,7 +41771,7 @@ class GreetingsApi {
41322
41771
  /**
41323
41772
  * Greetings service.
41324
41773
  * @module purecloud-platform-client-v2/api/GreetingsApi
41325
- * @version 252.1.0
41774
+ * @version 254.0.0
41326
41775
  */
41327
41776
 
41328
41777
  /**
@@ -41938,7 +42387,7 @@ class GroupsApi {
41938
42387
  /**
41939
42388
  * Groups service.
41940
42389
  * @module purecloud-platform-client-v2/api/GroupsApi
41941
- * @version 252.1.0
42390
+ * @version 254.0.0
41942
42391
  */
41943
42392
 
41944
42393
  /**
@@ -42529,7 +42978,7 @@ class IdentityProviderApi {
42529
42978
  /**
42530
42979
  * IdentityProvider service.
42531
42980
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
42532
- * @version 252.1.0
42981
+ * @version 254.0.0
42533
42982
  */
42534
42983
 
42535
42984
  /**
@@ -43580,7 +44029,7 @@ class InfrastructureAsCodeApi {
43580
44029
  /**
43581
44030
  * InfrastructureAsCode service.
43582
44031
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
43583
- * @version 252.1.0
44032
+ * @version 254.0.0
43584
44033
  */
43585
44034
 
43586
44035
  /**
@@ -43760,7 +44209,7 @@ class IntegrationsApi {
43760
44209
  /**
43761
44210
  * Integrations service.
43762
44211
  * @module purecloud-platform-client-v2/api/IntegrationsApi
43763
- * @version 252.1.0
44212
+ * @version 254.0.0
43764
44213
  */
43765
44214
 
43766
44215
  /**
@@ -46732,7 +47181,7 @@ class IntentsApi {
46732
47181
  /**
46733
47182
  * Intents service.
46734
47183
  * @module purecloud-platform-client-v2/api/IntentsApi
46735
- * @version 252.1.0
47184
+ * @version 254.0.0
46736
47185
  */
46737
47186
 
46738
47187
  /**
@@ -47264,7 +47713,7 @@ class JourneyApi {
47264
47713
  /**
47265
47714
  * Journey service.
47266
47715
  * @module purecloud-platform-client-v2/api/JourneyApi
47267
- * @version 252.1.0
47716
+ * @version 254.0.0
47268
47717
  */
47269
47718
 
47270
47719
  /**
@@ -47285,7 +47734,6 @@ class JourneyApi {
47285
47734
  * @param {String} jobId jobId
47286
47735
  * @param {Object} opts Optional parameters
47287
47736
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
47288
- * deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47289
47737
  */
47290
47738
  deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
47291
47739
  opts = opts || {};
@@ -47589,7 +48037,6 @@ class JourneyApi {
47589
48037
  * @param {String} jobId jobId
47590
48038
  * @param {Object} opts Optional parameters
47591
48039
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
47592
- * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47593
48040
  */
47594
48041
  getAnalyticsJourneysAggregatesJob(jobId, opts) {
47595
48042
  opts = opts || {};
@@ -47621,7 +48068,6 @@ class JourneyApi {
47621
48068
  * @param {Object} opts Optional parameters
47622
48069
  * @param {String} opts.cursor Cursor token to retrieve next page
47623
48070
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
47624
- * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47625
48071
  */
47626
48072
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
47627
48073
  opts = opts || {};
@@ -47837,11 +48283,12 @@ class JourneyApi {
47837
48283
  }
47838
48284
 
47839
48285
  /**
47840
- * Retrieve a single action target.
47841
- *
48286
+ * Deprecated. Retrieve a single action target.
48287
+ * ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
47842
48288
  * @param {String} actionTargetId ID of the action target.
47843
48289
  * @param {Object} opts Optional parameters
47844
48290
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
48291
+ * @deprecated
47845
48292
  */
47846
48293
  getJourneyActiontarget(actionTargetId, opts) {
47847
48294
  opts = opts || {};
@@ -47867,12 +48314,13 @@ class JourneyApi {
47867
48314
  }
47868
48315
 
47869
48316
  /**
47870
- * Retrieve all action targets.
47871
- *
48317
+ * Deprecated. Retrieve all action targets.
48318
+ * ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
47872
48319
  * @param {Object} opts Optional parameters
47873
48320
  * @param {Number} opts.pageNumber Page number (default to 1)
47874
48321
  * @param {Number} opts.pageSize Page size (default to 25)
47875
48322
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
48323
+ * @deprecated
47876
48324
  */
47877
48325
  getJourneyActiontargets(opts) {
47878
48326
  opts = opts || {};
@@ -49042,6 +49490,56 @@ class JourneyApi {
49042
49490
  );
49043
49491
  }
49044
49492
 
49493
+ /**
49494
+ * Get external events for journey views
49495
+ *
49496
+ * @param {Object} opts Optional parameters
49497
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
49498
+ */
49499
+ getJourneyViewsEventdefinitionsExternal(opts) {
49500
+ opts = opts || {};
49501
+
49502
+
49503
+ return this.apiClient.callApi(
49504
+ '/api/v2/journey/views/eventdefinitions/external',
49505
+ 'GET',
49506
+ { },
49507
+ { },
49508
+ { },
49509
+ { },
49510
+ null,
49511
+ ['PureCloud OAuth'],
49512
+ ['application/json'],
49513
+ ['application/json'],
49514
+ opts['customHeaders']
49515
+ );
49516
+ }
49517
+
49518
+ /**
49519
+ * Get changes in external event definitions
49520
+ *
49521
+ * @param {Object} opts Optional parameters
49522
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
49523
+ */
49524
+ getJourneyViewsEventdefinitionsExternalChanges(opts) {
49525
+ opts = opts || {};
49526
+
49527
+
49528
+ return this.apiClient.callApi(
49529
+ '/api/v2/journey/views/eventdefinitions/external/changes',
49530
+ 'GET',
49531
+ { },
49532
+ { },
49533
+ { },
49534
+ { },
49535
+ null,
49536
+ ['PureCloud OAuth'],
49537
+ ['application/json'],
49538
+ ['application/json'],
49539
+ opts['customHeaders']
49540
+ );
49541
+ }
49542
+
49045
49543
  /**
49046
49544
  * Get the jobs for an organization.
49047
49545
  *
@@ -49159,12 +49657,13 @@ class JourneyApi {
49159
49657
  }
49160
49658
 
49161
49659
  /**
49162
- * Update a single action target.
49163
- *
49660
+ * Deprecated. Update a single action target.
49661
+ * ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
49164
49662
  * @param {String} actionTargetId ID of the action target.
49165
49663
  * @param {Object} opts Optional parameters
49166
49664
  * @param {Object} opts.body
49167
49665
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
49666
+ * @deprecated
49168
49667
  */
49169
49668
  patchJourneyActiontarget(actionTargetId, opts) {
49170
49669
  opts = opts || {};
@@ -49365,7 +49864,6 @@ class JourneyApi {
49365
49864
  * @param {Object} body query
49366
49865
  * @param {Object} opts Optional parameters
49367
49866
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
49368
- * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49369
49867
  */
49370
49868
  postAnalyticsJourneysAggregatesJobs(body, opts) {
49371
49869
  opts = opts || {};
@@ -50123,13 +50621,75 @@ class JourneyApi {
50123
50621
  );
50124
50622
  }
50125
50623
 
50624
+ /**
50625
+ * Update external event for journey views
50626
+ *
50627
+ * @param {String} eventDefinitionId Event Definition ID
50628
+ * @param {Object} opts Optional parameters
50629
+ * @param {Object} opts.body
50630
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
50631
+ */
50632
+ putJourneyViewsEventdefinition(eventDefinitionId, opts) {
50633
+ opts = opts || {};
50634
+
50635
+ // verify the required parameter 'eventDefinitionId' is set
50636
+ if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
50637
+ throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';
50638
+ }
50639
+
50640
+ return this.apiClient.callApi(
50641
+ '/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
50642
+ 'PUT',
50643
+ { 'eventDefinitionId': eventDefinitionId },
50644
+ { },
50645
+ { },
50646
+ { },
50647
+ opts['body'],
50648
+ ['PureCloud OAuth'],
50649
+ ['application/json'],
50650
+ ['application/json'],
50651
+ opts['customHeaders']
50652
+ );
50653
+ }
50654
+
50655
+ /**
50656
+ * Activate external event for journey views
50657
+ *
50658
+ * @param {String} eventDefinitionId Event Definition ID
50659
+ * @param {Object} opts Optional parameters
50660
+ * @param {Object} opts.body
50661
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
50662
+ */
50663
+ putJourneyViewsEventdefinitionActivate(eventDefinitionId, opts) {
50664
+ opts = opts || {};
50665
+
50666
+ // verify the required parameter 'eventDefinitionId' is set
50667
+ if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
50668
+ throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';
50669
+ }
50670
+
50671
+ return this.apiClient.callApi(
50672
+ '/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate',
50673
+ 'PUT',
50674
+ { 'eventDefinitionId': eventDefinitionId },
50675
+ { },
50676
+ { },
50677
+ { },
50678
+ opts['body'],
50679
+ ['PureCloud OAuth'],
50680
+ ['application/json'],
50681
+ ['application/json'],
50682
+ opts['customHeaders']
50683
+ );
50684
+ }
50685
+
50126
50686
  }
50127
50687
 
50128
50688
  class KnowledgeApi {
50129
50689
  /**
50130
50690
  * Knowledge service.
50131
50691
  * @module purecloud-platform-client-v2/api/KnowledgeApi
50132
- * @version 252.1.0
50692
+ * @version 254.0.0
50133
50693
  */
50134
50694
 
50135
50695
  /**
@@ -51328,6 +51888,47 @@ class KnowledgeApi {
51328
51888
  );
51329
51889
  }
51330
51890
 
51891
+ /**
51892
+ * Get a list of feedback records given on documents in a knowledge base
51893
+ *
51894
+ * @param {String} knowledgeBaseId Knowledge base ID.
51895
+ * @param {Object} opts Optional parameters
51896
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
51897
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
51898
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
51899
+ * @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
51900
+ * @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
51901
+ * @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
51902
+ * @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
51903
+ * @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
51904
+ * @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
51905
+ * @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
51906
+ * @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
51907
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
51908
+ */
51909
+ getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId, opts) {
51910
+ opts = opts || {};
51911
+
51912
+ // verify the required parameter 'knowledgeBaseId' is set
51913
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
51914
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentsFeedback';
51915
+ }
51916
+
51917
+ return this.apiClient.callApi(
51918
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback',
51919
+ 'GET',
51920
+ { 'knowledgeBaseId': knowledgeBaseId },
51921
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'onlyCommented': opts['onlyCommented'],'documentVersionId': opts['documentVersionId'],'documentVariationId': opts['documentVariationId'],'appType': opts['appType'],'queryType': opts['queryType'],'userId': opts['userId'],'queueId': opts['queueId'],'state': opts['state'] },
51922
+ { },
51923
+ { },
51924
+ null,
51925
+ ['PureCloud OAuth'],
51926
+ ['application/json'],
51927
+ ['application/json'],
51928
+ opts['customHeaders']
51929
+ );
51930
+ }
51931
+
51331
51932
  /**
51332
51933
  * Get export job report
51333
51934
  *
@@ -54339,7 +54940,7 @@ class LanguageUnderstandingApi {
54339
54940
  /**
54340
54941
  * LanguageUnderstanding service.
54341
54942
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
54342
- * @version 252.1.0
54943
+ * @version 254.0.0
54343
54944
  */
54344
54945
 
54345
54946
  /**
@@ -55713,7 +56314,7 @@ class LanguagesApi {
55713
56314
  /**
55714
56315
  * Languages service.
55715
56316
  * @module purecloud-platform-client-v2/api/LanguagesApi
55716
- * @version 252.1.0
56317
+ * @version 254.0.0
55717
56318
  */
55718
56319
 
55719
56320
  /**
@@ -55972,7 +56573,7 @@ class LearningApi {
55972
56573
  /**
55973
56574
  * Learning service.
55974
56575
  * @module purecloud-platform-client-v2/api/LearningApi
55975
- * @version 252.1.0
56576
+ * @version 254.0.0
55976
56577
  */
55977
56578
 
55978
56579
  /**
@@ -57220,7 +57821,7 @@ class LicenseApi {
57220
57821
  /**
57221
57822
  * License service.
57222
57823
  * @module purecloud-platform-client-v2/api/LicenseApi
57223
- * @version 252.1.0
57824
+ * @version 254.0.0
57224
57825
  */
57225
57826
 
57226
57827
  /**
@@ -57518,7 +58119,7 @@ class LocationsApi {
57518
58119
  /**
57519
58120
  * Locations service.
57520
58121
  * @module purecloud-platform-client-v2/api/LocationsApi
57521
- * @version 252.1.0
58122
+ * @version 254.0.0
57522
58123
  */
57523
58124
 
57524
58125
  /**
@@ -57785,7 +58386,7 @@ class LogCaptureApi {
57785
58386
  /**
57786
58387
  * LogCapture service.
57787
58388
  * @module purecloud-platform-client-v2/api/LogCaptureApi
57788
- * @version 252.1.0
58389
+ * @version 254.0.0
57789
58390
  */
57790
58391
 
57791
58392
  /**
@@ -58007,7 +58608,7 @@ class MessagingApi {
58007
58608
  /**
58008
58609
  * Messaging service.
58009
58610
  * @module purecloud-platform-client-v2/api/MessagingApi
58010
- * @version 252.1.0
58611
+ * @version 254.0.0
58011
58612
  */
58012
58613
 
58013
58614
  /**
@@ -58425,7 +59026,7 @@ class MobileDevicesApi {
58425
59026
  /**
58426
59027
  * MobileDevices service.
58427
59028
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
58428
- * @version 252.1.0
59029
+ * @version 254.0.0
58429
59030
  */
58430
59031
 
58431
59032
  /**
@@ -58595,7 +59196,7 @@ class NotificationsApi {
58595
59196
  /**
58596
59197
  * Notifications service.
58597
59198
  * @module purecloud-platform-client-v2/api/NotificationsApi
58598
- * @version 252.1.0
59199
+ * @version 254.0.0
58599
59200
  */
58600
59201
 
58601
59202
  /**
@@ -58856,7 +59457,7 @@ class OAuthApi {
58856
59457
  /**
58857
59458
  * OAuth service.
58858
59459
  * @module purecloud-platform-client-v2/api/OAuthApi
58859
- * @version 252.1.0
59460
+ * @version 254.0.0
58860
59461
  */
58861
59462
 
58862
59463
  /**
@@ -59272,7 +59873,7 @@ class ObjectsApi {
59272
59873
  /**
59273
59874
  * Objects service.
59274
59875
  * @module purecloud-platform-client-v2/api/ObjectsApi
59275
- * @version 252.1.0
59876
+ * @version 254.0.0
59276
59877
  */
59277
59878
 
59278
59879
  /**
@@ -59636,7 +60237,7 @@ class OperationalEventsApi {
59636
60237
  /**
59637
60238
  * OperationalEvents service.
59638
60239
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
59639
- * @version 252.1.0
60240
+ * @version 254.0.0
59640
60241
  */
59641
60242
 
59642
60243
  /**
@@ -59767,7 +60368,7 @@ class OrganizationApi {
59767
60368
  /**
59768
60369
  * Organization service.
59769
60370
  * @module purecloud-platform-client-v2/api/OrganizationApi
59770
- * @version 252.1.0
60371
+ * @version 254.0.0
59771
60372
  */
59772
60373
 
59773
60374
  /**
@@ -60328,7 +60929,7 @@ class OrganizationAuthorizationApi {
60328
60929
  /**
60329
60930
  * OrganizationAuthorization service.
60330
60931
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
60331
- * @version 252.1.0
60932
+ * @version 254.0.0
60332
60933
  */
60333
60934
 
60334
60935
  /**
@@ -61932,7 +62533,7 @@ class OutboundApi {
61932
62533
  /**
61933
62534
  * Outbound service.
61934
62535
  * @module purecloud-platform-client-v2/api/OutboundApi
61935
- * @version 252.1.0
62536
+ * @version 254.0.0
61936
62537
  */
61937
62538
 
61938
62539
  /**
@@ -67519,7 +68120,7 @@ class PresenceApi {
67519
68120
  /**
67520
68121
  * Presence service.
67521
68122
  * @module purecloud-platform-client-v2/api/PresenceApi
67522
- * @version 252.1.0
68123
+ * @version 254.0.0
67523
68124
  */
67524
68125
 
67525
68126
  /**
@@ -68377,7 +68978,7 @@ class ProcessAutomationApi {
68377
68978
  /**
68378
68979
  * ProcessAutomation service.
68379
68980
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
68380
- * @version 252.1.0
68981
+ * @version 254.0.0
68381
68982
  */
68382
68983
 
68383
68984
  /**
@@ -68798,7 +69399,7 @@ class QualityApi {
68798
69399
  /**
68799
69400
  * Quality service.
68800
69401
  * @module purecloud-platform-client-v2/api/QualityApi
68801
- * @version 252.1.0
69402
+ * @version 254.0.0
68802
69403
  */
68803
69404
 
68804
69405
  /**
@@ -68819,7 +69420,6 @@ class QualityApi {
68819
69420
  * @param {String} jobId jobId
68820
69421
  * @param {Object} opts Optional parameters
68821
69422
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
68822
- * deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
68823
69423
  */
68824
69424
  deleteAnalyticsEvaluationsAggregatesJob(jobId, opts) {
68825
69425
  opts = opts || {};
@@ -68850,7 +69450,6 @@ class QualityApi {
68850
69450
  * @param {String} jobId jobId
68851
69451
  * @param {Object} opts Optional parameters
68852
69452
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
68853
- * deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
68854
69453
  */
68855
69454
  deleteAnalyticsSurveysAggregatesJob(jobId, opts) {
68856
69455
  opts = opts || {};
@@ -69078,7 +69677,6 @@ class QualityApi {
69078
69677
  * @param {String} jobId jobId
69079
69678
  * @param {Object} opts Optional parameters
69080
69679
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69081
- * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69082
69680
  */
69083
69681
  getAnalyticsEvaluationsAggregatesJob(jobId, opts) {
69084
69682
  opts = opts || {};
@@ -69110,7 +69708,6 @@ class QualityApi {
69110
69708
  * @param {Object} opts Optional parameters
69111
69709
  * @param {String} opts.cursor Cursor token to retrieve next page
69112
69710
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69113
- * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69114
69711
  */
69115
69712
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
69116
69713
  opts = opts || {};
@@ -69141,7 +69738,6 @@ class QualityApi {
69141
69738
  * @param {String} jobId jobId
69142
69739
  * @param {Object} opts Optional parameters
69143
69740
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69144
- * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69145
69741
  */
69146
69742
  getAnalyticsSurveysAggregatesJob(jobId, opts) {
69147
69743
  opts = opts || {};
@@ -69173,7 +69769,6 @@ class QualityApi {
69173
69769
  * @param {Object} opts Optional parameters
69174
69770
  * @param {String} opts.cursor Cursor token to retrieve next page
69175
69771
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69176
- * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69177
69772
  */
69178
69773
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
69179
69774
  opts = opts || {};
@@ -70277,7 +70872,6 @@ class QualityApi {
70277
70872
  * @param {Object} body query
70278
70873
  * @param {Object} opts Optional parameters
70279
70874
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
70280
- * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70281
70875
  */
70282
70876
  postAnalyticsEvaluationsAggregatesJobs(body, opts) {
70283
70877
  opts = opts || {};
@@ -70338,7 +70932,6 @@ class QualityApi {
70338
70932
  * @param {Object} body query
70339
70933
  * @param {Object} opts Optional parameters
70340
70934
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
70341
- * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70342
70935
  */
70343
70936
  postAnalyticsSurveysAggregatesJobs(body, opts) {
70344
70937
  opts = opts || {};
@@ -71156,7 +71749,7 @@ class RecordingApi {
71156
71749
  /**
71157
71750
  * Recording service.
71158
71751
  * @module purecloud-platform-client-v2/api/RecordingApi
71159
- * @version 252.1.0
71752
+ * @version 254.0.0
71160
71753
  */
71161
71754
 
71162
71755
  /**
@@ -73004,7 +73597,7 @@ class ResponseManagementApi {
73004
73597
  /**
73005
73598
  * ResponseManagement service.
73006
73599
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
73007
- * @version 252.1.0
73600
+ * @version 254.0.0
73008
73601
  */
73009
73602
 
73010
73603
  /**
@@ -73648,7 +74241,7 @@ class RoutingApi {
73648
74241
  /**
73649
74242
  * Routing service.
73650
74243
  * @module purecloud-platform-client-v2/api/RoutingApi
73651
- * @version 252.1.0
74244
+ * @version 254.0.0
73652
74245
  */
73653
74246
 
73654
74247
  /**
@@ -73813,6 +74406,36 @@ class RoutingApi {
73813
74406
  );
73814
74407
  }
73815
74408
 
74409
+ /**
74410
+ * Delete an email setting. Removes the email setting and its associated settings
74411
+ *
74412
+ * @param {String} emailSettingId Email Setting ID
74413
+ * @param {Object} opts Optional parameters
74414
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
74415
+ */
74416
+ deleteRoutingEmailSettingEmailSettingId(emailSettingId, opts) {
74417
+ opts = opts || {};
74418
+
74419
+ // verify the required parameter 'emailSettingId' is set
74420
+ if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
74421
+ throw 'Missing the required parameter "emailSettingId" when calling deleteRoutingEmailSettingEmailSettingId';
74422
+ }
74423
+
74424
+ return this.apiClient.callApi(
74425
+ '/api/v2/routing/email/setting/{emailSettingId}',
74426
+ 'DELETE',
74427
+ { 'emailSettingId': emailSettingId },
74428
+ { },
74429
+ { },
74430
+ { },
74431
+ null,
74432
+ ['PureCloud OAuth'],
74433
+ ['application/json'],
74434
+ ['application/json'],
74435
+ opts['customHeaders']
74436
+ );
74437
+ }
74438
+
73816
74439
  /**
73817
74440
  * Delete a routing language
73818
74441
  *
@@ -74096,6 +74719,62 @@ class RoutingApi {
74096
74719
  );
74097
74720
  }
74098
74721
 
74722
+ /**
74723
+ * Archive a skill expression to remove it from the set of active expressions
74724
+ *
74725
+ * @param {String} expressionId Expression ID
74726
+ * @param {Object} opts Optional parameters
74727
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
74728
+ */
74729
+ deleteRoutingSkillexpression(expressionId, opts) {
74730
+ opts = opts || {};
74731
+
74732
+ // verify the required parameter 'expressionId' is set
74733
+ if (expressionId === undefined || expressionId === null || expressionId === '') {
74734
+ throw 'Missing the required parameter "expressionId" when calling deleteRoutingSkillexpression';
74735
+ }
74736
+
74737
+ return this.apiClient.callApi(
74738
+ '/api/v2/routing/skillexpressions/{expressionId}',
74739
+ 'DELETE',
74740
+ { 'expressionId': expressionId },
74741
+ { },
74742
+ { },
74743
+ { },
74744
+ null,
74745
+ ['PureCloud OAuth'],
74746
+ ['application/json'],
74747
+ ['application/json'],
74748
+ opts['customHeaders']
74749
+ );
74750
+ }
74751
+
74752
+ /**
74753
+ * Archive a set of skill expressions to remove them from the set of active expressions
74754
+ *
74755
+ * @param {Object} opts Optional parameters
74756
+ * @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
74757
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
74758
+ */
74759
+ deleteRoutingSkillexpressions(opts) {
74760
+ opts = opts || {};
74761
+
74762
+
74763
+ return this.apiClient.callApi(
74764
+ '/api/v2/routing/skillexpressions',
74765
+ 'DELETE',
74766
+ { },
74767
+ { 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
74768
+ { },
74769
+ { },
74770
+ null,
74771
+ ['PureCloud OAuth'],
74772
+ ['application/json'],
74773
+ ['application/json'],
74774
+ opts['customHeaders']
74775
+ );
74776
+ }
74777
+
74099
74778
  /**
74100
74779
  * Remove skill group definition
74101
74780
  *
@@ -74302,38 +74981,6 @@ class RoutingApi {
74302
74981
  );
74303
74982
  }
74304
74983
 
74305
- /**
74306
- * Delete an utilization tag
74307
- *
74308
- * @param {String} tagId Utilization Tag ID
74309
- * @param {Object} opts Optional parameters
74310
- * @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
74311
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
74312
- * deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
74313
- */
74314
- deleteRoutingUtilizationTag(tagId, opts) {
74315
- opts = opts || {};
74316
-
74317
- // verify the required parameter 'tagId' is set
74318
- if (tagId === undefined || tagId === null || tagId === '') {
74319
- throw 'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';
74320
- }
74321
-
74322
- return this.apiClient.callApi(
74323
- '/api/v2/routing/utilization/tags/{tagId}',
74324
- 'DELETE',
74325
- { 'tagId': tagId },
74326
- { 'forceDelete': opts['forceDelete'] },
74327
- { },
74328
- { },
74329
- null,
74330
- ['PureCloud OAuth'],
74331
- ['application/json'],
74332
- ['application/json'],
74333
- opts['customHeaders']
74334
- );
74335
- }
74336
-
74337
74984
  /**
74338
74985
  * Delete wrap-up code
74339
74986
  *
@@ -74946,6 +75593,63 @@ class RoutingApi {
74946
75593
  );
74947
75594
  }
74948
75595
 
75596
+ /**
75597
+ * Get a paged list of email routing settings.
75598
+ *
75599
+ * @param {Object} opts Optional parameters
75600
+ * @param {Number} opts.pageSize Page size (default to 25)
75601
+ * @param {Number} opts.pageNumber Page number (default to 1)
75602
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
75603
+ */
75604
+ getRoutingEmailSetting(opts) {
75605
+ opts = opts || {};
75606
+
75607
+
75608
+ return this.apiClient.callApi(
75609
+ '/api/v2/routing/email/setting',
75610
+ 'GET',
75611
+ { },
75612
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
75613
+ { },
75614
+ { },
75615
+ null,
75616
+ ['PureCloud OAuth'],
75617
+ ['application/json'],
75618
+ ['application/json'],
75619
+ opts['customHeaders']
75620
+ );
75621
+ }
75622
+
75623
+ /**
75624
+ * Get email setting. Returns the specified email setting that defines settings for email
75625
+ *
75626
+ * @param {String} emailSettingId Email Setting ID
75627
+ * @param {Object} opts Optional parameters
75628
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
75629
+ */
75630
+ getRoutingEmailSettingEmailSettingId(emailSettingId, opts) {
75631
+ opts = opts || {};
75632
+
75633
+ // verify the required parameter 'emailSettingId' is set
75634
+ if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
75635
+ throw 'Missing the required parameter "emailSettingId" when calling getRoutingEmailSettingEmailSettingId';
75636
+ }
75637
+
75638
+ return this.apiClient.callApi(
75639
+ '/api/v2/routing/email/setting/{emailSettingId}',
75640
+ 'GET',
75641
+ { 'emailSettingId': emailSettingId },
75642
+ { },
75643
+ { },
75644
+ { },
75645
+ null,
75646
+ ['PureCloud OAuth'],
75647
+ ['application/json'],
75648
+ ['application/json'],
75649
+ opts['customHeaders']
75650
+ );
75651
+ }
75652
+
74949
75653
  /**
74950
75654
  * Get email setup
74951
75655
  *
@@ -75690,7 +76394,7 @@ class RoutingApi {
75690
76394
  * @param {Object} opts.sortOrder Sort order (default to asc)
75691
76395
  * @param {String} opts.name Name
75692
76396
  * @param {Array.<String>} opts.id Queue ID(s)
75693
- * @param {Array.<String>} opts.divisionId Division ID(s)
76397
+ * @param {Array.<String>} opts.divisionId Division ID(s). Including '*' will query for all divisions
75694
76398
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
75695
76399
  */
75696
76400
  getRoutingQueuesDivisionviews(opts) {
@@ -75874,6 +76578,98 @@ class RoutingApi {
75874
76578
  );
75875
76579
  }
75876
76580
 
76581
+ /**
76582
+ * Get a skill expression by ID
76583
+ *
76584
+ * @param {String} expressionId Expression ID
76585
+ * @param {Object} opts Optional parameters
76586
+ * @param {Boolean} opts.includeArchived Include archived (default to false)
76587
+ * @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
76588
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
76589
+ */
76590
+ getRoutingSkillexpression(expressionId, opts) {
76591
+ opts = opts || {};
76592
+
76593
+ // verify the required parameter 'expressionId' is set
76594
+ if (expressionId === undefined || expressionId === null || expressionId === '') {
76595
+ throw 'Missing the required parameter "expressionId" when calling getRoutingSkillexpression';
76596
+ }
76597
+
76598
+ return this.apiClient.callApi(
76599
+ '/api/v2/routing/skillexpressions/{expressionId}',
76600
+ 'GET',
76601
+ { 'expressionId': expressionId },
76602
+ { 'includeArchived': opts['includeArchived'],'format': opts['format'] },
76603
+ { },
76604
+ { },
76605
+ null,
76606
+ ['PureCloud OAuth'],
76607
+ ['application/json'],
76608
+ ['application/json'],
76609
+ opts['customHeaders']
76610
+ );
76611
+ }
76612
+
76613
+ /**
76614
+ * Get skill expressions
76615
+ *
76616
+ * @param {Object} opts Optional parameters
76617
+ * @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
76618
+ * @param {Boolean} opts.includeArchived Include archived (default to false)
76619
+ * @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
76620
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
76621
+ */
76622
+ getRoutingSkillexpressions(opts) {
76623
+ opts = opts || {};
76624
+
76625
+
76626
+ return this.apiClient.callApi(
76627
+ '/api/v2/routing/skillexpressions',
76628
+ 'GET',
76629
+ { },
76630
+ { 'format': opts['format'],'includeArchived': opts['includeArchived'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
76631
+ { },
76632
+ { },
76633
+ null,
76634
+ ['PureCloud OAuth'],
76635
+ ['application/json'],
76636
+ ['application/json'],
76637
+ opts['customHeaders']
76638
+ );
76639
+ }
76640
+
76641
+ /**
76642
+ * Get skill expressions associated with a queue
76643
+ *
76644
+ * @param {String} queueId Queue ID
76645
+ * @param {Object} opts Optional parameters
76646
+ * @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
76647
+ * @param {Boolean} opts.includeArchived Include archived (default to false)
76648
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
76649
+ */
76650
+ getRoutingSkillexpressionsQueueQueueId(queueId, opts) {
76651
+ opts = opts || {};
76652
+
76653
+ // verify the required parameter 'queueId' is set
76654
+ if (queueId === undefined || queueId === null || queueId === '') {
76655
+ throw 'Missing the required parameter "queueId" when calling getRoutingSkillexpressionsQueueQueueId';
76656
+ }
76657
+
76658
+ return this.apiClient.callApi(
76659
+ '/api/v2/routing/skillexpressions/queue/{queueId}',
76660
+ 'GET',
76661
+ { 'queueId': queueId },
76662
+ { 'format': opts['format'],'includeArchived': opts['includeArchived'] },
76663
+ { },
76664
+ { },
76665
+ null,
76666
+ ['PureCloud OAuth'],
76667
+ ['application/json'],
76668
+ ['application/json'],
76669
+ opts['customHeaders']
76670
+ );
76671
+ }
76672
+
75877
76673
  /**
75878
76674
  * Get skill group
75879
76675
  *
@@ -75999,7 +76795,7 @@ class RoutingApi {
75999
76795
  }
76000
76796
 
76001
76797
  /**
76002
- * Get the list of routing skills.
76798
+ * Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
76003
76799
  *
76004
76800
  * @param {Object} opts Optional parameters
76005
76801
  * @param {Number} opts.pageSize Page size (default to 25)
@@ -76396,98 +77192,6 @@ class RoutingApi {
76396
77192
  );
76397
77193
  }
76398
77194
 
76399
- /**
76400
- * Get details about this utilization tag
76401
- *
76402
- * @param {String} tagId Utilization Tag ID
76403
- * @param {Object} opts Optional parameters
76404
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
76405
- * getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
76406
- */
76407
- getRoutingUtilizationTag(tagId, opts) {
76408
- opts = opts || {};
76409
-
76410
- // verify the required parameter 'tagId' is set
76411
- if (tagId === undefined || tagId === null || tagId === '') {
76412
- throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';
76413
- }
76414
-
76415
- return this.apiClient.callApi(
76416
- '/api/v2/routing/utilization/tags/{tagId}',
76417
- 'GET',
76418
- { 'tagId': tagId },
76419
- { },
76420
- { },
76421
- { },
76422
- null,
76423
- ['PureCloud OAuth'],
76424
- ['application/json'],
76425
- ['application/json'],
76426
- opts['customHeaders']
76427
- );
76428
- }
76429
-
76430
- /**
76431
- * Get list of agent ids associated with a utilization tag
76432
- *
76433
- * @param {String} tagId Utilization Tag ID
76434
- * @param {Object} opts Optional parameters
76435
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
76436
- * getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
76437
- */
76438
- getRoutingUtilizationTagAgents(tagId, opts) {
76439
- opts = opts || {};
76440
-
76441
- // verify the required parameter 'tagId' is set
76442
- if (tagId === undefined || tagId === null || tagId === '') {
76443
- throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';
76444
- }
76445
-
76446
- return this.apiClient.callApi(
76447
- '/api/v2/routing/utilization/tags/{tagId}/agents',
76448
- 'GET',
76449
- { 'tagId': tagId },
76450
- { },
76451
- { },
76452
- { },
76453
- null,
76454
- ['PureCloud OAuth'],
76455
- ['application/json'],
76456
- ['application/json'],
76457
- opts['customHeaders']
76458
- );
76459
- }
76460
-
76461
- /**
76462
- * Get list of utilization tags
76463
- *
76464
- * @param {Object} opts Optional parameters
76465
- * @param {Number} opts.pageSize Page size (default to 25)
76466
- * @param {Number} opts.pageNumber Page number (default to 1)
76467
- * @param {Object} opts.sortOrder Sort order by name (default to ascending)
76468
- * @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
76469
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
76470
- * getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
76471
- */
76472
- getRoutingUtilizationTags(opts) {
76473
- opts = opts || {};
76474
-
76475
-
76476
- return this.apiClient.callApi(
76477
- '/api/v2/routing/utilization/tags',
76478
- 'GET',
76479
- { },
76480
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
76481
- { },
76482
- { },
76483
- null,
76484
- ['PureCloud OAuth'],
76485
- ['application/json'],
76486
- ['application/json'],
76487
- opts['customHeaders']
76488
- );
76489
- }
76490
-
76491
77195
  /**
76492
77196
  * Get details about this wrap-up code.
76493
77197
  *
@@ -76884,6 +77588,41 @@ class RoutingApi {
76884
77588
  );
76885
77589
  }
76886
77590
 
77591
+ /**
77592
+ * Update an email setting. Modifies the settings for email setting
77593
+ *
77594
+ * @param {String} emailSettingId Email Setting ID
77595
+ * @param {Object} body EmailSetting
77596
+ * @param {Object} opts Optional parameters
77597
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
77598
+ */
77599
+ patchRoutingEmailSettingEmailSettingId(emailSettingId, body, opts) {
77600
+ opts = opts || {};
77601
+
77602
+ // verify the required parameter 'emailSettingId' is set
77603
+ if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
77604
+ throw 'Missing the required parameter "emailSettingId" when calling patchRoutingEmailSettingEmailSettingId';
77605
+ }
77606
+ // verify the required parameter 'body' is set
77607
+ if (body === undefined || body === null) {
77608
+ throw 'Missing the required parameter "body" when calling patchRoutingEmailSettingEmailSettingId';
77609
+ }
77610
+
77611
+ return this.apiClient.callApi(
77612
+ '/api/v2/routing/email/setting/{emailSettingId}',
77613
+ 'PATCH',
77614
+ { 'emailSettingId': emailSettingId },
77615
+ { },
77616
+ { },
77617
+ { },
77618
+ body,
77619
+ ['PureCloud OAuth'],
77620
+ ['application/json'],
77621
+ ['application/json'],
77622
+ opts['customHeaders']
77623
+ );
77624
+ }
77625
+
76887
77626
  /**
76888
77627
  * Update single predictor.
76889
77628
  *
@@ -77846,6 +78585,36 @@ class RoutingApi {
77846
78585
  );
77847
78586
  }
77848
78587
 
78588
+ /**
78589
+ * Create a new email setting. Used to define various settings, that can then be associated with email domains
78590
+ *
78591
+ * @param {Object} body EmailSetting
78592
+ * @param {Object} opts Optional parameters
78593
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
78594
+ */
78595
+ postRoutingEmailSetting(body, opts) {
78596
+ opts = opts || {};
78597
+
78598
+ // verify the required parameter 'body' is set
78599
+ if (body === undefined || body === null) {
78600
+ throw 'Missing the required parameter "body" when calling postRoutingEmailSetting';
78601
+ }
78602
+
78603
+ return this.apiClient.callApi(
78604
+ '/api/v2/routing/email/setting',
78605
+ 'POST',
78606
+ { },
78607
+ { },
78608
+ { },
78609
+ { },
78610
+ body,
78611
+ ['PureCloud OAuth'],
78612
+ ['application/json'],
78613
+ ['application/json'],
78614
+ opts['customHeaders']
78615
+ );
78616
+ }
78617
+
77849
78618
  /**
77850
78619
  * Create Language
77851
78620
  *
@@ -78071,6 +78840,36 @@ class RoutingApi {
78071
78840
  );
78072
78841
  }
78073
78842
 
78843
+ /**
78844
+ * Validate and normalize a skill expression
78845
+ *
78846
+ * @param {Object} body Skill expression data to validate
78847
+ * @param {Object} opts Optional parameters
78848
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
78849
+ */
78850
+ postRoutingSkillexpressionsValidate(body, opts) {
78851
+ opts = opts || {};
78852
+
78853
+ // verify the required parameter 'body' is set
78854
+ if (body === undefined || body === null) {
78855
+ throw 'Missing the required parameter "body" when calling postRoutingSkillexpressionsValidate';
78856
+ }
78857
+
78858
+ return this.apiClient.callApi(
78859
+ '/api/v2/routing/skillexpressions/validate',
78860
+ 'POST',
78861
+ { },
78862
+ { },
78863
+ { },
78864
+ { },
78865
+ body,
78866
+ ['PureCloud OAuth'],
78867
+ ['application/json'],
78868
+ ['application/json'],
78869
+ opts['customHeaders']
78870
+ );
78871
+ }
78872
+
78074
78873
  /**
78075
78874
  * Add or remove member divisions for this skill group.
78076
78875
  *
@@ -78313,37 +79112,6 @@ class RoutingApi {
78313
79112
  );
78314
79113
  }
78315
79114
 
78316
- /**
78317
- * Create an utilization tag
78318
- *
78319
- * @param {Object} body UtilizationTag
78320
- * @param {Object} opts Optional parameters
78321
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
78322
- * postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
78323
- */
78324
- postRoutingUtilizationTags(body, opts) {
78325
- opts = opts || {};
78326
-
78327
- // verify the required parameter 'body' is set
78328
- if (body === undefined || body === null) {
78329
- throw 'Missing the required parameter "body" when calling postRoutingUtilizationTags';
78330
- }
78331
-
78332
- return this.apiClient.callApi(
78333
- '/api/v2/routing/utilization/tags',
78334
- 'POST',
78335
- { },
78336
- { },
78337
- { },
78338
- { },
78339
- body,
78340
- ['PureCloud OAuth'],
78341
- ['application/json'],
78342
- ['application/json'],
78343
- opts['customHeaders']
78344
- );
78345
- }
78346
-
78347
79115
  /**
78348
79116
  * Create a wrap-up code
78349
79117
  *
@@ -79035,7 +79803,7 @@ class SCIMApi {
79035
79803
  /**
79036
79804
  * SCIM service.
79037
79805
  * @module purecloud-platform-client-v2/api/SCIMApi
79038
- * @version 252.1.0
79806
+ * @version 254.0.0
79039
79807
  */
79040
79808
 
79041
79809
  /**
@@ -79996,7 +80764,7 @@ class ScriptsApi {
79996
80764
  /**
79997
80765
  * Scripts service.
79998
80766
  * @module purecloud-platform-client-v2/api/ScriptsApi
79999
- * @version 252.1.0
80767
+ * @version 254.0.0
80000
80768
  */
80001
80769
 
80002
80770
  /**
@@ -80505,7 +81273,7 @@ class SearchApi {
80505
81273
  /**
80506
81274
  * Search service.
80507
81275
  * @module purecloud-platform-client-v2/api/SearchApi
80508
- * @version 252.1.0
81276
+ * @version 254.0.0
80509
81277
  */
80510
81278
 
80511
81279
  /**
@@ -81321,7 +82089,7 @@ class SettingsApi {
81321
82089
  /**
81322
82090
  * Settings service.
81323
82091
  * @module purecloud-platform-client-v2/api/SettingsApi
81324
- * @version 252.1.0
82092
+ * @version 254.0.0
81325
82093
  */
81326
82094
 
81327
82095
  /**
@@ -81730,7 +82498,7 @@ class SocialMediaApi {
81730
82498
  /**
81731
82499
  * SocialMedia service.
81732
82500
  * @module purecloud-platform-client-v2/api/SocialMediaApi
81733
- * @version 252.1.0
82501
+ * @version 254.0.0
81734
82502
  */
81735
82503
 
81736
82504
  /**
@@ -83715,7 +84483,7 @@ class SpeechTextAnalyticsApi {
83715
84483
  /**
83716
84484
  * SpeechTextAnalytics service.
83717
84485
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
83718
- * @version 252.1.0
84486
+ * @version 254.0.0
83719
84487
  */
83720
84488
 
83721
84489
  /**
@@ -85667,7 +86435,7 @@ class StationsApi {
85667
86435
  /**
85668
86436
  * Stations service.
85669
86437
  * @module purecloud-platform-client-v2/api/StationsApi
85670
- * @version 252.1.0
86438
+ * @version 254.0.0
85671
86439
  */
85672
86440
 
85673
86441
  /**
@@ -85781,7 +86549,7 @@ class SuggestApi {
85781
86549
  /**
85782
86550
  * Suggest service.
85783
86551
  * @module purecloud-platform-client-v2/api/SuggestApi
85784
- * @version 252.1.0
86552
+ * @version 254.0.0
85785
86553
  */
85786
86554
 
85787
86555
  /**
@@ -85928,7 +86696,7 @@ class TaskManagementApi {
85928
86696
  /**
85929
86697
  * TaskManagement service.
85930
86698
  * @module purecloud-platform-client-v2/api/TaskManagementApi
85931
- * @version 252.1.0
86699
+ * @version 254.0.0
85932
86700
  */
85933
86701
 
85934
86702
  /**
@@ -88424,7 +89192,7 @@ class TeamsApi {
88424
89192
  /**
88425
89193
  * Teams service.
88426
89194
  * @module purecloud-platform-client-v2/api/TeamsApi
88427
- * @version 252.1.0
89195
+ * @version 254.0.0
88428
89196
  */
88429
89197
 
88430
89198
  /**
@@ -88767,7 +89535,7 @@ class TelephonyApi {
88767
89535
  /**
88768
89536
  * Telephony service.
88769
89537
  * @module purecloud-platform-client-v2/api/TelephonyApi
88770
- * @version 252.1.0
89538
+ * @version 254.0.0
88771
89539
  */
88772
89540
 
88773
89541
  /**
@@ -88782,6 +89550,36 @@ class TelephonyApi {
88782
89550
  }
88783
89551
 
88784
89552
 
89553
+ /**
89554
+ * Delete a link
89555
+ *
89556
+ * @param {String} targetOrganizationId targetOrganizationId
89557
+ * @param {Object} opts Optional parameters
89558
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89559
+ */
89560
+ deleteTelephonyOrganizationLinkTargetOrganizationId(targetOrganizationId, opts) {
89561
+ opts = opts || {};
89562
+
89563
+ // verify the required parameter 'targetOrganizationId' is set
89564
+ if (targetOrganizationId === undefined || targetOrganizationId === null || targetOrganizationId === '') {
89565
+ throw 'Missing the required parameter "targetOrganizationId" when calling deleteTelephonyOrganizationLinkTargetOrganizationId';
89566
+ }
89567
+
89568
+ return this.apiClient.callApi(
89569
+ '/api/v2/telephony/organization/link/{targetOrganizationId}',
89570
+ 'DELETE',
89571
+ { 'targetOrganizationId': targetOrganizationId },
89572
+ { },
89573
+ { },
89574
+ { },
89575
+ null,
89576
+ ['PureCloud OAuth'],
89577
+ ['application/json'],
89578
+ ['application/json'],
89579
+ opts['customHeaders']
89580
+ );
89581
+ }
89582
+
88785
89583
  /**
88786
89584
  * Get an agent's greetings.
88787
89585
  *
@@ -88888,6 +89686,88 @@ class TelephonyApi {
88888
89686
  );
88889
89687
  }
88890
89688
 
89689
+ /**
89690
+ * Get Number Routings by organizationId
89691
+ *
89692
+ * @param {Object} opts Optional parameters
89693
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
89694
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
89695
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
89696
+ * @param {String} opts.numberId numberId
89697
+ * @param {String} opts.activeRoutingOrganizationId activeRoutingOrganizationId
89698
+ * @param {String} opts.ownerOrganizationId ownerOrganizationId
89699
+ * @param {Object} opts.status status
89700
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89701
+ */
89702
+ getTelephonyNumbersRouting(opts) {
89703
+ opts = opts || {};
89704
+
89705
+
89706
+ return this.apiClient.callApi(
89707
+ '/api/v2/telephony/numbers/routing',
89708
+ 'GET',
89709
+ { },
89710
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'numberId': opts['numberId'],'activeRoutingOrganizationId': opts['activeRoutingOrganizationId'],'ownerOrganizationId': opts['ownerOrganizationId'],'status': opts['status'] },
89711
+ { },
89712
+ { },
89713
+ null,
89714
+ ['PureCloud OAuth'],
89715
+ ['application/json'],
89716
+ ['application/json'],
89717
+ opts['customHeaders']
89718
+ );
89719
+ }
89720
+
89721
+ /**
89722
+ * Get organization links
89723
+ *
89724
+ * @param {Object} opts Optional parameters
89725
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89726
+ */
89727
+ getTelephonyOrganizationLink(opts) {
89728
+ opts = opts || {};
89729
+
89730
+
89731
+ return this.apiClient.callApi(
89732
+ '/api/v2/telephony/organization/link',
89733
+ 'GET',
89734
+ { },
89735
+ { },
89736
+ { },
89737
+ { },
89738
+ null,
89739
+ ['PureCloud OAuth'],
89740
+ ['application/json'],
89741
+ ['application/json'],
89742
+ opts['customHeaders']
89743
+ );
89744
+ }
89745
+
89746
+ /**
89747
+ * Get all the replica regions by primary region
89748
+ *
89749
+ * @param {Object} opts Optional parameters
89750
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89751
+ */
89752
+ getTelephonyOrganizationLinkRegions(opts) {
89753
+ opts = opts || {};
89754
+
89755
+
89756
+ return this.apiClient.callApi(
89757
+ '/api/v2/telephony/organization/link/regions',
89758
+ 'GET',
89759
+ { },
89760
+ { },
89761
+ { },
89762
+ { },
89763
+ null,
89764
+ ['PureCloud OAuth'],
89765
+ ['application/json'],
89766
+ ['application/json'],
89767
+ opts['customHeaders']
89768
+ );
89769
+ }
89770
+
88891
89771
  /**
88892
89772
  * Get the global telephony configuration.
88893
89773
  *
@@ -89043,6 +89923,161 @@ class TelephonyApi {
89043
89923
  );
89044
89924
  }
89045
89925
 
89926
+ /**
89927
+ * Approving a requested link
89928
+ *
89929
+ * @param {String} requestingOrganizationId requestingOrganizationId
89930
+ * @param {Object} body Approval request body
89931
+ * @param {Object} opts Optional parameters
89932
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89933
+ */
89934
+ patchTelephonyOrganizationLinkApproveRequestingOrganizationId(requestingOrganizationId, body, opts) {
89935
+ opts = opts || {};
89936
+
89937
+ // verify the required parameter 'requestingOrganizationId' is set
89938
+ if (requestingOrganizationId === undefined || requestingOrganizationId === null || requestingOrganizationId === '') {
89939
+ throw 'Missing the required parameter "requestingOrganizationId" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';
89940
+ }
89941
+ // verify the required parameter 'body' is set
89942
+ if (body === undefined || body === null) {
89943
+ throw 'Missing the required parameter "body" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';
89944
+ }
89945
+
89946
+ return this.apiClient.callApi(
89947
+ '/api/v2/telephony/organization/link/approve/{requestingOrganizationId}',
89948
+ 'PATCH',
89949
+ { 'requestingOrganizationId': requestingOrganizationId },
89950
+ { },
89951
+ { },
89952
+ { },
89953
+ body,
89954
+ ['PureCloud OAuth'],
89955
+ ['application/json'],
89956
+ ['application/json'],
89957
+ opts['customHeaders']
89958
+ );
89959
+ }
89960
+
89961
+ /**
89962
+ * Update the routing of numbers for one or multiple organizations
89963
+ *
89964
+ * @param {Array.<Object>} body drRoutingList
89965
+ * @param {Object} opts Optional parameters
89966
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89967
+ */
89968
+ postTelephonyNumbersRouting(body, opts) {
89969
+ opts = opts || {};
89970
+
89971
+ // verify the required parameter 'body' is set
89972
+ if (body === undefined || body === null) {
89973
+ throw 'Missing the required parameter "body" when calling postTelephonyNumbersRouting';
89974
+ }
89975
+
89976
+ return this.apiClient.callApi(
89977
+ '/api/v2/telephony/numbers/routing',
89978
+ 'POST',
89979
+ { },
89980
+ { },
89981
+ { },
89982
+ { },
89983
+ body,
89984
+ ['PureCloud OAuth'],
89985
+ ['application/json'],
89986
+ ['application/json'],
89987
+ opts['customHeaders']
89988
+ );
89989
+ }
89990
+
89991
+ /**
89992
+ * Re-route all numbers on an organization
89993
+ *
89994
+ * @param {Object} body Value for all routing request body
89995
+ * @param {Object} opts Optional parameters
89996
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89997
+ */
89998
+ postTelephonyNumbersRoutingAll(body, opts) {
89999
+ opts = opts || {};
90000
+
90001
+ // verify the required parameter 'body' is set
90002
+ if (body === undefined || body === null) {
90003
+ throw 'Missing the required parameter "body" when calling postTelephonyNumbersRoutingAll';
90004
+ }
90005
+
90006
+ return this.apiClient.callApi(
90007
+ '/api/v2/telephony/numbers/routing/all',
90008
+ 'POST',
90009
+ { },
90010
+ { },
90011
+ { },
90012
+ { },
90013
+ body,
90014
+ ['PureCloud OAuth'],
90015
+ ['application/json'],
90016
+ ['application/json'],
90017
+ opts['customHeaders']
90018
+ );
90019
+ }
90020
+
90021
+ /**
90022
+ * Reset routing for organization
90023
+ *
90024
+ * @param {Object} body Value for bulk routing request body
90025
+ * @param {Object} opts Optional parameters
90026
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
90027
+ */
90028
+ postTelephonyNumbersRoutingReset(body, opts) {
90029
+ opts = opts || {};
90030
+
90031
+ // verify the required parameter 'body' is set
90032
+ if (body === undefined || body === null) {
90033
+ throw 'Missing the required parameter "body" when calling postTelephonyNumbersRoutingReset';
90034
+ }
90035
+
90036
+ return this.apiClient.callApi(
90037
+ '/api/v2/telephony/numbers/routing/reset',
90038
+ 'POST',
90039
+ { },
90040
+ { },
90041
+ { },
90042
+ { },
90043
+ body,
90044
+ ['PureCloud OAuth'],
90045
+ ['application/json'],
90046
+ ['application/json'],
90047
+ opts['customHeaders']
90048
+ );
90049
+ }
90050
+
90051
+ /**
90052
+ * Create a link with an organization
90053
+ *
90054
+ * @param {Object} body CreateLinkOrg body
90055
+ * @param {Object} opts Optional parameters
90056
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
90057
+ */
90058
+ postTelephonyOrganizationLink(body, opts) {
90059
+ opts = opts || {};
90060
+
90061
+ // verify the required parameter 'body' is set
90062
+ if (body === undefined || body === null) {
90063
+ throw 'Missing the required parameter "body" when calling postTelephonyOrganizationLink';
90064
+ }
90065
+
90066
+ return this.apiClient.callApi(
90067
+ '/api/v2/telephony/organization/link',
90068
+ 'POST',
90069
+ { },
90070
+ { },
90071
+ { },
90072
+ { },
90073
+ body,
90074
+ ['PureCloud OAuth'],
90075
+ ['application/json'],
90076
+ ['application/json'],
90077
+ opts['customHeaders']
90078
+ );
90079
+ }
90080
+
89046
90081
  /**
89047
90082
  * Request a download of a pcap file to S3
89048
90083
  *
@@ -89174,7 +90209,7 @@ class TelephonyProvidersEdgeApi {
89174
90209
  /**
89175
90210
  * TelephonyProvidersEdge service.
89176
90211
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
89177
- * @version 252.1.0
90212
+ * @version 254.0.0
89178
90213
  */
89179
90214
 
89180
90215
  /**
@@ -92366,52 +93401,6 @@ class TelephonyProvidersEdgeApi {
92366
93401
  );
92367
93402
  }
92368
93403
 
92369
- /**
92370
- * Post media endpoint statistics event.
92371
- *
92372
- * @param {String} conversationId Identifier of the conversation
92373
- * @param {String} communicationId Identifier of the media session
92374
- * @param {String} mediaResourceId Identifier of the media resource of the endpoint
92375
- * @param {Object} body MediaStatisticsPostRequest
92376
- * @param {Object} opts Optional parameters
92377
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
92378
- * postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
92379
- */
92380
- postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body, opts) {
92381
- opts = opts || {};
92382
-
92383
- // verify the required parameter 'conversationId' is set
92384
- if (conversationId === undefined || conversationId === null || conversationId === '') {
92385
- throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
92386
- }
92387
- // verify the required parameter 'communicationId' is set
92388
- if (communicationId === undefined || communicationId === null || communicationId === '') {
92389
- throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
92390
- }
92391
- // verify the required parameter 'mediaResourceId' is set
92392
- if (mediaResourceId === undefined || mediaResourceId === null || mediaResourceId === '') {
92393
- throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
92394
- }
92395
- // verify the required parameter 'body' is set
92396
- if (body === undefined || body === null) {
92397
- throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
92398
- }
92399
-
92400
- return this.apiClient.callApi(
92401
- '/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
92402
- 'POST',
92403
- { 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
92404
- { },
92405
- { },
92406
- { },
92407
- body,
92408
- ['PureCloud OAuth'],
92409
- ['application/json'],
92410
- ['application/json'],
92411
- opts['customHeaders']
92412
- );
92413
- }
92414
-
92415
93404
  /**
92416
93405
  * Reboot a Phone
92417
93406
  *
@@ -93198,7 +94187,7 @@ class TextbotsApi {
93198
94187
  /**
93199
94188
  * Textbots service.
93200
94189
  * @module purecloud-platform-client-v2/api/TextbotsApi
93201
- * @version 252.1.0
94190
+ * @version 254.0.0
93202
94191
  */
93203
94192
 
93204
94193
  /**
@@ -93344,7 +94333,7 @@ class TokensApi {
93344
94333
  /**
93345
94334
  * Tokens service.
93346
94335
  * @module purecloud-platform-client-v2/api/TokensApi
93347
- * @version 252.1.0
94336
+ * @version 254.0.0
93348
94337
  */
93349
94338
 
93350
94339
  /**
@@ -93522,7 +94511,7 @@ class UploadsApi {
93522
94511
  /**
93523
94512
  * Uploads service.
93524
94513
  * @module purecloud-platform-client-v2/api/UploadsApi
93525
- * @version 252.1.0
94514
+ * @version 254.0.0
93526
94515
  */
93527
94516
 
93528
94517
  /**
@@ -93893,7 +94882,7 @@ class UsageApi {
93893
94882
  /**
93894
94883
  * Usage service.
93895
94884
  * @module purecloud-platform-client-v2/api/UsageApi
93896
- * @version 252.1.0
94885
+ * @version 254.0.0
93897
94886
  */
93898
94887
 
93899
94888
  /**
@@ -94271,7 +95260,7 @@ class UserRecordingsApi {
94271
95260
  /**
94272
95261
  * UserRecordings service.
94273
95262
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
94274
- * @version 252.1.0
95263
+ * @version 254.0.0
94275
95264
  */
94276
95265
 
94277
95266
  /**
@@ -94473,7 +95462,7 @@ class UsersApi {
94473
95462
  /**
94474
95463
  * Users service.
94475
95464
  * @module purecloud-platform-client-v2/api/UsersApi
94476
- * @version 252.1.0
95465
+ * @version 254.0.0
94477
95466
  */
94478
95467
 
94479
95468
  /**
@@ -94494,7 +95483,6 @@ class UsersApi {
94494
95483
  * @param {String} jobId jobId
94495
95484
  * @param {Object} opts Optional parameters
94496
95485
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
94497
- * deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
94498
95486
  */
94499
95487
  deleteAnalyticsUsersAggregatesJob(jobId, opts) {
94500
95488
  opts = opts || {};
@@ -95005,7 +95993,6 @@ class UsersApi {
95005
95993
  * @param {String} jobId jobId
95006
95994
  * @param {Object} opts Optional parameters
95007
95995
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
95008
- * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
95009
95996
  */
95010
95997
  getAnalyticsUsersAggregatesJob(jobId, opts) {
95011
95998
  opts = opts || {};
@@ -95037,7 +96024,6 @@ class UsersApi {
95037
96024
  * @param {Object} opts Optional parameters
95038
96025
  * @param {String} opts.cursor Cursor token to retrieve next page
95039
96026
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
95040
- * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
95041
96027
  */
95042
96028
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
95043
96029
  opts = opts || {};
@@ -97185,7 +98171,6 @@ class UsersApi {
97185
98171
  * @param {Object} body query
97186
98172
  * @param {Object} opts Optional parameters
97187
98173
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
97188
- * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
97189
98174
  */
97190
98175
  postAnalyticsUsersAggregatesJobs(body, opts) {
97191
98176
  opts = opts || {};
@@ -98492,7 +99477,7 @@ class UsersRulesApi {
98492
99477
  /**
98493
99478
  * UsersRules service.
98494
99479
  * @module purecloud-platform-client-v2/api/UsersRulesApi
98495
- * @version 252.1.0
99480
+ * @version 254.0.0
98496
99481
  */
98497
99482
 
98498
99483
  /**
@@ -98809,7 +99794,7 @@ class UtilitiesApi {
98809
99794
  /**
98810
99795
  * Utilities service.
98811
99796
  * @module purecloud-platform-client-v2/api/UtilitiesApi
98812
- * @version 252.1.0
99797
+ * @version 254.0.0
98813
99798
  */
98814
99799
 
98815
99800
  /**
@@ -98937,7 +99922,7 @@ class VoicemailApi {
98937
99922
  /**
98938
99923
  * Voicemail service.
98939
99924
  * @module purecloud-platform-client-v2/api/VoicemailApi
98940
- * @version 252.1.0
99925
+ * @version 254.0.0
98941
99926
  */
98942
99927
 
98943
99928
  /**
@@ -99767,7 +100752,7 @@ class WebChatApi {
99767
100752
  /**
99768
100753
  * WebChat service.
99769
100754
  * @module purecloud-platform-client-v2/api/WebChatApi
99770
- * @version 252.1.0
100755
+ * @version 254.0.0
99771
100756
  */
99772
100757
 
99773
100758
  /**
@@ -100419,7 +101404,7 @@ class WebDeploymentsApi {
100419
101404
  /**
100420
101405
  * WebDeployments service.
100421
101406
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
100422
- * @version 252.1.0
101407
+ * @version 254.0.0
100423
101408
  */
100424
101409
 
100425
101410
  /**
@@ -101097,7 +102082,7 @@ class WebMessagingApi {
101097
102082
  /**
101098
102083
  * WebMessaging service.
101099
102084
  * @module purecloud-platform-client-v2/api/WebMessagingApi
101100
- * @version 252.1.0
102085
+ * @version 254.0.0
101101
102086
  */
101102
102087
 
101103
102088
  /**
@@ -101260,7 +102245,7 @@ class WidgetsApi {
101260
102245
  /**
101261
102246
  * Widgets service.
101262
102247
  * @module purecloud-platform-client-v2/api/WidgetsApi
101263
- * @version 252.1.0
102248
+ * @version 254.0.0
101264
102249
  */
101265
102250
 
101266
102251
  /**
@@ -101436,7 +102421,7 @@ class WorkforceManagementApi {
101436
102421
  /**
101437
102422
  * WorkforceManagement service.
101438
102423
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
101439
- * @version 252.1.0
102424
+ * @version 254.0.0
101440
102425
  */
101441
102426
 
101442
102427
  /**
@@ -103299,6 +104284,42 @@ class WorkforceManagementApi {
103299
104284
  );
103300
104285
  }
103301
104286
 
104287
+ /**
104288
+ * Get opportunity details
104289
+ *
104290
+ * @param {String} businessUnitId The ID of the business unit
104291
+ * @param {String} opportunityId The ID of the opportunity
104292
+ * @param {Object} opts Optional parameters
104293
+ * @param {Object} opts.expand List of resources to expand
104294
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104295
+ */
104296
+ getWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, opts) {
104297
+ opts = opts || {};
104298
+
104299
+ // verify the required parameter 'businessUnitId' is set
104300
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
104301
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';
104302
+ }
104303
+ // verify the required parameter 'opportunityId' is set
104304
+ if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
104305
+ throw 'Missing the required parameter "opportunityId" when calling getWorkforcemanagementBusinessunitOpportunity';
104306
+ }
104307
+
104308
+ return this.apiClient.callApi(
104309
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
104310
+ 'GET',
104311
+ { 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
104312
+ { 'expand': opts['expand'] },
104313
+ { },
104314
+ { },
104315
+ null,
104316
+ ['PureCloud OAuth'],
104317
+ ['application/json'],
104318
+ ['application/json'],
104319
+ opts['customHeaders']
104320
+ );
104321
+ }
104322
+
103302
104323
  /**
103303
104324
  * Get a planning group
103304
104325
  *
@@ -103921,6 +104942,7 @@ class WorkforceManagementApi {
103921
104942
  * @param {Object} opts Optional parameters
103922
104943
  * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
103923
104944
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
104945
+ * @param {Array.<String>} opts.expand Include to access additional data for the time-off plans
103924
104946
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
103925
104947
  */
103926
104948
  getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
@@ -103935,7 +104957,7 @@ class WorkforceManagementApi {
103935
104957
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
103936
104958
  'GET',
103937
104959
  { 'businessUnitId': businessUnitId },
103938
- { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
104960
+ { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
103939
104961
  { },
103940
104962
  { },
103941
104963
  null,
@@ -104235,6 +105257,8 @@ class WorkforceManagementApi {
104235
105257
  * @param {String} businessUnitId The ID of the business unit
104236
105258
  * @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
104237
105259
  * @param {Object} opts Optional parameters
105260
+ * @param {String} opts.earliestWeekDate If weekId == 'recent', specify the earliest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
105261
+ * @param {String} opts.latestWeekDate If weekId == 'recent', specify the latest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
104238
105262
  * @param {Boolean} opts.includeOnlyPublished includeOnlyPublished
104239
105263
  * @param {Object} opts.expand expand
104240
105264
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
@@ -104255,7 +105279,7 @@ class WorkforceManagementApi {
104255
105279
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules',
104256
105280
  'GET',
104257
105281
  { 'businessUnitId': businessUnitId,'weekId': weekId },
104258
- { 'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
105282
+ { 'earliestWeekDate': opts['earliestWeekDate'],'latestWeekDate': opts['latestWeekDate'],'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
104259
105283
  { },
104260
105284
  { },
104261
105285
  null,
@@ -105132,11 +106156,12 @@ class WorkforceManagementApi {
105132
106156
 
105133
106157
  /**
105134
106158
  * Gets all the shift trades for a given agent
105135
- *
106159
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
105136
106160
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
105137
106161
  * @param {String} agentId The agent id
105138
106162
  * @param {Object} opts Optional parameters
105139
106163
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
106164
+ * @deprecated
105140
106165
  */
105141
106166
  getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId, opts) {
105142
106167
  opts = opts || {};
@@ -105167,10 +106192,11 @@ class WorkforceManagementApi {
105167
106192
 
105168
106193
  /**
105169
106194
  * Gets a summary of all shift trades in the matched state
105170
- *
106195
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
105171
106196
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
105172
106197
  * @param {Object} opts Optional parameters
105173
106198
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
106199
+ * @deprecated
105174
106200
  */
105175
106201
  getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId, opts) {
105176
106202
  opts = opts || {};
@@ -105584,7 +106610,7 @@ class WorkforceManagementApi {
105584
106610
 
105585
106611
  /**
105586
106612
  * Gets all the shift trades for a given week
105587
- *
106613
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
105588
106614
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
105589
106615
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
105590
106616
  * @param {Object} opts Optional parameters
@@ -105592,6 +106618,7 @@ class WorkforceManagementApi {
105592
106618
  * @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
105593
106619
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
105594
106620
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
106621
+ * @deprecated
105595
106622
  */
105596
106623
  getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
105597
106624
  opts = opts || {};
@@ -105867,9 +106894,10 @@ class WorkforceManagementApi {
105867
106894
 
105868
106895
  /**
105869
106896
  * Gets all of my shift trades
105870
- *
106897
+ * Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
105871
106898
  * @param {Object} opts Optional parameters
105872
106899
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
106900
+ * @deprecated
105873
106901
  */
105874
106902
  getWorkforcemanagementShifttrades(opts) {
105875
106903
  opts = opts || {};
@@ -106731,9 +107759,49 @@ class WorkforceManagementApi {
106731
107759
  );
106732
107760
  }
106733
107761
 
107762
+ /**
107763
+ * Update the opportunity
107764
+ * Only opportunities with Draft status can be updated.
107765
+ * @param {String} businessUnitId The ID of the business unit
107766
+ * @param {String} opportunityId The ID of the opportunity
107767
+ * @param {Object} body body
107768
+ * @param {Object} opts Optional parameters
107769
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
107770
+ */
107771
+ patchWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, body, opts) {
107772
+ opts = opts || {};
107773
+
107774
+ // verify the required parameter 'businessUnitId' is set
107775
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
107776
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';
107777
+ }
107778
+ // verify the required parameter 'opportunityId' is set
107779
+ if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
107780
+ throw 'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';
107781
+ }
107782
+ // verify the required parameter 'body' is set
107783
+ if (body === undefined || body === null) {
107784
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';
107785
+ }
107786
+
107787
+ return this.apiClient.callApi(
107788
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
107789
+ 'PATCH',
107790
+ { 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
107791
+ { },
107792
+ { },
107793
+ { },
107794
+ body,
107795
+ ['PureCloud OAuth'],
107796
+ ['application/json'],
107797
+ ['application/json'],
107798
+ opts['customHeaders']
107799
+ );
107800
+ }
107801
+
106734
107802
  /**
106735
107803
  * Updates the planning group
106736
- *
107804
+ * If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
106737
107805
  * @param {String} businessUnitId The ID of the business unit.
106738
107806
  * @param {String} planningGroupId The ID of a planning group to update
106739
107807
  * @param {Object} body body
@@ -107408,13 +108476,14 @@ class WorkforceManagementApi {
107408
108476
 
107409
108477
  /**
107410
108478
  * Updates a shift trade. This route can only be called by the initiating agent
107411
- *
108479
+ * Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
107412
108480
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
107413
108481
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
107414
108482
  * @param {String} tradeId The ID of the shift trade to update
107415
108483
  * @param {Object} body body
107416
108484
  * @param {Object} opts Optional parameters
107417
108485
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
108486
+ * @deprecated
107418
108487
  */
107419
108488
  patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body, opts) {
107420
108489
  opts = opts || {};
@@ -107759,33 +108828,6 @@ class WorkforceManagementApi {
107759
108828
  );
107760
108829
  }
107761
108830
 
107762
- /**
107763
- * Deprecated. Use bulk routes instead (/adherence/historical/bulk)
107764
- *
107765
- * @param {Object} opts Optional parameters
107766
- * @param {Object} opts.body body
107767
- * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
107768
- * @deprecated
107769
- */
107770
- postWorkforcemanagementAdherenceHistorical(opts) {
107771
- opts = opts || {};
107772
-
107773
-
107774
- return this.apiClient.callApi(
107775
- '/api/v2/workforcemanagement/adherence/historical',
107776
- 'POST',
107777
- { },
107778
- { },
107779
- { },
107780
- { },
107781
- opts['body'],
107782
- ['PureCloud OAuth'],
107783
- ['application/json'],
107784
- ['application/json'],
107785
- opts['customHeaders']
107786
- );
107787
- }
107788
-
107789
108831
  /**
107790
108832
  * Request a historical adherence report in bulk
107791
108833
  *
@@ -108040,6 +109082,98 @@ class WorkforceManagementApi {
108040
109082
  );
108041
109083
  }
108042
109084
 
109085
+ /**
109086
+ * Bulk add enrollments to opportunities for the authenticated agent
109087
+ * Allows an agent to enroll in opportunities. This endpoint can return partial success.
109088
+ * @param {Object} body body
109089
+ * @param {Object} opts Optional parameters
109090
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109091
+ */
109092
+ postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body, opts) {
109093
+ opts = opts || {};
109094
+
109095
+ // verify the required parameter 'body' is set
109096
+ if (body === undefined || body === null) {
109097
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';
109098
+ }
109099
+
109100
+ return this.apiClient.callApi(
109101
+ '/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add',
109102
+ 'POST',
109103
+ { },
109104
+ { },
109105
+ { },
109106
+ { },
109107
+ body,
109108
+ ['PureCloud OAuth'],
109109
+ ['application/json'],
109110
+ ['application/json'],
109111
+ opts['customHeaders']
109112
+ );
109113
+ }
109114
+
109115
+ /**
109116
+ * Bulk update enrollment status for the authenticated agent
109117
+ * Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
109118
+ * @param {Object} body body
109119
+ * @param {Object} opts Optional parameters
109120
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109121
+ */
109122
+ postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body, opts) {
109123
+ opts = opts || {};
109124
+
109125
+ // verify the required parameter 'body' is set
109126
+ if (body === undefined || body === null) {
109127
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';
109128
+ }
109129
+
109130
+ return this.apiClient.callApi(
109131
+ '/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update',
109132
+ 'POST',
109133
+ { },
109134
+ { },
109135
+ { },
109136
+ { },
109137
+ body,
109138
+ ['PureCloud OAuth'],
109139
+ ['application/json'],
109140
+ ['application/json'],
109141
+ opts['customHeaders']
109142
+ );
109143
+ }
109144
+
109145
+ /**
109146
+ * Query opportunities for the authenticated agent
109147
+ * Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
109148
+ * @param {Object} body body
109149
+ * @param {Object} opts Optional parameters
109150
+ * @param {Object} opts.expand List of resources to expand
109151
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
109152
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109153
+ */
109154
+ postWorkforcemanagementAgentsOpportunitiesQuery(body, opts) {
109155
+ opts = opts || {};
109156
+
109157
+ // verify the required parameter 'body' is set
109158
+ if (body === undefined || body === null) {
109159
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';
109160
+ }
109161
+
109162
+ return this.apiClient.callApi(
109163
+ '/api/v2/workforcemanagement/agents/opportunities/query',
109164
+ 'POST',
109165
+ { },
109166
+ { 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
109167
+ { },
109168
+ { },
109169
+ body,
109170
+ ['PureCloud OAuth'],
109171
+ ['application/json'],
109172
+ ['application/json'],
109173
+ opts['customHeaders']
109174
+ );
109175
+ }
109176
+
108043
109177
  /**
108044
109178
  * Fetch agent schedules for the logged in user's management unit
108045
109179
  *
@@ -108709,8 +109843,291 @@ class WorkforceManagementApi {
108709
109843
  }
108710
109844
 
108711
109845
  /**
108712
- * Adds a new planning group
109846
+ * Bulk add opportunities
108713
109847
  *
109848
+ * @param {String} businessUnitId The ID of the business unit
109849
+ * @param {Object} body body
109850
+ * @param {Object} opts Optional parameters
109851
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109852
+ */
109853
+ postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId, body, opts) {
109854
+ opts = opts || {};
109855
+
109856
+ // verify the required parameter 'businessUnitId' is set
109857
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
109858
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
109859
+ }
109860
+ // verify the required parameter 'body' is set
109861
+ if (body === undefined || body === null) {
109862
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
109863
+ }
109864
+
109865
+ return this.apiClient.callApi(
109866
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add',
109867
+ 'POST',
109868
+ { 'businessUnitId': businessUnitId },
109869
+ { },
109870
+ { },
109871
+ { },
109872
+ body,
109873
+ ['PureCloud OAuth'],
109874
+ ['application/json'],
109875
+ ['application/json'],
109876
+ opts['customHeaders']
109877
+ );
109878
+ }
109879
+
109880
+ /**
109881
+ * Bulk publish opportunities
109882
+ * Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
109883
+ * @param {String} businessUnitId The ID of the business unit
109884
+ * @param {Object} body body
109885
+ * @param {Object} opts Optional parameters
109886
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109887
+ */
109888
+ postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId, body, opts) {
109889
+ opts = opts || {};
109890
+
109891
+ // verify the required parameter 'businessUnitId' is set
109892
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
109893
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
109894
+ }
109895
+ // verify the required parameter 'body' is set
109896
+ if (body === undefined || body === null) {
109897
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
109898
+ }
109899
+
109900
+ return this.apiClient.callApi(
109901
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish',
109902
+ 'POST',
109903
+ { 'businessUnitId': businessUnitId },
109904
+ { },
109905
+ { },
109906
+ { },
109907
+ body,
109908
+ ['PureCloud OAuth'],
109909
+ ['application/json'],
109910
+ ['application/json'],
109911
+ opts['customHeaders']
109912
+ );
109913
+ }
109914
+
109915
+ /**
109916
+ * Bulk remove opportunities
109917
+ * This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
109918
+ * @param {String} businessUnitId The ID of the business unit
109919
+ * @param {Object} body body
109920
+ * @param {Object} opts Optional parameters
109921
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109922
+ */
109923
+ postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId, body, opts) {
109924
+ opts = opts || {};
109925
+
109926
+ // verify the required parameter 'businessUnitId' is set
109927
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
109928
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
109929
+ }
109930
+ // verify the required parameter 'body' is set
109931
+ if (body === undefined || body === null) {
109932
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
109933
+ }
109934
+
109935
+ return this.apiClient.callApi(
109936
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove',
109937
+ 'POST',
109938
+ { 'businessUnitId': businessUnitId },
109939
+ { },
109940
+ { },
109941
+ { },
109942
+ body,
109943
+ ['PureCloud OAuth'],
109944
+ ['application/json'],
109945
+ ['application/json'],
109946
+ opts['customHeaders']
109947
+ );
109948
+ }
109949
+
109950
+ /**
109951
+ * Bulk update opportunities status
109952
+ * If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
109953
+ * @param {String} businessUnitId The ID of the business unit
109954
+ * @param {Object} body body
109955
+ * @param {Object} opts Optional parameters
109956
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109957
+ */
109958
+ postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId, body, opts) {
109959
+ opts = opts || {};
109960
+
109961
+ // verify the required parameter 'businessUnitId' is set
109962
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
109963
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
109964
+ }
109965
+ // verify the required parameter 'body' is set
109966
+ if (body === undefined || body === null) {
109967
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
109968
+ }
109969
+
109970
+ return this.apiClient.callApi(
109971
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update',
109972
+ 'POST',
109973
+ { 'businessUnitId': businessUnitId },
109974
+ { },
109975
+ { },
109976
+ { },
109977
+ body,
109978
+ ['PureCloud OAuth'],
109979
+ ['application/json'],
109980
+ ['application/json'],
109981
+ opts['customHeaders']
109982
+ );
109983
+ }
109984
+
109985
+ /**
109986
+ * Bulk update enrollment status
109987
+ * Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
109988
+ * @param {String} businessUnitId The ID of the business unit
109989
+ * @param {Object} body body
109990
+ * @param {Object} opts Optional parameters
109991
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
109992
+ */
109993
+ postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId, body, opts) {
109994
+ opts = opts || {};
109995
+
109996
+ // verify the required parameter 'businessUnitId' is set
109997
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
109998
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
109999
+ }
110000
+ // verify the required parameter 'body' is set
110001
+ if (body === undefined || body === null) {
110002
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
110003
+ }
110004
+
110005
+ return this.apiClient.callApi(
110006
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update',
110007
+ 'POST',
110008
+ { 'businessUnitId': businessUnitId },
110009
+ { },
110010
+ { },
110011
+ { },
110012
+ body,
110013
+ ['PureCloud OAuth'],
110014
+ ['application/json'],
110015
+ ['application/json'],
110016
+ opts['customHeaders']
110017
+ );
110018
+ }
110019
+
110020
+ /**
110021
+ * Query enrollments
110022
+ * For more information about opportunities, use the expand parameter.
110023
+ * @param {String} businessUnitId The ID of the business unit
110024
+ * @param {Object} body body
110025
+ * @param {Object} opts Optional parameters
110026
+ * @param {Object} opts.expand List of resources to expand
110027
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
110028
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110029
+ */
110030
+ postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId, body, opts) {
110031
+ opts = opts || {};
110032
+
110033
+ // verify the required parameter 'businessUnitId' is set
110034
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
110035
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
110036
+ }
110037
+ // verify the required parameter 'body' is set
110038
+ if (body === undefined || body === null) {
110039
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
110040
+ }
110041
+
110042
+ return this.apiClient.callApi(
110043
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query',
110044
+ 'POST',
110045
+ { 'businessUnitId': businessUnitId },
110046
+ { 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
110047
+ { },
110048
+ { },
110049
+ body,
110050
+ ['PureCloud OAuth'],
110051
+ ['application/json'],
110052
+ ['application/json'],
110053
+ opts['customHeaders']
110054
+ );
110055
+ }
110056
+
110057
+ /**
110058
+ * Query opportunities by external activity IDs
110059
+ *
110060
+ * @param {String} businessUnitId The ID of the business unit
110061
+ * @param {Object} body body
110062
+ * @param {Object} opts Optional parameters
110063
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110064
+ */
110065
+ postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId, body, opts) {
110066
+ opts = opts || {};
110067
+
110068
+ // verify the required parameter 'businessUnitId' is set
110069
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
110070
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
110071
+ }
110072
+ // verify the required parameter 'body' is set
110073
+ if (body === undefined || body === null) {
110074
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
110075
+ }
110076
+
110077
+ return this.apiClient.callApi(
110078
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query',
110079
+ 'POST',
110080
+ { 'businessUnitId': businessUnitId },
110081
+ { },
110082
+ { },
110083
+ { },
110084
+ body,
110085
+ ['PureCloud OAuth'],
110086
+ ['application/json'],
110087
+ ['application/json'],
110088
+ opts['customHeaders']
110089
+ );
110090
+ }
110091
+
110092
+ /**
110093
+ * Query opportunities within the specified date range
110094
+ *
110095
+ * @param {String} businessUnitId The ID of the business unit
110096
+ * @param {Object} body body
110097
+ * @param {Object} opts Optional parameters
110098
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
110099
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110100
+ */
110101
+ postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId, body, opts) {
110102
+ opts = opts || {};
110103
+
110104
+ // verify the required parameter 'businessUnitId' is set
110105
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
110106
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
110107
+ }
110108
+ // verify the required parameter 'body' is set
110109
+ if (body === undefined || body === null) {
110110
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
110111
+ }
110112
+
110113
+ return this.apiClient.callApi(
110114
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query',
110115
+ 'POST',
110116
+ { 'businessUnitId': businessUnitId },
110117
+ { 'forceDownloadService': opts['forceDownloadService'] },
110118
+ { },
110119
+ { },
110120
+ body,
110121
+ ['PureCloud OAuth'],
110122
+ ['application/json'],
110123
+ ['application/json'],
110124
+ opts['customHeaders']
110125
+ );
110126
+ }
110127
+
110128
+ /**
110129
+ * Adds a new planning group
110130
+ * If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
108714
110131
  * @param {String} businessUnitId The ID of the business unit.
108715
110132
  * @param {Object} body body
108716
110133
  * @param {Object} opts Optional parameters
@@ -110696,6 +112113,7 @@ class WorkforceManagementApi {
110696
112113
  * @param {String} userId The id of the user for whom the time off request estimate is requested
110697
112114
  * @param {Object} body body
110698
112115
  * @param {Object} opts Optional parameters
112116
+ * @param {Object} opts.includeOnly Limit response to the specified field
110699
112117
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110700
112118
  */
110701
112119
  postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body, opts) {
@@ -110718,7 +112136,7 @@ class WorkforceManagementApi {
110718
112136
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
110719
112137
  'POST',
110720
112138
  { 'managementUnitId': managementUnitId,'userId': userId },
110721
- { },
112139
+ { 'includeOnly': opts['includeOnly'] },
110722
112140
  { },
110723
112141
  { },
110724
112142
  body,
@@ -110731,13 +112149,14 @@ class WorkforceManagementApi {
110731
112149
 
110732
112150
  /**
110733
112151
  * Matches a shift trade. This route can only be called by the receiving agent
110734
- *
112152
+ * Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
110735
112153
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
110736
112154
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
110737
112155
  * @param {String} tradeId The ID of the shift trade to update
110738
112156
  * @param {Object} body body
110739
112157
  * @param {Object} opts Optional parameters
110740
112158
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
112159
+ * @deprecated
110741
112160
  */
110742
112161
  postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body, opts) {
110743
112162
  opts = opts || {};
@@ -110776,12 +112195,13 @@ class WorkforceManagementApi {
110776
112195
 
110777
112196
  /**
110778
112197
  * Adds a shift trade
110779
- *
112198
+ * Deprecated. Use new route instead (/shifttrading/trades/jobs)
110780
112199
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
110781
112200
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
110782
112201
  * @param {Object} body body
110783
112202
  * @param {Object} opts Optional parameters
110784
112203
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
112204
+ * @deprecated
110785
112205
  */
110786
112206
  postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body, opts) {
110787
112207
  opts = opts || {};
@@ -110816,13 +112236,14 @@ class WorkforceManagementApi {
110816
112236
 
110817
112237
  /**
110818
112238
  * Searches for potential shift trade matches for the current agent
110819
- *
112239
+ * Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
110820
112240
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
110821
112241
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
110822
112242
  * @param {Object} body body
110823
112243
  * @param {Object} opts Optional parameters
110824
112244
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
110825
112245
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
112246
+ * @deprecated
110826
112247
  */
110827
112248
  postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
110828
112249
  opts = opts || {};
@@ -110857,13 +112278,14 @@ class WorkforceManagementApi {
110857
112278
 
110858
112279
  /**
110859
112280
  * Updates the state of a batch of shift trades
110860
- * Admin functionality is not supported with "mine".
112281
+ * Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
110861
112282
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
110862
112283
  * @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
110863
112284
  * @param {Object} body body
110864
112285
  * @param {Object} opts Optional parameters
110865
112286
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
110866
112287
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
112288
+ * @deprecated
110867
112289
  */
110868
112290
  postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, opts) {
110869
112291
  opts = opts || {};
@@ -111511,6 +112933,7 @@ class WorkforceManagementApi {
111511
112933
  *
111512
112934
  * @param {Object} body body
111513
112935
  * @param {Object} opts Optional parameters
112936
+ * @param {Object} opts.includeOnly Limit response to the specified field
111514
112937
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
111515
112938
  */
111516
112939
  postWorkforcemanagementTimeoffrequestsEstimate(body, opts) {
@@ -111525,7 +112948,7 @@ class WorkforceManagementApi {
111525
112948
  '/api/v2/workforcemanagement/timeoffrequests/estimate',
111526
112949
  'POST',
111527
112950
  { },
111528
- { },
112951
+ { 'includeOnly': opts['includeOnly'] },
111529
112952
  { },
111530
112953
  { },
111531
112954
  body,
@@ -111772,7 +113195,7 @@ class WorkforceManagementApi {
111772
113195
  * </pre>
111773
113196
  * </p>
111774
113197
  * @module purecloud-platform-client-v2/index
111775
- * @version 252.1.0
113198
+ * @version 254.0.0
111776
113199
  */
111777
113200
  class platformClient {
111778
113201
  constructor() {