purecloud-platform-client-v2 182.1.0 → 183.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/node/purecloud-platform-client-v2.js +191 -113
- package/dist/web-amd/purecloud-platform-client-v2.js +191 -113
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +143 -110
- package/dist/web-cjs/purecloud-platform-client-v2.js +143 -110
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +294 -214
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +30 -19
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +41 -5
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +4 -8
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +39 -2
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -6
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +7 -4
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +1 -1
package/package.json
CHANGED
|
@@ -5,7 +5,7 @@ class AlertingApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Alerting service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 183.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -47,8 +47,9 @@ class AlertingApi {
|
|
|
47
47
|
|
|
48
48
|
/**
|
|
49
49
|
* Delete an interaction stats alert
|
|
50
|
-
*
|
|
50
|
+
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
51
51
|
* @param {String} alertId Alert ID
|
|
52
|
+
* @deprecated
|
|
52
53
|
*/
|
|
53
54
|
deleteAlertingInteractionstatsAlert(alertId) {
|
|
54
55
|
// verify the required parameter 'alertId' is set
|
|
@@ -71,9 +72,10 @@ class AlertingApi {
|
|
|
71
72
|
}
|
|
72
73
|
|
|
73
74
|
/**
|
|
74
|
-
* Delete an interaction stats rule
|
|
75
|
-
*
|
|
75
|
+
* Delete an interaction stats rule
|
|
76
|
+
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
76
77
|
* @param {String} ruleId Rule ID
|
|
78
|
+
* @deprecated
|
|
77
79
|
*/
|
|
78
80
|
deleteAlertingInteractionstatsRule(ruleId) {
|
|
79
81
|
// verify the required parameter 'ruleId' is set
|
|
@@ -146,8 +148,9 @@ class AlertingApi {
|
|
|
146
148
|
}
|
|
147
149
|
|
|
148
150
|
/**
|
|
149
|
-
* Gets active alert count for a user
|
|
150
|
-
*
|
|
151
|
+
* Gets active alert count for a user
|
|
152
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and alertStatus to Active in the request body.
|
|
153
|
+
* @deprecated
|
|
151
154
|
*/
|
|
152
155
|
getAlertingAlertsActive() {
|
|
153
156
|
|
|
@@ -167,10 +170,11 @@ class AlertingApi {
|
|
|
167
170
|
|
|
168
171
|
/**
|
|
169
172
|
* Get an interaction stats alert
|
|
170
|
-
*
|
|
173
|
+
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
171
174
|
* @param {String} alertId Alert ID
|
|
172
175
|
* @param {Object} opts Optional parameters
|
|
173
176
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
177
|
+
* @deprecated
|
|
174
178
|
*/
|
|
175
179
|
getAlertingInteractionstatsAlert(alertId, opts) {
|
|
176
180
|
opts = opts || {};
|
|
@@ -195,10 +199,11 @@ class AlertingApi {
|
|
|
195
199
|
}
|
|
196
200
|
|
|
197
201
|
/**
|
|
198
|
-
* Get interaction stats alert list
|
|
199
|
-
*
|
|
202
|
+
* Get interaction stats alert list
|
|
203
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
200
204
|
* @param {Object} opts Optional parameters
|
|
201
205
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
206
|
+
* @deprecated
|
|
202
207
|
*/
|
|
203
208
|
getAlertingInteractionstatsAlerts(opts) {
|
|
204
209
|
opts = opts || {};
|
|
@@ -219,8 +224,9 @@ class AlertingApi {
|
|
|
219
224
|
}
|
|
220
225
|
|
|
221
226
|
/**
|
|
222
|
-
* Gets user unread count of interaction stats alerts
|
|
223
|
-
*
|
|
227
|
+
* Gets user unread count of interaction stats alerts
|
|
228
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query with the queryType set to Count and viewStatus to Unread in the request body.
|
|
229
|
+
* @deprecated
|
|
224
230
|
*/
|
|
225
231
|
getAlertingInteractionstatsAlertsUnread() {
|
|
226
232
|
|
|
@@ -239,11 +245,12 @@ class AlertingApi {
|
|
|
239
245
|
}
|
|
240
246
|
|
|
241
247
|
/**
|
|
242
|
-
* Get an interaction stats rule
|
|
243
|
-
*
|
|
248
|
+
* Get an interaction stats rule
|
|
249
|
+
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
244
250
|
* @param {String} ruleId Rule ID
|
|
245
251
|
* @param {Object} opts Optional parameters
|
|
246
252
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
253
|
+
* @deprecated
|
|
247
254
|
*/
|
|
248
255
|
getAlertingInteractionstatsRule(ruleId, opts) {
|
|
249
256
|
opts = opts || {};
|
|
@@ -268,10 +275,11 @@ class AlertingApi {
|
|
|
268
275
|
}
|
|
269
276
|
|
|
270
277
|
/**
|
|
271
|
-
* Get an interaction stats rule list
|
|
272
|
-
*
|
|
278
|
+
* Get an interaction stats rule list
|
|
279
|
+
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
273
280
|
* @param {Object} opts Optional parameters
|
|
274
281
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
282
|
+
* @deprecated
|
|
275
283
|
*/
|
|
276
284
|
getAlertingInteractionstatsRules(opts) {
|
|
277
285
|
opts = opts || {};
|
|
@@ -420,11 +428,12 @@ class AlertingApi {
|
|
|
420
428
|
}
|
|
421
429
|
|
|
422
430
|
/**
|
|
423
|
-
* Create an interaction stats rule
|
|
424
|
-
*
|
|
431
|
+
* Create an interaction stats rule
|
|
432
|
+
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
425
433
|
* @param {Object} body AlertingRule
|
|
426
434
|
* @param {Object} opts Optional parameters
|
|
427
435
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
436
|
+
* @deprecated
|
|
428
437
|
*/
|
|
429
438
|
postAlertingInteractionstatsRules(body, opts) {
|
|
430
439
|
opts = opts || {};
|
|
@@ -553,11 +562,12 @@ class AlertingApi {
|
|
|
553
562
|
|
|
554
563
|
/**
|
|
555
564
|
* Update an interaction stats alert read status
|
|
556
|
-
*
|
|
565
|
+
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
557
566
|
* @param {String} alertId Alert ID
|
|
558
567
|
* @param {Object} body InteractionStatsAlert
|
|
559
568
|
* @param {Object} opts Optional parameters
|
|
560
569
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
570
|
+
* @deprecated
|
|
561
571
|
*/
|
|
562
572
|
putAlertingInteractionstatsAlert(alertId, body, opts) {
|
|
563
573
|
opts = opts || {};
|
|
@@ -587,11 +597,12 @@ class AlertingApi {
|
|
|
587
597
|
|
|
588
598
|
/**
|
|
589
599
|
* Update an interaction stats rule
|
|
590
|
-
*
|
|
600
|
+
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
591
601
|
* @param {String} ruleId Rule ID
|
|
592
602
|
* @param {Object} body AlertingRule
|
|
593
603
|
* @param {Object} opts Optional parameters
|
|
594
604
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
605
|
+
* @deprecated
|
|
595
606
|
*/
|
|
596
607
|
putAlertingInteractionstatsRule(ruleId, body, opts) {
|
|
597
608
|
opts = opts || {};
|
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 183.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -153,7 +153,7 @@ class AnalyticsApi {
|
|
|
153
153
|
|
|
154
154
|
/**
|
|
155
155
|
* Get Reporting Turns.
|
|
156
|
-
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint
|
|
156
|
+
* Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
157
157
|
* @param {String} botFlowId ID of the bot flow.
|
|
158
158
|
* @param {Object} opts Optional parameters
|
|
159
159
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -186,6 +186,39 @@ class AnalyticsApi {
|
|
|
186
186
|
);
|
|
187
187
|
}
|
|
188
188
|
|
|
189
|
+
/**
|
|
190
|
+
* Get Bot Flow Sessions.
|
|
191
|
+
* Returns the bot flow sessions in reverse chronological order from the date they were created. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
|
|
192
|
+
* @param {String} botFlowId ID of the bot flow.
|
|
193
|
+
* @param {Object} opts Optional parameters
|
|
194
|
+
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
195
|
+
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
196
|
+
* @param {String} opts.interval Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
197
|
+
* @param {Object} opts.botResultCategories Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.
|
|
198
|
+
* @param {String} opts.endLanguage Optional case-insensitive language code to filter sessions by the language the sessions ended in.
|
|
199
|
+
*/
|
|
200
|
+
getAnalyticsBotflowSessions(botFlowId, opts) {
|
|
201
|
+
opts = opts || {};
|
|
202
|
+
|
|
203
|
+
// verify the required parameter 'botFlowId' is set
|
|
204
|
+
if (botFlowId === undefined || botFlowId === null) {
|
|
205
|
+
throw 'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowSessions';
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
return this.apiClient.callApi(
|
|
209
|
+
'/api/v2/analytics/botflows/{botFlowId}/sessions',
|
|
210
|
+
'GET',
|
|
211
|
+
{ 'botFlowId': botFlowId },
|
|
212
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'botResultCategories': opts['botResultCategories'],'endLanguage': opts['endLanguage'] },
|
|
213
|
+
{ },
|
|
214
|
+
{ },
|
|
215
|
+
null,
|
|
216
|
+
['PureCloud OAuth'],
|
|
217
|
+
['application/json'],
|
|
218
|
+
['application/json']
|
|
219
|
+
);
|
|
220
|
+
}
|
|
221
|
+
|
|
189
222
|
/**
|
|
190
223
|
* Get status for async query for bot aggregates
|
|
191
224
|
*
|
|
@@ -1943,8 +1976,9 @@ class AnalyticsApi {
|
|
|
1943
1976
|
|
|
1944
1977
|
/**
|
|
1945
1978
|
* Place a scheduled report immediately into the reporting queue
|
|
1946
|
-
*
|
|
1979
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
1947
1980
|
* @param {String} scheduleId Schedule ID
|
|
1981
|
+
* @deprecated
|
|
1948
1982
|
*/
|
|
1949
1983
|
postAnalyticsReportingScheduleRunreport(scheduleId) {
|
|
1950
1984
|
// verify the required parameter 'scheduleId' is set
|
|
@@ -1968,8 +2002,9 @@ class AnalyticsApi {
|
|
|
1968
2002
|
|
|
1969
2003
|
/**
|
|
1970
2004
|
* Create a scheduled report job
|
|
1971
|
-
*
|
|
2005
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
1972
2006
|
* @param {Object} body ReportSchedule
|
|
2007
|
+
* @deprecated
|
|
1973
2008
|
*/
|
|
1974
2009
|
postAnalyticsReportingSchedules(body) {
|
|
1975
2010
|
// verify the required parameter 'body' is set
|
|
@@ -2417,9 +2452,10 @@ class AnalyticsApi {
|
|
|
2417
2452
|
|
|
2418
2453
|
/**
|
|
2419
2454
|
* Update a scheduled report job.
|
|
2420
|
-
*
|
|
2455
|
+
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
2421
2456
|
* @param {String} scheduleId Schedule ID
|
|
2422
2457
|
* @param {Object} body ReportSchedule
|
|
2458
|
+
* @deprecated
|
|
2423
2459
|
*/
|
|
2424
2460
|
putAnalyticsReportingSchedule(scheduleId, body) {
|
|
2425
2461
|
// verify the required parameter 'scheduleId' is set
|
|
@@ -5,7 +5,7 @@ class IntegrationsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Integrations service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 183.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1615,7 +1615,7 @@ class IntegrationsApi {
|
|
|
1615
1615
|
}
|
|
1616
1616
|
|
|
1617
1617
|
/**
|
|
1618
|
-
* Create a new Action
|
|
1618
|
+
* Create a new Action. Not supported for 'Function Integration' actions. Function integrations must be created as drafts to allow managing of uploading required ZIP function package before they may be used as a published action.
|
|
1619
1619
|
*
|
|
1620
1620
|
* @param {Object} body Input used to create Action.
|
|
1621
1621
|
*/
|
|
@@ -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 183.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -452,14 +452,14 @@ class JourneyApi {
|
|
|
452
452
|
*
|
|
453
453
|
* @param {String} deploymentId The ID of the deployment sending the ping.
|
|
454
454
|
* @param {String} customerCookieId ID of the customer associated with the ping.
|
|
455
|
-
* @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
456
455
|
* @param {Object} opts Optional parameters
|
|
457
456
|
* @param {String} opts.dl Document Location: 1) Web Page URL if overridden or URL fragment identifier (window.location.hash). OR 2) Application screen name that the ping request was sent from in the app. e.g. 'home' or 'help. Pings without this parameter will not return actions.
|
|
458
457
|
* @param {String} opts.dt Document Title. A human readable name for the page or screen
|
|
459
458
|
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
459
|
+
* @param {String} opts.sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
460
460
|
* @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.
|
|
461
461
|
*/
|
|
462
|
-
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId,
|
|
462
|
+
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, opts) {
|
|
463
463
|
opts = opts || {};
|
|
464
464
|
|
|
465
465
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -470,16 +470,12 @@ class JourneyApi {
|
|
|
470
470
|
if (customerCookieId === undefined || customerCookieId === null) {
|
|
471
471
|
throw 'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';
|
|
472
472
|
}
|
|
473
|
-
// verify the required parameter 'sessionId' is set
|
|
474
|
-
if (sessionId === undefined || sessionId === null) {
|
|
475
|
-
throw 'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';
|
|
476
|
-
}
|
|
477
473
|
|
|
478
474
|
return this.apiClient.callApi(
|
|
479
475
|
'/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping',
|
|
480
476
|
'GET',
|
|
481
477
|
{ 'deploymentId': deploymentId,'customerCookieId': customerCookieId },
|
|
482
|
-
{ 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': sessionId,'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
|
|
478
|
+
{ 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': opts['sessionId'],'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
|
|
483
479
|
{ },
|
|
484
480
|
{ },
|
|
485
481
|
null,
|
|
@@ -5,7 +5,7 @@ class LearningApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Learning service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 183.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -306,6 +306,7 @@ class LearningApi {
|
|
|
306
306
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
307
307
|
* @param {Object} opts.isPublished Specifies if only the Unpublished (isPublished is False) or Published (isPublished is True) modules are returned. If isPublished is Any or omitted, both types are returned (default to Any)
|
|
308
308
|
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
309
|
+
* @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
|
|
309
310
|
*/
|
|
310
311
|
getLearningModules(opts) {
|
|
311
312
|
opts = opts || {};
|
|
@@ -315,7 +316,7 @@ class LearningApi {
|
|
|
315
316
|
'/api/v2/learning/modules',
|
|
316
317
|
'GET',
|
|
317
318
|
{ },
|
|
318
|
-
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi') },
|
|
319
|
+
{ 'isArchived': opts['isArchived'],'types': this.apiClient.buildCollectionParam(opts['types'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'searchTerm': opts['searchTerm'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'isPublished': opts['isPublished'],'statuses': this.apiClient.buildCollectionParam(opts['statuses'], 'multi'),'externalIds': this.apiClient.buildCollectionParam(opts['externalIds'], 'multi') },
|
|
319
320
|
{ },
|
|
320
321
|
{ },
|
|
321
322
|
null,
|
|
@@ -442,6 +443,42 @@ class LearningApi {
|
|
|
442
443
|
);
|
|
443
444
|
}
|
|
444
445
|
|
|
446
|
+
/**
|
|
447
|
+
* Update an external assignment for a specific user
|
|
448
|
+
*
|
|
449
|
+
* @param {String} moduleId Key identifier for the module
|
|
450
|
+
* @param {String} userId Key identifier for the user
|
|
451
|
+
* @param {Object} body The learning request for updating the assignment
|
|
452
|
+
* patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
453
|
+
*/
|
|
454
|
+
patchLearningModuleUserAssignments(moduleId, userId, body) {
|
|
455
|
+
// verify the required parameter 'moduleId' is set
|
|
456
|
+
if (moduleId === undefined || moduleId === null) {
|
|
457
|
+
throw 'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';
|
|
458
|
+
}
|
|
459
|
+
// verify the required parameter 'userId' is set
|
|
460
|
+
if (userId === undefined || userId === null) {
|
|
461
|
+
throw 'Missing the required parameter "userId" when calling patchLearningModuleUserAssignments';
|
|
462
|
+
}
|
|
463
|
+
// verify the required parameter 'body' is set
|
|
464
|
+
if (body === undefined || body === null) {
|
|
465
|
+
throw 'Missing the required parameter "body" when calling patchLearningModuleUserAssignments';
|
|
466
|
+
}
|
|
467
|
+
|
|
468
|
+
return this.apiClient.callApi(
|
|
469
|
+
'/api/v2/learning/modules/{moduleId}/users/{userId}/assignments',
|
|
470
|
+
'PATCH',
|
|
471
|
+
{ 'moduleId': moduleId,'userId': userId },
|
|
472
|
+
{ },
|
|
473
|
+
{ },
|
|
474
|
+
{ },
|
|
475
|
+
body,
|
|
476
|
+
['PureCloud OAuth'],
|
|
477
|
+
['application/json'],
|
|
478
|
+
['application/json']
|
|
479
|
+
);
|
|
480
|
+
}
|
|
481
|
+
|
|
445
482
|
/**
|
|
446
483
|
* Score learning assessment for preview
|
|
447
484
|
*
|