purecloud-platform-client-v2 134.0.0 → 136.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 (73) hide show
  1. package/README.md +32 -29
  2. package/dist/node/purecloud-platform-client-v2.js +388 -214
  3. package/dist/web-amd/purecloud-platform-client-v2.js +388 -214
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +388 -214
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +398 -225
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +364 -35
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +2 -2
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +5 -5
  21. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/GamificationApi.js +29 -29
  26. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +11 -9
  32. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OutboundApi.js +26 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -51
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +132 -5
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -3
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +69 -3
  54. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
  60. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +51 -51
  73. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -5755,10 +5755,10 @@ function Request(method, url) {
5755
5755
 
5756
5756
  try {
5757
5757
  res = new Response(self);
5758
- } catch (error_) {
5758
+ } catch (err) {
5759
5759
  error = new Error('Parser is unable to parse the response');
5760
5760
  error.parse = true;
5761
- error.original = error_; // issue #675: return the raw response if the response parsing fails
5761
+ error.original = err; // issue #675: return the raw response if the response parsing fails
5762
5762
 
5763
5763
  if (self.xhr) {
5764
5764
  // ie9 doesn't have 'response' property
@@ -5881,14 +5881,13 @@ Request.prototype.auth = function (user, pass, options) {
5881
5881
  };
5882
5882
  }
5883
5883
 
5884
- var encoder = function encoder(string) {
5884
+ var encoder = options.encoder ? options.encoder : function (string) {
5885
5885
  if (typeof btoa === 'function') {
5886
5886
  return btoa(string);
5887
5887
  }
5888
5888
 
5889
5889
  throw new Error('Cannot use basic auth, btoa is not a function');
5890
5890
  };
5891
-
5892
5891
  return this._auth(user, pass, options, encoder);
5893
5892
  };
5894
5893
  /**
@@ -6552,8 +6551,8 @@ RequestBase.prototype._shouldRetry = function (error, res) {
6552
6551
 
6553
6552
  if (override === true) return true;
6554
6553
  if (override === false) return false; // undefined falls back to defaults
6555
- } catch (error_) {
6556
- console.error(error_);
6554
+ } catch (err) {
6555
+ console.error(err);
6557
6556
  }
6558
6557
  } // TODO: we would need to make this easily configurable before adding it in (e.g. some might want to add POST)
6559
6558
 
@@ -6645,8 +6644,8 @@ RequestBase.prototype.then = function (resolve, reject) {
6645
6644
  return this._fullfilledPromise.then(resolve, reject);
6646
6645
  };
6647
6646
 
6648
- RequestBase.prototype.catch = function (cb) {
6649
- return this.then(undefined, cb);
6647
+ RequestBase.prototype.catch = function (callback) {
6648
+ return this.then(undefined, callback);
6650
6649
  };
6651
6650
  /**
6652
6651
  * Allow for extension
@@ -6658,9 +6657,9 @@ RequestBase.prototype.use = function (fn) {
6658
6657
  return this;
6659
6658
  };
6660
6659
 
6661
- RequestBase.prototype.ok = function (cb) {
6662
- if (typeof cb !== 'function') throw new Error('Callback required');
6663
- this._okCallback = cb;
6660
+ RequestBase.prototype.ok = function (callback) {
6661
+ if (typeof callback !== 'function') throw new Error('Callback required');
6662
+ this._okCallback = callback;
6664
6663
  return this;
6665
6664
  };
6666
6665
 
@@ -9675,7 +9674,7 @@ class Configuration {
9675
9674
 
9676
9675
  /**
9677
9676
  * @module purecloud-platform-client-v2/ApiClient
9678
- * @version 134.0.0
9677
+ * @version 136.0.0
9679
9678
  */
9680
9679
  class ApiClient {
9681
9680
  /**
@@ -10615,7 +10614,7 @@ class ApiClient {
10615
10614
 
10616
10615
  // set header parameters
10617
10616
  request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
10618
- //request.set({ 'purecloud-sdk': '134.0.0' });
10617
+ //request.set({ 'purecloud-sdk': '136.0.0' });
10619
10618
 
10620
10619
  // set request timeout
10621
10620
  request.timeout(that.timeout);
@@ -10715,7 +10714,7 @@ class AlertingApi {
10715
10714
  /**
10716
10715
  * Alerting service.
10717
10716
  * @module purecloud-platform-client-v2/api/AlertingApi
10718
- * @version 134.0.0
10717
+ * @version 136.0.0
10719
10718
  */
10720
10719
 
10721
10720
  /**
@@ -11029,7 +11028,7 @@ class AnalyticsApi {
11029
11028
  /**
11030
11029
  * Analytics service.
11031
11030
  * @module purecloud-platform-client-v2/api/AnalyticsApi
11032
- * @version 134.0.0
11031
+ * @version 136.0.0
11033
11032
  */
11034
11033
 
11035
11034
  /**
@@ -12211,7 +12210,7 @@ class ArchitectApi {
12211
12210
  /**
12212
12211
  * Architect service.
12213
12212
  * @module purecloud-platform-client-v2/api/ArchitectApi
12214
- * @version 134.0.0
12213
+ * @version 136.0.0
12215
12214
  */
12216
12215
 
12217
12216
  /**
@@ -15207,7 +15206,7 @@ class AuditApi {
15207
15206
  /**
15208
15207
  * Audit service.
15209
15208
  * @module purecloud-platform-client-v2/api/AuditApi
15210
- * @version 134.0.0
15209
+ * @version 136.0.0
15211
15210
  */
15212
15211
 
15213
15212
  /**
@@ -15378,7 +15377,7 @@ class AuthorizationApi {
15378
15377
  /**
15379
15378
  * Authorization service.
15380
15379
  * @module purecloud-platform-client-v2/api/AuthorizationApi
15381
- * @version 134.0.0
15380
+ * @version 136.0.0
15382
15381
  */
15383
15382
 
15384
15383
  /**
@@ -16561,7 +16560,7 @@ class BillingApi {
16561
16560
  /**
16562
16561
  * Billing service.
16563
16562
  * @module purecloud-platform-client-v2/api/BillingApi
16564
- * @version 134.0.0
16563
+ * @version 136.0.0
16565
16564
  */
16566
16565
 
16567
16566
  /**
@@ -16641,7 +16640,7 @@ class ChatApi {
16641
16640
  /**
16642
16641
  * Chat service.
16643
16642
  * @module purecloud-platform-client-v2/api/ChatApi
16644
- * @version 134.0.0
16643
+ * @version 136.0.0
16645
16644
  */
16646
16645
 
16647
16646
  /**
@@ -16732,7 +16731,7 @@ class CoachingApi {
16732
16731
  /**
16733
16732
  * Coaching service.
16734
16733
  * @module purecloud-platform-client-v2/api/CoachingApi
16735
- * @version 134.0.0
16734
+ * @version 136.0.0
16736
16735
  */
16737
16736
 
16738
16737
  /**
@@ -17309,7 +17308,7 @@ class ContentManagementApi {
17309
17308
  /**
17310
17309
  * ContentManagement service.
17311
17310
  * @module purecloud-platform-client-v2/api/ContentManagementApi
17312
- * @version 134.0.0
17311
+ * @version 136.0.0
17313
17312
  */
17314
17313
 
17315
17314
  /**
@@ -18449,7 +18448,7 @@ class ConversationsApi {
18449
18448
  /**
18450
18449
  * Conversations service.
18451
18450
  * @module purecloud-platform-client-v2/api/ConversationsApi
18452
- * @version 134.0.0
18451
+ * @version 136.0.0
18453
18452
  */
18454
18453
 
18455
18454
  /**
@@ -20354,7 +20353,7 @@ class ConversationsApi {
20354
20353
  /**
20355
20354
  * Get a list of Messaging Stickers
20356
20355
  *
20357
- * @param {String} messengerType Messenger Type
20356
+ * @param {Object} messengerType Messenger Type
20358
20357
  * @param {Object} opts Optional parameters
20359
20358
  * @param {Number} opts.pageSize Page size (default to 25)
20360
20359
  * @param {Number} opts.pageNumber Page number (default to 1)
@@ -20542,7 +20541,7 @@ class ConversationsApi {
20542
20541
  }
20543
20542
 
20544
20543
  /**
20545
- * Update a conversation by setting it's recording state, merging in other conversations to create a conference, or disconnecting all of the participants
20544
+ * Update a conversation by setting its recording state, merging in other conversations to create a conference, or disconnecting all of the participants
20546
20545
  *
20547
20546
  * @param {String} conversationId conversationId
20548
20547
  * @param {Object} body Conversation
@@ -21528,8 +21527,8 @@ class ConversationsApi {
21528
21527
  }
21529
21528
 
21530
21529
  /**
21531
- * Update or activate a WhatsApp messaging integration.
21532
- * The following steps are required in order to fully activate a Whatsapp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
21530
+ * Update or activate a WhatsApp messaging integration
21531
+ * The following steps are required in order to fully activate a WhatsApp Integration: Initially, you will need to get an activation code by sending: an action set to Activate, and an authenticationMethod choosing from Sms or Voice. Finally, once you have been informed of an activation code on selected authenticationMethod, you will need to confirm the code by sending: an action set to Confirm, and the confirmationCode you have received from Whatsapp.
21533
21532
  * @param {String} integrationId Integration ID
21534
21533
  * @param {Object} body WhatsAppIntegrationUpdateRequest
21535
21534
  */
@@ -23113,7 +23112,7 @@ class DataExtensionsApi {
23113
23112
  /**
23114
23113
  * DataExtensions service.
23115
23114
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
23116
- * @version 134.0.0
23115
+ * @version 136.0.0
23117
23116
  */
23118
23117
 
23119
23118
  /**
@@ -23199,7 +23198,7 @@ class ExternalContactsApi {
23199
23198
  /**
23200
23199
  * ExternalContacts service.
23201
23200
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
23202
- * @version 134.0.0
23201
+ * @version 136.0.0
23203
23202
  */
23204
23203
 
23205
23204
  /**
@@ -24942,7 +24941,7 @@ class FaxApi {
24942
24941
  /**
24943
24942
  * Fax service.
24944
24943
  * @module purecloud-platform-client-v2/api/FaxApi
24945
- * @version 134.0.0
24944
+ * @version 136.0.0
24946
24945
  */
24947
24946
 
24948
24947
  /**
@@ -25113,7 +25112,7 @@ class FlowsApi {
25113
25112
  /**
25114
25113
  * Flows service.
25115
25114
  * @module purecloud-platform-client-v2/api/FlowsApi
25116
- * @version 134.0.0
25115
+ * @version 136.0.0
25117
25116
  */
25118
25117
 
25119
25118
  /**
@@ -25184,7 +25183,7 @@ class GamificationApi {
25184
25183
  /**
25185
25184
  * Gamification service.
25186
25185
  * @module purecloud-platform-client-v2/api/GamificationApi
25187
- * @version 134.0.0
25186
+ * @version 136.0.0
25188
25187
  */
25189
25188
 
25190
25189
  /**
@@ -25430,18 +25429,18 @@ class GamificationApi {
25430
25429
  /**
25431
25430
  * Performance profile by id
25432
25431
  *
25433
- * @param {String} performanceProfileId Performance Profile Id
25432
+ * @param {String} profileId performanceProfileId
25434
25433
  */
25435
- getGamificationProfile(performanceProfileId) {
25436
- // verify the required parameter 'performanceProfileId' is set
25437
- if (performanceProfileId === undefined || performanceProfileId === null) {
25438
- throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfile';
25434
+ getGamificationProfile(profileId) {
25435
+ // verify the required parameter 'profileId' is set
25436
+ if (profileId === undefined || profileId === null) {
25437
+ throw 'Missing the required parameter "profileId" when calling getGamificationProfile';
25439
25438
  }
25440
25439
 
25441
25440
  return this.apiClient.callApi(
25442
- '/api/v2/gamification/profiles/{performanceProfileId}',
25441
+ '/api/v2/gamification/profiles/{profileId}',
25443
25442
  'GET',
25444
- { 'performanceProfileId': performanceProfileId },
25443
+ { 'profileId': profileId },
25445
25444
  { },
25446
25445
  { },
25447
25446
  { },
@@ -26284,18 +26283,18 @@ class GamificationApi {
26284
26283
  /**
26285
26284
  * Activate a performance profile
26286
26285
  *
26287
- * @param {String} performanceProfileId Performance Profile Id
26286
+ * @param {String} profileId performanceProfileId
26288
26287
  */
26289
- postGamificationProfileActivate(performanceProfileId) {
26290
- // verify the required parameter 'performanceProfileId' is set
26291
- if (performanceProfileId === undefined || performanceProfileId === null) {
26292
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileActivate';
26288
+ postGamificationProfileActivate(profileId) {
26289
+ // verify the required parameter 'profileId' is set
26290
+ if (profileId === undefined || profileId === null) {
26291
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileActivate';
26293
26292
  }
26294
26293
 
26295
26294
  return this.apiClient.callApi(
26296
- '/api/v2/gamification/profiles/{performanceProfileId}/activate',
26295
+ '/api/v2/gamification/profiles/{profileId}/activate',
26297
26296
  'POST',
26298
- { 'performanceProfileId': performanceProfileId },
26297
+ { 'profileId': profileId },
26299
26298
  { },
26300
26299
  { },
26301
26300
  { },
@@ -26309,18 +26308,18 @@ class GamificationApi {
26309
26308
  /**
26310
26309
  * Deactivate a performance profile
26311
26310
  *
26312
- * @param {String} performanceProfileId Performance Profile Id
26311
+ * @param {String} profileId performanceProfileId
26313
26312
  */
26314
- postGamificationProfileDeactivate(performanceProfileId) {
26315
- // verify the required parameter 'performanceProfileId' is set
26316
- if (performanceProfileId === undefined || performanceProfileId === null) {
26317
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileDeactivate';
26313
+ postGamificationProfileDeactivate(profileId) {
26314
+ // verify the required parameter 'profileId' is set
26315
+ if (profileId === undefined || profileId === null) {
26316
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileDeactivate';
26318
26317
  }
26319
26318
 
26320
26319
  return this.apiClient.callApi(
26321
- '/api/v2/gamification/profiles/{performanceProfileId}/deactivate',
26320
+ '/api/v2/gamification/profiles/{profileId}/deactivate',
26322
26321
  'POST',
26323
- { 'performanceProfileId': performanceProfileId },
26322
+ { 'profileId': profileId },
26324
26323
  { },
26325
26324
  { },
26326
26325
  { },
@@ -26522,22 +26521,22 @@ class GamificationApi {
26522
26521
  /**
26523
26522
  * Updates a performance profile
26524
26523
  *
26525
- * @param {String} performanceProfileId Performance Profile Id
26524
+ * @param {String} profileId performanceProfileId
26526
26525
  * @param {Object} opts Optional parameters
26527
26526
  * @param {Object} opts.body performanceProfile
26528
26527
  */
26529
- putGamificationProfile(performanceProfileId, opts) {
26528
+ putGamificationProfile(profileId, opts) {
26530
26529
  opts = opts || {};
26531
26530
 
26532
- // verify the required parameter 'performanceProfileId' is set
26533
- if (performanceProfileId === undefined || performanceProfileId === null) {
26534
- throw 'Missing the required parameter "performanceProfileId" when calling putGamificationProfile';
26531
+ // verify the required parameter 'profileId' is set
26532
+ if (profileId === undefined || profileId === null) {
26533
+ throw 'Missing the required parameter "profileId" when calling putGamificationProfile';
26535
26534
  }
26536
26535
 
26537
26536
  return this.apiClient.callApi(
26538
- '/api/v2/gamification/profiles/{performanceProfileId}',
26537
+ '/api/v2/gamification/profiles/{profileId}',
26539
26538
  'PUT',
26540
- { 'performanceProfileId': performanceProfileId },
26539
+ { 'profileId': profileId },
26541
26540
  { },
26542
26541
  { },
26543
26542
  { },
@@ -26614,7 +26613,7 @@ class GeneralDataProtectionRegulationApi {
26614
26613
  /**
26615
26614
  * GeneralDataProtectionRegulation service.
26616
26615
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
26617
- * @version 134.0.0
26616
+ * @version 136.0.0
26618
26617
  */
26619
26618
 
26620
26619
  /**
@@ -26744,7 +26743,7 @@ class GeolocationApi {
26744
26743
  /**
26745
26744
  * Geolocation service.
26746
26745
  * @module purecloud-platform-client-v2/api/GeolocationApi
26747
- * @version 134.0.0
26746
+ * @version 136.0.0
26748
26747
  */
26749
26748
 
26750
26749
  /**
@@ -26875,7 +26874,7 @@ class GreetingsApi {
26875
26874
  /**
26876
26875
  * Greetings service.
26877
26876
  * @module purecloud-platform-client-v2/api/GreetingsApi
26878
- * @version 134.0.0
26877
+ * @version 136.0.0
26879
26878
  */
26880
26879
 
26881
26880
  /**
@@ -27330,7 +27329,7 @@ class GroupsApi {
27330
27329
  /**
27331
27330
  * Groups service.
27332
27331
  * @module purecloud-platform-client-v2/api/GroupsApi
27333
- * @version 134.0.0
27332
+ * @version 136.0.0
27334
27333
  */
27335
27334
 
27336
27335
  /**
@@ -27735,7 +27734,7 @@ class IdentityProviderApi {
27735
27734
  /**
27736
27735
  * IdentityProvider service.
27737
27736
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
27738
- * @version 134.0.0
27737
+ * @version 136.0.0
27739
27738
  */
27740
27739
 
27741
27740
  /**
@@ -28491,7 +28490,7 @@ class IntegrationsApi {
28491
28490
  /**
28492
28491
  * Integrations service.
28493
28492
  * @module purecloud-platform-client-v2/api/IntegrationsApi
28494
- * @version 134.0.0
28493
+ * @version 136.0.0
28495
28494
  */
28496
28495
 
28497
28496
  /**
@@ -28909,9 +28908,10 @@ class IntegrationsApi {
28909
28908
  * @param {String} opts.previousPage Previous page token
28910
28909
  * @param {String} opts.sortBy Root level field name to sort on.
28911
28910
  * @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
28912
- * @param {String} opts.category Filter by category name
28913
- * @param {String} opts.name Filter by action name. Provide full or just the first part of name.
28914
- * @param {Object} opts.secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
28911
+ * @param {String} opts.category Filter by category name.
28912
+ * @param {String} opts.name Filter by partial or complete action name.
28913
+ * @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
28914
+ * @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
28915
28915
  * @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
28916
28916
  */
28917
28917
  getIntegrationsActions(opts) {
@@ -28922,7 +28922,7 @@ class IntegrationsApi {
28922
28922
  '/api/v2/integrations/actions',
28923
28923
  'GET',
28924
28924
  { },
28925
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
28925
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
28926
28926
  { },
28927
28927
  { },
28928
28928
  null,
@@ -28972,9 +28972,10 @@ class IntegrationsApi {
28972
28972
  * @param {String} opts.previousPage Previous page token
28973
28973
  * @param {String} opts.sortBy Root level field name to sort on.
28974
28974
  * @param {Object} opts.sortOrder Direction to sort 'sortBy' field. (default to asc)
28975
- * @param {String} opts.category Filter by category name
28976
- * @param {String} opts.name Filter by action name. Provide full or just the first part of name.
28977
- * @param {Object} opts.secure Filter to only include secure actions. True will only include actions marked secured. False will include only unsecure actions. Do not use filter if you want all Actions.
28975
+ * @param {String} opts.category Filter by category name.
28976
+ * @param {String} opts.name Filter by partial or complete action name.
28977
+ * @param {String} opts.ids Filter by action Id. Can be a comma separated list to request multiple actions. Limit of 50 Ids.
28978
+ * @param {Object} opts.secure Filter based on 'secure' configuration option. True will only return actions marked as secure. False will return only non-secure actions. Do not use filter if you want all Actions.
28978
28979
  * @param {Object} opts.includeAuthActions Whether or not to include authentication actions in the response. These actions are not directly executable. Some integrations create them and will run them as needed to refresh authentication information for other actions. (default to false)
28979
28980
  */
28980
28981
  getIntegrationsActionsDrafts(opts) {
@@ -28985,7 +28986,7 @@ class IntegrationsApi {
28985
28986
  '/api/v2/integrations/actions/drafts',
28986
28987
  'GET',
28987
28988
  { },
28988
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
28989
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'category': opts['category'],'name': opts['name'],'ids': opts['ids'],'secure': opts['secure'],'includeAuthActions': opts['includeAuthActions'] },
28989
28990
  { },
28990
28991
  { },
28991
28992
  null,
@@ -30166,7 +30167,7 @@ class JourneyApi {
30166
30167
  /**
30167
30168
  * Journey service.
30168
30169
  * @module purecloud-platform-client-v2/api/JourneyApi
30169
- * @version 134.0.0
30170
+ * @version 136.0.0
30170
30171
  */
30171
30172
 
30172
30173
  /**
@@ -30877,7 +30878,7 @@ class KnowledgeApi {
30877
30878
  /**
30878
30879
  * Knowledge service.
30879
30880
  * @module purecloud-platform-client-v2/api/KnowledgeApi
30880
- * @version 134.0.0
30881
+ * @version 136.0.0
30881
30882
  */
30882
30883
 
30883
30884
  /**
@@ -31777,7 +31778,7 @@ class LanguageUnderstandingApi {
31777
31778
  /**
31778
31779
  * LanguageUnderstanding service.
31779
31780
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
31780
- * @version 134.0.0
31781
+ * @version 136.0.0
31781
31782
  */
31782
31783
 
31783
31784
  /**
@@ -32681,7 +32682,7 @@ class LanguagesApi {
32681
32682
  /**
32682
32683
  * Languages service.
32683
32684
  * @module purecloud-platform-client-v2/api/LanguagesApi
32684
- * @version 134.0.0
32685
+ * @version 136.0.0
32685
32686
  */
32686
32687
 
32687
32688
  /**
@@ -32949,7 +32950,7 @@ class LearningApi {
32949
32950
  /**
32950
32951
  * Learning service.
32951
32952
  * @module purecloud-platform-client-v2/api/LearningApi
32952
- * @version 134.0.0
32953
+ * @version 136.0.0
32953
32954
  */
32954
32955
 
32955
32956
  /**
@@ -33540,7 +33541,7 @@ class LicenseApi {
33540
33541
  /**
33541
33542
  * License service.
33542
33543
  * @module purecloud-platform-client-v2/api/LicenseApi
33543
- * @version 134.0.0
33544
+ * @version 136.0.0
33544
33545
  */
33545
33546
 
33546
33547
  /**
@@ -33778,7 +33779,7 @@ class LocationsApi {
33778
33779
  /**
33779
33780
  * Locations service.
33780
33781
  * @module purecloud-platform-client-v2/api/LocationsApi
33781
- * @version 134.0.0
33782
+ * @version 136.0.0
33782
33783
  */
33783
33784
 
33784
33785
  /**
@@ -34014,7 +34015,7 @@ class MessagingApi {
34014
34015
  /**
34015
34016
  * Messaging service.
34016
34017
  * @module purecloud-platform-client-v2/api/MessagingApi
34017
- * @version 134.0.0
34018
+ * @version 136.0.0
34018
34019
  */
34019
34020
 
34020
34021
  /**
@@ -34165,7 +34166,7 @@ class MobileDevicesApi {
34165
34166
  /**
34166
34167
  * MobileDevices service.
34167
34168
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
34168
- * @version 134.0.0
34169
+ * @version 136.0.0
34169
34170
  */
34170
34171
 
34171
34172
  /**
@@ -34316,7 +34317,7 @@ class NotificationsApi {
34316
34317
  /**
34317
34318
  * Notifications service.
34318
34319
  * @module purecloud-platform-client-v2/api/NotificationsApi
34319
- * @version 134.0.0
34320
+ * @version 136.0.0
34320
34321
  */
34321
34322
 
34322
34323
  /**
@@ -34541,7 +34542,7 @@ class OAuthApi {
34541
34542
  /**
34542
34543
  * OAuth service.
34543
34544
  * @module purecloud-platform-client-v2/api/OAuthApi
34544
- * @version 134.0.0
34545
+ * @version 136.0.0
34545
34546
  */
34546
34547
 
34547
34548
  /**
@@ -34907,7 +34908,7 @@ class ObjectsApi {
34907
34908
  /**
34908
34909
  * Objects service.
34909
34910
  * @module purecloud-platform-client-v2/api/ObjectsApi
34910
- * @version 134.0.0
34911
+ * @version 136.0.0
34911
34912
  */
34912
34913
 
34913
34914
  /**
@@ -35178,7 +35179,7 @@ class OrganizationApi {
35178
35179
  /**
35179
35180
  * Organization service.
35180
35181
  * @module purecloud-platform-client-v2/api/OrganizationApi
35181
- * @version 134.0.0
35182
+ * @version 136.0.0
35182
35183
  */
35183
35184
 
35184
35185
  /**
@@ -35581,7 +35582,7 @@ class OrganizationAuthorizationApi {
35581
35582
  /**
35582
35583
  * OrganizationAuthorization service.
35583
35584
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
35584
- * @version 134.0.0
35585
+ * @version 136.0.0
35585
35586
  */
35586
35587
 
35587
35588
  /**
@@ -36506,7 +36507,7 @@ class OutboundApi {
36506
36507
  /**
36507
36508
  * Outbound service.
36508
36509
  * @module purecloud-platform-client-v2/api/OutboundApi
36509
- * @version 134.0.0
36510
+ * @version 136.0.0
36510
36511
  */
36511
36512
 
36512
36513
  /**
@@ -36856,6 +36857,31 @@ class OutboundApi {
36856
36857
  );
36857
36858
  }
36858
36859
 
36860
+ /**
36861
+ * Reset messaging campaign progress and recycle the messaging campaign
36862
+ *
36863
+ * @param {String} messagingCampaignId The Messaging Campaign ID
36864
+ */
36865
+ deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
36866
+ // verify the required parameter 'messagingCampaignId' is set
36867
+ if (messagingCampaignId === undefined || messagingCampaignId === null) {
36868
+ throw 'Missing the required parameter "messagingCampaignId" when calling deleteOutboundMessagingcampaignProgress';
36869
+ }
36870
+
36871
+ return this.apiClient.callApi(
36872
+ '/api/v2/outbound/messagingcampaigns/{messagingCampaignId}/progress',
36873
+ 'DELETE',
36874
+ { 'messagingCampaignId': messagingCampaignId },
36875
+ { },
36876
+ { },
36877
+ { },
36878
+ null,
36879
+ ['PureCloud OAuth'],
36880
+ ['application/json'],
36881
+ ['application/json']
36882
+ );
36883
+ }
36884
+
36859
36885
  /**
36860
36886
  * Delete a Rule Set.
36861
36887
  *
@@ -39536,7 +39562,7 @@ class PresenceApi {
39536
39562
  /**
39537
39563
  * Presence service.
39538
39564
  * @module purecloud-platform-client-v2/api/PresenceApi
39539
- * @version 134.0.0
39565
+ * @version 136.0.0
39540
39566
  */
39541
39567
 
39542
39568
  /**
@@ -39682,31 +39708,6 @@ class PresenceApi {
39682
39708
  );
39683
39709
  }
39684
39710
 
39685
- /**
39686
- * Get a user's Microsoft Teams presence.
39687
- * Gets the presence for a Microsoft Teams user. This will return the Microsoft Teams presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
39688
- * @param {String} userId user Id
39689
- */
39690
- getUserPresencesMicrosoftteams(userId) {
39691
- // verify the required parameter 'userId' is set
39692
- if (userId === undefined || userId === null) {
39693
- throw 'Missing the required parameter "userId" when calling getUserPresencesMicrosoftteams';
39694
- }
39695
-
39696
- return this.apiClient.callApi(
39697
- '/api/v2/users/{userId}/presences/microsoftteams',
39698
- 'GET',
39699
- { 'userId': userId },
39700
- { },
39701
- { },
39702
- { },
39703
- null,
39704
- ['PureCloud OAuth'],
39705
- ['application/json'],
39706
- ['application/json']
39707
- );
39708
- }
39709
-
39710
39711
  /**
39711
39712
  * Get a user's Genesys Cloud presence.
39712
39713
  * Get the default Genesys Cloud user presence source PURECLOUD
@@ -39732,31 +39733,6 @@ class PresenceApi {
39732
39733
  );
39733
39734
  }
39734
39735
 
39735
- /**
39736
- * Get a user's Zoom Phone presence.
39737
- * Gets the presence for a Zoom user. This will return the Zoom Phone presence mapped to Genesys Cloud presence with additional activity details in the message field. This presence source is read-only.
39738
- * @param {String} userId user Id
39739
- */
39740
- getUserPresencesZoomphone(userId) {
39741
- // verify the required parameter 'userId' is set
39742
- if (userId === undefined || userId === null) {
39743
- throw 'Missing the required parameter "userId" when calling getUserPresencesZoomphone';
39744
- }
39745
-
39746
- return this.apiClient.callApi(
39747
- '/api/v2/users/{userId}/presences/zoomphone',
39748
- 'GET',
39749
- { 'userId': userId },
39750
- { },
39751
- { },
39752
- { },
39753
- null,
39754
- ['PureCloud OAuth'],
39755
- ['application/json'],
39756
- ['application/json']
39757
- );
39758
- }
39759
-
39760
39736
  /**
39761
39737
  * Patch a user's Presence
39762
39738
  * Patch a user's presence for the specified source that is not specifically listed. The presence object can be patched one of three ways. Option 1: Set the 'primary' property to true. This will set the 'source' defined in the path as the user's primary presence source. Option 2: Provide the presenceDefinition value. The 'id' is the only value required within the presenceDefinition. Option 3: Provide the message value. Option 1 can be combined with Option 2 and/or Option 3.
@@ -39908,7 +39884,7 @@ class QualityApi {
39908
39884
  /**
39909
39885
  * Quality service.
39910
39886
  * @module purecloud-platform-client-v2/api/QualityApi
39911
- * @version 134.0.0
39887
+ * @version 136.0.0
39912
39888
  */
39913
39889
 
39914
39890
  /**
@@ -41486,7 +41462,7 @@ class RecordingApi {
41486
41462
  /**
41487
41463
  * Recording service.
41488
41464
  * @module purecloud-platform-client-v2/api/RecordingApi
41489
- * @version 134.0.0
41465
+ * @version 136.0.0
41490
41466
  */
41491
41467
 
41492
41468
  /**
@@ -42009,6 +41985,7 @@ class RecordingApi {
42009
41985
  * @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
42010
41986
  * @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
42011
41987
  * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
41988
+ * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
42012
41989
  */
42013
41990
  getRecordingCrossplatformMediaretentionpolicies(opts) {
42014
41991
  opts = opts || {};
@@ -42018,7 +41995,7 @@ class RecordingApi {
42018
41995
  '/api/v2/recording/crossplatform/mediaretentionpolicies',
42019
41996
  'GET',
42020
41997
  { },
42021
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
41998
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
42022
41999
  { },
42023
42000
  { },
42024
42001
  null,
@@ -42141,6 +42118,51 @@ class RecordingApi {
42141
42118
  );
42142
42119
  }
42143
42120
 
42121
+ /**
42122
+ * Get the encryption key configurations
42123
+ *
42124
+ * @param {String} keyConfigurationId Key Configurations Id
42125
+ */
42126
+ getRecordingKeyconfiguration(keyConfigurationId) {
42127
+ // verify the required parameter 'keyConfigurationId' is set
42128
+ if (keyConfigurationId === undefined || keyConfigurationId === null) {
42129
+ throw 'Missing the required parameter "keyConfigurationId" when calling getRecordingKeyconfiguration';
42130
+ }
42131
+
42132
+ return this.apiClient.callApi(
42133
+ '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
42134
+ 'GET',
42135
+ { 'keyConfigurationId': keyConfigurationId },
42136
+ { },
42137
+ { },
42138
+ { },
42139
+ null,
42140
+ ['PureCloud OAuth'],
42141
+ ['application/json'],
42142
+ ['application/json']
42143
+ );
42144
+ }
42145
+
42146
+ /**
42147
+ * Get a list of key configurations data
42148
+ *
42149
+ */
42150
+ getRecordingKeyconfigurations() {
42151
+
42152
+ return this.apiClient.callApi(
42153
+ '/api/v2/recording/keyconfigurations',
42154
+ 'GET',
42155
+ { },
42156
+ { },
42157
+ { },
42158
+ { },
42159
+ null,
42160
+ ['PureCloud OAuth'],
42161
+ ['application/json'],
42162
+ ['application/json']
42163
+ );
42164
+ }
42165
+
42144
42166
  /**
42145
42167
  * Get the local encryption settings
42146
42168
  *
@@ -42200,6 +42222,7 @@ class RecordingApi {
42200
42222
  * @param {Boolean} opts.enabled checks to see if policy is enabled - use enabled = true or enabled = false
42201
42223
  * @param {Boolean} opts.summary provides a less verbose response of policy lists. (default to false)
42202
42224
  * @param {Boolean} opts.hasErrors provides a way to fetch all policies with errors or policies that do not have errors
42225
+ * @param {Number} opts.deleteDaysThreshold provides a way to fetch all policies with any actions having deleteDays exceeding the provided value
42203
42226
  */
42204
42227
  getRecordingMediaretentionpolicies(opts) {
42205
42228
  opts = opts || {};
@@ -42209,7 +42232,7 @@ class RecordingApi {
42209
42232
  '/api/v2/recording/mediaretentionpolicies',
42210
42233
  'GET',
42211
42234
  { },
42212
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'] },
42235
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'name': opts['name'],'enabled': opts['enabled'],'summary': opts['summary'],'hasErrors': opts['hasErrors'],'deleteDaysThreshold': opts['deleteDaysThreshold'] },
42213
42236
  { },
42214
42237
  { },
42215
42238
  null,
@@ -42513,8 +42536,8 @@ class RecordingApi {
42513
42536
  }
42514
42537
 
42515
42538
  /**
42516
- * Create a recording bulk job
42517
- *
42539
+ * Create a recording bulk job.
42540
+ * Each organization can run up to a maximum of two concurrent jobs that are either in pending or processing state.
42518
42541
  * @param {Object} body query
42519
42542
  */
42520
42543
  postRecordingJobs(body) {
@@ -42537,6 +42560,56 @@ class RecordingApi {
42537
42560
  );
42538
42561
  }
42539
42562
 
42563
+ /**
42564
+ * Setup configurations for encryption key creation
42565
+ *
42566
+ * @param {Object} body Encryption Configuration
42567
+ */
42568
+ postRecordingKeyconfigurations(body) {
42569
+ // verify the required parameter 'body' is set
42570
+ if (body === undefined || body === null) {
42571
+ throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurations';
42572
+ }
42573
+
42574
+ return this.apiClient.callApi(
42575
+ '/api/v2/recording/keyconfigurations',
42576
+ 'POST',
42577
+ { },
42578
+ { },
42579
+ { },
42580
+ { },
42581
+ body,
42582
+ ['PureCloud OAuth'],
42583
+ ['application/json'],
42584
+ ['application/json']
42585
+ );
42586
+ }
42587
+
42588
+ /**
42589
+ * Validate encryption key configurations without saving it
42590
+ *
42591
+ * @param {Object} body Encryption Configuration
42592
+ */
42593
+ postRecordingKeyconfigurationsValidate(body) {
42594
+ // verify the required parameter 'body' is set
42595
+ if (body === undefined || body === null) {
42596
+ throw 'Missing the required parameter "body" when calling postRecordingKeyconfigurationsValidate';
42597
+ }
42598
+
42599
+ return this.apiClient.callApi(
42600
+ '/api/v2/recording/keyconfigurations/validate',
42601
+ 'POST',
42602
+ { },
42603
+ { },
42604
+ { },
42605
+ { },
42606
+ body,
42607
+ ['PureCloud OAuth'],
42608
+ ['application/json'],
42609
+ ['application/json']
42610
+ );
42611
+ }
42612
+
42540
42613
  /**
42541
42614
  * create a local recording key
42542
42615
  *
@@ -42871,6 +42944,36 @@ class RecordingApi {
42871
42944
  );
42872
42945
  }
42873
42946
 
42947
+ /**
42948
+ * Update the encryption key configurations
42949
+ *
42950
+ * @param {String} keyConfigurationId Key Configurations Id
42951
+ * @param {Object} body Encryption key configuration metadata
42952
+ */
42953
+ putRecordingKeyconfiguration(keyConfigurationId, body) {
42954
+ // verify the required parameter 'keyConfigurationId' is set
42955
+ if (keyConfigurationId === undefined || keyConfigurationId === null) {
42956
+ throw 'Missing the required parameter "keyConfigurationId" when calling putRecordingKeyconfiguration';
42957
+ }
42958
+ // verify the required parameter 'body' is set
42959
+ if (body === undefined || body === null) {
42960
+ throw 'Missing the required parameter "body" when calling putRecordingKeyconfiguration';
42961
+ }
42962
+
42963
+ return this.apiClient.callApi(
42964
+ '/api/v2/recording/keyconfigurations/{keyConfigurationId}',
42965
+ 'PUT',
42966
+ { 'keyConfigurationId': keyConfigurationId },
42967
+ { },
42968
+ { },
42969
+ { },
42970
+ body,
42971
+ ['PureCloud OAuth'],
42972
+ ['application/json'],
42973
+ ['application/json']
42974
+ );
42975
+ }
42976
+
42874
42977
  /**
42875
42978
  * Update the local encryption settings
42876
42979
  *
@@ -43012,7 +43115,7 @@ class ResponseManagementApi {
43012
43115
  /**
43013
43116
  * ResponseManagement service.
43014
43117
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
43015
- * @version 134.0.0
43118
+ * @version 136.0.0
43016
43119
  */
43017
43120
 
43018
43121
  /**
@@ -43496,7 +43599,7 @@ class RoutingApi {
43496
43599
  /**
43497
43600
  * Routing service.
43498
43601
  * @module purecloud-platform-client-v2/api/RoutingApi
43499
- * @version 134.0.0
43602
+ * @version 136.0.0
43500
43603
  */
43501
43604
 
43502
43605
  /**
@@ -44155,14 +44258,18 @@ class RoutingApi {
44155
44258
  /**
44156
44259
  * Get domains
44157
44260
  *
44261
+ * @param {Object} opts Optional parameters
44262
+ * @param {Boolean} opts.excludeStatus Exclude MX record data (default to false)
44158
44263
  */
44159
- getRoutingEmailDomains() {
44264
+ getRoutingEmailDomains(opts) {
44265
+ opts = opts || {};
44266
+
44160
44267
 
44161
44268
  return this.apiClient.callApi(
44162
44269
  '/api/v2/routing/email/domains',
44163
44270
  'GET',
44164
44271
  { },
44165
- { },
44272
+ { 'excludeStatus': opts['excludeStatus'] },
44166
44273
  { },
44167
44274
  { },
44168
44275
  null,
@@ -46419,7 +46526,7 @@ class SCIMApi {
46419
46526
  /**
46420
46527
  * SCIM service.
46421
46528
  * @module purecloud-platform-client-v2/api/SCIMApi
46422
- * @version 134.0.0
46529
+ * @version 136.0.0
46423
46530
  */
46424
46531
 
46425
46532
  /**
@@ -47296,7 +47403,7 @@ class ScriptsApi {
47296
47403
  /**
47297
47404
  * Scripts service.
47298
47405
  * @module purecloud-platform-client-v2/api/ScriptsApi
47299
- * @version 134.0.0
47406
+ * @version 136.0.0
47300
47407
  */
47301
47408
 
47302
47409
  /**
@@ -47412,6 +47519,7 @@ class ScriptsApi {
47412
47519
  * @param {Object} opts.sortBy SortBy
47413
47520
  * @param {Object} opts.sortOrder SortOrder
47414
47521
  * @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
47522
+ * @param {String} opts.divisionIds Filters scripts to requested divisionIds
47415
47523
  */
47416
47524
  getScripts(opts) {
47417
47525
  opts = opts || {};
@@ -47421,7 +47529,40 @@ class ScriptsApi {
47421
47529
  '/api/v2/scripts',
47422
47530
  'GET',
47423
47531
  { },
47424
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'] },
47532
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
47533
+ { },
47534
+ { },
47535
+ null,
47536
+ ['PureCloud OAuth'],
47537
+ ['application/json'],
47538
+ ['application/json']
47539
+ );
47540
+ }
47541
+
47542
+ /**
47543
+ * Get the metadata for a list of scripts
47544
+ *
47545
+ * @param {Object} opts Optional parameters
47546
+ * @param {Number} opts.pageSize Page size (default to 25)
47547
+ * @param {Number} opts.pageNumber Page number (default to 1)
47548
+ * @param {String} opts.expand Expand
47549
+ * @param {String} opts.name Name filter
47550
+ * @param {String} opts.feature Feature filter
47551
+ * @param {String} opts.flowId Secure flow id filter
47552
+ * @param {Object} opts.sortBy SortBy
47553
+ * @param {Object} opts.sortOrder SortOrder
47554
+ * @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
47555
+ * @param {String} opts.divisionIds Filters scripts to requested divisionIds
47556
+ */
47557
+ getScriptsDivisionviews(opts) {
47558
+ opts = opts || {};
47559
+
47560
+
47561
+ return this.apiClient.callApi(
47562
+ '/api/v2/scripts/divisionviews',
47563
+ 'GET',
47564
+ { },
47565
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
47425
47566
  { },
47426
47567
  { },
47427
47568
  null,
@@ -47442,6 +47583,7 @@ class ScriptsApi {
47442
47583
  * @param {String} opts.feature Feature filter
47443
47584
  * @param {String} opts.flowId Secure flow id filter
47444
47585
  * @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
47586
+ * @param {String} opts.divisionIds Filters scripts to requested divisionIds
47445
47587
  */
47446
47588
  getScriptsPublished(opts) {
47447
47589
  opts = opts || {};
@@ -47451,7 +47593,38 @@ class ScriptsApi {
47451
47593
  '/api/v2/scripts/published',
47452
47594
  'GET',
47453
47595
  { },
47454
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'] },
47596
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
47597
+ { },
47598
+ { },
47599
+ null,
47600
+ ['PureCloud OAuth'],
47601
+ ['application/json'],
47602
+ ['application/json']
47603
+ );
47604
+ }
47605
+
47606
+ /**
47607
+ * Get the published scripts metadata.
47608
+ *
47609
+ * @param {Object} opts Optional parameters
47610
+ * @param {Number} opts.pageSize Page size (default to 25)
47611
+ * @param {Number} opts.pageNumber Page number (default to 1)
47612
+ * @param {String} opts.expand Expand
47613
+ * @param {String} opts.name Name filter
47614
+ * @param {String} opts.feature Feature filter
47615
+ * @param {String} opts.flowId Secure flow id filter
47616
+ * @param {String} opts.scriptDataVersion Advanced usage - controls the data version of the script
47617
+ * @param {String} opts.divisionIds Filters scripts to requested divisionIds
47618
+ */
47619
+ getScriptsPublishedDivisionviews(opts) {
47620
+ opts = opts || {};
47621
+
47622
+
47623
+ return this.apiClient.callApi(
47624
+ '/api/v2/scripts/published/divisionviews',
47625
+ 'GET',
47626
+ { },
47627
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'name': opts['name'],'feature': opts['feature'],'flowId': opts['flowId'],'scriptDataVersion': opts['scriptDataVersion'],'divisionIds': opts['divisionIds'] },
47455
47628
  { },
47456
47629
  { },
47457
47630
  null,
@@ -47649,7 +47822,7 @@ class SearchApi {
47649
47822
  /**
47650
47823
  * Search service.
47651
47824
  * @module purecloud-platform-client-v2/api/SearchApi
47652
- * @version 134.0.0
47825
+ * @version 136.0.0
47653
47826
  */
47654
47827
 
47655
47828
  /**
@@ -48184,7 +48357,7 @@ class SpeechTextAnalyticsApi {
48184
48357
  /**
48185
48358
  * SpeechTextAnalytics service.
48186
48359
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
48187
- * @version 134.0.0
48360
+ * @version 136.0.0
48188
48361
  */
48189
48362
 
48190
48363
  /**
@@ -49037,7 +49210,7 @@ class StationsApi {
49037
49210
  /**
49038
49211
  * Stations service.
49039
49212
  * @module purecloud-platform-client-v2/api/StationsApi
49040
- * @version 134.0.0
49213
+ * @version 136.0.0
49041
49214
  */
49042
49215
 
49043
49216
  /**
@@ -49184,7 +49357,7 @@ class SuggestApi {
49184
49357
  /**
49185
49358
  * Suggest service.
49186
49359
  * @module purecloud-platform-client-v2/api/SuggestApi
49187
- * @version 134.0.0
49360
+ * @version 136.0.0
49188
49361
  */
49189
49362
 
49190
49363
  /**
@@ -49323,7 +49496,7 @@ class TelephonyApi {
49323
49496
  /**
49324
49497
  * Telephony service.
49325
49498
  * @module purecloud-platform-client-v2/api/TelephonyApi
49326
- * @version 134.0.0
49499
+ * @version 136.0.0
49327
49500
  */
49328
49501
 
49329
49502
  /**
@@ -49431,7 +49604,7 @@ class TelephonyProvidersEdgeApi {
49431
49604
  /**
49432
49605
  * TelephonyProvidersEdge service.
49433
49606
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
49434
- * @version 134.0.0
49607
+ * @version 136.0.0
49435
49608
  */
49436
49609
 
49437
49610
  /**
@@ -50846,7 +51019,7 @@ class TelephonyProvidersEdgeApi {
50846
51019
  * @param {Number} opts.pageSize Page size (default to 25)
50847
51020
  * @param {Number} opts.pageNumber Page number (default to 1)
50848
51021
  * @param {String} opts.sortBy Sort by
50849
- * @param {String} opts._number Number
51022
+ * @param {String} opts._number Deprecated, filtering by number not supported
50850
51023
  */
50851
51024
  getTelephonyProvidersEdgesExtensionpools(opts) {
50852
51025
  opts = opts || {};
@@ -53064,7 +53237,7 @@ class TextbotsApi {
53064
53237
  /**
53065
53238
  * Textbots service.
53066
53239
  * @module purecloud-platform-client-v2/api/TextbotsApi
53067
- * @version 134.0.0
53240
+ * @version 136.0.0
53068
53241
  */
53069
53242
 
53070
53243
  /**
@@ -53192,7 +53365,7 @@ class TokensApi {
53192
53365
  /**
53193
53366
  * Tokens service.
53194
53367
  * @module purecloud-platform-client-v2/api/TokensApi
53195
- * @version 134.0.0
53368
+ * @version 136.0.0
53196
53369
  */
53197
53370
 
53198
53371
  /**
@@ -53298,7 +53471,7 @@ class UploadsApi {
53298
53471
  /**
53299
53472
  * Uploads service.
53300
53473
  * @module purecloud-platform-client-v2/api/UploadsApi
53301
- * @version 134.0.0
53474
+ * @version 136.0.0
53302
53475
  */
53303
53476
 
53304
53477
  /**
@@ -53449,7 +53622,7 @@ class UsageApi {
53449
53622
  /**
53450
53623
  * Usage service.
53451
53624
  * @module purecloud-platform-client-v2/api/UsageApi
53452
- * @version 134.0.0
53625
+ * @version 136.0.0
53453
53626
  */
53454
53627
 
53455
53628
  /**
@@ -53520,7 +53693,7 @@ class UserRecordingsApi {
53520
53693
  /**
53521
53694
  * UserRecordings service.
53522
53695
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
53523
- * @version 134.0.0
53696
+ * @version 136.0.0
53524
53697
  */
53525
53698
 
53526
53699
  /**
@@ -53704,7 +53877,7 @@ class UsersApi {
53704
53877
  /**
53705
53878
  * Users service.
53706
53879
  * @module purecloud-platform-client-v2/api/UsersApi
53707
- * @version 134.0.0
53880
+ * @version 136.0.0
53708
53881
  */
53709
53882
 
53710
53883
  /**
@@ -56006,7 +56179,7 @@ class UtilitiesApi {
56006
56179
  /**
56007
56180
  * Utilities service.
56008
56181
  * @module purecloud-platform-client-v2/api/UtilitiesApi
56009
- * @version 134.0.0
56182
+ * @version 136.0.0
56010
56183
  */
56011
56184
 
56012
56185
  /**
@@ -56117,7 +56290,7 @@ class VoicemailApi {
56117
56290
  /**
56118
56291
  * Voicemail service.
56119
56292
  * @module purecloud-platform-client-v2/api/VoicemailApi
56120
- * @version 134.0.0
56293
+ * @version 136.0.0
56121
56294
  */
56122
56295
 
56123
56296
  /**
@@ -56784,7 +56957,7 @@ class WebChatApi {
56784
56957
  /**
56785
56958
  * WebChat service.
56786
56959
  * @module purecloud-platform-client-v2/api/WebChatApi
56787
- * @version 134.0.0
56960
+ * @version 136.0.0
56788
56961
  */
56789
56962
 
56790
56963
  /**
@@ -57328,7 +57501,7 @@ class WebDeploymentsApi {
57328
57501
  /**
57329
57502
  * WebDeployments service.
57330
57503
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
57331
- * @version 134.0.0
57504
+ * @version 136.0.0
57332
57505
  */
57333
57506
 
57334
57507
  /**
@@ -57683,7 +57856,7 @@ class WebMessagingApi {
57683
57856
  /**
57684
57857
  * WebMessaging service.
57685
57858
  * @module purecloud-platform-client-v2/api/WebMessagingApi
57686
- * @version 134.0.0
57859
+ * @version 136.0.0
57687
57860
  */
57688
57861
 
57689
57862
  /**
@@ -57729,7 +57902,7 @@ class WidgetsApi {
57729
57902
  /**
57730
57903
  * Widgets service.
57731
57904
  * @module purecloud-platform-client-v2/api/WidgetsApi
57732
- * @version 134.0.0
57905
+ * @version 136.0.0
57733
57906
  */
57734
57907
 
57735
57908
  /**
@@ -57875,7 +58048,7 @@ class WorkforceManagementApi {
57875
58048
  /**
57876
58049
  * WorkforceManagement service.
57877
58050
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
57878
- * @version 134.0.0
58051
+ * @version 136.0.0
57879
58052
  */
57880
58053
 
57881
58054
  /**
@@ -58073,7 +58246,7 @@ class WorkforceManagementApi {
58073
58246
  /**
58074
58247
  * Delete a short term forecast
58075
58248
  * Must not be tied to any schedules
58076
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
58249
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
58077
58250
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
58078
58251
  * @param {String} forecastId The ID of the forecast
58079
58252
  */
@@ -58153,7 +58326,7 @@ class WorkforceManagementApi {
58153
58326
  /**
58154
58327
  * Deletes a time off limit object
58155
58328
  *
58156
- * @param {String} managementUnitId The management unit ID of the management unit.
58329
+ * @param {String} managementUnitId The ID of the management unit.
58157
58330
  * @param {String} timeOffLimitId The ID of the time off limit object to delete
58158
58331
  */
58159
58332
  deleteWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
@@ -58183,7 +58356,7 @@ class WorkforceManagementApi {
58183
58356
  /**
58184
58357
  * Deletes a time off plan
58185
58358
  *
58186
- * @param {String} managementUnitId The management unit ID.
58359
+ * @param {String} managementUnitId The ID of the management unit
58187
58360
  * @param {String} timeOffPlanId The ID of the time off plan to delete
58188
58361
  */
58189
58362
  deleteWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
@@ -58452,7 +58625,7 @@ class WorkforceManagementApi {
58452
58625
  /**
58453
58626
  * Get intraday planning groups for the given date
58454
58627
  *
58455
- * @param {String} businessUnitId The business unit ID of the business unit
58628
+ * @param {String} businessUnitId The ID of the business unit
58456
58629
  * @param {String} _date yyyy-MM-dd date string interpreted in the configured business unit time zone. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
58457
58630
  */
58458
58631
  getWorkforcemanagementBusinessunitIntradayPlanninggroups(businessUnitId, _date) {
@@ -58905,7 +59078,7 @@ class WorkforceManagementApi {
58905
59078
  /**
58906
59079
  * Get a short term forecast
58907
59080
  *
58908
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
59081
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
58909
59082
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
58910
59083
  * @param {String} forecastId The ID of the forecast
58911
59084
  * @param {Object} opts Optional parameters
@@ -58944,7 +59117,7 @@ class WorkforceManagementApi {
58944
59117
  /**
58945
59118
  * Get the result of a short term forecast calculation
58946
59119
  * Includes modifications unless you pass the doNotApplyModifications query parameter
58947
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
59120
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
58948
59121
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
58949
59122
  * @param {String} forecastId The ID of the forecast
58950
59123
  * @param {Object} opts Optional parameters
@@ -58984,7 +59157,7 @@ class WorkforceManagementApi {
58984
59157
  /**
58985
59158
  * Gets the forecast generation results
58986
59159
  *
58987
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
59160
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
58988
59161
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
58989
59162
  * @param {String} forecastId The ID of the forecast
58990
59163
  */
@@ -59019,7 +59192,7 @@ class WorkforceManagementApi {
59019
59192
  /**
59020
59193
  * Get the result of a long term forecast calculation
59021
59194
  * Includes modifications unless you pass the doNotApplyModifications query parameter
59022
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
59195
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
59023
59196
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
59024
59197
  * @param {String} forecastId The ID of the forecast
59025
59198
  * @param {Object} opts Optional parameters
@@ -59058,7 +59231,7 @@ class WorkforceManagementApi {
59058
59231
  /**
59059
59232
  * Gets the forecast planning group snapshot
59060
59233
  *
59061
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
59234
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
59062
59235
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
59063
59236
  * @param {String} forecastId The ID of the forecast
59064
59237
  */
@@ -59093,7 +59266,7 @@ class WorkforceManagementApi {
59093
59266
  /**
59094
59267
  * Get short term forecasts
59095
59268
  * Use \"recent\" (without quotes) for the `weekDateId` path parameter to fetch all forecasts for +/- 26 weeks from the current date. Response will include any forecast which spans the specified week
59096
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
59269
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
59097
59270
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format or 'recent' (without quotes) to fetch recent forecasts
59098
59271
  */
59099
59272
  getWorkforcemanagementBusinessunitWeekShorttermforecasts(businessUnitId, weekDateId) {
@@ -59311,7 +59484,7 @@ class WorkforceManagementApi {
59311
59484
  /**
59312
59485
  * Get a list of user schedule adherence records for the requested management unit
59313
59486
  *
59314
- * @param {String} managementUnitId The management unit ID of the management unit.
59487
+ * @param {String} managementUnitId The ID of the management unit
59315
59488
  * @param {Object} opts Optional parameters
59316
59489
  * @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
59317
59490
  */
@@ -59340,7 +59513,7 @@ class WorkforceManagementApi {
59340
59513
  /**
59341
59514
  * Get data for agent in the management unit
59342
59515
  *
59343
- * @param {String} managementUnitId The id of the management unit, or 'mine' for the management unit of the logged-in user.
59516
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59344
59517
  * @param {String} agentId The agent id
59345
59518
  * @param {Object} opts Optional parameters
59346
59519
  * @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
@@ -59374,7 +59547,7 @@ class WorkforceManagementApi {
59374
59547
  /**
59375
59548
  * Gets all the shift trades for a given agent
59376
59549
  *
59377
- * @param {String} managementUnitId The id of the management unit, or 'mine' for the management unit of the logged-in user.
59550
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59378
59551
  * @param {String} agentId The agent id
59379
59552
  */
59380
59553
  getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId) {
@@ -59404,7 +59577,7 @@ class WorkforceManagementApi {
59404
59577
  /**
59405
59578
  * Gets a summary of all shift trades in the matched state
59406
59579
  *
59407
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
59580
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59408
59581
  */
59409
59582
  getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId) {
59410
59583
  // verify the required parameter 'managementUnitId' is set
@@ -59429,7 +59602,7 @@ class WorkforceManagementApi {
59429
59602
  /**
59430
59603
  * Gets list of users available for whom you can send direct shift trade requests
59431
59604
  *
59432
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
59605
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59433
59606
  */
59434
59607
  getWorkforcemanagementManagementunitShifttradesUsers(managementUnitId) {
59435
59608
  // verify the required parameter 'managementUnitId' is set
@@ -59454,7 +59627,7 @@ class WorkforceManagementApi {
59454
59627
  /**
59455
59628
  * Gets a time off limit object
59456
59629
  * Returns properties of time off limit object, but not daily values.
59457
- * @param {String} managementUnitId The management unit ID of the management unit.
59630
+ * @param {String} managementUnitId The ID of the management unit.
59458
59631
  * @param {String} timeOffLimitId The ID of the time off limit to fetch
59459
59632
  */
59460
59633
  getWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId) {
@@ -59484,7 +59657,7 @@ class WorkforceManagementApi {
59484
59657
  /**
59485
59658
  * Gets a list of time off limit objects under management unit.
59486
59659
  * Currently only one time off limit object is allowed under management unit, so the list contains either 0 or 1 element.
59487
- * @param {String} managementUnitId The management unit ID of the management unit.
59660
+ * @param {String} managementUnitId The ID of the management unit.
59488
59661
  */
59489
59662
  getWorkforcemanagementManagementunitTimeofflimits(managementUnitId) {
59490
59663
  // verify the required parameter 'managementUnitId' is set
@@ -59509,7 +59682,7 @@ class WorkforceManagementApi {
59509
59682
  /**
59510
59683
  * Gets a time off plan
59511
59684
  *
59512
- * @param {String} managementUnitId The management unit ID.
59685
+ * @param {String} managementUnitId The ID of the management unit
59513
59686
  * @param {String} timeOffPlanId The ID of the time off plan to fetch
59514
59687
  */
59515
59688
  getWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId) {
@@ -59539,7 +59712,7 @@ class WorkforceManagementApi {
59539
59712
  /**
59540
59713
  * Gets a list of time off plans
59541
59714
  *
59542
- * @param {String} managementUnitId The management unit ID.
59715
+ * @param {String} managementUnitId The ID of the management unit
59543
59716
  */
59544
59717
  getWorkforcemanagementManagementunitTimeoffplans(managementUnitId) {
59545
59718
  // verify the required parameter 'managementUnitId' is set
@@ -59564,7 +59737,7 @@ class WorkforceManagementApi {
59564
59737
  /**
59565
59738
  * Get a time off request
59566
59739
  *
59567
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
59740
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59568
59741
  * @param {String} userId The userId to whom the Time Off Request applies.
59569
59742
  * @param {String} timeOffRequestId Time Off Request Id
59570
59743
  */
@@ -59599,7 +59772,7 @@ class WorkforceManagementApi {
59599
59772
  /**
59600
59773
  * Retrieves time off limit, allocated and waitlisted values according to specific time off request
59601
59774
  *
59602
- * @param {String} managementUnitId The management unit ID of the management unit.
59775
+ * @param {String} managementUnitId The ID of the management unit.
59603
59776
  * @param {String} userId The userId to whom the time off request applies.
59604
59777
  * @param {String} timeOffRequestId The ID of the time off request, which dates and activityCodeId determine limit values to retrieve
59605
59778
  */
@@ -59634,7 +59807,7 @@ class WorkforceManagementApi {
59634
59807
  /**
59635
59808
  * Get a list of time off requests for a given user
59636
59809
  *
59637
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
59810
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59638
59811
  * @param {String} userId The userId to whom the Time Off Request applies.
59639
59812
  * @param {Object} opts Optional parameters
59640
59813
  * @param {Boolean} opts.recentlyReviewed Limit results to requests that have been reviewed within the preceding 30 days (default to false)
@@ -59668,7 +59841,7 @@ class WorkforceManagementApi {
59668
59841
  /**
59669
59842
  * Get users in the management unit
59670
59843
  *
59671
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
59844
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59672
59845
  */
59673
59846
  getWorkforcemanagementManagementunitUsers(managementUnitId) {
59674
59847
  // verify the required parameter 'managementUnitId' is set
@@ -59769,7 +59942,7 @@ class WorkforceManagementApi {
59769
59942
  /**
59770
59943
  * Gets all the shift trades for a given week
59771
59944
  *
59772
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
59945
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
59773
59946
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
59774
59947
  * @param {Object} opts Optional parameters
59775
59948
  * @param {Boolean} opts.evaluateMatches Whether to evaluate the matches for violations (default to true)
@@ -60042,7 +60215,7 @@ class WorkforceManagementApi {
60042
60215
  /**
60043
60216
  * Get a time off request for the current user
60044
60217
  *
60045
- * @param {String} timeOffRequestId Time Off Request Id
60218
+ * @param {String} timeOffRequestId The ID of the time off request
60046
60219
  */
60047
60220
  getWorkforcemanagementTimeoffrequest(timeOffRequestId) {
60048
60221
  // verify the required parameter 'timeOffRequestId' is set
@@ -60067,7 +60240,7 @@ class WorkforceManagementApi {
60067
60240
  /**
60068
60241
  * Get the daily waitlist positions of a time off request for the current user
60069
60242
  *
60070
- * @param {String} timeOffRequestId Time Off Request Id
60243
+ * @param {String} timeOffRequestId The ID of the time off request
60071
60244
  */
60072
60245
  getWorkforcemanagementTimeoffrequestWaitlistpositions(timeOffRequestId) {
60073
60246
  // verify the required parameter 'timeOffRequestId' is set
@@ -60310,7 +60483,7 @@ class WorkforceManagementApi {
60310
60483
  /**
60311
60484
  * Updates a time off limit object.
60312
60485
  * Updates time off limit object properties, but not daily values.
60313
- * @param {String} managementUnitId The management unit ID of the management unit.
60486
+ * @param {String} managementUnitId The ID of the management unit.
60314
60487
  * @param {String} timeOffLimitId The id of time off limit object to update
60315
60488
  * @param {Object} opts Optional parameters
60316
60489
  * @param {Object} opts.body body
@@ -60344,7 +60517,7 @@ class WorkforceManagementApi {
60344
60517
  /**
60345
60518
  * Updates a time off plan
60346
60519
  *
60347
- * @param {String} managementUnitId The management unit ID.
60520
+ * @param {String} managementUnitId The ID of the management unit
60348
60521
  * @param {String} timeOffPlanId The ID of the time off plan to update
60349
60522
  * @param {Object} opts Optional parameters
60350
60523
  * @param {Object} opts.body body
@@ -60378,7 +60551,7 @@ class WorkforceManagementApi {
60378
60551
  /**
60379
60552
  * Update a time off request
60380
60553
  *
60381
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
60554
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
60382
60555
  * @param {String} userId The id of the user the requested time off request belongs to
60383
60556
  * @param {String} timeOffRequestId The id of the time off request to update
60384
60557
  * @param {Object} opts Optional parameters
@@ -60417,7 +60590,7 @@ class WorkforceManagementApi {
60417
60590
  /**
60418
60591
  * Updates a shift trade. This route can only be called by the initiating agent
60419
60592
  *
60420
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
60593
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
60421
60594
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
60422
60595
  * @param {Object} body body
60423
60596
  * @param {String} tradeId The ID of the shift trade to update
@@ -60526,7 +60699,7 @@ class WorkforceManagementApi {
60526
60699
  /**
60527
60700
  * Update a time off request for the current user
60528
60701
  *
60529
- * @param {String} timeOffRequestId Time Off Request Id
60702
+ * @param {String} timeOffRequestId The ID of the time off request
60530
60703
  * @param {Object} opts Optional parameters
60531
60704
  * @param {Object} opts.body body
60532
60705
  */
@@ -60663,7 +60836,7 @@ class WorkforceManagementApi {
60663
60836
  /**
60664
60837
  * Get intraday data for the given date for the requested planningGroupIds
60665
60838
  *
60666
- * @param {String} businessUnitId The business unit ID of the business unit
60839
+ * @param {String} businessUnitId The ID of the business unit
60667
60840
  * @param {Object} opts Optional parameters
60668
60841
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
60669
60842
  * @param {Object} opts.body body
@@ -61096,7 +61269,7 @@ class WorkforceManagementApi {
61096
61269
  /**
61097
61270
  * Copy a short term forecast
61098
61271
  *
61099
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
61272
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
61100
61273
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61101
61274
  * @param {String} forecastId The ID of the forecast to copy
61102
61275
  * @param {Object} body body
@@ -61140,7 +61313,7 @@ class WorkforceManagementApi {
61140
61313
  /**
61141
61314
  * Generate a short term forecast
61142
61315
  *
61143
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
61316
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
61144
61317
  * @param {String} weekDateId The week start date of the forecast in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61145
61318
  * @param {Object} body
61146
61319
  * @param {Object} opts Optional parameters
@@ -61179,7 +61352,7 @@ class WorkforceManagementApi {
61179
61352
  /**
61180
61353
  * Starts importing the uploaded short term forecast
61181
61354
  * Call after uploading the forecast data to the url supplied by the /import/uploadurl route
61182
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
61355
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
61183
61356
  * @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61184
61357
  * @param {Object} body
61185
61358
  */
@@ -61214,7 +61387,7 @@ class WorkforceManagementApi {
61214
61387
  /**
61215
61388
  * Creates a signed upload URL for importing a short term forecast
61216
61389
  * Once the upload is complete, call the /import route to start the short term forecast import process
61217
- * @param {String} businessUnitId The business unit ID of the business unit to which the forecast belongs
61390
+ * @param {String} businessUnitId The ID of the business unit to which the forecast belongs
61218
61391
  * @param {String} weekDateId First day of schedule week in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61219
61392
  * @param {Object} body body
61220
61393
  */
@@ -61341,7 +61514,7 @@ class WorkforceManagementApi {
61341
61514
  /**
61342
61515
  * Query published schedules for given given time range for set of users
61343
61516
  *
61344
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
61517
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61345
61518
  * @param {Object} opts Optional parameters
61346
61519
  * @param {Object} opts.body body
61347
61520
  * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
@@ -61372,7 +61545,7 @@ class WorkforceManagementApi {
61372
61545
  /**
61373
61546
  * Request a historical adherence report
61374
61547
  * The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
61375
- * @param {String} managementUnitId The management unit ID of the management unit
61548
+ * @param {String} managementUnitId The ID of the management unit
61376
61549
  * @param {Object} opts Optional parameters
61377
61550
  * @param {Object} opts.body body
61378
61551
  */
@@ -61430,7 +61603,7 @@ class WorkforceManagementApi {
61430
61603
  /**
61431
61604
  * Query published schedules for given given time range for set of users
61432
61605
  *
61433
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
61606
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61434
61607
  * @param {Object} opts Optional parameters
61435
61608
  * @param {Object} opts.body body
61436
61609
  */
@@ -61459,7 +61632,7 @@ class WorkforceManagementApi {
61459
61632
  /**
61460
61633
  * Creates a new time off limit object under management unit.
61461
61634
  * Only one limit object is allowed under management unit, so an attempt to create second object will fail.
61462
- * @param {String} managementUnitId The management unit ID of the management unit.
61635
+ * @param {String} managementUnitId The ID of the management unit.
61463
61636
  * @param {Object} opts Optional parameters
61464
61637
  * @param {Object} opts.body body
61465
61638
  */
@@ -61488,7 +61661,7 @@ class WorkforceManagementApi {
61488
61661
  /**
61489
61662
  * Retrieves time off limit related values based on a given set of filters.
61490
61663
  *
61491
- * @param {String} managementUnitId The management unit ID of the management unit.
61664
+ * @param {String} managementUnitId The ID of the management unit.
61492
61665
  * @param {Object} opts Optional parameters
61493
61666
  * @param {Object} opts.body body
61494
61667
  */
@@ -61517,7 +61690,7 @@ class WorkforceManagementApi {
61517
61690
  /**
61518
61691
  * Creates a new time off plan
61519
61692
  *
61520
- * @param {String} managementUnitId The management unit ID.
61693
+ * @param {String} managementUnitId The ID of the management unit
61521
61694
  * @param {Object} opts Optional parameters
61522
61695
  * @param {Object} opts.body body
61523
61696
  */
@@ -61546,7 +61719,7 @@ class WorkforceManagementApi {
61546
61719
  /**
61547
61720
  * Create a new time off request
61548
61721
  *
61549
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
61722
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61550
61723
  * @param {Object} opts Optional parameters
61551
61724
  * @param {Object} opts.body body
61552
61725
  */
@@ -61575,7 +61748,7 @@ class WorkforceManagementApi {
61575
61748
  /**
61576
61749
  * Fetches time off requests matching the conditions specified in the request body
61577
61750
  * Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
61578
- * @param {String} managementUnitId The muId of the management unit, or 'mine' for the management unit of the logged-in user.
61751
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61579
61752
  * @param {Object} opts Optional parameters
61580
61753
  * @param {Object} opts.body body
61581
61754
  */
@@ -61604,7 +61777,7 @@ class WorkforceManagementApi {
61604
61777
  /**
61605
61778
  * Retrieves daily waitlist position for a list of time off requests
61606
61779
  *
61607
- * @param {String} managementUnitId The management unit ID of the management unit.
61780
+ * @param {String} managementUnitId The ID of the management unit.
61608
61781
  * @param {Object} opts Optional parameters
61609
61782
  * @param {Object} opts.body body
61610
61783
  */
@@ -61633,7 +61806,7 @@ class WorkforceManagementApi {
61633
61806
  /**
61634
61807
  * Matches a shift trade. This route can only be called by the receiving agent
61635
61808
  *
61636
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
61809
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61637
61810
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61638
61811
  * @param {Object} body body
61639
61812
  * @param {String} tradeId The ID of the shift trade to update
@@ -61673,7 +61846,7 @@ class WorkforceManagementApi {
61673
61846
  /**
61674
61847
  * Adds a shift trade
61675
61848
  *
61676
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
61849
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61677
61850
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61678
61851
  * @param {Object} body body
61679
61852
  */
@@ -61708,7 +61881,7 @@ class WorkforceManagementApi {
61708
61881
  /**
61709
61882
  * Searches for potential shift trade matches for the current agent
61710
61883
  *
61711
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
61884
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61712
61885
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61713
61886
  * @param {Object} body body
61714
61887
  */
@@ -61743,7 +61916,7 @@ class WorkforceManagementApi {
61743
61916
  /**
61744
61917
  * Updates the state of a batch of shift trades
61745
61918
  * Admin functionality is not supported with \"mine\".
61746
- * @param {String} managementUnitId The management unit ID of the management unit, or 'mine' for the management unit of the logged-in user.
61919
+ * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
61747
61920
  * @param {String} weekDateId The start date of the week schedule in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
61748
61921
  * @param {Object} body body
61749
61922
  * @param {Object} opts Optional parameters
@@ -62064,7 +62237,7 @@ class WorkforceManagementApi {
62064
62237
  /**
62065
62238
  * Sets daily values for a date range of time off limit object
62066
62239
  * Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
62067
- * @param {String} managementUnitId The management unit ID of the management unit.
62240
+ * @param {String} managementUnitId The ID of the management unit.
62068
62241
  * @param {String} timeOffLimitId The ID of the time off limit object to set values for
62069
62242
  * @param {Object} opts Optional parameters
62070
62243
  * @param {Object} opts.body body
@@ -62126,7 +62299,7 @@ class WorkforceManagementApi {
62126
62299
  * </pre>
62127
62300
  * </p>
62128
62301
  * @module purecloud-platform-client-v2/index
62129
- * @version 134.0.0
62302
+ * @version 136.0.0
62130
62303
  */
62131
62304
  class platformClient {
62132
62305
  constructor() {