purecloud-platform-client-v2 252.0.0 → 253.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 +916 -345
- package/dist/web-amd/purecloud-platform-client-v2.js +916 -345
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +338 -179
- package/dist/web-cjs/purecloud-platform-client-v2.js +338 -179
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +632 -102
- package/package.json +5 -5
- package/src/purecloud-platform-client-v2/ApiClient.js +9 -6
- 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 -1
- 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 +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.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 +1 -1
- 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 -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/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -7
- 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 -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 +179 -156
- 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 +1 -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 -1
- 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 +472 -39
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -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 253.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -578,11 +578,12 @@ class JourneyApi {
|
|
|
578
578
|
}
|
|
579
579
|
|
|
580
580
|
/**
|
|
581
|
-
* Retrieve a single action target.
|
|
582
|
-
*
|
|
581
|
+
* Deprecated. Retrieve a single action target.
|
|
582
|
+
* 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
583
|
* @param {String} actionTargetId ID of the action target.
|
|
584
584
|
* @param {Object} opts Optional parameters
|
|
585
585
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
586
|
+
* @deprecated
|
|
586
587
|
*/
|
|
587
588
|
getJourneyActiontarget(actionTargetId, opts) {
|
|
588
589
|
opts = opts || {};
|
|
@@ -608,12 +609,13 @@ class JourneyApi {
|
|
|
608
609
|
}
|
|
609
610
|
|
|
610
611
|
/**
|
|
611
|
-
* Retrieve all action targets.
|
|
612
|
-
*
|
|
612
|
+
* Deprecated. Retrieve all action targets.
|
|
613
|
+
* 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
614
|
* @param {Object} opts Optional parameters
|
|
614
615
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
615
616
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
616
617
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
618
|
+
* @deprecated
|
|
617
619
|
*/
|
|
618
620
|
getJourneyActiontargets(opts) {
|
|
619
621
|
opts = opts || {};
|
|
@@ -1783,6 +1785,56 @@ class JourneyApi {
|
|
|
1783
1785
|
);
|
|
1784
1786
|
}
|
|
1785
1787
|
|
|
1788
|
+
/**
|
|
1789
|
+
* Get external events for journey views
|
|
1790
|
+
*
|
|
1791
|
+
* @param {Object} opts Optional parameters
|
|
1792
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1793
|
+
*/
|
|
1794
|
+
getJourneyViewsEventdefinitionsExternal(opts) {
|
|
1795
|
+
opts = opts || {};
|
|
1796
|
+
|
|
1797
|
+
|
|
1798
|
+
return this.apiClient.callApi(
|
|
1799
|
+
'/api/v2/journey/views/eventdefinitions/external',
|
|
1800
|
+
'GET',
|
|
1801
|
+
{ },
|
|
1802
|
+
{ },
|
|
1803
|
+
{ },
|
|
1804
|
+
{ },
|
|
1805
|
+
null,
|
|
1806
|
+
['PureCloud OAuth'],
|
|
1807
|
+
['application/json'],
|
|
1808
|
+
['application/json'],
|
|
1809
|
+
opts['customHeaders']
|
|
1810
|
+
);
|
|
1811
|
+
}
|
|
1812
|
+
|
|
1813
|
+
/**
|
|
1814
|
+
* Get changes in external event definitions
|
|
1815
|
+
*
|
|
1816
|
+
* @param {Object} opts Optional parameters
|
|
1817
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1818
|
+
*/
|
|
1819
|
+
getJourneyViewsEventdefinitionsExternalChanges(opts) {
|
|
1820
|
+
opts = opts || {};
|
|
1821
|
+
|
|
1822
|
+
|
|
1823
|
+
return this.apiClient.callApi(
|
|
1824
|
+
'/api/v2/journey/views/eventdefinitions/external/changes',
|
|
1825
|
+
'GET',
|
|
1826
|
+
{ },
|
|
1827
|
+
{ },
|
|
1828
|
+
{ },
|
|
1829
|
+
{ },
|
|
1830
|
+
null,
|
|
1831
|
+
['PureCloud OAuth'],
|
|
1832
|
+
['application/json'],
|
|
1833
|
+
['application/json'],
|
|
1834
|
+
opts['customHeaders']
|
|
1835
|
+
);
|
|
1836
|
+
}
|
|
1837
|
+
|
|
1786
1838
|
/**
|
|
1787
1839
|
* Get the jobs for an organization.
|
|
1788
1840
|
*
|
|
@@ -1900,12 +1952,13 @@ class JourneyApi {
|
|
|
1900
1952
|
}
|
|
1901
1953
|
|
|
1902
1954
|
/**
|
|
1903
|
-
* Update a single action target.
|
|
1904
|
-
*
|
|
1955
|
+
* Deprecated. Update a single action target.
|
|
1956
|
+
* 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
1957
|
* @param {String} actionTargetId ID of the action target.
|
|
1906
1958
|
* @param {Object} opts Optional parameters
|
|
1907
1959
|
* @param {Object} opts.body
|
|
1908
1960
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1961
|
+
* @deprecated
|
|
1909
1962
|
*/
|
|
1910
1963
|
patchJourneyActiontarget(actionTargetId, opts) {
|
|
1911
1964
|
opts = opts || {};
|
|
@@ -2864,6 +2917,68 @@ class JourneyApi {
|
|
|
2864
2917
|
);
|
|
2865
2918
|
}
|
|
2866
2919
|
|
|
2920
|
+
/**
|
|
2921
|
+
* Update external event for journey views
|
|
2922
|
+
*
|
|
2923
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
2924
|
+
* @param {Object} opts Optional parameters
|
|
2925
|
+
* @param {Object} opts.body
|
|
2926
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2927
|
+
*/
|
|
2928
|
+
putJourneyViewsEventdefinition(eventDefinitionId, opts) {
|
|
2929
|
+
opts = opts || {};
|
|
2930
|
+
|
|
2931
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
2932
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
2933
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';
|
|
2934
|
+
}
|
|
2935
|
+
|
|
2936
|
+
return this.apiClient.callApi(
|
|
2937
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
2938
|
+
'PUT',
|
|
2939
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
2940
|
+
{ },
|
|
2941
|
+
{ },
|
|
2942
|
+
{ },
|
|
2943
|
+
opts['body'],
|
|
2944
|
+
['PureCloud OAuth'],
|
|
2945
|
+
['application/json'],
|
|
2946
|
+
['application/json'],
|
|
2947
|
+
opts['customHeaders']
|
|
2948
|
+
);
|
|
2949
|
+
}
|
|
2950
|
+
|
|
2951
|
+
/**
|
|
2952
|
+
* Activate external event for journey views
|
|
2953
|
+
*
|
|
2954
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
2955
|
+
* @param {Object} opts Optional parameters
|
|
2956
|
+
* @param {Object} opts.body
|
|
2957
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2958
|
+
*/
|
|
2959
|
+
putJourneyViewsEventdefinitionActivate(eventDefinitionId, opts) {
|
|
2960
|
+
opts = opts || {};
|
|
2961
|
+
|
|
2962
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
2963
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
2964
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';
|
|
2965
|
+
}
|
|
2966
|
+
|
|
2967
|
+
return this.apiClient.callApi(
|
|
2968
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate',
|
|
2969
|
+
'PUT',
|
|
2970
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
2971
|
+
{ },
|
|
2972
|
+
{ },
|
|
2973
|
+
{ },
|
|
2974
|
+
opts['body'],
|
|
2975
|
+
['PureCloud OAuth'],
|
|
2976
|
+
['application/json'],
|
|
2977
|
+
['application/json'],
|
|
2978
|
+
opts['customHeaders']
|
|
2979
|
+
);
|
|
2980
|
+
}
|
|
2981
|
+
|
|
2867
2982
|
}
|
|
2868
2983
|
|
|
2869
2984
|
|
|
@@ -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 253.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
|
*
|