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
@@ -2276,7 +2276,7 @@ class Configuration {
2276
2276
 
2277
2277
  /**
2278
2278
  * @module purecloud-platform-client-v2/ApiClient
2279
- * @version 138.0.0
2279
+ * @version 140.0.0
2280
2280
  */
2281
2281
  class ApiClient {
2282
2282
  /**
@@ -3029,7 +3029,7 @@ class ApiClient {
3029
3029
  serialize(obj) {
3030
3030
  var result = {};
3031
3031
  for (var p in obj) {
3032
- if (obj.hasOwnProperty(p)) {
3032
+ if (obj.hasOwnProperty(p) && obj[p] !== undefined) {
3033
3033
  result[encodeURIComponent(p)] = Array.isArray(obj[p]) ? obj[p].join(",") : this.paramToString(obj[p]);
3034
3034
  }
3035
3035
  }
@@ -3159,6 +3159,9 @@ class ApiClient {
3159
3159
  */
3160
3160
  buildCollectionParam(param, collectionFormat) {
3161
3161
  if (!param) return;
3162
+ if (!Array.isArray(param)) {
3163
+ param = [param];
3164
+ }
3162
3165
 
3163
3166
  switch (collectionFormat) {
3164
3167
  case 'csv':
@@ -3344,7 +3347,7 @@ class AlertingApi {
3344
3347
  /**
3345
3348
  * Alerting service.
3346
3349
  * @module purecloud-platform-client-v2/api/AlertingApi
3347
- * @version 138.0.0
3350
+ * @version 140.0.0
3348
3351
  */
3349
3352
 
3350
3353
  /**
@@ -3658,7 +3661,7 @@ class AnalyticsApi {
3658
3661
  /**
3659
3662
  * Analytics service.
3660
3663
  * @module purecloud-platform-client-v2/api/AnalyticsApi
3661
- * @version 138.0.0
3664
+ * @version 140.0.0
3662
3665
  */
3663
3666
 
3664
3667
  /**
@@ -4840,7 +4843,7 @@ class ArchitectApi {
4840
4843
  /**
4841
4844
  * Architect service.
4842
4845
  * @module purecloud-platform-client-v2/api/ArchitectApi
4843
- * @version 138.0.0
4846
+ * @version 140.0.0
4844
4847
  */
4845
4848
 
4846
4849
  /**
@@ -7885,7 +7888,7 @@ class AuditApi {
7885
7888
  /**
7886
7889
  * Audit service.
7887
7890
  * @module purecloud-platform-client-v2/api/AuditApi
7888
- * @version 138.0.0
7891
+ * @version 140.0.0
7889
7892
  */
7890
7893
 
7891
7894
  /**
@@ -8056,7 +8059,7 @@ class AuthorizationApi {
8056
8059
  /**
8057
8060
  * Authorization service.
8058
8061
  * @module purecloud-platform-client-v2/api/AuthorizationApi
8059
- * @version 138.0.0
8062
+ * @version 140.0.0
8060
8063
  */
8061
8064
 
8062
8065
  /**
@@ -8661,18 +8664,18 @@ class AuthorizationApi {
8661
8664
  /**
8662
8665
  * Returns a listing of roles and permissions for a user.
8663
8666
  *
8664
- * @param {String} userId User ID
8667
+ * @param {String} subjectId User ID
8665
8668
  */
8666
- getUserRoles(userId) {
8667
- // verify the required parameter 'userId' is set
8668
- if (userId === undefined || userId === null) {
8669
- throw 'Missing the required parameter "userId" when calling getUserRoles';
8669
+ getUserRoles(subjectId) {
8670
+ // verify the required parameter 'subjectId' is set
8671
+ if (subjectId === undefined || subjectId === null) {
8672
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
8670
8673
  }
8671
8674
 
8672
8675
  return this.apiClient.callApi(
8673
- '/api/v2/users/{userId}/roles',
8676
+ '/api/v2/users/{subjectId}/roles',
8674
8677
  'GET',
8675
- { 'userId': userId },
8678
+ { 'subjectId': subjectId },
8676
8679
  { },
8677
8680
  { },
8678
8681
  { },
@@ -9206,13 +9209,13 @@ class AuthorizationApi {
9206
9209
  /**
9207
9210
  * Sets the user's roles
9208
9211
  *
9209
- * @param {String} userId User ID
9212
+ * @param {String} subjectId User ID
9210
9213
  * @param {Array.<String>} body List of roles
9211
9214
  */
9212
- putUserRoles(userId, body) {
9213
- // verify the required parameter 'userId' is set
9214
- if (userId === undefined || userId === null) {
9215
- throw 'Missing the required parameter "userId" when calling putUserRoles';
9215
+ putUserRoles(subjectId, body) {
9216
+ // verify the required parameter 'subjectId' is set
9217
+ if (subjectId === undefined || subjectId === null) {
9218
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
9216
9219
  }
9217
9220
  // verify the required parameter 'body' is set
9218
9221
  if (body === undefined || body === null) {
@@ -9220,9 +9223,9 @@ class AuthorizationApi {
9220
9223
  }
9221
9224
 
9222
9225
  return this.apiClient.callApi(
9223
- '/api/v2/users/{userId}/roles',
9226
+ '/api/v2/users/{subjectId}/roles',
9224
9227
  'PUT',
9225
- { 'userId': userId },
9228
+ { 'subjectId': subjectId },
9226
9229
  { },
9227
9230
  { },
9228
9231
  { },
@@ -9239,7 +9242,7 @@ class BillingApi {
9239
9242
  /**
9240
9243
  * Billing service.
9241
9244
  * @module purecloud-platform-client-v2/api/BillingApi
9242
- * @version 138.0.0
9245
+ * @version 140.0.0
9243
9246
  */
9244
9247
 
9245
9248
  /**
@@ -9319,7 +9322,7 @@ class ChatApi {
9319
9322
  /**
9320
9323
  * Chat service.
9321
9324
  * @module purecloud-platform-client-v2/api/ChatApi
9322
- * @version 138.0.0
9325
+ * @version 140.0.0
9323
9326
  */
9324
9327
 
9325
9328
  /**
@@ -9410,7 +9413,7 @@ class CoachingApi {
9410
9413
  /**
9411
9414
  * Coaching service.
9412
9415
  * @module purecloud-platform-client-v2/api/CoachingApi
9413
- * @version 138.0.0
9416
+ * @version 140.0.0
9414
9417
  */
9415
9418
 
9416
9419
  /**
@@ -9987,7 +9990,7 @@ class ContentManagementApi {
9987
9990
  /**
9988
9991
  * ContentManagement service.
9989
9992
  * @module purecloud-platform-client-v2/api/ContentManagementApi
9990
- * @version 138.0.0
9993
+ * @version 140.0.0
9991
9994
  */
9992
9995
 
9993
9996
  /**
@@ -11127,7 +11130,7 @@ class ConversationsApi {
11127
11130
  /**
11128
11131
  * Conversations service.
11129
11132
  * @module purecloud-platform-client-v2/api/ConversationsApi
11130
- * @version 138.0.0
11133
+ * @version 140.0.0
11131
11134
  */
11132
11135
 
11133
11136
  /**
@@ -15675,6 +15678,126 @@ class ConversationsApi {
15675
15678
  );
15676
15679
  }
15677
15680
 
15681
+ /**
15682
+ * Update a conversation by setting its recording state
15683
+ *
15684
+ * @param {String} conversationId conversationId
15685
+ * @param {Object} body SetRecordingState
15686
+ */
15687
+ putConversationsCallRecordingstate(conversationId, body) {
15688
+ // verify the required parameter 'conversationId' is set
15689
+ if (conversationId === undefined || conversationId === null) {
15690
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
15691
+ }
15692
+ // verify the required parameter 'body' is set
15693
+ if (body === undefined || body === null) {
15694
+ throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
15695
+ }
15696
+
15697
+ return this.apiClient.callApi(
15698
+ '/api/v2/conversations/calls/{conversationId}/recordingstate',
15699
+ 'PUT',
15700
+ { 'conversationId': conversationId },
15701
+ { },
15702
+ { },
15703
+ { },
15704
+ body,
15705
+ ['PureCloud OAuth'],
15706
+ ['application/json'],
15707
+ ['application/json']
15708
+ );
15709
+ }
15710
+
15711
+ /**
15712
+ * Update a conversation by setting its recording state
15713
+ *
15714
+ * @param {String} conversationId conversationId
15715
+ * @param {Object} body SetRecordingState
15716
+ */
15717
+ putConversationsCallbackRecordingstate(conversationId, body) {
15718
+ // verify the required parameter 'conversationId' is set
15719
+ if (conversationId === undefined || conversationId === null) {
15720
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
15721
+ }
15722
+ // verify the required parameter 'body' is set
15723
+ if (body === undefined || body === null) {
15724
+ throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
15725
+ }
15726
+
15727
+ return this.apiClient.callApi(
15728
+ '/api/v2/conversations/callbacks/{conversationId}/recordingstate',
15729
+ 'PUT',
15730
+ { 'conversationId': conversationId },
15731
+ { },
15732
+ { },
15733
+ { },
15734
+ body,
15735
+ ['PureCloud OAuth'],
15736
+ ['application/json'],
15737
+ ['application/json']
15738
+ );
15739
+ }
15740
+
15741
+ /**
15742
+ * Update a conversation by setting its recording state
15743
+ *
15744
+ * @param {String} conversationId conversationId
15745
+ * @param {Object} body SetRecordingState
15746
+ */
15747
+ putConversationsChatRecordingstate(conversationId, body) {
15748
+ // verify the required parameter 'conversationId' is set
15749
+ if (conversationId === undefined || conversationId === null) {
15750
+ throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
15751
+ }
15752
+ // verify the required parameter 'body' is set
15753
+ if (body === undefined || body === null) {
15754
+ throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
15755
+ }
15756
+
15757
+ return this.apiClient.callApi(
15758
+ '/api/v2/conversations/chats/{conversationId}/recordingstate',
15759
+ 'PUT',
15760
+ { 'conversationId': conversationId },
15761
+ { },
15762
+ { },
15763
+ { },
15764
+ body,
15765
+ ['PureCloud OAuth'],
15766
+ ['application/json'],
15767
+ ['application/json']
15768
+ );
15769
+ }
15770
+
15771
+ /**
15772
+ * Update a conversation by setting its recording state
15773
+ *
15774
+ * @param {String} conversationId conversationId
15775
+ * @param {Object} body SetRecordingState
15776
+ */
15777
+ putConversationsCobrowsesessionRecordingstate(conversationId, body) {
15778
+ // verify the required parameter 'conversationId' is set
15779
+ if (conversationId === undefined || conversationId === null) {
15780
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
15781
+ }
15782
+ // verify the required parameter 'body' is set
15783
+ if (body === undefined || body === null) {
15784
+ throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
15785
+ }
15786
+
15787
+ return this.apiClient.callApi(
15788
+ '/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate',
15789
+ 'PUT',
15790
+ { 'conversationId': conversationId },
15791
+ { },
15792
+ { },
15793
+ { },
15794
+ body,
15795
+ ['PureCloud OAuth'],
15796
+ ['application/json'],
15797
+ ['application/json']
15798
+ );
15799
+ }
15800
+
15678
15801
  /**
15679
15802
  * Update conversation draft reply
15680
15803
  *
@@ -15705,6 +15828,66 @@ class ConversationsApi {
15705
15828
  );
15706
15829
  }
15707
15830
 
15831
+ /**
15832
+ * Update a conversation by setting its recording state
15833
+ *
15834
+ * @param {String} conversationId conversationId
15835
+ * @param {Object} body SetRecordingState
15836
+ */
15837
+ putConversationsEmailRecordingstate(conversationId, body) {
15838
+ // verify the required parameter 'conversationId' is set
15839
+ if (conversationId === undefined || conversationId === null) {
15840
+ throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
15841
+ }
15842
+ // verify the required parameter 'body' is set
15843
+ if (body === undefined || body === null) {
15844
+ throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
15845
+ }
15846
+
15847
+ return this.apiClient.callApi(
15848
+ '/api/v2/conversations/emails/{conversationId}/recordingstate',
15849
+ 'PUT',
15850
+ { 'conversationId': conversationId },
15851
+ { },
15852
+ { },
15853
+ { },
15854
+ body,
15855
+ ['PureCloud OAuth'],
15856
+ ['application/json'],
15857
+ ['application/json']
15858
+ );
15859
+ }
15860
+
15861
+ /**
15862
+ * Update a conversation by setting its recording state
15863
+ *
15864
+ * @param {String} conversationId conversationId
15865
+ * @param {Object} body SetRecordingState
15866
+ */
15867
+ putConversationsMessageRecordingstate(conversationId, body) {
15868
+ // verify the required parameter 'conversationId' is set
15869
+ if (conversationId === undefined || conversationId === null) {
15870
+ throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
15871
+ }
15872
+ // verify the required parameter 'body' is set
15873
+ if (body === undefined || body === null) {
15874
+ throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
15875
+ }
15876
+
15877
+ return this.apiClient.callApi(
15878
+ '/api/v2/conversations/messages/{conversationId}/recordingstate',
15879
+ 'PUT',
15880
+ { 'conversationId': conversationId },
15881
+ { },
15882
+ { },
15883
+ { },
15884
+ body,
15885
+ ['PureCloud OAuth'],
15886
+ ['application/json'],
15887
+ ['application/json']
15888
+ );
15889
+ }
15890
+
15708
15891
  /**
15709
15892
  * Update a LINE messenger integration
15710
15893
  *
@@ -15785,13 +15968,103 @@ class ConversationsApi {
15785
15968
  );
15786
15969
  }
15787
15970
 
15971
+ /**
15972
+ * Update a conversation by setting its recording state
15973
+ *
15974
+ * @param {String} conversationId conversationId
15975
+ * @param {Object} body SetRecordingState
15976
+ */
15977
+ putConversationsScreenshareRecordingstate(conversationId, body) {
15978
+ // verify the required parameter 'conversationId' is set
15979
+ if (conversationId === undefined || conversationId === null) {
15980
+ throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
15981
+ }
15982
+ // verify the required parameter 'body' is set
15983
+ if (body === undefined || body === null) {
15984
+ throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
15985
+ }
15986
+
15987
+ return this.apiClient.callApi(
15988
+ '/api/v2/conversations/screenshares/{conversationId}/recordingstate',
15989
+ 'PUT',
15990
+ { 'conversationId': conversationId },
15991
+ { },
15992
+ { },
15993
+ { },
15994
+ body,
15995
+ ['PureCloud OAuth'],
15996
+ ['application/json'],
15997
+ ['application/json']
15998
+ );
15999
+ }
16000
+
16001
+ /**
16002
+ * Update a conversation by setting its recording state
16003
+ *
16004
+ * @param {String} conversationId conversationId
16005
+ * @param {Object} body SetRecordingState
16006
+ */
16007
+ putConversationsSocialRecordingstate(conversationId, body) {
16008
+ // verify the required parameter 'conversationId' is set
16009
+ if (conversationId === undefined || conversationId === null) {
16010
+ throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
16011
+ }
16012
+ // verify the required parameter 'body' is set
16013
+ if (body === undefined || body === null) {
16014
+ throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
16015
+ }
16016
+
16017
+ return this.apiClient.callApi(
16018
+ '/api/v2/conversations/socials/{conversationId}/recordingstate',
16019
+ 'PUT',
16020
+ { 'conversationId': conversationId },
16021
+ { },
16022
+ { },
16023
+ { },
16024
+ body,
16025
+ ['PureCloud OAuth'],
16026
+ ['application/json'],
16027
+ ['application/json']
16028
+ );
16029
+ }
16030
+
16031
+ /**
16032
+ * Update a conversation by setting its recording state
16033
+ *
16034
+ * @param {String} conversationId conversationId
16035
+ * @param {Object} body SetRecordingState
16036
+ */
16037
+ putConversationsVideoRecordingstate(conversationId, body) {
16038
+ // verify the required parameter 'conversationId' is set
16039
+ if (conversationId === undefined || conversationId === null) {
16040
+ throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
16041
+ }
16042
+ // verify the required parameter 'body' is set
16043
+ if (body === undefined || body === null) {
16044
+ throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
16045
+ }
16046
+
16047
+ return this.apiClient.callApi(
16048
+ '/api/v2/conversations/videos/{conversationId}/recordingstate',
16049
+ 'PUT',
16050
+ { 'conversationId': conversationId },
16051
+ { },
16052
+ { },
16053
+ { },
16054
+ body,
16055
+ ['PureCloud OAuth'],
16056
+ ['application/json'],
16057
+ ['application/json']
16058
+ );
16059
+ }
16060
+
15788
16061
  }
15789
16062
 
15790
16063
  class DataExtensionsApi {
15791
16064
  /**
15792
16065
  * DataExtensions service.
15793
16066
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
15794
- * @version 138.0.0
16067
+ * @version 140.0.0
15795
16068
  */
15796
16069
 
15797
16070
  /**
@@ -15877,7 +16150,7 @@ class ExternalContactsApi {
15877
16150
  /**
15878
16151
  * ExternalContacts service.
15879
16152
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
15880
- * @version 138.0.0
16153
+ * @version 140.0.0
15881
16154
  */
15882
16155
 
15883
16156
  /**
@@ -17620,7 +17893,7 @@ class FaxApi {
17620
17893
  /**
17621
17894
  * Fax service.
17622
17895
  * @module purecloud-platform-client-v2/api/FaxApi
17623
- * @version 138.0.0
17896
+ * @version 140.0.0
17624
17897
  */
17625
17898
 
17626
17899
  /**
@@ -17791,7 +18064,7 @@ class FlowsApi {
17791
18064
  /**
17792
18065
  * Flows service.
17793
18066
  * @module purecloud-platform-client-v2/api/FlowsApi
17794
- * @version 138.0.0
18067
+ * @version 140.0.0
17795
18068
  */
17796
18069
 
17797
18070
  /**
@@ -17862,7 +18135,7 @@ class GamificationApi {
17862
18135
  /**
17863
18136
  * Gamification service.
17864
18137
  * @module purecloud-platform-client-v2/api/GamificationApi
17865
- * @version 138.0.0
18138
+ * @version 140.0.0
17866
18139
  */
17867
18140
 
17868
18141
  /**
@@ -18007,7 +18280,7 @@ class GamificationApi {
18007
18280
 
18008
18281
  /**
18009
18282
  * Gamified metric by id
18010
- *
18283
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
18011
18284
  * @param {String} metricId metric Id
18012
18285
  * @param {Object} opts Optional parameters
18013
18286
  * @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
@@ -18082,7 +18355,7 @@ class GamificationApi {
18082
18355
 
18083
18356
  /**
18084
18357
  * All gamified metrics for a given profile
18085
- *
18358
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
18086
18359
  * @param {Object} opts Optional parameters
18087
18360
  * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
18088
18361
  * @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
@@ -18133,18 +18406,18 @@ class GamificationApi {
18133
18406
  /**
18134
18407
  * Members of a given performance profile
18135
18408
  *
18136
- * @param {String} performanceProfileId Performance Profile Id
18409
+ * @param {String} profileId Profile Id
18137
18410
  */
18138
- getGamificationProfileMembers(performanceProfileId) {
18139
- // verify the required parameter 'performanceProfileId' is set
18140
- if (performanceProfileId === undefined || performanceProfileId === null) {
18141
- throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
18411
+ getGamificationProfileMembers(profileId) {
18412
+ // verify the required parameter 'profileId' is set
18413
+ if (profileId === undefined || profileId === null) {
18414
+ throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
18142
18415
  }
18143
18416
 
18144
18417
  return this.apiClient.callApi(
18145
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
18418
+ '/api/v2/gamification/profiles/{profileId}/members',
18146
18419
  'GET',
18147
- { 'performanceProfileId': performanceProfileId },
18420
+ { 'profileId': profileId },
18148
18421
  { },
18149
18422
  { },
18150
18423
  { },
@@ -18196,6 +18469,7 @@ class GamificationApi {
18196
18469
  * @param {Object} opts Optional parameters
18197
18470
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
18198
18471
  * @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
18472
+ * @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
18199
18473
  */
18200
18474
  getGamificationProfileMetrics(profileId, opts) {
18201
18475
  opts = opts || {};
@@ -18209,7 +18483,7 @@ class GamificationApi {
18209
18483
  '/api/v2/gamification/profiles/{profileId}/metrics',
18210
18484
  'GET',
18211
18485
  { 'profileId': profileId },
18212
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
18486
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
18213
18487
  { },
18214
18488
  { },
18215
18489
  null,
@@ -18936,7 +19210,7 @@ class GamificationApi {
18936
19210
 
18937
19211
  /**
18938
19212
  * Creates a gamified metric with a given metric definition and metric objective
18939
- *
19213
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
18940
19214
  * @param {Object} body Metric
18941
19215
  */
18942
19216
  postGamificationMetrics(body) {
@@ -19012,13 +19286,13 @@ class GamificationApi {
19012
19286
  /**
19013
19287
  * Assign members to a given performance profile
19014
19288
  *
19015
- * @param {String} performanceProfileId Performance Profile Id
19289
+ * @param {String} profileId Profile Id
19016
19290
  * @param {Object} body assignUsers
19017
19291
  */
19018
- postGamificationProfileMembers(performanceProfileId, body) {
19019
- // verify the required parameter 'performanceProfileId' is set
19020
- if (performanceProfileId === undefined || performanceProfileId === null) {
19021
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
19292
+ postGamificationProfileMembers(profileId, body) {
19293
+ // verify the required parameter 'profileId' is set
19294
+ if (profileId === undefined || profileId === null) {
19295
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
19022
19296
  }
19023
19297
  // verify the required parameter 'body' is set
19024
19298
  if (body === undefined || body === null) {
@@ -19026,9 +19300,9 @@ class GamificationApi {
19026
19300
  }
19027
19301
 
19028
19302
  return this.apiClient.callApi(
19029
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
19303
+ '/api/v2/gamification/profiles/{profileId}/members',
19030
19304
  'POST',
19031
- { 'performanceProfileId': performanceProfileId },
19305
+ { 'profileId': profileId },
19032
19306
  { },
19033
19307
  { },
19034
19308
  { },
@@ -19042,13 +19316,13 @@ class GamificationApi {
19042
19316
  /**
19043
19317
  * Validate member assignment
19044
19318
  *
19045
- * @param {String} performanceProfileId Performance Profile Id
19319
+ * @param {String} profileId Profile Id
19046
19320
  * @param {Object} body memberAssignments
19047
19321
  */
19048
- postGamificationProfileMembersValidate(performanceProfileId, body) {
19049
- // verify the required parameter 'performanceProfileId' is set
19050
- if (performanceProfileId === undefined || performanceProfileId === null) {
19051
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
19322
+ postGamificationProfileMembersValidate(profileId, body) {
19323
+ // verify the required parameter 'profileId' is set
19324
+ if (profileId === undefined || profileId === null) {
19325
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
19052
19326
  }
19053
19327
  // verify the required parameter 'body' is set
19054
19328
  if (body === undefined || body === null) {
@@ -19056,9 +19330,9 @@ class GamificationApi {
19056
19330
  }
19057
19331
 
19058
19332
  return this.apiClient.callApi(
19059
- '/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
19333
+ '/api/v2/gamification/profiles/{profileId}/members/validate',
19060
19334
  'POST',
19061
- { 'performanceProfileId': performanceProfileId },
19335
+ { 'profileId': profileId },
19062
19336
  { },
19063
19337
  { },
19064
19338
  { },
@@ -19165,7 +19439,7 @@ class GamificationApi {
19165
19439
 
19166
19440
  /**
19167
19441
  * Updates a metric
19168
- *
19442
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
19169
19443
  * @param {String} metricId metric Id
19170
19444
  * @param {Object} body Metric
19171
19445
  * @param {Object} opts Optional parameters
@@ -19292,7 +19566,7 @@ class GeneralDataProtectionRegulationApi {
19292
19566
  /**
19293
19567
  * GeneralDataProtectionRegulation service.
19294
19568
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
19295
- * @version 138.0.0
19569
+ * @version 140.0.0
19296
19570
  */
19297
19571
 
19298
19572
  /**
@@ -19422,7 +19696,7 @@ class GeolocationApi {
19422
19696
  /**
19423
19697
  * Geolocation service.
19424
19698
  * @module purecloud-platform-client-v2/api/GeolocationApi
19425
- * @version 138.0.0
19699
+ * @version 140.0.0
19426
19700
  */
19427
19701
 
19428
19702
  /**
@@ -19553,7 +19827,7 @@ class GreetingsApi {
19553
19827
  /**
19554
19828
  * Greetings service.
19555
19829
  * @module purecloud-platform-client-v2/api/GreetingsApi
19556
- * @version 138.0.0
19830
+ * @version 140.0.0
19557
19831
  */
19558
19832
 
19559
19833
  /**
@@ -20008,7 +20282,7 @@ class GroupsApi {
20008
20282
  /**
20009
20283
  * Groups service.
20010
20284
  * @module purecloud-platform-client-v2/api/GroupsApi
20011
- * @version 138.0.0
20285
+ * @version 140.0.0
20012
20286
  */
20013
20287
 
20014
20288
  /**
@@ -20413,7 +20687,7 @@ class IdentityProviderApi {
20413
20687
  /**
20414
20688
  * IdentityProvider service.
20415
20689
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
20416
- * @version 138.0.0
20690
+ * @version 140.0.0
20417
20691
  */
20418
20692
 
20419
20693
  /**
@@ -21169,7 +21443,7 @@ class IntegrationsApi {
21169
21443
  /**
21170
21444
  * Integrations service.
21171
21445
  * @module purecloud-platform-client-v2/api/IntegrationsApi
21172
- * @version 138.0.0
21446
+ * @version 140.0.0
21173
21447
  */
21174
21448
 
21175
21449
  /**
@@ -22846,7 +23120,7 @@ class JourneyApi {
22846
23120
  /**
22847
23121
  * Journey service.
22848
23122
  * @module purecloud-platform-client-v2/api/JourneyApi
22849
- * @version 138.0.0
23123
+ * @version 140.0.0
22850
23124
  */
22851
23125
 
22852
23126
  /**
@@ -23557,7 +23831,7 @@ class KnowledgeApi {
23557
23831
  /**
23558
23832
  * Knowledge service.
23559
23833
  * @module purecloud-platform-client-v2/api/KnowledgeApi
23560
- * @version 138.0.0
23834
+ * @version 140.0.0
23561
23835
  */
23562
23836
 
23563
23837
  /**
@@ -23735,7 +24009,7 @@ class KnowledgeApi {
23735
24009
  * @param {Object} opts Optional parameters
23736
24010
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23737
24011
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23738
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
24012
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
23739
24013
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23740
24014
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
23741
24015
  */
@@ -23843,7 +24117,7 @@ class KnowledgeApi {
23843
24117
  * @param {Object} opts Optional parameters
23844
24118
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23845
24119
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23846
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
24120
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
23847
24121
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23848
24122
  * @param {String} opts.categories Filter by categories ids, comma separated values expected.
23849
24123
  * @param {String} opts.title Filter by document title.
@@ -23955,7 +24229,7 @@ class KnowledgeApi {
23955
24229
  * @param {Object} opts Optional parameters
23956
24230
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23957
24231
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23958
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
24232
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
23959
24233
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23960
24234
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
23961
24235
  */
@@ -23991,7 +24265,7 @@ class KnowledgeApi {
23991
24265
  * @param {Object} opts Optional parameters
23992
24266
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
23993
24267
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
23994
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
24268
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
23995
24269
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
23996
24270
  * @param {String} opts.name Filter by Name.
23997
24271
  * @param {Object} opts.coreLanguage Filter by core language.
@@ -24457,7 +24731,7 @@ class LanguageUnderstandingApi {
24457
24731
  /**
24458
24732
  * LanguageUnderstanding service.
24459
24733
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
24460
- * @version 138.0.0
24734
+ * @version 140.0.0
24461
24735
  */
24462
24736
 
24463
24737
  /**
@@ -25361,7 +25635,7 @@ class LanguagesApi {
25361
25635
  /**
25362
25636
  * Languages service.
25363
25637
  * @module purecloud-platform-client-v2/api/LanguagesApi
25364
- * @version 138.0.0
25638
+ * @version 140.0.0
25365
25639
  */
25366
25640
 
25367
25641
  /**
@@ -25629,7 +25903,7 @@ class LearningApi {
25629
25903
  /**
25630
25904
  * Learning service.
25631
25905
  * @module purecloud-platform-client-v2/api/LearningApi
25632
- * @version 138.0.0
25906
+ * @version 140.0.0
25633
25907
  */
25634
25908
 
25635
25909
  /**
@@ -25827,6 +26101,36 @@ class LearningApi {
25827
26101
  );
25828
26102
  }
25829
26103
 
26104
+ /**
26105
+ * Get a specific Learning Module job status
26106
+ *
26107
+ * @param {String} moduleId The ID of the learning module
26108
+ * @param {String} jobId The ID of the learning module job
26109
+ */
26110
+ getLearningModuleJob(moduleId, jobId) {
26111
+ // verify the required parameter 'moduleId' is set
26112
+ if (moduleId === undefined || moduleId === null) {
26113
+ throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
26114
+ }
26115
+ // verify the required parameter 'jobId' is set
26116
+ if (jobId === undefined || jobId === null) {
26117
+ throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
26118
+ }
26119
+
26120
+ return this.apiClient.callApi(
26121
+ '/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
26122
+ 'GET',
26123
+ { 'moduleId': moduleId,'jobId': jobId },
26124
+ { },
26125
+ { },
26126
+ { },
26127
+ null,
26128
+ ['PureCloud OAuth'],
26129
+ ['application/json'],
26130
+ ['application/json']
26131
+ );
26132
+ }
26133
+
25830
26134
  /**
25831
26135
  * Get a learning module rule
25832
26136
  *
@@ -25972,6 +26276,56 @@ class LearningApi {
25972
26276
  );
25973
26277
  }
25974
26278
 
26279
+ /**
26280
+ * Reassign Learning Assignment
26281
+ * This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
26282
+ * @param {String} assignmentId The Learning Assignment ID
26283
+ */
26284
+ postLearningAssignmentReassign(assignmentId) {
26285
+ // verify the required parameter 'assignmentId' is set
26286
+ if (assignmentId === undefined || assignmentId === null) {
26287
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
26288
+ }
26289
+
26290
+ return this.apiClient.callApi(
26291
+ '/api/v2/learning/assignments/{assignmentId}/reassign',
26292
+ 'POST',
26293
+ { 'assignmentId': assignmentId },
26294
+ { },
26295
+ { },
26296
+ { },
26297
+ null,
26298
+ ['PureCloud OAuth'],
26299
+ ['application/json'],
26300
+ ['application/json']
26301
+ );
26302
+ }
26303
+
26304
+ /**
26305
+ * Reset Learning Assignment
26306
+ * This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
26307
+ * @param {String} assignmentId The Learning Assignment ID
26308
+ */
26309
+ postLearningAssignmentReset(assignmentId) {
26310
+ // verify the required parameter 'assignmentId' is set
26311
+ if (assignmentId === undefined || assignmentId === null) {
26312
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
26313
+ }
26314
+
26315
+ return this.apiClient.callApi(
26316
+ '/api/v2/learning/assignments/{assignmentId}/reset',
26317
+ 'POST',
26318
+ { 'assignmentId': assignmentId },
26319
+ { },
26320
+ { },
26321
+ { },
26322
+ null,
26323
+ ['PureCloud OAuth'],
26324
+ ['application/json'],
26325
+ ['application/json']
26326
+ );
26327
+ }
26328
+
25975
26329
  /**
25976
26330
  * Create Learning Assignment
25977
26331
  *
@@ -26069,6 +26423,36 @@ class LearningApi {
26069
26423
  );
26070
26424
  }
26071
26425
 
26426
+ /**
26427
+ * Starts a specified operation on learning module
26428
+ * This will initiate operation specified in the request body for a learning module
26429
+ * @param {String} moduleId The ID of the learning module
26430
+ * @param {Object} body The learning module job request
26431
+ */
26432
+ postLearningModuleJobs(moduleId, body) {
26433
+ // verify the required parameter 'moduleId' is set
26434
+ if (moduleId === undefined || moduleId === null) {
26435
+ throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
26436
+ }
26437
+ // verify the required parameter 'body' is set
26438
+ if (body === undefined || body === null) {
26439
+ throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
26440
+ }
26441
+
26442
+ return this.apiClient.callApi(
26443
+ '/api/v2/learning/modules/{moduleId}/jobs',
26444
+ 'POST',
26445
+ { 'moduleId': moduleId },
26446
+ { },
26447
+ { },
26448
+ { },
26449
+ body,
26450
+ ['PureCloud OAuth'],
26451
+ ['application/json'],
26452
+ ['application/json']
26453
+ );
26454
+ }
26455
+
26072
26456
  /**
26073
26457
  * Publish a Learning module
26074
26458
  *
@@ -26220,7 +26604,7 @@ class LicenseApi {
26220
26604
  /**
26221
26605
  * License service.
26222
26606
  * @module purecloud-platform-client-v2/api/LicenseApi
26223
- * @version 138.0.0
26607
+ * @version 140.0.0
26224
26608
  */
26225
26609
 
26226
26610
  /**
@@ -26458,7 +26842,7 @@ class LocationsApi {
26458
26842
  /**
26459
26843
  * Locations service.
26460
26844
  * @module purecloud-platform-client-v2/api/LocationsApi
26461
- * @version 138.0.0
26845
+ * @version 140.0.0
26462
26846
  */
26463
26847
 
26464
26848
  /**
@@ -26694,7 +27078,7 @@ class MessagingApi {
26694
27078
  /**
26695
27079
  * Messaging service.
26696
27080
  * @module purecloud-platform-client-v2/api/MessagingApi
26697
- * @version 138.0.0
27081
+ * @version 140.0.0
26698
27082
  */
26699
27083
 
26700
27084
  /**
@@ -26845,7 +27229,7 @@ class MobileDevicesApi {
26845
27229
  /**
26846
27230
  * MobileDevices service.
26847
27231
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
26848
- * @version 138.0.0
27232
+ * @version 140.0.0
26849
27233
  */
26850
27234
 
26851
27235
  /**
@@ -26996,7 +27380,7 @@ class NotificationsApi {
26996
27380
  /**
26997
27381
  * Notifications service.
26998
27382
  * @module purecloud-platform-client-v2/api/NotificationsApi
26999
- * @version 138.0.0
27383
+ * @version 140.0.0
27000
27384
  */
27001
27385
 
27002
27386
  /**
@@ -27221,7 +27605,7 @@ class OAuthApi {
27221
27605
  /**
27222
27606
  * OAuth service.
27223
27607
  * @module purecloud-platform-client-v2/api/OAuthApi
27224
- * @version 138.0.0
27608
+ * @version 140.0.0
27225
27609
  */
27226
27610
 
27227
27611
  /**
@@ -27587,7 +27971,7 @@ class ObjectsApi {
27587
27971
  /**
27588
27972
  * Objects service.
27589
27973
  * @module purecloud-platform-client-v2/api/ObjectsApi
27590
- * @version 138.0.0
27974
+ * @version 140.0.0
27591
27975
  */
27592
27976
 
27593
27977
  /**
@@ -27858,7 +28242,7 @@ class OrganizationApi {
27858
28242
  /**
27859
28243
  * Organization service.
27860
28244
  * @module purecloud-platform-client-v2/api/OrganizationApi
27861
- * @version 138.0.0
28245
+ * @version 140.0.0
27862
28246
  */
27863
28247
 
27864
28248
  /**
@@ -28261,7 +28645,7 @@ class OrganizationAuthorizationApi {
28261
28645
  /**
28262
28646
  * OrganizationAuthorization service.
28263
28647
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
28264
- * @version 138.0.0
28648
+ * @version 140.0.0
28265
28649
  */
28266
28650
 
28267
28651
  /**
@@ -29186,7 +29570,7 @@ class OutboundApi {
29186
29570
  /**
29187
29571
  * Outbound service.
29188
29572
  * @module purecloud-platform-client-v2/api/OutboundApi
29189
- * @version 138.0.0
29573
+ * @version 140.0.0
29190
29574
  */
29191
29575
 
29192
29576
  /**
@@ -32441,7 +32825,7 @@ class PresenceApi {
32441
32825
  /**
32442
32826
  * Presence service.
32443
32827
  * @module purecloud-platform-client-v2/api/PresenceApi
32444
- * @version 138.0.0
32828
+ * @version 140.0.0
32445
32829
  */
32446
32830
 
32447
32831
  /**
@@ -32763,7 +33147,7 @@ class QualityApi {
32763
33147
  /**
32764
33148
  * Quality service.
32765
33149
  * @module purecloud-platform-client-v2/api/QualityApi
32766
- * @version 138.0.0
33150
+ * @version 140.0.0
32767
33151
  */
32768
33152
 
32769
33153
  /**
@@ -33521,7 +33905,7 @@ class QualityApi {
33521
33905
  /**
33522
33906
  * Retrieve a list of the latest form versions by context ids
33523
33907
  *
33524
- * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
33908
+ * @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.
33525
33909
  * @param {Object} opts Optional parameters
33526
33910
  * @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)
33527
33911
  */
@@ -34341,7 +34725,7 @@ class RecordingApi {
34341
34725
  /**
34342
34726
  * Recording service.
34343
34727
  * @module purecloud-platform-client-v2/api/RecordingApi
34344
- * @version 138.0.0
34728
+ * @version 140.0.0
34345
34729
  */
34346
34730
 
34347
34731
  /**
@@ -35994,7 +36378,7 @@ class ResponseManagementApi {
35994
36378
  /**
35995
36379
  * ResponseManagement service.
35996
36380
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
35997
- * @version 138.0.0
36381
+ * @version 140.0.0
35998
36382
  */
35999
36383
 
36000
36384
  /**
@@ -36478,7 +36862,7 @@ class RoutingApi {
36478
36862
  /**
36479
36863
  * Routing service.
36480
36864
  * @module purecloud-platform-client-v2/api/RoutingApi
36481
- * @version 138.0.0
36865
+ * @version 140.0.0
36482
36866
  */
36483
36867
 
36484
36868
  /**
@@ -36791,12 +37175,8 @@ class RoutingApi {
36791
37175
  * Delete a phone number provisioned for SMS.
36792
37176
  *
36793
37177
  * @param {String} addressId Address ID
36794
- * @param {Object} opts Optional parameters
36795
- * @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)
36796
37178
  */
36797
- deleteRoutingSmsPhonenumber(addressId, opts) {
36798
- opts = opts || {};
36799
-
37179
+ deleteRoutingSmsPhonenumber(addressId) {
36800
37180
  // verify the required parameter 'addressId' is set
36801
37181
  if (addressId === undefined || addressId === null) {
36802
37182
  throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
@@ -36806,7 +37186,7 @@ class RoutingApi {
36806
37186
  '/api/v2/routing/sms/phonenumbers/{addressId}',
36807
37187
  'DELETE',
36808
37188
  { 'addressId': addressId },
36809
- { 'async': opts['async'] },
37189
+ { },
36810
37190
  { },
36811
37191
  { },
36812
37192
  null,
@@ -36977,7 +37357,7 @@ class RoutingApi {
36977
37357
  * @param {Object} opts Optional parameters
36978
37358
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
36979
37359
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
36980
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
37360
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
36981
37361
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
36982
37362
  * @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
36983
37363
  */
@@ -37288,7 +37668,7 @@ class RoutingApi {
37288
37668
  * @param {Object} opts Optional parameters
37289
37669
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
37290
37670
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
37291
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
37671
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
37292
37672
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
37293
37673
  * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
37294
37674
  */
@@ -37311,16 +37691,20 @@ class RoutingApi {
37311
37691
  }
37312
37692
 
37313
37693
  /**
37314
- * Get a list of Key Performance Indicators available for the predictors.
37694
+ * Get a list of Key Performance Indicators
37315
37695
  *
37696
+ * @param {Object} opts Optional parameters
37697
+ * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
37316
37698
  */
37317
- getRoutingPredictorsKeyperformanceindicators() {
37699
+ getRoutingPredictorsKeyperformanceindicators(opts) {
37700
+ opts = opts || {};
37701
+
37318
37702
 
37319
37703
  return this.apiClient.callApi(
37320
37704
  '/api/v2/routing/predictors/keyperformanceindicators',
37321
37705
  'GET',
37322
37706
  { },
37323
- { },
37707
+ { 'kpiGroup': opts['kpiGroup'] },
37324
37708
  { },
37325
37709
  { },
37326
37710
  null,
@@ -38960,12 +39344,8 @@ class RoutingApi {
38960
39344
  * Provision a phone number for SMS
38961
39345
  *
38962
39346
  * @param {Object} body SmsPhoneNumber
38963
- * @param {Object} opts Optional parameters
38964
- * @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)
38965
39347
  */
38966
- postRoutingSmsPhonenumbers(body, opts) {
38967
- opts = opts || {};
38968
-
39348
+ postRoutingSmsPhonenumbers(body) {
38969
39349
  // verify the required parameter 'body' is set
38970
39350
  if (body === undefined || body === null) {
38971
39351
  throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
@@ -38975,7 +39355,7 @@ class RoutingApi {
38975
39355
  '/api/v2/routing/sms/phonenumbers',
38976
39356
  'POST',
38977
39357
  { },
38978
- { 'async': opts['async'] },
39358
+ { },
38979
39359
  { },
38980
39360
  { },
38981
39361
  body,
@@ -39220,12 +39600,8 @@ class RoutingApi {
39220
39600
  *
39221
39601
  * @param {String} addressId Address ID
39222
39602
  * @param {Object} body SmsPhoneNumber
39223
- * @param {Object} opts Optional parameters
39224
- * @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)
39225
39603
  */
39226
- putRoutingSmsPhonenumber(addressId, body, opts) {
39227
- opts = opts || {};
39228
-
39604
+ putRoutingSmsPhonenumber(addressId, body) {
39229
39605
  // verify the required parameter 'addressId' is set
39230
39606
  if (addressId === undefined || addressId === null) {
39231
39607
  throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
@@ -39239,7 +39615,7 @@ class RoutingApi {
39239
39615
  '/api/v2/routing/sms/phonenumbers/{addressId}',
39240
39616
  'PUT',
39241
39617
  { 'addressId': addressId },
39242
- { 'async': opts['async'] },
39618
+ { },
39243
39619
  { },
39244
39620
  { },
39245
39621
  body,
@@ -39405,7 +39781,7 @@ class SCIMApi {
39405
39781
  /**
39406
39782
  * SCIM service.
39407
39783
  * @module purecloud-platform-client-v2/api/SCIMApi
39408
- * @version 138.0.0
39784
+ * @version 140.0.0
39409
39785
  */
39410
39786
 
39411
39787
  /**
@@ -40282,7 +40658,7 @@ class ScriptsApi {
40282
40658
  /**
40283
40659
  * Scripts service.
40284
40660
  * @module purecloud-platform-client-v2/api/ScriptsApi
40285
- * @version 138.0.0
40661
+ * @version 140.0.0
40286
40662
  */
40287
40663
 
40288
40664
  /**
@@ -40701,7 +41077,7 @@ class SearchApi {
40701
41077
  /**
40702
41078
  * Search service.
40703
41079
  * @module purecloud-platform-client-v2/api/SearchApi
40704
- * @version 138.0.0
41080
+ * @version 140.0.0
40705
41081
  */
40706
41082
 
40707
41083
  /**
@@ -41236,7 +41612,7 @@ class SpeechTextAnalyticsApi {
41236
41612
  /**
41237
41613
  * SpeechTextAnalytics service.
41238
41614
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
41239
- * @version 138.0.0
41615
+ * @version 140.0.0
41240
41616
  */
41241
41617
 
41242
41618
  /**
@@ -42089,7 +42465,7 @@ class StationsApi {
42089
42465
  /**
42090
42466
  * Stations service.
42091
42467
  * @module purecloud-platform-client-v2/api/StationsApi
42092
- * @version 138.0.0
42468
+ * @version 140.0.0
42093
42469
  */
42094
42470
 
42095
42471
  /**
@@ -42236,7 +42612,7 @@ class SuggestApi {
42236
42612
  /**
42237
42613
  * Suggest service.
42238
42614
  * @module purecloud-platform-client-v2/api/SuggestApi
42239
- * @version 138.0.0
42615
+ * @version 140.0.0
42240
42616
  */
42241
42617
 
42242
42618
  /**
@@ -42375,7 +42751,7 @@ class TelephonyApi {
42375
42751
  /**
42376
42752
  * Telephony service.
42377
42753
  * @module purecloud-platform-client-v2/api/TelephonyApi
42378
- * @version 138.0.0
42754
+ * @version 140.0.0
42379
42755
  */
42380
42756
 
42381
42757
  /**
@@ -42483,7 +42859,7 @@ class TelephonyProvidersEdgeApi {
42483
42859
  /**
42484
42860
  * TelephonyProvidersEdge service.
42485
42861
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
42486
- * @version 138.0.0
42862
+ * @version 140.0.0
42487
42863
  */
42488
42864
 
42489
42865
  /**
@@ -46116,7 +46492,7 @@ class TextbotsApi {
46116
46492
  /**
46117
46493
  * Textbots service.
46118
46494
  * @module purecloud-platform-client-v2/api/TextbotsApi
46119
- * @version 138.0.0
46495
+ * @version 140.0.0
46120
46496
  */
46121
46497
 
46122
46498
  /**
@@ -46244,7 +46620,7 @@ class TokensApi {
46244
46620
  /**
46245
46621
  * Tokens service.
46246
46622
  * @module purecloud-platform-client-v2/api/TokensApi
46247
- * @version 138.0.0
46623
+ * @version 140.0.0
46248
46624
  */
46249
46625
 
46250
46626
  /**
@@ -46350,7 +46726,7 @@ class UploadsApi {
46350
46726
  /**
46351
46727
  * Uploads service.
46352
46728
  * @module purecloud-platform-client-v2/api/UploadsApi
46353
- * @version 138.0.0
46729
+ * @version 140.0.0
46354
46730
  */
46355
46731
 
46356
46732
  /**
@@ -46501,7 +46877,7 @@ class UsageApi {
46501
46877
  /**
46502
46878
  * Usage service.
46503
46879
  * @module purecloud-platform-client-v2/api/UsageApi
46504
- * @version 138.0.0
46880
+ * @version 140.0.0
46505
46881
  */
46506
46882
 
46507
46883
  /**
@@ -46572,7 +46948,7 @@ class UserRecordingsApi {
46572
46948
  /**
46573
46949
  * UserRecordings service.
46574
46950
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
46575
- * @version 138.0.0
46951
+ * @version 140.0.0
46576
46952
  */
46577
46953
 
46578
46954
  /**
@@ -46756,7 +47132,7 @@ class UsersApi {
46756
47132
  /**
46757
47133
  * Users service.
46758
47134
  * @module purecloud-platform-client-v2/api/UsersApi
46759
- * @version 138.0.0
47135
+ * @version 140.0.0
46760
47136
  */
46761
47137
 
46762
47138
  /**
@@ -47576,18 +47952,18 @@ class UsersApi {
47576
47952
  /**
47577
47953
  * Returns a listing of roles and permissions for a user.
47578
47954
  *
47579
- * @param {String} userId User ID
47955
+ * @param {String} subjectId User ID
47580
47956
  */
47581
- getUserRoles(userId) {
47582
- // verify the required parameter 'userId' is set
47583
- if (userId === undefined || userId === null) {
47584
- throw 'Missing the required parameter "userId" when calling getUserRoles';
47957
+ getUserRoles(subjectId) {
47958
+ // verify the required parameter 'subjectId' is set
47959
+ if (subjectId === undefined || subjectId === null) {
47960
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
47585
47961
  }
47586
47962
 
47587
47963
  return this.apiClient.callApi(
47588
- '/api/v2/users/{userId}/roles',
47964
+ '/api/v2/users/{subjectId}/roles',
47589
47965
  'GET',
47590
- { 'userId': userId },
47966
+ { 'subjectId': subjectId },
47591
47967
  { },
47592
47968
  { },
47593
47969
  { },
@@ -48840,13 +49216,13 @@ class UsersApi {
48840
49216
  /**
48841
49217
  * Sets the user's roles
48842
49218
  *
48843
- * @param {String} userId User ID
49219
+ * @param {String} subjectId User ID
48844
49220
  * @param {Array.<String>} body List of roles
48845
49221
  */
48846
- putUserRoles(userId, body) {
48847
- // verify the required parameter 'userId' is set
48848
- if (userId === undefined || userId === null) {
48849
- throw 'Missing the required parameter "userId" when calling putUserRoles';
49222
+ putUserRoles(subjectId, body) {
49223
+ // verify the required parameter 'subjectId' is set
49224
+ if (subjectId === undefined || subjectId === null) {
49225
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
48850
49226
  }
48851
49227
  // verify the required parameter 'body' is set
48852
49228
  if (body === undefined || body === null) {
@@ -48854,9 +49230,9 @@ class UsersApi {
48854
49230
  }
48855
49231
 
48856
49232
  return this.apiClient.callApi(
48857
- '/api/v2/users/{userId}/roles',
49233
+ '/api/v2/users/{subjectId}/roles',
48858
49234
  'PUT',
48859
- { 'userId': userId },
49235
+ { 'subjectId': subjectId },
48860
49236
  { },
48861
49237
  { },
48862
49238
  { },
@@ -49058,7 +49434,7 @@ class UtilitiesApi {
49058
49434
  /**
49059
49435
  * Utilities service.
49060
49436
  * @module purecloud-platform-client-v2/api/UtilitiesApi
49061
- * @version 138.0.0
49437
+ * @version 140.0.0
49062
49438
  */
49063
49439
 
49064
49440
  /**
@@ -49169,7 +49545,7 @@ class VoicemailApi {
49169
49545
  /**
49170
49546
  * Voicemail service.
49171
49547
  * @module purecloud-platform-client-v2/api/VoicemailApi
49172
- * @version 138.0.0
49548
+ * @version 140.0.0
49173
49549
  */
49174
49550
 
49175
49551
  /**
@@ -49836,7 +50212,7 @@ class WebChatApi {
49836
50212
  /**
49837
50213
  * WebChat service.
49838
50214
  * @module purecloud-platform-client-v2/api/WebChatApi
49839
- * @version 138.0.0
50215
+ * @version 140.0.0
49840
50216
  */
49841
50217
 
49842
50218
  /**
@@ -50380,7 +50756,7 @@ class WebDeploymentsApi {
50380
50756
  /**
50381
50757
  * WebDeployments service.
50382
50758
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
50383
- * @version 138.0.0
50759
+ * @version 140.0.0
50384
50760
  */
50385
50761
 
50386
50762
  /**
@@ -50735,7 +51111,7 @@ class WebMessagingApi {
50735
51111
  /**
50736
51112
  * WebMessaging service.
50737
51113
  * @module purecloud-platform-client-v2/api/WebMessagingApi
50738
- * @version 138.0.0
51114
+ * @version 140.0.0
50739
51115
  */
50740
51116
 
50741
51117
  /**
@@ -50781,7 +51157,7 @@ class WidgetsApi {
50781
51157
  /**
50782
51158
  * Widgets service.
50783
51159
  * @module purecloud-platform-client-v2/api/WidgetsApi
50784
- * @version 138.0.0
51160
+ * @version 140.0.0
50785
51161
  */
50786
51162
 
50787
51163
  /**
@@ -50927,7 +51303,7 @@ class WorkforceManagementApi {
50927
51303
  /**
50928
51304
  * WorkforceManagement service.
50929
51305
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
50930
- * @version 138.0.0
51306
+ * @version 140.0.0
50931
51307
  */
50932
51308
 
50933
51309
  /**
@@ -55178,7 +55554,7 @@ class WorkforceManagementApi {
55178
55554
  * </pre>
55179
55555
  * </p>
55180
55556
  * @module purecloud-platform-client-v2/index
55181
- * @version 138.0.0
55557
+ * @version 140.0.0
55182
55558
  */
55183
55559
  class platformClient {
55184
55560
  constructor() {