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
|
@@ -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 173.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 173.0.0
|
|
1489
1489
|
*/
|
|
1490
1490
|
|
|
1491
1491
|
/**
|
|
@@ -1500,6 +1500,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1500
1500
|
}
|
|
1501
1501
|
|
|
1502
1502
|
|
|
1503
|
+
/**
|
|
1504
|
+
* Delete an alert
|
|
1505
|
+
*
|
|
1506
|
+
* @param {String} alertId Alert ID
|
|
1507
|
+
*/
|
|
1508
|
+
deleteAlertingAlert(alertId) {
|
|
1509
|
+
// verify the required parameter 'alertId' is set
|
|
1510
|
+
if (alertId === undefined || alertId === null) {
|
|
1511
|
+
throw 'Missing the required parameter "alertId" when calling deleteAlertingAlert';
|
|
1512
|
+
}
|
|
1513
|
+
|
|
1514
|
+
return this.apiClient.callApi(
|
|
1515
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
1516
|
+
'DELETE',
|
|
1517
|
+
{ 'alertId': alertId },
|
|
1518
|
+
{ },
|
|
1519
|
+
{ },
|
|
1520
|
+
{ },
|
|
1521
|
+
null,
|
|
1522
|
+
['PureCloud OAuth'],
|
|
1523
|
+
['application/json'],
|
|
1524
|
+
['application/json']
|
|
1525
|
+
);
|
|
1526
|
+
}
|
|
1527
|
+
|
|
1503
1528
|
/**
|
|
1504
1529
|
* Delete an interaction stats alert
|
|
1505
1530
|
*
|
|
@@ -1550,6 +1575,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1550
1575
|
);
|
|
1551
1576
|
}
|
|
1552
1577
|
|
|
1578
|
+
/**
|
|
1579
|
+
* Delete a rule.
|
|
1580
|
+
*
|
|
1581
|
+
* @param {String} ruleId Rule Id
|
|
1582
|
+
*/
|
|
1583
|
+
deleteAlertingRule(ruleId) {
|
|
1584
|
+
// verify the required parameter 'ruleId' is set
|
|
1585
|
+
if (ruleId === undefined || ruleId === null) {
|
|
1586
|
+
throw 'Missing the required parameter "ruleId" when calling deleteAlertingRule';
|
|
1587
|
+
}
|
|
1588
|
+
|
|
1589
|
+
return this.apiClient.callApi(
|
|
1590
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
1591
|
+
'DELETE',
|
|
1592
|
+
{ 'ruleId': ruleId },
|
|
1593
|
+
{ },
|
|
1594
|
+
{ },
|
|
1595
|
+
{ },
|
|
1596
|
+
null,
|
|
1597
|
+
['PureCloud OAuth'],
|
|
1598
|
+
['application/json'],
|
|
1599
|
+
['application/json']
|
|
1600
|
+
);
|
|
1601
|
+
}
|
|
1602
|
+
|
|
1603
|
+
/**
|
|
1604
|
+
* Get an alert
|
|
1605
|
+
*
|
|
1606
|
+
* @param {String} alertId Alert ID
|
|
1607
|
+
*/
|
|
1608
|
+
getAlertingAlert(alertId) {
|
|
1609
|
+
// verify the required parameter 'alertId' is set
|
|
1610
|
+
if (alertId === undefined || alertId === null) {
|
|
1611
|
+
throw 'Missing the required parameter "alertId" when calling getAlertingAlert';
|
|
1612
|
+
}
|
|
1613
|
+
|
|
1614
|
+
return this.apiClient.callApi(
|
|
1615
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
1616
|
+
'GET',
|
|
1617
|
+
{ 'alertId': alertId },
|
|
1618
|
+
{ },
|
|
1619
|
+
{ },
|
|
1620
|
+
{ },
|
|
1621
|
+
null,
|
|
1622
|
+
['PureCloud OAuth'],
|
|
1623
|
+
['application/json'],
|
|
1624
|
+
['application/json']
|
|
1625
|
+
);
|
|
1626
|
+
}
|
|
1627
|
+
|
|
1553
1628
|
/**
|
|
1554
1629
|
* Gets active alert count for a user.
|
|
1555
1630
|
*
|
|
@@ -1696,6 +1771,134 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1696
1771
|
);
|
|
1697
1772
|
}
|
|
1698
1773
|
|
|
1774
|
+
/**
|
|
1775
|
+
* Get a rule.
|
|
1776
|
+
*
|
|
1777
|
+
* @param {String} ruleId Rule Id
|
|
1778
|
+
*/
|
|
1779
|
+
getAlertingRule(ruleId) {
|
|
1780
|
+
// verify the required parameter 'ruleId' is set
|
|
1781
|
+
if (ruleId === undefined || ruleId === null) {
|
|
1782
|
+
throw 'Missing the required parameter "ruleId" when calling getAlertingRule';
|
|
1783
|
+
}
|
|
1784
|
+
|
|
1785
|
+
return this.apiClient.callApi(
|
|
1786
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
1787
|
+
'GET',
|
|
1788
|
+
{ 'ruleId': ruleId },
|
|
1789
|
+
{ },
|
|
1790
|
+
{ },
|
|
1791
|
+
{ },
|
|
1792
|
+
null,
|
|
1793
|
+
['PureCloud OAuth'],
|
|
1794
|
+
['application/json'],
|
|
1795
|
+
['application/json']
|
|
1796
|
+
);
|
|
1797
|
+
}
|
|
1798
|
+
|
|
1799
|
+
/**
|
|
1800
|
+
* Allows an entity to mute/snooze an alert or update the unread status of the alert.
|
|
1801
|
+
* 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.
|
|
1802
|
+
* @param {String} alertId Alert ID
|
|
1803
|
+
* @param {Object} opts Optional parameters
|
|
1804
|
+
* @param {Object} opts.body
|
|
1805
|
+
*/
|
|
1806
|
+
patchAlertingAlert(alertId, opts) {
|
|
1807
|
+
opts = opts || {};
|
|
1808
|
+
|
|
1809
|
+
// verify the required parameter 'alertId' is set
|
|
1810
|
+
if (alertId === undefined || alertId === null) {
|
|
1811
|
+
throw 'Missing the required parameter "alertId" when calling patchAlertingAlert';
|
|
1812
|
+
}
|
|
1813
|
+
|
|
1814
|
+
return this.apiClient.callApi(
|
|
1815
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
1816
|
+
'PATCH',
|
|
1817
|
+
{ 'alertId': alertId },
|
|
1818
|
+
{ },
|
|
1819
|
+
{ },
|
|
1820
|
+
{ },
|
|
1821
|
+
opts['body'],
|
|
1822
|
+
['PureCloud OAuth'],
|
|
1823
|
+
['application/json'],
|
|
1824
|
+
['application/json']
|
|
1825
|
+
);
|
|
1826
|
+
}
|
|
1827
|
+
|
|
1828
|
+
/**
|
|
1829
|
+
* Bulk alert updates
|
|
1830
|
+
*
|
|
1831
|
+
* @param {Object} body
|
|
1832
|
+
*/
|
|
1833
|
+
patchAlertingAlertsBulk(body) {
|
|
1834
|
+
// verify the required parameter 'body' is set
|
|
1835
|
+
if (body === undefined || body === null) {
|
|
1836
|
+
throw 'Missing the required parameter "body" when calling patchAlertingAlertsBulk';
|
|
1837
|
+
}
|
|
1838
|
+
|
|
1839
|
+
return this.apiClient.callApi(
|
|
1840
|
+
'/api/v2/alerting/alerts/bulk',
|
|
1841
|
+
'PATCH',
|
|
1842
|
+
{ },
|
|
1843
|
+
{ },
|
|
1844
|
+
{ },
|
|
1845
|
+
{ },
|
|
1846
|
+
body,
|
|
1847
|
+
['PureCloud OAuth'],
|
|
1848
|
+
['application/json'],
|
|
1849
|
+
['application/json']
|
|
1850
|
+
);
|
|
1851
|
+
}
|
|
1852
|
+
|
|
1853
|
+
/**
|
|
1854
|
+
* Bulk update of notification lists
|
|
1855
|
+
*
|
|
1856
|
+
* @param {Object} body
|
|
1857
|
+
*/
|
|
1858
|
+
patchAlertingRulesBulk(body) {
|
|
1859
|
+
// verify the required parameter 'body' is set
|
|
1860
|
+
if (body === undefined || body === null) {
|
|
1861
|
+
throw 'Missing the required parameter "body" when calling patchAlertingRulesBulk';
|
|
1862
|
+
}
|
|
1863
|
+
|
|
1864
|
+
return this.apiClient.callApi(
|
|
1865
|
+
'/api/v2/alerting/rules/bulk',
|
|
1866
|
+
'PATCH',
|
|
1867
|
+
{ },
|
|
1868
|
+
{ },
|
|
1869
|
+
{ },
|
|
1870
|
+
{ },
|
|
1871
|
+
body,
|
|
1872
|
+
['PureCloud OAuth'],
|
|
1873
|
+
['application/json'],
|
|
1874
|
+
['application/json']
|
|
1875
|
+
);
|
|
1876
|
+
}
|
|
1877
|
+
|
|
1878
|
+
/**
|
|
1879
|
+
* Gets a paged list of alerts. The max page size is 50
|
|
1880
|
+
*
|
|
1881
|
+
* @param {Object} opts Optional parameters
|
|
1882
|
+
* @param {Object} opts.body
|
|
1883
|
+
*/
|
|
1884
|
+
postAlertingAlertsQuery(opts) {
|
|
1885
|
+
opts = opts || {};
|
|
1886
|
+
|
|
1887
|
+
|
|
1888
|
+
return this.apiClient.callApi(
|
|
1889
|
+
'/api/v2/alerting/alerts/query',
|
|
1890
|
+
'POST',
|
|
1891
|
+
{ },
|
|
1892
|
+
{ },
|
|
1893
|
+
{ },
|
|
1894
|
+
{ },
|
|
1895
|
+
opts['body'],
|
|
1896
|
+
['PureCloud OAuth'],
|
|
1897
|
+
['application/json'],
|
|
1898
|
+
['application/json']
|
|
1899
|
+
);
|
|
1900
|
+
}
|
|
1901
|
+
|
|
1699
1902
|
/**
|
|
1700
1903
|
* Create an interaction stats rule.
|
|
1701
1904
|
*
|
|
@@ -1725,6 +1928,109 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1725
1928
|
);
|
|
1726
1929
|
}
|
|
1727
1930
|
|
|
1931
|
+
/**
|
|
1932
|
+
* Create a Rule.
|
|
1933
|
+
*
|
|
1934
|
+
* @param {Object} body rule to be created
|
|
1935
|
+
*/
|
|
1936
|
+
postAlertingRules(body) {
|
|
1937
|
+
// verify the required parameter 'body' is set
|
|
1938
|
+
if (body === undefined || body === null) {
|
|
1939
|
+
throw 'Missing the required parameter "body" when calling postAlertingRules';
|
|
1940
|
+
}
|
|
1941
|
+
|
|
1942
|
+
return this.apiClient.callApi(
|
|
1943
|
+
'/api/v2/alerting/rules',
|
|
1944
|
+
'POST',
|
|
1945
|
+
{ },
|
|
1946
|
+
{ },
|
|
1947
|
+
{ },
|
|
1948
|
+
{ },
|
|
1949
|
+
body,
|
|
1950
|
+
['PureCloud OAuth'],
|
|
1951
|
+
['application/json'],
|
|
1952
|
+
['application/json']
|
|
1953
|
+
);
|
|
1954
|
+
}
|
|
1955
|
+
|
|
1956
|
+
/**
|
|
1957
|
+
* Bulk remove rules
|
|
1958
|
+
*
|
|
1959
|
+
* @param {Object} body
|
|
1960
|
+
*/
|
|
1961
|
+
postAlertingRulesBulkRemove(body) {
|
|
1962
|
+
// verify the required parameter 'body' is set
|
|
1963
|
+
if (body === undefined || body === null) {
|
|
1964
|
+
throw 'Missing the required parameter "body" when calling postAlertingRulesBulkRemove';
|
|
1965
|
+
}
|
|
1966
|
+
|
|
1967
|
+
return this.apiClient.callApi(
|
|
1968
|
+
'/api/v2/alerting/rules/bulk/remove',
|
|
1969
|
+
'POST',
|
|
1970
|
+
{ },
|
|
1971
|
+
{ },
|
|
1972
|
+
{ },
|
|
1973
|
+
{ },
|
|
1974
|
+
body,
|
|
1975
|
+
['PureCloud OAuth'],
|
|
1976
|
+
['application/json'],
|
|
1977
|
+
['application/json']
|
|
1978
|
+
);
|
|
1979
|
+
}
|
|
1980
|
+
|
|
1981
|
+
/**
|
|
1982
|
+
* Get a paged list of rules. The max size of the page is 50 items.
|
|
1983
|
+
*
|
|
1984
|
+
* @param {Object} opts Optional parameters
|
|
1985
|
+
* @param {Object} opts.body
|
|
1986
|
+
*/
|
|
1987
|
+
postAlertingRulesQuery(opts) {
|
|
1988
|
+
opts = opts || {};
|
|
1989
|
+
|
|
1990
|
+
|
|
1991
|
+
return this.apiClient.callApi(
|
|
1992
|
+
'/api/v2/alerting/rules/query',
|
|
1993
|
+
'POST',
|
|
1994
|
+
{ },
|
|
1995
|
+
{ },
|
|
1996
|
+
{ },
|
|
1997
|
+
{ },
|
|
1998
|
+
opts['body'],
|
|
1999
|
+
['PureCloud OAuth'],
|
|
2000
|
+
['application/json'],
|
|
2001
|
+
['application/json']
|
|
2002
|
+
);
|
|
2003
|
+
}
|
|
2004
|
+
|
|
2005
|
+
/**
|
|
2006
|
+
* Update an alert read status
|
|
2007
|
+
*
|
|
2008
|
+
* @param {String} alertId Alert ID
|
|
2009
|
+
* @param {Object} opts Optional parameters
|
|
2010
|
+
* @param {Object} opts.body
|
|
2011
|
+
*/
|
|
2012
|
+
putAlertingAlert(alertId, opts) {
|
|
2013
|
+
opts = opts || {};
|
|
2014
|
+
|
|
2015
|
+
// verify the required parameter 'alertId' is set
|
|
2016
|
+
if (alertId === undefined || alertId === null) {
|
|
2017
|
+
throw 'Missing the required parameter "alertId" when calling putAlertingAlert';
|
|
2018
|
+
}
|
|
2019
|
+
|
|
2020
|
+
return this.apiClient.callApi(
|
|
2021
|
+
'/api/v2/alerting/alerts/{alertId}',
|
|
2022
|
+
'PUT',
|
|
2023
|
+
{ 'alertId': alertId },
|
|
2024
|
+
{ },
|
|
2025
|
+
{ },
|
|
2026
|
+
{ },
|
|
2027
|
+
opts['body'],
|
|
2028
|
+
['PureCloud OAuth'],
|
|
2029
|
+
['application/json'],
|
|
2030
|
+
['application/json']
|
|
2031
|
+
);
|
|
2032
|
+
}
|
|
2033
|
+
|
|
1728
2034
|
/**
|
|
1729
2035
|
* Update an interaction stats alert read status
|
|
1730
2036
|
*
|
|
@@ -1793,13 +2099,43 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1793
2099
|
);
|
|
1794
2100
|
}
|
|
1795
2101
|
|
|
2102
|
+
/**
|
|
2103
|
+
* Update a rule
|
|
2104
|
+
*
|
|
2105
|
+
* @param {String} ruleId Rule Id
|
|
2106
|
+
* @param {Object} body rule to be updated
|
|
2107
|
+
*/
|
|
2108
|
+
putAlertingRule(ruleId, body) {
|
|
2109
|
+
// verify the required parameter 'ruleId' is set
|
|
2110
|
+
if (ruleId === undefined || ruleId === null) {
|
|
2111
|
+
throw 'Missing the required parameter "ruleId" when calling putAlertingRule';
|
|
2112
|
+
}
|
|
2113
|
+
// verify the required parameter 'body' is set
|
|
2114
|
+
if (body === undefined || body === null) {
|
|
2115
|
+
throw 'Missing the required parameter "body" when calling putAlertingRule';
|
|
2116
|
+
}
|
|
2117
|
+
|
|
2118
|
+
return this.apiClient.callApi(
|
|
2119
|
+
'/api/v2/alerting/rules/{ruleId}',
|
|
2120
|
+
'PUT',
|
|
2121
|
+
{ 'ruleId': ruleId },
|
|
2122
|
+
{ },
|
|
2123
|
+
{ },
|
|
2124
|
+
{ },
|
|
2125
|
+
body,
|
|
2126
|
+
['PureCloud OAuth'],
|
|
2127
|
+
['application/json'],
|
|
2128
|
+
['application/json']
|
|
2129
|
+
);
|
|
2130
|
+
}
|
|
2131
|
+
|
|
1796
2132
|
}
|
|
1797
2133
|
|
|
1798
2134
|
class AnalyticsApi {
|
|
1799
2135
|
/**
|
|
1800
2136
|
* Analytics service.
|
|
1801
2137
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
1802
|
-
* @version
|
|
2138
|
+
* @version 173.0.0
|
|
1803
2139
|
*/
|
|
1804
2140
|
|
|
1805
2141
|
/**
|
|
@@ -4244,7 +4580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4244
4580
|
/**
|
|
4245
4581
|
* Architect service.
|
|
4246
4582
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
4247
|
-
* @version
|
|
4583
|
+
* @version 173.0.0
|
|
4248
4584
|
*/
|
|
4249
4585
|
|
|
4250
4586
|
/**
|
|
@@ -7433,7 +7769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7433
7769
|
/**
|
|
7434
7770
|
* Audit service.
|
|
7435
7771
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
7436
|
-
* @version
|
|
7772
|
+
* @version 173.0.0
|
|
7437
7773
|
*/
|
|
7438
7774
|
|
|
7439
7775
|
/**
|
|
@@ -7604,7 +7940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7604
7940
|
/**
|
|
7605
7941
|
* Authorization service.
|
|
7606
7942
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
7607
|
-
* @version
|
|
7943
|
+
* @version 173.0.0
|
|
7608
7944
|
*/
|
|
7609
7945
|
|
|
7610
7946
|
/**
|
|
@@ -8835,7 +9171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8835
9171
|
/**
|
|
8836
9172
|
* Billing service.
|
|
8837
9173
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
8838
|
-
* @version
|
|
9174
|
+
* @version 173.0.0
|
|
8839
9175
|
*/
|
|
8840
9176
|
|
|
8841
9177
|
/**
|
|
@@ -8915,7 +9251,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8915
9251
|
/**
|
|
8916
9252
|
* CarrierServices service.
|
|
8917
9253
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
8918
|
-
* @version
|
|
9254
|
+
* @version 173.0.0
|
|
8919
9255
|
*/
|
|
8920
9256
|
|
|
8921
9257
|
/**
|
|
@@ -8985,7 +9321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8985
9321
|
/**
|
|
8986
9322
|
* Chat service.
|
|
8987
9323
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
8988
|
-
* @version
|
|
9324
|
+
* @version 173.0.0
|
|
8989
9325
|
*/
|
|
8990
9326
|
|
|
8991
9327
|
/**
|
|
@@ -9149,7 +9485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9149
9485
|
/**
|
|
9150
9486
|
* Coaching service.
|
|
9151
9487
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
9152
|
-
* @version
|
|
9488
|
+
* @version 173.0.0
|
|
9153
9489
|
*/
|
|
9154
9490
|
|
|
9155
9491
|
/**
|
|
@@ -9726,7 +10062,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9726
10062
|
/**
|
|
9727
10063
|
* ContentManagement service.
|
|
9728
10064
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
9729
|
-
* @version
|
|
10065
|
+
* @version 173.0.0
|
|
9730
10066
|
*/
|
|
9731
10067
|
|
|
9732
10068
|
/**
|
|
@@ -10869,7 +11205,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10869
11205
|
/**
|
|
10870
11206
|
* Conversations service.
|
|
10871
11207
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
10872
|
-
* @version
|
|
11208
|
+
* @version 173.0.0
|
|
10873
11209
|
*/
|
|
10874
11210
|
|
|
10875
11211
|
/**
|
|
@@ -11184,6 +11520,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11184
11520
|
);
|
|
11185
11521
|
}
|
|
11186
11522
|
|
|
11523
|
+
/**
|
|
11524
|
+
* Delete a messaging setting
|
|
11525
|
+
*
|
|
11526
|
+
* @param {String} messageSettingId Message Setting ID
|
|
11527
|
+
*/
|
|
11528
|
+
deleteConversationsMessagingSetting(messageSettingId) {
|
|
11529
|
+
// verify the required parameter 'messageSettingId' is set
|
|
11530
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
11531
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteConversationsMessagingSetting';
|
|
11532
|
+
}
|
|
11533
|
+
|
|
11534
|
+
return this.apiClient.callApi(
|
|
11535
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
11536
|
+
'DELETE',
|
|
11537
|
+
{ 'messageSettingId': messageSettingId },
|
|
11538
|
+
{ },
|
|
11539
|
+
{ },
|
|
11540
|
+
{ },
|
|
11541
|
+
null,
|
|
11542
|
+
['PureCloud OAuth'],
|
|
11543
|
+
['application/json'],
|
|
11544
|
+
['application/json']
|
|
11545
|
+
);
|
|
11546
|
+
}
|
|
11547
|
+
|
|
11548
|
+
/**
|
|
11549
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
11550
|
+
* 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.
|
|
11551
|
+
*/
|
|
11552
|
+
deleteConversationsMessagingSettingsDefault() {
|
|
11553
|
+
|
|
11554
|
+
return this.apiClient.callApi(
|
|
11555
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
11556
|
+
'DELETE',
|
|
11557
|
+
{ },
|
|
11558
|
+
{ },
|
|
11559
|
+
{ },
|
|
11560
|
+
{ },
|
|
11561
|
+
null,
|
|
11562
|
+
['PureCloud OAuth'],
|
|
11563
|
+
['application/json'],
|
|
11564
|
+
['application/json']
|
|
11565
|
+
);
|
|
11566
|
+
}
|
|
11567
|
+
|
|
11187
11568
|
/**
|
|
11188
11569
|
* Delete a supported content profile
|
|
11189
11570
|
*
|
|
@@ -13227,6 +13608,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13227
13608
|
);
|
|
13228
13609
|
}
|
|
13229
13610
|
|
|
13611
|
+
/**
|
|
13612
|
+
* Get a messaging setting
|
|
13613
|
+
*
|
|
13614
|
+
* @param {String} messageSettingId Message Setting ID
|
|
13615
|
+
*/
|
|
13616
|
+
getConversationsMessagingSetting(messageSettingId) {
|
|
13617
|
+
// verify the required parameter 'messageSettingId' is set
|
|
13618
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
13619
|
+
throw 'Missing the required parameter "messageSettingId" when calling getConversationsMessagingSetting';
|
|
13620
|
+
}
|
|
13621
|
+
|
|
13622
|
+
return this.apiClient.callApi(
|
|
13623
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
13624
|
+
'GET',
|
|
13625
|
+
{ 'messageSettingId': messageSettingId },
|
|
13626
|
+
{ },
|
|
13627
|
+
{ },
|
|
13628
|
+
{ },
|
|
13629
|
+
null,
|
|
13630
|
+
['PureCloud OAuth'],
|
|
13631
|
+
['application/json'],
|
|
13632
|
+
['application/json']
|
|
13633
|
+
);
|
|
13634
|
+
}
|
|
13635
|
+
|
|
13636
|
+
/**
|
|
13637
|
+
* Get a list of messaging settings
|
|
13638
|
+
*
|
|
13639
|
+
* @param {Object} opts Optional parameters
|
|
13640
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
13641
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
13642
|
+
*/
|
|
13643
|
+
getConversationsMessagingSettings(opts) {
|
|
13644
|
+
opts = opts || {};
|
|
13645
|
+
|
|
13646
|
+
|
|
13647
|
+
return this.apiClient.callApi(
|
|
13648
|
+
'/api/v2/conversations/messaging/settings',
|
|
13649
|
+
'GET',
|
|
13650
|
+
{ },
|
|
13651
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
13652
|
+
{ },
|
|
13653
|
+
{ },
|
|
13654
|
+
null,
|
|
13655
|
+
['PureCloud OAuth'],
|
|
13656
|
+
['application/json'],
|
|
13657
|
+
['application/json']
|
|
13658
|
+
);
|
|
13659
|
+
}
|
|
13660
|
+
|
|
13661
|
+
/**
|
|
13662
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
13663
|
+
* 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.
|
|
13664
|
+
*/
|
|
13665
|
+
getConversationsMessagingSettingsDefault() {
|
|
13666
|
+
|
|
13667
|
+
return this.apiClient.callApi(
|
|
13668
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
13669
|
+
'GET',
|
|
13670
|
+
{ },
|
|
13671
|
+
{ },
|
|
13672
|
+
{ },
|
|
13673
|
+
{ },
|
|
13674
|
+
null,
|
|
13675
|
+
['PureCloud OAuth'],
|
|
13676
|
+
['application/json'],
|
|
13677
|
+
['application/json']
|
|
13678
|
+
);
|
|
13679
|
+
}
|
|
13680
|
+
|
|
13230
13681
|
/**
|
|
13231
13682
|
* Get a list of Messaging Stickers
|
|
13232
13683
|
*
|
|
@@ -14727,6 +15178,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14727
15178
|
);
|
|
14728
15179
|
}
|
|
14729
15180
|
|
|
15181
|
+
/**
|
|
15182
|
+
* Update a messaging setting
|
|
15183
|
+
*
|
|
15184
|
+
* @param {String} messageSettingId Message Setting ID
|
|
15185
|
+
* @param {Object} body MessagingSetting
|
|
15186
|
+
*/
|
|
15187
|
+
patchConversationsMessagingSetting(messageSettingId, body) {
|
|
15188
|
+
// verify the required parameter 'messageSettingId' is set
|
|
15189
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
15190
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchConversationsMessagingSetting';
|
|
15191
|
+
}
|
|
15192
|
+
// verify the required parameter 'body' is set
|
|
15193
|
+
if (body === undefined || body === null) {
|
|
15194
|
+
throw 'Missing the required parameter "body" when calling patchConversationsMessagingSetting';
|
|
15195
|
+
}
|
|
15196
|
+
|
|
15197
|
+
return this.apiClient.callApi(
|
|
15198
|
+
'/api/v2/conversations/messaging/settings/{messageSettingId}',
|
|
15199
|
+
'PATCH',
|
|
15200
|
+
{ 'messageSettingId': messageSettingId },
|
|
15201
|
+
{ },
|
|
15202
|
+
{ },
|
|
15203
|
+
{ },
|
|
15204
|
+
body,
|
|
15205
|
+
['PureCloud OAuth'],
|
|
15206
|
+
['application/json'],
|
|
15207
|
+
['application/json']
|
|
15208
|
+
);
|
|
15209
|
+
}
|
|
15210
|
+
|
|
14730
15211
|
/**
|
|
14731
15212
|
* Update a supported content profile
|
|
14732
15213
|
*
|
|
@@ -14974,6 +15455,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14974
15455
|
);
|
|
14975
15456
|
}
|
|
14976
15457
|
|
|
15458
|
+
/**
|
|
15459
|
+
* Barge a conversation creating a barged in conference of connected participants.
|
|
15460
|
+
*
|
|
15461
|
+
* @param {String} conversationId conversation ID
|
|
15462
|
+
* postConversationBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15463
|
+
*/
|
|
15464
|
+
postConversationBarge(conversationId) {
|
|
15465
|
+
// verify the required parameter 'conversationId' is set
|
|
15466
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15467
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationBarge';
|
|
15468
|
+
}
|
|
15469
|
+
|
|
15470
|
+
return this.apiClient.callApi(
|
|
15471
|
+
'/api/v2/conversations/{conversationId}/barge',
|
|
15472
|
+
'POST',
|
|
15473
|
+
{ 'conversationId': conversationId },
|
|
15474
|
+
{ },
|
|
15475
|
+
{ },
|
|
15476
|
+
{ },
|
|
15477
|
+
null,
|
|
15478
|
+
['PureCloud OAuth'],
|
|
15479
|
+
['application/json'],
|
|
15480
|
+
['application/json']
|
|
15481
|
+
);
|
|
15482
|
+
}
|
|
15483
|
+
|
|
14977
15484
|
/**
|
|
14978
15485
|
* Creates a cobrowse session. Requires conversation:cobrowse:add (for web messaging) or conversation:cobrowsevoice:add permission.
|
|
14979
15486
|
*
|
|
@@ -15098,7 +15605,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15098
15605
|
* @param {String} conversationId conversation ID
|
|
15099
15606
|
* @param {String} participantId participant ID
|
|
15100
15607
|
* @param {Object} body Transfer request
|
|
15101
|
-
* @deprecated
|
|
15102
15608
|
*/
|
|
15103
15609
|
postConversationParticipantReplace(conversationId, participantId, body) {
|
|
15104
15610
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15134,6 +15640,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15134
15640
|
* @param {String} conversationId conversation ID
|
|
15135
15641
|
* @param {String} participantId participant ID
|
|
15136
15642
|
* @param {Object} body Transfer request
|
|
15643
|
+
* postConversationParticipantReplaceAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15137
15644
|
*/
|
|
15138
15645
|
postConversationParticipantReplaceAgent(conversationId, participantId, body) {
|
|
15139
15646
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15169,6 +15676,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15169
15676
|
* @param {String} conversationId conversation ID
|
|
15170
15677
|
* @param {String} participantId participant ID
|
|
15171
15678
|
* @param {Object} body Transfer request
|
|
15679
|
+
* postConversationParticipantReplaceExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15172
15680
|
*/
|
|
15173
15681
|
postConversationParticipantReplaceExternal(conversationId, participantId, body) {
|
|
15174
15682
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15204,6 +15712,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15204
15712
|
* @param {String} conversationId conversation ID
|
|
15205
15713
|
* @param {String} participantId participant ID
|
|
15206
15714
|
* @param {Object} body Transfer request
|
|
15715
|
+
* postConversationParticipantReplaceQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15207
15716
|
*/
|
|
15208
15717
|
postConversationParticipantReplaceQueue(conversationId, participantId, body) {
|
|
15209
15718
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15297,6 +15806,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15297
15806
|
);
|
|
15298
15807
|
}
|
|
15299
15808
|
|
|
15809
|
+
/**
|
|
15810
|
+
* Barge a given participant's call creating a barged in conference of connected participants.
|
|
15811
|
+
*
|
|
15812
|
+
* @param {String} conversationId conversationId
|
|
15813
|
+
* @param {String} participantId participantId
|
|
15814
|
+
* postConversationsCallParticipantBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15815
|
+
*/
|
|
15816
|
+
postConversationsCallParticipantBarge(conversationId, participantId) {
|
|
15817
|
+
// verify the required parameter 'conversationId' is set
|
|
15818
|
+
if (conversationId === undefined || conversationId === null) {
|
|
15819
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsCallParticipantBarge';
|
|
15820
|
+
}
|
|
15821
|
+
// verify the required parameter 'participantId' is set
|
|
15822
|
+
if (participantId === undefined || participantId === null) {
|
|
15823
|
+
throw 'Missing the required parameter "participantId" when calling postConversationsCallParticipantBarge';
|
|
15824
|
+
}
|
|
15825
|
+
|
|
15826
|
+
return this.apiClient.callApi(
|
|
15827
|
+
'/api/v2/conversations/calls/{conversationId}/participants/{participantId}/barge',
|
|
15828
|
+
'POST',
|
|
15829
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
15830
|
+
{ },
|
|
15831
|
+
{ },
|
|
15832
|
+
{ },
|
|
15833
|
+
null,
|
|
15834
|
+
['PureCloud OAuth'],
|
|
15835
|
+
['application/json'],
|
|
15836
|
+
['application/json']
|
|
15837
|
+
);
|
|
15838
|
+
}
|
|
15839
|
+
|
|
15300
15840
|
/**
|
|
15301
15841
|
* Listen in on the conversation from the point of view of a given participant while speaking to just the given participant.
|
|
15302
15842
|
*
|
|
@@ -15372,7 +15912,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15372
15912
|
* @param {String} conversationId conversationId
|
|
15373
15913
|
* @param {String} participantId participantId
|
|
15374
15914
|
* @param {Object} body Destination address and initial speak to
|
|
15375
|
-
* @deprecated
|
|
15376
15915
|
*/
|
|
15377
15916
|
postConversationsCallParticipantConsult(conversationId, participantId, body) {
|
|
15378
15917
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15408,6 +15947,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15408
15947
|
* @param {String} conversationId conversationId
|
|
15409
15948
|
* @param {String} participantId participantId
|
|
15410
15949
|
* @param {Object} body Destination agent and initial speak to
|
|
15950
|
+
* postConversationsCallParticipantConsultAgent is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15411
15951
|
*/
|
|
15412
15952
|
postConversationsCallParticipantConsultAgent(conversationId, participantId, body) {
|
|
15413
15953
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15443,6 +15983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15443
15983
|
* @param {String} conversationId conversationId
|
|
15444
15984
|
* @param {String} participantId participantId
|
|
15445
15985
|
* @param {Object} body Destination address and initial speak to
|
|
15986
|
+
* postConversationsCallParticipantConsultExternal is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15446
15987
|
*/
|
|
15447
15988
|
postConversationsCallParticipantConsultExternal(conversationId, participantId, body) {
|
|
15448
15989
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15478,6 +16019,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15478
16019
|
* @param {String} conversationId conversationId
|
|
15479
16020
|
* @param {String} participantId participantId
|
|
15480
16021
|
* @param {Object} body Destination queue and initial speak to
|
|
16022
|
+
* postConversationsCallParticipantConsultQueue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
15481
16023
|
*/
|
|
15482
16024
|
postConversationsCallParticipantConsultQueue(conversationId, participantId, body) {
|
|
15483
16025
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15543,7 +16085,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15543
16085
|
* @param {String} conversationId conversationId
|
|
15544
16086
|
* @param {String} participantId participantId
|
|
15545
16087
|
* @param {Object} body Transfer request
|
|
15546
|
-
* @deprecated
|
|
15547
16088
|
*/
|
|
15548
16089
|
postConversationsCallParticipantReplace(conversationId, participantId, body) {
|
|
15549
16090
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15648,7 +16189,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15648
16189
|
* @param {String} conversationId conversationId
|
|
15649
16190
|
* @param {String} participantId participantId
|
|
15650
16191
|
* @param {Object} body Transfer request
|
|
15651
|
-
* @deprecated
|
|
15652
16192
|
*/
|
|
15653
16193
|
postConversationsCallbackParticipantReplace(conversationId, participantId, body) {
|
|
15654
16194
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15888,7 +16428,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15888
16428
|
* @param {String} conversationId conversationId
|
|
15889
16429
|
* @param {String} participantId participantId
|
|
15890
16430
|
* @param {Object} body Transfer request
|
|
15891
|
-
* @deprecated
|
|
15892
16431
|
*/
|
|
15893
16432
|
postConversationsChatParticipantReplace(conversationId, participantId, body) {
|
|
15894
16433
|
// verify the required parameter 'conversationId' is set
|
|
@@ -15989,7 +16528,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15989
16528
|
* @param {String} participantId participantId
|
|
15990
16529
|
* @param {Object} opts Optional parameters
|
|
15991
16530
|
* @param {Object} opts.body
|
|
15992
|
-
* @deprecated
|
|
15993
16531
|
*/
|
|
15994
16532
|
postConversationsCobrowsesessionParticipantReplace(conversationId, participantId, opts) {
|
|
15995
16533
|
opts = opts || {};
|
|
@@ -16152,7 +16690,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16152
16690
|
* @param {String} conversationId conversationId
|
|
16153
16691
|
* @param {String} participantId participantId
|
|
16154
16692
|
* @param {Object} body Transfer request
|
|
16155
|
-
* @deprecated
|
|
16156
16693
|
*/
|
|
16157
16694
|
postConversationsEmailParticipantReplace(conversationId, participantId, body) {
|
|
16158
16695
|
// verify the required parameter 'conversationId' is set
|
|
@@ -16517,7 +17054,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16517
17054
|
* @param {String} conversationId conversationId
|
|
16518
17055
|
* @param {String} participantId participantId
|
|
16519
17056
|
* @param {Object} body Transfer request
|
|
16520
|
-
* @deprecated
|
|
16521
17057
|
*/
|
|
16522
17058
|
postConversationsMessageParticipantReplace(conversationId, participantId, body) {
|
|
16523
17059
|
// verify the required parameter 'conversationId' is set
|
|
@@ -16772,6 +17308,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16772
17308
|
);
|
|
16773
17309
|
}
|
|
16774
17310
|
|
|
17311
|
+
/**
|
|
17312
|
+
* Create a messaging setting
|
|
17313
|
+
*
|
|
17314
|
+
* @param {Object} body MessagingSetting
|
|
17315
|
+
*/
|
|
17316
|
+
postConversationsMessagingSettings(body) {
|
|
17317
|
+
// verify the required parameter 'body' is set
|
|
17318
|
+
if (body === undefined || body === null) {
|
|
17319
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessagingSettings';
|
|
17320
|
+
}
|
|
17321
|
+
|
|
17322
|
+
return this.apiClient.callApi(
|
|
17323
|
+
'/api/v2/conversations/messaging/settings',
|
|
17324
|
+
'POST',
|
|
17325
|
+
{ },
|
|
17326
|
+
{ },
|
|
17327
|
+
{ },
|
|
17328
|
+
{ },
|
|
17329
|
+
body,
|
|
17330
|
+
['PureCloud OAuth'],
|
|
17331
|
+
['application/json'],
|
|
17332
|
+
['application/json']
|
|
17333
|
+
);
|
|
17334
|
+
}
|
|
17335
|
+
|
|
16775
17336
|
/**
|
|
16776
17337
|
* Create a Supported Content profile
|
|
16777
17338
|
*
|
|
@@ -17339,6 +17900,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17339
17900
|
);
|
|
17340
17901
|
}
|
|
17341
17902
|
|
|
17903
|
+
/**
|
|
17904
|
+
* Set the organization's default setting that may be applied to to integrations without settings
|
|
17905
|
+
* 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.
|
|
17906
|
+
* @param {Object} body MessagingSetting
|
|
17907
|
+
*/
|
|
17908
|
+
putConversationsMessagingSettingsDefault(body) {
|
|
17909
|
+
// verify the required parameter 'body' is set
|
|
17910
|
+
if (body === undefined || body === null) {
|
|
17911
|
+
throw 'Missing the required parameter "body" when calling putConversationsMessagingSettingsDefault';
|
|
17912
|
+
}
|
|
17913
|
+
|
|
17914
|
+
return this.apiClient.callApi(
|
|
17915
|
+
'/api/v2/conversations/messaging/settings/default',
|
|
17916
|
+
'PUT',
|
|
17917
|
+
{ },
|
|
17918
|
+
{ },
|
|
17919
|
+
{ },
|
|
17920
|
+
{ },
|
|
17921
|
+
body,
|
|
17922
|
+
['PureCloud OAuth'],
|
|
17923
|
+
['application/json'],
|
|
17924
|
+
['application/json']
|
|
17925
|
+
);
|
|
17926
|
+
}
|
|
17927
|
+
|
|
17342
17928
|
/**
|
|
17343
17929
|
* Set the organization's default supported content profile that may be assigned to an integration when it is created.
|
|
17344
17930
|
* 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.
|
|
@@ -17485,7 +18071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17485
18071
|
/**
|
|
17486
18072
|
* DataExtensions service.
|
|
17487
18073
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
17488
|
-
* @version
|
|
18074
|
+
* @version 173.0.0
|
|
17489
18075
|
*/
|
|
17490
18076
|
|
|
17491
18077
|
/**
|
|
@@ -17571,7 +18157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17571
18157
|
/**
|
|
17572
18158
|
* Downloads service.
|
|
17573
18159
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
17574
|
-
* @version
|
|
18160
|
+
* @version 173.0.0
|
|
17575
18161
|
*/
|
|
17576
18162
|
|
|
17577
18163
|
/**
|
|
@@ -17619,11 +18205,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17619
18205
|
|
|
17620
18206
|
}
|
|
17621
18207
|
|
|
18208
|
+
class EmailsApi {
|
|
18209
|
+
/**
|
|
18210
|
+
* Emails service.
|
|
18211
|
+
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
18212
|
+
* @version 173.0.0
|
|
18213
|
+
*/
|
|
18214
|
+
|
|
18215
|
+
/**
|
|
18216
|
+
* Constructs a new EmailsApi.
|
|
18217
|
+
* @alias module:purecloud-platform-client-v2/api/EmailsApi
|
|
18218
|
+
* @class
|
|
18219
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
18220
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
18221
|
+
*/
|
|
18222
|
+
constructor(apiClient) {
|
|
18223
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
18224
|
+
}
|
|
18225
|
+
|
|
18226
|
+
|
|
18227
|
+
/**
|
|
18228
|
+
* Get email Contact Center settings
|
|
18229
|
+
*
|
|
18230
|
+
*/
|
|
18231
|
+
getEmailsSettings() {
|
|
18232
|
+
|
|
18233
|
+
return this.apiClient.callApi(
|
|
18234
|
+
'/api/v2/emails/settings',
|
|
18235
|
+
'GET',
|
|
18236
|
+
{ },
|
|
18237
|
+
{ },
|
|
18238
|
+
{ },
|
|
18239
|
+
{ },
|
|
18240
|
+
null,
|
|
18241
|
+
['PureCloud OAuth'],
|
|
18242
|
+
['application/json'],
|
|
18243
|
+
['application/json']
|
|
18244
|
+
);
|
|
18245
|
+
}
|
|
18246
|
+
|
|
18247
|
+
/**
|
|
18248
|
+
* Patch email Contact Center settings
|
|
18249
|
+
*
|
|
18250
|
+
* @param {Object} opts Optional parameters
|
|
18251
|
+
* @param {Object} opts.body
|
|
18252
|
+
*/
|
|
18253
|
+
patchEmailsSettings(opts) {
|
|
18254
|
+
opts = opts || {};
|
|
18255
|
+
|
|
18256
|
+
|
|
18257
|
+
return this.apiClient.callApi(
|
|
18258
|
+
'/api/v2/emails/settings',
|
|
18259
|
+
'PATCH',
|
|
18260
|
+
{ },
|
|
18261
|
+
{ },
|
|
18262
|
+
{ },
|
|
18263
|
+
{ },
|
|
18264
|
+
opts['body'],
|
|
18265
|
+
['PureCloud OAuth'],
|
|
18266
|
+
['application/json'],
|
|
18267
|
+
['application/json']
|
|
18268
|
+
);
|
|
18269
|
+
}
|
|
18270
|
+
|
|
18271
|
+
}
|
|
18272
|
+
|
|
17622
18273
|
class EventsApi {
|
|
17623
18274
|
/**
|
|
17624
18275
|
* Events service.
|
|
17625
18276
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
17626
|
-
* @version
|
|
18277
|
+
* @version 173.0.0
|
|
17627
18278
|
*/
|
|
17628
18279
|
|
|
17629
18280
|
/**
|
|
@@ -17719,7 +18370,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17719
18370
|
/**
|
|
17720
18371
|
* ExternalContacts service.
|
|
17721
18372
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
17722
|
-
* @version
|
|
18373
|
+
* @version 173.0.0
|
|
17723
18374
|
*/
|
|
17724
18375
|
|
|
17725
18376
|
/**
|
|
@@ -19677,7 +20328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19677
20328
|
/**
|
|
19678
20329
|
* Fax service.
|
|
19679
20330
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
19680
|
-
* @version
|
|
20331
|
+
* @version 173.0.0
|
|
19681
20332
|
*/
|
|
19682
20333
|
|
|
19683
20334
|
/**
|
|
@@ -19848,7 +20499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19848
20499
|
/**
|
|
19849
20500
|
* Flows service.
|
|
19850
20501
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
19851
|
-
* @version
|
|
20502
|
+
* @version 173.0.0
|
|
19852
20503
|
*/
|
|
19853
20504
|
|
|
19854
20505
|
/**
|
|
@@ -20032,7 +20683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20032
20683
|
/**
|
|
20033
20684
|
* Gamification service.
|
|
20034
20685
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
20035
|
-
* @version
|
|
20686
|
+
* @version 173.0.0
|
|
20036
20687
|
*/
|
|
20037
20688
|
|
|
20038
20689
|
/**
|
|
@@ -22118,7 +22769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22118
22769
|
/**
|
|
22119
22770
|
* GeneralDataProtectionRegulation service.
|
|
22120
22771
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
22121
|
-
* @version
|
|
22772
|
+
* @version 173.0.0
|
|
22122
22773
|
*/
|
|
22123
22774
|
|
|
22124
22775
|
/**
|
|
@@ -22248,7 +22899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22248
22899
|
/**
|
|
22249
22900
|
* Geolocation service.
|
|
22250
22901
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
22251
|
-
* @version
|
|
22902
|
+
* @version 173.0.0
|
|
22252
22903
|
*/
|
|
22253
22904
|
|
|
22254
22905
|
/**
|
|
@@ -22379,7 +23030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22379
23030
|
/**
|
|
22380
23031
|
* Greetings service.
|
|
22381
23032
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
22382
|
-
* @version
|
|
23033
|
+
* @version 173.0.0
|
|
22383
23034
|
*/
|
|
22384
23035
|
|
|
22385
23036
|
/**
|
|
@@ -22834,7 +23485,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22834
23485
|
/**
|
|
22835
23486
|
* Groups service.
|
|
22836
23487
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
22837
|
-
* @version
|
|
23488
|
+
* @version 173.0.0
|
|
22838
23489
|
*/
|
|
22839
23490
|
|
|
22840
23491
|
/**
|
|
@@ -23353,7 +24004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23353
24004
|
/**
|
|
23354
24005
|
* IdentityProvider service.
|
|
23355
24006
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
23356
|
-
* @version
|
|
24007
|
+
* @version 173.0.0
|
|
23357
24008
|
*/
|
|
23358
24009
|
|
|
23359
24010
|
/**
|
|
@@ -24109,7 +24760,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24109
24760
|
/**
|
|
24110
24761
|
* InfrastructureAsCode service.
|
|
24111
24762
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
24112
|
-
* @version
|
|
24763
|
+
* @version 173.0.0
|
|
24113
24764
|
*/
|
|
24114
24765
|
|
|
24115
24766
|
/**
|
|
@@ -24276,7 +24927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24276
24927
|
/**
|
|
24277
24928
|
* Integrations service.
|
|
24278
24929
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
24279
|
-
* @version
|
|
24930
|
+
* @version 173.0.0
|
|
24280
24931
|
*/
|
|
24281
24932
|
|
|
24282
24933
|
/**
|
|
@@ -26238,7 +26889,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26238
26889
|
/**
|
|
26239
26890
|
* Journey service.
|
|
26240
26891
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
26241
|
-
* @version
|
|
26892
|
+
* @version 173.0.0
|
|
26242
26893
|
*/
|
|
26243
26894
|
|
|
26244
26895
|
/**
|
|
@@ -27341,7 +27992,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27341
27992
|
/**
|
|
27342
27993
|
* Knowledge service.
|
|
27343
27994
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
27344
|
-
* @version
|
|
27995
|
+
* @version 173.0.0
|
|
27345
27996
|
*/
|
|
27346
27997
|
|
|
27347
27998
|
/**
|
|
@@ -28607,6 +29258,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28607
29258
|
* @param {String} groupId The ID of the group to be retrieved.
|
|
28608
29259
|
* @param {Object} opts Optional parameters
|
|
28609
29260
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
29261
|
+
* @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
|
|
29262
|
+
* @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
|
|
28610
29263
|
*/
|
|
28611
29264
|
getKnowledgeKnowledgebaseUnansweredGroup(knowledgeBaseId, groupId, opts) {
|
|
28612
29265
|
opts = opts || {};
|
|
@@ -28624,7 +29277,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28624
29277
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}',
|
|
28625
29278
|
'GET',
|
|
28626
29279
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId },
|
|
28627
|
-
{ 'app': opts['app'] },
|
|
29280
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
28628
29281
|
{ },
|
|
28629
29282
|
{ },
|
|
28630
29283
|
null,
|
|
@@ -28642,6 +29295,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28642
29295
|
* @param {String} phraseGroupId The ID of the phraseGroup to be retrieved.
|
|
28643
29296
|
* @param {Object} opts Optional parameters
|
|
28644
29297
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
29298
|
+
* @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
|
|
29299
|
+
* @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
|
|
28645
29300
|
*/
|
|
28646
29301
|
getKnowledgeKnowledgebaseUnansweredGroupPhrasegroup(knowledgeBaseId, groupId, phraseGroupId, opts) {
|
|
28647
29302
|
opts = opts || {};
|
|
@@ -28663,7 +29318,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28663
29318
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups/{groupId}/phrasegroups/{phraseGroupId}',
|
|
28664
29319
|
'GET',
|
|
28665
29320
|
{ 'knowledgeBaseId': knowledgeBaseId,'groupId': groupId,'phraseGroupId': phraseGroupId },
|
|
28666
|
-
{ 'app': opts['app'] },
|
|
29321
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
28667
29322
|
{ },
|
|
28668
29323
|
{ },
|
|
28669
29324
|
null,
|
|
@@ -28679,6 +29334,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28679
29334
|
* @param {String} knowledgeBaseId Knowledge base ID
|
|
28680
29335
|
* @param {Object} opts Optional parameters
|
|
28681
29336
|
* @param {Object} opts.app The app value to be used for filtering phrases.
|
|
29337
|
+
* @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
|
|
29338
|
+
* @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
|
|
28682
29339
|
*/
|
|
28683
29340
|
getKnowledgeKnowledgebaseUnansweredGroups(knowledgeBaseId, opts) {
|
|
28684
29341
|
opts = opts || {};
|
|
@@ -28692,7 +29349,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28692
29349
|
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/unanswered/groups',
|
|
28693
29350
|
'GET',
|
|
28694
29351
|
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
28695
|
-
{ 'app': opts['app'] },
|
|
29352
|
+
{ 'app': opts['app'],'dateStart': opts['dateStart'],'dateEnd': opts['dateEnd'] },
|
|
28696
29353
|
{ },
|
|
28697
29354
|
{ },
|
|
28698
29355
|
null,
|
|
@@ -29971,7 +30628,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29971
30628
|
/**
|
|
29972
30629
|
* LanguageUnderstanding service.
|
|
29973
30630
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
29974
|
-
* @version
|
|
30631
|
+
* @version 173.0.0
|
|
29975
30632
|
*/
|
|
29976
30633
|
|
|
29977
30634
|
/**
|
|
@@ -30984,7 +31641,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30984
31641
|
/**
|
|
30985
31642
|
* Languages service.
|
|
30986
31643
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
30987
|
-
* @version
|
|
31644
|
+
* @version 173.0.0
|
|
30988
31645
|
*/
|
|
30989
31646
|
|
|
30990
31647
|
/**
|
|
@@ -31206,7 +31863,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31206
31863
|
/**
|
|
31207
31864
|
* Learning service.
|
|
31208
31865
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
31209
|
-
* @version
|
|
31866
|
+
* @version 173.0.0
|
|
31210
31867
|
*/
|
|
31211
31868
|
|
|
31212
31869
|
/**
|
|
@@ -32021,7 +32678,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32021
32678
|
/**
|
|
32022
32679
|
* License service.
|
|
32023
32680
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
32024
|
-
* @version
|
|
32681
|
+
* @version 173.0.0
|
|
32025
32682
|
*/
|
|
32026
32683
|
|
|
32027
32684
|
/**
|
|
@@ -32082,7 +32739,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32082
32739
|
}
|
|
32083
32740
|
|
|
32084
32741
|
/**
|
|
32085
|
-
*
|
|
32742
|
+
* Deprecated - no alternative required. This operation will always return 'true' for requested toggles
|
|
32086
32743
|
*
|
|
32087
32744
|
* @param {String} featureName featureName
|
|
32088
32745
|
*/
|
|
@@ -32205,7 +32862,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32205
32862
|
}
|
|
32206
32863
|
|
|
32207
32864
|
/**
|
|
32208
|
-
*
|
|
32865
|
+
* Deprecated. No alternative required - this endpoint has no effect
|
|
32209
32866
|
*
|
|
32210
32867
|
* @param {String} featureName featureName
|
|
32211
32868
|
*/
|
|
@@ -32259,7 +32916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32259
32916
|
/**
|
|
32260
32917
|
* Locations service.
|
|
32261
32918
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
32262
|
-
* @version
|
|
32919
|
+
* @version 173.0.0
|
|
32263
32920
|
*/
|
|
32264
32921
|
|
|
32265
32922
|
/**
|
|
@@ -32495,7 +33152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32495
33152
|
/**
|
|
32496
33153
|
* Messaging service.
|
|
32497
33154
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
32498
|
-
* @version
|
|
33155
|
+
* @version 173.0.0
|
|
32499
33156
|
*/
|
|
32500
33157
|
|
|
32501
33158
|
/**
|
|
@@ -32510,6 +33167,53 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32510
33167
|
}
|
|
32511
33168
|
|
|
32512
33169
|
|
|
33170
|
+
/**
|
|
33171
|
+
* Delete a messaging setting
|
|
33172
|
+
*
|
|
33173
|
+
* @param {String} messageSettingId Message Settings ID
|
|
33174
|
+
* @deprecated
|
|
33175
|
+
*/
|
|
33176
|
+
deleteMessagingSetting(messageSettingId) {
|
|
33177
|
+
// verify the required parameter 'messageSettingId' is set
|
|
33178
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
33179
|
+
throw 'Missing the required parameter "messageSettingId" when calling deleteMessagingSetting';
|
|
33180
|
+
}
|
|
33181
|
+
|
|
33182
|
+
return this.apiClient.callApi(
|
|
33183
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
33184
|
+
'DELETE',
|
|
33185
|
+
{ 'messageSettingId': messageSettingId },
|
|
33186
|
+
{ },
|
|
33187
|
+
{ },
|
|
33188
|
+
{ },
|
|
33189
|
+
null,
|
|
33190
|
+
['PureCloud OAuth'],
|
|
33191
|
+
['application/json'],
|
|
33192
|
+
['application/json']
|
|
33193
|
+
);
|
|
33194
|
+
}
|
|
33195
|
+
|
|
33196
|
+
/**
|
|
33197
|
+
* Delete the organization's default setting, a global default will be applied to integrations without settings
|
|
33198
|
+
* 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.
|
|
33199
|
+
* @deprecated
|
|
33200
|
+
*/
|
|
33201
|
+
deleteMessagingSettingsDefault() {
|
|
33202
|
+
|
|
33203
|
+
return this.apiClient.callApi(
|
|
33204
|
+
'/api/v2/messaging/settings/default',
|
|
33205
|
+
'DELETE',
|
|
33206
|
+
{ },
|
|
33207
|
+
{ },
|
|
33208
|
+
{ },
|
|
33209
|
+
{ },
|
|
33210
|
+
null,
|
|
33211
|
+
['PureCloud OAuth'],
|
|
33212
|
+
['application/json'],
|
|
33213
|
+
['application/json']
|
|
33214
|
+
);
|
|
33215
|
+
}
|
|
33216
|
+
|
|
32513
33217
|
/**
|
|
32514
33218
|
* Delete a supported content profile
|
|
32515
33219
|
* Deprecated - use DELETE /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -32536,6 +33240,79 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32536
33240
|
);
|
|
32537
33241
|
}
|
|
32538
33242
|
|
|
33243
|
+
/**
|
|
33244
|
+
* Get a messaging setting
|
|
33245
|
+
*
|
|
33246
|
+
* @param {String} messageSettingId Message Settings ID
|
|
33247
|
+
* @deprecated
|
|
33248
|
+
*/
|
|
33249
|
+
getMessagingSetting(messageSettingId) {
|
|
33250
|
+
// verify the required parameter 'messageSettingId' is set
|
|
33251
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
33252
|
+
throw 'Missing the required parameter "messageSettingId" when calling getMessagingSetting';
|
|
33253
|
+
}
|
|
33254
|
+
|
|
33255
|
+
return this.apiClient.callApi(
|
|
33256
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
33257
|
+
'GET',
|
|
33258
|
+
{ 'messageSettingId': messageSettingId },
|
|
33259
|
+
{ },
|
|
33260
|
+
{ },
|
|
33261
|
+
{ },
|
|
33262
|
+
null,
|
|
33263
|
+
['PureCloud OAuth'],
|
|
33264
|
+
['application/json'],
|
|
33265
|
+
['application/json']
|
|
33266
|
+
);
|
|
33267
|
+
}
|
|
33268
|
+
|
|
33269
|
+
/**
|
|
33270
|
+
* Get a list of messaging settings
|
|
33271
|
+
*
|
|
33272
|
+
* @param {Object} opts Optional parameters
|
|
33273
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
33274
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33275
|
+
* @deprecated
|
|
33276
|
+
*/
|
|
33277
|
+
getMessagingSettings(opts) {
|
|
33278
|
+
opts = opts || {};
|
|
33279
|
+
|
|
33280
|
+
|
|
33281
|
+
return this.apiClient.callApi(
|
|
33282
|
+
'/api/v2/messaging/settings',
|
|
33283
|
+
'GET',
|
|
33284
|
+
{ },
|
|
33285
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
33286
|
+
{ },
|
|
33287
|
+
{ },
|
|
33288
|
+
null,
|
|
33289
|
+
['PureCloud OAuth'],
|
|
33290
|
+
['application/json'],
|
|
33291
|
+
['application/json']
|
|
33292
|
+
);
|
|
33293
|
+
}
|
|
33294
|
+
|
|
33295
|
+
/**
|
|
33296
|
+
* Get the organization's default settings that will be used as the default when creating an integration.
|
|
33297
|
+
* 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.
|
|
33298
|
+
* @deprecated
|
|
33299
|
+
*/
|
|
33300
|
+
getMessagingSettingsDefault() {
|
|
33301
|
+
|
|
33302
|
+
return this.apiClient.callApi(
|
|
33303
|
+
'/api/v2/messaging/settings/default',
|
|
33304
|
+
'GET',
|
|
33305
|
+
{ },
|
|
33306
|
+
{ },
|
|
33307
|
+
{ },
|
|
33308
|
+
{ },
|
|
33309
|
+
null,
|
|
33310
|
+
['PureCloud OAuth'],
|
|
33311
|
+
['application/json'],
|
|
33312
|
+
['application/json']
|
|
33313
|
+
);
|
|
33314
|
+
}
|
|
33315
|
+
|
|
32539
33316
|
/**
|
|
32540
33317
|
* Get a list of Supported Content profiles
|
|
32541
33318
|
* Deprecated - use GET /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -32588,6 +33365,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32588
33365
|
);
|
|
32589
33366
|
}
|
|
32590
33367
|
|
|
33368
|
+
/**
|
|
33369
|
+
* Update a messaging setting
|
|
33370
|
+
*
|
|
33371
|
+
* @param {String} messageSettingId Message Settings ID
|
|
33372
|
+
* @param {Object} body MessagingSetting
|
|
33373
|
+
* @deprecated
|
|
33374
|
+
*/
|
|
33375
|
+
patchMessagingSetting(messageSettingId, body) {
|
|
33376
|
+
// verify the required parameter 'messageSettingId' is set
|
|
33377
|
+
if (messageSettingId === undefined || messageSettingId === null) {
|
|
33378
|
+
throw 'Missing the required parameter "messageSettingId" when calling patchMessagingSetting';
|
|
33379
|
+
}
|
|
33380
|
+
// verify the required parameter 'body' is set
|
|
33381
|
+
if (body === undefined || body === null) {
|
|
33382
|
+
throw 'Missing the required parameter "body" when calling patchMessagingSetting';
|
|
33383
|
+
}
|
|
33384
|
+
|
|
33385
|
+
return this.apiClient.callApi(
|
|
33386
|
+
'/api/v2/messaging/settings/{messageSettingId}',
|
|
33387
|
+
'PATCH',
|
|
33388
|
+
{ 'messageSettingId': messageSettingId },
|
|
33389
|
+
{ },
|
|
33390
|
+
{ },
|
|
33391
|
+
{ },
|
|
33392
|
+
body,
|
|
33393
|
+
['PureCloud OAuth'],
|
|
33394
|
+
['application/json'],
|
|
33395
|
+
['application/json']
|
|
33396
|
+
);
|
|
33397
|
+
}
|
|
33398
|
+
|
|
32591
33399
|
/**
|
|
32592
33400
|
* Update a supported content profile
|
|
32593
33401
|
* Deprecated - use PATCH /api/v2/conversations/messaging/supportedcontent/{supportedContentId} as replacement
|
|
@@ -32619,6 +33427,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32619
33427
|
);
|
|
32620
33428
|
}
|
|
32621
33429
|
|
|
33430
|
+
/**
|
|
33431
|
+
* Create a messaging setting
|
|
33432
|
+
*
|
|
33433
|
+
* @param {Object} body MessagingSetting
|
|
33434
|
+
* @deprecated
|
|
33435
|
+
*/
|
|
33436
|
+
postMessagingSettings(body) {
|
|
33437
|
+
// verify the required parameter 'body' is set
|
|
33438
|
+
if (body === undefined || body === null) {
|
|
33439
|
+
throw 'Missing the required parameter "body" when calling postMessagingSettings';
|
|
33440
|
+
}
|
|
33441
|
+
|
|
33442
|
+
return this.apiClient.callApi(
|
|
33443
|
+
'/api/v2/messaging/settings',
|
|
33444
|
+
'POST',
|
|
33445
|
+
{ },
|
|
33446
|
+
{ },
|
|
33447
|
+
{ },
|
|
33448
|
+
{ },
|
|
33449
|
+
body,
|
|
33450
|
+
['PureCloud OAuth'],
|
|
33451
|
+
['application/json'],
|
|
33452
|
+
['application/json']
|
|
33453
|
+
);
|
|
33454
|
+
}
|
|
33455
|
+
|
|
32622
33456
|
/**
|
|
32623
33457
|
* Create a Supported Content profile
|
|
32624
33458
|
* Deprecated - use POST /api/v2/conversations/messaging/supportedcontent as replacement
|
|
@@ -32645,13 +33479,39 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32645
33479
|
);
|
|
32646
33480
|
}
|
|
32647
33481
|
|
|
33482
|
+
/**
|
|
33483
|
+
* Set the organization's default settings that may be applied to an integration when it is created.
|
|
33484
|
+
* 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.
|
|
33485
|
+
* @param {Object} body Messaging Setting ID
|
|
33486
|
+
* @deprecated
|
|
33487
|
+
*/
|
|
33488
|
+
putMessagingSettingsDefault(body) {
|
|
33489
|
+
// verify the required parameter 'body' is set
|
|
33490
|
+
if (body === undefined || body === null) {
|
|
33491
|
+
throw 'Missing the required parameter "body" when calling putMessagingSettingsDefault';
|
|
33492
|
+
}
|
|
33493
|
+
|
|
33494
|
+
return this.apiClient.callApi(
|
|
33495
|
+
'/api/v2/messaging/settings/default',
|
|
33496
|
+
'PUT',
|
|
33497
|
+
{ },
|
|
33498
|
+
{ },
|
|
33499
|
+
{ },
|
|
33500
|
+
{ },
|
|
33501
|
+
body,
|
|
33502
|
+
['PureCloud OAuth'],
|
|
33503
|
+
['application/json'],
|
|
33504
|
+
['application/json']
|
|
33505
|
+
);
|
|
33506
|
+
}
|
|
33507
|
+
|
|
32648
33508
|
}
|
|
32649
33509
|
|
|
32650
33510
|
class MobileDevicesApi {
|
|
32651
33511
|
/**
|
|
32652
33512
|
* MobileDevices service.
|
|
32653
33513
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
32654
|
-
* @version
|
|
33514
|
+
* @version 173.0.0
|
|
32655
33515
|
*/
|
|
32656
33516
|
|
|
32657
33517
|
/**
|
|
@@ -32802,7 +33662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32802
33662
|
/**
|
|
32803
33663
|
* Notifications service.
|
|
32804
33664
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
32805
|
-
* @version
|
|
33665
|
+
* @version 173.0.0
|
|
32806
33666
|
*/
|
|
32807
33667
|
|
|
32808
33668
|
/**
|
|
@@ -33035,7 +33895,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33035
33895
|
/**
|
|
33036
33896
|
* OAuth service.
|
|
33037
33897
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
33038
|
-
* @version
|
|
33898
|
+
* @version 173.0.0
|
|
33039
33899
|
*/
|
|
33040
33900
|
|
|
33041
33901
|
/**
|
|
@@ -33401,7 +34261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33401
34261
|
/**
|
|
33402
34262
|
* Objects service.
|
|
33403
34263
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
33404
|
-
* @version
|
|
34264
|
+
* @version 173.0.0
|
|
33405
34265
|
*/
|
|
33406
34266
|
|
|
33407
34267
|
/**
|
|
@@ -33672,7 +34532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33672
34532
|
/**
|
|
33673
34533
|
* Organization service.
|
|
33674
34534
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
33675
|
-
* @version
|
|
34535
|
+
* @version 173.0.0
|
|
33676
34536
|
*/
|
|
33677
34537
|
|
|
33678
34538
|
/**
|
|
@@ -34127,7 +34987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34127
34987
|
/**
|
|
34128
34988
|
* OrganizationAuthorization service.
|
|
34129
34989
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
34130
|
-
* @version
|
|
34990
|
+
* @version 173.0.0
|
|
34131
34991
|
*/
|
|
34132
34992
|
|
|
34133
34993
|
/**
|
|
@@ -35474,7 +36334,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35474
36334
|
/**
|
|
35475
36335
|
* Outbound service.
|
|
35476
36336
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
35477
|
-
* @version
|
|
36337
|
+
* @version 173.0.0
|
|
35478
36338
|
*/
|
|
35479
36339
|
|
|
35480
36340
|
/**
|
|
@@ -39096,7 +39956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39096
39956
|
/**
|
|
39097
39957
|
* Presence service.
|
|
39098
39958
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
39099
|
-
* @version
|
|
39959
|
+
* @version 173.0.0
|
|
39100
39960
|
*/
|
|
39101
39961
|
|
|
39102
39962
|
/**
|
|
@@ -39835,7 +40695,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39835
40695
|
/**
|
|
39836
40696
|
* ProcessAutomation service.
|
|
39837
40697
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
39838
|
-
* @version
|
|
40698
|
+
* @version 173.0.0
|
|
39839
40699
|
*/
|
|
39840
40700
|
|
|
39841
40701
|
/**
|
|
@@ -40074,7 +40934,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40074
40934
|
/**
|
|
40075
40935
|
* Quality service.
|
|
40076
40936
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
40077
|
-
* @version
|
|
40937
|
+
* @version 173.0.0
|
|
40078
40938
|
*/
|
|
40079
40939
|
|
|
40080
40940
|
/**
|
|
@@ -41826,7 +42686,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41826
42686
|
/**
|
|
41827
42687
|
* Recording service.
|
|
41828
42688
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
41829
|
-
* @version
|
|
42689
|
+
* @version 173.0.0
|
|
41830
42690
|
*/
|
|
41831
42691
|
|
|
41832
42692
|
/**
|
|
@@ -43463,7 +44323,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43463
44323
|
/**
|
|
43464
44324
|
* ResponseManagement service.
|
|
43465
44325
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
43466
|
-
* @version
|
|
44326
|
+
* @version 173.0.0
|
|
43467
44327
|
*/
|
|
43468
44328
|
|
|
43469
44329
|
/**
|
|
@@ -43948,7 +44808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43948
44808
|
/**
|
|
43949
44809
|
* Routing service.
|
|
43950
44810
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
43951
|
-
* @version
|
|
44811
|
+
* @version 173.0.0
|
|
43952
44812
|
*/
|
|
43953
44813
|
|
|
43954
44814
|
/**
|
|
@@ -47655,7 +48515,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47655
48515
|
/**
|
|
47656
48516
|
* SCIM service.
|
|
47657
48517
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
47658
|
-
* @version
|
|
48518
|
+
* @version 173.0.0
|
|
47659
48519
|
*/
|
|
47660
48520
|
|
|
47661
48521
|
/**
|
|
@@ -48532,7 +49392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48532
49392
|
/**
|
|
48533
49393
|
* Scripts service.
|
|
48534
49394
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
48535
|
-
* @version
|
|
49395
|
+
* @version 173.0.0
|
|
48536
49396
|
*/
|
|
48537
49397
|
|
|
48538
49398
|
/**
|
|
@@ -48976,7 +49836,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48976
49836
|
/**
|
|
48977
49837
|
* Search service.
|
|
48978
49838
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
48979
|
-
* @version
|
|
49839
|
+
* @version 173.0.0
|
|
48980
49840
|
*/
|
|
48981
49841
|
|
|
48982
49842
|
/**
|
|
@@ -49661,11 +50521,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49661
50521
|
|
|
49662
50522
|
}
|
|
49663
50523
|
|
|
50524
|
+
class SettingsApi {
|
|
50525
|
+
/**
|
|
50526
|
+
* Settings service.
|
|
50527
|
+
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
50528
|
+
* @version 173.0.0
|
|
50529
|
+
*/
|
|
50530
|
+
|
|
50531
|
+
/**
|
|
50532
|
+
* Constructs a new SettingsApi.
|
|
50533
|
+
* @alias module:purecloud-platform-client-v2/api/SettingsApi
|
|
50534
|
+
* @class
|
|
50535
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
50536
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
50537
|
+
*/
|
|
50538
|
+
constructor(apiClient) {
|
|
50539
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
50540
|
+
}
|
|
50541
|
+
|
|
50542
|
+
|
|
50543
|
+
/**
|
|
50544
|
+
* Get email Contact Center settings
|
|
50545
|
+
*
|
|
50546
|
+
*/
|
|
50547
|
+
getEmailsSettings() {
|
|
50548
|
+
|
|
50549
|
+
return this.apiClient.callApi(
|
|
50550
|
+
'/api/v2/emails/settings',
|
|
50551
|
+
'GET',
|
|
50552
|
+
{ },
|
|
50553
|
+
{ },
|
|
50554
|
+
{ },
|
|
50555
|
+
{ },
|
|
50556
|
+
null,
|
|
50557
|
+
['PureCloud OAuth'],
|
|
50558
|
+
['application/json'],
|
|
50559
|
+
['application/json']
|
|
50560
|
+
);
|
|
50561
|
+
}
|
|
50562
|
+
|
|
50563
|
+
/**
|
|
50564
|
+
* Patch email Contact Center settings
|
|
50565
|
+
*
|
|
50566
|
+
* @param {Object} opts Optional parameters
|
|
50567
|
+
* @param {Object} opts.body
|
|
50568
|
+
*/
|
|
50569
|
+
patchEmailsSettings(opts) {
|
|
50570
|
+
opts = opts || {};
|
|
50571
|
+
|
|
50572
|
+
|
|
50573
|
+
return this.apiClient.callApi(
|
|
50574
|
+
'/api/v2/emails/settings',
|
|
50575
|
+
'PATCH',
|
|
50576
|
+
{ },
|
|
50577
|
+
{ },
|
|
50578
|
+
{ },
|
|
50579
|
+
{ },
|
|
50580
|
+
opts['body'],
|
|
50581
|
+
['PureCloud OAuth'],
|
|
50582
|
+
['application/json'],
|
|
50583
|
+
['application/json']
|
|
50584
|
+
);
|
|
50585
|
+
}
|
|
50586
|
+
|
|
50587
|
+
}
|
|
50588
|
+
|
|
49664
50589
|
class SpeechTextAnalyticsApi {
|
|
49665
50590
|
/**
|
|
49666
50591
|
* SpeechTextAnalytics service.
|
|
49667
50592
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
49668
|
-
* @version
|
|
50593
|
+
* @version 173.0.0
|
|
49669
50594
|
*/
|
|
49670
50595
|
|
|
49671
50596
|
/**
|
|
@@ -49834,6 +50759,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49834
50759
|
);
|
|
49835
50760
|
}
|
|
49836
50761
|
|
|
50762
|
+
/**
|
|
50763
|
+
* Get the list of pre-signed S3 URL for the transcripts of a specific communication of a conversation
|
|
50764
|
+
*
|
|
50765
|
+
* @param {String} conversationId Conversation ID
|
|
50766
|
+
* @param {String} communicationId Communication ID
|
|
50767
|
+
*/
|
|
50768
|
+
getSpeechandtextanalyticsConversationCommunicationTranscripturls(conversationId, communicationId) {
|
|
50769
|
+
// verify the required parameter 'conversationId' is set
|
|
50770
|
+
if (conversationId === undefined || conversationId === null) {
|
|
50771
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
50772
|
+
}
|
|
50773
|
+
// verify the required parameter 'communicationId' is set
|
|
50774
|
+
if (communicationId === undefined || communicationId === null) {
|
|
50775
|
+
throw 'Missing the required parameter "communicationId" when calling getSpeechandtextanalyticsConversationCommunicationTranscripturls';
|
|
50776
|
+
}
|
|
50777
|
+
|
|
50778
|
+
return this.apiClient.callApi(
|
|
50779
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/communications/{communicationId}/transcripturls',
|
|
50780
|
+
'GET',
|
|
50781
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
50782
|
+
{ },
|
|
50783
|
+
{ },
|
|
50784
|
+
{ },
|
|
50785
|
+
null,
|
|
50786
|
+
['PureCloud OAuth'],
|
|
50787
|
+
['application/json'],
|
|
50788
|
+
['application/json']
|
|
50789
|
+
);
|
|
50790
|
+
}
|
|
50791
|
+
|
|
49837
50792
|
/**
|
|
49838
50793
|
* Get a Speech and Text Analytics program by id
|
|
49839
50794
|
*
|
|
@@ -50618,7 +51573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50618
51573
|
/**
|
|
50619
51574
|
* Stations service.
|
|
50620
51575
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
50621
|
-
* @version
|
|
51576
|
+
* @version 173.0.0
|
|
50622
51577
|
*/
|
|
50623
51578
|
|
|
50624
51579
|
/**
|
|
@@ -50720,7 +51675,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50720
51675
|
/**
|
|
50721
51676
|
* Suggest service.
|
|
50722
51677
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
50723
|
-
* @version
|
|
51678
|
+
* @version 173.0.0
|
|
50724
51679
|
*/
|
|
50725
51680
|
|
|
50726
51681
|
/**
|
|
@@ -50859,7 +51814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50859
51814
|
/**
|
|
50860
51815
|
* TaskManagement service.
|
|
50861
51816
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
50862
|
-
* @version
|
|
51817
|
+
* @version 173.0.0
|
|
50863
51818
|
*/
|
|
50864
51819
|
|
|
50865
51820
|
/**
|
|
@@ -52140,7 +53095,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52140
53095
|
/**
|
|
52141
53096
|
* Teams service.
|
|
52142
53097
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
52143
|
-
* @version
|
|
53098
|
+
* @version 173.0.0
|
|
52144
53099
|
*/
|
|
52145
53100
|
|
|
52146
53101
|
/**
|
|
@@ -52442,7 +53397,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52442
53397
|
/**
|
|
52443
53398
|
* Telephony service.
|
|
52444
53399
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
52445
|
-
* @version
|
|
53400
|
+
* @version 173.0.0
|
|
52446
53401
|
*/
|
|
52447
53402
|
|
|
52448
53403
|
/**
|
|
@@ -52570,7 +53525,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52570
53525
|
/**
|
|
52571
53526
|
* TelephonyProvidersEdge service.
|
|
52572
53527
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
52573
|
-
* @version
|
|
53528
|
+
* @version 173.0.0
|
|
52574
53529
|
*/
|
|
52575
53530
|
|
|
52576
53531
|
/**
|
|
@@ -54026,7 +54981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54026
54981
|
/**
|
|
54027
54982
|
* Get the metrics for a list of edges.
|
|
54028
54983
|
*
|
|
54029
|
-
* @param {String} edgeIds Comma separated list of Edge Id's
|
|
54984
|
+
* @param {String} edgeIds Comma separated list of Edge Id's. Maximum of 100 edge ids allowed.
|
|
54030
54985
|
*/
|
|
54031
54986
|
getTelephonyProvidersEdgesMetrics(edgeIds) {
|
|
54032
54987
|
// verify the required parameter 'edgeIds' is set
|
|
@@ -55859,7 +56814,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55859
56814
|
/**
|
|
55860
56815
|
* Textbots service.
|
|
55861
56816
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
55862
|
-
* @version
|
|
56817
|
+
* @version 173.0.0
|
|
55863
56818
|
*/
|
|
55864
56819
|
|
|
55865
56820
|
/**
|
|
@@ -55987,7 +56942,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55987
56942
|
/**
|
|
55988
56943
|
* Tokens service.
|
|
55989
56944
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
55990
|
-
* @version
|
|
56945
|
+
* @version 173.0.0
|
|
55991
56946
|
*/
|
|
55992
56947
|
|
|
55993
56948
|
/**
|
|
@@ -56139,7 +57094,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56139
57094
|
/**
|
|
56140
57095
|
* Uploads service.
|
|
56141
57096
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
56142
|
-
* @version
|
|
57097
|
+
* @version 173.0.0
|
|
56143
57098
|
*/
|
|
56144
57099
|
|
|
56145
57100
|
/**
|
|
@@ -56315,7 +57270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56315
57270
|
/**
|
|
56316
57271
|
* Usage service.
|
|
56317
57272
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
56318
|
-
* @version
|
|
57273
|
+
* @version 173.0.0
|
|
56319
57274
|
*/
|
|
56320
57275
|
|
|
56321
57276
|
/**
|
|
@@ -56525,7 +57480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56525
57480
|
/**
|
|
56526
57481
|
* UserRecordings service.
|
|
56527
57482
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
56528
|
-
* @version
|
|
57483
|
+
* @version 173.0.0
|
|
56529
57484
|
*/
|
|
56530
57485
|
|
|
56531
57486
|
/**
|
|
@@ -56710,7 +57665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56710
57665
|
/**
|
|
56711
57666
|
* Users service.
|
|
56712
57667
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
56713
|
-
* @version
|
|
57668
|
+
* @version 173.0.0
|
|
56714
57669
|
*/
|
|
56715
57670
|
|
|
56716
57671
|
/**
|
|
@@ -59271,7 +60226,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59271
60226
|
/**
|
|
59272
60227
|
* Utilities service.
|
|
59273
60228
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
59274
|
-
* @version
|
|
60229
|
+
* @version 173.0.0
|
|
59275
60230
|
*/
|
|
59276
60231
|
|
|
59277
60232
|
/**
|
|
@@ -59382,7 +60337,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59382
60337
|
/**
|
|
59383
60338
|
* Voicemail service.
|
|
59384
60339
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
59385
|
-
* @version
|
|
60340
|
+
* @version 173.0.0
|
|
59386
60341
|
*/
|
|
59387
60342
|
|
|
59388
60343
|
/**
|
|
@@ -60049,7 +61004,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60049
61004
|
/**
|
|
60050
61005
|
* WebChat service.
|
|
60051
61006
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
60052
|
-
* @version
|
|
61007
|
+
* @version 173.0.0
|
|
60053
61008
|
*/
|
|
60054
61009
|
|
|
60055
61010
|
/**
|
|
@@ -60598,7 +61553,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60598
61553
|
/**
|
|
60599
61554
|
* WebDeployments service.
|
|
60600
61555
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
60601
|
-
* @version
|
|
61556
|
+
* @version 173.0.0
|
|
60602
61557
|
*/
|
|
60603
61558
|
|
|
60604
61559
|
/**
|
|
@@ -61120,7 +62075,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61120
62075
|
/**
|
|
61121
62076
|
* WebMessaging service.
|
|
61122
62077
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
61123
|
-
* @version
|
|
62078
|
+
* @version 173.0.0
|
|
61124
62079
|
*/
|
|
61125
62080
|
|
|
61126
62081
|
/**
|
|
@@ -61166,7 +62121,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61166
62121
|
/**
|
|
61167
62122
|
* Widgets service.
|
|
61168
62123
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
61169
|
-
* @version
|
|
62124
|
+
* @version 173.0.0
|
|
61170
62125
|
*/
|
|
61171
62126
|
|
|
61172
62127
|
/**
|
|
@@ -61312,7 +62267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61312
62267
|
/**
|
|
61313
62268
|
* WorkforceManagement service.
|
|
61314
62269
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
61315
|
-
* @version
|
|
62270
|
+
* @version 173.0.0
|
|
61316
62271
|
*/
|
|
61317
62272
|
|
|
61318
62273
|
/**
|
|
@@ -62051,8 +63006,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62051
63006
|
*
|
|
62052
63007
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
62053
63008
|
* @param {Object} opts Optional parameters
|
|
62054
|
-
* @param {Object} opts.feature
|
|
62055
|
-
* @param {String} opts.divisionId
|
|
63009
|
+
* @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
|
|
63010
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
62056
63011
|
*/
|
|
62057
63012
|
getWorkforcemanagementBusinessunitManagementunits(businessUnitId, opts) {
|
|
62058
63013
|
opts = opts || {};
|
|
@@ -62691,8 +63646,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62691
63646
|
* Get business units
|
|
62692
63647
|
*
|
|
62693
63648
|
* @param {Object} opts Optional parameters
|
|
62694
|
-
* @param {Object} opts.feature
|
|
62695
|
-
* @param {String} opts.divisionId
|
|
63649
|
+
* @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
|
|
63650
|
+
* @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
|
|
62696
63651
|
*/
|
|
62697
63652
|
getWorkforcemanagementBusinessunits(opts) {
|
|
62698
63653
|
opts = opts || {};
|
|
@@ -63499,8 +64454,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63499
64454
|
* @param {Number} opts.pageSize Deprecated, paging is not supported
|
|
63500
64455
|
* @param {Number} opts.pageNumber Deprecated, paging is not supported
|
|
63501
64456
|
* @param {Object} opts.expand Deprecated, expand settings on the single MU route
|
|
63502
|
-
* @param {Object} opts.feature
|
|
63503
|
-
* @param {String} opts.divisionId
|
|
64457
|
+
* @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
|
|
64458
|
+
* @param {String} opts.divisionId If specified, the list of management units belonging to the specified division will be returned
|
|
63504
64459
|
*/
|
|
63505
64460
|
getWorkforcemanagementManagementunits(opts) {
|
|
63506
64461
|
opts = opts || {};
|
|
@@ -66119,7 +67074,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66119
67074
|
* </pre>
|
|
66120
67075
|
* </p>
|
|
66121
67076
|
* @module purecloud-platform-client-v2/index
|
|
66122
|
-
* @version
|
|
67077
|
+
* @version 173.0.0
|
|
66123
67078
|
*/
|
|
66124
67079
|
class platformClient {
|
|
66125
67080
|
constructor() {
|
|
@@ -66198,6 +67153,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66198
67153
|
* @property {module:purecloud-platform-client-v2/api/DownloadsApi}
|
|
66199
67154
|
*/
|
|
66200
67155
|
this.DownloadsApi = DownloadsApi;
|
|
67156
|
+
/**
|
|
67157
|
+
* The EmailsApi service constructor.
|
|
67158
|
+
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
67159
|
+
*/
|
|
67160
|
+
this.EmailsApi = EmailsApi;
|
|
66201
67161
|
/**
|
|
66202
67162
|
* The EventsApi service constructor.
|
|
66203
67163
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|
|
@@ -66378,6 +67338,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66378
67338
|
* @property {module:purecloud-platform-client-v2/api/SearchApi}
|
|
66379
67339
|
*/
|
|
66380
67340
|
this.SearchApi = SearchApi;
|
|
67341
|
+
/**
|
|
67342
|
+
* The SettingsApi service constructor.
|
|
67343
|
+
* @property {module:purecloud-platform-client-v2/api/SettingsApi}
|
|
67344
|
+
*/
|
|
67345
|
+
this.SettingsApi = SettingsApi;
|
|
66381
67346
|
/**
|
|
66382
67347
|
* The SpeechTextAnalyticsApi service constructor.
|
|
66383
67348
|
* @property {module:purecloud-platform-client-v2/api/SpeechTextAnalyticsApi}
|