purecloud-platform-client-v2 249.0.0 → 250.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.
- package/README.md +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class UsersApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Users service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,9 +24,13 @@ class UsersApi {
|
|
|
24
24
|
* Delete/cancel an async request for user aggregates
|
|
25
25
|
*
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
30
|
*/
|
|
29
|
-
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
31
|
+
deleteAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
32
|
+
opts = opts || {};
|
|
33
|
+
|
|
30
34
|
// verify the required parameter 'jobId' is set
|
|
31
35
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
32
36
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
@@ -42,7 +46,8 @@ class UsersApi {
|
|
|
42
46
|
null,
|
|
43
47
|
['PureCloud OAuth'],
|
|
44
48
|
['application/json'],
|
|
45
|
-
['application/json']
|
|
49
|
+
['application/json'],
|
|
50
|
+
opts['customHeaders']
|
|
46
51
|
);
|
|
47
52
|
}
|
|
48
53
|
|
|
@@ -50,8 +55,12 @@ class UsersApi {
|
|
|
50
55
|
* Delete/cancel an async request
|
|
51
56
|
*
|
|
52
57
|
* @param {String} jobId jobId
|
|
58
|
+
* @param {Object} opts Optional parameters
|
|
59
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
60
|
*/
|
|
54
|
-
deleteAnalyticsUsersDetailsJob(jobId) {
|
|
61
|
+
deleteAnalyticsUsersDetailsJob(jobId, opts) {
|
|
62
|
+
opts = opts || {};
|
|
63
|
+
|
|
55
64
|
// verify the required parameter 'jobId' is set
|
|
56
65
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
57
66
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersDetailsJob';
|
|
@@ -67,7 +76,8 @@ class UsersApi {
|
|
|
67
76
|
null,
|
|
68
77
|
['PureCloud OAuth'],
|
|
69
78
|
['application/json'],
|
|
70
|
-
['application/json']
|
|
79
|
+
['application/json'],
|
|
80
|
+
opts['customHeaders']
|
|
71
81
|
);
|
|
72
82
|
}
|
|
73
83
|
|
|
@@ -77,8 +87,12 @@ class UsersApi {
|
|
|
77
87
|
* @param {String} subjectId Subject ID (user or group)
|
|
78
88
|
* @param {String} divisionId the id of the division of the grant
|
|
79
89
|
* @param {String} roleId the id of the role of the grant
|
|
90
|
+
* @param {Object} opts Optional parameters
|
|
91
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
80
92
|
*/
|
|
81
|
-
deleteAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId) {
|
|
93
|
+
deleteAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId, opts) {
|
|
94
|
+
opts = opts || {};
|
|
95
|
+
|
|
82
96
|
// verify the required parameter 'subjectId' is set
|
|
83
97
|
if (subjectId === undefined || subjectId === null || subjectId === '') {
|
|
84
98
|
throw 'Missing the required parameter "subjectId" when calling deleteAuthorizationSubjectDivisionRole';
|
|
@@ -102,15 +116,20 @@ class UsersApi {
|
|
|
102
116
|
null,
|
|
103
117
|
['PureCloud OAuth'],
|
|
104
118
|
['application/json'],
|
|
105
|
-
['application/json']
|
|
119
|
+
['application/json'],
|
|
120
|
+
opts['customHeaders']
|
|
106
121
|
);
|
|
107
122
|
}
|
|
108
123
|
|
|
109
124
|
/**
|
|
110
125
|
* Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
|
|
111
126
|
*
|
|
127
|
+
* @param {Object} opts Optional parameters
|
|
128
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
112
129
|
*/
|
|
113
|
-
deleteRoutingDirectroutingbackupSettingsMe() {
|
|
130
|
+
deleteRoutingDirectroutingbackupSettingsMe(opts) {
|
|
131
|
+
opts = opts || {};
|
|
132
|
+
|
|
114
133
|
|
|
115
134
|
return this.apiClient.callApi(
|
|
116
135
|
'/api/v2/routing/directroutingbackup/settings/me',
|
|
@@ -122,7 +141,8 @@ class UsersApi {
|
|
|
122
141
|
null,
|
|
123
142
|
['PureCloud OAuth'],
|
|
124
143
|
['application/json'],
|
|
125
|
-
['application/json']
|
|
144
|
+
['application/json'],
|
|
145
|
+
opts['customHeaders']
|
|
126
146
|
);
|
|
127
147
|
}
|
|
128
148
|
|
|
@@ -130,8 +150,12 @@ class UsersApi {
|
|
|
130
150
|
* Delete the user's Direct Routing Backup settings and revert to the Direct Routing Queue default.
|
|
131
151
|
*
|
|
132
152
|
* @param {String} userId User ID
|
|
153
|
+
* @param {Object} opts Optional parameters
|
|
154
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
133
155
|
*/
|
|
134
|
-
deleteRoutingUserDirectroutingbackupSettings(userId) {
|
|
156
|
+
deleteRoutingUserDirectroutingbackupSettings(userId, opts) {
|
|
157
|
+
opts = opts || {};
|
|
158
|
+
|
|
135
159
|
// verify the required parameter 'userId' is set
|
|
136
160
|
if (userId === undefined || userId === null || userId === '') {
|
|
137
161
|
throw 'Missing the required parameter "userId" when calling deleteRoutingUserDirectroutingbackupSettings';
|
|
@@ -147,7 +171,8 @@ class UsersApi {
|
|
|
147
171
|
null,
|
|
148
172
|
['PureCloud OAuth'],
|
|
149
173
|
['application/json'],
|
|
150
|
-
['application/json']
|
|
174
|
+
['application/json'],
|
|
175
|
+
opts['customHeaders']
|
|
151
176
|
);
|
|
152
177
|
}
|
|
153
178
|
|
|
@@ -155,8 +180,12 @@ class UsersApi {
|
|
|
155
180
|
* Delete the user's max utilization settings and revert to the organization-wide default.
|
|
156
181
|
*
|
|
157
182
|
* @param {String} userId User ID
|
|
183
|
+
* @param {Object} opts Optional parameters
|
|
184
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
158
185
|
*/
|
|
159
|
-
deleteRoutingUserUtilization(userId) {
|
|
186
|
+
deleteRoutingUserUtilization(userId, opts) {
|
|
187
|
+
opts = opts || {};
|
|
188
|
+
|
|
160
189
|
// verify the required parameter 'userId' is set
|
|
161
190
|
if (userId === undefined || userId === null || userId === '') {
|
|
162
191
|
throw 'Missing the required parameter "userId" when calling deleteRoutingUserUtilization';
|
|
@@ -172,7 +201,8 @@ class UsersApi {
|
|
|
172
201
|
null,
|
|
173
202
|
['PureCloud OAuth'],
|
|
174
203
|
['application/json'],
|
|
175
|
-
['application/json']
|
|
204
|
+
['application/json'],
|
|
205
|
+
opts['customHeaders']
|
|
176
206
|
);
|
|
177
207
|
}
|
|
178
208
|
|
|
@@ -180,8 +210,12 @@ class UsersApi {
|
|
|
180
210
|
* Delete user
|
|
181
211
|
*
|
|
182
212
|
* @param {String} userId User ID
|
|
213
|
+
* @param {Object} opts Optional parameters
|
|
214
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
183
215
|
*/
|
|
184
|
-
deleteUser(userId) {
|
|
216
|
+
deleteUser(userId, opts) {
|
|
217
|
+
opts = opts || {};
|
|
218
|
+
|
|
185
219
|
// verify the required parameter 'userId' is set
|
|
186
220
|
if (userId === undefined || userId === null || userId === '') {
|
|
187
221
|
throw 'Missing the required parameter "userId" when calling deleteUser';
|
|
@@ -197,7 +231,8 @@ class UsersApi {
|
|
|
197
231
|
null,
|
|
198
232
|
['PureCloud OAuth'],
|
|
199
233
|
['application/json'],
|
|
200
|
-
['application/json']
|
|
234
|
+
['application/json'],
|
|
235
|
+
opts['customHeaders']
|
|
201
236
|
);
|
|
202
237
|
}
|
|
203
238
|
|
|
@@ -206,9 +241,12 @@ class UsersApi {
|
|
|
206
241
|
*
|
|
207
242
|
* @param {String} userId user ID
|
|
208
243
|
* @param {String} schemaId schemaId
|
|
209
|
-
*
|
|
244
|
+
* @param {Object} opts Optional parameters
|
|
245
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
210
246
|
*/
|
|
211
|
-
deleteUserCustomattribute(userId, schemaId) {
|
|
247
|
+
deleteUserCustomattribute(userId, schemaId, opts) {
|
|
248
|
+
opts = opts || {};
|
|
249
|
+
|
|
212
250
|
// verify the required parameter 'userId' is set
|
|
213
251
|
if (userId === undefined || userId === null || userId === '') {
|
|
214
252
|
throw 'Missing the required parameter "userId" when calling deleteUserCustomattribute';
|
|
@@ -228,7 +266,8 @@ class UsersApi {
|
|
|
228
266
|
null,
|
|
229
267
|
['PureCloud OAuth'],
|
|
230
268
|
['application/json'],
|
|
231
|
-
['application/json']
|
|
269
|
+
['application/json'],
|
|
270
|
+
opts['customHeaders']
|
|
232
271
|
);
|
|
233
272
|
}
|
|
234
273
|
|
|
@@ -238,8 +277,12 @@ class UsersApi {
|
|
|
238
277
|
* @param {String} userId User ID
|
|
239
278
|
* @param {String} authorityName Authority Name
|
|
240
279
|
* @param {String} externalKey External Key
|
|
280
|
+
* @param {Object} opts Optional parameters
|
|
281
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
241
282
|
*/
|
|
242
|
-
deleteUserExternalidAuthorityNameExternalKey(userId, authorityName, externalKey) {
|
|
283
|
+
deleteUserExternalidAuthorityNameExternalKey(userId, authorityName, externalKey, opts) {
|
|
284
|
+
opts = opts || {};
|
|
285
|
+
|
|
243
286
|
// verify the required parameter 'userId' is set
|
|
244
287
|
if (userId === undefined || userId === null || userId === '') {
|
|
245
288
|
throw 'Missing the required parameter "userId" when calling deleteUserExternalidAuthorityNameExternalKey';
|
|
@@ -263,7 +306,8 @@ class UsersApi {
|
|
|
263
306
|
null,
|
|
264
307
|
['PureCloud OAuth'],
|
|
265
308
|
['application/json'],
|
|
266
|
-
['application/json']
|
|
309
|
+
['application/json'],
|
|
310
|
+
opts['customHeaders']
|
|
267
311
|
);
|
|
268
312
|
}
|
|
269
313
|
|
|
@@ -272,8 +316,12 @@ class UsersApi {
|
|
|
272
316
|
*
|
|
273
317
|
* @param {String} userId User ID
|
|
274
318
|
* @param {String} languageId languageId
|
|
319
|
+
* @param {Object} opts Optional parameters
|
|
320
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
275
321
|
*/
|
|
276
|
-
deleteUserRoutinglanguage(userId, languageId) {
|
|
322
|
+
deleteUserRoutinglanguage(userId, languageId, opts) {
|
|
323
|
+
opts = opts || {};
|
|
324
|
+
|
|
277
325
|
// verify the required parameter 'userId' is set
|
|
278
326
|
if (userId === undefined || userId === null || userId === '') {
|
|
279
327
|
throw 'Missing the required parameter "userId" when calling deleteUserRoutinglanguage';
|
|
@@ -293,7 +341,8 @@ class UsersApi {
|
|
|
293
341
|
null,
|
|
294
342
|
['PureCloud OAuth'],
|
|
295
343
|
['application/json'],
|
|
296
|
-
['application/json']
|
|
344
|
+
['application/json'],
|
|
345
|
+
opts['customHeaders']
|
|
297
346
|
);
|
|
298
347
|
}
|
|
299
348
|
|
|
@@ -302,8 +351,12 @@ class UsersApi {
|
|
|
302
351
|
*
|
|
303
352
|
* @param {String} userId User ID
|
|
304
353
|
* @param {String} skillId skillId
|
|
354
|
+
* @param {Object} opts Optional parameters
|
|
355
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
305
356
|
*/
|
|
306
|
-
deleteUserRoutingskill(userId, skillId) {
|
|
357
|
+
deleteUserRoutingskill(userId, skillId, opts) {
|
|
358
|
+
opts = opts || {};
|
|
359
|
+
|
|
307
360
|
// verify the required parameter 'userId' is set
|
|
308
361
|
if (userId === undefined || userId === null || userId === '') {
|
|
309
362
|
throw 'Missing the required parameter "userId" when calling deleteUserRoutingskill';
|
|
@@ -323,7 +376,8 @@ class UsersApi {
|
|
|
323
376
|
null,
|
|
324
377
|
['PureCloud OAuth'],
|
|
325
378
|
['application/json'],
|
|
326
|
-
['application/json']
|
|
379
|
+
['application/json'],
|
|
380
|
+
opts['customHeaders']
|
|
327
381
|
);
|
|
328
382
|
}
|
|
329
383
|
|
|
@@ -331,8 +385,12 @@ class UsersApi {
|
|
|
331
385
|
* Clear associated station
|
|
332
386
|
*
|
|
333
387
|
* @param {String} userId User ID
|
|
388
|
+
* @param {Object} opts Optional parameters
|
|
389
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
334
390
|
*/
|
|
335
|
-
deleteUserStationAssociatedstation(userId) {
|
|
391
|
+
deleteUserStationAssociatedstation(userId, opts) {
|
|
392
|
+
opts = opts || {};
|
|
393
|
+
|
|
336
394
|
// verify the required parameter 'userId' is set
|
|
337
395
|
if (userId === undefined || userId === null || userId === '') {
|
|
338
396
|
throw 'Missing the required parameter "userId" when calling deleteUserStationAssociatedstation';
|
|
@@ -348,7 +406,8 @@ class UsersApi {
|
|
|
348
406
|
null,
|
|
349
407
|
['PureCloud OAuth'],
|
|
350
408
|
['application/json'],
|
|
351
|
-
['application/json']
|
|
409
|
+
['application/json'],
|
|
410
|
+
opts['customHeaders']
|
|
352
411
|
);
|
|
353
412
|
}
|
|
354
413
|
|
|
@@ -356,8 +415,12 @@ class UsersApi {
|
|
|
356
415
|
* Clear default station
|
|
357
416
|
*
|
|
358
417
|
* @param {String} userId User ID
|
|
418
|
+
* @param {Object} opts Optional parameters
|
|
419
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
359
420
|
*/
|
|
360
|
-
deleteUserStationDefaultstation(userId) {
|
|
421
|
+
deleteUserStationDefaultstation(userId, opts) {
|
|
422
|
+
opts = opts || {};
|
|
423
|
+
|
|
361
424
|
// verify the required parameter 'userId' is set
|
|
362
425
|
if (userId === undefined || userId === null || userId === '') {
|
|
363
426
|
throw 'Missing the required parameter "userId" when calling deleteUserStationDefaultstation';
|
|
@@ -373,7 +436,8 @@ class UsersApi {
|
|
|
373
436
|
null,
|
|
374
437
|
['PureCloud OAuth'],
|
|
375
438
|
['application/json'],
|
|
376
|
-
['application/json']
|
|
439
|
+
['application/json'],
|
|
440
|
+
opts['customHeaders']
|
|
377
441
|
);
|
|
378
442
|
}
|
|
379
443
|
|
|
@@ -382,8 +446,12 @@ class UsersApi {
|
|
|
382
446
|
*
|
|
383
447
|
* @param {String} userId User ID
|
|
384
448
|
* @param {String} verifierId Verifier ID
|
|
449
|
+
* @param {Object} opts Optional parameters
|
|
450
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
385
451
|
*/
|
|
386
|
-
deleteUserVerifier(userId, verifierId) {
|
|
452
|
+
deleteUserVerifier(userId, verifierId, opts) {
|
|
453
|
+
opts = opts || {};
|
|
454
|
+
|
|
387
455
|
// verify the required parameter 'userId' is set
|
|
388
456
|
if (userId === undefined || userId === null || userId === '') {
|
|
389
457
|
throw 'Missing the required parameter "userId" when calling deleteUserVerifier';
|
|
@@ -403,7 +471,8 @@ class UsersApi {
|
|
|
403
471
|
null,
|
|
404
472
|
['PureCloud OAuth'],
|
|
405
473
|
['application/json'],
|
|
406
|
-
['application/json']
|
|
474
|
+
['application/json'],
|
|
475
|
+
opts['customHeaders']
|
|
407
476
|
);
|
|
408
477
|
}
|
|
409
478
|
|
|
@@ -411,9 +480,12 @@ class UsersApi {
|
|
|
411
480
|
* Delete a schema
|
|
412
481
|
*
|
|
413
482
|
* @param {String} schemaId Schema ID
|
|
414
|
-
*
|
|
483
|
+
* @param {Object} opts Optional parameters
|
|
484
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
415
485
|
*/
|
|
416
|
-
deleteUsersCustomattributesSchema(schemaId) {
|
|
486
|
+
deleteUsersCustomattributesSchema(schemaId, opts) {
|
|
487
|
+
opts = opts || {};
|
|
488
|
+
|
|
417
489
|
// verify the required parameter 'schemaId' is set
|
|
418
490
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
419
491
|
throw 'Missing the required parameter "schemaId" when calling deleteUsersCustomattributesSchema';
|
|
@@ -429,7 +501,8 @@ class UsersApi {
|
|
|
429
501
|
null,
|
|
430
502
|
['PureCloud OAuth'],
|
|
431
503
|
['application/json'],
|
|
432
|
-
['application/json']
|
|
504
|
+
['application/json'],
|
|
505
|
+
opts['customHeaders']
|
|
433
506
|
);
|
|
434
507
|
}
|
|
435
508
|
|
|
@@ -437,9 +510,13 @@ class UsersApi {
|
|
|
437
510
|
* Get status for async query for user aggregates
|
|
438
511
|
*
|
|
439
512
|
* @param {String} jobId jobId
|
|
513
|
+
* @param {Object} opts Optional parameters
|
|
514
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
440
515
|
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
441
516
|
*/
|
|
442
|
-
getAnalyticsUsersAggregatesJob(jobId) {
|
|
517
|
+
getAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
518
|
+
opts = opts || {};
|
|
519
|
+
|
|
443
520
|
// verify the required parameter 'jobId' is set
|
|
444
521
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
445
522
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';
|
|
@@ -455,7 +532,8 @@ class UsersApi {
|
|
|
455
532
|
null,
|
|
456
533
|
['PureCloud OAuth'],
|
|
457
534
|
['application/json'],
|
|
458
|
-
['application/json']
|
|
535
|
+
['application/json'],
|
|
536
|
+
opts['customHeaders']
|
|
459
537
|
);
|
|
460
538
|
}
|
|
461
539
|
|
|
@@ -465,6 +543,7 @@ class UsersApi {
|
|
|
465
543
|
* @param {String} jobId jobId
|
|
466
544
|
* @param {Object} opts Optional parameters
|
|
467
545
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
546
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
468
547
|
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
469
548
|
*/
|
|
470
549
|
getAnalyticsUsersAggregatesJobResults(jobId, opts) {
|
|
@@ -485,7 +564,8 @@ class UsersApi {
|
|
|
485
564
|
null,
|
|
486
565
|
['PureCloud OAuth'],
|
|
487
566
|
['application/json'],
|
|
488
|
-
['application/json']
|
|
567
|
+
['application/json'],
|
|
568
|
+
opts['customHeaders']
|
|
489
569
|
);
|
|
490
570
|
}
|
|
491
571
|
|
|
@@ -493,8 +573,12 @@ class UsersApi {
|
|
|
493
573
|
* Get status for async query for user details
|
|
494
574
|
*
|
|
495
575
|
* @param {String} jobId jobId
|
|
576
|
+
* @param {Object} opts Optional parameters
|
|
577
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
496
578
|
*/
|
|
497
|
-
getAnalyticsUsersDetailsJob(jobId) {
|
|
579
|
+
getAnalyticsUsersDetailsJob(jobId, opts) {
|
|
580
|
+
opts = opts || {};
|
|
581
|
+
|
|
498
582
|
// verify the required parameter 'jobId' is set
|
|
499
583
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
500
584
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';
|
|
@@ -510,7 +594,8 @@ class UsersApi {
|
|
|
510
594
|
null,
|
|
511
595
|
['PureCloud OAuth'],
|
|
512
596
|
['application/json'],
|
|
513
|
-
['application/json']
|
|
597
|
+
['application/json'],
|
|
598
|
+
opts['customHeaders']
|
|
514
599
|
);
|
|
515
600
|
}
|
|
516
601
|
|
|
@@ -521,6 +606,7 @@ class UsersApi {
|
|
|
521
606
|
* @param {Object} opts Optional parameters
|
|
522
607
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
523
608
|
* @param {Number} opts.pageSize The desired maximum number of results
|
|
609
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
524
610
|
*/
|
|
525
611
|
getAnalyticsUsersDetailsJobResults(jobId, opts) {
|
|
526
612
|
opts = opts || {};
|
|
@@ -540,15 +626,20 @@ class UsersApi {
|
|
|
540
626
|
null,
|
|
541
627
|
['PureCloud OAuth'],
|
|
542
628
|
['application/json'],
|
|
543
|
-
['application/json']
|
|
629
|
+
['application/json'],
|
|
630
|
+
opts['customHeaders']
|
|
544
631
|
);
|
|
545
632
|
}
|
|
546
633
|
|
|
547
634
|
/**
|
|
548
635
|
* Lookup the datalake availability date and time
|
|
549
636
|
*
|
|
637
|
+
* @param {Object} opts Optional parameters
|
|
638
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
550
639
|
*/
|
|
551
|
-
getAnalyticsUsersDetailsJobsAvailability() {
|
|
640
|
+
getAnalyticsUsersDetailsJobsAvailability(opts) {
|
|
641
|
+
opts = opts || {};
|
|
642
|
+
|
|
552
643
|
|
|
553
644
|
return this.apiClient.callApi(
|
|
554
645
|
'/api/v2/analytics/users/details/jobs/availability',
|
|
@@ -560,7 +651,8 @@ class UsersApi {
|
|
|
560
651
|
null,
|
|
561
652
|
['PureCloud OAuth'],
|
|
562
653
|
['application/json'],
|
|
563
|
-
['application/json']
|
|
654
|
+
['application/json'],
|
|
655
|
+
opts['customHeaders']
|
|
564
656
|
);
|
|
565
657
|
}
|
|
566
658
|
|
|
@@ -570,6 +662,7 @@ class UsersApi {
|
|
|
570
662
|
* @param {String} permission The permission string, including the object to access, e.g. routing:queue:view
|
|
571
663
|
* @param {Object} opts Optional parameters
|
|
572
664
|
* @param {String} opts.name Search term to filter by division name
|
|
665
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
573
666
|
* @deprecated
|
|
574
667
|
*/
|
|
575
668
|
getAuthorizationDivisionspermittedMe(permission, opts) {
|
|
@@ -590,7 +683,8 @@ class UsersApi {
|
|
|
590
683
|
null,
|
|
591
684
|
['PureCloud OAuth'],
|
|
592
685
|
['application/json'],
|
|
593
|
-
['application/json']
|
|
686
|
+
['application/json'],
|
|
687
|
+
opts['customHeaders']
|
|
594
688
|
);
|
|
595
689
|
}
|
|
596
690
|
|
|
@@ -601,6 +695,7 @@ class UsersApi {
|
|
|
601
695
|
* @param {Object} opts Optional parameters
|
|
602
696
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
603
697
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
698
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
604
699
|
*/
|
|
605
700
|
getAuthorizationDivisionspermittedPagedMe(permission, opts) {
|
|
606
701
|
opts = opts || {};
|
|
@@ -620,7 +715,8 @@ class UsersApi {
|
|
|
620
715
|
null,
|
|
621
716
|
['PureCloud OAuth'],
|
|
622
717
|
['application/json'],
|
|
623
|
-
['application/json']
|
|
718
|
+
['application/json'],
|
|
719
|
+
opts['customHeaders']
|
|
624
720
|
);
|
|
625
721
|
}
|
|
626
722
|
|
|
@@ -632,6 +728,7 @@ class UsersApi {
|
|
|
632
728
|
* @param {Object} opts Optional parameters
|
|
633
729
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
634
730
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
731
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
635
732
|
* @deprecated
|
|
636
733
|
*/
|
|
637
734
|
getAuthorizationDivisionspermittedPagedSubjectId(subjectId, permission, opts) {
|
|
@@ -656,7 +753,8 @@ class UsersApi {
|
|
|
656
753
|
null,
|
|
657
754
|
['PureCloud OAuth'],
|
|
658
755
|
['application/json'],
|
|
659
|
-
['application/json']
|
|
756
|
+
['application/json'],
|
|
757
|
+
opts['customHeaders']
|
|
660
758
|
);
|
|
661
759
|
}
|
|
662
760
|
|
|
@@ -666,6 +764,7 @@ class UsersApi {
|
|
|
666
764
|
* @param {String} subjectId Subject ID (user or group)
|
|
667
765
|
* @param {Object} opts Optional parameters
|
|
668
766
|
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
767
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
669
768
|
*/
|
|
670
769
|
getAuthorizationSubject(subjectId, opts) {
|
|
671
770
|
opts = opts || {};
|
|
@@ -685,7 +784,8 @@ class UsersApi {
|
|
|
685
784
|
null,
|
|
686
785
|
['PureCloud OAuth'],
|
|
687
786
|
['application/json'],
|
|
688
|
-
['application/json']
|
|
787
|
+
['application/json'],
|
|
788
|
+
opts['customHeaders']
|
|
689
789
|
);
|
|
690
790
|
}
|
|
691
791
|
|
|
@@ -694,6 +794,7 @@ class UsersApi {
|
|
|
694
794
|
*
|
|
695
795
|
* @param {Object} opts Optional parameters
|
|
696
796
|
* @param {Object} opts.includeDuplicates Include multiple entries with the same role and division but different subjects (default to false)
|
|
797
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
697
798
|
*/
|
|
698
799
|
getAuthorizationSubjectsMe(opts) {
|
|
699
800
|
opts = opts || {};
|
|
@@ -709,7 +810,8 @@ class UsersApi {
|
|
|
709
810
|
null,
|
|
710
811
|
['PureCloud OAuth'],
|
|
711
812
|
['application/json'],
|
|
712
|
-
['application/json']
|
|
813
|
+
['application/json'],
|
|
814
|
+
opts['customHeaders']
|
|
713
815
|
);
|
|
714
816
|
}
|
|
715
817
|
|
|
@@ -717,9 +819,13 @@ class UsersApi {
|
|
|
717
819
|
* Fetch field config for an entity type
|
|
718
820
|
*
|
|
719
821
|
* @param {Object} type Field type
|
|
822
|
+
* @param {Object} opts Optional parameters
|
|
823
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
720
824
|
* @deprecated
|
|
721
825
|
*/
|
|
722
|
-
getFieldconfig(type) {
|
|
826
|
+
getFieldconfig(type, opts) {
|
|
827
|
+
opts = opts || {};
|
|
828
|
+
|
|
723
829
|
// verify the required parameter 'type' is set
|
|
724
830
|
if (type === undefined || type === null) {
|
|
725
831
|
throw 'Missing the required parameter "type" when calling getFieldconfig';
|
|
@@ -735,7 +841,8 @@ class UsersApi {
|
|
|
735
841
|
null,
|
|
736
842
|
['PureCloud OAuth'],
|
|
737
843
|
['application/json'],
|
|
738
|
-
['application/json']
|
|
844
|
+
['application/json'],
|
|
845
|
+
opts['customHeaders']
|
|
739
846
|
);
|
|
740
847
|
}
|
|
741
848
|
|
|
@@ -750,6 +857,7 @@ class UsersApi {
|
|
|
750
857
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
751
858
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
752
859
|
* @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.
|
|
860
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
753
861
|
* @deprecated
|
|
754
862
|
*/
|
|
755
863
|
getProfilesUsers(opts) {
|
|
@@ -766,15 +874,20 @@ class UsersApi {
|
|
|
766
874
|
null,
|
|
767
875
|
['PureCloud OAuth'],
|
|
768
876
|
['application/json'],
|
|
769
|
-
['application/json']
|
|
877
|
+
['application/json'],
|
|
878
|
+
opts['customHeaders']
|
|
770
879
|
);
|
|
771
880
|
}
|
|
772
881
|
|
|
773
882
|
/**
|
|
774
883
|
* Get the user's Direct Routing Backup settings.
|
|
775
884
|
*
|
|
885
|
+
* @param {Object} opts Optional parameters
|
|
886
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
776
887
|
*/
|
|
777
|
-
getRoutingDirectroutingbackupSettingsMe() {
|
|
888
|
+
getRoutingDirectroutingbackupSettingsMe(opts) {
|
|
889
|
+
opts = opts || {};
|
|
890
|
+
|
|
778
891
|
|
|
779
892
|
return this.apiClient.callApi(
|
|
780
893
|
'/api/v2/routing/directroutingbackup/settings/me',
|
|
@@ -786,7 +899,8 @@ class UsersApi {
|
|
|
786
899
|
null,
|
|
787
900
|
['PureCloud OAuth'],
|
|
788
901
|
['application/json'],
|
|
789
|
-
['application/json']
|
|
902
|
+
['application/json'],
|
|
903
|
+
opts['customHeaders']
|
|
790
904
|
);
|
|
791
905
|
}
|
|
792
906
|
|
|
@@ -794,8 +908,12 @@ class UsersApi {
|
|
|
794
908
|
* Get the user's Direct Routing Backup settings.
|
|
795
909
|
*
|
|
796
910
|
* @param {String} userId User ID
|
|
911
|
+
* @param {Object} opts Optional parameters
|
|
912
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
797
913
|
*/
|
|
798
|
-
getRoutingUserDirectroutingbackupSettings(userId) {
|
|
914
|
+
getRoutingUserDirectroutingbackupSettings(userId, opts) {
|
|
915
|
+
opts = opts || {};
|
|
916
|
+
|
|
799
917
|
// verify the required parameter 'userId' is set
|
|
800
918
|
if (userId === undefined || userId === null || userId === '') {
|
|
801
919
|
throw 'Missing the required parameter "userId" when calling getRoutingUserDirectroutingbackupSettings';
|
|
@@ -811,7 +929,8 @@ class UsersApi {
|
|
|
811
929
|
null,
|
|
812
930
|
['PureCloud OAuth'],
|
|
813
931
|
['application/json'],
|
|
814
|
-
['application/json']
|
|
932
|
+
['application/json'],
|
|
933
|
+
opts['customHeaders']
|
|
815
934
|
);
|
|
816
935
|
}
|
|
817
936
|
|
|
@@ -819,8 +938,12 @@ class UsersApi {
|
|
|
819
938
|
* Get the user's max utilization settings. If not configured, the organization-wide default is returned.
|
|
820
939
|
*
|
|
821
940
|
* @param {String} userId User ID
|
|
941
|
+
* @param {Object} opts Optional parameters
|
|
942
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
822
943
|
*/
|
|
823
|
-
getRoutingUserUtilization(userId) {
|
|
944
|
+
getRoutingUserUtilization(userId, opts) {
|
|
945
|
+
opts = opts || {};
|
|
946
|
+
|
|
824
947
|
// verify the required parameter 'userId' is set
|
|
825
948
|
if (userId === undefined || userId === null || userId === '') {
|
|
826
949
|
throw 'Missing the required parameter "userId" when calling getRoutingUserUtilization';
|
|
@@ -836,7 +959,8 @@ class UsersApi {
|
|
|
836
959
|
null,
|
|
837
960
|
['PureCloud OAuth'],
|
|
838
961
|
['application/json'],
|
|
839
|
-
['application/json']
|
|
962
|
+
['application/json'],
|
|
963
|
+
opts['customHeaders']
|
|
840
964
|
);
|
|
841
965
|
}
|
|
842
966
|
|
|
@@ -847,7 +971,9 @@ class UsersApi {
|
|
|
847
971
|
* @param {Object} opts Optional parameters
|
|
848
972
|
* @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.
|
|
849
973
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
974
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 100
|
|
850
975
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
976
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
851
977
|
*/
|
|
852
978
|
getUser(userId, opts) {
|
|
853
979
|
opts = opts || {};
|
|
@@ -861,13 +987,14 @@ class UsersApi {
|
|
|
861
987
|
'/api/v2/users/{userId}',
|
|
862
988
|
'GET',
|
|
863
989
|
{ 'userId': userId },
|
|
864
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
990
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi'),'state': opts['state'] },
|
|
865
991
|
{ },
|
|
866
992
|
{ },
|
|
867
993
|
null,
|
|
868
994
|
['PureCloud OAuth'],
|
|
869
995
|
['application/json'],
|
|
870
|
-
['application/json']
|
|
996
|
+
['application/json'],
|
|
997
|
+
opts['customHeaders']
|
|
871
998
|
);
|
|
872
999
|
}
|
|
873
1000
|
|
|
@@ -877,6 +1004,7 @@ class UsersApi {
|
|
|
877
1004
|
* @param {String} userId User ID
|
|
878
1005
|
* @param {Object} opts Optional parameters
|
|
879
1006
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1007
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
880
1008
|
*/
|
|
881
1009
|
getUserAdjacents(userId, opts) {
|
|
882
1010
|
opts = opts || {};
|
|
@@ -896,7 +1024,8 @@ class UsersApi {
|
|
|
896
1024
|
null,
|
|
897
1025
|
['PureCloud OAuth'],
|
|
898
1026
|
['application/json'],
|
|
899
|
-
['application/json']
|
|
1027
|
+
['application/json'],
|
|
1028
|
+
opts['customHeaders']
|
|
900
1029
|
);
|
|
901
1030
|
}
|
|
902
1031
|
|
|
@@ -904,8 +1033,12 @@ class UsersApi {
|
|
|
904
1033
|
* Get a user's CallForwarding
|
|
905
1034
|
*
|
|
906
1035
|
* @param {String} userId User ID
|
|
1036
|
+
* @param {Object} opts Optional parameters
|
|
1037
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
907
1038
|
*/
|
|
908
|
-
getUserCallforwarding(userId) {
|
|
1039
|
+
getUserCallforwarding(userId, opts) {
|
|
1040
|
+
opts = opts || {};
|
|
1041
|
+
|
|
909
1042
|
// verify the required parameter 'userId' is set
|
|
910
1043
|
if (userId === undefined || userId === null || userId === '') {
|
|
911
1044
|
throw 'Missing the required parameter "userId" when calling getUserCallforwarding';
|
|
@@ -921,7 +1054,8 @@ class UsersApi {
|
|
|
921
1054
|
null,
|
|
922
1055
|
['PureCloud OAuth'],
|
|
923
1056
|
['application/json'],
|
|
924
|
-
['application/json']
|
|
1057
|
+
['application/json'],
|
|
1058
|
+
opts['customHeaders']
|
|
925
1059
|
);
|
|
926
1060
|
}
|
|
927
1061
|
|
|
@@ -930,9 +1064,12 @@ class UsersApi {
|
|
|
930
1064
|
*
|
|
931
1065
|
* @param {String} userId user ID
|
|
932
1066
|
* @param {String} schemaId schemaId
|
|
933
|
-
*
|
|
1067
|
+
* @param {Object} opts Optional parameters
|
|
1068
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
934
1069
|
*/
|
|
935
|
-
getUserCustomattribute(userId, schemaId) {
|
|
1070
|
+
getUserCustomattribute(userId, schemaId, opts) {
|
|
1071
|
+
opts = opts || {};
|
|
1072
|
+
|
|
936
1073
|
// verify the required parameter 'userId' is set
|
|
937
1074
|
if (userId === undefined || userId === null || userId === '') {
|
|
938
1075
|
throw 'Missing the required parameter "userId" when calling getUserCustomattribute';
|
|
@@ -952,7 +1089,8 @@ class UsersApi {
|
|
|
952
1089
|
null,
|
|
953
1090
|
['PureCloud OAuth'],
|
|
954
1091
|
['application/json'],
|
|
955
|
-
['application/json']
|
|
1092
|
+
['application/json'],
|
|
1093
|
+
opts['customHeaders']
|
|
956
1094
|
);
|
|
957
1095
|
}
|
|
958
1096
|
|
|
@@ -961,9 +1099,12 @@ class UsersApi {
|
|
|
961
1099
|
*
|
|
962
1100
|
* @param {String} userId user ID
|
|
963
1101
|
* @param {Array.<String>} schemaIds
|
|
964
|
-
*
|
|
1102
|
+
* @param {Object} opts Optional parameters
|
|
1103
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
965
1104
|
*/
|
|
966
|
-
getUserCustomattributesBulk(userId, schemaIds) {
|
|
1105
|
+
getUserCustomattributesBulk(userId, schemaIds, opts) {
|
|
1106
|
+
opts = opts || {};
|
|
1107
|
+
|
|
967
1108
|
// verify the required parameter 'userId' is set
|
|
968
1109
|
if (userId === undefined || userId === null || userId === '') {
|
|
969
1110
|
throw 'Missing the required parameter "userId" when calling getUserCustomattributesBulk';
|
|
@@ -983,7 +1124,8 @@ class UsersApi {
|
|
|
983
1124
|
null,
|
|
984
1125
|
['PureCloud OAuth'],
|
|
985
1126
|
['application/json'],
|
|
986
|
-
['application/json']
|
|
1127
|
+
['application/json'],
|
|
1128
|
+
opts['customHeaders']
|
|
987
1129
|
);
|
|
988
1130
|
}
|
|
989
1131
|
|
|
@@ -993,6 +1135,7 @@ class UsersApi {
|
|
|
993
1135
|
* @param {String} userId User ID
|
|
994
1136
|
* @param {Object} opts Optional parameters
|
|
995
1137
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1138
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
996
1139
|
*/
|
|
997
1140
|
getUserDirectreports(userId, opts) {
|
|
998
1141
|
opts = opts || {};
|
|
@@ -1012,7 +1155,8 @@ class UsersApi {
|
|
|
1012
1155
|
null,
|
|
1013
1156
|
['PureCloud OAuth'],
|
|
1014
1157
|
['application/json'],
|
|
1015
|
-
['application/json']
|
|
1158
|
+
['application/json'],
|
|
1159
|
+
opts['customHeaders']
|
|
1016
1160
|
);
|
|
1017
1161
|
}
|
|
1018
1162
|
|
|
@@ -1020,8 +1164,12 @@ class UsersApi {
|
|
|
1020
1164
|
* Get the external identifiers for a user.
|
|
1021
1165
|
*
|
|
1022
1166
|
* @param {String} userId User ID
|
|
1167
|
+
* @param {Object} opts Optional parameters
|
|
1168
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1023
1169
|
*/
|
|
1024
|
-
getUserExternalid(userId) {
|
|
1170
|
+
getUserExternalid(userId, opts) {
|
|
1171
|
+
opts = opts || {};
|
|
1172
|
+
|
|
1025
1173
|
// verify the required parameter 'userId' is set
|
|
1026
1174
|
if (userId === undefined || userId === null || userId === '') {
|
|
1027
1175
|
throw 'Missing the required parameter "userId" when calling getUserExternalid';
|
|
@@ -1037,7 +1185,8 @@ class UsersApi {
|
|
|
1037
1185
|
null,
|
|
1038
1186
|
['PureCloud OAuth'],
|
|
1039
1187
|
['application/json'],
|
|
1040
|
-
['application/json']
|
|
1188
|
+
['application/json'],
|
|
1189
|
+
opts['customHeaders']
|
|
1041
1190
|
);
|
|
1042
1191
|
}
|
|
1043
1192
|
|
|
@@ -1046,8 +1195,12 @@ class UsersApi {
|
|
|
1046
1195
|
* Authority name and external key are case sensitive.
|
|
1047
1196
|
* @param {String} userId User ID
|
|
1048
1197
|
* @param {String} authorityName Authority Name
|
|
1198
|
+
* @param {Object} opts Optional parameters
|
|
1199
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1049
1200
|
*/
|
|
1050
|
-
getUserExternalidAuthorityName(userId, authorityName) {
|
|
1201
|
+
getUserExternalidAuthorityName(userId, authorityName, opts) {
|
|
1202
|
+
opts = opts || {};
|
|
1203
|
+
|
|
1051
1204
|
// verify the required parameter 'userId' is set
|
|
1052
1205
|
if (userId === undefined || userId === null || userId === '') {
|
|
1053
1206
|
throw 'Missing the required parameter "userId" when calling getUserExternalidAuthorityName';
|
|
@@ -1067,7 +1220,8 @@ class UsersApi {
|
|
|
1067
1220
|
null,
|
|
1068
1221
|
['PureCloud OAuth'],
|
|
1069
1222
|
['application/json'],
|
|
1070
|
-
['application/json']
|
|
1223
|
+
['application/json'],
|
|
1224
|
+
opts['customHeaders']
|
|
1071
1225
|
);
|
|
1072
1226
|
}
|
|
1073
1227
|
|
|
@@ -1080,6 +1234,7 @@ class UsersApi {
|
|
|
1080
1234
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1081
1235
|
* @param {String} opts.sortOrder Sort order (default to ASC)
|
|
1082
1236
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1237
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1083
1238
|
* @deprecated
|
|
1084
1239
|
*/
|
|
1085
1240
|
getUserFavorites(userId, opts) {
|
|
@@ -1100,7 +1255,8 @@ class UsersApi {
|
|
|
1100
1255
|
null,
|
|
1101
1256
|
['PureCloud OAuth'],
|
|
1102
1257
|
['application/json'],
|
|
1103
|
-
['application/json']
|
|
1258
|
+
['application/json'],
|
|
1259
|
+
opts['customHeaders']
|
|
1104
1260
|
);
|
|
1105
1261
|
}
|
|
1106
1262
|
|
|
@@ -1109,8 +1265,12 @@ class UsersApi {
|
|
|
1109
1265
|
*
|
|
1110
1266
|
* @param {String} userId user Id
|
|
1111
1267
|
* @param {String} clientId client Id
|
|
1268
|
+
* @param {Object} opts Optional parameters
|
|
1269
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1112
1270
|
*/
|
|
1113
|
-
getUserGeolocation(userId, clientId) {
|
|
1271
|
+
getUserGeolocation(userId, clientId, opts) {
|
|
1272
|
+
opts = opts || {};
|
|
1273
|
+
|
|
1114
1274
|
// verify the required parameter 'userId' is set
|
|
1115
1275
|
if (userId === undefined || userId === null || userId === '') {
|
|
1116
1276
|
throw 'Missing the required parameter "userId" when calling getUserGeolocation';
|
|
@@ -1130,7 +1290,8 @@ class UsersApi {
|
|
|
1130
1290
|
null,
|
|
1131
1291
|
['PureCloud OAuth'],
|
|
1132
1292
|
['application/json'],
|
|
1133
|
-
['application/json']
|
|
1293
|
+
['application/json'],
|
|
1294
|
+
opts['customHeaders']
|
|
1134
1295
|
);
|
|
1135
1296
|
}
|
|
1136
1297
|
|
|
@@ -1138,8 +1299,12 @@ class UsersApi {
|
|
|
1138
1299
|
* Get a OutOfOffice
|
|
1139
1300
|
*
|
|
1140
1301
|
* @param {String} userId User ID
|
|
1302
|
+
* @param {Object} opts Optional parameters
|
|
1303
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1141
1304
|
*/
|
|
1142
|
-
getUserOutofoffice(userId) {
|
|
1305
|
+
getUserOutofoffice(userId, opts) {
|
|
1306
|
+
opts = opts || {};
|
|
1307
|
+
|
|
1143
1308
|
// verify the required parameter 'userId' is set
|
|
1144
1309
|
if (userId === undefined || userId === null || userId === '') {
|
|
1145
1310
|
throw 'Missing the required parameter "userId" when calling getUserOutofoffice';
|
|
@@ -1155,7 +1320,8 @@ class UsersApi {
|
|
|
1155
1320
|
null,
|
|
1156
1321
|
['PureCloud OAuth'],
|
|
1157
1322
|
['application/json'],
|
|
1158
|
-
['application/json']
|
|
1323
|
+
['application/json'],
|
|
1324
|
+
opts['customHeaders']
|
|
1159
1325
|
);
|
|
1160
1326
|
}
|
|
1161
1327
|
|
|
@@ -1166,6 +1332,7 @@ class UsersApi {
|
|
|
1166
1332
|
* @param {Object} opts Optional parameters
|
|
1167
1333
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1168
1334
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
1335
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1169
1336
|
* @deprecated
|
|
1170
1337
|
*/
|
|
1171
1338
|
getUserProfile(userId, opts) {
|
|
@@ -1186,7 +1353,8 @@ class UsersApi {
|
|
|
1186
1353
|
null,
|
|
1187
1354
|
['PureCloud OAuth'],
|
|
1188
1355
|
['application/json'],
|
|
1189
|
-
['application/json']
|
|
1356
|
+
['application/json'],
|
|
1357
|
+
opts['customHeaders']
|
|
1190
1358
|
);
|
|
1191
1359
|
}
|
|
1192
1360
|
|
|
@@ -1194,8 +1362,12 @@ class UsersApi {
|
|
|
1194
1362
|
* List profile skills for a user
|
|
1195
1363
|
*
|
|
1196
1364
|
* @param {String} userId User ID
|
|
1365
|
+
* @param {Object} opts Optional parameters
|
|
1366
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1197
1367
|
*/
|
|
1198
|
-
getUserProfileskills(userId) {
|
|
1368
|
+
getUserProfileskills(userId, opts) {
|
|
1369
|
+
opts = opts || {};
|
|
1370
|
+
|
|
1199
1371
|
// verify the required parameter 'userId' is set
|
|
1200
1372
|
if (userId === undefined || userId === null || userId === '') {
|
|
1201
1373
|
throw 'Missing the required parameter "userId" when calling getUserProfileskills';
|
|
@@ -1211,7 +1383,8 @@ class UsersApi {
|
|
|
1211
1383
|
null,
|
|
1212
1384
|
['PureCloud OAuth'],
|
|
1213
1385
|
['application/json'],
|
|
1214
|
-
['application/json']
|
|
1386
|
+
['application/json'],
|
|
1387
|
+
opts['customHeaders']
|
|
1215
1388
|
);
|
|
1216
1389
|
}
|
|
1217
1390
|
|
|
@@ -1224,6 +1397,7 @@ class UsersApi {
|
|
|
1224
1397
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1225
1398
|
* @param {Boolean} opts.joined Is joined to the queue (default to true)
|
|
1226
1399
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
1400
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1227
1401
|
*/
|
|
1228
1402
|
getUserQueues(userId, opts) {
|
|
1229
1403
|
opts = opts || {};
|
|
@@ -1243,7 +1417,8 @@ class UsersApi {
|
|
|
1243
1417
|
null,
|
|
1244
1418
|
['PureCloud OAuth'],
|
|
1245
1419
|
['application/json'],
|
|
1246
|
-
['application/json']
|
|
1420
|
+
['application/json'],
|
|
1421
|
+
opts['customHeaders']
|
|
1247
1422
|
);
|
|
1248
1423
|
}
|
|
1249
1424
|
|
|
@@ -1251,8 +1426,12 @@ class UsersApi {
|
|
|
1251
1426
|
* Returns a listing of roles and permissions for a user.
|
|
1252
1427
|
*
|
|
1253
1428
|
* @param {String} subjectId User ID
|
|
1429
|
+
* @param {Object} opts Optional parameters
|
|
1430
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1254
1431
|
*/
|
|
1255
|
-
getUserRoles(subjectId) {
|
|
1432
|
+
getUserRoles(subjectId, opts) {
|
|
1433
|
+
opts = opts || {};
|
|
1434
|
+
|
|
1256
1435
|
// verify the required parameter 'subjectId' is set
|
|
1257
1436
|
if (subjectId === undefined || subjectId === null || subjectId === '') {
|
|
1258
1437
|
throw 'Missing the required parameter "subjectId" when calling getUserRoles';
|
|
@@ -1268,7 +1447,8 @@ class UsersApi {
|
|
|
1268
1447
|
null,
|
|
1269
1448
|
['PureCloud OAuth'],
|
|
1270
1449
|
['application/json'],
|
|
1271
|
-
['application/json']
|
|
1450
|
+
['application/json'],
|
|
1451
|
+
opts['customHeaders']
|
|
1272
1452
|
);
|
|
1273
1453
|
}
|
|
1274
1454
|
|
|
@@ -1280,6 +1460,7 @@ class UsersApi {
|
|
|
1280
1460
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1281
1461
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1282
1462
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
1463
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1283
1464
|
*/
|
|
1284
1465
|
getUserRoutinglanguages(userId, opts) {
|
|
1285
1466
|
opts = opts || {};
|
|
@@ -1299,7 +1480,8 @@ class UsersApi {
|
|
|
1299
1480
|
null,
|
|
1300
1481
|
['PureCloud OAuth'],
|
|
1301
1482
|
['application/json'],
|
|
1302
|
-
['application/json']
|
|
1483
|
+
['application/json'],
|
|
1484
|
+
opts['customHeaders']
|
|
1303
1485
|
);
|
|
1304
1486
|
}
|
|
1305
1487
|
|
|
@@ -1311,6 +1493,7 @@ class UsersApi {
|
|
|
1311
1493
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1312
1494
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1313
1495
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
1496
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1314
1497
|
*/
|
|
1315
1498
|
getUserRoutingskills(userId, opts) {
|
|
1316
1499
|
opts = opts || {};
|
|
@@ -1330,7 +1513,8 @@ class UsersApi {
|
|
|
1330
1513
|
null,
|
|
1331
1514
|
['PureCloud OAuth'],
|
|
1332
1515
|
['application/json'],
|
|
1333
|
-
['application/json']
|
|
1516
|
+
['application/json'],
|
|
1517
|
+
opts['customHeaders']
|
|
1334
1518
|
);
|
|
1335
1519
|
}
|
|
1336
1520
|
|
|
@@ -1338,8 +1522,12 @@ class UsersApi {
|
|
|
1338
1522
|
* Fetch the routing status of a user
|
|
1339
1523
|
*
|
|
1340
1524
|
* @param {String} userId User ID
|
|
1525
|
+
* @param {Object} opts Optional parameters
|
|
1526
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1341
1527
|
*/
|
|
1342
|
-
getUserRoutingstatus(userId) {
|
|
1528
|
+
getUserRoutingstatus(userId, opts) {
|
|
1529
|
+
opts = opts || {};
|
|
1530
|
+
|
|
1343
1531
|
// verify the required parameter 'userId' is set
|
|
1344
1532
|
if (userId === undefined || userId === null || userId === '') {
|
|
1345
1533
|
throw 'Missing the required parameter "userId" when calling getUserRoutingstatus';
|
|
@@ -1355,7 +1543,8 @@ class UsersApi {
|
|
|
1355
1543
|
null,
|
|
1356
1544
|
['PureCloud OAuth'],
|
|
1357
1545
|
['application/json'],
|
|
1358
|
-
['application/json']
|
|
1546
|
+
['application/json'],
|
|
1547
|
+
opts['customHeaders']
|
|
1359
1548
|
);
|
|
1360
1549
|
}
|
|
1361
1550
|
|
|
@@ -1367,6 +1556,7 @@ class UsersApi {
|
|
|
1367
1556
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1368
1557
|
* @param {String} opts.after The cursor that points to the next page
|
|
1369
1558
|
* @param {String} opts.before The cursor that points to the previous page
|
|
1559
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1370
1560
|
*/
|
|
1371
1561
|
getUserSkillgroups(userId, opts) {
|
|
1372
1562
|
opts = opts || {};
|
|
@@ -1386,7 +1576,8 @@ class UsersApi {
|
|
|
1386
1576
|
null,
|
|
1387
1577
|
['PureCloud OAuth'],
|
|
1388
1578
|
['application/json'],
|
|
1389
|
-
['application/json']
|
|
1579
|
+
['application/json'],
|
|
1580
|
+
opts['customHeaders']
|
|
1390
1581
|
);
|
|
1391
1582
|
}
|
|
1392
1583
|
|
|
@@ -1394,8 +1585,12 @@ class UsersApi {
|
|
|
1394
1585
|
* Get user state information.
|
|
1395
1586
|
*
|
|
1396
1587
|
* @param {String} userId User ID
|
|
1588
|
+
* @param {Object} opts Optional parameters
|
|
1589
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1397
1590
|
*/
|
|
1398
|
-
getUserState(userId) {
|
|
1591
|
+
getUserState(userId, opts) {
|
|
1592
|
+
opts = opts || {};
|
|
1593
|
+
|
|
1399
1594
|
// verify the required parameter 'userId' is set
|
|
1400
1595
|
if (userId === undefined || userId === null || userId === '') {
|
|
1401
1596
|
throw 'Missing the required parameter "userId" when calling getUserState';
|
|
@@ -1411,7 +1606,8 @@ class UsersApi {
|
|
|
1411
1606
|
null,
|
|
1412
1607
|
['PureCloud OAuth'],
|
|
1413
1608
|
['application/json'],
|
|
1414
|
-
['application/json']
|
|
1609
|
+
['application/json'],
|
|
1610
|
+
opts['customHeaders']
|
|
1415
1611
|
);
|
|
1416
1612
|
}
|
|
1417
1613
|
|
|
@@ -1419,8 +1615,12 @@ class UsersApi {
|
|
|
1419
1615
|
* Get station information for user
|
|
1420
1616
|
*
|
|
1421
1617
|
* @param {String} userId User ID
|
|
1618
|
+
* @param {Object} opts Optional parameters
|
|
1619
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1422
1620
|
*/
|
|
1423
|
-
getUserStation(userId) {
|
|
1621
|
+
getUserStation(userId, opts) {
|
|
1622
|
+
opts = opts || {};
|
|
1623
|
+
|
|
1424
1624
|
// verify the required parameter 'userId' is set
|
|
1425
1625
|
if (userId === undefined || userId === null || userId === '') {
|
|
1426
1626
|
throw 'Missing the required parameter "userId" when calling getUserStation';
|
|
@@ -1436,7 +1636,8 @@ class UsersApi {
|
|
|
1436
1636
|
null,
|
|
1437
1637
|
['PureCloud OAuth'],
|
|
1438
1638
|
['application/json'],
|
|
1439
|
-
['application/json']
|
|
1639
|
+
['application/json'],
|
|
1640
|
+
opts['customHeaders']
|
|
1440
1641
|
);
|
|
1441
1642
|
}
|
|
1442
1643
|
|
|
@@ -1446,6 +1647,7 @@ class UsersApi {
|
|
|
1446
1647
|
* @param {String} userId User ID
|
|
1447
1648
|
* @param {Object} opts Optional parameters
|
|
1448
1649
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1650
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1449
1651
|
*/
|
|
1450
1652
|
getUserSuperiors(userId, opts) {
|
|
1451
1653
|
opts = opts || {};
|
|
@@ -1465,7 +1667,8 @@ class UsersApi {
|
|
|
1465
1667
|
null,
|
|
1466
1668
|
['PureCloud OAuth'],
|
|
1467
1669
|
['application/json'],
|
|
1468
|
-
['application/json']
|
|
1670
|
+
['application/json'],
|
|
1671
|
+
opts['customHeaders']
|
|
1469
1672
|
);
|
|
1470
1673
|
}
|
|
1471
1674
|
|
|
@@ -1476,6 +1679,7 @@ class UsersApi {
|
|
|
1476
1679
|
* @param {Object} opts Optional parameters
|
|
1477
1680
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1478
1681
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1682
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1479
1683
|
*/
|
|
1480
1684
|
getUserTrustors(userId, opts) {
|
|
1481
1685
|
opts = opts || {};
|
|
@@ -1495,7 +1699,8 @@ class UsersApi {
|
|
|
1495
1699
|
null,
|
|
1496
1700
|
['PureCloud OAuth'],
|
|
1497
1701
|
['application/json'],
|
|
1498
|
-
['application/json']
|
|
1702
|
+
['application/json'],
|
|
1703
|
+
opts['customHeaders']
|
|
1499
1704
|
);
|
|
1500
1705
|
}
|
|
1501
1706
|
|
|
@@ -1503,8 +1708,12 @@ class UsersApi {
|
|
|
1503
1708
|
* Get a list of verifiers
|
|
1504
1709
|
*
|
|
1505
1710
|
* @param {String} userId User ID
|
|
1711
|
+
* @param {Object} opts Optional parameters
|
|
1712
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1506
1713
|
*/
|
|
1507
|
-
getUserVerifiers(userId) {
|
|
1714
|
+
getUserVerifiers(userId, opts) {
|
|
1715
|
+
opts = opts || {};
|
|
1716
|
+
|
|
1508
1717
|
// verify the required parameter 'userId' is set
|
|
1509
1718
|
if (userId === undefined || userId === null || userId === '') {
|
|
1510
1719
|
throw 'Missing the required parameter "userId" when calling getUserVerifiers';
|
|
@@ -1520,7 +1729,8 @@ class UsersApi {
|
|
|
1520
1729
|
null,
|
|
1521
1730
|
['PureCloud OAuth'],
|
|
1522
1731
|
['application/json'],
|
|
1523
|
-
['application/json']
|
|
1732
|
+
['application/json'],
|
|
1733
|
+
opts['customHeaders']
|
|
1524
1734
|
);
|
|
1525
1735
|
}
|
|
1526
1736
|
|
|
@@ -1535,7 +1745,9 @@ class UsersApi {
|
|
|
1535
1745
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
1536
1746
|
* @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.
|
|
1537
1747
|
* @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.
|
|
1748
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 5
|
|
1538
1749
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
1750
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1539
1751
|
*/
|
|
1540
1752
|
getUsers(opts) {
|
|
1541
1753
|
opts = opts || {};
|
|
@@ -1545,13 +1757,14 @@ class UsersApi {
|
|
|
1545
1757
|
'/api/v2/users',
|
|
1546
1758
|
'GET',
|
|
1547
1759
|
{ },
|
|
1548
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'jabberId': this.apiClient.buildCollectionParam(opts['jabberId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
1760
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'jabberId': this.apiClient.buildCollectionParam(opts['jabberId'], 'multi'),'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi'),'state': opts['state'] },
|
|
1549
1761
|
{ },
|
|
1550
1762
|
{ },
|
|
1551
1763
|
null,
|
|
1552
1764
|
['PureCloud OAuth'],
|
|
1553
1765
|
['application/json'],
|
|
1554
|
-
['application/json']
|
|
1766
|
+
['application/json'],
|
|
1767
|
+
opts['customHeaders']
|
|
1555
1768
|
);
|
|
1556
1769
|
}
|
|
1557
1770
|
|
|
@@ -1562,6 +1775,7 @@ class UsersApi {
|
|
|
1562
1775
|
* @param {Boolean} opts.excludeClosed Whether or not to exclude closed chats
|
|
1563
1776
|
* @param {Boolean} opts.includePresence Whether or not to include user presence
|
|
1564
1777
|
* @param {String} opts.after The key to start after
|
|
1778
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1565
1779
|
*/
|
|
1566
1780
|
getUsersChatsMe(opts) {
|
|
1567
1781
|
opts = opts || {};
|
|
@@ -1577,7 +1791,8 @@ class UsersApi {
|
|
|
1577
1791
|
null,
|
|
1578
1792
|
['PureCloud OAuth'],
|
|
1579
1793
|
['application/json'],
|
|
1580
|
-
['application/json']
|
|
1794
|
+
['application/json'],
|
|
1795
|
+
opts['customHeaders']
|
|
1581
1796
|
);
|
|
1582
1797
|
}
|
|
1583
1798
|
|
|
@@ -1585,9 +1800,12 @@ class UsersApi {
|
|
|
1585
1800
|
* Get a schema
|
|
1586
1801
|
*
|
|
1587
1802
|
* @param {String} schemaId Schema ID
|
|
1588
|
-
*
|
|
1803
|
+
* @param {Object} opts Optional parameters
|
|
1804
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1589
1805
|
*/
|
|
1590
|
-
getUsersCustomattributesSchema(schemaId) {
|
|
1806
|
+
getUsersCustomattributesSchema(schemaId, opts) {
|
|
1807
|
+
opts = opts || {};
|
|
1808
|
+
|
|
1591
1809
|
// verify the required parameter 'schemaId' is set
|
|
1592
1810
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
1593
1811
|
throw 'Missing the required parameter "schemaId" when calling getUsersCustomattributesSchema';
|
|
@@ -1603,7 +1821,8 @@ class UsersApi {
|
|
|
1603
1821
|
null,
|
|
1604
1822
|
['PureCloud OAuth'],
|
|
1605
1823
|
['application/json'],
|
|
1606
|
-
['application/json']
|
|
1824
|
+
['application/json'],
|
|
1825
|
+
opts['customHeaders']
|
|
1607
1826
|
);
|
|
1608
1827
|
}
|
|
1609
1828
|
|
|
@@ -1612,9 +1831,12 @@ class UsersApi {
|
|
|
1612
1831
|
*
|
|
1613
1832
|
* @param {String} schemaId Schema ID
|
|
1614
1833
|
* @param {String} versionId Schema version
|
|
1615
|
-
*
|
|
1834
|
+
* @param {Object} opts Optional parameters
|
|
1835
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1616
1836
|
*/
|
|
1617
|
-
getUsersCustomattributesSchemaVersion(schemaId, versionId) {
|
|
1837
|
+
getUsersCustomattributesSchemaVersion(schemaId, versionId, opts) {
|
|
1838
|
+
opts = opts || {};
|
|
1839
|
+
|
|
1618
1840
|
// verify the required parameter 'schemaId' is set
|
|
1619
1841
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
1620
1842
|
throw 'Missing the required parameter "schemaId" when calling getUsersCustomattributesSchemaVersion';
|
|
@@ -1634,7 +1856,8 @@ class UsersApi {
|
|
|
1634
1856
|
null,
|
|
1635
1857
|
['PureCloud OAuth'],
|
|
1636
1858
|
['application/json'],
|
|
1637
|
-
['application/json']
|
|
1859
|
+
['application/json'],
|
|
1860
|
+
opts['customHeaders']
|
|
1638
1861
|
);
|
|
1639
1862
|
}
|
|
1640
1863
|
|
|
@@ -1642,9 +1865,12 @@ class UsersApi {
|
|
|
1642
1865
|
* Get all versions of a user schema
|
|
1643
1866
|
*
|
|
1644
1867
|
* @param {String} schemaId Schema ID
|
|
1645
|
-
*
|
|
1868
|
+
* @param {Object} opts Optional parameters
|
|
1869
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1646
1870
|
*/
|
|
1647
|
-
getUsersCustomattributesSchemaVersions(schemaId) {
|
|
1871
|
+
getUsersCustomattributesSchemaVersions(schemaId, opts) {
|
|
1872
|
+
opts = opts || {};
|
|
1873
|
+
|
|
1648
1874
|
// verify the required parameter 'schemaId' is set
|
|
1649
1875
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
1650
1876
|
throw 'Missing the required parameter "schemaId" when calling getUsersCustomattributesSchemaVersions';
|
|
@@ -1660,16 +1886,20 @@ class UsersApi {
|
|
|
1660
1886
|
null,
|
|
1661
1887
|
['PureCloud OAuth'],
|
|
1662
1888
|
['application/json'],
|
|
1663
|
-
['application/json']
|
|
1889
|
+
['application/json'],
|
|
1890
|
+
opts['customHeaders']
|
|
1664
1891
|
);
|
|
1665
1892
|
}
|
|
1666
1893
|
|
|
1667
1894
|
/**
|
|
1668
1895
|
* Get a list of schemas.
|
|
1669
1896
|
*
|
|
1670
|
-
*
|
|
1897
|
+
* @param {Object} opts Optional parameters
|
|
1898
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1671
1899
|
*/
|
|
1672
|
-
getUsersCustomattributesSchemas() {
|
|
1900
|
+
getUsersCustomattributesSchemas(opts) {
|
|
1901
|
+
opts = opts || {};
|
|
1902
|
+
|
|
1673
1903
|
|
|
1674
1904
|
return this.apiClient.callApi(
|
|
1675
1905
|
'/api/v2/users/customattributes/schemas',
|
|
@@ -1681,7 +1911,8 @@ class UsersApi {
|
|
|
1681
1911
|
null,
|
|
1682
1912
|
['PureCloud OAuth'],
|
|
1683
1913
|
['application/json'],
|
|
1684
|
-
['application/json']
|
|
1914
|
+
['application/json'],
|
|
1915
|
+
opts['customHeaders']
|
|
1685
1916
|
);
|
|
1686
1917
|
}
|
|
1687
1918
|
|
|
@@ -1689,9 +1920,12 @@ class UsersApi {
|
|
|
1689
1920
|
* Get the core types from which all schemas are built.
|
|
1690
1921
|
*
|
|
1691
1922
|
* @param {String} coreTypeName Name of the core type
|
|
1692
|
-
*
|
|
1923
|
+
* @param {Object} opts Optional parameters
|
|
1924
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1693
1925
|
*/
|
|
1694
|
-
getUsersCustomattributesSchemasCoretype(coreTypeName) {
|
|
1926
|
+
getUsersCustomattributesSchemasCoretype(coreTypeName, opts) {
|
|
1927
|
+
opts = opts || {};
|
|
1928
|
+
|
|
1695
1929
|
// verify the required parameter 'coreTypeName' is set
|
|
1696
1930
|
if (coreTypeName === undefined || coreTypeName === null || coreTypeName === '') {
|
|
1697
1931
|
throw 'Missing the required parameter "coreTypeName" when calling getUsersCustomattributesSchemasCoretype';
|
|
@@ -1707,16 +1941,20 @@ class UsersApi {
|
|
|
1707
1941
|
null,
|
|
1708
1942
|
['PureCloud OAuth'],
|
|
1709
1943
|
['application/json'],
|
|
1710
|
-
['application/json']
|
|
1944
|
+
['application/json'],
|
|
1945
|
+
opts['customHeaders']
|
|
1711
1946
|
);
|
|
1712
1947
|
}
|
|
1713
1948
|
|
|
1714
1949
|
/**
|
|
1715
1950
|
* Get the list of core types enabled for a specific namespace.
|
|
1716
1951
|
*
|
|
1717
|
-
*
|
|
1952
|
+
* @param {Object} opts Optional parameters
|
|
1953
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1718
1954
|
*/
|
|
1719
|
-
getUsersCustomattributesSchemasCoretypes() {
|
|
1955
|
+
getUsersCustomattributesSchemasCoretypes(opts) {
|
|
1956
|
+
opts = opts || {};
|
|
1957
|
+
|
|
1720
1958
|
|
|
1721
1959
|
return this.apiClient.callApi(
|
|
1722
1960
|
'/api/v2/users/customattributes/schemas/coretypes',
|
|
@@ -1728,16 +1966,20 @@ class UsersApi {
|
|
|
1728
1966
|
null,
|
|
1729
1967
|
['PureCloud OAuth'],
|
|
1730
1968
|
['application/json'],
|
|
1731
|
-
['application/json']
|
|
1969
|
+
['application/json'],
|
|
1970
|
+
opts['customHeaders']
|
|
1732
1971
|
);
|
|
1733
1972
|
}
|
|
1734
1973
|
|
|
1735
1974
|
/**
|
|
1736
1975
|
* Get quantitative limits on schemas
|
|
1737
1976
|
*
|
|
1738
|
-
*
|
|
1977
|
+
* @param {Object} opts Optional parameters
|
|
1978
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1739
1979
|
*/
|
|
1740
|
-
getUsersCustomattributesSchemasLimits() {
|
|
1980
|
+
getUsersCustomattributesSchemasLimits(opts) {
|
|
1981
|
+
opts = opts || {};
|
|
1982
|
+
|
|
1741
1983
|
|
|
1742
1984
|
return this.apiClient.callApi(
|
|
1743
1985
|
'/api/v2/users/customattributes/schemas/limits',
|
|
@@ -1749,7 +1991,8 @@ class UsersApi {
|
|
|
1749
1991
|
null,
|
|
1750
1992
|
['PureCloud OAuth'],
|
|
1751
1993
|
['application/json'],
|
|
1752
|
-
['application/json']
|
|
1994
|
+
['application/json'],
|
|
1995
|
+
opts['customHeaders']
|
|
1753
1996
|
);
|
|
1754
1997
|
}
|
|
1755
1998
|
|
|
@@ -1769,6 +2012,7 @@ class UsersApi {
|
|
|
1769
2012
|
* @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
|
|
1770
2013
|
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
1771
2014
|
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.
|
|
2015
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1772
2016
|
*/
|
|
1773
2017
|
getUsersDevelopmentActivities(opts) {
|
|
1774
2018
|
opts = opts || {};
|
|
@@ -1784,7 +2028,8 @@ class UsersApi {
|
|
|
1784
2028
|
null,
|
|
1785
2029
|
['PureCloud OAuth'],
|
|
1786
2030
|
['application/json'],
|
|
1787
|
-
['application/json']
|
|
2031
|
+
['application/json'],
|
|
2032
|
+
opts['customHeaders']
|
|
1788
2033
|
);
|
|
1789
2034
|
}
|
|
1790
2035
|
|
|
@@ -1803,6 +2048,7 @@ class UsersApi {
|
|
|
1803
2048
|
* @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
|
|
1804
2049
|
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
1805
2050
|
* @param {Array.<String>} opts.relationship Specifies how the current user relation should be interpreted, and filters the activities returned to only the activities that have the specified relationship. If a value besides Attendee is specified, it will only return Coaching Appointments. If not specified, no filtering is applied.
|
|
2051
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1806
2052
|
*/
|
|
1807
2053
|
getUsersDevelopmentActivitiesMe(opts) {
|
|
1808
2054
|
opts = opts || {};
|
|
@@ -1818,7 +2064,8 @@ class UsersApi {
|
|
|
1818
2064
|
null,
|
|
1819
2065
|
['PureCloud OAuth'],
|
|
1820
2066
|
['application/json'],
|
|
1821
|
-
['application/json']
|
|
2067
|
+
['application/json'],
|
|
2068
|
+
opts['customHeaders']
|
|
1822
2069
|
);
|
|
1823
2070
|
}
|
|
1824
2071
|
|
|
@@ -1827,8 +2074,12 @@ class UsersApi {
|
|
|
1827
2074
|
* Permission not required if you are the attendee, creator or facilitator of the coaching appointment or you are the assigned user of the learning assignment.
|
|
1828
2075
|
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
1829
2076
|
* @param {Object} type Specifies the activity type. Informational, AssessedContent and Assessment are deprecated
|
|
2077
|
+
* @param {Object} opts Optional parameters
|
|
2078
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1830
2079
|
*/
|
|
1831
|
-
getUsersDevelopmentActivity(activityId, type) {
|
|
2080
|
+
getUsersDevelopmentActivity(activityId, type, opts) {
|
|
2081
|
+
opts = opts || {};
|
|
2082
|
+
|
|
1832
2083
|
// verify the required parameter 'activityId' is set
|
|
1833
2084
|
if (activityId === undefined || activityId === null || activityId === '') {
|
|
1834
2085
|
throw 'Missing the required parameter "activityId" when calling getUsersDevelopmentActivity';
|
|
@@ -1848,7 +2099,8 @@ class UsersApi {
|
|
|
1848
2099
|
null,
|
|
1849
2100
|
['PureCloud OAuth'],
|
|
1850
2101
|
['application/json'],
|
|
1851
|
-
['application/json']
|
|
2102
|
+
['application/json'],
|
|
2103
|
+
opts['customHeaders']
|
|
1852
2104
|
);
|
|
1853
2105
|
}
|
|
1854
2106
|
|
|
@@ -1859,6 +2111,7 @@ class UsersApi {
|
|
|
1859
2111
|
* @param {String} externalKey External Key
|
|
1860
2112
|
* @param {Object} opts Optional parameters
|
|
1861
2113
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
2114
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1862
2115
|
*/
|
|
1863
2116
|
getUsersExternalidAuthorityNameExternalKey(authorityName, externalKey, opts) {
|
|
1864
2117
|
opts = opts || {};
|
|
@@ -1882,7 +2135,8 @@ class UsersApi {
|
|
|
1882
2135
|
null,
|
|
1883
2136
|
['PureCloud OAuth'],
|
|
1884
2137
|
['application/json'],
|
|
1885
|
-
['application/json']
|
|
2138
|
+
['application/json'],
|
|
2139
|
+
opts['customHeaders']
|
|
1886
2140
|
);
|
|
1887
2141
|
}
|
|
1888
2142
|
|
|
@@ -1892,6 +2146,8 @@ class UsersApi {
|
|
|
1892
2146
|
* @param {Object} opts Optional parameters
|
|
1893
2147
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand.
|
|
1894
2148
|
* @param {Object} opts.integrationPresenceSource Get your presence for a given integration. This parameter will only be used when presence is provided as an expand.
|
|
2149
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 100
|
|
2150
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1895
2151
|
*/
|
|
1896
2152
|
getUsersMe(opts) {
|
|
1897
2153
|
opts = opts || {};
|
|
@@ -1901,13 +2157,14 @@ class UsersApi {
|
|
|
1901
2157
|
'/api/v2/users/me',
|
|
1902
2158
|
'GET',
|
|
1903
2159
|
{ },
|
|
1904
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'] },
|
|
2160
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi') },
|
|
1905
2161
|
{ },
|
|
1906
2162
|
{ },
|
|
1907
2163
|
null,
|
|
1908
2164
|
['PureCloud OAuth'],
|
|
1909
2165
|
['application/json'],
|
|
1910
|
-
['application/json']
|
|
2166
|
+
['application/json'],
|
|
2167
|
+
opts['customHeaders']
|
|
1911
2168
|
);
|
|
1912
2169
|
}
|
|
1913
2170
|
|
|
@@ -1920,7 +2177,9 @@ class UsersApi {
|
|
|
1920
2177
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
1921
2178
|
* @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.
|
|
1922
2179
|
* @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.
|
|
2180
|
+
* @param {Array.<String>} opts.userCustomAttributeSchemaIds Gets custom user attribute values for given schemas set for user. This parameter will only be used when customAttributes is provided as an expand. The maximum number of schemaIds that can be requested is 5
|
|
1923
2181
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
2182
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1924
2183
|
* getUsersQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1925
2184
|
*/
|
|
1926
2185
|
getUsersQuery(opts) {
|
|
@@ -1931,13 +2190,14 @@ class UsersApi {
|
|
|
1931
2190
|
'/api/v2/users/query',
|
|
1932
2191
|
'GET',
|
|
1933
2192
|
{ },
|
|
1934
|
-
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'state': opts['state'] },
|
|
2193
|
+
{ 'cursor': opts['cursor'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'integrationPresenceSource': opts['integrationPresenceSource'],'userCustomAttributeSchemaIds': this.apiClient.buildCollectionParam(opts['userCustomAttributeSchemaIds'], 'multi'),'state': opts['state'] },
|
|
1935
2194
|
{ },
|
|
1936
2195
|
{ },
|
|
1937
2196
|
null,
|
|
1938
2197
|
['PureCloud OAuth'],
|
|
1939
2198
|
['application/json'],
|
|
1940
|
-
['application/json']
|
|
2199
|
+
['application/json'],
|
|
2200
|
+
opts['customHeaders']
|
|
1941
2201
|
);
|
|
1942
2202
|
}
|
|
1943
2203
|
|
|
@@ -1948,6 +2208,7 @@ class UsersApi {
|
|
|
1948
2208
|
* @param {Object} opts Optional parameters
|
|
1949
2209
|
* @param {Array.<String>} opts.expand expand
|
|
1950
2210
|
* @param {Object} opts.integrationPresenceSource integrationPresenceSource
|
|
2211
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1951
2212
|
*/
|
|
1952
2213
|
getUsersSearch(q64, opts) {
|
|
1953
2214
|
opts = opts || {};
|
|
@@ -1967,7 +2228,8 @@ class UsersApi {
|
|
|
1967
2228
|
null,
|
|
1968
2229
|
['PureCloud OAuth'],
|
|
1969
2230
|
['application/json'],
|
|
1970
|
-
['application/json']
|
|
2231
|
+
['application/json'],
|
|
2232
|
+
opts['customHeaders']
|
|
1971
2233
|
);
|
|
1972
2234
|
}
|
|
1973
2235
|
|
|
@@ -1976,8 +2238,12 @@ class UsersApi {
|
|
|
1976
2238
|
*
|
|
1977
2239
|
* @param {String} userId User ID
|
|
1978
2240
|
* @param {Object} body User
|
|
2241
|
+
* @param {Object} opts Optional parameters
|
|
2242
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1979
2243
|
*/
|
|
1980
|
-
patchUser(userId, body) {
|
|
2244
|
+
patchUser(userId, body, opts) {
|
|
2245
|
+
opts = opts || {};
|
|
2246
|
+
|
|
1981
2247
|
// verify the required parameter 'userId' is set
|
|
1982
2248
|
if (userId === undefined || userId === null || userId === '') {
|
|
1983
2249
|
throw 'Missing the required parameter "userId" when calling patchUser';
|
|
@@ -1997,7 +2263,8 @@ class UsersApi {
|
|
|
1997
2263
|
body,
|
|
1998
2264
|
['PureCloud OAuth'],
|
|
1999
2265
|
['application/json'],
|
|
2000
|
-
['application/json']
|
|
2266
|
+
['application/json'],
|
|
2267
|
+
opts['customHeaders']
|
|
2001
2268
|
);
|
|
2002
2269
|
}
|
|
2003
2270
|
|
|
@@ -2006,8 +2273,12 @@ class UsersApi {
|
|
|
2006
2273
|
*
|
|
2007
2274
|
* @param {String} userId User ID
|
|
2008
2275
|
* @param {Object} body Call forwarding
|
|
2276
|
+
* @param {Object} opts Optional parameters
|
|
2277
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2009
2278
|
*/
|
|
2010
|
-
patchUserCallforwarding(userId, body) {
|
|
2279
|
+
patchUserCallforwarding(userId, body, opts) {
|
|
2280
|
+
opts = opts || {};
|
|
2281
|
+
|
|
2011
2282
|
// verify the required parameter 'userId' is set
|
|
2012
2283
|
if (userId === undefined || userId === null || userId === '') {
|
|
2013
2284
|
throw 'Missing the required parameter "userId" when calling patchUserCallforwarding';
|
|
@@ -2027,7 +2298,8 @@ class UsersApi {
|
|
|
2027
2298
|
body,
|
|
2028
2299
|
['PureCloud OAuth'],
|
|
2029
2300
|
['application/json'],
|
|
2030
|
-
['application/json']
|
|
2301
|
+
['application/json'],
|
|
2302
|
+
opts['customHeaders']
|
|
2031
2303
|
);
|
|
2032
2304
|
}
|
|
2033
2305
|
|
|
@@ -2036,9 +2308,12 @@ class UsersApi {
|
|
|
2036
2308
|
*
|
|
2037
2309
|
* @param {String} userId user ID
|
|
2038
2310
|
* @param {Object} userCustomAttributes
|
|
2039
|
-
*
|
|
2311
|
+
* @param {Object} opts Optional parameters
|
|
2312
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2040
2313
|
*/
|
|
2041
|
-
patchUserCustomattributes(userId, userCustomAttributes) {
|
|
2314
|
+
patchUserCustomattributes(userId, userCustomAttributes, opts) {
|
|
2315
|
+
opts = opts || {};
|
|
2316
|
+
|
|
2042
2317
|
// verify the required parameter 'userId' is set
|
|
2043
2318
|
if (userId === undefined || userId === null || userId === '') {
|
|
2044
2319
|
throw 'Missing the required parameter "userId" when calling patchUserCustomattributes';
|
|
@@ -2058,7 +2333,8 @@ class UsersApi {
|
|
|
2058
2333
|
userCustomAttributes,
|
|
2059
2334
|
['PureCloud OAuth'],
|
|
2060
2335
|
['application/json'],
|
|
2061
|
-
['application/json']
|
|
2336
|
+
['application/json'],
|
|
2337
|
+
opts['customHeaders']
|
|
2062
2338
|
);
|
|
2063
2339
|
}
|
|
2064
2340
|
|
|
@@ -2067,9 +2343,12 @@ class UsersApi {
|
|
|
2067
2343
|
*
|
|
2068
2344
|
* @param {String} userId user ID
|
|
2069
2345
|
* @param {Array.<Object>} userCustomAttributesList
|
|
2070
|
-
*
|
|
2346
|
+
* @param {Object} opts Optional parameters
|
|
2347
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2071
2348
|
*/
|
|
2072
|
-
patchUserCustomattributesBulk(userId, userCustomAttributesList) {
|
|
2349
|
+
patchUserCustomattributesBulk(userId, userCustomAttributesList, opts) {
|
|
2350
|
+
opts = opts || {};
|
|
2351
|
+
|
|
2073
2352
|
// verify the required parameter 'userId' is set
|
|
2074
2353
|
if (userId === undefined || userId === null || userId === '') {
|
|
2075
2354
|
throw 'Missing the required parameter "userId" when calling patchUserCustomattributesBulk';
|
|
@@ -2089,7 +2368,8 @@ class UsersApi {
|
|
|
2089
2368
|
userCustomAttributesList,
|
|
2090
2369
|
['PureCloud OAuth'],
|
|
2091
2370
|
['application/json'],
|
|
2092
|
-
['application/json']
|
|
2371
|
+
['application/json'],
|
|
2372
|
+
opts['customHeaders']
|
|
2093
2373
|
);
|
|
2094
2374
|
}
|
|
2095
2375
|
|
|
@@ -2099,8 +2379,12 @@ class UsersApi {
|
|
|
2099
2379
|
* @param {String} userId user Id
|
|
2100
2380
|
* @param {String} clientId client Id
|
|
2101
2381
|
* @param {Object} body Geolocation
|
|
2382
|
+
* @param {Object} opts Optional parameters
|
|
2383
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2102
2384
|
*/
|
|
2103
|
-
patchUserGeolocation(userId, clientId, body) {
|
|
2385
|
+
patchUserGeolocation(userId, clientId, body, opts) {
|
|
2386
|
+
opts = opts || {};
|
|
2387
|
+
|
|
2104
2388
|
// verify the required parameter 'userId' is set
|
|
2105
2389
|
if (userId === undefined || userId === null || userId === '') {
|
|
2106
2390
|
throw 'Missing the required parameter "userId" when calling patchUserGeolocation';
|
|
@@ -2124,7 +2408,8 @@ class UsersApi {
|
|
|
2124
2408
|
body,
|
|
2125
2409
|
['PureCloud OAuth'],
|
|
2126
2410
|
['application/json'],
|
|
2127
|
-
['application/json']
|
|
2411
|
+
['application/json'],
|
|
2412
|
+
opts['customHeaders']
|
|
2128
2413
|
);
|
|
2129
2414
|
}
|
|
2130
2415
|
|
|
@@ -2134,8 +2419,12 @@ class UsersApi {
|
|
|
2134
2419
|
* @param {String} queueId Queue ID
|
|
2135
2420
|
* @param {String} userId User ID
|
|
2136
2421
|
* @param {Object} body Queue Member
|
|
2422
|
+
* @param {Object} opts Optional parameters
|
|
2423
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2137
2424
|
*/
|
|
2138
|
-
patchUserQueue(queueId, userId, body) {
|
|
2425
|
+
patchUserQueue(queueId, userId, body, opts) {
|
|
2426
|
+
opts = opts || {};
|
|
2427
|
+
|
|
2139
2428
|
// verify the required parameter 'queueId' is set
|
|
2140
2429
|
if (queueId === undefined || queueId === null || queueId === '') {
|
|
2141
2430
|
throw 'Missing the required parameter "queueId" when calling patchUserQueue';
|
|
@@ -2159,7 +2448,8 @@ class UsersApi {
|
|
|
2159
2448
|
body,
|
|
2160
2449
|
['PureCloud OAuth'],
|
|
2161
2450
|
['application/json'],
|
|
2162
|
-
['application/json']
|
|
2451
|
+
['application/json'],
|
|
2452
|
+
opts['customHeaders']
|
|
2163
2453
|
);
|
|
2164
2454
|
}
|
|
2165
2455
|
|
|
@@ -2170,6 +2460,7 @@ class UsersApi {
|
|
|
2170
2460
|
* @param {Array.<Object>} body User Queues
|
|
2171
2461
|
* @param {Object} opts Optional parameters
|
|
2172
2462
|
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
2463
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2173
2464
|
*/
|
|
2174
2465
|
patchUserQueues(userId, body, opts) {
|
|
2175
2466
|
opts = opts || {};
|
|
@@ -2193,7 +2484,8 @@ class UsersApi {
|
|
|
2193
2484
|
body,
|
|
2194
2485
|
['PureCloud OAuth'],
|
|
2195
2486
|
['application/json'],
|
|
2196
|
-
['application/json']
|
|
2487
|
+
['application/json'],
|
|
2488
|
+
opts['customHeaders']
|
|
2197
2489
|
);
|
|
2198
2490
|
}
|
|
2199
2491
|
|
|
@@ -2203,8 +2495,12 @@ class UsersApi {
|
|
|
2203
2495
|
* @param {String} userId User ID
|
|
2204
2496
|
* @param {String} languageId languageId
|
|
2205
2497
|
* @param {Object} body Language
|
|
2498
|
+
* @param {Object} opts Optional parameters
|
|
2499
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2206
2500
|
*/
|
|
2207
|
-
patchUserRoutinglanguage(userId, languageId, body) {
|
|
2501
|
+
patchUserRoutinglanguage(userId, languageId, body, opts) {
|
|
2502
|
+
opts = opts || {};
|
|
2503
|
+
|
|
2208
2504
|
// verify the required parameter 'userId' is set
|
|
2209
2505
|
if (userId === undefined || userId === null || userId === '') {
|
|
2210
2506
|
throw 'Missing the required parameter "userId" when calling patchUserRoutinglanguage';
|
|
@@ -2228,7 +2524,8 @@ class UsersApi {
|
|
|
2228
2524
|
body,
|
|
2229
2525
|
['PureCloud OAuth'],
|
|
2230
2526
|
['application/json'],
|
|
2231
|
-
['application/json']
|
|
2527
|
+
['application/json'],
|
|
2528
|
+
opts['customHeaders']
|
|
2232
2529
|
);
|
|
2233
2530
|
}
|
|
2234
2531
|
|
|
@@ -2237,8 +2534,12 @@ class UsersApi {
|
|
|
2237
2534
|
*
|
|
2238
2535
|
* @param {String} userId User ID
|
|
2239
2536
|
* @param {Array.<Object>} body Language
|
|
2537
|
+
* @param {Object} opts Optional parameters
|
|
2538
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2240
2539
|
*/
|
|
2241
|
-
patchUserRoutinglanguagesBulk(userId, body) {
|
|
2540
|
+
patchUserRoutinglanguagesBulk(userId, body, opts) {
|
|
2541
|
+
opts = opts || {};
|
|
2542
|
+
|
|
2242
2543
|
// verify the required parameter 'userId' is set
|
|
2243
2544
|
if (userId === undefined || userId === null || userId === '') {
|
|
2244
2545
|
throw 'Missing the required parameter "userId" when calling patchUserRoutinglanguagesBulk';
|
|
@@ -2258,7 +2559,8 @@ class UsersApi {
|
|
|
2258
2559
|
body,
|
|
2259
2560
|
['PureCloud OAuth'],
|
|
2260
2561
|
['application/json'],
|
|
2261
|
-
['application/json']
|
|
2562
|
+
['application/json'],
|
|
2563
|
+
opts['customHeaders']
|
|
2262
2564
|
);
|
|
2263
2565
|
}
|
|
2264
2566
|
|
|
@@ -2267,8 +2569,12 @@ class UsersApi {
|
|
|
2267
2569
|
*
|
|
2268
2570
|
* @param {String} userId User ID
|
|
2269
2571
|
* @param {Array.<Object>} body Skill
|
|
2572
|
+
* @param {Object} opts Optional parameters
|
|
2573
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2270
2574
|
*/
|
|
2271
|
-
patchUserRoutingskillsBulk(userId, body) {
|
|
2575
|
+
patchUserRoutingskillsBulk(userId, body, opts) {
|
|
2576
|
+
opts = opts || {};
|
|
2577
|
+
|
|
2272
2578
|
// verify the required parameter 'userId' is set
|
|
2273
2579
|
if (userId === undefined || userId === null || userId === '') {
|
|
2274
2580
|
throw 'Missing the required parameter "userId" when calling patchUserRoutingskillsBulk';
|
|
@@ -2288,7 +2594,8 @@ class UsersApi {
|
|
|
2288
2594
|
body,
|
|
2289
2595
|
['PureCloud OAuth'],
|
|
2290
2596
|
['application/json'],
|
|
2291
|
-
['application/json']
|
|
2597
|
+
['application/json'],
|
|
2598
|
+
opts['customHeaders']
|
|
2292
2599
|
);
|
|
2293
2600
|
}
|
|
2294
2601
|
|
|
@@ -2296,8 +2603,12 @@ class UsersApi {
|
|
|
2296
2603
|
* Update bulk acd autoanswer on users. Max 50 users can be updated at a time.
|
|
2297
2604
|
*
|
|
2298
2605
|
* @param {Array.<Object>} body Users
|
|
2606
|
+
* @param {Object} opts Optional parameters
|
|
2607
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2299
2608
|
*/
|
|
2300
|
-
patchUsersBulk(body) {
|
|
2609
|
+
patchUsersBulk(body, opts) {
|
|
2610
|
+
opts = opts || {};
|
|
2611
|
+
|
|
2301
2612
|
// verify the required parameter 'body' is set
|
|
2302
2613
|
if (body === undefined || body === null) {
|
|
2303
2614
|
throw 'Missing the required parameter "body" when calling patchUsersBulk';
|
|
@@ -2313,7 +2624,8 @@ class UsersApi {
|
|
|
2313
2624
|
body,
|
|
2314
2625
|
['PureCloud OAuth'],
|
|
2315
2626
|
['application/json'],
|
|
2316
|
-
['application/json']
|
|
2627
|
+
['application/json'],
|
|
2628
|
+
opts['customHeaders']
|
|
2317
2629
|
);
|
|
2318
2630
|
}
|
|
2319
2631
|
|
|
@@ -2324,6 +2636,7 @@ class UsersApi {
|
|
|
2324
2636
|
* @param {Object} opts Optional parameters
|
|
2325
2637
|
* @param {Number} opts.pageSize The desired page size
|
|
2326
2638
|
* @param {Number} opts.pageNumber The desired page number
|
|
2639
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2327
2640
|
*/
|
|
2328
2641
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
2329
2642
|
opts = opts || {};
|
|
@@ -2343,7 +2656,8 @@ class UsersApi {
|
|
|
2343
2656
|
body,
|
|
2344
2657
|
['PureCloud OAuth'],
|
|
2345
2658
|
['application/json'],
|
|
2346
|
-
['application/json']
|
|
2659
|
+
['application/json'],
|
|
2660
|
+
opts['customHeaders']
|
|
2347
2661
|
);
|
|
2348
2662
|
}
|
|
2349
2663
|
|
|
@@ -2351,9 +2665,13 @@ class UsersApi {
|
|
|
2351
2665
|
* Query for user aggregates asynchronously
|
|
2352
2666
|
*
|
|
2353
2667
|
* @param {Object} body query
|
|
2668
|
+
* @param {Object} opts Optional parameters
|
|
2669
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2354
2670
|
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2355
2671
|
*/
|
|
2356
|
-
postAnalyticsUsersAggregatesJobs(body) {
|
|
2672
|
+
postAnalyticsUsersAggregatesJobs(body, opts) {
|
|
2673
|
+
opts = opts || {};
|
|
2674
|
+
|
|
2357
2675
|
// verify the required parameter 'body' is set
|
|
2358
2676
|
if (body === undefined || body === null) {
|
|
2359
2677
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';
|
|
@@ -2369,7 +2687,8 @@ class UsersApi {
|
|
|
2369
2687
|
body,
|
|
2370
2688
|
['PureCloud OAuth'],
|
|
2371
2689
|
['application/json'],
|
|
2372
|
-
['application/json']
|
|
2690
|
+
['application/json'],
|
|
2691
|
+
opts['customHeaders']
|
|
2373
2692
|
);
|
|
2374
2693
|
}
|
|
2375
2694
|
|
|
@@ -2377,8 +2696,12 @@ class UsersApi {
|
|
|
2377
2696
|
* Query for user aggregates
|
|
2378
2697
|
*
|
|
2379
2698
|
* @param {Object} body query
|
|
2699
|
+
* @param {Object} opts Optional parameters
|
|
2700
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2380
2701
|
*/
|
|
2381
|
-
postAnalyticsUsersAggregatesQuery(body) {
|
|
2702
|
+
postAnalyticsUsersAggregatesQuery(body, opts) {
|
|
2703
|
+
opts = opts || {};
|
|
2704
|
+
|
|
2382
2705
|
// verify the required parameter 'body' is set
|
|
2383
2706
|
if (body === undefined || body === null) {
|
|
2384
2707
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesQuery';
|
|
@@ -2394,7 +2717,8 @@ class UsersApi {
|
|
|
2394
2717
|
body,
|
|
2395
2718
|
['PureCloud OAuth'],
|
|
2396
2719
|
['application/json'],
|
|
2397
|
-
['application/json']
|
|
2720
|
+
['application/json'],
|
|
2721
|
+
opts['customHeaders']
|
|
2398
2722
|
);
|
|
2399
2723
|
}
|
|
2400
2724
|
|
|
@@ -2402,8 +2726,12 @@ class UsersApi {
|
|
|
2402
2726
|
* Query for user details asynchronously
|
|
2403
2727
|
*
|
|
2404
2728
|
* @param {Object} body query
|
|
2729
|
+
* @param {Object} opts Optional parameters
|
|
2730
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2405
2731
|
*/
|
|
2406
|
-
postAnalyticsUsersDetailsJobs(body) {
|
|
2732
|
+
postAnalyticsUsersDetailsJobs(body, opts) {
|
|
2733
|
+
opts = opts || {};
|
|
2734
|
+
|
|
2407
2735
|
// verify the required parameter 'body' is set
|
|
2408
2736
|
if (body === undefined || body === null) {
|
|
2409
2737
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersDetailsJobs';
|
|
@@ -2419,7 +2747,8 @@ class UsersApi {
|
|
|
2419
2747
|
body,
|
|
2420
2748
|
['PureCloud OAuth'],
|
|
2421
2749
|
['application/json'],
|
|
2422
|
-
['application/json']
|
|
2750
|
+
['application/json'],
|
|
2751
|
+
opts['customHeaders']
|
|
2423
2752
|
);
|
|
2424
2753
|
}
|
|
2425
2754
|
|
|
@@ -2427,8 +2756,12 @@ class UsersApi {
|
|
|
2427
2756
|
* Query for user details
|
|
2428
2757
|
*
|
|
2429
2758
|
* @param {Object} body query
|
|
2759
|
+
* @param {Object} opts Optional parameters
|
|
2760
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2430
2761
|
*/
|
|
2431
|
-
postAnalyticsUsersDetailsQuery(body) {
|
|
2762
|
+
postAnalyticsUsersDetailsQuery(body, opts) {
|
|
2763
|
+
opts = opts || {};
|
|
2764
|
+
|
|
2432
2765
|
// verify the required parameter 'body' is set
|
|
2433
2766
|
if (body === undefined || body === null) {
|
|
2434
2767
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersDetailsQuery';
|
|
@@ -2444,7 +2777,8 @@ class UsersApi {
|
|
|
2444
2777
|
body,
|
|
2445
2778
|
['PureCloud OAuth'],
|
|
2446
2779
|
['application/json'],
|
|
2447
|
-
['application/json']
|
|
2780
|
+
['application/json'],
|
|
2781
|
+
opts['customHeaders']
|
|
2448
2782
|
);
|
|
2449
2783
|
}
|
|
2450
2784
|
|
|
@@ -2452,8 +2786,12 @@ class UsersApi {
|
|
|
2452
2786
|
* Query for user observations
|
|
2453
2787
|
*
|
|
2454
2788
|
* @param {Object} body query
|
|
2789
|
+
* @param {Object} opts Optional parameters
|
|
2790
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2455
2791
|
*/
|
|
2456
|
-
postAnalyticsUsersObservationsQuery(body) {
|
|
2792
|
+
postAnalyticsUsersObservationsQuery(body, opts) {
|
|
2793
|
+
opts = opts || {};
|
|
2794
|
+
|
|
2457
2795
|
// verify the required parameter 'body' is set
|
|
2458
2796
|
if (body === undefined || body === null) {
|
|
2459
2797
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersObservationsQuery';
|
|
@@ -2469,7 +2807,8 @@ class UsersApi {
|
|
|
2469
2807
|
body,
|
|
2470
2808
|
['PureCloud OAuth'],
|
|
2471
2809
|
['application/json'],
|
|
2472
|
-
['application/json']
|
|
2810
|
+
['application/json'],
|
|
2811
|
+
opts['customHeaders']
|
|
2473
2812
|
);
|
|
2474
2813
|
}
|
|
2475
2814
|
|
|
@@ -2480,6 +2819,7 @@ class UsersApi {
|
|
|
2480
2819
|
* @param {Object} body Pairs of role and division IDs
|
|
2481
2820
|
* @param {Object} opts Optional parameters
|
|
2482
2821
|
* @param {String} opts.subjectType what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (default to PC_USER)
|
|
2822
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2483
2823
|
*/
|
|
2484
2824
|
postAuthorizationSubjectBulkadd(subjectId, body, opts) {
|
|
2485
2825
|
opts = opts || {};
|
|
@@ -2503,7 +2843,8 @@ class UsersApi {
|
|
|
2503
2843
|
body,
|
|
2504
2844
|
['PureCloud OAuth'],
|
|
2505
2845
|
['application/json'],
|
|
2506
|
-
['application/json']
|
|
2846
|
+
['application/json'],
|
|
2847
|
+
opts['customHeaders']
|
|
2507
2848
|
);
|
|
2508
2849
|
}
|
|
2509
2850
|
|
|
@@ -2512,8 +2853,12 @@ class UsersApi {
|
|
|
2512
2853
|
*
|
|
2513
2854
|
* @param {String} subjectId Subject ID (user or group)
|
|
2514
2855
|
* @param {Object} body Pairs of role and division IDs
|
|
2856
|
+
* @param {Object} opts Optional parameters
|
|
2857
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2515
2858
|
*/
|
|
2516
|
-
postAuthorizationSubjectBulkremove(subjectId, body) {
|
|
2859
|
+
postAuthorizationSubjectBulkremove(subjectId, body, opts) {
|
|
2860
|
+
opts = opts || {};
|
|
2861
|
+
|
|
2517
2862
|
// verify the required parameter 'subjectId' is set
|
|
2518
2863
|
if (subjectId === undefined || subjectId === null || subjectId === '') {
|
|
2519
2864
|
throw 'Missing the required parameter "subjectId" when calling postAuthorizationSubjectBulkremove';
|
|
@@ -2533,7 +2878,8 @@ class UsersApi {
|
|
|
2533
2878
|
body,
|
|
2534
2879
|
['PureCloud OAuth'],
|
|
2535
2880
|
['application/json'],
|
|
2536
|
-
['application/json']
|
|
2881
|
+
['application/json'],
|
|
2882
|
+
opts['customHeaders']
|
|
2537
2883
|
);
|
|
2538
2884
|
}
|
|
2539
2885
|
|
|
@@ -2544,6 +2890,7 @@ class UsersApi {
|
|
|
2544
2890
|
* @param {Object} body Pairs of role and division IDs
|
|
2545
2891
|
* @param {Object} opts Optional parameters
|
|
2546
2892
|
* @param {String} opts.subjectType what the type of the subject is (PC_GROUP, PC_USER or PC_OAUTH_CLIENT) (default to PC_USER)
|
|
2893
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2547
2894
|
*/
|
|
2548
2895
|
postAuthorizationSubjectBulkreplace(subjectId, body, opts) {
|
|
2549
2896
|
opts = opts || {};
|
|
@@ -2567,7 +2914,8 @@ class UsersApi {
|
|
|
2567
2914
|
body,
|
|
2568
2915
|
['PureCloud OAuth'],
|
|
2569
2916
|
['application/json'],
|
|
2570
|
-
['application/json']
|
|
2917
|
+
['application/json'],
|
|
2918
|
+
opts['customHeaders']
|
|
2571
2919
|
);
|
|
2572
2920
|
}
|
|
2573
2921
|
|
|
@@ -2579,6 +2927,7 @@ class UsersApi {
|
|
|
2579
2927
|
* @param {String} roleId the id of the role to grant
|
|
2580
2928
|
* @param {Object} opts Optional parameters
|
|
2581
2929
|
* @param {String} opts.subjectType what the type of the subject is: PC_GROUP, PC_USER or PC_OAUTH_CLIENT (note: for cross-org authorization, please use the Organization Authorization endpoints) (default to PC_USER)
|
|
2930
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2582
2931
|
*/
|
|
2583
2932
|
postAuthorizationSubjectDivisionRole(subjectId, divisionId, roleId, opts) {
|
|
2584
2933
|
opts = opts || {};
|
|
@@ -2606,7 +2955,8 @@ class UsersApi {
|
|
|
2606
2955
|
null,
|
|
2607
2956
|
['PureCloud OAuth'],
|
|
2608
2957
|
['application/json'],
|
|
2609
|
-
['application/json']
|
|
2958
|
+
['application/json'],
|
|
2959
|
+
opts['customHeaders']
|
|
2610
2960
|
);
|
|
2611
2961
|
}
|
|
2612
2962
|
|
|
@@ -2615,8 +2965,12 @@ class UsersApi {
|
|
|
2615
2965
|
* Authority Name and External key are case sensitive.
|
|
2616
2966
|
* @param {String} userId User ID
|
|
2617
2967
|
* @param {Object} body
|
|
2968
|
+
* @param {Object} opts Optional parameters
|
|
2969
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2618
2970
|
*/
|
|
2619
|
-
postUserExternalid(userId, body) {
|
|
2971
|
+
postUserExternalid(userId, body, opts) {
|
|
2972
|
+
opts = opts || {};
|
|
2973
|
+
|
|
2620
2974
|
// verify the required parameter 'userId' is set
|
|
2621
2975
|
if (userId === undefined || userId === null || userId === '') {
|
|
2622
2976
|
throw 'Missing the required parameter "userId" when calling postUserExternalid';
|
|
@@ -2636,7 +2990,8 @@ class UsersApi {
|
|
|
2636
2990
|
body,
|
|
2637
2991
|
['PureCloud OAuth'],
|
|
2638
2992
|
['application/json'],
|
|
2639
|
-
['application/json']
|
|
2993
|
+
['application/json'],
|
|
2994
|
+
opts['customHeaders']
|
|
2640
2995
|
);
|
|
2641
2996
|
}
|
|
2642
2997
|
|
|
@@ -2646,6 +3001,7 @@ class UsersApi {
|
|
|
2646
3001
|
* @param {String} userId User ID
|
|
2647
3002
|
* @param {Object} opts Optional parameters
|
|
2648
3003
|
* @param {Boolean} opts.force Resend the invitation even if one is already outstanding (default to false)
|
|
3004
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2649
3005
|
*/
|
|
2650
3006
|
postUserInvite(userId, opts) {
|
|
2651
3007
|
opts = opts || {};
|
|
@@ -2665,7 +3021,8 @@ class UsersApi {
|
|
|
2665
3021
|
null,
|
|
2666
3022
|
['PureCloud OAuth'],
|
|
2667
3023
|
['application/json'],
|
|
2668
|
-
['application/json']
|
|
3024
|
+
['application/json'],
|
|
3025
|
+
opts['customHeaders']
|
|
2669
3026
|
);
|
|
2670
3027
|
}
|
|
2671
3028
|
|
|
@@ -2674,8 +3031,12 @@ class UsersApi {
|
|
|
2674
3031
|
*
|
|
2675
3032
|
* @param {String} userId User ID
|
|
2676
3033
|
* @param {Object} body Password
|
|
3034
|
+
* @param {Object} opts Optional parameters
|
|
3035
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2677
3036
|
*/
|
|
2678
|
-
postUserPassword(userId, body) {
|
|
3037
|
+
postUserPassword(userId, body, opts) {
|
|
3038
|
+
opts = opts || {};
|
|
3039
|
+
|
|
2679
3040
|
// verify the required parameter 'userId' is set
|
|
2680
3041
|
if (userId === undefined || userId === null || userId === '') {
|
|
2681
3042
|
throw 'Missing the required parameter "userId" when calling postUserPassword';
|
|
@@ -2695,7 +3056,8 @@ class UsersApi {
|
|
|
2695
3056
|
body,
|
|
2696
3057
|
['PureCloud OAuth'],
|
|
2697
3058
|
['application/json'],
|
|
2698
|
-
['application/json']
|
|
3059
|
+
['application/json'],
|
|
3060
|
+
opts['customHeaders']
|
|
2699
3061
|
);
|
|
2700
3062
|
}
|
|
2701
3063
|
|
|
@@ -2704,8 +3066,12 @@ class UsersApi {
|
|
|
2704
3066
|
*
|
|
2705
3067
|
* @param {String} userId User ID
|
|
2706
3068
|
* @param {Object} body Language
|
|
3069
|
+
* @param {Object} opts Optional parameters
|
|
3070
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2707
3071
|
*/
|
|
2708
|
-
postUserRoutinglanguages(userId, body) {
|
|
3072
|
+
postUserRoutinglanguages(userId, body, opts) {
|
|
3073
|
+
opts = opts || {};
|
|
3074
|
+
|
|
2709
3075
|
// verify the required parameter 'userId' is set
|
|
2710
3076
|
if (userId === undefined || userId === null || userId === '') {
|
|
2711
3077
|
throw 'Missing the required parameter "userId" when calling postUserRoutinglanguages';
|
|
@@ -2725,7 +3091,8 @@ class UsersApi {
|
|
|
2725
3091
|
body,
|
|
2726
3092
|
['PureCloud OAuth'],
|
|
2727
3093
|
['application/json'],
|
|
2728
|
-
['application/json']
|
|
3094
|
+
['application/json'],
|
|
3095
|
+
opts['customHeaders']
|
|
2729
3096
|
);
|
|
2730
3097
|
}
|
|
2731
3098
|
|
|
@@ -2734,8 +3101,12 @@ class UsersApi {
|
|
|
2734
3101
|
*
|
|
2735
3102
|
* @param {String} userId User ID
|
|
2736
3103
|
* @param {Object} body Skill
|
|
3104
|
+
* @param {Object} opts Optional parameters
|
|
3105
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2737
3106
|
*/
|
|
2738
|
-
postUserRoutingskills(userId, body) {
|
|
3107
|
+
postUserRoutingskills(userId, body, opts) {
|
|
3108
|
+
opts = opts || {};
|
|
3109
|
+
|
|
2739
3110
|
// verify the required parameter 'userId' is set
|
|
2740
3111
|
if (userId === undefined || userId === null || userId === '') {
|
|
2741
3112
|
throw 'Missing the required parameter "userId" when calling postUserRoutingskills';
|
|
@@ -2755,7 +3126,8 @@ class UsersApi {
|
|
|
2755
3126
|
body,
|
|
2756
3127
|
['PureCloud OAuth'],
|
|
2757
3128
|
['application/json'],
|
|
2758
|
-
['application/json']
|
|
3129
|
+
['application/json'],
|
|
3130
|
+
opts['customHeaders']
|
|
2759
3131
|
);
|
|
2760
3132
|
}
|
|
2761
3133
|
|
|
@@ -2763,8 +3135,12 @@ class UsersApi {
|
|
|
2763
3135
|
* Create user
|
|
2764
3136
|
* If user creation is successful but the provided password is invalid or configuration fails, POST api/v2/users/{userId}/password can be used to re-attempt password configuration.
|
|
2765
3137
|
* @param {Object} body User
|
|
3138
|
+
* @param {Object} opts Optional parameters
|
|
3139
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2766
3140
|
*/
|
|
2767
|
-
postUsers(body) {
|
|
3141
|
+
postUsers(body, opts) {
|
|
3142
|
+
opts = opts || {};
|
|
3143
|
+
|
|
2768
3144
|
// verify the required parameter 'body' is set
|
|
2769
3145
|
if (body === undefined || body === null) {
|
|
2770
3146
|
throw 'Missing the required parameter "body" when calling postUsers';
|
|
@@ -2780,7 +3156,8 @@ class UsersApi {
|
|
|
2780
3156
|
body,
|
|
2781
3157
|
['PureCloud OAuth'],
|
|
2782
3158
|
['application/json'],
|
|
2783
|
-
['application/json']
|
|
3159
|
+
['application/json'],
|
|
3160
|
+
opts['customHeaders']
|
|
2784
3161
|
);
|
|
2785
3162
|
}
|
|
2786
3163
|
|
|
@@ -2788,9 +3165,12 @@ class UsersApi {
|
|
|
2788
3165
|
* Create a schema
|
|
2789
3166
|
*
|
|
2790
3167
|
* @param {Object} body Schema
|
|
2791
|
-
*
|
|
3168
|
+
* @param {Object} opts Optional parameters
|
|
3169
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2792
3170
|
*/
|
|
2793
|
-
postUsersCustomattributesSchemas(body) {
|
|
3171
|
+
postUsersCustomattributesSchemas(body, opts) {
|
|
3172
|
+
opts = opts || {};
|
|
3173
|
+
|
|
2794
3174
|
// verify the required parameter 'body' is set
|
|
2795
3175
|
if (body === undefined || body === null) {
|
|
2796
3176
|
throw 'Missing the required parameter "body" when calling postUsersCustomattributesSchemas';
|
|
@@ -2806,7 +3186,8 @@ class UsersApi {
|
|
|
2806
3186
|
body,
|
|
2807
3187
|
['PureCloud OAuth'],
|
|
2808
3188
|
['application/json'],
|
|
2809
|
-
['application/json']
|
|
3189
|
+
['application/json'],
|
|
3190
|
+
opts['customHeaders']
|
|
2810
3191
|
);
|
|
2811
3192
|
}
|
|
2812
3193
|
|
|
@@ -2814,8 +3195,12 @@ class UsersApi {
|
|
|
2814
3195
|
* Retrieve aggregated development activity data
|
|
2815
3196
|
* Results are filtered based on the applicable permissions.
|
|
2816
3197
|
* @param {Object} body Aggregate Request
|
|
3198
|
+
* @param {Object} opts Optional parameters
|
|
3199
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2817
3200
|
*/
|
|
2818
|
-
postUsersDevelopmentActivitiesAggregatesQuery(body) {
|
|
3201
|
+
postUsersDevelopmentActivitiesAggregatesQuery(body, opts) {
|
|
3202
|
+
opts = opts || {};
|
|
3203
|
+
|
|
2819
3204
|
// verify the required parameter 'body' is set
|
|
2820
3205
|
if (body === undefined || body === null) {
|
|
2821
3206
|
throw 'Missing the required parameter "body" when calling postUsersDevelopmentActivitiesAggregatesQuery';
|
|
@@ -2831,7 +3216,8 @@ class UsersApi {
|
|
|
2831
3216
|
body,
|
|
2832
3217
|
['PureCloud OAuth'],
|
|
2833
3218
|
['application/json'],
|
|
2834
|
-
['application/json']
|
|
3219
|
+
['application/json'],
|
|
3220
|
+
opts['customHeaders']
|
|
2835
3221
|
);
|
|
2836
3222
|
}
|
|
2837
3223
|
|
|
@@ -2839,8 +3225,12 @@ class UsersApi {
|
|
|
2839
3225
|
* Change your password
|
|
2840
3226
|
*
|
|
2841
3227
|
* @param {Object} body Password
|
|
3228
|
+
* @param {Object} opts Optional parameters
|
|
3229
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2842
3230
|
*/
|
|
2843
|
-
postUsersMePassword(body) {
|
|
3231
|
+
postUsersMePassword(body, opts) {
|
|
3232
|
+
opts = opts || {};
|
|
3233
|
+
|
|
2844
3234
|
// verify the required parameter 'body' is set
|
|
2845
3235
|
if (body === undefined || body === null) {
|
|
2846
3236
|
throw 'Missing the required parameter "body" when calling postUsersMePassword';
|
|
@@ -2856,7 +3246,8 @@ class UsersApi {
|
|
|
2856
3246
|
body,
|
|
2857
3247
|
['PureCloud OAuth'],
|
|
2858
3248
|
['application/json'],
|
|
2859
|
-
['application/json']
|
|
3249
|
+
['application/json'],
|
|
3250
|
+
opts['customHeaders']
|
|
2860
3251
|
);
|
|
2861
3252
|
}
|
|
2862
3253
|
|
|
@@ -2864,8 +3255,12 @@ class UsersApi {
|
|
|
2864
3255
|
* Search users
|
|
2865
3256
|
*
|
|
2866
3257
|
* @param {Object} body Search request options
|
|
3258
|
+
* @param {Object} opts Optional parameters
|
|
3259
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2867
3260
|
*/
|
|
2868
|
-
postUsersSearch(body) {
|
|
3261
|
+
postUsersSearch(body, opts) {
|
|
3262
|
+
opts = opts || {};
|
|
3263
|
+
|
|
2869
3264
|
// verify the required parameter 'body' is set
|
|
2870
3265
|
if (body === undefined || body === null) {
|
|
2871
3266
|
throw 'Missing the required parameter "body" when calling postUsersSearch';
|
|
@@ -2881,7 +3276,8 @@ class UsersApi {
|
|
|
2881
3276
|
body,
|
|
2882
3277
|
['PureCloud OAuth'],
|
|
2883
3278
|
['application/json'],
|
|
2884
|
-
['application/json']
|
|
3279
|
+
['application/json'],
|
|
3280
|
+
opts['customHeaders']
|
|
2885
3281
|
);
|
|
2886
3282
|
}
|
|
2887
3283
|
|
|
@@ -2889,9 +3285,13 @@ class UsersApi {
|
|
|
2889
3285
|
* Search users as conversation targets
|
|
2890
3286
|
*
|
|
2891
3287
|
* @param {Object} body Search request options
|
|
3288
|
+
* @param {Object} opts Optional parameters
|
|
3289
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2892
3290
|
* postUsersSearchConversationTarget is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2893
3291
|
*/
|
|
2894
|
-
postUsersSearchConversationTarget(body) {
|
|
3292
|
+
postUsersSearchConversationTarget(body, opts) {
|
|
3293
|
+
opts = opts || {};
|
|
3294
|
+
|
|
2895
3295
|
// verify the required parameter 'body' is set
|
|
2896
3296
|
if (body === undefined || body === null) {
|
|
2897
3297
|
throw 'Missing the required parameter "body" when calling postUsersSearchConversationTarget';
|
|
@@ -2907,7 +3307,8 @@ class UsersApi {
|
|
|
2907
3307
|
body,
|
|
2908
3308
|
['PureCloud OAuth'],
|
|
2909
3309
|
['application/json'],
|
|
2910
|
-
['application/json']
|
|
3310
|
+
['application/json'],
|
|
3311
|
+
opts['customHeaders']
|
|
2911
3312
|
);
|
|
2912
3313
|
}
|
|
2913
3314
|
|
|
@@ -2915,9 +3316,13 @@ class UsersApi {
|
|
|
2915
3316
|
* Search manage queue member
|
|
2916
3317
|
*
|
|
2917
3318
|
* @param {Object} body Search request options
|
|
3319
|
+
* @param {Object} opts Optional parameters
|
|
3320
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2918
3321
|
* postUsersSearchQueuemembersManage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2919
3322
|
*/
|
|
2920
|
-
postUsersSearchQueuemembersManage(body) {
|
|
3323
|
+
postUsersSearchQueuemembersManage(body, opts) {
|
|
3324
|
+
opts = opts || {};
|
|
3325
|
+
|
|
2921
3326
|
// verify the required parameter 'body' is set
|
|
2922
3327
|
if (body === undefined || body === null) {
|
|
2923
3328
|
throw 'Missing the required parameter "body" when calling postUsersSearchQueuemembersManage';
|
|
@@ -2933,7 +3338,8 @@ class UsersApi {
|
|
|
2933
3338
|
body,
|
|
2934
3339
|
['PureCloud OAuth'],
|
|
2935
3340
|
['application/json'],
|
|
2936
|
-
['application/json']
|
|
3341
|
+
['application/json'],
|
|
3342
|
+
opts['customHeaders']
|
|
2937
3343
|
);
|
|
2938
3344
|
}
|
|
2939
3345
|
|
|
@@ -2941,8 +3347,12 @@ class UsersApi {
|
|
|
2941
3347
|
* Search users assigned to teams
|
|
2942
3348
|
*
|
|
2943
3349
|
* @param {Object} body Search request options
|
|
3350
|
+
* @param {Object} opts Optional parameters
|
|
3351
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2944
3352
|
*/
|
|
2945
|
-
postUsersSearchTeamsAssign(body) {
|
|
3353
|
+
postUsersSearchTeamsAssign(body, opts) {
|
|
3354
|
+
opts = opts || {};
|
|
3355
|
+
|
|
2946
3356
|
// verify the required parameter 'body' is set
|
|
2947
3357
|
if (body === undefined || body === null) {
|
|
2948
3358
|
throw 'Missing the required parameter "body" when calling postUsersSearchTeamsAssign';
|
|
@@ -2958,7 +3368,8 @@ class UsersApi {
|
|
|
2958
3368
|
body,
|
|
2959
3369
|
['PureCloud OAuth'],
|
|
2960
3370
|
['application/json'],
|
|
2961
|
-
['application/json']
|
|
3371
|
+
['application/json'],
|
|
3372
|
+
opts['customHeaders']
|
|
2962
3373
|
);
|
|
2963
3374
|
}
|
|
2964
3375
|
|
|
@@ -2966,8 +3377,12 @@ class UsersApi {
|
|
|
2966
3377
|
* Update the user's Direct Routing Backup settings.
|
|
2967
3378
|
*
|
|
2968
3379
|
* @param {Object} body directRoutingBackup
|
|
3380
|
+
* @param {Object} opts Optional parameters
|
|
3381
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2969
3382
|
*/
|
|
2970
|
-
putRoutingDirectroutingbackupSettingsMe(body) {
|
|
3383
|
+
putRoutingDirectroutingbackupSettingsMe(body, opts) {
|
|
3384
|
+
opts = opts || {};
|
|
3385
|
+
|
|
2971
3386
|
// verify the required parameter 'body' is set
|
|
2972
3387
|
if (body === undefined || body === null) {
|
|
2973
3388
|
throw 'Missing the required parameter "body" when calling putRoutingDirectroutingbackupSettingsMe';
|
|
@@ -2983,7 +3398,8 @@ class UsersApi {
|
|
|
2983
3398
|
body,
|
|
2984
3399
|
['PureCloud OAuth'],
|
|
2985
3400
|
['application/json'],
|
|
2986
|
-
['application/json']
|
|
3401
|
+
['application/json'],
|
|
3402
|
+
opts['customHeaders']
|
|
2987
3403
|
);
|
|
2988
3404
|
}
|
|
2989
3405
|
|
|
@@ -2992,8 +3408,12 @@ class UsersApi {
|
|
|
2992
3408
|
*
|
|
2993
3409
|
* @param {String} userId User ID
|
|
2994
3410
|
* @param {Object} body directRoutingBackup
|
|
3411
|
+
* @param {Object} opts Optional parameters
|
|
3412
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2995
3413
|
*/
|
|
2996
|
-
putRoutingUserDirectroutingbackupSettings(userId, body) {
|
|
3414
|
+
putRoutingUserDirectroutingbackupSettings(userId, body, opts) {
|
|
3415
|
+
opts = opts || {};
|
|
3416
|
+
|
|
2997
3417
|
// verify the required parameter 'userId' is set
|
|
2998
3418
|
if (userId === undefined || userId === null || userId === '') {
|
|
2999
3419
|
throw 'Missing the required parameter "userId" when calling putRoutingUserDirectroutingbackupSettings';
|
|
@@ -3013,7 +3433,8 @@ class UsersApi {
|
|
|
3013
3433
|
body,
|
|
3014
3434
|
['PureCloud OAuth'],
|
|
3015
3435
|
['application/json'],
|
|
3016
|
-
['application/json']
|
|
3436
|
+
['application/json'],
|
|
3437
|
+
opts['customHeaders']
|
|
3017
3438
|
);
|
|
3018
3439
|
}
|
|
3019
3440
|
|
|
@@ -3022,8 +3443,12 @@ class UsersApi {
|
|
|
3022
3443
|
*
|
|
3023
3444
|
* @param {String} userId User ID
|
|
3024
3445
|
* @param {Object} body utilization
|
|
3446
|
+
* @param {Object} opts Optional parameters
|
|
3447
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3025
3448
|
*/
|
|
3026
|
-
putRoutingUserUtilization(userId, body) {
|
|
3449
|
+
putRoutingUserUtilization(userId, body, opts) {
|
|
3450
|
+
opts = opts || {};
|
|
3451
|
+
|
|
3027
3452
|
// verify the required parameter 'userId' is set
|
|
3028
3453
|
if (userId === undefined || userId === null || userId === '') {
|
|
3029
3454
|
throw 'Missing the required parameter "userId" when calling putRoutingUserUtilization';
|
|
@@ -3043,7 +3468,8 @@ class UsersApi {
|
|
|
3043
3468
|
body,
|
|
3044
3469
|
['PureCloud OAuth'],
|
|
3045
3470
|
['application/json'],
|
|
3046
|
-
['application/json']
|
|
3471
|
+
['application/json'],
|
|
3472
|
+
opts['customHeaders']
|
|
3047
3473
|
);
|
|
3048
3474
|
}
|
|
3049
3475
|
|
|
@@ -3052,8 +3478,12 @@ class UsersApi {
|
|
|
3052
3478
|
*
|
|
3053
3479
|
* @param {String} userId User ID
|
|
3054
3480
|
* @param {Object} body Call forwarding
|
|
3481
|
+
* @param {Object} opts Optional parameters
|
|
3482
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3055
3483
|
*/
|
|
3056
|
-
putUserCallforwarding(userId, body) {
|
|
3484
|
+
putUserCallforwarding(userId, body, opts) {
|
|
3485
|
+
opts = opts || {};
|
|
3486
|
+
|
|
3057
3487
|
// verify the required parameter 'userId' is set
|
|
3058
3488
|
if (userId === undefined || userId === null || userId === '') {
|
|
3059
3489
|
throw 'Missing the required parameter "userId" when calling putUserCallforwarding';
|
|
@@ -3073,7 +3503,8 @@ class UsersApi {
|
|
|
3073
3503
|
body,
|
|
3074
3504
|
['PureCloud OAuth'],
|
|
3075
3505
|
['application/json'],
|
|
3076
|
-
['application/json']
|
|
3506
|
+
['application/json'],
|
|
3507
|
+
opts['customHeaders']
|
|
3077
3508
|
);
|
|
3078
3509
|
}
|
|
3079
3510
|
|
|
@@ -3082,9 +3513,12 @@ class UsersApi {
|
|
|
3082
3513
|
*
|
|
3083
3514
|
* @param {String} userId user ID
|
|
3084
3515
|
* @param {Object} userCustomAttributes
|
|
3085
|
-
*
|
|
3516
|
+
* @param {Object} opts Optional parameters
|
|
3517
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3086
3518
|
*/
|
|
3087
|
-
putUserCustomattributes(userId, userCustomAttributes) {
|
|
3519
|
+
putUserCustomattributes(userId, userCustomAttributes, opts) {
|
|
3520
|
+
opts = opts || {};
|
|
3521
|
+
|
|
3088
3522
|
// verify the required parameter 'userId' is set
|
|
3089
3523
|
if (userId === undefined || userId === null || userId === '') {
|
|
3090
3524
|
throw 'Missing the required parameter "userId" when calling putUserCustomattributes';
|
|
@@ -3104,7 +3538,8 @@ class UsersApi {
|
|
|
3104
3538
|
userCustomAttributes,
|
|
3105
3539
|
['PureCloud OAuth'],
|
|
3106
3540
|
['application/json'],
|
|
3107
|
-
['application/json']
|
|
3541
|
+
['application/json'],
|
|
3542
|
+
opts['customHeaders']
|
|
3108
3543
|
);
|
|
3109
3544
|
}
|
|
3110
3545
|
|
|
@@ -3113,8 +3548,12 @@ class UsersApi {
|
|
|
3113
3548
|
*
|
|
3114
3549
|
* @param {String} userId User ID
|
|
3115
3550
|
* @param {Object} body The updated OutOffOffice
|
|
3551
|
+
* @param {Object} opts Optional parameters
|
|
3552
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3116
3553
|
*/
|
|
3117
|
-
putUserOutofoffice(userId, body) {
|
|
3554
|
+
putUserOutofoffice(userId, body, opts) {
|
|
3555
|
+
opts = opts || {};
|
|
3556
|
+
|
|
3118
3557
|
// verify the required parameter 'userId' is set
|
|
3119
3558
|
if (userId === undefined || userId === null || userId === '') {
|
|
3120
3559
|
throw 'Missing the required parameter "userId" when calling putUserOutofoffice';
|
|
@@ -3134,7 +3573,8 @@ class UsersApi {
|
|
|
3134
3573
|
body,
|
|
3135
3574
|
['PureCloud OAuth'],
|
|
3136
3575
|
['application/json'],
|
|
3137
|
-
['application/json']
|
|
3576
|
+
['application/json'],
|
|
3577
|
+
opts['customHeaders']
|
|
3138
3578
|
);
|
|
3139
3579
|
}
|
|
3140
3580
|
|
|
@@ -3143,8 +3583,12 @@ class UsersApi {
|
|
|
3143
3583
|
*
|
|
3144
3584
|
* @param {String} userId User ID
|
|
3145
3585
|
* @param {Array.<String>} body Skills
|
|
3586
|
+
* @param {Object} opts Optional parameters
|
|
3587
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3146
3588
|
*/
|
|
3147
|
-
putUserProfileskills(userId, body) {
|
|
3589
|
+
putUserProfileskills(userId, body, opts) {
|
|
3590
|
+
opts = opts || {};
|
|
3591
|
+
|
|
3148
3592
|
// verify the required parameter 'userId' is set
|
|
3149
3593
|
if (userId === undefined || userId === null || userId === '') {
|
|
3150
3594
|
throw 'Missing the required parameter "userId" when calling putUserProfileskills';
|
|
@@ -3164,7 +3608,8 @@ class UsersApi {
|
|
|
3164
3608
|
body,
|
|
3165
3609
|
['PureCloud OAuth'],
|
|
3166
3610
|
['application/json'],
|
|
3167
|
-
['application/json']
|
|
3611
|
+
['application/json'],
|
|
3612
|
+
opts['customHeaders']
|
|
3168
3613
|
);
|
|
3169
3614
|
}
|
|
3170
3615
|
|
|
@@ -3173,8 +3618,12 @@ class UsersApi {
|
|
|
3173
3618
|
*
|
|
3174
3619
|
* @param {String} subjectId User ID
|
|
3175
3620
|
* @param {Array.<String>} body List of roles
|
|
3621
|
+
* @param {Object} opts Optional parameters
|
|
3622
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3176
3623
|
*/
|
|
3177
|
-
putUserRoles(subjectId, body) {
|
|
3624
|
+
putUserRoles(subjectId, body, opts) {
|
|
3625
|
+
opts = opts || {};
|
|
3626
|
+
|
|
3178
3627
|
// verify the required parameter 'subjectId' is set
|
|
3179
3628
|
if (subjectId === undefined || subjectId === null || subjectId === '') {
|
|
3180
3629
|
throw 'Missing the required parameter "subjectId" when calling putUserRoles';
|
|
@@ -3194,7 +3643,8 @@ class UsersApi {
|
|
|
3194
3643
|
body,
|
|
3195
3644
|
['PureCloud OAuth'],
|
|
3196
3645
|
['application/json'],
|
|
3197
|
-
['application/json']
|
|
3646
|
+
['application/json'],
|
|
3647
|
+
opts['customHeaders']
|
|
3198
3648
|
);
|
|
3199
3649
|
}
|
|
3200
3650
|
|
|
@@ -3204,8 +3654,12 @@ class UsersApi {
|
|
|
3204
3654
|
* @param {String} userId User ID
|
|
3205
3655
|
* @param {String} skillId skillId
|
|
3206
3656
|
* @param {Object} body Skill
|
|
3657
|
+
* @param {Object} opts Optional parameters
|
|
3658
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3207
3659
|
*/
|
|
3208
|
-
putUserRoutingskill(userId, skillId, body) {
|
|
3660
|
+
putUserRoutingskill(userId, skillId, body, opts) {
|
|
3661
|
+
opts = opts || {};
|
|
3662
|
+
|
|
3209
3663
|
// verify the required parameter 'userId' is set
|
|
3210
3664
|
if (userId === undefined || userId === null || userId === '') {
|
|
3211
3665
|
throw 'Missing the required parameter "userId" when calling putUserRoutingskill';
|
|
@@ -3229,7 +3683,8 @@ class UsersApi {
|
|
|
3229
3683
|
body,
|
|
3230
3684
|
['PureCloud OAuth'],
|
|
3231
3685
|
['application/json'],
|
|
3232
|
-
['application/json']
|
|
3686
|
+
['application/json'],
|
|
3687
|
+
opts['customHeaders']
|
|
3233
3688
|
);
|
|
3234
3689
|
}
|
|
3235
3690
|
|
|
@@ -3238,8 +3693,12 @@ class UsersApi {
|
|
|
3238
3693
|
*
|
|
3239
3694
|
* @param {String} userId User ID
|
|
3240
3695
|
* @param {Array.<Object>} body Skill
|
|
3696
|
+
* @param {Object} opts Optional parameters
|
|
3697
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3241
3698
|
*/
|
|
3242
|
-
putUserRoutingskillsBulk(userId, body) {
|
|
3699
|
+
putUserRoutingskillsBulk(userId, body, opts) {
|
|
3700
|
+
opts = opts || {};
|
|
3701
|
+
|
|
3243
3702
|
// verify the required parameter 'userId' is set
|
|
3244
3703
|
if (userId === undefined || userId === null || userId === '') {
|
|
3245
3704
|
throw 'Missing the required parameter "userId" when calling putUserRoutingskillsBulk';
|
|
@@ -3259,7 +3718,8 @@ class UsersApi {
|
|
|
3259
3718
|
body,
|
|
3260
3719
|
['PureCloud OAuth'],
|
|
3261
3720
|
['application/json'],
|
|
3262
|
-
['application/json']
|
|
3721
|
+
['application/json'],
|
|
3722
|
+
opts['customHeaders']
|
|
3263
3723
|
);
|
|
3264
3724
|
}
|
|
3265
3725
|
|
|
@@ -3268,8 +3728,12 @@ class UsersApi {
|
|
|
3268
3728
|
*
|
|
3269
3729
|
* @param {String} userId User ID
|
|
3270
3730
|
* @param {Object} body Routing Status
|
|
3731
|
+
* @param {Object} opts Optional parameters
|
|
3732
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3271
3733
|
*/
|
|
3272
|
-
putUserRoutingstatus(userId, body) {
|
|
3734
|
+
putUserRoutingstatus(userId, body, opts) {
|
|
3735
|
+
opts = opts || {};
|
|
3736
|
+
|
|
3273
3737
|
// verify the required parameter 'userId' is set
|
|
3274
3738
|
if (userId === undefined || userId === null || userId === '') {
|
|
3275
3739
|
throw 'Missing the required parameter "userId" when calling putUserRoutingstatus';
|
|
@@ -3289,7 +3753,8 @@ class UsersApi {
|
|
|
3289
3753
|
body,
|
|
3290
3754
|
['PureCloud OAuth'],
|
|
3291
3755
|
['application/json'],
|
|
3292
|
-
['application/json']
|
|
3756
|
+
['application/json'],
|
|
3757
|
+
opts['customHeaders']
|
|
3293
3758
|
);
|
|
3294
3759
|
}
|
|
3295
3760
|
|
|
@@ -3298,8 +3763,12 @@ class UsersApi {
|
|
|
3298
3763
|
*
|
|
3299
3764
|
* @param {String} userId User ID
|
|
3300
3765
|
* @param {Object} body User
|
|
3766
|
+
* @param {Object} opts Optional parameters
|
|
3767
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3301
3768
|
*/
|
|
3302
|
-
putUserState(userId, body) {
|
|
3769
|
+
putUserState(userId, body, opts) {
|
|
3770
|
+
opts = opts || {};
|
|
3771
|
+
|
|
3303
3772
|
// verify the required parameter 'userId' is set
|
|
3304
3773
|
if (userId === undefined || userId === null || userId === '') {
|
|
3305
3774
|
throw 'Missing the required parameter "userId" when calling putUserState';
|
|
@@ -3319,7 +3788,8 @@ class UsersApi {
|
|
|
3319
3788
|
body,
|
|
3320
3789
|
['PureCloud OAuth'],
|
|
3321
3790
|
['application/json'],
|
|
3322
|
-
['application/json']
|
|
3791
|
+
['application/json'],
|
|
3792
|
+
opts['customHeaders']
|
|
3323
3793
|
);
|
|
3324
3794
|
}
|
|
3325
3795
|
|
|
@@ -3328,8 +3798,12 @@ class UsersApi {
|
|
|
3328
3798
|
*
|
|
3329
3799
|
* @param {String} userId User ID
|
|
3330
3800
|
* @param {String} stationId stationId
|
|
3801
|
+
* @param {Object} opts Optional parameters
|
|
3802
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3331
3803
|
*/
|
|
3332
|
-
putUserStationAssociatedstationStationId(userId, stationId) {
|
|
3804
|
+
putUserStationAssociatedstationStationId(userId, stationId, opts) {
|
|
3805
|
+
opts = opts || {};
|
|
3806
|
+
|
|
3333
3807
|
// verify the required parameter 'userId' is set
|
|
3334
3808
|
if (userId === undefined || userId === null || userId === '') {
|
|
3335
3809
|
throw 'Missing the required parameter "userId" when calling putUserStationAssociatedstationStationId';
|
|
@@ -3349,7 +3823,8 @@ class UsersApi {
|
|
|
3349
3823
|
null,
|
|
3350
3824
|
['PureCloud OAuth'],
|
|
3351
3825
|
['application/json'],
|
|
3352
|
-
['application/json']
|
|
3826
|
+
['application/json'],
|
|
3827
|
+
opts['customHeaders']
|
|
3353
3828
|
);
|
|
3354
3829
|
}
|
|
3355
3830
|
|
|
@@ -3358,8 +3833,12 @@ class UsersApi {
|
|
|
3358
3833
|
*
|
|
3359
3834
|
* @param {String} userId User ID
|
|
3360
3835
|
* @param {String} stationId stationId
|
|
3836
|
+
* @param {Object} opts Optional parameters
|
|
3837
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3361
3838
|
*/
|
|
3362
|
-
putUserStationDefaultstationStationId(userId, stationId) {
|
|
3839
|
+
putUserStationDefaultstationStationId(userId, stationId, opts) {
|
|
3840
|
+
opts = opts || {};
|
|
3841
|
+
|
|
3363
3842
|
// verify the required parameter 'userId' is set
|
|
3364
3843
|
if (userId === undefined || userId === null || userId === '') {
|
|
3365
3844
|
throw 'Missing the required parameter "userId" when calling putUserStationDefaultstationStationId';
|
|
@@ -3379,7 +3858,8 @@ class UsersApi {
|
|
|
3379
3858
|
null,
|
|
3380
3859
|
['PureCloud OAuth'],
|
|
3381
3860
|
['application/json'],
|
|
3382
|
-
['application/json']
|
|
3861
|
+
['application/json'],
|
|
3862
|
+
opts['customHeaders']
|
|
3383
3863
|
);
|
|
3384
3864
|
}
|
|
3385
3865
|
|
|
@@ -3389,8 +3869,12 @@ class UsersApi {
|
|
|
3389
3869
|
* @param {String} userId User ID
|
|
3390
3870
|
* @param {String} verifierId Verifier ID
|
|
3391
3871
|
* @param {Object} body Verifier Update
|
|
3872
|
+
* @param {Object} opts Optional parameters
|
|
3873
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3392
3874
|
*/
|
|
3393
|
-
putUserVerifier(userId, verifierId, body) {
|
|
3875
|
+
putUserVerifier(userId, verifierId, body, opts) {
|
|
3876
|
+
opts = opts || {};
|
|
3877
|
+
|
|
3394
3878
|
// verify the required parameter 'userId' is set
|
|
3395
3879
|
if (userId === undefined || userId === null || userId === '') {
|
|
3396
3880
|
throw 'Missing the required parameter "userId" when calling putUserVerifier';
|
|
@@ -3414,7 +3898,8 @@ class UsersApi {
|
|
|
3414
3898
|
body,
|
|
3415
3899
|
['PureCloud OAuth'],
|
|
3416
3900
|
['application/json'],
|
|
3417
|
-
['application/json']
|
|
3901
|
+
['application/json'],
|
|
3902
|
+
opts['customHeaders']
|
|
3418
3903
|
);
|
|
3419
3904
|
}
|
|
3420
3905
|
|
|
@@ -3423,9 +3908,12 @@ class UsersApi {
|
|
|
3423
3908
|
*
|
|
3424
3909
|
* @param {String} schemaId Schema ID
|
|
3425
3910
|
* @param {Object} body Data Schema
|
|
3426
|
-
*
|
|
3911
|
+
* @param {Object} opts Optional parameters
|
|
3912
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3427
3913
|
*/
|
|
3428
|
-
putUsersCustomattributesSchema(schemaId, body) {
|
|
3914
|
+
putUsersCustomattributesSchema(schemaId, body, opts) {
|
|
3915
|
+
opts = opts || {};
|
|
3916
|
+
|
|
3429
3917
|
// verify the required parameter 'schemaId' is set
|
|
3430
3918
|
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
3431
3919
|
throw 'Missing the required parameter "schemaId" when calling putUsersCustomattributesSchema';
|
|
@@ -3445,7 +3933,8 @@ class UsersApi {
|
|
|
3445
3933
|
body,
|
|
3446
3934
|
['PureCloud OAuth'],
|
|
3447
3935
|
['application/json'],
|
|
3448
|
-
['application/json']
|
|
3936
|
+
['application/json'],
|
|
3937
|
+
opts['customHeaders']
|
|
3449
3938
|
);
|
|
3450
3939
|
}
|
|
3451
3940
|
|