purecloud-platform-client-v2 174.0.0 → 176.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 +804 -77
- package/dist/web-amd/purecloud-platform-client-v2.js +804 -77
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +804 -77
- package/dist/web-cjs/purecloud-platform-client-v2.js +804 -77
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +296 -7
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +120 -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 +605 -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/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 +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 +7 -3
- 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 +3 -3
- 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 +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
|
@@ -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 176.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1698,6 +1698,125 @@ class ArchitectApi {
|
|
|
1698
1698
|
);
|
|
1699
1699
|
}
|
|
1700
1700
|
|
|
1701
|
+
/**
|
|
1702
|
+
* Get overall health scores for all intents present in the NLU domain version associated with the bot flow version.
|
|
1703
|
+
*
|
|
1704
|
+
* @param {String} flowId Flow ID.
|
|
1705
|
+
* @param {String} versionId Version ID.
|
|
1706
|
+
* @param {Object} opts Optional parameters
|
|
1707
|
+
* @param {Object} opts.language Language to filter for
|
|
1708
|
+
*/
|
|
1709
|
+
getFlowVersionHealth(flowId, versionId, opts) {
|
|
1710
|
+
opts = opts || {};
|
|
1711
|
+
|
|
1712
|
+
// verify the required parameter 'flowId' is set
|
|
1713
|
+
if (flowId === undefined || flowId === null) {
|
|
1714
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionHealth';
|
|
1715
|
+
}
|
|
1716
|
+
// verify the required parameter 'versionId' is set
|
|
1717
|
+
if (versionId === undefined || versionId === null) {
|
|
1718
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionHealth';
|
|
1719
|
+
}
|
|
1720
|
+
|
|
1721
|
+
return this.apiClient.callApi(
|
|
1722
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/health',
|
|
1723
|
+
'GET',
|
|
1724
|
+
{ 'flowId': flowId,'versionId': versionId },
|
|
1725
|
+
{ 'language': opts['language'] },
|
|
1726
|
+
{ },
|
|
1727
|
+
{ },
|
|
1728
|
+
null,
|
|
1729
|
+
['PureCloud OAuth'],
|
|
1730
|
+
['application/json'],
|
|
1731
|
+
['application/json']
|
|
1732
|
+
);
|
|
1733
|
+
}
|
|
1734
|
+
|
|
1735
|
+
/**
|
|
1736
|
+
* Get health scores and other health metrics for a specific intent. This includes the health metrics for each utterance in an intent.
|
|
1737
|
+
*
|
|
1738
|
+
* @param {String} flowId Flow ID.
|
|
1739
|
+
* @param {String} versionId Version ID.
|
|
1740
|
+
* @param {String} intentId Intent ID.
|
|
1741
|
+
* @param {Object} language Language to filter for
|
|
1742
|
+
*/
|
|
1743
|
+
getFlowVersionIntentHealth(flowId, versionId, intentId, language) {
|
|
1744
|
+
// verify the required parameter 'flowId' is set
|
|
1745
|
+
if (flowId === undefined || flowId === null) {
|
|
1746
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentHealth';
|
|
1747
|
+
}
|
|
1748
|
+
// verify the required parameter 'versionId' is set
|
|
1749
|
+
if (versionId === undefined || versionId === null) {
|
|
1750
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentHealth';
|
|
1751
|
+
}
|
|
1752
|
+
// verify the required parameter 'intentId' is set
|
|
1753
|
+
if (intentId === undefined || intentId === null) {
|
|
1754
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentHealth';
|
|
1755
|
+
}
|
|
1756
|
+
// verify the required parameter 'language' is set
|
|
1757
|
+
if (language === undefined || language === null) {
|
|
1758
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentHealth';
|
|
1759
|
+
}
|
|
1760
|
+
|
|
1761
|
+
return this.apiClient.callApi(
|
|
1762
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/health',
|
|
1763
|
+
'GET',
|
|
1764
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId },
|
|
1765
|
+
{ 'language': language },
|
|
1766
|
+
{ },
|
|
1767
|
+
{ },
|
|
1768
|
+
null,
|
|
1769
|
+
['PureCloud OAuth'],
|
|
1770
|
+
['application/json'],
|
|
1771
|
+
['application/json']
|
|
1772
|
+
);
|
|
1773
|
+
}
|
|
1774
|
+
|
|
1775
|
+
/**
|
|
1776
|
+
* Get health metrics associated with a specific utterance of an intent.
|
|
1777
|
+
*
|
|
1778
|
+
* @param {String} flowId Flow ID.
|
|
1779
|
+
* @param {String} versionId Version ID.
|
|
1780
|
+
* @param {String} intentId Intent ID.
|
|
1781
|
+
* @param {String} utteranceId Utterance ID.
|
|
1782
|
+
* @param {Object} language Language to filter for
|
|
1783
|
+
*/
|
|
1784
|
+
getFlowVersionIntentUtteranceHealth(flowId, versionId, intentId, utteranceId, language) {
|
|
1785
|
+
// verify the required parameter 'flowId' is set
|
|
1786
|
+
if (flowId === undefined || flowId === null) {
|
|
1787
|
+
throw 'Missing the required parameter "flowId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1788
|
+
}
|
|
1789
|
+
// verify the required parameter 'versionId' is set
|
|
1790
|
+
if (versionId === undefined || versionId === null) {
|
|
1791
|
+
throw 'Missing the required parameter "versionId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1792
|
+
}
|
|
1793
|
+
// verify the required parameter 'intentId' is set
|
|
1794
|
+
if (intentId === undefined || intentId === null) {
|
|
1795
|
+
throw 'Missing the required parameter "intentId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1796
|
+
}
|
|
1797
|
+
// verify the required parameter 'utteranceId' is set
|
|
1798
|
+
if (utteranceId === undefined || utteranceId === null) {
|
|
1799
|
+
throw 'Missing the required parameter "utteranceId" when calling getFlowVersionIntentUtteranceHealth';
|
|
1800
|
+
}
|
|
1801
|
+
// verify the required parameter 'language' is set
|
|
1802
|
+
if (language === undefined || language === null) {
|
|
1803
|
+
throw 'Missing the required parameter "language" when calling getFlowVersionIntentUtteranceHealth';
|
|
1804
|
+
}
|
|
1805
|
+
|
|
1806
|
+
return this.apiClient.callApi(
|
|
1807
|
+
'/api/v2/flows/{flowId}/versions/{versionId}/intents/{intentId}/utterances/{utteranceId}/health',
|
|
1808
|
+
'GET',
|
|
1809
|
+
{ 'flowId': flowId,'versionId': versionId,'intentId': intentId,'utteranceId': utteranceId },
|
|
1810
|
+
{ 'language': language },
|
|
1811
|
+
{ },
|
|
1812
|
+
{ },
|
|
1813
|
+
null,
|
|
1814
|
+
['PureCloud OAuth'],
|
|
1815
|
+
['application/json'],
|
|
1816
|
+
['application/json']
|
|
1817
|
+
);
|
|
1818
|
+
}
|
|
1819
|
+
|
|
1701
1820
|
/**
|
|
1702
1821
|
* Get flow version list
|
|
1703
1822
|
*
|