purecloud-platform-client-v2 253.0.0 → 255.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 (98) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +1886 -311
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1887 -311
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +635 -310
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +642 -3129
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1030 -65
  9. package/package.json +1 -2
  10. package/src/purecloud-platform-client-v2/ApiClient.js +5 -5
  11. package/src/purecloud-platform-client-v2/PureCloudRegionHosts.js +1 -0
  12. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -62
  18. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +64 -1
  19. package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +435 -1
  25. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
  27. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -6
  31. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
  38. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -5
  40. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -5
  50. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -9
  69. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/RoutingApi.js +155 -3
  72. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +2 -2
  78. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +268 -1
  83. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  88. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  89. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -5
  90. package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  92. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  93. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  94. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  95. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  96. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  97. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +719 -57
  98. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -1,12 +1,10 @@
1
1
  'use strict';
2
2
 
3
3
  var axios = require('axios');
4
- var qs = require('qs');
5
4
 
6
5
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
7
6
 
8
7
  var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
9
- var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
10
8
 
11
9
  var PureCloudRegionHosts = {
12
10
  us_east_1: 'mypurecloud.com',
@@ -26,6 +24,7 @@ var PureCloudRegionHosts = {
26
24
  eu_central_2: 'euc2.pure.cloud',
27
25
  mx_central_1: 'mxc1.pure.cloud',
28
26
  ap_southeast_1: 'apse1.pure.cloud',
27
+ eusc_de_east_1: 'edee1.eusc-pure.cloud',
29
28
  };
30
29
 
31
30
  class AbstractHttpClient {
@@ -748,7 +747,7 @@ class Configuration {
748
747
 
749
748
  /**
750
749
  * @module purecloud-platform-client-v2/ApiClient
751
- * @version 253.0.0
750
+ * @version 255.0.0
752
751
  */
753
752
  class ApiClient {
754
753
  /**
@@ -1378,11 +1377,11 @@ class ApiClient {
1378
1377
  var headers = {
1379
1378
  'Content-Type': 'application/x-www-form-urlencoded'
1380
1379
  };
1381
- var data = qs__default["default"].stringify({ grant_type: 'authorization_code',
1380
+ var data = new URLSearchParams({ grant_type: 'authorization_code',
1382
1381
  code: authCode,
1383
1382
  code_verifier: codeVerifier,
1384
1383
  client_id: clientId,
1385
- redirect_uri: redirectUri });
1384
+ redirect_uri: redirectUri }).toString();
1386
1385
 
1387
1386
  var requestOptions = new HttpRequestOptions(`${loginBasePath}/oauth/token`, `POST`, headers, null, data, this.timeout);
1388
1387
  const httpClient = this.getHttpClient();
@@ -1833,7 +1832,8 @@ class ApiClient {
1833
1832
  'Authorization': 'Basic ' + encodedData,
1834
1833
  'Content-Type': 'application/x-www-form-urlencoded'
1835
1834
  };
1836
- var requestOptions = new HttpRequestOptions(`${loginBasePath}/oauth/token`, `POST`, headers, null, qs__default["default"].stringify(data), this.timeout);
1835
+ var queryData = new URLSearchParams(data).toString();
1836
+ var requestOptions = new HttpRequestOptions(`${loginBasePath}/oauth/token`, `POST`, headers, null, queryData, this.timeout);
1837
1837
  const httpClient = this.getHttpClient();
1838
1838
  return httpClient.request(requestOptions);
1839
1839
  }
@@ -2439,7 +2439,7 @@ class AIStudioApi {
2439
2439
  /**
2440
2440
  * AIStudio service.
2441
2441
  * @module purecloud-platform-client-v2/api/AIStudioApi
2442
- * @version 253.0.0
2442
+ * @version 255.0.0
2443
2443
  */
2444
2444
 
2445
2445
  /**
@@ -3154,7 +3154,7 @@ class AgentAssistantsApi {
3154
3154
  /**
3155
3155
  * AgentAssistants service.
3156
3156
  * @module purecloud-platform-client-v2/api/AgentAssistantsApi
3157
- * @version 253.0.0
3157
+ * @version 255.0.0
3158
3158
  */
3159
3159
 
3160
3160
  /**
@@ -3959,7 +3959,7 @@ class AgentCopilotApi {
3959
3959
  /**
3960
3960
  * AgentCopilot service.
3961
3961
  * @module purecloud-platform-client-v2/api/AgentCopilotApi
3962
- * @version 253.0.0
3962
+ * @version 255.0.0
3963
3963
  */
3964
3964
 
3965
3965
  /**
@@ -4071,7 +4071,7 @@ class AgentUIApi {
4071
4071
  /**
4072
4072
  * AgentUI service.
4073
4073
  * @module purecloud-platform-client-v2/api/AgentUIApi
4074
- * @version 253.0.0
4074
+ * @version 255.0.0
4075
4075
  */
4076
4076
 
4077
4077
  /**
@@ -4222,7 +4222,7 @@ class AlertingApi {
4222
4222
  /**
4223
4223
  * Alerting service.
4224
4224
  * @module purecloud-platform-client-v2/api/AlertingApi
4225
- * @version 253.0.0
4225
+ * @version 255.0.0
4226
4226
  */
4227
4227
 
4228
4228
  /**
@@ -4683,7 +4683,7 @@ class AnalyticsApi {
4683
4683
  /**
4684
4684
  * Analytics service.
4685
4685
  * @module purecloud-platform-client-v2/api/AnalyticsApi
4686
- * @version 253.0.0
4686
+ * @version 255.0.0
4687
4687
  */
4688
4688
 
4689
4689
  /**
@@ -4704,7 +4704,6 @@ class AnalyticsApi {
4704
4704
  * @param {String} jobId jobId
4705
4705
  * @param {Object} opts Optional parameters
4706
4706
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4707
- * deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4708
4707
  */
4709
4708
  deleteAnalyticsActionsAggregatesJob(jobId, opts) {
4710
4709
  opts = opts || {};
@@ -4797,7 +4796,6 @@ class AnalyticsApi {
4797
4796
  * @param {String} jobId jobId
4798
4797
  * @param {Object} opts Optional parameters
4799
4798
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4800
- * deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4801
4799
  */
4802
4800
  deleteAnalyticsBotsAggregatesJob(jobId, opts) {
4803
4801
  opts = opts || {};
@@ -4828,7 +4826,6 @@ class AnalyticsApi {
4828
4826
  * @param {String} jobId jobId
4829
4827
  * @param {Object} opts Optional parameters
4830
4828
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4831
- * deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4832
4829
  */
4833
4830
  deleteAnalyticsCasemanagementAggregatesJob(jobId, opts) {
4834
4831
  opts = opts || {};
@@ -4859,7 +4856,6 @@ class AnalyticsApi {
4859
4856
  * @param {String} jobId jobId
4860
4857
  * @param {Object} opts Optional parameters
4861
4858
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4862
- * deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4863
4859
  */
4864
4860
  deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
4865
4861
  opts = opts || {};
@@ -4951,7 +4947,6 @@ class AnalyticsApi {
4951
4947
  * @param {String} jobId jobId
4952
4948
  * @param {Object} opts Optional parameters
4953
4949
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4954
- * deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4955
4950
  */
4956
4951
  deleteAnalyticsEvaluationsAggregatesJob(jobId, opts) {
4957
4952
  opts = opts || {};
@@ -4982,7 +4977,6 @@ class AnalyticsApi {
4982
4977
  * @param {String} jobId jobId
4983
4978
  * @param {Object} opts Optional parameters
4984
4979
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
4985
- * deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4986
4980
  */
4987
4981
  deleteAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
4988
4982
  opts = opts || {};
@@ -5013,7 +5007,6 @@ class AnalyticsApi {
5013
5007
  * @param {String} jobId jobId
5014
5008
  * @param {Object} opts Optional parameters
5015
5009
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5016
- * deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5017
5010
  */
5018
5011
  deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
5019
5012
  opts = opts || {};
@@ -5044,7 +5037,6 @@ class AnalyticsApi {
5044
5037
  * @param {String} jobId jobId
5045
5038
  * @param {Object} opts Optional parameters
5046
5039
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5047
- * deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5048
5040
  */
5049
5041
  deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
5050
5042
  opts = opts || {};
@@ -5075,7 +5067,6 @@ class AnalyticsApi {
5075
5067
  * @param {String} jobId jobId
5076
5068
  * @param {Object} opts Optional parameters
5077
5069
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5078
- * deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5079
5070
  */
5080
5071
  deleteAnalyticsKnowledgeAggregatesJob(jobId, opts) {
5081
5072
  opts = opts || {};
@@ -5106,7 +5097,6 @@ class AnalyticsApi {
5106
5097
  * @param {String} jobId jobId
5107
5098
  * @param {Object} opts Optional parameters
5108
5099
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5109
- * deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5110
5100
  */
5111
5101
  deleteAnalyticsResolutionsAggregatesJob(jobId, opts) {
5112
5102
  opts = opts || {};
@@ -5137,7 +5127,6 @@ class AnalyticsApi {
5137
5127
  * @param {String} jobId jobId
5138
5128
  * @param {Object} opts Optional parameters
5139
5129
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5140
- * deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5141
5130
  */
5142
5131
  deleteAnalyticsSummariesAggregatesJob(jobId, opts) {
5143
5132
  opts = opts || {};
@@ -5168,7 +5157,6 @@ class AnalyticsApi {
5168
5157
  * @param {String} jobId jobId
5169
5158
  * @param {Object} opts Optional parameters
5170
5159
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5171
- * deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5172
5160
  */
5173
5161
  deleteAnalyticsSurveysAggregatesJob(jobId, opts) {
5174
5162
  opts = opts || {};
@@ -5199,7 +5187,6 @@ class AnalyticsApi {
5199
5187
  * @param {String} jobId jobId
5200
5188
  * @param {Object} opts Optional parameters
5201
5189
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5202
- * deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5203
5190
  */
5204
5191
  deleteAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
5205
5192
  opts = opts || {};
@@ -5230,7 +5217,6 @@ class AnalyticsApi {
5230
5217
  * @param {String} jobId jobId
5231
5218
  * @param {Object} opts Optional parameters
5232
5219
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5233
- * deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5234
5220
  */
5235
5221
  deleteAnalyticsTranscriptsAggregatesJob(jobId, opts) {
5236
5222
  opts = opts || {};
@@ -5261,7 +5247,6 @@ class AnalyticsApi {
5261
5247
  * @param {String} jobId jobId
5262
5248
  * @param {Object} opts Optional parameters
5263
5249
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5264
- * deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5265
5250
  */
5266
5251
  deleteAnalyticsUsersAggregatesJob(jobId, opts) {
5267
5252
  opts = opts || {};
@@ -5322,7 +5307,6 @@ class AnalyticsApi {
5322
5307
  * @param {String} jobId jobId
5323
5308
  * @param {Object} opts Optional parameters
5324
5309
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5325
- * getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5326
5310
  */
5327
5311
  getAnalyticsActionsAggregatesJob(jobId, opts) {
5328
5312
  opts = opts || {};
@@ -5354,7 +5338,6 @@ class AnalyticsApi {
5354
5338
  * @param {Object} opts Optional parameters
5355
5339
  * @param {String} opts.cursor Cursor token to retrieve next page
5356
5340
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5357
- * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5358
5341
  */
5359
5342
  getAnalyticsActionsAggregatesJobResults(jobId, opts) {
5360
5343
  opts = opts || {};
@@ -5651,7 +5634,6 @@ class AnalyticsApi {
5651
5634
  * @param {String} jobId jobId
5652
5635
  * @param {Object} opts Optional parameters
5653
5636
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5654
- * getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5655
5637
  */
5656
5638
  getAnalyticsBotsAggregatesJob(jobId, opts) {
5657
5639
  opts = opts || {};
@@ -5683,7 +5665,6 @@ class AnalyticsApi {
5683
5665
  * @param {Object} opts Optional parameters
5684
5666
  * @param {String} opts.cursor Cursor token to retrieve next page
5685
5667
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5686
- * getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5687
5668
  */
5688
5669
  getAnalyticsBotsAggregatesJobResults(jobId, opts) {
5689
5670
  opts = opts || {};
@@ -5714,7 +5695,6 @@ class AnalyticsApi {
5714
5695
  * @param {String} jobId jobId
5715
5696
  * @param {Object} opts Optional parameters
5716
5697
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5717
- * getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5718
5698
  */
5719
5699
  getAnalyticsCasemanagementAggregatesJob(jobId, opts) {
5720
5700
  opts = opts || {};
@@ -5746,7 +5726,6 @@ class AnalyticsApi {
5746
5726
  * @param {Object} opts Optional parameters
5747
5727
  * @param {String} opts.cursor Cursor token to retrieve next page
5748
5728
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5749
- * getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5750
5729
  */
5751
5730
  getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
5752
5731
  opts = opts || {};
@@ -5807,7 +5786,6 @@ class AnalyticsApi {
5807
5786
  * @param {String} jobId jobId
5808
5787
  * @param {Object} opts Optional parameters
5809
5788
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5810
- * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5811
5789
  */
5812
5790
  getAnalyticsConversationsAggregatesJob(jobId, opts) {
5813
5791
  opts = opts || {};
@@ -5839,7 +5817,6 @@ class AnalyticsApi {
5839
5817
  * @param {Object} opts Optional parameters
5840
5818
  * @param {String} opts.cursor Cursor token to retrieve next page
5841
5819
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
5842
- * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5843
5820
  */
5844
5821
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
5845
5822
  opts = opts || {};
@@ -6134,7 +6111,6 @@ class AnalyticsApi {
6134
6111
  * @param {String} jobId jobId
6135
6112
  * @param {Object} opts Optional parameters
6136
6113
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6137
- * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6138
6114
  */
6139
6115
  getAnalyticsEvaluationsAggregatesJob(jobId, opts) {
6140
6116
  opts = opts || {};
@@ -6166,7 +6142,6 @@ class AnalyticsApi {
6166
6142
  * @param {Object} opts Optional parameters
6167
6143
  * @param {String} opts.cursor Cursor token to retrieve next page
6168
6144
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6169
- * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6170
6145
  */
6171
6146
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
6172
6147
  opts = opts || {};
@@ -6197,7 +6172,6 @@ class AnalyticsApi {
6197
6172
  * @param {String} jobId jobId
6198
6173
  * @param {Object} opts Optional parameters
6199
6174
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6200
- * getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6201
6175
  */
6202
6176
  getAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
6203
6177
  opts = opts || {};
@@ -6229,7 +6203,6 @@ class AnalyticsApi {
6229
6203
  * @param {Object} opts Optional parameters
6230
6204
  * @param {String} opts.cursor Cursor token to retrieve next page
6231
6205
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6232
- * getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6233
6206
  */
6234
6207
  getAnalyticsFlowexecutionsAggregatesJobResults(jobId, opts) {
6235
6208
  opts = opts || {};
@@ -6260,7 +6233,6 @@ class AnalyticsApi {
6260
6233
  * @param {String} jobId jobId
6261
6234
  * @param {Object} opts Optional parameters
6262
6235
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6263
- * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6264
6236
  */
6265
6237
  getAnalyticsFlowsAggregatesJob(jobId, opts) {
6266
6238
  opts = opts || {};
@@ -6292,7 +6264,6 @@ class AnalyticsApi {
6292
6264
  * @param {Object} opts Optional parameters
6293
6265
  * @param {String} opts.cursor Cursor token to retrieve next page
6294
6266
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6295
- * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6296
6267
  */
6297
6268
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
6298
6269
  opts = opts || {};
@@ -6323,7 +6294,6 @@ class AnalyticsApi {
6323
6294
  * @param {String} jobId jobId
6324
6295
  * @param {Object} opts Optional parameters
6325
6296
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6326
- * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6327
6297
  */
6328
6298
  getAnalyticsJourneysAggregatesJob(jobId, opts) {
6329
6299
  opts = opts || {};
@@ -6355,7 +6325,6 @@ class AnalyticsApi {
6355
6325
  * @param {Object} opts Optional parameters
6356
6326
  * @param {String} opts.cursor Cursor token to retrieve next page
6357
6327
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6358
- * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6359
6328
  */
6360
6329
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
6361
6330
  opts = opts || {};
@@ -6386,7 +6355,6 @@ class AnalyticsApi {
6386
6355
  * @param {String} jobId jobId
6387
6356
  * @param {Object} opts Optional parameters
6388
6357
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6389
- * getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6390
6358
  */
6391
6359
  getAnalyticsKnowledgeAggregatesJob(jobId, opts) {
6392
6360
  opts = opts || {};
@@ -6418,7 +6386,6 @@ class AnalyticsApi {
6418
6386
  * @param {Object} opts Optional parameters
6419
6387
  * @param {String} opts.cursor Cursor token to retrieve next page
6420
6388
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6421
- * getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6422
6389
  */
6423
6390
  getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
6424
6391
  opts = opts || {};
@@ -6664,7 +6631,6 @@ class AnalyticsApi {
6664
6631
  * @param {String} jobId jobId
6665
6632
  * @param {Object} opts Optional parameters
6666
6633
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6667
- * getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6668
6634
  */
6669
6635
  getAnalyticsResolutionsAggregatesJob(jobId, opts) {
6670
6636
  opts = opts || {};
@@ -6696,7 +6662,6 @@ class AnalyticsApi {
6696
6662
  * @param {Object} opts Optional parameters
6697
6663
  * @param {String} opts.cursor Cursor token to retrieve next page
6698
6664
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6699
- * getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6700
6665
  */
6701
6666
  getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
6702
6667
  opts = opts || {};
@@ -6727,7 +6692,6 @@ class AnalyticsApi {
6727
6692
  * @param {String} jobId jobId
6728
6693
  * @param {Object} opts Optional parameters
6729
6694
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6730
- * getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6731
6695
  */
6732
6696
  getAnalyticsSummariesAggregatesJob(jobId, opts) {
6733
6697
  opts = opts || {};
@@ -6759,7 +6723,6 @@ class AnalyticsApi {
6759
6723
  * @param {Object} opts Optional parameters
6760
6724
  * @param {String} opts.cursor Cursor token to retrieve next page
6761
6725
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6762
- * getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6763
6726
  */
6764
6727
  getAnalyticsSummariesAggregatesJobResults(jobId, opts) {
6765
6728
  opts = opts || {};
@@ -6790,7 +6753,6 @@ class AnalyticsApi {
6790
6753
  * @param {String} jobId jobId
6791
6754
  * @param {Object} opts Optional parameters
6792
6755
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6793
- * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6794
6756
  */
6795
6757
  getAnalyticsSurveysAggregatesJob(jobId, opts) {
6796
6758
  opts = opts || {};
@@ -6822,7 +6784,6 @@ class AnalyticsApi {
6822
6784
  * @param {Object} opts Optional parameters
6823
6785
  * @param {String} opts.cursor Cursor token to retrieve next page
6824
6786
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6825
- * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6826
6787
  */
6827
6788
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
6828
6789
  opts = opts || {};
@@ -6853,7 +6814,6 @@ class AnalyticsApi {
6853
6814
  * @param {String} jobId jobId
6854
6815
  * @param {Object} opts Optional parameters
6855
6816
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6856
- * getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6857
6817
  */
6858
6818
  getAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
6859
6819
  opts = opts || {};
@@ -6885,7 +6845,6 @@ class AnalyticsApi {
6885
6845
  * @param {Object} opts Optional parameters
6886
6846
  * @param {String} opts.cursor Cursor token to retrieve next page
6887
6847
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6888
- * getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6889
6848
  */
6890
6849
  getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
6891
6850
  opts = opts || {};
@@ -6916,7 +6875,6 @@ class AnalyticsApi {
6916
6875
  * @param {String} jobId jobId
6917
6876
  * @param {Object} opts Optional parameters
6918
6877
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6919
- * getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6920
6878
  */
6921
6879
  getAnalyticsTranscriptsAggregatesJob(jobId, opts) {
6922
6880
  opts = opts || {};
@@ -6948,7 +6906,6 @@ class AnalyticsApi {
6948
6906
  * @param {Object} opts Optional parameters
6949
6907
  * @param {String} opts.cursor Cursor token to retrieve next page
6950
6908
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6951
- * getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6952
6909
  */
6953
6910
  getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
6954
6911
  opts = opts || {};
@@ -6979,7 +6936,6 @@ class AnalyticsApi {
6979
6936
  * @param {String} jobId jobId
6980
6937
  * @param {Object} opts Optional parameters
6981
6938
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
6982
- * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6983
6939
  */
6984
6940
  getAnalyticsUsersAggregatesJob(jobId, opts) {
6985
6941
  opts = opts || {};
@@ -7011,7 +6967,6 @@ class AnalyticsApi {
7011
6967
  * @param {Object} opts Optional parameters
7012
6968
  * @param {String} opts.cursor Cursor token to retrieve next page
7013
6969
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7014
- * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7015
6970
  */
7016
6971
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
7017
6972
  opts = opts || {};
@@ -7159,7 +7114,6 @@ class AnalyticsApi {
7159
7114
  * @param {Object} body query
7160
7115
  * @param {Object} opts Optional parameters
7161
7116
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7162
- * postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7163
7117
  */
7164
7118
  postAnalyticsActionsAggregatesJobs(body, opts) {
7165
7119
  opts = opts || {};
@@ -7404,7 +7358,6 @@ class AnalyticsApi {
7404
7358
  * @param {Object} body query
7405
7359
  * @param {Object} opts Optional parameters
7406
7360
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7407
- * postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7408
7361
  */
7409
7362
  postAnalyticsBotsAggregatesJobs(body, opts) {
7410
7363
  opts = opts || {};
@@ -7465,7 +7418,6 @@ class AnalyticsApi {
7465
7418
  * @param {Object} body query
7466
7419
  * @param {Object} opts Optional parameters
7467
7420
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7468
- * postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7469
7421
  */
7470
7422
  postAnalyticsCasemanagementAggregatesJobs(body, opts) {
7471
7423
  opts = opts || {};
@@ -7496,7 +7448,6 @@ class AnalyticsApi {
7496
7448
  * @param {Object} body query
7497
7449
  * @param {Object} opts Optional parameters
7498
7450
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7499
- * postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7500
7451
  */
7501
7452
  postAnalyticsCasemanagementAggregatesQuery(body, opts) {
7502
7453
  opts = opts || {};
@@ -7594,7 +7545,6 @@ class AnalyticsApi {
7594
7545
  * @param {Object} body query
7595
7546
  * @param {Object} opts Optional parameters
7596
7547
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7597
- * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7598
7548
  */
7599
7549
  postAnalyticsConversationsAggregatesJobs(body, opts) {
7600
7550
  opts = opts || {};
@@ -7808,7 +7758,6 @@ class AnalyticsApi {
7808
7758
  * @param {Object} body query
7809
7759
  * @param {Object} opts Optional parameters
7810
7760
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7811
- * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7812
7761
  */
7813
7762
  postAnalyticsEvaluationsAggregatesJobs(body, opts) {
7814
7763
  opts = opts || {};
@@ -7869,7 +7818,6 @@ class AnalyticsApi {
7869
7818
  * @param {Object} body query
7870
7819
  * @param {Object} opts Optional parameters
7871
7820
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7872
- * postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7873
7821
  */
7874
7822
  postAnalyticsFlowexecutionsAggregatesJobs(body, opts) {
7875
7823
  opts = opts || {};
@@ -7962,7 +7910,6 @@ class AnalyticsApi {
7962
7910
  * @param {Object} body query
7963
7911
  * @param {Object} opts Optional parameters
7964
7912
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
7965
- * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7966
7913
  */
7967
7914
  postAnalyticsFlowsAggregatesJobs(body, opts) {
7968
7915
  opts = opts || {};
@@ -8053,7 +8000,6 @@ class AnalyticsApi {
8053
8000
  * @param {Object} body query
8054
8001
  * @param {Object} opts Optional parameters
8055
8002
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8056
- * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8057
8003
  */
8058
8004
  postAnalyticsJourneysAggregatesJobs(body, opts) {
8059
8005
  opts = opts || {};
@@ -8114,7 +8060,6 @@ class AnalyticsApi {
8114
8060
  * @param {Object} body query
8115
8061
  * @param {Object} opts Optional parameters
8116
8062
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8117
- * postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8118
8063
  */
8119
8064
  postAnalyticsKnowledgeAggregatesJobs(body, opts) {
8120
8065
  opts = opts || {};
@@ -8355,7 +8300,6 @@ class AnalyticsApi {
8355
8300
  * @param {Object} body query
8356
8301
  * @param {Object} opts Optional parameters
8357
8302
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8358
- * postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8359
8303
  */
8360
8304
  postAnalyticsResolutionsAggregatesJobs(body, opts) {
8361
8305
  opts = opts || {};
@@ -8448,7 +8392,6 @@ class AnalyticsApi {
8448
8392
  * @param {Object} body query
8449
8393
  * @param {Object} opts Optional parameters
8450
8394
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8451
- * postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8452
8395
  */
8453
8396
  postAnalyticsSummariesAggregatesJobs(body, opts) {
8454
8397
  opts = opts || {};
@@ -8509,7 +8452,6 @@ class AnalyticsApi {
8509
8452
  * @param {Object} body query
8510
8453
  * @param {Object} opts Optional parameters
8511
8454
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8512
- * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8513
8455
  */
8514
8456
  postAnalyticsSurveysAggregatesJobs(body, opts) {
8515
8457
  opts = opts || {};
@@ -8570,7 +8512,6 @@ class AnalyticsApi {
8570
8512
  * @param {Object} body query
8571
8513
  * @param {Object} opts Optional parameters
8572
8514
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8573
- * postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8574
8515
  */
8575
8516
  postAnalyticsTaskmanagementAggregatesJobs(body, opts) {
8576
8517
  opts = opts || {};
@@ -8695,7 +8636,6 @@ class AnalyticsApi {
8695
8636
  * @param {Object} body query
8696
8637
  * @param {Object} opts Optional parameters
8697
8638
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8698
- * postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8699
8639
  */
8700
8640
  postAnalyticsTranscriptsAggregatesJobs(body, opts) {
8701
8641
  opts = opts || {};
@@ -8788,7 +8728,6 @@ class AnalyticsApi {
8788
8728
  * @param {Object} body query
8789
8729
  * @param {Object} opts Optional parameters
8790
8730
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
8791
- * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
8792
8731
  */
8793
8732
  postAnalyticsUsersAggregatesJobs(body, opts) {
8794
8733
  opts = opts || {};
@@ -8969,7 +8908,7 @@ class ArchitectApi {
8969
8908
  /**
8970
8909
  * Architect service.
8971
8910
  * @module purecloud-platform-client-v2/api/ArchitectApi
8972
- * @version 253.0.0
8911
+ * @version 255.0.0
8973
8912
  */
8974
8913
 
8975
8914
  /**
@@ -11998,6 +11937,38 @@ class ArchitectApi {
11998
11937
  );
11999
11938
  }
12000
11939
 
11940
+ /**
11941
+ * Fetch Architect Validate Job Status
11942
+ *
11943
+ * @param {String} jobId Job ID
11944
+ * @param {Object} opts Optional parameters
11945
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand.
11946
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
11947
+ * getFlowsValidateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11948
+ */
11949
+ getFlowsValidateJob(jobId, opts) {
11950
+ opts = opts || {};
11951
+
11952
+ // verify the required parameter 'jobId' is set
11953
+ if (jobId === undefined || jobId === null || jobId === '') {
11954
+ throw 'Missing the required parameter "jobId" when calling getFlowsValidateJob';
11955
+ }
11956
+
11957
+ return this.apiClient.callApi(
11958
+ '/api/v2/flows/validate/jobs/{jobId}',
11959
+ 'GET',
11960
+ { 'jobId': jobId },
11961
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
11962
+ { },
11963
+ { },
11964
+ null,
11965
+ ['PureCloud OAuth'],
11966
+ ['application/json'],
11967
+ ['application/json'],
11968
+ opts['customHeaders']
11969
+ );
11970
+ }
11971
+
12001
11972
  /**
12002
11973
  * Updates a grammar
12003
11974
  *
@@ -13297,6 +13268,37 @@ class ArchitectApi {
13297
13268
  );
13298
13269
  }
13299
13270
 
13271
+ /**
13272
+ * Register Architect Validate Job
13273
+ *
13274
+ * @param {Object} body
13275
+ * @param {Object} opts Optional parameters
13276
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
13277
+ * postFlowsValidateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13278
+ */
13279
+ postFlowsValidateJobs(body, opts) {
13280
+ opts = opts || {};
13281
+
13282
+ // verify the required parameter 'body' is set
13283
+ if (body === undefined || body === null) {
13284
+ throw 'Missing the required parameter "body" when calling postFlowsValidateJobs';
13285
+ }
13286
+
13287
+ return this.apiClient.callApi(
13288
+ '/api/v2/flows/validate/jobs',
13289
+ 'POST',
13290
+ { },
13291
+ { },
13292
+ { },
13293
+ { },
13294
+ body,
13295
+ ['PureCloud OAuth'],
13296
+ ['application/json'],
13297
+ ['application/json'],
13298
+ opts['customHeaders']
13299
+ );
13300
+ }
13301
+
13300
13302
  /**
13301
13303
  * Updates a emergency group by ID
13302
13304
  *
@@ -13829,7 +13831,7 @@ class AssistantCopilotVariationsApi {
13829
13831
  /**
13830
13832
  * AssistantCopilotVariations service.
13831
13833
  * @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
13832
- * @version 253.0.0
13834
+ * @version 255.0.0
13833
13835
  */
13834
13836
 
13835
13837
  /**
@@ -14025,7 +14027,7 @@ class AuditApi {
14025
14027
  /**
14026
14028
  * Audit service.
14027
14029
  * @module purecloud-platform-client-v2/api/AuditApi
14028
- * @version 253.0.0
14030
+ * @version 255.0.0
14029
14031
  */
14030
14032
 
14031
14033
  /**
@@ -14252,7 +14254,7 @@ class AuthorizationApi {
14252
14254
  /**
14253
14255
  * Authorization service.
14254
14256
  * @module purecloud-platform-client-v2/api/AuthorizationApi
14255
- * @version 253.0.0
14257
+ * @version 255.0.0
14256
14258
  */
14257
14259
 
14258
14260
  /**
@@ -16177,7 +16179,7 @@ class BackgroundAssistantApi {
16177
16179
  /**
16178
16180
  * BackgroundAssistant service.
16179
16181
  * @module purecloud-platform-client-v2/api/BackgroundAssistantApi
16180
- * @version 253.0.0
16182
+ * @version 255.0.0
16181
16183
  */
16182
16184
 
16183
16185
  /**
@@ -16251,7 +16253,7 @@ class BillingApi {
16251
16253
  /**
16252
16254
  * Billing service.
16253
16255
  * @module purecloud-platform-client-v2/api/BillingApi
16254
- * @version 253.0.0
16256
+ * @version 255.0.0
16255
16257
  */
16256
16258
 
16257
16259
  /**
@@ -16535,7 +16537,7 @@ class BusinessRulesApi {
16535
16537
  /**
16536
16538
  * BusinessRules service.
16537
16539
  * @module purecloud-platform-client-v2/api/BusinessRulesApi
16538
- * @version 253.0.0
16540
+ * @version 255.0.0
16539
16541
  */
16540
16542
 
16541
16543
  /**
@@ -16581,6 +16583,76 @@ class BusinessRulesApi {
16581
16583
  );
16582
16584
  }
16583
16585
 
16586
+ /**
16587
+ * Delete an export job for a decision table
16588
+ *
16589
+ * @param {String} tableId Table ID
16590
+ * @param {String} exportJobId Export Job ID
16591
+ * @param {Object} opts Optional parameters
16592
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16593
+ */
16594
+ deleteBusinessrulesDecisiontableExport(tableId, exportJobId, opts) {
16595
+ opts = opts || {};
16596
+
16597
+ // verify the required parameter 'tableId' is set
16598
+ if (tableId === undefined || tableId === null || tableId === '') {
16599
+ throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableExport';
16600
+ }
16601
+ // verify the required parameter 'exportJobId' is set
16602
+ if (exportJobId === undefined || exportJobId === null || exportJobId === '') {
16603
+ throw 'Missing the required parameter "exportJobId" when calling deleteBusinessrulesDecisiontableExport';
16604
+ }
16605
+
16606
+ return this.apiClient.callApi(
16607
+ '/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}',
16608
+ 'DELETE',
16609
+ { 'tableId': tableId,'exportJobId': exportJobId },
16610
+ { },
16611
+ { },
16612
+ { },
16613
+ null,
16614
+ ['PureCloud OAuth'],
16615
+ ['application/json'],
16616
+ ['application/json'],
16617
+ opts['customHeaders']
16618
+ );
16619
+ }
16620
+
16621
+ /**
16622
+ * Delete decision table row import job
16623
+ *
16624
+ * @param {String} tableId Table ID
16625
+ * @param {String} importJobId Import job ID
16626
+ * @param {Object} opts Optional parameters
16627
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16628
+ */
16629
+ deleteBusinessrulesDecisiontableImport(tableId, importJobId, opts) {
16630
+ opts = opts || {};
16631
+
16632
+ // verify the required parameter 'tableId' is set
16633
+ if (tableId === undefined || tableId === null || tableId === '') {
16634
+ throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableImport';
16635
+ }
16636
+ // verify the required parameter 'importJobId' is set
16637
+ if (importJobId === undefined || importJobId === null || importJobId === '') {
16638
+ throw 'Missing the required parameter "importJobId" when calling deleteBusinessrulesDecisiontableImport';
16639
+ }
16640
+
16641
+ return this.apiClient.callApi(
16642
+ '/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
16643
+ 'DELETE',
16644
+ { 'tableId': tableId,'importJobId': importJobId },
16645
+ { },
16646
+ { },
16647
+ { },
16648
+ null,
16649
+ ['PureCloud OAuth'],
16650
+ ['application/json'],
16651
+ ['application/json'],
16652
+ opts['customHeaders']
16653
+ );
16654
+ }
16655
+
16584
16656
  /**
16585
16657
  * Delete a decision table version
16586
16658
  *
@@ -16716,6 +16788,140 @@ class BusinessRulesApi {
16716
16788
  );
16717
16789
  }
16718
16790
 
16791
+ /**
16792
+ * Get an export job for a decision table
16793
+ *
16794
+ * @param {String} tableId Table ID
16795
+ * @param {String} exportJobId Export Job ID
16796
+ * @param {Object} opts Optional parameters
16797
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16798
+ */
16799
+ getBusinessrulesDecisiontableExport(tableId, exportJobId, opts) {
16800
+ opts = opts || {};
16801
+
16802
+ // verify the required parameter 'tableId' is set
16803
+ if (tableId === undefined || tableId === null || tableId === '') {
16804
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExport';
16805
+ }
16806
+ // verify the required parameter 'exportJobId' is set
16807
+ if (exportJobId === undefined || exportJobId === null || exportJobId === '') {
16808
+ throw 'Missing the required parameter "exportJobId" when calling getBusinessrulesDecisiontableExport';
16809
+ }
16810
+
16811
+ return this.apiClient.callApi(
16812
+ '/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}',
16813
+ 'GET',
16814
+ { 'tableId': tableId,'exportJobId': exportJobId },
16815
+ { },
16816
+ { },
16817
+ { },
16818
+ null,
16819
+ ['PureCloud OAuth'],
16820
+ ['application/json'],
16821
+ ['application/json'],
16822
+ opts['customHeaders']
16823
+ );
16824
+ }
16825
+
16826
+ /**
16827
+ * List export jobs for a decision table
16828
+ *
16829
+ * @param {String} tableId Table ID
16830
+ * @param {Object} opts Optional parameters
16831
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
16832
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 100.
16833
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16834
+ */
16835
+ getBusinessrulesDecisiontableExports(tableId, opts) {
16836
+ opts = opts || {};
16837
+
16838
+ // verify the required parameter 'tableId' is set
16839
+ if (tableId === undefined || tableId === null || tableId === '') {
16840
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExports';
16841
+ }
16842
+
16843
+ return this.apiClient.callApi(
16844
+ '/api/v2/businessrules/decisiontables/{tableId}/exports',
16845
+ 'GET',
16846
+ { 'tableId': tableId },
16847
+ { 'after': opts['after'],'pageSize': opts['pageSize'] },
16848
+ { },
16849
+ { },
16850
+ null,
16851
+ ['PureCloud OAuth'],
16852
+ ['application/json'],
16853
+ ['application/json'],
16854
+ opts['customHeaders']
16855
+ );
16856
+ }
16857
+
16858
+ /**
16859
+ * Get decision table row import job
16860
+ *
16861
+ * @param {String} tableId Table ID
16862
+ * @param {String} importJobId Import job ID
16863
+ * @param {Object} opts Optional parameters
16864
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16865
+ */
16866
+ getBusinessrulesDecisiontableImport(tableId, importJobId, opts) {
16867
+ opts = opts || {};
16868
+
16869
+ // verify the required parameter 'tableId' is set
16870
+ if (tableId === undefined || tableId === null || tableId === '') {
16871
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImport';
16872
+ }
16873
+ // verify the required parameter 'importJobId' is set
16874
+ if (importJobId === undefined || importJobId === null || importJobId === '') {
16875
+ throw 'Missing the required parameter "importJobId" when calling getBusinessrulesDecisiontableImport';
16876
+ }
16877
+
16878
+ return this.apiClient.callApi(
16879
+ '/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
16880
+ 'GET',
16881
+ { 'tableId': tableId,'importJobId': importJobId },
16882
+ { },
16883
+ { },
16884
+ { },
16885
+ null,
16886
+ ['PureCloud OAuth'],
16887
+ ['application/json'],
16888
+ ['application/json'],
16889
+ opts['customHeaders']
16890
+ );
16891
+ }
16892
+
16893
+ /**
16894
+ * List decision table row import jobs
16895
+ *
16896
+ * @param {String} tableId Table ID
16897
+ * @param {Object} opts Optional parameters
16898
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
16899
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 100.
16900
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
16901
+ */
16902
+ getBusinessrulesDecisiontableImports(tableId, opts) {
16903
+ opts = opts || {};
16904
+
16905
+ // verify the required parameter 'tableId' is set
16906
+ if (tableId === undefined || tableId === null || tableId === '') {
16907
+ throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImports';
16908
+ }
16909
+
16910
+ return this.apiClient.callApi(
16911
+ '/api/v2/businessrules/decisiontables/{tableId}/imports',
16912
+ 'GET',
16913
+ { 'tableId': tableId },
16914
+ { 'after': opts['after'],'pageSize': opts['pageSize'] },
16915
+ { },
16916
+ { },
16917
+ null,
16918
+ ['PureCloud OAuth'],
16919
+ ['application/json'],
16920
+ ['application/json'],
16921
+ opts['customHeaders']
16922
+ );
16923
+ }
16924
+
16719
16925
  /**
16720
16926
  * Get a decision table version
16721
16927
  *
@@ -17066,6 +17272,46 @@ class BusinessRulesApi {
17066
17272
  );
17067
17273
  }
17068
17274
 
17275
+ /**
17276
+ * Update decision table row import job
17277
+ *
17278
+ * @param {String} tableId Table ID
17279
+ * @param {String} importJobId Import job ID
17280
+ * @param {Object} body Import job update request
17281
+ * @param {Object} opts Optional parameters
17282
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17283
+ */
17284
+ patchBusinessrulesDecisiontableImport(tableId, importJobId, body, opts) {
17285
+ opts = opts || {};
17286
+
17287
+ // verify the required parameter 'tableId' is set
17288
+ if (tableId === undefined || tableId === null || tableId === '') {
17289
+ throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableImport';
17290
+ }
17291
+ // verify the required parameter 'importJobId' is set
17292
+ if (importJobId === undefined || importJobId === null || importJobId === '') {
17293
+ throw 'Missing the required parameter "importJobId" when calling patchBusinessrulesDecisiontableImport';
17294
+ }
17295
+ // verify the required parameter 'body' is set
17296
+ if (body === undefined || body === null) {
17297
+ throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableImport';
17298
+ }
17299
+
17300
+ return this.apiClient.callApi(
17301
+ '/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
17302
+ 'PATCH',
17303
+ { 'tableId': tableId,'importJobId': importJobId },
17304
+ { },
17305
+ { },
17306
+ { },
17307
+ body,
17308
+ ['PureCloud OAuth'],
17309
+ ['application/json'],
17310
+ ['application/json'],
17311
+ opts['customHeaders']
17312
+ );
17313
+ }
17314
+
17069
17315
  /**
17070
17316
  * Update a decision table version
17071
17317
  *
@@ -17141,6 +17387,76 @@ class BusinessRulesApi {
17141
17387
  );
17142
17388
  }
17143
17389
 
17390
+ /**
17391
+ * Create an export job for a decision table version
17392
+ *
17393
+ * @param {String} tableId Table ID
17394
+ * @param {Object} body Export job request
17395
+ * @param {Object} opts Optional parameters
17396
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17397
+ */
17398
+ postBusinessrulesDecisiontableExports(tableId, body, opts) {
17399
+ opts = opts || {};
17400
+
17401
+ // verify the required parameter 'tableId' is set
17402
+ if (tableId === undefined || tableId === null || tableId === '') {
17403
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExports';
17404
+ }
17405
+ // verify the required parameter 'body' is set
17406
+ if (body === undefined || body === null) {
17407
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExports';
17408
+ }
17409
+
17410
+ return this.apiClient.callApi(
17411
+ '/api/v2/businessrules/decisiontables/{tableId}/exports',
17412
+ 'POST',
17413
+ { 'tableId': tableId },
17414
+ { },
17415
+ { },
17416
+ { },
17417
+ body,
17418
+ ['PureCloud OAuth'],
17419
+ ['application/json'],
17420
+ ['application/json'],
17421
+ opts['customHeaders']
17422
+ );
17423
+ }
17424
+
17425
+ /**
17426
+ * Create a decision table row import job
17427
+ *
17428
+ * @param {String} tableId Table ID
17429
+ * @param {Object} body Import job create request
17430
+ * @param {Object} opts Optional parameters
17431
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17432
+ */
17433
+ postBusinessrulesDecisiontableImports(tableId, body, opts) {
17434
+ opts = opts || {};
17435
+
17436
+ // verify the required parameter 'tableId' is set
17437
+ if (tableId === undefined || tableId === null || tableId === '') {
17438
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableImports';
17439
+ }
17440
+ // verify the required parameter 'body' is set
17441
+ if (body === undefined || body === null) {
17442
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableImports';
17443
+ }
17444
+
17445
+ return this.apiClient.callApi(
17446
+ '/api/v2/businessrules/decisiontables/{tableId}/imports',
17447
+ 'POST',
17448
+ { 'tableId': tableId },
17449
+ { },
17450
+ { },
17451
+ { },
17452
+ body,
17453
+ ['PureCloud OAuth'],
17454
+ ['application/json'],
17455
+ ['application/json'],
17456
+ opts['customHeaders']
17457
+ );
17458
+ }
17459
+
17144
17460
  /**
17145
17461
  * Copy a decision table version
17146
17462
  *
@@ -17261,6 +17577,126 @@ class BusinessRulesApi {
17261
17577
  );
17262
17578
  }
17263
17579
 
17580
+ /**
17581
+ * Bulk add decision table rows
17582
+ * 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.
17583
+ * @param {String} tableId Table ID
17584
+ * @param {Number} tableVersion Table Version
17585
+ * @param {Object} body Bulk add decision table rows request
17586
+ * @param {Object} opts Optional parameters
17587
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17588
+ */
17589
+ postBusinessrulesDecisiontableVersionRowsBulkAdd(tableId, tableVersion, body, opts) {
17590
+ opts = opts || {};
17591
+
17592
+ // verify the required parameter 'tableId' is set
17593
+ if (tableId === undefined || tableId === null || tableId === '') {
17594
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
17595
+ }
17596
+ // verify the required parameter 'tableVersion' is set
17597
+ if (tableVersion === undefined || tableVersion === null) {
17598
+ throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
17599
+ }
17600
+ // verify the required parameter 'body' is set
17601
+ if (body === undefined || body === null) {
17602
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
17603
+ }
17604
+
17605
+ return this.apiClient.callApi(
17606
+ '/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/add',
17607
+ 'POST',
17608
+ { 'tableId': tableId,'tableVersion': tableVersion },
17609
+ { },
17610
+ { },
17611
+ { },
17612
+ body,
17613
+ ['PureCloud OAuth'],
17614
+ ['application/json'],
17615
+ ['application/json'],
17616
+ opts['customHeaders']
17617
+ );
17618
+ }
17619
+
17620
+ /**
17621
+ * Bulk delete decision table rows
17622
+ * 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.
17623
+ * @param {String} tableId Table ID
17624
+ * @param {Number} tableVersion Table Version
17625
+ * @param {Object} body
17626
+ * @param {Object} opts Optional parameters
17627
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17628
+ */
17629
+ postBusinessrulesDecisiontableVersionRowsBulkRemove(tableId, tableVersion, body, opts) {
17630
+ opts = opts || {};
17631
+
17632
+ // verify the required parameter 'tableId' is set
17633
+ if (tableId === undefined || tableId === null || tableId === '') {
17634
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
17635
+ }
17636
+ // verify the required parameter 'tableVersion' is set
17637
+ if (tableVersion === undefined || tableVersion === null) {
17638
+ throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
17639
+ }
17640
+ // verify the required parameter 'body' is set
17641
+ if (body === undefined || body === null) {
17642
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
17643
+ }
17644
+
17645
+ return this.apiClient.callApi(
17646
+ '/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/remove',
17647
+ 'POST',
17648
+ { 'tableId': tableId,'tableVersion': tableVersion },
17649
+ { },
17650
+ { },
17651
+ { },
17652
+ body,
17653
+ ['PureCloud OAuth'],
17654
+ ['application/json'],
17655
+ ['application/json'],
17656
+ opts['customHeaders']
17657
+ );
17658
+ }
17659
+
17660
+ /**
17661
+ * Bulk update decision table rows
17662
+ * 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.
17663
+ * @param {String} tableId Table ID
17664
+ * @param {Number} tableVersion Table Version
17665
+ * @param {Object} body Bulk update decision table rows request
17666
+ * @param {Object} opts Optional parameters
17667
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17668
+ */
17669
+ postBusinessrulesDecisiontableVersionRowsBulkUpdate(tableId, tableVersion, body, opts) {
17670
+ opts = opts || {};
17671
+
17672
+ // verify the required parameter 'tableId' is set
17673
+ if (tableId === undefined || tableId === null || tableId === '') {
17674
+ throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
17675
+ }
17676
+ // verify the required parameter 'tableVersion' is set
17677
+ if (tableVersion === undefined || tableVersion === null) {
17678
+ throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
17679
+ }
17680
+ // verify the required parameter 'body' is set
17681
+ if (body === undefined || body === null) {
17682
+ throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
17683
+ }
17684
+
17685
+ return this.apiClient.callApi(
17686
+ '/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/update',
17687
+ 'POST',
17688
+ { 'tableId': tableId,'tableVersion': tableVersion },
17689
+ { },
17690
+ { },
17691
+ { },
17692
+ body,
17693
+ ['PureCloud OAuth'],
17694
+ ['application/json'],
17695
+ ['application/json'],
17696
+ opts['customHeaders']
17697
+ );
17698
+ }
17699
+
17264
17700
  /**
17265
17701
  * Search for decision table rows
17266
17702
  *
@@ -17549,7 +17985,7 @@ class CarrierServicesApi {
17549
17985
  /**
17550
17986
  * CarrierServices service.
17551
17987
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
17552
- * @version 253.0.0
17988
+ * @version 255.0.0
17553
17989
  */
17554
17990
 
17555
17991
  /**
@@ -17626,7 +18062,7 @@ class CaseManagementApi {
17626
18062
  /**
17627
18063
  * CaseManagement service.
17628
18064
  * @module purecloud-platform-client-v2/api/CaseManagementApi
17629
- * @version 253.0.0
18065
+ * @version 255.0.0
17630
18066
  */
17631
18067
 
17632
18068
  /**
@@ -17644,10 +18080,9 @@ class CaseManagementApi {
17644
18080
  /**
17645
18081
  * Delete a Case.
17646
18082
  *
17647
- * @param {String} caseId Case ID
18083
+ * @param {String} caseId Case identifier.
17648
18084
  * @param {Object} opts Optional parameters
17649
18085
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17650
- * deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17651
18086
  */
17652
18087
  deleteCasemanagementCase(caseId, opts) {
17653
18088
  opts = opts || {};
@@ -17675,10 +18110,9 @@ class CaseManagementApi {
17675
18110
  /**
17676
18111
  * Delete a Caseplan.
17677
18112
  *
17678
- * @param {String} caseplanId Caseplan ID
18113
+ * @param {String} caseplanId Caseplan identifier.
17679
18114
  * @param {Object} opts Optional parameters
17680
18115
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17681
- * deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17682
18116
  */
17683
18117
  deleteCasemanagementCaseplan(caseplanId, opts) {
17684
18118
  opts = opts || {};
@@ -17703,14 +18137,48 @@ class CaseManagementApi {
17703
18137
  );
17704
18138
  }
17705
18139
 
18140
+ /**
18141
+ * Remove a data schema from a draft Caseplan.
18142
+ *
18143
+ * @param {String} caseplanId Caseplan identifier.
18144
+ * @param {String} schemaKeyName Schema key (for example default).
18145
+ * @param {Object} opts Optional parameters
18146
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18147
+ */
18148
+ deleteCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, opts) {
18149
+ opts = opts || {};
18150
+
18151
+ // verify the required parameter 'caseplanId' is set
18152
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
18153
+ throw 'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplanDataschema';
18154
+ }
18155
+ // verify the required parameter 'schemaKeyName' is set
18156
+ if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
18157
+ throw 'Missing the required parameter "schemaKeyName" when calling deleteCasemanagementCaseplanDataschema';
18158
+ }
18159
+
18160
+ return this.apiClient.callApi(
18161
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
18162
+ 'DELETE',
18163
+ { 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
18164
+ { },
18165
+ { },
18166
+ { },
18167
+ null,
18168
+ ['PureCloud OAuth'],
18169
+ ['application/json'],
18170
+ ['application/json'],
18171
+ opts['customHeaders']
18172
+ );
18173
+ }
18174
+
17706
18175
  /**
17707
18176
  * Get a Case.
17708
18177
  *
17709
- * @param {String} caseId Case ID
18178
+ * @param {String} caseId Case identifier.
17710
18179
  * @param {Object} opts Optional parameters
17711
- * @param {Object} opts.expands Which fields to expand.
18180
+ * @param {Object} opts.expands Fields to expand.
17712
18181
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17713
- * getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17714
18182
  */
17715
18183
  getCasemanagementCase(caseId, opts) {
17716
18184
  opts = opts || {};
@@ -17738,11 +18206,10 @@ class CaseManagementApi {
17738
18206
  /**
17739
18207
  * Get a Case Association.
17740
18208
  *
17741
- * @param {String} caseId Case ID
17742
- * @param {String} associationId Case Association ID
18209
+ * @param {String} caseId Case identifier.
18210
+ * @param {String} associationId Case association identifier.
17743
18211
  * @param {Object} opts Optional parameters
17744
18212
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17745
- * getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17746
18213
  */
17747
18214
  getCasemanagementCaseAssociation(caseId, associationId, opts) {
17748
18215
  opts = opts || {};
@@ -17772,15 +18239,14 @@ class CaseManagementApi {
17772
18239
  }
17773
18240
 
17774
18241
  /**
17775
- * Get a list of case associations for a provided case.
18242
+ * Get a list of Case associations for the Case.
17776
18243
  *
17777
- * @param {String} caseId Case ID.
18244
+ * @param {String} caseId Case identifier.
17778
18245
  * @param {Object} opts Optional parameters
17779
18246
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
17780
18247
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17781
18248
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17782
18249
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17783
- * getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17784
18250
  */
17785
18251
  getCasemanagementCaseAssociations(caseId, opts) {
17786
18252
  opts = opts || {};
@@ -17808,11 +18274,10 @@ class CaseManagementApi {
17808
18274
  /**
17809
18275
  * Get a Stage.
17810
18276
  *
17811
- * @param {String} caseId Case ID
17812
- * @param {String} stageId Stage ID
18277
+ * @param {String} caseId Case identifier.
18278
+ * @param {String} stageId Stage identifier.
17813
18279
  * @param {Object} opts Optional parameters
17814
18280
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17815
- * getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17816
18281
  */
17817
18282
  getCasemanagementCaseStage(caseId, stageId, opts) {
17818
18283
  opts = opts || {};
@@ -17844,12 +18309,11 @@ class CaseManagementApi {
17844
18309
  /**
17845
18310
  * Get a Step.
17846
18311
  *
17847
- * @param {String} caseId Case ID
17848
- * @param {String} stageId Stage ID
17849
- * @param {String} stepId Step ID
18312
+ * @param {String} caseId Case identifier.
18313
+ * @param {String} stageId Stage identifier.
18314
+ * @param {String} stepId Step identifier.
17850
18315
  * @param {Object} opts Optional parameters
17851
18316
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17852
- * getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17853
18317
  */
17854
18318
  getCasemanagementCaseStageStep(caseId, stageId, stepId, opts) {
17855
18319
  opts = opts || {};
@@ -17885,14 +18349,13 @@ class CaseManagementApi {
17885
18349
  /**
17886
18350
  * Get a list of Steps.
17887
18351
  *
17888
- * @param {String} caseId Case ID
17889
- * @param {String} stageId Stage ID
18352
+ * @param {String} caseId Case identifier.
18353
+ * @param {String} stageId Stage identifier.
17890
18354
  * @param {Object} opts Optional parameters
17891
18355
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
17892
18356
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17893
18357
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17894
18358
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17895
- * getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17896
18359
  */
17897
18360
  getCasemanagementCaseStageSteps(caseId, stageId, opts) {
17898
18361
  opts = opts || {};
@@ -17924,13 +18387,12 @@ class CaseManagementApi {
17924
18387
  /**
17925
18388
  * Get a list of Stages.
17926
18389
  *
17927
- * @param {String} caseId Case ID
18390
+ * @param {String} caseId Case identifier.
17928
18391
  * @param {Object} opts Optional parameters
17929
18392
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
17930
18393
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
17931
18394
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
17932
18395
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17933
- * getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17934
18396
  */
17935
18397
  getCasemanagementCaseStages(caseId, opts) {
17936
18398
  opts = opts || {};
@@ -17958,11 +18420,10 @@ class CaseManagementApi {
17958
18420
  /**
17959
18421
  * Get a Terminate Job for a Case.
17960
18422
  *
17961
- * @param {String} caseId Case ID
17962
- * @param {String} jobId Job ID
18423
+ * @param {String} caseId Case identifier.
18424
+ * @param {String} jobId Terminate Job identifier.
17963
18425
  * @param {Object} opts Optional parameters
17964
18426
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
17965
- * getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17966
18427
  */
17967
18428
  getCasemanagementCaseTerminateJob(caseId, jobId, opts) {
17968
18429
  opts = opts || {};
@@ -17994,10 +18455,9 @@ class CaseManagementApi {
17994
18455
  /**
17995
18456
  * Get a Caseplan.
17996
18457
  *
17997
- * @param {String} caseplanId Caseplan ID
18458
+ * @param {String} caseplanId Caseplan identifier.
17998
18459
  * @param {Object} opts Optional parameters
17999
18460
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18000
- * getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18001
18461
  */
18002
18462
  getCasemanagementCaseplan(caseplanId, opts) {
18003
18463
  opts = opts || {};
@@ -18025,11 +18485,10 @@ class CaseManagementApi {
18025
18485
  /**
18026
18486
  * Get a Caseplan version.
18027
18487
  *
18028
- * @param {String} caseplanId Caseplan ID
18029
- * @param {String} versionId Version of the caseplan
18488
+ * @param {String} caseplanId Caseplan identifier.
18489
+ * @param {String} versionId Caseplan version identifier.
18030
18490
  * @param {Object} opts Optional parameters
18031
18491
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18032
- * getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18033
18492
  */
18034
18493
  getCasemanagementCaseplanVersion(caseplanId, versionId, opts) {
18035
18494
  opts = opts || {};
@@ -18059,13 +18518,12 @@ class CaseManagementApi {
18059
18518
  }
18060
18519
 
18061
18520
  /**
18062
- * Get the dataSchemas for a caseplan version.
18521
+ * Get the data schemas for a Caseplan version.
18063
18522
  *
18064
- * @param {String} caseplanId Caseplan ID
18065
- * @param {String} versionId Version of the caseplan
18523
+ * @param {String} caseplanId Caseplan identifier.
18524
+ * @param {String} versionId Caseplan version identifier.
18066
18525
  * @param {Object} opts Optional parameters
18067
18526
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18068
- * getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18069
18527
  */
18070
18528
  getCasemanagementCaseplanVersionDataschemas(caseplanId, versionId, opts) {
18071
18529
  opts = opts || {};
@@ -18097,11 +18555,10 @@ class CaseManagementApi {
18097
18555
  /**
18098
18556
  * Get the intake settings for a Caseplan version.
18099
18557
  *
18100
- * @param {String} caseplanId Caseplan ID
18101
- * @param {String} versionId Version of the caseplan
18558
+ * @param {String} caseplanId Caseplan identifier.
18559
+ * @param {String} versionId Caseplan version identifier.
18102
18560
  * @param {Object} opts Optional parameters
18103
18561
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18104
- * getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18105
18562
  */
18106
18563
  getCasemanagementCaseplanVersionIntakesettings(caseplanId, versionId, opts) {
18107
18564
  opts = opts || {};
@@ -18133,13 +18590,12 @@ class CaseManagementApi {
18133
18590
  /**
18134
18591
  * Get a Stageplan.
18135
18592
  *
18136
- * @param {String} caseplanId Caseplan ID
18137
- * @param {String} versionId Version ID
18138
- * @param {String} stageplanId Stageplan ID
18593
+ * @param {String} caseplanId Caseplan identifier.
18594
+ * @param {String} versionId Caseplan version identifier.
18595
+ * @param {String} stageplanId Stageplan identifier.
18139
18596
  * @param {Object} opts Optional parameters
18140
- * @param {Array.<String>} opts.expands Which fields to expand.
18597
+ * @param {Array.<String>} opts.expands Fields to expand.
18141
18598
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18142
- * getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18143
18599
  */
18144
18600
  getCasemanagementCaseplanVersionStageplan(caseplanId, versionId, stageplanId, opts) {
18145
18601
  opts = opts || {};
@@ -18175,14 +18631,13 @@ class CaseManagementApi {
18175
18631
  /**
18176
18632
  * Get a Stepplan.
18177
18633
  *
18178
- * @param {String} caseplanId Caseplan ID
18179
- * @param {String} versionId Version ID
18180
- * @param {String} stageplanId Stageplan ID
18181
- * @param {String} stepplanId Stepplan ID
18634
+ * @param {String} caseplanId Caseplan identifier.
18635
+ * @param {String} versionId Caseplan version identifier.
18636
+ * @param {String} stageplanId Stageplan identifier.
18637
+ * @param {String} stepplanId Stepplan identifier.
18182
18638
  * @param {Object} opts Optional parameters
18183
- * @param {Array.<String>} opts.expands Which fields to expand.
18639
+ * @param {Array.<String>} opts.expands Fields to expand.
18184
18640
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18185
- * getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18186
18641
  */
18187
18642
  getCasemanagementCaseplanVersionStageplanStepplan(caseplanId, versionId, stageplanId, stepplanId, opts) {
18188
18643
  opts = opts || {};
@@ -18222,16 +18677,15 @@ class CaseManagementApi {
18222
18677
  /**
18223
18678
  * Get a list of Stepplans.
18224
18679
  *
18225
- * @param {String} caseplanId Caseplan ID
18226
- * @param {String} versionId Version ID
18227
- * @param {String} stageplanId Stageplan ID
18680
+ * @param {String} caseplanId Caseplan identifier.
18681
+ * @param {String} versionId Caseplan version identifier.
18682
+ * @param {String} stageplanId Stageplan identifier.
18228
18683
  * @param {Object} opts Optional parameters
18229
18684
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
18230
18685
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
18231
18686
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
18232
- * @param {Array.<String>} opts.expands Which fields to expand.
18687
+ * @param {Array.<String>} opts.expands Fields to expand.
18233
18688
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18234
- * getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18235
18689
  */
18236
18690
  getCasemanagementCaseplanVersionStageplanStepplans(caseplanId, versionId, stageplanId, opts) {
18237
18691
  opts = opts || {};
@@ -18267,15 +18721,14 @@ class CaseManagementApi {
18267
18721
  /**
18268
18722
  * Get a list of Stageplans.
18269
18723
  *
18270
- * @param {String} caseplanId Caseplan ID
18271
- * @param {String} versionId Version ID
18724
+ * @param {String} caseplanId Caseplan identifier.
18725
+ * @param {String} versionId Caseplan version identifier.
18272
18726
  * @param {Object} opts Optional parameters
18273
18727
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
18274
18728
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
18275
18729
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
18276
- * @param {Array.<String>} opts.expands Which fields to expand.
18730
+ * @param {Array.<String>} opts.expands Fields to expand.
18277
18731
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18278
- * getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18279
18732
  */
18280
18733
  getCasemanagementCaseplanVersionStageplans(caseplanId, versionId, opts) {
18281
18734
  opts = opts || {};
@@ -18308,12 +18761,11 @@ class CaseManagementApi {
18308
18761
  * Get a list of Caseplans.
18309
18762
  *
18310
18763
  * @param {Object} opts Optional parameters
18311
- * @param {String} opts.after The cursor that points to the end of the set of caseplans that has been returned.
18312
- * @param {Number} opts.pageSize Number of caseplans to return. Maximum of 200.
18313
- * @param {String} opts.customerIntentId Filter by Customer Intent.
18314
- * @param {String} opts.divisionIds Filter by Divisions.
18764
+ * @param {String} opts.after Cursor that points to the end of the previously returned set of Caseplans.
18765
+ * @param {Number} opts.pageSize Number of Caseplans to return. Maximum is 200.
18766
+ * @param {String} opts.customerIntentId Filter by customer intent.
18767
+ * @param {String} opts.divisionIds Filter by divisions.
18315
18768
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18316
- * getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18317
18769
  */
18318
18770
  getCasemanagementCaseplans(opts) {
18319
18771
  opts = opts || {};
@@ -18335,16 +18787,15 @@ class CaseManagementApi {
18335
18787
  }
18336
18788
 
18337
18789
  /**
18338
- * Get a list of cases for provided external contact id.
18790
+ * Get a list of Cases for an External Contact.
18339
18791
  *
18340
- * @param {String} externalContactId External Contact ID
18792
+ * @param {String} externalContactId External contact identifier.
18341
18793
  * @param {Object} opts Optional parameters
18342
- * @param {String} opts.after The cursor that points to the end of the set of cases that has been returned.
18343
- * @param {Number} opts.pageSize Number of cases to return. Maximum of 200.
18344
- * @param {String} opts.divisionIds Filter by Divisions
18345
- * @param {Array.<String>} opts.expands Which fields to expand.
18794
+ * @param {String} opts.after Cursor pointing to the end of the previously returned page of Cases.
18795
+ * @param {Number} opts.pageSize Number of Cases to return (maximum 200).
18796
+ * @param {String} opts.divisionIds Filter by divisions.
18797
+ * @param {Array.<String>} opts.expands Fields to expand.
18346
18798
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18347
- * getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18348
18799
  */
18349
18800
  getCasemanagementCasesExternalcontact(externalContactId, opts) {
18350
18801
  opts = opts || {};
@@ -18372,11 +18823,10 @@ class CaseManagementApi {
18372
18823
  /**
18373
18824
  * Get a Case by reference.
18374
18825
  *
18375
- * @param {String} referenceId Reference
18826
+ * @param {String} referenceId Case reference.
18376
18827
  * @param {Object} opts Optional parameters
18377
- * @param {Object} opts.expands Which fields to expand.
18828
+ * @param {Object} opts.expands Fields to expand.
18378
18829
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18379
- * getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18380
18830
  */
18381
18831
  getCasemanagementCasesReference(referenceId, opts) {
18382
18832
  opts = opts || {};
@@ -18402,13 +18852,12 @@ class CaseManagementApi {
18402
18852
  }
18403
18853
 
18404
18854
  /**
18405
- * Update date due of a Case.
18855
+ * Update the due date of a Case.
18406
18856
  *
18407
- * @param {String} caseId Case ID
18408
- * @param {Object} body Date due
18857
+ * @param {String} caseId Case identifier.
18858
+ * @param {Object} body Due date update.
18409
18859
  * @param {Object} opts Optional parameters
18410
18860
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18411
- * patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18412
18861
  */
18413
18862
  patchCasemanagementCaseDatedue(caseId, body, opts) {
18414
18863
  opts = opts || {};
@@ -18440,11 +18889,10 @@ class CaseManagementApi {
18440
18889
  /**
18441
18890
  * Update priority of a Case.
18442
18891
  *
18443
- * @param {String} caseId Case ID
18444
- * @param {Object} body Priority
18892
+ * @param {String} caseId Case identifier.
18893
+ * @param {Object} body Priority update.
18445
18894
  * @param {Object} opts Optional parameters
18446
18895
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18447
- * patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18448
18896
  */
18449
18897
  patchCasemanagementCasePriority(caseId, body, opts) {
18450
18898
  opts = opts || {};
@@ -18476,11 +18924,10 @@ class CaseManagementApi {
18476
18924
  /**
18477
18925
  * Update summary of a Case.
18478
18926
  *
18479
- * @param {String} caseId Case ID
18480
- * @param {Object} body Summary
18927
+ * @param {String} caseId Case identifier.
18928
+ * @param {Object} body Summary update.
18481
18929
  * @param {Object} opts Optional parameters
18482
18930
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18483
- * patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18484
18931
  */
18485
18932
  patchCasemanagementCaseSummary(caseId, body, opts) {
18486
18933
  opts = opts || {};
@@ -18512,11 +18959,10 @@ class CaseManagementApi {
18512
18959
  /**
18513
18960
  * Update the attributes of a Caseplan.
18514
18961
  *
18515
- * @param {String} caseplanId Caseplan ID
18516
- * @param {Object} body Caseplan
18962
+ * @param {String} caseplanId Caseplan identifier.
18963
+ * @param {Object} body Caseplan update.
18517
18964
  * @param {Object} opts Optional parameters
18518
18965
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18519
- * patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18520
18966
  */
18521
18967
  patchCasemanagementCaseplan(caseplanId, body, opts) {
18522
18968
  opts = opts || {};
@@ -18548,12 +18994,11 @@ class CaseManagementApi {
18548
18994
  /**
18549
18995
  * Update the attributes of a Stageplan.
18550
18996
  *
18551
- * @param {String} caseplanId Caseplan ID
18552
- * @param {String} stageplanId Stageplan ID
18553
- * @param {Object} body Stageplan
18997
+ * @param {String} caseplanId Caseplan identifier.
18998
+ * @param {String} stageplanId Stageplan identifier.
18999
+ * @param {Object} body Stageplan update.
18554
19000
  * @param {Object} opts Optional parameters
18555
19001
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18556
- * patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18557
19002
  */
18558
19003
  patchCasemanagementCaseplanStageplan(caseplanId, stageplanId, body, opts) {
18559
19004
  opts = opts || {};
@@ -18589,13 +19034,12 @@ class CaseManagementApi {
18589
19034
  /**
18590
19035
  * Update the attributes of a Stepplan.
18591
19036
  *
18592
- * @param {String} caseplanId Caseplan ID
18593
- * @param {String} stageplanId Stageplan ID
18594
- * @param {String} stepplanId Stepplan ID
18595
- * @param {Object} body Stepplan
19037
+ * @param {String} caseplanId Caseplan identifier.
19038
+ * @param {String} stageplanId Stageplan identifier.
19039
+ * @param {String} stepplanId Stepplan identifier.
19040
+ * @param {Object} body Stepplan update.
18596
19041
  * @param {Object} opts Optional parameters
18597
19042
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18598
- * patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18599
19043
  */
18600
19044
  patchCasemanagementCaseplanStageplanStepplan(caseplanId, stageplanId, stepplanId, body, opts) {
18601
19045
  opts = opts || {};
@@ -18633,21 +19077,24 @@ class CaseManagementApi {
18633
19077
  }
18634
19078
 
18635
19079
  /**
18636
- * Create a case association.
19080
+ * Create a Case association.
18637
19081
  *
18638
- * @param {String} caseId Case ID.
19082
+ * @param {String} caseId Case identifier.
19083
+ * @param {Object} body Case association create request.
18639
19084
  * @param {Object} opts Optional parameters
18640
- * @param {Object} opts.body Case Association
18641
19085
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18642
- * postCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18643
19086
  */
18644
- postCasemanagementCaseAssociations(caseId, opts) {
19087
+ postCasemanagementCaseAssociations(caseId, body, opts) {
18645
19088
  opts = opts || {};
18646
19089
 
18647
19090
  // verify the required parameter 'caseId' is set
18648
19091
  if (caseId === undefined || caseId === null || caseId === '') {
18649
19092
  throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';
18650
19093
  }
19094
+ // verify the required parameter 'body' is set
19095
+ if (body === undefined || body === null) {
19096
+ throw 'Missing the required parameter "body" when calling postCasemanagementCaseAssociations';
19097
+ }
18651
19098
 
18652
19099
  return this.apiClient.callApi(
18653
19100
  '/api/v2/casemanagement/cases/{caseId}/associations',
@@ -18656,7 +19103,7 @@ class CaseManagementApi {
18656
19103
  { },
18657
19104
  { },
18658
19105
  { },
18659
- opts['body'],
19106
+ body,
18660
19107
  ['PureCloud OAuth'],
18661
19108
  ['application/json'],
18662
19109
  ['application/json'],
@@ -18667,10 +19114,9 @@ class CaseManagementApi {
18667
19114
  /**
18668
19115
  * Create a Terminate Job for a Case.
18669
19116
  *
18670
- * @param {String} caseId Case ID
19117
+ * @param {String} caseId Case identifier.
18671
19118
  * @param {Object} opts Optional parameters
18672
19119
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18673
- * postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18674
19120
  */
18675
19121
  postCasemanagementCaseTerminateJobs(caseId, opts) {
18676
19122
  opts = opts || {};
@@ -18695,13 +19141,47 @@ class CaseManagementApi {
18695
19141
  );
18696
19142
  }
18697
19143
 
19144
+ /**
19145
+ * Add a data schema to a draft Caseplan.
19146
+ *
19147
+ * @param {String} caseplanId Caseplan identifier.
19148
+ * @param {Object} body Data schema reference.
19149
+ * @param {Object} opts Optional parameters
19150
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
19151
+ */
19152
+ postCasemanagementCaseplanDataschemas(caseplanId, body, opts) {
19153
+ opts = opts || {};
19154
+
19155
+ // verify the required parameter 'caseplanId' is set
19156
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
19157
+ throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanDataschemas';
19158
+ }
19159
+ // verify the required parameter 'body' is set
19160
+ if (body === undefined || body === null) {
19161
+ throw 'Missing the required parameter "body" when calling postCasemanagementCaseplanDataschemas';
19162
+ }
19163
+
19164
+ return this.apiClient.callApi(
19165
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas',
19166
+ 'POST',
19167
+ { 'caseplanId': caseplanId },
19168
+ { },
19169
+ { },
19170
+ { },
19171
+ body,
19172
+ ['PureCloud OAuth'],
19173
+ ['application/json'],
19174
+ ['application/json'],
19175
+ opts['customHeaders']
19176
+ );
19177
+ }
19178
+
18698
19179
  /**
18699
19180
  * Publish Caseplan.
18700
19181
  *
18701
- * @param {String} caseplanId Caseplan ID
19182
+ * @param {String} caseplanId Caseplan identifier.
18702
19183
  * @param {Object} opts Optional parameters
18703
19184
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18704
- * postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18705
19185
  */
18706
19186
  postCasemanagementCaseplanPublish(caseplanId, opts) {
18707
19187
  opts = opts || {};
@@ -18729,10 +19209,9 @@ class CaseManagementApi {
18729
19209
  /**
18730
19210
  * Create Caseplan version.
18731
19211
  *
18732
- * @param {String} caseplanId Caseplan ID
19212
+ * @param {String} caseplanId Caseplan identifier.
18733
19213
  * @param {Object} opts Optional parameters
18734
19214
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18735
- * postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18736
19215
  */
18737
19216
  postCasemanagementCaseplanVersions(caseplanId, opts) {
18738
19217
  opts = opts || {};
@@ -18760,10 +19239,9 @@ class CaseManagementApi {
18760
19239
  /**
18761
19240
  * Create a Caseplan.
18762
19241
  *
18763
- * @param {Object} body Caseplan
19242
+ * @param {Object} body Caseplan create request.
18764
19243
  * @param {Object} opts Optional parameters
18765
19244
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18766
- * postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18767
19245
  */
18768
19246
  postCasemanagementCaseplans(body, opts) {
18769
19247
  opts = opts || {};
@@ -18789,12 +19267,11 @@ class CaseManagementApi {
18789
19267
  }
18790
19268
 
18791
19269
  /**
18792
- * Query for caseplans
19270
+ * Query for Caseplans.
18793
19271
  *
18794
- * @param {Object} body CaseplanQueryRequest
19272
+ * @param {Object} body Caseplan query request.
18795
19273
  * @param {Object} opts Optional parameters
18796
19274
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18797
- * postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18798
19275
  */
18799
19276
  postCasemanagementCaseplansQuery(body, opts) {
18800
19277
  opts = opts || {};
@@ -18822,10 +19299,9 @@ class CaseManagementApi {
18822
19299
  /**
18823
19300
  * Create a Case.
18824
19301
  *
18825
- * @param {Object} body Case
19302
+ * @param {Object} body Case create request.
18826
19303
  * @param {Object} opts Optional parameters
18827
19304
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18828
- * postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18829
19305
  */
18830
19306
  postCasemanagementCases(body, opts) {
18831
19307
  opts = opts || {};
@@ -18851,16 +19327,19 @@ class CaseManagementApi {
18851
19327
  }
18852
19328
 
18853
19329
  /**
18854
- * Query for case associations
19330
+ * Query for Case associations by interaction.
18855
19331
  *
19332
+ * @param {Object} body Case association query request.
18856
19333
  * @param {Object} opts Optional parameters
18857
- * @param {Object} opts.body Case Association
18858
19334
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18859
- * postCasemanagementCasesAssociationsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18860
19335
  */
18861
- postCasemanagementCasesAssociationsQuery(opts) {
19336
+ postCasemanagementCasesAssociationsQuery(body, opts) {
18862
19337
  opts = opts || {};
18863
19338
 
19339
+ // verify the required parameter 'body' is set
19340
+ if (body === undefined || body === null) {
19341
+ throw 'Missing the required parameter "body" when calling postCasemanagementCasesAssociationsQuery';
19342
+ }
18864
19343
 
18865
19344
  return this.apiClient.callApi(
18866
19345
  '/api/v2/casemanagement/cases/associations/query',
@@ -18869,7 +19348,47 @@ class CaseManagementApi {
18869
19348
  { },
18870
19349
  { },
18871
19350
  { },
18872
- opts['body'],
19351
+ body,
19352
+ ['PureCloud OAuth'],
19353
+ ['application/json'],
19354
+ ['application/json'],
19355
+ opts['customHeaders']
19356
+ );
19357
+ }
19358
+
19359
+ /**
19360
+ * Update a data schema on a draft Caseplan.
19361
+ *
19362
+ * @param {String} caseplanId Caseplan identifier.
19363
+ * @param {String} schemaKeyName Schema key (for example default).
19364
+ * @param {Object} body Data schema reference.
19365
+ * @param {Object} opts Optional parameters
19366
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
19367
+ */
19368
+ putCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, body, opts) {
19369
+ opts = opts || {};
19370
+
19371
+ // verify the required parameter 'caseplanId' is set
19372
+ if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
19373
+ throw 'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanDataschema';
19374
+ }
19375
+ // verify the required parameter 'schemaKeyName' is set
19376
+ if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
19377
+ throw 'Missing the required parameter "schemaKeyName" when calling putCasemanagementCaseplanDataschema';
19378
+ }
19379
+ // verify the required parameter 'body' is set
19380
+ if (body === undefined || body === null) {
19381
+ throw 'Missing the required parameter "body" when calling putCasemanagementCaseplanDataschema';
19382
+ }
19383
+
19384
+ return this.apiClient.callApi(
19385
+ '/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
19386
+ 'PUT',
19387
+ { 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
19388
+ { },
19389
+ { },
19390
+ { },
19391
+ body,
18873
19392
  ['PureCloud OAuth'],
18874
19393
  ['application/json'],
18875
19394
  ['application/json'],
@@ -18880,11 +19399,10 @@ class CaseManagementApi {
18880
19399
  /**
18881
19400
  * Update the intake settings for a Caseplan.
18882
19401
  *
18883
- * @param {String} caseplanId Caseplan ID
18884
- * @param {Object} body Intake Settings
19402
+ * @param {String} caseplanId Caseplan identifier.
19403
+ * @param {Object} body Intake settings update.
18885
19404
  * @param {Object} opts Optional parameters
18886
19405
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
18887
- * putCasemanagementCaseplanIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18888
19406
  */
18889
19407
  putCasemanagementCaseplanIntakesettings(caseplanId, body, opts) {
18890
19408
  opts = opts || {};
@@ -18919,7 +19437,7 @@ class ChatApi {
18919
19437
  /**
18920
19438
  * Chat service.
18921
19439
  * @module purecloud-platform-client-v2/api/ChatApi
18922
- * @version 253.0.0
19440
+ * @version 255.0.0
18923
19441
  */
18924
19442
 
18925
19443
  /**
@@ -20058,7 +20576,7 @@ class CoachingApi {
20058
20576
  /**
20059
20577
  * Coaching service.
20060
20578
  * @module purecloud-platform-client-v2/api/CoachingApi
20061
- * @version 253.0.0
20579
+ * @version 255.0.0
20062
20580
  */
20063
20581
 
20064
20582
  /**
@@ -20772,7 +21290,7 @@ class ContentManagementApi {
20772
21290
  /**
20773
21291
  * ContentManagement service.
20774
21292
  * @module purecloud-platform-client-v2/api/ContentManagementApi
20775
- * @version 253.0.0
21293
+ * @version 255.0.0
20776
21294
  */
20777
21295
 
20778
21296
  /**
@@ -21967,7 +22485,7 @@ class ConversationsApi {
21967
22485
  /**
21968
22486
  * Conversations service.
21969
22487
  * @module purecloud-platform-client-v2/api/ConversationsApi
21970
- * @version 253.0.0
22488
+ * @version 255.0.0
21971
22489
  */
21972
22490
 
21973
22491
  /**
@@ -21988,7 +22506,6 @@ class ConversationsApi {
21988
22506
  * @param {String} jobId jobId
21989
22507
  * @param {Object} opts Optional parameters
21990
22508
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
21991
- * deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
21992
22509
  */
21993
22510
  deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
21994
22511
  opts = opts || {};
@@ -22655,7 +23172,6 @@ class ConversationsApi {
22655
23172
  * @param {String} jobId jobId
22656
23173
  * @param {Object} opts Optional parameters
22657
23174
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
22658
- * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22659
23175
  */
22660
23176
  getAnalyticsConversationsAggregatesJob(jobId, opts) {
22661
23177
  opts = opts || {};
@@ -22687,7 +23203,6 @@ class ConversationsApi {
22687
23203
  * @param {Object} opts Optional parameters
22688
23204
  * @param {String} opts.cursor Cursor token to retrieve next page
22689
23205
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
22690
- * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
22691
23206
  */
22692
23207
  getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
22693
23208
  opts = opts || {};
@@ -28534,7 +29049,6 @@ class ConversationsApi {
28534
29049
  * @param {Object} body query
28535
29050
  * @param {Object} opts Optional parameters
28536
29051
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
28537
- * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28538
29052
  */
28539
29053
  postAnalyticsConversationsAggregatesJobs(body, opts) {
28540
29054
  opts = opts || {};
@@ -31519,7 +32033,7 @@ class ConversationsApi {
31519
32033
 
31520
32034
  /**
31521
32035
  * Send an agentless outbound message
31522
- * 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.
32036
+ * 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.
31523
32037
  * @param {Object} body Create agentless outbound messaging request
31524
32038
  * @param {Object} opts Optional parameters
31525
32039
  * @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, messagingTemplate) (default to false)
@@ -33073,7 +33587,7 @@ class DataExtensionsApi {
33073
33587
  /**
33074
33588
  * DataExtensions service.
33075
33589
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
33076
- * @version 253.0.0
33590
+ * @version 255.0.0
33077
33591
  */
33078
33592
 
33079
33593
  /**
@@ -33174,7 +33688,7 @@ class DataPrivacyApi {
33174
33688
  /**
33175
33689
  * DataPrivacy service.
33176
33690
  * @module purecloud-platform-client-v2/api/DataPrivacyApi
33177
- * @version 253.0.0
33691
+ * @version 255.0.0
33178
33692
  */
33179
33693
 
33180
33694
  /**
@@ -33371,7 +33885,7 @@ class DownloadsApi {
33371
33885
  /**
33372
33886
  * Downloads service.
33373
33887
  * @module purecloud-platform-client-v2/api/DownloadsApi
33374
- * @version 253.0.0
33888
+ * @version 255.0.0
33375
33889
  */
33376
33890
 
33377
33891
  /**
@@ -33425,7 +33939,7 @@ class EmailsApi {
33425
33939
  /**
33426
33940
  * Emails service.
33427
33941
  * @module purecloud-platform-client-v2/api/EmailsApi
33428
- * @version 253.0.0
33942
+ * @version 255.0.0
33429
33943
  */
33430
33944
 
33431
33945
  /**
@@ -33573,7 +34087,7 @@ class EmployeeEngagementApi {
33573
34087
  /**
33574
34088
  * EmployeeEngagement service.
33575
34089
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
33576
- * @version 253.0.0
34090
+ * @version 255.0.0
33577
34091
  */
33578
34092
 
33579
34093
  /**
@@ -33777,7 +34291,7 @@ class EventsApi {
33777
34291
  /**
33778
34292
  * Events service.
33779
34293
  * @module purecloud-platform-client-v2/api/EventsApi
33780
- * @version 253.0.0
34294
+ * @version 255.0.0
33781
34295
  */
33782
34296
 
33783
34297
  /**
@@ -33919,7 +34433,7 @@ class ExternalContactsApi {
33919
34433
  /**
33920
34434
  * ExternalContacts service.
33921
34435
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
33922
- * @version 253.0.0
34436
+ * @version 255.0.0
33923
34437
  */
33924
34438
 
33925
34439
  /**
@@ -34533,7 +35047,7 @@ class ExternalContactsApi {
34533
35047
  }
34534
35048
 
34535
35049
  /**
34536
- * List exports for organization
35050
+ * List contact exports for organization
34537
35051
  *
34538
35052
  * @param {Object} opts Optional parameters
34539
35053
  * @param {Array.<String>} opts.divisionIds Division IDs of entities
@@ -37690,7 +38204,7 @@ class FaxApi {
37690
38204
  /**
37691
38205
  * Fax service.
37692
38206
  * @module purecloud-platform-client-v2/api/FaxApi
37693
- * @version 253.0.0
38207
+ * @version 255.0.0
37694
38208
  */
37695
38209
 
37696
38210
  /**
@@ -37939,7 +38453,7 @@ class FlowsApi {
37939
38453
  /**
37940
38454
  * Flows service.
37941
38455
  * @module purecloud-platform-client-v2/api/FlowsApi
37942
- * @version 253.0.0
38456
+ * @version 255.0.0
37943
38457
  */
37944
38458
 
37945
38459
  /**
@@ -37960,7 +38474,6 @@ class FlowsApi {
37960
38474
  * @param {String} jobId jobId
37961
38475
  * @param {Object} opts Optional parameters
37962
38476
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
37963
- * deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37964
38477
  */
37965
38478
  deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
37966
38479
  opts = opts || {};
@@ -37991,7 +38504,6 @@ class FlowsApi {
37991
38504
  * @param {String} jobId jobId
37992
38505
  * @param {Object} opts Optional parameters
37993
38506
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
37994
- * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37995
38507
  */
37996
38508
  getAnalyticsFlowsAggregatesJob(jobId, opts) {
37997
38509
  opts = opts || {};
@@ -38023,7 +38535,6 @@ class FlowsApi {
38023
38535
  * @param {Object} opts Optional parameters
38024
38536
  * @param {String} opts.cursor Cursor token to retrieve next page
38025
38537
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
38026
- * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38027
38538
  */
38028
38539
  getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
38029
38540
  opts = opts || {};
@@ -38086,7 +38597,6 @@ class FlowsApi {
38086
38597
  * @param {Object} body query
38087
38598
  * @param {Object} opts Optional parameters
38088
38599
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
38089
- * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
38090
38600
  */
38091
38601
  postAnalyticsFlowsAggregatesJobs(body, opts) {
38092
38602
  opts = opts || {};
@@ -38177,7 +38687,7 @@ class GamificationApi {
38177
38687
  /**
38178
38688
  * Gamification service.
38179
38689
  * @module purecloud-platform-client-v2/api/GamificationApi
38180
- * @version 253.0.0
38690
+ * @version 255.0.0
38181
38691
  */
38182
38692
 
38183
38693
  /**
@@ -41029,7 +41539,7 @@ class GeneralDataProtectionRegulationApi {
41029
41539
  /**
41030
41540
  * GeneralDataProtectionRegulation service.
41031
41541
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
41032
- * @version 253.0.0
41542
+ * @version 255.0.0
41033
41543
  */
41034
41544
 
41035
41545
  /**
@@ -41173,7 +41683,7 @@ class GeolocationApi {
41173
41683
  /**
41174
41684
  * Geolocation service.
41175
41685
  * @module purecloud-platform-client-v2/api/GeolocationApi
41176
- * @version 253.0.0
41686
+ * @version 255.0.0
41177
41687
  */
41178
41688
 
41179
41689
  /**
@@ -41324,7 +41834,7 @@ class GreetingsApi {
41324
41834
  /**
41325
41835
  * Greetings service.
41326
41836
  * @module purecloud-platform-client-v2/api/GreetingsApi
41327
- * @version 253.0.0
41837
+ * @version 255.0.0
41328
41838
  */
41329
41839
 
41330
41840
  /**
@@ -41940,7 +42450,7 @@ class GroupsApi {
41940
42450
  /**
41941
42451
  * Groups service.
41942
42452
  * @module purecloud-platform-client-v2/api/GroupsApi
41943
- * @version 253.0.0
42453
+ * @version 255.0.0
41944
42454
  */
41945
42455
 
41946
42456
  /**
@@ -42531,7 +43041,7 @@ class IdentityProviderApi {
42531
43041
  /**
42532
43042
  * IdentityProvider service.
42533
43043
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
42534
- * @version 253.0.0
43044
+ * @version 255.0.0
42535
43045
  */
42536
43046
 
42537
43047
  /**
@@ -43582,7 +44092,7 @@ class InfrastructureAsCodeApi {
43582
44092
  /**
43583
44093
  * InfrastructureAsCode service.
43584
44094
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
43585
- * @version 253.0.0
44095
+ * @version 255.0.0
43586
44096
  */
43587
44097
 
43588
44098
  /**
@@ -43762,7 +44272,7 @@ class IntegrationsApi {
43762
44272
  /**
43763
44273
  * Integrations service.
43764
44274
  * @module purecloud-platform-client-v2/api/IntegrationsApi
43765
- * @version 253.0.0
44275
+ * @version 255.0.0
43766
44276
  */
43767
44277
 
43768
44278
  /**
@@ -46734,7 +47244,7 @@ class IntentsApi {
46734
47244
  /**
46735
47245
  * Intents service.
46736
47246
  * @module purecloud-platform-client-v2/api/IntentsApi
46737
- * @version 253.0.0
47247
+ * @version 255.0.0
46738
47248
  */
46739
47249
 
46740
47250
  /**
@@ -47266,7 +47776,7 @@ class JourneyApi {
47266
47776
  /**
47267
47777
  * Journey service.
47268
47778
  * @module purecloud-platform-client-v2/api/JourneyApi
47269
- * @version 253.0.0
47779
+ * @version 255.0.0
47270
47780
  */
47271
47781
 
47272
47782
  /**
@@ -47287,7 +47797,6 @@ class JourneyApi {
47287
47797
  * @param {String} jobId jobId
47288
47798
  * @param {Object} opts Optional parameters
47289
47799
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
47290
- * deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47291
47800
  */
47292
47801
  deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
47293
47802
  opts = opts || {};
@@ -47591,7 +48100,6 @@ class JourneyApi {
47591
48100
  * @param {String} jobId jobId
47592
48101
  * @param {Object} opts Optional parameters
47593
48102
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
47594
- * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47595
48103
  */
47596
48104
  getAnalyticsJourneysAggregatesJob(jobId, opts) {
47597
48105
  opts = opts || {};
@@ -47623,7 +48131,6 @@ class JourneyApi {
47623
48131
  * @param {Object} opts Optional parameters
47624
48132
  * @param {String} opts.cursor Cursor token to retrieve next page
47625
48133
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
47626
- * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
47627
48134
  */
47628
48135
  getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
47629
48136
  opts = opts || {};
@@ -49420,7 +49927,6 @@ class JourneyApi {
49420
49927
  * @param {Object} body query
49421
49928
  * @param {Object} opts Optional parameters
49422
49929
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
49423
- * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
49424
49930
  */
49425
49931
  postAnalyticsJourneysAggregatesJobs(body, opts) {
49426
49932
  opts = opts || {};
@@ -50246,7 +50752,7 @@ class KnowledgeApi {
50246
50752
  /**
50247
50753
  * Knowledge service.
50248
50754
  * @module purecloud-platform-client-v2/api/KnowledgeApi
50249
- * @version 253.0.0
50755
+ * @version 255.0.0
50250
50756
  */
50251
50757
 
50252
50758
  /**
@@ -54497,7 +55003,7 @@ class LanguageUnderstandingApi {
54497
55003
  /**
54498
55004
  * LanguageUnderstanding service.
54499
55005
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
54500
- * @version 253.0.0
55006
+ * @version 255.0.0
54501
55007
  */
54502
55008
 
54503
55009
  /**
@@ -55871,7 +56377,7 @@ class LanguagesApi {
55871
56377
  /**
55872
56378
  * Languages service.
55873
56379
  * @module purecloud-platform-client-v2/api/LanguagesApi
55874
- * @version 253.0.0
56380
+ * @version 255.0.0
55875
56381
  */
55876
56382
 
55877
56383
  /**
@@ -56130,7 +56636,7 @@ class LearningApi {
56130
56636
  /**
56131
56637
  * Learning service.
56132
56638
  * @module purecloud-platform-client-v2/api/LearningApi
56133
- * @version 253.0.0
56639
+ * @version 255.0.0
56134
56640
  */
56135
56641
 
56136
56642
  /**
@@ -57378,7 +57884,7 @@ class LicenseApi {
57378
57884
  /**
57379
57885
  * License service.
57380
57886
  * @module purecloud-platform-client-v2/api/LicenseApi
57381
- * @version 253.0.0
57887
+ * @version 255.0.0
57382
57888
  */
57383
57889
 
57384
57890
  /**
@@ -57676,7 +58182,7 @@ class LocationsApi {
57676
58182
  /**
57677
58183
  * Locations service.
57678
58184
  * @module purecloud-platform-client-v2/api/LocationsApi
57679
- * @version 253.0.0
58185
+ * @version 255.0.0
57680
58186
  */
57681
58187
 
57682
58188
  /**
@@ -57943,7 +58449,7 @@ class LogCaptureApi {
57943
58449
  /**
57944
58450
  * LogCapture service.
57945
58451
  * @module purecloud-platform-client-v2/api/LogCaptureApi
57946
- * @version 253.0.0
58452
+ * @version 255.0.0
57947
58453
  */
57948
58454
 
57949
58455
  /**
@@ -58165,7 +58671,7 @@ class MessagingApi {
58165
58671
  /**
58166
58672
  * Messaging service.
58167
58673
  * @module purecloud-platform-client-v2/api/MessagingApi
58168
- * @version 253.0.0
58674
+ * @version 255.0.0
58169
58675
  */
58170
58676
 
58171
58677
  /**
@@ -58583,7 +59089,7 @@ class MobileDevicesApi {
58583
59089
  /**
58584
59090
  * MobileDevices service.
58585
59091
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
58586
- * @version 253.0.0
59092
+ * @version 255.0.0
58587
59093
  */
58588
59094
 
58589
59095
  /**
@@ -58753,7 +59259,7 @@ class NotificationsApi {
58753
59259
  /**
58754
59260
  * Notifications service.
58755
59261
  * @module purecloud-platform-client-v2/api/NotificationsApi
58756
- * @version 253.0.0
59262
+ * @version 255.0.0
58757
59263
  */
58758
59264
 
58759
59265
  /**
@@ -59014,7 +59520,7 @@ class OAuthApi {
59014
59520
  /**
59015
59521
  * OAuth service.
59016
59522
  * @module purecloud-platform-client-v2/api/OAuthApi
59017
- * @version 253.0.0
59523
+ * @version 255.0.0
59018
59524
  */
59019
59525
 
59020
59526
  /**
@@ -59430,7 +59936,7 @@ class ObjectsApi {
59430
59936
  /**
59431
59937
  * Objects service.
59432
59938
  * @module purecloud-platform-client-v2/api/ObjectsApi
59433
- * @version 253.0.0
59939
+ * @version 255.0.0
59434
59940
  */
59435
59941
 
59436
59942
  /**
@@ -59794,7 +60300,7 @@ class OperationalEventsApi {
59794
60300
  /**
59795
60301
  * OperationalEvents service.
59796
60302
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
59797
- * @version 253.0.0
60303
+ * @version 255.0.0
59798
60304
  */
59799
60305
 
59800
60306
  /**
@@ -59925,7 +60431,7 @@ class OrganizationApi {
59925
60431
  /**
59926
60432
  * Organization service.
59927
60433
  * @module purecloud-platform-client-v2/api/OrganizationApi
59928
- * @version 253.0.0
60434
+ * @version 255.0.0
59929
60435
  */
59930
60436
 
59931
60437
  /**
@@ -60486,7 +60992,7 @@ class OrganizationAuthorizationApi {
60486
60992
  /**
60487
60993
  * OrganizationAuthorization service.
60488
60994
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
60489
- * @version 253.0.0
60995
+ * @version 255.0.0
60490
60996
  */
60491
60997
 
60492
60998
  /**
@@ -62090,7 +62596,7 @@ class OutboundApi {
62090
62596
  /**
62091
62597
  * Outbound service.
62092
62598
  * @module purecloud-platform-client-v2/api/OutboundApi
62093
- * @version 253.0.0
62599
+ * @version 255.0.0
62094
62600
  */
62095
62601
 
62096
62602
  /**
@@ -67677,7 +68183,7 @@ class PresenceApi {
67677
68183
  /**
67678
68184
  * Presence service.
67679
68185
  * @module purecloud-platform-client-v2/api/PresenceApi
67680
- * @version 253.0.0
68186
+ * @version 255.0.0
67681
68187
  */
67682
68188
 
67683
68189
  /**
@@ -68535,7 +69041,7 @@ class ProcessAutomationApi {
68535
69041
  /**
68536
69042
  * ProcessAutomation service.
68537
69043
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
68538
- * @version 253.0.0
69044
+ * @version 255.0.0
68539
69045
  */
68540
69046
 
68541
69047
  /**
@@ -68956,7 +69462,7 @@ class QualityApi {
68956
69462
  /**
68957
69463
  * Quality service.
68958
69464
  * @module purecloud-platform-client-v2/api/QualityApi
68959
- * @version 253.0.0
69465
+ * @version 255.0.0
68960
69466
  */
68961
69467
 
68962
69468
  /**
@@ -68977,7 +69483,6 @@ class QualityApi {
68977
69483
  * @param {String} jobId jobId
68978
69484
  * @param {Object} opts Optional parameters
68979
69485
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
68980
- * deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
68981
69486
  */
68982
69487
  deleteAnalyticsEvaluationsAggregatesJob(jobId, opts) {
68983
69488
  opts = opts || {};
@@ -69008,7 +69513,6 @@ class QualityApi {
69008
69513
  * @param {String} jobId jobId
69009
69514
  * @param {Object} opts Optional parameters
69010
69515
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69011
- * deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69012
69516
  */
69013
69517
  deleteAnalyticsSurveysAggregatesJob(jobId, opts) {
69014
69518
  opts = opts || {};
@@ -69236,7 +69740,6 @@ class QualityApi {
69236
69740
  * @param {String} jobId jobId
69237
69741
  * @param {Object} opts Optional parameters
69238
69742
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69239
- * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69240
69743
  */
69241
69744
  getAnalyticsEvaluationsAggregatesJob(jobId, opts) {
69242
69745
  opts = opts || {};
@@ -69268,7 +69771,6 @@ class QualityApi {
69268
69771
  * @param {Object} opts Optional parameters
69269
69772
  * @param {String} opts.cursor Cursor token to retrieve next page
69270
69773
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69271
- * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69272
69774
  */
69273
69775
  getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
69274
69776
  opts = opts || {};
@@ -69299,7 +69801,6 @@ class QualityApi {
69299
69801
  * @param {String} jobId jobId
69300
69802
  * @param {Object} opts Optional parameters
69301
69803
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69302
- * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69303
69804
  */
69304
69805
  getAnalyticsSurveysAggregatesJob(jobId, opts) {
69305
69806
  opts = opts || {};
@@ -69331,7 +69832,6 @@ class QualityApi {
69331
69832
  * @param {Object} opts Optional parameters
69332
69833
  * @param {String} opts.cursor Cursor token to retrieve next page
69333
69834
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
69334
- * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69335
69835
  */
69336
69836
  getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
69337
69837
  opts = opts || {};
@@ -70435,7 +70935,6 @@ class QualityApi {
70435
70935
  * @param {Object} body query
70436
70936
  * @param {Object} opts Optional parameters
70437
70937
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
70438
- * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70439
70938
  */
70440
70939
  postAnalyticsEvaluationsAggregatesJobs(body, opts) {
70441
70940
  opts = opts || {};
@@ -70496,7 +70995,6 @@ class QualityApi {
70496
70995
  * @param {Object} body query
70497
70996
  * @param {Object} opts Optional parameters
70498
70997
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
70499
- * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70500
70998
  */
70501
70999
  postAnalyticsSurveysAggregatesJobs(body, opts) {
70502
71000
  opts = opts || {};
@@ -71314,7 +71812,7 @@ class RecordingApi {
71314
71812
  /**
71315
71813
  * Recording service.
71316
71814
  * @module purecloud-platform-client-v2/api/RecordingApi
71317
- * @version 253.0.0
71815
+ * @version 255.0.0
71318
71816
  */
71319
71817
 
71320
71818
  /**
@@ -73162,7 +73660,7 @@ class ResponseManagementApi {
73162
73660
  /**
73163
73661
  * ResponseManagement service.
73164
73662
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
73165
- * @version 253.0.0
73663
+ * @version 255.0.0
73166
73664
  */
73167
73665
 
73168
73666
  /**
@@ -73806,7 +74304,7 @@ class RoutingApi {
73806
74304
  /**
73807
74305
  * Routing service.
73808
74306
  * @module purecloud-platform-client-v2/api/RoutingApi
73809
- * @version 253.0.0
74307
+ * @version 255.0.0
73810
74308
  */
73811
74309
 
73812
74310
  /**
@@ -73971,6 +74469,36 @@ class RoutingApi {
73971
74469
  );
73972
74470
  }
73973
74471
 
74472
+ /**
74473
+ * Delete an email setting. Removes the email setting and its associated settings
74474
+ *
74475
+ * @param {String} emailSettingId Email Setting ID
74476
+ * @param {Object} opts Optional parameters
74477
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
74478
+ */
74479
+ deleteRoutingEmailSettingEmailSettingId(emailSettingId, opts) {
74480
+ opts = opts || {};
74481
+
74482
+ // verify the required parameter 'emailSettingId' is set
74483
+ if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
74484
+ throw 'Missing the required parameter "emailSettingId" when calling deleteRoutingEmailSettingEmailSettingId';
74485
+ }
74486
+
74487
+ return this.apiClient.callApi(
74488
+ '/api/v2/routing/email/setting/{emailSettingId}',
74489
+ 'DELETE',
74490
+ { 'emailSettingId': emailSettingId },
74491
+ { },
74492
+ { },
74493
+ { },
74494
+ null,
74495
+ ['PureCloud OAuth'],
74496
+ ['application/json'],
74497
+ ['application/json'],
74498
+ opts['customHeaders']
74499
+ );
74500
+ }
74501
+
73974
74502
  /**
73975
74503
  * Delete a routing language
73976
74504
  *
@@ -75128,6 +75656,63 @@ class RoutingApi {
75128
75656
  );
75129
75657
  }
75130
75658
 
75659
+ /**
75660
+ * Get a paged list of email routing settings.
75661
+ *
75662
+ * @param {Object} opts Optional parameters
75663
+ * @param {Number} opts.pageSize Page size (default to 25)
75664
+ * @param {Number} opts.pageNumber Page number (default to 1)
75665
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
75666
+ */
75667
+ getRoutingEmailSetting(opts) {
75668
+ opts = opts || {};
75669
+
75670
+
75671
+ return this.apiClient.callApi(
75672
+ '/api/v2/routing/email/setting',
75673
+ 'GET',
75674
+ { },
75675
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
75676
+ { },
75677
+ { },
75678
+ null,
75679
+ ['PureCloud OAuth'],
75680
+ ['application/json'],
75681
+ ['application/json'],
75682
+ opts['customHeaders']
75683
+ );
75684
+ }
75685
+
75686
+ /**
75687
+ * Get email setting. Returns the specified email setting that defines settings for email
75688
+ *
75689
+ * @param {String} emailSettingId Email Setting ID
75690
+ * @param {Object} opts Optional parameters
75691
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
75692
+ */
75693
+ getRoutingEmailSettingEmailSettingId(emailSettingId, opts) {
75694
+ opts = opts || {};
75695
+
75696
+ // verify the required parameter 'emailSettingId' is set
75697
+ if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
75698
+ throw 'Missing the required parameter "emailSettingId" when calling getRoutingEmailSettingEmailSettingId';
75699
+ }
75700
+
75701
+ return this.apiClient.callApi(
75702
+ '/api/v2/routing/email/setting/{emailSettingId}',
75703
+ 'GET',
75704
+ { 'emailSettingId': emailSettingId },
75705
+ { },
75706
+ { },
75707
+ { },
75708
+ null,
75709
+ ['PureCloud OAuth'],
75710
+ ['application/json'],
75711
+ ['application/json'],
75712
+ opts['customHeaders']
75713
+ );
75714
+ }
75715
+
75131
75716
  /**
75132
75717
  * Get email setup
75133
75718
  *
@@ -75872,7 +76457,7 @@ class RoutingApi {
75872
76457
  * @param {Object} opts.sortOrder Sort order (default to asc)
75873
76458
  * @param {String} opts.name Name
75874
76459
  * @param {Array.<String>} opts.id Queue ID(s)
75875
- * @param {Array.<String>} opts.divisionId Division ID(s)
76460
+ * @param {Array.<String>} opts.divisionId Division ID(s). Including '*' will query for all divisions
75876
76461
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
75877
76462
  */
75878
76463
  getRoutingQueuesDivisionviews(opts) {
@@ -76273,7 +76858,7 @@ class RoutingApi {
76273
76858
  }
76274
76859
 
76275
76860
  /**
76276
- * Get the list of routing skills.
76861
+ * Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
76277
76862
  *
76278
76863
  * @param {Object} opts Optional parameters
76279
76864
  * @param {Number} opts.pageSize Page size (default to 25)
@@ -77066,6 +77651,41 @@ class RoutingApi {
77066
77651
  );
77067
77652
  }
77068
77653
 
77654
+ /**
77655
+ * Update an email setting. Modifies the settings for email setting
77656
+ *
77657
+ * @param {String} emailSettingId Email Setting ID
77658
+ * @param {Object} body EmailSetting
77659
+ * @param {Object} opts Optional parameters
77660
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
77661
+ */
77662
+ patchRoutingEmailSettingEmailSettingId(emailSettingId, body, opts) {
77663
+ opts = opts || {};
77664
+
77665
+ // verify the required parameter 'emailSettingId' is set
77666
+ if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
77667
+ throw 'Missing the required parameter "emailSettingId" when calling patchRoutingEmailSettingEmailSettingId';
77668
+ }
77669
+ // verify the required parameter 'body' is set
77670
+ if (body === undefined || body === null) {
77671
+ throw 'Missing the required parameter "body" when calling patchRoutingEmailSettingEmailSettingId';
77672
+ }
77673
+
77674
+ return this.apiClient.callApi(
77675
+ '/api/v2/routing/email/setting/{emailSettingId}',
77676
+ 'PATCH',
77677
+ { 'emailSettingId': emailSettingId },
77678
+ { },
77679
+ { },
77680
+ { },
77681
+ body,
77682
+ ['PureCloud OAuth'],
77683
+ ['application/json'],
77684
+ ['application/json'],
77685
+ opts['customHeaders']
77686
+ );
77687
+ }
77688
+
77069
77689
  /**
77070
77690
  * Update single predictor.
77071
77691
  *
@@ -78028,6 +78648,36 @@ class RoutingApi {
78028
78648
  );
78029
78649
  }
78030
78650
 
78651
+ /**
78652
+ * Create a new email setting. Used to define various settings, that can then be associated with email domains
78653
+ *
78654
+ * @param {Object} body EmailSetting
78655
+ * @param {Object} opts Optional parameters
78656
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
78657
+ */
78658
+ postRoutingEmailSetting(body, opts) {
78659
+ opts = opts || {};
78660
+
78661
+ // verify the required parameter 'body' is set
78662
+ if (body === undefined || body === null) {
78663
+ throw 'Missing the required parameter "body" when calling postRoutingEmailSetting';
78664
+ }
78665
+
78666
+ return this.apiClient.callApi(
78667
+ '/api/v2/routing/email/setting',
78668
+ 'POST',
78669
+ { },
78670
+ { },
78671
+ { },
78672
+ { },
78673
+ body,
78674
+ ['PureCloud OAuth'],
78675
+ ['application/json'],
78676
+ ['application/json'],
78677
+ opts['customHeaders']
78678
+ );
78679
+ }
78680
+
78031
78681
  /**
78032
78682
  * Create Language
78033
78683
  *
@@ -79216,7 +79866,7 @@ class SCIMApi {
79216
79866
  /**
79217
79867
  * SCIM service.
79218
79868
  * @module purecloud-platform-client-v2/api/SCIMApi
79219
- * @version 253.0.0
79869
+ * @version 255.0.0
79220
79870
  */
79221
79871
 
79222
79872
  /**
@@ -80177,7 +80827,7 @@ class ScriptsApi {
80177
80827
  /**
80178
80828
  * Scripts service.
80179
80829
  * @module purecloud-platform-client-v2/api/ScriptsApi
80180
- * @version 253.0.0
80830
+ * @version 255.0.0
80181
80831
  */
80182
80832
 
80183
80833
  /**
@@ -80686,7 +81336,7 @@ class SearchApi {
80686
81336
  /**
80687
81337
  * Search service.
80688
81338
  * @module purecloud-platform-client-v2/api/SearchApi
80689
- * @version 253.0.0
81339
+ * @version 255.0.0
80690
81340
  */
80691
81341
 
80692
81342
  /**
@@ -81502,7 +82152,7 @@ class SettingsApi {
81502
82152
  /**
81503
82153
  * Settings service.
81504
82154
  * @module purecloud-platform-client-v2/api/SettingsApi
81505
- * @version 253.0.0
82155
+ * @version 255.0.0
81506
82156
  */
81507
82157
 
81508
82158
  /**
@@ -81911,7 +82561,7 @@ class SocialMediaApi {
81911
82561
  /**
81912
82562
  * SocialMedia service.
81913
82563
  * @module purecloud-platform-client-v2/api/SocialMediaApi
81914
- * @version 253.0.0
82564
+ * @version 255.0.0
81915
82565
  */
81916
82566
 
81917
82567
  /**
@@ -83896,7 +84546,7 @@ class SpeechTextAnalyticsApi {
83896
84546
  /**
83897
84547
  * SpeechTextAnalytics service.
83898
84548
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
83899
- * @version 253.0.0
84549
+ * @version 255.0.0
83900
84550
  */
83901
84551
 
83902
84552
  /**
@@ -84378,7 +85028,7 @@ class SpeechTextAnalyticsApi {
84378
85028
  * @param {String} opts.dialect The key for filter the listing by dialect, dialect format is {language}-{country} where language follows ISO 639-1 standard and country follows ISO 3166-1 alpha 2 standard
84379
85029
  * @param {Object} opts.transcriptionEngine Filter by transcription engine, If not provided, all transcription engines will be considered
84380
85030
  * @param {String} opts.nextPage The key for listing the next page
84381
- * @param {Number} opts.pageSize The page size for the listing (default to 500)
85031
+ * @param {Number} opts.pageSize The page size for the listing. Default is 500 per page. Note: organizations may store up to 1000 dictionary terms per dialect; use nextPage to paginate beyond the first page when listing a full dialect vocabulary. (default to 500)
84382
85032
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
84383
85033
  */
84384
85034
  getSpeechandtextanalyticsDictionaryfeedback(opts) {
@@ -85848,7 +86498,7 @@ class StationsApi {
85848
86498
  /**
85849
86499
  * Stations service.
85850
86500
  * @module purecloud-platform-client-v2/api/StationsApi
85851
- * @version 253.0.0
86501
+ * @version 255.0.0
85852
86502
  */
85853
86503
 
85854
86504
  /**
@@ -85962,7 +86612,7 @@ class SuggestApi {
85962
86612
  /**
85963
86613
  * Suggest service.
85964
86614
  * @module purecloud-platform-client-v2/api/SuggestApi
85965
- * @version 253.0.0
86615
+ * @version 255.0.0
85966
86616
  */
85967
86617
 
85968
86618
  /**
@@ -86109,7 +86759,7 @@ class TaskManagementApi {
86109
86759
  /**
86110
86760
  * TaskManagement service.
86111
86761
  * @module purecloud-platform-client-v2/api/TaskManagementApi
86112
- * @version 253.0.0
86762
+ * @version 255.0.0
86113
86763
  */
86114
86764
 
86115
86765
  /**
@@ -88605,7 +89255,7 @@ class TeamsApi {
88605
89255
  /**
88606
89256
  * Teams service.
88607
89257
  * @module purecloud-platform-client-v2/api/TeamsApi
88608
- * @version 253.0.0
89258
+ * @version 255.0.0
88609
89259
  */
88610
89260
 
88611
89261
  /**
@@ -88948,7 +89598,7 @@ class TelephonyApi {
88948
89598
  /**
88949
89599
  * Telephony service.
88950
89600
  * @module purecloud-platform-client-v2/api/TelephonyApi
88951
- * @version 253.0.0
89601
+ * @version 255.0.0
88952
89602
  */
88953
89603
 
88954
89604
  /**
@@ -88963,6 +89613,36 @@ class TelephonyApi {
88963
89613
  }
88964
89614
 
88965
89615
 
89616
+ /**
89617
+ * Delete a link
89618
+ *
89619
+ * @param {String} targetOrganizationId targetOrganizationId
89620
+ * @param {Object} opts Optional parameters
89621
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89622
+ */
89623
+ deleteTelephonyOrganizationLinkTargetOrganizationId(targetOrganizationId, opts) {
89624
+ opts = opts || {};
89625
+
89626
+ // verify the required parameter 'targetOrganizationId' is set
89627
+ if (targetOrganizationId === undefined || targetOrganizationId === null || targetOrganizationId === '') {
89628
+ throw 'Missing the required parameter "targetOrganizationId" when calling deleteTelephonyOrganizationLinkTargetOrganizationId';
89629
+ }
89630
+
89631
+ return this.apiClient.callApi(
89632
+ '/api/v2/telephony/organization/link/{targetOrganizationId}',
89633
+ 'DELETE',
89634
+ { 'targetOrganizationId': targetOrganizationId },
89635
+ { },
89636
+ { },
89637
+ { },
89638
+ null,
89639
+ ['PureCloud OAuth'],
89640
+ ['application/json'],
89641
+ ['application/json'],
89642
+ opts['customHeaders']
89643
+ );
89644
+ }
89645
+
88966
89646
  /**
88967
89647
  * Get an agent's greetings.
88968
89648
  *
@@ -89069,6 +89749,88 @@ class TelephonyApi {
89069
89749
  );
89070
89750
  }
89071
89751
 
89752
+ /**
89753
+ * Get Number Routings by organizationId
89754
+ *
89755
+ * @param {Object} opts Optional parameters
89756
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
89757
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
89758
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
89759
+ * @param {String} opts.numberId numberId
89760
+ * @param {String} opts.activeRoutingOrganizationId activeRoutingOrganizationId
89761
+ * @param {String} opts.ownerOrganizationId ownerOrganizationId
89762
+ * @param {Object} opts.status status
89763
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89764
+ */
89765
+ getTelephonyNumbersRouting(opts) {
89766
+ opts = opts || {};
89767
+
89768
+
89769
+ return this.apiClient.callApi(
89770
+ '/api/v2/telephony/numbers/routing',
89771
+ 'GET',
89772
+ { },
89773
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'numberId': opts['numberId'],'activeRoutingOrganizationId': opts['activeRoutingOrganizationId'],'ownerOrganizationId': opts['ownerOrganizationId'],'status': opts['status'] },
89774
+ { },
89775
+ { },
89776
+ null,
89777
+ ['PureCloud OAuth'],
89778
+ ['application/json'],
89779
+ ['application/json'],
89780
+ opts['customHeaders']
89781
+ );
89782
+ }
89783
+
89784
+ /**
89785
+ * Get organization links
89786
+ *
89787
+ * @param {Object} opts Optional parameters
89788
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89789
+ */
89790
+ getTelephonyOrganizationLink(opts) {
89791
+ opts = opts || {};
89792
+
89793
+
89794
+ return this.apiClient.callApi(
89795
+ '/api/v2/telephony/organization/link',
89796
+ 'GET',
89797
+ { },
89798
+ { },
89799
+ { },
89800
+ { },
89801
+ null,
89802
+ ['PureCloud OAuth'],
89803
+ ['application/json'],
89804
+ ['application/json'],
89805
+ opts['customHeaders']
89806
+ );
89807
+ }
89808
+
89809
+ /**
89810
+ * Get all the replica regions by primary region
89811
+ *
89812
+ * @param {Object} opts Optional parameters
89813
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89814
+ */
89815
+ getTelephonyOrganizationLinkRegions(opts) {
89816
+ opts = opts || {};
89817
+
89818
+
89819
+ return this.apiClient.callApi(
89820
+ '/api/v2/telephony/organization/link/regions',
89821
+ 'GET',
89822
+ { },
89823
+ { },
89824
+ { },
89825
+ { },
89826
+ null,
89827
+ ['PureCloud OAuth'],
89828
+ ['application/json'],
89829
+ ['application/json'],
89830
+ opts['customHeaders']
89831
+ );
89832
+ }
89833
+
89072
89834
  /**
89073
89835
  * Get the global telephony configuration.
89074
89836
  *
@@ -89224,6 +89986,161 @@ class TelephonyApi {
89224
89986
  );
89225
89987
  }
89226
89988
 
89989
+ /**
89990
+ * Approving a requested link
89991
+ *
89992
+ * @param {String} requestingOrganizationId requestingOrganizationId
89993
+ * @param {Object} body Approval request body
89994
+ * @param {Object} opts Optional parameters
89995
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
89996
+ */
89997
+ patchTelephonyOrganizationLinkApproveRequestingOrganizationId(requestingOrganizationId, body, opts) {
89998
+ opts = opts || {};
89999
+
90000
+ // verify the required parameter 'requestingOrganizationId' is set
90001
+ if (requestingOrganizationId === undefined || requestingOrganizationId === null || requestingOrganizationId === '') {
90002
+ throw 'Missing the required parameter "requestingOrganizationId" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';
90003
+ }
90004
+ // verify the required parameter 'body' is set
90005
+ if (body === undefined || body === null) {
90006
+ throw 'Missing the required parameter "body" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';
90007
+ }
90008
+
90009
+ return this.apiClient.callApi(
90010
+ '/api/v2/telephony/organization/link/approve/{requestingOrganizationId}',
90011
+ 'PATCH',
90012
+ { 'requestingOrganizationId': requestingOrganizationId },
90013
+ { },
90014
+ { },
90015
+ { },
90016
+ body,
90017
+ ['PureCloud OAuth'],
90018
+ ['application/json'],
90019
+ ['application/json'],
90020
+ opts['customHeaders']
90021
+ );
90022
+ }
90023
+
90024
+ /**
90025
+ * Update the routing of numbers for one or multiple organizations
90026
+ *
90027
+ * @param {Array.<Object>} body drRoutingList
90028
+ * @param {Object} opts Optional parameters
90029
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
90030
+ */
90031
+ postTelephonyNumbersRouting(body, opts) {
90032
+ opts = opts || {};
90033
+
90034
+ // verify the required parameter 'body' is set
90035
+ if (body === undefined || body === null) {
90036
+ throw 'Missing the required parameter "body" when calling postTelephonyNumbersRouting';
90037
+ }
90038
+
90039
+ return this.apiClient.callApi(
90040
+ '/api/v2/telephony/numbers/routing',
90041
+ 'POST',
90042
+ { },
90043
+ { },
90044
+ { },
90045
+ { },
90046
+ body,
90047
+ ['PureCloud OAuth'],
90048
+ ['application/json'],
90049
+ ['application/json'],
90050
+ opts['customHeaders']
90051
+ );
90052
+ }
90053
+
90054
+ /**
90055
+ * Re-route all numbers on an organization
90056
+ *
90057
+ * @param {Object} body Value for all routing request body
90058
+ * @param {Object} opts Optional parameters
90059
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
90060
+ */
90061
+ postTelephonyNumbersRoutingAll(body, opts) {
90062
+ opts = opts || {};
90063
+
90064
+ // verify the required parameter 'body' is set
90065
+ if (body === undefined || body === null) {
90066
+ throw 'Missing the required parameter "body" when calling postTelephonyNumbersRoutingAll';
90067
+ }
90068
+
90069
+ return this.apiClient.callApi(
90070
+ '/api/v2/telephony/numbers/routing/all',
90071
+ 'POST',
90072
+ { },
90073
+ { },
90074
+ { },
90075
+ { },
90076
+ body,
90077
+ ['PureCloud OAuth'],
90078
+ ['application/json'],
90079
+ ['application/json'],
90080
+ opts['customHeaders']
90081
+ );
90082
+ }
90083
+
90084
+ /**
90085
+ * Reset routing for organization
90086
+ *
90087
+ * @param {Object} body Value for bulk routing request body
90088
+ * @param {Object} opts Optional parameters
90089
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
90090
+ */
90091
+ postTelephonyNumbersRoutingReset(body, opts) {
90092
+ opts = opts || {};
90093
+
90094
+ // verify the required parameter 'body' is set
90095
+ if (body === undefined || body === null) {
90096
+ throw 'Missing the required parameter "body" when calling postTelephonyNumbersRoutingReset';
90097
+ }
90098
+
90099
+ return this.apiClient.callApi(
90100
+ '/api/v2/telephony/numbers/routing/reset',
90101
+ 'POST',
90102
+ { },
90103
+ { },
90104
+ { },
90105
+ { },
90106
+ body,
90107
+ ['PureCloud OAuth'],
90108
+ ['application/json'],
90109
+ ['application/json'],
90110
+ opts['customHeaders']
90111
+ );
90112
+ }
90113
+
90114
+ /**
90115
+ * Create a link with an organization
90116
+ *
90117
+ * @param {Object} body CreateLinkOrg body
90118
+ * @param {Object} opts Optional parameters
90119
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
90120
+ */
90121
+ postTelephonyOrganizationLink(body, opts) {
90122
+ opts = opts || {};
90123
+
90124
+ // verify the required parameter 'body' is set
90125
+ if (body === undefined || body === null) {
90126
+ throw 'Missing the required parameter "body" when calling postTelephonyOrganizationLink';
90127
+ }
90128
+
90129
+ return this.apiClient.callApi(
90130
+ '/api/v2/telephony/organization/link',
90131
+ 'POST',
90132
+ { },
90133
+ { },
90134
+ { },
90135
+ { },
90136
+ body,
90137
+ ['PureCloud OAuth'],
90138
+ ['application/json'],
90139
+ ['application/json'],
90140
+ opts['customHeaders']
90141
+ );
90142
+ }
90143
+
89227
90144
  /**
89228
90145
  * Request a download of a pcap file to S3
89229
90146
  *
@@ -89355,7 +90272,7 @@ class TelephonyProvidersEdgeApi {
89355
90272
  /**
89356
90273
  * TelephonyProvidersEdge service.
89357
90274
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
89358
- * @version 253.0.0
90275
+ * @version 255.0.0
89359
90276
  */
89360
90277
 
89361
90278
  /**
@@ -93333,7 +94250,7 @@ class TextbotsApi {
93333
94250
  /**
93334
94251
  * Textbots service.
93335
94252
  * @module purecloud-platform-client-v2/api/TextbotsApi
93336
- * @version 253.0.0
94253
+ * @version 255.0.0
93337
94254
  */
93338
94255
 
93339
94256
  /**
@@ -93479,7 +94396,7 @@ class TokensApi {
93479
94396
  /**
93480
94397
  * Tokens service.
93481
94398
  * @module purecloud-platform-client-v2/api/TokensApi
93482
- * @version 253.0.0
94399
+ * @version 255.0.0
93483
94400
  */
93484
94401
 
93485
94402
  /**
@@ -93657,7 +94574,7 @@ class UploadsApi {
93657
94574
  /**
93658
94575
  * Uploads service.
93659
94576
  * @module purecloud-platform-client-v2/api/UploadsApi
93660
- * @version 253.0.0
94577
+ * @version 255.0.0
93661
94578
  */
93662
94579
 
93663
94580
  /**
@@ -94028,7 +94945,7 @@ class UsageApi {
94028
94945
  /**
94029
94946
  * Usage service.
94030
94947
  * @module purecloud-platform-client-v2/api/UsageApi
94031
- * @version 253.0.0
94948
+ * @version 255.0.0
94032
94949
  */
94033
94950
 
94034
94951
  /**
@@ -94406,7 +95323,7 @@ class UserRecordingsApi {
94406
95323
  /**
94407
95324
  * UserRecordings service.
94408
95325
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
94409
- * @version 253.0.0
95326
+ * @version 255.0.0
94410
95327
  */
94411
95328
 
94412
95329
  /**
@@ -94608,7 +95525,7 @@ class UsersApi {
94608
95525
  /**
94609
95526
  * Users service.
94610
95527
  * @module purecloud-platform-client-v2/api/UsersApi
94611
- * @version 253.0.0
95528
+ * @version 255.0.0
94612
95529
  */
94613
95530
 
94614
95531
  /**
@@ -94629,7 +95546,6 @@ class UsersApi {
94629
95546
  * @param {String} jobId jobId
94630
95547
  * @param {Object} opts Optional parameters
94631
95548
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
94632
- * deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
94633
95549
  */
94634
95550
  deleteAnalyticsUsersAggregatesJob(jobId, opts) {
94635
95551
  opts = opts || {};
@@ -95140,7 +96056,6 @@ class UsersApi {
95140
96056
  * @param {String} jobId jobId
95141
96057
  * @param {Object} opts Optional parameters
95142
96058
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
95143
- * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
95144
96059
  */
95145
96060
  getAnalyticsUsersAggregatesJob(jobId, opts) {
95146
96061
  opts = opts || {};
@@ -95172,7 +96087,6 @@ class UsersApi {
95172
96087
  * @param {Object} opts Optional parameters
95173
96088
  * @param {String} opts.cursor Cursor token to retrieve next page
95174
96089
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
95175
- * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
95176
96090
  */
95177
96091
  getAnalyticsUsersAggregatesJobResults(jobId, opts) {
95178
96092
  opts = opts || {};
@@ -97320,7 +98234,6 @@ class UsersApi {
97320
98234
  * @param {Object} body query
97321
98235
  * @param {Object} opts Optional parameters
97322
98236
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
97323
- * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
97324
98237
  */
97325
98238
  postAnalyticsUsersAggregatesJobs(body, opts) {
97326
98239
  opts = opts || {};
@@ -98627,7 +99540,7 @@ class UsersRulesApi {
98627
99540
  /**
98628
99541
  * UsersRules service.
98629
99542
  * @module purecloud-platform-client-v2/api/UsersRulesApi
98630
- * @version 253.0.0
99543
+ * @version 255.0.0
98631
99544
  */
98632
99545
 
98633
99546
  /**
@@ -98944,7 +99857,7 @@ class UtilitiesApi {
98944
99857
  /**
98945
99858
  * Utilities service.
98946
99859
  * @module purecloud-platform-client-v2/api/UtilitiesApi
98947
- * @version 253.0.0
99860
+ * @version 255.0.0
98948
99861
  */
98949
99862
 
98950
99863
  /**
@@ -99072,7 +99985,7 @@ class VoicemailApi {
99072
99985
  /**
99073
99986
  * Voicemail service.
99074
99987
  * @module purecloud-platform-client-v2/api/VoicemailApi
99075
- * @version 253.0.0
99988
+ * @version 255.0.0
99076
99989
  */
99077
99990
 
99078
99991
  /**
@@ -99902,7 +100815,7 @@ class WebChatApi {
99902
100815
  /**
99903
100816
  * WebChat service.
99904
100817
  * @module purecloud-platform-client-v2/api/WebChatApi
99905
- * @version 253.0.0
100818
+ * @version 255.0.0
99906
100819
  */
99907
100820
 
99908
100821
  /**
@@ -100554,7 +101467,7 @@ class WebDeploymentsApi {
100554
101467
  /**
100555
101468
  * WebDeployments service.
100556
101469
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
100557
- * @version 253.0.0
101470
+ * @version 255.0.0
100558
101471
  */
100559
101472
 
100560
101473
  /**
@@ -101232,7 +102145,7 @@ class WebMessagingApi {
101232
102145
  /**
101233
102146
  * WebMessaging service.
101234
102147
  * @module purecloud-platform-client-v2/api/WebMessagingApi
101235
- * @version 253.0.0
102148
+ * @version 255.0.0
101236
102149
  */
101237
102150
 
101238
102151
  /**
@@ -101395,7 +102308,7 @@ class WidgetsApi {
101395
102308
  /**
101396
102309
  * Widgets service.
101397
102310
  * @module purecloud-platform-client-v2/api/WidgetsApi
101398
- * @version 253.0.0
102311
+ * @version 255.0.0
101399
102312
  */
101400
102313
 
101401
102314
  /**
@@ -101571,7 +102484,7 @@ class WorkforceManagementApi {
101571
102484
  /**
101572
102485
  * WorkforceManagement service.
101573
102486
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
101574
- * @version 253.0.0
102487
+ * @version 255.0.0
101575
102488
  */
101576
102489
 
101577
102490
  /**
@@ -101722,6 +102635,81 @@ class WorkforceManagementApi {
101722
102635
  );
101723
102636
  }
101724
102637
 
102638
+ /**
102639
+ * Delete a schedule bid
102640
+ *
102641
+ * @param {String} businessUnitId The ID of the business unit
102642
+ * @param {String} bidId The ID of the schedule bid
102643
+ * @param {Object} opts Optional parameters
102644
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
102645
+ */
102646
+ deleteWorkforcemanagementBusinessunitSchedulebid(businessUnitId, bidId, opts) {
102647
+ opts = opts || {};
102648
+
102649
+ // verify the required parameter 'businessUnitId' is set
102650
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
102651
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitSchedulebid';
102652
+ }
102653
+ // verify the required parameter 'bidId' is set
102654
+ if (bidId === undefined || bidId === null || bidId === '') {
102655
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitSchedulebid';
102656
+ }
102657
+
102658
+ return this.apiClient.callApi(
102659
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}',
102660
+ 'DELETE',
102661
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
102662
+ { },
102663
+ { },
102664
+ { },
102665
+ null,
102666
+ ['PureCloud OAuth'],
102667
+ ['application/json'],
102668
+ ['application/json'],
102669
+ opts['customHeaders']
102670
+ );
102671
+ }
102672
+
102673
+ /**
102674
+ * Delete a schedule bid group by bid group Id
102675
+ *
102676
+ * @param {String} businessUnitId The ID of the business unit
102677
+ * @param {String} bidId The ID of the schedule bid associated with the bid groups
102678
+ * @param {String} bidGroupId Schedule Bid Group id
102679
+ * @param {Object} opts Optional parameters
102680
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
102681
+ */
102682
+ deleteWorkforcemanagementBusinessunitSchedulebidGroup(businessUnitId, bidId, bidGroupId, opts) {
102683
+ opts = opts || {};
102684
+
102685
+ // verify the required parameter 'businessUnitId' is set
102686
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
102687
+ throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitSchedulebidGroup';
102688
+ }
102689
+ // verify the required parameter 'bidId' is set
102690
+ if (bidId === undefined || bidId === null || bidId === '') {
102691
+ throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitSchedulebidGroup';
102692
+ }
102693
+ // verify the required parameter 'bidGroupId' is set
102694
+ if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
102695
+ throw 'Missing the required parameter "bidGroupId" when calling deleteWorkforcemanagementBusinessunitSchedulebidGroup';
102696
+ }
102697
+
102698
+ return this.apiClient.callApi(
102699
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}',
102700
+ 'DELETE',
102701
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
102702
+ { },
102703
+ { },
102704
+ { },
102705
+ null,
102706
+ ['PureCloud OAuth'],
102707
+ ['application/json'],
102708
+ ['application/json'],
102709
+ opts['customHeaders']
102710
+ );
102711
+ }
102712
+
101725
102713
  /**
101726
102714
  * Cancel a scheduling run
101727
102715
  *
@@ -103535,6 +104523,188 @@ class WorkforceManagementApi {
103535
104523
  );
103536
104524
  }
103537
104525
 
104526
+ /**
104527
+ * Get a schedule bid
104528
+ *
104529
+ * @param {String} businessUnitId The ID of the business unit
104530
+ * @param {String} bidId The ID of the schedule bid
104531
+ * @param {Object} opts Optional parameters
104532
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104533
+ */
104534
+ getWorkforcemanagementBusinessunitSchedulebid(businessUnitId, bidId, opts) {
104535
+ opts = opts || {};
104536
+
104537
+ // verify the required parameter 'businessUnitId' is set
104538
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
104539
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebid';
104540
+ }
104541
+ // verify the required parameter 'bidId' is set
104542
+ if (bidId === undefined || bidId === null || bidId === '') {
104543
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebid';
104544
+ }
104545
+
104546
+ return this.apiClient.callApi(
104547
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}',
104548
+ 'GET',
104549
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
104550
+ { },
104551
+ { },
104552
+ { },
104553
+ null,
104554
+ ['PureCloud OAuth'],
104555
+ ['application/json'],
104556
+ ['application/json'],
104557
+ opts['customHeaders']
104558
+ );
104559
+ }
104560
+
104561
+ /**
104562
+ * Get a schedule bid group
104563
+ *
104564
+ * @param {String} businessUnitId The ID of the business unit
104565
+ * @param {String} bidId The ID of the schedule bid associated with the bid groups
104566
+ * @param {String} bidGroupId Schedule Bid Group id
104567
+ * @param {Object} opts Optional parameters
104568
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104569
+ */
104570
+ getWorkforcemanagementBusinessunitSchedulebidGroup(businessUnitId, bidId, bidGroupId, opts) {
104571
+ opts = opts || {};
104572
+
104573
+ // verify the required parameter 'businessUnitId' is set
104574
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
104575
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebidGroup';
104576
+ }
104577
+ // verify the required parameter 'bidId' is set
104578
+ if (bidId === undefined || bidId === null || bidId === '') {
104579
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebidGroup';
104580
+ }
104581
+ // verify the required parameter 'bidGroupId' is set
104582
+ if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
104583
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitSchedulebidGroup';
104584
+ }
104585
+
104586
+ return this.apiClient.callApi(
104587
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}',
104588
+ 'GET',
104589
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
104590
+ { },
104591
+ { },
104592
+ { },
104593
+ null,
104594
+ ['PureCloud OAuth'],
104595
+ ['application/json'],
104596
+ ['application/json'],
104597
+ opts['customHeaders']
104598
+ );
104599
+ }
104600
+
104601
+ /**
104602
+ * Get agents schedule bid preferences for a bid group
104603
+ *
104604
+ * @param {String} businessUnitId The ID of the business unit
104605
+ * @param {String} bidId The ID of the schedule bid associated with the bid groups
104606
+ * @param {String} bidGroupId The ID of the schedule bid group
104607
+ * @param {Object} opts Optional parameters
104608
+ * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
104609
+ * @param {Array.<String>} opts.expand Include to fetch agents' preferences with priorities
104610
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104611
+ */
104612
+ getWorkforcemanagementBusinessunitSchedulebidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
104613
+ opts = opts || {};
104614
+
104615
+ // verify the required parameter 'businessUnitId' is set
104616
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
104617
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
104618
+ }
104619
+ // verify the required parameter 'bidId' is set
104620
+ if (bidId === undefined || bidId === null || bidId === '') {
104621
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
104622
+ }
104623
+ // verify the required parameter 'bidGroupId' is set
104624
+ if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
104625
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
104626
+ }
104627
+
104628
+ return this.apiClient.callApi(
104629
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences',
104630
+ 'GET',
104631
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
104632
+ { 'forceDownloadService': opts['forceDownloadService'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
104633
+ { },
104634
+ { },
104635
+ null,
104636
+ ['PureCloud OAuth'],
104637
+ ['application/json'],
104638
+ ['application/json'],
104639
+ opts['customHeaders']
104640
+ );
104641
+ }
104642
+
104643
+ /**
104644
+ * Get summary of bid groups that belong to a schedule bid
104645
+ *
104646
+ * @param {String} businessUnitId The ID of the business unit
104647
+ * @param {String} bidId The ID of the schedule bid associated with the bid groups
104648
+ * @param {Object} opts Optional parameters
104649
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104650
+ */
104651
+ getWorkforcemanagementBusinessunitSchedulebidGroupsSummary(businessUnitId, bidId, opts) {
104652
+ opts = opts || {};
104653
+
104654
+ // verify the required parameter 'businessUnitId' is set
104655
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
104656
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupsSummary';
104657
+ }
104658
+ // verify the required parameter 'bidId' is set
104659
+ if (bidId === undefined || bidId === null || bidId === '') {
104660
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitSchedulebidGroupsSummary';
104661
+ }
104662
+
104663
+ return this.apiClient.callApi(
104664
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/summary',
104665
+ 'GET',
104666
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
104667
+ { },
104668
+ { },
104669
+ { },
104670
+ null,
104671
+ ['PureCloud OAuth'],
104672
+ ['application/json'],
104673
+ ['application/json'],
104674
+ opts['customHeaders']
104675
+ );
104676
+ }
104677
+
104678
+ /**
104679
+ * Get list of schedule bids
104680
+ *
104681
+ * @param {String} businessUnitId The ID of the business unit
104682
+ * @param {Object} opts Optional parameters
104683
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104684
+ */
104685
+ getWorkforcemanagementBusinessunitSchedulebids(businessUnitId, opts) {
104686
+ opts = opts || {};
104687
+
104688
+ // verify the required parameter 'businessUnitId' is set
104689
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
104690
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulebids';
104691
+ }
104692
+
104693
+ return this.apiClient.callApi(
104694
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids',
104695
+ 'GET',
104696
+ { 'businessUnitId': businessUnitId },
104697
+ { },
104698
+ { },
104699
+ { },
104700
+ null,
104701
+ ['PureCloud OAuth'],
104702
+ ['application/json'],
104703
+ ['application/json'],
104704
+ opts['customHeaders']
104705
+ );
104706
+ }
104707
+
103538
104708
  /**
103539
104709
  * Get scheduler settings for a business unit
103540
104710
  *
@@ -104092,6 +105262,7 @@ class WorkforceManagementApi {
104092
105262
  * @param {Object} opts Optional parameters
104093
105263
  * @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
104094
105264
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
105265
+ * @param {Array.<String>} opts.expand Include to access additional data for the time-off plans
104095
105266
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
104096
105267
  */
104097
105268
  getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
@@ -104106,7 +105277,7 @@ class WorkforceManagementApi {
104106
105277
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
104107
105278
  'GET',
104108
105279
  { 'businessUnitId': businessUnitId },
104109
- { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
105280
+ { 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
104110
105281
  { },
104111
105282
  { },
104112
105283
  null,
@@ -104406,6 +105577,8 @@ class WorkforceManagementApi {
104406
105577
  * @param {String} businessUnitId The ID of the business unit
104407
105578
  * @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
104408
105579
  * @param {Object} opts Optional parameters
105580
+ * @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
105581
+ * @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
104409
105582
  * @param {Boolean} opts.includeOnlyPublished includeOnlyPublished
104410
105583
  * @param {Object} opts.expand expand
104411
105584
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
@@ -104426,7 +105599,7 @@ class WorkforceManagementApi {
104426
105599
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules',
104427
105600
  'GET',
104428
105601
  { 'businessUnitId': businessUnitId,'weekId': weekId },
104429
- { 'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
105602
+ { 'earliestWeekDate': opts['earliestWeekDate'],'latestWeekDate': opts['latestWeekDate'],'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
104430
105603
  { },
104431
105604
  { },
104432
105605
  null,
@@ -106009,6 +107182,91 @@ class WorkforceManagementApi {
106009
107182
  );
106010
107183
  }
106011
107184
 
107185
+ /**
107186
+ * Gets an agent's schedule bidding preference
107187
+ *
107188
+ * @param {String} bidId The ID of the schedule bid
107189
+ * @param {Object} opts Optional parameters
107190
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
107191
+ */
107192
+ getWorkforcemanagementSchedulebidPreference(bidId, opts) {
107193
+ opts = opts || {};
107194
+
107195
+ // verify the required parameter 'bidId' is set
107196
+ if (bidId === undefined || bidId === null || bidId === '') {
107197
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementSchedulebidPreference';
107198
+ }
107199
+
107200
+ return this.apiClient.callApi(
107201
+ '/api/v2/workforcemanagement/schedulebids/{bidId}/preference',
107202
+ 'GET',
107203
+ { 'bidId': bidId },
107204
+ { },
107205
+ { },
107206
+ { },
107207
+ null,
107208
+ ['PureCloud OAuth'],
107209
+ ['application/json'],
107210
+ ['application/json'],
107211
+ opts['customHeaders']
107212
+ );
107213
+ }
107214
+
107215
+ /**
107216
+ * Gets an agent's schedule sets for a bid
107217
+ *
107218
+ * @param {String} bidId The ID of the schedule bid
107219
+ * @param {Object} opts Optional parameters
107220
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
107221
+ */
107222
+ getWorkforcemanagementSchedulebidSchedulesets(bidId, opts) {
107223
+ opts = opts || {};
107224
+
107225
+ // verify the required parameter 'bidId' is set
107226
+ if (bidId === undefined || bidId === null || bidId === '') {
107227
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementSchedulebidSchedulesets';
107228
+ }
107229
+
107230
+ return this.apiClient.callApi(
107231
+ '/api/v2/workforcemanagement/schedulebids/{bidId}/schedulesets',
107232
+ 'GET',
107233
+ { 'bidId': bidId },
107234
+ { },
107235
+ { },
107236
+ { },
107237
+ null,
107238
+ ['PureCloud OAuth'],
107239
+ ['application/json'],
107240
+ ['application/json'],
107241
+ opts['customHeaders']
107242
+ );
107243
+ }
107244
+
107245
+ /**
107246
+ * Gets the list of schedule bids that belong to an agent. It will fetch an open bid or upcoming bid or a bid that is closed recently
107247
+ *
107248
+ * @param {Object} opts Optional parameters
107249
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
107250
+ */
107251
+ getWorkforcemanagementSchedulebids(opts) {
107252
+ opts = opts || {};
107253
+
107254
+
107255
+ return this.apiClient.callApi(
107256
+ '/api/v2/workforcemanagement/schedulebids',
107257
+ 'GET',
107258
+ { },
107259
+ { },
107260
+ { },
107261
+ { },
107262
+ null,
107263
+ ['PureCloud OAuth'],
107264
+ ['application/json'],
107265
+ ['application/json'],
107266
+ opts['customHeaders']
107267
+ );
107268
+ }
107269
+
106012
107270
  /**
106013
107271
  * Get status of the scheduling job
106014
107272
  *
@@ -106986,6 +108244,136 @@ class WorkforceManagementApi {
106986
108244
  );
106987
108245
  }
106988
108246
 
108247
+ /**
108248
+ * Update a schedule bid
108249
+ *
108250
+ * @param {String} businessUnitId The ID of the business unit
108251
+ * @param {String} bidId The ID of the schedule bid
108252
+ * @param {Object} body The schedule bid to be updated
108253
+ * @param {Object} opts Optional parameters
108254
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
108255
+ */
108256
+ patchWorkforcemanagementBusinessunitSchedulebid(businessUnitId, bidId, body, opts) {
108257
+ opts = opts || {};
108258
+
108259
+ // verify the required parameter 'businessUnitId' is set
108260
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
108261
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulebid';
108262
+ }
108263
+ // verify the required parameter 'bidId' is set
108264
+ if (bidId === undefined || bidId === null || bidId === '') {
108265
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitSchedulebid';
108266
+ }
108267
+ // verify the required parameter 'body' is set
108268
+ if (body === undefined || body === null) {
108269
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulebid';
108270
+ }
108271
+
108272
+ return this.apiClient.callApi(
108273
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}',
108274
+ 'PATCH',
108275
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
108276
+ { },
108277
+ { },
108278
+ { },
108279
+ body,
108280
+ ['PureCloud OAuth'],
108281
+ ['application/json'],
108282
+ ['application/json'],
108283
+ opts['customHeaders']
108284
+ );
108285
+ }
108286
+
108287
+ /**
108288
+ * Update a schedule bid group by bid group Id
108289
+ *
108290
+ * @param {String} businessUnitId The ID of the business unit
108291
+ * @param {String} bidId The ID of the schedule bid associated with the bid groups
108292
+ * @param {String} bidGroupId Schedule Bid Group id
108293
+ * @param {Object} body body
108294
+ * @param {Object} opts Optional parameters
108295
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
108296
+ */
108297
+ patchWorkforcemanagementBusinessunitSchedulebidGroup(businessUnitId, bidId, bidGroupId, body, opts) {
108298
+ opts = opts || {};
108299
+
108300
+ // verify the required parameter 'businessUnitId' is set
108301
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
108302
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
108303
+ }
108304
+ // verify the required parameter 'bidId' is set
108305
+ if (bidId === undefined || bidId === null || bidId === '') {
108306
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
108307
+ }
108308
+ // verify the required parameter 'bidGroupId' is set
108309
+ if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
108310
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
108311
+ }
108312
+ // verify the required parameter 'body' is set
108313
+ if (body === undefined || body === null) {
108314
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulebidGroup';
108315
+ }
108316
+
108317
+ return this.apiClient.callApi(
108318
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}',
108319
+ 'PATCH',
108320
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
108321
+ { },
108322
+ { },
108323
+ { },
108324
+ body,
108325
+ ['PureCloud OAuth'],
108326
+ ['application/json'],
108327
+ ['application/json'],
108328
+ opts['customHeaders']
108329
+ );
108330
+ }
108331
+
108332
+ /**
108333
+ * Overrides the assigned schedule bid for the specified agents
108334
+ *
108335
+ * @param {String} businessUnitId The ID of the business unit
108336
+ * @param {String} bidId The ID of the schedule bid associated with the bid groups
108337
+ * @param {String} bidGroupId The ID of the schedule bid group
108338
+ * @param {Object} body body
108339
+ * @param {Object} opts Optional parameters
108340
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
108341
+ */
108342
+ patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences(businessUnitId, bidId, bidGroupId, body, opts) {
108343
+ opts = opts || {};
108344
+
108345
+ // verify the required parameter 'businessUnitId' is set
108346
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
108347
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
108348
+ }
108349
+ // verify the required parameter 'bidId' is set
108350
+ if (bidId === undefined || bidId === null || bidId === '') {
108351
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
108352
+ }
108353
+ // verify the required parameter 'bidGroupId' is set
108354
+ if (bidGroupId === undefined || bidGroupId === null || bidGroupId === '') {
108355
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
108356
+ }
108357
+ // verify the required parameter 'body' is set
108358
+ if (body === undefined || body === null) {
108359
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulebidGroupPreferences';
108360
+ }
108361
+
108362
+ return this.apiClient.callApi(
108363
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups/{bidGroupId}/preferences',
108364
+ 'PATCH',
108365
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
108366
+ { },
108367
+ { },
108368
+ { },
108369
+ body,
108370
+ ['PureCloud OAuth'],
108371
+ ['application/json'],
108372
+ ['application/json'],
108373
+ opts['customHeaders']
108374
+ );
108375
+ }
108376
+
106989
108377
  /**
106990
108378
  * Update scheduler settings for a business unit
106991
108379
  *
@@ -109307,6 +110695,156 @@ class WorkforceManagementApi {
109307
110695
  );
109308
110696
  }
109309
110697
 
110698
+ /**
110699
+ * Copy a schedule bid
110700
+ *
110701
+ * @param {String} businessUnitId The ID of the business unit
110702
+ * @param {String} bidId The ID of the schedule bid to copy
110703
+ * @param {Object} body body
110704
+ * @param {Object} opts Optional parameters
110705
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110706
+ */
110707
+ postWorkforcemanagementBusinessunitSchedulebidCopy(businessUnitId, bidId, body, opts) {
110708
+ opts = opts || {};
110709
+
110710
+ // verify the required parameter 'businessUnitId' is set
110711
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
110712
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebidCopy';
110713
+ }
110714
+ // verify the required parameter 'bidId' is set
110715
+ if (bidId === undefined || bidId === null || bidId === '') {
110716
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitSchedulebidCopy';
110717
+ }
110718
+ // verify the required parameter 'body' is set
110719
+ if (body === undefined || body === null) {
110720
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebidCopy';
110721
+ }
110722
+
110723
+ return this.apiClient.callApi(
110724
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/copy',
110725
+ 'POST',
110726
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
110727
+ { },
110728
+ { },
110729
+ { },
110730
+ body,
110731
+ ['PureCloud OAuth'],
110732
+ ['application/json'],
110733
+ ['application/json'],
110734
+ opts['customHeaders']
110735
+ );
110736
+ }
110737
+
110738
+ /**
110739
+ * Add a bid group in a given schedule bid
110740
+ *
110741
+ * @param {String} businessUnitId The ID of the business unit
110742
+ * @param {String} bidId The ID of the schedule bid associated with the bid groups
110743
+ * @param {Object} body body
110744
+ * @param {Object} opts Optional parameters
110745
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110746
+ */
110747
+ postWorkforcemanagementBusinessunitSchedulebidGroups(businessUnitId, bidId, body, opts) {
110748
+ opts = opts || {};
110749
+
110750
+ // verify the required parameter 'businessUnitId' is set
110751
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
110752
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebidGroups';
110753
+ }
110754
+ // verify the required parameter 'bidId' is set
110755
+ if (bidId === undefined || bidId === null || bidId === '') {
110756
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitSchedulebidGroups';
110757
+ }
110758
+ // verify the required parameter 'body' is set
110759
+ if (body === undefined || body === null) {
110760
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebidGroups';
110761
+ }
110762
+
110763
+ return this.apiClient.callApi(
110764
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/{bidId}/groups',
110765
+ 'POST',
110766
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
110767
+ { },
110768
+ { },
110769
+ { },
110770
+ body,
110771
+ ['PureCloud OAuth'],
110772
+ ['application/json'],
110773
+ ['application/json'],
110774
+ opts['customHeaders']
110775
+ );
110776
+ }
110777
+
110778
+ /**
110779
+ * Create a new schedule bid
110780
+ *
110781
+ * @param {String} businessUnitId The ID of the business unit
110782
+ * @param {Object} body The schedule bid to be created
110783
+ * @param {Object} opts Optional parameters
110784
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110785
+ */
110786
+ postWorkforcemanagementBusinessunitSchedulebids(businessUnitId, body, opts) {
110787
+ opts = opts || {};
110788
+
110789
+ // verify the required parameter 'businessUnitId' is set
110790
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
110791
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebids';
110792
+ }
110793
+ // verify the required parameter 'body' is set
110794
+ if (body === undefined || body === null) {
110795
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebids';
110796
+ }
110797
+
110798
+ return this.apiClient.callApi(
110799
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids',
110800
+ 'POST',
110801
+ { 'businessUnitId': businessUnitId },
110802
+ { },
110803
+ { },
110804
+ { },
110805
+ body,
110806
+ ['PureCloud OAuth'],
110807
+ ['application/json'],
110808
+ ['application/json'],
110809
+ opts['customHeaders']
110810
+ );
110811
+ }
110812
+
110813
+ /**
110814
+ * Fetch all the agents with effective schedule set for the given BU
110815
+ *
110816
+ * @param {String} businessUnitId The ID of the business unit
110817
+ * @param {Object} body body
110818
+ * @param {Object} opts Optional parameters
110819
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
110820
+ */
110821
+ postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets(businessUnitId, body, opts) {
110822
+ opts = opts || {};
110823
+
110824
+ // verify the required parameter 'businessUnitId' is set
110825
+ if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
110826
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets';
110827
+ }
110828
+ // verify the required parameter 'body' is set
110829
+ if (body === undefined || body === null) {
110830
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitSchedulebidsEffectiveschedulesets';
110831
+ }
110832
+
110833
+ return this.apiClient.callApi(
110834
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/schedulebids/effectiveschedulesets',
110835
+ 'POST',
110836
+ { 'businessUnitId': businessUnitId },
110837
+ { },
110838
+ { },
110839
+ { },
110840
+ body,
110841
+ ['PureCloud OAuth'],
110842
+ ['application/json'],
110843
+ ['application/json'],
110844
+ opts['customHeaders']
110845
+ );
110846
+ }
110847
+
109310
110848
  /**
109311
110849
  * Adds a new service goal template
109312
110850
  *
@@ -111260,6 +112798,7 @@ class WorkforceManagementApi {
111260
112798
  * @param {String} userId The id of the user for whom the time off request estimate is requested
111261
112799
  * @param {Object} body body
111262
112800
  * @param {Object} opts Optional parameters
112801
+ * @param {Object} opts.includeOnly Limit response to the specified field
111263
112802
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
111264
112803
  */
111265
112804
  postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body, opts) {
@@ -111282,7 +112821,7 @@ class WorkforceManagementApi {
111282
112821
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
111283
112822
  'POST',
111284
112823
  { 'managementUnitId': managementUnitId,'userId': userId },
111285
- { },
112824
+ { 'includeOnly': opts['includeOnly'] },
111286
112825
  { },
111287
112826
  { },
111288
112827
  body,
@@ -112079,6 +113618,7 @@ class WorkforceManagementApi {
112079
113618
  *
112080
113619
  * @param {Object} body body
112081
113620
  * @param {Object} opts Optional parameters
113621
+ * @param {Object} opts.includeOnly Limit response to the specified field
112082
113622
  * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
112083
113623
  */
112084
113624
  postWorkforcemanagementTimeoffrequestsEstimate(body, opts) {
@@ -112093,7 +113633,7 @@ class WorkforceManagementApi {
112093
113633
  '/api/v2/workforcemanagement/timeoffrequests/estimate',
112094
113634
  'POST',
112095
113635
  { },
112096
- { },
113636
+ { 'includeOnly': opts['includeOnly'] },
112097
113637
  { },
112098
113638
  { },
112099
113639
  body,
@@ -112309,6 +113849,41 @@ class WorkforceManagementApi {
112309
113849
  );
112310
113850
  }
112311
113851
 
113852
+ /**
113853
+ * Update an agent's schedule set preference
113854
+ *
113855
+ * @param {String} bidId The ID of the schedule bid
113856
+ * @param {Object} body body
113857
+ * @param {Object} opts Optional parameters
113858
+ * @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
113859
+ */
113860
+ putWorkforcemanagementSchedulebidPreference(bidId, body, opts) {
113861
+ opts = opts || {};
113862
+
113863
+ // verify the required parameter 'bidId' is set
113864
+ if (bidId === undefined || bidId === null || bidId === '') {
113865
+ throw 'Missing the required parameter "bidId" when calling putWorkforcemanagementSchedulebidPreference';
113866
+ }
113867
+ // verify the required parameter 'body' is set
113868
+ if (body === undefined || body === null) {
113869
+ throw 'Missing the required parameter "body" when calling putWorkforcemanagementSchedulebidPreference';
113870
+ }
113871
+
113872
+ return this.apiClient.callApi(
113873
+ '/api/v2/workforcemanagement/schedulebids/{bidId}/preference',
113874
+ 'PUT',
113875
+ { 'bidId': bidId },
113876
+ { },
113877
+ { },
113878
+ { },
113879
+ body,
113880
+ ['PureCloud OAuth'],
113881
+ ['application/json'],
113882
+ ['application/json'],
113883
+ opts['customHeaders']
113884
+ );
113885
+ }
113886
+
112312
113887
  }
112313
113888
 
112314
113889
  /**
@@ -112340,7 +113915,7 @@ class WorkforceManagementApi {
112340
113915
  * </pre>
112341
113916
  * </p>
112342
113917
  * @module purecloud-platform-client-v2/index
112343
- * @version 253.0.0
113918
+ * @version 255.0.0
112344
113919
  */
112345
113920
  class platformClient {
112346
113921
  constructor() {