purecloud-platform-client-v2 131.0.0 → 133.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 +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +220 -87
  3. package/dist/web-amd/purecloud-platform-client-v2.js +221 -88
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +226 -93
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +4099 -1174
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +417 -39
  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 +46 -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 +3 -3
  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 +54 -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 +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 +2 -2
  73. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -1,8 +1,10 @@
1
1
  'use strict';
2
2
 
3
- function _interopDefault (ex) { return (ex && (typeof ex === 'object') && 'default' in ex) ? ex['default'] : ex; }
3
+ var superagent = require('superagent');
4
4
 
5
- var superagent = _interopDefault(require('superagent'));
5
+ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
6
+
7
+ var superagent__default = /*#__PURE__*/_interopDefaultLegacy(superagent);
6
8
 
7
9
  var PureCloudRegionHosts = {
8
10
  us_east_1: 'mypurecloud.com',
@@ -393,7 +395,7 @@ class Configuration {
393
395
 
394
396
  /**
395
397
  * @module purecloud-platform-client-v2/ApiClient
396
- * @version 131.0.0
398
+ * @version 133.0.0
397
399
  */
398
400
  class ApiClient {
399
401
  /**
@@ -497,7 +499,7 @@ class ApiClient {
497
499
  this.settingsPrefix = 'purecloud';
498
500
 
499
501
  // Expose superagent module for use with superagent-proxy
500
- this.superagent = superagent;
502
+ this.superagent = superagent__default["default"];
501
503
 
502
504
  // Transparently request a new access token when it expires (Code Authorization only)
503
505
  this.refreshInProgress = false;
@@ -668,7 +670,7 @@ class ApiClient {
668
670
  }
669
671
 
670
672
  // Build token request
671
- var request = superagent('POST', `https://login.${this.config.environment}/oauth/token`);
673
+ var request = superagent__default["default"]('POST', `https://login.${this.config.environment}/oauth/token`);
672
674
  if (this.proxy && request.proxy) {
673
675
  request.proxy(this.proxy);
674
676
  }
@@ -924,7 +926,7 @@ class ApiClient {
924
926
  * @param {string} encodedData - Base64 encoded client and clientSecret pair
925
927
  */
926
928
  _formAuthRequest(encodedData) {
927
- var request = superagent('POST', `https://login.${this.config.environment}/oauth/token`);
929
+ var request = superagent__default["default"]('POST', `https://login.${this.config.environment}/oauth/token`);
928
930
  // Set the headers
929
931
  request.set('Authorization', 'Basic ' + encodedData);
930
932
  request.set('Content-Type', 'application/x-www-form-urlencoded');
@@ -1326,7 +1328,7 @@ class ApiClient {
1326
1328
  sendRequest(this);
1327
1329
  function sendRequest(that) {
1328
1330
  var url = that.buildUrl(path, pathParams);
1329
- var request = superagent(httpMethod, url);
1331
+ var request = superagent__default["default"](httpMethod, url);
1330
1332
 
1331
1333
  if (that.proxy && request.proxy) {
1332
1334
  request.proxy(that.proxy);
@@ -1340,7 +1342,7 @@ class ApiClient {
1340
1342
 
1341
1343
  // set header parameters
1342
1344
  request.set(that.defaultHeaders).set(that.normalizeParams(headerParams));
1343
- //request.set({ 'purecloud-sdk': '131.0.0' });
1345
+ //request.set({ 'purecloud-sdk': '133.0.0' });
1344
1346
 
1345
1347
  // set request timeout
1346
1348
  request.timeout(that.timeout);
@@ -1440,7 +1442,7 @@ class AlertingApi {
1440
1442
  /**
1441
1443
  * Alerting service.
1442
1444
  * @module purecloud-platform-client-v2/api/AlertingApi
1443
- * @version 131.0.0
1445
+ * @version 133.0.0
1444
1446
  */
1445
1447
 
1446
1448
  /**
@@ -1754,7 +1756,7 @@ class AnalyticsApi {
1754
1756
  /**
1755
1757
  * Analytics service.
1756
1758
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1757
- * @version 131.0.0
1759
+ * @version 133.0.0
1758
1760
  */
1759
1761
 
1760
1762
  /**
@@ -2255,6 +2257,26 @@ class AnalyticsApi {
2255
2257
  );
2256
2258
  }
2257
2259
 
2260
+ /**
2261
+ * Get AnalyticsReportingSettings for an organization
2262
+ *
2263
+ */
2264
+ getAnalyticsReportingSettings() {
2265
+
2266
+ return this.apiClient.callApi(
2267
+ '/api/v2/analytics/reporting/settings',
2268
+ 'GET',
2269
+ { },
2270
+ { },
2271
+ { },
2272
+ { },
2273
+ null,
2274
+ ['PureCloud OAuth'],
2275
+ ['application/json'],
2276
+ ['application/json']
2277
+ );
2278
+ }
2279
+
2258
2280
  /**
2259
2281
  * Get a list of report time periods.
2260
2282
  *
@@ -2350,6 +2372,31 @@ class AnalyticsApi {
2350
2372
  );
2351
2373
  }
2352
2374
 
2375
+ /**
2376
+ * Patch AnalyticsReportingSettings values for an organization
2377
+ *
2378
+ * @param {Object} body AnalyticsReportingSettingsRequest
2379
+ */
2380
+ patchAnalyticsReportingSettings(body) {
2381
+ // verify the required parameter 'body' is set
2382
+ if (body === undefined || body === null) {
2383
+ throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
2384
+ }
2385
+
2386
+ return this.apiClient.callApi(
2387
+ '/api/v2/analytics/reporting/settings',
2388
+ 'PATCH',
2389
+ { },
2390
+ { },
2391
+ { },
2392
+ { },
2393
+ body,
2394
+ ['PureCloud OAuth'],
2395
+ ['application/json'],
2396
+ ['application/json']
2397
+ );
2398
+ }
2399
+
2353
2400
  /**
2354
2401
  * Query for bot aggregates
2355
2402
  *
@@ -2891,7 +2938,7 @@ class ArchitectApi {
2891
2938
  /**
2892
2939
  * Architect service.
2893
2940
  * @module purecloud-platform-client-v2/api/ArchitectApi
2894
- * @version 131.0.0
2941
+ * @version 133.0.0
2895
2942
  */
2896
2943
 
2897
2944
  /**
@@ -5887,7 +5934,7 @@ class AuditApi {
5887
5934
  /**
5888
5935
  * Audit service.
5889
5936
  * @module purecloud-platform-client-v2/api/AuditApi
5890
- * @version 131.0.0
5937
+ * @version 133.0.0
5891
5938
  */
5892
5939
 
5893
5940
  /**
@@ -6058,7 +6105,7 @@ class AuthorizationApi {
6058
6105
  /**
6059
6106
  * Authorization service.
6060
6107
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6061
- * @version 131.0.0
6108
+ * @version 133.0.0
6062
6109
  */
6063
6110
 
6064
6111
  /**
@@ -7241,7 +7288,7 @@ class BillingApi {
7241
7288
  /**
7242
7289
  * Billing service.
7243
7290
  * @module purecloud-platform-client-v2/api/BillingApi
7244
- * @version 131.0.0
7291
+ * @version 133.0.0
7245
7292
  */
7246
7293
 
7247
7294
  /**
@@ -7321,7 +7368,7 @@ class ChatApi {
7321
7368
  /**
7322
7369
  * Chat service.
7323
7370
  * @module purecloud-platform-client-v2/api/ChatApi
7324
- * @version 131.0.0
7371
+ * @version 133.0.0
7325
7372
  */
7326
7373
 
7327
7374
  /**
@@ -7412,7 +7459,7 @@ class CoachingApi {
7412
7459
  /**
7413
7460
  * Coaching service.
7414
7461
  * @module purecloud-platform-client-v2/api/CoachingApi
7415
- * @version 131.0.0
7462
+ * @version 133.0.0
7416
7463
  */
7417
7464
 
7418
7465
  /**
@@ -7989,7 +8036,7 @@ class ContentManagementApi {
7989
8036
  /**
7990
8037
  * ContentManagement service.
7991
8038
  * @module purecloud-platform-client-v2/api/ContentManagementApi
7992
- * @version 131.0.0
8039
+ * @version 133.0.0
7993
8040
  */
7994
8041
 
7995
8042
  /**
@@ -9129,7 +9176,7 @@ class ConversationsApi {
9129
9176
  /**
9130
9177
  * Conversations service.
9131
9178
  * @module purecloud-platform-client-v2/api/ConversationsApi
9132
- * @version 131.0.0
9179
+ * @version 133.0.0
9133
9180
  */
9134
9181
 
9135
9182
  /**
@@ -10460,6 +10507,31 @@ class ConversationsApi {
10460
10507
  );
10461
10508
  }
10462
10509
 
10510
+ /**
10511
+ * Get emails settings for a given conversation
10512
+ *
10513
+ * @param {String} conversationId conversationId
10514
+ */
10515
+ getConversationsEmailSettings(conversationId) {
10516
+ // verify the required parameter 'conversationId' is set
10517
+ if (conversationId === undefined || conversationId === null) {
10518
+ throw 'Missing the required parameter "conversationId" when calling getConversationsEmailSettings';
10519
+ }
10520
+
10521
+ return this.apiClient.callApi(
10522
+ '/api/v2/conversations/emails/{conversationId}/settings',
10523
+ 'GET',
10524
+ { 'conversationId': conversationId },
10525
+ { },
10526
+ { },
10527
+ { },
10528
+ null,
10529
+ ['PureCloud OAuth'],
10530
+ ['application/json'],
10531
+ ['application/json']
10532
+ );
10533
+ }
10534
+
10463
10535
  /**
10464
10536
  * Get active email conversations for the logged in user
10465
10537
  *
@@ -13279,7 +13351,7 @@ class ConversationsApi {
13279
13351
 
13280
13352
  /**
13281
13353
  * Send an agentless outbound message
13282
- * 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.
13354
+ * 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.
13283
13355
  * @param {Object} body Create agentless outbound messaging request
13284
13356
  */
13285
13357
  postConversationsMessagesAgentless(body) {
@@ -13693,7 +13765,7 @@ class DataExtensionsApi {
13693
13765
  /**
13694
13766
  * DataExtensions service.
13695
13767
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
13696
- * @version 131.0.0
13768
+ * @version 133.0.0
13697
13769
  */
13698
13770
 
13699
13771
  /**
@@ -13779,7 +13851,7 @@ class ExternalContactsApi {
13779
13851
  /**
13780
13852
  * ExternalContacts service.
13781
13853
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
13782
- * @version 131.0.0
13854
+ * @version 133.0.0
13783
13855
  */
13784
13856
 
13785
13857
  /**
@@ -15522,7 +15594,7 @@ class FaxApi {
15522
15594
  /**
15523
15595
  * Fax service.
15524
15596
  * @module purecloud-platform-client-v2/api/FaxApi
15525
- * @version 131.0.0
15597
+ * @version 133.0.0
15526
15598
  */
15527
15599
 
15528
15600
  /**
@@ -15693,7 +15765,7 @@ class FlowsApi {
15693
15765
  /**
15694
15766
  * Flows service.
15695
15767
  * @module purecloud-platform-client-v2/api/FlowsApi
15696
- * @version 131.0.0
15768
+ * @version 133.0.0
15697
15769
  */
15698
15770
 
15699
15771
  /**
@@ -15764,7 +15836,7 @@ class GamificationApi {
15764
15836
  /**
15765
15837
  * Gamification service.
15766
15838
  * @module purecloud-platform-client-v2/api/GamificationApi
15767
- * @version 131.0.0
15839
+ * @version 133.0.0
15768
15840
  */
15769
15841
 
15770
15842
  /**
@@ -17040,8 +17112,12 @@ class GamificationApi {
17040
17112
  * Create a new custom performance profile
17041
17113
  *
17042
17114
  * @param {Object} body performanceProfile
17115
+ * @param {Object} opts Optional parameters
17116
+ * @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)
17043
17117
  */
17044
- postGamificationProfiles(body) {
17118
+ postGamificationProfiles(body, opts) {
17119
+ opts = opts || {};
17120
+
17045
17121
  // verify the required parameter 'body' is set
17046
17122
  if (body === undefined || body === null) {
17047
17123
  throw 'Missing the required parameter "body" when calling postGamificationProfiles';
@@ -17051,7 +17127,7 @@ class GamificationApi {
17051
17127
  '/api/v2/gamification/profiles',
17052
17128
  'POST',
17053
17129
  { },
17054
- { },
17130
+ { 'copyMetrics': opts['copyMetrics'] },
17055
17131
  { },
17056
17132
  { },
17057
17133
  body,
@@ -17190,7 +17266,7 @@ class GeneralDataProtectionRegulationApi {
17190
17266
  /**
17191
17267
  * GeneralDataProtectionRegulation service.
17192
17268
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
17193
- * @version 131.0.0
17269
+ * @version 133.0.0
17194
17270
  */
17195
17271
 
17196
17272
  /**
@@ -17320,7 +17396,7 @@ class GeolocationApi {
17320
17396
  /**
17321
17397
  * Geolocation service.
17322
17398
  * @module purecloud-platform-client-v2/api/GeolocationApi
17323
- * @version 131.0.0
17399
+ * @version 133.0.0
17324
17400
  */
17325
17401
 
17326
17402
  /**
@@ -17451,7 +17527,7 @@ class GreetingsApi {
17451
17527
  /**
17452
17528
  * Greetings service.
17453
17529
  * @module purecloud-platform-client-v2/api/GreetingsApi
17454
- * @version 131.0.0
17530
+ * @version 133.0.0
17455
17531
  */
17456
17532
 
17457
17533
  /**
@@ -17906,7 +17982,7 @@ class GroupsApi {
17906
17982
  /**
17907
17983
  * Groups service.
17908
17984
  * @module purecloud-platform-client-v2/api/GroupsApi
17909
- * @version 131.0.0
17985
+ * @version 133.0.0
17910
17986
  */
17911
17987
 
17912
17988
  /**
@@ -18311,7 +18387,7 @@ class IdentityProviderApi {
18311
18387
  /**
18312
18388
  * IdentityProvider service.
18313
18389
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
18314
- * @version 131.0.0
18390
+ * @version 133.0.0
18315
18391
  */
18316
18392
 
18317
18393
  /**
@@ -19067,7 +19143,7 @@ class IntegrationsApi {
19067
19143
  /**
19068
19144
  * Integrations service.
19069
19145
  * @module purecloud-platform-client-v2/api/IntegrationsApi
19070
- * @version 131.0.0
19146
+ * @version 133.0.0
19071
19147
  */
19072
19148
 
19073
19149
  /**
@@ -20742,7 +20818,7 @@ class JourneyApi {
20742
20818
  /**
20743
20819
  * Journey service.
20744
20820
  * @module purecloud-platform-client-v2/api/JourneyApi
20745
- * @version 131.0.0
20821
+ * @version 133.0.0
20746
20822
  */
20747
20823
 
20748
20824
  /**
@@ -21453,7 +21529,7 @@ class KnowledgeApi {
21453
21529
  /**
21454
21530
  * Knowledge service.
21455
21531
  * @module purecloud-platform-client-v2/api/KnowledgeApi
21456
- * @version 131.0.0
21532
+ * @version 133.0.0
21457
21533
  */
21458
21534
 
21459
21535
  /**
@@ -22353,7 +22429,7 @@ class LanguageUnderstandingApi {
22353
22429
  /**
22354
22430
  * LanguageUnderstanding service.
22355
22431
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
22356
- * @version 131.0.0
22432
+ * @version 133.0.0
22357
22433
  */
22358
22434
 
22359
22435
  /**
@@ -22811,7 +22887,7 @@ class LanguageUnderstandingApi {
22811
22887
  * @param {String} minerId Miner ID
22812
22888
  * @param {String} intentId The ID of the intent to be retrieved.
22813
22889
  * @param {Object} opts Optional parameters
22814
- * @param {String} opts.expand Option to fetch utterances
22890
+ * @param {Object} opts.expand Option to fetch utterances
22815
22891
  */
22816
22892
  getLanguageunderstandingMinerIntent(minerId, intentId, opts) {
22817
22893
  opts = opts || {};
@@ -22844,7 +22920,7 @@ class LanguageUnderstandingApi {
22844
22920
  *
22845
22921
  * @param {String} minerId Miner ID
22846
22922
  * @param {Object} opts Optional parameters
22847
- * @param {String} opts.expand Option to fetch utterances.
22923
+ * @param {Object} opts.expand Option to fetch utterances.
22848
22924
  */
22849
22925
  getLanguageunderstandingMinerIntents(minerId, opts) {
22850
22926
  opts = opts || {};
@@ -23257,7 +23333,7 @@ class LanguagesApi {
23257
23333
  /**
23258
23334
  * Languages service.
23259
23335
  * @module purecloud-platform-client-v2/api/LanguagesApi
23260
- * @version 131.0.0
23336
+ * @version 133.0.0
23261
23337
  */
23262
23338
 
23263
23339
  /**
@@ -23525,7 +23601,7 @@ class LearningApi {
23525
23601
  /**
23526
23602
  * Learning service.
23527
23603
  * @module purecloud-platform-client-v2/api/LearningApi
23528
- * @version 131.0.0
23604
+ * @version 133.0.0
23529
23605
  */
23530
23606
 
23531
23607
  /**
@@ -24116,7 +24192,7 @@ class LicenseApi {
24116
24192
  /**
24117
24193
  * License service.
24118
24194
  * @module purecloud-platform-client-v2/api/LicenseApi
24119
- * @version 131.0.0
24195
+ * @version 133.0.0
24120
24196
  */
24121
24197
 
24122
24198
  /**
@@ -24354,7 +24430,7 @@ class LocationsApi {
24354
24430
  /**
24355
24431
  * Locations service.
24356
24432
  * @module purecloud-platform-client-v2/api/LocationsApi
24357
- * @version 131.0.0
24433
+ * @version 133.0.0
24358
24434
  */
24359
24435
 
24360
24436
  /**
@@ -24590,7 +24666,7 @@ class MessagingApi {
24590
24666
  /**
24591
24667
  * Messaging service.
24592
24668
  * @module purecloud-platform-client-v2/api/MessagingApi
24593
- * @version 131.0.0
24669
+ * @version 133.0.0
24594
24670
  */
24595
24671
 
24596
24672
  /**
@@ -24741,7 +24817,7 @@ class MobileDevicesApi {
24741
24817
  /**
24742
24818
  * MobileDevices service.
24743
24819
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
24744
- * @version 131.0.0
24820
+ * @version 133.0.0
24745
24821
  */
24746
24822
 
24747
24823
  /**
@@ -24892,7 +24968,7 @@ class NotificationsApi {
24892
24968
  /**
24893
24969
  * Notifications service.
24894
24970
  * @module purecloud-platform-client-v2/api/NotificationsApi
24895
- * @version 131.0.0
24971
+ * @version 133.0.0
24896
24972
  */
24897
24973
 
24898
24974
  /**
@@ -25117,7 +25193,7 @@ class OAuthApi {
25117
25193
  /**
25118
25194
  * OAuth service.
25119
25195
  * @module purecloud-platform-client-v2/api/OAuthApi
25120
- * @version 131.0.0
25196
+ * @version 133.0.0
25121
25197
  */
25122
25198
 
25123
25199
  /**
@@ -25475,7 +25551,7 @@ class ObjectsApi {
25475
25551
  /**
25476
25552
  * Objects service.
25477
25553
  * @module purecloud-platform-client-v2/api/ObjectsApi
25478
- * @version 131.0.0
25554
+ * @version 133.0.0
25479
25555
  */
25480
25556
 
25481
25557
  /**
@@ -25746,7 +25822,7 @@ class OrganizationApi {
25746
25822
  /**
25747
25823
  * Organization service.
25748
25824
  * @module purecloud-platform-client-v2/api/OrganizationApi
25749
- * @version 131.0.0
25825
+ * @version 133.0.0
25750
25826
  */
25751
25827
 
25752
25828
  /**
@@ -26149,7 +26225,7 @@ class OrganizationAuthorizationApi {
26149
26225
  /**
26150
26226
  * OrganizationAuthorization service.
26151
26227
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
26152
- * @version 131.0.0
26228
+ * @version 133.0.0
26153
26229
  */
26154
26230
 
26155
26231
  /**
@@ -27074,7 +27150,7 @@ class OutboundApi {
27074
27150
  /**
27075
27151
  * Outbound service.
27076
27152
  * @module purecloud-platform-client-v2/api/OutboundApi
27077
- * @version 131.0.0
27153
+ * @version 133.0.0
27078
27154
  */
27079
27155
 
27080
27156
  /**
@@ -29459,8 +29535,12 @@ class OutboundApi {
29459
29535
  * Only Internal DNC lists may be appended to
29460
29536
  * @param {String} dncListId DncList ID
29461
29537
  * @param {Array.<Object>} body DNC Phone Numbers
29538
+ * @param {Object} opts Optional parameters
29539
+ * @param {String} opts.expirationDateTime Expiration date for DNC phone numbers in yyyy-MM-ddTHH:mmZ format
29462
29540
  */
29463
- postOutboundDnclistPhonenumbers(dncListId, body) {
29541
+ postOutboundDnclistPhonenumbers(dncListId, body, opts) {
29542
+ opts = opts || {};
29543
+
29464
29544
  // verify the required parameter 'dncListId' is set
29465
29545
  if (dncListId === undefined || dncListId === null) {
29466
29546
  throw 'Missing the required parameter "dncListId" when calling postOutboundDnclistPhonenumbers';
@@ -29474,7 +29554,7 @@ class OutboundApi {
29474
29554
  '/api/v2/outbound/dnclists/{dncListId}/phonenumbers',
29475
29555
  'POST',
29476
29556
  { 'dncListId': dncListId },
29477
- { },
29557
+ { 'expirationDateTime': opts['expirationDateTime'] },
29478
29558
  { },
29479
29559
  { },
29480
29560
  body,
@@ -30100,7 +30180,7 @@ class PresenceApi {
30100
30180
  /**
30101
30181
  * Presence service.
30102
30182
  * @module purecloud-platform-client-v2/api/PresenceApi
30103
- * @version 131.0.0
30183
+ * @version 133.0.0
30104
30184
  */
30105
30185
 
30106
30186
  /**
@@ -30472,7 +30552,7 @@ class QualityApi {
30472
30552
  /**
30473
30553
  * Quality service.
30474
30554
  * @module purecloud-platform-client-v2/api/QualityApi
30475
- * @version 131.0.0
30555
+ * @version 133.0.0
30476
30556
  */
30477
30557
 
30478
30558
  /**
@@ -30523,7 +30603,7 @@ class QualityApi {
30523
30603
  * @param {String} conversationId conversationId
30524
30604
  * @param {String} evaluationId evaluationId
30525
30605
  * @param {Object} opts Optional parameters
30526
- * @param {String} opts.expand evaluatorId
30606
+ * @param {String} opts.expand evaluatorId, evaluationForm
30527
30607
  */
30528
30608
  deleteQualityConversationEvaluation(conversationId, evaluationId, opts) {
30529
30609
  opts = opts || {};
@@ -30628,7 +30708,7 @@ class QualityApi {
30628
30708
 
30629
30709
  /**
30630
30710
  * Gets a list of Agent Activities
30631
- * 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.
30711
+ * 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
30632
30712
  * @param {Object} opts Optional parameters
30633
30713
  * @param {Number} opts.pageSize The total page size requested (default to 25)
30634
30714
  * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -31091,6 +31171,31 @@ class QualityApi {
31091
31171
  );
31092
31172
  }
31093
31173
 
31174
+ /**
31175
+ * Retrieve a list of the latest published evaluation form versions by context ids
31176
+ *
31177
+ * @param {Array.<String>} contextId A comma-delimited list of valid evaluation form context ids
31178
+ */
31179
+ getQualityFormsEvaluationsBulkContexts(contextId) {
31180
+ // verify the required parameter 'contextId' is set
31181
+ if (contextId === undefined || contextId === null) {
31182
+ throw 'Missing the required parameter "contextId" when calling getQualityFormsEvaluationsBulkContexts';
31183
+ }
31184
+
31185
+ return this.apiClient.callApi(
31186
+ '/api/v2/quality/forms/evaluations/bulk/contexts',
31187
+ 'GET',
31188
+ { },
31189
+ { 'contextId': this.apiClient.buildCollectionParam(contextId, 'multi') },
31190
+ { },
31191
+ { },
31192
+ null,
31193
+ ['PureCloud OAuth'],
31194
+ ['application/json'],
31195
+ ['application/json']
31196
+ );
31197
+ }
31198
+
31094
31199
  /**
31095
31200
  * Get a survey form
31096
31201
  *
@@ -31605,6 +31710,31 @@ class QualityApi {
31605
31710
  );
31606
31711
  }
31607
31712
 
31713
+ /**
31714
+ * Query for evaluation aggregates for the current user
31715
+ *
31716
+ * @param {Object} body query
31717
+ */
31718
+ postQualityEvaluationsAggregatesQueryMe(body) {
31719
+ // verify the required parameter 'body' is set
31720
+ if (body === undefined || body === null) {
31721
+ throw 'Missing the required parameter "body" when calling postQualityEvaluationsAggregatesQueryMe';
31722
+ }
31723
+
31724
+ return this.apiClient.callApi(
31725
+ '/api/v2/quality/evaluations/aggregates/query/me',
31726
+ 'POST',
31727
+ { },
31728
+ { },
31729
+ { },
31730
+ { },
31731
+ body,
31732
+ ['PureCloud OAuth'],
31733
+ ['application/json'],
31734
+ ['application/json']
31735
+ );
31736
+ }
31737
+
31608
31738
  /**
31609
31739
  * Score evaluation
31610
31740
  *
@@ -31842,7 +31972,7 @@ class QualityApi {
31842
31972
  * @param {String} evaluationId evaluationId
31843
31973
  * @param {Object} body evaluation
31844
31974
  * @param {Object} opts Optional parameters
31845
- * @param {String} opts.expand evaluatorId
31975
+ * @param {String} opts.expand evaluatorId, evaluationForm
31846
31976
  */
31847
31977
  putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
31848
31978
  opts = opts || {};
@@ -32000,7 +32130,7 @@ class RecordingApi {
32000
32130
  /**
32001
32131
  * Recording service.
32002
32132
  * @module purecloud-platform-client-v2/api/RecordingApi
32003
- * @version 131.0.0
32133
+ * @version 133.0.0
32004
32134
  */
32005
32135
 
32006
32136
  /**
@@ -32213,6 +32343,7 @@ class RecordingApi {
32213
32343
  * @param {Boolean} opts.download requesting a download format of the recording. Valid values:true,false (default to false)
32214
32344
  * @param {String} opts.fileName the name of the downloaded fileName
32215
32345
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
32346
+ * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
32216
32347
  */
32217
32348
  getConversationRecording(conversationId, recordingId, opts) {
32218
32349
  opts = opts || {};
@@ -32230,7 +32361,7 @@ class RecordingApi {
32230
32361
  '/api/v2/conversations/{conversationId}/recordings/{recordingId}',
32231
32362
  'GET',
32232
32363
  { 'conversationId': conversationId,'recordingId': recordingId },
32233
- { 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
32364
+ { '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') },
32234
32365
  { },
32235
32366
  { },
32236
32367
  null,
@@ -32366,7 +32497,8 @@ class RecordingApi {
32366
32497
  * @param {String} conversationId Conversation ID
32367
32498
  * @param {Object} opts Optional parameters
32368
32499
  * @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)
32369
- * @param {Object} opts.formatId The desired media format . Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
32500
+ * @param {Object} opts.formatId The desired media format. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3,NONE. (default to WEBM)
32501
+ * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3.
32370
32502
  */
32371
32503
  getConversationRecordings(conversationId, opts) {
32372
32504
  opts = opts || {};
@@ -32380,7 +32512,7 @@ class RecordingApi {
32380
32512
  '/api/v2/conversations/{conversationId}/recordings',
32381
32513
  'GET',
32382
32514
  { 'conversationId': conversationId },
32383
- { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'] },
32515
+ { 'maxWaitMs': opts['maxWaitMs'],'formatId': opts['formatId'],'mediaFormats': this.apiClient.buildCollectionParam(opts['mediaFormats'], 'multi') },
32384
32516
  { },
32385
32517
  { },
32386
32518
  null,
@@ -32427,6 +32559,7 @@ class RecordingApi {
32427
32559
  * @param {Boolean} opts.download requesting a download format of the recording (default to false)
32428
32560
  * @param {String} opts.fileName the name of the downloaded fileName
32429
32561
  * @param {String} opts.locale The locale for the requested file when downloading, as an ISO 639-1 code
32562
+ * @param {Array.<String>} opts.mediaFormats All acceptable media formats. Overrides formatId. Valid values:WAV,WEBM,WAV_ULAW,OGG_VORBIS,OGG_OPUS,MP3
32430
32563
  */
32431
32564
  getOrphanrecordingMedia(orphanId, opts) {
32432
32565
  opts = opts || {};
@@ -32440,7 +32573,7 @@ class RecordingApi {
32440
32573
  '/api/v2/orphanrecordings/{orphanId}/media',
32441
32574
  'GET',
32442
32575
  { 'orphanId': orphanId },
32443
- { 'formatId': opts['formatId'],'emailFormatId': opts['emailFormatId'],'chatFormatId': opts['chatFormatId'],'messageFormatId': opts['messageFormatId'],'download': opts['download'],'fileName': opts['fileName'],'locale': opts['locale'] },
32576
+ { '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') },
32444
32577
  { },
32445
32578
  { },
32446
32579
  null,
@@ -33523,7 +33656,7 @@ class ResponseManagementApi {
33523
33656
  /**
33524
33657
  * ResponseManagement service.
33525
33658
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
33526
- * @version 131.0.0
33659
+ * @version 133.0.0
33527
33660
  */
33528
33661
 
33529
33662
  /**
@@ -33848,7 +33981,7 @@ class RoutingApi {
33848
33981
  /**
33849
33982
  * Routing service.
33850
33983
  * @module purecloud-platform-client-v2/api/RoutingApi
33851
- * @version 131.0.0
33984
+ * @version 133.0.0
33852
33985
  */
33853
33986
 
33854
33987
  /**
@@ -36771,7 +36904,7 @@ class SCIMApi {
36771
36904
  /**
36772
36905
  * SCIM service.
36773
36906
  * @module purecloud-platform-client-v2/api/SCIMApi
36774
- * @version 131.0.0
36907
+ * @version 133.0.0
36775
36908
  */
36776
36909
 
36777
36910
  /**
@@ -37648,7 +37781,7 @@ class ScriptsApi {
37648
37781
  /**
37649
37782
  * Scripts service.
37650
37783
  * @module purecloud-platform-client-v2/api/ScriptsApi
37651
- * @version 131.0.0
37784
+ * @version 133.0.0
37652
37785
  */
37653
37786
 
37654
37787
  /**
@@ -38001,7 +38134,7 @@ class SearchApi {
38001
38134
  /**
38002
38135
  * Search service.
38003
38136
  * @module purecloud-platform-client-v2/api/SearchApi
38004
- * @version 131.0.0
38137
+ * @version 133.0.0
38005
38138
  */
38006
38139
 
38007
38140
  /**
@@ -38536,7 +38669,7 @@ class SpeechTextAnalyticsApi {
38536
38669
  /**
38537
38670
  * SpeechTextAnalytics service.
38538
38671
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
38539
- * @version 131.0.0
38672
+ * @version 133.0.0
38540
38673
  */
38541
38674
 
38542
38675
  /**
@@ -39389,7 +39522,7 @@ class StationsApi {
39389
39522
  /**
39390
39523
  * Stations service.
39391
39524
  * @module purecloud-platform-client-v2/api/StationsApi
39392
- * @version 131.0.0
39525
+ * @version 133.0.0
39393
39526
  */
39394
39527
 
39395
39528
  /**
@@ -39536,7 +39669,7 @@ class SuggestApi {
39536
39669
  /**
39537
39670
  * Suggest service.
39538
39671
  * @module purecloud-platform-client-v2/api/SuggestApi
39539
- * @version 131.0.0
39672
+ * @version 133.0.0
39540
39673
  */
39541
39674
 
39542
39675
  /**
@@ -39675,7 +39808,7 @@ class TelephonyApi {
39675
39808
  /**
39676
39809
  * Telephony service.
39677
39810
  * @module purecloud-platform-client-v2/api/TelephonyApi
39678
- * @version 131.0.0
39811
+ * @version 133.0.0
39679
39812
  */
39680
39813
 
39681
39814
  /**
@@ -39783,7 +39916,7 @@ class TelephonyProvidersEdgeApi {
39783
39916
  /**
39784
39917
  * TelephonyProvidersEdge service.
39785
39918
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
39786
- * @version 131.0.0
39919
+ * @version 133.0.0
39787
39920
  */
39788
39921
 
39789
39922
  /**
@@ -41197,7 +41330,7 @@ class TelephonyProvidersEdgeApi {
41197
41330
  * @param {Object} opts Optional parameters
41198
41331
  * @param {Number} opts.pageSize Page size (default to 25)
41199
41332
  * @param {Number} opts.pageNumber Page number (default to 1)
41200
- * @param {String} opts.sortBy Sort by (default to startNumber)
41333
+ * @param {String} opts.sortBy Sort by
41201
41334
  * @param {String} opts._number Number
41202
41335
  */
41203
41336
  getTelephonyProvidersEdgesExtensionpools(opts) {
@@ -43416,7 +43549,7 @@ class TextbotsApi {
43416
43549
  /**
43417
43550
  * Textbots service.
43418
43551
  * @module purecloud-platform-client-v2/api/TextbotsApi
43419
- * @version 131.0.0
43552
+ * @version 133.0.0
43420
43553
  */
43421
43554
 
43422
43555
  /**
@@ -43544,7 +43677,7 @@ class TokensApi {
43544
43677
  /**
43545
43678
  * Tokens service.
43546
43679
  * @module purecloud-platform-client-v2/api/TokensApi
43547
- * @version 131.0.0
43680
+ * @version 133.0.0
43548
43681
  */
43549
43682
 
43550
43683
  /**
@@ -43650,7 +43783,7 @@ class UploadsApi {
43650
43783
  /**
43651
43784
  * Uploads service.
43652
43785
  * @module purecloud-platform-client-v2/api/UploadsApi
43653
- * @version 131.0.0
43786
+ * @version 133.0.0
43654
43787
  */
43655
43788
 
43656
43789
  /**
@@ -43826,7 +43959,7 @@ class UsageApi {
43826
43959
  /**
43827
43960
  * Usage service.
43828
43961
  * @module purecloud-platform-client-v2/api/UsageApi
43829
- * @version 131.0.0
43962
+ * @version 133.0.0
43830
43963
  */
43831
43964
 
43832
43965
  /**
@@ -43897,7 +44030,7 @@ class UserRecordingsApi {
43897
44030
  /**
43898
44031
  * UserRecordings service.
43899
44032
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
43900
- * @version 131.0.0
44033
+ * @version 133.0.0
43901
44034
  */
43902
44035
 
43903
44036
  /**
@@ -44081,7 +44214,7 @@ class UsersApi {
44081
44214
  /**
44082
44215
  * Users service.
44083
44216
  * @module purecloud-platform-client-v2/api/UsersApi
44084
- * @version 131.0.0
44217
+ * @version 133.0.0
44085
44218
  */
44086
44219
 
44087
44220
  /**
@@ -46383,7 +46516,7 @@ class UtilitiesApi {
46383
46516
  /**
46384
46517
  * Utilities service.
46385
46518
  * @module purecloud-platform-client-v2/api/UtilitiesApi
46386
- * @version 131.0.0
46519
+ * @version 133.0.0
46387
46520
  */
46388
46521
 
46389
46522
  /**
@@ -46494,7 +46627,7 @@ class VoicemailApi {
46494
46627
  /**
46495
46628
  * Voicemail service.
46496
46629
  * @module purecloud-platform-client-v2/api/VoicemailApi
46497
- * @version 131.0.0
46630
+ * @version 133.0.0
46498
46631
  */
46499
46632
 
46500
46633
  /**
@@ -47161,7 +47294,7 @@ class WebChatApi {
47161
47294
  /**
47162
47295
  * WebChat service.
47163
47296
  * @module purecloud-platform-client-v2/api/WebChatApi
47164
- * @version 131.0.0
47297
+ * @version 133.0.0
47165
47298
  */
47166
47299
 
47167
47300
  /**
@@ -47705,7 +47838,7 @@ class WebDeploymentsApi {
47705
47838
  /**
47706
47839
  * WebDeployments service.
47707
47840
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
47708
- * @version 131.0.0
47841
+ * @version 133.0.0
47709
47842
  */
47710
47843
 
47711
47844
  /**
@@ -48060,7 +48193,7 @@ class WebMessagingApi {
48060
48193
  /**
48061
48194
  * WebMessaging service.
48062
48195
  * @module purecloud-platform-client-v2/api/WebMessagingApi
48063
- * @version 131.0.0
48196
+ * @version 133.0.0
48064
48197
  */
48065
48198
 
48066
48199
  /**
@@ -48106,7 +48239,7 @@ class WidgetsApi {
48106
48239
  /**
48107
48240
  * Widgets service.
48108
48241
  * @module purecloud-platform-client-v2/api/WidgetsApi
48109
- * @version 131.0.0
48242
+ * @version 133.0.0
48110
48243
  */
48111
48244
 
48112
48245
  /**
@@ -48252,7 +48385,7 @@ class WorkforceManagementApi {
48252
48385
  /**
48253
48386
  * WorkforceManagement service.
48254
48387
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
48255
- * @version 131.0.0
48388
+ * @version 133.0.0
48256
48389
  */
48257
48390
 
48258
48391
  /**
@@ -50353,7 +50486,7 @@ class WorkforceManagementApi {
50353
50486
 
50354
50487
  /**
50355
50488
  * Get a list of notifications for the current user
50356
- *
50489
+ * Notifications are only initially sent if you have the relevant Notify and Edit permissions
50357
50490
  */
50358
50491
  getWorkforcemanagementNotifications() {
50359
50492
 
@@ -52283,7 +52416,7 @@ class WorkforceManagementApi {
52283
52416
  * </pre>
52284
52417
  * </p>
52285
52418
  * @module purecloud-platform-client-v2/index
52286
- * @version 131.0.0
52419
+ * @version 133.0.0
52287
52420
  */
52288
52421
  class platformClient {
52289
52422
  constructor() {