purecloud-platform-client-v2 205.0.0 → 207.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 +102 -3
- package/dist/node/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.js +1241 -133
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.js +384 -137
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1242 -275
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +40 -18
- 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 +7 -6
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +2 -2
- 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 +2 -3
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +9 -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/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +232 -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 +191 -4
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -19
- 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 +48 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +101 -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 +1 -1
- 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/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 +311 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +7 -3
- 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 +27 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +56 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +2 -2
- 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 +60 -1
- package/src/purecloud-platform-client-v2/configuration.js +81 -0
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class ExternalContactsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* ExternalContacts service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -126,6 +126,31 @@ class ExternalContactsApi {
|
|
|
126
126
|
);
|
|
127
127
|
}
|
|
128
128
|
|
|
129
|
+
/**
|
|
130
|
+
* Delete settings for CSV import
|
|
131
|
+
*
|
|
132
|
+
* @param {String} settingsId Settings id
|
|
133
|
+
*/
|
|
134
|
+
deleteExternalcontactsImportCsvSetting(settingsId) {
|
|
135
|
+
// verify the required parameter 'settingsId' is set
|
|
136
|
+
if (settingsId === undefined || settingsId === null) {
|
|
137
|
+
throw 'Missing the required parameter "settingsId" when calling deleteExternalcontactsImportCsvSetting';
|
|
138
|
+
}
|
|
139
|
+
|
|
140
|
+
return this.apiClient.callApi(
|
|
141
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
142
|
+
'DELETE',
|
|
143
|
+
{ 'settingsId': settingsId },
|
|
144
|
+
{ },
|
|
145
|
+
{ },
|
|
146
|
+
{ },
|
|
147
|
+
null,
|
|
148
|
+
['PureCloud OAuth'],
|
|
149
|
+
['application/json'],
|
|
150
|
+
['application/json']
|
|
151
|
+
);
|
|
152
|
+
}
|
|
153
|
+
|
|
129
154
|
/**
|
|
130
155
|
* Delete an external organization
|
|
131
156
|
*
|
|
@@ -593,6 +618,107 @@ class ExternalContactsApi {
|
|
|
593
618
|
);
|
|
594
619
|
}
|
|
595
620
|
|
|
621
|
+
/**
|
|
622
|
+
* Get settings for CSV import
|
|
623
|
+
*
|
|
624
|
+
* @param {String} settingsId Settings id
|
|
625
|
+
*/
|
|
626
|
+
getExternalcontactsImportCsvSetting(settingsId) {
|
|
627
|
+
// verify the required parameter 'settingsId' is set
|
|
628
|
+
if (settingsId === undefined || settingsId === null) {
|
|
629
|
+
throw 'Missing the required parameter "settingsId" when calling getExternalcontactsImportCsvSetting';
|
|
630
|
+
}
|
|
631
|
+
|
|
632
|
+
return this.apiClient.callApi(
|
|
633
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
634
|
+
'GET',
|
|
635
|
+
{ 'settingsId': settingsId },
|
|
636
|
+
{ },
|
|
637
|
+
{ },
|
|
638
|
+
{ },
|
|
639
|
+
null,
|
|
640
|
+
['PureCloud OAuth'],
|
|
641
|
+
['application/json'],
|
|
642
|
+
['application/json']
|
|
643
|
+
);
|
|
644
|
+
}
|
|
645
|
+
|
|
646
|
+
/**
|
|
647
|
+
* Retrieve all settings for organization filtered by externalSettingsId if provided
|
|
648
|
+
*
|
|
649
|
+
* @param {Object} opts Optional parameters
|
|
650
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
651
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
652
|
+
* @param {String} opts.externalSettingsId External Settings Id to filter the list.
|
|
653
|
+
*/
|
|
654
|
+
getExternalcontactsImportCsvSettings(opts) {
|
|
655
|
+
opts = opts || {};
|
|
656
|
+
|
|
657
|
+
|
|
658
|
+
return this.apiClient.callApi(
|
|
659
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
660
|
+
'GET',
|
|
661
|
+
{ },
|
|
662
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'externalSettingsId': opts['externalSettingsId'] },
|
|
663
|
+
{ },
|
|
664
|
+
{ },
|
|
665
|
+
null,
|
|
666
|
+
['PureCloud OAuth'],
|
|
667
|
+
['application/json'],
|
|
668
|
+
['application/json']
|
|
669
|
+
);
|
|
670
|
+
}
|
|
671
|
+
|
|
672
|
+
/**
|
|
673
|
+
* Get details for CSV upload
|
|
674
|
+
*
|
|
675
|
+
* @param {String} uploadId Upload id
|
|
676
|
+
*/
|
|
677
|
+
getExternalcontactsImportCsvUploadDetails(uploadId) {
|
|
678
|
+
// verify the required parameter 'uploadId' is set
|
|
679
|
+
if (uploadId === undefined || uploadId === null) {
|
|
680
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadDetails';
|
|
681
|
+
}
|
|
682
|
+
|
|
683
|
+
return this.apiClient.callApi(
|
|
684
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/details',
|
|
685
|
+
'GET',
|
|
686
|
+
{ 'uploadId': uploadId },
|
|
687
|
+
{ },
|
|
688
|
+
{ },
|
|
689
|
+
{ },
|
|
690
|
+
null,
|
|
691
|
+
['PureCloud OAuth'],
|
|
692
|
+
['application/json'],
|
|
693
|
+
['application/json']
|
|
694
|
+
);
|
|
695
|
+
}
|
|
696
|
+
|
|
697
|
+
/**
|
|
698
|
+
* Get preview for CSV upload
|
|
699
|
+
*
|
|
700
|
+
* @param {String} uploadId Upload id
|
|
701
|
+
*/
|
|
702
|
+
getExternalcontactsImportCsvUploadPreview(uploadId) {
|
|
703
|
+
// verify the required parameter 'uploadId' is set
|
|
704
|
+
if (uploadId === undefined || uploadId === null) {
|
|
705
|
+
throw 'Missing the required parameter "uploadId" when calling getExternalcontactsImportCsvUploadPreview';
|
|
706
|
+
}
|
|
707
|
+
|
|
708
|
+
return this.apiClient.callApi(
|
|
709
|
+
'/api/v2/externalcontacts/import/csv/uploads/{uploadId}/preview',
|
|
710
|
+
'GET',
|
|
711
|
+
{ 'uploadId': uploadId },
|
|
712
|
+
{ },
|
|
713
|
+
{ },
|
|
714
|
+
{ },
|
|
715
|
+
null,
|
|
716
|
+
['PureCloud OAuth'],
|
|
717
|
+
['application/json'],
|
|
718
|
+
['application/json']
|
|
719
|
+
);
|
|
720
|
+
}
|
|
721
|
+
|
|
596
722
|
/**
|
|
597
723
|
* Fetch an external organization
|
|
598
724
|
*
|
|
@@ -1657,6 +1783,81 @@ class ExternalContactsApi {
|
|
|
1657
1783
|
);
|
|
1658
1784
|
}
|
|
1659
1785
|
|
|
1786
|
+
/**
|
|
1787
|
+
* Create CSV import job
|
|
1788
|
+
*
|
|
1789
|
+
* @param {Object} body ImportRequest
|
|
1790
|
+
*/
|
|
1791
|
+
postExternalcontactsImportCsvJobs(body) {
|
|
1792
|
+
// verify the required parameter 'body' is set
|
|
1793
|
+
if (body === undefined || body === null) {
|
|
1794
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvJobs';
|
|
1795
|
+
}
|
|
1796
|
+
|
|
1797
|
+
return this.apiClient.callApi(
|
|
1798
|
+
'/api/v2/externalcontacts/import/csv/jobs',
|
|
1799
|
+
'POST',
|
|
1800
|
+
{ },
|
|
1801
|
+
{ },
|
|
1802
|
+
{ },
|
|
1803
|
+
{ },
|
|
1804
|
+
body,
|
|
1805
|
+
['PureCloud OAuth'],
|
|
1806
|
+
['application/json'],
|
|
1807
|
+
['application/json']
|
|
1808
|
+
);
|
|
1809
|
+
}
|
|
1810
|
+
|
|
1811
|
+
/**
|
|
1812
|
+
* Create settings for CSV import
|
|
1813
|
+
*
|
|
1814
|
+
* @param {Object} body Settings
|
|
1815
|
+
*/
|
|
1816
|
+
postExternalcontactsImportCsvSettings(body) {
|
|
1817
|
+
// verify the required parameter 'body' is set
|
|
1818
|
+
if (body === undefined || body === null) {
|
|
1819
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvSettings';
|
|
1820
|
+
}
|
|
1821
|
+
|
|
1822
|
+
return this.apiClient.callApi(
|
|
1823
|
+
'/api/v2/externalcontacts/import/csv/settings',
|
|
1824
|
+
'POST',
|
|
1825
|
+
{ },
|
|
1826
|
+
{ },
|
|
1827
|
+
{ },
|
|
1828
|
+
{ },
|
|
1829
|
+
body,
|
|
1830
|
+
['PureCloud OAuth'],
|
|
1831
|
+
['application/json'],
|
|
1832
|
+
['application/json']
|
|
1833
|
+
);
|
|
1834
|
+
}
|
|
1835
|
+
|
|
1836
|
+
/**
|
|
1837
|
+
* Get url for CSV upload
|
|
1838
|
+
*
|
|
1839
|
+
* @param {Object} body UploadRequest
|
|
1840
|
+
*/
|
|
1841
|
+
postExternalcontactsImportCsvUploads(body) {
|
|
1842
|
+
// verify the required parameter 'body' is set
|
|
1843
|
+
if (body === undefined || body === null) {
|
|
1844
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsImportCsvUploads';
|
|
1845
|
+
}
|
|
1846
|
+
|
|
1847
|
+
return this.apiClient.callApi(
|
|
1848
|
+
'/api/v2/externalcontacts/import/csv/uploads',
|
|
1849
|
+
'POST',
|
|
1850
|
+
{ },
|
|
1851
|
+
{ },
|
|
1852
|
+
{ },
|
|
1853
|
+
{ },
|
|
1854
|
+
body,
|
|
1855
|
+
['PureCloud OAuth'],
|
|
1856
|
+
['application/json'],
|
|
1857
|
+
['application/json']
|
|
1858
|
+
);
|
|
1859
|
+
}
|
|
1860
|
+
|
|
1660
1861
|
/**
|
|
1661
1862
|
* Merge two contacts into a new contact record
|
|
1662
1863
|
* Two curated contacts cannot be merged. Refer to the Contact Merging article on the Developer Center for details
|
|
@@ -1943,6 +2144,36 @@ class ExternalContactsApi {
|
|
|
1943
2144
|
);
|
|
1944
2145
|
}
|
|
1945
2146
|
|
|
2147
|
+
/**
|
|
2148
|
+
* Update settings for CSV import
|
|
2149
|
+
*
|
|
2150
|
+
* @param {String} settingsId Settings id
|
|
2151
|
+
* @param {Object} body Settings
|
|
2152
|
+
*/
|
|
2153
|
+
putExternalcontactsImportCsvSetting(settingsId, body) {
|
|
2154
|
+
// verify the required parameter 'settingsId' is set
|
|
2155
|
+
if (settingsId === undefined || settingsId === null) {
|
|
2156
|
+
throw 'Missing the required parameter "settingsId" when calling putExternalcontactsImportCsvSetting';
|
|
2157
|
+
}
|
|
2158
|
+
// verify the required parameter 'body' is set
|
|
2159
|
+
if (body === undefined || body === null) {
|
|
2160
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsImportCsvSetting';
|
|
2161
|
+
}
|
|
2162
|
+
|
|
2163
|
+
return this.apiClient.callApi(
|
|
2164
|
+
'/api/v2/externalcontacts/import/csv/settings/{settingsId}',
|
|
2165
|
+
'PUT',
|
|
2166
|
+
{ 'settingsId': settingsId },
|
|
2167
|
+
{ },
|
|
2168
|
+
{ },
|
|
2169
|
+
{ },
|
|
2170
|
+
body,
|
|
2171
|
+
['PureCloud OAuth'],
|
|
2172
|
+
['application/json'],
|
|
2173
|
+
['application/json']
|
|
2174
|
+
);
|
|
2175
|
+
}
|
|
2176
|
+
|
|
1946
2177
|
/**
|
|
1947
2178
|
* Update an external organization
|
|
1948
2179
|
*
|
|
@@ -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 207.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -852,6 +852,81 @@ class JourneyApi {
|
|
|
852
852
|
);
|
|
853
853
|
}
|
|
854
854
|
|
|
855
|
+
/**
|
|
856
|
+
* Get a Chart by ID
|
|
857
|
+
* returns the latest version
|
|
858
|
+
* @param {String} viewId viewId
|
|
859
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
860
|
+
* @param {String} chartId chartId
|
|
861
|
+
*/
|
|
862
|
+
getJourneyViewVersionChart(viewId, journeyViewVersion, chartId) {
|
|
863
|
+
// verify the required parameter 'viewId' is set
|
|
864
|
+
if (viewId === undefined || viewId === null) {
|
|
865
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';
|
|
866
|
+
}
|
|
867
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
868
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
869
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChart';
|
|
870
|
+
}
|
|
871
|
+
// verify the required parameter 'chartId' is set
|
|
872
|
+
if (chartId === undefined || chartId === null) {
|
|
873
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChart';
|
|
874
|
+
}
|
|
875
|
+
|
|
876
|
+
return this.apiClient.callApi(
|
|
877
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}',
|
|
878
|
+
'GET',
|
|
879
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId },
|
|
880
|
+
{ },
|
|
881
|
+
{ },
|
|
882
|
+
{ },
|
|
883
|
+
null,
|
|
884
|
+
['PureCloud OAuth'],
|
|
885
|
+
['application/json'],
|
|
886
|
+
['application/json']
|
|
887
|
+
);
|
|
888
|
+
}
|
|
889
|
+
|
|
890
|
+
/**
|
|
891
|
+
* Get a Chart by ID and version
|
|
892
|
+
*
|
|
893
|
+
* @param {String} viewId viewId
|
|
894
|
+
* @param {String} journeyViewVersion Journey View Version
|
|
895
|
+
* @param {String} chartId chartId
|
|
896
|
+
* @param {String} chartVersion chartVersion
|
|
897
|
+
*/
|
|
898
|
+
getJourneyViewVersionChartVersion(viewId, journeyViewVersion, chartId, chartVersion) {
|
|
899
|
+
// verify the required parameter 'viewId' is set
|
|
900
|
+
if (viewId === undefined || viewId === null) {
|
|
901
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';
|
|
902
|
+
}
|
|
903
|
+
// verify the required parameter 'journeyViewVersion' is set
|
|
904
|
+
if (journeyViewVersion === undefined || journeyViewVersion === null) {
|
|
905
|
+
throw 'Missing the required parameter "journeyViewVersion" when calling getJourneyViewVersionChartVersion';
|
|
906
|
+
}
|
|
907
|
+
// verify the required parameter 'chartId' is set
|
|
908
|
+
if (chartId === undefined || chartId === null) {
|
|
909
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionChartVersion';
|
|
910
|
+
}
|
|
911
|
+
// verify the required parameter 'chartVersion' is set
|
|
912
|
+
if (chartVersion === undefined || chartVersion === null) {
|
|
913
|
+
throw 'Missing the required parameter "chartVersion" when calling getJourneyViewVersionChartVersion';
|
|
914
|
+
}
|
|
915
|
+
|
|
916
|
+
return this.apiClient.callApi(
|
|
917
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyViewVersion}/charts/{chartId}/versions/{chartVersion}',
|
|
918
|
+
'GET',
|
|
919
|
+
{ 'viewId': viewId,'journeyViewVersion': journeyViewVersion,'chartId': chartId,'chartVersion': chartVersion },
|
|
920
|
+
{ },
|
|
921
|
+
{ },
|
|
922
|
+
{ },
|
|
923
|
+
null,
|
|
924
|
+
['PureCloud OAuth'],
|
|
925
|
+
['application/json'],
|
|
926
|
+
['application/json']
|
|
927
|
+
);
|
|
928
|
+
}
|
|
929
|
+
|
|
855
930
|
/**
|
|
856
931
|
* Get the job for a journey view version.
|
|
857
932
|
* used for long descriptions
|
|
@@ -922,6 +997,46 @@ class JourneyApi {
|
|
|
922
997
|
);
|
|
923
998
|
}
|
|
924
999
|
|
|
1000
|
+
/**
|
|
1001
|
+
* Get the chart result associated with a journey view job.
|
|
1002
|
+
*
|
|
1003
|
+
* @param {String} viewId Journey View Id
|
|
1004
|
+
* @param {String} journeyVersionId Journey View Version
|
|
1005
|
+
* @param {String} jobId JobId
|
|
1006
|
+
* @param {String} chartId ChartId
|
|
1007
|
+
*/
|
|
1008
|
+
getJourneyViewVersionJobResultsChart(viewId, journeyVersionId, jobId, chartId) {
|
|
1009
|
+
// verify the required parameter 'viewId' is set
|
|
1010
|
+
if (viewId === undefined || viewId === null) {
|
|
1011
|
+
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';
|
|
1012
|
+
}
|
|
1013
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
1014
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
1015
|
+
throw 'Missing the required parameter "journeyVersionId" when calling getJourneyViewVersionJobResultsChart';
|
|
1016
|
+
}
|
|
1017
|
+
// verify the required parameter 'jobId' is set
|
|
1018
|
+
if (jobId === undefined || jobId === null) {
|
|
1019
|
+
throw 'Missing the required parameter "jobId" when calling getJourneyViewVersionJobResultsChart';
|
|
1020
|
+
}
|
|
1021
|
+
// verify the required parameter 'chartId' is set
|
|
1022
|
+
if (chartId === undefined || chartId === null) {
|
|
1023
|
+
throw 'Missing the required parameter "chartId" when calling getJourneyViewVersionJobResultsChart';
|
|
1024
|
+
}
|
|
1025
|
+
|
|
1026
|
+
return this.apiClient.callApi(
|
|
1027
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}/results/charts/{chartId}',
|
|
1028
|
+
'GET',
|
|
1029
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId,'chartId': chartId },
|
|
1030
|
+
{ },
|
|
1031
|
+
{ },
|
|
1032
|
+
{ },
|
|
1033
|
+
null,
|
|
1034
|
+
['PureCloud OAuth'],
|
|
1035
|
+
['application/json'],
|
|
1036
|
+
['application/json']
|
|
1037
|
+
);
|
|
1038
|
+
}
|
|
1039
|
+
|
|
925
1040
|
/**
|
|
926
1041
|
* Get the latest job of a journey view version.
|
|
927
1042
|
* used for long descriptions
|
|
@@ -984,7 +1099,6 @@ class JourneyApi {
|
|
|
984
1099
|
* Get an Event Definition
|
|
985
1100
|
*
|
|
986
1101
|
* @param {String} eventDefinitionId Event Definition ID
|
|
987
|
-
* getJourneyViewsEventdefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
988
1102
|
*/
|
|
989
1103
|
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
990
1104
|
// verify the required parameter 'eventDefinitionId' is set
|
|
@@ -1009,7 +1123,6 @@ class JourneyApi {
|
|
|
1009
1123
|
/**
|
|
1010
1124
|
* Get a list of Event Definitions
|
|
1011
1125
|
*
|
|
1012
|
-
* getJourneyViewsEventdefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1013
1126
|
*/
|
|
1014
1127
|
getJourneyViewsEventdefinitions() {
|
|
1015
1128
|
|
|
@@ -1199,6 +1312,46 @@ class JourneyApi {
|
|
|
1199
1312
|
);
|
|
1200
1313
|
}
|
|
1201
1314
|
|
|
1315
|
+
/**
|
|
1316
|
+
* Update the job for a journey view version. Only the status can be changed and only to Cancelled
|
|
1317
|
+
* used for long descriptions
|
|
1318
|
+
* @param {String} viewId Journey View Id
|
|
1319
|
+
* @param {String} journeyVersionId Journey View Version
|
|
1320
|
+
* @param {String} jobId JobId
|
|
1321
|
+
* @param {Object} body journeyViewJob
|
|
1322
|
+
*/
|
|
1323
|
+
patchJourneyViewVersionJob(viewId, journeyVersionId, jobId, body) {
|
|
1324
|
+
// verify the required parameter 'viewId' is set
|
|
1325
|
+
if (viewId === undefined || viewId === null) {
|
|
1326
|
+
throw 'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';
|
|
1327
|
+
}
|
|
1328
|
+
// verify the required parameter 'journeyVersionId' is set
|
|
1329
|
+
if (journeyVersionId === undefined || journeyVersionId === null) {
|
|
1330
|
+
throw 'Missing the required parameter "journeyVersionId" when calling patchJourneyViewVersionJob';
|
|
1331
|
+
}
|
|
1332
|
+
// verify the required parameter 'jobId' is set
|
|
1333
|
+
if (jobId === undefined || jobId === null) {
|
|
1334
|
+
throw 'Missing the required parameter "jobId" when calling patchJourneyViewVersionJob';
|
|
1335
|
+
}
|
|
1336
|
+
// verify the required parameter 'body' is set
|
|
1337
|
+
if (body === undefined || body === null) {
|
|
1338
|
+
throw 'Missing the required parameter "body" when calling patchJourneyViewVersionJob';
|
|
1339
|
+
}
|
|
1340
|
+
|
|
1341
|
+
return this.apiClient.callApi(
|
|
1342
|
+
'/api/v2/journey/views/{viewId}/versions/{journeyVersionId}/jobs/{jobId}',
|
|
1343
|
+
'PATCH',
|
|
1344
|
+
{ 'viewId': viewId,'journeyVersionId': journeyVersionId,'jobId': jobId },
|
|
1345
|
+
{ },
|
|
1346
|
+
{ },
|
|
1347
|
+
{ },
|
|
1348
|
+
body,
|
|
1349
|
+
['PureCloud OAuth'],
|
|
1350
|
+
['application/json'],
|
|
1351
|
+
['application/json']
|
|
1352
|
+
);
|
|
1353
|
+
}
|
|
1354
|
+
|
|
1202
1355
|
/**
|
|
1203
1356
|
* Query for journey aggregates asynchronously
|
|
1204
1357
|
*
|
|
@@ -1622,7 +1775,6 @@ class JourneyApi {
|
|
|
1622
1775
|
* True indicates a valid encoding
|
|
1623
1776
|
* @param {Object} opts Optional parameters
|
|
1624
1777
|
* @param {Array.<Object>} opts.body
|
|
1625
|
-
* postJourneyViewsEncodingsValidate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1626
1778
|
*/
|
|
1627
1779
|
postJourneyViewsEncodingsValidate(opts) {
|
|
1628
1780
|
opts = opts || {};
|
|
@@ -1642,6 +1794,41 @@ class JourneyApi {
|
|
|
1642
1794
|
);
|
|
1643
1795
|
}
|
|
1644
1796
|
|
|
1797
|
+
/**
|
|
1798
|
+
* Update a Journey View by ID and version
|
|
1799
|
+
* does not create a new version
|
|
1800
|
+
* @param {String} viewId viewId
|
|
1801
|
+
* @param {String} versionId versionId
|
|
1802
|
+
* @param {Object} body JourneyView
|
|
1803
|
+
*/
|
|
1804
|
+
putJourneyViewVersion(viewId, versionId, body) {
|
|
1805
|
+
// verify the required parameter 'viewId' is set
|
|
1806
|
+
if (viewId === undefined || viewId === null) {
|
|
1807
|
+
throw 'Missing the required parameter "viewId" when calling putJourneyViewVersion';
|
|
1808
|
+
}
|
|
1809
|
+
// verify the required parameter 'versionId' is set
|
|
1810
|
+
if (versionId === undefined || versionId === null) {
|
|
1811
|
+
throw 'Missing the required parameter "versionId" when calling putJourneyViewVersion';
|
|
1812
|
+
}
|
|
1813
|
+
// verify the required parameter 'body' is set
|
|
1814
|
+
if (body === undefined || body === null) {
|
|
1815
|
+
throw 'Missing the required parameter "body" when calling putJourneyViewVersion';
|
|
1816
|
+
}
|
|
1817
|
+
|
|
1818
|
+
return this.apiClient.callApi(
|
|
1819
|
+
'/api/v2/journey/views/{viewId}/versions/{versionId}',
|
|
1820
|
+
'PUT',
|
|
1821
|
+
{ 'viewId': viewId,'versionId': versionId },
|
|
1822
|
+
{ },
|
|
1823
|
+
{ },
|
|
1824
|
+
{ },
|
|
1825
|
+
body,
|
|
1826
|
+
['PureCloud OAuth'],
|
|
1827
|
+
['application/json'],
|
|
1828
|
+
['application/json']
|
|
1829
|
+
);
|
|
1830
|
+
}
|
|
1831
|
+
|
|
1645
1832
|
}
|
|
1646
1833
|
|
|
1647
1834
|
|