purecloud-platform-client-v2 151.0.0 → 152.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 +336 -145
- package/dist/web-amd/purecloud-platform-client-v2.js +336 -145
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +336 -145
- package/dist/web-cjs/purecloud-platform-client-v2.js +336 -145
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +367 -209
- 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 +28 -2
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +5 -4
- 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/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 +14 -8
- 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/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 -65
- 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/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +3 -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 +1 -1
- 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 +223 -1
- 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/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/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 +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -104,6 +104,7 @@ class AnalyticsApi {
|
|
|
104
104
|
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
105
105
|
* @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
|
|
106
106
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
|
|
107
|
+
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
107
108
|
*/
|
|
108
109
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
109
110
|
opts = opts || {};
|
|
@@ -117,7 +118,7 @@ class AnalyticsApi {
|
|
|
117
118
|
'/api/v2/analytics/botflows/{botFlowId}/reportingturns',
|
|
118
119
|
'GET',
|
|
119
120
|
{ 'botFlowId': botFlowId },
|
|
120
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'] },
|
|
121
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'] },
|
|
121
122
|
{ },
|
|
122
123
|
{ },
|
|
123
124
|
null,
|
|
@@ -666,6 +667,31 @@ class AnalyticsApi {
|
|
|
666
667
|
);
|
|
667
668
|
}
|
|
668
669
|
|
|
670
|
+
/**
|
|
671
|
+
* Query for action aggregates
|
|
672
|
+
*
|
|
673
|
+
* @param {Object} body query
|
|
674
|
+
*/
|
|
675
|
+
postAnalyticsActionsAggregatesQuery(body) {
|
|
676
|
+
// verify the required parameter 'body' is set
|
|
677
|
+
if (body === undefined || body === null) {
|
|
678
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
679
|
+
}
|
|
680
|
+
|
|
681
|
+
return this.apiClient.callApi(
|
|
682
|
+
'/api/v2/analytics/actions/aggregates/query',
|
|
683
|
+
'POST',
|
|
684
|
+
{ },
|
|
685
|
+
{ },
|
|
686
|
+
{ },
|
|
687
|
+
{ },
|
|
688
|
+
body,
|
|
689
|
+
['PureCloud OAuth'],
|
|
690
|
+
['application/json'],
|
|
691
|
+
['application/json']
|
|
692
|
+
);
|
|
693
|
+
}
|
|
694
|
+
|
|
669
695
|
/**
|
|
670
696
|
* Query for bot aggregates
|
|
671
697
|
*
|
|
@@ -5,7 +5,7 @@ class ArchitectApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Architect service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1598,6 +1598,7 @@ class ArchitectApi {
|
|
|
1598
1598
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1599
1599
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1600
1600
|
* @param {Boolean} opts.showbrief If true returns just the key value of the row (default to true)
|
|
1601
|
+
* @param {Object} opts.sortOrder Sort order (default to ascending)
|
|
1601
1602
|
*/
|
|
1602
1603
|
getFlowsDatatableRows(datatableId, opts) {
|
|
1603
1604
|
opts = opts || {};
|
|
@@ -1611,7 +1612,7 @@ class ArchitectApi {
|
|
|
1611
1612
|
'/api/v2/flows/datatables/{datatableId}/rows',
|
|
1612
1613
|
'GET',
|
|
1613
1614
|
{ 'datatableId': datatableId },
|
|
1614
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'] },
|
|
1615
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'showbrief': opts['showbrief'],'sortOrder': opts['sortOrder'] },
|
|
1615
1616
|
{ },
|
|
1616
1617
|
{ },
|
|
1617
1618
|
null,
|
|
@@ -1631,7 +1632,7 @@ class ArchitectApi {
|
|
|
1631
1632
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
1632
1633
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
1633
1634
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
1634
|
-
* @param {String} opts.name Name
|
|
1635
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
1635
1636
|
*/
|
|
1636
1637
|
getFlowsDatatables(opts) {
|
|
1637
1638
|
opts = opts || {};
|
|
@@ -1690,7 +1691,7 @@ class ArchitectApi {
|
|
|
1690
1691
|
* @param {Object} opts.sortBy Sort by (default to id)
|
|
1691
1692
|
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
1692
1693
|
* @param {Array.<String>} opts.divisionId division ID(s)
|
|
1693
|
-
* @param {String} opts.name Name
|
|
1694
|
+
* @param {String} opts.name Filter by Name. The wildcard character * is supported within the filter. Matches are case-insensitive.
|
|
1694
1695
|
*/
|
|
1695
1696
|
getFlowsDatatablesDivisionviews(opts) {
|
|
1696
1697
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class ConversationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Conversations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1684,8 +1684,9 @@ class ConversationsApi {
|
|
|
1684
1684
|
* @param {Object} opts Optional parameters
|
|
1685
1685
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1686
1686
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1687
|
-
* @param {
|
|
1687
|
+
* @param {Array.<String>} opts.expand Expand instructions for the return value.
|
|
1688
1688
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
1689
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
1689
1690
|
*/
|
|
1690
1691
|
getConversationsMessagingIntegrations(opts) {
|
|
1691
1692
|
opts = opts || {};
|
|
@@ -1695,7 +1696,7 @@ class ConversationsApi {
|
|
|
1695
1696
|
'/api/v2/conversations/messaging/integrations',
|
|
1696
1697
|
'GET',
|
|
1697
1698
|
{ },
|
|
1698
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
1699
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
1699
1700
|
{ },
|
|
1700
1701
|
{ },
|
|
1701
1702
|
null,
|
|
@@ -1713,6 +1714,7 @@ class ConversationsApi {
|
|
|
1713
1714
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1714
1715
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
1715
1716
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
1717
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
1716
1718
|
*/
|
|
1717
1719
|
getConversationsMessagingIntegrationsFacebook(opts) {
|
|
1718
1720
|
opts = opts || {};
|
|
@@ -1722,7 +1724,7 @@ class ConversationsApi {
|
|
|
1722
1724
|
'/api/v2/conversations/messaging/integrations/facebook',
|
|
1723
1725
|
'GET',
|
|
1724
1726
|
{ },
|
|
1725
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
1727
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
1726
1728
|
{ },
|
|
1727
1729
|
{ },
|
|
1728
1730
|
null,
|
|
@@ -1769,6 +1771,7 @@ class ConversationsApi {
|
|
|
1769
1771
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1770
1772
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
1771
1773
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
1774
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
1772
1775
|
*/
|
|
1773
1776
|
getConversationsMessagingIntegrationsLine(opts) {
|
|
1774
1777
|
opts = opts || {};
|
|
@@ -1778,7 +1781,7 @@ class ConversationsApi {
|
|
|
1778
1781
|
'/api/v2/conversations/messaging/integrations/line',
|
|
1779
1782
|
'GET',
|
|
1780
1783
|
{ },
|
|
1781
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
1784
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
1782
1785
|
{ },
|
|
1783
1786
|
{ },
|
|
1784
1787
|
null,
|
|
@@ -1825,6 +1828,7 @@ class ConversationsApi {
|
|
|
1825
1828
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1826
1829
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
1827
1830
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
1831
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
1828
1832
|
*/
|
|
1829
1833
|
getConversationsMessagingIntegrationsOpen(opts) {
|
|
1830
1834
|
opts = opts || {};
|
|
@@ -1834,7 +1838,7 @@ class ConversationsApi {
|
|
|
1834
1838
|
'/api/v2/conversations/messaging/integrations/open',
|
|
1835
1839
|
'GET',
|
|
1836
1840
|
{ },
|
|
1837
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
1841
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
1838
1842
|
{ },
|
|
1839
1843
|
{ },
|
|
1840
1844
|
null,
|
|
@@ -1881,6 +1885,7 @@ class ConversationsApi {
|
|
|
1881
1885
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1882
1886
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
1883
1887
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
1888
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
1884
1889
|
*/
|
|
1885
1890
|
getConversationsMessagingIntegrationsTwitter(opts) {
|
|
1886
1891
|
opts = opts || {};
|
|
@@ -1890,7 +1895,7 @@ class ConversationsApi {
|
|
|
1890
1895
|
'/api/v2/conversations/messaging/integrations/twitter',
|
|
1891
1896
|
'GET',
|
|
1892
1897
|
{ },
|
|
1893
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
1898
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
1894
1899
|
{ },
|
|
1895
1900
|
{ },
|
|
1896
1901
|
null,
|
|
@@ -1937,6 +1942,7 @@ class ConversationsApi {
|
|
|
1937
1942
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1938
1943
|
* @param {Object} opts.expand Expand instructions for the return value.
|
|
1939
1944
|
* @param {String} opts.supportedContentId Filter integrations returned based on the supported content ID
|
|
1945
|
+
* @param {String} opts.messagingSettingId Filter integrations returned based on the setting ID
|
|
1940
1946
|
*/
|
|
1941
1947
|
getConversationsMessagingIntegrationsWhatsapp(opts) {
|
|
1942
1948
|
opts = opts || {};
|
|
@@ -1946,7 +1952,7 @@ class ConversationsApi {
|
|
|
1946
1952
|
'/api/v2/conversations/messaging/integrations/whatsapp',
|
|
1947
1953
|
'GET',
|
|
1948
1954
|
{ },
|
|
1949
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'] },
|
|
1955
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': opts['expand'],'supportedContent.id': opts['supportedContentId'],'messagingSetting.id': opts['messagingSettingId'] },
|
|
1950
1956
|
{ },
|
|
1951
1957
|
{ },
|
|
1952
1958
|
null,
|
|
@@ -5,7 +5,7 @@ class GamificationApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Gamification service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -223,36 +223,6 @@ class GamificationApi {
|
|
|
223
223
|
);
|
|
224
224
|
}
|
|
225
225
|
|
|
226
|
-
/**
|
|
227
|
-
* Gamified metric by id
|
|
228
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
229
|
-
* @param {String} metricId metric Id
|
|
230
|
-
* @param {Object} opts Optional parameters
|
|
231
|
-
* @param {String} opts.workday The objective query workday. If not specified, then it retrieves the current objective. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
232
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
233
|
-
*/
|
|
234
|
-
getGamificationMetric(metricId, opts) {
|
|
235
|
-
opts = opts || {};
|
|
236
|
-
|
|
237
|
-
// verify the required parameter 'metricId' is set
|
|
238
|
-
if (metricId === undefined || metricId === null) {
|
|
239
|
-
throw 'Missing the required parameter "metricId" when calling getGamificationMetric';
|
|
240
|
-
}
|
|
241
|
-
|
|
242
|
-
return this.apiClient.callApi(
|
|
243
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
244
|
-
'GET',
|
|
245
|
-
{ 'metricId': metricId },
|
|
246
|
-
{ 'workday': opts['workday'],'performanceProfileId': opts['performanceProfileId'] },
|
|
247
|
-
{ },
|
|
248
|
-
{ },
|
|
249
|
-
null,
|
|
250
|
-
['PureCloud OAuth'],
|
|
251
|
-
['application/json'],
|
|
252
|
-
['application/json']
|
|
253
|
-
);
|
|
254
|
-
}
|
|
255
|
-
|
|
256
226
|
/**
|
|
257
227
|
* Metric definition by id
|
|
258
228
|
*
|
|
@@ -1557,40 +1527,6 @@ class GamificationApi {
|
|
|
1557
1527
|
);
|
|
1558
1528
|
}
|
|
1559
1529
|
|
|
1560
|
-
/**
|
|
1561
|
-
* Updates a metric
|
|
1562
|
-
* This API is deprecated. Use /api/v2/gamification/profiles/{profileId}/metrics/{metricId} instead.
|
|
1563
|
-
* @param {String} metricId metric Id
|
|
1564
|
-
* @param {Object} body Metric
|
|
1565
|
-
* @param {Object} opts Optional parameters
|
|
1566
|
-
* @param {String} opts.performanceProfileId The profile id of the metrics you are trying to retrieve. The DEFAULT profile is used if nothing is given.
|
|
1567
|
-
*/
|
|
1568
|
-
putGamificationMetric(metricId, body, opts) {
|
|
1569
|
-
opts = opts || {};
|
|
1570
|
-
|
|
1571
|
-
// verify the required parameter 'metricId' is set
|
|
1572
|
-
if (metricId === undefined || metricId === null) {
|
|
1573
|
-
throw 'Missing the required parameter "metricId" when calling putGamificationMetric';
|
|
1574
|
-
}
|
|
1575
|
-
// verify the required parameter 'body' is set
|
|
1576
|
-
if (body === undefined || body === null) {
|
|
1577
|
-
throw 'Missing the required parameter "body" when calling putGamificationMetric';
|
|
1578
|
-
}
|
|
1579
|
-
|
|
1580
|
-
return this.apiClient.callApi(
|
|
1581
|
-
'/api/v2/gamification/metrics/{metricId}',
|
|
1582
|
-
'PUT',
|
|
1583
|
-
{ 'metricId': metricId },
|
|
1584
|
-
{ 'performanceProfileId': opts['performanceProfileId'] },
|
|
1585
|
-
{ },
|
|
1586
|
-
{ },
|
|
1587
|
-
body,
|
|
1588
|
-
['PureCloud OAuth'],
|
|
1589
|
-
['application/json'],
|
|
1590
|
-
['application/json']
|
|
1591
|
-
);
|
|
1592
|
-
}
|
|
1593
|
-
|
|
1594
1530
|
/**
|
|
1595
1531
|
* Updates a performance profile
|
|
1596
1532
|
*
|
|
@@ -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 152.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -408,8 +408,8 @@ class KnowledgeApi {
|
|
|
408
408
|
* @param {String} sessionId Knowledge guest session ID.
|
|
409
409
|
* @param {Object} opts Optional parameters
|
|
410
410
|
* @param {Array.<String>} opts.categoryId If specified, retrieves documents associated with category ids, comma separated values expected.
|
|
411
|
-
* @param {Boolean} opts.includeSubcategories Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
412
|
-
* @param {
|
|
411
|
+
* @param {Boolean} opts.includeSubcategories Deprecated - Do Not Use. Works along with 'categoryId' query parameter. If specified, retrieves documents associated with category ids and its children categories.
|
|
412
|
+
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 10)
|
|
413
413
|
*/
|
|
414
414
|
getKnowledgeGuestSessionDocuments(sessionId, opts) {
|
|
415
415
|
opts = opts || {};
|