purecloud-platform-client-v2 203.0.0 → 204.0.1
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 +8 -10
- package/dist/node/purecloud-platform-client-v2.js +810 -95
- package/dist/web-amd/purecloud-platform-client-v2.js +810 -95
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +436 -250
- package/dist/web-cjs/purecloud-platform-client-v2.js +2364 -2178
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +556 -221
- package/package.json +5 -2
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +381 -0
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +81 -0
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +3 -3
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +139 -2
- 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 +3 -13
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +100 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -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 +30 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -3
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +13 -1
|
@@ -405,7 +405,7 @@ class Configuration {
|
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
407
|
* @module purecloud-platform-client-v2/ApiClient
|
|
408
|
-
* @version
|
|
408
|
+
* @version 204.0.1
|
|
409
409
|
*/
|
|
410
410
|
class ApiClient {
|
|
411
411
|
/**
|
|
@@ -1823,11 +1823,463 @@ class ApiClient {
|
|
|
1823
1823
|
}
|
|
1824
1824
|
}
|
|
1825
1825
|
|
|
1826
|
+
class AgentAssistantsApi {
|
|
1827
|
+
/**
|
|
1828
|
+
* AgentAssistants service.
|
|
1829
|
+
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1830
|
+
* @version 204.0.1
|
|
1831
|
+
*/
|
|
1832
|
+
|
|
1833
|
+
/**
|
|
1834
|
+
* Constructs a new AgentAssistantsApi.
|
|
1835
|
+
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1836
|
+
* @class
|
|
1837
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
1838
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
1839
|
+
*/
|
|
1840
|
+
constructor(apiClient) {
|
|
1841
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
1842
|
+
}
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
/**
|
|
1846
|
+
* Delete an assistant.
|
|
1847
|
+
*
|
|
1848
|
+
* @param {String} assistantId Assistant ID
|
|
1849
|
+
*/
|
|
1850
|
+
deleteAssistant(assistantId) {
|
|
1851
|
+
// verify the required parameter 'assistantId' is set
|
|
1852
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1853
|
+
throw 'Missing the required parameter "assistantId" when calling deleteAssistant';
|
|
1854
|
+
}
|
|
1855
|
+
|
|
1856
|
+
return this.apiClient.callApi(
|
|
1857
|
+
'/api/v2/assistants/{assistantId}',
|
|
1858
|
+
'DELETE',
|
|
1859
|
+
{ 'assistantId': assistantId },
|
|
1860
|
+
{ },
|
|
1861
|
+
{ },
|
|
1862
|
+
{ },
|
|
1863
|
+
null,
|
|
1864
|
+
['PureCloud OAuth'],
|
|
1865
|
+
['application/json'],
|
|
1866
|
+
['application/json']
|
|
1867
|
+
);
|
|
1868
|
+
}
|
|
1869
|
+
|
|
1870
|
+
/**
|
|
1871
|
+
* Disassociate a queue from an assistant.
|
|
1872
|
+
*
|
|
1873
|
+
* @param {String} assistantId Assistant ID
|
|
1874
|
+
* @param {String} queueId Queue ID
|
|
1875
|
+
*/
|
|
1876
|
+
deleteAssistantQueue(assistantId, queueId) {
|
|
1877
|
+
// verify the required parameter 'assistantId' is set
|
|
1878
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1879
|
+
throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueue';
|
|
1880
|
+
}
|
|
1881
|
+
// verify the required parameter 'queueId' is set
|
|
1882
|
+
if (queueId === undefined || queueId === null) {
|
|
1883
|
+
throw 'Missing the required parameter "queueId" when calling deleteAssistantQueue';
|
|
1884
|
+
}
|
|
1885
|
+
|
|
1886
|
+
return this.apiClient.callApi(
|
|
1887
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}',
|
|
1888
|
+
'DELETE',
|
|
1889
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
1890
|
+
{ },
|
|
1891
|
+
{ },
|
|
1892
|
+
{ },
|
|
1893
|
+
null,
|
|
1894
|
+
['PureCloud OAuth'],
|
|
1895
|
+
['application/json'],
|
|
1896
|
+
['application/json']
|
|
1897
|
+
);
|
|
1898
|
+
}
|
|
1899
|
+
|
|
1900
|
+
/**
|
|
1901
|
+
* Disassociate the queues from an assistant for the given assistant ID and queue IDs.
|
|
1902
|
+
*
|
|
1903
|
+
* @param {String} assistantId Assistant ID
|
|
1904
|
+
* @param {Object} opts Optional parameters
|
|
1905
|
+
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be deleted.
|
|
1906
|
+
*/
|
|
1907
|
+
deleteAssistantQueues(assistantId, opts) {
|
|
1908
|
+
opts = opts || {};
|
|
1909
|
+
|
|
1910
|
+
// verify the required parameter 'assistantId' is set
|
|
1911
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1912
|
+
throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueues';
|
|
1913
|
+
}
|
|
1914
|
+
|
|
1915
|
+
return this.apiClient.callApi(
|
|
1916
|
+
'/api/v2/assistants/{assistantId}/queues',
|
|
1917
|
+
'DELETE',
|
|
1918
|
+
{ 'assistantId': assistantId },
|
|
1919
|
+
{ 'queueIds': opts['queueIds'] },
|
|
1920
|
+
{ },
|
|
1921
|
+
{ },
|
|
1922
|
+
null,
|
|
1923
|
+
['PureCloud OAuth'],
|
|
1924
|
+
['application/json'],
|
|
1925
|
+
['application/json']
|
|
1926
|
+
);
|
|
1927
|
+
}
|
|
1928
|
+
|
|
1929
|
+
/**
|
|
1930
|
+
* Get an assistant.
|
|
1931
|
+
*
|
|
1932
|
+
* @param {String} assistantId Assistant ID
|
|
1933
|
+
* @param {Object} opts Optional parameters
|
|
1934
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
1935
|
+
*/
|
|
1936
|
+
getAssistant(assistantId, opts) {
|
|
1937
|
+
opts = opts || {};
|
|
1938
|
+
|
|
1939
|
+
// verify the required parameter 'assistantId' is set
|
|
1940
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1941
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistant';
|
|
1942
|
+
}
|
|
1943
|
+
|
|
1944
|
+
return this.apiClient.callApi(
|
|
1945
|
+
'/api/v2/assistants/{assistantId}',
|
|
1946
|
+
'GET',
|
|
1947
|
+
{ 'assistantId': assistantId },
|
|
1948
|
+
{ 'expand': opts['expand'] },
|
|
1949
|
+
{ },
|
|
1950
|
+
{ },
|
|
1951
|
+
null,
|
|
1952
|
+
['PureCloud OAuth'],
|
|
1953
|
+
['application/json'],
|
|
1954
|
+
['application/json']
|
|
1955
|
+
);
|
|
1956
|
+
}
|
|
1957
|
+
|
|
1958
|
+
/**
|
|
1959
|
+
* Get queue Information for an assistant.
|
|
1960
|
+
*
|
|
1961
|
+
* @param {String} assistantId Assistant ID
|
|
1962
|
+
* @param {String} queueId Queue ID
|
|
1963
|
+
* @param {Object} opts Optional parameters
|
|
1964
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
1965
|
+
*/
|
|
1966
|
+
getAssistantQueue(assistantId, queueId, opts) {
|
|
1967
|
+
opts = opts || {};
|
|
1968
|
+
|
|
1969
|
+
// verify the required parameter 'assistantId' is set
|
|
1970
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1971
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistantQueue';
|
|
1972
|
+
}
|
|
1973
|
+
// verify the required parameter 'queueId' is set
|
|
1974
|
+
if (queueId === undefined || queueId === null) {
|
|
1975
|
+
throw 'Missing the required parameter "queueId" when calling getAssistantQueue';
|
|
1976
|
+
}
|
|
1977
|
+
|
|
1978
|
+
return this.apiClient.callApi(
|
|
1979
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}',
|
|
1980
|
+
'GET',
|
|
1981
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
1982
|
+
{ 'expand': opts['expand'] },
|
|
1983
|
+
{ },
|
|
1984
|
+
{ },
|
|
1985
|
+
null,
|
|
1986
|
+
['PureCloud OAuth'],
|
|
1987
|
+
['application/json'],
|
|
1988
|
+
['application/json']
|
|
1989
|
+
);
|
|
1990
|
+
}
|
|
1991
|
+
|
|
1992
|
+
/**
|
|
1993
|
+
* Get all the queues associated with an assistant.
|
|
1994
|
+
*
|
|
1995
|
+
* @param {String} assistantId Assistant ID
|
|
1996
|
+
* @param {Object} opts Optional parameters
|
|
1997
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
1998
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1999
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2000
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
2001
|
+
*/
|
|
2002
|
+
getAssistantQueues(assistantId, opts) {
|
|
2003
|
+
opts = opts || {};
|
|
2004
|
+
|
|
2005
|
+
// verify the required parameter 'assistantId' is set
|
|
2006
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2007
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistantQueues';
|
|
2008
|
+
}
|
|
2009
|
+
|
|
2010
|
+
return this.apiClient.callApi(
|
|
2011
|
+
'/api/v2/assistants/{assistantId}/queues',
|
|
2012
|
+
'GET',
|
|
2013
|
+
{ 'assistantId': assistantId },
|
|
2014
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': opts['expand'] },
|
|
2015
|
+
{ },
|
|
2016
|
+
{ },
|
|
2017
|
+
null,
|
|
2018
|
+
['PureCloud OAuth'],
|
|
2019
|
+
['application/json'],
|
|
2020
|
+
['application/json']
|
|
2021
|
+
);
|
|
2022
|
+
}
|
|
2023
|
+
|
|
2024
|
+
/**
|
|
2025
|
+
* Get all assistants.
|
|
2026
|
+
*
|
|
2027
|
+
* @param {Object} opts Optional parameters
|
|
2028
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
2029
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
2030
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
2031
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2032
|
+
* @param {String} opts.name Return the assistant by the given name.
|
|
2033
|
+
*/
|
|
2034
|
+
getAssistants(opts) {
|
|
2035
|
+
opts = opts || {};
|
|
2036
|
+
|
|
2037
|
+
|
|
2038
|
+
return this.apiClient.callApi(
|
|
2039
|
+
'/api/v2/assistants',
|
|
2040
|
+
'GET',
|
|
2041
|
+
{ },
|
|
2042
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
2043
|
+
{ },
|
|
2044
|
+
{ },
|
|
2045
|
+
null,
|
|
2046
|
+
['PureCloud OAuth'],
|
|
2047
|
+
['application/json'],
|
|
2048
|
+
['application/json']
|
|
2049
|
+
);
|
|
2050
|
+
}
|
|
2051
|
+
|
|
2052
|
+
/**
|
|
2053
|
+
* Get all queues assigned to any assistant.
|
|
2054
|
+
*
|
|
2055
|
+
* @param {Object} opts Optional parameters
|
|
2056
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
2057
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
2058
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2059
|
+
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be retrieved.
|
|
2060
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
2061
|
+
*/
|
|
2062
|
+
getAssistantsQueues(opts) {
|
|
2063
|
+
opts = opts || {};
|
|
2064
|
+
|
|
2065
|
+
|
|
2066
|
+
return this.apiClient.callApi(
|
|
2067
|
+
'/api/v2/assistants/queues',
|
|
2068
|
+
'GET',
|
|
2069
|
+
{ },
|
|
2070
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'queueIds': opts['queueIds'],'expand': opts['expand'] },
|
|
2071
|
+
{ },
|
|
2072
|
+
{ },
|
|
2073
|
+
null,
|
|
2074
|
+
['PureCloud OAuth'],
|
|
2075
|
+
['application/json'],
|
|
2076
|
+
['application/json']
|
|
2077
|
+
);
|
|
2078
|
+
}
|
|
2079
|
+
|
|
2080
|
+
/**
|
|
2081
|
+
* Update an assistant.
|
|
2082
|
+
*
|
|
2083
|
+
* @param {String} assistantId Assistant ID
|
|
2084
|
+
* @param {Object} body
|
|
2085
|
+
*/
|
|
2086
|
+
patchAssistant(assistantId, body) {
|
|
2087
|
+
// verify the required parameter 'assistantId' is set
|
|
2088
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2089
|
+
throw 'Missing the required parameter "assistantId" when calling patchAssistant';
|
|
2090
|
+
}
|
|
2091
|
+
// verify the required parameter 'body' is set
|
|
2092
|
+
if (body === undefined || body === null) {
|
|
2093
|
+
throw 'Missing the required parameter "body" when calling patchAssistant';
|
|
2094
|
+
}
|
|
2095
|
+
|
|
2096
|
+
return this.apiClient.callApi(
|
|
2097
|
+
'/api/v2/assistants/{assistantId}',
|
|
2098
|
+
'PATCH',
|
|
2099
|
+
{ 'assistantId': assistantId },
|
|
2100
|
+
{ },
|
|
2101
|
+
{ },
|
|
2102
|
+
{ },
|
|
2103
|
+
body,
|
|
2104
|
+
['PureCloud OAuth'],
|
|
2105
|
+
['application/json'],
|
|
2106
|
+
['application/json']
|
|
2107
|
+
);
|
|
2108
|
+
}
|
|
2109
|
+
|
|
2110
|
+
/**
|
|
2111
|
+
* Update Queues for an Assistant.
|
|
2112
|
+
*
|
|
2113
|
+
* @param {String} assistantId Assistant ID
|
|
2114
|
+
* @param {Array.<Object>} body
|
|
2115
|
+
*/
|
|
2116
|
+
patchAssistantQueues(assistantId, body) {
|
|
2117
|
+
// verify the required parameter 'assistantId' is set
|
|
2118
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2119
|
+
throw 'Missing the required parameter "assistantId" when calling patchAssistantQueues';
|
|
2120
|
+
}
|
|
2121
|
+
// verify the required parameter 'body' is set
|
|
2122
|
+
if (body === undefined || body === null) {
|
|
2123
|
+
throw 'Missing the required parameter "body" when calling patchAssistantQueues';
|
|
2124
|
+
}
|
|
2125
|
+
|
|
2126
|
+
return this.apiClient.callApi(
|
|
2127
|
+
'/api/v2/assistants/{assistantId}/queues',
|
|
2128
|
+
'PATCH',
|
|
2129
|
+
{ 'assistantId': assistantId },
|
|
2130
|
+
{ },
|
|
2131
|
+
{ },
|
|
2132
|
+
{ },
|
|
2133
|
+
body,
|
|
2134
|
+
['PureCloud OAuth'],
|
|
2135
|
+
['application/json'],
|
|
2136
|
+
['application/json']
|
|
2137
|
+
);
|
|
2138
|
+
}
|
|
2139
|
+
|
|
2140
|
+
/**
|
|
2141
|
+
* Create an Assistant.
|
|
2142
|
+
*
|
|
2143
|
+
* @param {Object} body
|
|
2144
|
+
*/
|
|
2145
|
+
postAssistants(body) {
|
|
2146
|
+
// verify the required parameter 'body' is set
|
|
2147
|
+
if (body === undefined || body === null) {
|
|
2148
|
+
throw 'Missing the required parameter "body" when calling postAssistants';
|
|
2149
|
+
}
|
|
2150
|
+
|
|
2151
|
+
return this.apiClient.callApi(
|
|
2152
|
+
'/api/v2/assistants',
|
|
2153
|
+
'POST',
|
|
2154
|
+
{ },
|
|
2155
|
+
{ },
|
|
2156
|
+
{ },
|
|
2157
|
+
{ },
|
|
2158
|
+
body,
|
|
2159
|
+
['PureCloud OAuth'],
|
|
2160
|
+
['application/json'],
|
|
2161
|
+
['application/json']
|
|
2162
|
+
);
|
|
2163
|
+
}
|
|
2164
|
+
|
|
2165
|
+
/**
|
|
2166
|
+
* Create a queue assistant association.
|
|
2167
|
+
*
|
|
2168
|
+
* @param {String} assistantId Assistant ID
|
|
2169
|
+
* @param {String} queueId Queue ID
|
|
2170
|
+
* @param {Object} body
|
|
2171
|
+
*/
|
|
2172
|
+
putAssistantQueue(assistantId, queueId, body) {
|
|
2173
|
+
// verify the required parameter 'assistantId' is set
|
|
2174
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2175
|
+
throw 'Missing the required parameter "assistantId" when calling putAssistantQueue';
|
|
2176
|
+
}
|
|
2177
|
+
// verify the required parameter 'queueId' is set
|
|
2178
|
+
if (queueId === undefined || queueId === null) {
|
|
2179
|
+
throw 'Missing the required parameter "queueId" when calling putAssistantQueue';
|
|
2180
|
+
}
|
|
2181
|
+
// verify the required parameter 'body' is set
|
|
2182
|
+
if (body === undefined || body === null) {
|
|
2183
|
+
throw 'Missing the required parameter "body" when calling putAssistantQueue';
|
|
2184
|
+
}
|
|
2185
|
+
|
|
2186
|
+
return this.apiClient.callApi(
|
|
2187
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}',
|
|
2188
|
+
'PUT',
|
|
2189
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
2190
|
+
{ },
|
|
2191
|
+
{ },
|
|
2192
|
+
{ },
|
|
2193
|
+
body,
|
|
2194
|
+
['PureCloud OAuth'],
|
|
2195
|
+
['application/json'],
|
|
2196
|
+
['application/json']
|
|
2197
|
+
);
|
|
2198
|
+
}
|
|
2199
|
+
|
|
2200
|
+
}
|
|
2201
|
+
|
|
2202
|
+
class AgentCopilotApi {
|
|
2203
|
+
/**
|
|
2204
|
+
* AgentCopilot service.
|
|
2205
|
+
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2206
|
+
* @version 204.0.1
|
|
2207
|
+
*/
|
|
2208
|
+
|
|
2209
|
+
/**
|
|
2210
|
+
* Constructs a new AgentCopilotApi.
|
|
2211
|
+
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2212
|
+
* @class
|
|
2213
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
2214
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
2215
|
+
*/
|
|
2216
|
+
constructor(apiClient) {
|
|
2217
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
2218
|
+
}
|
|
2219
|
+
|
|
2220
|
+
|
|
2221
|
+
/**
|
|
2222
|
+
* Get copilot configuration of an assistant.
|
|
2223
|
+
*
|
|
2224
|
+
* @param {String} assistantId Assistant ID
|
|
2225
|
+
*/
|
|
2226
|
+
getAssistantCopilot(assistantId) {
|
|
2227
|
+
// verify the required parameter 'assistantId' is set
|
|
2228
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2229
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistantCopilot';
|
|
2230
|
+
}
|
|
2231
|
+
|
|
2232
|
+
return this.apiClient.callApi(
|
|
2233
|
+
'/api/v2/assistants/{assistantId}/copilot',
|
|
2234
|
+
'GET',
|
|
2235
|
+
{ 'assistantId': assistantId },
|
|
2236
|
+
{ },
|
|
2237
|
+
{ },
|
|
2238
|
+
{ },
|
|
2239
|
+
null,
|
|
2240
|
+
['PureCloud OAuth'],
|
|
2241
|
+
['application/json'],
|
|
2242
|
+
['application/json']
|
|
2243
|
+
);
|
|
2244
|
+
}
|
|
2245
|
+
|
|
2246
|
+
/**
|
|
2247
|
+
* Update agent copilot configuration
|
|
2248
|
+
*
|
|
2249
|
+
* @param {String} assistantId Assistant ID
|
|
2250
|
+
* @param {Object} body
|
|
2251
|
+
*/
|
|
2252
|
+
putAssistantCopilot(assistantId, body) {
|
|
2253
|
+
// verify the required parameter 'assistantId' is set
|
|
2254
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2255
|
+
throw 'Missing the required parameter "assistantId" when calling putAssistantCopilot';
|
|
2256
|
+
}
|
|
2257
|
+
// verify the required parameter 'body' is set
|
|
2258
|
+
if (body === undefined || body === null) {
|
|
2259
|
+
throw 'Missing the required parameter "body" when calling putAssistantCopilot';
|
|
2260
|
+
}
|
|
2261
|
+
|
|
2262
|
+
return this.apiClient.callApi(
|
|
2263
|
+
'/api/v2/assistants/{assistantId}/copilot',
|
|
2264
|
+
'PUT',
|
|
2265
|
+
{ 'assistantId': assistantId },
|
|
2266
|
+
{ },
|
|
2267
|
+
{ },
|
|
2268
|
+
{ },
|
|
2269
|
+
body,
|
|
2270
|
+
['PureCloud OAuth'],
|
|
2271
|
+
['application/json'],
|
|
2272
|
+
['application/json']
|
|
2273
|
+
);
|
|
2274
|
+
}
|
|
2275
|
+
|
|
2276
|
+
}
|
|
2277
|
+
|
|
1826
2278
|
class AgentUIApi {
|
|
1827
2279
|
/**
|
|
1828
2280
|
* AgentUI service.
|
|
1829
2281
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1830
|
-
* @version
|
|
2282
|
+
* @version 204.0.1
|
|
1831
2283
|
*/
|
|
1832
2284
|
|
|
1833
2285
|
/**
|
|
@@ -1958,7 +2410,7 @@ class AlertingApi {
|
|
|
1958
2410
|
/**
|
|
1959
2411
|
* Alerting service.
|
|
1960
2412
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1961
|
-
* @version
|
|
2413
|
+
* @version 204.0.1
|
|
1962
2414
|
*/
|
|
1963
2415
|
|
|
1964
2416
|
/**
|
|
@@ -2619,7 +3071,7 @@ class AnalyticsApi {
|
|
|
2619
3071
|
/**
|
|
2620
3072
|
* Analytics service.
|
|
2621
3073
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2622
|
-
* @version
|
|
3074
|
+
* @version 204.0.1
|
|
2623
3075
|
*/
|
|
2624
3076
|
|
|
2625
3077
|
/**
|
|
@@ -3560,6 +4012,7 @@ class AnalyticsApi {
|
|
|
3560
4012
|
* @param {Object} dashboardType List dashboard of given type
|
|
3561
4013
|
* @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
|
|
3562
4014
|
* @param {Object} opts Optional parameters
|
|
4015
|
+
* @param {String} opts.name name of the dashboard
|
|
3563
4016
|
* @param {String} opts.sortBy (default to desc)
|
|
3564
4017
|
* @param {Number} opts.pageNumber (default to 1)
|
|
3565
4018
|
* @param {Number} opts.pageSize (default to 9)
|
|
@@ -3580,7 +4033,7 @@ class AnalyticsApi {
|
|
|
3580
4033
|
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
3581
4034
|
'GET',
|
|
3582
4035
|
{ },
|
|
3583
|
-
{ 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
4036
|
+
{ 'name': opts['name'],'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3584
4037
|
{ },
|
|
3585
4038
|
{ },
|
|
3586
4039
|
null,
|
|
@@ -4085,7 +4538,6 @@ class AnalyticsApi {
|
|
|
4085
4538
|
* Query for agent copilot aggregates
|
|
4086
4539
|
*
|
|
4087
4540
|
* @param {Object} body query
|
|
4088
|
-
* postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4089
4541
|
*/
|
|
4090
4542
|
postAnalyticsAgentcopilotsAggregatesQuery(body) {
|
|
4091
4543
|
// verify the required parameter 'body' is set
|
|
@@ -5231,7 +5683,7 @@ class ArchitectApi {
|
|
|
5231
5683
|
/**
|
|
5232
5684
|
* Architect service.
|
|
5233
5685
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5234
|
-
* @version
|
|
5686
|
+
* @version 204.0.1
|
|
5235
5687
|
*/
|
|
5236
5688
|
|
|
5237
5689
|
/**
|
|
@@ -9366,7 +9818,7 @@ class AuditApi {
|
|
|
9366
9818
|
/**
|
|
9367
9819
|
* Audit service.
|
|
9368
9820
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9369
|
-
* @version
|
|
9821
|
+
* @version 204.0.1
|
|
9370
9822
|
*/
|
|
9371
9823
|
|
|
9372
9824
|
/**
|
|
@@ -9567,7 +10019,7 @@ class AuthorizationApi {
|
|
|
9567
10019
|
/**
|
|
9568
10020
|
* Authorization service.
|
|
9569
10021
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9570
|
-
* @version
|
|
10022
|
+
* @version 204.0.1
|
|
9571
10023
|
*/
|
|
9572
10024
|
|
|
9573
10025
|
/**
|
|
@@ -10850,7 +11302,7 @@ class BillingApi {
|
|
|
10850
11302
|
/**
|
|
10851
11303
|
* Billing service.
|
|
10852
11304
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10853
|
-
* @version
|
|
11305
|
+
* @version 204.0.1
|
|
10854
11306
|
*/
|
|
10855
11307
|
|
|
10856
11308
|
/**
|
|
@@ -10930,7 +11382,7 @@ class CarrierServicesApi {
|
|
|
10930
11382
|
/**
|
|
10931
11383
|
* CarrierServices service.
|
|
10932
11384
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10933
|
-
* @version
|
|
11385
|
+
* @version 204.0.1
|
|
10934
11386
|
*/
|
|
10935
11387
|
|
|
10936
11388
|
/**
|
|
@@ -11000,7 +11452,7 @@ class ChatApi {
|
|
|
11000
11452
|
/**
|
|
11001
11453
|
* Chat service.
|
|
11002
11454
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
11003
|
-
* @version
|
|
11455
|
+
* @version 204.0.1
|
|
11004
11456
|
*/
|
|
11005
11457
|
|
|
11006
11458
|
/**
|
|
@@ -11936,7 +12388,7 @@ class CoachingApi {
|
|
|
11936
12388
|
/**
|
|
11937
12389
|
* Coaching service.
|
|
11938
12390
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11939
|
-
* @version
|
|
12391
|
+
* @version 204.0.1
|
|
11940
12392
|
*/
|
|
11941
12393
|
|
|
11942
12394
|
/**
|
|
@@ -12513,7 +12965,7 @@ class ContentManagementApi {
|
|
|
12513
12965
|
/**
|
|
12514
12966
|
* ContentManagement service.
|
|
12515
12967
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12516
|
-
* @version
|
|
12968
|
+
* @version 204.0.1
|
|
12517
12969
|
*/
|
|
12518
12970
|
|
|
12519
12971
|
/**
|
|
@@ -13595,7 +14047,7 @@ class ConversationsApi {
|
|
|
13595
14047
|
/**
|
|
13596
14048
|
* Conversations service.
|
|
13597
14049
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13598
|
-
* @version
|
|
14050
|
+
* @version 204.0.1
|
|
13599
14051
|
*/
|
|
13600
14052
|
|
|
13601
14053
|
/**
|
|
@@ -20708,7 +21160,7 @@ class DataExtensionsApi {
|
|
|
20708
21160
|
/**
|
|
20709
21161
|
* DataExtensions service.
|
|
20710
21162
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20711
|
-
* @version
|
|
21163
|
+
* @version 204.0.1
|
|
20712
21164
|
*/
|
|
20713
21165
|
|
|
20714
21166
|
/**
|
|
@@ -20794,7 +21246,7 @@ class DownloadsApi {
|
|
|
20794
21246
|
/**
|
|
20795
21247
|
* Downloads service.
|
|
20796
21248
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20797
|
-
* @version
|
|
21249
|
+
* @version 204.0.1
|
|
20798
21250
|
*/
|
|
20799
21251
|
|
|
20800
21252
|
/**
|
|
@@ -20846,7 +21298,7 @@ class EmailsApi {
|
|
|
20846
21298
|
/**
|
|
20847
21299
|
* Emails service.
|
|
20848
21300
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20849
|
-
* @version
|
|
21301
|
+
* @version 204.0.1
|
|
20850
21302
|
*/
|
|
20851
21303
|
|
|
20852
21304
|
/**
|
|
@@ -20911,7 +21363,7 @@ class EmployeeEngagementApi {
|
|
|
20911
21363
|
/**
|
|
20912
21364
|
* EmployeeEngagement service.
|
|
20913
21365
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20914
|
-
* @version
|
|
21366
|
+
* @version 204.0.1
|
|
20915
21367
|
*/
|
|
20916
21368
|
|
|
20917
21369
|
/**
|
|
@@ -21062,7 +21514,7 @@ class EventsApi {
|
|
|
21062
21514
|
/**
|
|
21063
21515
|
* Events service.
|
|
21064
21516
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21065
|
-
* @version
|
|
21517
|
+
* @version 204.0.1
|
|
21066
21518
|
*/
|
|
21067
21519
|
|
|
21068
21520
|
/**
|
|
@@ -21158,7 +21610,7 @@ class ExternalContactsApi {
|
|
|
21158
21610
|
/**
|
|
21159
21611
|
* ExternalContacts service.
|
|
21160
21612
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21161
|
-
* @version
|
|
21613
|
+
* @version 204.0.1
|
|
21162
21614
|
*/
|
|
21163
21615
|
|
|
21164
21616
|
/**
|
|
@@ -21253,6 +21705,32 @@ class ExternalContactsApi {
|
|
|
21253
21705
|
);
|
|
21254
21706
|
}
|
|
21255
21707
|
|
|
21708
|
+
/**
|
|
21709
|
+
* Delete an External Source. WARNING: Any records that reference this External Source will not be automatically cleaned up. Those records will still be editable, but their External IDs may not be fully viewable.
|
|
21710
|
+
*
|
|
21711
|
+
* @param {String} externalSourceId External Source ID
|
|
21712
|
+
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21713
|
+
*/
|
|
21714
|
+
deleteExternalcontactsExternalsource(externalSourceId) {
|
|
21715
|
+
// verify the required parameter 'externalSourceId' is set
|
|
21716
|
+
if (externalSourceId === undefined || externalSourceId === null) {
|
|
21717
|
+
throw 'Missing the required parameter "externalSourceId" when calling deleteExternalcontactsExternalsource';
|
|
21718
|
+
}
|
|
21719
|
+
|
|
21720
|
+
return this.apiClient.callApi(
|
|
21721
|
+
'/api/v2/externalcontacts/externalsources/{externalSourceId}',
|
|
21722
|
+
'DELETE',
|
|
21723
|
+
{ 'externalSourceId': externalSourceId },
|
|
21724
|
+
{ },
|
|
21725
|
+
{ },
|
|
21726
|
+
{ },
|
|
21727
|
+
null,
|
|
21728
|
+
['PureCloud OAuth'],
|
|
21729
|
+
['application/json'],
|
|
21730
|
+
['application/json']
|
|
21731
|
+
);
|
|
21732
|
+
}
|
|
21733
|
+
|
|
21256
21734
|
/**
|
|
21257
21735
|
* Delete an external organization
|
|
21258
21736
|
*
|
|
@@ -21363,7 +21841,7 @@ class ExternalContactsApi {
|
|
|
21363
21841
|
*
|
|
21364
21842
|
* @param {String} contactId ExternalContact ID
|
|
21365
21843
|
* @param {Object} opts Optional parameters
|
|
21366
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21844
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21367
21845
|
*/
|
|
21368
21846
|
getExternalcontactsContact(contactId, opts) {
|
|
21369
21847
|
opts = opts || {};
|
|
@@ -21666,6 +22144,60 @@ class ExternalContactsApi {
|
|
|
21666
22144
|
);
|
|
21667
22145
|
}
|
|
21668
22146
|
|
|
22147
|
+
/**
|
|
22148
|
+
* Fetch an External Source
|
|
22149
|
+
*
|
|
22150
|
+
* @param {String} externalSourceId External Source ID
|
|
22151
|
+
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22152
|
+
*/
|
|
22153
|
+
getExternalcontactsExternalsource(externalSourceId) {
|
|
22154
|
+
// verify the required parameter 'externalSourceId' is set
|
|
22155
|
+
if (externalSourceId === undefined || externalSourceId === null) {
|
|
22156
|
+
throw 'Missing the required parameter "externalSourceId" when calling getExternalcontactsExternalsource';
|
|
22157
|
+
}
|
|
22158
|
+
|
|
22159
|
+
return this.apiClient.callApi(
|
|
22160
|
+
'/api/v2/externalcontacts/externalsources/{externalSourceId}',
|
|
22161
|
+
'GET',
|
|
22162
|
+
{ 'externalSourceId': externalSourceId },
|
|
22163
|
+
{ },
|
|
22164
|
+
{ },
|
|
22165
|
+
{ },
|
|
22166
|
+
null,
|
|
22167
|
+
['PureCloud OAuth'],
|
|
22168
|
+
['application/json'],
|
|
22169
|
+
['application/json']
|
|
22170
|
+
);
|
|
22171
|
+
}
|
|
22172
|
+
|
|
22173
|
+
/**
|
|
22174
|
+
* Fetch a list of External Sources
|
|
22175
|
+
*
|
|
22176
|
+
* @param {Object} opts Optional parameters
|
|
22177
|
+
* @param {String} opts.cursor Indicates where to resume query results (not required for first page), each page returns a new cursor with a 24h TTL
|
|
22178
|
+
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
22179
|
+
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
22180
|
+
* @param {Boolean} opts.active Filter by active status of external source
|
|
22181
|
+
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22182
|
+
*/
|
|
22183
|
+
getExternalcontactsExternalsources(opts) {
|
|
22184
|
+
opts = opts || {};
|
|
22185
|
+
|
|
22186
|
+
|
|
22187
|
+
return this.apiClient.callApi(
|
|
22188
|
+
'/api/v2/externalcontacts/externalsources',
|
|
22189
|
+
'GET',
|
|
22190
|
+
{ },
|
|
22191
|
+
{ 'cursor': opts['cursor'],'limit': opts['limit'],'name': opts['name'],'active': opts['active'] },
|
|
22192
|
+
{ },
|
|
22193
|
+
{ },
|
|
22194
|
+
null,
|
|
22195
|
+
['PureCloud OAuth'],
|
|
22196
|
+
['application/json'],
|
|
22197
|
+
['application/json']
|
|
22198
|
+
);
|
|
22199
|
+
}
|
|
22200
|
+
|
|
21669
22201
|
/**
|
|
21670
22202
|
* Fetch an external organization
|
|
21671
22203
|
*
|
|
@@ -22675,6 +23207,32 @@ class ExternalContactsApi {
|
|
|
22675
23207
|
);
|
|
22676
23208
|
}
|
|
22677
23209
|
|
|
23210
|
+
/**
|
|
23211
|
+
* Create an External Source
|
|
23212
|
+
*
|
|
23213
|
+
* @param {Object} body External Source
|
|
23214
|
+
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23215
|
+
*/
|
|
23216
|
+
postExternalcontactsExternalsources(body) {
|
|
23217
|
+
// verify the required parameter 'body' is set
|
|
23218
|
+
if (body === undefined || body === null) {
|
|
23219
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsExternalsources';
|
|
23220
|
+
}
|
|
23221
|
+
|
|
23222
|
+
return this.apiClient.callApi(
|
|
23223
|
+
'/api/v2/externalcontacts/externalsources',
|
|
23224
|
+
'POST',
|
|
23225
|
+
{ },
|
|
23226
|
+
{ },
|
|
23227
|
+
{ },
|
|
23228
|
+
{ },
|
|
23229
|
+
body,
|
|
23230
|
+
['PureCloud OAuth'],
|
|
23231
|
+
['application/json'],
|
|
23232
|
+
['application/json']
|
|
23233
|
+
);
|
|
23234
|
+
}
|
|
23235
|
+
|
|
22678
23236
|
/**
|
|
22679
23237
|
* Fetch a contact using an identifier type and value.
|
|
22680
23238
|
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
@@ -22959,6 +23517,37 @@ class ExternalContactsApi {
|
|
|
22959
23517
|
);
|
|
22960
23518
|
}
|
|
22961
23519
|
|
|
23520
|
+
/**
|
|
23521
|
+
* Update an External Source
|
|
23522
|
+
*
|
|
23523
|
+
* @param {String} externalSourceId External Source ID
|
|
23524
|
+
* @param {Object} body External Source
|
|
23525
|
+
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23526
|
+
*/
|
|
23527
|
+
putExternalcontactsExternalsource(externalSourceId, body) {
|
|
23528
|
+
// verify the required parameter 'externalSourceId' is set
|
|
23529
|
+
if (externalSourceId === undefined || externalSourceId === null) {
|
|
23530
|
+
throw 'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';
|
|
23531
|
+
}
|
|
23532
|
+
// verify the required parameter 'body' is set
|
|
23533
|
+
if (body === undefined || body === null) {
|
|
23534
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsExternalsource';
|
|
23535
|
+
}
|
|
23536
|
+
|
|
23537
|
+
return this.apiClient.callApi(
|
|
23538
|
+
'/api/v2/externalcontacts/externalsources/{externalSourceId}',
|
|
23539
|
+
'PUT',
|
|
23540
|
+
{ 'externalSourceId': externalSourceId },
|
|
23541
|
+
{ },
|
|
23542
|
+
{ },
|
|
23543
|
+
{ },
|
|
23544
|
+
body,
|
|
23545
|
+
['PureCloud OAuth'],
|
|
23546
|
+
['application/json'],
|
|
23547
|
+
['application/json']
|
|
23548
|
+
);
|
|
23549
|
+
}
|
|
23550
|
+
|
|
22962
23551
|
/**
|
|
22963
23552
|
* Update an external organization
|
|
22964
23553
|
*
|
|
@@ -23120,7 +23709,7 @@ class FaxApi {
|
|
|
23120
23709
|
/**
|
|
23121
23710
|
* Fax service.
|
|
23122
23711
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23123
|
-
* @version
|
|
23712
|
+
* @version 204.0.1
|
|
23124
23713
|
*/
|
|
23125
23714
|
|
|
23126
23715
|
/**
|
|
@@ -23335,7 +23924,7 @@ class FlowsApi {
|
|
|
23335
23924
|
/**
|
|
23336
23925
|
* Flows service.
|
|
23337
23926
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23338
|
-
* @version
|
|
23927
|
+
* @version 204.0.1
|
|
23339
23928
|
*/
|
|
23340
23929
|
|
|
23341
23930
|
/**
|
|
@@ -23518,7 +24107,7 @@ class GamificationApi {
|
|
|
23518
24107
|
/**
|
|
23519
24108
|
* Gamification service.
|
|
23520
24109
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23521
|
-
* @version
|
|
24110
|
+
* @version 204.0.1
|
|
23522
24111
|
*/
|
|
23523
24112
|
|
|
23524
24113
|
/**
|
|
@@ -25604,7 +26193,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25604
26193
|
/**
|
|
25605
26194
|
* GeneralDataProtectionRegulation service.
|
|
25606
26195
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25607
|
-
* @version
|
|
26196
|
+
* @version 204.0.1
|
|
25608
26197
|
*/
|
|
25609
26198
|
|
|
25610
26199
|
/**
|
|
@@ -25734,7 +26323,7 @@ class GeolocationApi {
|
|
|
25734
26323
|
/**
|
|
25735
26324
|
* Geolocation service.
|
|
25736
26325
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25737
|
-
* @version
|
|
26326
|
+
* @version 204.0.1
|
|
25738
26327
|
*/
|
|
25739
26328
|
|
|
25740
26329
|
/**
|
|
@@ -25865,7 +26454,7 @@ class GreetingsApi {
|
|
|
25865
26454
|
/**
|
|
25866
26455
|
* Greetings service.
|
|
25867
26456
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25868
|
-
* @version
|
|
26457
|
+
* @version 204.0.1
|
|
25869
26458
|
*/
|
|
25870
26459
|
|
|
25871
26460
|
/**
|
|
@@ -26320,7 +26909,7 @@ class GroupsApi {
|
|
|
26320
26909
|
/**
|
|
26321
26910
|
* Groups service.
|
|
26322
26911
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26323
|
-
* @version
|
|
26912
|
+
* @version 204.0.1
|
|
26324
26913
|
*/
|
|
26325
26914
|
|
|
26326
26915
|
/**
|
|
@@ -26839,7 +27428,7 @@ class IdentityProviderApi {
|
|
|
26839
27428
|
/**
|
|
26840
27429
|
* IdentityProvider service.
|
|
26841
27430
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26842
|
-
* @version
|
|
27431
|
+
* @version 204.0.1
|
|
26843
27432
|
*/
|
|
26844
27433
|
|
|
26845
27434
|
/**
|
|
@@ -27700,7 +28289,7 @@ class InfrastructureAsCodeApi {
|
|
|
27700
28289
|
/**
|
|
27701
28290
|
* InfrastructureAsCode service.
|
|
27702
28291
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27703
|
-
* @version
|
|
28292
|
+
* @version 204.0.1
|
|
27704
28293
|
*/
|
|
27705
28294
|
|
|
27706
28295
|
/**
|
|
@@ -27867,7 +28456,7 @@ class IntegrationsApi {
|
|
|
27867
28456
|
/**
|
|
27868
28457
|
* Integrations service.
|
|
27869
28458
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27870
|
-
* @version
|
|
28459
|
+
* @version 204.0.1
|
|
27871
28460
|
*/
|
|
27872
28461
|
|
|
27873
28462
|
/**
|
|
@@ -30239,7 +30828,7 @@ class JourneyApi {
|
|
|
30239
30828
|
/**
|
|
30240
30829
|
* Journey service.
|
|
30241
30830
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30242
|
-
* @version
|
|
30831
|
+
* @version 204.0.1
|
|
30243
30832
|
*/
|
|
30244
30833
|
|
|
30245
30834
|
/**
|
|
@@ -30387,7 +30976,6 @@ class JourneyApi {
|
|
|
30387
30976
|
* Delete a Journey View by ID
|
|
30388
30977
|
* deletes all versions
|
|
30389
30978
|
* @param {String} viewId viewId
|
|
30390
|
-
* deleteJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30391
30979
|
*/
|
|
30392
30980
|
deleteJourneyView(viewId) {
|
|
30393
30981
|
// verify the required parameter 'viewId' is set
|
|
@@ -31036,7 +31624,6 @@ class JourneyApi {
|
|
|
31036
31624
|
* Get a Journey View by ID
|
|
31037
31625
|
* returns the latest version
|
|
31038
31626
|
* @param {String} viewId viewId
|
|
31039
|
-
* getJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31040
31627
|
*/
|
|
31041
31628
|
getJourneyView(viewId) {
|
|
31042
31629
|
// verify the required parameter 'viewId' is set
|
|
@@ -31063,7 +31650,6 @@ class JourneyApi {
|
|
|
31063
31650
|
*
|
|
31064
31651
|
* @param {String} viewId viewId
|
|
31065
31652
|
* @param {String} versionId versionId
|
|
31066
|
-
* getJourneyViewVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31067
31653
|
*/
|
|
31068
31654
|
getJourneyViewVersion(viewId, versionId) {
|
|
31069
31655
|
// verify the required parameter 'viewId' is set
|
|
@@ -31095,7 +31681,6 @@ class JourneyApi {
|
|
|
31095
31681
|
* @param {String} viewId Journey View Id
|
|
31096
31682
|
* @param {String} journeyVersionId Journey View Version
|
|
31097
31683
|
* @param {String} jobId JobId
|
|
31098
|
-
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31099
31684
|
*/
|
|
31100
31685
|
getJourneyViewVersionJob(viewId, journeyVersionId, jobId) {
|
|
31101
31686
|
// verify the required parameter 'viewId' is set
|
|
@@ -31131,7 +31716,6 @@ class JourneyApi {
|
|
|
31131
31716
|
* @param {String} viewId JourneyViewResult id
|
|
31132
31717
|
* @param {String} journeyViewVersion Journey View Version
|
|
31133
31718
|
* @param {String} jobId Id of the executing job
|
|
31134
|
-
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31135
31719
|
*/
|
|
31136
31720
|
getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) {
|
|
31137
31721
|
// verify the required parameter 'viewId' is set
|
|
@@ -31166,7 +31750,6 @@ class JourneyApi {
|
|
|
31166
31750
|
* used for long descriptions
|
|
31167
31751
|
* @param {String} viewId Journey View Id
|
|
31168
31752
|
* @param {String} journeyVersionId Journey View Version
|
|
31169
|
-
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31170
31753
|
*/
|
|
31171
31754
|
getJourneyViewVersionJobsLatest(viewId, journeyVersionId) {
|
|
31172
31755
|
// verify the required parameter 'viewId' is set
|
|
@@ -31200,7 +31783,7 @@ class JourneyApi {
|
|
|
31200
31783
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
31201
31784
|
* @param {String} opts.nameOrCreatedBy Journey View Name or Created By
|
|
31202
31785
|
* @param {Object} opts.expand Parameter to request additional data to return in Journey payload
|
|
31203
|
-
*
|
|
31786
|
+
* @param {String} opts.id Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.
|
|
31204
31787
|
*/
|
|
31205
31788
|
getJourneyViews(opts) {
|
|
31206
31789
|
opts = opts || {};
|
|
@@ -31210,7 +31793,7 @@ class JourneyApi {
|
|
|
31210
31793
|
'/api/v2/journey/views',
|
|
31211
31794
|
'GET',
|
|
31212
31795
|
{ },
|
|
31213
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'nameOrCreatedBy': opts['nameOrCreatedBy'],'expand': opts['expand'] },
|
|
31796
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'nameOrCreatedBy': opts['nameOrCreatedBy'],'expand': opts['expand'],'id': opts['id'] },
|
|
31214
31797
|
{ },
|
|
31215
31798
|
{ },
|
|
31216
31799
|
null,
|
|
@@ -31275,7 +31858,6 @@ class JourneyApi {
|
|
|
31275
31858
|
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
31276
31859
|
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
31277
31860
|
* @param {String} opts.statuses Job statuses to filter for
|
|
31278
|
-
* getJourneyViewsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31279
31861
|
*/
|
|
31280
31862
|
getJourneyViewsJobs(opts) {
|
|
31281
31863
|
opts = opts || {};
|
|
@@ -31778,7 +32360,6 @@ class JourneyApi {
|
|
|
31778
32360
|
* used for long descriptions
|
|
31779
32361
|
* @param {String} viewId Journey View Id
|
|
31780
32362
|
* @param {String} journeyVersionId Journey View Version
|
|
31781
|
-
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31782
32363
|
*/
|
|
31783
32364
|
postJourneyViewVersionJobs(viewId, journeyVersionId) {
|
|
31784
32365
|
// verify the required parameter 'viewId' is set
|
|
@@ -31809,7 +32390,6 @@ class JourneyApi {
|
|
|
31809
32390
|
* creates a new version
|
|
31810
32391
|
* @param {String} viewId viewId
|
|
31811
32392
|
* @param {Object} body JourneyView
|
|
31812
|
-
* postJourneyViewVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31813
32393
|
*/
|
|
31814
32394
|
postJourneyViewVersions(viewId, body) {
|
|
31815
32395
|
// verify the required parameter 'viewId' is set
|
|
@@ -31839,7 +32419,6 @@ class JourneyApi {
|
|
|
31839
32419
|
* Create a new Journey View
|
|
31840
32420
|
*
|
|
31841
32421
|
* @param {Object} body JourneyView
|
|
31842
|
-
* postJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31843
32422
|
*/
|
|
31844
32423
|
postJourneyViews(body) {
|
|
31845
32424
|
// verify the required parameter 'body' is set
|
|
@@ -31892,7 +32471,7 @@ class KnowledgeApi {
|
|
|
31892
32471
|
/**
|
|
31893
32472
|
* Knowledge service.
|
|
31894
32473
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31895
|
-
* @version
|
|
32474
|
+
* @version 204.0.1
|
|
31896
32475
|
*/
|
|
31897
32476
|
|
|
31898
32477
|
/**
|
|
@@ -33638,6 +34217,45 @@ class KnowledgeApi {
|
|
|
33638
34217
|
);
|
|
33639
34218
|
}
|
|
33640
34219
|
|
|
34220
|
+
/**
|
|
34221
|
+
* Update feedback on a document
|
|
34222
|
+
*
|
|
34223
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
34224
|
+
* @param {String} documentId Document ID.
|
|
34225
|
+
* @param {String} feedbackId Feedback ID.
|
|
34226
|
+
* @param {Object} opts Optional parameters
|
|
34227
|
+
* @param {Object} opts.body
|
|
34228
|
+
*/
|
|
34229
|
+
patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId, opts) {
|
|
34230
|
+
opts = opts || {};
|
|
34231
|
+
|
|
34232
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
34233
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
34234
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
34235
|
+
}
|
|
34236
|
+
// verify the required parameter 'documentId' is set
|
|
34237
|
+
if (documentId === undefined || documentId === null) {
|
|
34238
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
34239
|
+
}
|
|
34240
|
+
// verify the required parameter 'feedbackId' is set
|
|
34241
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
34242
|
+
throw 'Missing the required parameter "feedbackId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
34243
|
+
}
|
|
34244
|
+
|
|
34245
|
+
return this.apiClient.callApi(
|
|
34246
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
34247
|
+
'PATCH',
|
|
34248
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
34249
|
+
{ },
|
|
34250
|
+
{ },
|
|
34251
|
+
{ },
|
|
34252
|
+
opts['body'],
|
|
34253
|
+
['PureCloud OAuth'],
|
|
34254
|
+
['application/json'],
|
|
34255
|
+
['application/json']
|
|
34256
|
+
);
|
|
34257
|
+
}
|
|
34258
|
+
|
|
33641
34259
|
/**
|
|
33642
34260
|
* Update a variation for a document.
|
|
33643
34261
|
*
|
|
@@ -34144,6 +34762,36 @@ class KnowledgeApi {
|
|
|
34144
34762
|
);
|
|
34145
34763
|
}
|
|
34146
34764
|
|
|
34765
|
+
/**
|
|
34766
|
+
* Answer documents.
|
|
34767
|
+
*
|
|
34768
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
34769
|
+
* @param {Object} body
|
|
34770
|
+
*/
|
|
34771
|
+
postKnowledgeGuestSessionDocumentsAnswers(sessionId, body) {
|
|
34772
|
+
// verify the required parameter 'sessionId' is set
|
|
34773
|
+
if (sessionId === undefined || sessionId === null) {
|
|
34774
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsAnswers';
|
|
34775
|
+
}
|
|
34776
|
+
// verify the required parameter 'body' is set
|
|
34777
|
+
if (body === undefined || body === null) {
|
|
34778
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessionDocumentsAnswers';
|
|
34779
|
+
}
|
|
34780
|
+
|
|
34781
|
+
return this.apiClient.callApi(
|
|
34782
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers',
|
|
34783
|
+
'POST',
|
|
34784
|
+
{ 'sessionId': sessionId },
|
|
34785
|
+
{ },
|
|
34786
|
+
{ },
|
|
34787
|
+
{ },
|
|
34788
|
+
body,
|
|
34789
|
+
['PureCloud OAuth'],
|
|
34790
|
+
['application/json'],
|
|
34791
|
+
['application/json']
|
|
34792
|
+
);
|
|
34793
|
+
}
|
|
34794
|
+
|
|
34147
34795
|
/**
|
|
34148
34796
|
* Indicate that documents were presented to the user.
|
|
34149
34797
|
*
|
|
@@ -34489,6 +35137,36 @@ class KnowledgeApi {
|
|
|
34489
35137
|
);
|
|
34490
35138
|
}
|
|
34491
35139
|
|
|
35140
|
+
/**
|
|
35141
|
+
* Answer documents.
|
|
35142
|
+
*
|
|
35143
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
35144
|
+
* @param {Object} body
|
|
35145
|
+
*/
|
|
35146
|
+
postKnowledgeKnowledgebaseDocumentsAnswers(knowledgeBaseId, body) {
|
|
35147
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
35148
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
35149
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsAnswers';
|
|
35150
|
+
}
|
|
35151
|
+
// verify the required parameter 'body' is set
|
|
35152
|
+
if (body === undefined || body === null) {
|
|
35153
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsAnswers';
|
|
35154
|
+
}
|
|
35155
|
+
|
|
35156
|
+
return this.apiClient.callApi(
|
|
35157
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers',
|
|
35158
|
+
'POST',
|
|
35159
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
35160
|
+
{ },
|
|
35161
|
+
{ },
|
|
35162
|
+
{ },
|
|
35163
|
+
body,
|
|
35164
|
+
['PureCloud OAuth'],
|
|
35165
|
+
['application/json'],
|
|
35166
|
+
['application/json']
|
|
35167
|
+
);
|
|
35168
|
+
}
|
|
35169
|
+
|
|
34492
35170
|
/**
|
|
34493
35171
|
* Bulk remove documents.
|
|
34494
35172
|
*
|
|
@@ -35166,7 +35844,7 @@ class LanguageUnderstandingApi {
|
|
|
35166
35844
|
/**
|
|
35167
35845
|
* LanguageUnderstanding service.
|
|
35168
35846
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
35169
|
-
* @version
|
|
35847
|
+
* @version 204.0.1
|
|
35170
35848
|
*/
|
|
35171
35849
|
|
|
35172
35850
|
/**
|
|
@@ -36200,7 +36878,7 @@ class LanguagesApi {
|
|
|
36200
36878
|
/**
|
|
36201
36879
|
* Languages service.
|
|
36202
36880
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
36203
|
-
* @version
|
|
36881
|
+
* @version 204.0.1
|
|
36204
36882
|
*/
|
|
36205
36883
|
|
|
36206
36884
|
/**
|
|
@@ -36422,7 +37100,7 @@ class LearningApi {
|
|
|
36422
37100
|
/**
|
|
36423
37101
|
* Learning service.
|
|
36424
37102
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36425
|
-
* @version
|
|
37103
|
+
* @version 204.0.1
|
|
36426
37104
|
*/
|
|
36427
37105
|
|
|
36428
37106
|
/**
|
|
@@ -37451,7 +38129,7 @@ class LicenseApi {
|
|
|
37451
38129
|
/**
|
|
37452
38130
|
* License service.
|
|
37453
38131
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37454
|
-
* @version
|
|
38132
|
+
* @version 204.0.1
|
|
37455
38133
|
*/
|
|
37456
38134
|
|
|
37457
38135
|
/**
|
|
@@ -37689,7 +38367,7 @@ class LocationsApi {
|
|
|
37689
38367
|
/**
|
|
37690
38368
|
* Locations service.
|
|
37691
38369
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37692
|
-
* @version
|
|
38370
|
+
* @version 204.0.1
|
|
37693
38371
|
*/
|
|
37694
38372
|
|
|
37695
38373
|
/**
|
|
@@ -37925,7 +38603,7 @@ class LogCaptureApi {
|
|
|
37925
38603
|
/**
|
|
37926
38604
|
* LogCapture service.
|
|
37927
38605
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37928
|
-
* @version
|
|
38606
|
+
* @version 204.0.1
|
|
37929
38607
|
*/
|
|
37930
38608
|
|
|
37931
38609
|
/**
|
|
@@ -38125,7 +38803,7 @@ class MessagingApi {
|
|
|
38125
38803
|
/**
|
|
38126
38804
|
* Messaging service.
|
|
38127
38805
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
38128
|
-
* @version
|
|
38806
|
+
* @version 204.0.1
|
|
38129
38807
|
*/
|
|
38130
38808
|
|
|
38131
38809
|
/**
|
|
@@ -38484,7 +39162,7 @@ class MobileDevicesApi {
|
|
|
38484
39162
|
/**
|
|
38485
39163
|
* MobileDevices service.
|
|
38486
39164
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38487
|
-
* @version
|
|
39165
|
+
* @version 204.0.1
|
|
38488
39166
|
*/
|
|
38489
39167
|
|
|
38490
39168
|
/**
|
|
@@ -38635,7 +39313,7 @@ class NotificationsApi {
|
|
|
38635
39313
|
/**
|
|
38636
39314
|
* Notifications service.
|
|
38637
39315
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38638
|
-
* @version
|
|
39316
|
+
* @version 204.0.1
|
|
38639
39317
|
*/
|
|
38640
39318
|
|
|
38641
39319
|
/**
|
|
@@ -38868,7 +39546,7 @@ class OAuthApi {
|
|
|
38868
39546
|
/**
|
|
38869
39547
|
* OAuth service.
|
|
38870
39548
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38871
|
-
* @version
|
|
39549
|
+
* @version 204.0.1
|
|
38872
39550
|
*/
|
|
38873
39551
|
|
|
38874
39552
|
/**
|
|
@@ -39234,7 +39912,7 @@ class ObjectsApi {
|
|
|
39234
39912
|
/**
|
|
39235
39913
|
* Objects service.
|
|
39236
39914
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
39237
|
-
* @version
|
|
39915
|
+
* @version 204.0.1
|
|
39238
39916
|
*/
|
|
39239
39917
|
|
|
39240
39918
|
/**
|
|
@@ -39504,7 +40182,7 @@ class OperationalEventsApi {
|
|
|
39504
40182
|
/**
|
|
39505
40183
|
* OperationalEvents service.
|
|
39506
40184
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39507
|
-
* @version
|
|
40185
|
+
* @version 204.0.1
|
|
39508
40186
|
*/
|
|
39509
40187
|
|
|
39510
40188
|
/**
|
|
@@ -39570,7 +40248,7 @@ class OrganizationApi {
|
|
|
39570
40248
|
/**
|
|
39571
40249
|
* Organization service.
|
|
39572
40250
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39573
|
-
* @version
|
|
40251
|
+
* @version 204.0.1
|
|
39574
40252
|
*/
|
|
39575
40253
|
|
|
39576
40254
|
/**
|
|
@@ -40112,7 +40790,7 @@ class OrganizationAuthorizationApi {
|
|
|
40112
40790
|
/**
|
|
40113
40791
|
* OrganizationAuthorization service.
|
|
40114
40792
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
40115
|
-
* @version
|
|
40793
|
+
* @version 204.0.1
|
|
40116
40794
|
*/
|
|
40117
40795
|
|
|
40118
40796
|
/**
|
|
@@ -41459,7 +42137,7 @@ class OutboundApi {
|
|
|
41459
42137
|
/**
|
|
41460
42138
|
* Outbound service.
|
|
41461
42139
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
41462
|
-
* @version
|
|
42140
|
+
* @version 204.0.1
|
|
41463
42141
|
*/
|
|
41464
42142
|
|
|
41465
42143
|
/**
|
|
@@ -45876,7 +46554,7 @@ class PresenceApi {
|
|
|
45876
46554
|
/**
|
|
45877
46555
|
* Presence service.
|
|
45878
46556
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45879
|
-
* @version
|
|
46557
|
+
* @version 204.0.1
|
|
45880
46558
|
*/
|
|
45881
46559
|
|
|
45882
46560
|
/**
|
|
@@ -46620,7 +47298,7 @@ class ProcessAutomationApi {
|
|
|
46620
47298
|
/**
|
|
46621
47299
|
* ProcessAutomation service.
|
|
46622
47300
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
46623
|
-
* @version
|
|
47301
|
+
* @version 204.0.1
|
|
46624
47302
|
*/
|
|
46625
47303
|
|
|
46626
47304
|
/**
|
|
@@ -46859,7 +47537,7 @@ class QualityApi {
|
|
|
46859
47537
|
/**
|
|
46860
47538
|
* Quality service.
|
|
46861
47539
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46862
|
-
* @version
|
|
47540
|
+
* @version 204.0.1
|
|
46863
47541
|
*/
|
|
46864
47542
|
|
|
46865
47543
|
/**
|
|
@@ -48645,7 +49323,7 @@ class RecordingApi {
|
|
|
48645
49323
|
/**
|
|
48646
49324
|
* Recording service.
|
|
48647
49325
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
48648
|
-
* @version
|
|
49326
|
+
* @version 204.0.1
|
|
48649
49327
|
*/
|
|
48650
49328
|
|
|
48651
49329
|
/**
|
|
@@ -50304,7 +50982,7 @@ class ResponseManagementApi {
|
|
|
50304
50982
|
/**
|
|
50305
50983
|
* ResponseManagement service.
|
|
50306
50984
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
50307
|
-
* @version
|
|
50985
|
+
* @version 204.0.1
|
|
50308
50986
|
*/
|
|
50309
50987
|
|
|
50310
50988
|
/**
|
|
@@ -50814,7 +51492,7 @@ class RoutingApi {
|
|
|
50814
51492
|
/**
|
|
50815
51493
|
* Routing service.
|
|
50816
51494
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50817
|
-
* @version
|
|
51495
|
+
* @version 204.0.1
|
|
50818
51496
|
*/
|
|
50819
51497
|
|
|
50820
51498
|
/**
|
|
@@ -52095,6 +52773,35 @@ class RoutingApi {
|
|
|
52095
52773
|
);
|
|
52096
52774
|
}
|
|
52097
52775
|
|
|
52776
|
+
/**
|
|
52777
|
+
* Get an assistant associated with a queue.
|
|
52778
|
+
*
|
|
52779
|
+
* @param {String} queueId Queue ID
|
|
52780
|
+
* @param {Object} opts Optional parameters
|
|
52781
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
52782
|
+
*/
|
|
52783
|
+
getRoutingQueueAssistant(queueId, opts) {
|
|
52784
|
+
opts = opts || {};
|
|
52785
|
+
|
|
52786
|
+
// verify the required parameter 'queueId' is set
|
|
52787
|
+
if (queueId === undefined || queueId === null) {
|
|
52788
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingQueueAssistant';
|
|
52789
|
+
}
|
|
52790
|
+
|
|
52791
|
+
return this.apiClient.callApi(
|
|
52792
|
+
'/api/v2/routing/queues/{queueId}/assistant',
|
|
52793
|
+
'GET',
|
|
52794
|
+
{ 'queueId': queueId },
|
|
52795
|
+
{ 'expand': opts['expand'] },
|
|
52796
|
+
{ },
|
|
52797
|
+
{ },
|
|
52798
|
+
null,
|
|
52799
|
+
['PureCloud OAuth'],
|
|
52800
|
+
['application/json'],
|
|
52801
|
+
['application/json']
|
|
52802
|
+
);
|
|
52803
|
+
}
|
|
52804
|
+
|
|
52098
52805
|
/**
|
|
52099
52806
|
* Get a Comparison Period.
|
|
52100
52807
|
*
|
|
@@ -54933,7 +55640,7 @@ class SCIMApi {
|
|
|
54933
55640
|
/**
|
|
54934
55641
|
* SCIM service.
|
|
54935
55642
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54936
|
-
* @version
|
|
55643
|
+
* @version 204.0.1
|
|
54937
55644
|
*/
|
|
54938
55645
|
|
|
54939
55646
|
/**
|
|
@@ -55810,7 +56517,7 @@ class ScreenRecordingApi {
|
|
|
55810
56517
|
/**
|
|
55811
56518
|
* ScreenRecording service.
|
|
55812
56519
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
55813
|
-
* @version
|
|
56520
|
+
* @version 204.0.1
|
|
55814
56521
|
*/
|
|
55815
56522
|
|
|
55816
56523
|
/**
|
|
@@ -55855,7 +56562,7 @@ class ScriptsApi {
|
|
|
55855
56562
|
/**
|
|
55856
56563
|
* Scripts service.
|
|
55857
56564
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55858
|
-
* @version
|
|
56565
|
+
* @version 204.0.1
|
|
55859
56566
|
*/
|
|
55860
56567
|
|
|
55861
56568
|
/**
|
|
@@ -56299,7 +57006,7 @@ class SearchApi {
|
|
|
56299
57006
|
/**
|
|
56300
57007
|
* Search service.
|
|
56301
57008
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
56302
|
-
* @version
|
|
57009
|
+
* @version 204.0.1
|
|
56303
57010
|
*/
|
|
56304
57011
|
|
|
56305
57012
|
/**
|
|
@@ -56988,7 +57695,7 @@ class SettingsApi {
|
|
|
56988
57695
|
/**
|
|
56989
57696
|
* Settings service.
|
|
56990
57697
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56991
|
-
* @version
|
|
57698
|
+
* @version 204.0.1
|
|
56992
57699
|
*/
|
|
56993
57700
|
|
|
56994
57701
|
/**
|
|
@@ -57051,7 +57758,6 @@ class SettingsApi {
|
|
|
57051
57758
|
/**
|
|
57052
57759
|
* Get the execution history enabled setting.
|
|
57053
57760
|
* Get the execution history enabled setting.
|
|
57054
|
-
* getSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57055
57761
|
*/
|
|
57056
57762
|
getSettingsExecutiondata() {
|
|
57057
57763
|
|
|
@@ -57122,7 +57828,6 @@ class SettingsApi {
|
|
|
57122
57828
|
* Edit the execution history on off setting.
|
|
57123
57829
|
* Edit the execution history on off setting.
|
|
57124
57830
|
* @param {Object} body New Execution Data Setting
|
|
57125
|
-
* patchSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57126
57831
|
*/
|
|
57127
57832
|
patchSettingsExecutiondata(body) {
|
|
57128
57833
|
// verify the required parameter 'body' is set
|
|
@@ -57210,7 +57915,7 @@ class SpeechTextAnalyticsApi {
|
|
|
57210
57915
|
/**
|
|
57211
57916
|
* SpeechTextAnalytics service.
|
|
57212
57917
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
57213
|
-
* @version
|
|
57918
|
+
* @version 204.0.1
|
|
57214
57919
|
*/
|
|
57215
57920
|
|
|
57216
57921
|
/**
|
|
@@ -58488,7 +59193,7 @@ class StationsApi {
|
|
|
58488
59193
|
/**
|
|
58489
59194
|
* Stations service.
|
|
58490
59195
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
58491
|
-
* @version
|
|
59196
|
+
* @version 204.0.1
|
|
58492
59197
|
*/
|
|
58493
59198
|
|
|
58494
59199
|
/**
|
|
@@ -58590,7 +59295,7 @@ class SuggestApi {
|
|
|
58590
59295
|
/**
|
|
58591
59296
|
* Suggest service.
|
|
58592
59297
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
58593
|
-
* @version
|
|
59298
|
+
* @version 204.0.1
|
|
58594
59299
|
*/
|
|
58595
59300
|
|
|
58596
59301
|
/**
|
|
@@ -58729,7 +59434,7 @@ class TaskManagementApi {
|
|
|
58729
59434
|
/**
|
|
58730
59435
|
* TaskManagement service.
|
|
58731
59436
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
58732
|
-
* @version
|
|
59437
|
+
* @version 204.0.1
|
|
58733
59438
|
*/
|
|
58734
59439
|
|
|
58735
59440
|
/**
|
|
@@ -60083,7 +60788,7 @@ class TeamsApi {
|
|
|
60083
60788
|
/**
|
|
60084
60789
|
* Teams service.
|
|
60085
60790
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
60086
|
-
* @version
|
|
60791
|
+
* @version 204.0.1
|
|
60087
60792
|
*/
|
|
60088
60793
|
|
|
60089
60794
|
/**
|
|
@@ -60384,7 +61089,7 @@ class TelephonyApi {
|
|
|
60384
61089
|
/**
|
|
60385
61090
|
* Telephony service.
|
|
60386
61091
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
60387
|
-
* @version
|
|
61092
|
+
* @version 204.0.1
|
|
60388
61093
|
*/
|
|
60389
61094
|
|
|
60390
61095
|
/**
|
|
@@ -60566,7 +61271,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
60566
61271
|
/**
|
|
60567
61272
|
* TelephonyProvidersEdge service.
|
|
60568
61273
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
60569
|
-
* @version
|
|
61274
|
+
* @version 204.0.1
|
|
60570
61275
|
*/
|
|
60571
61276
|
|
|
60572
61277
|
/**
|
|
@@ -63894,7 +64599,7 @@ class TextbotsApi {
|
|
|
63894
64599
|
/**
|
|
63895
64600
|
* Textbots service.
|
|
63896
64601
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
63897
|
-
* @version
|
|
64602
|
+
* @version 204.0.1
|
|
63898
64603
|
*/
|
|
63899
64604
|
|
|
63900
64605
|
/**
|
|
@@ -64022,7 +64727,7 @@ class TokensApi {
|
|
|
64022
64727
|
/**
|
|
64023
64728
|
* Tokens service.
|
|
64024
64729
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
64025
|
-
* @version
|
|
64730
|
+
* @version 204.0.1
|
|
64026
64731
|
*/
|
|
64027
64732
|
|
|
64028
64733
|
/**
|
|
@@ -64176,7 +64881,7 @@ class UploadsApi {
|
|
|
64176
64881
|
/**
|
|
64177
64882
|
* Uploads service.
|
|
64178
64883
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
64179
|
-
* @version
|
|
64884
|
+
* @version 204.0.1
|
|
64180
64885
|
*/
|
|
64181
64886
|
|
|
64182
64887
|
/**
|
|
@@ -64445,7 +65150,7 @@ class UsageApi {
|
|
|
64445
65150
|
/**
|
|
64446
65151
|
* Usage service.
|
|
64447
65152
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
64448
|
-
* @version
|
|
65153
|
+
* @version 204.0.1
|
|
64449
65154
|
*/
|
|
64450
65155
|
|
|
64451
65156
|
/**
|
|
@@ -64660,7 +65365,7 @@ class UserRecordingsApi {
|
|
|
64660
65365
|
/**
|
|
64661
65366
|
* UserRecordings service.
|
|
64662
65367
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
64663
|
-
* @version
|
|
65368
|
+
* @version 204.0.1
|
|
64664
65369
|
*/
|
|
64665
65370
|
|
|
64666
65371
|
/**
|
|
@@ -64875,7 +65580,7 @@ class UsersApi {
|
|
|
64875
65580
|
/**
|
|
64876
65581
|
* Users service.
|
|
64877
65582
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
64878
|
-
* @version
|
|
65583
|
+
* @version 204.0.1
|
|
64879
65584
|
*/
|
|
64880
65585
|
|
|
64881
65586
|
/**
|
|
@@ -67678,7 +68383,7 @@ class UtilitiesApi {
|
|
|
67678
68383
|
/**
|
|
67679
68384
|
* Utilities service.
|
|
67680
68385
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
67681
|
-
* @version
|
|
68386
|
+
* @version 204.0.1
|
|
67682
68387
|
*/
|
|
67683
68388
|
|
|
67684
68389
|
/**
|
|
@@ -67789,7 +68494,7 @@ class VoicemailApi {
|
|
|
67789
68494
|
/**
|
|
67790
68495
|
* Voicemail service.
|
|
67791
68496
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
67792
|
-
* @version
|
|
68497
|
+
* @version 204.0.1
|
|
67793
68498
|
*/
|
|
67794
68499
|
|
|
67795
68500
|
/**
|
|
@@ -68456,7 +69161,7 @@ class WebChatApi {
|
|
|
68456
69161
|
/**
|
|
68457
69162
|
* WebChat service.
|
|
68458
69163
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
68459
|
-
* @version
|
|
69164
|
+
* @version 204.0.1
|
|
68460
69165
|
*/
|
|
68461
69166
|
|
|
68462
69167
|
/**
|
|
@@ -69007,7 +69712,7 @@ class WebDeploymentsApi {
|
|
|
69007
69712
|
/**
|
|
69008
69713
|
* WebDeployments service.
|
|
69009
69714
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
69010
|
-
* @version
|
|
69715
|
+
* @version 204.0.1
|
|
69011
69716
|
*/
|
|
69012
69717
|
|
|
69013
69718
|
/**
|
|
@@ -69534,7 +70239,7 @@ class WebMessagingApi {
|
|
|
69534
70239
|
/**
|
|
69535
70240
|
* WebMessaging service.
|
|
69536
70241
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
69537
|
-
* @version
|
|
70242
|
+
* @version 204.0.1
|
|
69538
70243
|
*/
|
|
69539
70244
|
|
|
69540
70245
|
/**
|
|
@@ -69580,7 +70285,7 @@ class WidgetsApi {
|
|
|
69580
70285
|
/**
|
|
69581
70286
|
* Widgets service.
|
|
69582
70287
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
69583
|
-
* @version
|
|
70288
|
+
* @version 204.0.1
|
|
69584
70289
|
*/
|
|
69585
70290
|
|
|
69586
70291
|
/**
|
|
@@ -69726,7 +70431,7 @@ class WorkforceManagementApi {
|
|
|
69726
70431
|
/**
|
|
69727
70432
|
* WorkforceManagement service.
|
|
69728
70433
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
69729
|
-
* @version
|
|
70434
|
+
* @version 204.0.1
|
|
69730
70435
|
*/
|
|
69731
70436
|
|
|
69732
70437
|
/**
|
|
@@ -76881,7 +77586,7 @@ class WorkforceManagementApi {
|
|
|
76881
77586
|
* </pre>
|
|
76882
77587
|
* </p>
|
|
76883
77588
|
* @module purecloud-platform-client-v2/index
|
|
76884
|
-
* @version
|
|
77589
|
+
* @version 204.0.1
|
|
76885
77590
|
*/
|
|
76886
77591
|
class platformClient {
|
|
76887
77592
|
constructor() {
|
|
@@ -76895,6 +77600,16 @@ class platformClient {
|
|
|
76895
77600
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
76896
77601
|
*/
|
|
76897
77602
|
this.ApiClientClass = ApiClient;
|
|
77603
|
+
/**
|
|
77604
|
+
* The AgentAssistantsApi service constructor.
|
|
77605
|
+
* @property {module:purecloud-platform-client-v2/api/AgentAssistantsApi}
|
|
77606
|
+
*/
|
|
77607
|
+
this.AgentAssistantsApi = AgentAssistantsApi;
|
|
77608
|
+
/**
|
|
77609
|
+
* The AgentCopilotApi service constructor.
|
|
77610
|
+
* @property {module:purecloud-platform-client-v2/api/AgentCopilotApi}
|
|
77611
|
+
*/
|
|
77612
|
+
this.AgentCopilotApi = AgentCopilotApi;
|
|
76898
77613
|
/**
|
|
76899
77614
|
* The AgentUIApi service constructor.
|
|
76900
77615
|
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|