purecloud-platform-client-v2 173.1.0 → 174.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 +1427 -101
- package/dist/web-amd/purecloud-platform-client-v2.js +1427 -101
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1427 -101
- package/dist/web-cjs/purecloud-platform-client-v2.js +1427 -101
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1076 -18
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +493 -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 +223 -5
- 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/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 +62 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +188 -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/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/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 +10 -8
- 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 +3 -2
- package/src/purecloud-platform-client-v2/api/SCIMApi.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 +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 +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +7 -3
- 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 +10 -5
- 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 +362 -5
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class KnowledgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Knowledge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 174.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -562,6 +562,85 @@ class KnowledgeApi {
|
|
|
562
562
|
);
|
|
563
563
|
}
|
|
564
564
|
|
|
565
|
+
/**
|
|
566
|
+
* Get a list of feedback records given on a document
|
|
567
|
+
*
|
|
568
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
569
|
+
* @param {String} documentId Document ID.
|
|
570
|
+
* @param {Object} opts Optional parameters
|
|
571
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
572
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
573
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
574
|
+
* @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
|
|
575
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
576
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
577
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
578
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
579
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
580
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
581
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
582
|
+
*/
|
|
583
|
+
getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
584
|
+
opts = opts || {};
|
|
585
|
+
|
|
586
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
587
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
588
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
589
|
+
}
|
|
590
|
+
// verify the required parameter 'documentId' is set
|
|
591
|
+
if (documentId === undefined || documentId === null) {
|
|
592
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
|
|
593
|
+
}
|
|
594
|
+
|
|
595
|
+
return this.apiClient.callApi(
|
|
596
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
597
|
+
'GET',
|
|
598
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
599
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'onlyCommented': opts['onlyCommented'],'documentVersionId': opts['documentVersionId'],'documentVariationId': opts['documentVariationId'],'appType': opts['appType'],'queryType': opts['queryType'],'userId': opts['userId'],'queueId': opts['queueId'],'state': opts['state'] },
|
|
600
|
+
{ },
|
|
601
|
+
{ },
|
|
602
|
+
null,
|
|
603
|
+
['PureCloud OAuth'],
|
|
604
|
+
['application/json'],
|
|
605
|
+
['application/json']
|
|
606
|
+
);
|
|
607
|
+
}
|
|
608
|
+
|
|
609
|
+
/**
|
|
610
|
+
* Get a single feedback record given on a document
|
|
611
|
+
*
|
|
612
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
613
|
+
* @param {String} documentId Document ID.
|
|
614
|
+
* @param {String} feedbackId Feedback ID.
|
|
615
|
+
*/
|
|
616
|
+
getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
|
|
617
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
618
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
619
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
620
|
+
}
|
|
621
|
+
// verify the required parameter 'documentId' is set
|
|
622
|
+
if (documentId === undefined || documentId === null) {
|
|
623
|
+
throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
624
|
+
}
|
|
625
|
+
// verify the required parameter 'feedbackId' is set
|
|
626
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
627
|
+
throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
628
|
+
}
|
|
629
|
+
|
|
630
|
+
return this.apiClient.callApi(
|
|
631
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
632
|
+
'GET',
|
|
633
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
634
|
+
{ },
|
|
635
|
+
{ },
|
|
636
|
+
{ },
|
|
637
|
+
null,
|
|
638
|
+
['PureCloud OAuth'],
|
|
639
|
+
['application/json'],
|
|
640
|
+
['application/json']
|
|
641
|
+
);
|
|
642
|
+
}
|
|
643
|
+
|
|
565
644
|
/**
|
|
566
645
|
* Get a variation for a document.
|
|
567
646
|
*
|
|
@@ -869,8 +948,12 @@ class KnowledgeApi {
|
|
|
869
948
|
*
|
|
870
949
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
871
950
|
* @param {String} importJobId Import job ID
|
|
951
|
+
* @param {Object} opts Optional parameters
|
|
952
|
+
* @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
|
|
872
953
|
*/
|
|
873
|
-
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
|
|
954
|
+
getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
|
|
955
|
+
opts = opts || {};
|
|
956
|
+
|
|
874
957
|
// verify the required parameter 'knowledgeBaseId' is set
|
|
875
958
|
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
876
959
|
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
|
|
@@ -884,7 +967,7 @@ class KnowledgeApi {
|
|
|
884
967
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
|
|
885
968
|
'GET',
|
|
886
969
|
{ 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
|
|
887
|
-
{
|
|
970
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
888
971
|
{ },
|
|
889
972
|
{ },
|
|
890
973
|
null,
|
|
@@ -1907,6 +1990,40 @@ class KnowledgeApi {
|
|
|
1907
1990
|
);
|
|
1908
1991
|
}
|
|
1909
1992
|
|
|
1993
|
+
/**
|
|
1994
|
+
* Give feedback on a document
|
|
1995
|
+
*
|
|
1996
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
1997
|
+
* @param {String} documentId Document ID.
|
|
1998
|
+
* @param {Object} opts Optional parameters
|
|
1999
|
+
* @param {Object} opts.body
|
|
2000
|
+
*/
|
|
2001
|
+
postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
|
|
2002
|
+
opts = opts || {};
|
|
2003
|
+
|
|
2004
|
+
// verify the required parameter 'sessionId' is set
|
|
2005
|
+
if (sessionId === undefined || sessionId === null) {
|
|
2006
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
2007
|
+
}
|
|
2008
|
+
// verify the required parameter 'documentId' is set
|
|
2009
|
+
if (documentId === undefined || documentId === null) {
|
|
2010
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
|
|
2011
|
+
}
|
|
2012
|
+
|
|
2013
|
+
return this.apiClient.callApi(
|
|
2014
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
|
|
2015
|
+
'POST',
|
|
2016
|
+
{ 'sessionId': sessionId,'documentId': documentId },
|
|
2017
|
+
{ },
|
|
2018
|
+
{ },
|
|
2019
|
+
{ },
|
|
2020
|
+
opts['body'],
|
|
2021
|
+
['PureCloud OAuth'],
|
|
2022
|
+
['application/json'],
|
|
2023
|
+
['application/json']
|
|
2024
|
+
);
|
|
2025
|
+
}
|
|
2026
|
+
|
|
1910
2027
|
/**
|
|
1911
2028
|
* Search the documents in a guest session.
|
|
1912
2029
|
*
|
|
@@ -2021,6 +2138,40 @@ class KnowledgeApi {
|
|
|
2021
2138
|
);
|
|
2022
2139
|
}
|
|
2023
2140
|
|
|
2141
|
+
/**
|
|
2142
|
+
* Give feedback on a document
|
|
2143
|
+
*
|
|
2144
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
2145
|
+
* @param {String} documentId Document ID.
|
|
2146
|
+
* @param {Object} opts Optional parameters
|
|
2147
|
+
* @param {Object} opts.body
|
|
2148
|
+
*/
|
|
2149
|
+
postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
|
|
2150
|
+
opts = opts || {};
|
|
2151
|
+
|
|
2152
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
2153
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
2154
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
2155
|
+
}
|
|
2156
|
+
// verify the required parameter 'documentId' is set
|
|
2157
|
+
if (documentId === undefined || documentId === null) {
|
|
2158
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
|
|
2159
|
+
}
|
|
2160
|
+
|
|
2161
|
+
return this.apiClient.callApi(
|
|
2162
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
|
|
2163
|
+
'POST',
|
|
2164
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
2165
|
+
{ },
|
|
2166
|
+
{ },
|
|
2167
|
+
{ },
|
|
2168
|
+
opts['body'],
|
|
2169
|
+
['PureCloud OAuth'],
|
|
2170
|
+
['application/json'],
|
|
2171
|
+
['application/json']
|
|
2172
|
+
);
|
|
2173
|
+
}
|
|
2174
|
+
|
|
2024
2175
|
/**
|
|
2025
2176
|
* Create a variation for a document.
|
|
2026
2177
|
*
|
|
@@ -2091,6 +2242,40 @@ class KnowledgeApi {
|
|
|
2091
2242
|
);
|
|
2092
2243
|
}
|
|
2093
2244
|
|
|
2245
|
+
/**
|
|
2246
|
+
* Create view for a document.
|
|
2247
|
+
*
|
|
2248
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
2249
|
+
* @param {String} documentId Document ID.
|
|
2250
|
+
* @param {Object} opts Optional parameters
|
|
2251
|
+
* @param {Object} opts.body
|
|
2252
|
+
*/
|
|
2253
|
+
postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
|
|
2254
|
+
opts = opts || {};
|
|
2255
|
+
|
|
2256
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
2257
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
2258
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
2259
|
+
}
|
|
2260
|
+
// verify the required parameter 'documentId' is set
|
|
2261
|
+
if (documentId === undefined || documentId === null) {
|
|
2262
|
+
throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
|
|
2263
|
+
}
|
|
2264
|
+
|
|
2265
|
+
return this.apiClient.callApi(
|
|
2266
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
|
|
2267
|
+
'POST',
|
|
2268
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
|
|
2269
|
+
{ },
|
|
2270
|
+
{ },
|
|
2271
|
+
{ },
|
|
2272
|
+
opts['body'],
|
|
2273
|
+
['PureCloud OAuth'],
|
|
2274
|
+
['application/json'],
|
|
2275
|
+
['application/json']
|
|
2276
|
+
);
|
|
2277
|
+
}
|
|
2278
|
+
|
|
2094
2279
|
/**
|
|
2095
2280
|
* Create document.
|
|
2096
2281
|
*
|
|
@@ -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 174.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -288,6 +288,7 @@ class QualityApi {
|
|
|
288
288
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
289
289
|
* @param {String} opts.name name
|
|
290
290
|
* @param {String} opts.group group id
|
|
291
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
291
292
|
*/
|
|
292
293
|
getQualityAgentsActivity(opts) {
|
|
293
294
|
opts = opts || {};
|
|
@@ -297,7 +298,7 @@ class QualityApi {
|
|
|
297
298
|
'/api/v2/quality/agents/activity',
|
|
298
299
|
'GET',
|
|
299
300
|
{ },
|
|
300
|
-
{ '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'] },
|
|
301
|
+
{ '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'],'formContextId': opts['formContextId'] },
|
|
301
302
|
{ },
|
|
302
303
|
{ },
|
|
303
304
|
null,
|
|
@@ -495,9 +496,9 @@ class QualityApi {
|
|
|
495
496
|
* @param {Object} opts Optional parameters
|
|
496
497
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
497
498
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
498
|
-
* @param {String} opts.sortBy
|
|
499
|
+
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
499
500
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
500
|
-
* @param {String} opts.nextPage
|
|
501
|
+
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
501
502
|
* @param {String} opts.previousPage Previous page token
|
|
502
503
|
* @param {String} opts.conversationId conversationId specified
|
|
503
504
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -506,12 +507,13 @@ class QualityApi {
|
|
|
506
507
|
* @param {String} opts.queueId queue id
|
|
507
508
|
* @param {String} opts.startTime start time of the evaluation query
|
|
508
509
|
* @param {String} opts.endTime end time of the evaluation query
|
|
510
|
+
* @param {String} opts.formContextId shared id between form versions
|
|
509
511
|
* @param {Array.<String>} opts.evaluationState
|
|
510
512
|
* @param {Boolean} opts.isReleased the evaluation has been released
|
|
511
513
|
* @param {Boolean} opts.agentHasRead agent has the evaluation
|
|
512
514
|
* @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
|
|
513
|
-
* @param {Number} opts.maximum maximum
|
|
514
|
-
* @param {String} opts.sortOrder
|
|
515
|
+
* @param {Number} opts.maximum the maximum number of results to return
|
|
516
|
+
* @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
|
|
515
517
|
*/
|
|
516
518
|
getQualityEvaluationsQuery(opts) {
|
|
517
519
|
opts = opts || {};
|
|
@@ -521,7 +523,7 @@ class QualityApi {
|
|
|
521
523
|
'/api/v2/quality/evaluations/query',
|
|
522
524
|
'GET',
|
|
523
525
|
{ },
|
|
524
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
526
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'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'] },
|
|
525
527
|
{ },
|
|
526
528
|
{ },
|
|
527
529
|
null,
|
|
@@ -1598,7 +1600,7 @@ class QualityApi {
|
|
|
1598
1600
|
* @param {String} evaluationId evaluationId
|
|
1599
1601
|
* @param {Object} body evaluation
|
|
1600
1602
|
* @param {Object} opts Optional parameters
|
|
1601
|
-
* @param {String} opts.expand evaluatorId, evaluationForm, assignee
|
|
1603
|
+
* @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
|
|
1602
1604
|
*/
|
|
1603
1605
|
putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
|
|
1604
1606
|
opts = opts || {};
|
|
@@ -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 174.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1012,6 +1012,7 @@ class RoutingApi {
|
|
|
1012
1012
|
*
|
|
1013
1013
|
* @param {Object} opts Optional parameters
|
|
1014
1014
|
* @param {Object} opts.messengerType Messenger Type
|
|
1015
|
+
* @param {String} opts.name Recipient Name
|
|
1015
1016
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1016
1017
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1017
1018
|
*/
|
|
@@ -1023,7 +1024,7 @@ class RoutingApi {
|
|
|
1023
1024
|
'/api/v2/routing/message/recipients',
|
|
1024
1025
|
'GET',
|
|
1025
1026
|
{ },
|
|
1026
|
-
{ 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
1027
|
+
{ 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
1027
1028
|
{ },
|
|
1028
1029
|
{ },
|
|
1029
1030
|
null,
|
|
@@ -5,7 +5,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* TelephonyProvidersEdge service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 174.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1668,7 +1668,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
1668
1668
|
}
|
|
1669
1669
|
|
|
1670
1670
|
/**
|
|
1671
|
-
* Get a list of Phone Instances
|
|
1671
|
+
* Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.
|
|
1672
1672
|
*
|
|
1673
1673
|
* @param {Object} opts Optional parameters
|
|
1674
1674
|
* @param {Number} opts.pageNumber Page number (default to 1)
|