purecloud-platform-client-v2 131.1.0 → 133.0.1

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 +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +122 -84
  3. package/dist/web-amd/purecloud-platform-client-v2.js +123 -85
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +128 -90
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +3775 -945
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +245 -11
  9. package/package.json +9 -9
  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 +27 -2
  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 +7 -3
  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 +1 -1
  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 +7 -3
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +4 -4
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +8 -5
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  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 +1 -1
  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 +2 -2
  73. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -1,6 +1,8 @@
1
- define(['superagent'], function (superagent) { 'use strict';
1
+ define(['superagent'], (function (superagent) { 'use strict';
2
2
 
3
- superagent = superagent && superagent.hasOwnProperty('default') ? superagent['default'] : superagent;
3
+ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
4
+
5
+ var superagent__default = /*#__PURE__*/_interopDefaultLegacy(superagent);
4
6
 
5
7
  var PureCloudRegionHosts = {
6
8
  us_east_1: 'mypurecloud.com',
@@ -391,7 +393,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
391
393
 
392
394
  /**
393
395
  * @module purecloud-platform-client-v2/ApiClient
394
- * @version 131.1.0
396
+ * @version 133.0.1
395
397
  */
396
398
  class ApiClient {
397
399
  /**
@@ -495,7 +497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
495
497
  this.settingsPrefix = 'purecloud';
496
498
 
497
499
  // Expose superagent module for use with superagent-proxy
498
- this.superagent = superagent;
500
+ this.superagent = superagent__default["default"];
499
501
 
500
502
  // Transparently request a new access token when it expires (Code Authorization only)
501
503
  this.refreshInProgress = false;
@@ -666,7 +668,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
666
668
  }
667
669
 
668
670
  // Build token request
669
- var request = superagent('POST', `https://login.${this.config.environment}/oauth/token`);
671
+ var request = superagent__default["default"]('POST', `https://login.${this.config.environment}/oauth/token`);
670
672
  if (this.proxy && request.proxy) {
671
673
  request.proxy(this.proxy);
672
674
  }
@@ -922,7 +924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
922
924
  * @param {string} encodedData - Base64 encoded client and clientSecret pair
923
925
  */
924
926
  _formAuthRequest(encodedData) {
925
- var request = superagent('POST', `https://login.${this.config.environment}/oauth/token`);
927
+ var request = superagent__default["default"]('POST', `https://login.${this.config.environment}/oauth/token`);
926
928
  // Set the headers
927
929
  request.set('Authorization', 'Basic ' + encodedData);
928
930
  request.set('Content-Type', 'application/x-www-form-urlencoded');
@@ -1324,7 +1326,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1324
1326
  sendRequest(this);
1325
1327
  function sendRequest(that) {
1326
1328
  var url = that.buildUrl(path, pathParams);
1327
- var request = superagent(httpMethod, url);
1329
+ var request = superagent__default["default"](httpMethod, url);
1328
1330
 
1329
1331
  if (that.proxy && request.proxy) {
1330
1332
  request.proxy(that.proxy);
@@ -1338,7 +1340,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1338
1340
 
1339
1341
  // set header parameters
1340
1342
  request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
1341
- //request.set({ 'purecloud-sdk': '131.1.0' });
1343
+ //request.set({ 'purecloud-sdk': '133.0.1' });
1342
1344
 
1343
1345
  // set request timeout
1344
1346
  request.timeout(that.timeout);
@@ -1438,7 +1440,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1438
1440
  /**
1439
1441
  * Alerting service.
1440
1442
  * @module purecloud-platform-client-v2/api/AlertingApi
1441
- * @version 131.1.0
1443
+ * @version 133.0.1
1442
1444
  */
1443
1445
 
1444
1446
  /**
@@ -1752,7 +1754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1752
1754
  /**
1753
1755
  * Analytics service.
1754
1756
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1755
- * @version 131.1.0
1757
+ * @version 133.0.1
1756
1758
  */
1757
1759
 
1758
1760
  /**
@@ -2934,7 +2936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2934
2936
  /**
2935
2937
  * Architect service.
2936
2938
  * @module purecloud-platform-client-v2/api/ArchitectApi
2937
- * @version 131.1.0
2939
+ * @version 133.0.1
2938
2940
  */
2939
2941
 
2940
2942
  /**
@@ -5930,7 +5932,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5930
5932
  /**
5931
5933
  * Audit service.
5932
5934
  * @module purecloud-platform-client-v2/api/AuditApi
5933
- * @version 131.1.0
5935
+ * @version 133.0.1
5934
5936
  */
5935
5937
 
5936
5938
  /**
@@ -6101,7 +6103,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
6101
6103
  /**
6102
6104
  * Authorization service.
6103
6105
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6104
- * @version 131.1.0
6106
+ * @version 133.0.1
6105
6107
  */
6106
6108
 
6107
6109
  /**
@@ -7284,7 +7286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7284
7286
  /**
7285
7287
  * Billing service.
7286
7288
  * @module purecloud-platform-client-v2/api/BillingApi
7287
- * @version 131.1.0
7289
+ * @version 133.0.1
7288
7290
  */
7289
7291
 
7290
7292
  /**
@@ -7364,7 +7366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7364
7366
  /**
7365
7367
  * Chat service.
7366
7368
  * @module purecloud-platform-client-v2/api/ChatApi
7367
- * @version 131.1.0
7369
+ * @version 133.0.1
7368
7370
  */
7369
7371
 
7370
7372
  /**
@@ -7455,7 +7457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
7455
7457
  /**
7456
7458
  * Coaching service.
7457
7459
  * @module purecloud-platform-client-v2/api/CoachingApi
7458
- * @version 131.1.0
7460
+ * @version 133.0.1
7459
7461
  */
7460
7462
 
7461
7463
  /**
@@ -8032,7 +8034,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
8032
8034
  /**
8033
8035
  * ContentManagement service.
8034
8036
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8035
- * @version 131.1.0
8037
+ * @version 133.0.1
8036
8038
  */
8037
8039
 
8038
8040
  /**
@@ -9172,7 +9174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9172
9174
  /**
9173
9175
  * Conversations service.
9174
9176
  * @module purecloud-platform-client-v2/api/ConversationsApi
9175
- * @version 131.1.0
9177
+ * @version 133.0.1
9176
9178
  */
9177
9179
 
9178
9180
  /**
@@ -10503,6 +10505,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10503
10505
  );
10504
10506
  }
10505
10507
 
10508
+ /**
10509
+ * Get emails settings for a given conversation
10510
+ *
10511
+ * @param {String} conversationId conversationId
10512
+ */
10513
+ getConversationsEmailSettings(conversationId) {
10514
+ // verify the required parameter 'conversationId' is set
10515
+ if (conversationId === undefined || conversationId === null) {
10516
+ throw 'Missing the required parameter "conversationId" when calling getConversationsEmailSettings';
10517
+ }
10518
+
10519
+ return this.apiClient.callApi(
10520
+ '/api/v2/conversations/emails/{conversationId}/settings',
10521
+ 'GET',
10522
+ { 'conversationId': conversationId },
10523
+ { },
10524
+ { },
10525
+ { },
10526
+ null,
10527
+ ['PureCloud OAuth'],
10528
+ ['application/json'],
10529
+ ['application/json']
10530
+ );
10531
+ }
10532
+
10506
10533
  /**
10507
10534
  * Get active email conversations for the logged in user
10508
10535
  *
@@ -13322,7 +13349,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13322
13349
 
13323
13350
  /**
13324
13351
  * Send an agentless outbound message
13325
- * Send an agentlesss (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. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
13352
+ * 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. This will generate a new Conversation, if there is an existing active Conversation between the fromAddress and toAddress already, then this POST will fail.
13326
13353
  * @param {Object} body Create agentless outbound messaging request
13327
13354
  */
13328
13355
  postConversationsMessagesAgentless(body) {
@@ -13736,7 +13763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13736
13763
  /**
13737
13764
  * DataExtensions service.
13738
13765
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
13739
- * @version 131.1.0
13766
+ * @version 133.0.1
13740
13767
  */
13741
13768
 
13742
13769
  /**
@@ -13822,7 +13849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13822
13849
  /**
13823
13850
  * ExternalContacts service.
13824
13851
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
13825
- * @version 131.1.0
13852
+ * @version 133.0.1
13826
13853
  */
13827
13854
 
13828
13855
  /**
@@ -15565,7 +15592,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15565
15592
  /**
15566
15593
  * Fax service.
15567
15594
  * @module purecloud-platform-client-v2/api/FaxApi
15568
- * @version 131.1.0
15595
+ * @version 133.0.1
15569
15596
  */
15570
15597
 
15571
15598
  /**
@@ -15736,7 +15763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15736
15763
  /**
15737
15764
  * Flows service.
15738
15765
  * @module purecloud-platform-client-v2/api/FlowsApi
15739
- * @version 131.1.0
15766
+ * @version 133.0.1
15740
15767
  */
15741
15768
 
15742
15769
  /**
@@ -15807,7 +15834,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
15807
15834
  /**
15808
15835
  * Gamification service.
15809
15836
  * @module purecloud-platform-client-v2/api/GamificationApi
15810
- * @version 131.1.0
15837
+ * @version 133.0.1
15811
15838
  */
15812
15839
 
15813
15840
  /**
@@ -17083,8 +17110,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17083
17110
  * Create a new custom performance profile
17084
17111
  *
17085
17112
  * @param {Object} body performanceProfile
17113
+ * @param {Object} opts Optional parameters
17114
+ * @param {Boolean} opts.copyMetrics Flag to copy metrics. If set to false, there will be no metrics associated with the new profile. If set to true or is absent (the default behavior), all metrics from the default profile will be copied over into the new profile. (default to true)
17086
17115
  */
17087
- postGamificationProfiles(body) {
17116
+ postGamificationProfiles(body, opts) {
17117
+ opts = opts || {};
17118
+
17088
17119
  // verify the required parameter 'body' is set
17089
17120
  if (body === undefined || body === null) {
17090
17121
  throw 'Missing the required parameter "body" when calling postGamificationProfiles';
@@ -17094,7 +17125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17094
17125
  '/api/v2/gamification/profiles',
17095
17126
  'POST',
17096
17127
  { },
17097
- { },
17128
+ { 'copyMetrics': opts['copyMetrics'] },
17098
17129
  { },
17099
17130
  { },
17100
17131
  body,
@@ -17233,7 +17264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17233
17264
  /**
17234
17265
  * GeneralDataProtectionRegulation service.
17235
17266
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
17236
- * @version 131.1.0
17267
+ * @version 133.0.1
17237
17268
  */
17238
17269
 
17239
17270
  /**
@@ -17363,7 +17394,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17363
17394
  /**
17364
17395
  * Geolocation service.
17365
17396
  * @module purecloud-platform-client-v2/api/GeolocationApi
17366
- * @version 131.1.0
17397
+ * @version 133.0.1
17367
17398
  */
17368
17399
 
17369
17400
  /**
@@ -17494,7 +17525,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17494
17525
  /**
17495
17526
  * Greetings service.
17496
17527
  * @module purecloud-platform-client-v2/api/GreetingsApi
17497
- * @version 131.1.0
17528
+ * @version 133.0.1
17498
17529
  */
17499
17530
 
17500
17531
  /**
@@ -17949,7 +17980,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17949
17980
  /**
17950
17981
  * Groups service.
17951
17982
  * @module purecloud-platform-client-v2/api/GroupsApi
17952
- * @version 131.1.0
17983
+ * @version 133.0.1
17953
17984
  */
17954
17985
 
17955
17986
  /**
@@ -18354,7 +18385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18354
18385
  /**
18355
18386
  * IdentityProvider service.
18356
18387
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
18357
- * @version 131.1.0
18388
+ * @version 133.0.1
18358
18389
  */
18359
18390
 
18360
18391
  /**
@@ -19110,7 +19141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
19110
19141
  /**
19111
19142
  * Integrations service.
19112
19143
  * @module purecloud-platform-client-v2/api/IntegrationsApi
19113
- * @version 131.1.0
19144
+ * @version 133.0.1
19114
19145
  */
19115
19146
 
19116
19147
  /**
@@ -20785,7 +20816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20785
20816
  /**
20786
20817
  * Journey service.
20787
20818
  * @module purecloud-platform-client-v2/api/JourneyApi
20788
- * @version 131.1.0
20819
+ * @version 133.0.1
20789
20820
  */
20790
20821
 
20791
20822
  /**
@@ -21496,7 +21527,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21496
21527
  /**
21497
21528
  * Knowledge service.
21498
21529
  * @module purecloud-platform-client-v2/api/KnowledgeApi
21499
- * @version 131.1.0
21530
+ * @version 133.0.1
21500
21531
  */
21501
21532
 
21502
21533
  /**
@@ -22396,7 +22427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
22396
22427
  /**
22397
22428
  * LanguageUnderstanding service.
22398
22429
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
22399
- * @version 131.1.0
22430
+ * @version 133.0.1
22400
22431
  */
22401
22432
 
22402
22433
  /**
@@ -23300,7 +23331,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23300
23331
  /**
23301
23332
  * Languages service.
23302
23333
  * @module purecloud-platform-client-v2/api/LanguagesApi
23303
- * @version 131.1.0
23334
+ * @version 133.0.1
23304
23335
  */
23305
23336
 
23306
23337
  /**
@@ -23568,7 +23599,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23568
23599
  /**
23569
23600
  * Learning service.
23570
23601
  * @module purecloud-platform-client-v2/api/LearningApi
23571
- * @version 131.1.0
23602
+ * @version 133.0.1
23572
23603
  */
23573
23604
 
23574
23605
  /**
@@ -24159,7 +24190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24159
24190
  /**
24160
24191
  * License service.
24161
24192
  * @module purecloud-platform-client-v2/api/LicenseApi
24162
- * @version 131.1.0
24193
+ * @version 133.0.1
24163
24194
  */
24164
24195
 
24165
24196
  /**
@@ -24397,7 +24428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24397
24428
  /**
24398
24429
  * Locations service.
24399
24430
  * @module purecloud-platform-client-v2/api/LocationsApi
24400
- * @version 131.1.0
24431
+ * @version 133.0.1
24401
24432
  */
24402
24433
 
24403
24434
  /**
@@ -24633,7 +24664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24633
24664
  /**
24634
24665
  * Messaging service.
24635
24666
  * @module purecloud-platform-client-v2/api/MessagingApi
24636
- * @version 131.1.0
24667
+ * @version 133.0.1
24637
24668
  */
24638
24669
 
24639
24670
  /**
@@ -24784,7 +24815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24784
24815
  /**
24785
24816
  * MobileDevices service.
24786
24817
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
24787
- * @version 131.1.0
24818
+ * @version 133.0.1
24788
24819
  */
24789
24820
 
24790
24821
  /**
@@ -24935,7 +24966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
24935
24966
  /**
24936
24967
  * Notifications service.
24937
24968
  * @module purecloud-platform-client-v2/api/NotificationsApi
24938
- * @version 131.1.0
24969
+ * @version 133.0.1
24939
24970
  */
24940
24971
 
24941
24972
  /**
@@ -25160,7 +25191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25160
25191
  /**
25161
25192
  * OAuth service.
25162
25193
  * @module purecloud-platform-client-v2/api/OAuthApi
25163
- * @version 131.1.0
25194
+ * @version 133.0.1
25164
25195
  */
25165
25196
 
25166
25197
  /**
@@ -25518,7 +25549,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25518
25549
  /**
25519
25550
  * Objects service.
25520
25551
  * @module purecloud-platform-client-v2/api/ObjectsApi
25521
- * @version 131.1.0
25552
+ * @version 133.0.1
25522
25553
  */
25523
25554
 
25524
25555
  /**
@@ -25789,7 +25820,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25789
25820
  /**
25790
25821
  * Organization service.
25791
25822
  * @module purecloud-platform-client-v2/api/OrganizationApi
25792
- * @version 131.1.0
25823
+ * @version 133.0.1
25793
25824
  */
25794
25825
 
25795
25826
  /**
@@ -26192,7 +26223,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26192
26223
  /**
26193
26224
  * OrganizationAuthorization service.
26194
26225
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
26195
- * @version 131.1.0
26226
+ * @version 133.0.1
26196
26227
  */
26197
26228
 
26198
26229
  /**
@@ -27117,7 +27148,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27117
27148
  /**
27118
27149
  * Outbound service.
27119
27150
  * @module purecloud-platform-client-v2/api/OutboundApi
27120
- * @version 131.1.0
27151
+ * @version 133.0.1
27121
27152
  */
27122
27153
 
27123
27154
  /**
@@ -29502,8 +29533,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29502
29533
  * Only Internal DNC lists may be appended to
29503
29534
  * @param {String} dncListId DncList ID
29504
29535
  * @param {Array.<Object>} body DNC Phone Numbers
29536
+ * @param {Object} opts Optional parameters
29537
+ * @param {String} opts.expirationDateTime Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format
29505
29538
  */
29506
- postOutboundDnclistPhonenumbers(dncListId, body) {
29539
+ postOutboundDnclistPhonenumbers(dncListId, body, opts) {
29540
+ opts = opts || {};
29541
+
29507
29542
  // verify the required parameter 'dncListId' is set
29508
29543
  if (dncListId === undefined || dncListId === null) {
29509
29544
  throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistPhonenumbers';
@@ -29517,7 +29552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
29517
29552
  '/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
29518
29553
  'POST',
29519
29554
  { 'dncListId': dncListId },
29520
- { },
29555
+ { 'expirationDateTime': opts['expirationDateTime'] },
29521
29556
  { },
29522
29557
  { },
29523
29558
  body,
@@ -30143,7 +30178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30143
30178
  /**
30144
30179
  * Presence service.
30145
30180
  * @module purecloud-platform-client-v2/api/PresenceApi
30146
- * @version 131.1.0
30181
+ * @version 133.0.1
30147
30182
  */
30148
30183
 
30149
30184
  /**
@@ -30515,7 +30550,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30515
30550
  /**
30516
30551
  * Quality service.
30517
30552
  * @module purecloud-platform-client-v2/api/QualityApi
30518
- * @version 131.1.0
30553
+ * @version 133.0.1
30519
30554
  */
30520
30555
 
30521
30556
  /**
@@ -30566,7 +30601,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30566
30601
  * @param {String} conversationId conversationId
30567
30602
  * @param {String} evaluationId evaluationId
30568
30603
  * @param {Object} opts Optional parameters
30569
- * @param {String} opts.expand evaluatorId
30604
+ * @param {String} opts.expand evaluatorId, evaluationForm
30570
30605
  */
30571
30606
  deleteQualityConversationEvaluation(conversationId, evaluationId, opts) {
30572
30607
  opts = opts || {};
@@ -30671,7 +30706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30671
30706
 
30672
30707
  /**
30673
30708
  * Gets a list of Agent Activities
30674
- * Includes the number of evaluations and average evaluation score. These statistics include released evaluations only when evaluatorUserId is provided. In the absence of evaluatorUserId in the request, the api excludes evaluations which are set to never release for the calculation of evaluation statistics.
30709
+ * Each item on the list shows one agent&#39;s evaluation activity comprised of the number of evaluations and the highest, average, and lowest standard and critical scores, as well as a sub list showing the number and average score of evaluations for each evaluator for that agent. evaluatorUserId, startTime, and endTime are all filtering criteria. If specified, the only evaluations used to compile the agent activity response will be ones that match the filtering criteria. agentUserId, name, group, and agentTeamId are all agent selection criteria. criteria. If one or more agent selection criteria are specified, then the returned activity will include users that match the criteria even if those users did not have any agent activity or evaluations that do not match any filtering criteria. If no agent selection criteria are specified but an evaluatorUserId is, then the returned activity will be only for those agents that had evaluations where the evaluator is the evaluatorUserId. If no agent selection criteria are specified and no evaluatorUserId is specified, then the returned activity will be for all users
30675
30710
  * @param {Object} opts Optional parameters
30676
30711
  * @param {Number} opts.pageSize The total page size requested (default to 25)
30677
30712
  * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -31935,7 +31970,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31935
31970
  * @param {String} evaluationId evaluationId
31936
31971
  * @param {Object} body evaluation
31937
31972
  * @param {Object} opts Optional parameters
31938
- * @param {String} opts.expand evaluatorId
31973
+ * @param {String} opts.expand evaluatorId, evaluationForm
31939
31974
  */
31940
31975
  putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
31941
31976
  opts = opts || {};
@@ -32093,7 +32128,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32093
32128
  /**
32094
32129
  * Recording service.
32095
32130
  * @module purecloud-platform-client-v2/api/RecordingApi
32096
- * @version 131.1.0
32131
+ * @version 133.0.1
32097
32132
  */
32098
32133
 
32099
32134
  /**
@@ -32306,6 +32341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32306
32341
  * @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
32307
32342
  * @param {String} opts.fileName the name of the downloaded fileName
32308
32343
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
32344
+ * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
32309
32345
  */
32310
32346
  getConversationRecording(conversationId, recordingId, opts) {
32311
32347
  opts = opts || {};
@@ -32323,7 +32359,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32323
32359
  '/api/v2/conversations/{conversationId}/recordings/{recordingId}',
32324
32360
  'GET',
32325
32361
  { 'conversationId': conversationId,'recordingId': recordingId },
32326
- { 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
32362
+ { 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
32327
32363
  { },
32328
32364
  { },
32329
32365
  null,
@@ -32459,7 +32495,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32459
32495
  * @param {String} conversationId Conversation ID
32460
32496
  * @param {Object} opts Optional parameters
32461
32497
  * @param {Number} opts.maxWaitMs The maximum number of milliseconds to wait for the recording to be ready. Must be a positive value. (default to 5000)
32462
- * @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
32498
+ * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
32499
+ * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
32463
32500
  */
32464
32501
  getConversationRecordings(conversationId, opts) {
32465
32502
  opts = opts || {};
@@ -32473,7 +32510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32473
32510
  '/api/v2/conversations/{conversationId}/recordings',
32474
32511
  'GET',
32475
32512
  { 'conversationId': conversationId },
32476
- { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'] },
32513
+ { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
32477
32514
  { },
32478
32515
  { },
32479
32516
  null,
@@ -32520,6 +32557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32520
32557
  * @param {Boolean} opts.download requesting a download format of the recording (default to false)
32521
32558
  * @param {String} opts.fileName the name of the downloaded fileName
32522
32559
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
32560
+ * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
32523
32561
  */
32524
32562
  getOrphanrecordingMedia(orphanId, opts) {
32525
32563
  opts = opts || {};
@@ -32533,7 +32571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
32533
32571
  '/api/v2/orphanrecordings/{orphanId}/media',
32534
32572
  'GET',
32535
32573
  { 'orphanId': orphanId },
32536
- { 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
32574
+ { 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
32537
32575
  { },
32538
32576
  { },
32539
32577
  null,
@@ -33616,7 +33654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33616
33654
  /**
33617
33655
  * ResponseManagement service.
33618
33656
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
33619
- * @version 131.1.0
33657
+ * @version 133.0.1
33620
33658
  */
33621
33659
 
33622
33660
  /**
@@ -33941,7 +33979,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
33941
33979
  /**
33942
33980
  * Routing service.
33943
33981
  * @module purecloud-platform-client-v2/api/RoutingApi
33944
- * @version 131.1.0
33982
+ * @version 133.0.1
33945
33983
  */
33946
33984
 
33947
33985
  /**
@@ -36864,7 +36902,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36864
36902
  /**
36865
36903
  * SCIM service.
36866
36904
  * @module purecloud-platform-client-v2/api/SCIMApi
36867
- * @version 131.1.0
36905
+ * @version 133.0.1
36868
36906
  */
36869
36907
 
36870
36908
  /**
@@ -37741,7 +37779,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37741
37779
  /**
37742
37780
  * Scripts service.
37743
37781
  * @module purecloud-platform-client-v2/api/ScriptsApi
37744
- * @version 131.1.0
37782
+ * @version 133.0.1
37745
37783
  */
37746
37784
 
37747
37785
  /**
@@ -38094,7 +38132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38094
38132
  /**
38095
38133
  * Search service.
38096
38134
  * @module purecloud-platform-client-v2/api/SearchApi
38097
- * @version 131.1.0
38135
+ * @version 133.0.1
38098
38136
  */
38099
38137
 
38100
38138
  /**
@@ -38629,7 +38667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38629
38667
  /**
38630
38668
  * SpeechTextAnalytics service.
38631
38669
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
38632
- * @version 131.1.0
38670
+ * @version 133.0.1
38633
38671
  */
38634
38672
 
38635
38673
  /**
@@ -39482,7 +39520,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39482
39520
  /**
39483
39521
  * Stations service.
39484
39522
  * @module purecloud-platform-client-v2/api/StationsApi
39485
- * @version 131.1.0
39523
+ * @version 133.0.1
39486
39524
  */
39487
39525
 
39488
39526
  /**
@@ -39629,7 +39667,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39629
39667
  /**
39630
39668
  * Suggest service.
39631
39669
  * @module purecloud-platform-client-v2/api/SuggestApi
39632
- * @version 131.1.0
39670
+ * @version 133.0.1
39633
39671
  */
39634
39672
 
39635
39673
  /**
@@ -39768,7 +39806,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39768
39806
  /**
39769
39807
  * Telephony service.
39770
39808
  * @module purecloud-platform-client-v2/api/TelephonyApi
39771
- * @version 131.1.0
39809
+ * @version 133.0.1
39772
39810
  */
39773
39811
 
39774
39812
  /**
@@ -39876,7 +39914,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39876
39914
  /**
39877
39915
  * TelephonyProvidersEdge service.
39878
39916
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
39879
- * @version 131.1.0
39917
+ * @version 133.0.1
39880
39918
  */
39881
39919
 
39882
39920
  /**
@@ -43509,7 +43547,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43509
43547
  /**
43510
43548
  * Textbots service.
43511
43549
  * @module purecloud-platform-client-v2/api/TextbotsApi
43512
- * @version 131.1.0
43550
+ * @version 133.0.1
43513
43551
  */
43514
43552
 
43515
43553
  /**
@@ -43637,7 +43675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43637
43675
  /**
43638
43676
  * Tokens service.
43639
43677
  * @module purecloud-platform-client-v2/api/TokensApi
43640
- * @version 131.1.0
43678
+ * @version 133.0.1
43641
43679
  */
43642
43680
 
43643
43681
  /**
@@ -43743,7 +43781,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43743
43781
  /**
43744
43782
  * Uploads service.
43745
43783
  * @module purecloud-platform-client-v2/api/UploadsApi
43746
- * @version 131.1.0
43784
+ * @version 133.0.1
43747
43785
  */
43748
43786
 
43749
43787
  /**
@@ -43919,7 +43957,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43919
43957
  /**
43920
43958
  * Usage service.
43921
43959
  * @module purecloud-platform-client-v2/api/UsageApi
43922
- * @version 131.1.0
43960
+ * @version 133.0.1
43923
43961
  */
43924
43962
 
43925
43963
  /**
@@ -43990,7 +44028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
43990
44028
  /**
43991
44029
  * UserRecordings service.
43992
44030
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
43993
- * @version 131.1.0
44031
+ * @version 133.0.1
43994
44032
  */
43995
44033
 
43996
44034
  /**
@@ -44174,7 +44212,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
44174
44212
  /**
44175
44213
  * Users service.
44176
44214
  * @module purecloud-platform-client-v2/api/UsersApi
44177
- * @version 131.1.0
44215
+ * @version 133.0.1
44178
44216
  */
44179
44217
 
44180
44218
  /**
@@ -46476,7 +46514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46476
46514
  /**
46477
46515
  * Utilities service.
46478
46516
  * @module purecloud-platform-client-v2/api/UtilitiesApi
46479
- * @version 131.1.0
46517
+ * @version 133.0.1
46480
46518
  */
46481
46519
 
46482
46520
  /**
@@ -46587,7 +46625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46587
46625
  /**
46588
46626
  * Voicemail service.
46589
46627
  * @module purecloud-platform-client-v2/api/VoicemailApi
46590
- * @version 131.1.0
46628
+ * @version 133.0.1
46591
46629
  */
46592
46630
 
46593
46631
  /**
@@ -47254,7 +47292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47254
47292
  /**
47255
47293
  * WebChat service.
47256
47294
  * @module purecloud-platform-client-v2/api/WebChatApi
47257
- * @version 131.1.0
47295
+ * @version 133.0.1
47258
47296
  */
47259
47297
 
47260
47298
  /**
@@ -47798,7 +47836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47798
47836
  /**
47799
47837
  * WebDeployments service.
47800
47838
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
47801
- * @version 131.1.0
47839
+ * @version 133.0.1
47802
47840
  */
47803
47841
 
47804
47842
  /**
@@ -48153,7 +48191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48153
48191
  /**
48154
48192
  * WebMessaging service.
48155
48193
  * @module purecloud-platform-client-v2/api/WebMessagingApi
48156
- * @version 131.1.0
48194
+ * @version 133.0.1
48157
48195
  */
48158
48196
 
48159
48197
  /**
@@ -48199,7 +48237,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48199
48237
  /**
48200
48238
  * Widgets service.
48201
48239
  * @module purecloud-platform-client-v2/api/WidgetsApi
48202
- * @version 131.1.0
48240
+ * @version 133.0.1
48203
48241
  */
48204
48242
 
48205
48243
  /**
@@ -48345,7 +48383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48345
48383
  /**
48346
48384
  * WorkforceManagement service.
48347
48385
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
48348
- * @version 131.1.0
48386
+ * @version 133.0.1
48349
48387
  */
48350
48388
 
48351
48389
  /**
@@ -50446,7 +50484,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50446
50484
 
50447
50485
  /**
50448
50486
  * Get a list of notifications for the current user
50449
- *
50487
+ * Notifications are only initially sent if you have the relevant Notify and Edit permissions
50450
50488
  */
50451
50489
  getWorkforcemanagementNotifications() {
50452
50490
 
@@ -52376,7 +52414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52376
52414
  * </pre>
52377
52415
  * </p>
52378
52416
  * @module purecloud-platform-client-v2/index
52379
- * @version 131.1.0
52417
+ * @version 133.0.1
52380
52418
  */
52381
52419
  class platformClient {
52382
52420
  constructor() {
@@ -52715,4 +52753,4 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
52715
52753
 
52716
52754
  return index;
52717
52755
 
52718
- });
52756
+ }));