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
@@ -7248,7 +7248,7 @@ class Configuration {
7248
7248
 
7249
7249
  /**
7250
7250
  * @module purecloud-platform-client-v2/ApiClient
7251
- * @version 138.0.0
7251
+ * @version 140.0.0
7252
7252
  */
7253
7253
  class ApiClient {
7254
7254
  /**
@@ -8001,7 +8001,7 @@ class ApiClient {
8001
8001
  serialize(obj) {
8002
8002
  var result = {};
8003
8003
  for (var p in obj) {
8004
- if (obj.hasOwnProperty(p)) {
8004
+ if (obj.hasOwnProperty(p) && obj[p] !== undefined) {
8005
8005
  result[encodeURIComponent(p)] = Array.isArray(obj[p]) ? obj[p].join(",") : this.paramToString(obj[p]);
8006
8006
  }
8007
8007
  }
@@ -8131,6 +8131,9 @@ class ApiClient {
8131
8131
  */
8132
8132
  buildCollectionParam(param, collectionFormat) {
8133
8133
  if (!param) return;
8134
+ if (!Array.isArray(param)) {
8135
+ param = [param];
8136
+ }
8134
8137
 
8135
8138
  switch (collectionFormat) {
8136
8139
  case 'csv':
@@ -8316,7 +8319,7 @@ class AlertingApi {
8316
8319
  /**
8317
8320
  * Alerting service.
8318
8321
  * @module purecloud-platform-client-v2/api/AlertingApi
8319
- * @version 138.0.0
8322
+ * @version 140.0.0
8320
8323
  */
8321
8324
 
8322
8325
  /**
@@ -8630,7 +8633,7 @@ class AnalyticsApi {
8630
8633
  /**
8631
8634
  * Analytics service.
8632
8635
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8633
- * @version 138.0.0
8636
+ * @version 140.0.0
8634
8637
  */
8635
8638
 
8636
8639
  /**
@@ -9812,7 +9815,7 @@ class ArchitectApi {
9812
9815
  /**
9813
9816
  * Architect service.
9814
9817
  * @module purecloud-platform-client-v2/api/ArchitectApi
9815
- * @version 138.0.0
9818
+ * @version 140.0.0
9816
9819
  */
9817
9820
 
9818
9821
  /**
@@ -12857,7 +12860,7 @@ class AuditApi {
12857
12860
  /**
12858
12861
  * Audit service.
12859
12862
  * @module purecloud-platform-client-v2/api/AuditApi
12860
- * @version 138.0.0
12863
+ * @version 140.0.0
12861
12864
  */
12862
12865
 
12863
12866
  /**
@@ -13028,7 +13031,7 @@ class AuthorizationApi {
13028
13031
  /**
13029
13032
  * Authorization service.
13030
13033
  * @module purecloud-platform-client-v2/api/AuthorizationApi
13031
- * @version 138.0.0
13034
+ * @version 140.0.0
13032
13035
  */
13033
13036
 
13034
13037
  /**
@@ -13633,18 +13636,18 @@ class AuthorizationApi {
13633
13636
  /**
13634
13637
  * Returns a listing of roles and permissions for a user.
13635
13638
  *
13636
- * @param {String} userId User ID
13639
+ * @param {String} subjectId User ID
13637
13640
  */
13638
- getUserRoles(userId) {
13639
- // verify the required parameter 'userId' is set
13640
- if (userId === undefined || userId === null) {
13641
- throw 'Missing the required parameter "userId" when calling getUserRoles';
13641
+ getUserRoles(subjectId) {
13642
+ // verify the required parameter 'subjectId' is set
13643
+ if (subjectId === undefined || subjectId === null) {
13644
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
13642
13645
  }
13643
13646
 
13644
13647
  return this.apiClient.callApi(
13645
- '/api/v2/users/{userId}/roles',
13648
+ '/api/v2/users/{subjectId}/roles',
13646
13649
  'GET',
13647
- { 'userId': userId },
13650
+ { 'subjectId': subjectId },
13648
13651
  { },
13649
13652
  { },
13650
13653
  { },
@@ -14178,13 +14181,13 @@ class AuthorizationApi {
14178
14181
  /**
14179
14182
  * Sets the user's roles
14180
14183
  *
14181
- * @param {String} userId User ID
14184
+ * @param {String} subjectId User ID
14182
14185
  * @param {Array.<String>} body List of roles
14183
14186
  */
14184
- putUserRoles(userId, body) {
14185
- // verify the required parameter 'userId' is set
14186
- if (userId === undefined || userId === null) {
14187
- throw 'Missing the required parameter "userId" when calling putUserRoles';
14187
+ putUserRoles(subjectId, body) {
14188
+ // verify the required parameter 'subjectId' is set
14189
+ if (subjectId === undefined || subjectId === null) {
14190
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
14188
14191
  }
14189
14192
  // verify the required parameter 'body' is set
14190
14193
  if (body === undefined || body === null) {
@@ -14192,9 +14195,9 @@ class AuthorizationApi {
14192
14195
  }
14193
14196
 
14194
14197
  return this.apiClient.callApi(
14195
- '/api/v2/users/{userId}/roles',
14198
+ '/api/v2/users/{subjectId}/roles',
14196
14199
  'PUT',
14197
- { 'userId': userId },
14200
+ { 'subjectId': subjectId },
14198
14201
  { },
14199
14202
  { },
14200
14203
  { },
@@ -14211,7 +14214,7 @@ class BillingApi {
14211
14214
  /**
14212
14215
  * Billing service.
14213
14216
  * @module purecloud-platform-client-v2/api/BillingApi
14214
- * @version 138.0.0
14217
+ * @version 140.0.0
14215
14218
  */
14216
14219
 
14217
14220
  /**
@@ -14291,7 +14294,7 @@ class ChatApi {
14291
14294
  /**
14292
14295
  * Chat service.
14293
14296
  * @module purecloud-platform-client-v2/api/ChatApi
14294
- * @version 138.0.0
14297
+ * @version 140.0.0
14295
14298
  */
14296
14299
 
14297
14300
  /**
@@ -14382,7 +14385,7 @@ class CoachingApi {
14382
14385
  /**
14383
14386
  * Coaching service.
14384
14387
  * @module purecloud-platform-client-v2/api/CoachingApi
14385
- * @version 138.0.0
14388
+ * @version 140.0.0
14386
14389
  */
14387
14390
 
14388
14391
  /**
@@ -14959,7 +14962,7 @@ class ContentManagementApi {
14959
14962
  /**
14960
14963
  * ContentManagement service.
14961
14964
  * @module purecloud-platform-client-v2/api/ContentManagementApi
14962
- * @version 138.0.0
14965
+ * @version 140.0.0
14963
14966
  */
14964
14967
 
14965
14968
  /**
@@ -16099,7 +16102,7 @@ class ConversationsApi {
16099
16102
  /**
16100
16103
  * Conversations service.
16101
16104
  * @module purecloud-platform-client-v2/api/ConversationsApi
16102
- * @version 138.0.0
16105
+ * @version 140.0.0
16103
16106
  */
16104
16107
 
16105
16108
  /**
@@ -20647,6 +20650,126 @@ class ConversationsApi {
20647
20650
  );
20648
20651
  }
20649
20652
 
20653
+ /**
20654
+ * Update a conversation by setting its recording state
20655
+ *
20656
+ * @param {String} conversationId conversationId
20657
+ * @param {Object} body SetRecordingState
20658
+ */
20659
+ putConversationsCallRecordingstate(conversationId, body) {
20660
+ // verify the required parameter 'conversationId' is set
20661
+ if (conversationId === undefined || conversationId === null) {
20662
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallRecordingstate';
20663
+ }
20664
+ // verify the required parameter 'body' is set
20665
+ if (body === undefined || body === null) {
20666
+ throw 'Missing the required parameter "body" when calling putConversationsCallRecordingstate';
20667
+ }
20668
+
20669
+ return this.apiClient.callApi(
20670
+ '/api/v2/conversations/calls/{conversationId}/recordingstate',
20671
+ 'PUT',
20672
+ { 'conversationId': conversationId },
20673
+ { },
20674
+ { },
20675
+ { },
20676
+ body,
20677
+ ['PureCloud OAuth'],
20678
+ ['application/json'],
20679
+ ['application/json']
20680
+ );
20681
+ }
20682
+
20683
+ /**
20684
+ * Update a conversation by setting its recording state
20685
+ *
20686
+ * @param {String} conversationId conversationId
20687
+ * @param {Object} body SetRecordingState
20688
+ */
20689
+ putConversationsCallbackRecordingstate(conversationId, body) {
20690
+ // verify the required parameter 'conversationId' is set
20691
+ if (conversationId === undefined || conversationId === null) {
20692
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCallbackRecordingstate';
20693
+ }
20694
+ // verify the required parameter 'body' is set
20695
+ if (body === undefined || body === null) {
20696
+ throw 'Missing the required parameter "body" when calling putConversationsCallbackRecordingstate';
20697
+ }
20698
+
20699
+ return this.apiClient.callApi(
20700
+ '/api/v2/conversations/callbacks/{conversationId}/recordingstate',
20701
+ 'PUT',
20702
+ { 'conversationId': conversationId },
20703
+ { },
20704
+ { },
20705
+ { },
20706
+ body,
20707
+ ['PureCloud OAuth'],
20708
+ ['application/json'],
20709
+ ['application/json']
20710
+ );
20711
+ }
20712
+
20713
+ /**
20714
+ * Update a conversation by setting its recording state
20715
+ *
20716
+ * @param {String} conversationId conversationId
20717
+ * @param {Object} body SetRecordingState
20718
+ */
20719
+ putConversationsChatRecordingstate(conversationId, body) {
20720
+ // verify the required parameter 'conversationId' is set
20721
+ if (conversationId === undefined || conversationId === null) {
20722
+ throw 'Missing the required parameter "conversationId" when calling putConversationsChatRecordingstate';
20723
+ }
20724
+ // verify the required parameter 'body' is set
20725
+ if (body === undefined || body === null) {
20726
+ throw 'Missing the required parameter "body" when calling putConversationsChatRecordingstate';
20727
+ }
20728
+
20729
+ return this.apiClient.callApi(
20730
+ '/api/v2/conversations/chats/{conversationId}/recordingstate',
20731
+ 'PUT',
20732
+ { 'conversationId': conversationId },
20733
+ { },
20734
+ { },
20735
+ { },
20736
+ body,
20737
+ ['PureCloud OAuth'],
20738
+ ['application/json'],
20739
+ ['application/json']
20740
+ );
20741
+ }
20742
+
20743
+ /**
20744
+ * Update a conversation by setting its recording state
20745
+ *
20746
+ * @param {String} conversationId conversationId
20747
+ * @param {Object} body SetRecordingState
20748
+ */
20749
+ putConversationsCobrowsesessionRecordingstate(conversationId, body) {
20750
+ // verify the required parameter 'conversationId' is set
20751
+ if (conversationId === undefined || conversationId === null) {
20752
+ throw 'Missing the required parameter "conversationId" when calling putConversationsCobrowsesessionRecordingstate';
20753
+ }
20754
+ // verify the required parameter 'body' is set
20755
+ if (body === undefined || body === null) {
20756
+ throw 'Missing the required parameter "body" when calling putConversationsCobrowsesessionRecordingstate';
20757
+ }
20758
+
20759
+ return this.apiClient.callApi(
20760
+ '/api/v2/conversations/cobrowsesessions/{conversationId}/recordingstate',
20761
+ 'PUT',
20762
+ { 'conversationId': conversationId },
20763
+ { },
20764
+ { },
20765
+ { },
20766
+ body,
20767
+ ['PureCloud OAuth'],
20768
+ ['application/json'],
20769
+ ['application/json']
20770
+ );
20771
+ }
20772
+
20650
20773
  /**
20651
20774
  * Update conversation draft reply
20652
20775
  *
@@ -20677,6 +20800,66 @@ class ConversationsApi {
20677
20800
  );
20678
20801
  }
20679
20802
 
20803
+ /**
20804
+ * Update a conversation by setting its recording state
20805
+ *
20806
+ * @param {String} conversationId conversationId
20807
+ * @param {Object} body SetRecordingState
20808
+ */
20809
+ putConversationsEmailRecordingstate(conversationId, body) {
20810
+ // verify the required parameter 'conversationId' is set
20811
+ if (conversationId === undefined || conversationId === null) {
20812
+ throw 'Missing the required parameter "conversationId" when calling putConversationsEmailRecordingstate';
20813
+ }
20814
+ // verify the required parameter 'body' is set
20815
+ if (body === undefined || body === null) {
20816
+ throw 'Missing the required parameter "body" when calling putConversationsEmailRecordingstate';
20817
+ }
20818
+
20819
+ return this.apiClient.callApi(
20820
+ '/api/v2/conversations/emails/{conversationId}/recordingstate',
20821
+ 'PUT',
20822
+ { 'conversationId': conversationId },
20823
+ { },
20824
+ { },
20825
+ { },
20826
+ body,
20827
+ ['PureCloud OAuth'],
20828
+ ['application/json'],
20829
+ ['application/json']
20830
+ );
20831
+ }
20832
+
20833
+ /**
20834
+ * Update a conversation by setting its recording state
20835
+ *
20836
+ * @param {String} conversationId conversationId
20837
+ * @param {Object} body SetRecordingState
20838
+ */
20839
+ putConversationsMessageRecordingstate(conversationId, body) {
20840
+ // verify the required parameter 'conversationId' is set
20841
+ if (conversationId === undefined || conversationId === null) {
20842
+ throw 'Missing the required parameter "conversationId" when calling putConversationsMessageRecordingstate';
20843
+ }
20844
+ // verify the required parameter 'body' is set
20845
+ if (body === undefined || body === null) {
20846
+ throw 'Missing the required parameter "body" when calling putConversationsMessageRecordingstate';
20847
+ }
20848
+
20849
+ return this.apiClient.callApi(
20850
+ '/api/v2/conversations/messages/{conversationId}/recordingstate',
20851
+ 'PUT',
20852
+ { 'conversationId': conversationId },
20853
+ { },
20854
+ { },
20855
+ { },
20856
+ body,
20857
+ ['PureCloud OAuth'],
20858
+ ['application/json'],
20859
+ ['application/json']
20860
+ );
20861
+ }
20862
+
20680
20863
  /**
20681
20864
  * Update a LINE messenger integration
20682
20865
  *
@@ -20757,13 +20940,103 @@ class ConversationsApi {
20757
20940
  );
20758
20941
  }
20759
20942
 
20943
+ /**
20944
+ * Update a conversation by setting its recording state
20945
+ *
20946
+ * @param {String} conversationId conversationId
20947
+ * @param {Object} body SetRecordingState
20948
+ */
20949
+ putConversationsScreenshareRecordingstate(conversationId, body) {
20950
+ // verify the required parameter 'conversationId' is set
20951
+ if (conversationId === undefined || conversationId === null) {
20952
+ throw 'Missing the required parameter "conversationId" when calling putConversationsScreenshareRecordingstate';
20953
+ }
20954
+ // verify the required parameter 'body' is set
20955
+ if (body === undefined || body === null) {
20956
+ throw 'Missing the required parameter "body" when calling putConversationsScreenshareRecordingstate';
20957
+ }
20958
+
20959
+ return this.apiClient.callApi(
20960
+ '/api/v2/conversations/screenshares/{conversationId}/recordingstate',
20961
+ 'PUT',
20962
+ { 'conversationId': conversationId },
20963
+ { },
20964
+ { },
20965
+ { },
20966
+ body,
20967
+ ['PureCloud OAuth'],
20968
+ ['application/json'],
20969
+ ['application/json']
20970
+ );
20971
+ }
20972
+
20973
+ /**
20974
+ * Update a conversation by setting its recording state
20975
+ *
20976
+ * @param {String} conversationId conversationId
20977
+ * @param {Object} body SetRecordingState
20978
+ */
20979
+ putConversationsSocialRecordingstate(conversationId, body) {
20980
+ // verify the required parameter 'conversationId' is set
20981
+ if (conversationId === undefined || conversationId === null) {
20982
+ throw 'Missing the required parameter "conversationId" when calling putConversationsSocialRecordingstate';
20983
+ }
20984
+ // verify the required parameter 'body' is set
20985
+ if (body === undefined || body === null) {
20986
+ throw 'Missing the required parameter "body" when calling putConversationsSocialRecordingstate';
20987
+ }
20988
+
20989
+ return this.apiClient.callApi(
20990
+ '/api/v2/conversations/socials/{conversationId}/recordingstate',
20991
+ 'PUT',
20992
+ { 'conversationId': conversationId },
20993
+ { },
20994
+ { },
20995
+ { },
20996
+ body,
20997
+ ['PureCloud OAuth'],
20998
+ ['application/json'],
20999
+ ['application/json']
21000
+ );
21001
+ }
21002
+
21003
+ /**
21004
+ * Update a conversation by setting its recording state
21005
+ *
21006
+ * @param {String} conversationId conversationId
21007
+ * @param {Object} body SetRecordingState
21008
+ */
21009
+ putConversationsVideoRecordingstate(conversationId, body) {
21010
+ // verify the required parameter 'conversationId' is set
21011
+ if (conversationId === undefined || conversationId === null) {
21012
+ throw 'Missing the required parameter "conversationId" when calling putConversationsVideoRecordingstate';
21013
+ }
21014
+ // verify the required parameter 'body' is set
21015
+ if (body === undefined || body === null) {
21016
+ throw 'Missing the required parameter "body" when calling putConversationsVideoRecordingstate';
21017
+ }
21018
+
21019
+ return this.apiClient.callApi(
21020
+ '/api/v2/conversations/videos/{conversationId}/recordingstate',
21021
+ 'PUT',
21022
+ { 'conversationId': conversationId },
21023
+ { },
21024
+ { },
21025
+ { },
21026
+ body,
21027
+ ['PureCloud OAuth'],
21028
+ ['application/json'],
21029
+ ['application/json']
21030
+ );
21031
+ }
21032
+
20760
21033
  }
20761
21034
 
20762
21035
  class DataExtensionsApi {
20763
21036
  /**
20764
21037
  * DataExtensions service.
20765
21038
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20766
- * @version 138.0.0
21039
+ * @version 140.0.0
20767
21040
  */
20768
21041
 
20769
21042
  /**
@@ -20849,7 +21122,7 @@ class ExternalContactsApi {
20849
21122
  /**
20850
21123
  * ExternalContacts service.
20851
21124
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
20852
- * @version 138.0.0
21125
+ * @version 140.0.0
20853
21126
  */
20854
21127
 
20855
21128
  /**
@@ -22592,7 +22865,7 @@ class FaxApi {
22592
22865
  /**
22593
22866
  * Fax service.
22594
22867
  * @module purecloud-platform-client-v2/api/FaxApi
22595
- * @version 138.0.0
22868
+ * @version 140.0.0
22596
22869
  */
22597
22870
 
22598
22871
  /**
@@ -22763,7 +23036,7 @@ class FlowsApi {
22763
23036
  /**
22764
23037
  * Flows service.
22765
23038
  * @module purecloud-platform-client-v2/api/FlowsApi
22766
- * @version 138.0.0
23039
+ * @version 140.0.0
22767
23040
  */
22768
23041
 
22769
23042
  /**
@@ -22834,7 +23107,7 @@ class GamificationApi {
22834
23107
  /**
22835
23108
  * Gamification service.
22836
23109
  * @module purecloud-platform-client-v2/api/GamificationApi
22837
- * @version 138.0.0
23110
+ * @version 140.0.0
22838
23111
  */
22839
23112
 
22840
23113
  /**
@@ -22979,7 +23252,7 @@ class GamificationApi {
22979
23252
 
22980
23253
  /**
22981
23254
  * Gamified metric by id
22982
- *
23255
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
22983
23256
  * @param {String} metricId metric Id
22984
23257
  * @param {Object} opts Optional parameters
22985
23258
  * @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
@@ -23054,7 +23327,7 @@ class GamificationApi {
23054
23327
 
23055
23328
  /**
23056
23329
  * All gamified metrics for a given profile
23057
- *
23330
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
23058
23331
  * @param {Object} opts Optional parameters
23059
23332
  * @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
23060
23333
  * @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
@@ -23105,18 +23378,18 @@ class GamificationApi {
23105
23378
  /**
23106
23379
  * Members of a given performance profile
23107
23380
  *
23108
- * @param {String} performanceProfileId Performance Profile Id
23381
+ * @param {String} profileId Profile Id
23109
23382
  */
23110
- getGamificationProfileMembers(performanceProfileId) {
23111
- // verify the required parameter 'performanceProfileId' is set
23112
- if (performanceProfileId === undefined || performanceProfileId === null) {
23113
- throw 'Missing the required parameter "performanceProfileId" when calling getGamificationProfileMembers';
23383
+ getGamificationProfileMembers(profileId) {
23384
+ // verify the required parameter 'profileId' is set
23385
+ if (profileId === undefined || profileId === null) {
23386
+ throw 'Missing the required parameter "profileId" when calling getGamificationProfileMembers';
23114
23387
  }
23115
23388
 
23116
23389
  return this.apiClient.callApi(
23117
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
23390
+ '/api/v2/gamification/profiles/{profileId}/members',
23118
23391
  'GET',
23119
- { 'performanceProfileId': performanceProfileId },
23392
+ { 'profileId': profileId },
23120
23393
  { },
23121
23394
  { },
23122
23395
  { },
@@ -23168,6 +23441,7 @@ class GamificationApi {
23168
23441
  * @param {Object} opts Optional parameters
23169
23442
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
23170
23443
  * @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
23444
+ * @param {String} opts.metricIds List of metric ids to filter the response (Optional, comma-separated).
23171
23445
  */
23172
23446
  getGamificationProfileMetrics(profileId, opts) {
23173
23447
  opts = opts || {};
@@ -23181,7 +23455,7 @@ class GamificationApi {
23181
23455
  '/api/v2/gamification/profiles/{profileId}/metrics',
23182
23456
  'GET',
23183
23457
  { 'profileId': profileId },
23184
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'] },
23458
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'workday': opts['workday'],'metricIds': opts['metricIds'] },
23185
23459
  { },
23186
23460
  { },
23187
23461
  null,
@@ -23908,7 +24182,7 @@ class GamificationApi {
23908
24182
 
23909
24183
  /**
23910
24184
  * Creates a gamified metric with a given metric definition and metric objective
23911
- *
24185
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics instead.
23912
24186
  * @param {Object} body Metric
23913
24187
  */
23914
24188
  postGamificationMetrics(body) {
@@ -23984,13 +24258,13 @@ class GamificationApi {
23984
24258
  /**
23985
24259
  * Assign members to a given performance profile
23986
24260
  *
23987
- * @param {String} performanceProfileId Performance Profile Id
24261
+ * @param {String} profileId Profile Id
23988
24262
  * @param {Object} body assignUsers
23989
24263
  */
23990
- postGamificationProfileMembers(performanceProfileId, body) {
23991
- // verify the required parameter 'performanceProfileId' is set
23992
- if (performanceProfileId === undefined || performanceProfileId === null) {
23993
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembers';
24264
+ postGamificationProfileMembers(profileId, body) {
24265
+ // verify the required parameter 'profileId' is set
24266
+ if (profileId === undefined || profileId === null) {
24267
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembers';
23994
24268
  }
23995
24269
  // verify the required parameter 'body' is set
23996
24270
  if (body === undefined || body === null) {
@@ -23998,9 +24272,9 @@ class GamificationApi {
23998
24272
  }
23999
24273
 
24000
24274
  return this.apiClient.callApi(
24001
- '/api/v2/gamification/profiles/{performanceProfileId}/members',
24275
+ '/api/v2/gamification/profiles/{profileId}/members',
24002
24276
  'POST',
24003
- { 'performanceProfileId': performanceProfileId },
24277
+ { 'profileId': profileId },
24004
24278
  { },
24005
24279
  { },
24006
24280
  { },
@@ -24014,13 +24288,13 @@ class GamificationApi {
24014
24288
  /**
24015
24289
  * Validate member assignment
24016
24290
  *
24017
- * @param {String} performanceProfileId Performance Profile Id
24291
+ * @param {String} profileId Profile Id
24018
24292
  * @param {Object} body memberAssignments
24019
24293
  */
24020
- postGamificationProfileMembersValidate(performanceProfileId, body) {
24021
- // verify the required parameter 'performanceProfileId' is set
24022
- if (performanceProfileId === undefined || performanceProfileId === null) {
24023
- throw 'Missing the required parameter "performanceProfileId" when calling postGamificationProfileMembersValidate';
24294
+ postGamificationProfileMembersValidate(profileId, body) {
24295
+ // verify the required parameter 'profileId' is set
24296
+ if (profileId === undefined || profileId === null) {
24297
+ throw 'Missing the required parameter "profileId" when calling postGamificationProfileMembersValidate';
24024
24298
  }
24025
24299
  // verify the required parameter 'body' is set
24026
24300
  if (body === undefined || body === null) {
@@ -24028,9 +24302,9 @@ class GamificationApi {
24028
24302
  }
24029
24303
 
24030
24304
  return this.apiClient.callApi(
24031
- '/api/v2/gamification/profiles/{performanceProfileId}/members/validate',
24305
+ '/api/v2/gamification/profiles/{profileId}/members/validate',
24032
24306
  'POST',
24033
- { 'performanceProfileId': performanceProfileId },
24307
+ { 'profileId': profileId },
24034
24308
  { },
24035
24309
  { },
24036
24310
  { },
@@ -24137,7 +24411,7 @@ class GamificationApi {
24137
24411
 
24138
24412
  /**
24139
24413
  * Updates a metric
24140
- *
24414
+ * This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
24141
24415
  * @param {String} metricId metric Id
24142
24416
  * @param {Object} body Metric
24143
24417
  * @param {Object} opts Optional parameters
@@ -24264,7 +24538,7 @@ class GeneralDataProtectionRegulationApi {
24264
24538
  /**
24265
24539
  * GeneralDataProtectionRegulation service.
24266
24540
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
24267
- * @version 138.0.0
24541
+ * @version 140.0.0
24268
24542
  */
24269
24543
 
24270
24544
  /**
@@ -24394,7 +24668,7 @@ class GeolocationApi {
24394
24668
  /**
24395
24669
  * Geolocation service.
24396
24670
  * @module purecloud-platform-client-v2/api/GeolocationApi
24397
- * @version 138.0.0
24671
+ * @version 140.0.0
24398
24672
  */
24399
24673
 
24400
24674
  /**
@@ -24525,7 +24799,7 @@ class GreetingsApi {
24525
24799
  /**
24526
24800
  * Greetings service.
24527
24801
  * @module purecloud-platform-client-v2/api/GreetingsApi
24528
- * @version 138.0.0
24802
+ * @version 140.0.0
24529
24803
  */
24530
24804
 
24531
24805
  /**
@@ -24980,7 +25254,7 @@ class GroupsApi {
24980
25254
  /**
24981
25255
  * Groups service.
24982
25256
  * @module purecloud-platform-client-v2/api/GroupsApi
24983
- * @version 138.0.0
25257
+ * @version 140.0.0
24984
25258
  */
24985
25259
 
24986
25260
  /**
@@ -25385,7 +25659,7 @@ class IdentityProviderApi {
25385
25659
  /**
25386
25660
  * IdentityProvider service.
25387
25661
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
25388
- * @version 138.0.0
25662
+ * @version 140.0.0
25389
25663
  */
25390
25664
 
25391
25665
  /**
@@ -26141,7 +26415,7 @@ class IntegrationsApi {
26141
26415
  /**
26142
26416
  * Integrations service.
26143
26417
  * @module purecloud-platform-client-v2/api/IntegrationsApi
26144
- * @version 138.0.0
26418
+ * @version 140.0.0
26145
26419
  */
26146
26420
 
26147
26421
  /**
@@ -27818,7 +28092,7 @@ class JourneyApi {
27818
28092
  /**
27819
28093
  * Journey service.
27820
28094
  * @module purecloud-platform-client-v2/api/JourneyApi
27821
- * @version 138.0.0
28095
+ * @version 140.0.0
27822
28096
  */
27823
28097
 
27824
28098
  /**
@@ -28529,7 +28803,7 @@ class KnowledgeApi {
28529
28803
  /**
28530
28804
  * Knowledge service.
28531
28805
  * @module purecloud-platform-client-v2/api/KnowledgeApi
28532
- * @version 138.0.0
28806
+ * @version 140.0.0
28533
28807
  */
28534
28808
 
28535
28809
  /**
@@ -28707,7 +28981,7 @@ class KnowledgeApi {
28707
28981
  * @param {Object} opts Optional parameters
28708
28982
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
28709
28983
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
28710
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
28984
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
28711
28985
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28712
28986
  * @param {String} opts.name Filter to return the categories that starts with the given category name.
28713
28987
  */
@@ -28815,7 +29089,7 @@ class KnowledgeApi {
28815
29089
  * @param {Object} opts Optional parameters
28816
29090
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
28817
29091
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
28818
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
29092
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
28819
29093
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28820
29094
  * @param {String} opts.categories Filter by categories ids, comma separated values expected.
28821
29095
  * @param {String} opts.title Filter by document title.
@@ -28927,7 +29201,7 @@ class KnowledgeApi {
28927
29201
  * @param {Object} opts Optional parameters
28928
29202
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
28929
29203
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
28930
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
29204
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
28931
29205
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28932
29206
  * @param {Object} opts.knowledgeDocumentsState Return the training with the specified state of the trained documents.
28933
29207
  */
@@ -28963,7 +29237,7 @@ class KnowledgeApi {
28963
29237
  * @param {Object} opts Optional parameters
28964
29238
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
28965
29239
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
28966
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
29240
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
28967
29241
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
28968
29242
  * @param {String} opts.name Filter by Name.
28969
29243
  * @param {Object} opts.coreLanguage Filter by core language.
@@ -29429,7 +29703,7 @@ class LanguageUnderstandingApi {
29429
29703
  /**
29430
29704
  * LanguageUnderstanding service.
29431
29705
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
29432
- * @version 138.0.0
29706
+ * @version 140.0.0
29433
29707
  */
29434
29708
 
29435
29709
  /**
@@ -30333,7 +30607,7 @@ class LanguagesApi {
30333
30607
  /**
30334
30608
  * Languages service.
30335
30609
  * @module purecloud-platform-client-v2/api/LanguagesApi
30336
- * @version 138.0.0
30610
+ * @version 140.0.0
30337
30611
  */
30338
30612
 
30339
30613
  /**
@@ -30601,7 +30875,7 @@ class LearningApi {
30601
30875
  /**
30602
30876
  * Learning service.
30603
30877
  * @module purecloud-platform-client-v2/api/LearningApi
30604
- * @version 138.0.0
30878
+ * @version 140.0.0
30605
30879
  */
30606
30880
 
30607
30881
  /**
@@ -30799,6 +31073,36 @@ class LearningApi {
30799
31073
  );
30800
31074
  }
30801
31075
 
31076
+ /**
31077
+ * Get a specific Learning Module job status
31078
+ *
31079
+ * @param {String} moduleId The ID of the learning module
31080
+ * @param {String} jobId The ID of the learning module job
31081
+ */
31082
+ getLearningModuleJob(moduleId, jobId) {
31083
+ // verify the required parameter 'moduleId' is set
31084
+ if (moduleId === undefined || moduleId === null) {
31085
+ throw 'Missing the required parameter "moduleId" when calling getLearningModuleJob';
31086
+ }
31087
+ // verify the required parameter 'jobId' is set
31088
+ if (jobId === undefined || jobId === null) {
31089
+ throw 'Missing the required parameter "jobId" when calling getLearningModuleJob';
31090
+ }
31091
+
31092
+ return this.apiClient.callApi(
31093
+ '/api/v2/learning/modules/{moduleId}/jobs/{jobId}',
31094
+ 'GET',
31095
+ { 'moduleId': moduleId,'jobId': jobId },
31096
+ { },
31097
+ { },
31098
+ { },
31099
+ null,
31100
+ ['PureCloud OAuth'],
31101
+ ['application/json'],
31102
+ ['application/json']
31103
+ );
31104
+ }
31105
+
30802
31106
  /**
30803
31107
  * Get a learning module rule
30804
31108
  *
@@ -30944,6 +31248,56 @@ class LearningApi {
30944
31248
  );
30945
31249
  }
30946
31250
 
31251
+ /**
31252
+ * Reassign Learning Assignment
31253
+ * This will reassign the state of the assignment to Assigned and update the assignment to the latest version of the module
31254
+ * @param {String} assignmentId The Learning Assignment ID
31255
+ */
31256
+ postLearningAssignmentReassign(assignmentId) {
31257
+ // verify the required parameter 'assignmentId' is set
31258
+ if (assignmentId === undefined || assignmentId === null) {
31259
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReassign';
31260
+ }
31261
+
31262
+ return this.apiClient.callApi(
31263
+ '/api/v2/learning/assignments/{assignmentId}/reassign',
31264
+ 'POST',
31265
+ { 'assignmentId': assignmentId },
31266
+ { },
31267
+ { },
31268
+ { },
31269
+ null,
31270
+ ['PureCloud OAuth'],
31271
+ ['application/json'],
31272
+ ['application/json']
31273
+ );
31274
+ }
31275
+
31276
+ /**
31277
+ * Reset Learning Assignment
31278
+ * This will reset the state of the assignment to Assigned and remove the version of Learning module associated with the assignment
31279
+ * @param {String} assignmentId The Learning Assignment ID
31280
+ */
31281
+ postLearningAssignmentReset(assignmentId) {
31282
+ // verify the required parameter 'assignmentId' is set
31283
+ if (assignmentId === undefined || assignmentId === null) {
31284
+ throw 'Missing the required parameter "assignmentId" when calling postLearningAssignmentReset';
31285
+ }
31286
+
31287
+ return this.apiClient.callApi(
31288
+ '/api/v2/learning/assignments/{assignmentId}/reset',
31289
+ 'POST',
31290
+ { 'assignmentId': assignmentId },
31291
+ { },
31292
+ { },
31293
+ { },
31294
+ null,
31295
+ ['PureCloud OAuth'],
31296
+ ['application/json'],
31297
+ ['application/json']
31298
+ );
31299
+ }
31300
+
30947
31301
  /**
30948
31302
  * Create Learning Assignment
30949
31303
  *
@@ -31041,6 +31395,36 @@ class LearningApi {
31041
31395
  );
31042
31396
  }
31043
31397
 
31398
+ /**
31399
+ * Starts a specified operation on learning module
31400
+ * This will initiate operation specified in the request body for a learning module
31401
+ * @param {String} moduleId The ID of the learning module
31402
+ * @param {Object} body The learning module job request
31403
+ */
31404
+ postLearningModuleJobs(moduleId, body) {
31405
+ // verify the required parameter 'moduleId' is set
31406
+ if (moduleId === undefined || moduleId === null) {
31407
+ throw 'Missing the required parameter "moduleId" when calling postLearningModuleJobs';
31408
+ }
31409
+ // verify the required parameter 'body' is set
31410
+ if (body === undefined || body === null) {
31411
+ throw 'Missing the required parameter "body" when calling postLearningModuleJobs';
31412
+ }
31413
+
31414
+ return this.apiClient.callApi(
31415
+ '/api/v2/learning/modules/{moduleId}/jobs',
31416
+ 'POST',
31417
+ { 'moduleId': moduleId },
31418
+ { },
31419
+ { },
31420
+ { },
31421
+ body,
31422
+ ['PureCloud OAuth'],
31423
+ ['application/json'],
31424
+ ['application/json']
31425
+ );
31426
+ }
31427
+
31044
31428
  /**
31045
31429
  * Publish a Learning module
31046
31430
  *
@@ -31192,7 +31576,7 @@ class LicenseApi {
31192
31576
  /**
31193
31577
  * License service.
31194
31578
  * @module purecloud-platform-client-v2/api/LicenseApi
31195
- * @version 138.0.0
31579
+ * @version 140.0.0
31196
31580
  */
31197
31581
 
31198
31582
  /**
@@ -31430,7 +31814,7 @@ class LocationsApi {
31430
31814
  /**
31431
31815
  * Locations service.
31432
31816
  * @module purecloud-platform-client-v2/api/LocationsApi
31433
- * @version 138.0.0
31817
+ * @version 140.0.0
31434
31818
  */
31435
31819
 
31436
31820
  /**
@@ -31666,7 +32050,7 @@ class MessagingApi {
31666
32050
  /**
31667
32051
  * Messaging service.
31668
32052
  * @module purecloud-platform-client-v2/api/MessagingApi
31669
- * @version 138.0.0
32053
+ * @version 140.0.0
31670
32054
  */
31671
32055
 
31672
32056
  /**
@@ -31817,7 +32201,7 @@ class MobileDevicesApi {
31817
32201
  /**
31818
32202
  * MobileDevices service.
31819
32203
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
31820
- * @version 138.0.0
32204
+ * @version 140.0.0
31821
32205
  */
31822
32206
 
31823
32207
  /**
@@ -31968,7 +32352,7 @@ class NotificationsApi {
31968
32352
  /**
31969
32353
  * Notifications service.
31970
32354
  * @module purecloud-platform-client-v2/api/NotificationsApi
31971
- * @version 138.0.0
32355
+ * @version 140.0.0
31972
32356
  */
31973
32357
 
31974
32358
  /**
@@ -32193,7 +32577,7 @@ class OAuthApi {
32193
32577
  /**
32194
32578
  * OAuth service.
32195
32579
  * @module purecloud-platform-client-v2/api/OAuthApi
32196
- * @version 138.0.0
32580
+ * @version 140.0.0
32197
32581
  */
32198
32582
 
32199
32583
  /**
@@ -32559,7 +32943,7 @@ class ObjectsApi {
32559
32943
  /**
32560
32944
  * Objects service.
32561
32945
  * @module purecloud-platform-client-v2/api/ObjectsApi
32562
- * @version 138.0.0
32946
+ * @version 140.0.0
32563
32947
  */
32564
32948
 
32565
32949
  /**
@@ -32830,7 +33214,7 @@ class OrganizationApi {
32830
33214
  /**
32831
33215
  * Organization service.
32832
33216
  * @module purecloud-platform-client-v2/api/OrganizationApi
32833
- * @version 138.0.0
33217
+ * @version 140.0.0
32834
33218
  */
32835
33219
 
32836
33220
  /**
@@ -33233,7 +33617,7 @@ class OrganizationAuthorizationApi {
33233
33617
  /**
33234
33618
  * OrganizationAuthorization service.
33235
33619
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
33236
- * @version 138.0.0
33620
+ * @version 140.0.0
33237
33621
  */
33238
33622
 
33239
33623
  /**
@@ -34158,7 +34542,7 @@ class OutboundApi {
34158
34542
  /**
34159
34543
  * Outbound service.
34160
34544
  * @module purecloud-platform-client-v2/api/OutboundApi
34161
- * @version 138.0.0
34545
+ * @version 140.0.0
34162
34546
  */
34163
34547
 
34164
34548
  /**
@@ -37413,7 +37797,7 @@ class PresenceApi {
37413
37797
  /**
37414
37798
  * Presence service.
37415
37799
  * @module purecloud-platform-client-v2/api/PresenceApi
37416
- * @version 138.0.0
37800
+ * @version 140.0.0
37417
37801
  */
37418
37802
 
37419
37803
  /**
@@ -37735,7 +38119,7 @@ class QualityApi {
37735
38119
  /**
37736
38120
  * Quality service.
37737
38121
  * @module purecloud-platform-client-v2/api/QualityApi
37738
- * @version 138.0.0
38122
+ * @version 140.0.0
37739
38123
  */
37740
38124
 
37741
38125
  /**
@@ -38493,7 +38877,7 @@ class QualityApi {
38493
38877
  /**
38494
38878
  * Retrieve a list of the latest form versions by context ids
38495
38879
  *
38496
- * @param {Array.<String>} contextId A comma-delimited list of valid survey form context ids
38880
+ * @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.
38497
38881
  * @param {Object} opts Optional parameters
38498
38882
  * @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)
38499
38883
  */
@@ -39313,7 +39697,7 @@ class RecordingApi {
39313
39697
  /**
39314
39698
  * Recording service.
39315
39699
  * @module purecloud-platform-client-v2/api/RecordingApi
39316
- * @version 138.0.0
39700
+ * @version 140.0.0
39317
39701
  */
39318
39702
 
39319
39703
  /**
@@ -40966,7 +41350,7 @@ class ResponseManagementApi {
40966
41350
  /**
40967
41351
  * ResponseManagement service.
40968
41352
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
40969
- * @version 138.0.0
41353
+ * @version 140.0.0
40970
41354
  */
40971
41355
 
40972
41356
  /**
@@ -41450,7 +41834,7 @@ class RoutingApi {
41450
41834
  /**
41451
41835
  * Routing service.
41452
41836
  * @module purecloud-platform-client-v2/api/RoutingApi
41453
- * @version 138.0.0
41837
+ * @version 140.0.0
41454
41838
  */
41455
41839
 
41456
41840
  /**
@@ -41763,12 +42147,8 @@ class RoutingApi {
41763
42147
  * Delete a phone number provisioned for SMS.
41764
42148
  *
41765
42149
  * @param {String} addressId Address ID
41766
- * @param {Object} opts Optional parameters
41767
- * @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)
41768
42150
  */
41769
- deleteRoutingSmsPhonenumber(addressId, opts) {
41770
- opts = opts || {};
41771
-
42151
+ deleteRoutingSmsPhonenumber(addressId) {
41772
42152
  // verify the required parameter 'addressId' is set
41773
42153
  if (addressId === undefined || addressId === null) {
41774
42154
  throw 'Missing the required parameter "addressId" when calling deleteRoutingSmsPhonenumber';
@@ -41778,7 +42158,7 @@ class RoutingApi {
41778
42158
  '/api/v2/routing/sms/phonenumbers/{addressId}',
41779
42159
  'DELETE',
41780
42160
  { 'addressId': addressId },
41781
- { 'async': opts['async'] },
42161
+ { },
41782
42162
  { },
41783
42163
  { },
41784
42164
  null,
@@ -41949,7 +42329,7 @@ class RoutingApi {
41949
42329
  * @param {Object} opts Optional parameters
41950
42330
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
41951
42331
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
41952
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
42332
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
41953
42333
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
41954
42334
  * @param {Array.<String>} opts.queueId Queue ID(s) to filter assessments by.
41955
42335
  */
@@ -42260,7 +42640,7 @@ class RoutingApi {
42260
42640
  * @param {Object} opts Optional parameters
42261
42641
  * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
42262
42642
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
42263
- * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize, use CursorQueryParameters instead.
42643
+ * @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
42264
42644
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
42265
42645
  * @param {Array.<String>} opts.queueId Comma-separated list of queue Ids to filter by.
42266
42646
  */
@@ -42283,16 +42663,20 @@ class RoutingApi {
42283
42663
  }
42284
42664
 
42285
42665
  /**
42286
- * Get a list of Key Performance Indicators available for the predictors.
42666
+ * Get a list of Key Performance Indicators
42287
42667
  *
42668
+ * @param {Object} opts Optional parameters
42669
+ * @param {Object} opts.kpiGroup The Group of Key Performance Indicators to return
42288
42670
  */
42289
- getRoutingPredictorsKeyperformanceindicators() {
42671
+ getRoutingPredictorsKeyperformanceindicators(opts) {
42672
+ opts = opts || {};
42673
+
42290
42674
 
42291
42675
  return this.apiClient.callApi(
42292
42676
  '/api/v2/routing/predictors/keyperformanceindicators',
42293
42677
  'GET',
42294
42678
  { },
42295
- { },
42679
+ { 'kpiGroup': opts['kpiGroup'] },
42296
42680
  { },
42297
42681
  { },
42298
42682
  null,
@@ -43932,12 +44316,8 @@ class RoutingApi {
43932
44316
  * Provision a phone number for SMS
43933
44317
  *
43934
44318
  * @param {Object} body SmsPhoneNumber
43935
- * @param {Object} opts Optional parameters
43936
- * @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)
43937
44319
  */
43938
- postRoutingSmsPhonenumbers(body, opts) {
43939
- opts = opts || {};
43940
-
44320
+ postRoutingSmsPhonenumbers(body) {
43941
44321
  // verify the required parameter 'body' is set
43942
44322
  if (body === undefined || body === null) {
43943
44323
  throw 'Missing the required parameter "body" when calling postRoutingSmsPhonenumbers';
@@ -43947,7 +44327,7 @@ class RoutingApi {
43947
44327
  '/api/v2/routing/sms/phonenumbers',
43948
44328
  'POST',
43949
44329
  { },
43950
- { 'async': opts['async'] },
44330
+ { },
43951
44331
  { },
43952
44332
  { },
43953
44333
  body,
@@ -44192,12 +44572,8 @@ class RoutingApi {
44192
44572
  *
44193
44573
  * @param {String} addressId Address ID
44194
44574
  * @param {Object} body SmsPhoneNumber
44195
- * @param {Object} opts Optional parameters
44196
- * @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)
44197
44575
  */
44198
- putRoutingSmsPhonenumber(addressId, body, opts) {
44199
- opts = opts || {};
44200
-
44576
+ putRoutingSmsPhonenumber(addressId, body) {
44201
44577
  // verify the required parameter 'addressId' is set
44202
44578
  if (addressId === undefined || addressId === null) {
44203
44579
  throw 'Missing the required parameter "addressId" when calling putRoutingSmsPhonenumber';
@@ -44211,7 +44587,7 @@ class RoutingApi {
44211
44587
  '/api/v2/routing/sms/phonenumbers/{addressId}',
44212
44588
  'PUT',
44213
44589
  { 'addressId': addressId },
44214
- { 'async': opts['async'] },
44590
+ { },
44215
44591
  { },
44216
44592
  { },
44217
44593
  body,
@@ -44377,7 +44753,7 @@ class SCIMApi {
44377
44753
  /**
44378
44754
  * SCIM service.
44379
44755
  * @module purecloud-platform-client-v2/api/SCIMApi
44380
- * @version 138.0.0
44756
+ * @version 140.0.0
44381
44757
  */
44382
44758
 
44383
44759
  /**
@@ -45254,7 +45630,7 @@ class ScriptsApi {
45254
45630
  /**
45255
45631
  * Scripts service.
45256
45632
  * @module purecloud-platform-client-v2/api/ScriptsApi
45257
- * @version 138.0.0
45633
+ * @version 140.0.0
45258
45634
  */
45259
45635
 
45260
45636
  /**
@@ -45673,7 +46049,7 @@ class SearchApi {
45673
46049
  /**
45674
46050
  * Search service.
45675
46051
  * @module purecloud-platform-client-v2/api/SearchApi
45676
- * @version 138.0.0
46052
+ * @version 140.0.0
45677
46053
  */
45678
46054
 
45679
46055
  /**
@@ -46208,7 +46584,7 @@ class SpeechTextAnalyticsApi {
46208
46584
  /**
46209
46585
  * SpeechTextAnalytics service.
46210
46586
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
46211
- * @version 138.0.0
46587
+ * @version 140.0.0
46212
46588
  */
46213
46589
 
46214
46590
  /**
@@ -47061,7 +47437,7 @@ class StationsApi {
47061
47437
  /**
47062
47438
  * Stations service.
47063
47439
  * @module purecloud-platform-client-v2/api/StationsApi
47064
- * @version 138.0.0
47440
+ * @version 140.0.0
47065
47441
  */
47066
47442
 
47067
47443
  /**
@@ -47208,7 +47584,7 @@ class SuggestApi {
47208
47584
  /**
47209
47585
  * Suggest service.
47210
47586
  * @module purecloud-platform-client-v2/api/SuggestApi
47211
- * @version 138.0.0
47587
+ * @version 140.0.0
47212
47588
  */
47213
47589
 
47214
47590
  /**
@@ -47347,7 +47723,7 @@ class TelephonyApi {
47347
47723
  /**
47348
47724
  * Telephony service.
47349
47725
  * @module purecloud-platform-client-v2/api/TelephonyApi
47350
- * @version 138.0.0
47726
+ * @version 140.0.0
47351
47727
  */
47352
47728
 
47353
47729
  /**
@@ -47455,7 +47831,7 @@ class TelephonyProvidersEdgeApi {
47455
47831
  /**
47456
47832
  * TelephonyProvidersEdge service.
47457
47833
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
47458
- * @version 138.0.0
47834
+ * @version 140.0.0
47459
47835
  */
47460
47836
 
47461
47837
  /**
@@ -51088,7 +51464,7 @@ class TextbotsApi {
51088
51464
  /**
51089
51465
  * Textbots service.
51090
51466
  * @module purecloud-platform-client-v2/api/TextbotsApi
51091
- * @version 138.0.0
51467
+ * @version 140.0.0
51092
51468
  */
51093
51469
 
51094
51470
  /**
@@ -51216,7 +51592,7 @@ class TokensApi {
51216
51592
  /**
51217
51593
  * Tokens service.
51218
51594
  * @module purecloud-platform-client-v2/api/TokensApi
51219
- * @version 138.0.0
51595
+ * @version 140.0.0
51220
51596
  */
51221
51597
 
51222
51598
  /**
@@ -51322,7 +51698,7 @@ class UploadsApi {
51322
51698
  /**
51323
51699
  * Uploads service.
51324
51700
  * @module purecloud-platform-client-v2/api/UploadsApi
51325
- * @version 138.0.0
51701
+ * @version 140.0.0
51326
51702
  */
51327
51703
 
51328
51704
  /**
@@ -51473,7 +51849,7 @@ class UsageApi {
51473
51849
  /**
51474
51850
  * Usage service.
51475
51851
  * @module purecloud-platform-client-v2/api/UsageApi
51476
- * @version 138.0.0
51852
+ * @version 140.0.0
51477
51853
  */
51478
51854
 
51479
51855
  /**
@@ -51544,7 +51920,7 @@ class UserRecordingsApi {
51544
51920
  /**
51545
51921
  * UserRecordings service.
51546
51922
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
51547
- * @version 138.0.0
51923
+ * @version 140.0.0
51548
51924
  */
51549
51925
 
51550
51926
  /**
@@ -51728,7 +52104,7 @@ class UsersApi {
51728
52104
  /**
51729
52105
  * Users service.
51730
52106
  * @module purecloud-platform-client-v2/api/UsersApi
51731
- * @version 138.0.0
52107
+ * @version 140.0.0
51732
52108
  */
51733
52109
 
51734
52110
  /**
@@ -52548,18 +52924,18 @@ class UsersApi {
52548
52924
  /**
52549
52925
  * Returns a listing of roles and permissions for a user.
52550
52926
  *
52551
- * @param {String} userId User ID
52927
+ * @param {String} subjectId User ID
52552
52928
  */
52553
- getUserRoles(userId) {
52554
- // verify the required parameter 'userId' is set
52555
- if (userId === undefined || userId === null) {
52556
- throw 'Missing the required parameter "userId" when calling getUserRoles';
52929
+ getUserRoles(subjectId) {
52930
+ // verify the required parameter 'subjectId' is set
52931
+ if (subjectId === undefined || subjectId === null) {
52932
+ throw 'Missing the required parameter "subjectId" when calling getUserRoles';
52557
52933
  }
52558
52934
 
52559
52935
  return this.apiClient.callApi(
52560
- '/api/v2/users/{userId}/roles',
52936
+ '/api/v2/users/{subjectId}/roles',
52561
52937
  'GET',
52562
- { 'userId': userId },
52938
+ { 'subjectId': subjectId },
52563
52939
  { },
52564
52940
  { },
52565
52941
  { },
@@ -53812,13 +54188,13 @@ class UsersApi {
53812
54188
  /**
53813
54189
  * Sets the user's roles
53814
54190
  *
53815
- * @param {String} userId User ID
54191
+ * @param {String} subjectId User ID
53816
54192
  * @param {Array.<String>} body List of roles
53817
54193
  */
53818
- putUserRoles(userId, body) {
53819
- // verify the required parameter 'userId' is set
53820
- if (userId === undefined || userId === null) {
53821
- throw 'Missing the required parameter "userId" when calling putUserRoles';
54194
+ putUserRoles(subjectId, body) {
54195
+ // verify the required parameter 'subjectId' is set
54196
+ if (subjectId === undefined || subjectId === null) {
54197
+ throw 'Missing the required parameter "subjectId" when calling putUserRoles';
53822
54198
  }
53823
54199
  // verify the required parameter 'body' is set
53824
54200
  if (body === undefined || body === null) {
@@ -53826,9 +54202,9 @@ class UsersApi {
53826
54202
  }
53827
54203
 
53828
54204
  return this.apiClient.callApi(
53829
- '/api/v2/users/{userId}/roles',
54205
+ '/api/v2/users/{subjectId}/roles',
53830
54206
  'PUT',
53831
- { 'userId': userId },
54207
+ { 'subjectId': subjectId },
53832
54208
  { },
53833
54209
  { },
53834
54210
  { },
@@ -54030,7 +54406,7 @@ class UtilitiesApi {
54030
54406
  /**
54031
54407
  * Utilities service.
54032
54408
  * @module purecloud-platform-client-v2/api/UtilitiesApi
54033
- * @version 138.0.0
54409
+ * @version 140.0.0
54034
54410
  */
54035
54411
 
54036
54412
  /**
@@ -54141,7 +54517,7 @@ class VoicemailApi {
54141
54517
  /**
54142
54518
  * Voicemail service.
54143
54519
  * @module purecloud-platform-client-v2/api/VoicemailApi
54144
- * @version 138.0.0
54520
+ * @version 140.0.0
54145
54521
  */
54146
54522
 
54147
54523
  /**
@@ -54808,7 +55184,7 @@ class WebChatApi {
54808
55184
  /**
54809
55185
  * WebChat service.
54810
55186
  * @module purecloud-platform-client-v2/api/WebChatApi
54811
- * @version 138.0.0
55187
+ * @version 140.0.0
54812
55188
  */
54813
55189
 
54814
55190
  /**
@@ -55352,7 +55728,7 @@ class WebDeploymentsApi {
55352
55728
  /**
55353
55729
  * WebDeployments service.
55354
55730
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
55355
- * @version 138.0.0
55731
+ * @version 140.0.0
55356
55732
  */
55357
55733
 
55358
55734
  /**
@@ -55707,7 +56083,7 @@ class WebMessagingApi {
55707
56083
  /**
55708
56084
  * WebMessaging service.
55709
56085
  * @module purecloud-platform-client-v2/api/WebMessagingApi
55710
- * @version 138.0.0
56086
+ * @version 140.0.0
55711
56087
  */
55712
56088
 
55713
56089
  /**
@@ -55753,7 +56129,7 @@ class WidgetsApi {
55753
56129
  /**
55754
56130
  * Widgets service.
55755
56131
  * @module purecloud-platform-client-v2/api/WidgetsApi
55756
- * @version 138.0.0
56132
+ * @version 140.0.0
55757
56133
  */
55758
56134
 
55759
56135
  /**
@@ -55899,7 +56275,7 @@ class WorkforceManagementApi {
55899
56275
  /**
55900
56276
  * WorkforceManagement service.
55901
56277
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
55902
- * @version 138.0.0
56278
+ * @version 140.0.0
55903
56279
  */
55904
56280
 
55905
56281
  /**
@@ -60150,7 +60526,7 @@ class WorkforceManagementApi {
60150
60526
  * </pre>
60151
60527
  * </p>
60152
60528
  * @module purecloud-platform-client-v2/index
60153
- * @version 138.0.0
60529
+ * @version 140.0.0
60154
60530
  */
60155
60531
  class platformClient {
60156
60532
  constructor() {