purecloud-platform-client-v2 200.0.0 → 202.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 +2 -2
- package/dist/node/purecloud-platform-client-v2.js +1349 -125
- package/dist/web-amd/purecloud-platform-client-v2.js +1349 -125
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +432 -133
- package/dist/web-cjs/purecloud-platform-client-v2.js +548 -165
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1121 -241
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +21 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +68 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +36 -31
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +32 -2
- package/src/purecloud-platform-client-v2/api/UsersApi.js +4 -4
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1080 -33
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class OutboundApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Outbound service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 202.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1407,6 +1407,61 @@ class OutboundApi {
|
|
|
1407
1407
|
);
|
|
1408
1408
|
}
|
|
1409
1409
|
|
|
1410
|
+
/**
|
|
1411
|
+
* Get bulk operation job.
|
|
1412
|
+
*
|
|
1413
|
+
* @param {String} contactListId Contact List ID
|
|
1414
|
+
* @param {String} jobId Job ID
|
|
1415
|
+
*/
|
|
1416
|
+
getOutboundContactlistContactsBulkJob(contactListId, jobId) {
|
|
1417
|
+
// verify the required parameter 'contactListId' is set
|
|
1418
|
+
if (contactListId === undefined || contactListId === null) {
|
|
1419
|
+
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJob';
|
|
1420
|
+
}
|
|
1421
|
+
// verify the required parameter 'jobId' is set
|
|
1422
|
+
if (jobId === undefined || jobId === null) {
|
|
1423
|
+
throw 'Missing the required parameter "jobId" when calling getOutboundContactlistContactsBulkJob';
|
|
1424
|
+
}
|
|
1425
|
+
|
|
1426
|
+
return this.apiClient.callApi(
|
|
1427
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs/{jobId}',
|
|
1428
|
+
'GET',
|
|
1429
|
+
{ 'contactListId': contactListId,'jobId': jobId },
|
|
1430
|
+
{ },
|
|
1431
|
+
{ },
|
|
1432
|
+
{ },
|
|
1433
|
+
null,
|
|
1434
|
+
['PureCloud OAuth'],
|
|
1435
|
+
['application/json'],
|
|
1436
|
+
['application/json']
|
|
1437
|
+
);
|
|
1438
|
+
}
|
|
1439
|
+
|
|
1440
|
+
/**
|
|
1441
|
+
* Get 10 most recent bulk operation jobs associated with contact list.
|
|
1442
|
+
*
|
|
1443
|
+
* @param {String} contactListId Contact List ID
|
|
1444
|
+
*/
|
|
1445
|
+
getOutboundContactlistContactsBulkJobs(contactListId) {
|
|
1446
|
+
// verify the required parameter 'contactListId' is set
|
|
1447
|
+
if (contactListId === undefined || contactListId === null) {
|
|
1448
|
+
throw 'Missing the required parameter "contactListId" when calling getOutboundContactlistContactsBulkJobs';
|
|
1449
|
+
}
|
|
1450
|
+
|
|
1451
|
+
return this.apiClient.callApi(
|
|
1452
|
+
'/api/v2/outbound/contactlists/{contactListId}/contacts/bulk/jobs',
|
|
1453
|
+
'GET',
|
|
1454
|
+
{ 'contactListId': contactListId },
|
|
1455
|
+
{ },
|
|
1456
|
+
{ },
|
|
1457
|
+
{ },
|
|
1458
|
+
null,
|
|
1459
|
+
['PureCloud OAuth'],
|
|
1460
|
+
['application/json'],
|
|
1461
|
+
['application/json']
|
|
1462
|
+
);
|
|
1463
|
+
}
|
|
1464
|
+
|
|
1410
1465
|
/**
|
|
1411
1466
|
* Get the URI of a contact list export.
|
|
1412
1467
|
*
|
|
@@ -5,7 +5,7 @@ class RecordingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Recording service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 202.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -490,7 +490,7 @@ class RecordingApi {
|
|
|
490
490
|
}
|
|
491
491
|
|
|
492
492
|
/**
|
|
493
|
-
* Get the status and results for a batch request job, only the user that submitted the job may retrieve results
|
|
493
|
+
* Get the status and results for a batch request job, only the user that submitted the job may retrieve results. Each result may contain either a URL to a recording or an error; additionally, a recording could be associated with multiple results.
|
|
494
494
|
*
|
|
495
495
|
* @param {String} jobId jobId
|
|
496
496
|
*/
|
|
@@ -5,7 +5,7 @@ class TaskManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TaskManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 202.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -952,16 +952,17 @@ class TaskManagementApi {
|
|
|
952
952
|
* Update the attributes of a worktype
|
|
953
953
|
*
|
|
954
954
|
* @param {String} worktypeId Worktype id
|
|
955
|
-
* @param {Object}
|
|
956
|
-
* @param {Object} opts.body body
|
|
955
|
+
* @param {Object} body Worktype
|
|
957
956
|
*/
|
|
958
|
-
patchTaskmanagementWorktype(worktypeId,
|
|
959
|
-
opts = opts || {};
|
|
960
|
-
|
|
957
|
+
patchTaskmanagementWorktype(worktypeId, body) {
|
|
961
958
|
// verify the required parameter 'worktypeId' is set
|
|
962
959
|
if (worktypeId === undefined || worktypeId === null) {
|
|
963
960
|
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktype';
|
|
964
961
|
}
|
|
962
|
+
// verify the required parameter 'body' is set
|
|
963
|
+
if (body === undefined || body === null) {
|
|
964
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktype';
|
|
965
|
+
}
|
|
965
966
|
|
|
966
967
|
return this.apiClient.callApi(
|
|
967
968
|
'/api/v2/taskmanagement/worktypes/{worktypeId}',
|
|
@@ -970,7 +971,7 @@ class TaskManagementApi {
|
|
|
970
971
|
{ },
|
|
971
972
|
{ },
|
|
972
973
|
{ },
|
|
973
|
-
|
|
974
|
+
body,
|
|
974
975
|
['PureCloud OAuth'],
|
|
975
976
|
['application/json'],
|
|
976
977
|
['application/json']
|
|
@@ -982,12 +983,9 @@ class TaskManagementApi {
|
|
|
982
983
|
*
|
|
983
984
|
* @param {String} worktypeId Worktype id
|
|
984
985
|
* @param {String} statusId Status id
|
|
985
|
-
* @param {Object}
|
|
986
|
-
* @param {Object} opts.body body
|
|
986
|
+
* @param {Object} body Status
|
|
987
987
|
*/
|
|
988
|
-
patchTaskmanagementWorktypeStatus(worktypeId, statusId,
|
|
989
|
-
opts = opts || {};
|
|
990
|
-
|
|
988
|
+
patchTaskmanagementWorktypeStatus(worktypeId, statusId, body) {
|
|
991
989
|
// verify the required parameter 'worktypeId' is set
|
|
992
990
|
if (worktypeId === undefined || worktypeId === null) {
|
|
993
991
|
throw 'Missing the required parameter "worktypeId" when calling patchTaskmanagementWorktypeStatus';
|
|
@@ -996,6 +994,10 @@ class TaskManagementApi {
|
|
|
996
994
|
if (statusId === undefined || statusId === null) {
|
|
997
995
|
throw 'Missing the required parameter "statusId" when calling patchTaskmanagementWorktypeStatus';
|
|
998
996
|
}
|
|
997
|
+
// verify the required parameter 'body' is set
|
|
998
|
+
if (body === undefined || body === null) {
|
|
999
|
+
throw 'Missing the required parameter "body" when calling patchTaskmanagementWorktypeStatus';
|
|
1000
|
+
}
|
|
999
1001
|
|
|
1000
1002
|
return this.apiClient.callApi(
|
|
1001
1003
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/statuses/{statusId}',
|
|
@@ -1004,7 +1006,7 @@ class TaskManagementApi {
|
|
|
1004
1006
|
{ },
|
|
1005
1007
|
{ },
|
|
1006
1008
|
{ },
|
|
1007
|
-
|
|
1009
|
+
body,
|
|
1008
1010
|
['PureCloud OAuth'],
|
|
1009
1011
|
['application/json'],
|
|
1010
1012
|
['application/json']
|
|
@@ -1014,12 +1016,13 @@ class TaskManagementApi {
|
|
|
1014
1016
|
/**
|
|
1015
1017
|
* Create a workbin
|
|
1016
1018
|
*
|
|
1017
|
-
* @param {Object}
|
|
1018
|
-
* @param {Object} opts.body body
|
|
1019
|
+
* @param {Object} body Workbin
|
|
1019
1020
|
*/
|
|
1020
|
-
postTaskmanagementWorkbins(
|
|
1021
|
-
|
|
1022
|
-
|
|
1021
|
+
postTaskmanagementWorkbins(body) {
|
|
1022
|
+
// verify the required parameter 'body' is set
|
|
1023
|
+
if (body === undefined || body === null) {
|
|
1024
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorkbins';
|
|
1025
|
+
}
|
|
1023
1026
|
|
|
1024
1027
|
return this.apiClient.callApi(
|
|
1025
1028
|
'/api/v2/taskmanagement/workbins',
|
|
@@ -1028,7 +1031,7 @@ class TaskManagementApi {
|
|
|
1028
1031
|
{ },
|
|
1029
1032
|
{ },
|
|
1030
1033
|
{ },
|
|
1031
|
-
|
|
1034
|
+
body,
|
|
1032
1035
|
['PureCloud OAuth'],
|
|
1033
1036
|
['application/json'],
|
|
1034
1037
|
['application/json']
|
|
@@ -1244,16 +1247,17 @@ class TaskManagementApi {
|
|
|
1244
1247
|
* Add a status to a worktype
|
|
1245
1248
|
*
|
|
1246
1249
|
* @param {String} worktypeId Worktype id
|
|
1247
|
-
* @param {Object}
|
|
1248
|
-
* @param {Object} opts.body body
|
|
1250
|
+
* @param {Object} body Status
|
|
1249
1251
|
*/
|
|
1250
|
-
postTaskmanagementWorktypeStatuses(worktypeId,
|
|
1251
|
-
opts = opts || {};
|
|
1252
|
-
|
|
1252
|
+
postTaskmanagementWorktypeStatuses(worktypeId, body) {
|
|
1253
1253
|
// verify the required parameter 'worktypeId' is set
|
|
1254
1254
|
if (worktypeId === undefined || worktypeId === null) {
|
|
1255
1255
|
throw 'Missing the required parameter "worktypeId" when calling postTaskmanagementWorktypeStatuses';
|
|
1256
1256
|
}
|
|
1257
|
+
// verify the required parameter 'body' is set
|
|
1258
|
+
if (body === undefined || body === null) {
|
|
1259
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypeStatuses';
|
|
1260
|
+
}
|
|
1257
1261
|
|
|
1258
1262
|
return this.apiClient.callApi(
|
|
1259
1263
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/statuses',
|
|
@@ -1262,7 +1266,7 @@ class TaskManagementApi {
|
|
|
1262
1266
|
{ },
|
|
1263
1267
|
{ },
|
|
1264
1268
|
{ },
|
|
1265
|
-
|
|
1269
|
+
body,
|
|
1266
1270
|
['PureCloud OAuth'],
|
|
1267
1271
|
['application/json'],
|
|
1268
1272
|
['application/json']
|
|
@@ -1272,12 +1276,13 @@ class TaskManagementApi {
|
|
|
1272
1276
|
/**
|
|
1273
1277
|
* Create a worktype
|
|
1274
1278
|
*
|
|
1275
|
-
* @param {Object}
|
|
1276
|
-
* @param {Object} opts.body body
|
|
1279
|
+
* @param {Object} body Worktype
|
|
1277
1280
|
*/
|
|
1278
|
-
postTaskmanagementWorktypes(
|
|
1279
|
-
|
|
1280
|
-
|
|
1281
|
+
postTaskmanagementWorktypes(body) {
|
|
1282
|
+
// verify the required parameter 'body' is set
|
|
1283
|
+
if (body === undefined || body === null) {
|
|
1284
|
+
throw 'Missing the required parameter "body" when calling postTaskmanagementWorktypes';
|
|
1285
|
+
}
|
|
1281
1286
|
|
|
1282
1287
|
return this.apiClient.callApi(
|
|
1283
1288
|
'/api/v2/taskmanagement/worktypes',
|
|
@@ -1286,7 +1291,7 @@ class TaskManagementApi {
|
|
|
1286
1291
|
{ },
|
|
1287
1292
|
{ },
|
|
1288
1293
|
{ },
|
|
1289
|
-
|
|
1294
|
+
body,
|
|
1290
1295
|
['PureCloud OAuth'],
|
|
1291
1296
|
['application/json'],
|
|
1292
1297
|
['application/json']
|
|
@@ -5,7 +5,7 @@ class UserRecordingsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* UserRecordings service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 202.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -76,11 +76,12 @@ class UserRecordingsApi {
|
|
|
76
76
|
|
|
77
77
|
/**
|
|
78
78
|
* Download a user recording.
|
|
79
|
-
*
|
|
79
|
+
* API should migrate to use GET api/v2/userrecordings/{recordingId}/transcoding
|
|
80
80
|
* @param {String} recordingId User Recording ID
|
|
81
81
|
* @param {Object} opts Optional parameters
|
|
82
82
|
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
83
83
|
* @param {Boolean} opts.async When set to true, api will return 202 response until the recording is ready for download
|
|
84
|
+
* @deprecated
|
|
84
85
|
*/
|
|
85
86
|
getUserrecordingMedia(recordingId, opts) {
|
|
86
87
|
opts = opts || {};
|
|
@@ -104,6 +105,35 @@ class UserRecordingsApi {
|
|
|
104
105
|
);
|
|
105
106
|
}
|
|
106
107
|
|
|
108
|
+
/**
|
|
109
|
+
* Download a user recording.
|
|
110
|
+
*
|
|
111
|
+
* @param {String} recordingId User Recording ID
|
|
112
|
+
* @param {Object} opts Optional parameters
|
|
113
|
+
* @param {Object} opts.formatId The desired media format. (default to WEBM)
|
|
114
|
+
*/
|
|
115
|
+
getUserrecordingTranscoding(recordingId, opts) {
|
|
116
|
+
opts = opts || {};
|
|
117
|
+
|
|
118
|
+
// verify the required parameter 'recordingId' is set
|
|
119
|
+
if (recordingId === undefined || recordingId === null) {
|
|
120
|
+
throw 'Missing the required parameter "recordingId" when calling getUserrecordingTranscoding';
|
|
121
|
+
}
|
|
122
|
+
|
|
123
|
+
return this.apiClient.callApi(
|
|
124
|
+
'/api/v2/userrecordings/{recordingId}/transcoding',
|
|
125
|
+
'GET',
|
|
126
|
+
{ 'recordingId': recordingId },
|
|
127
|
+
{ 'formatId': opts['formatId'] },
|
|
128
|
+
{ },
|
|
129
|
+
{ },
|
|
130
|
+
null,
|
|
131
|
+
['PureCloud OAuth'],
|
|
132
|
+
['application/json'],
|
|
133
|
+
['application/json']
|
|
134
|
+
);
|
|
135
|
+
}
|
|
136
|
+
|
|
107
137
|
/**
|
|
108
138
|
* Get a list of user recordings.
|
|
109
139
|
*
|
|
@@ -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 202.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1333,7 +1333,7 @@ class UsersApi {
|
|
|
1333
1333
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1334
1334
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1335
1335
|
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
1336
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
1336
|
+
* @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
|
|
1337
1337
|
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
1338
1338
|
* @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.
|
|
1339
1339
|
*/
|
|
@@ -1367,7 +1367,7 @@ class UsersApi {
|
|
|
1367
1367
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1368
1368
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1369
1369
|
* @param {Object} opts.sortOrder Specifies result set sort order sorted by the date due; if not specified, default sort order is descending (Desc) (default to Desc)
|
|
1370
|
-
* @param {Array.<String>} opts.types Specifies the activity types.
|
|
1370
|
+
* @param {Array.<String>} opts.types Specifies the activity types. Informational, AssessedContent and Assessment are deprecated
|
|
1371
1371
|
* @param {Array.<String>} opts.statuses Specifies the activity statuses to filter by
|
|
1372
1372
|
* @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.
|
|
1373
1373
|
*/
|
|
@@ -1393,7 +1393,7 @@ class UsersApi {
|
|
|
1393
1393
|
* Get a Development Activity
|
|
1394
1394
|
* 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.
|
|
1395
1395
|
* @param {String} activityId Specifies the activity ID, maps to either assignment or appointment ID
|
|
1396
|
-
* @param {Object} type Specifies the activity type.
|
|
1396
|
+
* @param {Object} type Specifies the activity type. Informational, AssessedContent and Assessment are deprecated
|
|
1397
1397
|
*/
|
|
1398
1398
|
getUsersDevelopmentActivity(activityId, type) {
|
|
1399
1399
|
// verify the required parameter 'activityId' is set
|