purecloud-platform-client-v2 223.0.0 → 225.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 (94) hide show
  1. package/README.md +3 -3
  2. package/dist/node/purecloud-platform-client-v2.js +3630 -2644
  3. package/dist/web-amd/purecloud-platform-client-v2.js +3630 -2644
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +2891 -2627
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +2891 -2627
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +825 -249
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AIStudioApi.js +387 -0
  12. package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +13 -13
  13. package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +3 -3
  14. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +5 -5
  15. package/src/purecloud-platform-client-v2/api/AlertingApi.js +8 -8
  16. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +46 -46
  17. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +124 -122
  18. package/src/purecloud-platform-client-v2/api/AuditApi.js +3 -3
  19. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +47 -47
  20. package/src/purecloud-platform-client-v2/api/BillingApi.js +7 -7
  21. package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +75 -30
  22. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/ChatApi.js +38 -38
  24. package/src/purecloud-platform-client-v2/api/CoachingApi.js +17 -17
  25. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +32 -32
  26. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +620 -344
  27. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +2 -2
  28. package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +4 -4
  29. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +2 -2
  30. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +4 -4
  32. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +66 -66
  34. package/src/purecloud-platform-client-v2/api/FaxApi.js +5 -5
  35. package/src/purecloud-platform-client-v2/api/FlowsApi.js +3 -3
  36. package/src/purecloud-platform-client-v2/api/GamificationApi.js +49 -49
  37. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +2 -2
  38. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +5 -5
  39. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +101 -14
  40. package/src/purecloud-platform-client-v2/api/GroupsApi.js +12 -12
  41. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +4 -4
  42. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +3 -3
  43. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +106 -80
  44. package/src/purecloud-platform-client-v2/api/JourneyApi.js +68 -68
  45. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +212 -212
  46. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +46 -46
  47. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +4 -4
  48. package/src/purecloud-platform-client-v2/api/LearningApi.js +28 -28
  49. package/src/purecloud-platform-client-v2/api/LicenseApi.js +5 -5
  50. package/src/purecloud-platform-client-v2/api/LocationsApi.js +5 -5
  51. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +5 -5
  52. package/src/purecloud-platform-client-v2/api/MessagingApi.js +7 -7
  53. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +4 -4
  54. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +6 -6
  55. package/src/purecloud-platform-client-v2/api/OAuthApi.js +11 -11
  56. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +7 -7
  57. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +2 -2
  58. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +5 -5
  59. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +59 -59
  60. package/src/purecloud-platform-client-v2/api/OutboundApi.js +118 -118
  61. package/src/purecloud-platform-client-v2/api/PresenceApi.js +19 -19
  62. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +6 -6
  63. package/src/purecloud-platform-client-v2/api/QualityApi.js +36 -36
  64. package/src/purecloud-platform-client-v2/api/RecordingApi.js +42 -42
  65. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +11 -11
  66. package/src/purecloud-platform-client-v2/api/RoutingApi.js +148 -118
  67. package/src/purecloud-platform-client-v2/api/SCIMApi.js +19 -19
  68. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +13 -13
  70. package/src/purecloud-platform-client-v2/api/SearchApi.js +2 -2
  71. package/src/purecloud-platform-client-v2/api/SettingsApi.js +5 -5
  72. package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +59 -59
  73. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +33 -33
  74. package/src/purecloud-platform-client-v2/api/StationsApi.js +3 -3
  75. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +78 -78
  77. package/src/purecloud-platform-client-v2/api/TeamsApi.js +8 -8
  78. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +4 -4
  79. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +134 -93
  80. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +2 -2
  81. package/src/purecloud-platform-client-v2/api/TokensApi.js +2 -2
  82. package/src/purecloud-platform-client-v2/api/UploadsApi.js +6 -6
  83. package/src/purecloud-platform-client-v2/api/UsageApi.js +7 -7
  84. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +6 -6
  85. package/src/purecloud-platform-client-v2/api/UsersApi.js +123 -93
  86. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  87. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +17 -17
  88. package/src/purecloud-platform-client-v2/api/WebChatApi.js +21 -21
  89. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +18 -18
  90. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  91. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +4 -4
  92. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +332 -326
  93. package/src/purecloud-platform-client-v2/configuration.js +80 -23
  94. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class UsersApi {
5
5
  /**
6
6
  * Users service.
7
7
  * @module purecloud-platform-client-v2/api/UsersApi
8
- * @version 223.0.0
8
+ * @version 225.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -27,7 +27,7 @@ class UsersApi {
27
27
  */
28
28
  deleteAnalyticsUsersDetailsJob(jobId) {
29
29
  // verify the required parameter 'jobId' is set
30
- if (jobId === undefined || jobId === null) {
30
+ if (jobId === undefined || jobId === null || jobId === '') {
31
31
  throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersDetailsJob';
32
32
  }
33
33
 
@@ -54,15 +54,15 @@ class UsersApi {
54
54
  */
55
55
  deleteAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId) {
56
56
  // verify the required parameter 'subjectId' is set
57
- if (subjectId === undefined || subjectId === null) {
57
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
58
58
  throw 'Missing the required parameter "subjectId" when calling deleteAuthorizationSubjectDivisionRole';
59
59
  }
60
60
  // verify the required parameter 'divisionId' is set
61
- if (divisionId === undefined || divisionId === null) {
61
+ if (divisionId === undefined || divisionId === null || divisionId === '') {
62
62
  throw 'Missing the required parameter "divisionId" when calling deleteAuthorizationSubjectDivisionRole';
63
63
  }
64
64
  // verify the required parameter 'roleId' is set
65
- if (roleId === undefined || roleId === null) {
65
+ if (roleId === undefined || roleId === null || roleId === '') {
66
66
  throw 'Missing the required parameter "roleId" when calling deleteAuthorizationSubjectDivisionRole';
67
67
  }
68
68
 
@@ -107,7 +107,7 @@ class UsersApi {
107
107
  */
108
108
  deleteRoutingUserDirectroutingbackupSettings(userId) {
109
109
  // verify the required parameter 'userId' is set
110
- if (userId === undefined || userId === null) {
110
+ if (userId === undefined || userId === null || userId === '') {
111
111
  throw 'Missing the required parameter "userId" when calling deleteRoutingUserDirectroutingbackupSettings';
112
112
  }
113
113
 
@@ -132,7 +132,7 @@ class UsersApi {
132
132
  */
133
133
  deleteRoutingUserUtilization(userId) {
134
134
  // verify the required parameter 'userId' is set
135
- if (userId === undefined || userId === null) {
135
+ if (userId === undefined || userId === null || userId === '') {
136
136
  throw 'Missing the required parameter "userId" when calling deleteRoutingUserUtilization';
137
137
  }
138
138
 
@@ -157,7 +157,7 @@ class UsersApi {
157
157
  */
158
158
  deleteUser(userId) {
159
159
  // verify the required parameter 'userId' is set
160
- if (userId === undefined || userId === null) {
160
+ if (userId === undefined || userId === null || userId === '') {
161
161
  throw 'Missing the required parameter "userId" when calling deleteUser';
162
162
  }
163
163
 
@@ -184,15 +184,15 @@ class UsersApi {
184
184
  */
185
185
  deleteUserExternalidAuthorityNameExternalKey(userId, authorityName, externalKey) {
186
186
  // verify the required parameter 'userId' is set
187
- if (userId === undefined || userId === null) {
187
+ if (userId === undefined || userId === null || userId === '') {
188
188
  throw 'Missing the required parameter "userId" when calling deleteUserExternalidAuthorityNameExternalKey';
189
189
  }
190
190
  // verify the required parameter 'authorityName' is set
191
- if (authorityName === undefined || authorityName === null) {
191
+ if (authorityName === undefined || authorityName === null || authorityName === '') {
192
192
  throw 'Missing the required parameter "authorityName" when calling deleteUserExternalidAuthorityNameExternalKey';
193
193
  }
194
194
  // verify the required parameter 'externalKey' is set
195
- if (externalKey === undefined || externalKey === null) {
195
+ if (externalKey === undefined || externalKey === null || externalKey === '') {
196
196
  throw 'Missing the required parameter "externalKey" when calling deleteUserExternalidAuthorityNameExternalKey';
197
197
  }
198
198
 
@@ -218,11 +218,11 @@ class UsersApi {
218
218
  */
219
219
  deleteUserRoutinglanguage(userId, languageId) {
220
220
  // verify the required parameter 'userId' is set
221
- if (userId === undefined || userId === null) {
221
+ if (userId === undefined || userId === null || userId === '') {
222
222
  throw 'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';
223
223
  }
224
224
  // verify the required parameter 'languageId' is set
225
- if (languageId === undefined || languageId === null) {
225
+ if (languageId === undefined || languageId === null || languageId === '') {
226
226
  throw 'Missing the required parameter "languageId" when calling deleteUserRoutinglanguage';
227
227
  }
228
228
 
@@ -248,11 +248,11 @@ class UsersApi {
248
248
  */
249
249
  deleteUserRoutingskill(userId, skillId) {
250
250
  // verify the required parameter 'userId' is set
251
- if (userId === undefined || userId === null) {
251
+ if (userId === undefined || userId === null || userId === '') {
252
252
  throw 'Missing the required parameter "userId" when calling deleteUserRoutingskill';
253
253
  }
254
254
  // verify the required parameter 'skillId' is set
255
- if (skillId === undefined || skillId === null) {
255
+ if (skillId === undefined || skillId === null || skillId === '') {
256
256
  throw 'Missing the required parameter "skillId" when calling deleteUserRoutingskill';
257
257
  }
258
258
 
@@ -277,7 +277,7 @@ class UsersApi {
277
277
  */
278
278
  deleteUserStationAssociatedstation(userId) {
279
279
  // verify the required parameter 'userId' is set
280
- if (userId === undefined || userId === null) {
280
+ if (userId === undefined || userId === null || userId === '') {
281
281
  throw 'Missing the required parameter "userId" when calling deleteUserStationAssociatedstation';
282
282
  }
283
283
 
@@ -302,7 +302,7 @@ class UsersApi {
302
302
  */
303
303
  deleteUserStationDefaultstation(userId) {
304
304
  // verify the required parameter 'userId' is set
305
- if (userId === undefined || userId === null) {
305
+ if (userId === undefined || userId === null || userId === '') {
306
306
  throw 'Missing the required parameter "userId" when calling deleteUserStationDefaultstation';
307
307
  }
308
308
 
@@ -328,11 +328,11 @@ class UsersApi {
328
328
  */
329
329
  deleteUserVerifier(userId, verifierId) {
330
330
  // verify the required parameter 'userId' is set
331
- if (userId === undefined || userId === null) {
331
+ if (userId === undefined || userId === null || userId === '') {
332
332
  throw 'Missing the required parameter "userId" when calling deleteUserVerifier';
333
333
  }
334
334
  // verify the required parameter 'verifierId' is set
335
- if (verifierId === undefined || verifierId === null) {
335
+ if (verifierId === undefined || verifierId === null || verifierId === '') {
336
336
  throw 'Missing the required parameter "verifierId" when calling deleteUserVerifier';
337
337
  }
338
338
 
@@ -358,7 +358,7 @@ class UsersApi {
358
358
  */
359
359
  getAnalyticsUsersAggregatesJob(jobId) {
360
360
  // verify the required parameter 'jobId' is set
361
- if (jobId === undefined || jobId === null) {
361
+ if (jobId === undefined || jobId === null || jobId === '') {
362
362
  throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';
363
363
  }
364
364
 
@@ -388,7 +388,7 @@ class UsersApi {
388
388
  opts = opts || {};
389
389
 
390
390
  // verify the required parameter 'jobId' is set
391
- if (jobId === undefined || jobId === null) {
391
+ if (jobId === undefined || jobId === null || jobId === '') {
392
392
  throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';
393
393
  }
394
394
 
@@ -413,7 +413,7 @@ class UsersApi {
413
413
  */
414
414
  getAnalyticsUsersDetailsJob(jobId) {
415
415
  // verify the required parameter 'jobId' is set
416
- if (jobId === undefined || jobId === null) {
416
+ if (jobId === undefined || jobId === null || jobId === '') {
417
417
  throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';
418
418
  }
419
419
 
@@ -443,7 +443,7 @@ class UsersApi {
443
443
  opts = opts || {};
444
444
 
445
445
  // verify the required parameter 'jobId' is set
446
- if (jobId === undefined || jobId === null) {
446
+ if (jobId === undefined || jobId === null || jobId === '') {
447
447
  throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJobResults';
448
448
  }
449
449
 
@@ -555,7 +555,7 @@ class UsersApi {
555
555
  opts = opts || {};
556
556
 
557
557
  // verify the required parameter 'subjectId' is set
558
- if (subjectId === undefined || subjectId === null) {
558
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
559
559
  throw 'Missing the required parameter "subjectId" when calling getAuthorizationDivisionspermittedPagedSubjectId';
560
560
  }
561
561
  // verify the required parameter 'permission' is set
@@ -588,7 +588,7 @@ class UsersApi {
588
588
  opts = opts || {};
589
589
 
590
590
  // verify the required parameter 'subjectId' is set
591
- if (subjectId === undefined || subjectId === null) {
591
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
592
592
  throw 'Missing the required parameter "subjectId" when calling getAuthorizationSubject';
593
593
  }
594
594
 
@@ -714,7 +714,7 @@ class UsersApi {
714
714
  */
715
715
  getRoutingUserDirectroutingbackupSettings(userId) {
716
716
  // verify the required parameter 'userId' is set
717
- if (userId === undefined || userId === null) {
717
+ if (userId === undefined || userId === null || userId === '') {
718
718
  throw 'Missing the required parameter "userId" when calling getRoutingUserDirectroutingbackupSettings';
719
719
  }
720
720
 
@@ -739,7 +739,7 @@ class UsersApi {
739
739
  */
740
740
  getRoutingUserUtilization(userId) {
741
741
  // verify the required parameter 'userId' is set
742
- if (userId === undefined || userId === null) {
742
+ if (userId === undefined || userId === null || userId === '') {
743
743
  throw 'Missing the required parameter "userId" when calling getRoutingUserUtilization';
744
744
  }
745
745
 
@@ -770,7 +770,7 @@ class UsersApi {
770
770
  opts = opts || {};
771
771
 
772
772
  // verify the required parameter 'userId' is set
773
- if (userId === undefined || userId === null) {
773
+ if (userId === undefined || userId === null || userId === '') {
774
774
  throw 'Missing the required parameter "userId" when calling getUser';
775
775
  }
776
776
 
@@ -799,7 +799,7 @@ class UsersApi {
799
799
  opts = opts || {};
800
800
 
801
801
  // verify the required parameter 'userId' is set
802
- if (userId === undefined || userId === null) {
802
+ if (userId === undefined || userId === null || userId === '') {
803
803
  throw 'Missing the required parameter "userId" when calling getUserAdjacents';
804
804
  }
805
805
 
@@ -824,7 +824,7 @@ class UsersApi {
824
824
  */
825
825
  getUserCallforwarding(userId) {
826
826
  // verify the required parameter 'userId' is set
827
- if (userId === undefined || userId === null) {
827
+ if (userId === undefined || userId === null || userId === '') {
828
828
  throw 'Missing the required parameter "userId" when calling getUserCallforwarding';
829
829
  }
830
830
 
@@ -853,7 +853,7 @@ class UsersApi {
853
853
  opts = opts || {};
854
854
 
855
855
  // verify the required parameter 'userId' is set
856
- if (userId === undefined || userId === null) {
856
+ if (userId === undefined || userId === null || userId === '') {
857
857
  throw 'Missing the required parameter "userId" when calling getUserDirectreports';
858
858
  }
859
859
 
@@ -878,7 +878,7 @@ class UsersApi {
878
878
  */
879
879
  getUserExternalid(userId) {
880
880
  // verify the required parameter 'userId' is set
881
- if (userId === undefined || userId === null) {
881
+ if (userId === undefined || userId === null || userId === '') {
882
882
  throw 'Missing the required parameter "userId" when calling getUserExternalid';
883
883
  }
884
884
 
@@ -904,11 +904,11 @@ class UsersApi {
904
904
  */
905
905
  getUserExternalidAuthorityName(userId, authorityName) {
906
906
  // verify the required parameter 'userId' is set
907
- if (userId === undefined || userId === null) {
907
+ if (userId === undefined || userId === null || userId === '') {
908
908
  throw 'Missing the required parameter "userId" when calling getUserExternalidAuthorityName';
909
909
  }
910
910
  // verify the required parameter 'authorityName' is set
911
- if (authorityName === undefined || authorityName === null) {
911
+ if (authorityName === undefined || authorityName === null || authorityName === '') {
912
912
  throw 'Missing the required parameter "authorityName" when calling getUserExternalidAuthorityName';
913
913
  }
914
914
 
@@ -941,7 +941,7 @@ class UsersApi {
941
941
  opts = opts || {};
942
942
 
943
943
  // verify the required parameter 'userId' is set
944
- if (userId === undefined || userId === null) {
944
+ if (userId === undefined || userId === null || userId === '') {
945
945
  throw 'Missing the required parameter "userId" when calling getUserFavorites';
946
946
  }
947
947
 
@@ -967,11 +967,11 @@ class UsersApi {
967
967
  */
968
968
  getUserGeolocation(userId, clientId) {
969
969
  // verify the required parameter 'userId' is set
970
- if (userId === undefined || userId === null) {
970
+ if (userId === undefined || userId === null || userId === '') {
971
971
  throw 'Missing the required parameter "userId" when calling getUserGeolocation';
972
972
  }
973
973
  // verify the required parameter 'clientId' is set
974
- if (clientId === undefined || clientId === null) {
974
+ if (clientId === undefined || clientId === null || clientId === '') {
975
975
  throw 'Missing the required parameter "clientId" when calling getUserGeolocation';
976
976
  }
977
977
 
@@ -996,7 +996,7 @@ class UsersApi {
996
996
  */
997
997
  getUserOutofoffice(userId) {
998
998
  // verify the required parameter 'userId' is set
999
- if (userId === undefined || userId === null) {
999
+ if (userId === undefined || userId === null || userId === '') {
1000
1000
  throw 'Missing the required parameter "userId" when calling getUserOutofoffice';
1001
1001
  }
1002
1002
 
@@ -1027,7 +1027,7 @@ class UsersApi {
1027
1027
  opts = opts || {};
1028
1028
 
1029
1029
  // verify the required parameter 'userId' is set
1030
- if (userId === undefined || userId === null) {
1030
+ if (userId === undefined || userId === null || userId === '') {
1031
1031
  throw 'Missing the required parameter "userId" when calling getUserProfile';
1032
1032
  }
1033
1033
 
@@ -1052,7 +1052,7 @@ class UsersApi {
1052
1052
  */
1053
1053
  getUserProfileskills(userId) {
1054
1054
  // verify the required parameter 'userId' is set
1055
- if (userId === undefined || userId === null) {
1055
+ if (userId === undefined || userId === null || userId === '') {
1056
1056
  throw 'Missing the required parameter "userId" when calling getUserProfileskills';
1057
1057
  }
1058
1058
 
@@ -1084,7 +1084,7 @@ class UsersApi {
1084
1084
  opts = opts || {};
1085
1085
 
1086
1086
  // verify the required parameter 'userId' is set
1087
- if (userId === undefined || userId === null) {
1087
+ if (userId === undefined || userId === null || userId === '') {
1088
1088
  throw 'Missing the required parameter "userId" when calling getUserQueues';
1089
1089
  }
1090
1090
 
@@ -1109,7 +1109,7 @@ class UsersApi {
1109
1109
  */
1110
1110
  getUserRoles(subjectId) {
1111
1111
  // verify the required parameter 'subjectId' is set
1112
- if (subjectId === undefined || subjectId === null) {
1112
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
1113
1113
  throw 'Missing the required parameter "subjectId" when calling getUserRoles';
1114
1114
  }
1115
1115
 
@@ -1140,7 +1140,7 @@ class UsersApi {
1140
1140
  opts = opts || {};
1141
1141
 
1142
1142
  // verify the required parameter 'userId' is set
1143
- if (userId === undefined || userId === null) {
1143
+ if (userId === undefined || userId === null || userId === '') {
1144
1144
  throw 'Missing the required parameter "userId" when calling getUserRoutinglanguages';
1145
1145
  }
1146
1146
 
@@ -1171,7 +1171,7 @@ class UsersApi {
1171
1171
  opts = opts || {};
1172
1172
 
1173
1173
  // verify the required parameter 'userId' is set
1174
- if (userId === undefined || userId === null) {
1174
+ if (userId === undefined || userId === null || userId === '') {
1175
1175
  throw 'Missing the required parameter "userId" when calling getUserRoutingskills';
1176
1176
  }
1177
1177
 
@@ -1196,7 +1196,7 @@ class UsersApi {
1196
1196
  */
1197
1197
  getUserRoutingstatus(userId) {
1198
1198
  // verify the required parameter 'userId' is set
1199
- if (userId === undefined || userId === null) {
1199
+ if (userId === undefined || userId === null || userId === '') {
1200
1200
  throw 'Missing the required parameter "userId" when calling getUserRoutingstatus';
1201
1201
  }
1202
1202
 
@@ -1227,7 +1227,7 @@ class UsersApi {
1227
1227
  opts = opts || {};
1228
1228
 
1229
1229
  // verify the required parameter 'userId' is set
1230
- if (userId === undefined || userId === null) {
1230
+ if (userId === undefined || userId === null || userId === '') {
1231
1231
  throw 'Missing the required parameter "userId" when calling getUserSkillgroups';
1232
1232
  }
1233
1233
 
@@ -1252,7 +1252,7 @@ class UsersApi {
1252
1252
  */
1253
1253
  getUserState(userId) {
1254
1254
  // verify the required parameter 'userId' is set
1255
- if (userId === undefined || userId === null) {
1255
+ if (userId === undefined || userId === null || userId === '') {
1256
1256
  throw 'Missing the required parameter "userId" when calling getUserState';
1257
1257
  }
1258
1258
 
@@ -1277,7 +1277,7 @@ class UsersApi {
1277
1277
  */
1278
1278
  getUserStation(userId) {
1279
1279
  // verify the required parameter 'userId' is set
1280
- if (userId === undefined || userId === null) {
1280
+ if (userId === undefined || userId === null || userId === '') {
1281
1281
  throw 'Missing the required parameter "userId" when calling getUserStation';
1282
1282
  }
1283
1283
 
@@ -1306,7 +1306,7 @@ class UsersApi {
1306
1306
  opts = opts || {};
1307
1307
 
1308
1308
  // verify the required parameter 'userId' is set
1309
- if (userId === undefined || userId === null) {
1309
+ if (userId === undefined || userId === null || userId === '') {
1310
1310
  throw 'Missing the required parameter "userId" when calling getUserSuperiors';
1311
1311
  }
1312
1312
 
@@ -1336,7 +1336,7 @@ class UsersApi {
1336
1336
  opts = opts || {};
1337
1337
 
1338
1338
  // verify the required parameter 'userId' is set
1339
- if (userId === undefined || userId === null) {
1339
+ if (userId === undefined || userId === null || userId === '') {
1340
1340
  throw 'Missing the required parameter "userId" when calling getUserTrustors';
1341
1341
  }
1342
1342
 
@@ -1361,7 +1361,7 @@ class UsersApi {
1361
1361
  */
1362
1362
  getUserVerifiers(userId) {
1363
1363
  // verify the required parameter 'userId' is set
1364
- if (userId === undefined || userId === null) {
1364
+ if (userId === undefined || userId === null || userId === '') {
1365
1365
  throw 'Missing the required parameter "userId" when calling getUserVerifiers';
1366
1366
  }
1367
1367
 
@@ -1513,7 +1513,7 @@ class UsersApi {
1513
1513
  */
1514
1514
  getUsersDevelopmentActivity(activityId, type) {
1515
1515
  // verify the required parameter 'activityId' is set
1516
- if (activityId === undefined || activityId === null) {
1516
+ if (activityId === undefined || activityId === null || activityId === '') {
1517
1517
  throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
1518
1518
  }
1519
1519
  // verify the required parameter 'type' is set
@@ -1547,11 +1547,11 @@ class UsersApi {
1547
1547
  opts = opts || {};
1548
1548
 
1549
1549
  // verify the required parameter 'authorityName' is set
1550
- if (authorityName === undefined || authorityName === null) {
1550
+ if (authorityName === undefined || authorityName === null || authorityName === '') {
1551
1551
  throw 'Missing the required parameter "authorityName" when calling getUsersExternalidAuthorityNameExternalKey';
1552
1552
  }
1553
1553
  // verify the required parameter 'externalKey' is set
1554
- if (externalKey === undefined || externalKey === null) {
1554
+ if (externalKey === undefined || externalKey === null || externalKey === '') {
1555
1555
  throw 'Missing the required parameter "externalKey" when calling getUsersExternalidAuthorityNameExternalKey';
1556
1556
  }
1557
1557
 
@@ -1594,6 +1594,36 @@ class UsersApi {
1594
1594
  );
1595
1595
  }
1596
1596
 
1597
+ /**
1598
+ * Get list of available users, paged by cursor token, No division filtering available so directory:user:view permission for all divisions is required
1599
+ *
1600
+ * @param {Object} opts Optional parameters
1601
+ * @param {String} opts.cursor Cursor token to retrieve next page
1602
+ * @param {Number} opts.pageSize Page size (default to 25)
1603
+ * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
1604
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
1605
+ * @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
1606
+ * @param {Object} opts.state Only list users of this state (default to active)
1607
+ * getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1608
+ */
1609
+ getUsersQuery(opts) {
1610
+ opts = opts || {};
1611
+
1612
+
1613
+ return this.apiClient.callApi(
1614
+ '/api/v2/users/query',
1615
+ 'GET',
1616
+ { },
1617
+ { 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
1618
+ { },
1619
+ { },
1620
+ null,
1621
+ ['PureCloud OAuth'],
1622
+ ['application/json'],
1623
+ ['application/json']
1624
+ );
1625
+ }
1626
+
1597
1627
  /**
1598
1628
  * Search users using the q64 value returned from a previous search
1599
1629
  *
@@ -1632,7 +1662,7 @@ class UsersApi {
1632
1662
  */
1633
1663
  patchUser(userId, body) {
1634
1664
  // verify the required parameter 'userId' is set
1635
- if (userId === undefined || userId === null) {
1665
+ if (userId === undefined || userId === null || userId === '') {
1636
1666
  throw 'Missing the required parameter "userId" when calling patchUser';
1637
1667
  }
1638
1668
  // verify the required parameter 'body' is set
@@ -1662,7 +1692,7 @@ class UsersApi {
1662
1692
  */
1663
1693
  patchUserCallforwarding(userId, body) {
1664
1694
  // verify the required parameter 'userId' is set
1665
- if (userId === undefined || userId === null) {
1695
+ if (userId === undefined || userId === null || userId === '') {
1666
1696
  throw 'Missing the required parameter "userId" when calling patchUserCallforwarding';
1667
1697
  }
1668
1698
  // verify the required parameter 'body' is set
@@ -1693,11 +1723,11 @@ class UsersApi {
1693
1723
  */
1694
1724
  patchUserGeolocation(userId, clientId, body) {
1695
1725
  // verify the required parameter 'userId' is set
1696
- if (userId === undefined || userId === null) {
1726
+ if (userId === undefined || userId === null || userId === '') {
1697
1727
  throw 'Missing the required parameter "userId" when calling patchUserGeolocation';
1698
1728
  }
1699
1729
  // verify the required parameter 'clientId' is set
1700
- if (clientId === undefined || clientId === null) {
1730
+ if (clientId === undefined || clientId === null || clientId === '') {
1701
1731
  throw 'Missing the required parameter "clientId" when calling patchUserGeolocation';
1702
1732
  }
1703
1733
  // verify the required parameter 'body' is set
@@ -1728,11 +1758,11 @@ class UsersApi {
1728
1758
  */
1729
1759
  patchUserQueue(queueId, userId, body) {
1730
1760
  // verify the required parameter 'queueId' is set
1731
- if (queueId === undefined || queueId === null) {
1761
+ if (queueId === undefined || queueId === null || queueId === '') {
1732
1762
  throw 'Missing the required parameter "queueId" when calling patchUserQueue';
1733
1763
  }
1734
1764
  // verify the required parameter 'userId' is set
1735
- if (userId === undefined || userId === null) {
1765
+ if (userId === undefined || userId === null || userId === '') {
1736
1766
  throw 'Missing the required parameter "userId" when calling patchUserQueue';
1737
1767
  }
1738
1768
  // verify the required parameter 'body' is set
@@ -1766,7 +1796,7 @@ class UsersApi {
1766
1796
  opts = opts || {};
1767
1797
 
1768
1798
  // verify the required parameter 'userId' is set
1769
- if (userId === undefined || userId === null) {
1799
+ if (userId === undefined || userId === null || userId === '') {
1770
1800
  throw 'Missing the required parameter "userId" when calling patchUserQueues';
1771
1801
  }
1772
1802
  // verify the required parameter 'body' is set
@@ -1797,11 +1827,11 @@ class UsersApi {
1797
1827
  */
1798
1828
  patchUserRoutinglanguage(userId, languageId, body) {
1799
1829
  // verify the required parameter 'userId' is set
1800
- if (userId === undefined || userId === null) {
1830
+ if (userId === undefined || userId === null || userId === '') {
1801
1831
  throw 'Missing the required parameter "userId" when calling patchUserRoutinglanguage';
1802
1832
  }
1803
1833
  // verify the required parameter 'languageId' is set
1804
- if (languageId === undefined || languageId === null) {
1834
+ if (languageId === undefined || languageId === null || languageId === '') {
1805
1835
  throw 'Missing the required parameter "languageId" when calling patchUserRoutinglanguage';
1806
1836
  }
1807
1837
  // verify the required parameter 'body' is set
@@ -1831,7 +1861,7 @@ class UsersApi {
1831
1861
  */
1832
1862
  patchUserRoutinglanguagesBulk(userId, body) {
1833
1863
  // verify the required parameter 'userId' is set
1834
- if (userId === undefined || userId === null) {
1864
+ if (userId === undefined || userId === null || userId === '') {
1835
1865
  throw 'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';
1836
1866
  }
1837
1867
  // verify the required parameter 'body' is set
@@ -1861,7 +1891,7 @@ class UsersApi {
1861
1891
  */
1862
1892
  patchUserRoutingskillsBulk(userId, body) {
1863
1893
  // verify the required parameter 'userId' is set
1864
- if (userId === undefined || userId === null) {
1894
+ if (userId === undefined || userId === null || userId === '') {
1865
1895
  throw 'Missing the required parameter "userId" when calling patchUserRoutingskillsBulk';
1866
1896
  }
1867
1897
  // verify the required parameter 'body' is set
@@ -2076,7 +2106,7 @@ class UsersApi {
2076
2106
  opts = opts || {};
2077
2107
 
2078
2108
  // verify the required parameter 'subjectId' is set
2079
- if (subjectId === undefined || subjectId === null) {
2109
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
2080
2110
  throw 'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkadd';
2081
2111
  }
2082
2112
  // verify the required parameter 'body' is set
@@ -2106,7 +2136,7 @@ class UsersApi {
2106
2136
  */
2107
2137
  postAuthorizationSubjectBulkremove(subjectId, body) {
2108
2138
  // verify the required parameter 'subjectId' is set
2109
- if (subjectId === undefined || subjectId === null) {
2139
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
2110
2140
  throw 'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkremove';
2111
2141
  }
2112
2142
  // verify the required parameter 'body' is set
@@ -2140,7 +2170,7 @@ class UsersApi {
2140
2170
  opts = opts || {};
2141
2171
 
2142
2172
  // verify the required parameter 'subjectId' is set
2143
- if (subjectId === undefined || subjectId === null) {
2173
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
2144
2174
  throw 'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkreplace';
2145
2175
  }
2146
2176
  // verify the required parameter 'body' is set
@@ -2175,15 +2205,15 @@ class UsersApi {
2175
2205
  opts = opts || {};
2176
2206
 
2177
2207
  // verify the required parameter 'subjectId' is set
2178
- if (subjectId === undefined || subjectId === null) {
2208
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
2179
2209
  throw 'Missing the required parameter "subjectId" when calling postAuthorizationSubjectDivisionRole';
2180
2210
  }
2181
2211
  // verify the required parameter 'divisionId' is set
2182
- if (divisionId === undefined || divisionId === null) {
2212
+ if (divisionId === undefined || divisionId === null || divisionId === '') {
2183
2213
  throw 'Missing the required parameter "divisionId" when calling postAuthorizationSubjectDivisionRole';
2184
2214
  }
2185
2215
  // verify the required parameter 'roleId' is set
2186
- if (roleId === undefined || roleId === null) {
2216
+ if (roleId === undefined || roleId === null || roleId === '') {
2187
2217
  throw 'Missing the required parameter "roleId" when calling postAuthorizationSubjectDivisionRole';
2188
2218
  }
2189
2219
 
@@ -2209,7 +2239,7 @@ class UsersApi {
2209
2239
  */
2210
2240
  postUserExternalid(userId, body) {
2211
2241
  // verify the required parameter 'userId' is set
2212
- if (userId === undefined || userId === null) {
2242
+ if (userId === undefined || userId === null || userId === '') {
2213
2243
  throw 'Missing the required parameter "userId" when calling postUserExternalid';
2214
2244
  }
2215
2245
  // verify the required parameter 'body' is set
@@ -2242,7 +2272,7 @@ class UsersApi {
2242
2272
  opts = opts || {};
2243
2273
 
2244
2274
  // verify the required parameter 'userId' is set
2245
- if (userId === undefined || userId === null) {
2275
+ if (userId === undefined || userId === null || userId === '') {
2246
2276
  throw 'Missing the required parameter "userId" when calling postUserInvite';
2247
2277
  }
2248
2278
 
@@ -2268,7 +2298,7 @@ class UsersApi {
2268
2298
  */
2269
2299
  postUserPassword(userId, body) {
2270
2300
  // verify the required parameter 'userId' is set
2271
- if (userId === undefined || userId === null) {
2301
+ if (userId === undefined || userId === null || userId === '') {
2272
2302
  throw 'Missing the required parameter "userId" when calling postUserPassword';
2273
2303
  }
2274
2304
  // verify the required parameter 'body' is set
@@ -2298,7 +2328,7 @@ class UsersApi {
2298
2328
  */
2299
2329
  postUserRoutinglanguages(userId, body) {
2300
2330
  // verify the required parameter 'userId' is set
2301
- if (userId === undefined || userId === null) {
2331
+ if (userId === undefined || userId === null || userId === '') {
2302
2332
  throw 'Missing the required parameter "userId" when calling postUserRoutinglanguages';
2303
2333
  }
2304
2334
  // verify the required parameter 'body' is set
@@ -2328,7 +2358,7 @@ class UsersApi {
2328
2358
  */
2329
2359
  postUserRoutingskills(userId, body) {
2330
2360
  // verify the required parameter 'userId' is set
2331
- if (userId === undefined || userId === null) {
2361
+ if (userId === undefined || userId === null || userId === '') {
2332
2362
  throw 'Missing the required parameter "userId" when calling postUserRoutingskills';
2333
2363
  }
2334
2364
  // verify the required parameter 'body' is set
@@ -2560,7 +2590,7 @@ class UsersApi {
2560
2590
  */
2561
2591
  putRoutingUserDirectroutingbackupSettings(userId, body) {
2562
2592
  // verify the required parameter 'userId' is set
2563
- if (userId === undefined || userId === null) {
2593
+ if (userId === undefined || userId === null || userId === '') {
2564
2594
  throw 'Missing the required parameter "userId" when calling putRoutingUserDirectroutingbackupSettings';
2565
2595
  }
2566
2596
  // verify the required parameter 'body' is set
@@ -2590,7 +2620,7 @@ class UsersApi {
2590
2620
  */
2591
2621
  putRoutingUserUtilization(userId, body) {
2592
2622
  // verify the required parameter 'userId' is set
2593
- if (userId === undefined || userId === null) {
2623
+ if (userId === undefined || userId === null || userId === '') {
2594
2624
  throw 'Missing the required parameter "userId" when calling putRoutingUserUtilization';
2595
2625
  }
2596
2626
  // verify the required parameter 'body' is set
@@ -2620,7 +2650,7 @@ class UsersApi {
2620
2650
  */
2621
2651
  putUserCallforwarding(userId, body) {
2622
2652
  // verify the required parameter 'userId' is set
2623
- if (userId === undefined || userId === null) {
2653
+ if (userId === undefined || userId === null || userId === '') {
2624
2654
  throw 'Missing the required parameter "userId" when calling putUserCallforwarding';
2625
2655
  }
2626
2656
  // verify the required parameter 'body' is set
@@ -2650,7 +2680,7 @@ class UsersApi {
2650
2680
  */
2651
2681
  putUserOutofoffice(userId, body) {
2652
2682
  // verify the required parameter 'userId' is set
2653
- if (userId === undefined || userId === null) {
2683
+ if (userId === undefined || userId === null || userId === '') {
2654
2684
  throw 'Missing the required parameter "userId" when calling putUserOutofoffice';
2655
2685
  }
2656
2686
  // verify the required parameter 'body' is set
@@ -2680,7 +2710,7 @@ class UsersApi {
2680
2710
  */
2681
2711
  putUserProfileskills(userId, body) {
2682
2712
  // verify the required parameter 'userId' is set
2683
- if (userId === undefined || userId === null) {
2713
+ if (userId === undefined || userId === null || userId === '') {
2684
2714
  throw 'Missing the required parameter "userId" when calling putUserProfileskills';
2685
2715
  }
2686
2716
  // verify the required parameter 'body' is set
@@ -2710,7 +2740,7 @@ class UsersApi {
2710
2740
  */
2711
2741
  putUserRoles(subjectId, body) {
2712
2742
  // verify the required parameter 'subjectId' is set
2713
- if (subjectId === undefined || subjectId === null) {
2743
+ if (subjectId === undefined || subjectId === null || subjectId === '') {
2714
2744
  throw 'Missing the required parameter "subjectId" when calling putUserRoles';
2715
2745
  }
2716
2746
  // verify the required parameter 'body' is set
@@ -2741,11 +2771,11 @@ class UsersApi {
2741
2771
  */
2742
2772
  putUserRoutingskill(userId, skillId, body) {
2743
2773
  // verify the required parameter 'userId' is set
2744
- if (userId === undefined || userId === null) {
2774
+ if (userId === undefined || userId === null || userId === '') {
2745
2775
  throw 'Missing the required parameter "userId" when calling putUserRoutingskill';
2746
2776
  }
2747
2777
  // verify the required parameter 'skillId' is set
2748
- if (skillId === undefined || skillId === null) {
2778
+ if (skillId === undefined || skillId === null || skillId === '') {
2749
2779
  throw 'Missing the required parameter "skillId" when calling putUserRoutingskill';
2750
2780
  }
2751
2781
  // verify the required parameter 'body' is set
@@ -2775,7 +2805,7 @@ class UsersApi {
2775
2805
  */
2776
2806
  putUserRoutingskillsBulk(userId, body) {
2777
2807
  // verify the required parameter 'userId' is set
2778
- if (userId === undefined || userId === null) {
2808
+ if (userId === undefined || userId === null || userId === '') {
2779
2809
  throw 'Missing the required parameter "userId" when calling putUserRoutingskillsBulk';
2780
2810
  }
2781
2811
  // verify the required parameter 'body' is set
@@ -2805,7 +2835,7 @@ class UsersApi {
2805
2835
  */
2806
2836
  putUserRoutingstatus(userId, body) {
2807
2837
  // verify the required parameter 'userId' is set
2808
- if (userId === undefined || userId === null) {
2838
+ if (userId === undefined || userId === null || userId === '') {
2809
2839
  throw 'Missing the required parameter "userId" when calling putUserRoutingstatus';
2810
2840
  }
2811
2841
  // verify the required parameter 'body' is set
@@ -2835,7 +2865,7 @@ class UsersApi {
2835
2865
  */
2836
2866
  putUserState(userId, body) {
2837
2867
  // verify the required parameter 'userId' is set
2838
- if (userId === undefined || userId === null) {
2868
+ if (userId === undefined || userId === null || userId === '') {
2839
2869
  throw 'Missing the required parameter "userId" when calling putUserState';
2840
2870
  }
2841
2871
  // verify the required parameter 'body' is set
@@ -2865,11 +2895,11 @@ class UsersApi {
2865
2895
  */
2866
2896
  putUserStationAssociatedstationStationId(userId, stationId) {
2867
2897
  // verify the required parameter 'userId' is set
2868
- if (userId === undefined || userId === null) {
2898
+ if (userId === undefined || userId === null || userId === '') {
2869
2899
  throw 'Missing the required parameter "userId" when calling putUserStationAssociatedstationStationId';
2870
2900
  }
2871
2901
  // verify the required parameter 'stationId' is set
2872
- if (stationId === undefined || stationId === null) {
2902
+ if (stationId === undefined || stationId === null || stationId === '') {
2873
2903
  throw 'Missing the required parameter "stationId" when calling putUserStationAssociatedstationStationId';
2874
2904
  }
2875
2905
 
@@ -2895,11 +2925,11 @@ class UsersApi {
2895
2925
  */
2896
2926
  putUserStationDefaultstationStationId(userId, stationId) {
2897
2927
  // verify the required parameter 'userId' is set
2898
- if (userId === undefined || userId === null) {
2928
+ if (userId === undefined || userId === null || userId === '') {
2899
2929
  throw 'Missing the required parameter "userId" when calling putUserStationDefaultstationStationId';
2900
2930
  }
2901
2931
  // verify the required parameter 'stationId' is set
2902
- if (stationId === undefined || stationId === null) {
2932
+ if (stationId === undefined || stationId === null || stationId === '') {
2903
2933
  throw 'Missing the required parameter "stationId" when calling putUserStationDefaultstationStationId';
2904
2934
  }
2905
2935
 
@@ -2926,11 +2956,11 @@ class UsersApi {
2926
2956
  */
2927
2957
  putUserVerifier(userId, verifierId, body) {
2928
2958
  // verify the required parameter 'userId' is set
2929
- if (userId === undefined || userId === null) {
2959
+ if (userId === undefined || userId === null || userId === '') {
2930
2960
  throw 'Missing the required parameter "userId" when calling putUserVerifier';
2931
2961
  }
2932
2962
  // verify the required parameter 'verifierId' is set
2933
- if (verifierId === undefined || verifierId === null) {
2963
+ if (verifierId === undefined || verifierId === null || verifierId === '') {
2934
2964
  throw 'Missing the required parameter "verifierId" when calling putUserVerifier';
2935
2965
  }
2936
2966
  // verify the required parameter 'body' is set