purecloud-platform-client-v2 138.0.1 → 140.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (73) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +537 -161
  3. package/dist/web-amd/purecloud-platform-client-v2.js +537 -162
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +537 -161
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +2631 -199
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +783 -224
  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 +271 -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 +28 -27
  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 +5 -5
  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 +111 -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 +16 -24
  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',
@@ -399,7 +401,7 @@ class Configuration {
399
401
 
400
402
  /**
401
403
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 138.0.1
404
+ * @version 140.0.1
403
405
  */
404
406
  class ApiClient {
405
407
  /**
@@ -434,7 +436,7 @@ class ApiClient {
434
436
 
435
437
  /**
436
438
  * Enumeration of collection format separator strategies.
437
- * @enum {String}
439
+ * @enum {String}
438
440
  * @readonly
439
441
  */
440
442
  this.CollectionFormatEnum = {
@@ -581,7 +583,7 @@ class ApiClient {
581
583
  // Load current auth data
582
584
  const tempState = this.authData.state;
583
585
  this.authData = localStorage.getItem(`${this.settingsPrefix}_auth_data`);
584
- if (!this.authData)
586
+ if (!this.authData)
585
587
  this.authData = {};
586
588
  else
587
589
  this.authData = JSON.parse(this.authData);
@@ -601,7 +603,7 @@ class ApiClient {
601
603
  * @description Initiates the implicit grant login flow. Will attempt to load the token from local storage, if enabled.
602
604
  * @param {string} clientId - The client ID of an OAuth Implicit Grant client
603
605
  * @param {string} redirectUri - The redirect URI of the OAuth Implicit Grant client
604
- * @param {object} opts - (optional) Additional options
606
+ * @param {object} opts - (optional) Additional options
605
607
  * @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.
606
608
  * @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.
607
609
  * @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.
@@ -747,9 +749,9 @@ class ApiClient {
747
749
  }
748
750
  var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
749
751
  var request = this._formAuthRequest(encodedData,
750
- { grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer' },
751
- { orgName: orgName },
752
- { assertion: assertion });
752
+ { grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
753
+ orgName: orgName,
754
+ assertion: assertion });
753
755
  request.proxy = this.proxy;
754
756
  var bodyParam = {
755
757
  grant_type: 'urn:ietf:params:oauth:grant-type:saml2-bearer',
@@ -828,9 +830,9 @@ class ApiClient {
828
830
  }
829
831
  var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
830
832
  var request = this._formAuthRequest(encodedData,
831
- { grant_type: 'authorization_code' },
832
- { code: authCode },
833
- { redirect_uri: redirectUri });
833
+ { grant_type: 'authorization_code',
834
+ code: authCode,
835
+ redirect_uri: redirectUri });
834
836
  request.proxy = this.proxy;
835
837
  var bodyParam = {
836
838
  grant_type: 'authorization_code',
@@ -856,7 +858,7 @@ class ApiClient {
856
858
  return;
857
859
  }
858
860
  var encodedData = Buffer.from(clientId + ':' + clientSecret).toString('base64');
859
- var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token' }, { refresh_token: refreshToken });
861
+ var request = this._formAuthRequest(encodedData, { grant_type: 'refresh_token' , refresh_token: refreshToken });
860
862
  request.proxy = this.proxy;
861
863
  var bodyParam = {
862
864
  grant_type: 'refresh_token',
@@ -933,8 +935,9 @@ class ApiClient {
933
935
  /**
934
936
  * @description Utility function to create the request for auth requests
935
937
  * @param {string} encodedData - Base64 encoded client and clientSecret pair
938
+ * @param {object} data - data to url form encode
936
939
  */
937
- _formAuthRequest(encodedData) {
940
+ _formAuthRequest(encodedData, data) {
938
941
  var request = axios__default["default"]({
939
942
  method: `POST`,
940
943
  url: `https://login.${this.config.environment}/oauth/token`,
@@ -942,7 +945,7 @@ class ApiClient {
942
945
  'Authorization': 'Basic ' + encodedData,
943
946
  'Content-Type': 'application/x-www-form-urlencoded'
944
947
  },
945
- data: arguments
948
+ data: qs__default["default"].stringify(data)
946
949
  });
947
950
 
948
951
  return request;
@@ -1006,7 +1009,7 @@ class ApiClient {
1006
1009
  }
1007
1010
 
1008
1011
  // Test token
1009
- this.callApi('/api/v2/tokens/me', 'GET',
1012
+ this.callApi('/api/v2/tokens/me', 'GET',
1010
1013
  null, null, null, null, null, ['PureCloud OAuth'], ['application/json'], ['application/json'])
1011
1014
  .then(() => {
1012
1015
  resolve();
@@ -1032,7 +1035,7 @@ class ApiClient {
1032
1035
  const match = hashRegex.exec(h);
1033
1036
  if (match) hash[match[1]] = decodeURIComponent(decodeURIComponent(match[2].replace(/\+/g, '%20')));
1034
1037
  });
1035
-
1038
+
1036
1039
  // Check for error
1037
1040
  if (hash.error) {
1038
1041
  return hash;
@@ -1230,7 +1233,7 @@ class ApiClient {
1230
1233
  /**
1231
1234
  * Checks whether the given parameter value represents file-like content.
1232
1235
  * @param param The parameter to check.
1233
- * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
1236
+ * @returns {Boolean} <code>true</code> if <code>param</code> represents a file.
1234
1237
  */
1235
1238
  isFileParam(param) {
1236
1239
  // fs.ReadStream in Node.js (but not in runtime like browserify)
@@ -1477,7 +1480,7 @@ class AlertingApi {
1477
1480
  /**
1478
1481
  * Alerting service.
1479
1482
  * @module purecloud-platform-client-v2/api/AlertingApi
1480
- * @version 138.0.1
1483
+ * @version 140.0.1
1481
1484
  */
1482
1485
 
1483
1486
  /**
@@ -1791,7 +1794,7 @@ class AnalyticsApi {
1791
1794
  /**
1792
1795
  * Analytics service.
1793
1796
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1794
- * @version 138.0.1
1797
+ * @version 140.0.1
1795
1798
  */
1796
1799
 
1797
1800
  /**
@@ -2973,7 +2976,7 @@ class ArchitectApi {
2973
2976
  /**
2974
2977
  * Architect service.
2975
2978
  * @module purecloud-platform-client-v2/api/ArchitectApi
2976
- * @version 138.0.1
2979
+ * @version 140.0.1
2977
2980
  */
2978
2981
 
2979
2982
  /**
@@ -6018,7 +6021,7 @@ class AuditApi {
6018
6021
  /**
6019
6022
  * Audit service.
6020
6023
  * @module purecloud-platform-client-v2/api/AuditApi
6021
- * @version 138.0.1
6024
+ * @version 140.0.1
6022
6025
  */
6023
6026
 
6024
6027
  /**
@@ -6189,7 +6192,7 @@ class AuthorizationApi {
6189
6192
  /**
6190
6193
  * Authorization service.
6191
6194
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6192
- * @version 138.0.1
6195
+ * @version 140.0.1
6193
6196
  */
6194
6197
 
6195
6198
  /**
@@ -6794,18 +6797,18 @@ class AuthorizationApi {
6794
6797
  /**
6795
6798
  * Returns a listing of roles and permissions for a user.
6796
6799
  *
6797
- * @param {String} userId User ID
6800
+ * @param {String} subjectId User ID
6798
6801
  */
6799
- getUserRoles(userId) {
6800
- // verify the required parameter 'userId' is set
6801
- if (userId === undefined || userId === null) {
6802
- throw 'Missing the required parameter "userId" when calling getUserRoles';
6802
+ getUserRoles(subjectId) {
6803
+ // verify the required parameter 'subjectId' is set
6804
+ if (subjectId === undefined || subjectId === null) {
6805
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
6803
6806
  }
6804
6807
 
6805
6808
  return this.apiClient.callApi(
6806
- '/api/v2/users/{userId}/roles',
6809
+ '/api/v2/users/{subjectId}/roles',
6807
6810
  'GET',
6808
- { 'userId': userId },
6811
+ { 'subjectId': subjectId },
6809
6812
  { },
6810
6813
  { },
6811
6814
  { },
@@ -7339,13 +7342,13 @@ class AuthorizationApi {
7339
7342
  /**
7340
7343
  * Sets the user's roles
7341
7344
  *
7342
- * @param {String} userId User ID
7345
+ * @param {String} subjectId User ID
7343
7346
  * @param {Array.<String>} body List of roles
7344
7347
  */
7345
- putUserRoles(userId, body) {
7346
- // verify the required parameter 'userId' is set
7347
- if (userId === undefined || userId === null) {
7348
- throw 'Missing the required parameter "userId" when calling putUserRoles';
7348
+ putUserRoles(subjectId, body) {
7349
+ // verify the required parameter 'subjectId' is set
7350
+ if (subjectId === undefined || subjectId === null) {
7351
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
7349
7352
  }
7350
7353
  // verify the required parameter 'body' is set
7351
7354
  if (body === undefined || body === null) {
@@ -7353,9 +7356,9 @@ class AuthorizationApi {
7353
7356
  }
7354
7357
 
7355
7358
  return this.apiClient.callApi(
7356
- '/api/v2/users/{userId}/roles',
7359
+ '/api/v2/users/{subjectId}/roles',
7357
7360
  'PUT',
7358
- { 'userId': userId },
7361
+ { 'subjectId': subjectId },
7359
7362
  { },
7360
7363
  { },
7361
7364
  { },
@@ -7372,7 +7375,7 @@ class BillingApi {
7372
7375
  /**
7373
7376
  * Billing service.
7374
7377
  * @module purecloud-platform-client-v2/api/BillingApi
7375
- * @version 138.0.1
7378
+ * @version 140.0.1
7376
7379
  */
7377
7380
 
7378
7381
  /**
@@ -7452,7 +7455,7 @@ class ChatApi {
7452
7455
  /**
7453
7456
  * Chat service.
7454
7457
  * @module purecloud-platform-client-v2/api/ChatApi
7455
- * @version 138.0.1
7458
+ * @version 140.0.1
7456
7459
  */
7457
7460
 
7458
7461
  /**
@@ -7543,7 +7546,7 @@ class CoachingApi {
7543
7546
  /**
7544
7547
  * Coaching service.
7545
7548
  * @module purecloud-platform-client-v2/api/CoachingApi
7546
- * @version 138.0.1
7549
+ * @version 140.0.1
7547
7550
  */
7548
7551
 
7549
7552
  /**
@@ -8120,7 +8123,7 @@ class ContentManagementApi {
8120
8123
  /**
8121
8124
  * ContentManagement service.
8122
8125
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8123
- * @version 138.0.1
8126
+ * @version 140.0.1
8124
8127
  */
8125
8128
 
8126
8129
  /**
@@ -9260,7 +9263,7 @@ class ConversationsApi {
9260
9263
  /**
9261
9264
  * Conversations service.
9262
9265
  * @module purecloud-platform-client-v2/api/ConversationsApi
9263
- * @version 138.0.1
9266
+ * @version 140.0.1
9264
9267
  */
9265
9268
 
9266
9269
  /**
@@ -13808,6 +13811,126 @@ class ConversationsApi {
13808
13811
  );
13809
13812
  }
13810
13813
 
13814
+ /**
13815
+ * Update a conversation by setting its recording state
13816
+ *
13817
+ * @param {String} conversationId conversationId
13818
+ * @param {Object} body SetRecordingState
13819
+ */
13820
+ putConversationsCallRecordingstate(conversationId, body) {
13821
+ // verify the required parameter 'conversationId' is set
13822
+ if (conversationId === undefined || conversationId === null) {
13823
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
13824
+ }
13825
+ // verify the required parameter 'body' is set
13826
+ if (body === undefined || body === null) {
13827
+ throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
13828
+ }
13829
+
13830
+ return this.apiClient.callApi(
13831
+ '/api/v2/conversations/calls/{conversationId}/recordingstate',
13832
+ 'PUT',
13833
+ { 'conversationId': conversationId },
13834
+ { },
13835
+ { },
13836
+ { },
13837
+ body,
13838
+ ['PureCloud OAuth'],
13839
+ ['application/json'],
13840
+ ['application/json']
13841
+ );
13842
+ }
13843
+
13844
+ /**
13845
+ * Update a conversation by setting its recording state
13846
+ *
13847
+ * @param {String} conversationId conversationId
13848
+ * @param {Object} body SetRecordingState
13849
+ */
13850
+ putConversationsCallbackRecordingstate(conversationId, body) {
13851
+ // verify the required parameter 'conversationId' is set
13852
+ if (conversationId === undefined || conversationId === null) {
13853
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
13854
+ }
13855
+ // verify the required parameter 'body' is set
13856
+ if (body === undefined || body === null) {
13857
+ throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
13858
+ }
13859
+
13860
+ return this.apiClient.callApi(
13861
+ '/api/v2/conversations/callbacks/{conversationId}/recordingstate',
13862
+ 'PUT',
13863
+ { 'conversationId': conversationId },
13864
+ { },
13865
+ { },
13866
+ { },
13867
+ body,
13868
+ ['PureCloud OAuth'],
13869
+ ['application/json'],
13870
+ ['application/json']
13871
+ );
13872
+ }
13873
+
13874
+ /**
13875
+ * Update a conversation by setting its recording state
13876
+ *
13877
+ * @param {String} conversationId conversationId
13878
+ * @param {Object} body SetRecordingState
13879
+ */
13880
+ putConversationsChatRecordingstate(conversationId, body) {
13881
+ // verify the required parameter 'conversationId' is set
13882
+ if (conversationId === undefined || conversationId === null) {
13883
+ throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
13884
+ }
13885
+ // verify the required parameter 'body' is set
13886
+ if (body === undefined || body === null) {
13887
+ throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
13888
+ }
13889
+
13890
+ return this.apiClient.callApi(
13891
+ '/api/v2/conversations/chats/{conversationId}/recordingstate',
13892
+ 'PUT',
13893
+ { 'conversationId': conversationId },
13894
+ { },
13895
+ { },
13896
+ { },
13897
+ body,
13898
+ ['PureCloud OAuth'],
13899
+ ['application/json'],
13900
+ ['application/json']
13901
+ );
13902
+ }
13903
+
13904
+ /**
13905
+ * Update a conversation by setting its recording state
13906
+ *
13907
+ * @param {String} conversationId conversationId
13908
+ * @param {Object} body SetRecordingState
13909
+ */
13910
+ putConversationsCobrowsesessionRecordingstate(conversationId, body) {
13911
+ // verify the required parameter 'conversationId' is set
13912
+ if (conversationId === undefined || conversationId === null) {
13913
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
13914
+ }
13915
+ // verify the required parameter 'body' is set
13916
+ if (body === undefined || body === null) {
13917
+ throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
13918
+ }
13919
+
13920
+ return this.apiClient.callApi(
13921
+ '/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate',
13922
+ 'PUT',
13923
+ { 'conversationId': conversationId },
13924
+ { },
13925
+ { },
13926
+ { },
13927
+ body,
13928
+ ['PureCloud OAuth'],
13929
+ ['application/json'],
13930
+ ['application/json']
13931
+ );
13932
+ }
13933
+
13811
13934
  /**
13812
13935
  * Update conversation draft reply
13813
13936
  *
@@ -13838,6 +13961,66 @@ class ConversationsApi {
13838
13961
  );
13839
13962
  }
13840
13963
 
13964
+ /**
13965
+ * Update a conversation by setting its recording state
13966
+ *
13967
+ * @param {String} conversationId conversationId
13968
+ * @param {Object} body SetRecordingState
13969
+ */
13970
+ putConversationsEmailRecordingstate(conversationId, body) {
13971
+ // verify the required parameter 'conversationId' is set
13972
+ if (conversationId === undefined || conversationId === null) {
13973
+ throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
13974
+ }
13975
+ // verify the required parameter 'body' is set
13976
+ if (body === undefined || body === null) {
13977
+ throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
13978
+ }
13979
+
13980
+ return this.apiClient.callApi(
13981
+ '/api/v2/conversations/emails/{conversationId}/recordingstate',
13982
+ 'PUT',
13983
+ { 'conversationId': conversationId },
13984
+ { },
13985
+ { },
13986
+ { },
13987
+ body,
13988
+ ['PureCloud OAuth'],
13989
+ ['application/json'],
13990
+ ['application/json']
13991
+ );
13992
+ }
13993
+
13994
+ /**
13995
+ * Update a conversation by setting its recording state
13996
+ *
13997
+ * @param {String} conversationId conversationId
13998
+ * @param {Object} body SetRecordingState
13999
+ */
14000
+ putConversationsMessageRecordingstate(conversationId, body) {
14001
+ // verify the required parameter 'conversationId' is set
14002
+ if (conversationId === undefined || conversationId === null) {
14003
+ throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
14004
+ }
14005
+ // verify the required parameter 'body' is set
14006
+ if (body === undefined || body === null) {
14007
+ throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
14008
+ }
14009
+
14010
+ return this.apiClient.callApi(
14011
+ '/api/v2/conversations/messages/{conversationId}/recordingstate',
14012
+ 'PUT',
14013
+ { 'conversationId': conversationId },
14014
+ { },
14015
+ { },
14016
+ { },
14017
+ body,
14018
+ ['PureCloud OAuth'],
14019
+ ['application/json'],
14020
+ ['application/json']
14021
+ );
14022
+ }
14023
+
13841
14024
  /**
13842
14025
  * Update a LINE messenger integration
13843
14026
  *
@@ -13918,13 +14101,103 @@ class ConversationsApi {
13918
14101
  );
13919
14102
  }
13920
14103
 
14104
+ /**
14105
+ * Update a conversation by setting its recording state
14106
+ *
14107
+ * @param {String} conversationId conversationId
14108
+ * @param {Object} body SetRecordingState
14109
+ */
14110
+ putConversationsScreenshareRecordingstate(conversationId, body) {
14111
+ // verify the required parameter 'conversationId' is set
14112
+ if (conversationId === undefined || conversationId === null) {
14113
+ throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
14114
+ }
14115
+ // verify the required parameter 'body' is set
14116
+ if (body === undefined || body === null) {
14117
+ throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
14118
+ }
14119
+
14120
+ return this.apiClient.callApi(
14121
+ '/api/v2/conversations/screenshares/{conversationId}/recordingstate',
14122
+ 'PUT',
14123
+ { 'conversationId': conversationId },
14124
+ { },
14125
+ { },
14126
+ { },
14127
+ body,
14128
+ ['PureCloud OAuth'],
14129
+ ['application/json'],
14130
+ ['application/json']
14131
+ );
14132
+ }
14133
+
14134
+ /**
14135
+ * Update a conversation by setting its recording state
14136
+ *
14137
+ * @param {String} conversationId conversationId
14138
+ * @param {Object} body SetRecordingState
14139
+ */
14140
+ putConversationsSocialRecordingstate(conversationId, body) {
14141
+ // verify the required parameter 'conversationId' is set
14142
+ if (conversationId === undefined || conversationId === null) {
14143
+ throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
14144
+ }
14145
+ // verify the required parameter 'body' is set
14146
+ if (body === undefined || body === null) {
14147
+ throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
14148
+ }
14149
+
14150
+ return this.apiClient.callApi(
14151
+ '/api/v2/conversations/socials/{conversationId}/recordingstate',
14152
+ 'PUT',
14153
+ { 'conversationId': conversationId },
14154
+ { },
14155
+ { },
14156
+ { },
14157
+ body,
14158
+ ['PureCloud OAuth'],
14159
+ ['application/json'],
14160
+ ['application/json']
14161
+ );
14162
+ }
14163
+
14164
+ /**
14165
+ * Update a conversation by setting its recording state
14166
+ *
14167
+ * @param {String} conversationId conversationId
14168
+ * @param {Object} body SetRecordingState
14169
+ */
14170
+ putConversationsVideoRecordingstate(conversationId, body) {
14171
+ // verify the required parameter 'conversationId' is set
14172
+ if (conversationId === undefined || conversationId === null) {
14173
+ throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
14174
+ }
14175
+ // verify the required parameter 'body' is set
14176
+ if (body === undefined || body === null) {
14177
+ throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
14178
+ }
14179
+
14180
+ return this.apiClient.callApi(
14181
+ '/api/v2/conversations/videos/{conversationId}/recordingstate',
14182
+ 'PUT',
14183
+ { 'conversationId': conversationId },
14184
+ { },
14185
+ { },
14186
+ { },
14187
+ body,
14188
+ ['PureCloud OAuth'],
14189
+ ['application/json'],
14190
+ ['application/json']
14191
+ );
14192
+ }
14193
+
13921
14194
  }
13922
14195
 
13923
14196
  class DataExtensionsApi {
13924
14197
  /**
13925
14198
  * DataExtensions service.
13926
14199
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
13927
- * @version 138.0.1
14200
+ * @version 140.0.1
13928
14201
  */
13929
14202
 
13930
14203
  /**
@@ -14010,7 +14283,7 @@ class ExternalContactsApi {
14010
14283
  /**
14011
14284
  * ExternalContacts service.
14012
14285
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
14013
- * @version 138.0.1
14286
+ * @version 140.0.1
14014
14287
  */
14015
14288
 
14016
14289
  /**
@@ -15753,7 +16026,7 @@ class FaxApi {
15753
16026
  /**
15754
16027
  * Fax service.
15755
16028
  * @module purecloud-platform-client-v2/api/FaxApi
15756
- * @version 138.0.1
16029
+ * @version 140.0.1
15757
16030
  */
15758
16031
 
15759
16032
  /**
@@ -15924,7 +16197,7 @@ class FlowsApi {
15924
16197
  /**
15925
16198
  * Flows service.
15926
16199
  * @module purecloud-platform-client-v2/api/FlowsApi
15927
- * @version 138.0.1
16200
+ * @version 140.0.1
15928
16201
  */
15929
16202
 
15930
16203
  /**
@@ -15995,7 +16268,7 @@ class GamificationApi {
15995
16268
  /**
15996
16269
  * Gamification service.
15997
16270
  * @module purecloud-platform-client-v2/api/GamificationApi
15998
- * @version 138.0.1
16271
+ * @version 140.0.1
15999
16272
  */
16000
16273
 
16001
16274
  /**
@@ -16140,7 +16413,7 @@ class GamificationApi {
16140
16413
 
16141
16414
  /**
16142
16415
  * Gamified metric by id
16143
- *
16416
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
16144
16417
  * @param {String} metricId metric Id
16145
16418
  * @param {Object} opts Optional parameters
16146
16419
  * @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
@@ -16215,7 +16488,7 @@ class GamificationApi {
16215
16488
 
16216
16489
  /**
16217
16490
  * All gamified metrics for a given profile
16218
- *
16491
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
16219
16492
  * @param {Object} opts Optional parameters
16220
16493
  * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
16221
16494
  * @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
@@ -16266,18 +16539,18 @@ class GamificationApi {
16266
16539
  /**
16267
16540
  * Members of a given performance profile
16268
16541
  *
16269
- * @param {String} performanceProfileId Performance Profile Id
16542
+ * @param {String} profileId Profile Id
16270
16543
  */
16271
- getGamificationProfileMembers(performanceProfileId) {
16272
- // verify the required parameter 'performanceProfileId' is set
16273
- if (performanceProfileId === undefined || performanceProfileId === null) {
16274
- throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
16544
+ getGamificationProfileMembers(profileId) {
16545
+ // verify the required parameter 'profileId' is set
16546
+ if (profileId === undefined || profileId === null) {
16547
+ throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
16275
16548
  }
16276
16549
 
16277
16550
  return this.apiClient.callApi(
16278
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
16551
+ '/api/v2/gamification/profiles/{profileId}/members',
16279
16552
  'GET',
16280
- { 'performanceProfileId': performanceProfileId },
16553
+ { 'profileId': profileId },
16281
16554
  { },
16282
16555
  { },
16283
16556
  { },
@@ -16329,6 +16602,7 @@ class GamificationApi {
16329
16602
  * @param {Object} opts Optional parameters
16330
16603
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
16331
16604
  * @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
16605
+ * @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
16332
16606
  */
16333
16607
  getGamificationProfileMetrics(profileId, opts) {
16334
16608
  opts = opts || {};
@@ -16342,7 +16616,7 @@ class GamificationApi {
16342
16616
  '/api/v2/gamification/profiles/{profileId}/metrics',
16343
16617
  'GET',
16344
16618
  { 'profileId': profileId },
16345
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
16619
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
16346
16620
  { },
16347
16621
  { },
16348
16622
  null,
@@ -17069,7 +17343,7 @@ class GamificationApi {
17069
17343
 
17070
17344
  /**
17071
17345
  * Creates a gamified metric with a given metric definition and metric objective
17072
- *
17346
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
17073
17347
  * @param {Object} body Metric
17074
17348
  */
17075
17349
  postGamificationMetrics(body) {
@@ -17145,13 +17419,13 @@ class GamificationApi {
17145
17419
  /**
17146
17420
  * Assign members to a given performance profile
17147
17421
  *
17148
- * @param {String} performanceProfileId Performance Profile Id
17422
+ * @param {String} profileId Profile Id
17149
17423
  * @param {Object} body assignUsers
17150
17424
  */
17151
- postGamificationProfileMembers(performanceProfileId, body) {
17152
- // verify the required parameter 'performanceProfileId' is set
17153
- if (performanceProfileId === undefined || performanceProfileId === null) {
17154
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
17425
+ postGamificationProfileMembers(profileId, body) {
17426
+ // verify the required parameter 'profileId' is set
17427
+ if (profileId === undefined || profileId === null) {
17428
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
17155
17429
  }
17156
17430
  // verify the required parameter 'body' is set
17157
17431
  if (body === undefined || body === null) {
@@ -17159,9 +17433,9 @@ class GamificationApi {
17159
17433
  }
17160
17434
 
17161
17435
  return this.apiClient.callApi(
17162
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
17436
+ '/api/v2/gamification/profiles/{profileId}/members',
17163
17437
  'POST',
17164
- { 'performanceProfileId': performanceProfileId },
17438
+ { 'profileId': profileId },
17165
17439
  { },
17166
17440
  { },
17167
17441
  { },
@@ -17175,13 +17449,13 @@ class GamificationApi {
17175
17449
  /**
17176
17450
  * Validate member assignment
17177
17451
  *
17178
- * @param {String} performanceProfileId Performance Profile Id
17452
+ * @param {String} profileId Profile Id
17179
17453
  * @param {Object} body memberAssignments
17180
17454
  */
17181
- postGamificationProfileMembersValidate(performanceProfileId, body) {
17182
- // verify the required parameter 'performanceProfileId' is set
17183
- if (performanceProfileId === undefined || performanceProfileId === null) {
17184
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
17455
+ postGamificationProfileMembersValidate(profileId, body) {
17456
+ // verify the required parameter 'profileId' is set
17457
+ if (profileId === undefined || profileId === null) {
17458
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
17185
17459
  }
17186
17460
  // verify the required parameter 'body' is set
17187
17461
  if (body === undefined || body === null) {
@@ -17189,9 +17463,9 @@ class GamificationApi {
17189
17463
  }
17190
17464
 
17191
17465
  return this.apiClient.callApi(
17192
- '/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
17466
+ '/api/v2/gamification/profiles/{profileId}/members/validate',
17193
17467
  'POST',
17194
- { 'performanceProfileId': performanceProfileId },
17468
+ { 'profileId': profileId },
17195
17469
  { },
17196
17470
  { },
17197
17471
  { },
@@ -17298,7 +17572,7 @@ class GamificationApi {
17298
17572
 
17299
17573
  /**
17300
17574
  * Updates a metric
17301
- *
17575
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
17302
17576
  * @param {String} metricId metric Id
17303
17577
  * @param {Object} body Metric
17304
17578
  * @param {Object} opts Optional parameters
@@ -17425,7 +17699,7 @@ class GeneralDataProtectionRegulationApi {
17425
17699
  /**
17426
17700
  * GeneralDataProtectionRegulation service.
17427
17701
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
17428
- * @version 138.0.1
17702
+ * @version 140.0.1
17429
17703
  */
17430
17704
 
17431
17705
  /**
@@ -17555,7 +17829,7 @@ class GeolocationApi {
17555
17829
  /**
17556
17830
  * Geolocation service.
17557
17831
  * @module purecloud-platform-client-v2/api/GeolocationApi
17558
- * @version 138.0.1
17832
+ * @version 140.0.1
17559
17833
  */
17560
17834
 
17561
17835
  /**
@@ -17686,7 +17960,7 @@ class GreetingsApi {
17686
17960
  /**
17687
17961
  * Greetings service.
17688
17962
  * @module purecloud-platform-client-v2/api/GreetingsApi
17689
- * @version 138.0.1
17963
+ * @version 140.0.1
17690
17964
  */
17691
17965
 
17692
17966
  /**
@@ -18141,7 +18415,7 @@ class GroupsApi {
18141
18415
  /**
18142
18416
  * Groups service.
18143
18417
  * @module purecloud-platform-client-v2/api/GroupsApi
18144
- * @version 138.0.1
18418
+ * @version 140.0.1
18145
18419
  */
18146
18420
 
18147
18421
  /**
@@ -18546,7 +18820,7 @@ class IdentityProviderApi {
18546
18820
  /**
18547
18821
  * IdentityProvider service.
18548
18822
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
18549
- * @version 138.0.1
18823
+ * @version 140.0.1
18550
18824
  */
18551
18825
 
18552
18826
  /**
@@ -19302,7 +19576,7 @@ class IntegrationsApi {
19302
19576
  /**
19303
19577
  * Integrations service.
19304
19578
  * @module purecloud-platform-client-v2/api/IntegrationsApi
19305
- * @version 138.0.1
19579
+ * @version 140.0.1
19306
19580
  */
19307
19581
 
19308
19582
  /**
@@ -20979,7 +21253,7 @@ class JourneyApi {
20979
21253
  /**
20980
21254
  * Journey service.
20981
21255
  * @module purecloud-platform-client-v2/api/JourneyApi
20982
- * @version 138.0.1
21256
+ * @version 140.0.1
20983
21257
  */
20984
21258
 
20985
21259
  /**
@@ -21690,7 +21964,7 @@ class KnowledgeApi {
21690
21964
  /**
21691
21965
  * Knowledge service.
21692
21966
  * @module purecloud-platform-client-v2/api/KnowledgeApi
21693
- * @version 138.0.1
21967
+ * @version 140.0.1
21694
21968
  */
21695
21969
 
21696
21970
  /**
@@ -21868,7 +22142,7 @@ class KnowledgeApi {
21868
22142
  * @param {Object} opts Optional parameters
21869
22143
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
21870
22144
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
21871
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22145
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
21872
22146
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
21873
22147
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
21874
22148
  */
@@ -21976,7 +22250,7 @@ class KnowledgeApi {
21976
22250
  * @param {Object} opts Optional parameters
21977
22251
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
21978
22252
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
21979
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22253
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
21980
22254
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
21981
22255
  * @param {String} opts.categories Filter by categories ids, comma separated values expected.
21982
22256
  * @param {String} opts.title Filter by document title.
@@ -22088,7 +22362,7 @@ class KnowledgeApi {
22088
22362
  * @param {Object} opts Optional parameters
22089
22363
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22090
22364
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22091
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22365
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
22092
22366
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22093
22367
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
22094
22368
  */
@@ -22124,7 +22398,7 @@ class KnowledgeApi {
22124
22398
  * @param {Object} opts Optional parameters
22125
22399
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22126
22400
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22127
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22401
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
22128
22402
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22129
22403
  * @param {String} opts.name Filter by Name.
22130
22404
  * @param {Object} opts.coreLanguage Filter by core language.
@@ -22590,7 +22864,7 @@ class LanguageUnderstandingApi {
22590
22864
  /**
22591
22865
  * LanguageUnderstanding service.
22592
22866
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
22593
- * @version 138.0.1
22867
+ * @version 140.0.1
22594
22868
  */
22595
22869
 
22596
22870
  /**
@@ -23494,7 +23768,7 @@ class LanguagesApi {
23494
23768
  /**
23495
23769
  * Languages service.
23496
23770
  * @module purecloud-platform-client-v2/api/LanguagesApi
23497
- * @version 138.0.1
23771
+ * @version 140.0.1
23498
23772
  */
23499
23773
 
23500
23774
  /**
@@ -23762,7 +24036,7 @@ class LearningApi {
23762
24036
  /**
23763
24037
  * Learning service.
23764
24038
  * @module purecloud-platform-client-v2/api/LearningApi
23765
- * @version 138.0.1
24039
+ * @version 140.0.1
23766
24040
  */
23767
24041
 
23768
24042
  /**
@@ -23960,6 +24234,36 @@ class LearningApi {
23960
24234
  );
23961
24235
  }
23962
24236
 
24237
+ /**
24238
+ * Get a specific Learning Module job status
24239
+ *
24240
+ * @param {String} moduleId The ID of the learning module
24241
+ * @param {String} jobId The ID of the learning module job
24242
+ */
24243
+ getLearningModuleJob(moduleId, jobId) {
24244
+ // verify the required parameter 'moduleId' is set
24245
+ if (moduleId === undefined || moduleId === null) {
24246
+ throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
24247
+ }
24248
+ // verify the required parameter 'jobId' is set
24249
+ if (jobId === undefined || jobId === null) {
24250
+ throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
24251
+ }
24252
+
24253
+ return this.apiClient.callApi(
24254
+ '/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
24255
+ 'GET',
24256
+ { 'moduleId': moduleId,'jobId': jobId },
24257
+ { },
24258
+ { },
24259
+ { },
24260
+ null,
24261
+ ['PureCloud OAuth'],
24262
+ ['application/json'],
24263
+ ['application/json']
24264
+ );
24265
+ }
24266
+
23963
24267
  /**
23964
24268
  * Get a learning module rule
23965
24269
  *
@@ -24105,6 +24409,56 @@ class LearningApi {
24105
24409
  );
24106
24410
  }
24107
24411
 
24412
+ /**
24413
+ * Reassign Learning Assignment
24414
+ * This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
24415
+ * @param {String} assignmentId The Learning Assignment ID
24416
+ */
24417
+ postLearningAssignmentReassign(assignmentId) {
24418
+ // verify the required parameter 'assignmentId' is set
24419
+ if (assignmentId === undefined || assignmentId === null) {
24420
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
24421
+ }
24422
+
24423
+ return this.apiClient.callApi(
24424
+ '/api/v2/learning/assignments/{assignmentId}/reassign',
24425
+ 'POST',
24426
+ { 'assignmentId': assignmentId },
24427
+ { },
24428
+ { },
24429
+ { },
24430
+ null,
24431
+ ['PureCloud OAuth'],
24432
+ ['application/json'],
24433
+ ['application/json']
24434
+ );
24435
+ }
24436
+
24437
+ /**
24438
+ * Reset Learning Assignment
24439
+ * This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
24440
+ * @param {String} assignmentId The Learning Assignment ID
24441
+ */
24442
+ postLearningAssignmentReset(assignmentId) {
24443
+ // verify the required parameter 'assignmentId' is set
24444
+ if (assignmentId === undefined || assignmentId === null) {
24445
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
24446
+ }
24447
+
24448
+ return this.apiClient.callApi(
24449
+ '/api/v2/learning/assignments/{assignmentId}/reset',
24450
+ 'POST',
24451
+ { 'assignmentId': assignmentId },
24452
+ { },
24453
+ { },
24454
+ { },
24455
+ null,
24456
+ ['PureCloud OAuth'],
24457
+ ['application/json'],
24458
+ ['application/json']
24459
+ );
24460
+ }
24461
+
24108
24462
  /**
24109
24463
  * Create Learning Assignment
24110
24464
  *
@@ -24202,6 +24556,36 @@ class LearningApi {
24202
24556
  );
24203
24557
  }
24204
24558
 
24559
+ /**
24560
+ * Starts a specified operation on learning module
24561
+ * This will initiate operation specified in the request body for a learning module
24562
+ * @param {String} moduleId The ID of the learning module
24563
+ * @param {Object} body The learning module job request
24564
+ */
24565
+ postLearningModuleJobs(moduleId, body) {
24566
+ // verify the required parameter 'moduleId' is set
24567
+ if (moduleId === undefined || moduleId === null) {
24568
+ throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
24569
+ }
24570
+ // verify the required parameter 'body' is set
24571
+ if (body === undefined || body === null) {
24572
+ throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
24573
+ }
24574
+
24575
+ return this.apiClient.callApi(
24576
+ '/api/v2/learning/modules/{moduleId}/jobs',
24577
+ 'POST',
24578
+ { 'moduleId': moduleId },
24579
+ { },
24580
+ { },
24581
+ { },
24582
+ body,
24583
+ ['PureCloud OAuth'],
24584
+ ['application/json'],
24585
+ ['application/json']
24586
+ );
24587
+ }
24588
+
24205
24589
  /**
24206
24590
  * Publish a Learning module
24207
24591
  *
@@ -24353,7 +24737,7 @@ class LicenseApi {
24353
24737
  /**
24354
24738
  * License service.
24355
24739
  * @module purecloud-platform-client-v2/api/LicenseApi
24356
- * @version 138.0.1
24740
+ * @version 140.0.1
24357
24741
  */
24358
24742
 
24359
24743
  /**
@@ -24591,7 +24975,7 @@ class LocationsApi {
24591
24975
  /**
24592
24976
  * Locations service.
24593
24977
  * @module purecloud-platform-client-v2/api/LocationsApi
24594
- * @version 138.0.1
24978
+ * @version 140.0.1
24595
24979
  */
24596
24980
 
24597
24981
  /**
@@ -24827,7 +25211,7 @@ class MessagingApi {
24827
25211
  /**
24828
25212
  * Messaging service.
24829
25213
  * @module purecloud-platform-client-v2/api/MessagingApi
24830
- * @version 138.0.1
25214
+ * @version 140.0.1
24831
25215
  */
24832
25216
 
24833
25217
  /**
@@ -24978,7 +25362,7 @@ class MobileDevicesApi {
24978
25362
  /**
24979
25363
  * MobileDevices service.
24980
25364
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
24981
- * @version 138.0.1
25365
+ * @version 140.0.1
24982
25366
  */
24983
25367
 
24984
25368
  /**
@@ -25129,7 +25513,7 @@ class NotificationsApi {
25129
25513
  /**
25130
25514
  * Notifications service.
25131
25515
  * @module purecloud-platform-client-v2/api/NotificationsApi
25132
- * @version 138.0.1
25516
+ * @version 140.0.1
25133
25517
  */
25134
25518
 
25135
25519
  /**
@@ -25354,7 +25738,7 @@ class OAuthApi {
25354
25738
  /**
25355
25739
  * OAuth service.
25356
25740
  * @module purecloud-platform-client-v2/api/OAuthApi
25357
- * @version 138.0.1
25741
+ * @version 140.0.1
25358
25742
  */
25359
25743
 
25360
25744
  /**
@@ -25720,7 +26104,7 @@ class ObjectsApi {
25720
26104
  /**
25721
26105
  * Objects service.
25722
26106
  * @module purecloud-platform-client-v2/api/ObjectsApi
25723
- * @version 138.0.1
26107
+ * @version 140.0.1
25724
26108
  */
25725
26109
 
25726
26110
  /**
@@ -25991,7 +26375,7 @@ class OrganizationApi {
25991
26375
  /**
25992
26376
  * Organization service.
25993
26377
  * @module purecloud-platform-client-v2/api/OrganizationApi
25994
- * @version 138.0.1
26378
+ * @version 140.0.1
25995
26379
  */
25996
26380
 
25997
26381
  /**
@@ -26394,7 +26778,7 @@ class OrganizationAuthorizationApi {
26394
26778
  /**
26395
26779
  * OrganizationAuthorization service.
26396
26780
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
26397
- * @version 138.0.1
26781
+ * @version 140.0.1
26398
26782
  */
26399
26783
 
26400
26784
  /**
@@ -27319,7 +27703,7 @@ class OutboundApi {
27319
27703
  /**
27320
27704
  * Outbound service.
27321
27705
  * @module purecloud-platform-client-v2/api/OutboundApi
27322
- * @version 138.0.1
27706
+ * @version 140.0.1
27323
27707
  */
27324
27708
 
27325
27709
  /**
@@ -30574,7 +30958,7 @@ class PresenceApi {
30574
30958
  /**
30575
30959
  * Presence service.
30576
30960
  * @module purecloud-platform-client-v2/api/PresenceApi
30577
- * @version 138.0.1
30961
+ * @version 140.0.1
30578
30962
  */
30579
30963
 
30580
30964
  /**
@@ -30896,7 +31280,7 @@ class QualityApi {
30896
31280
  /**
30897
31281
  * Quality service.
30898
31282
  * @module purecloud-platform-client-v2/api/QualityApi
30899
- * @version 138.0.1
31283
+ * @version 140.0.1
30900
31284
  */
30901
31285
 
30902
31286
  /**
@@ -31654,7 +32038,7 @@ class QualityApi {
31654
32038
  /**
31655
32039
  * Retrieve a list of the latest form versions by context ids
31656
32040
  *
31657
- * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
32041
+ * @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.
31658
32042
  * @param {Object} opts Optional parameters
31659
32043
  * @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)
31660
32044
  */
@@ -32474,7 +32858,7 @@ class RecordingApi {
32474
32858
  /**
32475
32859
  * Recording service.
32476
32860
  * @module purecloud-platform-client-v2/api/RecordingApi
32477
- * @version 138.0.1
32861
+ * @version 140.0.1
32478
32862
  */
32479
32863
 
32480
32864
  /**
@@ -34127,7 +34511,7 @@ class ResponseManagementApi {
34127
34511
  /**
34128
34512
  * ResponseManagement service.
34129
34513
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
34130
- * @version 138.0.1
34514
+ * @version 140.0.1
34131
34515
  */
34132
34516
 
34133
34517
  /**
@@ -34611,7 +34995,7 @@ class RoutingApi {
34611
34995
  /**
34612
34996
  * Routing service.
34613
34997
  * @module purecloud-platform-client-v2/api/RoutingApi
34614
- * @version 138.0.1
34998
+ * @version 140.0.1
34615
34999
  */
34616
35000
 
34617
35001
  /**
@@ -34924,12 +35308,8 @@ class RoutingApi {
34924
35308
  * Delete a phone number provisioned for SMS.
34925
35309
  *
34926
35310
  * @param {String} addressId Address ID
34927
- * @param {Object} opts Optional parameters
34928
- * @param {Boolean} opts.async Delete a phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the deletion of a provisioned phone number. (default to false)
34929
35311
  */
34930
- deleteRoutingSmsPhonenumber(addressId, opts) {
34931
- opts = opts || {};
34932
-
35312
+ deleteRoutingSmsPhonenumber(addressId) {
34933
35313
  // verify the required parameter 'addressId' is set
34934
35314
  if (addressId === undefined || addressId === null) {
34935
35315
  throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
@@ -34939,7 +35319,7 @@ class RoutingApi {
34939
35319
  '/api/v2/routing/sms/phonenumbers/{addressId}',
34940
35320
  'DELETE',
34941
35321
  { 'addressId': addressId },
34942
- { 'async': opts['async'] },
35322
+ { },
34943
35323
  { },
34944
35324
  { },
34945
35325
  null,
@@ -35110,7 +35490,7 @@ class RoutingApi {
35110
35490
  * @param {Object} opts Optional parameters
35111
35491
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
35112
35492
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
35113
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
35493
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
35114
35494
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
35115
35495
  * @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
35116
35496
  */
@@ -35421,7 +35801,7 @@ class RoutingApi {
35421
35801
  * @param {Object} opts Optional parameters
35422
35802
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
35423
35803
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
35424
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
35804
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
35425
35805
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
35426
35806
  * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
35427
35807
  */
@@ -35444,16 +35824,20 @@ class RoutingApi {
35444
35824
  }
35445
35825
 
35446
35826
  /**
35447
- * Get a list of Key Performance Indicators available for the predictors.
35827
+ * Get a list of Key Performance Indicators
35448
35828
  *
35829
+ * @param {Object} opts Optional parameters
35830
+ * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
35449
35831
  */
35450
- getRoutingPredictorsKeyperformanceindicators() {
35832
+ getRoutingPredictorsKeyperformanceindicators(opts) {
35833
+ opts = opts || {};
35834
+
35451
35835
 
35452
35836
  return this.apiClient.callApi(
35453
35837
  '/api/v2/routing/predictors/keyperformanceindicators',
35454
35838
  'GET',
35455
35839
  { },
35456
- { },
35840
+ { 'kpiGroup': opts['kpiGroup'] },
35457
35841
  { },
35458
35842
  { },
35459
35843
  null,
@@ -37093,12 +37477,8 @@ class RoutingApi {
37093
37477
  * Provision a phone number for SMS
37094
37478
  *
37095
37479
  * @param {Object} body SmsPhoneNumber
37096
- * @param {Object} opts Optional parameters
37097
- * @param {Boolean} opts.async Provision a new phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the provisioning of a new phone number. Check the phoneNumber's provisioningStatus for completion of this request. (default to false)
37098
37480
  */
37099
- postRoutingSmsPhonenumbers(body, opts) {
37100
- opts = opts || {};
37101
-
37481
+ postRoutingSmsPhonenumbers(body) {
37102
37482
  // verify the required parameter 'body' is set
37103
37483
  if (body === undefined || body === null) {
37104
37484
  throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
@@ -37108,7 +37488,7 @@ class RoutingApi {
37108
37488
  '/api/v2/routing/sms/phonenumbers',
37109
37489
  'POST',
37110
37490
  { },
37111
- { 'async': opts['async'] },
37491
+ { },
37112
37492
  { },
37113
37493
  { },
37114
37494
  body,
@@ -37353,12 +37733,8 @@ class RoutingApi {
37353
37733
  *
37354
37734
  * @param {String} addressId Address ID
37355
37735
  * @param {Object} body SmsPhoneNumber
37356
- * @param {Object} opts Optional parameters
37357
- * @param {Boolean} opts.async Update an existing phone number for SMS in an asynchronous manner. If the async parameter value is true, this initiates the update of a provisioned phone number. Check the phoneNumber's provisioningStatus for the progress of this request. (default to false)
37358
37736
  */
37359
- putRoutingSmsPhonenumber(addressId, body, opts) {
37360
- opts = opts || {};
37361
-
37737
+ putRoutingSmsPhonenumber(addressId, body) {
37362
37738
  // verify the required parameter 'addressId' is set
37363
37739
  if (addressId === undefined || addressId === null) {
37364
37740
  throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
@@ -37372,7 +37748,7 @@ class RoutingApi {
37372
37748
  '/api/v2/routing/sms/phonenumbers/{addressId}',
37373
37749
  'PUT',
37374
37750
  { 'addressId': addressId },
37375
- { 'async': opts['async'] },
37751
+ { },
37376
37752
  { },
37377
37753
  { },
37378
37754
  body,
@@ -37538,7 +37914,7 @@ class SCIMApi {
37538
37914
  /**
37539
37915
  * SCIM service.
37540
37916
  * @module purecloud-platform-client-v2/api/SCIMApi
37541
- * @version 138.0.1
37917
+ * @version 140.0.1
37542
37918
  */
37543
37919
 
37544
37920
  /**
@@ -38415,7 +38791,7 @@ class ScriptsApi {
38415
38791
  /**
38416
38792
  * Scripts service.
38417
38793
  * @module purecloud-platform-client-v2/api/ScriptsApi
38418
- * @version 138.0.1
38794
+ * @version 140.0.1
38419
38795
  */
38420
38796
 
38421
38797
  /**
@@ -38834,7 +39210,7 @@ class SearchApi {
38834
39210
  /**
38835
39211
  * Search service.
38836
39212
  * @module purecloud-platform-client-v2/api/SearchApi
38837
- * @version 138.0.1
39213
+ * @version 140.0.1
38838
39214
  */
38839
39215
 
38840
39216
  /**
@@ -39369,7 +39745,7 @@ class SpeechTextAnalyticsApi {
39369
39745
  /**
39370
39746
  * SpeechTextAnalytics service.
39371
39747
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
39372
- * @version 138.0.1
39748
+ * @version 140.0.1
39373
39749
  */
39374
39750
 
39375
39751
  /**
@@ -40222,7 +40598,7 @@ class StationsApi {
40222
40598
  /**
40223
40599
  * Stations service.
40224
40600
  * @module purecloud-platform-client-v2/api/StationsApi
40225
- * @version 138.0.1
40601
+ * @version 140.0.1
40226
40602
  */
40227
40603
 
40228
40604
  /**
@@ -40369,7 +40745,7 @@ class SuggestApi {
40369
40745
  /**
40370
40746
  * Suggest service.
40371
40747
  * @module purecloud-platform-client-v2/api/SuggestApi
40372
- * @version 138.0.1
40748
+ * @version 140.0.1
40373
40749
  */
40374
40750
 
40375
40751
  /**
@@ -40508,7 +40884,7 @@ class TelephonyApi {
40508
40884
  /**
40509
40885
  * Telephony service.
40510
40886
  * @module purecloud-platform-client-v2/api/TelephonyApi
40511
- * @version 138.0.1
40887
+ * @version 140.0.1
40512
40888
  */
40513
40889
 
40514
40890
  /**
@@ -40616,7 +40992,7 @@ class TelephonyProvidersEdgeApi {
40616
40992
  /**
40617
40993
  * TelephonyProvidersEdge service.
40618
40994
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
40619
- * @version 138.0.1
40995
+ * @version 140.0.1
40620
40996
  */
40621
40997
 
40622
40998
  /**
@@ -44249,7 +44625,7 @@ class TextbotsApi {
44249
44625
  /**
44250
44626
  * Textbots service.
44251
44627
  * @module purecloud-platform-client-v2/api/TextbotsApi
44252
- * @version 138.0.1
44628
+ * @version 140.0.1
44253
44629
  */
44254
44630
 
44255
44631
  /**
@@ -44377,7 +44753,7 @@ class TokensApi {
44377
44753
  /**
44378
44754
  * Tokens service.
44379
44755
  * @module purecloud-platform-client-v2/api/TokensApi
44380
- * @version 138.0.1
44756
+ * @version 140.0.1
44381
44757
  */
44382
44758
 
44383
44759
  /**
@@ -44483,7 +44859,7 @@ class UploadsApi {
44483
44859
  /**
44484
44860
  * Uploads service.
44485
44861
  * @module purecloud-platform-client-v2/api/UploadsApi
44486
- * @version 138.0.1
44862
+ * @version 140.0.1
44487
44863
  */
44488
44864
 
44489
44865
  /**
@@ -44634,7 +45010,7 @@ class UsageApi {
44634
45010
  /**
44635
45011
  * Usage service.
44636
45012
  * @module purecloud-platform-client-v2/api/UsageApi
44637
- * @version 138.0.1
45013
+ * @version 140.0.1
44638
45014
  */
44639
45015
 
44640
45016
  /**
@@ -44705,7 +45081,7 @@ class UserRecordingsApi {
44705
45081
  /**
44706
45082
  * UserRecordings service.
44707
45083
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
44708
- * @version 138.0.1
45084
+ * @version 140.0.1
44709
45085
  */
44710
45086
 
44711
45087
  /**
@@ -44889,7 +45265,7 @@ class UsersApi {
44889
45265
  /**
44890
45266
  * Users service.
44891
45267
  * @module purecloud-platform-client-v2/api/UsersApi
44892
- * @version 138.0.1
45268
+ * @version 140.0.1
44893
45269
  */
44894
45270
 
44895
45271
  /**
@@ -45709,18 +46085,18 @@ class UsersApi {
45709
46085
  /**
45710
46086
  * Returns a listing of roles and permissions for a user.
45711
46087
  *
45712
- * @param {String} userId User ID
46088
+ * @param {String} subjectId User ID
45713
46089
  */
45714
- getUserRoles(userId) {
45715
- // verify the required parameter 'userId' is set
45716
- if (userId === undefined || userId === null) {
45717
- throw 'Missing the required parameter "userId" when calling getUserRoles';
46090
+ getUserRoles(subjectId) {
46091
+ // verify the required parameter 'subjectId' is set
46092
+ if (subjectId === undefined || subjectId === null) {
46093
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
45718
46094
  }
45719
46095
 
45720
46096
  return this.apiClient.callApi(
45721
- '/api/v2/users/{userId}/roles',
46097
+ '/api/v2/users/{subjectId}/roles',
45722
46098
  'GET',
45723
- { 'userId': userId },
46099
+ { 'subjectId': subjectId },
45724
46100
  { },
45725
46101
  { },
45726
46102
  { },
@@ -46973,13 +47349,13 @@ class UsersApi {
46973
47349
  /**
46974
47350
  * Sets the user's roles
46975
47351
  *
46976
- * @param {String} userId User ID
47352
+ * @param {String} subjectId User ID
46977
47353
  * @param {Array.<String>} body List of roles
46978
47354
  */
46979
- putUserRoles(userId, body) {
46980
- // verify the required parameter 'userId' is set
46981
- if (userId === undefined || userId === null) {
46982
- throw 'Missing the required parameter "userId" when calling putUserRoles';
47355
+ putUserRoles(subjectId, body) {
47356
+ // verify the required parameter 'subjectId' is set
47357
+ if (subjectId === undefined || subjectId === null) {
47358
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
46983
47359
  }
46984
47360
  // verify the required parameter 'body' is set
46985
47361
  if (body === undefined || body === null) {
@@ -46987,9 +47363,9 @@ class UsersApi {
46987
47363
  }
46988
47364
 
46989
47365
  return this.apiClient.callApi(
46990
- '/api/v2/users/{userId}/roles',
47366
+ '/api/v2/users/{subjectId}/roles',
46991
47367
  'PUT',
46992
- { 'userId': userId },
47368
+ { 'subjectId': subjectId },
46993
47369
  { },
46994
47370
  { },
46995
47371
  { },
@@ -47191,7 +47567,7 @@ class UtilitiesApi {
47191
47567
  /**
47192
47568
  * Utilities service.
47193
47569
  * @module purecloud-platform-client-v2/api/UtilitiesApi
47194
- * @version 138.0.1
47570
+ * @version 140.0.1
47195
47571
  */
47196
47572
 
47197
47573
  /**
@@ -47302,7 +47678,7 @@ class VoicemailApi {
47302
47678
  /**
47303
47679
  * Voicemail service.
47304
47680
  * @module purecloud-platform-client-v2/api/VoicemailApi
47305
- * @version 138.0.1
47681
+ * @version 140.0.1
47306
47682
  */
47307
47683
 
47308
47684
  /**
@@ -47969,7 +48345,7 @@ class WebChatApi {
47969
48345
  /**
47970
48346
  * WebChat service.
47971
48347
  * @module purecloud-platform-client-v2/api/WebChatApi
47972
- * @version 138.0.1
48348
+ * @version 140.0.1
47973
48349
  */
47974
48350
 
47975
48351
  /**
@@ -48513,7 +48889,7 @@ class WebDeploymentsApi {
48513
48889
  /**
48514
48890
  * WebDeployments service.
48515
48891
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
48516
- * @version 138.0.1
48892
+ * @version 140.0.1
48517
48893
  */
48518
48894
 
48519
48895
  /**
@@ -48868,7 +49244,7 @@ class WebMessagingApi {
48868
49244
  /**
48869
49245
  * WebMessaging service.
48870
49246
  * @module purecloud-platform-client-v2/api/WebMessagingApi
48871
- * @version 138.0.1
49247
+ * @version 140.0.1
48872
49248
  */
48873
49249
 
48874
49250
  /**
@@ -48914,7 +49290,7 @@ class WidgetsApi {
48914
49290
  /**
48915
49291
  * Widgets service.
48916
49292
  * @module purecloud-platform-client-v2/api/WidgetsApi
48917
- * @version 138.0.1
49293
+ * @version 140.0.1
48918
49294
  */
48919
49295
 
48920
49296
  /**
@@ -49060,7 +49436,7 @@ class WorkforceManagementApi {
49060
49436
  /**
49061
49437
  * WorkforceManagement service.
49062
49438
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
49063
- * @version 138.0.1
49439
+ * @version 140.0.1
49064
49440
  */
49065
49441
 
49066
49442
  /**
@@ -53311,7 +53687,7 @@ class WorkforceManagementApi {
53311
53687
  * </pre>
53312
53688
  * </p>
53313
53689
  * @module purecloud-platform-client-v2/index
53314
- * @version 138.0.1
53690
+ * @version 140.0.1
53315
53691
  */
53316
53692
  class platformClient {
53317
53693
  constructor() {