purecloud-platform-client-v2 173.0.0 → 174.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 +1432 -106
- package/dist/web-amd/purecloud-platform-client-v2.js +1432 -106
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1432 -106
- package/dist/web-cjs/purecloud-platform-client-v2.js +1432 -106
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1278 -218
- 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 +5 -4
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +493 -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 +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 +223 -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/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 +62 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +188 -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 +10 -8
- 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 +7 -6
- 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 +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +7 -3
- 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 +10 -5
- 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 +363 -6
- 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 174.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -170,6 +170,31 @@ class ConversationsApi {
|
|
|
170
170
|
);
|
|
171
171
|
}
|
|
172
172
|
|
|
173
|
+
/**
|
|
174
|
+
* Remove a cached media item asychronously
|
|
175
|
+
*
|
|
176
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
177
|
+
*/
|
|
178
|
+
deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
179
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
180
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
181
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
|
|
182
|
+
}
|
|
183
|
+
|
|
184
|
+
return this.apiClient.callApi(
|
|
185
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
186
|
+
'DELETE',
|
|
187
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
188
|
+
{ },
|
|
189
|
+
{ },
|
|
190
|
+
{ },
|
|
191
|
+
null,
|
|
192
|
+
['PureCloud OAuth'],
|
|
193
|
+
['application/json'],
|
|
194
|
+
['application/json']
|
|
195
|
+
);
|
|
196
|
+
}
|
|
197
|
+
|
|
173
198
|
/**
|
|
174
199
|
* Delete a Facebook messaging integration
|
|
175
200
|
*
|
|
@@ -1971,7 +1996,7 @@ class ConversationsApi {
|
|
|
1971
1996
|
/**
|
|
1972
1997
|
* Get list of wrapup codes for this conversation participant
|
|
1973
1998
|
*
|
|
1974
|
-
* @param {String} conversationId
|
|
1999
|
+
* @param {String} conversationId conversationId
|
|
1975
2000
|
* @param {String} participantId participantId
|
|
1976
2001
|
*/
|
|
1977
2002
|
getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
|
|
@@ -2018,6 +2043,57 @@ class ConversationsApi {
|
|
|
2018
2043
|
);
|
|
2019
2044
|
}
|
|
2020
2045
|
|
|
2046
|
+
/**
|
|
2047
|
+
* Get a list of cached media items
|
|
2048
|
+
*
|
|
2049
|
+
* @param {Object} opts Optional parameters
|
|
2050
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
2051
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
2052
|
+
* @param {String} opts.url URL to search for
|
|
2053
|
+
*/
|
|
2054
|
+
getConversationsMessagesCachedmedia(opts) {
|
|
2055
|
+
opts = opts || {};
|
|
2056
|
+
|
|
2057
|
+
|
|
2058
|
+
return this.apiClient.callApi(
|
|
2059
|
+
'/api/v2/conversations/messages/cachedmedia',
|
|
2060
|
+
'GET',
|
|
2061
|
+
{ },
|
|
2062
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
|
|
2063
|
+
{ },
|
|
2064
|
+
{ },
|
|
2065
|
+
null,
|
|
2066
|
+
['PureCloud OAuth'],
|
|
2067
|
+
['application/json'],
|
|
2068
|
+
['application/json']
|
|
2069
|
+
);
|
|
2070
|
+
}
|
|
2071
|
+
|
|
2072
|
+
/**
|
|
2073
|
+
* Get a cached media item
|
|
2074
|
+
*
|
|
2075
|
+
* @param {String} cachedMediaItemId cachedMediaItemId
|
|
2076
|
+
*/
|
|
2077
|
+
getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
|
|
2078
|
+
// verify the required parameter 'cachedMediaItemId' is set
|
|
2079
|
+
if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
|
|
2080
|
+
throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
|
|
2081
|
+
}
|
|
2082
|
+
|
|
2083
|
+
return this.apiClient.callApi(
|
|
2084
|
+
'/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
|
|
2085
|
+
'GET',
|
|
2086
|
+
{ 'cachedMediaItemId': cachedMediaItemId },
|
|
2087
|
+
{ },
|
|
2088
|
+
{ },
|
|
2089
|
+
{ },
|
|
2090
|
+
null,
|
|
2091
|
+
['PureCloud OAuth'],
|
|
2092
|
+
['application/json'],
|
|
2093
|
+
['application/json']
|
|
2094
|
+
);
|
|
2095
|
+
}
|
|
2096
|
+
|
|
2021
2097
|
/**
|
|
2022
2098
|
* Get Genesys Facebook App Id
|
|
2023
2099
|
*
|
|
@@ -2761,6 +2837,32 @@ class ConversationsApi {
|
|
|
2761
2837
|
);
|
|
2762
2838
|
}
|
|
2763
2839
|
|
|
2840
|
+
/**
|
|
2841
|
+
* Gets a record for a given meetingId
|
|
2842
|
+
*
|
|
2843
|
+
* @param {String} meetingId meetingId
|
|
2844
|
+
* getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2845
|
+
*/
|
|
2846
|
+
getConversationsVideosMeeting(meetingId) {
|
|
2847
|
+
// verify the required parameter 'meetingId' is set
|
|
2848
|
+
if (meetingId === undefined || meetingId === null) {
|
|
2849
|
+
throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
|
|
2850
|
+
}
|
|
2851
|
+
|
|
2852
|
+
return this.apiClient.callApi(
|
|
2853
|
+
'/api/v2/conversations/videos/meetings/{meetingId}',
|
|
2854
|
+
'GET',
|
|
2855
|
+
{ 'meetingId': meetingId },
|
|
2856
|
+
{ },
|
|
2857
|
+
{ },
|
|
2858
|
+
{ },
|
|
2859
|
+
null,
|
|
2860
|
+
['PureCloud OAuth'],
|
|
2861
|
+
['application/json'],
|
|
2862
|
+
['application/json']
|
|
2863
|
+
);
|
|
2864
|
+
}
|
|
2865
|
+
|
|
2764
2866
|
/**
|
|
2765
2867
|
* Update a participant.
|
|
2766
2868
|
* Update conversation participant.
|
|
@@ -3723,7 +3825,7 @@ class ConversationsApi {
|
|
|
3723
3825
|
/**
|
|
3724
3826
|
* Update conversation participant
|
|
3725
3827
|
*
|
|
3726
|
-
* @param {String} conversationId
|
|
3828
|
+
* @param {String} conversationId conversationId
|
|
3727
3829
|
* @param {String} participantId participantId
|
|
3728
3830
|
* @param {Object} opts Optional parameters
|
|
3729
3831
|
* @param {Object} opts.body
|
|
@@ -3757,7 +3859,7 @@ class ConversationsApi {
|
|
|
3757
3859
|
/**
|
|
3758
3860
|
* Update the attributes on a conversation participant.
|
|
3759
3861
|
*
|
|
3760
|
-
* @param {String} conversationId
|
|
3862
|
+
* @param {String} conversationId conversationId
|
|
3761
3863
|
* @param {String} participantId participantId
|
|
3762
3864
|
* @param {Object} opts Optional parameters
|
|
3763
3865
|
* @param {Object} opts.body
|
|
@@ -3791,7 +3893,7 @@ class ConversationsApi {
|
|
|
3791
3893
|
/**
|
|
3792
3894
|
* Update conversation participant's communication by disconnecting it.
|
|
3793
3895
|
*
|
|
3794
|
-
* @param {String} conversationId
|
|
3896
|
+
* @param {String} conversationId conversationId
|
|
3795
3897
|
* @param {String} participantId participantId
|
|
3796
3898
|
* @param {String} communicationId communicationId
|
|
3797
3899
|
* @param {Object} body Participant
|
|
@@ -5748,6 +5850,96 @@ class ConversationsApi {
|
|
|
5748
5850
|
);
|
|
5749
5851
|
}
|
|
5750
5852
|
|
|
5853
|
+
/**
|
|
5854
|
+
* Send an inbound Open Event Message
|
|
5855
|
+
* Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5856
|
+
* @param {String} integrationId integrationId
|
|
5857
|
+
* @param {Object} body NormalizedMessage
|
|
5858
|
+
*/
|
|
5859
|
+
postConversationsMessageInboundOpenEvent(integrationId, body) {
|
|
5860
|
+
// verify the required parameter 'integrationId' is set
|
|
5861
|
+
if (integrationId === undefined || integrationId === null) {
|
|
5862
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
|
|
5863
|
+
}
|
|
5864
|
+
// verify the required parameter 'body' is set
|
|
5865
|
+
if (body === undefined || body === null) {
|
|
5866
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
|
|
5867
|
+
}
|
|
5868
|
+
|
|
5869
|
+
return this.apiClient.callApi(
|
|
5870
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/event',
|
|
5871
|
+
'POST',
|
|
5872
|
+
{ 'integrationId': integrationId },
|
|
5873
|
+
{ },
|
|
5874
|
+
{ },
|
|
5875
|
+
{ },
|
|
5876
|
+
body,
|
|
5877
|
+
['PureCloud OAuth'],
|
|
5878
|
+
['application/json'],
|
|
5879
|
+
['application/json']
|
|
5880
|
+
);
|
|
5881
|
+
}
|
|
5882
|
+
|
|
5883
|
+
/**
|
|
5884
|
+
* Send inbound Open Message
|
|
5885
|
+
* Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5886
|
+
* @param {String} integrationId integrationId
|
|
5887
|
+
* @param {Object} body NormalizedMessage
|
|
5888
|
+
*/
|
|
5889
|
+
postConversationsMessageInboundOpenMessage(integrationId, body) {
|
|
5890
|
+
// verify the required parameter 'integrationId' is set
|
|
5891
|
+
if (integrationId === undefined || integrationId === null) {
|
|
5892
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
|
|
5893
|
+
}
|
|
5894
|
+
// verify the required parameter 'body' is set
|
|
5895
|
+
if (body === undefined || body === null) {
|
|
5896
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
|
|
5897
|
+
}
|
|
5898
|
+
|
|
5899
|
+
return this.apiClient.callApi(
|
|
5900
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/message',
|
|
5901
|
+
'POST',
|
|
5902
|
+
{ 'integrationId': integrationId },
|
|
5903
|
+
{ },
|
|
5904
|
+
{ },
|
|
5905
|
+
{ },
|
|
5906
|
+
body,
|
|
5907
|
+
['PureCloud OAuth'],
|
|
5908
|
+
['application/json'],
|
|
5909
|
+
['application/json']
|
|
5910
|
+
);
|
|
5911
|
+
}
|
|
5912
|
+
|
|
5913
|
+
/**
|
|
5914
|
+
* Send an inbound Open Receipt Message
|
|
5915
|
+
* Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
|
|
5916
|
+
* @param {String} integrationId integrationId
|
|
5917
|
+
* @param {Object} body NormalizedMessage
|
|
5918
|
+
*/
|
|
5919
|
+
postConversationsMessageInboundOpenReceipt(integrationId, body) {
|
|
5920
|
+
// verify the required parameter 'integrationId' is set
|
|
5921
|
+
if (integrationId === undefined || integrationId === null) {
|
|
5922
|
+
throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
|
|
5923
|
+
}
|
|
5924
|
+
// verify the required parameter 'body' is set
|
|
5925
|
+
if (body === undefined || body === null) {
|
|
5926
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
|
|
5927
|
+
}
|
|
5928
|
+
|
|
5929
|
+
return this.apiClient.callApi(
|
|
5930
|
+
'/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
|
|
5931
|
+
'POST',
|
|
5932
|
+
{ 'integrationId': integrationId },
|
|
5933
|
+
{ },
|
|
5934
|
+
{ },
|
|
5935
|
+
{ },
|
|
5936
|
+
body,
|
|
5937
|
+
['PureCloud OAuth'],
|
|
5938
|
+
['application/json'],
|
|
5939
|
+
['application/json']
|
|
5940
|
+
);
|
|
5941
|
+
}
|
|
5942
|
+
|
|
5751
5943
|
/**
|
|
5752
5944
|
* Get messages in batch
|
|
5753
5945
|
* The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
|
|
@@ -6300,6 +6492,32 @@ class ConversationsApi {
|
|
|
6300
6492
|
);
|
|
6301
6493
|
}
|
|
6302
6494
|
|
|
6495
|
+
/**
|
|
6496
|
+
* Generate a meetingId for a given conferenceId
|
|
6497
|
+
*
|
|
6498
|
+
* @param {Object} body MeetingIdRequest
|
|
6499
|
+
* postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6500
|
+
*/
|
|
6501
|
+
postConversationsVideosMeetings(body) {
|
|
6502
|
+
// verify the required parameter 'body' is set
|
|
6503
|
+
if (body === undefined || body === null) {
|
|
6504
|
+
throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
|
|
6505
|
+
}
|
|
6506
|
+
|
|
6507
|
+
return this.apiClient.callApi(
|
|
6508
|
+
'/api/v2/conversations/videos/meetings',
|
|
6509
|
+
'POST',
|
|
6510
|
+
{ },
|
|
6511
|
+
{ },
|
|
6512
|
+
{ },
|
|
6513
|
+
{ },
|
|
6514
|
+
body,
|
|
6515
|
+
['PureCloud OAuth'],
|
|
6516
|
+
['application/json'],
|
|
6517
|
+
['application/json']
|
|
6518
|
+
);
|
|
6519
|
+
}
|
|
6520
|
+
|
|
6303
6521
|
/**
|
|
6304
6522
|
* Set flagged reason on conversation participant to indicate bad conversation quality.
|
|
6305
6523
|
*
|
|
@@ -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 174.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -205,6 +205,37 @@ class JourneyApi {
|
|
|
205
205
|
);
|
|
206
206
|
}
|
|
207
207
|
|
|
208
|
+
/**
|
|
209
|
+
* Retrieve all sessions for a given external contact.
|
|
210
|
+
*
|
|
211
|
+
* @param {String} contactId ExternalContact ID
|
|
212
|
+
* @param {Object} opts Optional parameters
|
|
213
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
214
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
215
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
216
|
+
*/
|
|
217
|
+
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
218
|
+
opts = opts || {};
|
|
219
|
+
|
|
220
|
+
// verify the required parameter 'contactId' is set
|
|
221
|
+
if (contactId === undefined || contactId === null) {
|
|
222
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
|
|
223
|
+
}
|
|
224
|
+
|
|
225
|
+
return this.apiClient.callApi(
|
|
226
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
|
|
227
|
+
'GET',
|
|
228
|
+
{ 'contactId': contactId },
|
|
229
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
|
|
230
|
+
{ },
|
|
231
|
+
{ },
|
|
232
|
+
null,
|
|
233
|
+
['PureCloud OAuth'],
|
|
234
|
+
['application/json'],
|
|
235
|
+
['application/json']
|
|
236
|
+
);
|
|
237
|
+
}
|
|
238
|
+
|
|
208
239
|
/**
|
|
209
240
|
* Retrieve a single action map.
|
|
210
241
|
*
|
|
@@ -1005,6 +1036,36 @@ class JourneyApi {
|
|
|
1005
1036
|
);
|
|
1006
1037
|
}
|
|
1007
1038
|
|
|
1039
|
+
/**
|
|
1040
|
+
* Send a journey app event, used for tracking customer activity on an application.
|
|
1041
|
+
*
|
|
1042
|
+
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
1043
|
+
* @param {Object} opts Optional parameters
|
|
1044
|
+
* @param {Object} opts.body
|
|
1045
|
+
* postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1046
|
+
*/
|
|
1047
|
+
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
1048
|
+
opts = opts || {};
|
|
1049
|
+
|
|
1050
|
+
// verify the required parameter 'deploymentId' is set
|
|
1051
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
1052
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
|
|
1053
|
+
}
|
|
1054
|
+
|
|
1055
|
+
return this.apiClient.callApi(
|
|
1056
|
+
'/api/v2/journey/deployments/{deploymentId}/appevents',
|
|
1057
|
+
'POST',
|
|
1058
|
+
{ 'deploymentId': deploymentId },
|
|
1059
|
+
{ },
|
|
1060
|
+
{ },
|
|
1061
|
+
{ },
|
|
1062
|
+
opts['body'],
|
|
1063
|
+
['PureCloud OAuth'],
|
|
1064
|
+
['application/json'],
|
|
1065
|
+
['application/json']
|
|
1066
|
+
);
|
|
1067
|
+
}
|
|
1068
|
+
|
|
1008
1069
|
/**
|
|
1009
1070
|
* Create an outcome.
|
|
1010
1071
|
*
|