purecloud-platform-client-v2 138.0.0 → 140.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 +523 -147
  3. package/dist/web-amd/purecloud-platform-client-v2.js +523 -147
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +523 -147
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +523 -147
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +783 -224
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +5 -2
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +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
@@ -399,7 +399,7 @@ class Configuration {
399
399
 
400
400
  /**
401
401
  * @module purecloud-platform-client-v2/ApiClient
402
- * @version 138.0.0
402
+ * @version 140.0.0
403
403
  */
404
404
  class ApiClient {
405
405
  /**
@@ -1152,7 +1152,7 @@ class ApiClient {
1152
1152
  serialize(obj) {
1153
1153
  var result = {};
1154
1154
  for (var p in obj) {
1155
- if (obj.hasOwnProperty(p)) {
1155
+ if (obj.hasOwnProperty(p) && obj[p] !== undefined) {
1156
1156
  result[encodeURIComponent(p)] = Array.isArray(obj[p]) ? obj[p].join(",") : this.paramToString(obj[p]);
1157
1157
  }
1158
1158
  }
@@ -1289,6 +1289,9 @@ class ApiClient {
1289
1289
  */
1290
1290
  buildCollectionParam(param, collectionFormat) {
1291
1291
  if (!param) return;
1292
+ if (!Array.isArray(param)) {
1293
+ param = [param];
1294
+ }
1292
1295
 
1293
1296
  switch (collectionFormat) {
1294
1297
  case 'csv':
@@ -1474,7 +1477,7 @@ class AlertingApi {
1474
1477
  /**
1475
1478
  * Alerting service.
1476
1479
  * @module purecloud-platform-client-v2/api/AlertingApi
1477
- * @version 138.0.0
1480
+ * @version 140.0.0
1478
1481
  */
1479
1482
 
1480
1483
  /**
@@ -1788,7 +1791,7 @@ class AnalyticsApi {
1788
1791
  /**
1789
1792
  * Analytics service.
1790
1793
  * @module purecloud-platform-client-v2/api/AnalyticsApi
1791
- * @version 138.0.0
1794
+ * @version 140.0.0
1792
1795
  */
1793
1796
 
1794
1797
  /**
@@ -2970,7 +2973,7 @@ class ArchitectApi {
2970
2973
  /**
2971
2974
  * Architect service.
2972
2975
  * @module purecloud-platform-client-v2/api/ArchitectApi
2973
- * @version 138.0.0
2976
+ * @version 140.0.0
2974
2977
  */
2975
2978
 
2976
2979
  /**
@@ -6015,7 +6018,7 @@ class AuditApi {
6015
6018
  /**
6016
6019
  * Audit service.
6017
6020
  * @module purecloud-platform-client-v2/api/AuditApi
6018
- * @version 138.0.0
6021
+ * @version 140.0.0
6019
6022
  */
6020
6023
 
6021
6024
  /**
@@ -6186,7 +6189,7 @@ class AuthorizationApi {
6186
6189
  /**
6187
6190
  * Authorization service.
6188
6191
  * @module purecloud-platform-client-v2/api/AuthorizationApi
6189
- * @version 138.0.0
6192
+ * @version 140.0.0
6190
6193
  */
6191
6194
 
6192
6195
  /**
@@ -6791,18 +6794,18 @@ class AuthorizationApi {
6791
6794
  /**
6792
6795
  * Returns a listing of roles and permissions for a user.
6793
6796
  *
6794
- * @param {String} userId User ID
6797
+ * @param {String} subjectId User ID
6795
6798
  */
6796
- getUserRoles(userId) {
6797
- // verify the required parameter 'userId' is set
6798
- if (userId === undefined || userId === null) {
6799
- throw 'Missing the required parameter "userId" when calling getUserRoles';
6799
+ getUserRoles(subjectId) {
6800
+ // verify the required parameter 'subjectId' is set
6801
+ if (subjectId === undefined || subjectId === null) {
6802
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
6800
6803
  }
6801
6804
 
6802
6805
  return this.apiClient.callApi(
6803
- '/api/v2/users/{userId}/roles',
6806
+ '/api/v2/users/{subjectId}/roles',
6804
6807
  'GET',
6805
- { 'userId': userId },
6808
+ { 'subjectId': subjectId },
6806
6809
  { },
6807
6810
  { },
6808
6811
  { },
@@ -7336,13 +7339,13 @@ class AuthorizationApi {
7336
7339
  /**
7337
7340
  * Sets the user's roles
7338
7341
  *
7339
- * @param {String} userId User ID
7342
+ * @param {String} subjectId User ID
7340
7343
  * @param {Array.<String>} body List of roles
7341
7344
  */
7342
- putUserRoles(userId, body) {
7343
- // verify the required parameter 'userId' is set
7344
- if (userId === undefined || userId === null) {
7345
- throw 'Missing the required parameter "userId" when calling putUserRoles';
7345
+ putUserRoles(subjectId, body) {
7346
+ // verify the required parameter 'subjectId' is set
7347
+ if (subjectId === undefined || subjectId === null) {
7348
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
7346
7349
  }
7347
7350
  // verify the required parameter 'body' is set
7348
7351
  if (body === undefined || body === null) {
@@ -7350,9 +7353,9 @@ class AuthorizationApi {
7350
7353
  }
7351
7354
 
7352
7355
  return this.apiClient.callApi(
7353
- '/api/v2/users/{userId}/roles',
7356
+ '/api/v2/users/{subjectId}/roles',
7354
7357
  'PUT',
7355
- { 'userId': userId },
7358
+ { 'subjectId': subjectId },
7356
7359
  { },
7357
7360
  { },
7358
7361
  { },
@@ -7369,7 +7372,7 @@ class BillingApi {
7369
7372
  /**
7370
7373
  * Billing service.
7371
7374
  * @module purecloud-platform-client-v2/api/BillingApi
7372
- * @version 138.0.0
7375
+ * @version 140.0.0
7373
7376
  */
7374
7377
 
7375
7378
  /**
@@ -7449,7 +7452,7 @@ class ChatApi {
7449
7452
  /**
7450
7453
  * Chat service.
7451
7454
  * @module purecloud-platform-client-v2/api/ChatApi
7452
- * @version 138.0.0
7455
+ * @version 140.0.0
7453
7456
  */
7454
7457
 
7455
7458
  /**
@@ -7540,7 +7543,7 @@ class CoachingApi {
7540
7543
  /**
7541
7544
  * Coaching service.
7542
7545
  * @module purecloud-platform-client-v2/api/CoachingApi
7543
- * @version 138.0.0
7546
+ * @version 140.0.0
7544
7547
  */
7545
7548
 
7546
7549
  /**
@@ -8117,7 +8120,7 @@ class ContentManagementApi {
8117
8120
  /**
8118
8121
  * ContentManagement service.
8119
8122
  * @module purecloud-platform-client-v2/api/ContentManagementApi
8120
- * @version 138.0.0
8123
+ * @version 140.0.0
8121
8124
  */
8122
8125
 
8123
8126
  /**
@@ -9257,7 +9260,7 @@ class ConversationsApi {
9257
9260
  /**
9258
9261
  * Conversations service.
9259
9262
  * @module purecloud-platform-client-v2/api/ConversationsApi
9260
- * @version 138.0.0
9263
+ * @version 140.0.0
9261
9264
  */
9262
9265
 
9263
9266
  /**
@@ -13805,6 +13808,126 @@ class ConversationsApi {
13805
13808
  );
13806
13809
  }
13807
13810
 
13811
+ /**
13812
+ * Update a conversation by setting its recording state
13813
+ *
13814
+ * @param {String} conversationId conversationId
13815
+ * @param {Object} body SetRecordingState
13816
+ */
13817
+ putConversationsCallRecordingstate(conversationId, body) {
13818
+ // verify the required parameter 'conversationId' is set
13819
+ if (conversationId === undefined || conversationId === null) {
13820
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
13821
+ }
13822
+ // verify the required parameter 'body' is set
13823
+ if (body === undefined || body === null) {
13824
+ throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
13825
+ }
13826
+
13827
+ return this.apiClient.callApi(
13828
+ '/api/v2/conversations/calls/{conversationId}/recordingstate',
13829
+ 'PUT',
13830
+ { 'conversationId': conversationId },
13831
+ { },
13832
+ { },
13833
+ { },
13834
+ body,
13835
+ ['PureCloud OAuth'],
13836
+ ['application/json'],
13837
+ ['application/json']
13838
+ );
13839
+ }
13840
+
13841
+ /**
13842
+ * Update a conversation by setting its recording state
13843
+ *
13844
+ * @param {String} conversationId conversationId
13845
+ * @param {Object} body SetRecordingState
13846
+ */
13847
+ putConversationsCallbackRecordingstate(conversationId, body) {
13848
+ // verify the required parameter 'conversationId' is set
13849
+ if (conversationId === undefined || conversationId === null) {
13850
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
13851
+ }
13852
+ // verify the required parameter 'body' is set
13853
+ if (body === undefined || body === null) {
13854
+ throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
13855
+ }
13856
+
13857
+ return this.apiClient.callApi(
13858
+ '/api/v2/conversations/callbacks/{conversationId}/recordingstate',
13859
+ 'PUT',
13860
+ { 'conversationId': conversationId },
13861
+ { },
13862
+ { },
13863
+ { },
13864
+ body,
13865
+ ['PureCloud OAuth'],
13866
+ ['application/json'],
13867
+ ['application/json']
13868
+ );
13869
+ }
13870
+
13871
+ /**
13872
+ * Update a conversation by setting its recording state
13873
+ *
13874
+ * @param {String} conversationId conversationId
13875
+ * @param {Object} body SetRecordingState
13876
+ */
13877
+ putConversationsChatRecordingstate(conversationId, body) {
13878
+ // verify the required parameter 'conversationId' is set
13879
+ if (conversationId === undefined || conversationId === null) {
13880
+ throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
13881
+ }
13882
+ // verify the required parameter 'body' is set
13883
+ if (body === undefined || body === null) {
13884
+ throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
13885
+ }
13886
+
13887
+ return this.apiClient.callApi(
13888
+ '/api/v2/conversations/chats/{conversationId}/recordingstate',
13889
+ 'PUT',
13890
+ { 'conversationId': conversationId },
13891
+ { },
13892
+ { },
13893
+ { },
13894
+ body,
13895
+ ['PureCloud OAuth'],
13896
+ ['application/json'],
13897
+ ['application/json']
13898
+ );
13899
+ }
13900
+
13901
+ /**
13902
+ * Update a conversation by setting its recording state
13903
+ *
13904
+ * @param {String} conversationId conversationId
13905
+ * @param {Object} body SetRecordingState
13906
+ */
13907
+ putConversationsCobrowsesessionRecordingstate(conversationId, body) {
13908
+ // verify the required parameter 'conversationId' is set
13909
+ if (conversationId === undefined || conversationId === null) {
13910
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
13911
+ }
13912
+ // verify the required parameter 'body' is set
13913
+ if (body === undefined || body === null) {
13914
+ throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
13915
+ }
13916
+
13917
+ return this.apiClient.callApi(
13918
+ '/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate',
13919
+ 'PUT',
13920
+ { 'conversationId': conversationId },
13921
+ { },
13922
+ { },
13923
+ { },
13924
+ body,
13925
+ ['PureCloud OAuth'],
13926
+ ['application/json'],
13927
+ ['application/json']
13928
+ );
13929
+ }
13930
+
13808
13931
  /**
13809
13932
  * Update conversation draft reply
13810
13933
  *
@@ -13835,6 +13958,66 @@ class ConversationsApi {
13835
13958
  );
13836
13959
  }
13837
13960
 
13961
+ /**
13962
+ * Update a conversation by setting its recording state
13963
+ *
13964
+ * @param {String} conversationId conversationId
13965
+ * @param {Object} body SetRecordingState
13966
+ */
13967
+ putConversationsEmailRecordingstate(conversationId, body) {
13968
+ // verify the required parameter 'conversationId' is set
13969
+ if (conversationId === undefined || conversationId === null) {
13970
+ throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
13971
+ }
13972
+ // verify the required parameter 'body' is set
13973
+ if (body === undefined || body === null) {
13974
+ throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
13975
+ }
13976
+
13977
+ return this.apiClient.callApi(
13978
+ '/api/v2/conversations/emails/{conversationId}/recordingstate',
13979
+ 'PUT',
13980
+ { 'conversationId': conversationId },
13981
+ { },
13982
+ { },
13983
+ { },
13984
+ body,
13985
+ ['PureCloud OAuth'],
13986
+ ['application/json'],
13987
+ ['application/json']
13988
+ );
13989
+ }
13990
+
13991
+ /**
13992
+ * Update a conversation by setting its recording state
13993
+ *
13994
+ * @param {String} conversationId conversationId
13995
+ * @param {Object} body SetRecordingState
13996
+ */
13997
+ putConversationsMessageRecordingstate(conversationId, body) {
13998
+ // verify the required parameter 'conversationId' is set
13999
+ if (conversationId === undefined || conversationId === null) {
14000
+ throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
14001
+ }
14002
+ // verify the required parameter 'body' is set
14003
+ if (body === undefined || body === null) {
14004
+ throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
14005
+ }
14006
+
14007
+ return this.apiClient.callApi(
14008
+ '/api/v2/conversations/messages/{conversationId}/recordingstate',
14009
+ 'PUT',
14010
+ { 'conversationId': conversationId },
14011
+ { },
14012
+ { },
14013
+ { },
14014
+ body,
14015
+ ['PureCloud OAuth'],
14016
+ ['application/json'],
14017
+ ['application/json']
14018
+ );
14019
+ }
14020
+
13838
14021
  /**
13839
14022
  * Update a LINE messenger integration
13840
14023
  *
@@ -13915,13 +14098,103 @@ class ConversationsApi {
13915
14098
  );
13916
14099
  }
13917
14100
 
14101
+ /**
14102
+ * Update a conversation by setting its recording state
14103
+ *
14104
+ * @param {String} conversationId conversationId
14105
+ * @param {Object} body SetRecordingState
14106
+ */
14107
+ putConversationsScreenshareRecordingstate(conversationId, body) {
14108
+ // verify the required parameter 'conversationId' is set
14109
+ if (conversationId === undefined || conversationId === null) {
14110
+ throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
14111
+ }
14112
+ // verify the required parameter 'body' is set
14113
+ if (body === undefined || body === null) {
14114
+ throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
14115
+ }
14116
+
14117
+ return this.apiClient.callApi(
14118
+ '/api/v2/conversations/screenshares/{conversationId}/recordingstate',
14119
+ 'PUT',
14120
+ { 'conversationId': conversationId },
14121
+ { },
14122
+ { },
14123
+ { },
14124
+ body,
14125
+ ['PureCloud OAuth'],
14126
+ ['application/json'],
14127
+ ['application/json']
14128
+ );
14129
+ }
14130
+
14131
+ /**
14132
+ * Update a conversation by setting its recording state
14133
+ *
14134
+ * @param {String} conversationId conversationId
14135
+ * @param {Object} body SetRecordingState
14136
+ */
14137
+ putConversationsSocialRecordingstate(conversationId, body) {
14138
+ // verify the required parameter 'conversationId' is set
14139
+ if (conversationId === undefined || conversationId === null) {
14140
+ throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
14141
+ }
14142
+ // verify the required parameter 'body' is set
14143
+ if (body === undefined || body === null) {
14144
+ throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
14145
+ }
14146
+
14147
+ return this.apiClient.callApi(
14148
+ '/api/v2/conversations/socials/{conversationId}/recordingstate',
14149
+ 'PUT',
14150
+ { 'conversationId': conversationId },
14151
+ { },
14152
+ { },
14153
+ { },
14154
+ body,
14155
+ ['PureCloud OAuth'],
14156
+ ['application/json'],
14157
+ ['application/json']
14158
+ );
14159
+ }
14160
+
14161
+ /**
14162
+ * Update a conversation by setting its recording state
14163
+ *
14164
+ * @param {String} conversationId conversationId
14165
+ * @param {Object} body SetRecordingState
14166
+ */
14167
+ putConversationsVideoRecordingstate(conversationId, body) {
14168
+ // verify the required parameter 'conversationId' is set
14169
+ if (conversationId === undefined || conversationId === null) {
14170
+ throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
14171
+ }
14172
+ // verify the required parameter 'body' is set
14173
+ if (body === undefined || body === null) {
14174
+ throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
14175
+ }
14176
+
14177
+ return this.apiClient.callApi(
14178
+ '/api/v2/conversations/videos/{conversationId}/recordingstate',
14179
+ 'PUT',
14180
+ { 'conversationId': conversationId },
14181
+ { },
14182
+ { },
14183
+ { },
14184
+ body,
14185
+ ['PureCloud OAuth'],
14186
+ ['application/json'],
14187
+ ['application/json']
14188
+ );
14189
+ }
14190
+
13918
14191
  }
13919
14192
 
13920
14193
  class DataExtensionsApi {
13921
14194
  /**
13922
14195
  * DataExtensions service.
13923
14196
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
13924
- * @version 138.0.0
14197
+ * @version 140.0.0
13925
14198
  */
13926
14199
 
13927
14200
  /**
@@ -14007,7 +14280,7 @@ class ExternalContactsApi {
14007
14280
  /**
14008
14281
  * ExternalContacts service.
14009
14282
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
14010
- * @version 138.0.0
14283
+ * @version 140.0.0
14011
14284
  */
14012
14285
 
14013
14286
  /**
@@ -15750,7 +16023,7 @@ class FaxApi {
15750
16023
  /**
15751
16024
  * Fax service.
15752
16025
  * @module purecloud-platform-client-v2/api/FaxApi
15753
- * @version 138.0.0
16026
+ * @version 140.0.0
15754
16027
  */
15755
16028
 
15756
16029
  /**
@@ -15921,7 +16194,7 @@ class FlowsApi {
15921
16194
  /**
15922
16195
  * Flows service.
15923
16196
  * @module purecloud-platform-client-v2/api/FlowsApi
15924
- * @version 138.0.0
16197
+ * @version 140.0.0
15925
16198
  */
15926
16199
 
15927
16200
  /**
@@ -15992,7 +16265,7 @@ class GamificationApi {
15992
16265
  /**
15993
16266
  * Gamification service.
15994
16267
  * @module purecloud-platform-client-v2/api/GamificationApi
15995
- * @version 138.0.0
16268
+ * @version 140.0.0
15996
16269
  */
15997
16270
 
15998
16271
  /**
@@ -16137,7 +16410,7 @@ class GamificationApi {
16137
16410
 
16138
16411
  /**
16139
16412
  * Gamified metric by id
16140
- *
16413
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
16141
16414
  * @param {String} metricId metric Id
16142
16415
  * @param {Object} opts Optional parameters
16143
16416
  * @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
@@ -16212,7 +16485,7 @@ class GamificationApi {
16212
16485
 
16213
16486
  /**
16214
16487
  * All gamified metrics for a given profile
16215
- *
16488
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
16216
16489
  * @param {Object} opts Optional parameters
16217
16490
  * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
16218
16491
  * @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
@@ -16263,18 +16536,18 @@ class GamificationApi {
16263
16536
  /**
16264
16537
  * Members of a given performance profile
16265
16538
  *
16266
- * @param {String} performanceProfileId Performance Profile Id
16539
+ * @param {String} profileId Profile Id
16267
16540
  */
16268
- getGamificationProfileMembers(performanceProfileId) {
16269
- // verify the required parameter 'performanceProfileId' is set
16270
- if (performanceProfileId === undefined || performanceProfileId === null) {
16271
- throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
16541
+ getGamificationProfileMembers(profileId) {
16542
+ // verify the required parameter 'profileId' is set
16543
+ if (profileId === undefined || profileId === null) {
16544
+ throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
16272
16545
  }
16273
16546
 
16274
16547
  return this.apiClient.callApi(
16275
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
16548
+ '/api/v2/gamification/profiles/{profileId}/members',
16276
16549
  'GET',
16277
- { 'performanceProfileId': performanceProfileId },
16550
+ { 'profileId': profileId },
16278
16551
  { },
16279
16552
  { },
16280
16553
  { },
@@ -16326,6 +16599,7 @@ class GamificationApi {
16326
16599
  * @param {Object} opts Optional parameters
16327
16600
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
16328
16601
  * @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
16602
+ * @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
16329
16603
  */
16330
16604
  getGamificationProfileMetrics(profileId, opts) {
16331
16605
  opts = opts || {};
@@ -16339,7 +16613,7 @@ class GamificationApi {
16339
16613
  '/api/v2/gamification/profiles/{profileId}/metrics',
16340
16614
  'GET',
16341
16615
  { 'profileId': profileId },
16342
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
16616
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
16343
16617
  { },
16344
16618
  { },
16345
16619
  null,
@@ -17066,7 +17340,7 @@ class GamificationApi {
17066
17340
 
17067
17341
  /**
17068
17342
  * Creates a gamified metric with a given metric definition and metric objective
17069
- *
17343
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
17070
17344
  * @param {Object} body Metric
17071
17345
  */
17072
17346
  postGamificationMetrics(body) {
@@ -17142,13 +17416,13 @@ class GamificationApi {
17142
17416
  /**
17143
17417
  * Assign members to a given performance profile
17144
17418
  *
17145
- * @param {String} performanceProfileId Performance Profile Id
17419
+ * @param {String} profileId Profile Id
17146
17420
  * @param {Object} body assignUsers
17147
17421
  */
17148
- postGamificationProfileMembers(performanceProfileId, body) {
17149
- // verify the required parameter 'performanceProfileId' is set
17150
- if (performanceProfileId === undefined || performanceProfileId === null) {
17151
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
17422
+ postGamificationProfileMembers(profileId, body) {
17423
+ // verify the required parameter 'profileId' is set
17424
+ if (profileId === undefined || profileId === null) {
17425
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
17152
17426
  }
17153
17427
  // verify the required parameter 'body' is set
17154
17428
  if (body === undefined || body === null) {
@@ -17156,9 +17430,9 @@ class GamificationApi {
17156
17430
  }
17157
17431
 
17158
17432
  return this.apiClient.callApi(
17159
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
17433
+ '/api/v2/gamification/profiles/{profileId}/members',
17160
17434
  'POST',
17161
- { 'performanceProfileId': performanceProfileId },
17435
+ { 'profileId': profileId },
17162
17436
  { },
17163
17437
  { },
17164
17438
  { },
@@ -17172,13 +17446,13 @@ class GamificationApi {
17172
17446
  /**
17173
17447
  * Validate member assignment
17174
17448
  *
17175
- * @param {String} performanceProfileId Performance Profile Id
17449
+ * @param {String} profileId Profile Id
17176
17450
  * @param {Object} body memberAssignments
17177
17451
  */
17178
- postGamificationProfileMembersValidate(performanceProfileId, body) {
17179
- // verify the required parameter 'performanceProfileId' is set
17180
- if (performanceProfileId === undefined || performanceProfileId === null) {
17181
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
17452
+ postGamificationProfileMembersValidate(profileId, body) {
17453
+ // verify the required parameter 'profileId' is set
17454
+ if (profileId === undefined || profileId === null) {
17455
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
17182
17456
  }
17183
17457
  // verify the required parameter 'body' is set
17184
17458
  if (body === undefined || body === null) {
@@ -17186,9 +17460,9 @@ class GamificationApi {
17186
17460
  }
17187
17461
 
17188
17462
  return this.apiClient.callApi(
17189
- '/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
17463
+ '/api/v2/gamification/profiles/{profileId}/members/validate',
17190
17464
  'POST',
17191
- { 'performanceProfileId': performanceProfileId },
17465
+ { 'profileId': profileId },
17192
17466
  { },
17193
17467
  { },
17194
17468
  { },
@@ -17295,7 +17569,7 @@ class GamificationApi {
17295
17569
 
17296
17570
  /**
17297
17571
  * Updates a metric
17298
- *
17572
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
17299
17573
  * @param {String} metricId metric Id
17300
17574
  * @param {Object} body Metric
17301
17575
  * @param {Object} opts Optional parameters
@@ -17422,7 +17696,7 @@ class GeneralDataProtectionRegulationApi {
17422
17696
  /**
17423
17697
  * GeneralDataProtectionRegulation service.
17424
17698
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
17425
- * @version 138.0.0
17699
+ * @version 140.0.0
17426
17700
  */
17427
17701
 
17428
17702
  /**
@@ -17552,7 +17826,7 @@ class GeolocationApi {
17552
17826
  /**
17553
17827
  * Geolocation service.
17554
17828
  * @module purecloud-platform-client-v2/api/GeolocationApi
17555
- * @version 138.0.0
17829
+ * @version 140.0.0
17556
17830
  */
17557
17831
 
17558
17832
  /**
@@ -17683,7 +17957,7 @@ class GreetingsApi {
17683
17957
  /**
17684
17958
  * Greetings service.
17685
17959
  * @module purecloud-platform-client-v2/api/GreetingsApi
17686
- * @version 138.0.0
17960
+ * @version 140.0.0
17687
17961
  */
17688
17962
 
17689
17963
  /**
@@ -18138,7 +18412,7 @@ class GroupsApi {
18138
18412
  /**
18139
18413
  * Groups service.
18140
18414
  * @module purecloud-platform-client-v2/api/GroupsApi
18141
- * @version 138.0.0
18415
+ * @version 140.0.0
18142
18416
  */
18143
18417
 
18144
18418
  /**
@@ -18543,7 +18817,7 @@ class IdentityProviderApi {
18543
18817
  /**
18544
18818
  * IdentityProvider service.
18545
18819
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
18546
- * @version 138.0.0
18820
+ * @version 140.0.0
18547
18821
  */
18548
18822
 
18549
18823
  /**
@@ -19299,7 +19573,7 @@ class IntegrationsApi {
19299
19573
  /**
19300
19574
  * Integrations service.
19301
19575
  * @module purecloud-platform-client-v2/api/IntegrationsApi
19302
- * @version 138.0.0
19576
+ * @version 140.0.0
19303
19577
  */
19304
19578
 
19305
19579
  /**
@@ -20976,7 +21250,7 @@ class JourneyApi {
20976
21250
  /**
20977
21251
  * Journey service.
20978
21252
  * @module purecloud-platform-client-v2/api/JourneyApi
20979
- * @version 138.0.0
21253
+ * @version 140.0.0
20980
21254
  */
20981
21255
 
20982
21256
  /**
@@ -21687,7 +21961,7 @@ class KnowledgeApi {
21687
21961
  /**
21688
21962
  * Knowledge service.
21689
21963
  * @module purecloud-platform-client-v2/api/KnowledgeApi
21690
- * @version 138.0.0
21964
+ * @version 140.0.0
21691
21965
  */
21692
21966
 
21693
21967
  /**
@@ -21865,7 +22139,7 @@ class KnowledgeApi {
21865
22139
  * @param {Object} opts Optional parameters
21866
22140
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
21867
22141
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
21868
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22142
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
21869
22143
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
21870
22144
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
21871
22145
  */
@@ -21973,7 +22247,7 @@ class KnowledgeApi {
21973
22247
  * @param {Object} opts Optional parameters
21974
22248
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
21975
22249
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
21976
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22250
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
21977
22251
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
21978
22252
  * @param {String} opts.categories Filter by categories ids, comma separated values expected.
21979
22253
  * @param {String} opts.title Filter by document title.
@@ -22085,7 +22359,7 @@ class KnowledgeApi {
22085
22359
  * @param {Object} opts Optional parameters
22086
22360
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22087
22361
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22088
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22362
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
22089
22363
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22090
22364
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
22091
22365
  */
@@ -22121,7 +22395,7 @@ class KnowledgeApi {
22121
22395
  * @param {Object} opts Optional parameters
22122
22396
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
22123
22397
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
22124
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
22398
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
22125
22399
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
22126
22400
  * @param {String} opts.name Filter by Name.
22127
22401
  * @param {Object} opts.coreLanguage Filter by core language.
@@ -22587,7 +22861,7 @@ class LanguageUnderstandingApi {
22587
22861
  /**
22588
22862
  * LanguageUnderstanding service.
22589
22863
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
22590
- * @version 138.0.0
22864
+ * @version 140.0.0
22591
22865
  */
22592
22866
 
22593
22867
  /**
@@ -23491,7 +23765,7 @@ class LanguagesApi {
23491
23765
  /**
23492
23766
  * Languages service.
23493
23767
  * @module purecloud-platform-client-v2/api/LanguagesApi
23494
- * @version 138.0.0
23768
+ * @version 140.0.0
23495
23769
  */
23496
23770
 
23497
23771
  /**
@@ -23759,7 +24033,7 @@ class LearningApi {
23759
24033
  /**
23760
24034
  * Learning service.
23761
24035
  * @module purecloud-platform-client-v2/api/LearningApi
23762
- * @version 138.0.0
24036
+ * @version 140.0.0
23763
24037
  */
23764
24038
 
23765
24039
  /**
@@ -23957,6 +24231,36 @@ class LearningApi {
23957
24231
  );
23958
24232
  }
23959
24233
 
24234
+ /**
24235
+ * Get a specific Learning Module job status
24236
+ *
24237
+ * @param {String} moduleId The ID of the learning module
24238
+ * @param {String} jobId The ID of the learning module job
24239
+ */
24240
+ getLearningModuleJob(moduleId, jobId) {
24241
+ // verify the required parameter 'moduleId' is set
24242
+ if (moduleId === undefined || moduleId === null) {
24243
+ throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
24244
+ }
24245
+ // verify the required parameter 'jobId' is set
24246
+ if (jobId === undefined || jobId === null) {
24247
+ throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
24248
+ }
24249
+
24250
+ return this.apiClient.callApi(
24251
+ '/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
24252
+ 'GET',
24253
+ { 'moduleId': moduleId,'jobId': jobId },
24254
+ { },
24255
+ { },
24256
+ { },
24257
+ null,
24258
+ ['PureCloud OAuth'],
24259
+ ['application/json'],
24260
+ ['application/json']
24261
+ );
24262
+ }
24263
+
23960
24264
  /**
23961
24265
  * Get a learning module rule
23962
24266
  *
@@ -24102,6 +24406,56 @@ class LearningApi {
24102
24406
  );
24103
24407
  }
24104
24408
 
24409
+ /**
24410
+ * Reassign Learning Assignment
24411
+ * This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
24412
+ * @param {String} assignmentId The Learning Assignment ID
24413
+ */
24414
+ postLearningAssignmentReassign(assignmentId) {
24415
+ // verify the required parameter 'assignmentId' is set
24416
+ if (assignmentId === undefined || assignmentId === null) {
24417
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
24418
+ }
24419
+
24420
+ return this.apiClient.callApi(
24421
+ '/api/v2/learning/assignments/{assignmentId}/reassign',
24422
+ 'POST',
24423
+ { 'assignmentId': assignmentId },
24424
+ { },
24425
+ { },
24426
+ { },
24427
+ null,
24428
+ ['PureCloud OAuth'],
24429
+ ['application/json'],
24430
+ ['application/json']
24431
+ );
24432
+ }
24433
+
24434
+ /**
24435
+ * Reset Learning Assignment
24436
+ * This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
24437
+ * @param {String} assignmentId The Learning Assignment ID
24438
+ */
24439
+ postLearningAssignmentReset(assignmentId) {
24440
+ // verify the required parameter 'assignmentId' is set
24441
+ if (assignmentId === undefined || assignmentId === null) {
24442
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
24443
+ }
24444
+
24445
+ return this.apiClient.callApi(
24446
+ '/api/v2/learning/assignments/{assignmentId}/reset',
24447
+ 'POST',
24448
+ { 'assignmentId': assignmentId },
24449
+ { },
24450
+ { },
24451
+ { },
24452
+ null,
24453
+ ['PureCloud OAuth'],
24454
+ ['application/json'],
24455
+ ['application/json']
24456
+ );
24457
+ }
24458
+
24105
24459
  /**
24106
24460
  * Create Learning Assignment
24107
24461
  *
@@ -24199,6 +24553,36 @@ class LearningApi {
24199
24553
  );
24200
24554
  }
24201
24555
 
24556
+ /**
24557
+ * Starts a specified operation on learning module
24558
+ * This will initiate operation specified in the request body for a learning module
24559
+ * @param {String} moduleId The ID of the learning module
24560
+ * @param {Object} body The learning module job request
24561
+ */
24562
+ postLearningModuleJobs(moduleId, body) {
24563
+ // verify the required parameter 'moduleId' is set
24564
+ if (moduleId === undefined || moduleId === null) {
24565
+ throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
24566
+ }
24567
+ // verify the required parameter 'body' is set
24568
+ if (body === undefined || body === null) {
24569
+ throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
24570
+ }
24571
+
24572
+ return this.apiClient.callApi(
24573
+ '/api/v2/learning/modules/{moduleId}/jobs',
24574
+ 'POST',
24575
+ { 'moduleId': moduleId },
24576
+ { },
24577
+ { },
24578
+ { },
24579
+ body,
24580
+ ['PureCloud OAuth'],
24581
+ ['application/json'],
24582
+ ['application/json']
24583
+ );
24584
+ }
24585
+
24202
24586
  /**
24203
24587
  * Publish a Learning module
24204
24588
  *
@@ -24350,7 +24734,7 @@ class LicenseApi {
24350
24734
  /**
24351
24735
  * License service.
24352
24736
  * @module purecloud-platform-client-v2/api/LicenseApi
24353
- * @version 138.0.0
24737
+ * @version 140.0.0
24354
24738
  */
24355
24739
 
24356
24740
  /**
@@ -24588,7 +24972,7 @@ class LocationsApi {
24588
24972
  /**
24589
24973
  * Locations service.
24590
24974
  * @module purecloud-platform-client-v2/api/LocationsApi
24591
- * @version 138.0.0
24975
+ * @version 140.0.0
24592
24976
  */
24593
24977
 
24594
24978
  /**
@@ -24824,7 +25208,7 @@ class MessagingApi {
24824
25208
  /**
24825
25209
  * Messaging service.
24826
25210
  * @module purecloud-platform-client-v2/api/MessagingApi
24827
- * @version 138.0.0
25211
+ * @version 140.0.0
24828
25212
  */
24829
25213
 
24830
25214
  /**
@@ -24975,7 +25359,7 @@ class MobileDevicesApi {
24975
25359
  /**
24976
25360
  * MobileDevices service.
24977
25361
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
24978
- * @version 138.0.0
25362
+ * @version 140.0.0
24979
25363
  */
24980
25364
 
24981
25365
  /**
@@ -25126,7 +25510,7 @@ class NotificationsApi {
25126
25510
  /**
25127
25511
  * Notifications service.
25128
25512
  * @module purecloud-platform-client-v2/api/NotificationsApi
25129
- * @version 138.0.0
25513
+ * @version 140.0.0
25130
25514
  */
25131
25515
 
25132
25516
  /**
@@ -25351,7 +25735,7 @@ class OAuthApi {
25351
25735
  /**
25352
25736
  * OAuth service.
25353
25737
  * @module purecloud-platform-client-v2/api/OAuthApi
25354
- * @version 138.0.0
25738
+ * @version 140.0.0
25355
25739
  */
25356
25740
 
25357
25741
  /**
@@ -25717,7 +26101,7 @@ class ObjectsApi {
25717
26101
  /**
25718
26102
  * Objects service.
25719
26103
  * @module purecloud-platform-client-v2/api/ObjectsApi
25720
- * @version 138.0.0
26104
+ * @version 140.0.0
25721
26105
  */
25722
26106
 
25723
26107
  /**
@@ -25988,7 +26372,7 @@ class OrganizationApi {
25988
26372
  /**
25989
26373
  * Organization service.
25990
26374
  * @module purecloud-platform-client-v2/api/OrganizationApi
25991
- * @version 138.0.0
26375
+ * @version 140.0.0
25992
26376
  */
25993
26377
 
25994
26378
  /**
@@ -26391,7 +26775,7 @@ class OrganizationAuthorizationApi {
26391
26775
  /**
26392
26776
  * OrganizationAuthorization service.
26393
26777
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
26394
- * @version 138.0.0
26778
+ * @version 140.0.0
26395
26779
  */
26396
26780
 
26397
26781
  /**
@@ -27316,7 +27700,7 @@ class OutboundApi {
27316
27700
  /**
27317
27701
  * Outbound service.
27318
27702
  * @module purecloud-platform-client-v2/api/OutboundApi
27319
- * @version 138.0.0
27703
+ * @version 140.0.0
27320
27704
  */
27321
27705
 
27322
27706
  /**
@@ -30571,7 +30955,7 @@ class PresenceApi {
30571
30955
  /**
30572
30956
  * Presence service.
30573
30957
  * @module purecloud-platform-client-v2/api/PresenceApi
30574
- * @version 138.0.0
30958
+ * @version 140.0.0
30575
30959
  */
30576
30960
 
30577
30961
  /**
@@ -30893,7 +31277,7 @@ class QualityApi {
30893
31277
  /**
30894
31278
  * Quality service.
30895
31279
  * @module purecloud-platform-client-v2/api/QualityApi
30896
- * @version 138.0.0
31280
+ * @version 140.0.0
30897
31281
  */
30898
31282
 
30899
31283
  /**
@@ -31651,7 +32035,7 @@ class QualityApi {
31651
32035
  /**
31652
32036
  * Retrieve a list of the latest form versions by context ids
31653
32037
  *
31654
- * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
32038
+ * @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.
31655
32039
  * @param {Object} opts Optional parameters
31656
32040
  * @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)
31657
32041
  */
@@ -32471,7 +32855,7 @@ class RecordingApi {
32471
32855
  /**
32472
32856
  * Recording service.
32473
32857
  * @module purecloud-platform-client-v2/api/RecordingApi
32474
- * @version 138.0.0
32858
+ * @version 140.0.0
32475
32859
  */
32476
32860
 
32477
32861
  /**
@@ -34124,7 +34508,7 @@ class ResponseManagementApi {
34124
34508
  /**
34125
34509
  * ResponseManagement service.
34126
34510
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
34127
- * @version 138.0.0
34511
+ * @version 140.0.0
34128
34512
  */
34129
34513
 
34130
34514
  /**
@@ -34608,7 +34992,7 @@ class RoutingApi {
34608
34992
  /**
34609
34993
  * Routing service.
34610
34994
  * @module purecloud-platform-client-v2/api/RoutingApi
34611
- * @version 138.0.0
34995
+ * @version 140.0.0
34612
34996
  */
34613
34997
 
34614
34998
  /**
@@ -34921,12 +35305,8 @@ class RoutingApi {
34921
35305
  * Delete a phone number provisioned for SMS.
34922
35306
  *
34923
35307
  * @param {String} addressId Address ID
34924
- * @param {Object} opts Optional parameters
34925
- * @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)
34926
35308
  */
34927
- deleteRoutingSmsPhonenumber(addressId, opts) {
34928
- opts = opts || {};
34929
-
35309
+ deleteRoutingSmsPhonenumber(addressId) {
34930
35310
  // verify the required parameter 'addressId' is set
34931
35311
  if (addressId === undefined || addressId === null) {
34932
35312
  throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
@@ -34936,7 +35316,7 @@ class RoutingApi {
34936
35316
  '/api/v2/routing/sms/phonenumbers/{addressId}',
34937
35317
  'DELETE',
34938
35318
  { 'addressId': addressId },
34939
- { 'async': opts['async'] },
35319
+ { },
34940
35320
  { },
34941
35321
  { },
34942
35322
  null,
@@ -35107,7 +35487,7 @@ class RoutingApi {
35107
35487
  * @param {Object} opts Optional parameters
35108
35488
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
35109
35489
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
35110
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
35490
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
35111
35491
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
35112
35492
  * @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
35113
35493
  */
@@ -35418,7 +35798,7 @@ class RoutingApi {
35418
35798
  * @param {Object} opts Optional parameters
35419
35799
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
35420
35800
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
35421
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
35801
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
35422
35802
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
35423
35803
  * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
35424
35804
  */
@@ -35441,16 +35821,20 @@ class RoutingApi {
35441
35821
  }
35442
35822
 
35443
35823
  /**
35444
- * Get a list of Key Performance Indicators available for the predictors.
35824
+ * Get a list of Key Performance Indicators
35445
35825
  *
35826
+ * @param {Object} opts Optional parameters
35827
+ * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
35446
35828
  */
35447
- getRoutingPredictorsKeyperformanceindicators() {
35829
+ getRoutingPredictorsKeyperformanceindicators(opts) {
35830
+ opts = opts || {};
35831
+
35448
35832
 
35449
35833
  return this.apiClient.callApi(
35450
35834
  '/api/v2/routing/predictors/keyperformanceindicators',
35451
35835
  'GET',
35452
35836
  { },
35453
- { },
35837
+ { 'kpiGroup': opts['kpiGroup'] },
35454
35838
  { },
35455
35839
  { },
35456
35840
  null,
@@ -37090,12 +37474,8 @@ class RoutingApi {
37090
37474
  * Provision a phone number for SMS
37091
37475
  *
37092
37476
  * @param {Object} body SmsPhoneNumber
37093
- * @param {Object} opts Optional parameters
37094
- * @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)
37095
37477
  */
37096
- postRoutingSmsPhonenumbers(body, opts) {
37097
- opts = opts || {};
37098
-
37478
+ postRoutingSmsPhonenumbers(body) {
37099
37479
  // verify the required parameter 'body' is set
37100
37480
  if (body === undefined || body === null) {
37101
37481
  throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
@@ -37105,7 +37485,7 @@ class RoutingApi {
37105
37485
  '/api/v2/routing/sms/phonenumbers',
37106
37486
  'POST',
37107
37487
  { },
37108
- { 'async': opts['async'] },
37488
+ { },
37109
37489
  { },
37110
37490
  { },
37111
37491
  body,
@@ -37350,12 +37730,8 @@ class RoutingApi {
37350
37730
  *
37351
37731
  * @param {String} addressId Address ID
37352
37732
  * @param {Object} body SmsPhoneNumber
37353
- * @param {Object} opts Optional parameters
37354
- * @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)
37355
37733
  */
37356
- putRoutingSmsPhonenumber(addressId, body, opts) {
37357
- opts = opts || {};
37358
-
37734
+ putRoutingSmsPhonenumber(addressId, body) {
37359
37735
  // verify the required parameter 'addressId' is set
37360
37736
  if (addressId === undefined || addressId === null) {
37361
37737
  throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
@@ -37369,7 +37745,7 @@ class RoutingApi {
37369
37745
  '/api/v2/routing/sms/phonenumbers/{addressId}',
37370
37746
  'PUT',
37371
37747
  { 'addressId': addressId },
37372
- { 'async': opts['async'] },
37748
+ { },
37373
37749
  { },
37374
37750
  { },
37375
37751
  body,
@@ -37535,7 +37911,7 @@ class SCIMApi {
37535
37911
  /**
37536
37912
  * SCIM service.
37537
37913
  * @module purecloud-platform-client-v2/api/SCIMApi
37538
- * @version 138.0.0
37914
+ * @version 140.0.0
37539
37915
  */
37540
37916
 
37541
37917
  /**
@@ -38412,7 +38788,7 @@ class ScriptsApi {
38412
38788
  /**
38413
38789
  * Scripts service.
38414
38790
  * @module purecloud-platform-client-v2/api/ScriptsApi
38415
- * @version 138.0.0
38791
+ * @version 140.0.0
38416
38792
  */
38417
38793
 
38418
38794
  /**
@@ -38831,7 +39207,7 @@ class SearchApi {
38831
39207
  /**
38832
39208
  * Search service.
38833
39209
  * @module purecloud-platform-client-v2/api/SearchApi
38834
- * @version 138.0.0
39210
+ * @version 140.0.0
38835
39211
  */
38836
39212
 
38837
39213
  /**
@@ -39366,7 +39742,7 @@ class SpeechTextAnalyticsApi {
39366
39742
  /**
39367
39743
  * SpeechTextAnalytics service.
39368
39744
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
39369
- * @version 138.0.0
39745
+ * @version 140.0.0
39370
39746
  */
39371
39747
 
39372
39748
  /**
@@ -40219,7 +40595,7 @@ class StationsApi {
40219
40595
  /**
40220
40596
  * Stations service.
40221
40597
  * @module purecloud-platform-client-v2/api/StationsApi
40222
- * @version 138.0.0
40598
+ * @version 140.0.0
40223
40599
  */
40224
40600
 
40225
40601
  /**
@@ -40366,7 +40742,7 @@ class SuggestApi {
40366
40742
  /**
40367
40743
  * Suggest service.
40368
40744
  * @module purecloud-platform-client-v2/api/SuggestApi
40369
- * @version 138.0.0
40745
+ * @version 140.0.0
40370
40746
  */
40371
40747
 
40372
40748
  /**
@@ -40505,7 +40881,7 @@ class TelephonyApi {
40505
40881
  /**
40506
40882
  * Telephony service.
40507
40883
  * @module purecloud-platform-client-v2/api/TelephonyApi
40508
- * @version 138.0.0
40884
+ * @version 140.0.0
40509
40885
  */
40510
40886
 
40511
40887
  /**
@@ -40613,7 +40989,7 @@ class TelephonyProvidersEdgeApi {
40613
40989
  /**
40614
40990
  * TelephonyProvidersEdge service.
40615
40991
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
40616
- * @version 138.0.0
40992
+ * @version 140.0.0
40617
40993
  */
40618
40994
 
40619
40995
  /**
@@ -44246,7 +44622,7 @@ class TextbotsApi {
44246
44622
  /**
44247
44623
  * Textbots service.
44248
44624
  * @module purecloud-platform-client-v2/api/TextbotsApi
44249
- * @version 138.0.0
44625
+ * @version 140.0.0
44250
44626
  */
44251
44627
 
44252
44628
  /**
@@ -44374,7 +44750,7 @@ class TokensApi {
44374
44750
  /**
44375
44751
  * Tokens service.
44376
44752
  * @module purecloud-platform-client-v2/api/TokensApi
44377
- * @version 138.0.0
44753
+ * @version 140.0.0
44378
44754
  */
44379
44755
 
44380
44756
  /**
@@ -44480,7 +44856,7 @@ class UploadsApi {
44480
44856
  /**
44481
44857
  * Uploads service.
44482
44858
  * @module purecloud-platform-client-v2/api/UploadsApi
44483
- * @version 138.0.0
44859
+ * @version 140.0.0
44484
44860
  */
44485
44861
 
44486
44862
  /**
@@ -44631,7 +45007,7 @@ class UsageApi {
44631
45007
  /**
44632
45008
  * Usage service.
44633
45009
  * @module purecloud-platform-client-v2/api/UsageApi
44634
- * @version 138.0.0
45010
+ * @version 140.0.0
44635
45011
  */
44636
45012
 
44637
45013
  /**
@@ -44702,7 +45078,7 @@ class UserRecordingsApi {
44702
45078
  /**
44703
45079
  * UserRecordings service.
44704
45080
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
44705
- * @version 138.0.0
45081
+ * @version 140.0.0
44706
45082
  */
44707
45083
 
44708
45084
  /**
@@ -44886,7 +45262,7 @@ class UsersApi {
44886
45262
  /**
44887
45263
  * Users service.
44888
45264
  * @module purecloud-platform-client-v2/api/UsersApi
44889
- * @version 138.0.0
45265
+ * @version 140.0.0
44890
45266
  */
44891
45267
 
44892
45268
  /**
@@ -45706,18 +46082,18 @@ class UsersApi {
45706
46082
  /**
45707
46083
  * Returns a listing of roles and permissions for a user.
45708
46084
  *
45709
- * @param {String} userId User ID
46085
+ * @param {String} subjectId User ID
45710
46086
  */
45711
- getUserRoles(userId) {
45712
- // verify the required parameter 'userId' is set
45713
- if (userId === undefined || userId === null) {
45714
- throw 'Missing the required parameter "userId" when calling getUserRoles';
46087
+ getUserRoles(subjectId) {
46088
+ // verify the required parameter 'subjectId' is set
46089
+ if (subjectId === undefined || subjectId === null) {
46090
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
45715
46091
  }
45716
46092
 
45717
46093
  return this.apiClient.callApi(
45718
- '/api/v2/users/{userId}/roles',
46094
+ '/api/v2/users/{subjectId}/roles',
45719
46095
  'GET',
45720
- { 'userId': userId },
46096
+ { 'subjectId': subjectId },
45721
46097
  { },
45722
46098
  { },
45723
46099
  { },
@@ -46970,13 +47346,13 @@ class UsersApi {
46970
47346
  /**
46971
47347
  * Sets the user's roles
46972
47348
  *
46973
- * @param {String} userId User ID
47349
+ * @param {String} subjectId User ID
46974
47350
  * @param {Array.<String>} body List of roles
46975
47351
  */
46976
- putUserRoles(userId, body) {
46977
- // verify the required parameter 'userId' is set
46978
- if (userId === undefined || userId === null) {
46979
- throw 'Missing the required parameter "userId" when calling putUserRoles';
47352
+ putUserRoles(subjectId, body) {
47353
+ // verify the required parameter 'subjectId' is set
47354
+ if (subjectId === undefined || subjectId === null) {
47355
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
46980
47356
  }
46981
47357
  // verify the required parameter 'body' is set
46982
47358
  if (body === undefined || body === null) {
@@ -46984,9 +47360,9 @@ class UsersApi {
46984
47360
  }
46985
47361
 
46986
47362
  return this.apiClient.callApi(
46987
- '/api/v2/users/{userId}/roles',
47363
+ '/api/v2/users/{subjectId}/roles',
46988
47364
  'PUT',
46989
- { 'userId': userId },
47365
+ { 'subjectId': subjectId },
46990
47366
  { },
46991
47367
  { },
46992
47368
  { },
@@ -47188,7 +47564,7 @@ class UtilitiesApi {
47188
47564
  /**
47189
47565
  * Utilities service.
47190
47566
  * @module purecloud-platform-client-v2/api/UtilitiesApi
47191
- * @version 138.0.0
47567
+ * @version 140.0.0
47192
47568
  */
47193
47569
 
47194
47570
  /**
@@ -47299,7 +47675,7 @@ class VoicemailApi {
47299
47675
  /**
47300
47676
  * Voicemail service.
47301
47677
  * @module purecloud-platform-client-v2/api/VoicemailApi
47302
- * @version 138.0.0
47678
+ * @version 140.0.0
47303
47679
  */
47304
47680
 
47305
47681
  /**
@@ -47966,7 +48342,7 @@ class WebChatApi {
47966
48342
  /**
47967
48343
  * WebChat service.
47968
48344
  * @module purecloud-platform-client-v2/api/WebChatApi
47969
- * @version 138.0.0
48345
+ * @version 140.0.0
47970
48346
  */
47971
48347
 
47972
48348
  /**
@@ -48510,7 +48886,7 @@ class WebDeploymentsApi {
48510
48886
  /**
48511
48887
  * WebDeployments service.
48512
48888
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
48513
- * @version 138.0.0
48889
+ * @version 140.0.0
48514
48890
  */
48515
48891
 
48516
48892
  /**
@@ -48865,7 +49241,7 @@ class WebMessagingApi {
48865
49241
  /**
48866
49242
  * WebMessaging service.
48867
49243
  * @module purecloud-platform-client-v2/api/WebMessagingApi
48868
- * @version 138.0.0
49244
+ * @version 140.0.0
48869
49245
  */
48870
49246
 
48871
49247
  /**
@@ -48911,7 +49287,7 @@ class WidgetsApi {
48911
49287
  /**
48912
49288
  * Widgets service.
48913
49289
  * @module purecloud-platform-client-v2/api/WidgetsApi
48914
- * @version 138.0.0
49290
+ * @version 140.0.0
48915
49291
  */
48916
49292
 
48917
49293
  /**
@@ -49057,7 +49433,7 @@ class WorkforceManagementApi {
49057
49433
  /**
49058
49434
  * WorkforceManagement service.
49059
49435
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
49060
- * @version 138.0.0
49436
+ * @version 140.0.0
49061
49437
  */
49062
49438
 
49063
49439
  /**
@@ -53308,7 +53684,7 @@ class WorkforceManagementApi {
53308
53684
  * </pre>
53309
53685
  * </p>
53310
53686
  * @module purecloud-platform-client-v2/index
53311
- * @version 138.0.0
53687
+ * @version 140.0.0
53312
53688
  */
53313
53689
  class platformClient {
53314
53690
  constructor() {