purecloud-platform-client-v2 182.1.0 → 184.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 +786 -127
- package/dist/web-amd/purecloud-platform-client-v2.js +786 -127
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +295 -119
- package/dist/web-cjs/purecloud-platform-client-v2.js +295 -119
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +554 -229
- 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 +149 -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 +7 -8
- 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/LogCaptureApi.js +75 -0
- 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 +7 -8
- 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 +401 -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 +7 -1
|
@@ -399,7 +399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
399
399
|
|
|
400
400
|
/**
|
|
401
401
|
* @module purecloud-platform-client-v2/ApiClient
|
|
402
|
-
* @version
|
|
402
|
+
* @version 184.0.0
|
|
403
403
|
*/
|
|
404
404
|
class ApiClient {
|
|
405
405
|
/**
|
|
@@ -1485,7 +1485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1485
1485
|
/**
|
|
1486
1486
|
* Alerting service.
|
|
1487
1487
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1488
|
-
* @version
|
|
1488
|
+
* @version 184.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -1527,8 +1527,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1527
1527
|
|
|
1528
1528
|
/**
|
|
1529
1529
|
* Delete an interaction stats alert
|
|
1530
|
-
*
|
|
1530
|
+
* Apps should migrate to use DELETE /api/v2/alerting/alerts/{alertId}.
|
|
1531
1531
|
* @param {String} alertId Alert ID
|
|
1532
|
+
* @deprecated
|
|
1532
1533
|
*/
|
|
1533
1534
|
deleteAlertingInteractionstatsAlert(alertId) {
|
|
1534
1535
|
// verify the required parameter 'alertId' is set
|
|
@@ -1551,9 +1552,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1551
1552
|
}
|
|
1552
1553
|
|
|
1553
1554
|
/**
|
|
1554
|
-
* Delete an interaction stats rule
|
|
1555
|
-
*
|
|
1555
|
+
* Delete an interaction stats rule
|
|
1556
|
+
* Apps should migrate to use DELETE /api/v2/alerting/rules/{ruleId}.
|
|
1556
1557
|
* @param {String} ruleId Rule ID
|
|
1558
|
+
* @deprecated
|
|
1557
1559
|
*/
|
|
1558
1560
|
deleteAlertingInteractionstatsRule(ruleId) {
|
|
1559
1561
|
// verify the required parameter 'ruleId' is set
|
|
@@ -1626,8 +1628,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1626
1628
|
}
|
|
1627
1629
|
|
|
1628
1630
|
/**
|
|
1629
|
-
* Gets active alert count for a user
|
|
1630
|
-
*
|
|
1631
|
+
* Gets active alert count for a user
|
|
1632
|
+
* 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.
|
|
1633
|
+
* @deprecated
|
|
1631
1634
|
*/
|
|
1632
1635
|
getAlertingAlertsActive() {
|
|
1633
1636
|
|
|
@@ -1647,10 +1650,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1647
1650
|
|
|
1648
1651
|
/**
|
|
1649
1652
|
* Get an interaction stats alert
|
|
1650
|
-
*
|
|
1653
|
+
* Apps should migrate to use GET /api/v2/alerting/alerts/{alertId}.
|
|
1651
1654
|
* @param {String} alertId Alert ID
|
|
1652
1655
|
* @param {Object} opts Optional parameters
|
|
1653
1656
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1657
|
+
* @deprecated
|
|
1654
1658
|
*/
|
|
1655
1659
|
getAlertingInteractionstatsAlert(alertId, opts) {
|
|
1656
1660
|
opts = opts || {};
|
|
@@ -1675,10 +1679,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1675
1679
|
}
|
|
1676
1680
|
|
|
1677
1681
|
/**
|
|
1678
|
-
* Get interaction stats alert list
|
|
1679
|
-
*
|
|
1682
|
+
* Get interaction stats alert list
|
|
1683
|
+
* Apps should migrate to use POST /api/v2/alerting/alerts/query.
|
|
1680
1684
|
* @param {Object} opts Optional parameters
|
|
1681
1685
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1686
|
+
* @deprecated
|
|
1682
1687
|
*/
|
|
1683
1688
|
getAlertingInteractionstatsAlerts(opts) {
|
|
1684
1689
|
opts = opts || {};
|
|
@@ -1699,8 +1704,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1699
1704
|
}
|
|
1700
1705
|
|
|
1701
1706
|
/**
|
|
1702
|
-
* Gets user unread count of interaction stats alerts
|
|
1703
|
-
*
|
|
1707
|
+
* Gets user unread count of interaction stats alerts
|
|
1708
|
+
* 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.
|
|
1709
|
+
* @deprecated
|
|
1704
1710
|
*/
|
|
1705
1711
|
getAlertingInteractionstatsAlertsUnread() {
|
|
1706
1712
|
|
|
@@ -1719,11 +1725,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1719
1725
|
}
|
|
1720
1726
|
|
|
1721
1727
|
/**
|
|
1722
|
-
* Get an interaction stats rule
|
|
1723
|
-
*
|
|
1728
|
+
* Get an interaction stats rule
|
|
1729
|
+
* Apps should migrate to use GET /api/v2/alerting/rules/{ruleId}.
|
|
1724
1730
|
* @param {String} ruleId Rule ID
|
|
1725
1731
|
* @param {Object} opts Optional parameters
|
|
1726
1732
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1733
|
+
* @deprecated
|
|
1727
1734
|
*/
|
|
1728
1735
|
getAlertingInteractionstatsRule(ruleId, opts) {
|
|
1729
1736
|
opts = opts || {};
|
|
@@ -1748,10 +1755,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1748
1755
|
}
|
|
1749
1756
|
|
|
1750
1757
|
/**
|
|
1751
|
-
* Get an interaction stats rule list
|
|
1752
|
-
*
|
|
1758
|
+
* Get an interaction stats rule list
|
|
1759
|
+
* Apps should migrate to use POST /api/v2/alerting/rules/query.
|
|
1753
1760
|
* @param {Object} opts Optional parameters
|
|
1754
1761
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1762
|
+
* @deprecated
|
|
1755
1763
|
*/
|
|
1756
1764
|
getAlertingInteractionstatsRules(opts) {
|
|
1757
1765
|
opts = opts || {};
|
|
@@ -1900,11 +1908,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1900
1908
|
}
|
|
1901
1909
|
|
|
1902
1910
|
/**
|
|
1903
|
-
* Create an interaction stats rule
|
|
1904
|
-
*
|
|
1911
|
+
* Create an interaction stats rule
|
|
1912
|
+
* Apps should migrate to use POST /api/v2/alerting/rules.
|
|
1905
1913
|
* @param {Object} body AlertingRule
|
|
1906
1914
|
* @param {Object} opts Optional parameters
|
|
1907
1915
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
1916
|
+
* @deprecated
|
|
1908
1917
|
*/
|
|
1909
1918
|
postAlertingInteractionstatsRules(body, opts) {
|
|
1910
1919
|
opts = opts || {};
|
|
@@ -2033,11 +2042,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2033
2042
|
|
|
2034
2043
|
/**
|
|
2035
2044
|
* Update an interaction stats alert read status
|
|
2036
|
-
*
|
|
2045
|
+
* Apps should migrate to use PUT /api/v2/alerting/alerts/{alertId}.
|
|
2037
2046
|
* @param {String} alertId Alert ID
|
|
2038
2047
|
* @param {Object} body InteractionStatsAlert
|
|
2039
2048
|
* @param {Object} opts Optional parameters
|
|
2040
2049
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
2050
|
+
* @deprecated
|
|
2041
2051
|
*/
|
|
2042
2052
|
putAlertingInteractionstatsAlert(alertId, body, opts) {
|
|
2043
2053
|
opts = opts || {};
|
|
@@ -2067,11 +2077,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2067
2077
|
|
|
2068
2078
|
/**
|
|
2069
2079
|
* Update an interaction stats rule
|
|
2070
|
-
*
|
|
2080
|
+
* Apps should migrate to use PUT /api/v2/alerting/rules/{ruleId}.
|
|
2071
2081
|
* @param {String} ruleId Rule ID
|
|
2072
2082
|
* @param {Object} body AlertingRule
|
|
2073
2083
|
* @param {Object} opts Optional parameters
|
|
2074
2084
|
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
2085
|
+
* @deprecated
|
|
2075
2086
|
*/
|
|
2076
2087
|
putAlertingInteractionstatsRule(ruleId, body, opts) {
|
|
2077
2088
|
opts = opts || {};
|
|
@@ -2135,7 +2146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2135
2146
|
/**
|
|
2136
2147
|
* Analytics service.
|
|
2137
2148
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2138
|
-
* @version
|
|
2149
|
+
* @version 184.0.0
|
|
2139
2150
|
*/
|
|
2140
2151
|
|
|
2141
2152
|
/**
|
|
@@ -2283,7 +2294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2283
2294
|
|
|
2284
2295
|
/**
|
|
2285
2296
|
* Get Reporting Turns.
|
|
2286
|
-
* 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
|
|
2297
|
+
* 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.
|
|
2287
2298
|
* @param {String} botFlowId ID of the bot flow.
|
|
2288
2299
|
* @param {Object} opts Optional parameters
|
|
2289
2300
|
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
@@ -2316,6 +2327,39 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2316
2327
|
);
|
|
2317
2328
|
}
|
|
2318
2329
|
|
|
2330
|
+
/**
|
|
2331
|
+
* Get Bot Flow Sessions.
|
|
2332
|
+
* 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.
|
|
2333
|
+
* @param {String} botFlowId ID of the bot flow.
|
|
2334
|
+
* @param {Object} opts Optional parameters
|
|
2335
|
+
* @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
|
|
2336
|
+
* @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
|
|
2337
|
+
* @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
|
|
2338
|
+
* @param {Object} opts.botResultCategories Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.
|
|
2339
|
+
* @param {String} opts.endLanguage Optional case-insensitive language code to filter sessions by the language the sessions ended in.
|
|
2340
|
+
*/
|
|
2341
|
+
getAnalyticsBotflowSessions(botFlowId, opts) {
|
|
2342
|
+
opts = opts || {};
|
|
2343
|
+
|
|
2344
|
+
// verify the required parameter 'botFlowId' is set
|
|
2345
|
+
if (botFlowId === undefined || botFlowId === null) {
|
|
2346
|
+
throw 'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowSessions';
|
|
2347
|
+
}
|
|
2348
|
+
|
|
2349
|
+
return this.apiClient.callApi(
|
|
2350
|
+
'/api/v2/analytics/botflows/{botFlowId}/sessions',
|
|
2351
|
+
'GET',
|
|
2352
|
+
{ 'botFlowId': botFlowId },
|
|
2353
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'botResultCategories': opts['botResultCategories'],'endLanguage': opts['endLanguage'] },
|
|
2354
|
+
{ },
|
|
2355
|
+
{ },
|
|
2356
|
+
null,
|
|
2357
|
+
['PureCloud OAuth'],
|
|
2358
|
+
['application/json'],
|
|
2359
|
+
['application/json']
|
|
2360
|
+
);
|
|
2361
|
+
}
|
|
2362
|
+
|
|
2319
2363
|
/**
|
|
2320
2364
|
* Get status for async query for bot aggregates
|
|
2321
2365
|
*
|
|
@@ -2628,6 +2672,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2628
2672
|
);
|
|
2629
2673
|
}
|
|
2630
2674
|
|
|
2675
|
+
/**
|
|
2676
|
+
* Get status for async query for flow execution aggregates
|
|
2677
|
+
*
|
|
2678
|
+
* @param {String} jobId jobId
|
|
2679
|
+
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2680
|
+
*/
|
|
2681
|
+
getAnalyticsFlowexecutionsAggregatesJob(jobId) {
|
|
2682
|
+
// verify the required parameter 'jobId' is set
|
|
2683
|
+
if (jobId === undefined || jobId === null) {
|
|
2684
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';
|
|
2685
|
+
}
|
|
2686
|
+
|
|
2687
|
+
return this.apiClient.callApi(
|
|
2688
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}',
|
|
2689
|
+
'GET',
|
|
2690
|
+
{ 'jobId': jobId },
|
|
2691
|
+
{ },
|
|
2692
|
+
{ },
|
|
2693
|
+
{ },
|
|
2694
|
+
null,
|
|
2695
|
+
['PureCloud OAuth'],
|
|
2696
|
+
['application/json'],
|
|
2697
|
+
['application/json']
|
|
2698
|
+
);
|
|
2699
|
+
}
|
|
2700
|
+
|
|
2701
|
+
/**
|
|
2702
|
+
* Fetch a page of results for an async aggregates query
|
|
2703
|
+
*
|
|
2704
|
+
* @param {String} jobId jobId
|
|
2705
|
+
* @param {Object} opts Optional parameters
|
|
2706
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2707
|
+
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2708
|
+
*/
|
|
2709
|
+
getAnalyticsFlowexecutionsAggregatesJobResults(jobId, opts) {
|
|
2710
|
+
opts = opts || {};
|
|
2711
|
+
|
|
2712
|
+
// verify the required parameter 'jobId' is set
|
|
2713
|
+
if (jobId === undefined || jobId === null) {
|
|
2714
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJobResults';
|
|
2715
|
+
}
|
|
2716
|
+
|
|
2717
|
+
return this.apiClient.callApi(
|
|
2718
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}/results',
|
|
2719
|
+
'GET',
|
|
2720
|
+
{ 'jobId': jobId },
|
|
2721
|
+
{ 'cursor': opts['cursor'] },
|
|
2722
|
+
{ },
|
|
2723
|
+
{ },
|
|
2724
|
+
null,
|
|
2725
|
+
['PureCloud OAuth'],
|
|
2726
|
+
['application/json'],
|
|
2727
|
+
['application/json']
|
|
2728
|
+
);
|
|
2729
|
+
}
|
|
2730
|
+
|
|
2631
2731
|
/**
|
|
2632
2732
|
* Get status for async query for Flow aggregates
|
|
2633
2733
|
*
|
|
@@ -3811,6 +3911,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3811
3911
|
);
|
|
3812
3912
|
}
|
|
3813
3913
|
|
|
3914
|
+
/**
|
|
3915
|
+
* Query for flow execution aggregates asynchronously
|
|
3916
|
+
*
|
|
3917
|
+
* @param {Object} body query
|
|
3918
|
+
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3919
|
+
*/
|
|
3920
|
+
postAnalyticsFlowexecutionsAggregatesJobs(body) {
|
|
3921
|
+
// verify the required parameter 'body' is set
|
|
3922
|
+
if (body === undefined || body === null) {
|
|
3923
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';
|
|
3924
|
+
}
|
|
3925
|
+
|
|
3926
|
+
return this.apiClient.callApi(
|
|
3927
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs',
|
|
3928
|
+
'POST',
|
|
3929
|
+
{ },
|
|
3930
|
+
{ },
|
|
3931
|
+
{ },
|
|
3932
|
+
{ },
|
|
3933
|
+
body,
|
|
3934
|
+
['PureCloud OAuth'],
|
|
3935
|
+
['application/json'],
|
|
3936
|
+
['application/json']
|
|
3937
|
+
);
|
|
3938
|
+
}
|
|
3939
|
+
|
|
3940
|
+
/**
|
|
3941
|
+
* Query for flow execution aggregates
|
|
3942
|
+
*
|
|
3943
|
+
* @param {Object} body query
|
|
3944
|
+
* postAnalyticsFlowexecutionsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3945
|
+
*/
|
|
3946
|
+
postAnalyticsFlowexecutionsAggregatesQuery(body) {
|
|
3947
|
+
// verify the required parameter 'body' is set
|
|
3948
|
+
if (body === undefined || body === null) {
|
|
3949
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesQuery';
|
|
3950
|
+
}
|
|
3951
|
+
|
|
3952
|
+
return this.apiClient.callApi(
|
|
3953
|
+
'/api/v2/analytics/flowexecutions/aggregates/query',
|
|
3954
|
+
'POST',
|
|
3955
|
+
{ },
|
|
3956
|
+
{ },
|
|
3957
|
+
{ },
|
|
3958
|
+
{ },
|
|
3959
|
+
body,
|
|
3960
|
+
['PureCloud OAuth'],
|
|
3961
|
+
['application/json'],
|
|
3962
|
+
['application/json']
|
|
3963
|
+
);
|
|
3964
|
+
}
|
|
3965
|
+
|
|
3814
3966
|
/**
|
|
3815
3967
|
* Query for flow activity observations
|
|
3816
3968
|
*
|
|
@@ -4073,8 +4225,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4073
4225
|
|
|
4074
4226
|
/**
|
|
4075
4227
|
* Place a scheduled report immediately into the reporting queue
|
|
4076
|
-
*
|
|
4228
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
|
|
4077
4229
|
* @param {String} scheduleId Schedule ID
|
|
4230
|
+
* @deprecated
|
|
4078
4231
|
*/
|
|
4079
4232
|
postAnalyticsReportingScheduleRunreport(scheduleId) {
|
|
4080
4233
|
// verify the required parameter 'scheduleId' is set
|
|
@@ -4098,8 +4251,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4098
4251
|
|
|
4099
4252
|
/**
|
|
4100
4253
|
* Create a scheduled report job
|
|
4101
|
-
*
|
|
4254
|
+
* This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
|
|
4102
4255
|
* @param {Object} body ReportSchedule
|
|
4256
|
+
* @deprecated
|
|
4103
4257
|
*/
|
|
4104
4258
|
postAnalyticsReportingSchedules(body) {
|
|
4105
4259
|
// verify the required parameter 'body' is set
|
|
@@ -4547,9 +4701,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4547
4701
|
|
|
4548
4702
|
/**
|
|
4549
4703
|
* Update a scheduled report job.
|
|
4550
|
-
*
|
|
4704
|
+
* This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
|
|
4551
4705
|
* @param {String} scheduleId Schedule ID
|
|
4552
4706
|
* @param {Object} body ReportSchedule
|
|
4707
|
+
* @deprecated
|
|
4553
4708
|
*/
|
|
4554
4709
|
putAnalyticsReportingSchedule(scheduleId, body) {
|
|
4555
4710
|
// verify the required parameter 'scheduleId' is set
|
|
@@ -4581,7 +4736,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4581
4736
|
/**
|
|
4582
4737
|
* Architect service.
|
|
4583
4738
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4584
|
-
* @version
|
|
4739
|
+
* @version 184.0.0
|
|
4585
4740
|
*/
|
|
4586
4741
|
|
|
4587
4742
|
/**
|
|
@@ -8416,7 +8571,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8416
8571
|
/**
|
|
8417
8572
|
* Audit service.
|
|
8418
8573
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
8419
|
-
* @version
|
|
8574
|
+
* @version 184.0.0
|
|
8420
8575
|
*/
|
|
8421
8576
|
|
|
8422
8577
|
/**
|
|
@@ -8587,7 +8742,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8587
8742
|
/**
|
|
8588
8743
|
* Authorization service.
|
|
8589
8744
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
8590
|
-
* @version
|
|
8745
|
+
* @version 184.0.0
|
|
8591
8746
|
*/
|
|
8592
8747
|
|
|
8593
8748
|
/**
|
|
@@ -9331,17 +9486,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9331
9486
|
* Recreate a previously deleted division.
|
|
9332
9487
|
*
|
|
9333
9488
|
* @param {String} divisionId Division ID
|
|
9334
|
-
* @param {Object}
|
|
9489
|
+
* @param {Object} opts Optional parameters
|
|
9490
|
+
* @param {Object} opts.body Recreated division data
|
|
9335
9491
|
*/
|
|
9336
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
9492
|
+
postAuthorizationDivisionRestore(divisionId, opts) {
|
|
9493
|
+
opts = opts || {};
|
|
9494
|
+
|
|
9337
9495
|
// verify the required parameter 'divisionId' is set
|
|
9338
9496
|
if (divisionId === undefined || divisionId === null) {
|
|
9339
9497
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
9340
9498
|
}
|
|
9341
|
-
// verify the required parameter 'body' is set
|
|
9342
|
-
if (body === undefined || body === null) {
|
|
9343
|
-
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
9344
|
-
}
|
|
9345
9499
|
|
|
9346
9500
|
return this.apiClient.callApi(
|
|
9347
9501
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -9350,7 +9504,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9350
9504
|
{ },
|
|
9351
9505
|
{ },
|
|
9352
9506
|
{ },
|
|
9353
|
-
body,
|
|
9507
|
+
opts['body'],
|
|
9354
9508
|
['PureCloud OAuth'],
|
|
9355
9509
|
['application/json'],
|
|
9356
9510
|
['application/json']
|
|
@@ -9818,7 +9972,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9818
9972
|
/**
|
|
9819
9973
|
* Billing service.
|
|
9820
9974
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
9821
|
-
* @version
|
|
9975
|
+
* @version 184.0.0
|
|
9822
9976
|
*/
|
|
9823
9977
|
|
|
9824
9978
|
/**
|
|
@@ -9898,7 +10052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9898
10052
|
/**
|
|
9899
10053
|
* CarrierServices service.
|
|
9900
10054
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
9901
|
-
* @version
|
|
10055
|
+
* @version 184.0.0
|
|
9902
10056
|
*/
|
|
9903
10057
|
|
|
9904
10058
|
/**
|
|
@@ -9968,7 +10122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9968
10122
|
/**
|
|
9969
10123
|
* Chat service.
|
|
9970
10124
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
9971
|
-
* @version
|
|
10125
|
+
* @version 184.0.0
|
|
9972
10126
|
*/
|
|
9973
10127
|
|
|
9974
10128
|
/**
|
|
@@ -10664,7 +10818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10664
10818
|
/**
|
|
10665
10819
|
* Coaching service.
|
|
10666
10820
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
10667
|
-
* @version
|
|
10821
|
+
* @version 184.0.0
|
|
10668
10822
|
*/
|
|
10669
10823
|
|
|
10670
10824
|
/**
|
|
@@ -11241,7 +11395,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11241
11395
|
/**
|
|
11242
11396
|
* ContentManagement service.
|
|
11243
11397
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
11244
|
-
* @version
|
|
11398
|
+
* @version 184.0.0
|
|
11245
11399
|
*/
|
|
11246
11400
|
|
|
11247
11401
|
/**
|
|
@@ -12384,7 +12538,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12384
12538
|
/**
|
|
12385
12539
|
* Conversations service.
|
|
12386
12540
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
12387
|
-
* @version
|
|
12541
|
+
* @version 184.0.0
|
|
12388
12542
|
*/
|
|
12389
12543
|
|
|
12390
12544
|
/**
|
|
@@ -19524,7 +19678,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19524
19678
|
/**
|
|
19525
19679
|
* DataExtensions service.
|
|
19526
19680
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
19527
|
-
* @version
|
|
19681
|
+
* @version 184.0.0
|
|
19528
19682
|
*/
|
|
19529
19683
|
|
|
19530
19684
|
/**
|
|
@@ -19610,7 +19764,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19610
19764
|
/**
|
|
19611
19765
|
* Downloads service.
|
|
19612
19766
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
19613
|
-
* @version
|
|
19767
|
+
* @version 184.0.0
|
|
19614
19768
|
*/
|
|
19615
19769
|
|
|
19616
19770
|
/**
|
|
@@ -19662,7 +19816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19662
19816
|
/**
|
|
19663
19817
|
* Emails service.
|
|
19664
19818
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
19665
|
-
* @version
|
|
19819
|
+
* @version 184.0.0
|
|
19666
19820
|
*/
|
|
19667
19821
|
|
|
19668
19822
|
/**
|
|
@@ -19727,7 +19881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19727
19881
|
/**
|
|
19728
19882
|
* Events service.
|
|
19729
19883
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
19730
|
-
* @version
|
|
19884
|
+
* @version 184.0.0
|
|
19731
19885
|
*/
|
|
19732
19886
|
|
|
19733
19887
|
/**
|
|
@@ -19823,7 +19977,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19823
19977
|
/**
|
|
19824
19978
|
* ExternalContacts service.
|
|
19825
19979
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
19826
|
-
* @version
|
|
19980
|
+
* @version 184.0.0
|
|
19827
19981
|
*/
|
|
19828
19982
|
|
|
19829
19983
|
/**
|
|
@@ -21781,7 +21935,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21781
21935
|
/**
|
|
21782
21936
|
* Fax service.
|
|
21783
21937
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
21784
|
-
* @version
|
|
21938
|
+
* @version 184.0.0
|
|
21785
21939
|
*/
|
|
21786
21940
|
|
|
21787
21941
|
/**
|
|
@@ -21952,7 +22106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21952
22106
|
/**
|
|
21953
22107
|
* Flows service.
|
|
21954
22108
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
21955
|
-
* @version
|
|
22109
|
+
* @version 184.0.0
|
|
21956
22110
|
*/
|
|
21957
22111
|
|
|
21958
22112
|
/**
|
|
@@ -22136,7 +22290,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22136
22290
|
/**
|
|
22137
22291
|
* Gamification service.
|
|
22138
22292
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
22139
|
-
* @version
|
|
22293
|
+
* @version 184.0.0
|
|
22140
22294
|
*/
|
|
22141
22295
|
|
|
22142
22296
|
/**
|
|
@@ -24222,7 +24376,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24222
24376
|
/**
|
|
24223
24377
|
* GeneralDataProtectionRegulation service.
|
|
24224
24378
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
24225
|
-
* @version
|
|
24379
|
+
* @version 184.0.0
|
|
24226
24380
|
*/
|
|
24227
24381
|
|
|
24228
24382
|
/**
|
|
@@ -24352,7 +24506,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24352
24506
|
/**
|
|
24353
24507
|
* Geolocation service.
|
|
24354
24508
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
24355
|
-
* @version
|
|
24509
|
+
* @version 184.0.0
|
|
24356
24510
|
*/
|
|
24357
24511
|
|
|
24358
24512
|
/**
|
|
@@ -24483,7 +24637,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24483
24637
|
/**
|
|
24484
24638
|
* Greetings service.
|
|
24485
24639
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
24486
|
-
* @version
|
|
24640
|
+
* @version 184.0.0
|
|
24487
24641
|
*/
|
|
24488
24642
|
|
|
24489
24643
|
/**
|
|
@@ -24938,7 +25092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24938
25092
|
/**
|
|
24939
25093
|
* Groups service.
|
|
24940
25094
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
24941
|
-
* @version
|
|
25095
|
+
* @version 184.0.0
|
|
24942
25096
|
*/
|
|
24943
25097
|
|
|
24944
25098
|
/**
|
|
@@ -25457,7 +25611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25457
25611
|
/**
|
|
25458
25612
|
* IdentityProvider service.
|
|
25459
25613
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
25460
|
-
* @version
|
|
25614
|
+
* @version 184.0.0
|
|
25461
25615
|
*/
|
|
25462
25616
|
|
|
25463
25617
|
/**
|
|
@@ -26213,7 +26367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26213
26367
|
/**
|
|
26214
26368
|
* InfrastructureAsCode service.
|
|
26215
26369
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
26216
|
-
* @version
|
|
26370
|
+
* @version 184.0.0
|
|
26217
26371
|
*/
|
|
26218
26372
|
|
|
26219
26373
|
/**
|
|
@@ -26380,7 +26534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26380
26534
|
/**
|
|
26381
26535
|
* Integrations service.
|
|
26382
26536
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
26383
|
-
* @version
|
|
26537
|
+
* @version 184.0.0
|
|
26384
26538
|
*/
|
|
26385
26539
|
|
|
26386
26540
|
/**
|
|
@@ -27990,7 +28144,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27990
28144
|
}
|
|
27991
28145
|
|
|
27992
28146
|
/**
|
|
27993
|
-
* Create a new Action
|
|
28147
|
+
* 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.
|
|
27994
28148
|
*
|
|
27995
28149
|
* @param {Object} body Input used to create Action.
|
|
27996
28150
|
*/
|
|
@@ -28342,7 +28496,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28342
28496
|
/**
|
|
28343
28497
|
* Journey service.
|
|
28344
28498
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
28345
|
-
* @version
|
|
28499
|
+
* @version 184.0.0
|
|
28346
28500
|
*/
|
|
28347
28501
|
|
|
28348
28502
|
/**
|
|
@@ -28789,14 +28943,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28789
28943
|
*
|
|
28790
28944
|
* @param {String} deploymentId The ID of the deployment sending the ping.
|
|
28791
28945
|
* @param {String} customerCookieId ID of the customer associated with the ping.
|
|
28792
|
-
* @param {String} sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
28793
28946
|
* @param {Object} opts Optional parameters
|
|
28794
28947
|
* @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.
|
|
28795
28948
|
* @param {String} opts.dt Document Title. A human readable name for the page or screen
|
|
28796
28949
|
* @param {String} opts.appNamespace Namespace of the application (e.g. com.genesys.bancodinero). Used for domain filtering in application sessions
|
|
28950
|
+
* @param {String} opts.sessionId UUID of the customer session. Use the same Session Id for all pings, AppEvents and ActionEvents in the session
|
|
28797
28951
|
* @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.
|
|
28798
28952
|
*/
|
|
28799
|
-
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId,
|
|
28953
|
+
getJourneyDeploymentCustomerPing(deploymentId, customerCookieId, opts) {
|
|
28800
28954
|
opts = opts || {};
|
|
28801
28955
|
|
|
28802
28956
|
// verify the required parameter 'deploymentId' is set
|
|
@@ -28807,16 +28961,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28807
28961
|
if (customerCookieId === undefined || customerCookieId === null) {
|
|
28808
28962
|
throw 'Missing the required parameter "customerCookieId" when calling getJourneyDeploymentCustomerPing';
|
|
28809
28963
|
}
|
|
28810
|
-
// verify the required parameter 'sessionId' is set
|
|
28811
|
-
if (sessionId === undefined || sessionId === null) {
|
|
28812
|
-
throw 'Missing the required parameter "sessionId" when calling getJourneyDeploymentCustomerPing';
|
|
28813
|
-
}
|
|
28814
28964
|
|
|
28815
28965
|
return this.apiClient.callApi(
|
|
28816
28966
|
'/api/v2/journey/deployments/{deploymentId}/customers/{customerCookieId}/ping',
|
|
28817
28967
|
'GET',
|
|
28818
28968
|
{ 'deploymentId': deploymentId,'customerCookieId': customerCookieId },
|
|
28819
|
-
{ 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': sessionId,'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
|
|
28969
|
+
{ 'dl': opts['dl'],'dt': opts['dt'],'appNamespace': opts['appNamespace'],'sessionId': opts['sessionId'],'sinceLastBeaconMilliseconds': opts['sinceLastBeaconMilliseconds'] },
|
|
28820
28970
|
{ },
|
|
28821
28971
|
{ },
|
|
28822
28972
|
null,
|
|
@@ -29577,7 +29727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29577
29727
|
/**
|
|
29578
29728
|
* Knowledge service.
|
|
29579
29729
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
29580
|
-
* @version
|
|
29730
|
+
* @version 184.0.0
|
|
29581
29731
|
*/
|
|
29582
29732
|
|
|
29583
29733
|
/**
|
|
@@ -32398,7 +32548,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32398
32548
|
/**
|
|
32399
32549
|
* LanguageUnderstanding service.
|
|
32400
32550
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
32401
|
-
* @version
|
|
32551
|
+
* @version 184.0.0
|
|
32402
32552
|
*/
|
|
32403
32553
|
|
|
32404
32554
|
/**
|
|
@@ -33411,7 +33561,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33411
33561
|
/**
|
|
33412
33562
|
* Languages service.
|
|
33413
33563
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
33414
|
-
* @version
|
|
33564
|
+
* @version 184.0.0
|
|
33415
33565
|
*/
|
|
33416
33566
|
|
|
33417
33567
|
/**
|
|
@@ -33633,7 +33783,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33633
33783
|
/**
|
|
33634
33784
|
* Learning service.
|
|
33635
33785
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
33636
|
-
* @version
|
|
33786
|
+
* @version 184.0.0
|
|
33637
33787
|
*/
|
|
33638
33788
|
|
|
33639
33789
|
/**
|
|
@@ -33934,6 +34084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33934
34084
|
* @param {Array.<String>} opts.expand Fields to expand in response(case insensitive)
|
|
33935
34085
|
* @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)
|
|
33936
34086
|
* @param {Array.<String>} opts.statuses Specifies the module statuses to filter by
|
|
34087
|
+
* @param {Array.<String>} opts.externalIds Specifies the module external IDs to filter by. Only one ID is allowed
|
|
33937
34088
|
*/
|
|
33938
34089
|
getLearningModules(opts) {
|
|
33939
34090
|
opts = opts || {};
|
|
@@ -33943,7 +34094,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33943
34094
|
'/api/v2/learning/modules',
|
|
33944
34095
|
'GET',
|
|
33945
34096
|
{ },
|
|
33946
|
-
{ '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') },
|
|
34097
|
+
{ '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') },
|
|
33947
34098
|
{ },
|
|
33948
34099
|
{ },
|
|
33949
34100
|
null,
|
|
@@ -34070,6 +34221,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34070
34221
|
);
|
|
34071
34222
|
}
|
|
34072
34223
|
|
|
34224
|
+
/**
|
|
34225
|
+
* Update an external assignment for a specific user
|
|
34226
|
+
*
|
|
34227
|
+
* @param {String} moduleId Key identifier for the module
|
|
34228
|
+
* @param {String} userId Key identifier for the user
|
|
34229
|
+
* @param {Object} body The learning request for updating the assignment
|
|
34230
|
+
* patchLearningModuleUserAssignments is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
34231
|
+
*/
|
|
34232
|
+
patchLearningModuleUserAssignments(moduleId, userId, body) {
|
|
34233
|
+
// verify the required parameter 'moduleId' is set
|
|
34234
|
+
if (moduleId === undefined || moduleId === null) {
|
|
34235
|
+
throw 'Missing the required parameter "moduleId" when calling patchLearningModuleUserAssignments';
|
|
34236
|
+
}
|
|
34237
|
+
// verify the required parameter 'userId' is set
|
|
34238
|
+
if (userId === undefined || userId === null) {
|
|
34239
|
+
throw 'Missing the required parameter "userId" when calling patchLearningModuleUserAssignments';
|
|
34240
|
+
}
|
|
34241
|
+
// verify the required parameter 'body' is set
|
|
34242
|
+
if (body === undefined || body === null) {
|
|
34243
|
+
throw 'Missing the required parameter "body" when calling patchLearningModuleUserAssignments';
|
|
34244
|
+
}
|
|
34245
|
+
|
|
34246
|
+
return this.apiClient.callApi(
|
|
34247
|
+
'/api/v2/learning/modules/{moduleId}/users/{userId}/assignments',
|
|
34248
|
+
'PATCH',
|
|
34249
|
+
{ 'moduleId': moduleId,'userId': userId },
|
|
34250
|
+
{ },
|
|
34251
|
+
{ },
|
|
34252
|
+
{ },
|
|
34253
|
+
body,
|
|
34254
|
+
['PureCloud OAuth'],
|
|
34255
|
+
['application/json'],
|
|
34256
|
+
['application/json']
|
|
34257
|
+
);
|
|
34258
|
+
}
|
|
34259
|
+
|
|
34073
34260
|
/**
|
|
34074
34261
|
* Score learning assessment for preview
|
|
34075
34262
|
*
|
|
@@ -34452,7 +34639,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34452
34639
|
/**
|
|
34453
34640
|
* License service.
|
|
34454
34641
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
34455
|
-
* @version
|
|
34642
|
+
* @version 184.0.0
|
|
34456
34643
|
*/
|
|
34457
34644
|
|
|
34458
34645
|
/**
|
|
@@ -34690,7 +34877,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34690
34877
|
/**
|
|
34691
34878
|
* Locations service.
|
|
34692
34879
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
34693
|
-
* @version
|
|
34880
|
+
* @version 184.0.0
|
|
34694
34881
|
*/
|
|
34695
34882
|
|
|
34696
34883
|
/**
|
|
@@ -34922,11 +35109,81 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34922
35109
|
|
|
34923
35110
|
}
|
|
34924
35111
|
|
|
35112
|
+
class LogCaptureApi {
|
|
35113
|
+
/**
|
|
35114
|
+
* LogCapture service.
|
|
35115
|
+
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
35116
|
+
* @version 184.0.0
|
|
35117
|
+
*/
|
|
35118
|
+
|
|
35119
|
+
/**
|
|
35120
|
+
* Constructs a new LogCaptureApi.
|
|
35121
|
+
* @alias module:purecloud-platform-client-v2/api/LogCaptureApi
|
|
35122
|
+
* @class
|
|
35123
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
35124
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
35125
|
+
*/
|
|
35126
|
+
constructor(apiClient) {
|
|
35127
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
35128
|
+
}
|
|
35129
|
+
|
|
35130
|
+
|
|
35131
|
+
/**
|
|
35132
|
+
* Gets status of async download execution
|
|
35133
|
+
*
|
|
35134
|
+
* @param {String} jobId Job ID
|
|
35135
|
+
*/
|
|
35136
|
+
getDiagnosticsLogcaptureBrowserEntriesDownloadJob(jobId) {
|
|
35137
|
+
// verify the required parameter 'jobId' is set
|
|
35138
|
+
if (jobId === undefined || jobId === null) {
|
|
35139
|
+
throw 'Missing the required parameter "jobId" when calling getDiagnosticsLogcaptureBrowserEntriesDownloadJob';
|
|
35140
|
+
}
|
|
35141
|
+
|
|
35142
|
+
return this.apiClient.callApi(
|
|
35143
|
+
'/api/v2/diagnostics/logcapture/browser/entries/download/jobs/{jobId}',
|
|
35144
|
+
'GET',
|
|
35145
|
+
{ 'jobId': jobId },
|
|
35146
|
+
{ },
|
|
35147
|
+
{ },
|
|
35148
|
+
{ },
|
|
35149
|
+
null,
|
|
35150
|
+
['PureCloud OAuth'],
|
|
35151
|
+
['application/json'],
|
|
35152
|
+
['application/json']
|
|
35153
|
+
);
|
|
35154
|
+
}
|
|
35155
|
+
|
|
35156
|
+
/**
|
|
35157
|
+
* Creates an async download execution
|
|
35158
|
+
*
|
|
35159
|
+
* @param {Object} opts Optional parameters
|
|
35160
|
+
* @param {Object} opts.body
|
|
35161
|
+
*/
|
|
35162
|
+
postDiagnosticsLogcaptureBrowserEntriesDownloadJobs(opts) {
|
|
35163
|
+
opts = opts || {};
|
|
35164
|
+
|
|
35165
|
+
|
|
35166
|
+
return this.apiClient.callApi(
|
|
35167
|
+
'/api/v2/diagnostics/logcapture/browser/entries/download/jobs',
|
|
35168
|
+
'POST',
|
|
35169
|
+
{ },
|
|
35170
|
+
{ },
|
|
35171
|
+
{ },
|
|
35172
|
+
{ },
|
|
35173
|
+
opts['body'],
|
|
35174
|
+
['PureCloud OAuth'],
|
|
35175
|
+
['application/json'],
|
|
35176
|
+
['application/json']
|
|
35177
|
+
);
|
|
35178
|
+
}
|
|
35179
|
+
|
|
35180
|
+
}
|
|
35181
|
+
|
|
34925
35182
|
class MessagingApi {
|
|
34926
35183
|
/**
|
|
34927
35184
|
* Messaging service.
|
|
34928
35185
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
34929
|
-
* @version
|
|
35186
|
+
* @version 184.0.0
|
|
34930
35187
|
*/
|
|
34931
35188
|
|
|
34932
35189
|
/**
|
|
@@ -35285,7 +35542,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35285
35542
|
/**
|
|
35286
35543
|
* MobileDevices service.
|
|
35287
35544
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
35288
|
-
* @version
|
|
35545
|
+
* @version 184.0.0
|
|
35289
35546
|
*/
|
|
35290
35547
|
|
|
35291
35548
|
/**
|
|
@@ -35436,7 +35693,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35436
35693
|
/**
|
|
35437
35694
|
* Notifications service.
|
|
35438
35695
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
35439
|
-
* @version
|
|
35696
|
+
* @version 184.0.0
|
|
35440
35697
|
*/
|
|
35441
35698
|
|
|
35442
35699
|
/**
|
|
@@ -35669,7 +35926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35669
35926
|
/**
|
|
35670
35927
|
* OAuth service.
|
|
35671
35928
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
35672
|
-
* @version
|
|
35929
|
+
* @version 184.0.0
|
|
35673
35930
|
*/
|
|
35674
35931
|
|
|
35675
35932
|
/**
|
|
@@ -36035,7 +36292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36035
36292
|
/**
|
|
36036
36293
|
* Objects service.
|
|
36037
36294
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
36038
|
-
* @version
|
|
36295
|
+
* @version 184.0.0
|
|
36039
36296
|
*/
|
|
36040
36297
|
|
|
36041
36298
|
/**
|
|
@@ -36219,17 +36476,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36219
36476
|
* Recreate a previously deleted division.
|
|
36220
36477
|
*
|
|
36221
36478
|
* @param {String} divisionId Division ID
|
|
36222
|
-
* @param {Object}
|
|
36479
|
+
* @param {Object} opts Optional parameters
|
|
36480
|
+
* @param {Object} opts.body Recreated division data
|
|
36223
36481
|
*/
|
|
36224
|
-
postAuthorizationDivisionRestore(divisionId,
|
|
36482
|
+
postAuthorizationDivisionRestore(divisionId, opts) {
|
|
36483
|
+
opts = opts || {};
|
|
36484
|
+
|
|
36225
36485
|
// verify the required parameter 'divisionId' is set
|
|
36226
36486
|
if (divisionId === undefined || divisionId === null) {
|
|
36227
36487
|
throw 'Missing the required parameter "divisionId" when calling postAuthorizationDivisionRestore';
|
|
36228
36488
|
}
|
|
36229
|
-
// verify the required parameter 'body' is set
|
|
36230
|
-
if (body === undefined || body === null) {
|
|
36231
|
-
throw 'Missing the required parameter "body" when calling postAuthorizationDivisionRestore';
|
|
36232
|
-
}
|
|
36233
36489
|
|
|
36234
36490
|
return this.apiClient.callApi(
|
|
36235
36491
|
'/api/v2/authorization/divisions/{divisionId}/restore',
|
|
@@ -36238,7 +36494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36238
36494
|
{ },
|
|
36239
36495
|
{ },
|
|
36240
36496
|
{ },
|
|
36241
|
-
body,
|
|
36497
|
+
opts['body'],
|
|
36242
36498
|
['PureCloud OAuth'],
|
|
36243
36499
|
['application/json'],
|
|
36244
36500
|
['application/json']
|
|
@@ -36306,7 +36562,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36306
36562
|
/**
|
|
36307
36563
|
* OperationalEvents service.
|
|
36308
36564
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
36309
|
-
* @version
|
|
36565
|
+
* @version 184.0.0
|
|
36310
36566
|
*/
|
|
36311
36567
|
|
|
36312
36568
|
/**
|
|
@@ -36372,7 +36628,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36372
36628
|
/**
|
|
36373
36629
|
* Organization service.
|
|
36374
36630
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
36375
|
-
* @version
|
|
36631
|
+
* @version 184.0.0
|
|
36376
36632
|
*/
|
|
36377
36633
|
|
|
36378
36634
|
/**
|
|
@@ -36827,7 +37083,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36827
37083
|
/**
|
|
36828
37084
|
* OrganizationAuthorization service.
|
|
36829
37085
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
36830
|
-
* @version
|
|
37086
|
+
* @version 184.0.0
|
|
36831
37087
|
*/
|
|
36832
37088
|
|
|
36833
37089
|
/**
|
|
@@ -38174,7 +38430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38174
38430
|
/**
|
|
38175
38431
|
* Outbound service.
|
|
38176
38432
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
38177
|
-
* @version
|
|
38433
|
+
* @version 184.0.0
|
|
38178
38434
|
*/
|
|
38179
38435
|
|
|
38180
38436
|
/**
|
|
@@ -38474,6 +38730,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38474
38730
|
);
|
|
38475
38731
|
}
|
|
38476
38732
|
|
|
38733
|
+
/**
|
|
38734
|
+
* Delete Contact List Template
|
|
38735
|
+
*
|
|
38736
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
38737
|
+
*/
|
|
38738
|
+
deleteOutboundContactlisttemplate(contactListTemplateId) {
|
|
38739
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
38740
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
38741
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling deleteOutboundContactlisttemplate';
|
|
38742
|
+
}
|
|
38743
|
+
|
|
38744
|
+
return this.apiClient.callApi(
|
|
38745
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
38746
|
+
'DELETE',
|
|
38747
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
38748
|
+
{ },
|
|
38749
|
+
{ },
|
|
38750
|
+
{ },
|
|
38751
|
+
null,
|
|
38752
|
+
['PureCloud OAuth'],
|
|
38753
|
+
['application/json'],
|
|
38754
|
+
['application/json']
|
|
38755
|
+
);
|
|
38756
|
+
}
|
|
38757
|
+
|
|
38758
|
+
/**
|
|
38759
|
+
* Delete multiple contact list templates.
|
|
38760
|
+
*
|
|
38761
|
+
* @param {Array.<String>} id contact list template id(s) to delete
|
|
38762
|
+
*/
|
|
38763
|
+
deleteOutboundContactlisttemplates(id) {
|
|
38764
|
+
// verify the required parameter 'id' is set
|
|
38765
|
+
if (id === undefined || id === null) {
|
|
38766
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundContactlisttemplates';
|
|
38767
|
+
}
|
|
38768
|
+
|
|
38769
|
+
return this.apiClient.callApi(
|
|
38770
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
38771
|
+
'DELETE',
|
|
38772
|
+
{ },
|
|
38773
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
38774
|
+
{ },
|
|
38775
|
+
{ },
|
|
38776
|
+
null,
|
|
38777
|
+
['PureCloud OAuth'],
|
|
38778
|
+
['application/json'],
|
|
38779
|
+
['application/json']
|
|
38780
|
+
);
|
|
38781
|
+
}
|
|
38782
|
+
|
|
38477
38783
|
/**
|
|
38478
38784
|
* Delete an Outbound Digital Rule Set
|
|
38479
38785
|
*
|
|
@@ -38611,6 +38917,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38611
38917
|
);
|
|
38612
38918
|
}
|
|
38613
38919
|
|
|
38920
|
+
/**
|
|
38921
|
+
* Delete Import Template
|
|
38922
|
+
*
|
|
38923
|
+
* @param {String} importTemplateId Import Template ID
|
|
38924
|
+
*/
|
|
38925
|
+
deleteOutboundImporttemplate(importTemplateId) {
|
|
38926
|
+
// verify the required parameter 'importTemplateId' is set
|
|
38927
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
38928
|
+
throw 'Missing the required parameter "importTemplateId" when calling deleteOutboundImporttemplate';
|
|
38929
|
+
}
|
|
38930
|
+
|
|
38931
|
+
return this.apiClient.callApi(
|
|
38932
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
38933
|
+
'DELETE',
|
|
38934
|
+
{ 'importTemplateId': importTemplateId },
|
|
38935
|
+
{ },
|
|
38936
|
+
{ },
|
|
38937
|
+
{ },
|
|
38938
|
+
null,
|
|
38939
|
+
['PureCloud OAuth'],
|
|
38940
|
+
['application/json'],
|
|
38941
|
+
['application/json']
|
|
38942
|
+
);
|
|
38943
|
+
}
|
|
38944
|
+
|
|
38945
|
+
/**
|
|
38946
|
+
* Delete multiple import templates.
|
|
38947
|
+
*
|
|
38948
|
+
* @param {Array.<String>} id import template id(s) to delete
|
|
38949
|
+
*/
|
|
38950
|
+
deleteOutboundImporttemplates(id) {
|
|
38951
|
+
// verify the required parameter 'id' is set
|
|
38952
|
+
if (id === undefined || id === null) {
|
|
38953
|
+
throw 'Missing the required parameter "id" when calling deleteOutboundImporttemplates';
|
|
38954
|
+
}
|
|
38955
|
+
|
|
38956
|
+
return this.apiClient.callApi(
|
|
38957
|
+
'/api/v2/outbound/importtemplates',
|
|
38958
|
+
'DELETE',
|
|
38959
|
+
{ },
|
|
38960
|
+
{ 'id': this.apiClient.buildCollectionParam(id, 'multi') },
|
|
38961
|
+
{ },
|
|
38962
|
+
{ },
|
|
38963
|
+
null,
|
|
38964
|
+
['PureCloud OAuth'],
|
|
38965
|
+
['application/json'],
|
|
38966
|
+
['application/json']
|
|
38967
|
+
);
|
|
38968
|
+
}
|
|
38969
|
+
|
|
38614
38970
|
/**
|
|
38615
38971
|
* Delete an Outbound Messaging Campaign
|
|
38616
38972
|
*
|
|
@@ -39623,6 +39979,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39623
39979
|
);
|
|
39624
39980
|
}
|
|
39625
39981
|
|
|
39982
|
+
/**
|
|
39983
|
+
* Get Contact List Template
|
|
39984
|
+
*
|
|
39985
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
39986
|
+
*/
|
|
39987
|
+
getOutboundContactlisttemplate(contactListTemplateId) {
|
|
39988
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
39989
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
39990
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling getOutboundContactlisttemplate';
|
|
39991
|
+
}
|
|
39992
|
+
|
|
39993
|
+
return this.apiClient.callApi(
|
|
39994
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
39995
|
+
'GET',
|
|
39996
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
39997
|
+
{ },
|
|
39998
|
+
{ },
|
|
39999
|
+
{ },
|
|
40000
|
+
null,
|
|
40001
|
+
['PureCloud OAuth'],
|
|
40002
|
+
['application/json'],
|
|
40003
|
+
['application/json']
|
|
40004
|
+
);
|
|
40005
|
+
}
|
|
40006
|
+
|
|
40007
|
+
/**
|
|
40008
|
+
* Query a list of contact list templates
|
|
40009
|
+
*
|
|
40010
|
+
* @param {Object} opts Optional parameters
|
|
40011
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
40012
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40013
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
40014
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
40015
|
+
* @param {String} opts.name Name
|
|
40016
|
+
* @param {String} opts.sortBy Sort by
|
|
40017
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
40018
|
+
*/
|
|
40019
|
+
getOutboundContactlisttemplates(opts) {
|
|
40020
|
+
opts = opts || {};
|
|
40021
|
+
|
|
40022
|
+
|
|
40023
|
+
return this.apiClient.callApi(
|
|
40024
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
40025
|
+
'GET',
|
|
40026
|
+
{ },
|
|
40027
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'] },
|
|
40028
|
+
{ },
|
|
40029
|
+
{ },
|
|
40030
|
+
null,
|
|
40031
|
+
['PureCloud OAuth'],
|
|
40032
|
+
['application/json'],
|
|
40033
|
+
['application/json']
|
|
40034
|
+
);
|
|
40035
|
+
}
|
|
40036
|
+
|
|
39626
40037
|
/**
|
|
39627
40038
|
* Get an Outbound Digital Rule Set
|
|
39628
40039
|
*
|
|
@@ -39913,6 +40324,91 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39913
40324
|
);
|
|
39914
40325
|
}
|
|
39915
40326
|
|
|
40327
|
+
/**
|
|
40328
|
+
* Get Import Template
|
|
40329
|
+
*
|
|
40330
|
+
* @param {String} importTemplateId Import Template ID
|
|
40331
|
+
*/
|
|
40332
|
+
getOutboundImporttemplate(importTemplateId) {
|
|
40333
|
+
// verify the required parameter 'importTemplateId' is set
|
|
40334
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
40335
|
+
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplate';
|
|
40336
|
+
}
|
|
40337
|
+
|
|
40338
|
+
return this.apiClient.callApi(
|
|
40339
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
40340
|
+
'GET',
|
|
40341
|
+
{ 'importTemplateId': importTemplateId },
|
|
40342
|
+
{ },
|
|
40343
|
+
{ },
|
|
40344
|
+
{ },
|
|
40345
|
+
null,
|
|
40346
|
+
['PureCloud OAuth'],
|
|
40347
|
+
['application/json'],
|
|
40348
|
+
['application/json']
|
|
40349
|
+
);
|
|
40350
|
+
}
|
|
40351
|
+
|
|
40352
|
+
/**
|
|
40353
|
+
* Get the import status for an import template.
|
|
40354
|
+
*
|
|
40355
|
+
* @param {String} importTemplateId importTemplateId
|
|
40356
|
+
* @param {Object} opts Optional parameters
|
|
40357
|
+
* @param {String} opts.listNamePrefix listNamePrefix
|
|
40358
|
+
*/
|
|
40359
|
+
getOutboundImporttemplateImportstatus(importTemplateId, opts) {
|
|
40360
|
+
opts = opts || {};
|
|
40361
|
+
|
|
40362
|
+
// verify the required parameter 'importTemplateId' is set
|
|
40363
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
40364
|
+
throw 'Missing the required parameter "importTemplateId" when calling getOutboundImporttemplateImportstatus';
|
|
40365
|
+
}
|
|
40366
|
+
|
|
40367
|
+
return this.apiClient.callApi(
|
|
40368
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}/importstatus',
|
|
40369
|
+
'GET',
|
|
40370
|
+
{ 'importTemplateId': importTemplateId },
|
|
40371
|
+
{ 'listNamePrefix': opts['listNamePrefix'] },
|
|
40372
|
+
{ },
|
|
40373
|
+
{ },
|
|
40374
|
+
null,
|
|
40375
|
+
['PureCloud OAuth'],
|
|
40376
|
+
['application/json'],
|
|
40377
|
+
['application/json']
|
|
40378
|
+
);
|
|
40379
|
+
}
|
|
40380
|
+
|
|
40381
|
+
/**
|
|
40382
|
+
* Query Import Templates
|
|
40383
|
+
*
|
|
40384
|
+
* @param {Object} opts Optional parameters
|
|
40385
|
+
* @param {Number} opts.pageSize Page size. The max that will be returned is 100. (default to 25)
|
|
40386
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
40387
|
+
* @param {Boolean} opts.allowEmptyResult Whether to return an empty page when there are no results for that page (default to false)
|
|
40388
|
+
* @param {Object} opts.filterType Filter type (default to Prefix)
|
|
40389
|
+
* @param {String} opts.name Name
|
|
40390
|
+
* @param {String} opts.sortBy Sort by
|
|
40391
|
+
* @param {Object} opts.sortOrder Sort order (default to a)
|
|
40392
|
+
* @param {String} opts.contactListTemplateId Contact List Template ID
|
|
40393
|
+
*/
|
|
40394
|
+
getOutboundImporttemplates(opts) {
|
|
40395
|
+
opts = opts || {};
|
|
40396
|
+
|
|
40397
|
+
|
|
40398
|
+
return this.apiClient.callApi(
|
|
40399
|
+
'/api/v2/outbound/importtemplates',
|
|
40400
|
+
'GET',
|
|
40401
|
+
{ },
|
|
40402
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'allowEmptyResult': opts['allowEmptyResult'],'filterType': opts['filterType'],'name': opts['name'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'contactListTemplateId': opts['contactListTemplateId'] },
|
|
40403
|
+
{ },
|
|
40404
|
+
{ },
|
|
40405
|
+
null,
|
|
40406
|
+
['PureCloud OAuth'],
|
|
40407
|
+
['application/json'],
|
|
40408
|
+
['application/json']
|
|
40409
|
+
);
|
|
40410
|
+
}
|
|
40411
|
+
|
|
39916
40412
|
/**
|
|
39917
40413
|
* Get an Outbound Messaging Campaign
|
|
39918
40414
|
*
|
|
@@ -40951,6 +41447,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40951
41447
|
);
|
|
40952
41448
|
}
|
|
40953
41449
|
|
|
41450
|
+
/**
|
|
41451
|
+
* Create Contact List Template
|
|
41452
|
+
*
|
|
41453
|
+
* @param {Object} body ContactListTemplate
|
|
41454
|
+
*/
|
|
41455
|
+
postOutboundContactlisttemplates(body) {
|
|
41456
|
+
// verify the required parameter 'body' is set
|
|
41457
|
+
if (body === undefined || body === null) {
|
|
41458
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplates';
|
|
41459
|
+
}
|
|
41460
|
+
|
|
41461
|
+
return this.apiClient.callApi(
|
|
41462
|
+
'/api/v2/outbound/contactlisttemplates',
|
|
41463
|
+
'POST',
|
|
41464
|
+
{ },
|
|
41465
|
+
{ },
|
|
41466
|
+
{ },
|
|
41467
|
+
{ },
|
|
41468
|
+
body,
|
|
41469
|
+
['PureCloud OAuth'],
|
|
41470
|
+
['application/json'],
|
|
41471
|
+
['application/json']
|
|
41472
|
+
);
|
|
41473
|
+
}
|
|
41474
|
+
|
|
41475
|
+
/**
|
|
41476
|
+
* Add multiple contact list templates
|
|
41477
|
+
*
|
|
41478
|
+
* @param {Array.<Object>} body contact list template(s) to add
|
|
41479
|
+
*/
|
|
41480
|
+
postOutboundContactlisttemplatesBulkAdd(body) {
|
|
41481
|
+
// verify the required parameter 'body' is set
|
|
41482
|
+
if (body === undefined || body === null) {
|
|
41483
|
+
throw 'Missing the required parameter "body" when calling postOutboundContactlisttemplatesBulkAdd';
|
|
41484
|
+
}
|
|
41485
|
+
|
|
41486
|
+
return this.apiClient.callApi(
|
|
41487
|
+
'/api/v2/outbound/contactlisttemplates/bulk/add',
|
|
41488
|
+
'POST',
|
|
41489
|
+
{ },
|
|
41490
|
+
{ },
|
|
41491
|
+
{ },
|
|
41492
|
+
{ },
|
|
41493
|
+
body,
|
|
41494
|
+
['PureCloud OAuth'],
|
|
41495
|
+
['application/json'],
|
|
41496
|
+
['application/json']
|
|
41497
|
+
);
|
|
41498
|
+
}
|
|
41499
|
+
|
|
40954
41500
|
/**
|
|
40955
41501
|
* Add phone numbers to a Dialer DNC list.
|
|
40956
41502
|
*
|
|
@@ -41115,6 +41661,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41115
41661
|
);
|
|
41116
41662
|
}
|
|
41117
41663
|
|
|
41664
|
+
/**
|
|
41665
|
+
* Create Import Template
|
|
41666
|
+
*
|
|
41667
|
+
* @param {Object} body ImportTemplate
|
|
41668
|
+
*/
|
|
41669
|
+
postOutboundImporttemplates(body) {
|
|
41670
|
+
// verify the required parameter 'body' is set
|
|
41671
|
+
if (body === undefined || body === null) {
|
|
41672
|
+
throw 'Missing the required parameter "body" when calling postOutboundImporttemplates';
|
|
41673
|
+
}
|
|
41674
|
+
|
|
41675
|
+
return this.apiClient.callApi(
|
|
41676
|
+
'/api/v2/outbound/importtemplates',
|
|
41677
|
+
'POST',
|
|
41678
|
+
{ },
|
|
41679
|
+
{ },
|
|
41680
|
+
{ },
|
|
41681
|
+
{ },
|
|
41682
|
+
body,
|
|
41683
|
+
['PureCloud OAuth'],
|
|
41684
|
+
['application/json'],
|
|
41685
|
+
['application/json']
|
|
41686
|
+
);
|
|
41687
|
+
}
|
|
41688
|
+
|
|
41689
|
+
/**
|
|
41690
|
+
* Add multiple import templates
|
|
41691
|
+
*
|
|
41692
|
+
* @param {Array.<Object>} body import template(s) to add
|
|
41693
|
+
*/
|
|
41694
|
+
postOutboundImporttemplatesBulkAdd(body) {
|
|
41695
|
+
// verify the required parameter 'body' is set
|
|
41696
|
+
if (body === undefined || body === null) {
|
|
41697
|
+
throw 'Missing the required parameter "body" when calling postOutboundImporttemplatesBulkAdd';
|
|
41698
|
+
}
|
|
41699
|
+
|
|
41700
|
+
return this.apiClient.callApi(
|
|
41701
|
+
'/api/v2/outbound/importtemplates/bulk/add',
|
|
41702
|
+
'POST',
|
|
41703
|
+
{ },
|
|
41704
|
+
{ },
|
|
41705
|
+
{ },
|
|
41706
|
+
{ },
|
|
41707
|
+
body,
|
|
41708
|
+
['PureCloud OAuth'],
|
|
41709
|
+
['application/json'],
|
|
41710
|
+
['application/json']
|
|
41711
|
+
);
|
|
41712
|
+
}
|
|
41713
|
+
|
|
41118
41714
|
/**
|
|
41119
41715
|
* Create a Messaging Campaign
|
|
41120
41716
|
*
|
|
@@ -41495,6 +42091,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41495
42091
|
);
|
|
41496
42092
|
}
|
|
41497
42093
|
|
|
42094
|
+
/**
|
|
42095
|
+
* Update a contact list template.
|
|
42096
|
+
*
|
|
42097
|
+
* @param {String} contactListTemplateId ContactListTemplate ID
|
|
42098
|
+
* @param {Object} body ContactListTemplate
|
|
42099
|
+
*/
|
|
42100
|
+
putOutboundContactlisttemplate(contactListTemplateId, body) {
|
|
42101
|
+
// verify the required parameter 'contactListTemplateId' is set
|
|
42102
|
+
if (contactListTemplateId === undefined || contactListTemplateId === null) {
|
|
42103
|
+
throw 'Missing the required parameter "contactListTemplateId" when calling putOutboundContactlisttemplate';
|
|
42104
|
+
}
|
|
42105
|
+
// verify the required parameter 'body' is set
|
|
42106
|
+
if (body === undefined || body === null) {
|
|
42107
|
+
throw 'Missing the required parameter "body" when calling putOutboundContactlisttemplate';
|
|
42108
|
+
}
|
|
42109
|
+
|
|
42110
|
+
return this.apiClient.callApi(
|
|
42111
|
+
'/api/v2/outbound/contactlisttemplates/{contactListTemplateId}',
|
|
42112
|
+
'PUT',
|
|
42113
|
+
{ 'contactListTemplateId': contactListTemplateId },
|
|
42114
|
+
{ },
|
|
42115
|
+
{ },
|
|
42116
|
+
{ },
|
|
42117
|
+
body,
|
|
42118
|
+
['PureCloud OAuth'],
|
|
42119
|
+
['application/json'],
|
|
42120
|
+
['application/json']
|
|
42121
|
+
);
|
|
42122
|
+
}
|
|
42123
|
+
|
|
41498
42124
|
/**
|
|
41499
42125
|
* Update an Outbound Digital Rule Set
|
|
41500
42126
|
*
|
|
@@ -41555,6 +42181,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41555
42181
|
);
|
|
41556
42182
|
}
|
|
41557
42183
|
|
|
42184
|
+
/**
|
|
42185
|
+
* Update Import Template
|
|
42186
|
+
*
|
|
42187
|
+
* @param {String} importTemplateId Import Template ID
|
|
42188
|
+
* @param {Object} body importTemplate
|
|
42189
|
+
*/
|
|
42190
|
+
putOutboundImporttemplate(importTemplateId, body) {
|
|
42191
|
+
// verify the required parameter 'importTemplateId' is set
|
|
42192
|
+
if (importTemplateId === undefined || importTemplateId === null) {
|
|
42193
|
+
throw 'Missing the required parameter "importTemplateId" when calling putOutboundImporttemplate';
|
|
42194
|
+
}
|
|
42195
|
+
// verify the required parameter 'body' is set
|
|
42196
|
+
if (body === undefined || body === null) {
|
|
42197
|
+
throw 'Missing the required parameter "body" when calling putOutboundImporttemplate';
|
|
42198
|
+
}
|
|
42199
|
+
|
|
42200
|
+
return this.apiClient.callApi(
|
|
42201
|
+
'/api/v2/outbound/importtemplates/{importTemplateId}',
|
|
42202
|
+
'PUT',
|
|
42203
|
+
{ 'importTemplateId': importTemplateId },
|
|
42204
|
+
{ },
|
|
42205
|
+
{ },
|
|
42206
|
+
{ },
|
|
42207
|
+
body,
|
|
42208
|
+
['PureCloud OAuth'],
|
|
42209
|
+
['application/json'],
|
|
42210
|
+
['application/json']
|
|
42211
|
+
);
|
|
42212
|
+
}
|
|
42213
|
+
|
|
41558
42214
|
/**
|
|
41559
42215
|
* Update an Outbound Messaging Campaign
|
|
41560
42216
|
*
|
|
@@ -41796,7 +42452,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41796
42452
|
/**
|
|
41797
42453
|
* Presence service.
|
|
41798
42454
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
41799
|
-
* @version
|
|
42455
|
+
* @version 184.0.0
|
|
41800
42456
|
*/
|
|
41801
42457
|
|
|
41802
42458
|
/**
|
|
@@ -41815,7 +42471,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41815
42471
|
* Delete a Presence Definition
|
|
41816
42472
|
*
|
|
41817
42473
|
* @param {String} definitionId Presence Definition ID
|
|
41818
|
-
* deletePresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
41819
42474
|
*/
|
|
41820
42475
|
deletePresenceDefinition0(definitionId) {
|
|
41821
42476
|
// verify the required parameter 'definitionId' is set
|
|
@@ -41893,7 +42548,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41893
42548
|
* @param {String} definitionId Presence Definition ID
|
|
41894
42549
|
* @param {Object} opts Optional parameters
|
|
41895
42550
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
41896
|
-
* getPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
41897
42551
|
*/
|
|
41898
42552
|
getPresenceDefinition0(definitionId, opts) {
|
|
41899
42553
|
opts = opts || {};
|
|
@@ -41924,7 +42578,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41924
42578
|
* @param {String} opts.deactivated Deactivated query can be TRUE or FALSE (default to false)
|
|
41925
42579
|
* @param {Array.<String>} opts.divisionId One or more division IDs. If nothing is provided, the definitions associated withthe list of divisions that the user has access to will be returned.
|
|
41926
42580
|
* @param {Object} opts.localeCode The locale code to fetch for the presence definition. Use ALL to fetch everything.
|
|
41927
|
-
* getPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
41928
42581
|
*/
|
|
41929
42582
|
getPresenceDefinitions0(opts) {
|
|
41930
42583
|
opts = opts || {};
|
|
@@ -42291,7 +42944,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42291
42944
|
* Create a Presence Definition
|
|
42292
42945
|
*
|
|
42293
42946
|
* @param {Object} body The Presence Definition to create
|
|
42294
|
-
* postPresenceDefinitions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
42295
42947
|
*/
|
|
42296
42948
|
postPresenceDefinitions0(body) {
|
|
42297
42949
|
// verify the required parameter 'body' is set
|
|
@@ -42368,7 +43020,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42368
43020
|
*
|
|
42369
43021
|
* @param {String} definitionId Presence Definition ID
|
|
42370
43022
|
* @param {Object} body The updated Presence Definition
|
|
42371
|
-
* putPresenceDefinition is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
42372
43023
|
*/
|
|
42373
43024
|
putPresenceDefinition0(definitionId, body) {
|
|
42374
43025
|
// verify the required parameter 'definitionId' is set
|
|
@@ -42540,7 +43191,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42540
43191
|
/**
|
|
42541
43192
|
* ProcessAutomation service.
|
|
42542
43193
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
42543
|
-
* @version
|
|
43194
|
+
* @version 184.0.0
|
|
42544
43195
|
*/
|
|
42545
43196
|
|
|
42546
43197
|
/**
|
|
@@ -42779,7 +43430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42779
43430
|
/**
|
|
42780
43431
|
* Quality service.
|
|
42781
43432
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
42782
|
-
* @version
|
|
43433
|
+
* @version 184.0.0
|
|
42783
43434
|
*/
|
|
42784
43435
|
|
|
42785
43436
|
/**
|
|
@@ -43062,6 +43713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43062
43713
|
* @param {String} opts.evaluatorUserId user id of the evaluator
|
|
43063
43714
|
* @param {String} opts.name name
|
|
43064
43715
|
* @param {String} opts.group group id
|
|
43716
|
+
* @param {String} opts.agentTeamId team id of agents requested
|
|
43065
43717
|
* @param {String} opts.formContextId shared id between form versions
|
|
43066
43718
|
*/
|
|
43067
43719
|
getQualityAgentsActivity(opts) {
|
|
@@ -43072,7 +43724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43072
43724
|
'/api/v2/quality/agents/activity',
|
|
43073
43725
|
'GET',
|
|
43074
43726
|
{ },
|
|
43075
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'formContextId': opts['formContextId'] },
|
|
43727
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'agentTeamId': opts['agentTeamId'],'formContextId': opts['formContextId'] },
|
|
43076
43728
|
{ },
|
|
43077
43729
|
{ },
|
|
43078
43730
|
null,
|
|
@@ -43276,6 +43928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43276
43928
|
* @param {String} opts.previousPage Previous page token
|
|
43277
43929
|
* @param {String} opts.conversationId conversationId specified
|
|
43278
43930
|
* @param {String} opts.agentUserId user id of the agent
|
|
43931
|
+
* @param {String} opts.agentTeamId team id of the agent
|
|
43279
43932
|
* @param {String} opts.evaluatorUserId evaluator user id
|
|
43280
43933
|
* @param {String} opts.assigneeUserId assignee user id
|
|
43281
43934
|
* @param {String} opts.queueId queue id
|
|
@@ -43297,7 +43950,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43297
43950
|
'/api/v2/quality/evaluations/query',
|
|
43298
43951
|
'GET',
|
|
43299
43952
|
{ },
|
|
43300
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
43953
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
43301
43954
|
{ },
|
|
43302
43955
|
{ },
|
|
43303
43956
|
null,
|
|
@@ -43322,6 +43975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43322
43975
|
* @param {String} opts.name Evaluator name
|
|
43323
43976
|
* @param {Array.<String>} opts.permission permission strings
|
|
43324
43977
|
* @param {String} opts.group group id
|
|
43978
|
+
* @param {String} opts.agentTeamId team id of agents to be considered
|
|
43325
43979
|
*/
|
|
43326
43980
|
getQualityEvaluatorsActivity(opts) {
|
|
43327
43981
|
opts = opts || {};
|
|
@@ -43331,7 +43985,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43331
43985
|
'/api/v2/quality/evaluators/activity',
|
|
43332
43986
|
'GET',
|
|
43333
43987
|
{ },
|
|
43334
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'name': opts['name'],'permission': this.apiClient.buildCollectionParam(opts['permission'], 'multi'),'group': opts['group'] },
|
|
43988
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'name': opts['name'],'permission': this.apiClient.buildCollectionParam(opts['permission'], 'multi'),'group': opts['group'],'agentTeamId': opts['agentTeamId'] },
|
|
43335
43989
|
{ },
|
|
43336
43990
|
{ },
|
|
43337
43991
|
null,
|
|
@@ -44533,7 +45187,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44533
45187
|
/**
|
|
44534
45188
|
* Recording service.
|
|
44535
45189
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
44536
|
-
* @version
|
|
45190
|
+
* @version 184.0.0
|
|
44537
45191
|
*/
|
|
44538
45192
|
|
|
44539
45193
|
/**
|
|
@@ -46170,7 +46824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46170
46824
|
/**
|
|
46171
46825
|
* ResponseManagement service.
|
|
46172
46826
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
46173
|
-
* @version
|
|
46827
|
+
* @version 184.0.0
|
|
46174
46828
|
*/
|
|
46175
46829
|
|
|
46176
46830
|
/**
|
|
@@ -46655,7 +47309,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46655
47309
|
/**
|
|
46656
47310
|
* Routing service.
|
|
46657
47311
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
46658
|
-
* @version
|
|
47312
|
+
* @version 184.0.0
|
|
46659
47313
|
*/
|
|
46660
47314
|
|
|
46661
47315
|
/**
|
|
@@ -50363,7 +51017,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50363
51017
|
/**
|
|
50364
51018
|
* SCIM service.
|
|
50365
51019
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
50366
|
-
* @version
|
|
51020
|
+
* @version 184.0.0
|
|
50367
51021
|
*/
|
|
50368
51022
|
|
|
50369
51023
|
/**
|
|
@@ -51240,7 +51894,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51240
51894
|
/**
|
|
51241
51895
|
* Scripts service.
|
|
51242
51896
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
51243
|
-
* @version
|
|
51897
|
+
* @version 184.0.0
|
|
51244
51898
|
*/
|
|
51245
51899
|
|
|
51246
51900
|
/**
|
|
@@ -51684,7 +52338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51684
52338
|
/**
|
|
51685
52339
|
* Search service.
|
|
51686
52340
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
51687
|
-
* @version
|
|
52341
|
+
* @version 184.0.0
|
|
51688
52342
|
*/
|
|
51689
52343
|
|
|
51690
52344
|
/**
|
|
@@ -52373,7 +53027,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52373
53027
|
/**
|
|
52374
53028
|
* Settings service.
|
|
52375
53029
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
52376
|
-
* @version
|
|
53030
|
+
* @version 184.0.0
|
|
52377
53031
|
*/
|
|
52378
53032
|
|
|
52379
53033
|
/**
|
|
@@ -52438,7 +53092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52438
53092
|
/**
|
|
52439
53093
|
* SpeechTextAnalytics service.
|
|
52440
53094
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
52441
|
-
* @version
|
|
53095
|
+
* @version 184.0.0
|
|
52442
53096
|
*/
|
|
52443
53097
|
|
|
52444
53098
|
/**
|
|
@@ -53551,7 +54205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53551
54205
|
/**
|
|
53552
54206
|
* Stations service.
|
|
53553
54207
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
53554
|
-
* @version
|
|
54208
|
+
* @version 184.0.0
|
|
53555
54209
|
*/
|
|
53556
54210
|
|
|
53557
54211
|
/**
|
|
@@ -53653,7 +54307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53653
54307
|
/**
|
|
53654
54308
|
* Suggest service.
|
|
53655
54309
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
53656
|
-
* @version
|
|
54310
|
+
* @version 184.0.0
|
|
53657
54311
|
*/
|
|
53658
54312
|
|
|
53659
54313
|
/**
|
|
@@ -53792,7 +54446,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53792
54446
|
/**
|
|
53793
54447
|
* TaskManagement service.
|
|
53794
54448
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
53795
|
-
* @version
|
|
54449
|
+
* @version 184.0.0
|
|
53796
54450
|
*/
|
|
53797
54451
|
|
|
53798
54452
|
/**
|
|
@@ -55073,7 +55727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55073
55727
|
/**
|
|
55074
55728
|
* Teams service.
|
|
55075
55729
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
55076
|
-
* @version
|
|
55730
|
+
* @version 184.0.0
|
|
55077
55731
|
*/
|
|
55078
55732
|
|
|
55079
55733
|
/**
|
|
@@ -55375,7 +56029,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55375
56029
|
/**
|
|
55376
56030
|
* Telephony service.
|
|
55377
56031
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
55378
|
-
* @version
|
|
56032
|
+
* @version 184.0.0
|
|
55379
56033
|
*/
|
|
55380
56034
|
|
|
55381
56035
|
/**
|
|
@@ -55559,7 +56213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55559
56213
|
/**
|
|
55560
56214
|
* TelephonyProvidersEdge service.
|
|
55561
56215
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
55562
|
-
* @version
|
|
56216
|
+
* @version 184.0.0
|
|
55563
56217
|
*/
|
|
55564
56218
|
|
|
55565
56219
|
/**
|
|
@@ -58933,7 +59587,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58933
59587
|
/**
|
|
58934
59588
|
* Textbots service.
|
|
58935
59589
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
58936
|
-
* @version
|
|
59590
|
+
* @version 184.0.0
|
|
58937
59591
|
*/
|
|
58938
59592
|
|
|
58939
59593
|
/**
|
|
@@ -59061,7 +59715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59061
59715
|
/**
|
|
59062
59716
|
* Tokens service.
|
|
59063
59717
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
59064
|
-
* @version
|
|
59718
|
+
* @version 184.0.0
|
|
59065
59719
|
*/
|
|
59066
59720
|
|
|
59067
59721
|
/**
|
|
@@ -59217,7 +59871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59217
59871
|
/**
|
|
59218
59872
|
* Uploads service.
|
|
59219
59873
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
59220
|
-
* @version
|
|
59874
|
+
* @version 184.0.0
|
|
59221
59875
|
*/
|
|
59222
59876
|
|
|
59223
59877
|
/**
|
|
@@ -59393,7 +60047,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59393
60047
|
/**
|
|
59394
60048
|
* Usage service.
|
|
59395
60049
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
59396
|
-
* @version
|
|
60050
|
+
* @version 184.0.0
|
|
59397
60051
|
*/
|
|
59398
60052
|
|
|
59399
60053
|
/**
|
|
@@ -59603,7 +60257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59603
60257
|
/**
|
|
59604
60258
|
* UserRecordings service.
|
|
59605
60259
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
59606
|
-
* @version
|
|
60260
|
+
* @version 184.0.0
|
|
59607
60261
|
*/
|
|
59608
60262
|
|
|
59609
60263
|
/**
|
|
@@ -59788,7 +60442,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59788
60442
|
/**
|
|
59789
60443
|
* Users service.
|
|
59790
60444
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
59791
|
-
* @version
|
|
60445
|
+
* @version 184.0.0
|
|
59792
60446
|
*/
|
|
59793
60447
|
|
|
59794
60448
|
/**
|
|
@@ -62439,7 +63093,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62439
63093
|
/**
|
|
62440
63094
|
* Utilities service.
|
|
62441
63095
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
62442
|
-
* @version
|
|
63096
|
+
* @version 184.0.0
|
|
62443
63097
|
*/
|
|
62444
63098
|
|
|
62445
63099
|
/**
|
|
@@ -62550,7 +63204,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62550
63204
|
/**
|
|
62551
63205
|
* Voicemail service.
|
|
62552
63206
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
62553
|
-
* @version
|
|
63207
|
+
* @version 184.0.0
|
|
62554
63208
|
*/
|
|
62555
63209
|
|
|
62556
63210
|
/**
|
|
@@ -63217,7 +63871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63217
63871
|
/**
|
|
63218
63872
|
* WebChat service.
|
|
63219
63873
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
63220
|
-
* @version
|
|
63874
|
+
* @version 184.0.0
|
|
63221
63875
|
*/
|
|
63222
63876
|
|
|
63223
63877
|
/**
|
|
@@ -63766,7 +64420,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63766
64420
|
/**
|
|
63767
64421
|
* WebDeployments service.
|
|
63768
64422
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
63769
|
-
* @version
|
|
64423
|
+
* @version 184.0.0
|
|
63770
64424
|
*/
|
|
63771
64425
|
|
|
63772
64426
|
/**
|
|
@@ -64293,7 +64947,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64293
64947
|
/**
|
|
64294
64948
|
* WebMessaging service.
|
|
64295
64949
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
64296
|
-
* @version
|
|
64950
|
+
* @version 184.0.0
|
|
64297
64951
|
*/
|
|
64298
64952
|
|
|
64299
64953
|
/**
|
|
@@ -64339,7 +64993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64339
64993
|
/**
|
|
64340
64994
|
* Widgets service.
|
|
64341
64995
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
64342
|
-
* @version
|
|
64996
|
+
* @version 184.0.0
|
|
64343
64997
|
*/
|
|
64344
64998
|
|
|
64345
64999
|
/**
|
|
@@ -64485,7 +65139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64485
65139
|
/**
|
|
64486
65140
|
* WorkforceManagement service.
|
|
64487
65141
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
64488
|
-
* @version
|
|
65142
|
+
* @version 184.0.0
|
|
64489
65143
|
*/
|
|
64490
65144
|
|
|
64491
65145
|
/**
|
|
@@ -69659,7 +70313,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69659
70313
|
* </pre>
|
|
69660
70314
|
* </p>
|
|
69661
70315
|
* @module purecloud-platform-client-v2/index
|
|
69662
|
-
* @version
|
|
70316
|
+
* @version 184.0.0
|
|
69663
70317
|
*/
|
|
69664
70318
|
class platformClient {
|
|
69665
70319
|
constructor() {
|
|
@@ -69838,6 +70492,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69838
70492
|
* @property {module:purecloud-platform-client-v2/api/LocationsApi}
|
|
69839
70493
|
*/
|
|
69840
70494
|
this.LocationsApi = LocationsApi;
|
|
70495
|
+
/**
|
|
70496
|
+
* The LogCaptureApi service constructor.
|
|
70497
|
+
* @property {module:purecloud-platform-client-v2/api/LogCaptureApi}
|
|
70498
|
+
*/
|
|
70499
|
+
this.LogCaptureApi = LogCaptureApi;
|
|
69841
70500
|
/**
|
|
69842
70501
|
* The MessagingApi service constructor.
|
|
69843
70502
|
* @property {module:purecloud-platform-client-v2/api/MessagingApi}
|