purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- 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 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,9 +24,13 @@ class JourneyApi {
|
|
|
24
24
|
* Delete/cancel an async request for journey aggregates
|
|
25
25
|
*
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
30
|
*/
|
|
29
|
-
deleteAnalyticsJourneysAggregatesJob(jobId) {
|
|
31
|
+
deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
32
|
+
opts = opts || {};
|
|
33
|
+
|
|
30
34
|
// verify the required parameter 'jobId' is set
|
|
31
35
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
32
36
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';
|
|
@@ -42,7 +46,8 @@ class JourneyApi {
|
|
|
42
46
|
null,
|
|
43
47
|
['PureCloud OAuth'],
|
|
44
48
|
['application/json'],
|
|
45
|
-
['application/json']
|
|
49
|
+
['application/json'],
|
|
50
|
+
opts['customHeaders']
|
|
46
51
|
);
|
|
47
52
|
}
|
|
48
53
|
|
|
@@ -50,8 +55,12 @@ class JourneyApi {
|
|
|
50
55
|
* Delete single action map.
|
|
51
56
|
*
|
|
52
57
|
* @param {String} actionMapId ID of the action map.
|
|
58
|
+
* @param {Object} opts Optional parameters
|
|
59
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
60
|
*/
|
|
54
|
-
deleteJourneyActionmap(actionMapId) {
|
|
61
|
+
deleteJourneyActionmap(actionMapId, opts) {
|
|
62
|
+
opts = opts || {};
|
|
63
|
+
|
|
55
64
|
// verify the required parameter 'actionMapId' is set
|
|
56
65
|
if (actionMapId === undefined || actionMapId === null || actionMapId === '') {
|
|
57
66
|
throw 'Missing the required parameter "actionMapId" when calling deleteJourneyActionmap';
|
|
@@ -67,7 +76,8 @@ class JourneyApi {
|
|
|
67
76
|
null,
|
|
68
77
|
['PureCloud OAuth'],
|
|
69
78
|
['application/json'],
|
|
70
|
-
['application/json']
|
|
79
|
+
['application/json'],
|
|
80
|
+
opts['customHeaders']
|
|
71
81
|
);
|
|
72
82
|
}
|
|
73
83
|
|
|
@@ -77,6 +87,7 @@ class JourneyApi {
|
|
|
77
87
|
* @param {String} actionTemplateId ID of the action template.
|
|
78
88
|
* @param {Object} opts Optional parameters
|
|
79
89
|
* @param {Boolean} opts.hardDelete Determines whether Action Template should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default.
|
|
90
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
80
91
|
*/
|
|
81
92
|
deleteJourneyActiontemplate(actionTemplateId, opts) {
|
|
82
93
|
opts = opts || {};
|
|
@@ -96,7 +107,68 @@ class JourneyApi {
|
|
|
96
107
|
null,
|
|
97
108
|
['PureCloud OAuth'],
|
|
98
109
|
['application/json'],
|
|
99
|
-
['application/json']
|
|
110
|
+
['application/json'],
|
|
111
|
+
opts['customHeaders']
|
|
112
|
+
);
|
|
113
|
+
}
|
|
114
|
+
|
|
115
|
+
/**
|
|
116
|
+
* Delete an external events configuration.
|
|
117
|
+
*
|
|
118
|
+
* @param {String} configId The ID of the external event configuration.
|
|
119
|
+
* @param {Object} opts Optional parameters
|
|
120
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
121
|
+
*/
|
|
122
|
+
deleteJourneyExternaleventsConfiguration(configId, opts) {
|
|
123
|
+
opts = opts || {};
|
|
124
|
+
|
|
125
|
+
// verify the required parameter 'configId' is set
|
|
126
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
127
|
+
throw 'Missing the required parameter "configId" when calling deleteJourneyExternaleventsConfiguration';
|
|
128
|
+
}
|
|
129
|
+
|
|
130
|
+
return this.apiClient.callApi(
|
|
131
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
132
|
+
'DELETE',
|
|
133
|
+
{ 'configId': configId },
|
|
134
|
+
{ },
|
|
135
|
+
{ },
|
|
136
|
+
{ },
|
|
137
|
+
null,
|
|
138
|
+
['PureCloud OAuth'],
|
|
139
|
+
['application/json'],
|
|
140
|
+
['application/json'],
|
|
141
|
+
opts['customHeaders']
|
|
142
|
+
);
|
|
143
|
+
}
|
|
144
|
+
|
|
145
|
+
/**
|
|
146
|
+
* Delete a schema
|
|
147
|
+
*
|
|
148
|
+
* @param {String} schemaId Schema ID
|
|
149
|
+
* @param {Object} opts Optional parameters
|
|
150
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
151
|
+
*/
|
|
152
|
+
deleteJourneyExternaleventsSchema(schemaId, opts) {
|
|
153
|
+
opts = opts || {};
|
|
154
|
+
|
|
155
|
+
// verify the required parameter 'schemaId' is set
|
|
156
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
157
|
+
throw 'Missing the required parameter "schemaId" when calling deleteJourneyExternaleventsSchema';
|
|
158
|
+
}
|
|
159
|
+
|
|
160
|
+
return this.apiClient.callApi(
|
|
161
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
162
|
+
'DELETE',
|
|
163
|
+
{ 'schemaId': schemaId },
|
|
164
|
+
{ },
|
|
165
|
+
{ },
|
|
166
|
+
{ },
|
|
167
|
+
null,
|
|
168
|
+
['PureCloud OAuth'],
|
|
169
|
+
['application/json'],
|
|
170
|
+
['application/json'],
|
|
171
|
+
opts['customHeaders']
|
|
100
172
|
);
|
|
101
173
|
}
|
|
102
174
|
|
|
@@ -104,8 +176,12 @@ class JourneyApi {
|
|
|
104
176
|
* Delete an outcome.
|
|
105
177
|
*
|
|
106
178
|
* @param {String} outcomeId ID of the outcome.
|
|
179
|
+
* @param {Object} opts Optional parameters
|
|
180
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107
181
|
*/
|
|
108
|
-
deleteJourneyOutcome(outcomeId) {
|
|
182
|
+
deleteJourneyOutcome(outcomeId, opts) {
|
|
183
|
+
opts = opts || {};
|
|
184
|
+
|
|
109
185
|
// verify the required parameter 'outcomeId' is set
|
|
110
186
|
if (outcomeId === undefined || outcomeId === null || outcomeId === '') {
|
|
111
187
|
throw 'Missing the required parameter "outcomeId" when calling deleteJourneyOutcome';
|
|
@@ -121,7 +197,8 @@ class JourneyApi {
|
|
|
121
197
|
null,
|
|
122
198
|
['PureCloud OAuth'],
|
|
123
199
|
['application/json'],
|
|
124
|
-
['application/json']
|
|
200
|
+
['application/json'],
|
|
201
|
+
opts['customHeaders']
|
|
125
202
|
);
|
|
126
203
|
}
|
|
127
204
|
|
|
@@ -129,8 +206,12 @@ class JourneyApi {
|
|
|
129
206
|
* Delete an outcome predictor.
|
|
130
207
|
*
|
|
131
208
|
* @param {String} predictorId ID of predictor
|
|
209
|
+
* @param {Object} opts Optional parameters
|
|
210
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
132
211
|
*/
|
|
133
|
-
deleteJourneyOutcomesPredictor(predictorId) {
|
|
212
|
+
deleteJourneyOutcomesPredictor(predictorId, opts) {
|
|
213
|
+
opts = opts || {};
|
|
214
|
+
|
|
134
215
|
// verify the required parameter 'predictorId' is set
|
|
135
216
|
if (predictorId === undefined || predictorId === null || predictorId === '') {
|
|
136
217
|
throw 'Missing the required parameter "predictorId" when calling deleteJourneyOutcomesPredictor';
|
|
@@ -146,7 +227,8 @@ class JourneyApi {
|
|
|
146
227
|
null,
|
|
147
228
|
['PureCloud OAuth'],
|
|
148
229
|
['application/json'],
|
|
149
|
-
['application/json']
|
|
230
|
+
['application/json'],
|
|
231
|
+
opts['customHeaders']
|
|
150
232
|
);
|
|
151
233
|
}
|
|
152
234
|
|
|
@@ -154,8 +236,12 @@ class JourneyApi {
|
|
|
154
236
|
* Delete a segment.
|
|
155
237
|
*
|
|
156
238
|
* @param {String} segmentId ID of the segment.
|
|
239
|
+
* @param {Object} opts Optional parameters
|
|
240
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
157
241
|
*/
|
|
158
|
-
deleteJourneySegment(segmentId) {
|
|
242
|
+
deleteJourneySegment(segmentId, opts) {
|
|
243
|
+
opts = opts || {};
|
|
244
|
+
|
|
159
245
|
// verify the required parameter 'segmentId' is set
|
|
160
246
|
if (segmentId === undefined || segmentId === null || segmentId === '') {
|
|
161
247
|
throw 'Missing the required parameter "segmentId" when calling deleteJourneySegment';
|
|
@@ -171,7 +257,8 @@ class JourneyApi {
|
|
|
171
257
|
null,
|
|
172
258
|
['PureCloud OAuth'],
|
|
173
259
|
['application/json'],
|
|
174
|
-
['application/json']
|
|
260
|
+
['application/json'],
|
|
261
|
+
opts['customHeaders']
|
|
175
262
|
);
|
|
176
263
|
}
|
|
177
264
|
|
|
@@ -179,8 +266,12 @@ class JourneyApi {
|
|
|
179
266
|
* Delete a Journey View by ID
|
|
180
267
|
* deletes all versions
|
|
181
268
|
* @param {String} viewId viewId
|
|
269
|
+
* @param {Object} opts Optional parameters
|
|
270
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
182
271
|
*/
|
|
183
|
-
deleteJourneyView(viewId) {
|
|
272
|
+
deleteJourneyView(viewId, opts) {
|
|
273
|
+
opts = opts || {};
|
|
274
|
+
|
|
184
275
|
// verify the required parameter 'viewId' is set
|
|
185
276
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
186
277
|
throw 'Missing the required parameter "viewId" when calling deleteJourneyView';
|
|
@@ -196,7 +287,8 @@ class JourneyApi {
|
|
|
196
287
|
null,
|
|
197
288
|
['PureCloud OAuth'],
|
|
198
289
|
['application/json'],
|
|
199
|
-
['application/json']
|
|
290
|
+
['application/json'],
|
|
291
|
+
opts['customHeaders']
|
|
200
292
|
);
|
|
201
293
|
}
|
|
202
294
|
|
|
@@ -204,8 +296,12 @@ class JourneyApi {
|
|
|
204
296
|
* Delete the Schedule of a JourneyView
|
|
205
297
|
*
|
|
206
298
|
* @param {String} viewId Journey View Id
|
|
299
|
+
* @param {Object} opts Optional parameters
|
|
300
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
207
301
|
*/
|
|
208
|
-
deleteJourneyViewSchedules(viewId) {
|
|
302
|
+
deleteJourneyViewSchedules(viewId, opts) {
|
|
303
|
+
opts = opts || {};
|
|
304
|
+
|
|
209
305
|
// verify the required parameter 'viewId' is set
|
|
210
306
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
211
307
|
throw 'Missing the required parameter "viewId" when calling deleteJourneyViewSchedules';
|
|
@@ -221,7 +317,8 @@ class JourneyApi {
|
|
|
221
317
|
null,
|
|
222
318
|
['PureCloud OAuth'],
|
|
223
319
|
['application/json'],
|
|
224
|
-
['application/json']
|
|
320
|
+
['application/json'],
|
|
321
|
+
opts['customHeaders']
|
|
225
322
|
);
|
|
226
323
|
}
|
|
227
324
|
|
|
@@ -229,9 +326,13 @@ class JourneyApi {
|
|
|
229
326
|
* Get status for async query for journey aggregates
|
|
230
327
|
*
|
|
231
328
|
* @param {String} jobId jobId
|
|
329
|
+
* @param {Object} opts Optional parameters
|
|
330
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
232
331
|
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
233
332
|
*/
|
|
234
|
-
getAnalyticsJourneysAggregatesJob(jobId) {
|
|
333
|
+
getAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
334
|
+
opts = opts || {};
|
|
335
|
+
|
|
235
336
|
// verify the required parameter 'jobId' is set
|
|
236
337
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
237
338
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';
|
|
@@ -247,7 +348,8 @@ class JourneyApi {
|
|
|
247
348
|
null,
|
|
248
349
|
['PureCloud OAuth'],
|
|
249
350
|
['application/json'],
|
|
250
|
-
['application/json']
|
|
351
|
+
['application/json'],
|
|
352
|
+
opts['customHeaders']
|
|
251
353
|
);
|
|
252
354
|
}
|
|
253
355
|
|
|
@@ -257,6 +359,7 @@ class JourneyApi {
|
|
|
257
359
|
* @param {String} jobId jobId
|
|
258
360
|
* @param {Object} opts Optional parameters
|
|
259
361
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
362
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
260
363
|
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
261
364
|
*/
|
|
262
365
|
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
@@ -277,7 +380,8 @@ class JourneyApi {
|
|
|
277
380
|
null,
|
|
278
381
|
['PureCloud OAuth'],
|
|
279
382
|
['application/json'],
|
|
280
|
-
['application/json']
|
|
383
|
+
['application/json'],
|
|
384
|
+
opts['customHeaders']
|
|
281
385
|
);
|
|
282
386
|
}
|
|
283
387
|
|
|
@@ -288,6 +392,7 @@ class JourneyApi {
|
|
|
288
392
|
* @param {Object} opts Optional parameters
|
|
289
393
|
* @param {Boolean} opts.includeMerged Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
|
|
290
394
|
* @param {Number} opts.limit Number of entities to return. Default of 25, maximum of 500.
|
|
395
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
291
396
|
*/
|
|
292
397
|
getExternalcontactsContactJourneySegments(contactId, opts) {
|
|
293
398
|
opts = opts || {};
|
|
@@ -307,7 +412,8 @@ class JourneyApi {
|
|
|
307
412
|
null,
|
|
308
413
|
['PureCloud OAuth'],
|
|
309
414
|
['application/json'],
|
|
310
|
-
['application/json']
|
|
415
|
+
['application/json'],
|
|
416
|
+
opts['customHeaders']
|
|
311
417
|
);
|
|
312
418
|
}
|
|
313
419
|
|
|
@@ -319,6 +425,7 @@ class JourneyApi {
|
|
|
319
425
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
320
426
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
321
427
|
* @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
|
|
428
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
322
429
|
*/
|
|
323
430
|
getExternalcontactsContactJourneySessions(contactId, opts) {
|
|
324
431
|
opts = opts || {};
|
|
@@ -338,7 +445,8 @@ class JourneyApi {
|
|
|
338
445
|
null,
|
|
339
446
|
['PureCloud OAuth'],
|
|
340
447
|
['application/json'],
|
|
341
|
-
['application/json']
|
|
448
|
+
['application/json'],
|
|
449
|
+
opts['customHeaders']
|
|
342
450
|
);
|
|
343
451
|
}
|
|
344
452
|
|
|
@@ -346,8 +454,12 @@ class JourneyApi {
|
|
|
346
454
|
* Retrieve a single action map.
|
|
347
455
|
*
|
|
348
456
|
* @param {String} actionMapId ID of the action map.
|
|
457
|
+
* @param {Object} opts Optional parameters
|
|
458
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
349
459
|
*/
|
|
350
|
-
getJourneyActionmap(actionMapId) {
|
|
460
|
+
getJourneyActionmap(actionMapId, opts) {
|
|
461
|
+
opts = opts || {};
|
|
462
|
+
|
|
351
463
|
// verify the required parameter 'actionMapId' is set
|
|
352
464
|
if (actionMapId === undefined || actionMapId === null || actionMapId === '') {
|
|
353
465
|
throw 'Missing the required parameter "actionMapId" when calling getJourneyActionmap';
|
|
@@ -363,7 +475,8 @@ class JourneyApi {
|
|
|
363
475
|
null,
|
|
364
476
|
['PureCloud OAuth'],
|
|
365
477
|
['application/json'],
|
|
366
|
-
['application/json']
|
|
478
|
+
['application/json'],
|
|
479
|
+
opts['customHeaders']
|
|
367
480
|
);
|
|
368
481
|
}
|
|
369
482
|
|
|
@@ -379,6 +492,7 @@ class JourneyApi {
|
|
|
379
492
|
* @param {Array.<String>} opts.actionMapIds IDs of action maps to return. Use of this parameter is not compatible with pagination, filtering, sorting or querying. A maximum of 100 action maps are allowed per request.
|
|
380
493
|
* @param {Array.<String>} opts.queryFields Action Map field(s) to query on. Requires 'queryValue' to also be set.
|
|
381
494
|
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
495
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
382
496
|
*/
|
|
383
497
|
getJourneyActionmaps(opts) {
|
|
384
498
|
opts = opts || {};
|
|
@@ -394,7 +508,8 @@ class JourneyApi {
|
|
|
394
508
|
null,
|
|
395
509
|
['PureCloud OAuth'],
|
|
396
510
|
['application/json'],
|
|
397
|
-
['application/json']
|
|
511
|
+
['application/json'],
|
|
512
|
+
opts['customHeaders']
|
|
398
513
|
);
|
|
399
514
|
}
|
|
400
515
|
|
|
@@ -402,8 +517,12 @@ class JourneyApi {
|
|
|
402
517
|
* Get status of job.
|
|
403
518
|
*
|
|
404
519
|
* @param {String} jobId ID of the job.
|
|
520
|
+
* @param {Object} opts Optional parameters
|
|
521
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
405
522
|
*/
|
|
406
|
-
getJourneyActionmapsEstimatesJob(jobId) {
|
|
523
|
+
getJourneyActionmapsEstimatesJob(jobId, opts) {
|
|
524
|
+
opts = opts || {};
|
|
525
|
+
|
|
407
526
|
// verify the required parameter 'jobId' is set
|
|
408
527
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
409
528
|
throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJob';
|
|
@@ -419,7 +538,8 @@ class JourneyApi {
|
|
|
419
538
|
null,
|
|
420
539
|
['PureCloud OAuth'],
|
|
421
540
|
['application/json'],
|
|
422
|
-
['application/json']
|
|
541
|
+
['application/json'],
|
|
542
|
+
opts['customHeaders']
|
|
423
543
|
);
|
|
424
544
|
}
|
|
425
545
|
|
|
@@ -427,8 +547,12 @@ class JourneyApi {
|
|
|
427
547
|
* Get estimates from completed job.
|
|
428
548
|
*
|
|
429
549
|
* @param {String} jobId ID of the job.
|
|
550
|
+
* @param {Object} opts Optional parameters
|
|
551
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
430
552
|
*/
|
|
431
|
-
getJourneyActionmapsEstimatesJobResults(jobId) {
|
|
553
|
+
getJourneyActionmapsEstimatesJobResults(jobId, opts) {
|
|
554
|
+
opts = opts || {};
|
|
555
|
+
|
|
432
556
|
// verify the required parameter 'jobId' is set
|
|
433
557
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
434
558
|
throw 'Missing the required parameter "jobId" when calling getJourneyActionmapsEstimatesJobResults';
|
|
@@ -444,7 +568,8 @@ class JourneyApi {
|
|
|
444
568
|
null,
|
|
445
569
|
['PureCloud OAuth'],
|
|
446
570
|
['application/json'],
|
|
447
|
-
['application/json']
|
|
571
|
+
['application/json'],
|
|
572
|
+
opts['customHeaders']
|
|
448
573
|
);
|
|
449
574
|
}
|
|
450
575
|
|
|
@@ -452,8 +577,12 @@ class JourneyApi {
|
|
|
452
577
|
* Retrieve a single action target.
|
|
453
578
|
*
|
|
454
579
|
* @param {String} actionTargetId ID of the action target.
|
|
580
|
+
* @param {Object} opts Optional parameters
|
|
581
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
455
582
|
*/
|
|
456
|
-
getJourneyActiontarget(actionTargetId) {
|
|
583
|
+
getJourneyActiontarget(actionTargetId, opts) {
|
|
584
|
+
opts = opts || {};
|
|
585
|
+
|
|
457
586
|
// verify the required parameter 'actionTargetId' is set
|
|
458
587
|
if (actionTargetId === undefined || actionTargetId === null || actionTargetId === '') {
|
|
459
588
|
throw 'Missing the required parameter "actionTargetId" when calling getJourneyActiontarget';
|
|
@@ -469,7 +598,8 @@ class JourneyApi {
|
|
|
469
598
|
null,
|
|
470
599
|
['PureCloud OAuth'],
|
|
471
600
|
['application/json'],
|
|
472
|
-
['application/json']
|
|
601
|
+
['application/json'],
|
|
602
|
+
opts['customHeaders']
|
|
473
603
|
);
|
|
474
604
|
}
|
|
475
605
|
|
|
@@ -479,6 +609,7 @@ class JourneyApi {
|
|
|
479
609
|
* @param {Object} opts Optional parameters
|
|
480
610
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
481
611
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
612
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
482
613
|
*/
|
|
483
614
|
getJourneyActiontargets(opts) {
|
|
484
615
|
opts = opts || {};
|
|
@@ -494,7 +625,8 @@ class JourneyApi {
|
|
|
494
625
|
null,
|
|
495
626
|
['PureCloud OAuth'],
|
|
496
627
|
['application/json'],
|
|
497
|
-
['application/json']
|
|
628
|
+
['application/json'],
|
|
629
|
+
opts['customHeaders']
|
|
498
630
|
);
|
|
499
631
|
}
|
|
500
632
|
|
|
@@ -502,8 +634,12 @@ class JourneyApi {
|
|
|
502
634
|
* Retrieve a single action template.
|
|
503
635
|
*
|
|
504
636
|
* @param {String} actionTemplateId ID of the action template.
|
|
637
|
+
* @param {Object} opts Optional parameters
|
|
638
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
505
639
|
*/
|
|
506
|
-
getJourneyActiontemplate(actionTemplateId) {
|
|
640
|
+
getJourneyActiontemplate(actionTemplateId, opts) {
|
|
641
|
+
opts = opts || {};
|
|
642
|
+
|
|
507
643
|
// verify the required parameter 'actionTemplateId' is set
|
|
508
644
|
if (actionTemplateId === undefined || actionTemplateId === null || actionTemplateId === '') {
|
|
509
645
|
throw 'Missing the required parameter "actionTemplateId" when calling getJourneyActiontemplate';
|
|
@@ -519,7 +655,8 @@ class JourneyApi {
|
|
|
519
655
|
null,
|
|
520
656
|
['PureCloud OAuth'],
|
|
521
657
|
['application/json'],
|
|
522
|
-
['application/json']
|
|
658
|
+
['application/json'],
|
|
659
|
+
opts['customHeaders']
|
|
523
660
|
);
|
|
524
661
|
}
|
|
525
662
|
|
|
@@ -534,6 +671,7 @@ class JourneyApi {
|
|
|
534
671
|
* @param {Object} opts.state Action template state.
|
|
535
672
|
* @param {Array.<String>} opts.queryFields ActionTemplate field(s) to query on. Requires 'queryValue' to also be set.
|
|
536
673
|
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
674
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
537
675
|
*/
|
|
538
676
|
getJourneyActiontemplates(opts) {
|
|
539
677
|
opts = opts || {};
|
|
@@ -549,7 +687,8 @@ class JourneyApi {
|
|
|
549
687
|
null,
|
|
550
688
|
['PureCloud OAuth'],
|
|
551
689
|
['application/json'],
|
|
552
|
-
['application/json']
|
|
690
|
+
['application/json'],
|
|
691
|
+
opts['customHeaders']
|
|
553
692
|
);
|
|
554
693
|
}
|
|
555
694
|
|
|
@@ -564,6 +703,7 @@ class JourneyApi {
|
|
|
564
703
|
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
565
704
|
* @param {String} opts.sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
566
705
|
* @param {Number} opts.sinceLastBeaconMilliseconds How long (milliseconds) since the last app event or beacon was sent. The response may return a pollInternvalMilliseconds to reduce the frequency of pings.
|
|
706
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
567
707
|
*/
|
|
568
708
|
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, opts) {
|
|
569
709
|
opts = opts || {};
|
|
@@ -587,7 +727,265 @@ class JourneyApi {
|
|
|
587
727
|
null,
|
|
588
728
|
['PureCloud OAuth'],
|
|
589
729
|
['application/json'],
|
|
590
|
-
['application/json']
|
|
730
|
+
['application/json'],
|
|
731
|
+
opts['customHeaders']
|
|
732
|
+
);
|
|
733
|
+
}
|
|
734
|
+
|
|
735
|
+
/**
|
|
736
|
+
* Get an external events configuration
|
|
737
|
+
*
|
|
738
|
+
* @param {String} configId The ID of the external event configuration.
|
|
739
|
+
* @param {Object} opts Optional parameters
|
|
740
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
741
|
+
*/
|
|
742
|
+
getJourneyExternaleventsConfiguration(configId, opts) {
|
|
743
|
+
opts = opts || {};
|
|
744
|
+
|
|
745
|
+
// verify the required parameter 'configId' is set
|
|
746
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
747
|
+
throw 'Missing the required parameter "configId" when calling getJourneyExternaleventsConfiguration';
|
|
748
|
+
}
|
|
749
|
+
|
|
750
|
+
return this.apiClient.callApi(
|
|
751
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
752
|
+
'GET',
|
|
753
|
+
{ 'configId': configId },
|
|
754
|
+
{ },
|
|
755
|
+
{ },
|
|
756
|
+
{ },
|
|
757
|
+
null,
|
|
758
|
+
['PureCloud OAuth'],
|
|
759
|
+
['application/json'],
|
|
760
|
+
['application/json'],
|
|
761
|
+
opts['customHeaders']
|
|
762
|
+
);
|
|
763
|
+
}
|
|
764
|
+
|
|
765
|
+
/**
|
|
766
|
+
* Get all external event configurations.
|
|
767
|
+
*
|
|
768
|
+
* @param {Object} opts Optional parameters
|
|
769
|
+
* @param {Number} opts.pageSize Page size (default to 20)
|
|
770
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
771
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
772
|
+
*/
|
|
773
|
+
getJourneyExternaleventsConfigurations(opts) {
|
|
774
|
+
opts = opts || {};
|
|
775
|
+
|
|
776
|
+
|
|
777
|
+
return this.apiClient.callApi(
|
|
778
|
+
'/api/v2/journey/externalevents/configurations',
|
|
779
|
+
'GET',
|
|
780
|
+
{ },
|
|
781
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
782
|
+
{ },
|
|
783
|
+
{ },
|
|
784
|
+
null,
|
|
785
|
+
['PureCloud OAuth'],
|
|
786
|
+
['application/json'],
|
|
787
|
+
['application/json'],
|
|
788
|
+
opts['customHeaders']
|
|
789
|
+
);
|
|
790
|
+
}
|
|
791
|
+
|
|
792
|
+
/**
|
|
793
|
+
* Get a schema
|
|
794
|
+
*
|
|
795
|
+
* @param {String} schemaId Schema ID
|
|
796
|
+
* @param {Object} opts Optional parameters
|
|
797
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
798
|
+
*/
|
|
799
|
+
getJourneyExternaleventsSchema(schemaId, opts) {
|
|
800
|
+
opts = opts || {};
|
|
801
|
+
|
|
802
|
+
// verify the required parameter 'schemaId' is set
|
|
803
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
804
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchema';
|
|
805
|
+
}
|
|
806
|
+
|
|
807
|
+
return this.apiClient.callApi(
|
|
808
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
809
|
+
'GET',
|
|
810
|
+
{ 'schemaId': schemaId },
|
|
811
|
+
{ },
|
|
812
|
+
{ },
|
|
813
|
+
{ },
|
|
814
|
+
null,
|
|
815
|
+
['PureCloud OAuth'],
|
|
816
|
+
['application/json'],
|
|
817
|
+
['application/json'],
|
|
818
|
+
opts['customHeaders']
|
|
819
|
+
);
|
|
820
|
+
}
|
|
821
|
+
|
|
822
|
+
/**
|
|
823
|
+
* Get a specific version of a schema
|
|
824
|
+
*
|
|
825
|
+
* @param {String} schemaId Schema ID
|
|
826
|
+
* @param {String} versionId Schema version
|
|
827
|
+
* @param {Object} opts Optional parameters
|
|
828
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
829
|
+
*/
|
|
830
|
+
getJourneyExternaleventsSchemaVersion(schemaId, versionId, opts) {
|
|
831
|
+
opts = opts || {};
|
|
832
|
+
|
|
833
|
+
// verify the required parameter 'schemaId' is set
|
|
834
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
835
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchemaVersion';
|
|
836
|
+
}
|
|
837
|
+
// verify the required parameter 'versionId' is set
|
|
838
|
+
if (versionId === undefined || versionId === null || versionId === '') {
|
|
839
|
+
throw 'Missing the required parameter "versionId" when calling getJourneyExternaleventsSchemaVersion';
|
|
840
|
+
}
|
|
841
|
+
|
|
842
|
+
return this.apiClient.callApi(
|
|
843
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}/versions/{versionId}',
|
|
844
|
+
'GET',
|
|
845
|
+
{ 'schemaId': schemaId,'versionId': versionId },
|
|
846
|
+
{ },
|
|
847
|
+
{ },
|
|
848
|
+
{ },
|
|
849
|
+
null,
|
|
850
|
+
['PureCloud OAuth'],
|
|
851
|
+
['application/json'],
|
|
852
|
+
['application/json'],
|
|
853
|
+
opts['customHeaders']
|
|
854
|
+
);
|
|
855
|
+
}
|
|
856
|
+
|
|
857
|
+
/**
|
|
858
|
+
* Get all versions of a External Events schema
|
|
859
|
+
*
|
|
860
|
+
* @param {String} schemaId Schema ID
|
|
861
|
+
* @param {Object} opts Optional parameters
|
|
862
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
863
|
+
*/
|
|
864
|
+
getJourneyExternaleventsSchemaVersions(schemaId, opts) {
|
|
865
|
+
opts = opts || {};
|
|
866
|
+
|
|
867
|
+
// verify the required parameter 'schemaId' is set
|
|
868
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
869
|
+
throw 'Missing the required parameter "schemaId" when calling getJourneyExternaleventsSchemaVersions';
|
|
870
|
+
}
|
|
871
|
+
|
|
872
|
+
return this.apiClient.callApi(
|
|
873
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}/versions',
|
|
874
|
+
'GET',
|
|
875
|
+
{ 'schemaId': schemaId },
|
|
876
|
+
{ },
|
|
877
|
+
{ },
|
|
878
|
+
{ },
|
|
879
|
+
null,
|
|
880
|
+
['PureCloud OAuth'],
|
|
881
|
+
['application/json'],
|
|
882
|
+
['application/json'],
|
|
883
|
+
opts['customHeaders']
|
|
884
|
+
);
|
|
885
|
+
}
|
|
886
|
+
|
|
887
|
+
/**
|
|
888
|
+
* Get a list of schemas.
|
|
889
|
+
*
|
|
890
|
+
* @param {Object} opts Optional parameters
|
|
891
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
892
|
+
*/
|
|
893
|
+
getJourneyExternaleventsSchemas(opts) {
|
|
894
|
+
opts = opts || {};
|
|
895
|
+
|
|
896
|
+
|
|
897
|
+
return this.apiClient.callApi(
|
|
898
|
+
'/api/v2/journey/externalevents/schemas',
|
|
899
|
+
'GET',
|
|
900
|
+
{ },
|
|
901
|
+
{ },
|
|
902
|
+
{ },
|
|
903
|
+
{ },
|
|
904
|
+
null,
|
|
905
|
+
['PureCloud OAuth'],
|
|
906
|
+
['application/json'],
|
|
907
|
+
['application/json'],
|
|
908
|
+
opts['customHeaders']
|
|
909
|
+
);
|
|
910
|
+
}
|
|
911
|
+
|
|
912
|
+
/**
|
|
913
|
+
* Get a core type from which all schemas are built
|
|
914
|
+
*
|
|
915
|
+
* @param {String} coreTypeName Name of core type
|
|
916
|
+
* @param {Object} opts Optional parameters
|
|
917
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
918
|
+
*/
|
|
919
|
+
getJourneyExternaleventsSchemasCoretype(coreTypeName, opts) {
|
|
920
|
+
opts = opts || {};
|
|
921
|
+
|
|
922
|
+
// verify the required parameter 'coreTypeName' is set
|
|
923
|
+
if (coreTypeName === undefined || coreTypeName === null || coreTypeName === '') {
|
|
924
|
+
throw 'Missing the required parameter "coreTypeName" when calling getJourneyExternaleventsSchemasCoretype';
|
|
925
|
+
}
|
|
926
|
+
|
|
927
|
+
return this.apiClient.callApi(
|
|
928
|
+
'/api/v2/journey/externalevents/schemas/coretypes/{coreTypeName}',
|
|
929
|
+
'GET',
|
|
930
|
+
{ 'coreTypeName': coreTypeName },
|
|
931
|
+
{ },
|
|
932
|
+
{ },
|
|
933
|
+
{ },
|
|
934
|
+
null,
|
|
935
|
+
['PureCloud OAuth'],
|
|
936
|
+
['application/json'],
|
|
937
|
+
['application/json'],
|
|
938
|
+
opts['customHeaders']
|
|
939
|
+
);
|
|
940
|
+
}
|
|
941
|
+
|
|
942
|
+
/**
|
|
943
|
+
* Get the list of core types enabled for a specific namespace.
|
|
944
|
+
*
|
|
945
|
+
* @param {Object} opts Optional parameters
|
|
946
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
947
|
+
*/
|
|
948
|
+
getJourneyExternaleventsSchemasCoretypes(opts) {
|
|
949
|
+
opts = opts || {};
|
|
950
|
+
|
|
951
|
+
|
|
952
|
+
return this.apiClient.callApi(
|
|
953
|
+
'/api/v2/journey/externalevents/schemas/coretypes',
|
|
954
|
+
'GET',
|
|
955
|
+
{ },
|
|
956
|
+
{ },
|
|
957
|
+
{ },
|
|
958
|
+
{ },
|
|
959
|
+
null,
|
|
960
|
+
['PureCloud OAuth'],
|
|
961
|
+
['application/json'],
|
|
962
|
+
['application/json'],
|
|
963
|
+
opts['customHeaders']
|
|
964
|
+
);
|
|
965
|
+
}
|
|
966
|
+
|
|
967
|
+
/**
|
|
968
|
+
* Get quantitative limits on schemas
|
|
969
|
+
*
|
|
970
|
+
* @param {Object} opts Optional parameters
|
|
971
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
972
|
+
*/
|
|
973
|
+
getJourneyExternaleventsSchemasLimits(opts) {
|
|
974
|
+
opts = opts || {};
|
|
975
|
+
|
|
976
|
+
|
|
977
|
+
return this.apiClient.callApi(
|
|
978
|
+
'/api/v2/journey/externalevents/schemas/limits',
|
|
979
|
+
'GET',
|
|
980
|
+
{ },
|
|
981
|
+
{ },
|
|
982
|
+
{ },
|
|
983
|
+
{ },
|
|
984
|
+
null,
|
|
985
|
+
['PureCloud OAuth'],
|
|
986
|
+
['application/json'],
|
|
987
|
+
['application/json'],
|
|
988
|
+
opts['customHeaders']
|
|
591
989
|
);
|
|
592
990
|
}
|
|
593
991
|
|
|
@@ -595,8 +993,12 @@ class JourneyApi {
|
|
|
595
993
|
* Retrieve a single outcome.
|
|
596
994
|
*
|
|
597
995
|
* @param {String} outcomeId ID of the outcome.
|
|
996
|
+
* @param {Object} opts Optional parameters
|
|
997
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
598
998
|
*/
|
|
599
|
-
getJourneyOutcome(outcomeId) {
|
|
999
|
+
getJourneyOutcome(outcomeId, opts) {
|
|
1000
|
+
opts = opts || {};
|
|
1001
|
+
|
|
600
1002
|
// verify the required parameter 'outcomeId' is set
|
|
601
1003
|
if (outcomeId === undefined || outcomeId === null || outcomeId === '') {
|
|
602
1004
|
throw 'Missing the required parameter "outcomeId" when calling getJourneyOutcome';
|
|
@@ -612,7 +1014,8 @@ class JourneyApi {
|
|
|
612
1014
|
null,
|
|
613
1015
|
['PureCloud OAuth'],
|
|
614
1016
|
['application/json'],
|
|
615
|
-
['application/json']
|
|
1017
|
+
['application/json'],
|
|
1018
|
+
opts['customHeaders']
|
|
616
1019
|
);
|
|
617
1020
|
}
|
|
618
1021
|
|
|
@@ -626,6 +1029,7 @@ class JourneyApi {
|
|
|
626
1029
|
* @param {Array.<String>} opts.outcomeIds IDs of outcomes to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 20 outcomes are allowed per request.
|
|
627
1030
|
* @param {Array.<String>} opts.queryFields Outcome field(s) to query on. Requires 'queryValue' to also be set.
|
|
628
1031
|
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
1032
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
629
1033
|
*/
|
|
630
1034
|
getJourneyOutcomes(opts) {
|
|
631
1035
|
opts = opts || {};
|
|
@@ -641,7 +1045,8 @@ class JourneyApi {
|
|
|
641
1045
|
null,
|
|
642
1046
|
['PureCloud OAuth'],
|
|
643
1047
|
['application/json'],
|
|
644
|
-
['application/json']
|
|
1048
|
+
['application/json'],
|
|
1049
|
+
opts['customHeaders']
|
|
645
1050
|
);
|
|
646
1051
|
}
|
|
647
1052
|
|
|
@@ -649,9 +1054,13 @@ class JourneyApi {
|
|
|
649
1054
|
* Get job status.
|
|
650
1055
|
*
|
|
651
1056
|
* @param {String} jobId ID of the job.
|
|
1057
|
+
* @param {Object} opts Optional parameters
|
|
1058
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
652
1059
|
* getJourneyOutcomesAttributionsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
653
1060
|
*/
|
|
654
|
-
getJourneyOutcomesAttributionsJob(jobId) {
|
|
1061
|
+
getJourneyOutcomesAttributionsJob(jobId, opts) {
|
|
1062
|
+
opts = opts || {};
|
|
1063
|
+
|
|
655
1064
|
// verify the required parameter 'jobId' is set
|
|
656
1065
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
657
1066
|
throw 'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJob';
|
|
@@ -667,7 +1076,8 @@ class JourneyApi {
|
|
|
667
1076
|
null,
|
|
668
1077
|
['PureCloud OAuth'],
|
|
669
1078
|
['application/json'],
|
|
670
|
-
['application/json']
|
|
1079
|
+
['application/json'],
|
|
1080
|
+
opts['customHeaders']
|
|
671
1081
|
);
|
|
672
1082
|
}
|
|
673
1083
|
|
|
@@ -675,9 +1085,13 @@ class JourneyApi {
|
|
|
675
1085
|
* Get outcome attribution entities from completed job.
|
|
676
1086
|
*
|
|
677
1087
|
* @param {String} jobId ID of the job.
|
|
1088
|
+
* @param {Object} opts Optional parameters
|
|
1089
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
678
1090
|
* getJourneyOutcomesAttributionsJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
679
1091
|
*/
|
|
680
|
-
getJourneyOutcomesAttributionsJobResults(jobId) {
|
|
1092
|
+
getJourneyOutcomesAttributionsJobResults(jobId, opts) {
|
|
1093
|
+
opts = opts || {};
|
|
1094
|
+
|
|
681
1095
|
// verify the required parameter 'jobId' is set
|
|
682
1096
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
683
1097
|
throw 'Missing the required parameter "jobId" when calling getJourneyOutcomesAttributionsJobResults';
|
|
@@ -693,7 +1107,8 @@ class JourneyApi {
|
|
|
693
1107
|
null,
|
|
694
1108
|
['PureCloud OAuth'],
|
|
695
1109
|
['application/json'],
|
|
696
|
-
['application/json']
|
|
1110
|
+
['application/json'],
|
|
1111
|
+
opts['customHeaders']
|
|
697
1112
|
);
|
|
698
1113
|
}
|
|
699
1114
|
|
|
@@ -701,8 +1116,12 @@ class JourneyApi {
|
|
|
701
1116
|
* Retrieve a single outcome predictor.
|
|
702
1117
|
*
|
|
703
1118
|
* @param {String} predictorId ID of predictor
|
|
1119
|
+
* @param {Object} opts Optional parameters
|
|
1120
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
704
1121
|
*/
|
|
705
|
-
getJourneyOutcomesPredictor(predictorId) {
|
|
1122
|
+
getJourneyOutcomesPredictor(predictorId, opts) {
|
|
1123
|
+
opts = opts || {};
|
|
1124
|
+
|
|
706
1125
|
// verify the required parameter 'predictorId' is set
|
|
707
1126
|
if (predictorId === undefined || predictorId === null || predictorId === '') {
|
|
708
1127
|
throw 'Missing the required parameter "predictorId" when calling getJourneyOutcomesPredictor';
|
|
@@ -718,15 +1137,20 @@ class JourneyApi {
|
|
|
718
1137
|
null,
|
|
719
1138
|
['PureCloud OAuth'],
|
|
720
1139
|
['application/json'],
|
|
721
|
-
['application/json']
|
|
1140
|
+
['application/json'],
|
|
1141
|
+
opts['customHeaders']
|
|
722
1142
|
);
|
|
723
1143
|
}
|
|
724
1144
|
|
|
725
1145
|
/**
|
|
726
1146
|
* Retrieve all outcome predictors.
|
|
727
1147
|
*
|
|
1148
|
+
* @param {Object} opts Optional parameters
|
|
1149
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
728
1150
|
*/
|
|
729
|
-
getJourneyOutcomesPredictors() {
|
|
1151
|
+
getJourneyOutcomesPredictors(opts) {
|
|
1152
|
+
opts = opts || {};
|
|
1153
|
+
|
|
730
1154
|
|
|
731
1155
|
return this.apiClient.callApi(
|
|
732
1156
|
'/api/v2/journey/outcomes/predictors',
|
|
@@ -738,7 +1162,8 @@ class JourneyApi {
|
|
|
738
1162
|
null,
|
|
739
1163
|
['PureCloud OAuth'],
|
|
740
1164
|
['application/json'],
|
|
741
|
-
['application/json']
|
|
1165
|
+
['application/json'],
|
|
1166
|
+
opts['customHeaders']
|
|
742
1167
|
);
|
|
743
1168
|
}
|
|
744
1169
|
|
|
@@ -746,8 +1171,12 @@ class JourneyApi {
|
|
|
746
1171
|
* Retrieve a single segment.
|
|
747
1172
|
*
|
|
748
1173
|
* @param {String} segmentId ID of the segment.
|
|
1174
|
+
* @param {Object} opts Optional parameters
|
|
1175
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
749
1176
|
*/
|
|
750
|
-
getJourneySegment(segmentId) {
|
|
1177
|
+
getJourneySegment(segmentId, opts) {
|
|
1178
|
+
opts = opts || {};
|
|
1179
|
+
|
|
751
1180
|
// verify the required parameter 'segmentId' is set
|
|
752
1181
|
if (segmentId === undefined || segmentId === null || segmentId === '') {
|
|
753
1182
|
throw 'Missing the required parameter "segmentId" when calling getJourneySegment';
|
|
@@ -763,7 +1192,8 @@ class JourneyApi {
|
|
|
763
1192
|
null,
|
|
764
1193
|
['PureCloud OAuth'],
|
|
765
1194
|
['application/json'],
|
|
766
|
-
['application/json']
|
|
1195
|
+
['application/json'],
|
|
1196
|
+
opts['customHeaders']
|
|
767
1197
|
);
|
|
768
1198
|
}
|
|
769
1199
|
|
|
@@ -778,6 +1208,7 @@ class JourneyApi {
|
|
|
778
1208
|
* @param {Array.<String>} opts.segmentIds IDs of segments to return. Use of this parameter is not compatible with pagination, sorting or querying. A maximum of 100 segments are allowed per request.
|
|
779
1209
|
* @param {Array.<String>} opts.queryFields Segment field(s) to query on. Requires 'queryValue' to also be set.
|
|
780
1210
|
* @param {String} opts.queryValue Value to query on using fuzzy matching. Requires 'queryFields' to also be set.
|
|
1211
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
781
1212
|
*/
|
|
782
1213
|
getJourneySegments(opts) {
|
|
783
1214
|
opts = opts || {};
|
|
@@ -793,7 +1224,8 @@ class JourneyApi {
|
|
|
793
1224
|
null,
|
|
794
1225
|
['PureCloud OAuth'],
|
|
795
1226
|
['application/json'],
|
|
796
|
-
['application/json']
|
|
1227
|
+
['application/json'],
|
|
1228
|
+
opts['customHeaders']
|
|
797
1229
|
);
|
|
798
1230
|
}
|
|
799
1231
|
|
|
@@ -801,8 +1233,12 @@ class JourneyApi {
|
|
|
801
1233
|
* Retrieve a single session.
|
|
802
1234
|
*
|
|
803
1235
|
* @param {String} sessionId ID of the session.
|
|
1236
|
+
* @param {Object} opts Optional parameters
|
|
1237
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
804
1238
|
*/
|
|
805
|
-
getJourneySession(sessionId) {
|
|
1239
|
+
getJourneySession(sessionId, opts) {
|
|
1240
|
+
opts = opts || {};
|
|
1241
|
+
|
|
806
1242
|
// verify the required parameter 'sessionId' is set
|
|
807
1243
|
if (sessionId === undefined || sessionId === null || sessionId === '') {
|
|
808
1244
|
throw 'Missing the required parameter "sessionId" when calling getJourneySession';
|
|
@@ -818,7 +1254,8 @@ class JourneyApi {
|
|
|
818
1254
|
null,
|
|
819
1255
|
['PureCloud OAuth'],
|
|
820
1256
|
['application/json'],
|
|
821
|
-
['application/json']
|
|
1257
|
+
['application/json'],
|
|
1258
|
+
opts['customHeaders']
|
|
822
1259
|
);
|
|
823
1260
|
}
|
|
824
1261
|
|
|
@@ -830,6 +1267,7 @@ class JourneyApi {
|
|
|
830
1267
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
831
1268
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
832
1269
|
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
1270
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
833
1271
|
*/
|
|
834
1272
|
getJourneySessionEvents(sessionId, opts) {
|
|
835
1273
|
opts = opts || {};
|
|
@@ -849,7 +1287,8 @@ class JourneyApi {
|
|
|
849
1287
|
null,
|
|
850
1288
|
['PureCloud OAuth'],
|
|
851
1289
|
['application/json'],
|
|
852
|
-
['application/json']
|
|
1290
|
+
['application/json'],
|
|
1291
|
+
opts['customHeaders']
|
|
853
1292
|
);
|
|
854
1293
|
}
|
|
855
1294
|
|
|
@@ -857,8 +1296,12 @@ class JourneyApi {
|
|
|
857
1296
|
* Retrieve latest outcome score associated with a session for all outcomes.
|
|
858
1297
|
*
|
|
859
1298
|
* @param {String} sessionId ID of the session.
|
|
1299
|
+
* @param {Object} opts Optional parameters
|
|
1300
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
860
1301
|
*/
|
|
861
|
-
getJourneySessionOutcomescores(sessionId) {
|
|
1302
|
+
getJourneySessionOutcomescores(sessionId, opts) {
|
|
1303
|
+
opts = opts || {};
|
|
1304
|
+
|
|
862
1305
|
// verify the required parameter 'sessionId' is set
|
|
863
1306
|
if (sessionId === undefined || sessionId === null || sessionId === '') {
|
|
864
1307
|
throw 'Missing the required parameter "sessionId" when calling getJourneySessionOutcomescores';
|
|
@@ -874,7 +1317,8 @@ class JourneyApi {
|
|
|
874
1317
|
null,
|
|
875
1318
|
['PureCloud OAuth'],
|
|
876
1319
|
['application/json'],
|
|
877
|
-
['application/json']
|
|
1320
|
+
['application/json'],
|
|
1321
|
+
opts['customHeaders']
|
|
878
1322
|
);
|
|
879
1323
|
}
|
|
880
1324
|
|
|
@@ -882,8 +1326,12 @@ class JourneyApi {
|
|
|
882
1326
|
* Get a Journey View by ID
|
|
883
1327
|
* returns the latest version
|
|
884
1328
|
* @param {String} viewId viewId
|
|
1329
|
+
* @param {Object} opts Optional parameters
|
|
1330
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
885
1331
|
*/
|
|
886
|
-
getJourneyView(viewId) {
|
|
1332
|
+
getJourneyView(viewId, opts) {
|
|
1333
|
+
opts = opts || {};
|
|
1334
|
+
|
|
887
1335
|
// verify the required parameter 'viewId' is set
|
|
888
1336
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
889
1337
|
throw 'Missing the required parameter "viewId" when calling getJourneyView';
|
|
@@ -899,7 +1347,8 @@ class JourneyApi {
|
|
|
899
1347
|
null,
|
|
900
1348
|
['PureCloud OAuth'],
|
|
901
1349
|
['application/json'],
|
|
902
|
-
['application/json']
|
|
1350
|
+
['application/json'],
|
|
1351
|
+
opts['customHeaders']
|
|
903
1352
|
);
|
|
904
1353
|
}
|
|
905
1354
|
|
|
@@ -907,8 +1356,12 @@ class JourneyApi {
|
|
|
907
1356
|
* Get the Schedule for a JourneyView
|
|
908
1357
|
*
|
|
909
1358
|
* @param {String} viewId Journey View Id
|
|
1359
|
+
* @param {Object} opts Optional parameters
|
|
1360
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
910
1361
|
*/
|
|
911
|
-
getJourneyViewSchedules(viewId) {
|
|
1362
|
+
getJourneyViewSchedules(viewId, opts) {
|
|
1363
|
+
opts = opts || {};
|
|
1364
|
+
|
|
912
1365
|
// verify the required parameter 'viewId' is set
|
|
913
1366
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
914
1367
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewSchedules';
|
|
@@ -924,7 +1377,8 @@ class JourneyApi {
|
|
|
924
1377
|
null,
|
|
925
1378
|
['PureCloud OAuth'],
|
|
926
1379
|
['application/json'],
|
|
927
|
-
['application/json']
|
|
1380
|
+
['application/json'],
|
|
1381
|
+
opts['customHeaders']
|
|
928
1382
|
);
|
|
929
1383
|
}
|
|
930
1384
|
|
|
@@ -933,8 +1387,12 @@ class JourneyApi {
|
|
|
933
1387
|
*
|
|
934
1388
|
* @param {String} viewId viewId
|
|
935
1389
|
* @param {String} versionId versionId
|
|
1390
|
+
* @param {Object} opts Optional parameters
|
|
1391
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
936
1392
|
*/
|
|
937
|
-
getJourneyViewVersion(viewId, versionId) {
|
|
1393
|
+
getJourneyViewVersion(viewId, versionId, opts) {
|
|
1394
|
+
opts = opts || {};
|
|
1395
|
+
|
|
938
1396
|
// verify the required parameter 'viewId' is set
|
|
939
1397
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
940
1398
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersion';
|
|
@@ -954,7 +1412,8 @@ class JourneyApi {
|
|
|
954
1412
|
null,
|
|
955
1413
|
['PureCloud OAuth'],
|
|
956
1414
|
['application/json'],
|
|
957
|
-
['application/json']
|
|
1415
|
+
['application/json'],
|
|
1416
|
+
opts['customHeaders']
|
|
958
1417
|
);
|
|
959
1418
|
}
|
|
960
1419
|
|
|
@@ -964,8 +1423,12 @@ class JourneyApi {
|
|
|
964
1423
|
* @param {String} viewId viewId
|
|
965
1424
|
* @param {String} journeyViewVersion Journey View Version
|
|
966
1425
|
* @param {String} chartId chartId
|
|
1426
|
+
* @param {Object} opts Optional parameters
|
|
1427
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
967
1428
|
*/
|
|
968
|
-
getJourneyViewVersionChart(viewId, journeyViewVersion, chartId) {
|
|
1429
|
+
getJourneyViewVersionChart(viewId, journeyViewVersion, chartId, opts) {
|
|
1430
|
+
opts = opts || {};
|
|
1431
|
+
|
|
969
1432
|
// verify the required parameter 'viewId' is set
|
|
970
1433
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
971
1434
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChart';
|
|
@@ -989,7 +1452,8 @@ class JourneyApi {
|
|
|
989
1452
|
null,
|
|
990
1453
|
['PureCloud OAuth'],
|
|
991
1454
|
['application/json'],
|
|
992
|
-
['application/json']
|
|
1455
|
+
['application/json'],
|
|
1456
|
+
opts['customHeaders']
|
|
993
1457
|
);
|
|
994
1458
|
}
|
|
995
1459
|
|
|
@@ -1000,8 +1464,12 @@ class JourneyApi {
|
|
|
1000
1464
|
* @param {String} journeyViewVersion Journey View Version
|
|
1001
1465
|
* @param {String} chartId chartId
|
|
1002
1466
|
* @param {String} chartVersion chartVersion
|
|
1467
|
+
* @param {Object} opts Optional parameters
|
|
1468
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1003
1469
|
*/
|
|
1004
|
-
getJourneyViewVersionChartVersion(viewId, journeyViewVersion, chartId, chartVersion) {
|
|
1470
|
+
getJourneyViewVersionChartVersion(viewId, journeyViewVersion, chartId, chartVersion, opts) {
|
|
1471
|
+
opts = opts || {};
|
|
1472
|
+
|
|
1005
1473
|
// verify the required parameter 'viewId' is set
|
|
1006
1474
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1007
1475
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionChartVersion';
|
|
@@ -1029,7 +1497,8 @@ class JourneyApi {
|
|
|
1029
1497
|
null,
|
|
1030
1498
|
['PureCloud OAuth'],
|
|
1031
1499
|
['application/json'],
|
|
1032
|
-
['application/json']
|
|
1500
|
+
['application/json'],
|
|
1501
|
+
opts['customHeaders']
|
|
1033
1502
|
);
|
|
1034
1503
|
}
|
|
1035
1504
|
|
|
@@ -1039,8 +1508,12 @@ class JourneyApi {
|
|
|
1039
1508
|
* @param {String} viewId Journey View Id
|
|
1040
1509
|
* @param {String} journeyVersionId Journey View Version
|
|
1041
1510
|
* @param {String} jobId JobId
|
|
1511
|
+
* @param {Object} opts Optional parameters
|
|
1512
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1042
1513
|
*/
|
|
1043
|
-
getJourneyViewVersionJob(viewId, journeyVersionId, jobId) {
|
|
1514
|
+
getJourneyViewVersionJob(viewId, journeyVersionId, jobId, opts) {
|
|
1515
|
+
opts = opts || {};
|
|
1516
|
+
|
|
1044
1517
|
// verify the required parameter 'viewId' is set
|
|
1045
1518
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1046
1519
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJob';
|
|
@@ -1064,7 +1537,8 @@ class JourneyApi {
|
|
|
1064
1537
|
null,
|
|
1065
1538
|
['PureCloud OAuth'],
|
|
1066
1539
|
['application/json'],
|
|
1067
|
-
['application/json']
|
|
1540
|
+
['application/json'],
|
|
1541
|
+
opts['customHeaders']
|
|
1068
1542
|
);
|
|
1069
1543
|
}
|
|
1070
1544
|
|
|
@@ -1074,8 +1548,12 @@ class JourneyApi {
|
|
|
1074
1548
|
* @param {String} viewId JourneyViewResult id
|
|
1075
1549
|
* @param {String} journeyViewVersion Journey View Version
|
|
1076
1550
|
* @param {String} jobId Id of the executing job
|
|
1551
|
+
* @param {Object} opts Optional parameters
|
|
1552
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1077
1553
|
*/
|
|
1078
|
-
getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) {
|
|
1554
|
+
getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId, opts) {
|
|
1555
|
+
opts = opts || {};
|
|
1556
|
+
|
|
1079
1557
|
// verify the required parameter 'viewId' is set
|
|
1080
1558
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1081
1559
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResults';
|
|
@@ -1099,7 +1577,8 @@ class JourneyApi {
|
|
|
1099
1577
|
null,
|
|
1100
1578
|
['PureCloud OAuth'],
|
|
1101
1579
|
['application/json'],
|
|
1102
|
-
['application/json']
|
|
1580
|
+
['application/json'],
|
|
1581
|
+
opts['customHeaders']
|
|
1103
1582
|
);
|
|
1104
1583
|
}
|
|
1105
1584
|
|
|
@@ -1110,8 +1589,12 @@ class JourneyApi {
|
|
|
1110
1589
|
* @param {String} journeyVersionId Journey View Version
|
|
1111
1590
|
* @param {String} jobId JobId
|
|
1112
1591
|
* @param {String} chartId ChartId
|
|
1592
|
+
* @param {Object} opts Optional parameters
|
|
1593
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1113
1594
|
*/
|
|
1114
|
-
getJourneyViewVersionJobResultsChart(viewId, journeyVersionId, jobId, chartId) {
|
|
1595
|
+
getJourneyViewVersionJobResultsChart(viewId, journeyVersionId, jobId, chartId, opts) {
|
|
1596
|
+
opts = opts || {};
|
|
1597
|
+
|
|
1115
1598
|
// verify the required parameter 'viewId' is set
|
|
1116
1599
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1117
1600
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobResultsChart';
|
|
@@ -1139,7 +1622,8 @@ class JourneyApi {
|
|
|
1139
1622
|
null,
|
|
1140
1623
|
['PureCloud OAuth'],
|
|
1141
1624
|
['application/json'],
|
|
1142
|
-
['application/json']
|
|
1625
|
+
['application/json'],
|
|
1626
|
+
opts['customHeaders']
|
|
1143
1627
|
);
|
|
1144
1628
|
}
|
|
1145
1629
|
|
|
@@ -1148,8 +1632,12 @@ class JourneyApi {
|
|
|
1148
1632
|
*
|
|
1149
1633
|
* @param {String} viewId Journey View Id
|
|
1150
1634
|
* @param {String} journeyVersionId Journey View Version
|
|
1635
|
+
* @param {Object} opts Optional parameters
|
|
1636
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1151
1637
|
*/
|
|
1152
|
-
getJourneyViewVersionJobsLatest(viewId, journeyVersionId) {
|
|
1638
|
+
getJourneyViewVersionJobsLatest(viewId, journeyVersionId, opts) {
|
|
1639
|
+
opts = opts || {};
|
|
1640
|
+
|
|
1153
1641
|
// verify the required parameter 'viewId' is set
|
|
1154
1642
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1155
1643
|
throw 'Missing the required parameter "viewId" when calling getJourneyViewVersionJobsLatest';
|
|
@@ -1169,7 +1657,8 @@ class JourneyApi {
|
|
|
1169
1657
|
null,
|
|
1170
1658
|
['PureCloud OAuth'],
|
|
1171
1659
|
['application/json'],
|
|
1172
|
-
['application/json']
|
|
1660
|
+
['application/json'],
|
|
1661
|
+
opts['customHeaders']
|
|
1173
1662
|
);
|
|
1174
1663
|
}
|
|
1175
1664
|
|
|
@@ -1182,6 +1671,7 @@ class JourneyApi {
|
|
|
1182
1671
|
* @param {String} opts.nameOrCreatedBy Journey View Name or Created By
|
|
1183
1672
|
* @param {Object} opts.expand Parameter to request additional data to return in Journey payload
|
|
1184
1673
|
* @param {String} opts.id Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.
|
|
1674
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1185
1675
|
*/
|
|
1186
1676
|
getJourneyViews(opts) {
|
|
1187
1677
|
opts = opts || {};
|
|
@@ -1197,15 +1687,20 @@ class JourneyApi {
|
|
|
1197
1687
|
null,
|
|
1198
1688
|
['PureCloud OAuth'],
|
|
1199
1689
|
['application/json'],
|
|
1200
|
-
['application/json']
|
|
1690
|
+
['application/json'],
|
|
1691
|
+
opts['customHeaders']
|
|
1201
1692
|
);
|
|
1202
1693
|
}
|
|
1203
1694
|
|
|
1204
1695
|
/**
|
|
1205
1696
|
* Get details about the data available for journey queries including oldest and newest event dates
|
|
1206
1697
|
*
|
|
1698
|
+
* @param {Object} opts Optional parameters
|
|
1699
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1207
1700
|
*/
|
|
1208
|
-
getJourneyViewsDataDetails() {
|
|
1701
|
+
getJourneyViewsDataDetails(opts) {
|
|
1702
|
+
opts = opts || {};
|
|
1703
|
+
|
|
1209
1704
|
|
|
1210
1705
|
return this.apiClient.callApi(
|
|
1211
1706
|
'/api/v2/journey/views/data/details',
|
|
@@ -1217,7 +1712,8 @@ class JourneyApi {
|
|
|
1217
1712
|
null,
|
|
1218
1713
|
['PureCloud OAuth'],
|
|
1219
1714
|
['application/json'],
|
|
1220
|
-
['application/json']
|
|
1715
|
+
['application/json'],
|
|
1716
|
+
opts['customHeaders']
|
|
1221
1717
|
);
|
|
1222
1718
|
}
|
|
1223
1719
|
|
|
@@ -1225,8 +1721,12 @@ class JourneyApi {
|
|
|
1225
1721
|
* Get an Event Definition
|
|
1226
1722
|
*
|
|
1227
1723
|
* @param {String} eventDefinitionId Event Definition ID
|
|
1724
|
+
* @param {Object} opts Optional parameters
|
|
1725
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1228
1726
|
*/
|
|
1229
|
-
getJourneyViewsEventdefinition(eventDefinitionId) {
|
|
1727
|
+
getJourneyViewsEventdefinition(eventDefinitionId, opts) {
|
|
1728
|
+
opts = opts || {};
|
|
1729
|
+
|
|
1230
1730
|
// verify the required parameter 'eventDefinitionId' is set
|
|
1231
1731
|
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
1232
1732
|
throw 'Missing the required parameter "eventDefinitionId" when calling getJourneyViewsEventdefinition';
|
|
@@ -1242,15 +1742,20 @@ class JourneyApi {
|
|
|
1242
1742
|
null,
|
|
1243
1743
|
['PureCloud OAuth'],
|
|
1244
1744
|
['application/json'],
|
|
1245
|
-
['application/json']
|
|
1745
|
+
['application/json'],
|
|
1746
|
+
opts['customHeaders']
|
|
1246
1747
|
);
|
|
1247
1748
|
}
|
|
1248
1749
|
|
|
1249
1750
|
/**
|
|
1250
1751
|
* Get a list of Event Definitions
|
|
1251
1752
|
*
|
|
1753
|
+
* @param {Object} opts Optional parameters
|
|
1754
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1252
1755
|
*/
|
|
1253
|
-
getJourneyViewsEventdefinitions() {
|
|
1756
|
+
getJourneyViewsEventdefinitions(opts) {
|
|
1757
|
+
opts = opts || {};
|
|
1758
|
+
|
|
1254
1759
|
|
|
1255
1760
|
return this.apiClient.callApi(
|
|
1256
1761
|
'/api/v2/journey/views/eventdefinitions',
|
|
@@ -1262,7 +1767,8 @@ class JourneyApi {
|
|
|
1262
1767
|
null,
|
|
1263
1768
|
['PureCloud OAuth'],
|
|
1264
1769
|
['application/json'],
|
|
1265
|
-
['application/json']
|
|
1770
|
+
['application/json'],
|
|
1771
|
+
opts['customHeaders']
|
|
1266
1772
|
);
|
|
1267
1773
|
}
|
|
1268
1774
|
|
|
@@ -1274,6 +1780,7 @@ class JourneyApi {
|
|
|
1274
1780
|
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
1275
1781
|
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
1276
1782
|
* @param {String} opts.statuses Job statuses to filter for
|
|
1783
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1277
1784
|
*/
|
|
1278
1785
|
getJourneyViewsJobs(opts) {
|
|
1279
1786
|
opts = opts || {};
|
|
@@ -1289,7 +1796,8 @@ class JourneyApi {
|
|
|
1289
1796
|
null,
|
|
1290
1797
|
['PureCloud OAuth'],
|
|
1291
1798
|
['application/json'],
|
|
1292
|
-
['application/json']
|
|
1799
|
+
['application/json'],
|
|
1800
|
+
opts['customHeaders']
|
|
1293
1801
|
);
|
|
1294
1802
|
}
|
|
1295
1803
|
|
|
@@ -1301,6 +1809,7 @@ class JourneyApi {
|
|
|
1301
1809
|
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
1302
1810
|
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
1303
1811
|
* @param {String} opts.statuses Job statuses to filter for
|
|
1812
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1304
1813
|
*/
|
|
1305
1814
|
getJourneyViewsJobsMe(opts) {
|
|
1306
1815
|
opts = opts || {};
|
|
@@ -1316,7 +1825,8 @@ class JourneyApi {
|
|
|
1316
1825
|
null,
|
|
1317
1826
|
['PureCloud OAuth'],
|
|
1318
1827
|
['application/json'],
|
|
1319
|
-
['application/json']
|
|
1828
|
+
['application/json'],
|
|
1829
|
+
opts['customHeaders']
|
|
1320
1830
|
);
|
|
1321
1831
|
}
|
|
1322
1832
|
|
|
@@ -1326,6 +1836,7 @@ class JourneyApi {
|
|
|
1326
1836
|
* @param {Object} opts Optional parameters
|
|
1327
1837
|
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
1328
1838
|
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
1839
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1329
1840
|
*/
|
|
1330
1841
|
getJourneyViewsSchedules(opts) {
|
|
1331
1842
|
opts = opts || {};
|
|
@@ -1341,7 +1852,8 @@ class JourneyApi {
|
|
|
1341
1852
|
null,
|
|
1342
1853
|
['PureCloud OAuth'],
|
|
1343
1854
|
['application/json'],
|
|
1344
|
-
['application/json']
|
|
1855
|
+
['application/json'],
|
|
1856
|
+
opts['customHeaders']
|
|
1345
1857
|
);
|
|
1346
1858
|
}
|
|
1347
1859
|
|
|
@@ -1351,6 +1863,7 @@ class JourneyApi {
|
|
|
1351
1863
|
* @param {String} actionMapId ID of the action map.
|
|
1352
1864
|
* @param {Object} opts Optional parameters
|
|
1353
1865
|
* @param {Object} opts.body
|
|
1866
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1354
1867
|
*/
|
|
1355
1868
|
patchJourneyActionmap(actionMapId, opts) {
|
|
1356
1869
|
opts = opts || {};
|
|
@@ -1370,7 +1883,8 @@ class JourneyApi {
|
|
|
1370
1883
|
opts['body'],
|
|
1371
1884
|
['PureCloud OAuth'],
|
|
1372
1885
|
['application/json'],
|
|
1373
|
-
['application/json']
|
|
1886
|
+
['application/json'],
|
|
1887
|
+
opts['customHeaders']
|
|
1374
1888
|
);
|
|
1375
1889
|
}
|
|
1376
1890
|
|
|
@@ -1380,6 +1894,7 @@ class JourneyApi {
|
|
|
1380
1894
|
* @param {String} actionTargetId ID of the action target.
|
|
1381
1895
|
* @param {Object} opts Optional parameters
|
|
1382
1896
|
* @param {Object} opts.body
|
|
1897
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1383
1898
|
*/
|
|
1384
1899
|
patchJourneyActiontarget(actionTargetId, opts) {
|
|
1385
1900
|
opts = opts || {};
|
|
@@ -1399,7 +1914,8 @@ class JourneyApi {
|
|
|
1399
1914
|
opts['body'],
|
|
1400
1915
|
['PureCloud OAuth'],
|
|
1401
1916
|
['application/json'],
|
|
1402
|
-
['application/json']
|
|
1917
|
+
['application/json'],
|
|
1918
|
+
opts['customHeaders']
|
|
1403
1919
|
);
|
|
1404
1920
|
}
|
|
1405
1921
|
|
|
@@ -1409,6 +1925,7 @@ class JourneyApi {
|
|
|
1409
1925
|
* @param {String} actionTemplateId ID of the action template.
|
|
1410
1926
|
* @param {Object} opts Optional parameters
|
|
1411
1927
|
* @param {Object} opts.body
|
|
1928
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1412
1929
|
*/
|
|
1413
1930
|
patchJourneyActiontemplate(actionTemplateId, opts) {
|
|
1414
1931
|
opts = opts || {};
|
|
@@ -1428,7 +1945,39 @@ class JourneyApi {
|
|
|
1428
1945
|
opts['body'],
|
|
1429
1946
|
['PureCloud OAuth'],
|
|
1430
1947
|
['application/json'],
|
|
1431
|
-
['application/json']
|
|
1948
|
+
['application/json'],
|
|
1949
|
+
opts['customHeaders']
|
|
1950
|
+
);
|
|
1951
|
+
}
|
|
1952
|
+
|
|
1953
|
+
/**
|
|
1954
|
+
* Update an external events configuration.
|
|
1955
|
+
*
|
|
1956
|
+
* @param {String} configId The ID of the external event configuration.
|
|
1957
|
+
* @param {Object} opts Optional parameters
|
|
1958
|
+
* @param {Object} opts.body
|
|
1959
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1960
|
+
*/
|
|
1961
|
+
patchJourneyExternaleventsConfiguration(configId, opts) {
|
|
1962
|
+
opts = opts || {};
|
|
1963
|
+
|
|
1964
|
+
// verify the required parameter 'configId' is set
|
|
1965
|
+
if (configId === undefined || configId === null || configId === '') {
|
|
1966
|
+
throw 'Missing the required parameter "configId" when calling patchJourneyExternaleventsConfiguration';
|
|
1967
|
+
}
|
|
1968
|
+
|
|
1969
|
+
return this.apiClient.callApi(
|
|
1970
|
+
'/api/v2/journey/externalevents/configurations/{configId}',
|
|
1971
|
+
'PATCH',
|
|
1972
|
+
{ 'configId': configId },
|
|
1973
|
+
{ },
|
|
1974
|
+
{ },
|
|
1975
|
+
{ },
|
|
1976
|
+
opts['body'],
|
|
1977
|
+
['PureCloud OAuth'],
|
|
1978
|
+
['application/json'],
|
|
1979
|
+
['application/json'],
|
|
1980
|
+
opts['customHeaders']
|
|
1432
1981
|
);
|
|
1433
1982
|
}
|
|
1434
1983
|
|
|
@@ -1438,6 +1987,7 @@ class JourneyApi {
|
|
|
1438
1987
|
* @param {String} outcomeId ID of the outcome.
|
|
1439
1988
|
* @param {Object} opts Optional parameters
|
|
1440
1989
|
* @param {Object} opts.body
|
|
1990
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1441
1991
|
*/
|
|
1442
1992
|
patchJourneyOutcome(outcomeId, opts) {
|
|
1443
1993
|
opts = opts || {};
|
|
@@ -1457,7 +2007,8 @@ class JourneyApi {
|
|
|
1457
2007
|
opts['body'],
|
|
1458
2008
|
['PureCloud OAuth'],
|
|
1459
2009
|
['application/json'],
|
|
1460
|
-
['application/json']
|
|
2010
|
+
['application/json'],
|
|
2011
|
+
opts['customHeaders']
|
|
1461
2012
|
);
|
|
1462
2013
|
}
|
|
1463
2014
|
|
|
@@ -1467,6 +2018,7 @@ class JourneyApi {
|
|
|
1467
2018
|
* @param {String} segmentId ID of the segment.
|
|
1468
2019
|
* @param {Object} opts Optional parameters
|
|
1469
2020
|
* @param {Object} opts.body
|
|
2021
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1470
2022
|
*/
|
|
1471
2023
|
patchJourneySegment(segmentId, opts) {
|
|
1472
2024
|
opts = opts || {};
|
|
@@ -1486,7 +2038,8 @@ class JourneyApi {
|
|
|
1486
2038
|
opts['body'],
|
|
1487
2039
|
['PureCloud OAuth'],
|
|
1488
2040
|
['application/json'],
|
|
1489
|
-
['application/json']
|
|
2041
|
+
['application/json'],
|
|
2042
|
+
opts['customHeaders']
|
|
1490
2043
|
);
|
|
1491
2044
|
}
|
|
1492
2045
|
|
|
@@ -1497,8 +2050,12 @@ class JourneyApi {
|
|
|
1497
2050
|
* @param {String} journeyVersionId Journey View Version
|
|
1498
2051
|
* @param {String} jobId JobId
|
|
1499
2052
|
* @param {Object} body journeyViewJob
|
|
2053
|
+
* @param {Object} opts Optional parameters
|
|
2054
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1500
2055
|
*/
|
|
1501
|
-
patchJourneyViewVersionJob(viewId, journeyVersionId, jobId, body) {
|
|
2056
|
+
patchJourneyViewVersionJob(viewId, journeyVersionId, jobId, body, opts) {
|
|
2057
|
+
opts = opts || {};
|
|
2058
|
+
|
|
1502
2059
|
// verify the required parameter 'viewId' is set
|
|
1503
2060
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1504
2061
|
throw 'Missing the required parameter "viewId" when calling patchJourneyViewVersionJob';
|
|
@@ -1526,7 +2083,8 @@ class JourneyApi {
|
|
|
1526
2083
|
body,
|
|
1527
2084
|
['PureCloud OAuth'],
|
|
1528
2085
|
['application/json'],
|
|
1529
|
-
['application/json']
|
|
2086
|
+
['application/json'],
|
|
2087
|
+
opts['customHeaders']
|
|
1530
2088
|
);
|
|
1531
2089
|
}
|
|
1532
2090
|
|
|
@@ -1534,9 +2092,13 @@ class JourneyApi {
|
|
|
1534
2092
|
* Query for journey aggregates asynchronously
|
|
1535
2093
|
*
|
|
1536
2094
|
* @param {Object} body query
|
|
2095
|
+
* @param {Object} opts Optional parameters
|
|
2096
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1537
2097
|
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1538
2098
|
*/
|
|
1539
|
-
postAnalyticsJourneysAggregatesJobs(body) {
|
|
2099
|
+
postAnalyticsJourneysAggregatesJobs(body, opts) {
|
|
2100
|
+
opts = opts || {};
|
|
2101
|
+
|
|
1540
2102
|
// verify the required parameter 'body' is set
|
|
1541
2103
|
if (body === undefined || body === null) {
|
|
1542
2104
|
throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';
|
|
@@ -1552,7 +2114,8 @@ class JourneyApi {
|
|
|
1552
2114
|
body,
|
|
1553
2115
|
['PureCloud OAuth'],
|
|
1554
2116
|
['application/json'],
|
|
1555
|
-
['application/json']
|
|
2117
|
+
['application/json'],
|
|
2118
|
+
opts['customHeaders']
|
|
1556
2119
|
);
|
|
1557
2120
|
}
|
|
1558
2121
|
|
|
@@ -1560,8 +2123,12 @@ class JourneyApi {
|
|
|
1560
2123
|
* Query for journey aggregates
|
|
1561
2124
|
*
|
|
1562
2125
|
* @param {Object} body query
|
|
2126
|
+
* @param {Object} opts Optional parameters
|
|
2127
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1563
2128
|
*/
|
|
1564
|
-
postAnalyticsJourneysAggregatesQuery(body) {
|
|
2129
|
+
postAnalyticsJourneysAggregatesQuery(body, opts) {
|
|
2130
|
+
opts = opts || {};
|
|
2131
|
+
|
|
1565
2132
|
// verify the required parameter 'body' is set
|
|
1566
2133
|
if (body === undefined || body === null) {
|
|
1567
2134
|
throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';
|
|
@@ -1577,7 +2144,8 @@ class JourneyApi {
|
|
|
1577
2144
|
body,
|
|
1578
2145
|
['PureCloud OAuth'],
|
|
1579
2146
|
['application/json'],
|
|
1580
|
-
['application/json']
|
|
2147
|
+
['application/json'],
|
|
2148
|
+
opts['customHeaders']
|
|
1581
2149
|
);
|
|
1582
2150
|
}
|
|
1583
2151
|
|
|
@@ -1587,6 +2155,7 @@ class JourneyApi {
|
|
|
1587
2155
|
* @param {String} contactId ExternalContact ID
|
|
1588
2156
|
* @param {Object} opts Optional parameters
|
|
1589
2157
|
* @param {Object} opts.body
|
|
2158
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1590
2159
|
*/
|
|
1591
2160
|
postExternalcontactsContactJourneySegments(contactId, opts) {
|
|
1592
2161
|
opts = opts || {};
|
|
@@ -1606,7 +2175,8 @@ class JourneyApi {
|
|
|
1606
2175
|
opts['body'],
|
|
1607
2176
|
['PureCloud OAuth'],
|
|
1608
2177
|
['application/json'],
|
|
1609
|
-
['application/json']
|
|
2178
|
+
['application/json'],
|
|
2179
|
+
opts['customHeaders']
|
|
1610
2180
|
);
|
|
1611
2181
|
}
|
|
1612
2182
|
|
|
@@ -1615,6 +2185,7 @@ class JourneyApi {
|
|
|
1615
2185
|
*
|
|
1616
2186
|
* @param {Object} opts Optional parameters
|
|
1617
2187
|
* @param {Object} opts.body
|
|
2188
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1618
2189
|
*/
|
|
1619
2190
|
postJourneyActionmaps(opts) {
|
|
1620
2191
|
opts = opts || {};
|
|
@@ -1630,7 +2201,8 @@ class JourneyApi {
|
|
|
1630
2201
|
opts['body'],
|
|
1631
2202
|
['PureCloud OAuth'],
|
|
1632
2203
|
['application/json'],
|
|
1633
|
-
['application/json']
|
|
2204
|
+
['application/json'],
|
|
2205
|
+
opts['customHeaders']
|
|
1634
2206
|
);
|
|
1635
2207
|
}
|
|
1636
2208
|
|
|
@@ -1638,8 +2210,12 @@ class JourneyApi {
|
|
|
1638
2210
|
* Query for estimates
|
|
1639
2211
|
*
|
|
1640
2212
|
* @param {Object} body audience estimator request
|
|
2213
|
+
* @param {Object} opts Optional parameters
|
|
2214
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1641
2215
|
*/
|
|
1642
|
-
postJourneyActionmapsEstimatesJobs(body) {
|
|
2216
|
+
postJourneyActionmapsEstimatesJobs(body, opts) {
|
|
2217
|
+
opts = opts || {};
|
|
2218
|
+
|
|
1643
2219
|
// verify the required parameter 'body' is set
|
|
1644
2220
|
if (body === undefined || body === null) {
|
|
1645
2221
|
throw 'Missing the required parameter "body" when calling postJourneyActionmapsEstimatesJobs';
|
|
@@ -1655,7 +2231,8 @@ class JourneyApi {
|
|
|
1655
2231
|
body,
|
|
1656
2232
|
['PureCloud OAuth'],
|
|
1657
2233
|
['application/json'],
|
|
1658
|
-
['application/json']
|
|
2234
|
+
['application/json'],
|
|
2235
|
+
opts['customHeaders']
|
|
1659
2236
|
);
|
|
1660
2237
|
}
|
|
1661
2238
|
|
|
@@ -1664,6 +2241,7 @@ class JourneyApi {
|
|
|
1664
2241
|
*
|
|
1665
2242
|
* @param {Object} opts Optional parameters
|
|
1666
2243
|
* @param {Object} opts.body
|
|
2244
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1667
2245
|
*/
|
|
1668
2246
|
postJourneyActiontemplates(opts) {
|
|
1669
2247
|
opts = opts || {};
|
|
@@ -1679,7 +2257,8 @@ class JourneyApi {
|
|
|
1679
2257
|
opts['body'],
|
|
1680
2258
|
['PureCloud OAuth'],
|
|
1681
2259
|
['application/json'],
|
|
1682
|
-
['application/json']
|
|
2260
|
+
['application/json'],
|
|
2261
|
+
opts['customHeaders']
|
|
1683
2262
|
);
|
|
1684
2263
|
}
|
|
1685
2264
|
|
|
@@ -1688,8 +2267,12 @@ class JourneyApi {
|
|
|
1688
2267
|
*
|
|
1689
2268
|
* @param {String} deploymentId The ID of the deployment sending the beacon.
|
|
1690
2269
|
* @param {Object} body
|
|
2270
|
+
* @param {Object} opts Optional parameters
|
|
2271
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1691
2272
|
*/
|
|
1692
|
-
postJourneyDeploymentActionevent(deploymentId, body) {
|
|
2273
|
+
postJourneyDeploymentActionevent(deploymentId, body, opts) {
|
|
2274
|
+
opts = opts || {};
|
|
2275
|
+
|
|
1693
2276
|
// verify the required parameter 'deploymentId' is set
|
|
1694
2277
|
if (deploymentId === undefined || deploymentId === null || deploymentId === '') {
|
|
1695
2278
|
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentActionevent';
|
|
@@ -1709,7 +2292,8 @@ class JourneyApi {
|
|
|
1709
2292
|
body,
|
|
1710
2293
|
['PureCloud OAuth'],
|
|
1711
2294
|
['application/json'],
|
|
1712
|
-
['application/json']
|
|
2295
|
+
['application/json'],
|
|
2296
|
+
opts['customHeaders']
|
|
1713
2297
|
);
|
|
1714
2298
|
}
|
|
1715
2299
|
|
|
@@ -1719,6 +2303,7 @@ class JourneyApi {
|
|
|
1719
2303
|
* @param {String} deploymentId The ID of the deployment sending the app event.
|
|
1720
2304
|
* @param {Object} opts Optional parameters
|
|
1721
2305
|
* @param {Object} opts.body
|
|
2306
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1722
2307
|
*/
|
|
1723
2308
|
postJourneyDeploymentAppevents(deploymentId, opts) {
|
|
1724
2309
|
opts = opts || {};
|
|
@@ -1738,7 +2323,8 @@ class JourneyApi {
|
|
|
1738
2323
|
opts['body'],
|
|
1739
2324
|
['PureCloud OAuth'],
|
|
1740
2325
|
['application/json'],
|
|
1741
|
-
['application/json']
|
|
2326
|
+
['application/json'],
|
|
2327
|
+
opts['customHeaders']
|
|
1742
2328
|
);
|
|
1743
2329
|
}
|
|
1744
2330
|
|
|
@@ -1748,6 +2334,7 @@ class JourneyApi {
|
|
|
1748
2334
|
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
1749
2335
|
* @param {Object} opts Optional parameters
|
|
1750
2336
|
* @param {Object} opts.body
|
|
2337
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1751
2338
|
*/
|
|
1752
2339
|
postJourneyDeploymentWebevents(deploymentId, opts) {
|
|
1753
2340
|
opts = opts || {};
|
|
@@ -1767,7 +2354,95 @@ class JourneyApi {
|
|
|
1767
2354
|
opts['body'],
|
|
1768
2355
|
['PureCloud OAuth'],
|
|
1769
2356
|
['application/json'],
|
|
1770
|
-
['application/json']
|
|
2357
|
+
['application/json'],
|
|
2358
|
+
opts['customHeaders']
|
|
2359
|
+
);
|
|
2360
|
+
}
|
|
2361
|
+
|
|
2362
|
+
/**
|
|
2363
|
+
* Create external events
|
|
2364
|
+
*
|
|
2365
|
+
* @param {String} configurationId The ID of the external event configuration.
|
|
2366
|
+
* @param {Object} opts Optional parameters
|
|
2367
|
+
* @param {Object} opts.body
|
|
2368
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2369
|
+
*/
|
|
2370
|
+
postJourneyExternaleventsConfigurationEvents(configurationId, opts) {
|
|
2371
|
+
opts = opts || {};
|
|
2372
|
+
|
|
2373
|
+
// verify the required parameter 'configurationId' is set
|
|
2374
|
+
if (configurationId === undefined || configurationId === null || configurationId === '') {
|
|
2375
|
+
throw 'Missing the required parameter "configurationId" when calling postJourneyExternaleventsConfigurationEvents';
|
|
2376
|
+
}
|
|
2377
|
+
|
|
2378
|
+
return this.apiClient.callApi(
|
|
2379
|
+
'/api/v2/journey/externalevents/configurations/{configurationId}/events',
|
|
2380
|
+
'POST',
|
|
2381
|
+
{ 'configurationId': configurationId },
|
|
2382
|
+
{ },
|
|
2383
|
+
{ },
|
|
2384
|
+
{ },
|
|
2385
|
+
opts['body'],
|
|
2386
|
+
['PureCloud OAuth'],
|
|
2387
|
+
['application/json'],
|
|
2388
|
+
['application/json'],
|
|
2389
|
+
opts['customHeaders']
|
|
2390
|
+
);
|
|
2391
|
+
}
|
|
2392
|
+
|
|
2393
|
+
/**
|
|
2394
|
+
* Create an external events configuration.
|
|
2395
|
+
*
|
|
2396
|
+
* @param {Object} opts Optional parameters
|
|
2397
|
+
* @param {Object} opts.body
|
|
2398
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2399
|
+
*/
|
|
2400
|
+
postJourneyExternaleventsConfigurations(opts) {
|
|
2401
|
+
opts = opts || {};
|
|
2402
|
+
|
|
2403
|
+
|
|
2404
|
+
return this.apiClient.callApi(
|
|
2405
|
+
'/api/v2/journey/externalevents/configurations',
|
|
2406
|
+
'POST',
|
|
2407
|
+
{ },
|
|
2408
|
+
{ },
|
|
2409
|
+
{ },
|
|
2410
|
+
{ },
|
|
2411
|
+
opts['body'],
|
|
2412
|
+
['PureCloud OAuth'],
|
|
2413
|
+
['application/json'],
|
|
2414
|
+
['application/json'],
|
|
2415
|
+
opts['customHeaders']
|
|
2416
|
+
);
|
|
2417
|
+
}
|
|
2418
|
+
|
|
2419
|
+
/**
|
|
2420
|
+
* Create a schema
|
|
2421
|
+
*
|
|
2422
|
+
* @param {Object} body Schema create request body
|
|
2423
|
+
* @param {Object} opts Optional parameters
|
|
2424
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2425
|
+
*/
|
|
2426
|
+
postJourneyExternaleventsSchemas(body, opts) {
|
|
2427
|
+
opts = opts || {};
|
|
2428
|
+
|
|
2429
|
+
// verify the required parameter 'body' is set
|
|
2430
|
+
if (body === undefined || body === null) {
|
|
2431
|
+
throw 'Missing the required parameter "body" when calling postJourneyExternaleventsSchemas';
|
|
2432
|
+
}
|
|
2433
|
+
|
|
2434
|
+
return this.apiClient.callApi(
|
|
2435
|
+
'/api/v2/journey/externalevents/schemas',
|
|
2436
|
+
'POST',
|
|
2437
|
+
{ },
|
|
2438
|
+
{ },
|
|
2439
|
+
{ },
|
|
2440
|
+
{ },
|
|
2441
|
+
body,
|
|
2442
|
+
['PureCloud OAuth'],
|
|
2443
|
+
['application/json'],
|
|
2444
|
+
['application/json'],
|
|
2445
|
+
opts['customHeaders']
|
|
1771
2446
|
);
|
|
1772
2447
|
}
|
|
1773
2448
|
|
|
@@ -1776,6 +2451,7 @@ class JourneyApi {
|
|
|
1776
2451
|
*
|
|
1777
2452
|
* @param {Object} opts Optional parameters
|
|
1778
2453
|
* @param {Object} opts.body
|
|
2454
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1779
2455
|
*/
|
|
1780
2456
|
postJourneyFlowsPathsQuery(opts) {
|
|
1781
2457
|
opts = opts || {};
|
|
@@ -1791,7 +2467,8 @@ class JourneyApi {
|
|
|
1791
2467
|
opts['body'],
|
|
1792
2468
|
['PureCloud OAuth'],
|
|
1793
2469
|
['application/json'],
|
|
1794
|
-
['application/json']
|
|
2470
|
+
['application/json'],
|
|
2471
|
+
opts['customHeaders']
|
|
1795
2472
|
);
|
|
1796
2473
|
}
|
|
1797
2474
|
|
|
@@ -1800,6 +2477,7 @@ class JourneyApi {
|
|
|
1800
2477
|
*
|
|
1801
2478
|
* @param {Object} opts Optional parameters
|
|
1802
2479
|
* @param {Object} opts.body
|
|
2480
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1803
2481
|
*/
|
|
1804
2482
|
postJourneyOutcomes(opts) {
|
|
1805
2483
|
opts = opts || {};
|
|
@@ -1815,7 +2493,8 @@ class JourneyApi {
|
|
|
1815
2493
|
opts['body'],
|
|
1816
2494
|
['PureCloud OAuth'],
|
|
1817
2495
|
['application/json'],
|
|
1818
|
-
['application/json']
|
|
2496
|
+
['application/json'],
|
|
2497
|
+
opts['customHeaders']
|
|
1819
2498
|
);
|
|
1820
2499
|
}
|
|
1821
2500
|
|
|
@@ -1824,6 +2503,7 @@ class JourneyApi {
|
|
|
1824
2503
|
*
|
|
1825
2504
|
* @param {Object} opts Optional parameters
|
|
1826
2505
|
* @param {Object} opts.body outcome attribution request
|
|
2506
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1827
2507
|
* postJourneyOutcomesAttributionsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1828
2508
|
*/
|
|
1829
2509
|
postJourneyOutcomesAttributionsJobs(opts) {
|
|
@@ -1840,7 +2520,8 @@ class JourneyApi {
|
|
|
1840
2520
|
opts['body'],
|
|
1841
2521
|
['PureCloud OAuth'],
|
|
1842
2522
|
['application/json'],
|
|
1843
|
-
['application/json']
|
|
2523
|
+
['application/json'],
|
|
2524
|
+
opts['customHeaders']
|
|
1844
2525
|
);
|
|
1845
2526
|
}
|
|
1846
2527
|
|
|
@@ -1849,6 +2530,7 @@ class JourneyApi {
|
|
|
1849
2530
|
*
|
|
1850
2531
|
* @param {Object} opts Optional parameters
|
|
1851
2532
|
* @param {Object} opts.body
|
|
2533
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1852
2534
|
*/
|
|
1853
2535
|
postJourneyOutcomesPredictors(opts) {
|
|
1854
2536
|
opts = opts || {};
|
|
@@ -1864,7 +2546,8 @@ class JourneyApi {
|
|
|
1864
2546
|
opts['body'],
|
|
1865
2547
|
['PureCloud OAuth'],
|
|
1866
2548
|
['application/json'],
|
|
1867
|
-
['application/json']
|
|
2549
|
+
['application/json'],
|
|
2550
|
+
opts['customHeaders']
|
|
1868
2551
|
);
|
|
1869
2552
|
}
|
|
1870
2553
|
|
|
@@ -1873,6 +2556,7 @@ class JourneyApi {
|
|
|
1873
2556
|
*
|
|
1874
2557
|
* @param {Object} opts Optional parameters
|
|
1875
2558
|
* @param {Object} opts.body
|
|
2559
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1876
2560
|
*/
|
|
1877
2561
|
postJourneySegments(opts) {
|
|
1878
2562
|
opts = opts || {};
|
|
@@ -1888,7 +2572,8 @@ class JourneyApi {
|
|
|
1888
2572
|
opts['body'],
|
|
1889
2573
|
['PureCloud OAuth'],
|
|
1890
2574
|
['application/json'],
|
|
1891
|
-
['application/json']
|
|
2575
|
+
['application/json'],
|
|
2576
|
+
opts['customHeaders']
|
|
1892
2577
|
);
|
|
1893
2578
|
}
|
|
1894
2579
|
|
|
@@ -1897,8 +2582,12 @@ class JourneyApi {
|
|
|
1897
2582
|
*
|
|
1898
2583
|
* @param {String} viewId Journey View Id
|
|
1899
2584
|
* @param {Object} body journeyViewSchedule
|
|
2585
|
+
* @param {Object} opts Optional parameters
|
|
2586
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1900
2587
|
*/
|
|
1901
|
-
postJourneyViewSchedules(viewId, body) {
|
|
2588
|
+
postJourneyViewSchedules(viewId, body, opts) {
|
|
2589
|
+
opts = opts || {};
|
|
2590
|
+
|
|
1902
2591
|
// verify the required parameter 'viewId' is set
|
|
1903
2592
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1904
2593
|
throw 'Missing the required parameter "viewId" when calling postJourneyViewSchedules';
|
|
@@ -1918,7 +2607,8 @@ class JourneyApi {
|
|
|
1918
2607
|
body,
|
|
1919
2608
|
['PureCloud OAuth'],
|
|
1920
2609
|
['application/json'],
|
|
1921
|
-
['application/json']
|
|
2610
|
+
['application/json'],
|
|
2611
|
+
opts['customHeaders']
|
|
1922
2612
|
);
|
|
1923
2613
|
}
|
|
1924
2614
|
|
|
@@ -1927,8 +2617,12 @@ class JourneyApi {
|
|
|
1927
2617
|
*
|
|
1928
2618
|
* @param {String} viewId Journey View Id
|
|
1929
2619
|
* @param {String} journeyVersionId Journey View Version
|
|
2620
|
+
* @param {Object} opts Optional parameters
|
|
2621
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1930
2622
|
*/
|
|
1931
|
-
postJourneyViewVersionJobs(viewId, journeyVersionId) {
|
|
2623
|
+
postJourneyViewVersionJobs(viewId, journeyVersionId, opts) {
|
|
2624
|
+
opts = opts || {};
|
|
2625
|
+
|
|
1932
2626
|
// verify the required parameter 'viewId' is set
|
|
1933
2627
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1934
2628
|
throw 'Missing the required parameter "viewId" when calling postJourneyViewVersionJobs';
|
|
@@ -1948,7 +2642,8 @@ class JourneyApi {
|
|
|
1948
2642
|
null,
|
|
1949
2643
|
['PureCloud OAuth'],
|
|
1950
2644
|
['application/json'],
|
|
1951
|
-
['application/json']
|
|
2645
|
+
['application/json'],
|
|
2646
|
+
opts['customHeaders']
|
|
1952
2647
|
);
|
|
1953
2648
|
}
|
|
1954
2649
|
|
|
@@ -1957,8 +2652,12 @@ class JourneyApi {
|
|
|
1957
2652
|
* creates a new version
|
|
1958
2653
|
* @param {String} viewId viewId
|
|
1959
2654
|
* @param {Object} body JourneyView
|
|
2655
|
+
* @param {Object} opts Optional parameters
|
|
2656
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1960
2657
|
*/
|
|
1961
|
-
postJourneyViewVersions(viewId, body) {
|
|
2658
|
+
postJourneyViewVersions(viewId, body, opts) {
|
|
2659
|
+
opts = opts || {};
|
|
2660
|
+
|
|
1962
2661
|
// verify the required parameter 'viewId' is set
|
|
1963
2662
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
1964
2663
|
throw 'Missing the required parameter "viewId" when calling postJourneyViewVersions';
|
|
@@ -1978,7 +2677,8 @@ class JourneyApi {
|
|
|
1978
2677
|
body,
|
|
1979
2678
|
['PureCloud OAuth'],
|
|
1980
2679
|
['application/json'],
|
|
1981
|
-
['application/json']
|
|
2680
|
+
['application/json'],
|
|
2681
|
+
opts['customHeaders']
|
|
1982
2682
|
);
|
|
1983
2683
|
}
|
|
1984
2684
|
|
|
@@ -1986,8 +2686,12 @@ class JourneyApi {
|
|
|
1986
2686
|
* Create a new Journey View
|
|
1987
2687
|
*
|
|
1988
2688
|
* @param {Object} body JourneyView
|
|
2689
|
+
* @param {Object} opts Optional parameters
|
|
2690
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1989
2691
|
*/
|
|
1990
|
-
postJourneyViews(body) {
|
|
2692
|
+
postJourneyViews(body, opts) {
|
|
2693
|
+
opts = opts || {};
|
|
2694
|
+
|
|
1991
2695
|
// verify the required parameter 'body' is set
|
|
1992
2696
|
if (body === undefined || body === null) {
|
|
1993
2697
|
throw 'Missing the required parameter "body" when calling postJourneyViews';
|
|
@@ -2003,7 +2707,8 @@ class JourneyApi {
|
|
|
2003
2707
|
body,
|
|
2004
2708
|
['PureCloud OAuth'],
|
|
2005
2709
|
['application/json'],
|
|
2006
|
-
['application/json']
|
|
2710
|
+
['application/json'],
|
|
2711
|
+
opts['customHeaders']
|
|
2007
2712
|
);
|
|
2008
2713
|
}
|
|
2009
2714
|
|
|
@@ -2012,6 +2717,7 @@ class JourneyApi {
|
|
|
2012
2717
|
* True indicates a valid encoding
|
|
2013
2718
|
* @param {Object} opts Optional parameters
|
|
2014
2719
|
* @param {Array.<Object>} opts.body
|
|
2720
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2015
2721
|
*/
|
|
2016
2722
|
postJourneyViewsEncodingsValidate(opts) {
|
|
2017
2723
|
opts = opts || {};
|
|
@@ -2027,7 +2733,43 @@ class JourneyApi {
|
|
|
2027
2733
|
opts['body'],
|
|
2028
2734
|
['PureCloud OAuth'],
|
|
2029
2735
|
['application/json'],
|
|
2030
|
-
['application/json']
|
|
2736
|
+
['application/json'],
|
|
2737
|
+
opts['customHeaders']
|
|
2738
|
+
);
|
|
2739
|
+
}
|
|
2740
|
+
|
|
2741
|
+
/**
|
|
2742
|
+
* Update a schema
|
|
2743
|
+
*
|
|
2744
|
+
* @param {String} schemaId Schema ID
|
|
2745
|
+
* @param {Object} body Schema update request body
|
|
2746
|
+
* @param {Object} opts Optional parameters
|
|
2747
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2748
|
+
*/
|
|
2749
|
+
putJourneyExternaleventsSchema(schemaId, body, opts) {
|
|
2750
|
+
opts = opts || {};
|
|
2751
|
+
|
|
2752
|
+
// verify the required parameter 'schemaId' is set
|
|
2753
|
+
if (schemaId === undefined || schemaId === null || schemaId === '') {
|
|
2754
|
+
throw 'Missing the required parameter "schemaId" when calling putJourneyExternaleventsSchema';
|
|
2755
|
+
}
|
|
2756
|
+
// verify the required parameter 'body' is set
|
|
2757
|
+
if (body === undefined || body === null) {
|
|
2758
|
+
throw 'Missing the required parameter "body" when calling putJourneyExternaleventsSchema';
|
|
2759
|
+
}
|
|
2760
|
+
|
|
2761
|
+
return this.apiClient.callApi(
|
|
2762
|
+
'/api/v2/journey/externalevents/schemas/{schemaId}',
|
|
2763
|
+
'PUT',
|
|
2764
|
+
{ 'schemaId': schemaId },
|
|
2765
|
+
{ },
|
|
2766
|
+
{ },
|
|
2767
|
+
{ },
|
|
2768
|
+
body,
|
|
2769
|
+
['PureCloud OAuth'],
|
|
2770
|
+
['application/json'],
|
|
2771
|
+
['application/json'],
|
|
2772
|
+
opts['customHeaders']
|
|
2031
2773
|
);
|
|
2032
2774
|
}
|
|
2033
2775
|
|
|
@@ -2036,8 +2778,12 @@ class JourneyApi {
|
|
|
2036
2778
|
*
|
|
2037
2779
|
* @param {String} viewId Journey View Id
|
|
2038
2780
|
* @param {Object} body journeyViewSchedule
|
|
2781
|
+
* @param {Object} opts Optional parameters
|
|
2782
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2039
2783
|
*/
|
|
2040
|
-
putJourneyViewSchedules(viewId, body) {
|
|
2784
|
+
putJourneyViewSchedules(viewId, body, opts) {
|
|
2785
|
+
opts = opts || {};
|
|
2786
|
+
|
|
2041
2787
|
// verify the required parameter 'viewId' is set
|
|
2042
2788
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
2043
2789
|
throw 'Missing the required parameter "viewId" when calling putJourneyViewSchedules';
|
|
@@ -2057,7 +2803,8 @@ class JourneyApi {
|
|
|
2057
2803
|
body,
|
|
2058
2804
|
['PureCloud OAuth'],
|
|
2059
2805
|
['application/json'],
|
|
2060
|
-
['application/json']
|
|
2806
|
+
['application/json'],
|
|
2807
|
+
opts['customHeaders']
|
|
2061
2808
|
);
|
|
2062
2809
|
}
|
|
2063
2810
|
|
|
@@ -2067,8 +2814,12 @@ class JourneyApi {
|
|
|
2067
2814
|
* @param {String} viewId viewId
|
|
2068
2815
|
* @param {String} versionId versionId
|
|
2069
2816
|
* @param {Object} body JourneyView
|
|
2817
|
+
* @param {Object} opts Optional parameters
|
|
2818
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2070
2819
|
*/
|
|
2071
|
-
putJourneyViewVersion(viewId, versionId, body) {
|
|
2820
|
+
putJourneyViewVersion(viewId, versionId, body, opts) {
|
|
2821
|
+
opts = opts || {};
|
|
2822
|
+
|
|
2072
2823
|
// verify the required parameter 'viewId' is set
|
|
2073
2824
|
if (viewId === undefined || viewId === null || viewId === '') {
|
|
2074
2825
|
throw 'Missing the required parameter "viewId" when calling putJourneyViewVersion';
|
|
@@ -2092,7 +2843,8 @@ class JourneyApi {
|
|
|
2092
2843
|
body,
|
|
2093
2844
|
['PureCloud OAuth'],
|
|
2094
2845
|
['application/json'],
|
|
2095
|
-
['application/json']
|
|
2846
|
+
['application/json'],
|
|
2847
|
+
opts['customHeaders']
|
|
2096
2848
|
);
|
|
2097
2849
|
}
|
|
2098
2850
|
|