purecloud-platform-client-v2 252.1.0 → 254.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 +1979 -556
- package/dist/web-amd/purecloud-platform-client-v2.js +1979 -556
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +686 -393
- package/dist/web-cjs/purecloud-platform-client-v2.js +686 -393
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1094 -117
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
- 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 +1 -62
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.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/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +435 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
- 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 +2 -6
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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 -5
- 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/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -11
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +42 -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 +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 +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 -9
- 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 +333 -158
- 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/SocialMediaApi.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 +268 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -47
- 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 -5
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.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 +481 -43
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 254.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -26,7 +26,6 @@ class ConversationsApi {
|
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
27
|
* @param {Object} opts Optional parameters
|
|
28
28
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29
|
-
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30
29
|
*/
|
|
31
30
|
deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
32
31
|
opts = opts || {};
|
|
@@ -693,7 +692,6 @@ class ConversationsApi {
|
|
|
693
692
|
* @param {String} jobId jobId
|
|
694
693
|
* @param {Object} opts Optional parameters
|
|
695
694
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
696
|
-
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
697
695
|
*/
|
|
698
696
|
getAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
699
697
|
opts = opts || {};
|
|
@@ -725,7 +723,6 @@ class ConversationsApi {
|
|
|
725
723
|
* @param {Object} opts Optional parameters
|
|
726
724
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
727
725
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
728
|
-
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
729
726
|
*/
|
|
730
727
|
getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
|
|
731
728
|
opts = opts || {};
|
|
@@ -6572,7 +6569,6 @@ class ConversationsApi {
|
|
|
6572
6569
|
* @param {Object} body query
|
|
6573
6570
|
* @param {Object} opts Optional parameters
|
|
6574
6571
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6575
|
-
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6576
6572
|
*/
|
|
6577
6573
|
postAnalyticsConversationsAggregatesJobs(body, opts) {
|
|
6578
6574
|
opts = opts || {};
|
|
@@ -9557,7 +9553,7 @@ class ConversationsApi {
|
|
|
9557
9553
|
|
|
9558
9554
|
/**
|
|
9559
9555
|
* Send an agentless outbound message
|
|
9560
|
-
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and
|
|
9556
|
+
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and recipient specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
|
|
9561
9557
|
* @param {Object} body Create agentless outbound messaging request
|
|
9562
9558
|
* @param {Object} opts Optional parameters
|
|
9563
9559
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, messagingTemplate) (default to false)
|
|
@@ -5,7 +5,7 @@ class FlowsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Flows service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 254.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -26,7 +26,6 @@ class FlowsApi {
|
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
27
|
* @param {Object} opts Optional parameters
|
|
28
28
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29
|
-
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30
29
|
*/
|
|
31
30
|
deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
32
31
|
opts = opts || {};
|
|
@@ -57,7 +56,6 @@ class FlowsApi {
|
|
|
57
56
|
* @param {String} jobId jobId
|
|
58
57
|
* @param {Object} opts Optional parameters
|
|
59
58
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
60
|
-
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
61
59
|
*/
|
|
62
60
|
getAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
63
61
|
opts = opts || {};
|
|
@@ -89,7 +87,6 @@ class FlowsApi {
|
|
|
89
87
|
* @param {Object} opts Optional parameters
|
|
90
88
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
91
89
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
92
|
-
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
93
90
|
*/
|
|
94
91
|
getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
|
|
95
92
|
opts = opts || {};
|
|
@@ -152,7 +149,6 @@ class FlowsApi {
|
|
|
152
149
|
* @param {Object} body query
|
|
153
150
|
* @param {Object} opts Optional parameters
|
|
154
151
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
155
|
-
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
156
152
|
*/
|
|
157
153
|
postAnalyticsFlowsAggregatesJobs(body, opts) {
|
|
158
154
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class JourneyApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Journey service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 254.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -26,7 +26,6 @@ class JourneyApi {
|
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
27
|
* @param {Object} opts Optional parameters
|
|
28
28
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
29
|
-
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30
29
|
*/
|
|
31
30
|
deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
32
31
|
opts = opts || {};
|
|
@@ -330,7 +329,6 @@ class JourneyApi {
|
|
|
330
329
|
* @param {String} jobId jobId
|
|
331
330
|
* @param {Object} opts Optional parameters
|
|
332
331
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
333
|
-
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
334
332
|
*/
|
|
335
333
|
getAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
336
334
|
opts = opts || {};
|
|
@@ -362,7 +360,6 @@ class JourneyApi {
|
|
|
362
360
|
* @param {Object} opts Optional parameters
|
|
363
361
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
364
362
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
365
|
-
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
366
363
|
*/
|
|
367
364
|
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
368
365
|
opts = opts || {};
|
|
@@ -578,11 +575,12 @@ class JourneyApi {
|
|
|
578
575
|
}
|
|
579
576
|
|
|
580
577
|
/**
|
|
581
|
-
* Retrieve a single action target.
|
|
582
|
-
*
|
|
578
|
+
* Deprecated. Retrieve a single action target.
|
|
579
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
583
580
|
* @param {String} actionTargetId ID of the action target.
|
|
584
581
|
* @param {Object} opts Optional parameters
|
|
585
582
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
583
|
+
* @deprecated
|
|
586
584
|
*/
|
|
587
585
|
getJourneyActiontarget(actionTargetId, opts) {
|
|
588
586
|
opts = opts || {};
|
|
@@ -608,12 +606,13 @@ class JourneyApi {
|
|
|
608
606
|
}
|
|
609
607
|
|
|
610
608
|
/**
|
|
611
|
-
* Retrieve all action targets.
|
|
612
|
-
*
|
|
609
|
+
* Deprecated. Retrieve all action targets.
|
|
610
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
613
611
|
* @param {Object} opts Optional parameters
|
|
614
612
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
615
613
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
616
614
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
615
|
+
* @deprecated
|
|
617
616
|
*/
|
|
618
617
|
getJourneyActiontargets(opts) {
|
|
619
618
|
opts = opts || {};
|
|
@@ -1783,6 +1782,56 @@ class JourneyApi {
|
|
|
1783
1782
|
);
|
|
1784
1783
|
}
|
|
1785
1784
|
|
|
1785
|
+
/**
|
|
1786
|
+
* Get external events for journey views
|
|
1787
|
+
*
|
|
1788
|
+
* @param {Object} opts Optional parameters
|
|
1789
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1790
|
+
*/
|
|
1791
|
+
getJourneyViewsEventdefinitionsExternal(opts) {
|
|
1792
|
+
opts = opts || {};
|
|
1793
|
+
|
|
1794
|
+
|
|
1795
|
+
return this.apiClient.callApi(
|
|
1796
|
+
'/api/v2/journey/views/eventdefinitions/external',
|
|
1797
|
+
'GET',
|
|
1798
|
+
{ },
|
|
1799
|
+
{ },
|
|
1800
|
+
{ },
|
|
1801
|
+
{ },
|
|
1802
|
+
null,
|
|
1803
|
+
['PureCloud OAuth'],
|
|
1804
|
+
['application/json'],
|
|
1805
|
+
['application/json'],
|
|
1806
|
+
opts['customHeaders']
|
|
1807
|
+
);
|
|
1808
|
+
}
|
|
1809
|
+
|
|
1810
|
+
/**
|
|
1811
|
+
* Get changes in external event definitions
|
|
1812
|
+
*
|
|
1813
|
+
* @param {Object} opts Optional parameters
|
|
1814
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1815
|
+
*/
|
|
1816
|
+
getJourneyViewsEventdefinitionsExternalChanges(opts) {
|
|
1817
|
+
opts = opts || {};
|
|
1818
|
+
|
|
1819
|
+
|
|
1820
|
+
return this.apiClient.callApi(
|
|
1821
|
+
'/api/v2/journey/views/eventdefinitions/external/changes',
|
|
1822
|
+
'GET',
|
|
1823
|
+
{ },
|
|
1824
|
+
{ },
|
|
1825
|
+
{ },
|
|
1826
|
+
{ },
|
|
1827
|
+
null,
|
|
1828
|
+
['PureCloud OAuth'],
|
|
1829
|
+
['application/json'],
|
|
1830
|
+
['application/json'],
|
|
1831
|
+
opts['customHeaders']
|
|
1832
|
+
);
|
|
1833
|
+
}
|
|
1834
|
+
|
|
1786
1835
|
/**
|
|
1787
1836
|
* Get the jobs for an organization.
|
|
1788
1837
|
*
|
|
@@ -1900,12 +1949,13 @@ class JourneyApi {
|
|
|
1900
1949
|
}
|
|
1901
1950
|
|
|
1902
1951
|
/**
|
|
1903
|
-
* Update a single action target.
|
|
1904
|
-
*
|
|
1952
|
+
* Deprecated. Update a single action target.
|
|
1953
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
1905
1954
|
* @param {String} actionTargetId ID of the action target.
|
|
1906
1955
|
* @param {Object} opts Optional parameters
|
|
1907
1956
|
* @param {Object} opts.body
|
|
1908
1957
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1958
|
+
* @deprecated
|
|
1909
1959
|
*/
|
|
1910
1960
|
patchJourneyActiontarget(actionTargetId, opts) {
|
|
1911
1961
|
opts = opts || {};
|
|
@@ -2106,7 +2156,6 @@ class JourneyApi {
|
|
|
2106
2156
|
* @param {Object} body query
|
|
2107
2157
|
* @param {Object} opts Optional parameters
|
|
2108
2158
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2109
|
-
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2110
2159
|
*/
|
|
2111
2160
|
postAnalyticsJourneysAggregatesJobs(body, opts) {
|
|
2112
2161
|
opts = opts || {};
|
|
@@ -2864,6 +2913,68 @@ class JourneyApi {
|
|
|
2864
2913
|
);
|
|
2865
2914
|
}
|
|
2866
2915
|
|
|
2916
|
+
/**
|
|
2917
|
+
* Update external event for journey views
|
|
2918
|
+
*
|
|
2919
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
2920
|
+
* @param {Object} opts Optional parameters
|
|
2921
|
+
* @param {Object} opts.body
|
|
2922
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2923
|
+
*/
|
|
2924
|
+
putJourneyViewsEventdefinition(eventDefinitionId, opts) {
|
|
2925
|
+
opts = opts || {};
|
|
2926
|
+
|
|
2927
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
2928
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
2929
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';
|
|
2930
|
+
}
|
|
2931
|
+
|
|
2932
|
+
return this.apiClient.callApi(
|
|
2933
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
2934
|
+
'PUT',
|
|
2935
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
2936
|
+
{ },
|
|
2937
|
+
{ },
|
|
2938
|
+
{ },
|
|
2939
|
+
opts['body'],
|
|
2940
|
+
['PureCloud OAuth'],
|
|
2941
|
+
['application/json'],
|
|
2942
|
+
['application/json'],
|
|
2943
|
+
opts['customHeaders']
|
|
2944
|
+
);
|
|
2945
|
+
}
|
|
2946
|
+
|
|
2947
|
+
/**
|
|
2948
|
+
* Activate external event for journey views
|
|
2949
|
+
*
|
|
2950
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
2951
|
+
* @param {Object} opts Optional parameters
|
|
2952
|
+
* @param {Object} opts.body
|
|
2953
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2954
|
+
*/
|
|
2955
|
+
putJourneyViewsEventdefinitionActivate(eventDefinitionId, opts) {
|
|
2956
|
+
opts = opts || {};
|
|
2957
|
+
|
|
2958
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
2959
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
2960
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';
|
|
2961
|
+
}
|
|
2962
|
+
|
|
2963
|
+
return this.apiClient.callApi(
|
|
2964
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate',
|
|
2965
|
+
'PUT',
|
|
2966
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
2967
|
+
{ },
|
|
2968
|
+
{ },
|
|
2969
|
+
{ },
|
|
2970
|
+
opts['body'],
|
|
2971
|
+
['PureCloud OAuth'],
|
|
2972
|
+
['application/json'],
|
|
2973
|
+
['application/json'],
|
|
2974
|
+
opts['customHeaders']
|
|
2975
|
+
);
|
|
2976
|
+
}
|
|
2977
|
+
|
|
2867
2978
|
}
|
|
2868
2979
|
|
|
2869
2980
|
|
|
@@ -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 254.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1204,6 +1204,47 @@ class KnowledgeApi {
|
|
|
1204
1204
|
);
|
|
1205
1205
|
}
|
|
1206
1206
|
|
|
1207
|
+
/**
|
|
1208
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
1209
|
+
*
|
|
1210
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
1211
|
+
* @param {Object} opts Optional parameters
|
|
1212
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
1213
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1214
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
1215
|
+
* @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.
|
|
1216
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
1217
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
1218
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
1219
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
1220
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
1221
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
1222
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
1223
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1224
|
+
*/
|
|
1225
|
+
getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId, opts) {
|
|
1226
|
+
opts = opts || {};
|
|
1227
|
+
|
|
1228
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
1229
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
1230
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentsFeedback';
|
|
1231
|
+
}
|
|
1232
|
+
|
|
1233
|
+
return this.apiClient.callApi(
|
|
1234
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback',
|
|
1235
|
+
'GET',
|
|
1236
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
1237
|
+
{ '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'] },
|
|
1238
|
+
{ },
|
|
1239
|
+
{ },
|
|
1240
|
+
null,
|
|
1241
|
+
['PureCloud OAuth'],
|
|
1242
|
+
['application/json'],
|
|
1243
|
+
['application/json'],
|
|
1244
|
+
opts['customHeaders']
|
|
1245
|
+
);
|
|
1246
|
+
}
|
|
1247
|
+
|
|
1207
1248
|
/**
|
|
1208
1249
|
* Get export job report
|
|
1209
1250
|
*
|