purecloud-platform-client-v2 208.0.0 → 209.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +1088 -118
- package/dist/web-amd/purecloud-platform-client-v2.js +1088 -118
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +406 -134
- package/dist/web-cjs/purecloud-platform-client-v2.js +547 -209
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +3406 -2914
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.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 +4 -4
- 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 -2
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +7 -3
- 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 +1 -1
- 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 +52 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -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 +5 -3
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +29 -25
- 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/SocialMediaApi.js +910 -0
- 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 +1 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- 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 +7 -7
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class QualityApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Quality service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 209.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -290,6 +290,7 @@ class QualityApi {
|
|
|
290
290
|
* @param {String} opts.group group id
|
|
291
291
|
* @param {String} opts.agentTeamId team id of agents requested
|
|
292
292
|
* @param {String} opts.formContextId shared id between form versions
|
|
293
|
+
* @param {Object} opts.userState 'Legacy' fetches active and inactive users when evaluatorUserId or no user filters are supplied; otherwise fetches active users. 'Any' fetches users of 'active', 'inactive' and 'deleted' states. (default to Legacy)
|
|
293
294
|
*/
|
|
294
295
|
getQualityAgentsActivity(opts) {
|
|
295
296
|
opts = opts || {};
|
|
@@ -299,7 +300,7 @@ class QualityApi {
|
|
|
299
300
|
'/api/v2/quality/agents/activity',
|
|
300
301
|
'GET',
|
|
301
302
|
{ },
|
|
302
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'] },
|
|
303
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'],'userState': opts['userState'] },
|
|
303
304
|
{ },
|
|
304
305
|
{ },
|
|
305
306
|
null,
|
|
@@ -514,6 +515,7 @@ class QualityApi {
|
|
|
514
515
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.
|
|
515
516
|
* @param {Number} opts.maximum the maximum number of results to return
|
|
516
517
|
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
518
|
+
* @param {Boolean} opts.includeDeletedUsers Allow returning an agent or evaluator user with a 'delete' status. Defaults to false. (default to false)
|
|
517
519
|
*/
|
|
518
520
|
getQualityEvaluationsQuery(opts) {
|
|
519
521
|
opts = opts || {};
|
|
@@ -523,7 +525,7 @@ class QualityApi {
|
|
|
523
525
|
'/api/v2/quality/evaluations/query',
|
|
524
526
|
'GET',
|
|
525
527
|
{ },
|
|
526
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
528
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'],'includeDeletedUsers': opts['includeDeletedUsers'] },
|
|
527
529
|
{ },
|
|
528
530
|
{ },
|
|
529
531
|
null,
|
|
@@ -5,7 +5,7 @@ class RoutingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Routing service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 209.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -413,18 +413,18 @@ class RoutingApi {
|
|
|
413
413
|
/**
|
|
414
414
|
* Delete a phone number provisioned for SMS.
|
|
415
415
|
*
|
|
416
|
-
* @param {String}
|
|
416
|
+
* @param {String} phoneNumberId phone number
|
|
417
417
|
*/
|
|
418
|
-
deleteRoutingSmsPhonenumber(
|
|
419
|
-
// verify the required parameter '
|
|
420
|
-
if (
|
|
421
|
-
throw 'Missing the required parameter "
|
|
418
|
+
deleteRoutingSmsPhonenumber(phoneNumberId) {
|
|
419
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
420
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
421
|
+
throw 'Missing the required parameter "phoneNumberId" when calling deleteRoutingSmsPhonenumber';
|
|
422
422
|
}
|
|
423
423
|
|
|
424
424
|
return this.apiClient.callApi(
|
|
425
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
425
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
426
426
|
'DELETE',
|
|
427
|
-
{ '
|
|
427
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
428
428
|
{ },
|
|
429
429
|
{ },
|
|
430
430
|
{ },
|
|
@@ -1403,9 +1403,13 @@ class RoutingApi {
|
|
|
1403
1403
|
* Get Estimated Wait Time
|
|
1404
1404
|
*
|
|
1405
1405
|
* @param {String} queueId queueId
|
|
1406
|
-
* @param {
|
|
1406
|
+
* @param {Object} mediaType mediaType
|
|
1407
|
+
* @param {Object} opts Optional parameters
|
|
1408
|
+
* @param {String} opts.labelId Unique id that represents the interaction label used with media type for EWT calculation
|
|
1407
1409
|
*/
|
|
1408
|
-
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType) {
|
|
1410
|
+
getRoutingQueueMediatypeEstimatedwaittime(queueId, mediaType, opts) {
|
|
1411
|
+
opts = opts || {};
|
|
1412
|
+
|
|
1409
1413
|
// verify the required parameter 'queueId' is set
|
|
1410
1414
|
if (queueId === undefined || queueId === null) {
|
|
1411
1415
|
throw 'Missing the required parameter "queueId" when calling getRoutingQueueMediatypeEstimatedwaittime';
|
|
@@ -1419,7 +1423,7 @@ class RoutingApi {
|
|
|
1419
1423
|
'/api/v2/routing/queues/{queueId}/mediatypes/{mediaType}/estimatedwaittime',
|
|
1420
1424
|
'GET',
|
|
1421
1425
|
{ 'queueId': queueId,'mediaType': mediaType },
|
|
1422
|
-
{
|
|
1426
|
+
{ 'labelId': opts['labelId'] },
|
|
1423
1427
|
{ },
|
|
1424
1428
|
{ },
|
|
1425
1429
|
null,
|
|
@@ -1970,22 +1974,22 @@ class RoutingApi {
|
|
|
1970
1974
|
/**
|
|
1971
1975
|
* Get a phone number provisioned for SMS.
|
|
1972
1976
|
*
|
|
1973
|
-
* @param {String}
|
|
1977
|
+
* @param {String} phoneNumberId phone number
|
|
1974
1978
|
* @param {Object} opts Optional parameters
|
|
1975
1979
|
* @param {Object} opts.expand Expand response with additional information
|
|
1976
1980
|
*/
|
|
1977
|
-
getRoutingSmsPhonenumber(
|
|
1981
|
+
getRoutingSmsPhonenumber(phoneNumberId, opts) {
|
|
1978
1982
|
opts = opts || {};
|
|
1979
1983
|
|
|
1980
|
-
// verify the required parameter '
|
|
1981
|
-
if (
|
|
1982
|
-
throw 'Missing the required parameter "
|
|
1984
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
1985
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
1986
|
+
throw 'Missing the required parameter "phoneNumberId" when calling getRoutingSmsPhonenumber';
|
|
1983
1987
|
}
|
|
1984
1988
|
|
|
1985
1989
|
return this.apiClient.callApi(
|
|
1986
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
1990
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
1987
1991
|
'GET',
|
|
1988
|
-
{ '
|
|
1992
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
1989
1993
|
{ 'expand': opts['expand'] },
|
|
1990
1994
|
{ },
|
|
1991
1995
|
{ },
|
|
@@ -3910,13 +3914,13 @@ class RoutingApi {
|
|
|
3910
3914
|
/**
|
|
3911
3915
|
* Update a phone number provisioned for SMS.
|
|
3912
3916
|
*
|
|
3913
|
-
* @param {String}
|
|
3917
|
+
* @param {String} phoneNumberId phone number
|
|
3914
3918
|
* @param {Object} body SmsPhoneNumber
|
|
3915
3919
|
*/
|
|
3916
|
-
putRoutingSmsPhonenumber(
|
|
3917
|
-
// verify the required parameter '
|
|
3918
|
-
if (
|
|
3919
|
-
throw 'Missing the required parameter "
|
|
3920
|
+
putRoutingSmsPhonenumber(phoneNumberId, body) {
|
|
3921
|
+
// verify the required parameter 'phoneNumberId' is set
|
|
3922
|
+
if (phoneNumberId === undefined || phoneNumberId === null) {
|
|
3923
|
+
throw 'Missing the required parameter "phoneNumberId" when calling putRoutingSmsPhonenumber';
|
|
3920
3924
|
}
|
|
3921
3925
|
// verify the required parameter 'body' is set
|
|
3922
3926
|
if (body === undefined || body === null) {
|
|
@@ -3924,9 +3928,9 @@ class RoutingApi {
|
|
|
3924
3928
|
}
|
|
3925
3929
|
|
|
3926
3930
|
return this.apiClient.callApi(
|
|
3927
|
-
'/api/v2/routing/sms/phonenumbers/{
|
|
3931
|
+
'/api/v2/routing/sms/phonenumbers/{phoneNumberId}',
|
|
3928
3932
|
'PUT',
|
|
3929
|
-
{ '
|
|
3933
|
+
{ 'phoneNumberId': phoneNumberId },
|
|
3930
3934
|
{ },
|
|
3931
3935
|
{ },
|
|
3932
3936
|
{ },
|