purecloud-platform-client-v2 171.0.0 → 173.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 +1056 -91
- package/dist/web-amd/purecloud-platform-client-v2.js +1056 -91
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +1056 -91
- package/dist/web-cjs/purecloud-platform-client-v2.js +1056 -91
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +631 -214
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +337 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +259 -9
- 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 +70 -0
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +10 -4
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +204 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +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 +70 -0
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +31 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +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 +7 -7
- package/src/purecloud-platform-client-v2/index.js +13 -1
|
@@ -402,7 +402,7 @@ class Configuration {
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 173.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1488,7 +1488,7 @@ class AlertingApi {
|
|
|
1488
1488
|
/**
|
|
1489
1489
|
* Alerting service.
|
|
1490
1490
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1491
|
-
* @version
|
|
1491
|
+
* @version 173.0.0
|
|
1492
1492
|
*/
|
|
1493
1493
|
|
|
1494
1494
|
/**
|
|
@@ -1503,6 +1503,31 @@ class AlertingApi {
|
|
|
1503
1503
|
}
|
|
1504
1504
|
|
|
1505
1505
|
|
|
1506
|
+
/**
|
|
1507
|
+
* Delete an alert
|
|
1508
|
+
*
|
|
1509
|
+
* @param {String} alertId Alert ID
|
|
1510
|
+
*/
|
|
1511
|
+
deleteAlertingAlert(alertId) {
|
|
1512
|
+
// verify the required parameter 'alertId' is set
|
|
1513
|
+
if (alertId === undefined || alertId === null) {
|
|
1514
|
+
throw 'Missing the required parameter "alertId" when calling deleteAlertingAlert';
|
|
1515
|
+
}
|
|
1516
|
+
|
|
1517
|
+
return this.apiClient.callApi(
|
|
1518
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
1519
|
+
'DELETE',
|
|
1520
|
+
{ 'alertId': alertId },
|
|
1521
|
+
{ },
|
|
1522
|
+
{ },
|
|
1523
|
+
{ },
|
|
1524
|
+
null,
|
|
1525
|
+
['PureCloud OAuth'],
|
|
1526
|
+
['application/json'],
|
|
1527
|
+
['application/json']
|
|
1528
|
+
);
|
|
1529
|
+
}
|
|
1530
|
+
|
|
1506
1531
|
/**
|
|
1507
1532
|
* Delete an interaction stats alert
|
|
1508
1533
|
*
|
|
@@ -1553,6 +1578,56 @@ class AlertingApi {
|
|
|
1553
1578
|
);
|
|
1554
1579
|
}
|
|
1555
1580
|
|
|
1581
|
+
/**
|
|
1582
|
+
* Delete a rule.
|
|
1583
|
+
*
|
|
1584
|
+
* @param {String} ruleId Rule Id
|
|
1585
|
+
*/
|
|
1586
|
+
deleteAlertingRule(ruleId) {
|
|
1587
|
+
// verify the required parameter 'ruleId' is set
|
|
1588
|
+
if (ruleId === undefined || ruleId === null) {
|
|
1589
|
+
throw 'Missing the required parameter "ruleId" when calling deleteAlertingRule';
|
|
1590
|
+
}
|
|
1591
|
+
|
|
1592
|
+
return this.apiClient.callApi(
|
|
1593
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
1594
|
+
'DELETE',
|
|
1595
|
+
{ 'ruleId': ruleId },
|
|
1596
|
+
{ },
|
|
1597
|
+
{ },
|
|
1598
|
+
{ },
|
|
1599
|
+
null,
|
|
1600
|
+
['PureCloud OAuth'],
|
|
1601
|
+
['application/json'],
|
|
1602
|
+
['application/json']
|
|
1603
|
+
);
|
|
1604
|
+
}
|
|
1605
|
+
|
|
1606
|
+
/**
|
|
1607
|
+
* Get an alert
|
|
1608
|
+
*
|
|
1609
|
+
* @param {String} alertId Alert ID
|
|
1610
|
+
*/
|
|
1611
|
+
getAlertingAlert(alertId) {
|
|
1612
|
+
// verify the required parameter 'alertId' is set
|
|
1613
|
+
if (alertId === undefined || alertId === null) {
|
|
1614
|
+
throw 'Missing the required parameter "alertId" when calling getAlertingAlert';
|
|
1615
|
+
}
|
|
1616
|
+
|
|
1617
|
+
return this.apiClient.callApi(
|
|
1618
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
1619
|
+
'GET',
|
|
1620
|
+
{ 'alertId': alertId },
|
|
1621
|
+
{ },
|
|
1622
|
+
{ },
|
|
1623
|
+
{ },
|
|
1624
|
+
null,
|
|
1625
|
+
['PureCloud OAuth'],
|
|
1626
|
+
['application/json'],
|
|
1627
|
+
['application/json']
|
|
1628
|
+
);
|
|
1629
|
+
}
|
|
1630
|
+
|
|
1556
1631
|
/**
|
|
1557
1632
|
* Gets active alert count for a user.
|
|
1558
1633
|
*
|
|
@@ -1699,6 +1774,134 @@ class AlertingApi {
|
|
|
1699
1774
|
);
|
|
1700
1775
|
}
|
|
1701
1776
|
|
|
1777
|
+
/**
|
|
1778
|
+
* Get a rule.
|
|
1779
|
+
*
|
|
1780
|
+
* @param {String} ruleId Rule Id
|
|
1781
|
+
*/
|
|
1782
|
+
getAlertingRule(ruleId) {
|
|
1783
|
+
// verify the required parameter 'ruleId' is set
|
|
1784
|
+
if (ruleId === undefined || ruleId === null) {
|
|
1785
|
+
throw 'Missing the required parameter "ruleId" when calling getAlertingRule';
|
|
1786
|
+
}
|
|
1787
|
+
|
|
1788
|
+
return this.apiClient.callApi(
|
|
1789
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
1790
|
+
'GET',
|
|
1791
|
+
{ 'ruleId': ruleId },
|
|
1792
|
+
{ },
|
|
1793
|
+
{ },
|
|
1794
|
+
{ },
|
|
1795
|
+
null,
|
|
1796
|
+
['PureCloud OAuth'],
|
|
1797
|
+
['application/json'],
|
|
1798
|
+
['application/json']
|
|
1799
|
+
);
|
|
1800
|
+
}
|
|
1801
|
+
|
|
1802
|
+
/**
|
|
1803
|
+
* Allows an entity to mute/snooze an alert or update the unread status of the alert.
|
|
1804
|
+
* Snoozing an alert temporarily stop it from resending notifications to individualsas well as other services within Genesys Cloud for a given period. Muting an alert will only block the notifications to individuals.
|
|
1805
|
+
* @param {String} alertId Alert ID
|
|
1806
|
+
* @param {Object} opts Optional parameters
|
|
1807
|
+
* @param {Object} opts.body
|
|
1808
|
+
*/
|
|
1809
|
+
patchAlertingAlert(alertId, opts) {
|
|
1810
|
+
opts = opts || {};
|
|
1811
|
+
|
|
1812
|
+
// verify the required parameter 'alertId' is set
|
|
1813
|
+
if (alertId === undefined || alertId === null) {
|
|
1814
|
+
throw 'Missing the required parameter "alertId" when calling patchAlertingAlert';
|
|
1815
|
+
}
|
|
1816
|
+
|
|
1817
|
+
return this.apiClient.callApi(
|
|
1818
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
1819
|
+
'PATCH',
|
|
1820
|
+
{ 'alertId': alertId },
|
|
1821
|
+
{ },
|
|
1822
|
+
{ },
|
|
1823
|
+
{ },
|
|
1824
|
+
opts['body'],
|
|
1825
|
+
['PureCloud OAuth'],
|
|
1826
|
+
['application/json'],
|
|
1827
|
+
['application/json']
|
|
1828
|
+
);
|
|
1829
|
+
}
|
|
1830
|
+
|
|
1831
|
+
/**
|
|
1832
|
+
* Bulk alert updates
|
|
1833
|
+
*
|
|
1834
|
+
* @param {Object} body
|
|
1835
|
+
*/
|
|
1836
|
+
patchAlertingAlertsBulk(body) {
|
|
1837
|
+
// verify the required parameter 'body' is set
|
|
1838
|
+
if (body === undefined || body === null) {
|
|
1839
|
+
throw 'Missing the required parameter "body" when calling patchAlertingAlertsBulk';
|
|
1840
|
+
}
|
|
1841
|
+
|
|
1842
|
+
return this.apiClient.callApi(
|
|
1843
|
+
'/api/v2/alerting/alerts/bulk',
|
|
1844
|
+
'PATCH',
|
|
1845
|
+
{ },
|
|
1846
|
+
{ },
|
|
1847
|
+
{ },
|
|
1848
|
+
{ },
|
|
1849
|
+
body,
|
|
1850
|
+
['PureCloud OAuth'],
|
|
1851
|
+
['application/json'],
|
|
1852
|
+
['application/json']
|
|
1853
|
+
);
|
|
1854
|
+
}
|
|
1855
|
+
|
|
1856
|
+
/**
|
|
1857
|
+
* Bulk update of notification lists
|
|
1858
|
+
*
|
|
1859
|
+
* @param {Object} body
|
|
1860
|
+
*/
|
|
1861
|
+
patchAlertingRulesBulk(body) {
|
|
1862
|
+
// verify the required parameter 'body' is set
|
|
1863
|
+
if (body === undefined || body === null) {
|
|
1864
|
+
throw 'Missing the required parameter "body" when calling patchAlertingRulesBulk';
|
|
1865
|
+
}
|
|
1866
|
+
|
|
1867
|
+
return this.apiClient.callApi(
|
|
1868
|
+
'/api/v2/alerting/rules/bulk',
|
|
1869
|
+
'PATCH',
|
|
1870
|
+
{ },
|
|
1871
|
+
{ },
|
|
1872
|
+
{ },
|
|
1873
|
+
{ },
|
|
1874
|
+
body,
|
|
1875
|
+
['PureCloud OAuth'],
|
|
1876
|
+
['application/json'],
|
|
1877
|
+
['application/json']
|
|
1878
|
+
);
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1881
|
+
/**
|
|
1882
|
+
* Gets a paged list of alerts. The max page size is 50
|
|
1883
|
+
*
|
|
1884
|
+
* @param {Object} opts Optional parameters
|
|
1885
|
+
* @param {Object} opts.body
|
|
1886
|
+
*/
|
|
1887
|
+
postAlertingAlertsQuery(opts) {
|
|
1888
|
+
opts = opts || {};
|
|
1889
|
+
|
|
1890
|
+
|
|
1891
|
+
return this.apiClient.callApi(
|
|
1892
|
+
'/api/v2/alerting/alerts/query',
|
|
1893
|
+
'POST',
|
|
1894
|
+
{ },
|
|
1895
|
+
{ },
|
|
1896
|
+
{ },
|
|
1897
|
+
{ },
|
|
1898
|
+
opts['body'],
|
|
1899
|
+
['PureCloud OAuth'],
|
|
1900
|
+
['application/json'],
|
|
1901
|
+
['application/json']
|
|
1902
|
+
);
|
|
1903
|
+
}
|
|
1904
|
+
|
|
1702
1905
|
/**
|
|
1703
1906
|
* Create an interaction stats rule.
|
|
1704
1907
|
*
|
|
@@ -1728,6 +1931,109 @@ class AlertingApi {
|
|
|
1728
1931
|
);
|
|
1729
1932
|
}
|
|
1730
1933
|
|
|
1934
|
+
/**
|
|
1935
|
+
* Create a Rule.
|
|
1936
|
+
*
|
|
1937
|
+
* @param {Object} body rule to be created
|
|
1938
|
+
*/
|
|
1939
|
+
postAlertingRules(body) {
|
|
1940
|
+
// verify the required parameter 'body' is set
|
|
1941
|
+
if (body === undefined || body === null) {
|
|
1942
|
+
throw 'Missing the required parameter "body" when calling postAlertingRules';
|
|
1943
|
+
}
|
|
1944
|
+
|
|
1945
|
+
return this.apiClient.callApi(
|
|
1946
|
+
'/api/v2/alerting/rules',
|
|
1947
|
+
'POST',
|
|
1948
|
+
{ },
|
|
1949
|
+
{ },
|
|
1950
|
+
{ },
|
|
1951
|
+
{ },
|
|
1952
|
+
body,
|
|
1953
|
+
['PureCloud OAuth'],
|
|
1954
|
+
['application/json'],
|
|
1955
|
+
['application/json']
|
|
1956
|
+
);
|
|
1957
|
+
}
|
|
1958
|
+
|
|
1959
|
+
/**
|
|
1960
|
+
* Bulk remove rules
|
|
1961
|
+
*
|
|
1962
|
+
* @param {Object} body
|
|
1963
|
+
*/
|
|
1964
|
+
postAlertingRulesBulkRemove(body) {
|
|
1965
|
+
// verify the required parameter 'body' is set
|
|
1966
|
+
if (body === undefined || body === null) {
|
|
1967
|
+
throw 'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';
|
|
1968
|
+
}
|
|
1969
|
+
|
|
1970
|
+
return this.apiClient.callApi(
|
|
1971
|
+
'/api/v2/alerting/rules/bulk/remove',
|
|
1972
|
+
'POST',
|
|
1973
|
+
{ },
|
|
1974
|
+
{ },
|
|
1975
|
+
{ },
|
|
1976
|
+
{ },
|
|
1977
|
+
body,
|
|
1978
|
+
['PureCloud OAuth'],
|
|
1979
|
+
['application/json'],
|
|
1980
|
+
['application/json']
|
|
1981
|
+
);
|
|
1982
|
+
}
|
|
1983
|
+
|
|
1984
|
+
/**
|
|
1985
|
+
* Get a paged list of rules. The max size of the page is 50 items.
|
|
1986
|
+
*
|
|
1987
|
+
* @param {Object} opts Optional parameters
|
|
1988
|
+
* @param {Object} opts.body
|
|
1989
|
+
*/
|
|
1990
|
+
postAlertingRulesQuery(opts) {
|
|
1991
|
+
opts = opts || {};
|
|
1992
|
+
|
|
1993
|
+
|
|
1994
|
+
return this.apiClient.callApi(
|
|
1995
|
+
'/api/v2/alerting/rules/query',
|
|
1996
|
+
'POST',
|
|
1997
|
+
{ },
|
|
1998
|
+
{ },
|
|
1999
|
+
{ },
|
|
2000
|
+
{ },
|
|
2001
|
+
opts['body'],
|
|
2002
|
+
['PureCloud OAuth'],
|
|
2003
|
+
['application/json'],
|
|
2004
|
+
['application/json']
|
|
2005
|
+
);
|
|
2006
|
+
}
|
|
2007
|
+
|
|
2008
|
+
/**
|
|
2009
|
+
* Update an alert read status
|
|
2010
|
+
*
|
|
2011
|
+
* @param {String} alertId Alert ID
|
|
2012
|
+
* @param {Object} opts Optional parameters
|
|
2013
|
+
* @param {Object} opts.body
|
|
2014
|
+
*/
|
|
2015
|
+
putAlertingAlert(alertId, opts) {
|
|
2016
|
+
opts = opts || {};
|
|
2017
|
+
|
|
2018
|
+
// verify the required parameter 'alertId' is set
|
|
2019
|
+
if (alertId === undefined || alertId === null) {
|
|
2020
|
+
throw 'Missing the required parameter "alertId" when calling putAlertingAlert';
|
|
2021
|
+
}
|
|
2022
|
+
|
|
2023
|
+
return this.apiClient.callApi(
|
|
2024
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
2025
|
+
'PUT',
|
|
2026
|
+
{ 'alertId': alertId },
|
|
2027
|
+
{ },
|
|
2028
|
+
{ },
|
|
2029
|
+
{ },
|
|
2030
|
+
opts['body'],
|
|
2031
|
+
['PureCloud OAuth'],
|
|
2032
|
+
['application/json'],
|
|
2033
|
+
['application/json']
|
|
2034
|
+
);
|
|
2035
|
+
}
|
|
2036
|
+
|
|
1731
2037
|
/**
|
|
1732
2038
|
* Update an interaction stats alert read status
|
|
1733
2039
|
*
|
|
@@ -1796,13 +2102,43 @@ class AlertingApi {
|
|
|
1796
2102
|
);
|
|
1797
2103
|
}
|
|
1798
2104
|
|
|
2105
|
+
/**
|
|
2106
|
+
* Update a rule
|
|
2107
|
+
*
|
|
2108
|
+
* @param {String} ruleId Rule Id
|
|
2109
|
+
* @param {Object} body rule to be updated
|
|
2110
|
+
*/
|
|
2111
|
+
putAlertingRule(ruleId, body) {
|
|
2112
|
+
// verify the required parameter 'ruleId' is set
|
|
2113
|
+
if (ruleId === undefined || ruleId === null) {
|
|
2114
|
+
throw 'Missing the required parameter "ruleId" when calling putAlertingRule';
|
|
2115
|
+
}
|
|
2116
|
+
// verify the required parameter 'body' is set
|
|
2117
|
+
if (body === undefined || body === null) {
|
|
2118
|
+
throw 'Missing the required parameter "body" when calling putAlertingRule';
|
|
2119
|
+
}
|
|
2120
|
+
|
|
2121
|
+
return this.apiClient.callApi(
|
|
2122
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
2123
|
+
'PUT',
|
|
2124
|
+
{ 'ruleId': ruleId },
|
|
2125
|
+
{ },
|
|
2126
|
+
{ },
|
|
2127
|
+
{ },
|
|
2128
|
+
body,
|
|
2129
|
+
['PureCloud OAuth'],
|
|
2130
|
+
['application/json'],
|
|
2131
|
+
['application/json']
|
|
2132
|
+
);
|
|
2133
|
+
}
|
|
2134
|
+
|
|
1799
2135
|
}
|
|
1800
2136
|
|
|
1801
2137
|
class AnalyticsApi {
|
|
1802
2138
|
/**
|
|
1803
2139
|
* Analytics service.
|
|
1804
2140
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1805
|
-
* @version
|
|
2141
|
+
* @version 173.0.0
|
|
1806
2142
|
*/
|
|
1807
2143
|
|
|
1808
2144
|
/**
|
|
@@ -4247,7 +4583,7 @@ class ArchitectApi {
|
|
|
4247
4583
|
/**
|
|
4248
4584
|
* Architect service.
|
|
4249
4585
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4250
|
-
* @version
|
|
4586
|
+
* @version 173.0.0
|
|
4251
4587
|
*/
|
|
4252
4588
|
|
|
4253
4589
|
/**
|
|
@@ -7436,7 +7772,7 @@ class AuditApi {
|
|
|
7436
7772
|
/**
|
|
7437
7773
|
* Audit service.
|
|
7438
7774
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7439
|
-
* @version
|
|
7775
|
+
* @version 173.0.0
|
|
7440
7776
|
*/
|
|
7441
7777
|
|
|
7442
7778
|
/**
|
|
@@ -7607,7 +7943,7 @@ class AuthorizationApi {
|
|
|
7607
7943
|
/**
|
|
7608
7944
|
* Authorization service.
|
|
7609
7945
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7610
|
-
* @version
|
|
7946
|
+
* @version 173.0.0
|
|
7611
7947
|
*/
|
|
7612
7948
|
|
|
7613
7949
|
/**
|
|
@@ -8838,7 +9174,7 @@ class BillingApi {
|
|
|
8838
9174
|
/**
|
|
8839
9175
|
* Billing service.
|
|
8840
9176
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8841
|
-
* @version
|
|
9177
|
+
* @version 173.0.0
|
|
8842
9178
|
*/
|
|
8843
9179
|
|
|
8844
9180
|
/**
|
|
@@ -8918,7 +9254,7 @@ class CarrierServicesApi {
|
|
|
8918
9254
|
/**
|
|
8919
9255
|
* CarrierServices service.
|
|
8920
9256
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8921
|
-
* @version
|
|
9257
|
+
* @version 173.0.0
|
|
8922
9258
|
*/
|
|
8923
9259
|
|
|
8924
9260
|
/**
|
|
@@ -8988,7 +9324,7 @@ class ChatApi {
|
|
|
8988
9324
|
/**
|
|
8989
9325
|
* Chat service.
|
|
8990
9326
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8991
|
-
* @version
|
|
9327
|
+
* @version 173.0.0
|
|
8992
9328
|
*/
|
|
8993
9329
|
|
|
8994
9330
|
/**
|
|
@@ -9152,7 +9488,7 @@ class CoachingApi {
|
|
|
9152
9488
|
/**
|
|
9153
9489
|
* Coaching service.
|
|
9154
9490
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9155
|
-
* @version
|
|
9491
|
+
* @version 173.0.0
|
|
9156
9492
|
*/
|
|
9157
9493
|
|
|
9158
9494
|
/**
|
|
@@ -9729,7 +10065,7 @@ class ContentManagementApi {
|
|
|
9729
10065
|
/**
|
|
9730
10066
|
* ContentManagement service.
|
|
9731
10067
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9732
|
-
* @version
|
|
10068
|
+
* @version 173.0.0
|
|
9733
10069
|
*/
|
|
9734
10070
|
|
|
9735
10071
|
/**
|
|
@@ -10872,7 +11208,7 @@ class ConversationsApi {
|
|
|
10872
11208
|
/**
|
|
10873
11209
|
* Conversations service.
|
|
10874
11210
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10875
|
-
* @version
|
|
11211
|
+
* @version 173.0.0
|
|
10876
11212
|
*/
|
|
10877
11213
|
|
|
10878
11214
|
/**
|
|
@@ -11187,6 +11523,51 @@ class ConversationsApi {
|
|
|
11187
11523
|
);
|
|
11188
11524
|
}
|
|
11189
11525
|
|
|
11526
|
+
/**
|
|
11527
|
+
* Delete a messaging setting
|
|
11528
|
+
*
|
|
11529
|
+
* @param {String} messageSettingId Message Setting ID
|
|
11530
|
+
*/
|
|
11531
|
+
deleteConversationsMessagingSetting(messageSettingId) {
|
|
11532
|
+
// verify the required parameter 'messageSettingId' is set
|
|
11533
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
11534
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteConversationsMessagingSetting';
|
|
11535
|
+
}
|
|
11536
|
+
|
|
11537
|
+
return this.apiClient.callApi(
|
|
11538
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
11539
|
+
'DELETE',
|
|
11540
|
+
{ 'messageSettingId': messageSettingId },
|
|
11541
|
+
{ },
|
|
11542
|
+
{ },
|
|
11543
|
+
{ },
|
|
11544
|
+
null,
|
|
11545
|
+
['PureCloud OAuth'],
|
|
11546
|
+
['application/json'],
|
|
11547
|
+
['application/json']
|
|
11548
|
+
);
|
|
11549
|
+
}
|
|
11550
|
+
|
|
11551
|
+
/**
|
|
11552
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
11553
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
11554
|
+
*/
|
|
11555
|
+
deleteConversationsMessagingSettingsDefault() {
|
|
11556
|
+
|
|
11557
|
+
return this.apiClient.callApi(
|
|
11558
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
11559
|
+
'DELETE',
|
|
11560
|
+
{ },
|
|
11561
|
+
{ },
|
|
11562
|
+
{ },
|
|
11563
|
+
{ },
|
|
11564
|
+
null,
|
|
11565
|
+
['PureCloud OAuth'],
|
|
11566
|
+
['application/json'],
|
|
11567
|
+
['application/json']
|
|
11568
|
+
);
|
|
11569
|
+
}
|
|
11570
|
+
|
|
11190
11571
|
/**
|
|
11191
11572
|
* Delete a supported content profile
|
|
11192
11573
|
*
|
|
@@ -13230,6 +13611,76 @@ class ConversationsApi {
|
|
|
13230
13611
|
);
|
|
13231
13612
|
}
|
|
13232
13613
|
|
|
13614
|
+
/**
|
|
13615
|
+
* Get a messaging setting
|
|
13616
|
+
*
|
|
13617
|
+
* @param {String} messageSettingId Message Setting ID
|
|
13618
|
+
*/
|
|
13619
|
+
getConversationsMessagingSetting(messageSettingId) {
|
|
13620
|
+
// verify the required parameter 'messageSettingId' is set
|
|
13621
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
13622
|
+
throw 'Missing the required parameter "messageSettingId" when calling getConversationsMessagingSetting';
|
|
13623
|
+
}
|
|
13624
|
+
|
|
13625
|
+
return this.apiClient.callApi(
|
|
13626
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
13627
|
+
'GET',
|
|
13628
|
+
{ 'messageSettingId': messageSettingId },
|
|
13629
|
+
{ },
|
|
13630
|
+
{ },
|
|
13631
|
+
{ },
|
|
13632
|
+
null,
|
|
13633
|
+
['PureCloud OAuth'],
|
|
13634
|
+
['application/json'],
|
|
13635
|
+
['application/json']
|
|
13636
|
+
);
|
|
13637
|
+
}
|
|
13638
|
+
|
|
13639
|
+
/**
|
|
13640
|
+
* Get a list of messaging settings
|
|
13641
|
+
*
|
|
13642
|
+
* @param {Object} opts Optional parameters
|
|
13643
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13644
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13645
|
+
*/
|
|
13646
|
+
getConversationsMessagingSettings(opts) {
|
|
13647
|
+
opts = opts || {};
|
|
13648
|
+
|
|
13649
|
+
|
|
13650
|
+
return this.apiClient.callApi(
|
|
13651
|
+
'/api/v2/conversations/messaging/settings',
|
|
13652
|
+
'GET',
|
|
13653
|
+
{ },
|
|
13654
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
13655
|
+
{ },
|
|
13656
|
+
{ },
|
|
13657
|
+
null,
|
|
13658
|
+
['PureCloud OAuth'],
|
|
13659
|
+
['application/json'],
|
|
13660
|
+
['application/json']
|
|
13661
|
+
);
|
|
13662
|
+
}
|
|
13663
|
+
|
|
13664
|
+
/**
|
|
13665
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
13666
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
13667
|
+
*/
|
|
13668
|
+
getConversationsMessagingSettingsDefault() {
|
|
13669
|
+
|
|
13670
|
+
return this.apiClient.callApi(
|
|
13671
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
13672
|
+
'GET',
|
|
13673
|
+
{ },
|
|
13674
|
+
{ },
|
|
13675
|
+
{ },
|
|
13676
|
+
{ },
|
|
13677
|
+
null,
|
|
13678
|
+
['PureCloud OAuth'],
|
|
13679
|
+
['application/json'],
|
|
13680
|
+
['application/json']
|
|
13681
|
+
);
|
|
13682
|
+
}
|
|
13683
|
+
|
|
13233
13684
|
/**
|
|
13234
13685
|
* Get a list of Messaging Stickers
|
|
13235
13686
|
*
|
|
@@ -14730,6 +15181,36 @@ class ConversationsApi {
|
|
|
14730
15181
|
);
|
|
14731
15182
|
}
|
|
14732
15183
|
|
|
15184
|
+
/**
|
|
15185
|
+
* Update a messaging setting
|
|
15186
|
+
*
|
|
15187
|
+
* @param {String} messageSettingId Message Setting ID
|
|
15188
|
+
* @param {Object} body MessagingSetting
|
|
15189
|
+
*/
|
|
15190
|
+
patchConversationsMessagingSetting(messageSettingId, body) {
|
|
15191
|
+
// verify the required parameter 'messageSettingId' is set
|
|
15192
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
15193
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchConversationsMessagingSetting';
|
|
15194
|
+
}
|
|
15195
|
+
// verify the required parameter 'body' is set
|
|
15196
|
+
if (body === undefined || body === null) {
|
|
15197
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingSetting';
|
|
15198
|
+
}
|
|
15199
|
+
|
|
15200
|
+
return this.apiClient.callApi(
|
|
15201
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
15202
|
+
'PATCH',
|
|
15203
|
+
{ 'messageSettingId': messageSettingId },
|
|
15204
|
+
{ },
|
|
15205
|
+
{ },
|
|
15206
|
+
{ },
|
|
15207
|
+
body,
|
|
15208
|
+
['PureCloud OAuth'],
|
|
15209
|
+
['application/json'],
|
|
15210
|
+
['application/json']
|
|
15211
|
+
);
|
|
15212
|
+
}
|
|
15213
|
+
|
|
14733
15214
|
/**
|
|
14734
15215
|
* Update a supported content profile
|
|
14735
15216
|
*
|
|
@@ -14977,6 +15458,32 @@ class ConversationsApi {
|
|
|
14977
15458
|
);
|
|
14978
15459
|
}
|
|
14979
15460
|
|
|
15461
|
+
/**
|
|
15462
|
+
* Barge a conversation creating a barged in conference of connected participants.
|
|
15463
|
+
*
|
|
15464
|
+
* @param {String} conversationId conversation ID
|
|
15465
|
+
* postConversationBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15466
|
+
*/
|
|
15467
|
+
postConversationBarge(conversationId) {
|
|
15468
|
+
// verify the required parameter 'conversationId' is set
|
|
15469
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15470
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationBarge';
|
|
15471
|
+
}
|
|
15472
|
+
|
|
15473
|
+
return this.apiClient.callApi(
|
|
15474
|
+
'/api/v2/conversations/{conversationId}/barge',
|
|
15475
|
+
'POST',
|
|
15476
|
+
{ 'conversationId': conversationId },
|
|
15477
|
+
{ },
|
|
15478
|
+
{ },
|
|
15479
|
+
{ },
|
|
15480
|
+
null,
|
|
15481
|
+
['PureCloud OAuth'],
|
|
15482
|
+
['application/json'],
|
|
15483
|
+
['application/json']
|
|
15484
|
+
);
|
|
15485
|
+
}
|
|
15486
|
+
|
|
14980
15487
|
/**
|
|
14981
15488
|
* Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
|
|
14982
15489
|
*
|
|
@@ -15101,7 +15608,6 @@ class ConversationsApi {
|
|
|
15101
15608
|
* @param {String} conversationId conversation ID
|
|
15102
15609
|
* @param {String} participantId participant ID
|
|
15103
15610
|
* @param {Object} body Transfer request
|
|
15104
|
-
* @deprecated
|
|
15105
15611
|
*/
|
|
15106
15612
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
15107
15613
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15137,6 +15643,7 @@ class ConversationsApi {
|
|
|
15137
15643
|
* @param {String} conversationId conversation ID
|
|
15138
15644
|
* @param {String} participantId participant ID
|
|
15139
15645
|
* @param {Object} body Transfer request
|
|
15646
|
+
* postConversationParticipantReplaceAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15140
15647
|
*/
|
|
15141
15648
|
postConversationParticipantReplaceAgent(conversationId, participantId, body) {
|
|
15142
15649
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15172,6 +15679,7 @@ class ConversationsApi {
|
|
|
15172
15679
|
* @param {String} conversationId conversation ID
|
|
15173
15680
|
* @param {String} participantId participant ID
|
|
15174
15681
|
* @param {Object} body Transfer request
|
|
15682
|
+
* postConversationParticipantReplaceExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15175
15683
|
*/
|
|
15176
15684
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
15177
15685
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15207,6 +15715,7 @@ class ConversationsApi {
|
|
|
15207
15715
|
* @param {String} conversationId conversation ID
|
|
15208
15716
|
* @param {String} participantId participant ID
|
|
15209
15717
|
* @param {Object} body Transfer request
|
|
15718
|
+
* postConversationParticipantReplaceQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15210
15719
|
*/
|
|
15211
15720
|
postConversationParticipantReplaceQueue(conversationId, participantId, body) {
|
|
15212
15721
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15300,6 +15809,37 @@ class ConversationsApi {
|
|
|
15300
15809
|
);
|
|
15301
15810
|
}
|
|
15302
15811
|
|
|
15812
|
+
/**
|
|
15813
|
+
* Barge a given participant's call creating a barged in conference of connected participants.
|
|
15814
|
+
*
|
|
15815
|
+
* @param {String} conversationId conversationId
|
|
15816
|
+
* @param {String} participantId participantId
|
|
15817
|
+
* postConversationsCallParticipantBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15818
|
+
*/
|
|
15819
|
+
postConversationsCallParticipantBarge(conversationId, participantId) {
|
|
15820
|
+
// verify the required parameter 'conversationId' is set
|
|
15821
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15822
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantBarge';
|
|
15823
|
+
}
|
|
15824
|
+
// verify the required parameter 'participantId' is set
|
|
15825
|
+
if (participantId === undefined || participantId === null) {
|
|
15826
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantBarge';
|
|
15827
|
+
}
|
|
15828
|
+
|
|
15829
|
+
return this.apiClient.callApi(
|
|
15830
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge',
|
|
15831
|
+
'POST',
|
|
15832
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
15833
|
+
{ },
|
|
15834
|
+
{ },
|
|
15835
|
+
{ },
|
|
15836
|
+
null,
|
|
15837
|
+
['PureCloud OAuth'],
|
|
15838
|
+
['application/json'],
|
|
15839
|
+
['application/json']
|
|
15840
|
+
);
|
|
15841
|
+
}
|
|
15842
|
+
|
|
15303
15843
|
/**
|
|
15304
15844
|
* Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
|
|
15305
15845
|
*
|
|
@@ -15375,7 +15915,6 @@ class ConversationsApi {
|
|
|
15375
15915
|
* @param {String} conversationId conversationId
|
|
15376
15916
|
* @param {String} participantId participantId
|
|
15377
15917
|
* @param {Object} body Destination address and initial speak to
|
|
15378
|
-
* @deprecated
|
|
15379
15918
|
*/
|
|
15380
15919
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
15381
15920
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15411,6 +15950,7 @@ class ConversationsApi {
|
|
|
15411
15950
|
* @param {String} conversationId conversationId
|
|
15412
15951
|
* @param {String} participantId participantId
|
|
15413
15952
|
* @param {Object} body Destination agent and initial speak to
|
|
15953
|
+
* postConversationsCallParticipantConsultAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15414
15954
|
*/
|
|
15415
15955
|
postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
|
|
15416
15956
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15446,6 +15986,7 @@ class ConversationsApi {
|
|
|
15446
15986
|
* @param {String} conversationId conversationId
|
|
15447
15987
|
* @param {String} participantId participantId
|
|
15448
15988
|
* @param {Object} body Destination address and initial speak to
|
|
15989
|
+
* postConversationsCallParticipantConsultExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15449
15990
|
*/
|
|
15450
15991
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
15451
15992
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15481,6 +16022,7 @@ class ConversationsApi {
|
|
|
15481
16022
|
* @param {String} conversationId conversationId
|
|
15482
16023
|
* @param {String} participantId participantId
|
|
15483
16024
|
* @param {Object} body Destination queue and initial speak to
|
|
16025
|
+
* postConversationsCallParticipantConsultQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15484
16026
|
*/
|
|
15485
16027
|
postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
|
|
15486
16028
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15546,7 +16088,6 @@ class ConversationsApi {
|
|
|
15546
16088
|
* @param {String} conversationId conversationId
|
|
15547
16089
|
* @param {String} participantId participantId
|
|
15548
16090
|
* @param {Object} body Transfer request
|
|
15549
|
-
* @deprecated
|
|
15550
16091
|
*/
|
|
15551
16092
|
postConversationsCallParticipantReplace(conversationId, participantId, body) {
|
|
15552
16093
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15651,7 +16192,6 @@ class ConversationsApi {
|
|
|
15651
16192
|
* @param {String} conversationId conversationId
|
|
15652
16193
|
* @param {String} participantId participantId
|
|
15653
16194
|
* @param {Object} body Transfer request
|
|
15654
|
-
* @deprecated
|
|
15655
16195
|
*/
|
|
15656
16196
|
postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
|
|
15657
16197
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15891,7 +16431,6 @@ class ConversationsApi {
|
|
|
15891
16431
|
* @param {String} conversationId conversationId
|
|
15892
16432
|
* @param {String} participantId participantId
|
|
15893
16433
|
* @param {Object} body Transfer request
|
|
15894
|
-
* @deprecated
|
|
15895
16434
|
*/
|
|
15896
16435
|
postConversationsChatParticipantReplace(conversationId, participantId, body) {
|
|
15897
16436
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15992,7 +16531,6 @@ class ConversationsApi {
|
|
|
15992
16531
|
* @param {String} participantId participantId
|
|
15993
16532
|
* @param {Object} opts Optional parameters
|
|
15994
16533
|
* @param {Object} opts.body
|
|
15995
|
-
* @deprecated
|
|
15996
16534
|
*/
|
|
15997
16535
|
postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
|
|
15998
16536
|
opts = opts || {};
|
|
@@ -16155,7 +16693,6 @@ class ConversationsApi {
|
|
|
16155
16693
|
* @param {String} conversationId conversationId
|
|
16156
16694
|
* @param {String} participantId participantId
|
|
16157
16695
|
* @param {Object} body Transfer request
|
|
16158
|
-
* @deprecated
|
|
16159
16696
|
*/
|
|
16160
16697
|
postConversationsEmailParticipantReplace(conversationId, participantId, body) {
|
|
16161
16698
|
// verify the required parameter 'conversationId' is set
|
|
@@ -16520,7 +17057,6 @@ class ConversationsApi {
|
|
|
16520
17057
|
* @param {String} conversationId conversationId
|
|
16521
17058
|
* @param {String} participantId participantId
|
|
16522
17059
|
* @param {Object} body Transfer request
|
|
16523
|
-
* @deprecated
|
|
16524
17060
|
*/
|
|
16525
17061
|
postConversationsMessageParticipantReplace(conversationId, participantId, body) {
|
|
16526
17062
|
// verify the required parameter 'conversationId' is set
|
|
@@ -16775,6 +17311,31 @@ class ConversationsApi {
|
|
|
16775
17311
|
);
|
|
16776
17312
|
}
|
|
16777
17313
|
|
|
17314
|
+
/**
|
|
17315
|
+
* Create a messaging setting
|
|
17316
|
+
*
|
|
17317
|
+
* @param {Object} body MessagingSetting
|
|
17318
|
+
*/
|
|
17319
|
+
postConversationsMessagingSettings(body) {
|
|
17320
|
+
// verify the required parameter 'body' is set
|
|
17321
|
+
if (body === undefined || body === null) {
|
|
17322
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingSettings';
|
|
17323
|
+
}
|
|
17324
|
+
|
|
17325
|
+
return this.apiClient.callApi(
|
|
17326
|
+
'/api/v2/conversations/messaging/settings',
|
|
17327
|
+
'POST',
|
|
17328
|
+
{ },
|
|
17329
|
+
{ },
|
|
17330
|
+
{ },
|
|
17331
|
+
{ },
|
|
17332
|
+
body,
|
|
17333
|
+
['PureCloud OAuth'],
|
|
17334
|
+
['application/json'],
|
|
17335
|
+
['application/json']
|
|
17336
|
+
);
|
|
17337
|
+
}
|
|
17338
|
+
|
|
16778
17339
|
/**
|
|
16779
17340
|
* Create a Supported Content profile
|
|
16780
17341
|
*
|
|
@@ -17342,6 +17903,31 @@ class ConversationsApi {
|
|
|
17342
17903
|
);
|
|
17343
17904
|
}
|
|
17344
17905
|
|
|
17906
|
+
/**
|
|
17907
|
+
* Set the organization's default setting that may be applied to to integrations without settings
|
|
17908
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be assigned to it.
|
|
17909
|
+
* @param {Object} body MessagingSetting
|
|
17910
|
+
*/
|
|
17911
|
+
putConversationsMessagingSettingsDefault(body) {
|
|
17912
|
+
// verify the required parameter 'body' is set
|
|
17913
|
+
if (body === undefined || body === null) {
|
|
17914
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingSettingsDefault';
|
|
17915
|
+
}
|
|
17916
|
+
|
|
17917
|
+
return this.apiClient.callApi(
|
|
17918
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
17919
|
+
'PUT',
|
|
17920
|
+
{ },
|
|
17921
|
+
{ },
|
|
17922
|
+
{ },
|
|
17923
|
+
{ },
|
|
17924
|
+
body,
|
|
17925
|
+
['PureCloud OAuth'],
|
|
17926
|
+
['application/json'],
|
|
17927
|
+
['application/json']
|
|
17928
|
+
);
|
|
17929
|
+
}
|
|
17930
|
+
|
|
17345
17931
|
/**
|
|
17346
17932
|
* Set the organization's default supported content profile that may be assigned to an integration when it is created.
|
|
17347
17933
|
* When an integration is created a supported content ID may be assigned to it. If the supported content ID is not supplied, the default supported content profile will be assigned to it.
|
|
@@ -17488,7 +18074,7 @@ class DataExtensionsApi {
|
|
|
17488
18074
|
/**
|
|
17489
18075
|
* DataExtensions service.
|
|
17490
18076
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
17491
|
-
* @version
|
|
18077
|
+
* @version 173.0.0
|
|
17492
18078
|
*/
|
|
17493
18079
|
|
|
17494
18080
|
/**
|
|
@@ -17574,7 +18160,7 @@ class DownloadsApi {
|
|
|
17574
18160
|
/**
|
|
17575
18161
|
* Downloads service.
|
|
17576
18162
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
17577
|
-
* @version
|
|
18163
|
+
* @version 173.0.0
|
|
17578
18164
|
*/
|
|
17579
18165
|
|
|
17580
18166
|
/**
|
|
@@ -17622,11 +18208,76 @@ class DownloadsApi {
|
|
|
17622
18208
|
|
|
17623
18209
|
}
|
|
17624
18210
|
|
|
18211
|
+
class EmailsApi {
|
|
18212
|
+
/**
|
|
18213
|
+
* Emails service.
|
|
18214
|
+
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
18215
|
+
* @version 173.0.0
|
|
18216
|
+
*/
|
|
18217
|
+
|
|
18218
|
+
/**
|
|
18219
|
+
* Constructs a new EmailsApi.
|
|
18220
|
+
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
18221
|
+
* @class
|
|
18222
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
18223
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
18224
|
+
*/
|
|
18225
|
+
constructor(apiClient) {
|
|
18226
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
18227
|
+
}
|
|
18228
|
+
|
|
18229
|
+
|
|
18230
|
+
/**
|
|
18231
|
+
* Get email Contact Center settings
|
|
18232
|
+
*
|
|
18233
|
+
*/
|
|
18234
|
+
getEmailsSettings() {
|
|
18235
|
+
|
|
18236
|
+
return this.apiClient.callApi(
|
|
18237
|
+
'/api/v2/emails/settings',
|
|
18238
|
+
'GET',
|
|
18239
|
+
{ },
|
|
18240
|
+
{ },
|
|
18241
|
+
{ },
|
|
18242
|
+
{ },
|
|
18243
|
+
null,
|
|
18244
|
+
['PureCloud OAuth'],
|
|
18245
|
+
['application/json'],
|
|
18246
|
+
['application/json']
|
|
18247
|
+
);
|
|
18248
|
+
}
|
|
18249
|
+
|
|
18250
|
+
/**
|
|
18251
|
+
* Patch email Contact Center settings
|
|
18252
|
+
*
|
|
18253
|
+
* @param {Object} opts Optional parameters
|
|
18254
|
+
* @param {Object} opts.body
|
|
18255
|
+
*/
|
|
18256
|
+
patchEmailsSettings(opts) {
|
|
18257
|
+
opts = opts || {};
|
|
18258
|
+
|
|
18259
|
+
|
|
18260
|
+
return this.apiClient.callApi(
|
|
18261
|
+
'/api/v2/emails/settings',
|
|
18262
|
+
'PATCH',
|
|
18263
|
+
{ },
|
|
18264
|
+
{ },
|
|
18265
|
+
{ },
|
|
18266
|
+
{ },
|
|
18267
|
+
opts['body'],
|
|
18268
|
+
['PureCloud OAuth'],
|
|
18269
|
+
['application/json'],
|
|
18270
|
+
['application/json']
|
|
18271
|
+
);
|
|
18272
|
+
}
|
|
18273
|
+
|
|
18274
|
+
}
|
|
18275
|
+
|
|
17625
18276
|
class EventsApi {
|
|
17626
18277
|
/**
|
|
17627
18278
|
* Events service.
|
|
17628
18279
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
17629
|
-
* @version
|
|
18280
|
+
* @version 173.0.0
|
|
17630
18281
|
*/
|
|
17631
18282
|
|
|
17632
18283
|
/**
|
|
@@ -17722,7 +18373,7 @@ class ExternalContactsApi {
|
|
|
17722
18373
|
/**
|
|
17723
18374
|
* ExternalContacts service.
|
|
17724
18375
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
17725
|
-
* @version
|
|
18376
|
+
* @version 173.0.0
|
|
17726
18377
|
*/
|
|
17727
18378
|
|
|
17728
18379
|
/**
|
|
@@ -19680,7 +20331,7 @@ class FaxApi {
|
|
|
19680
20331
|
/**
|
|
19681
20332
|
* Fax service.
|
|
19682
20333
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
19683
|
-
* @version
|
|
20334
|
+
* @version 173.0.0
|
|
19684
20335
|
*/
|
|
19685
20336
|
|
|
19686
20337
|
/**
|
|
@@ -19851,7 +20502,7 @@ class FlowsApi {
|
|
|
19851
20502
|
/**
|
|
19852
20503
|
* Flows service.
|
|
19853
20504
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
19854
|
-
* @version
|
|
20505
|
+
* @version 173.0.0
|
|
19855
20506
|
*/
|
|
19856
20507
|
|
|
19857
20508
|
/**
|
|
@@ -20035,7 +20686,7 @@ class GamificationApi {
|
|
|
20035
20686
|
/**
|
|
20036
20687
|
* Gamification service.
|
|
20037
20688
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
20038
|
-
* @version
|
|
20689
|
+
* @version 173.0.0
|
|
20039
20690
|
*/
|
|
20040
20691
|
|
|
20041
20692
|
/**
|
|
@@ -22121,7 +22772,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
22121
22772
|
/**
|
|
22122
22773
|
* GeneralDataProtectionRegulation service.
|
|
22123
22774
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
22124
|
-
* @version
|
|
22775
|
+
* @version 173.0.0
|
|
22125
22776
|
*/
|
|
22126
22777
|
|
|
22127
22778
|
/**
|
|
@@ -22251,7 +22902,7 @@ class GeolocationApi {
|
|
|
22251
22902
|
/**
|
|
22252
22903
|
* Geolocation service.
|
|
22253
22904
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
22254
|
-
* @version
|
|
22905
|
+
* @version 173.0.0
|
|
22255
22906
|
*/
|
|
22256
22907
|
|
|
22257
22908
|
/**
|
|
@@ -22382,7 +23033,7 @@ class GreetingsApi {
|
|
|
22382
23033
|
/**
|
|
22383
23034
|
* Greetings service.
|
|
22384
23035
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
22385
|
-
* @version
|
|
23036
|
+
* @version 173.0.0
|
|
22386
23037
|
*/
|
|
22387
23038
|
|
|
22388
23039
|
/**
|
|
@@ -22837,7 +23488,7 @@ class GroupsApi {
|
|
|
22837
23488
|
/**
|
|
22838
23489
|
* Groups service.
|
|
22839
23490
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
22840
|
-
* @version
|
|
23491
|
+
* @version 173.0.0
|
|
22841
23492
|
*/
|
|
22842
23493
|
|
|
22843
23494
|
/**
|
|
@@ -23356,7 +24007,7 @@ class IdentityProviderApi {
|
|
|
23356
24007
|
/**
|
|
23357
24008
|
* IdentityProvider service.
|
|
23358
24009
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
23359
|
-
* @version
|
|
24010
|
+
* @version 173.0.0
|
|
23360
24011
|
*/
|
|
23361
24012
|
|
|
23362
24013
|
/**
|
|
@@ -24112,7 +24763,7 @@ class InfrastructureAsCodeApi {
|
|
|
24112
24763
|
/**
|
|
24113
24764
|
* InfrastructureAsCode service.
|
|
24114
24765
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
24115
|
-
* @version
|
|
24766
|
+
* @version 173.0.0
|
|
24116
24767
|
*/
|
|
24117
24768
|
|
|
24118
24769
|
/**
|
|
@@ -24279,7 +24930,7 @@ class IntegrationsApi {
|
|
|
24279
24930
|
/**
|
|
24280
24931
|
* Integrations service.
|
|
24281
24932
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
24282
|
-
* @version
|
|
24933
|
+
* @version 173.0.0
|
|
24283
24934
|
*/
|
|
24284
24935
|
|
|
24285
24936
|
/**
|
|
@@ -26241,7 +26892,7 @@ class JourneyApi {
|
|
|
26241
26892
|
/**
|
|
26242
26893
|
* Journey service.
|
|
26243
26894
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
26244
|
-
* @version
|
|
26895
|
+
* @version 173.0.0
|
|
26245
26896
|
*/
|
|
26246
26897
|
|
|
26247
26898
|
/**
|
|
@@ -27344,7 +27995,7 @@ class KnowledgeApi {
|
|
|
27344
27995
|
/**
|
|
27345
27996
|
* Knowledge service.
|
|
27346
27997
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
27347
|
-
* @version
|
|
27998
|
+
* @version 173.0.0
|
|
27348
27999
|
*/
|
|
27349
28000
|
|
|
27350
28001
|
/**
|
|
@@ -28610,6 +29261,8 @@ class KnowledgeApi {
|
|
|
28610
29261
|
* @param {String} groupId The ID of the group to be retrieved.
|
|
28611
29262
|
* @param {Object} opts Optional parameters
|
|
28612
29263
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
29264
|
+
* @param {String} opts.dateStart The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
29265
|
+
* @param {String} opts.dateEnd The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
28613
29266
|
*/
|
|
28614
29267
|
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
28615
29268
|
opts = opts || {};
|
|
@@ -28627,7 +29280,7 @@ class KnowledgeApi {
|
|
|
28627
29280
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
28628
29281
|
'GET',
|
|
28629
29282
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
28630
|
-
{ 'app': opts['app'] },
|
|
29283
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
28631
29284
|
{ },
|
|
28632
29285
|
{ },
|
|
28633
29286
|
null,
|
|
@@ -28645,6 +29298,8 @@ class KnowledgeApi {
|
|
|
28645
29298
|
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
28646
29299
|
* @param {Object} opts Optional parameters
|
|
28647
29300
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
29301
|
+
* @param {String} opts.dateStart The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
29302
|
+
* @param {String} opts.dateEnd The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
28648
29303
|
*/
|
|
28649
29304
|
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
28650
29305
|
opts = opts || {};
|
|
@@ -28666,7 +29321,7 @@ class KnowledgeApi {
|
|
|
28666
29321
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
28667
29322
|
'GET',
|
|
28668
29323
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
28669
|
-
{ 'app': opts['app'] },
|
|
29324
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
28670
29325
|
{ },
|
|
28671
29326
|
{ },
|
|
28672
29327
|
null,
|
|
@@ -28682,6 +29337,8 @@ class KnowledgeApi {
|
|
|
28682
29337
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28683
29338
|
* @param {Object} opts Optional parameters
|
|
28684
29339
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
29340
|
+
* @param {String} opts.dateStart The start date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
29341
|
+
* @param {String} opts.dateEnd The end date to be used for filtering phrases. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
28685
29342
|
*/
|
|
28686
29343
|
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
28687
29344
|
opts = opts || {};
|
|
@@ -28695,7 +29352,7 @@ class KnowledgeApi {
|
|
|
28695
29352
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
28696
29353
|
'GET',
|
|
28697
29354
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
28698
|
-
{ 'app': opts['app'] },
|
|
29355
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
28699
29356
|
{ },
|
|
28700
29357
|
{ },
|
|
28701
29358
|
null,
|
|
@@ -29974,7 +30631,7 @@ class LanguageUnderstandingApi {
|
|
|
29974
30631
|
/**
|
|
29975
30632
|
* LanguageUnderstanding service.
|
|
29976
30633
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
29977
|
-
* @version
|
|
30634
|
+
* @version 173.0.0
|
|
29978
30635
|
*/
|
|
29979
30636
|
|
|
29980
30637
|
/**
|
|
@@ -30987,7 +31644,7 @@ class LanguagesApi {
|
|
|
30987
31644
|
/**
|
|
30988
31645
|
* Languages service.
|
|
30989
31646
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
30990
|
-
* @version
|
|
31647
|
+
* @version 173.0.0
|
|
30991
31648
|
*/
|
|
30992
31649
|
|
|
30993
31650
|
/**
|
|
@@ -31209,7 +31866,7 @@ class LearningApi {
|
|
|
31209
31866
|
/**
|
|
31210
31867
|
* Learning service.
|
|
31211
31868
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
31212
|
-
* @version
|
|
31869
|
+
* @version 173.0.0
|
|
31213
31870
|
*/
|
|
31214
31871
|
|
|
31215
31872
|
/**
|
|
@@ -32024,7 +32681,7 @@ class LicenseApi {
|
|
|
32024
32681
|
/**
|
|
32025
32682
|
* License service.
|
|
32026
32683
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
32027
|
-
* @version
|
|
32684
|
+
* @version 173.0.0
|
|
32028
32685
|
*/
|
|
32029
32686
|
|
|
32030
32687
|
/**
|
|
@@ -32085,7 +32742,7 @@ class LicenseApi {
|
|
|
32085
32742
|
}
|
|
32086
32743
|
|
|
32087
32744
|
/**
|
|
32088
|
-
*
|
|
32745
|
+
* Deprecated - no alternative required. This operation will always return 'true' for requested toggles
|
|
32089
32746
|
*
|
|
32090
32747
|
* @param {String} featureName featureName
|
|
32091
32748
|
*/
|
|
@@ -32208,7 +32865,7 @@ class LicenseApi {
|
|
|
32208
32865
|
}
|
|
32209
32866
|
|
|
32210
32867
|
/**
|
|
32211
|
-
*
|
|
32868
|
+
* Deprecated. No alternative required - this endpoint has no effect
|
|
32212
32869
|
*
|
|
32213
32870
|
* @param {String} featureName featureName
|
|
32214
32871
|
*/
|
|
@@ -32262,7 +32919,7 @@ class LocationsApi {
|
|
|
32262
32919
|
/**
|
|
32263
32920
|
* Locations service.
|
|
32264
32921
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
32265
|
-
* @version
|
|
32922
|
+
* @version 173.0.0
|
|
32266
32923
|
*/
|
|
32267
32924
|
|
|
32268
32925
|
/**
|
|
@@ -32498,7 +33155,7 @@ class MessagingApi {
|
|
|
32498
33155
|
/**
|
|
32499
33156
|
* Messaging service.
|
|
32500
33157
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
32501
|
-
* @version
|
|
33158
|
+
* @version 173.0.0
|
|
32502
33159
|
*/
|
|
32503
33160
|
|
|
32504
33161
|
/**
|
|
@@ -32513,6 +33170,53 @@ class MessagingApi {
|
|
|
32513
33170
|
}
|
|
32514
33171
|
|
|
32515
33172
|
|
|
33173
|
+
/**
|
|
33174
|
+
* Delete a messaging setting
|
|
33175
|
+
*
|
|
33176
|
+
* @param {String} messageSettingId Message Settings ID
|
|
33177
|
+
* @deprecated
|
|
33178
|
+
*/
|
|
33179
|
+
deleteMessagingSetting(messageSettingId) {
|
|
33180
|
+
// verify the required parameter 'messageSettingId' is set
|
|
33181
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
33182
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteMessagingSetting';
|
|
33183
|
+
}
|
|
33184
|
+
|
|
33185
|
+
return this.apiClient.callApi(
|
|
33186
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
33187
|
+
'DELETE',
|
|
33188
|
+
{ 'messageSettingId': messageSettingId },
|
|
33189
|
+
{ },
|
|
33190
|
+
{ },
|
|
33191
|
+
{ },
|
|
33192
|
+
null,
|
|
33193
|
+
['PureCloud OAuth'],
|
|
33194
|
+
['application/json'],
|
|
33195
|
+
['application/json']
|
|
33196
|
+
);
|
|
33197
|
+
}
|
|
33198
|
+
|
|
33199
|
+
/**
|
|
33200
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
33201
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
|
|
33202
|
+
* @deprecated
|
|
33203
|
+
*/
|
|
33204
|
+
deleteMessagingSettingsDefault() {
|
|
33205
|
+
|
|
33206
|
+
return this.apiClient.callApi(
|
|
33207
|
+
'/api/v2/messaging/settings/default',
|
|
33208
|
+
'DELETE',
|
|
33209
|
+
{ },
|
|
33210
|
+
{ },
|
|
33211
|
+
{ },
|
|
33212
|
+
{ },
|
|
33213
|
+
null,
|
|
33214
|
+
['PureCloud OAuth'],
|
|
33215
|
+
['application/json'],
|
|
33216
|
+
['application/json']
|
|
33217
|
+
);
|
|
33218
|
+
}
|
|
33219
|
+
|
|
32516
33220
|
/**
|
|
32517
33221
|
* Delete a supported content profile
|
|
32518
33222
|
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -32539,6 +33243,79 @@ class MessagingApi {
|
|
|
32539
33243
|
);
|
|
32540
33244
|
}
|
|
32541
33245
|
|
|
33246
|
+
/**
|
|
33247
|
+
* Get a messaging setting
|
|
33248
|
+
*
|
|
33249
|
+
* @param {String} messageSettingId Message Settings ID
|
|
33250
|
+
* @deprecated
|
|
33251
|
+
*/
|
|
33252
|
+
getMessagingSetting(messageSettingId) {
|
|
33253
|
+
// verify the required parameter 'messageSettingId' is set
|
|
33254
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
33255
|
+
throw 'Missing the required parameter "messageSettingId" when calling getMessagingSetting';
|
|
33256
|
+
}
|
|
33257
|
+
|
|
33258
|
+
return this.apiClient.callApi(
|
|
33259
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
33260
|
+
'GET',
|
|
33261
|
+
{ 'messageSettingId': messageSettingId },
|
|
33262
|
+
{ },
|
|
33263
|
+
{ },
|
|
33264
|
+
{ },
|
|
33265
|
+
null,
|
|
33266
|
+
['PureCloud OAuth'],
|
|
33267
|
+
['application/json'],
|
|
33268
|
+
['application/json']
|
|
33269
|
+
);
|
|
33270
|
+
}
|
|
33271
|
+
|
|
33272
|
+
/**
|
|
33273
|
+
* Get a list of messaging settings
|
|
33274
|
+
*
|
|
33275
|
+
* @param {Object} opts Optional parameters
|
|
33276
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
33277
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33278
|
+
* @deprecated
|
|
33279
|
+
*/
|
|
33280
|
+
getMessagingSettings(opts) {
|
|
33281
|
+
opts = opts || {};
|
|
33282
|
+
|
|
33283
|
+
|
|
33284
|
+
return this.apiClient.callApi(
|
|
33285
|
+
'/api/v2/messaging/settings',
|
|
33286
|
+
'GET',
|
|
33287
|
+
{ },
|
|
33288
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
33289
|
+
{ },
|
|
33290
|
+
{ },
|
|
33291
|
+
null,
|
|
33292
|
+
['PureCloud OAuth'],
|
|
33293
|
+
['application/json'],
|
|
33294
|
+
['application/json']
|
|
33295
|
+
);
|
|
33296
|
+
}
|
|
33297
|
+
|
|
33298
|
+
/**
|
|
33299
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
33300
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
|
|
33301
|
+
* @deprecated
|
|
33302
|
+
*/
|
|
33303
|
+
getMessagingSettingsDefault() {
|
|
33304
|
+
|
|
33305
|
+
return this.apiClient.callApi(
|
|
33306
|
+
'/api/v2/messaging/settings/default',
|
|
33307
|
+
'GET',
|
|
33308
|
+
{ },
|
|
33309
|
+
{ },
|
|
33310
|
+
{ },
|
|
33311
|
+
{ },
|
|
33312
|
+
null,
|
|
33313
|
+
['PureCloud OAuth'],
|
|
33314
|
+
['application/json'],
|
|
33315
|
+
['application/json']
|
|
33316
|
+
);
|
|
33317
|
+
}
|
|
33318
|
+
|
|
32542
33319
|
/**
|
|
32543
33320
|
* Get a list of Supported Content profiles
|
|
32544
33321
|
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -32591,6 +33368,37 @@ class MessagingApi {
|
|
|
32591
33368
|
);
|
|
32592
33369
|
}
|
|
32593
33370
|
|
|
33371
|
+
/**
|
|
33372
|
+
* Update a messaging setting
|
|
33373
|
+
*
|
|
33374
|
+
* @param {String} messageSettingId Message Settings ID
|
|
33375
|
+
* @param {Object} body MessagingSetting
|
|
33376
|
+
* @deprecated
|
|
33377
|
+
*/
|
|
33378
|
+
patchMessagingSetting(messageSettingId, body) {
|
|
33379
|
+
// verify the required parameter 'messageSettingId' is set
|
|
33380
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
33381
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchMessagingSetting';
|
|
33382
|
+
}
|
|
33383
|
+
// verify the required parameter 'body' is set
|
|
33384
|
+
if (body === undefined || body === null) {
|
|
33385
|
+
throw 'Missing the required parameter "body" when calling patchMessagingSetting';
|
|
33386
|
+
}
|
|
33387
|
+
|
|
33388
|
+
return this.apiClient.callApi(
|
|
33389
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
33390
|
+
'PATCH',
|
|
33391
|
+
{ 'messageSettingId': messageSettingId },
|
|
33392
|
+
{ },
|
|
33393
|
+
{ },
|
|
33394
|
+
{ },
|
|
33395
|
+
body,
|
|
33396
|
+
['PureCloud OAuth'],
|
|
33397
|
+
['application/json'],
|
|
33398
|
+
['application/json']
|
|
33399
|
+
);
|
|
33400
|
+
}
|
|
33401
|
+
|
|
32594
33402
|
/**
|
|
32595
33403
|
* Update a supported content profile
|
|
32596
33404
|
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -32622,6 +33430,32 @@ class MessagingApi {
|
|
|
32622
33430
|
);
|
|
32623
33431
|
}
|
|
32624
33432
|
|
|
33433
|
+
/**
|
|
33434
|
+
* Create a messaging setting
|
|
33435
|
+
*
|
|
33436
|
+
* @param {Object} body MessagingSetting
|
|
33437
|
+
* @deprecated
|
|
33438
|
+
*/
|
|
33439
|
+
postMessagingSettings(body) {
|
|
33440
|
+
// verify the required parameter 'body' is set
|
|
33441
|
+
if (body === undefined || body === null) {
|
|
33442
|
+
throw 'Missing the required parameter "body" when calling postMessagingSettings';
|
|
33443
|
+
}
|
|
33444
|
+
|
|
33445
|
+
return this.apiClient.callApi(
|
|
33446
|
+
'/api/v2/messaging/settings',
|
|
33447
|
+
'POST',
|
|
33448
|
+
{ },
|
|
33449
|
+
{ },
|
|
33450
|
+
{ },
|
|
33451
|
+
{ },
|
|
33452
|
+
body,
|
|
33453
|
+
['PureCloud OAuth'],
|
|
33454
|
+
['application/json'],
|
|
33455
|
+
['application/json']
|
|
33456
|
+
);
|
|
33457
|
+
}
|
|
33458
|
+
|
|
32625
33459
|
/**
|
|
32626
33460
|
* Create a Supported Content profile
|
|
32627
33461
|
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -32648,13 +33482,39 @@ class MessagingApi {
|
|
|
32648
33482
|
);
|
|
32649
33483
|
}
|
|
32650
33484
|
|
|
33485
|
+
/**
|
|
33486
|
+
* Set the organization's default settings that may be applied to an integration when it is created.
|
|
33487
|
+
* When an integration is created a settings ID may be assigned to it. If the settings ID is not supplied, the default settings will be applied to it.
|
|
33488
|
+
* @param {Object} body Messaging Setting ID
|
|
33489
|
+
* @deprecated
|
|
33490
|
+
*/
|
|
33491
|
+
putMessagingSettingsDefault(body) {
|
|
33492
|
+
// verify the required parameter 'body' is set
|
|
33493
|
+
if (body === undefined || body === null) {
|
|
33494
|
+
throw 'Missing the required parameter "body" when calling putMessagingSettingsDefault';
|
|
33495
|
+
}
|
|
33496
|
+
|
|
33497
|
+
return this.apiClient.callApi(
|
|
33498
|
+
'/api/v2/messaging/settings/default',
|
|
33499
|
+
'PUT',
|
|
33500
|
+
{ },
|
|
33501
|
+
{ },
|
|
33502
|
+
{ },
|
|
33503
|
+
{ },
|
|
33504
|
+
body,
|
|
33505
|
+
['PureCloud OAuth'],
|
|
33506
|
+
['application/json'],
|
|
33507
|
+
['application/json']
|
|
33508
|
+
);
|
|
33509
|
+
}
|
|
33510
|
+
|
|
32651
33511
|
}
|
|
32652
33512
|
|
|
32653
33513
|
class MobileDevicesApi {
|
|
32654
33514
|
/**
|
|
32655
33515
|
* MobileDevices service.
|
|
32656
33516
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
32657
|
-
* @version
|
|
33517
|
+
* @version 173.0.0
|
|
32658
33518
|
*/
|
|
32659
33519
|
|
|
32660
33520
|
/**
|
|
@@ -32805,7 +33665,7 @@ class NotificationsApi {
|
|
|
32805
33665
|
/**
|
|
32806
33666
|
* Notifications service.
|
|
32807
33667
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
32808
|
-
* @version
|
|
33668
|
+
* @version 173.0.0
|
|
32809
33669
|
*/
|
|
32810
33670
|
|
|
32811
33671
|
/**
|
|
@@ -33038,7 +33898,7 @@ class OAuthApi {
|
|
|
33038
33898
|
/**
|
|
33039
33899
|
* OAuth service.
|
|
33040
33900
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
33041
|
-
* @version
|
|
33901
|
+
* @version 173.0.0
|
|
33042
33902
|
*/
|
|
33043
33903
|
|
|
33044
33904
|
/**
|
|
@@ -33404,7 +34264,7 @@ class ObjectsApi {
|
|
|
33404
34264
|
/**
|
|
33405
34265
|
* Objects service.
|
|
33406
34266
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
33407
|
-
* @version
|
|
34267
|
+
* @version 173.0.0
|
|
33408
34268
|
*/
|
|
33409
34269
|
|
|
33410
34270
|
/**
|
|
@@ -33675,7 +34535,7 @@ class OrganizationApi {
|
|
|
33675
34535
|
/**
|
|
33676
34536
|
* Organization service.
|
|
33677
34537
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
33678
|
-
* @version
|
|
34538
|
+
* @version 173.0.0
|
|
33679
34539
|
*/
|
|
33680
34540
|
|
|
33681
34541
|
/**
|
|
@@ -34130,7 +34990,7 @@ class OrganizationAuthorizationApi {
|
|
|
34130
34990
|
/**
|
|
34131
34991
|
* OrganizationAuthorization service.
|
|
34132
34992
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
34133
|
-
* @version
|
|
34993
|
+
* @version 173.0.0
|
|
34134
34994
|
*/
|
|
34135
34995
|
|
|
34136
34996
|
/**
|
|
@@ -35477,7 +36337,7 @@ class OutboundApi {
|
|
|
35477
36337
|
/**
|
|
35478
36338
|
* Outbound service.
|
|
35479
36339
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
35480
|
-
* @version
|
|
36340
|
+
* @version 173.0.0
|
|
35481
36341
|
*/
|
|
35482
36342
|
|
|
35483
36343
|
/**
|
|
@@ -39099,7 +39959,7 @@ class PresenceApi {
|
|
|
39099
39959
|
/**
|
|
39100
39960
|
* Presence service.
|
|
39101
39961
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39102
|
-
* @version
|
|
39962
|
+
* @version 173.0.0
|
|
39103
39963
|
*/
|
|
39104
39964
|
|
|
39105
39965
|
/**
|
|
@@ -39838,7 +40698,7 @@ class ProcessAutomationApi {
|
|
|
39838
40698
|
/**
|
|
39839
40699
|
* ProcessAutomation service.
|
|
39840
40700
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
39841
|
-
* @version
|
|
40701
|
+
* @version 173.0.0
|
|
39842
40702
|
*/
|
|
39843
40703
|
|
|
39844
40704
|
/**
|
|
@@ -40077,7 +40937,7 @@ class QualityApi {
|
|
|
40077
40937
|
/**
|
|
40078
40938
|
* Quality service.
|
|
40079
40939
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40080
|
-
* @version
|
|
40940
|
+
* @version 173.0.0
|
|
40081
40941
|
*/
|
|
40082
40942
|
|
|
40083
40943
|
/**
|
|
@@ -41829,7 +42689,7 @@ class RecordingApi {
|
|
|
41829
42689
|
/**
|
|
41830
42690
|
* Recording service.
|
|
41831
42691
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
41832
|
-
* @version
|
|
42692
|
+
* @version 173.0.0
|
|
41833
42693
|
*/
|
|
41834
42694
|
|
|
41835
42695
|
/**
|
|
@@ -43466,7 +44326,7 @@ class ResponseManagementApi {
|
|
|
43466
44326
|
/**
|
|
43467
44327
|
* ResponseManagement service.
|
|
43468
44328
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
43469
|
-
* @version
|
|
44329
|
+
* @version 173.0.0
|
|
43470
44330
|
*/
|
|
43471
44331
|
|
|
43472
44332
|
/**
|
|
@@ -43951,7 +44811,7 @@ class RoutingApi {
|
|
|
43951
44811
|
/**
|
|
43952
44812
|
* Routing service.
|
|
43953
44813
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
43954
|
-
* @version
|
|
44814
|
+
* @version 173.0.0
|
|
43955
44815
|
*/
|
|
43956
44816
|
|
|
43957
44817
|
/**
|
|
@@ -47658,7 +48518,7 @@ class SCIMApi {
|
|
|
47658
48518
|
/**
|
|
47659
48519
|
* SCIM service.
|
|
47660
48520
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
47661
|
-
* @version
|
|
48521
|
+
* @version 173.0.0
|
|
47662
48522
|
*/
|
|
47663
48523
|
|
|
47664
48524
|
/**
|
|
@@ -48535,7 +49395,7 @@ class ScriptsApi {
|
|
|
48535
49395
|
/**
|
|
48536
49396
|
* Scripts service.
|
|
48537
49397
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
48538
|
-
* @version
|
|
49398
|
+
* @version 173.0.0
|
|
48539
49399
|
*/
|
|
48540
49400
|
|
|
48541
49401
|
/**
|
|
@@ -48979,7 +49839,7 @@ class SearchApi {
|
|
|
48979
49839
|
/**
|
|
48980
49840
|
* Search service.
|
|
48981
49841
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
48982
|
-
* @version
|
|
49842
|
+
* @version 173.0.0
|
|
48983
49843
|
*/
|
|
48984
49844
|
|
|
48985
49845
|
/**
|
|
@@ -49664,11 +50524,76 @@ class SearchApi {
|
|
|
49664
50524
|
|
|
49665
50525
|
}
|
|
49666
50526
|
|
|
50527
|
+
class SettingsApi {
|
|
50528
|
+
/**
|
|
50529
|
+
* Settings service.
|
|
50530
|
+
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
50531
|
+
* @version 173.0.0
|
|
50532
|
+
*/
|
|
50533
|
+
|
|
50534
|
+
/**
|
|
50535
|
+
* Constructs a new SettingsApi.
|
|
50536
|
+
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
50537
|
+
* @class
|
|
50538
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
50539
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
50540
|
+
*/
|
|
50541
|
+
constructor(apiClient) {
|
|
50542
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
50543
|
+
}
|
|
50544
|
+
|
|
50545
|
+
|
|
50546
|
+
/**
|
|
50547
|
+
* Get email Contact Center settings
|
|
50548
|
+
*
|
|
50549
|
+
*/
|
|
50550
|
+
getEmailsSettings() {
|
|
50551
|
+
|
|
50552
|
+
return this.apiClient.callApi(
|
|
50553
|
+
'/api/v2/emails/settings',
|
|
50554
|
+
'GET',
|
|
50555
|
+
{ },
|
|
50556
|
+
{ },
|
|
50557
|
+
{ },
|
|
50558
|
+
{ },
|
|
50559
|
+
null,
|
|
50560
|
+
['PureCloud OAuth'],
|
|
50561
|
+
['application/json'],
|
|
50562
|
+
['application/json']
|
|
50563
|
+
);
|
|
50564
|
+
}
|
|
50565
|
+
|
|
50566
|
+
/**
|
|
50567
|
+
* Patch email Contact Center settings
|
|
50568
|
+
*
|
|
50569
|
+
* @param {Object} opts Optional parameters
|
|
50570
|
+
* @param {Object} opts.body
|
|
50571
|
+
*/
|
|
50572
|
+
patchEmailsSettings(opts) {
|
|
50573
|
+
opts = opts || {};
|
|
50574
|
+
|
|
50575
|
+
|
|
50576
|
+
return this.apiClient.callApi(
|
|
50577
|
+
'/api/v2/emails/settings',
|
|
50578
|
+
'PATCH',
|
|
50579
|
+
{ },
|
|
50580
|
+
{ },
|
|
50581
|
+
{ },
|
|
50582
|
+
{ },
|
|
50583
|
+
opts['body'],
|
|
50584
|
+
['PureCloud OAuth'],
|
|
50585
|
+
['application/json'],
|
|
50586
|
+
['application/json']
|
|
50587
|
+
);
|
|
50588
|
+
}
|
|
50589
|
+
|
|
50590
|
+
}
|
|
50591
|
+
|
|
49667
50592
|
class SpeechTextAnalyticsApi {
|
|
49668
50593
|
/**
|
|
49669
50594
|
* SpeechTextAnalytics service.
|
|
49670
50595
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
49671
|
-
* @version
|
|
50596
|
+
* @version 173.0.0
|
|
49672
50597
|
*/
|
|
49673
50598
|
|
|
49674
50599
|
/**
|
|
@@ -49837,6 +50762,36 @@ class SpeechTextAnalyticsApi {
|
|
|
49837
50762
|
);
|
|
49838
50763
|
}
|
|
49839
50764
|
|
|
50765
|
+
/**
|
|
50766
|
+
* Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation
|
|
50767
|
+
*
|
|
50768
|
+
* @param {String} conversationId Conversation ID
|
|
50769
|
+
* @param {String} communicationId Communication ID
|
|
50770
|
+
*/
|
|
50771
|
+
getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId, communicationId) {
|
|
50772
|
+
// verify the required parameter 'conversationId' is set
|
|
50773
|
+
if (conversationId === undefined || conversationId === null) {
|
|
50774
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
50775
|
+
}
|
|
50776
|
+
// verify the required parameter 'communicationId' is set
|
|
50777
|
+
if (communicationId === undefined || communicationId === null) {
|
|
50778
|
+
throw 'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
50779
|
+
}
|
|
50780
|
+
|
|
50781
|
+
return this.apiClient.callApi(
|
|
50782
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls',
|
|
50783
|
+
'GET',
|
|
50784
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
50785
|
+
{ },
|
|
50786
|
+
{ },
|
|
50787
|
+
{ },
|
|
50788
|
+
null,
|
|
50789
|
+
['PureCloud OAuth'],
|
|
50790
|
+
['application/json'],
|
|
50791
|
+
['application/json']
|
|
50792
|
+
);
|
|
50793
|
+
}
|
|
50794
|
+
|
|
49840
50795
|
/**
|
|
49841
50796
|
* Get a Speech and Text Analytics program by id
|
|
49842
50797
|
*
|
|
@@ -50621,7 +51576,7 @@ class StationsApi {
|
|
|
50621
51576
|
/**
|
|
50622
51577
|
* Stations service.
|
|
50623
51578
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
50624
|
-
* @version
|
|
51579
|
+
* @version 173.0.0
|
|
50625
51580
|
*/
|
|
50626
51581
|
|
|
50627
51582
|
/**
|
|
@@ -50723,7 +51678,7 @@ class SuggestApi {
|
|
|
50723
51678
|
/**
|
|
50724
51679
|
* Suggest service.
|
|
50725
51680
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
50726
|
-
* @version
|
|
51681
|
+
* @version 173.0.0
|
|
50727
51682
|
*/
|
|
50728
51683
|
|
|
50729
51684
|
/**
|
|
@@ -50862,7 +51817,7 @@ class TaskManagementApi {
|
|
|
50862
51817
|
/**
|
|
50863
51818
|
* TaskManagement service.
|
|
50864
51819
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
50865
|
-
* @version
|
|
51820
|
+
* @version 173.0.0
|
|
50866
51821
|
*/
|
|
50867
51822
|
|
|
50868
51823
|
/**
|
|
@@ -52143,7 +53098,7 @@ class TeamsApi {
|
|
|
52143
53098
|
/**
|
|
52144
53099
|
* Teams service.
|
|
52145
53100
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
52146
|
-
* @version
|
|
53101
|
+
* @version 173.0.0
|
|
52147
53102
|
*/
|
|
52148
53103
|
|
|
52149
53104
|
/**
|
|
@@ -52445,7 +53400,7 @@ class TelephonyApi {
|
|
|
52445
53400
|
/**
|
|
52446
53401
|
* Telephony service.
|
|
52447
53402
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
52448
|
-
* @version
|
|
53403
|
+
* @version 173.0.0
|
|
52449
53404
|
*/
|
|
52450
53405
|
|
|
52451
53406
|
/**
|
|
@@ -52573,7 +53528,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
52573
53528
|
/**
|
|
52574
53529
|
* TelephonyProvidersEdge service.
|
|
52575
53530
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
52576
|
-
* @version
|
|
53531
|
+
* @version 173.0.0
|
|
52577
53532
|
*/
|
|
52578
53533
|
|
|
52579
53534
|
/**
|
|
@@ -54029,7 +54984,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
54029
54984
|
/**
|
|
54030
54985
|
* Get the metrics for a list of edges.
|
|
54031
54986
|
*
|
|
54032
|
-
* @param {String} edgeIds Comma separated list of Edge Id's
|
|
54987
|
+
* @param {String} edgeIds Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.
|
|
54033
54988
|
*/
|
|
54034
54989
|
getTelephonyProvidersEdgesMetrics(edgeIds) {
|
|
54035
54990
|
// verify the required parameter 'edgeIds' is set
|
|
@@ -55862,7 +56817,7 @@ class TextbotsApi {
|
|
|
55862
56817
|
/**
|
|
55863
56818
|
* Textbots service.
|
|
55864
56819
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
55865
|
-
* @version
|
|
56820
|
+
* @version 173.0.0
|
|
55866
56821
|
*/
|
|
55867
56822
|
|
|
55868
56823
|
/**
|
|
@@ -55990,7 +56945,7 @@ class TokensApi {
|
|
|
55990
56945
|
/**
|
|
55991
56946
|
* Tokens service.
|
|
55992
56947
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
55993
|
-
* @version
|
|
56948
|
+
* @version 173.0.0
|
|
55994
56949
|
*/
|
|
55995
56950
|
|
|
55996
56951
|
/**
|
|
@@ -56142,7 +57097,7 @@ class UploadsApi {
|
|
|
56142
57097
|
/**
|
|
56143
57098
|
* Uploads service.
|
|
56144
57099
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
56145
|
-
* @version
|
|
57100
|
+
* @version 173.0.0
|
|
56146
57101
|
*/
|
|
56147
57102
|
|
|
56148
57103
|
/**
|
|
@@ -56318,7 +57273,7 @@ class UsageApi {
|
|
|
56318
57273
|
/**
|
|
56319
57274
|
* Usage service.
|
|
56320
57275
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
56321
|
-
* @version
|
|
57276
|
+
* @version 173.0.0
|
|
56322
57277
|
*/
|
|
56323
57278
|
|
|
56324
57279
|
/**
|
|
@@ -56528,7 +57483,7 @@ class UserRecordingsApi {
|
|
|
56528
57483
|
/**
|
|
56529
57484
|
* UserRecordings service.
|
|
56530
57485
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
56531
|
-
* @version
|
|
57486
|
+
* @version 173.0.0
|
|
56532
57487
|
*/
|
|
56533
57488
|
|
|
56534
57489
|
/**
|
|
@@ -56713,7 +57668,7 @@ class UsersApi {
|
|
|
56713
57668
|
/**
|
|
56714
57669
|
* Users service.
|
|
56715
57670
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
56716
|
-
* @version
|
|
57671
|
+
* @version 173.0.0
|
|
56717
57672
|
*/
|
|
56718
57673
|
|
|
56719
57674
|
/**
|
|
@@ -59274,7 +60229,7 @@ class UtilitiesApi {
|
|
|
59274
60229
|
/**
|
|
59275
60230
|
* Utilities service.
|
|
59276
60231
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
59277
|
-
* @version
|
|
60232
|
+
* @version 173.0.0
|
|
59278
60233
|
*/
|
|
59279
60234
|
|
|
59280
60235
|
/**
|
|
@@ -59385,7 +60340,7 @@ class VoicemailApi {
|
|
|
59385
60340
|
/**
|
|
59386
60341
|
* Voicemail service.
|
|
59387
60342
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
59388
|
-
* @version
|
|
60343
|
+
* @version 173.0.0
|
|
59389
60344
|
*/
|
|
59390
60345
|
|
|
59391
60346
|
/**
|
|
@@ -60052,7 +61007,7 @@ class WebChatApi {
|
|
|
60052
61007
|
/**
|
|
60053
61008
|
* WebChat service.
|
|
60054
61009
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
60055
|
-
* @version
|
|
61010
|
+
* @version 173.0.0
|
|
60056
61011
|
*/
|
|
60057
61012
|
|
|
60058
61013
|
/**
|
|
@@ -60601,7 +61556,7 @@ class WebDeploymentsApi {
|
|
|
60601
61556
|
/**
|
|
60602
61557
|
* WebDeployments service.
|
|
60603
61558
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
60604
|
-
* @version
|
|
61559
|
+
* @version 173.0.0
|
|
60605
61560
|
*/
|
|
60606
61561
|
|
|
60607
61562
|
/**
|
|
@@ -61123,7 +62078,7 @@ class WebMessagingApi {
|
|
|
61123
62078
|
/**
|
|
61124
62079
|
* WebMessaging service.
|
|
61125
62080
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
61126
|
-
* @version
|
|
62081
|
+
* @version 173.0.0
|
|
61127
62082
|
*/
|
|
61128
62083
|
|
|
61129
62084
|
/**
|
|
@@ -61169,7 +62124,7 @@ class WidgetsApi {
|
|
|
61169
62124
|
/**
|
|
61170
62125
|
* Widgets service.
|
|
61171
62126
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
61172
|
-
* @version
|
|
62127
|
+
* @version 173.0.0
|
|
61173
62128
|
*/
|
|
61174
62129
|
|
|
61175
62130
|
/**
|
|
@@ -61315,7 +62270,7 @@ class WorkforceManagementApi {
|
|
|
61315
62270
|
/**
|
|
61316
62271
|
* WorkforceManagement service.
|
|
61317
62272
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
61318
|
-
* @version
|
|
62273
|
+
* @version 173.0.0
|
|
61319
62274
|
*/
|
|
61320
62275
|
|
|
61321
62276
|
/**
|
|
@@ -62054,8 +63009,8 @@ class WorkforceManagementApi {
|
|
|
62054
63009
|
*
|
|
62055
63010
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
62056
63011
|
* @param {Object} opts Optional parameters
|
|
62057
|
-
* @param {Object} opts.feature
|
|
62058
|
-
* @param {String} opts.divisionId
|
|
63012
|
+
* @param {Object} opts.feature If specified, the list of management units for which the user is authorized to use the requested feature will be returned
|
|
63013
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
62059
63014
|
*/
|
|
62060
63015
|
getWorkforcemanagementBusinessunitManagementunits(businessUnitId, opts) {
|
|
62061
63016
|
opts = opts || {};
|
|
@@ -62694,8 +63649,8 @@ class WorkforceManagementApi {
|
|
|
62694
63649
|
* Get business units
|
|
62695
63650
|
*
|
|
62696
63651
|
* @param {Object} opts Optional parameters
|
|
62697
|
-
* @param {Object} opts.feature
|
|
62698
|
-
* @param {String} opts.divisionId
|
|
63652
|
+
* @param {Object} opts.feature If specified, the list of business units for which the user is authorized to use the requested feature will be returned
|
|
63653
|
+
* @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
|
|
62699
63654
|
*/
|
|
62700
63655
|
getWorkforcemanagementBusinessunits(opts) {
|
|
62701
63656
|
opts = opts || {};
|
|
@@ -63502,8 +64457,8 @@ class WorkforceManagementApi {
|
|
|
63502
64457
|
* @param {Number} opts.pageSize Deprecated, paging is not supported
|
|
63503
64458
|
* @param {Number} opts.pageNumber Deprecated, paging is not supported
|
|
63504
64459
|
* @param {Object} opts.expand Deprecated, expand settings on the single MU route
|
|
63505
|
-
* @param {Object} opts.feature
|
|
63506
|
-
* @param {String} opts.divisionId
|
|
64460
|
+
* @param {Object} opts.feature If specified, the list of management units for which the user is authorized to use the requested feature will be returned
|
|
64461
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
63507
64462
|
*/
|
|
63508
64463
|
getWorkforcemanagementManagementunits(opts) {
|
|
63509
64464
|
opts = opts || {};
|
|
@@ -66122,7 +67077,7 @@ class WorkforceManagementApi {
|
|
|
66122
67077
|
* </pre>
|
|
66123
67078
|
* </p>
|
|
66124
67079
|
* @module purecloud-platform-client-v2/index
|
|
66125
|
-
* @version
|
|
67080
|
+
* @version 173.0.0
|
|
66126
67081
|
*/
|
|
66127
67082
|
class platformClient {
|
|
66128
67083
|
constructor() {
|
|
@@ -66201,6 +67156,11 @@ class platformClient {
|
|
|
66201
67156
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
66202
67157
|
*/
|
|
66203
67158
|
this.DownloadsApi = DownloadsApi;
|
|
67159
|
+
/**
|
|
67160
|
+
* The EmailsApi service constructor.
|
|
67161
|
+
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
67162
|
+
*/
|
|
67163
|
+
this.EmailsApi = EmailsApi;
|
|
66204
67164
|
/**
|
|
66205
67165
|
* The EventsApi service constructor.
|
|
66206
67166
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
@@ -66381,6 +67341,11 @@ class platformClient {
|
|
|
66381
67341
|
* @property {module:purecloud-platform-client-v2/api/SearchApi}
|
|
66382
67342
|
*/
|
|
66383
67343
|
this.SearchApi = SearchApi;
|
|
67344
|
+
/**
|
|
67345
|
+
* The SettingsApi service constructor.
|
|
67346
|
+
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
67347
|
+
*/
|
|
67348
|
+
this.SettingsApi = SettingsApi;
|
|
66384
67349
|
/**
|
|
66385
67350
|
* The SpeechTextAnalyticsApi service constructor.
|
|
66386
67351
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|