purecloud-platform-client-v2 202.1.0 → 204.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 +885 -106
- package/dist/web-amd/purecloud-platform-client-v2.js +885 -106
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +452 -261
- package/dist/web-cjs/purecloud-platform-client-v2.js +452 -261
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +589 -224
- package/package.json +2 -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 -12
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +46 -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 +130 -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
|
@@ -402,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
402
402
|
|
|
403
403
|
/**
|
|
404
404
|
* @module purecloud-platform-client-v2/ApiClient
|
|
405
|
-
* @version
|
|
405
|
+
* @version 204.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1820,11 +1820,463 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1820
1820
|
}
|
|
1821
1821
|
}
|
|
1822
1822
|
|
|
1823
|
+
class AgentAssistantsApi {
|
|
1824
|
+
/**
|
|
1825
|
+
* AgentAssistants service.
|
|
1826
|
+
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1827
|
+
* @version 204.0.0
|
|
1828
|
+
*/
|
|
1829
|
+
|
|
1830
|
+
/**
|
|
1831
|
+
* Constructs a new AgentAssistantsApi.
|
|
1832
|
+
* @alias module:purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
1833
|
+
* @class
|
|
1834
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
1835
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
1836
|
+
*/
|
|
1837
|
+
constructor(apiClient) {
|
|
1838
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
1839
|
+
}
|
|
1840
|
+
|
|
1841
|
+
|
|
1842
|
+
/**
|
|
1843
|
+
* Delete an assistant.
|
|
1844
|
+
*
|
|
1845
|
+
* @param {String} assistantId Assistant ID
|
|
1846
|
+
*/
|
|
1847
|
+
deleteAssistant(assistantId) {
|
|
1848
|
+
// verify the required parameter 'assistantId' is set
|
|
1849
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1850
|
+
throw 'Missing the required parameter "assistantId" when calling deleteAssistant';
|
|
1851
|
+
}
|
|
1852
|
+
|
|
1853
|
+
return this.apiClient.callApi(
|
|
1854
|
+
'/api/v2/assistants/{assistantId}',
|
|
1855
|
+
'DELETE',
|
|
1856
|
+
{ 'assistantId': assistantId },
|
|
1857
|
+
{ },
|
|
1858
|
+
{ },
|
|
1859
|
+
{ },
|
|
1860
|
+
null,
|
|
1861
|
+
['PureCloud OAuth'],
|
|
1862
|
+
['application/json'],
|
|
1863
|
+
['application/json']
|
|
1864
|
+
);
|
|
1865
|
+
}
|
|
1866
|
+
|
|
1867
|
+
/**
|
|
1868
|
+
* Disassociate a queue from an assistant.
|
|
1869
|
+
*
|
|
1870
|
+
* @param {String} assistantId Assistant ID
|
|
1871
|
+
* @param {String} queueId Queue ID
|
|
1872
|
+
*/
|
|
1873
|
+
deleteAssistantQueue(assistantId, queueId) {
|
|
1874
|
+
// verify the required parameter 'assistantId' is set
|
|
1875
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1876
|
+
throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueue';
|
|
1877
|
+
}
|
|
1878
|
+
// verify the required parameter 'queueId' is set
|
|
1879
|
+
if (queueId === undefined || queueId === null) {
|
|
1880
|
+
throw 'Missing the required parameter "queueId" when calling deleteAssistantQueue';
|
|
1881
|
+
}
|
|
1882
|
+
|
|
1883
|
+
return this.apiClient.callApi(
|
|
1884
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}',
|
|
1885
|
+
'DELETE',
|
|
1886
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
1887
|
+
{ },
|
|
1888
|
+
{ },
|
|
1889
|
+
{ },
|
|
1890
|
+
null,
|
|
1891
|
+
['PureCloud OAuth'],
|
|
1892
|
+
['application/json'],
|
|
1893
|
+
['application/json']
|
|
1894
|
+
);
|
|
1895
|
+
}
|
|
1896
|
+
|
|
1897
|
+
/**
|
|
1898
|
+
* Disassociate the queues from an assistant for the given assistant ID and queue IDs.
|
|
1899
|
+
*
|
|
1900
|
+
* @param {String} assistantId Assistant ID
|
|
1901
|
+
* @param {Object} opts Optional parameters
|
|
1902
|
+
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be deleted.
|
|
1903
|
+
*/
|
|
1904
|
+
deleteAssistantQueues(assistantId, opts) {
|
|
1905
|
+
opts = opts || {};
|
|
1906
|
+
|
|
1907
|
+
// verify the required parameter 'assistantId' is set
|
|
1908
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1909
|
+
throw 'Missing the required parameter "assistantId" when calling deleteAssistantQueues';
|
|
1910
|
+
}
|
|
1911
|
+
|
|
1912
|
+
return this.apiClient.callApi(
|
|
1913
|
+
'/api/v2/assistants/{assistantId}/queues',
|
|
1914
|
+
'DELETE',
|
|
1915
|
+
{ 'assistantId': assistantId },
|
|
1916
|
+
{ 'queueIds': opts['queueIds'] },
|
|
1917
|
+
{ },
|
|
1918
|
+
{ },
|
|
1919
|
+
null,
|
|
1920
|
+
['PureCloud OAuth'],
|
|
1921
|
+
['application/json'],
|
|
1922
|
+
['application/json']
|
|
1923
|
+
);
|
|
1924
|
+
}
|
|
1925
|
+
|
|
1926
|
+
/**
|
|
1927
|
+
* Get an assistant.
|
|
1928
|
+
*
|
|
1929
|
+
* @param {String} assistantId Assistant ID
|
|
1930
|
+
* @param {Object} opts Optional parameters
|
|
1931
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
1932
|
+
*/
|
|
1933
|
+
getAssistant(assistantId, opts) {
|
|
1934
|
+
opts = opts || {};
|
|
1935
|
+
|
|
1936
|
+
// verify the required parameter 'assistantId' is set
|
|
1937
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1938
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistant';
|
|
1939
|
+
}
|
|
1940
|
+
|
|
1941
|
+
return this.apiClient.callApi(
|
|
1942
|
+
'/api/v2/assistants/{assistantId}',
|
|
1943
|
+
'GET',
|
|
1944
|
+
{ 'assistantId': assistantId },
|
|
1945
|
+
{ 'expand': opts['expand'] },
|
|
1946
|
+
{ },
|
|
1947
|
+
{ },
|
|
1948
|
+
null,
|
|
1949
|
+
['PureCloud OAuth'],
|
|
1950
|
+
['application/json'],
|
|
1951
|
+
['application/json']
|
|
1952
|
+
);
|
|
1953
|
+
}
|
|
1954
|
+
|
|
1955
|
+
/**
|
|
1956
|
+
* Get queue Information for an assistant.
|
|
1957
|
+
*
|
|
1958
|
+
* @param {String} assistantId Assistant ID
|
|
1959
|
+
* @param {String} queueId Queue ID
|
|
1960
|
+
* @param {Object} opts Optional parameters
|
|
1961
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
1962
|
+
*/
|
|
1963
|
+
getAssistantQueue(assistantId, queueId, opts) {
|
|
1964
|
+
opts = opts || {};
|
|
1965
|
+
|
|
1966
|
+
// verify the required parameter 'assistantId' is set
|
|
1967
|
+
if (assistantId === undefined || assistantId === null) {
|
|
1968
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistantQueue';
|
|
1969
|
+
}
|
|
1970
|
+
// verify the required parameter 'queueId' is set
|
|
1971
|
+
if (queueId === undefined || queueId === null) {
|
|
1972
|
+
throw 'Missing the required parameter "queueId" when calling getAssistantQueue';
|
|
1973
|
+
}
|
|
1974
|
+
|
|
1975
|
+
return this.apiClient.callApi(
|
|
1976
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}',
|
|
1977
|
+
'GET',
|
|
1978
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
1979
|
+
{ 'expand': opts['expand'] },
|
|
1980
|
+
{ },
|
|
1981
|
+
{ },
|
|
1982
|
+
null,
|
|
1983
|
+
['PureCloud OAuth'],
|
|
1984
|
+
['application/json'],
|
|
1985
|
+
['application/json']
|
|
1986
|
+
);
|
|
1987
|
+
}
|
|
1988
|
+
|
|
1989
|
+
/**
|
|
1990
|
+
* Get all the queues associated with an assistant.
|
|
1991
|
+
*
|
|
1992
|
+
* @param {String} assistantId Assistant ID
|
|
1993
|
+
* @param {Object} opts Optional parameters
|
|
1994
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
1995
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
1996
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
1997
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
1998
|
+
*/
|
|
1999
|
+
getAssistantQueues(assistantId, opts) {
|
|
2000
|
+
opts = opts || {};
|
|
2001
|
+
|
|
2002
|
+
// verify the required parameter 'assistantId' is set
|
|
2003
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2004
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistantQueues';
|
|
2005
|
+
}
|
|
2006
|
+
|
|
2007
|
+
return this.apiClient.callApi(
|
|
2008
|
+
'/api/v2/assistants/{assistantId}/queues',
|
|
2009
|
+
'GET',
|
|
2010
|
+
{ 'assistantId': assistantId },
|
|
2011
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'expand': opts['expand'] },
|
|
2012
|
+
{ },
|
|
2013
|
+
{ },
|
|
2014
|
+
null,
|
|
2015
|
+
['PureCloud OAuth'],
|
|
2016
|
+
['application/json'],
|
|
2017
|
+
['application/json']
|
|
2018
|
+
);
|
|
2019
|
+
}
|
|
2020
|
+
|
|
2021
|
+
/**
|
|
2022
|
+
* Get all assistants.
|
|
2023
|
+
*
|
|
2024
|
+
* @param {Object} opts Optional parameters
|
|
2025
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
2026
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
2027
|
+
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
2028
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2029
|
+
* @param {String} opts.name Return the assistant by the given name.
|
|
2030
|
+
*/
|
|
2031
|
+
getAssistants(opts) {
|
|
2032
|
+
opts = opts || {};
|
|
2033
|
+
|
|
2034
|
+
|
|
2035
|
+
return this.apiClient.callApi(
|
|
2036
|
+
'/api/v2/assistants',
|
|
2037
|
+
'GET',
|
|
2038
|
+
{ },
|
|
2039
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
2040
|
+
{ },
|
|
2041
|
+
{ },
|
|
2042
|
+
null,
|
|
2043
|
+
['PureCloud OAuth'],
|
|
2044
|
+
['application/json'],
|
|
2045
|
+
['application/json']
|
|
2046
|
+
);
|
|
2047
|
+
}
|
|
2048
|
+
|
|
2049
|
+
/**
|
|
2050
|
+
* Get all queues assigned to any assistant.
|
|
2051
|
+
*
|
|
2052
|
+
* @param {Object} opts Optional parameters
|
|
2053
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
2054
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
2055
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2056
|
+
* @param {String} opts.queueIds Comma-separated identifiers of the queues that need to be retrieved.
|
|
2057
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
2058
|
+
*/
|
|
2059
|
+
getAssistantsQueues(opts) {
|
|
2060
|
+
opts = opts || {};
|
|
2061
|
+
|
|
2062
|
+
|
|
2063
|
+
return this.apiClient.callApi(
|
|
2064
|
+
'/api/v2/assistants/queues',
|
|
2065
|
+
'GET',
|
|
2066
|
+
{ },
|
|
2067
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'queueIds': opts['queueIds'],'expand': opts['expand'] },
|
|
2068
|
+
{ },
|
|
2069
|
+
{ },
|
|
2070
|
+
null,
|
|
2071
|
+
['PureCloud OAuth'],
|
|
2072
|
+
['application/json'],
|
|
2073
|
+
['application/json']
|
|
2074
|
+
);
|
|
2075
|
+
}
|
|
2076
|
+
|
|
2077
|
+
/**
|
|
2078
|
+
* Update an assistant.
|
|
2079
|
+
*
|
|
2080
|
+
* @param {String} assistantId Assistant ID
|
|
2081
|
+
* @param {Object} body
|
|
2082
|
+
*/
|
|
2083
|
+
patchAssistant(assistantId, body) {
|
|
2084
|
+
// verify the required parameter 'assistantId' is set
|
|
2085
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2086
|
+
throw 'Missing the required parameter "assistantId" when calling patchAssistant';
|
|
2087
|
+
}
|
|
2088
|
+
// verify the required parameter 'body' is set
|
|
2089
|
+
if (body === undefined || body === null) {
|
|
2090
|
+
throw 'Missing the required parameter "body" when calling patchAssistant';
|
|
2091
|
+
}
|
|
2092
|
+
|
|
2093
|
+
return this.apiClient.callApi(
|
|
2094
|
+
'/api/v2/assistants/{assistantId}',
|
|
2095
|
+
'PATCH',
|
|
2096
|
+
{ 'assistantId': assistantId },
|
|
2097
|
+
{ },
|
|
2098
|
+
{ },
|
|
2099
|
+
{ },
|
|
2100
|
+
body,
|
|
2101
|
+
['PureCloud OAuth'],
|
|
2102
|
+
['application/json'],
|
|
2103
|
+
['application/json']
|
|
2104
|
+
);
|
|
2105
|
+
}
|
|
2106
|
+
|
|
2107
|
+
/**
|
|
2108
|
+
* Update Queues for an Assistant.
|
|
2109
|
+
*
|
|
2110
|
+
* @param {String} assistantId Assistant ID
|
|
2111
|
+
* @param {Array.<Object>} body
|
|
2112
|
+
*/
|
|
2113
|
+
patchAssistantQueues(assistantId, body) {
|
|
2114
|
+
// verify the required parameter 'assistantId' is set
|
|
2115
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2116
|
+
throw 'Missing the required parameter "assistantId" when calling patchAssistantQueues';
|
|
2117
|
+
}
|
|
2118
|
+
// verify the required parameter 'body' is set
|
|
2119
|
+
if (body === undefined || body === null) {
|
|
2120
|
+
throw 'Missing the required parameter "body" when calling patchAssistantQueues';
|
|
2121
|
+
}
|
|
2122
|
+
|
|
2123
|
+
return this.apiClient.callApi(
|
|
2124
|
+
'/api/v2/assistants/{assistantId}/queues',
|
|
2125
|
+
'PATCH',
|
|
2126
|
+
{ 'assistantId': assistantId },
|
|
2127
|
+
{ },
|
|
2128
|
+
{ },
|
|
2129
|
+
{ },
|
|
2130
|
+
body,
|
|
2131
|
+
['PureCloud OAuth'],
|
|
2132
|
+
['application/json'],
|
|
2133
|
+
['application/json']
|
|
2134
|
+
);
|
|
2135
|
+
}
|
|
2136
|
+
|
|
2137
|
+
/**
|
|
2138
|
+
* Create an Assistant.
|
|
2139
|
+
*
|
|
2140
|
+
* @param {Object} body
|
|
2141
|
+
*/
|
|
2142
|
+
postAssistants(body) {
|
|
2143
|
+
// verify the required parameter 'body' is set
|
|
2144
|
+
if (body === undefined || body === null) {
|
|
2145
|
+
throw 'Missing the required parameter "body" when calling postAssistants';
|
|
2146
|
+
}
|
|
2147
|
+
|
|
2148
|
+
return this.apiClient.callApi(
|
|
2149
|
+
'/api/v2/assistants',
|
|
2150
|
+
'POST',
|
|
2151
|
+
{ },
|
|
2152
|
+
{ },
|
|
2153
|
+
{ },
|
|
2154
|
+
{ },
|
|
2155
|
+
body,
|
|
2156
|
+
['PureCloud OAuth'],
|
|
2157
|
+
['application/json'],
|
|
2158
|
+
['application/json']
|
|
2159
|
+
);
|
|
2160
|
+
}
|
|
2161
|
+
|
|
2162
|
+
/**
|
|
2163
|
+
* Create a queue assistant association.
|
|
2164
|
+
*
|
|
2165
|
+
* @param {String} assistantId Assistant ID
|
|
2166
|
+
* @param {String} queueId Queue ID
|
|
2167
|
+
* @param {Object} body
|
|
2168
|
+
*/
|
|
2169
|
+
putAssistantQueue(assistantId, queueId, body) {
|
|
2170
|
+
// verify the required parameter 'assistantId' is set
|
|
2171
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2172
|
+
throw 'Missing the required parameter "assistantId" when calling putAssistantQueue';
|
|
2173
|
+
}
|
|
2174
|
+
// verify the required parameter 'queueId' is set
|
|
2175
|
+
if (queueId === undefined || queueId === null) {
|
|
2176
|
+
throw 'Missing the required parameter "queueId" when calling putAssistantQueue';
|
|
2177
|
+
}
|
|
2178
|
+
// verify the required parameter 'body' is set
|
|
2179
|
+
if (body === undefined || body === null) {
|
|
2180
|
+
throw 'Missing the required parameter "body" when calling putAssistantQueue';
|
|
2181
|
+
}
|
|
2182
|
+
|
|
2183
|
+
return this.apiClient.callApi(
|
|
2184
|
+
'/api/v2/assistants/{assistantId}/queues/{queueId}',
|
|
2185
|
+
'PUT',
|
|
2186
|
+
{ 'assistantId': assistantId,'queueId': queueId },
|
|
2187
|
+
{ },
|
|
2188
|
+
{ },
|
|
2189
|
+
{ },
|
|
2190
|
+
body,
|
|
2191
|
+
['PureCloud OAuth'],
|
|
2192
|
+
['application/json'],
|
|
2193
|
+
['application/json']
|
|
2194
|
+
);
|
|
2195
|
+
}
|
|
2196
|
+
|
|
2197
|
+
}
|
|
2198
|
+
|
|
2199
|
+
class AgentCopilotApi {
|
|
2200
|
+
/**
|
|
2201
|
+
* AgentCopilot service.
|
|
2202
|
+
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2203
|
+
* @version 204.0.0
|
|
2204
|
+
*/
|
|
2205
|
+
|
|
2206
|
+
/**
|
|
2207
|
+
* Constructs a new AgentCopilotApi.
|
|
2208
|
+
* @alias module:purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2209
|
+
* @class
|
|
2210
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
2211
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
2212
|
+
*/
|
|
2213
|
+
constructor(apiClient) {
|
|
2214
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
2215
|
+
}
|
|
2216
|
+
|
|
2217
|
+
|
|
2218
|
+
/**
|
|
2219
|
+
* Get copilot configuration of an assistant.
|
|
2220
|
+
*
|
|
2221
|
+
* @param {String} assistantId Assistant ID
|
|
2222
|
+
*/
|
|
2223
|
+
getAssistantCopilot(assistantId) {
|
|
2224
|
+
// verify the required parameter 'assistantId' is set
|
|
2225
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2226
|
+
throw 'Missing the required parameter "assistantId" when calling getAssistantCopilot';
|
|
2227
|
+
}
|
|
2228
|
+
|
|
2229
|
+
return this.apiClient.callApi(
|
|
2230
|
+
'/api/v2/assistants/{assistantId}/copilot',
|
|
2231
|
+
'GET',
|
|
2232
|
+
{ 'assistantId': assistantId },
|
|
2233
|
+
{ },
|
|
2234
|
+
{ },
|
|
2235
|
+
{ },
|
|
2236
|
+
null,
|
|
2237
|
+
['PureCloud OAuth'],
|
|
2238
|
+
['application/json'],
|
|
2239
|
+
['application/json']
|
|
2240
|
+
);
|
|
2241
|
+
}
|
|
2242
|
+
|
|
2243
|
+
/**
|
|
2244
|
+
* Update agent copilot configuration
|
|
2245
|
+
*
|
|
2246
|
+
* @param {String} assistantId Assistant ID
|
|
2247
|
+
* @param {Object} body
|
|
2248
|
+
*/
|
|
2249
|
+
putAssistantCopilot(assistantId, body) {
|
|
2250
|
+
// verify the required parameter 'assistantId' is set
|
|
2251
|
+
if (assistantId === undefined || assistantId === null) {
|
|
2252
|
+
throw 'Missing the required parameter "assistantId" when calling putAssistantCopilot';
|
|
2253
|
+
}
|
|
2254
|
+
// verify the required parameter 'body' is set
|
|
2255
|
+
if (body === undefined || body === null) {
|
|
2256
|
+
throw 'Missing the required parameter "body" when calling putAssistantCopilot';
|
|
2257
|
+
}
|
|
2258
|
+
|
|
2259
|
+
return this.apiClient.callApi(
|
|
2260
|
+
'/api/v2/assistants/{assistantId}/copilot',
|
|
2261
|
+
'PUT',
|
|
2262
|
+
{ 'assistantId': assistantId },
|
|
2263
|
+
{ },
|
|
2264
|
+
{ },
|
|
2265
|
+
{ },
|
|
2266
|
+
body,
|
|
2267
|
+
['PureCloud OAuth'],
|
|
2268
|
+
['application/json'],
|
|
2269
|
+
['application/json']
|
|
2270
|
+
);
|
|
2271
|
+
}
|
|
2272
|
+
|
|
2273
|
+
}
|
|
2274
|
+
|
|
1823
2275
|
class AgentUIApi {
|
|
1824
2276
|
/**
|
|
1825
2277
|
* AgentUI service.
|
|
1826
2278
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1827
|
-
* @version
|
|
2279
|
+
* @version 204.0.0
|
|
1828
2280
|
*/
|
|
1829
2281
|
|
|
1830
2282
|
/**
|
|
@@ -1955,7 +2407,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1955
2407
|
/**
|
|
1956
2408
|
* Alerting service.
|
|
1957
2409
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1958
|
-
* @version
|
|
2410
|
+
* @version 204.0.0
|
|
1959
2411
|
*/
|
|
1960
2412
|
|
|
1961
2413
|
/**
|
|
@@ -2616,7 +3068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2616
3068
|
/**
|
|
2617
3069
|
* Analytics service.
|
|
2618
3070
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2619
|
-
* @version
|
|
3071
|
+
* @version 204.0.0
|
|
2620
3072
|
*/
|
|
2621
3073
|
|
|
2622
3074
|
/**
|
|
@@ -3557,6 +4009,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3557
4009
|
* @param {Object} dashboardType List dashboard of given type
|
|
3558
4010
|
* @param {Object} dashboardAccessFilter Filter dashboard based on the owner of dashboard
|
|
3559
4011
|
* @param {Object} opts Optional parameters
|
|
4012
|
+
* @param {String} opts.name name of the dashboard
|
|
3560
4013
|
* @param {String} opts.sortBy (default to desc)
|
|
3561
4014
|
* @param {Number} opts.pageNumber (default to 1)
|
|
3562
4015
|
* @param {Number} opts.pageSize (default to 9)
|
|
@@ -3577,7 +4030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3577
4030
|
'/api/v2/analytics/reporting/settings/dashboards/query',
|
|
3578
4031
|
'GET',
|
|
3579
4032
|
{ },
|
|
3580
|
-
{ 'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
4033
|
+
{ 'name': opts['name'],'dashboardType': dashboardType,'dashboardAccessFilter': dashboardAccessFilter,'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
3581
4034
|
{ },
|
|
3582
4035
|
{ },
|
|
3583
4036
|
null,
|
|
@@ -4082,7 +4535,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4082
4535
|
* Query for agent copilot aggregates
|
|
4083
4536
|
*
|
|
4084
4537
|
* @param {Object} body query
|
|
4085
|
-
* postAnalyticsAgentcopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4086
4538
|
*/
|
|
4087
4539
|
postAnalyticsAgentcopilotsAggregatesQuery(body) {
|
|
4088
4540
|
// verify the required parameter 'body' is set
|
|
@@ -5228,7 +5680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5228
5680
|
/**
|
|
5229
5681
|
* Architect service.
|
|
5230
5682
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5231
|
-
* @version
|
|
5683
|
+
* @version 204.0.0
|
|
5232
5684
|
*/
|
|
5233
5685
|
|
|
5234
5686
|
/**
|
|
@@ -5635,7 +6087,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5635
6087
|
* Deletes a log level for a flow by flow id.
|
|
5636
6088
|
* Deletes the associated log level for a flow by flow id
|
|
5637
6089
|
* @param {String} flowId The flow id to delete the loglevel for
|
|
5638
|
-
* deleteFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5639
6090
|
*/
|
|
5640
6091
|
deleteFlowInstancesSettingsLoglevels(flowId) {
|
|
5641
6092
|
// verify the required parameter 'flowId' is set
|
|
@@ -5744,7 +6195,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5744
6195
|
/**
|
|
5745
6196
|
* Resets the org log level to default, base
|
|
5746
6197
|
* Resets the org log level to default, base
|
|
5747
|
-
* deleteFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5748
6198
|
*/
|
|
5749
6199
|
deleteFlowsInstancesSettingsLoglevelsDefault() {
|
|
5750
6200
|
|
|
@@ -6895,7 +7345,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6895
7345
|
* @param {String} flowId The flow id to get the loglevel for
|
|
6896
7346
|
* @param {Object} opts Optional parameters
|
|
6897
7347
|
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
6898
|
-
* getFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6899
7348
|
*/
|
|
6900
7349
|
getFlowInstancesSettingsLoglevels(flowId, opts) {
|
|
6901
7350
|
opts = opts || {};
|
|
@@ -7623,7 +8072,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7623
8072
|
/**
|
|
7624
8073
|
* Get the execution history enabled setting.
|
|
7625
8074
|
* Get the execution history enabled setting.
|
|
7626
|
-
* getFlowsInstancesSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7627
8075
|
*/
|
|
7628
8076
|
getFlowsInstancesSettingsExecutiondata() {
|
|
7629
8077
|
|
|
@@ -7648,7 +8096,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7648
8096
|
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
7649
8097
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
7650
8098
|
* @param {Number} opts.pageSize Number of entities to return. Maximum of 200. (default to 25)
|
|
7651
|
-
* getFlowsInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7652
8099
|
*/
|
|
7653
8100
|
getFlowsInstancesSettingsLoglevels(opts) {
|
|
7654
8101
|
opts = opts || {};
|
|
@@ -7671,7 +8118,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7671
8118
|
/**
|
|
7672
8119
|
* Gets the available flow log level characteristics for this organization.
|
|
7673
8120
|
* Log levels can be customized and this returns the set of available characteristics that can be enabled/disabled.
|
|
7674
|
-
* getFlowsInstancesSettingsLoglevelsCharacteristics is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7675
8121
|
*/
|
|
7676
8122
|
getFlowsInstancesSettingsLoglevelsCharacteristics() {
|
|
7677
8123
|
|
|
@@ -7694,7 +8140,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7694
8140
|
* Returns the flow default log level which will be used if no specific flow id log level is found.
|
|
7695
8141
|
* @param {Object} opts Optional parameters
|
|
7696
8142
|
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
7697
|
-
* getFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7698
8143
|
*/
|
|
7699
8144
|
getFlowsInstancesSettingsLoglevelsDefault(opts) {
|
|
7700
8145
|
opts = opts || {};
|
|
@@ -7986,7 +8431,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7986
8431
|
* Edit the execution history enabled setting.
|
|
7987
8432
|
* Edit the execution history enabled setting.
|
|
7988
8433
|
* @param {Object} body New Execution Data Setting
|
|
7989
|
-
* patchFlowsInstancesSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7990
8434
|
*/
|
|
7991
8435
|
patchFlowsInstancesSettingsExecutiondata(body) {
|
|
7992
8436
|
// verify the required parameter 'body' is set
|
|
@@ -8424,7 +8868,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8424
8868
|
* @param {Object} body New LogLevel settings
|
|
8425
8869
|
* @param {Object} opts Optional parameters
|
|
8426
8870
|
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
8427
|
-
* postFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8428
8871
|
*/
|
|
8429
8872
|
postFlowInstancesSettingsLoglevels(flowId, body, opts) {
|
|
8430
8873
|
opts = opts || {};
|
|
@@ -9184,7 +9627,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9184
9627
|
* @param {Object} body New LogLevel settings
|
|
9185
9628
|
* @param {Object} opts Optional parameters
|
|
9186
9629
|
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
9187
|
-
* putFlowInstancesSettingsLoglevels is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9188
9630
|
*/
|
|
9189
9631
|
putFlowInstancesSettingsLoglevels(flowId, body, opts) {
|
|
9190
9632
|
opts = opts || {};
|
|
@@ -9286,7 +9728,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9286
9728
|
* @param {Object} body New LogLevel settings
|
|
9287
9729
|
* @param {Object} opts Optional parameters
|
|
9288
9730
|
* @param {Array.<String>} opts.expand Expand instructions for the result
|
|
9289
|
-
* putFlowsInstancesSettingsLoglevelsDefault is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
9290
9731
|
*/
|
|
9291
9732
|
putFlowsInstancesSettingsLoglevelsDefault(body, opts) {
|
|
9292
9733
|
opts = opts || {};
|
|
@@ -9374,7 +9815,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9374
9815
|
/**
|
|
9375
9816
|
* Audit service.
|
|
9376
9817
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9377
|
-
* @version
|
|
9818
|
+
* @version 204.0.0
|
|
9378
9819
|
*/
|
|
9379
9820
|
|
|
9380
9821
|
/**
|
|
@@ -9575,7 +10016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9575
10016
|
/**
|
|
9576
10017
|
* Authorization service.
|
|
9577
10018
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9578
|
-
* @version
|
|
10019
|
+
* @version 204.0.0
|
|
9579
10020
|
*/
|
|
9580
10021
|
|
|
9581
10022
|
/**
|
|
@@ -10111,6 +10552,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10111
10552
|
);
|
|
10112
10553
|
}
|
|
10113
10554
|
|
|
10555
|
+
/**
|
|
10556
|
+
* Get authorization role settings
|
|
10557
|
+
*
|
|
10558
|
+
*/
|
|
10559
|
+
getAuthorizationRolesSettings() {
|
|
10560
|
+
|
|
10561
|
+
return this.apiClient.callApi(
|
|
10562
|
+
'/api/v2/authorization/roles/settings',
|
|
10563
|
+
'GET',
|
|
10564
|
+
{ },
|
|
10565
|
+
{ },
|
|
10566
|
+
{ },
|
|
10567
|
+
{ },
|
|
10568
|
+
null,
|
|
10569
|
+
['PureCloud OAuth'],
|
|
10570
|
+
['application/json'],
|
|
10571
|
+
['application/json']
|
|
10572
|
+
);
|
|
10573
|
+
}
|
|
10574
|
+
|
|
10114
10575
|
/**
|
|
10115
10576
|
* Get authorization settings
|
|
10116
10577
|
*
|
|
@@ -10777,6 +11238,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10777
11238
|
);
|
|
10778
11239
|
}
|
|
10779
11240
|
|
|
11241
|
+
/**
|
|
11242
|
+
* Change authorization role settings
|
|
11243
|
+
* Change role settings
|
|
11244
|
+
* @param {Object} body Authorization Role Settings
|
|
11245
|
+
*/
|
|
11246
|
+
putAuthorizationRolesSettings(body) {
|
|
11247
|
+
// verify the required parameter 'body' is set
|
|
11248
|
+
if (body === undefined || body === null) {
|
|
11249
|
+
throw 'Missing the required parameter "body" when calling putAuthorizationRolesSettings';
|
|
11250
|
+
}
|
|
11251
|
+
|
|
11252
|
+
return this.apiClient.callApi(
|
|
11253
|
+
'/api/v2/authorization/roles/settings',
|
|
11254
|
+
'PUT',
|
|
11255
|
+
{ },
|
|
11256
|
+
{ },
|
|
11257
|
+
{ },
|
|
11258
|
+
{ },
|
|
11259
|
+
body,
|
|
11260
|
+
['PureCloud OAuth'],
|
|
11261
|
+
['application/json'],
|
|
11262
|
+
['application/json']
|
|
11263
|
+
);
|
|
11264
|
+
}
|
|
11265
|
+
|
|
10780
11266
|
/**
|
|
10781
11267
|
* Sets the user's roles
|
|
10782
11268
|
*
|
|
@@ -10813,7 +11299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10813
11299
|
/**
|
|
10814
11300
|
* Billing service.
|
|
10815
11301
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10816
|
-
* @version
|
|
11302
|
+
* @version 204.0.0
|
|
10817
11303
|
*/
|
|
10818
11304
|
|
|
10819
11305
|
/**
|
|
@@ -10893,7 +11379,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10893
11379
|
/**
|
|
10894
11380
|
* CarrierServices service.
|
|
10895
11381
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10896
|
-
* @version
|
|
11382
|
+
* @version 204.0.0
|
|
10897
11383
|
*/
|
|
10898
11384
|
|
|
10899
11385
|
/**
|
|
@@ -10963,7 +11449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10963
11449
|
/**
|
|
10964
11450
|
* Chat service.
|
|
10965
11451
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10966
|
-
* @version
|
|
11452
|
+
* @version 204.0.0
|
|
10967
11453
|
*/
|
|
10968
11454
|
|
|
10969
11455
|
/**
|
|
@@ -11899,7 +12385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11899
12385
|
/**
|
|
11900
12386
|
* Coaching service.
|
|
11901
12387
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11902
|
-
* @version
|
|
12388
|
+
* @version 204.0.0
|
|
11903
12389
|
*/
|
|
11904
12390
|
|
|
11905
12391
|
/**
|
|
@@ -12476,7 +12962,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12476
12962
|
/**
|
|
12477
12963
|
* ContentManagement service.
|
|
12478
12964
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12479
|
-
* @version
|
|
12965
|
+
* @version 204.0.0
|
|
12480
12966
|
*/
|
|
12481
12967
|
|
|
12482
12968
|
/**
|
|
@@ -13558,7 +14044,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13558
14044
|
/**
|
|
13559
14045
|
* Conversations service.
|
|
13560
14046
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13561
|
-
* @version
|
|
14047
|
+
* @version 204.0.0
|
|
13562
14048
|
*/
|
|
13563
14049
|
|
|
13564
14050
|
/**
|
|
@@ -20671,7 +21157,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20671
21157
|
/**
|
|
20672
21158
|
* DataExtensions service.
|
|
20673
21159
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20674
|
-
* @version
|
|
21160
|
+
* @version 204.0.0
|
|
20675
21161
|
*/
|
|
20676
21162
|
|
|
20677
21163
|
/**
|
|
@@ -20757,7 +21243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20757
21243
|
/**
|
|
20758
21244
|
* Downloads service.
|
|
20759
21245
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20760
|
-
* @version
|
|
21246
|
+
* @version 204.0.0
|
|
20761
21247
|
*/
|
|
20762
21248
|
|
|
20763
21249
|
/**
|
|
@@ -20809,7 +21295,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20809
21295
|
/**
|
|
20810
21296
|
* Emails service.
|
|
20811
21297
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20812
|
-
* @version
|
|
21298
|
+
* @version 204.0.0
|
|
20813
21299
|
*/
|
|
20814
21300
|
|
|
20815
21301
|
/**
|
|
@@ -20874,7 +21360,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20874
21360
|
/**
|
|
20875
21361
|
* EmployeeEngagement service.
|
|
20876
21362
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20877
|
-
* @version
|
|
21363
|
+
* @version 204.0.0
|
|
20878
21364
|
*/
|
|
20879
21365
|
|
|
20880
21366
|
/**
|
|
@@ -21025,7 +21511,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21025
21511
|
/**
|
|
21026
21512
|
* Events service.
|
|
21027
21513
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
21028
|
-
* @version
|
|
21514
|
+
* @version 204.0.0
|
|
21029
21515
|
*/
|
|
21030
21516
|
|
|
21031
21517
|
/**
|
|
@@ -21121,7 +21607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21121
21607
|
/**
|
|
21122
21608
|
* ExternalContacts service.
|
|
21123
21609
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
21124
|
-
* @version
|
|
21610
|
+
* @version 204.0.0
|
|
21125
21611
|
*/
|
|
21126
21612
|
|
|
21127
21613
|
/**
|
|
@@ -21216,6 +21702,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21216
21702
|
);
|
|
21217
21703
|
}
|
|
21218
21704
|
|
|
21705
|
+
/**
|
|
21706
|
+
* 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.
|
|
21707
|
+
*
|
|
21708
|
+
* @param {String} externalSourceId External Source ID
|
|
21709
|
+
* deleteExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21710
|
+
*/
|
|
21711
|
+
deleteExternalcontactsExternalsource(externalSourceId) {
|
|
21712
|
+
// verify the required parameter 'externalSourceId' is set
|
|
21713
|
+
if (externalSourceId === undefined || externalSourceId === null) {
|
|
21714
|
+
throw 'Missing the required parameter "externalSourceId" when calling deleteExternalcontactsExternalsource';
|
|
21715
|
+
}
|
|
21716
|
+
|
|
21717
|
+
return this.apiClient.callApi(
|
|
21718
|
+
'/api/v2/externalcontacts/externalsources/{externalSourceId}',
|
|
21719
|
+
'DELETE',
|
|
21720
|
+
{ 'externalSourceId': externalSourceId },
|
|
21721
|
+
{ },
|
|
21722
|
+
{ },
|
|
21723
|
+
{ },
|
|
21724
|
+
null,
|
|
21725
|
+
['PureCloud OAuth'],
|
|
21726
|
+
['application/json'],
|
|
21727
|
+
['application/json']
|
|
21728
|
+
);
|
|
21729
|
+
}
|
|
21730
|
+
|
|
21219
21731
|
/**
|
|
21220
21732
|
* Delete an external organization
|
|
21221
21733
|
*
|
|
@@ -21326,7 +21838,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21326
21838
|
*
|
|
21327
21839
|
* @param {String} contactId ExternalContact ID
|
|
21328
21840
|
* @param {Object} opts Optional parameters
|
|
21329
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21841
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand
|
|
21330
21842
|
*/
|
|
21331
21843
|
getExternalcontactsContact(contactId, opts) {
|
|
21332
21844
|
opts = opts || {};
|
|
@@ -21629,6 +22141,60 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21629
22141
|
);
|
|
21630
22142
|
}
|
|
21631
22143
|
|
|
22144
|
+
/**
|
|
22145
|
+
* Fetch an External Source
|
|
22146
|
+
*
|
|
22147
|
+
* @param {String} externalSourceId External Source ID
|
|
22148
|
+
* getExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22149
|
+
*/
|
|
22150
|
+
getExternalcontactsExternalsource(externalSourceId) {
|
|
22151
|
+
// verify the required parameter 'externalSourceId' is set
|
|
22152
|
+
if (externalSourceId === undefined || externalSourceId === null) {
|
|
22153
|
+
throw 'Missing the required parameter "externalSourceId" when calling getExternalcontactsExternalsource';
|
|
22154
|
+
}
|
|
22155
|
+
|
|
22156
|
+
return this.apiClient.callApi(
|
|
22157
|
+
'/api/v2/externalcontacts/externalsources/{externalSourceId}',
|
|
22158
|
+
'GET',
|
|
22159
|
+
{ 'externalSourceId': externalSourceId },
|
|
22160
|
+
{ },
|
|
22161
|
+
{ },
|
|
22162
|
+
{ },
|
|
22163
|
+
null,
|
|
22164
|
+
['PureCloud OAuth'],
|
|
22165
|
+
['application/json'],
|
|
22166
|
+
['application/json']
|
|
22167
|
+
);
|
|
22168
|
+
}
|
|
22169
|
+
|
|
22170
|
+
/**
|
|
22171
|
+
* Fetch a list of External Sources
|
|
22172
|
+
*
|
|
22173
|
+
* @param {Object} opts Optional parameters
|
|
22174
|
+
* @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
|
|
22175
|
+
* @param {Number} opts.limit The number of ExternalSources per page; must be between 10 and 200, default is 100
|
|
22176
|
+
* @param {String} opts.name Filter by external source name. Filtering is prefix filtering and not an exact match
|
|
22177
|
+
* @param {Boolean} opts.active Filter by active status of external source
|
|
22178
|
+
* getExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22179
|
+
*/
|
|
22180
|
+
getExternalcontactsExternalsources(opts) {
|
|
22181
|
+
opts = opts || {};
|
|
22182
|
+
|
|
22183
|
+
|
|
22184
|
+
return this.apiClient.callApi(
|
|
22185
|
+
'/api/v2/externalcontacts/externalsources',
|
|
22186
|
+
'GET',
|
|
22187
|
+
{ },
|
|
22188
|
+
{ 'cursor': opts['cursor'],'limit': opts['limit'],'name': opts['name'],'active': opts['active'] },
|
|
22189
|
+
{ },
|
|
22190
|
+
{ },
|
|
22191
|
+
null,
|
|
22192
|
+
['PureCloud OAuth'],
|
|
22193
|
+
['application/json'],
|
|
22194
|
+
['application/json']
|
|
22195
|
+
);
|
|
22196
|
+
}
|
|
22197
|
+
|
|
21632
22198
|
/**
|
|
21633
22199
|
* Fetch an external organization
|
|
21634
22200
|
*
|
|
@@ -22638,6 +23204,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22638
23204
|
);
|
|
22639
23205
|
}
|
|
22640
23206
|
|
|
23207
|
+
/**
|
|
23208
|
+
* Create an External Source
|
|
23209
|
+
*
|
|
23210
|
+
* @param {Object} body External Source
|
|
23211
|
+
* postExternalcontactsExternalsources is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23212
|
+
*/
|
|
23213
|
+
postExternalcontactsExternalsources(body) {
|
|
23214
|
+
// verify the required parameter 'body' is set
|
|
23215
|
+
if (body === undefined || body === null) {
|
|
23216
|
+
throw 'Missing the required parameter "body" when calling postExternalcontactsExternalsources';
|
|
23217
|
+
}
|
|
23218
|
+
|
|
23219
|
+
return this.apiClient.callApi(
|
|
23220
|
+
'/api/v2/externalcontacts/externalsources',
|
|
23221
|
+
'POST',
|
|
23222
|
+
{ },
|
|
23223
|
+
{ },
|
|
23224
|
+
{ },
|
|
23225
|
+
{ },
|
|
23226
|
+
body,
|
|
23227
|
+
['PureCloud OAuth'],
|
|
23228
|
+
['application/json'],
|
|
23229
|
+
['application/json']
|
|
23230
|
+
);
|
|
23231
|
+
}
|
|
23232
|
+
|
|
22641
23233
|
/**
|
|
22642
23234
|
* Fetch a contact using an identifier type and value.
|
|
22643
23235
|
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
@@ -22922,6 +23514,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22922
23514
|
);
|
|
22923
23515
|
}
|
|
22924
23516
|
|
|
23517
|
+
/**
|
|
23518
|
+
* Update an External Source
|
|
23519
|
+
*
|
|
23520
|
+
* @param {String} externalSourceId External Source ID
|
|
23521
|
+
* @param {Object} body External Source
|
|
23522
|
+
* putExternalcontactsExternalsource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
23523
|
+
*/
|
|
23524
|
+
putExternalcontactsExternalsource(externalSourceId, body) {
|
|
23525
|
+
// verify the required parameter 'externalSourceId' is set
|
|
23526
|
+
if (externalSourceId === undefined || externalSourceId === null) {
|
|
23527
|
+
throw 'Missing the required parameter "externalSourceId" when calling putExternalcontactsExternalsource';
|
|
23528
|
+
}
|
|
23529
|
+
// verify the required parameter 'body' is set
|
|
23530
|
+
if (body === undefined || body === null) {
|
|
23531
|
+
throw 'Missing the required parameter "body" when calling putExternalcontactsExternalsource';
|
|
23532
|
+
}
|
|
23533
|
+
|
|
23534
|
+
return this.apiClient.callApi(
|
|
23535
|
+
'/api/v2/externalcontacts/externalsources/{externalSourceId}',
|
|
23536
|
+
'PUT',
|
|
23537
|
+
{ 'externalSourceId': externalSourceId },
|
|
23538
|
+
{ },
|
|
23539
|
+
{ },
|
|
23540
|
+
{ },
|
|
23541
|
+
body,
|
|
23542
|
+
['PureCloud OAuth'],
|
|
23543
|
+
['application/json'],
|
|
23544
|
+
['application/json']
|
|
23545
|
+
);
|
|
23546
|
+
}
|
|
23547
|
+
|
|
22925
23548
|
/**
|
|
22926
23549
|
* Update an external organization
|
|
22927
23550
|
*
|
|
@@ -23083,7 +23706,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23083
23706
|
/**
|
|
23084
23707
|
* Fax service.
|
|
23085
23708
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
23086
|
-
* @version
|
|
23709
|
+
* @version 204.0.0
|
|
23087
23710
|
*/
|
|
23088
23711
|
|
|
23089
23712
|
/**
|
|
@@ -23298,7 +23921,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23298
23921
|
/**
|
|
23299
23922
|
* Flows service.
|
|
23300
23923
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
23301
|
-
* @version
|
|
23924
|
+
* @version 204.0.0
|
|
23302
23925
|
*/
|
|
23303
23926
|
|
|
23304
23927
|
/**
|
|
@@ -23481,7 +24104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23481
24104
|
/**
|
|
23482
24105
|
* Gamification service.
|
|
23483
24106
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23484
|
-
* @version
|
|
24107
|
+
* @version 204.0.0
|
|
23485
24108
|
*/
|
|
23486
24109
|
|
|
23487
24110
|
/**
|
|
@@ -25567,7 +26190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25567
26190
|
/**
|
|
25568
26191
|
* GeneralDataProtectionRegulation service.
|
|
25569
26192
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25570
|
-
* @version
|
|
26193
|
+
* @version 204.0.0
|
|
25571
26194
|
*/
|
|
25572
26195
|
|
|
25573
26196
|
/**
|
|
@@ -25697,7 +26320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25697
26320
|
/**
|
|
25698
26321
|
* Geolocation service.
|
|
25699
26322
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25700
|
-
* @version
|
|
26323
|
+
* @version 204.0.0
|
|
25701
26324
|
*/
|
|
25702
26325
|
|
|
25703
26326
|
/**
|
|
@@ -25828,7 +26451,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25828
26451
|
/**
|
|
25829
26452
|
* Greetings service.
|
|
25830
26453
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25831
|
-
* @version
|
|
26454
|
+
* @version 204.0.0
|
|
25832
26455
|
*/
|
|
25833
26456
|
|
|
25834
26457
|
/**
|
|
@@ -26283,7 +26906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26283
26906
|
/**
|
|
26284
26907
|
* Groups service.
|
|
26285
26908
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
26286
|
-
* @version
|
|
26909
|
+
* @version 204.0.0
|
|
26287
26910
|
*/
|
|
26288
26911
|
|
|
26289
26912
|
/**
|
|
@@ -26802,7 +27425,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26802
27425
|
/**
|
|
26803
27426
|
* IdentityProvider service.
|
|
26804
27427
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26805
|
-
* @version
|
|
27428
|
+
* @version 204.0.0
|
|
26806
27429
|
*/
|
|
26807
27430
|
|
|
26808
27431
|
/**
|
|
@@ -27663,7 +28286,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27663
28286
|
/**
|
|
27664
28287
|
* InfrastructureAsCode service.
|
|
27665
28288
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27666
|
-
* @version
|
|
28289
|
+
* @version 204.0.0
|
|
27667
28290
|
*/
|
|
27668
28291
|
|
|
27669
28292
|
/**
|
|
@@ -27830,7 +28453,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27830
28453
|
/**
|
|
27831
28454
|
* Integrations service.
|
|
27832
28455
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27833
|
-
* @version
|
|
28456
|
+
* @version 204.0.0
|
|
27834
28457
|
*/
|
|
27835
28458
|
|
|
27836
28459
|
/**
|
|
@@ -30202,7 +30825,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30202
30825
|
/**
|
|
30203
30826
|
* Journey service.
|
|
30204
30827
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
30205
|
-
* @version
|
|
30828
|
+
* @version 204.0.0
|
|
30206
30829
|
*/
|
|
30207
30830
|
|
|
30208
30831
|
/**
|
|
@@ -30350,7 +30973,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30350
30973
|
* Delete a Journey View by ID
|
|
30351
30974
|
* deletes all versions
|
|
30352
30975
|
* @param {String} viewId viewId
|
|
30353
|
-
* deleteJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30354
30976
|
*/
|
|
30355
30977
|
deleteJourneyView(viewId) {
|
|
30356
30978
|
// verify the required parameter 'viewId' is set
|
|
@@ -30999,7 +31621,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30999
31621
|
* Get a Journey View by ID
|
|
31000
31622
|
* returns the latest version
|
|
31001
31623
|
* @param {String} viewId viewId
|
|
31002
|
-
* getJourneyView is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31003
31624
|
*/
|
|
31004
31625
|
getJourneyView(viewId) {
|
|
31005
31626
|
// verify the required parameter 'viewId' is set
|
|
@@ -31026,7 +31647,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31026
31647
|
*
|
|
31027
31648
|
* @param {String} viewId viewId
|
|
31028
31649
|
* @param {String} versionId versionId
|
|
31029
|
-
* getJourneyViewVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31030
31650
|
*/
|
|
31031
31651
|
getJourneyViewVersion(viewId, versionId) {
|
|
31032
31652
|
// verify the required parameter 'viewId' is set
|
|
@@ -31058,7 +31678,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31058
31678
|
* @param {String} viewId Journey View Id
|
|
31059
31679
|
* @param {String} journeyVersionId Journey View Version
|
|
31060
31680
|
* @param {String} jobId JobId
|
|
31061
|
-
* getJourneyViewVersionJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31062
31681
|
*/
|
|
31063
31682
|
getJourneyViewVersionJob(viewId, journeyVersionId, jobId) {
|
|
31064
31683
|
// verify the required parameter 'viewId' is set
|
|
@@ -31094,7 +31713,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31094
31713
|
* @param {String} viewId JourneyViewResult id
|
|
31095
31714
|
* @param {String} journeyViewVersion Journey View Version
|
|
31096
31715
|
* @param {String} jobId Id of the executing job
|
|
31097
|
-
* getJourneyViewVersionJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31098
31716
|
*/
|
|
31099
31717
|
getJourneyViewVersionJobResults(viewId, journeyViewVersion, jobId) {
|
|
31100
31718
|
// verify the required parameter 'viewId' is set
|
|
@@ -31129,7 +31747,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31129
31747
|
* used for long descriptions
|
|
31130
31748
|
* @param {String} viewId Journey View Id
|
|
31131
31749
|
* @param {String} journeyVersionId Journey View Version
|
|
31132
|
-
* getJourneyViewVersionJobsLatest is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31133
31750
|
*/
|
|
31134
31751
|
getJourneyViewVersionJobsLatest(viewId, journeyVersionId) {
|
|
31135
31752
|
// verify the required parameter 'viewId' is set
|
|
@@ -31163,7 +31780,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31163
31780
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
31164
31781
|
* @param {String} opts.nameOrCreatedBy Journey View Name or Created By
|
|
31165
31782
|
* @param {Object} opts.expand Parameter to request additional data to return in Journey payload
|
|
31166
|
-
*
|
|
31783
|
+
* @param {String} opts.id Parameter to request a list of Journey Views by id, separated by commas. Limit of 100 items.
|
|
31167
31784
|
*/
|
|
31168
31785
|
getJourneyViews(opts) {
|
|
31169
31786
|
opts = opts || {};
|
|
@@ -31173,7 +31790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31173
31790
|
'/api/v2/journey/views',
|
|
31174
31791
|
'GET',
|
|
31175
31792
|
{ },
|
|
31176
|
-
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'nameOrCreatedBy': opts['nameOrCreatedBy'],'expand': opts['expand'] },
|
|
31793
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'nameOrCreatedBy': opts['nameOrCreatedBy'],'expand': opts['expand'],'id': opts['id'] },
|
|
31177
31794
|
{ },
|
|
31178
31795
|
{ },
|
|
31179
31796
|
null,
|
|
@@ -31238,7 +31855,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31238
31855
|
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
31239
31856
|
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
31240
31857
|
* @param {String} opts.statuses Job statuses to filter for
|
|
31241
|
-
* getJourneyViewsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31242
31858
|
*/
|
|
31243
31859
|
getJourneyViewsJobs(opts) {
|
|
31244
31860
|
opts = opts || {};
|
|
@@ -31741,7 +32357,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31741
32357
|
* used for long descriptions
|
|
31742
32358
|
* @param {String} viewId Journey View Id
|
|
31743
32359
|
* @param {String} journeyVersionId Journey View Version
|
|
31744
|
-
* postJourneyViewVersionJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31745
32360
|
*/
|
|
31746
32361
|
postJourneyViewVersionJobs(viewId, journeyVersionId) {
|
|
31747
32362
|
// verify the required parameter 'viewId' is set
|
|
@@ -31772,7 +32387,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31772
32387
|
* creates a new version
|
|
31773
32388
|
* @param {String} viewId viewId
|
|
31774
32389
|
* @param {Object} body JourneyView
|
|
31775
|
-
* postJourneyViewVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31776
32390
|
*/
|
|
31777
32391
|
postJourneyViewVersions(viewId, body) {
|
|
31778
32392
|
// verify the required parameter 'viewId' is set
|
|
@@ -31802,7 +32416,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31802
32416
|
* Create a new Journey View
|
|
31803
32417
|
*
|
|
31804
32418
|
* @param {Object} body JourneyView
|
|
31805
|
-
* postJourneyViews is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31806
32419
|
*/
|
|
31807
32420
|
postJourneyViews(body) {
|
|
31808
32421
|
// verify the required parameter 'body' is set
|
|
@@ -31855,7 +32468,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31855
32468
|
/**
|
|
31856
32469
|
* Knowledge service.
|
|
31857
32470
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31858
|
-
* @version
|
|
32471
|
+
* @version 204.0.0
|
|
31859
32472
|
*/
|
|
31860
32473
|
|
|
31861
32474
|
/**
|
|
@@ -33601,6 +34214,45 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33601
34214
|
);
|
|
33602
34215
|
}
|
|
33603
34216
|
|
|
34217
|
+
/**
|
|
34218
|
+
* Update feedback on a document
|
|
34219
|
+
*
|
|
34220
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
34221
|
+
* @param {String} documentId Document ID.
|
|
34222
|
+
* @param {String} feedbackId Feedback ID.
|
|
34223
|
+
* @param {Object} opts Optional parameters
|
|
34224
|
+
* @param {Object} opts.body
|
|
34225
|
+
*/
|
|
34226
|
+
patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId, opts) {
|
|
34227
|
+
opts = opts || {};
|
|
34228
|
+
|
|
34229
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
34230
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
34231
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
34232
|
+
}
|
|
34233
|
+
// verify the required parameter 'documentId' is set
|
|
34234
|
+
if (documentId === undefined || documentId === null) {
|
|
34235
|
+
throw 'Missing the required parameter "documentId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
34236
|
+
}
|
|
34237
|
+
// verify the required parameter 'feedbackId' is set
|
|
34238
|
+
if (feedbackId === undefined || feedbackId === null) {
|
|
34239
|
+
throw 'Missing the required parameter "feedbackId" when calling patchKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
|
|
34240
|
+
}
|
|
34241
|
+
|
|
34242
|
+
return this.apiClient.callApi(
|
|
34243
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
|
|
34244
|
+
'PATCH',
|
|
34245
|
+
{ 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
|
|
34246
|
+
{ },
|
|
34247
|
+
{ },
|
|
34248
|
+
{ },
|
|
34249
|
+
opts['body'],
|
|
34250
|
+
['PureCloud OAuth'],
|
|
34251
|
+
['application/json'],
|
|
34252
|
+
['application/json']
|
|
34253
|
+
);
|
|
34254
|
+
}
|
|
34255
|
+
|
|
33604
34256
|
/**
|
|
33605
34257
|
* Update a variation for a document.
|
|
33606
34258
|
*
|
|
@@ -34107,6 +34759,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34107
34759
|
);
|
|
34108
34760
|
}
|
|
34109
34761
|
|
|
34762
|
+
/**
|
|
34763
|
+
* Answer documents.
|
|
34764
|
+
*
|
|
34765
|
+
* @param {String} sessionId Knowledge guest session ID.
|
|
34766
|
+
* @param {Object} body
|
|
34767
|
+
*/
|
|
34768
|
+
postKnowledgeGuestSessionDocumentsAnswers(sessionId, body) {
|
|
34769
|
+
// verify the required parameter 'sessionId' is set
|
|
34770
|
+
if (sessionId === undefined || sessionId === null) {
|
|
34771
|
+
throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentsAnswers';
|
|
34772
|
+
}
|
|
34773
|
+
// verify the required parameter 'body' is set
|
|
34774
|
+
if (body === undefined || body === null) {
|
|
34775
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeGuestSessionDocumentsAnswers';
|
|
34776
|
+
}
|
|
34777
|
+
|
|
34778
|
+
return this.apiClient.callApi(
|
|
34779
|
+
'/api/v2/knowledge/guest/sessions/{sessionId}/documents/answers',
|
|
34780
|
+
'POST',
|
|
34781
|
+
{ 'sessionId': sessionId },
|
|
34782
|
+
{ },
|
|
34783
|
+
{ },
|
|
34784
|
+
{ },
|
|
34785
|
+
body,
|
|
34786
|
+
['PureCloud OAuth'],
|
|
34787
|
+
['application/json'],
|
|
34788
|
+
['application/json']
|
|
34789
|
+
);
|
|
34790
|
+
}
|
|
34791
|
+
|
|
34110
34792
|
/**
|
|
34111
34793
|
* Indicate that documents were presented to the user.
|
|
34112
34794
|
*
|
|
@@ -34452,6 +35134,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34452
35134
|
);
|
|
34453
35135
|
}
|
|
34454
35136
|
|
|
35137
|
+
/**
|
|
35138
|
+
* Answer documents.
|
|
35139
|
+
*
|
|
35140
|
+
* @param {String} knowledgeBaseId Knowledge base ID
|
|
35141
|
+
* @param {Object} body
|
|
35142
|
+
*/
|
|
35143
|
+
postKnowledgeKnowledgebaseDocumentsAnswers(knowledgeBaseId, body) {
|
|
35144
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
35145
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
35146
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsAnswers';
|
|
35147
|
+
}
|
|
35148
|
+
// verify the required parameter 'body' is set
|
|
35149
|
+
if (body === undefined || body === null) {
|
|
35150
|
+
throw 'Missing the required parameter "body" when calling postKnowledgeKnowledgebaseDocumentsAnswers';
|
|
35151
|
+
}
|
|
35152
|
+
|
|
35153
|
+
return this.apiClient.callApi(
|
|
35154
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/answers',
|
|
35155
|
+
'POST',
|
|
35156
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
35157
|
+
{ },
|
|
35158
|
+
{ },
|
|
35159
|
+
{ },
|
|
35160
|
+
body,
|
|
35161
|
+
['PureCloud OAuth'],
|
|
35162
|
+
['application/json'],
|
|
35163
|
+
['application/json']
|
|
35164
|
+
);
|
|
35165
|
+
}
|
|
35166
|
+
|
|
34455
35167
|
/**
|
|
34456
35168
|
* Bulk remove documents.
|
|
34457
35169
|
*
|
|
@@ -34543,6 +35255,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34543
35255
|
);
|
|
34544
35256
|
}
|
|
34545
35257
|
|
|
35258
|
+
/**
|
|
35259
|
+
* Query for knowledge documents.
|
|
35260
|
+
*
|
|
35261
|
+
* @param {String} knowledgeBaseId Knowledge Base ID
|
|
35262
|
+
* @param {Object} opts Optional parameters
|
|
35263
|
+
* @param {Array.<String>} opts.expand Fields, if any, to expand for each document in the search result matching the query.
|
|
35264
|
+
* @param {Object} opts.body
|
|
35265
|
+
*/
|
|
35266
|
+
postKnowledgeKnowledgebaseDocumentsQuery(knowledgeBaseId, opts) {
|
|
35267
|
+
opts = opts || {};
|
|
35268
|
+
|
|
35269
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
35270
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
|
|
35271
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentsQuery';
|
|
35272
|
+
}
|
|
35273
|
+
|
|
35274
|
+
return this.apiClient.callApi(
|
|
35275
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/query',
|
|
35276
|
+
'POST',
|
|
35277
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
35278
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35279
|
+
{ },
|
|
35280
|
+
{ },
|
|
35281
|
+
opts['body'],
|
|
35282
|
+
['PureCloud OAuth'],
|
|
35283
|
+
['application/json'],
|
|
35284
|
+
['application/json']
|
|
35285
|
+
);
|
|
35286
|
+
}
|
|
35287
|
+
|
|
34546
35288
|
/**
|
|
34547
35289
|
* Search the documents in a knowledge base.
|
|
34548
35290
|
*
|
|
@@ -35099,7 +35841,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35099
35841
|
/**
|
|
35100
35842
|
* LanguageUnderstanding service.
|
|
35101
35843
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
35102
|
-
* @version
|
|
35844
|
+
* @version 204.0.0
|
|
35103
35845
|
*/
|
|
35104
35846
|
|
|
35105
35847
|
/**
|
|
@@ -36133,7 +36875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36133
36875
|
/**
|
|
36134
36876
|
* Languages service.
|
|
36135
36877
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
36136
|
-
* @version
|
|
36878
|
+
* @version 204.0.0
|
|
36137
36879
|
*/
|
|
36138
36880
|
|
|
36139
36881
|
/**
|
|
@@ -36355,7 +37097,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36355
37097
|
/**
|
|
36356
37098
|
* Learning service.
|
|
36357
37099
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
36358
|
-
* @version
|
|
37100
|
+
* @version 204.0.0
|
|
36359
37101
|
*/
|
|
36360
37102
|
|
|
36361
37103
|
/**
|
|
@@ -37384,7 +38126,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37384
38126
|
/**
|
|
37385
38127
|
* License service.
|
|
37386
38128
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
37387
|
-
* @version
|
|
38129
|
+
* @version 204.0.0
|
|
37388
38130
|
*/
|
|
37389
38131
|
|
|
37390
38132
|
/**
|
|
@@ -37622,7 +38364,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37622
38364
|
/**
|
|
37623
38365
|
* Locations service.
|
|
37624
38366
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37625
|
-
* @version
|
|
38367
|
+
* @version 204.0.0
|
|
37626
38368
|
*/
|
|
37627
38369
|
|
|
37628
38370
|
/**
|
|
@@ -37858,7 +38600,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37858
38600
|
/**
|
|
37859
38601
|
* LogCapture service.
|
|
37860
38602
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37861
|
-
* @version
|
|
38603
|
+
* @version 204.0.0
|
|
37862
38604
|
*/
|
|
37863
38605
|
|
|
37864
38606
|
/**
|
|
@@ -38058,7 +38800,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38058
38800
|
/**
|
|
38059
38801
|
* Messaging service.
|
|
38060
38802
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
38061
|
-
* @version
|
|
38803
|
+
* @version 204.0.0
|
|
38062
38804
|
*/
|
|
38063
38805
|
|
|
38064
38806
|
/**
|
|
@@ -38417,7 +39159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38417
39159
|
/**
|
|
38418
39160
|
* MobileDevices service.
|
|
38419
39161
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
38420
|
-
* @version
|
|
39162
|
+
* @version 204.0.0
|
|
38421
39163
|
*/
|
|
38422
39164
|
|
|
38423
39165
|
/**
|
|
@@ -38568,7 +39310,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38568
39310
|
/**
|
|
38569
39311
|
* Notifications service.
|
|
38570
39312
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38571
|
-
* @version
|
|
39313
|
+
* @version 204.0.0
|
|
38572
39314
|
*/
|
|
38573
39315
|
|
|
38574
39316
|
/**
|
|
@@ -38801,7 +39543,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38801
39543
|
/**
|
|
38802
39544
|
* OAuth service.
|
|
38803
39545
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38804
|
-
* @version
|
|
39546
|
+
* @version 204.0.0
|
|
38805
39547
|
*/
|
|
38806
39548
|
|
|
38807
39549
|
/**
|
|
@@ -39167,7 +39909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39167
39909
|
/**
|
|
39168
39910
|
* Objects service.
|
|
39169
39911
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
39170
|
-
* @version
|
|
39912
|
+
* @version 204.0.0
|
|
39171
39913
|
*/
|
|
39172
39914
|
|
|
39173
39915
|
/**
|
|
@@ -39437,7 +40179,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39437
40179
|
/**
|
|
39438
40180
|
* OperationalEvents service.
|
|
39439
40181
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
39440
|
-
* @version
|
|
40182
|
+
* @version 204.0.0
|
|
39441
40183
|
*/
|
|
39442
40184
|
|
|
39443
40185
|
/**
|
|
@@ -39503,7 +40245,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39503
40245
|
/**
|
|
39504
40246
|
* Organization service.
|
|
39505
40247
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39506
|
-
* @version
|
|
40248
|
+
* @version 204.0.0
|
|
39507
40249
|
*/
|
|
39508
40250
|
|
|
39509
40251
|
/**
|
|
@@ -40045,7 +40787,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40045
40787
|
/**
|
|
40046
40788
|
* OrganizationAuthorization service.
|
|
40047
40789
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
40048
|
-
* @version
|
|
40790
|
+
* @version 204.0.0
|
|
40049
40791
|
*/
|
|
40050
40792
|
|
|
40051
40793
|
/**
|
|
@@ -41392,7 +42134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41392
42134
|
/**
|
|
41393
42135
|
* Outbound service.
|
|
41394
42136
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
41395
|
-
* @version
|
|
42137
|
+
* @version 204.0.0
|
|
41396
42138
|
*/
|
|
41397
42139
|
|
|
41398
42140
|
/**
|
|
@@ -45809,7 +46551,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45809
46551
|
/**
|
|
45810
46552
|
* Presence service.
|
|
45811
46553
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45812
|
-
* @version
|
|
46554
|
+
* @version 204.0.0
|
|
45813
46555
|
*/
|
|
45814
46556
|
|
|
45815
46557
|
/**
|
|
@@ -46553,7 +47295,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46553
47295
|
/**
|
|
46554
47296
|
* ProcessAutomation service.
|
|
46555
47297
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
46556
|
-
* @version
|
|
47298
|
+
* @version 204.0.0
|
|
46557
47299
|
*/
|
|
46558
47300
|
|
|
46559
47301
|
/**
|
|
@@ -46792,7 +47534,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46792
47534
|
/**
|
|
46793
47535
|
* Quality service.
|
|
46794
47536
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46795
|
-
* @version
|
|
47537
|
+
* @version 204.0.0
|
|
46796
47538
|
*/
|
|
46797
47539
|
|
|
46798
47540
|
/**
|
|
@@ -48578,7 +49320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48578
49320
|
/**
|
|
48579
49321
|
* Recording service.
|
|
48580
49322
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
48581
|
-
* @version
|
|
49323
|
+
* @version 204.0.0
|
|
48582
49324
|
*/
|
|
48583
49325
|
|
|
48584
49326
|
/**
|
|
@@ -50237,7 +50979,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50237
50979
|
/**
|
|
50238
50980
|
* ResponseManagement service.
|
|
50239
50981
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
50240
|
-
* @version
|
|
50982
|
+
* @version 204.0.0
|
|
50241
50983
|
*/
|
|
50242
50984
|
|
|
50243
50985
|
/**
|
|
@@ -50747,7 +51489,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50747
51489
|
/**
|
|
50748
51490
|
* Routing service.
|
|
50749
51491
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50750
|
-
* @version
|
|
51492
|
+
* @version 204.0.0
|
|
50751
51493
|
*/
|
|
50752
51494
|
|
|
50753
51495
|
/**
|
|
@@ -52028,6 +52770,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52028
52770
|
);
|
|
52029
52771
|
}
|
|
52030
52772
|
|
|
52773
|
+
/**
|
|
52774
|
+
* Get an assistant associated with a queue.
|
|
52775
|
+
*
|
|
52776
|
+
* @param {String} queueId Queue ID
|
|
52777
|
+
* @param {Object} opts Optional parameters
|
|
52778
|
+
* @param {Object} opts.expand Which fields, if any, to expand.
|
|
52779
|
+
*/
|
|
52780
|
+
getRoutingQueueAssistant(queueId, opts) {
|
|
52781
|
+
opts = opts || {};
|
|
52782
|
+
|
|
52783
|
+
// verify the required parameter 'queueId' is set
|
|
52784
|
+
if (queueId === undefined || queueId === null) {
|
|
52785
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingQueueAssistant';
|
|
52786
|
+
}
|
|
52787
|
+
|
|
52788
|
+
return this.apiClient.callApi(
|
|
52789
|
+
'/api/v2/routing/queues/{queueId}/assistant',
|
|
52790
|
+
'GET',
|
|
52791
|
+
{ 'queueId': queueId },
|
|
52792
|
+
{ 'expand': opts['expand'] },
|
|
52793
|
+
{ },
|
|
52794
|
+
{ },
|
|
52795
|
+
null,
|
|
52796
|
+
['PureCloud OAuth'],
|
|
52797
|
+
['application/json'],
|
|
52798
|
+
['application/json']
|
|
52799
|
+
);
|
|
52800
|
+
}
|
|
52801
|
+
|
|
52031
52802
|
/**
|
|
52032
52803
|
* Get a Comparison Period.
|
|
52033
52804
|
*
|
|
@@ -54866,7 +55637,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54866
55637
|
/**
|
|
54867
55638
|
* SCIM service.
|
|
54868
55639
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54869
|
-
* @version
|
|
55640
|
+
* @version 204.0.0
|
|
54870
55641
|
*/
|
|
54871
55642
|
|
|
54872
55643
|
/**
|
|
@@ -55743,7 +56514,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55743
56514
|
/**
|
|
55744
56515
|
* ScreenRecording service.
|
|
55745
56516
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
55746
|
-
* @version
|
|
56517
|
+
* @version 204.0.0
|
|
55747
56518
|
*/
|
|
55748
56519
|
|
|
55749
56520
|
/**
|
|
@@ -55788,7 +56559,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55788
56559
|
/**
|
|
55789
56560
|
* Scripts service.
|
|
55790
56561
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
55791
|
-
* @version
|
|
56562
|
+
* @version 204.0.0
|
|
55792
56563
|
*/
|
|
55793
56564
|
|
|
55794
56565
|
/**
|
|
@@ -56232,7 +57003,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56232
57003
|
/**
|
|
56233
57004
|
* Search service.
|
|
56234
57005
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
56235
|
-
* @version
|
|
57006
|
+
* @version 204.0.0
|
|
56236
57007
|
*/
|
|
56237
57008
|
|
|
56238
57009
|
/**
|
|
@@ -56921,7 +57692,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56921
57692
|
/**
|
|
56922
57693
|
* Settings service.
|
|
56923
57694
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56924
|
-
* @version
|
|
57695
|
+
* @version 204.0.0
|
|
56925
57696
|
*/
|
|
56926
57697
|
|
|
56927
57698
|
/**
|
|
@@ -56984,7 +57755,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56984
57755
|
/**
|
|
56985
57756
|
* Get the execution history enabled setting.
|
|
56986
57757
|
* Get the execution history enabled setting.
|
|
56987
|
-
* getSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
56988
57758
|
*/
|
|
56989
57759
|
getSettingsExecutiondata() {
|
|
56990
57760
|
|
|
@@ -57055,7 +57825,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57055
57825
|
* Edit the execution history on off setting.
|
|
57056
57826
|
* Edit the execution history on off setting.
|
|
57057
57827
|
* @param {Object} body New Execution Data Setting
|
|
57058
|
-
* patchSettingsExecutiondata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
57059
57828
|
*/
|
|
57060
57829
|
patchSettingsExecutiondata(body) {
|
|
57061
57830
|
// verify the required parameter 'body' is set
|
|
@@ -57143,7 +57912,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57143
57912
|
/**
|
|
57144
57913
|
* SpeechTextAnalytics service.
|
|
57145
57914
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
57146
|
-
* @version
|
|
57915
|
+
* @version 204.0.0
|
|
57147
57916
|
*/
|
|
57148
57917
|
|
|
57149
57918
|
/**
|
|
@@ -58421,7 +59190,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58421
59190
|
/**
|
|
58422
59191
|
* Stations service.
|
|
58423
59192
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
58424
|
-
* @version
|
|
59193
|
+
* @version 204.0.0
|
|
58425
59194
|
*/
|
|
58426
59195
|
|
|
58427
59196
|
/**
|
|
@@ -58523,7 +59292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58523
59292
|
/**
|
|
58524
59293
|
* Suggest service.
|
|
58525
59294
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
58526
|
-
* @version
|
|
59295
|
+
* @version 204.0.0
|
|
58527
59296
|
*/
|
|
58528
59297
|
|
|
58529
59298
|
/**
|
|
@@ -58662,7 +59431,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58662
59431
|
/**
|
|
58663
59432
|
* TaskManagement service.
|
|
58664
59433
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
58665
|
-
* @version
|
|
59434
|
+
* @version 204.0.0
|
|
58666
59435
|
*/
|
|
58667
59436
|
|
|
58668
59437
|
/**
|
|
@@ -60016,7 +60785,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60016
60785
|
/**
|
|
60017
60786
|
* Teams service.
|
|
60018
60787
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
60019
|
-
* @version
|
|
60788
|
+
* @version 204.0.0
|
|
60020
60789
|
*/
|
|
60021
60790
|
|
|
60022
60791
|
/**
|
|
@@ -60317,7 +61086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60317
61086
|
/**
|
|
60318
61087
|
* Telephony service.
|
|
60319
61088
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
60320
|
-
* @version
|
|
61089
|
+
* @version 204.0.0
|
|
60321
61090
|
*/
|
|
60322
61091
|
|
|
60323
61092
|
/**
|
|
@@ -60499,7 +61268,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60499
61268
|
/**
|
|
60500
61269
|
* TelephonyProvidersEdge service.
|
|
60501
61270
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
60502
|
-
* @version
|
|
61271
|
+
* @version 204.0.0
|
|
60503
61272
|
*/
|
|
60504
61273
|
|
|
60505
61274
|
/**
|
|
@@ -63827,7 +64596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63827
64596
|
/**
|
|
63828
64597
|
* Textbots service.
|
|
63829
64598
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
63830
|
-
* @version
|
|
64599
|
+
* @version 204.0.0
|
|
63831
64600
|
*/
|
|
63832
64601
|
|
|
63833
64602
|
/**
|
|
@@ -63955,7 +64724,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63955
64724
|
/**
|
|
63956
64725
|
* Tokens service.
|
|
63957
64726
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63958
|
-
* @version
|
|
64727
|
+
* @version 204.0.0
|
|
63959
64728
|
*/
|
|
63960
64729
|
|
|
63961
64730
|
/**
|
|
@@ -64109,7 +64878,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64109
64878
|
/**
|
|
64110
64879
|
* Uploads service.
|
|
64111
64880
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
64112
|
-
* @version
|
|
64881
|
+
* @version 204.0.0
|
|
64113
64882
|
*/
|
|
64114
64883
|
|
|
64115
64884
|
/**
|
|
@@ -64378,7 +65147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64378
65147
|
/**
|
|
64379
65148
|
* Usage service.
|
|
64380
65149
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
64381
|
-
* @version
|
|
65150
|
+
* @version 204.0.0
|
|
64382
65151
|
*/
|
|
64383
65152
|
|
|
64384
65153
|
/**
|
|
@@ -64593,7 +65362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64593
65362
|
/**
|
|
64594
65363
|
* UserRecordings service.
|
|
64595
65364
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
64596
|
-
* @version
|
|
65365
|
+
* @version 204.0.0
|
|
64597
65366
|
*/
|
|
64598
65367
|
|
|
64599
65368
|
/**
|
|
@@ -64808,7 +65577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64808
65577
|
/**
|
|
64809
65578
|
* Users service.
|
|
64810
65579
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
64811
|
-
* @version
|
|
65580
|
+
* @version 204.0.0
|
|
64812
65581
|
*/
|
|
64813
65582
|
|
|
64814
65583
|
/**
|
|
@@ -67611,7 +68380,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67611
68380
|
/**
|
|
67612
68381
|
* Utilities service.
|
|
67613
68382
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
67614
|
-
* @version
|
|
68383
|
+
* @version 204.0.0
|
|
67615
68384
|
*/
|
|
67616
68385
|
|
|
67617
68386
|
/**
|
|
@@ -67722,7 +68491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67722
68491
|
/**
|
|
67723
68492
|
* Voicemail service.
|
|
67724
68493
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
67725
|
-
* @version
|
|
68494
|
+
* @version 204.0.0
|
|
67726
68495
|
*/
|
|
67727
68496
|
|
|
67728
68497
|
/**
|
|
@@ -68389,7 +69158,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68389
69158
|
/**
|
|
68390
69159
|
* WebChat service.
|
|
68391
69160
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
68392
|
-
* @version
|
|
69161
|
+
* @version 204.0.0
|
|
68393
69162
|
*/
|
|
68394
69163
|
|
|
68395
69164
|
/**
|
|
@@ -68940,7 +69709,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68940
69709
|
/**
|
|
68941
69710
|
* WebDeployments service.
|
|
68942
69711
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
68943
|
-
* @version
|
|
69712
|
+
* @version 204.0.0
|
|
68944
69713
|
*/
|
|
68945
69714
|
|
|
68946
69715
|
/**
|
|
@@ -69467,7 +70236,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69467
70236
|
/**
|
|
69468
70237
|
* WebMessaging service.
|
|
69469
70238
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
69470
|
-
* @version
|
|
70239
|
+
* @version 204.0.0
|
|
69471
70240
|
*/
|
|
69472
70241
|
|
|
69473
70242
|
/**
|
|
@@ -69513,7 +70282,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69513
70282
|
/**
|
|
69514
70283
|
* Widgets service.
|
|
69515
70284
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
69516
|
-
* @version
|
|
70285
|
+
* @version 204.0.0
|
|
69517
70286
|
*/
|
|
69518
70287
|
|
|
69519
70288
|
/**
|
|
@@ -69659,7 +70428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69659
70428
|
/**
|
|
69660
70429
|
* WorkforceManagement service.
|
|
69661
70430
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
69662
|
-
* @version
|
|
70431
|
+
* @version 204.0.0
|
|
69663
70432
|
*/
|
|
69664
70433
|
|
|
69665
70434
|
/**
|
|
@@ -76814,7 +77583,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76814
77583
|
* </pre>
|
|
76815
77584
|
* </p>
|
|
76816
77585
|
* @module purecloud-platform-client-v2/index
|
|
76817
|
-
* @version
|
|
77586
|
+
* @version 204.0.0
|
|
76818
77587
|
*/
|
|
76819
77588
|
class platformClient {
|
|
76820
77589
|
constructor() {
|
|
@@ -76828,6 +77597,16 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76828
77597
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
76829
77598
|
*/
|
|
76830
77599
|
this.ApiClientClass = ApiClient;
|
|
77600
|
+
/**
|
|
77601
|
+
* The AgentAssistantsApi service constructor.
|
|
77602
|
+
* @property {module:purecloud-platform-client-v2/api/AgentAssistantsApi}
|
|
77603
|
+
*/
|
|
77604
|
+
this.AgentAssistantsApi = AgentAssistantsApi;
|
|
77605
|
+
/**
|
|
77606
|
+
* The AgentCopilotApi service constructor.
|
|
77607
|
+
* @property {module:purecloud-platform-client-v2/api/AgentCopilotApi}
|
|
77608
|
+
*/
|
|
77609
|
+
this.AgentCopilotApi = AgentCopilotApi;
|
|
76831
77610
|
/**
|
|
76832
77611
|
* The AgentUIApi service constructor.
|
|
76833
77612
|
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|