purecloud-platform-client-v2 139.0.0 → 141.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 +420 -116
  3. package/dist/web-amd/purecloud-platform-client-v2.js +420 -117
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +420 -116
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +2514 -154
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +499 -207
  9. package/package.json +2 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +18 -16
  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 +15 -15
  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 +1 -1
  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 +156 -5
  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 +145 -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 +1 -1
  47. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/QualityApi.js +2 -2
  49. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/RoutingApi.js +11 -5
  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 +15 -15
  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 +1 -1
  73. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -1,10 +1,12 @@
1
1
  'use strict';
2
2
 
3
3
  var axios = require('axios');
4
+ var qs = require('qs');
4
5
 
5
6
  function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
6
7
 
7
8
  var axios__default = /*#__PURE__*/_interopDefaultLegacy(axios);
9
+ var qs__default = /*#__PURE__*/_interopDefaultLegacy(qs);
8
10
 
9
11
  var PureCloudRegionHosts = {
10
12
  us_east_1: 'mypurecloud.com',
@@ -2276,7 +2278,7 @@ class Configuration {
2276
2278
 
2277
2279
  /**
2278
2280
  * @module purecloud-platform-client-v2/ApiClient
2279
- * @version 139.0.0
2281
+ * @version 141.0.0
2280
2282
  */
2281
2283
  class ApiClient {
2282
2284
  /**
@@ -2311,7 +2313,7 @@ class ApiClient {
2311
2313
 
2312
2314
  /**
2313
2315
  * Enumeration of collection format separator strategies.
2314
- * @enum {String}
2316
+ * @enum {String}
2315
2317
  * @readonly
2316
2318
  */
2317
2319
  this.CollectionFormatEnum = {
@@ -2458,7 +2460,7 @@ class ApiClient {
2458
2460
  // Load current auth data
2459
2461
  const tempState = this.authData.state;
2460
2462
  this.authData = localStorage.getItem(`${this.settingsPrefix}_auth_data`);
2461
- if (!this.authData)
2463
+ if (!this.authData)
2462
2464
  this.authData = {};
2463
2465
  else
2464
2466
  this.authData = JSON.parse(this.authData);
@@ -2478,7 +2480,7 @@ class ApiClient {
2478
2480
  * @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
2479
2481
  * @param {string} clientId - The client ID of an OAuth Implicit Grant client
2480
2482
  * @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
2481
- * @param {object} opts - (optional) Additional options
2483
+ * @param {object} opts - (optional) Additional options
2482
2484
  * @param {string} opts.state - (optional) An arbitrary string to be passed back with the login response. Used for client apps to associate login responses with a request.
2483
2485
  * @param {string} opts.org - (optional) The organization name that would normally used when specifying an organization name when logging in. This is only used when a provider is also specified.
2484
2486
  * @param {string} opts.provider - (optional) Authentication provider to log in with e.g. okta, adfs, salesforce, onelogin. This is only used when an org is also specified.
@@ -2624,9 +2626,9 @@ class ApiClient {
2624
2626
  }
2625
2627
  var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
2626
2628
  var request = this._formAuthRequest(encodedData,
2627
- { grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer' },
2628
- { orgName: orgName },
2629
- { assertion: assertion });
2629
+ { grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
2630
+ orgName: orgName,
2631
+ assertion: assertion });
2630
2632
  request.proxy = this.proxy;
2631
2633
  var bodyParam = {
2632
2634
  grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
@@ -2705,9 +2707,9 @@ class ApiClient {
2705
2707
  }
2706
2708
  var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
2707
2709
  var request = this._formAuthRequest(encodedData,
2708
- { grant_type: 'authorization_code' },
2709
- { code: authCode },
2710
- { redirect_uri: redirectUri });
2710
+ { grant_type: 'authorization_code',
2711
+ code: authCode,
2712
+ redirect_uri: redirectUri });
2711
2713
  request.proxy = this.proxy;
2712
2714
  var bodyParam = {
2713
2715
  grant_type: 'authorization_code',
@@ -2733,7 +2735,7 @@ class ApiClient {
2733
2735
  return;
2734
2736
  }
2735
2737
  var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
2736
- var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token' }, { refresh_token: refreshToken });
2738
+ var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token' , refresh_token: refreshToken });
2737
2739
  request.proxy = this.proxy;
2738
2740
  var bodyParam = {
2739
2741
  grant_type: 'refresh_token',
@@ -2810,8 +2812,9 @@ class ApiClient {
2810
2812
  /**
2811
2813
  * @description Utility function to create the request for auth requests
2812
2814
  * @param {string} encodedData - Base64 encoded client and clientSecret pair
2815
+ * @param {object} data - data to url form encode
2813
2816
  */
2814
- _formAuthRequest(encodedData) {
2817
+ _formAuthRequest(encodedData, data) {
2815
2818
  var request = axios__default["default"]({
2816
2819
  method: `POST`,
2817
2820
  url: `https://login.${this.config.environment}/oauth/token`,
@@ -2819,7 +2822,7 @@ class ApiClient {
2819
2822
  'Authorization': 'Basic ' + encodedData,
2820
2823
  'Content-Type': 'application/x-www-form-urlencoded'
2821
2824
  },
2822
- data: arguments
2825
+ data: qs__default["default"].stringify(data)
2823
2826
  });
2824
2827
 
2825
2828
  return request;
@@ -2883,7 +2886,7 @@ class ApiClient {
2883
2886
  }
2884
2887
 
2885
2888
  // Test token
2886
- this.callApi('/api/v2/tokens/me', 'GET',
2889
+ this.callApi('/api/v2/tokens/me', 'GET',
2887
2890
  null, null, null, null, null, ['PureCloud OAuth'], ['application/json'], ['application/json'])
2888
2891
  .then(() => {
2889
2892
  resolve();
@@ -2909,7 +2912,7 @@ class ApiClient {
2909
2912
  const match = hashRegex.exec(h);
2910
2913
  if (match) hash[match[1]] = decodeURIComponent(decodeURIComponent(match[2].replace(/\+/g, '%20')));
2911
2914
  });
2912
-
2915
+
2913
2916
  // Check for error
2914
2917
  if (hash.error) {
2915
2918
  return hash;
@@ -3107,7 +3110,7 @@ class ApiClient {
3107
3110
  /**
3108
3111
  * Checks whether the given parameter value represents file-like content.
3109
3112
  * @param param The parameter to check.
3110
- * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
3113
+ * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
3111
3114
  */
3112
3115
  isFileParam(param) {
3113
3116
  // Buffer in Node.js
@@ -3347,7 +3350,7 @@ class AlertingApi {
3347
3350
  /**
3348
3351
  * Alerting service.
3349
3352
  * @module purecloud-platform-client-v2/api/AlertingApi
3350
- * @version 139.0.0
3353
+ * @version 141.0.0
3351
3354
  */
3352
3355
 
3353
3356
  /**
@@ -3661,7 +3664,7 @@ class AnalyticsApi {
3661
3664
  /**
3662
3665
  * Analytics service.
3663
3666
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3664
- * @version 139.0.0
3667
+ * @version 141.0.0
3665
3668
  */
3666
3669
 
3667
3670
  /**
@@ -4843,7 +4846,7 @@ class ArchitectApi {
4843
4846
  /**
4844
4847
  * Architect service.
4845
4848
  * @module purecloud-platform-client-v2/api/ArchitectApi
4846
- * @version 139.0.0
4849
+ * @version 141.0.0
4847
4850
  */
4848
4851
 
4849
4852
  /**
@@ -7888,7 +7891,7 @@ class AuditApi {
7888
7891
  /**
7889
7892
  * Audit service.
7890
7893
  * @module purecloud-platform-client-v2/api/AuditApi
7891
- * @version 139.0.0
7894
+ * @version 141.0.0
7892
7895
  */
7893
7896
 
7894
7897
  /**
@@ -8059,7 +8062,7 @@ class AuthorizationApi {
8059
8062
  /**
8060
8063
  * Authorization service.
8061
8064
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8062
- * @version 139.0.0
8065
+ * @version 141.0.0
8063
8066
  */
8064
8067
 
8065
8068
  /**
@@ -8664,18 +8667,18 @@ class AuthorizationApi {
8664
8667
  /**
8665
8668
  * Returns a listing of roles and permissions for a user.
8666
8669
  *
8667
- * @param {String} userId User ID
8670
+ * @param {String} subjectId User ID
8668
8671
  */
8669
- getUserRoles(userId) {
8670
- // verify the required parameter 'userId' is set
8671
- if (userId === undefined || userId === null) {
8672
- throw 'Missing the required parameter "userId" when calling getUserRoles';
8672
+ getUserRoles(subjectId) {
8673
+ // verify the required parameter 'subjectId' is set
8674
+ if (subjectId === undefined || subjectId === null) {
8675
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
8673
8676
  }
8674
8677
 
8675
8678
  return this.apiClient.callApi(
8676
- '/api/v2/users/{userId}/roles',
8679
+ '/api/v2/users/{subjectId}/roles',
8677
8680
  'GET',
8678
- { 'userId': userId },
8681
+ { 'subjectId': subjectId },
8679
8682
  { },
8680
8683
  { },
8681
8684
  { },
@@ -9209,13 +9212,13 @@ class AuthorizationApi {
9209
9212
  /**
9210
9213
  * Sets the user's roles
9211
9214
  *
9212
- * @param {String} userId User ID
9215
+ * @param {String} subjectId User ID
9213
9216
  * @param {Array.<String>} body List of roles
9214
9217
  */
9215
- putUserRoles(userId, body) {
9216
- // verify the required parameter 'userId' is set
9217
- if (userId === undefined || userId === null) {
9218
- throw 'Missing the required parameter "userId" when calling putUserRoles';
9218
+ putUserRoles(subjectId, body) {
9219
+ // verify the required parameter 'subjectId' is set
9220
+ if (subjectId === undefined || subjectId === null) {
9221
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
9219
9222
  }
9220
9223
  // verify the required parameter 'body' is set
9221
9224
  if (body === undefined || body === null) {
@@ -9223,9 +9226,9 @@ class AuthorizationApi {
9223
9226
  }
9224
9227
 
9225
9228
  return this.apiClient.callApi(
9226
- '/api/v2/users/{userId}/roles',
9229
+ '/api/v2/users/{subjectId}/roles',
9227
9230
  'PUT',
9228
- { 'userId': userId },
9231
+ { 'subjectId': subjectId },
9229
9232
  { },
9230
9233
  { },
9231
9234
  { },
@@ -9242,7 +9245,7 @@ class BillingApi {
9242
9245
  /**
9243
9246
  * Billing service.
9244
9247
  * @module purecloud-platform-client-v2/api/BillingApi
9245
- * @version 139.0.0
9248
+ * @version 141.0.0
9246
9249
  */
9247
9250
 
9248
9251
  /**
@@ -9322,7 +9325,7 @@ class ChatApi {
9322
9325
  /**
9323
9326
  * Chat service.
9324
9327
  * @module purecloud-platform-client-v2/api/ChatApi
9325
- * @version 139.0.0
9328
+ * @version 141.0.0
9326
9329
  */
9327
9330
 
9328
9331
  /**
@@ -9413,7 +9416,7 @@ class CoachingApi {
9413
9416
  /**
9414
9417
  * Coaching service.
9415
9418
  * @module purecloud-platform-client-v2/api/CoachingApi
9416
- * @version 139.0.0
9419
+ * @version 141.0.0
9417
9420
  */
9418
9421
 
9419
9422
  /**
@@ -9990,7 +9993,7 @@ class ContentManagementApi {
9990
9993
  /**
9991
9994
  * ContentManagement service.
9992
9995
  * @module purecloud-platform-client-v2/api/ContentManagementApi
9993
- * @version 139.0.0
9996
+ * @version 141.0.0
9994
9997
  */
9995
9998
 
9996
9999
  /**
@@ -11130,7 +11133,7 @@ class ConversationsApi {
11130
11133
  /**
11131
11134
  * Conversations service.
11132
11135
  * @module purecloud-platform-client-v2/api/ConversationsApi
11133
- * @version 139.0.0
11136
+ * @version 141.0.0
11134
11137
  */
11135
11138
 
11136
11139
  /**
@@ -16064,7 +16067,7 @@ class DataExtensionsApi {
16064
16067
  /**
16065
16068
  * DataExtensions service.
16066
16069
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
16067
- * @version 139.0.0
16070
+ * @version 141.0.0
16068
16071
  */
16069
16072
 
16070
16073
  /**
@@ -16150,7 +16153,7 @@ class ExternalContactsApi {
16150
16153
  /**
16151
16154
  * ExternalContacts service.
16152
16155
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
16153
- * @version 139.0.0
16156
+ * @version 141.0.0
16154
16157
  */
16155
16158
 
16156
16159
  /**
@@ -17893,7 +17896,7 @@ class FaxApi {
17893
17896
  /**
17894
17897
  * Fax service.
17895
17898
  * @module purecloud-platform-client-v2/api/FaxApi
17896
- * @version 139.0.0
17899
+ * @version 141.0.0
17897
17900
  */
17898
17901
 
17899
17902
  /**
@@ -18064,7 +18067,7 @@ class FlowsApi {
18064
18067
  /**
18065
18068
  * Flows service.
18066
18069
  * @module purecloud-platform-client-v2/api/FlowsApi
18067
- * @version 139.0.0
18070
+ * @version 141.0.0
18068
18071
  */
18069
18072
 
18070
18073
  /**
@@ -18135,7 +18138,7 @@ class GamificationApi {
18135
18138
  /**
18136
18139
  * Gamification service.
18137
18140
  * @module purecloud-platform-client-v2/api/GamificationApi
18138
- * @version 139.0.0
18141
+ * @version 141.0.0
18139
18142
  */
18140
18143
 
18141
18144
  /**
@@ -18280,7 +18283,7 @@ class GamificationApi {
18280
18283
 
18281
18284
  /**
18282
18285
  * Gamified metric by id
18283
- *
18286
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
18284
18287
  * @param {String} metricId metric Id
18285
18288
  * @param {Object} opts Optional parameters
18286
18289
  * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
@@ -18355,7 +18358,7 @@ class GamificationApi {
18355
18358
 
18356
18359
  /**
18357
18360
  * All gamified metrics for a given profile
18358
- *
18361
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
18359
18362
  * @param {Object} opts Optional parameters
18360
18363
  * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
18361
18364
  * @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
@@ -18758,6 +18761,157 @@ class GamificationApi {
18758
18761
  );
18759
18762
  }
18760
18763
 
18764
+ /**
18765
+ * Average performance values trends by metric of a user
18766
+ *
18767
+ * @param {String} profileId performanceProfileId
18768
+ * @param {String} metricId metricId
18769
+ * @param {String} userId
18770
+ * @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18771
+ * @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18772
+ * @param {Object} opts Optional parameters
18773
+ * @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18774
+ * @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
18775
+ */
18776
+ getGamificationScorecardsProfileMetricUserValuesTrends(profileId, metricId, userId, startWorkday, endWorkday, opts) {
18777
+ opts = opts || {};
18778
+
18779
+ // verify the required parameter 'profileId' is set
18780
+ if (profileId === undefined || profileId === null) {
18781
+ throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
18782
+ }
18783
+ // verify the required parameter 'metricId' is set
18784
+ if (metricId === undefined || metricId === null) {
18785
+ throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
18786
+ }
18787
+ // verify the required parameter 'userId' is set
18788
+ if (userId === undefined || userId === null) {
18789
+ throw 'Missing the required parameter "userId" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
18790
+ }
18791
+ // verify the required parameter 'startWorkday' is set
18792
+ if (startWorkday === undefined || startWorkday === null) {
18793
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
18794
+ }
18795
+ // verify the required parameter 'endWorkday' is set
18796
+ if (endWorkday === undefined || endWorkday === null) {
18797
+ throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUserValuesTrends';
18798
+ }
18799
+
18800
+ return this.apiClient.callApi(
18801
+ '/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/{userId}/values/trends',
18802
+ 'GET',
18803
+ { 'profileId': profileId,'metricId': metricId,'userId': userId },
18804
+ { 'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
18805
+ { },
18806
+ { },
18807
+ null,
18808
+ ['PureCloud OAuth'],
18809
+ ['application/json'],
18810
+ ['application/json']
18811
+ );
18812
+ }
18813
+
18814
+ /**
18815
+ * Average performance values trends by metric of a division or a performance profile
18816
+ *
18817
+ * @param {String} profileId performanceProfileId
18818
+ * @param {String} metricId metricId
18819
+ * @param {Object} filterType Filter type for the query request.
18820
+ * @param {String} filterId ID for the filter type. For example, division Id
18821
+ * @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18822
+ * @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18823
+ * @param {Object} opts Optional parameters
18824
+ * @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18825
+ * @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
18826
+ */
18827
+ getGamificationScorecardsProfileMetricUsersValuesTrends(profileId, metricId, filterType, filterId, startWorkday, endWorkday, opts) {
18828
+ opts = opts || {};
18829
+
18830
+ // verify the required parameter 'profileId' is set
18831
+ if (profileId === undefined || profileId === null) {
18832
+ throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
18833
+ }
18834
+ // verify the required parameter 'metricId' is set
18835
+ if (metricId === undefined || metricId === null) {
18836
+ throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
18837
+ }
18838
+ // verify the required parameter 'filterType' is set
18839
+ if (filterType === undefined || filterType === null) {
18840
+ throw 'Missing the required parameter "filterType" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
18841
+ }
18842
+ // verify the required parameter 'filterId' is set
18843
+ if (filterId === undefined || filterId === null) {
18844
+ throw 'Missing the required parameter "filterId" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
18845
+ }
18846
+ // verify the required parameter 'startWorkday' is set
18847
+ if (startWorkday === undefined || startWorkday === null) {
18848
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
18849
+ }
18850
+ // verify the required parameter 'endWorkday' is set
18851
+ if (endWorkday === undefined || endWorkday === null) {
18852
+ throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricUsersValuesTrends';
18853
+ }
18854
+
18855
+ return this.apiClient.callApi(
18856
+ '/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/users/values/trends',
18857
+ 'GET',
18858
+ { 'profileId': profileId,'metricId': metricId },
18859
+ { 'filterType': filterType,'filterId': filterId,'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
18860
+ { },
18861
+ { },
18862
+ null,
18863
+ ['PureCloud OAuth'],
18864
+ ['application/json'],
18865
+ ['application/json']
18866
+ );
18867
+ }
18868
+
18869
+ /**
18870
+ * Average performance values trends by metric of the requesting user
18871
+ *
18872
+ * @param {String} profileId performanceProfileId
18873
+ * @param {String} metricId metricId
18874
+ * @param {String} startWorkday Start workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18875
+ * @param {String} endWorkday End workday of querying workdays range. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18876
+ * @param {Object} opts Optional parameters
18877
+ * @param {Object} opts.filterType Filter type for the query request. If not set, returns the values trends of the requesting user
18878
+ * @param {String} opts.referenceWorkday Reference workday for the trend. Used to determine the associated metric definition. If not set, then the value of endWorkday is used. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
18879
+ * @param {String} opts.timeZone Timezone for the workday. Defaults to UTC (default to UTC)
18880
+ */
18881
+ getGamificationScorecardsProfileMetricValuesTrends(profileId, metricId, startWorkday, endWorkday, opts) {
18882
+ opts = opts || {};
18883
+
18884
+ // verify the required parameter 'profileId' is set
18885
+ if (profileId === undefined || profileId === null) {
18886
+ throw 'Missing the required parameter "profileId" when calling getGamificationScorecardsProfileMetricValuesTrends';
18887
+ }
18888
+ // verify the required parameter 'metricId' is set
18889
+ if (metricId === undefined || metricId === null) {
18890
+ throw 'Missing the required parameter "metricId" when calling getGamificationScorecardsProfileMetricValuesTrends';
18891
+ }
18892
+ // verify the required parameter 'startWorkday' is set
18893
+ if (startWorkday === undefined || startWorkday === null) {
18894
+ throw 'Missing the required parameter "startWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
18895
+ }
18896
+ // verify the required parameter 'endWorkday' is set
18897
+ if (endWorkday === undefined || endWorkday === null) {
18898
+ throw 'Missing the required parameter "endWorkday" when calling getGamificationScorecardsProfileMetricValuesTrends';
18899
+ }
18900
+
18901
+ return this.apiClient.callApi(
18902
+ '/api/v2/gamification/scorecards/profiles/{profileId}/metrics/{metricId}/values/trends',
18903
+ 'GET',
18904
+ { 'profileId': profileId,'metricId': metricId },
18905
+ { 'filterType': opts['filterType'],'startWorkday': startWorkday,'endWorkday': endWorkday,'referenceWorkday': opts['referenceWorkday'],'timeZone': opts['timeZone'] },
18906
+ { },
18907
+ { },
18908
+ null,
18909
+ ['PureCloud OAuth'],
18910
+ ['application/json'],
18911
+ ['application/json']
18912
+ );
18913
+ }
18914
+
18761
18915
  /**
18762
18916
  * Workday performance metrics for a user
18763
18917
  *
@@ -19210,7 +19364,7 @@ class GamificationApi {
19210
19364
 
19211
19365
  /**
19212
19366
  * Creates a gamified metric with a given metric definition and metric objective
19213
- *
19367
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
19214
19368
  * @param {Object} body Metric
19215
19369
  */
19216
19370
  postGamificationMetrics(body) {
@@ -19439,7 +19593,7 @@ class GamificationApi {
19439
19593
 
19440
19594
  /**
19441
19595
  * Updates a metric
19442
- *
19596
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
19443
19597
  * @param {String} metricId metric Id
19444
19598
  * @param {Object} body Metric
19445
19599
  * @param {Object} opts Optional parameters
@@ -19566,7 +19720,7 @@ class GeneralDataProtectionRegulationApi {
19566
19720
  /**
19567
19721
  * GeneralDataProtectionRegulation service.
19568
19722
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
19569
- * @version 139.0.0
19723
+ * @version 141.0.0
19570
19724
  */
19571
19725
 
19572
19726
  /**
@@ -19696,7 +19850,7 @@ class GeolocationApi {
19696
19850
  /**
19697
19851
  * Geolocation service.
19698
19852
  * @module purecloud-platform-client-v2/api/GeolocationApi
19699
- * @version 139.0.0
19853
+ * @version 141.0.0
19700
19854
  */
19701
19855
 
19702
19856
  /**
@@ -19827,7 +19981,7 @@ class GreetingsApi {
19827
19981
  /**
19828
19982
  * Greetings service.
19829
19983
  * @module purecloud-platform-client-v2/api/GreetingsApi
19830
- * @version 139.0.0
19984
+ * @version 141.0.0
19831
19985
  */
19832
19986
 
19833
19987
  /**
@@ -20282,7 +20436,7 @@ class GroupsApi {
20282
20436
  /**
20283
20437
  * Groups service.
20284
20438
  * @module purecloud-platform-client-v2/api/GroupsApi
20285
- * @version 139.0.0
20439
+ * @version 141.0.0
20286
20440
  */
20287
20441
 
20288
20442
  /**
@@ -20687,7 +20841,7 @@ class IdentityProviderApi {
20687
20841
  /**
20688
20842
  * IdentityProvider service.
20689
20843
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
20690
- * @version 139.0.0
20844
+ * @version 141.0.0
20691
20845
  */
20692
20846
 
20693
20847
  /**
@@ -21443,7 +21597,7 @@ class IntegrationsApi {
21443
21597
  /**
21444
21598
  * Integrations service.
21445
21599
  * @module purecloud-platform-client-v2/api/IntegrationsApi
21446
- * @version 139.0.0
21600
+ * @version 141.0.0
21447
21601
  */
21448
21602
 
21449
21603
  /**
@@ -23120,7 +23274,7 @@ class JourneyApi {
23120
23274
  /**
23121
23275
  * Journey service.
23122
23276
  * @module purecloud-platform-client-v2/api/JourneyApi
23123
- * @version 139.0.0
23277
+ * @version 141.0.0
23124
23278
  */
23125
23279
 
23126
23280
  /**
@@ -23831,7 +23985,7 @@ class KnowledgeApi {
23831
23985
  /**
23832
23986
  * Knowledge service.
23833
23987
  * @module purecloud-platform-client-v2/api/KnowledgeApi
23834
- * @version 139.0.0
23988
+ * @version 141.0.0
23835
23989
  */
23836
23990
 
23837
23991
  /**
@@ -24731,7 +24885,7 @@ class LanguageUnderstandingApi {
24731
24885
  /**
24732
24886
  * LanguageUnderstanding service.
24733
24887
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
24734
- * @version 139.0.0
24888
+ * @version 141.0.0
24735
24889
  */
24736
24890
 
24737
24891
  /**
@@ -25635,7 +25789,7 @@ class LanguagesApi {
25635
25789
  /**
25636
25790
  * Languages service.
25637
25791
  * @module purecloud-platform-client-v2/api/LanguagesApi
25638
- * @version 139.0.0
25792
+ * @version 141.0.0
25639
25793
  */
25640
25794
 
25641
25795
  /**
@@ -25903,7 +26057,7 @@ class LearningApi {
25903
26057
  /**
25904
26058
  * Learning service.
25905
26059
  * @module purecloud-platform-client-v2/api/LearningApi
25906
- * @version 139.0.0
26060
+ * @version 141.0.0
25907
26061
  */
25908
26062
 
25909
26063
  /**
@@ -26101,6 +26255,36 @@ class LearningApi {
26101
26255
  );
26102
26256
  }
26103
26257
 
26258
+ /**
26259
+ * Get a specific Learning Module job status
26260
+ *
26261
+ * @param {String} moduleId The ID of the learning module
26262
+ * @param {String} jobId The ID of the learning module job
26263
+ */
26264
+ getLearningModuleJob(moduleId, jobId) {
26265
+ // verify the required parameter 'moduleId' is set
26266
+ if (moduleId === undefined || moduleId === null) {
26267
+ throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
26268
+ }
26269
+ // verify the required parameter 'jobId' is set
26270
+ if (jobId === undefined || jobId === null) {
26271
+ throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
26272
+ }
26273
+
26274
+ return this.apiClient.callApi(
26275
+ '/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
26276
+ 'GET',
26277
+ { 'moduleId': moduleId,'jobId': jobId },
26278
+ { },
26279
+ { },
26280
+ { },
26281
+ null,
26282
+ ['PureCloud OAuth'],
26283
+ ['application/json'],
26284
+ ['application/json']
26285
+ );
26286
+ }
26287
+
26104
26288
  /**
26105
26289
  * Get a learning module rule
26106
26290
  *
@@ -26192,6 +26376,40 @@ class LearningApi {
26192
26376
  );
26193
26377
  }
26194
26378
 
26379
+ /**
26380
+ * Get all learning modules of an organization including assignments for a specific user
26381
+ *
26382
+ * @param {Array.<String>} userIds The IDs of the users to include
26383
+ * @param {Object} opts Optional parameters
26384
+ * @param {Number} opts.pageSize Page size (default to 25)
26385
+ * @param {Number} opts.pageNumber Page number (default to 1)
26386
+ * @param {String} opts.searchTerm Search Term (searches by name and description)
26387
+ * @param {Object} opts.overdue Specifies if only modules with overdue/not overdue (overdue is True or False) assignments are returned. If overdue is Any or omitted, both are returned and can including modules that are unassigned. (default to Any)
26388
+ * @param {Array.<String>} opts.assignmentStates Specifies the assignment states to return.
26389
+ * @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
26390
+ */
26391
+ getLearningModulesAssignments(userIds, opts) {
26392
+ opts = opts || {};
26393
+
26394
+ // verify the required parameter 'userIds' is set
26395
+ if (userIds === undefined || userIds === null) {
26396
+ throw 'Missing the required parameter "userIds" when calling getLearningModulesAssignments';
26397
+ }
26398
+
26399
+ return this.apiClient.callApi(
26400
+ '/api/v2/learning/modules/assignments',
26401
+ 'GET',
26402
+ { },
26403
+ { 'userIds': this.apiClient.buildCollectionParam(userIds, 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'searchTerm': opts['searchTerm'],'overdue': opts['overdue'],'assignmentStates': this.apiClient.buildCollectionParam(opts['assignmentStates'], 'multi'),'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
26404
+ { },
26405
+ { },
26406
+ null,
26407
+ ['PureCloud OAuth'],
26408
+ ['application/json'],
26409
+ ['application/json']
26410
+ );
26411
+ }
26412
+
26195
26413
  /**
26196
26414
  * Update Learning Assignment
26197
26415
  *
@@ -26246,6 +26464,56 @@ class LearningApi {
26246
26464
  );
26247
26465
  }
26248
26466
 
26467
+ /**
26468
+ * Reassign Learning Assignment
26469
+ * This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
26470
+ * @param {String} assignmentId The Learning Assignment ID
26471
+ */
26472
+ postLearningAssignmentReassign(assignmentId) {
26473
+ // verify the required parameter 'assignmentId' is set
26474
+ if (assignmentId === undefined || assignmentId === null) {
26475
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
26476
+ }
26477
+
26478
+ return this.apiClient.callApi(
26479
+ '/api/v2/learning/assignments/{assignmentId}/reassign',
26480
+ 'POST',
26481
+ { 'assignmentId': assignmentId },
26482
+ { },
26483
+ { },
26484
+ { },
26485
+ null,
26486
+ ['PureCloud OAuth'],
26487
+ ['application/json'],
26488
+ ['application/json']
26489
+ );
26490
+ }
26491
+
26492
+ /**
26493
+ * Reset Learning Assignment
26494
+ * This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
26495
+ * @param {String} assignmentId The Learning Assignment ID
26496
+ */
26497
+ postLearningAssignmentReset(assignmentId) {
26498
+ // verify the required parameter 'assignmentId' is set
26499
+ if (assignmentId === undefined || assignmentId === null) {
26500
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
26501
+ }
26502
+
26503
+ return this.apiClient.callApi(
26504
+ '/api/v2/learning/assignments/{assignmentId}/reset',
26505
+ 'POST',
26506
+ { 'assignmentId': assignmentId },
26507
+ { },
26508
+ { },
26509
+ { },
26510
+ null,
26511
+ ['PureCloud OAuth'],
26512
+ ['application/json'],
26513
+ ['application/json']
26514
+ );
26515
+ }
26516
+
26249
26517
  /**
26250
26518
  * Create Learning Assignment
26251
26519
  *
@@ -26343,6 +26611,36 @@ class LearningApi {
26343
26611
  );
26344
26612
  }
26345
26613
 
26614
+ /**
26615
+ * Starts a specified operation on learning module
26616
+ * This will initiate operation specified in the request body for a learning module
26617
+ * @param {String} moduleId The ID of the learning module
26618
+ * @param {Object} body The learning module job request
26619
+ */
26620
+ postLearningModuleJobs(moduleId, body) {
26621
+ // verify the required parameter 'moduleId' is set
26622
+ if (moduleId === undefined || moduleId === null) {
26623
+ throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
26624
+ }
26625
+ // verify the required parameter 'body' is set
26626
+ if (body === undefined || body === null) {
26627
+ throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
26628
+ }
26629
+
26630
+ return this.apiClient.callApi(
26631
+ '/api/v2/learning/modules/{moduleId}/jobs',
26632
+ 'POST',
26633
+ { 'moduleId': moduleId },
26634
+ { },
26635
+ { },
26636
+ { },
26637
+ body,
26638
+ ['PureCloud OAuth'],
26639
+ ['application/json'],
26640
+ ['application/json']
26641
+ );
26642
+ }
26643
+
26346
26644
  /**
26347
26645
  * Publish a Learning module
26348
26646
  *
@@ -26494,7 +26792,7 @@ class LicenseApi {
26494
26792
  /**
26495
26793
  * License service.
26496
26794
  * @module purecloud-platform-client-v2/api/LicenseApi
26497
- * @version 139.0.0
26795
+ * @version 141.0.0
26498
26796
  */
26499
26797
 
26500
26798
  /**
@@ -26732,7 +27030,7 @@ class LocationsApi {
26732
27030
  /**
26733
27031
  * Locations service.
26734
27032
  * @module purecloud-platform-client-v2/api/LocationsApi
26735
- * @version 139.0.0
27033
+ * @version 141.0.0
26736
27034
  */
26737
27035
 
26738
27036
  /**
@@ -26968,7 +27266,7 @@ class MessagingApi {
26968
27266
  /**
26969
27267
  * Messaging service.
26970
27268
  * @module purecloud-platform-client-v2/api/MessagingApi
26971
- * @version 139.0.0
27269
+ * @version 141.0.0
26972
27270
  */
26973
27271
 
26974
27272
  /**
@@ -27119,7 +27417,7 @@ class MobileDevicesApi {
27119
27417
  /**
27120
27418
  * MobileDevices service.
27121
27419
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
27122
- * @version 139.0.0
27420
+ * @version 141.0.0
27123
27421
  */
27124
27422
 
27125
27423
  /**
@@ -27270,7 +27568,7 @@ class NotificationsApi {
27270
27568
  /**
27271
27569
  * Notifications service.
27272
27570
  * @module purecloud-platform-client-v2/api/NotificationsApi
27273
- * @version 139.0.0
27571
+ * @version 141.0.0
27274
27572
  */
27275
27573
 
27276
27574
  /**
@@ -27495,7 +27793,7 @@ class OAuthApi {
27495
27793
  /**
27496
27794
  * OAuth service.
27497
27795
  * @module purecloud-platform-client-v2/api/OAuthApi
27498
- * @version 139.0.0
27796
+ * @version 141.0.0
27499
27797
  */
27500
27798
 
27501
27799
  /**
@@ -27861,7 +28159,7 @@ class ObjectsApi {
27861
28159
  /**
27862
28160
  * Objects service.
27863
28161
  * @module purecloud-platform-client-v2/api/ObjectsApi
27864
- * @version 139.0.0
28162
+ * @version 141.0.0
27865
28163
  */
27866
28164
 
27867
28165
  /**
@@ -28132,7 +28430,7 @@ class OrganizationApi {
28132
28430
  /**
28133
28431
  * Organization service.
28134
28432
  * @module purecloud-platform-client-v2/api/OrganizationApi
28135
- * @version 139.0.0
28433
+ * @version 141.0.0
28136
28434
  */
28137
28435
 
28138
28436
  /**
@@ -28535,7 +28833,7 @@ class OrganizationAuthorizationApi {
28535
28833
  /**
28536
28834
  * OrganizationAuthorization service.
28537
28835
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
28538
- * @version 139.0.0
28836
+ * @version 141.0.0
28539
28837
  */
28540
28838
 
28541
28839
  /**
@@ -29460,7 +29758,7 @@ class OutboundApi {
29460
29758
  /**
29461
29759
  * Outbound service.
29462
29760
  * @module purecloud-platform-client-v2/api/OutboundApi
29463
- * @version 139.0.0
29761
+ * @version 141.0.0
29464
29762
  */
29465
29763
 
29466
29764
  /**
@@ -32715,7 +33013,7 @@ class PresenceApi {
32715
33013
  /**
32716
33014
  * Presence service.
32717
33015
  * @module purecloud-platform-client-v2/api/PresenceApi
32718
- * @version 139.0.0
33016
+ * @version 141.0.0
32719
33017
  */
32720
33018
 
32721
33019
  /**
@@ -33037,7 +33335,7 @@ class QualityApi {
33037
33335
  /**
33038
33336
  * Quality service.
33039
33337
  * @module purecloud-platform-client-v2/api/QualityApi
33040
- * @version 139.0.0
33338
+ * @version 141.0.0
33041
33339
  */
33042
33340
 
33043
33341
  /**
@@ -33795,7 +34093,7 @@ class QualityApi {
33795
34093
  /**
33796
34094
  * Retrieve a list of the latest form versions by context ids
33797
34095
  *
33798
- * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
34096
+ * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids. The maximum number of ids allowed in this list is 100.
33799
34097
  * @param {Object} opts Optional parameters
33800
34098
  * @param {Boolean} opts.published If true, the latest published version will be included. If false, only the unpublished version will be included. (default to true)
33801
34099
  */
@@ -34615,7 +34913,7 @@ class RecordingApi {
34615
34913
  /**
34616
34914
  * Recording service.
34617
34915
  * @module purecloud-platform-client-v2/api/RecordingApi
34618
- * @version 139.0.0
34916
+ * @version 141.0.0
34619
34917
  */
34620
34918
 
34621
34919
  /**
@@ -36268,7 +36566,7 @@ class ResponseManagementApi {
36268
36566
  /**
36269
36567
  * ResponseManagement service.
36270
36568
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
36271
- * @version 139.0.0
36569
+ * @version 141.0.0
36272
36570
  */
36273
36571
 
36274
36572
  /**
@@ -36752,7 +37050,7 @@ class RoutingApi {
36752
37050
  /**
36753
37051
  * Routing service.
36754
37052
  * @module purecloud-platform-client-v2/api/RoutingApi
36755
- * @version 139.0.0
37053
+ * @version 141.0.0
36756
37054
  */
36757
37055
 
36758
37056
  /**
@@ -37581,16 +37879,20 @@ class RoutingApi {
37581
37879
  }
37582
37880
 
37583
37881
  /**
37584
- * Get a list of Key Performance Indicators available for the predictors.
37882
+ * Get a list of Key Performance Indicators
37585
37883
  *
37884
+ * @param {Object} opts Optional parameters
37885
+ * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
37586
37886
  */
37587
- getRoutingPredictorsKeyperformanceindicators() {
37887
+ getRoutingPredictorsKeyperformanceindicators(opts) {
37888
+ opts = opts || {};
37889
+
37588
37890
 
37589
37891
  return this.apiClient.callApi(
37590
37892
  '/api/v2/routing/predictors/keyperformanceindicators',
37591
37893
  'GET',
37592
37894
  { },
37593
- { },
37895
+ { 'kpiGroup': opts['kpiGroup'] },
37594
37896
  { },
37595
37897
  { },
37596
37898
  null,
@@ -37858,6 +38160,8 @@ class RoutingApi {
37858
38160
  * @param {String} opts.name Filter by queue name
37859
38161
  * @param {Array.<String>} opts.id Filter by queue ID(s)
37860
38162
  * @param {Array.<String>} opts.divisionId Filter by queue division ID(s)
38163
+ * @param {Array.<String>} opts.peerId Filter by queue peer ID(s)
38164
+ * @param {Boolean} opts.hasPeer Filter by queues associated with peer
37861
38165
  */
37862
38166
  getRoutingQueues(opts) {
37863
38167
  opts = opts || {};
@@ -37867,7 +38171,7 @@ class RoutingApi {
37867
38171
  '/api/v2/routing/queues',
37868
38172
  'GET',
37869
38173
  { },
37870
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
38174
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'name': opts['name'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi'),'peerId': this.apiClient.buildCollectionParam(opts['peerId'], 'multi'),'hasPeer': opts['hasPeer'] },
37871
38175
  { },
37872
38176
  { },
37873
38177
  null,
@@ -39667,7 +39971,7 @@ class SCIMApi {
39667
39971
  /**
39668
39972
  * SCIM service.
39669
39973
  * @module purecloud-platform-client-v2/api/SCIMApi
39670
- * @version 139.0.0
39974
+ * @version 141.0.0
39671
39975
  */
39672
39976
 
39673
39977
  /**
@@ -40544,7 +40848,7 @@ class ScriptsApi {
40544
40848
  /**
40545
40849
  * Scripts service.
40546
40850
  * @module purecloud-platform-client-v2/api/ScriptsApi
40547
- * @version 139.0.0
40851
+ * @version 141.0.0
40548
40852
  */
40549
40853
 
40550
40854
  /**
@@ -40963,7 +41267,7 @@ class SearchApi {
40963
41267
  /**
40964
41268
  * Search service.
40965
41269
  * @module purecloud-platform-client-v2/api/SearchApi
40966
- * @version 139.0.0
41270
+ * @version 141.0.0
40967
41271
  */
40968
41272
 
40969
41273
  /**
@@ -41498,7 +41802,7 @@ class SpeechTextAnalyticsApi {
41498
41802
  /**
41499
41803
  * SpeechTextAnalytics service.
41500
41804
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
41501
- * @version 139.0.0
41805
+ * @version 141.0.0
41502
41806
  */
41503
41807
 
41504
41808
  /**
@@ -42351,7 +42655,7 @@ class StationsApi {
42351
42655
  /**
42352
42656
  * Stations service.
42353
42657
  * @module purecloud-platform-client-v2/api/StationsApi
42354
- * @version 139.0.0
42658
+ * @version 141.0.0
42355
42659
  */
42356
42660
 
42357
42661
  /**
@@ -42498,7 +42802,7 @@ class SuggestApi {
42498
42802
  /**
42499
42803
  * Suggest service.
42500
42804
  * @module purecloud-platform-client-v2/api/SuggestApi
42501
- * @version 139.0.0
42805
+ * @version 141.0.0
42502
42806
  */
42503
42807
 
42504
42808
  /**
@@ -42637,7 +42941,7 @@ class TelephonyApi {
42637
42941
  /**
42638
42942
  * Telephony service.
42639
42943
  * @module purecloud-platform-client-v2/api/TelephonyApi
42640
- * @version 139.0.0
42944
+ * @version 141.0.0
42641
42945
  */
42642
42946
 
42643
42947
  /**
@@ -42745,7 +43049,7 @@ class TelephonyProvidersEdgeApi {
42745
43049
  /**
42746
43050
  * TelephonyProvidersEdge service.
42747
43051
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
42748
- * @version 139.0.0
43052
+ * @version 141.0.0
42749
43053
  */
42750
43054
 
42751
43055
  /**
@@ -46378,7 +46682,7 @@ class TextbotsApi {
46378
46682
  /**
46379
46683
  * Textbots service.
46380
46684
  * @module purecloud-platform-client-v2/api/TextbotsApi
46381
- * @version 139.0.0
46685
+ * @version 141.0.0
46382
46686
  */
46383
46687
 
46384
46688
  /**
@@ -46506,7 +46810,7 @@ class TokensApi {
46506
46810
  /**
46507
46811
  * Tokens service.
46508
46812
  * @module purecloud-platform-client-v2/api/TokensApi
46509
- * @version 139.0.0
46813
+ * @version 141.0.0
46510
46814
  */
46511
46815
 
46512
46816
  /**
@@ -46612,7 +46916,7 @@ class UploadsApi {
46612
46916
  /**
46613
46917
  * Uploads service.
46614
46918
  * @module purecloud-platform-client-v2/api/UploadsApi
46615
- * @version 139.0.0
46919
+ * @version 141.0.0
46616
46920
  */
46617
46921
 
46618
46922
  /**
@@ -46763,7 +47067,7 @@ class UsageApi {
46763
47067
  /**
46764
47068
  * Usage service.
46765
47069
  * @module purecloud-platform-client-v2/api/UsageApi
46766
- * @version 139.0.0
47070
+ * @version 141.0.0
46767
47071
  */
46768
47072
 
46769
47073
  /**
@@ -46834,7 +47138,7 @@ class UserRecordingsApi {
46834
47138
  /**
46835
47139
  * UserRecordings service.
46836
47140
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
46837
- * @version 139.0.0
47141
+ * @version 141.0.0
46838
47142
  */
46839
47143
 
46840
47144
  /**
@@ -47018,7 +47322,7 @@ class UsersApi {
47018
47322
  /**
47019
47323
  * Users service.
47020
47324
  * @module purecloud-platform-client-v2/api/UsersApi
47021
- * @version 139.0.0
47325
+ * @version 141.0.0
47022
47326
  */
47023
47327
 
47024
47328
  /**
@@ -47838,18 +48142,18 @@ class UsersApi {
47838
48142
  /**
47839
48143
  * Returns a listing of roles and permissions for a user.
47840
48144
  *
47841
- * @param {String} userId User ID
48145
+ * @param {String} subjectId User ID
47842
48146
  */
47843
- getUserRoles(userId) {
47844
- // verify the required parameter 'userId' is set
47845
- if (userId === undefined || userId === null) {
47846
- throw 'Missing the required parameter "userId" when calling getUserRoles';
48147
+ getUserRoles(subjectId) {
48148
+ // verify the required parameter 'subjectId' is set
48149
+ if (subjectId === undefined || subjectId === null) {
48150
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
47847
48151
  }
47848
48152
 
47849
48153
  return this.apiClient.callApi(
47850
- '/api/v2/users/{userId}/roles',
48154
+ '/api/v2/users/{subjectId}/roles',
47851
48155
  'GET',
47852
- { 'userId': userId },
48156
+ { 'subjectId': subjectId },
47853
48157
  { },
47854
48158
  { },
47855
48159
  { },
@@ -49102,13 +49406,13 @@ class UsersApi {
49102
49406
  /**
49103
49407
  * Sets the user's roles
49104
49408
  *
49105
- * @param {String} userId User ID
49409
+ * @param {String} subjectId User ID
49106
49410
  * @param {Array.<String>} body List of roles
49107
49411
  */
49108
- putUserRoles(userId, body) {
49109
- // verify the required parameter 'userId' is set
49110
- if (userId === undefined || userId === null) {
49111
- throw 'Missing the required parameter "userId" when calling putUserRoles';
49412
+ putUserRoles(subjectId, body) {
49413
+ // verify the required parameter 'subjectId' is set
49414
+ if (subjectId === undefined || subjectId === null) {
49415
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
49112
49416
  }
49113
49417
  // verify the required parameter 'body' is set
49114
49418
  if (body === undefined || body === null) {
@@ -49116,9 +49420,9 @@ class UsersApi {
49116
49420
  }
49117
49421
 
49118
49422
  return this.apiClient.callApi(
49119
- '/api/v2/users/{userId}/roles',
49423
+ '/api/v2/users/{subjectId}/roles',
49120
49424
  'PUT',
49121
- { 'userId': userId },
49425
+ { 'subjectId': subjectId },
49122
49426
  { },
49123
49427
  { },
49124
49428
  { },
@@ -49320,7 +49624,7 @@ class UtilitiesApi {
49320
49624
  /**
49321
49625
  * Utilities service.
49322
49626
  * @module purecloud-platform-client-v2/api/UtilitiesApi
49323
- * @version 139.0.0
49627
+ * @version 141.0.0
49324
49628
  */
49325
49629
 
49326
49630
  /**
@@ -49431,7 +49735,7 @@ class VoicemailApi {
49431
49735
  /**
49432
49736
  * Voicemail service.
49433
49737
  * @module purecloud-platform-client-v2/api/VoicemailApi
49434
- * @version 139.0.0
49738
+ * @version 141.0.0
49435
49739
  */
49436
49740
 
49437
49741
  /**
@@ -50098,7 +50402,7 @@ class WebChatApi {
50098
50402
  /**
50099
50403
  * WebChat service.
50100
50404
  * @module purecloud-platform-client-v2/api/WebChatApi
50101
- * @version 139.0.0
50405
+ * @version 141.0.0
50102
50406
  */
50103
50407
 
50104
50408
  /**
@@ -50642,7 +50946,7 @@ class WebDeploymentsApi {
50642
50946
  /**
50643
50947
  * WebDeployments service.
50644
50948
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
50645
- * @version 139.0.0
50949
+ * @version 141.0.0
50646
50950
  */
50647
50951
 
50648
50952
  /**
@@ -50997,7 +51301,7 @@ class WebMessagingApi {
50997
51301
  /**
50998
51302
  * WebMessaging service.
50999
51303
  * @module purecloud-platform-client-v2/api/WebMessagingApi
51000
- * @version 139.0.0
51304
+ * @version 141.0.0
51001
51305
  */
51002
51306
 
51003
51307
  /**
@@ -51043,7 +51347,7 @@ class WidgetsApi {
51043
51347
  /**
51044
51348
  * Widgets service.
51045
51349
  * @module purecloud-platform-client-v2/api/WidgetsApi
51046
- * @version 139.0.0
51350
+ * @version 141.0.0
51047
51351
  */
51048
51352
 
51049
51353
  /**
@@ -51189,7 +51493,7 @@ class WorkforceManagementApi {
51189
51493
  /**
51190
51494
  * WorkforceManagement service.
51191
51495
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
51192
- * @version 139.0.0
51496
+ * @version 141.0.0
51193
51497
  */
51194
51498
 
51195
51499
  /**
@@ -55440,7 +55744,7 @@ class WorkforceManagementApi {
55440
55744
  * </pre>
55441
55745
  * </p>
55442
55746
  * @module purecloud-platform-client-v2/index
55443
- * @version 139.0.0
55747
+ * @version 141.0.0
55444
55748
  */
55445
55749
  class platformClient {
55446
55750
  constructor() {