purecloud-platform-client-v2 195.0.0 → 197.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 +678 -119
- package/dist/web-amd/purecloud-platform-client-v2.js +678 -119
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +244 -101
- package/dist/web-cjs/purecloud-platform-client-v2.js +249 -102
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +521 -316
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +136 -0
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +129 -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 +156 -0
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +8 -4
- 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 +31 -2
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +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 +31 -35
- 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 +2 -4
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +3 -2
- 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 +111 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/index.js +13 -1
|
@@ -405,7 +405,7 @@ class Configuration {
|
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
407
|
* @module purecloud-platform-client-v2/ApiClient
|
|
408
|
-
* @version
|
|
408
|
+
* @version 197.0.0
|
|
409
409
|
*/
|
|
410
410
|
class ApiClient {
|
|
411
411
|
/**
|
|
@@ -1823,11 +1823,142 @@ class ApiClient {
|
|
|
1823
1823
|
}
|
|
1824
1824
|
}
|
|
1825
1825
|
|
|
1826
|
+
class AgentUIApi {
|
|
1827
|
+
/**
|
|
1828
|
+
* AgentUI service.
|
|
1829
|
+
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1830
|
+
* @version 197.0.0
|
|
1831
|
+
*/
|
|
1832
|
+
|
|
1833
|
+
/**
|
|
1834
|
+
* Constructs a new AgentUIApi.
|
|
1835
|
+
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
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 agent auto answer settings
|
|
1847
|
+
*
|
|
1848
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1849
|
+
*/
|
|
1850
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
1851
|
+
// verify the required parameter 'agentId' is set
|
|
1852
|
+
if (agentId === undefined || agentId === null) {
|
|
1853
|
+
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1854
|
+
}
|
|
1855
|
+
|
|
1856
|
+
return this.apiClient.callApi(
|
|
1857
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1858
|
+
'DELETE',
|
|
1859
|
+
{ 'agentId': agentId },
|
|
1860
|
+
{ },
|
|
1861
|
+
{ },
|
|
1862
|
+
{ },
|
|
1863
|
+
null,
|
|
1864
|
+
['PureCloud OAuth'],
|
|
1865
|
+
['application/json'],
|
|
1866
|
+
['application/json']
|
|
1867
|
+
);
|
|
1868
|
+
}
|
|
1869
|
+
|
|
1870
|
+
/**
|
|
1871
|
+
* Get agent auto answer settings
|
|
1872
|
+
*
|
|
1873
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1874
|
+
*/
|
|
1875
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
1876
|
+
// verify the required parameter 'agentId' is set
|
|
1877
|
+
if (agentId === undefined || agentId === null) {
|
|
1878
|
+
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1881
|
+
return this.apiClient.callApi(
|
|
1882
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1883
|
+
'GET',
|
|
1884
|
+
{ 'agentId': agentId },
|
|
1885
|
+
{ },
|
|
1886
|
+
{ },
|
|
1887
|
+
{ },
|
|
1888
|
+
null,
|
|
1889
|
+
['PureCloud OAuth'],
|
|
1890
|
+
['application/json'],
|
|
1891
|
+
['application/json']
|
|
1892
|
+
);
|
|
1893
|
+
}
|
|
1894
|
+
|
|
1895
|
+
/**
|
|
1896
|
+
* Update agent auto answer settings
|
|
1897
|
+
*
|
|
1898
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1899
|
+
* @param {Object} body AutoAnswerSettings
|
|
1900
|
+
*/
|
|
1901
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
1902
|
+
// verify the required parameter 'agentId' is set
|
|
1903
|
+
if (agentId === undefined || agentId === null) {
|
|
1904
|
+
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1905
|
+
}
|
|
1906
|
+
// verify the required parameter 'body' is set
|
|
1907
|
+
if (body === undefined || body === null) {
|
|
1908
|
+
throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1909
|
+
}
|
|
1910
|
+
|
|
1911
|
+
return this.apiClient.callApi(
|
|
1912
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1913
|
+
'PATCH',
|
|
1914
|
+
{ 'agentId': agentId },
|
|
1915
|
+
{ },
|
|
1916
|
+
{ },
|
|
1917
|
+
{ },
|
|
1918
|
+
body,
|
|
1919
|
+
['PureCloud OAuth'],
|
|
1920
|
+
['application/json'],
|
|
1921
|
+
['application/json']
|
|
1922
|
+
);
|
|
1923
|
+
}
|
|
1924
|
+
|
|
1925
|
+
/**
|
|
1926
|
+
* Set agent auto answer settings
|
|
1927
|
+
*
|
|
1928
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1929
|
+
* @param {Object} body AutoAnswerSettings
|
|
1930
|
+
*/
|
|
1931
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
1932
|
+
// verify the required parameter 'agentId' is set
|
|
1933
|
+
if (agentId === undefined || agentId === null) {
|
|
1934
|
+
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1935
|
+
}
|
|
1936
|
+
// verify the required parameter 'body' is set
|
|
1937
|
+
if (body === undefined || body === null) {
|
|
1938
|
+
throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1939
|
+
}
|
|
1940
|
+
|
|
1941
|
+
return this.apiClient.callApi(
|
|
1942
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1943
|
+
'PUT',
|
|
1944
|
+
{ 'agentId': agentId },
|
|
1945
|
+
{ },
|
|
1946
|
+
{ },
|
|
1947
|
+
{ },
|
|
1948
|
+
body,
|
|
1949
|
+
['PureCloud OAuth'],
|
|
1950
|
+
['application/json'],
|
|
1951
|
+
['application/json']
|
|
1952
|
+
);
|
|
1953
|
+
}
|
|
1954
|
+
|
|
1955
|
+
}
|
|
1956
|
+
|
|
1826
1957
|
class AlertingApi {
|
|
1827
1958
|
/**
|
|
1828
1959
|
* Alerting service.
|
|
1829
1960
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1830
|
-
* @version
|
|
1961
|
+
* @version 197.0.0
|
|
1831
1962
|
*/
|
|
1832
1963
|
|
|
1833
1964
|
/**
|
|
@@ -2488,7 +2619,7 @@ class AnalyticsApi {
|
|
|
2488
2619
|
/**
|
|
2489
2620
|
* Analytics service.
|
|
2490
2621
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2491
|
-
* @version
|
|
2622
|
+
* @version 197.0.0
|
|
2492
2623
|
*/
|
|
2493
2624
|
|
|
2494
2625
|
/**
|
|
@@ -5100,7 +5231,7 @@ class ArchitectApi {
|
|
|
5100
5231
|
/**
|
|
5101
5232
|
* Architect service.
|
|
5102
5233
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5103
|
-
* @version
|
|
5234
|
+
* @version 197.0.0
|
|
5104
5235
|
*/
|
|
5105
5236
|
|
|
5106
5237
|
/**
|
|
@@ -9246,7 +9377,7 @@ class AuditApi {
|
|
|
9246
9377
|
/**
|
|
9247
9378
|
* Audit service.
|
|
9248
9379
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9249
|
-
* @version
|
|
9380
|
+
* @version 197.0.0
|
|
9250
9381
|
*/
|
|
9251
9382
|
|
|
9252
9383
|
/**
|
|
@@ -9446,7 +9577,7 @@ class AuthorizationApi {
|
|
|
9446
9577
|
/**
|
|
9447
9578
|
* Authorization service.
|
|
9448
9579
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9449
|
-
* @version
|
|
9580
|
+
* @version 197.0.0
|
|
9450
9581
|
*/
|
|
9451
9582
|
|
|
9452
9583
|
/**
|
|
@@ -10684,7 +10815,7 @@ class BillingApi {
|
|
|
10684
10815
|
/**
|
|
10685
10816
|
* Billing service.
|
|
10686
10817
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10687
|
-
* @version
|
|
10818
|
+
* @version 197.0.0
|
|
10688
10819
|
*/
|
|
10689
10820
|
|
|
10690
10821
|
/**
|
|
@@ -10764,7 +10895,7 @@ class CarrierServicesApi {
|
|
|
10764
10895
|
/**
|
|
10765
10896
|
* CarrierServices service.
|
|
10766
10897
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10767
|
-
* @version
|
|
10898
|
+
* @version 197.0.0
|
|
10768
10899
|
*/
|
|
10769
10900
|
|
|
10770
10901
|
/**
|
|
@@ -10834,7 +10965,7 @@ class ChatApi {
|
|
|
10834
10965
|
/**
|
|
10835
10966
|
* Chat service.
|
|
10836
10967
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10837
|
-
* @version
|
|
10968
|
+
* @version 197.0.0
|
|
10838
10969
|
*/
|
|
10839
10970
|
|
|
10840
10971
|
/**
|
|
@@ -11770,7 +11901,7 @@ class CoachingApi {
|
|
|
11770
11901
|
/**
|
|
11771
11902
|
* Coaching service.
|
|
11772
11903
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11773
|
-
* @version
|
|
11904
|
+
* @version 197.0.0
|
|
11774
11905
|
*/
|
|
11775
11906
|
|
|
11776
11907
|
/**
|
|
@@ -12347,7 +12478,7 @@ class ContentManagementApi {
|
|
|
12347
12478
|
/**
|
|
12348
12479
|
* ContentManagement service.
|
|
12349
12480
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12350
|
-
* @version
|
|
12481
|
+
* @version 197.0.0
|
|
12351
12482
|
*/
|
|
12352
12483
|
|
|
12353
12484
|
/**
|
|
@@ -13429,7 +13560,7 @@ class ConversationsApi {
|
|
|
13429
13560
|
/**
|
|
13430
13561
|
* Conversations service.
|
|
13431
13562
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13432
|
-
* @version
|
|
13563
|
+
* @version 197.0.0
|
|
13433
13564
|
*/
|
|
13434
13565
|
|
|
13435
13566
|
/**
|
|
@@ -14148,6 +14279,69 @@ class ConversationsApi {
|
|
|
14148
14279
|
);
|
|
14149
14280
|
}
|
|
14150
14281
|
|
|
14282
|
+
/**
|
|
14283
|
+
* Get Suggestion.
|
|
14284
|
+
*
|
|
14285
|
+
* @param {String} conversationId Conversation ID
|
|
14286
|
+
* @param {String} suggestionId Suggestion ID
|
|
14287
|
+
*/
|
|
14288
|
+
getConversationSuggestion(conversationId, suggestionId) {
|
|
14289
|
+
// verify the required parameter 'conversationId' is set
|
|
14290
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14291
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSuggestion';
|
|
14292
|
+
}
|
|
14293
|
+
// verify the required parameter 'suggestionId' is set
|
|
14294
|
+
if (suggestionId === undefined || suggestionId === null) {
|
|
14295
|
+
throw 'Missing the required parameter "suggestionId" when calling getConversationSuggestion';
|
|
14296
|
+
}
|
|
14297
|
+
|
|
14298
|
+
return this.apiClient.callApi(
|
|
14299
|
+
'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}',
|
|
14300
|
+
'GET',
|
|
14301
|
+
{ 'conversationId': conversationId,'suggestionId': suggestionId },
|
|
14302
|
+
{ },
|
|
14303
|
+
{ },
|
|
14304
|
+
{ },
|
|
14305
|
+
null,
|
|
14306
|
+
['PureCloud OAuth'],
|
|
14307
|
+
['application/json'],
|
|
14308
|
+
['application/json']
|
|
14309
|
+
);
|
|
14310
|
+
}
|
|
14311
|
+
|
|
14312
|
+
/**
|
|
14313
|
+
* Get all suggestions for a conversation.
|
|
14314
|
+
*
|
|
14315
|
+
* @param {String} conversationId Conversation ID
|
|
14316
|
+
* @param {Object} opts Optional parameters
|
|
14317
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
14318
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14319
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14320
|
+
* @param {Object} opts.type Suggestion type to filter by.
|
|
14321
|
+
* @param {Object} opts.state Suggestion state to filter Copilot suggestions.
|
|
14322
|
+
*/
|
|
14323
|
+
getConversationSuggestions(conversationId, opts) {
|
|
14324
|
+
opts = opts || {};
|
|
14325
|
+
|
|
14326
|
+
// verify the required parameter 'conversationId' is set
|
|
14327
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14328
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSuggestions';
|
|
14329
|
+
}
|
|
14330
|
+
|
|
14331
|
+
return this.apiClient.callApi(
|
|
14332
|
+
'/api/v2/conversations/{conversationId}/suggestions',
|
|
14333
|
+
'GET',
|
|
14334
|
+
{ 'conversationId': conversationId },
|
|
14335
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'type': opts['type'],'state': opts['state'] },
|
|
14336
|
+
{ },
|
|
14337
|
+
{ },
|
|
14338
|
+
null,
|
|
14339
|
+
['PureCloud OAuth'],
|
|
14340
|
+
['application/json'],
|
|
14341
|
+
['application/json']
|
|
14342
|
+
);
|
|
14343
|
+
}
|
|
14344
|
+
|
|
14151
14345
|
/**
|
|
14152
14346
|
* Get active conversations for the logged in user
|
|
14153
14347
|
*
|
|
@@ -17963,6 +18157,71 @@ class ConversationsApi {
|
|
|
17963
18157
|
);
|
|
17964
18158
|
}
|
|
17965
18159
|
|
|
18160
|
+
/**
|
|
18161
|
+
* Save an engagement on the suggestion.
|
|
18162
|
+
*
|
|
18163
|
+
* @param {String} conversationId Conversation ID
|
|
18164
|
+
* @param {String} suggestionId Suggestion ID
|
|
18165
|
+
* @param {Object} body
|
|
18166
|
+
*/
|
|
18167
|
+
postConversationSuggestionEngagement(conversationId, suggestionId, body) {
|
|
18168
|
+
// verify the required parameter 'conversationId' is set
|
|
18169
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18170
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionEngagement';
|
|
18171
|
+
}
|
|
18172
|
+
// verify the required parameter 'suggestionId' is set
|
|
18173
|
+
if (suggestionId === undefined || suggestionId === null) {
|
|
18174
|
+
throw 'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';
|
|
18175
|
+
}
|
|
18176
|
+
// verify the required parameter 'body' is set
|
|
18177
|
+
if (body === undefined || body === null) {
|
|
18178
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionEngagement';
|
|
18179
|
+
}
|
|
18180
|
+
|
|
18181
|
+
return this.apiClient.callApi(
|
|
18182
|
+
'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement',
|
|
18183
|
+
'POST',
|
|
18184
|
+
{ 'conversationId': conversationId,'suggestionId': suggestionId },
|
|
18185
|
+
{ },
|
|
18186
|
+
{ },
|
|
18187
|
+
{ },
|
|
18188
|
+
body,
|
|
18189
|
+
['PureCloud OAuth'],
|
|
18190
|
+
['application/json'],
|
|
18191
|
+
['application/json']
|
|
18192
|
+
);
|
|
18193
|
+
}
|
|
18194
|
+
|
|
18195
|
+
/**
|
|
18196
|
+
* Suggestion feedback.
|
|
18197
|
+
*
|
|
18198
|
+
* @param {String} conversationId Conversation ID
|
|
18199
|
+
* @param {Object} body SuggestionFeedback
|
|
18200
|
+
*/
|
|
18201
|
+
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18202
|
+
// verify the required parameter 'conversationId' is set
|
|
18203
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18204
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';
|
|
18205
|
+
}
|
|
18206
|
+
// verify the required parameter 'body' is set
|
|
18207
|
+
if (body === undefined || body === null) {
|
|
18208
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';
|
|
18209
|
+
}
|
|
18210
|
+
|
|
18211
|
+
return this.apiClient.callApi(
|
|
18212
|
+
'/api/v2/conversations/{conversationId}/suggestions/feedback',
|
|
18213
|
+
'POST',
|
|
18214
|
+
{ 'conversationId': conversationId },
|
|
18215
|
+
{ },
|
|
18216
|
+
{ },
|
|
18217
|
+
{ },
|
|
18218
|
+
body,
|
|
18219
|
+
['PureCloud OAuth'],
|
|
18220
|
+
['application/json'],
|
|
18221
|
+
['application/json']
|
|
18222
|
+
);
|
|
18223
|
+
}
|
|
18224
|
+
|
|
17966
18225
|
/**
|
|
17967
18226
|
* Submit feedback for the summary.
|
|
17968
18227
|
*
|
|
@@ -20380,7 +20639,7 @@ class DataExtensionsApi {
|
|
|
20380
20639
|
/**
|
|
20381
20640
|
* DataExtensions service.
|
|
20382
20641
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20383
|
-
* @version
|
|
20642
|
+
* @version 197.0.0
|
|
20384
20643
|
*/
|
|
20385
20644
|
|
|
20386
20645
|
/**
|
|
@@ -20466,7 +20725,7 @@ class DownloadsApi {
|
|
|
20466
20725
|
/**
|
|
20467
20726
|
* Downloads service.
|
|
20468
20727
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20469
|
-
* @version
|
|
20728
|
+
* @version 197.0.0
|
|
20470
20729
|
*/
|
|
20471
20730
|
|
|
20472
20731
|
/**
|
|
@@ -20518,7 +20777,7 @@ class EmailsApi {
|
|
|
20518
20777
|
/**
|
|
20519
20778
|
* Emails service.
|
|
20520
20779
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20521
|
-
* @version
|
|
20780
|
+
* @version 197.0.0
|
|
20522
20781
|
*/
|
|
20523
20782
|
|
|
20524
20783
|
/**
|
|
@@ -20579,11 +20838,162 @@ class EmailsApi {
|
|
|
20579
20838
|
|
|
20580
20839
|
}
|
|
20581
20840
|
|
|
20841
|
+
class EmployeeEngagementApi {
|
|
20842
|
+
/**
|
|
20843
|
+
* EmployeeEngagement service.
|
|
20844
|
+
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20845
|
+
* @version 197.0.0
|
|
20846
|
+
*/
|
|
20847
|
+
|
|
20848
|
+
/**
|
|
20849
|
+
* Constructs a new EmployeeEngagementApi.
|
|
20850
|
+
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20851
|
+
* @class
|
|
20852
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20853
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20854
|
+
*/
|
|
20855
|
+
constructor(apiClient) {
|
|
20856
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
20857
|
+
}
|
|
20858
|
+
|
|
20859
|
+
|
|
20860
|
+
/**
|
|
20861
|
+
* Deletes a celebration
|
|
20862
|
+
*
|
|
20863
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20864
|
+
*/
|
|
20865
|
+
deleteEmployeeengagementCelebration(celebrationId) {
|
|
20866
|
+
// verify the required parameter 'celebrationId' is set
|
|
20867
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20868
|
+
throw 'Missing the required parameter "celebrationId" when calling deleteEmployeeengagementCelebration';
|
|
20869
|
+
}
|
|
20870
|
+
|
|
20871
|
+
return this.apiClient.callApi(
|
|
20872
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20873
|
+
'DELETE',
|
|
20874
|
+
{ 'celebrationId': celebrationId },
|
|
20875
|
+
{ },
|
|
20876
|
+
{ },
|
|
20877
|
+
{ },
|
|
20878
|
+
null,
|
|
20879
|
+
['PureCloud OAuth'],
|
|
20880
|
+
['application/json'],
|
|
20881
|
+
['application/json']
|
|
20882
|
+
);
|
|
20883
|
+
}
|
|
20884
|
+
|
|
20885
|
+
/**
|
|
20886
|
+
* Get all celebrations
|
|
20887
|
+
*
|
|
20888
|
+
* @param {Object} opts Optional parameters
|
|
20889
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
20890
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
20891
|
+
*/
|
|
20892
|
+
getEmployeeengagementCelebrations(opts) {
|
|
20893
|
+
opts = opts || {};
|
|
20894
|
+
|
|
20895
|
+
|
|
20896
|
+
return this.apiClient.callApi(
|
|
20897
|
+
'/api/v2/employeeengagement/celebrations',
|
|
20898
|
+
'GET',
|
|
20899
|
+
{ },
|
|
20900
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
20901
|
+
{ },
|
|
20902
|
+
{ },
|
|
20903
|
+
null,
|
|
20904
|
+
['PureCloud OAuth'],
|
|
20905
|
+
['application/json'],
|
|
20906
|
+
['application/json']
|
|
20907
|
+
);
|
|
20908
|
+
}
|
|
20909
|
+
|
|
20910
|
+
/**
|
|
20911
|
+
* Gets a single recognition
|
|
20912
|
+
*
|
|
20913
|
+
* @param {String} recognitionId The Recognition ID
|
|
20914
|
+
*/
|
|
20915
|
+
getEmployeeengagementRecognition(recognitionId) {
|
|
20916
|
+
// verify the required parameter 'recognitionId' is set
|
|
20917
|
+
if (recognitionId === undefined || recognitionId === null) {
|
|
20918
|
+
throw 'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';
|
|
20919
|
+
}
|
|
20920
|
+
|
|
20921
|
+
return this.apiClient.callApi(
|
|
20922
|
+
'/api/v2/employeeengagement/recognitions/{recognitionId}',
|
|
20923
|
+
'GET',
|
|
20924
|
+
{ 'recognitionId': recognitionId },
|
|
20925
|
+
{ },
|
|
20926
|
+
{ },
|
|
20927
|
+
{ },
|
|
20928
|
+
null,
|
|
20929
|
+
['PureCloud OAuth'],
|
|
20930
|
+
['application/json'],
|
|
20931
|
+
['application/json']
|
|
20932
|
+
);
|
|
20933
|
+
}
|
|
20934
|
+
|
|
20935
|
+
/**
|
|
20936
|
+
* Set a state for a celebration
|
|
20937
|
+
*
|
|
20938
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20939
|
+
* @param {Object} body Patch Celebration state
|
|
20940
|
+
*/
|
|
20941
|
+
patchEmployeeengagementCelebration(celebrationId, body) {
|
|
20942
|
+
// verify the required parameter 'celebrationId' is set
|
|
20943
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20944
|
+
throw 'Missing the required parameter "celebrationId" when calling patchEmployeeengagementCelebration';
|
|
20945
|
+
}
|
|
20946
|
+
// verify the required parameter 'body' is set
|
|
20947
|
+
if (body === undefined || body === null) {
|
|
20948
|
+
throw 'Missing the required parameter "body" when calling patchEmployeeengagementCelebration';
|
|
20949
|
+
}
|
|
20950
|
+
|
|
20951
|
+
return this.apiClient.callApi(
|
|
20952
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20953
|
+
'PATCH',
|
|
20954
|
+
{ 'celebrationId': celebrationId },
|
|
20955
|
+
{ },
|
|
20956
|
+
{ },
|
|
20957
|
+
{ },
|
|
20958
|
+
body,
|
|
20959
|
+
['PureCloud OAuth'],
|
|
20960
|
+
['application/json'],
|
|
20961
|
+
['application/json']
|
|
20962
|
+
);
|
|
20963
|
+
}
|
|
20964
|
+
|
|
20965
|
+
/**
|
|
20966
|
+
* Creates a recognition
|
|
20967
|
+
*
|
|
20968
|
+
* @param {Object} body Create Recognition
|
|
20969
|
+
*/
|
|
20970
|
+
postEmployeeengagementRecognitions(body) {
|
|
20971
|
+
// verify the required parameter 'body' is set
|
|
20972
|
+
if (body === undefined || body === null) {
|
|
20973
|
+
throw 'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';
|
|
20974
|
+
}
|
|
20975
|
+
|
|
20976
|
+
return this.apiClient.callApi(
|
|
20977
|
+
'/api/v2/employeeengagement/recognitions',
|
|
20978
|
+
'POST',
|
|
20979
|
+
{ },
|
|
20980
|
+
{ },
|
|
20981
|
+
{ },
|
|
20982
|
+
{ },
|
|
20983
|
+
body,
|
|
20984
|
+
['PureCloud OAuth'],
|
|
20985
|
+
['application/json'],
|
|
20986
|
+
['application/json']
|
|
20987
|
+
);
|
|
20988
|
+
}
|
|
20989
|
+
|
|
20990
|
+
}
|
|
20991
|
+
|
|
20582
20992
|
class EventsApi {
|
|
20583
20993
|
/**
|
|
20584
20994
|
* Events service.
|
|
20585
20995
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20586
|
-
* @version
|
|
20996
|
+
* @version 197.0.0
|
|
20587
20997
|
*/
|
|
20588
20998
|
|
|
20589
20999
|
/**
|
|
@@ -20679,7 +21089,7 @@ class ExternalContactsApi {
|
|
|
20679
21089
|
/**
|
|
20680
21090
|
* ExternalContacts service.
|
|
20681
21091
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20682
|
-
* @version
|
|
21092
|
+
* @version 197.0.0
|
|
20683
21093
|
*/
|
|
20684
21094
|
|
|
20685
21095
|
/**
|
|
@@ -20884,7 +21294,7 @@ class ExternalContactsApi {
|
|
|
20884
21294
|
*
|
|
20885
21295
|
* @param {String} contactId ExternalContact ID
|
|
20886
21296
|
* @param {Object} opts Optional parameters
|
|
20887
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21297
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
20888
21298
|
*/
|
|
20889
21299
|
getExternalcontactsContact(contactId, opts) {
|
|
20890
21300
|
opts = opts || {};
|
|
@@ -22200,8 +22610,12 @@ class ExternalContactsApi {
|
|
|
22200
22610
|
* Fetch a contact using an identifier type and value.
|
|
22201
22611
|
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
22202
22612
|
* @param {Object} identifier
|
|
22613
|
+
* @param {Object} opts Optional parameters
|
|
22614
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
22203
22615
|
*/
|
|
22204
|
-
postExternalcontactsIdentifierlookup(identifier) {
|
|
22616
|
+
postExternalcontactsIdentifierlookup(identifier, opts) {
|
|
22617
|
+
opts = opts || {};
|
|
22618
|
+
|
|
22205
22619
|
// verify the required parameter 'identifier' is set
|
|
22206
22620
|
if (identifier === undefined || identifier === null) {
|
|
22207
22621
|
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
@@ -22211,7 +22625,7 @@ class ExternalContactsApi {
|
|
|
22211
22625
|
'/api/v2/externalcontacts/identifierlookup',
|
|
22212
22626
|
'POST',
|
|
22213
22627
|
{ },
|
|
22214
|
-
{
|
|
22628
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
22215
22629
|
{ },
|
|
22216
22630
|
{ },
|
|
22217
22631
|
identifier,
|
|
@@ -22637,7 +23051,7 @@ class FaxApi {
|
|
|
22637
23051
|
/**
|
|
22638
23052
|
* Fax service.
|
|
22639
23053
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22640
|
-
* @version
|
|
23054
|
+
* @version 197.0.0
|
|
22641
23055
|
*/
|
|
22642
23056
|
|
|
22643
23057
|
/**
|
|
@@ -22852,7 +23266,7 @@ class FlowsApi {
|
|
|
22852
23266
|
/**
|
|
22853
23267
|
* Flows service.
|
|
22854
23268
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22855
|
-
* @version
|
|
23269
|
+
* @version 197.0.0
|
|
22856
23270
|
*/
|
|
22857
23271
|
|
|
22858
23272
|
/**
|
|
@@ -23035,7 +23449,7 @@ class GamificationApi {
|
|
|
23035
23449
|
/**
|
|
23036
23450
|
* Gamification service.
|
|
23037
23451
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23038
|
-
* @version
|
|
23452
|
+
* @version 197.0.0
|
|
23039
23453
|
*/
|
|
23040
23454
|
|
|
23041
23455
|
/**
|
|
@@ -25121,7 +25535,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25121
25535
|
/**
|
|
25122
25536
|
* GeneralDataProtectionRegulation service.
|
|
25123
25537
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25124
|
-
* @version
|
|
25538
|
+
* @version 197.0.0
|
|
25125
25539
|
*/
|
|
25126
25540
|
|
|
25127
25541
|
/**
|
|
@@ -25251,7 +25665,7 @@ class GeolocationApi {
|
|
|
25251
25665
|
/**
|
|
25252
25666
|
* Geolocation service.
|
|
25253
25667
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25254
|
-
* @version
|
|
25668
|
+
* @version 197.0.0
|
|
25255
25669
|
*/
|
|
25256
25670
|
|
|
25257
25671
|
/**
|
|
@@ -25382,7 +25796,7 @@ class GreetingsApi {
|
|
|
25382
25796
|
/**
|
|
25383
25797
|
* Greetings service.
|
|
25384
25798
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25385
|
-
* @version
|
|
25799
|
+
* @version 197.0.0
|
|
25386
25800
|
*/
|
|
25387
25801
|
|
|
25388
25802
|
/**
|
|
@@ -25837,7 +26251,7 @@ class GroupsApi {
|
|
|
25837
26251
|
/**
|
|
25838
26252
|
* Groups service.
|
|
25839
26253
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25840
|
-
* @version
|
|
26254
|
+
* @version 197.0.0
|
|
25841
26255
|
*/
|
|
25842
26256
|
|
|
25843
26257
|
/**
|
|
@@ -26356,7 +26770,7 @@ class IdentityProviderApi {
|
|
|
26356
26770
|
/**
|
|
26357
26771
|
* IdentityProvider service.
|
|
26358
26772
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26359
|
-
* @version
|
|
26773
|
+
* @version 197.0.0
|
|
26360
26774
|
*/
|
|
26361
26775
|
|
|
26362
26776
|
/**
|
|
@@ -27217,7 +27631,7 @@ class InfrastructureAsCodeApi {
|
|
|
27217
27631
|
/**
|
|
27218
27632
|
* InfrastructureAsCode service.
|
|
27219
27633
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27220
|
-
* @version
|
|
27634
|
+
* @version 197.0.0
|
|
27221
27635
|
*/
|
|
27222
27636
|
|
|
27223
27637
|
/**
|
|
@@ -27384,7 +27798,7 @@ class IntegrationsApi {
|
|
|
27384
27798
|
/**
|
|
27385
27799
|
* Integrations service.
|
|
27386
27800
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27387
|
-
* @version
|
|
27801
|
+
* @version 197.0.0
|
|
27388
27802
|
*/
|
|
27389
27803
|
|
|
27390
27804
|
/**
|
|
@@ -29736,7 +30150,7 @@ class JourneyApi {
|
|
|
29736
30150
|
/**
|
|
29737
30151
|
* Journey service.
|
|
29738
30152
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29739
|
-
* @version
|
|
30153
|
+
* @version 197.0.0
|
|
29740
30154
|
*/
|
|
29741
30155
|
|
|
29742
30156
|
/**
|
|
@@ -30480,6 +30894,7 @@ class JourneyApi {
|
|
|
30480
30894
|
* @param {Object} opts Optional parameters
|
|
30481
30895
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
30482
30896
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
30897
|
+
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
30483
30898
|
* getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30484
30899
|
*/
|
|
30485
30900
|
getJourneySessionEvents(sessionId, opts) {
|
|
@@ -30494,7 +30909,7 @@ class JourneyApi {
|
|
|
30494
30909
|
'/api/v2/journey/sessions/{sessionId}/events',
|
|
30495
30910
|
'GET',
|
|
30496
30911
|
{ 'sessionId': sessionId },
|
|
30497
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
30912
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'eventType': opts['eventType'] },
|
|
30498
30913
|
{ },
|
|
30499
30914
|
{ },
|
|
30500
30915
|
null,
|
|
@@ -30757,6 +31172,34 @@ class JourneyApi {
|
|
|
30757
31172
|
);
|
|
30758
31173
|
}
|
|
30759
31174
|
|
|
31175
|
+
/**
|
|
31176
|
+
* Get the jobs for an organization.
|
|
31177
|
+
*
|
|
31178
|
+
* @param {Object} opts Optional parameters
|
|
31179
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
31180
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
31181
|
+
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
31182
|
+
* @param {String} opts.statuses Job statuses to filter for
|
|
31183
|
+
* getJourneyViewsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31184
|
+
*/
|
|
31185
|
+
getJourneyViewsJobs(opts) {
|
|
31186
|
+
opts = opts || {};
|
|
31187
|
+
|
|
31188
|
+
|
|
31189
|
+
return this.apiClient.callApi(
|
|
31190
|
+
'/api/v2/journey/views/jobs',
|
|
31191
|
+
'GET',
|
|
31192
|
+
{ },
|
|
31193
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'interval': opts['interval'],'statuses': opts['statuses'] },
|
|
31194
|
+
{ },
|
|
31195
|
+
{ },
|
|
31196
|
+
null,
|
|
31197
|
+
['PureCloud OAuth'],
|
|
31198
|
+
['application/json'],
|
|
31199
|
+
['application/json']
|
|
31200
|
+
);
|
|
31201
|
+
}
|
|
31202
|
+
|
|
30760
31203
|
/**
|
|
30761
31204
|
* Update single action map.
|
|
30762
31205
|
*
|
|
@@ -31325,7 +31768,7 @@ class KnowledgeApi {
|
|
|
31325
31768
|
/**
|
|
31326
31769
|
* Knowledge service.
|
|
31327
31770
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31328
|
-
* @version
|
|
31771
|
+
* @version 197.0.0
|
|
31329
31772
|
*/
|
|
31330
31773
|
|
|
31331
31774
|
/**
|
|
@@ -34569,7 +35012,7 @@ class LanguageUnderstandingApi {
|
|
|
34569
35012
|
/**
|
|
34570
35013
|
* LanguageUnderstanding service.
|
|
34571
35014
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34572
|
-
* @version
|
|
35015
|
+
* @version 197.0.0
|
|
34573
35016
|
*/
|
|
34574
35017
|
|
|
34575
35018
|
/**
|
|
@@ -35603,7 +36046,7 @@ class LanguagesApi {
|
|
|
35603
36046
|
/**
|
|
35604
36047
|
* Languages service.
|
|
35605
36048
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35606
|
-
* @version
|
|
36049
|
+
* @version 197.0.0
|
|
35607
36050
|
*/
|
|
35608
36051
|
|
|
35609
36052
|
/**
|
|
@@ -35825,7 +36268,7 @@ class LearningApi {
|
|
|
35825
36268
|
/**
|
|
35826
36269
|
* Learning service.
|
|
35827
36270
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35828
|
-
* @version
|
|
36271
|
+
* @version 197.0.0
|
|
35829
36272
|
*/
|
|
35830
36273
|
|
|
35831
36274
|
/**
|
|
@@ -35926,6 +36369,7 @@ class LearningApi {
|
|
|
35926
36369
|
* @param {String} stepId The ID of Learning Assignment Step
|
|
35927
36370
|
* @param {Object} opts Optional parameters
|
|
35928
36371
|
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
36372
|
+
* @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
|
|
35929
36373
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35930
36374
|
*/
|
|
35931
36375
|
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
@@ -35944,7 +36388,7 @@ class LearningApi {
|
|
|
35944
36388
|
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35945
36389
|
'GET',
|
|
35946
36390
|
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35947
|
-
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
36391
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'defaultShareableContentObject': opts['defaultShareableContentObject'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35948
36392
|
{ },
|
|
35949
36393
|
{ },
|
|
35950
36394
|
null,
|
|
@@ -36853,7 +37297,7 @@ class LicenseApi {
|
|
|
36853
37297
|
/**
|
|
36854
37298
|
* License service.
|
|
36855
37299
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36856
|
-
* @version
|
|
37300
|
+
* @version 197.0.0
|
|
36857
37301
|
*/
|
|
36858
37302
|
|
|
36859
37303
|
/**
|
|
@@ -37091,7 +37535,7 @@ class LocationsApi {
|
|
|
37091
37535
|
/**
|
|
37092
37536
|
* Locations service.
|
|
37093
37537
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37094
|
-
* @version
|
|
37538
|
+
* @version 197.0.0
|
|
37095
37539
|
*/
|
|
37096
37540
|
|
|
37097
37541
|
/**
|
|
@@ -37327,7 +37771,7 @@ class LogCaptureApi {
|
|
|
37327
37771
|
/**
|
|
37328
37772
|
* LogCapture service.
|
|
37329
37773
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37330
|
-
* @version
|
|
37774
|
+
* @version 197.0.0
|
|
37331
37775
|
*/
|
|
37332
37776
|
|
|
37333
37777
|
/**
|
|
@@ -37527,7 +37971,7 @@ class MessagingApi {
|
|
|
37527
37971
|
/**
|
|
37528
37972
|
* Messaging service.
|
|
37529
37973
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37530
|
-
* @version
|
|
37974
|
+
* @version 197.0.0
|
|
37531
37975
|
*/
|
|
37532
37976
|
|
|
37533
37977
|
/**
|
|
@@ -37886,7 +38330,7 @@ class MobileDevicesApi {
|
|
|
37886
38330
|
/**
|
|
37887
38331
|
* MobileDevices service.
|
|
37888
38332
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37889
|
-
* @version
|
|
38333
|
+
* @version 197.0.0
|
|
37890
38334
|
*/
|
|
37891
38335
|
|
|
37892
38336
|
/**
|
|
@@ -38037,7 +38481,7 @@ class NotificationsApi {
|
|
|
38037
38481
|
/**
|
|
38038
38482
|
* Notifications service.
|
|
38039
38483
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38040
|
-
* @version
|
|
38484
|
+
* @version 197.0.0
|
|
38041
38485
|
*/
|
|
38042
38486
|
|
|
38043
38487
|
/**
|
|
@@ -38270,7 +38714,7 @@ class OAuthApi {
|
|
|
38270
38714
|
/**
|
|
38271
38715
|
* OAuth service.
|
|
38272
38716
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38273
|
-
* @version
|
|
38717
|
+
* @version 197.0.0
|
|
38274
38718
|
*/
|
|
38275
38719
|
|
|
38276
38720
|
/**
|
|
@@ -38636,7 +39080,7 @@ class ObjectsApi {
|
|
|
38636
39080
|
/**
|
|
38637
39081
|
* Objects service.
|
|
38638
39082
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38639
|
-
* @version
|
|
39083
|
+
* @version 197.0.0
|
|
38640
39084
|
*/
|
|
38641
39085
|
|
|
38642
39086
|
/**
|
|
@@ -38906,7 +39350,7 @@ class OperationalEventsApi {
|
|
|
38906
39350
|
/**
|
|
38907
39351
|
* OperationalEvents service.
|
|
38908
39352
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38909
|
-
* @version
|
|
39353
|
+
* @version 197.0.0
|
|
38910
39354
|
*/
|
|
38911
39355
|
|
|
38912
39356
|
/**
|
|
@@ -38972,7 +39416,7 @@ class OrganizationApi {
|
|
|
38972
39416
|
/**
|
|
38973
39417
|
* Organization service.
|
|
38974
39418
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38975
|
-
* @version
|
|
39419
|
+
* @version 197.0.0
|
|
38976
39420
|
*/
|
|
38977
39421
|
|
|
38978
39422
|
/**
|
|
@@ -39447,7 +39891,7 @@ class OrganizationAuthorizationApi {
|
|
|
39447
39891
|
/**
|
|
39448
39892
|
* OrganizationAuthorization service.
|
|
39449
39893
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39450
|
-
* @version
|
|
39894
|
+
* @version 197.0.0
|
|
39451
39895
|
*/
|
|
39452
39896
|
|
|
39453
39897
|
/**
|
|
@@ -40794,7 +41238,7 @@ class OutboundApi {
|
|
|
40794
41238
|
/**
|
|
40795
41239
|
* Outbound service.
|
|
40796
41240
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40797
|
-
* @version
|
|
41241
|
+
* @version 197.0.0
|
|
40798
41242
|
*/
|
|
40799
41243
|
|
|
40800
41244
|
/**
|
|
@@ -43410,6 +43854,36 @@ class OutboundApi {
|
|
|
43410
43854
|
);
|
|
43411
43855
|
}
|
|
43412
43856
|
|
|
43857
|
+
/**
|
|
43858
|
+
* Update a campaign.
|
|
43859
|
+
*
|
|
43860
|
+
* @param {String} campaignId Campaign ID
|
|
43861
|
+
* @param {Object} body CampaignPatchRequest
|
|
43862
|
+
*/
|
|
43863
|
+
patchOutboundCampaign(campaignId, body) {
|
|
43864
|
+
// verify the required parameter 'campaignId' is set
|
|
43865
|
+
if (campaignId === undefined || campaignId === null) {
|
|
43866
|
+
throw 'Missing the required parameter "campaignId" when calling patchOutboundCampaign';
|
|
43867
|
+
}
|
|
43868
|
+
// verify the required parameter 'body' is set
|
|
43869
|
+
if (body === undefined || body === null) {
|
|
43870
|
+
throw 'Missing the required parameter "body" when calling patchOutboundCampaign';
|
|
43871
|
+
}
|
|
43872
|
+
|
|
43873
|
+
return this.apiClient.callApi(
|
|
43874
|
+
'/api/v2/outbound/campaigns/{campaignId}',
|
|
43875
|
+
'PATCH',
|
|
43876
|
+
{ 'campaignId': campaignId },
|
|
43877
|
+
{ },
|
|
43878
|
+
{ },
|
|
43879
|
+
{ },
|
|
43880
|
+
body,
|
|
43881
|
+
['PureCloud OAuth'],
|
|
43882
|
+
['application/json'],
|
|
43883
|
+
['application/json']
|
|
43884
|
+
);
|
|
43885
|
+
}
|
|
43886
|
+
|
|
43413
43887
|
/**
|
|
43414
43888
|
* Add entries to or delete entries from a DNC list.
|
|
43415
43889
|
* Only Internal DNC lists may be deleted from
|
|
@@ -43550,40 +44024,6 @@ class OutboundApi {
|
|
|
43550
44024
|
);
|
|
43551
44025
|
}
|
|
43552
44026
|
|
|
43553
|
-
/**
|
|
43554
|
-
* Retrieves audits for dialer. (Deprecated)
|
|
43555
|
-
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
43556
|
-
* @param {Object} body AuditSearch
|
|
43557
|
-
* @param {Object} opts Optional parameters
|
|
43558
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43559
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43560
|
-
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
43561
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
43562
|
-
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
43563
|
-
* @deprecated
|
|
43564
|
-
*/
|
|
43565
|
-
postOutboundAudits(body, opts) {
|
|
43566
|
-
opts = opts || {};
|
|
43567
|
-
|
|
43568
|
-
// verify the required parameter 'body' is set
|
|
43569
|
-
if (body === undefined || body === null) {
|
|
43570
|
-
throw 'Missing the required parameter "body" when calling postOutboundAudits';
|
|
43571
|
-
}
|
|
43572
|
-
|
|
43573
|
-
return this.apiClient.callApi(
|
|
43574
|
-
'/api/v2/outbound/audits',
|
|
43575
|
-
'POST',
|
|
43576
|
-
{ },
|
|
43577
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'facetsOnly': opts['facetsOnly'] },
|
|
43578
|
-
{ },
|
|
43579
|
-
{ },
|
|
43580
|
-
body,
|
|
43581
|
-
['PureCloud OAuth'],
|
|
43582
|
-
['application/json'],
|
|
43583
|
-
['application/json']
|
|
43584
|
-
);
|
|
43585
|
-
}
|
|
43586
|
-
|
|
43587
44027
|
/**
|
|
43588
44028
|
* Create callable time set
|
|
43589
44029
|
*
|
|
@@ -45160,7 +45600,7 @@ class PresenceApi {
|
|
|
45160
45600
|
/**
|
|
45161
45601
|
* Presence service.
|
|
45162
45602
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45163
|
-
* @version
|
|
45603
|
+
* @version 197.0.0
|
|
45164
45604
|
*/
|
|
45165
45605
|
|
|
45166
45606
|
/**
|
|
@@ -45904,7 +46344,7 @@ class ProcessAutomationApi {
|
|
|
45904
46344
|
/**
|
|
45905
46345
|
* ProcessAutomation service.
|
|
45906
46346
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45907
|
-
* @version
|
|
46347
|
+
* @version 197.0.0
|
|
45908
46348
|
*/
|
|
45909
46349
|
|
|
45910
46350
|
/**
|
|
@@ -46143,7 +46583,7 @@ class QualityApi {
|
|
|
46143
46583
|
/**
|
|
46144
46584
|
* Quality service.
|
|
46145
46585
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46146
|
-
* @version
|
|
46586
|
+
* @version 197.0.0
|
|
46147
46587
|
*/
|
|
46148
46588
|
|
|
46149
46589
|
/**
|
|
@@ -46635,9 +47075,7 @@ class QualityApi {
|
|
|
46635
47075
|
* @param {Object} opts Optional parameters
|
|
46636
47076
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46637
47077
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
46638
|
-
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
46639
47078
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
46640
|
-
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
46641
47079
|
* @param {String} opts.previousPage Previous page token
|
|
46642
47080
|
* @param {String} opts.conversationId conversationId specified
|
|
46643
47081
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -46663,7 +47101,7 @@ class QualityApi {
|
|
|
46663
47101
|
'/api/v2/quality/evaluations/query',
|
|
46664
47102
|
'GET',
|
|
46665
47103
|
{ },
|
|
46666
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
47104
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'agentTeamId': opts['agentTeamId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
|
|
46667
47105
|
{ },
|
|
46668
47106
|
{ },
|
|
46669
47107
|
null,
|
|
@@ -47900,7 +48338,7 @@ class RecordingApi {
|
|
|
47900
48338
|
/**
|
|
47901
48339
|
* Recording service.
|
|
47902
48340
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47903
|
-
* @version
|
|
48341
|
+
* @version 197.0.0
|
|
47904
48342
|
*/
|
|
47905
48343
|
|
|
47906
48344
|
/**
|
|
@@ -49558,7 +49996,7 @@ class ResponseManagementApi {
|
|
|
49558
49996
|
/**
|
|
49559
49997
|
* ResponseManagement service.
|
|
49560
49998
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49561
|
-
* @version
|
|
49999
|
+
* @version 197.0.0
|
|
49562
50000
|
*/
|
|
49563
50001
|
|
|
49564
50002
|
/**
|
|
@@ -50068,7 +50506,7 @@ class RoutingApi {
|
|
|
50068
50506
|
/**
|
|
50069
50507
|
* Routing service.
|
|
50070
50508
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50071
|
-
* @version
|
|
50509
|
+
* @version 197.0.0
|
|
50072
50510
|
*/
|
|
50073
50511
|
|
|
50074
50512
|
/**
|
|
@@ -51979,6 +52417,7 @@ class RoutingApi {
|
|
|
51979
52417
|
* @param {Object} opts.sortOrder Sort order
|
|
51980
52418
|
* @param {String} opts.language A language tag (which is sometimes referred to as a locale identifier) to use to localize country field and sort operations (default to en-US)
|
|
51981
52419
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
52420
|
+
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
51982
52421
|
*/
|
|
51983
52422
|
getRoutingSmsPhonenumbers(opts) {
|
|
51984
52423
|
opts = opts || {};
|
|
@@ -51988,7 +52427,7 @@ class RoutingApi {
|
|
|
51988
52427
|
'/api/v2/routing/sms/phonenumbers',
|
|
51989
52428
|
'GET',
|
|
51990
52429
|
{ },
|
|
51991
|
-
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'] },
|
|
52430
|
+
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'],'supportedContent.id': opts['supportedContentId'] },
|
|
51992
52431
|
{ },
|
|
51993
52432
|
{ },
|
|
51994
52433
|
null,
|
|
@@ -54041,7 +54480,7 @@ class SCIMApi {
|
|
|
54041
54480
|
/**
|
|
54042
54481
|
* SCIM service.
|
|
54043
54482
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54044
|
-
* @version
|
|
54483
|
+
* @version 197.0.0
|
|
54045
54484
|
*/
|
|
54046
54485
|
|
|
54047
54486
|
/**
|
|
@@ -54918,7 +55357,7 @@ class ScreenRecordingApi {
|
|
|
54918
55357
|
/**
|
|
54919
55358
|
* ScreenRecording service.
|
|
54920
55359
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54921
|
-
* @version
|
|
55360
|
+
* @version 197.0.0
|
|
54922
55361
|
*/
|
|
54923
55362
|
|
|
54924
55363
|
/**
|
|
@@ -54963,7 +55402,7 @@ class ScriptsApi {
|
|
|
54963
55402
|
/**
|
|
54964
55403
|
* Scripts service.
|
|
54965
55404
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54966
|
-
* @version
|
|
55405
|
+
* @version 197.0.0
|
|
54967
55406
|
*/
|
|
54968
55407
|
|
|
54969
55408
|
/**
|
|
@@ -55407,7 +55846,7 @@ class SearchApi {
|
|
|
55407
55846
|
/**
|
|
55408
55847
|
* Search service.
|
|
55409
55848
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55410
|
-
* @version
|
|
55849
|
+
* @version 197.0.0
|
|
55411
55850
|
*/
|
|
55412
55851
|
|
|
55413
55852
|
/**
|
|
@@ -56096,7 +56535,7 @@ class SettingsApi {
|
|
|
56096
56535
|
/**
|
|
56097
56536
|
* Settings service.
|
|
56098
56537
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56099
|
-
* @version
|
|
56538
|
+
* @version 197.0.0
|
|
56100
56539
|
*/
|
|
56101
56540
|
|
|
56102
56541
|
/**
|
|
@@ -56111,6 +56550,31 @@ class SettingsApi {
|
|
|
56111
56550
|
}
|
|
56112
56551
|
|
|
56113
56552
|
|
|
56553
|
+
/**
|
|
56554
|
+
* Delete agent auto answer settings
|
|
56555
|
+
*
|
|
56556
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56557
|
+
*/
|
|
56558
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56559
|
+
// verify the required parameter 'agentId' is set
|
|
56560
|
+
if (agentId === undefined || agentId === null) {
|
|
56561
|
+
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56562
|
+
}
|
|
56563
|
+
|
|
56564
|
+
return this.apiClient.callApi(
|
|
56565
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56566
|
+
'DELETE',
|
|
56567
|
+
{ 'agentId': agentId },
|
|
56568
|
+
{ },
|
|
56569
|
+
{ },
|
|
56570
|
+
{ },
|
|
56571
|
+
null,
|
|
56572
|
+
['PureCloud OAuth'],
|
|
56573
|
+
['application/json'],
|
|
56574
|
+
['application/json']
|
|
56575
|
+
);
|
|
56576
|
+
}
|
|
56577
|
+
|
|
56114
56578
|
/**
|
|
56115
56579
|
* Get email Contact Center settings
|
|
56116
56580
|
*
|
|
@@ -56152,6 +56616,31 @@ class SettingsApi {
|
|
|
56152
56616
|
);
|
|
56153
56617
|
}
|
|
56154
56618
|
|
|
56619
|
+
/**
|
|
56620
|
+
* Get agent auto answer settings
|
|
56621
|
+
*
|
|
56622
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56623
|
+
*/
|
|
56624
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56625
|
+
// verify the required parameter 'agentId' is set
|
|
56626
|
+
if (agentId === undefined || agentId === null) {
|
|
56627
|
+
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56628
|
+
}
|
|
56629
|
+
|
|
56630
|
+
return this.apiClient.callApi(
|
|
56631
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56632
|
+
'GET',
|
|
56633
|
+
{ 'agentId': agentId },
|
|
56634
|
+
{ },
|
|
56635
|
+
{ },
|
|
56636
|
+
{ },
|
|
56637
|
+
null,
|
|
56638
|
+
['PureCloud OAuth'],
|
|
56639
|
+
['application/json'],
|
|
56640
|
+
['application/json']
|
|
56641
|
+
);
|
|
56642
|
+
}
|
|
56643
|
+
|
|
56155
56644
|
/**
|
|
56156
56645
|
* Patch email Contact Center settings
|
|
56157
56646
|
*
|
|
@@ -56202,13 +56691,73 @@ class SettingsApi {
|
|
|
56202
56691
|
);
|
|
56203
56692
|
}
|
|
56204
56693
|
|
|
56694
|
+
/**
|
|
56695
|
+
* Update agent auto answer settings
|
|
56696
|
+
*
|
|
56697
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56698
|
+
* @param {Object} body AutoAnswerSettings
|
|
56699
|
+
*/
|
|
56700
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56701
|
+
// verify the required parameter 'agentId' is set
|
|
56702
|
+
if (agentId === undefined || agentId === null) {
|
|
56703
|
+
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56704
|
+
}
|
|
56705
|
+
// verify the required parameter 'body' is set
|
|
56706
|
+
if (body === undefined || body === null) {
|
|
56707
|
+
throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56708
|
+
}
|
|
56709
|
+
|
|
56710
|
+
return this.apiClient.callApi(
|
|
56711
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56712
|
+
'PATCH',
|
|
56713
|
+
{ 'agentId': agentId },
|
|
56714
|
+
{ },
|
|
56715
|
+
{ },
|
|
56716
|
+
{ },
|
|
56717
|
+
body,
|
|
56718
|
+
['PureCloud OAuth'],
|
|
56719
|
+
['application/json'],
|
|
56720
|
+
['application/json']
|
|
56721
|
+
);
|
|
56722
|
+
}
|
|
56723
|
+
|
|
56724
|
+
/**
|
|
56725
|
+
* Set agent auto answer settings
|
|
56726
|
+
*
|
|
56727
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56728
|
+
* @param {Object} body AutoAnswerSettings
|
|
56729
|
+
*/
|
|
56730
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56731
|
+
// verify the required parameter 'agentId' is set
|
|
56732
|
+
if (agentId === undefined || agentId === null) {
|
|
56733
|
+
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56734
|
+
}
|
|
56735
|
+
// verify the required parameter 'body' is set
|
|
56736
|
+
if (body === undefined || body === null) {
|
|
56737
|
+
throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56738
|
+
}
|
|
56739
|
+
|
|
56740
|
+
return this.apiClient.callApi(
|
|
56741
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56742
|
+
'PUT',
|
|
56743
|
+
{ 'agentId': agentId },
|
|
56744
|
+
{ },
|
|
56745
|
+
{ },
|
|
56746
|
+
{ },
|
|
56747
|
+
body,
|
|
56748
|
+
['PureCloud OAuth'],
|
|
56749
|
+
['application/json'],
|
|
56750
|
+
['application/json']
|
|
56751
|
+
);
|
|
56752
|
+
}
|
|
56753
|
+
|
|
56205
56754
|
}
|
|
56206
56755
|
|
|
56207
56756
|
class SpeechTextAnalyticsApi {
|
|
56208
56757
|
/**
|
|
56209
56758
|
* SpeechTextAnalytics service.
|
|
56210
56759
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56211
|
-
* @version
|
|
56760
|
+
* @version 197.0.0
|
|
56212
56761
|
*/
|
|
56213
56762
|
|
|
56214
56763
|
/**
|
|
@@ -57486,7 +58035,7 @@ class StationsApi {
|
|
|
57486
58035
|
/**
|
|
57487
58036
|
* Stations service.
|
|
57488
58037
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57489
|
-
* @version
|
|
58038
|
+
* @version 197.0.0
|
|
57490
58039
|
*/
|
|
57491
58040
|
|
|
57492
58041
|
/**
|
|
@@ -57588,7 +58137,7 @@ class SuggestApi {
|
|
|
57588
58137
|
/**
|
|
57589
58138
|
* Suggest service.
|
|
57590
58139
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57591
|
-
* @version
|
|
58140
|
+
* @version 197.0.0
|
|
57592
58141
|
*/
|
|
57593
58142
|
|
|
57594
58143
|
/**
|
|
@@ -57727,7 +58276,7 @@ class TaskManagementApi {
|
|
|
57727
58276
|
/**
|
|
57728
58277
|
* TaskManagement service.
|
|
57729
58278
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57730
|
-
* @version
|
|
58279
|
+
* @version 197.0.0
|
|
57731
58280
|
*/
|
|
57732
58281
|
|
|
57733
58282
|
/**
|
|
@@ -59075,7 +59624,7 @@ class TeamsApi {
|
|
|
59075
59624
|
/**
|
|
59076
59625
|
* Teams service.
|
|
59077
59626
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59078
|
-
* @version
|
|
59627
|
+
* @version 197.0.0
|
|
59079
59628
|
*/
|
|
59080
59629
|
|
|
59081
59630
|
/**
|
|
@@ -59376,7 +59925,7 @@ class TelephonyApi {
|
|
|
59376
59925
|
/**
|
|
59377
59926
|
* Telephony service.
|
|
59378
59927
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59379
|
-
* @version
|
|
59928
|
+
* @version 197.0.0
|
|
59380
59929
|
*/
|
|
59381
59930
|
|
|
59382
59931
|
/**
|
|
@@ -59558,7 +60107,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
59558
60107
|
/**
|
|
59559
60108
|
* TelephonyProvidersEdge service.
|
|
59560
60109
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59561
|
-
* @version
|
|
60110
|
+
* @version 197.0.0
|
|
59562
60111
|
*/
|
|
59563
60112
|
|
|
59564
60113
|
/**
|
|
@@ -62886,7 +63435,7 @@ class TextbotsApi {
|
|
|
62886
63435
|
/**
|
|
62887
63436
|
* Textbots service.
|
|
62888
63437
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62889
|
-
* @version
|
|
63438
|
+
* @version 197.0.0
|
|
62890
63439
|
*/
|
|
62891
63440
|
|
|
62892
63441
|
/**
|
|
@@ -63014,7 +63563,7 @@ class TokensApi {
|
|
|
63014
63563
|
/**
|
|
63015
63564
|
* Tokens service.
|
|
63016
63565
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63017
|
-
* @version
|
|
63566
|
+
* @version 197.0.0
|
|
63018
63567
|
*/
|
|
63019
63568
|
|
|
63020
63569
|
/**
|
|
@@ -63168,7 +63717,7 @@ class UploadsApi {
|
|
|
63168
63717
|
/**
|
|
63169
63718
|
* Uploads service.
|
|
63170
63719
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63171
|
-
* @version
|
|
63720
|
+
* @version 197.0.0
|
|
63172
63721
|
*/
|
|
63173
63722
|
|
|
63174
63723
|
/**
|
|
@@ -63437,7 +63986,7 @@ class UsageApi {
|
|
|
63437
63986
|
/**
|
|
63438
63987
|
* Usage service.
|
|
63439
63988
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63440
|
-
* @version
|
|
63989
|
+
* @version 197.0.0
|
|
63441
63990
|
*/
|
|
63442
63991
|
|
|
63443
63992
|
/**
|
|
@@ -63652,7 +64201,7 @@ class UserRecordingsApi {
|
|
|
63652
64201
|
/**
|
|
63653
64202
|
* UserRecordings service.
|
|
63654
64203
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63655
|
-
* @version
|
|
64204
|
+
* @version 197.0.0
|
|
63656
64205
|
*/
|
|
63657
64206
|
|
|
63658
64207
|
/**
|
|
@@ -63837,7 +64386,7 @@ class UsersApi {
|
|
|
63837
64386
|
/**
|
|
63838
64387
|
* Users service.
|
|
63839
64388
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63840
|
-
* @version
|
|
64389
|
+
* @version 197.0.0
|
|
63841
64390
|
*/
|
|
63842
64391
|
|
|
63843
64392
|
/**
|
|
@@ -66495,7 +67044,7 @@ class UtilitiesApi {
|
|
|
66495
67044
|
/**
|
|
66496
67045
|
* Utilities service.
|
|
66497
67046
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66498
|
-
* @version
|
|
67047
|
+
* @version 197.0.0
|
|
66499
67048
|
*/
|
|
66500
67049
|
|
|
66501
67050
|
/**
|
|
@@ -66606,7 +67155,7 @@ class VoicemailApi {
|
|
|
66606
67155
|
/**
|
|
66607
67156
|
* Voicemail service.
|
|
66608
67157
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66609
|
-
* @version
|
|
67158
|
+
* @version 197.0.0
|
|
66610
67159
|
*/
|
|
66611
67160
|
|
|
66612
67161
|
/**
|
|
@@ -67273,7 +67822,7 @@ class WebChatApi {
|
|
|
67273
67822
|
/**
|
|
67274
67823
|
* WebChat service.
|
|
67275
67824
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67276
|
-
* @version
|
|
67825
|
+
* @version 197.0.0
|
|
67277
67826
|
*/
|
|
67278
67827
|
|
|
67279
67828
|
/**
|
|
@@ -67824,7 +68373,7 @@ class WebDeploymentsApi {
|
|
|
67824
68373
|
/**
|
|
67825
68374
|
* WebDeployments service.
|
|
67826
68375
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67827
|
-
* @version
|
|
68376
|
+
* @version 197.0.0
|
|
67828
68377
|
*/
|
|
67829
68378
|
|
|
67830
68379
|
/**
|
|
@@ -68351,7 +68900,7 @@ class WebMessagingApi {
|
|
|
68351
68900
|
/**
|
|
68352
68901
|
* WebMessaging service.
|
|
68353
68902
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68354
|
-
* @version
|
|
68903
|
+
* @version 197.0.0
|
|
68355
68904
|
*/
|
|
68356
68905
|
|
|
68357
68906
|
/**
|
|
@@ -68397,7 +68946,7 @@ class WidgetsApi {
|
|
|
68397
68946
|
/**
|
|
68398
68947
|
* Widgets service.
|
|
68399
68948
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68400
|
-
* @version
|
|
68949
|
+
* @version 197.0.0
|
|
68401
68950
|
*/
|
|
68402
68951
|
|
|
68403
68952
|
/**
|
|
@@ -68543,7 +69092,7 @@ class WorkforceManagementApi {
|
|
|
68543
69092
|
/**
|
|
68544
69093
|
* WorkforceManagement service.
|
|
68545
69094
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68546
|
-
* @version
|
|
69095
|
+
* @version 197.0.0
|
|
68547
69096
|
*/
|
|
68548
69097
|
|
|
68549
69098
|
/**
|
|
@@ -74456,7 +75005,7 @@ class WorkforceManagementApi {
|
|
|
74456
75005
|
* </pre>
|
|
74457
75006
|
* </p>
|
|
74458
75007
|
* @module purecloud-platform-client-v2/index
|
|
74459
|
-
* @version
|
|
75008
|
+
* @version 197.0.0
|
|
74460
75009
|
*/
|
|
74461
75010
|
class platformClient {
|
|
74462
75011
|
constructor() {
|
|
@@ -74470,6 +75019,11 @@ class platformClient {
|
|
|
74470
75019
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
74471
75020
|
*/
|
|
74472
75021
|
this.ApiClientClass = ApiClient;
|
|
75022
|
+
/**
|
|
75023
|
+
* The AgentUIApi service constructor.
|
|
75024
|
+
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|
|
75025
|
+
*/
|
|
75026
|
+
this.AgentUIApi = AgentUIApi;
|
|
74473
75027
|
/**
|
|
74474
75028
|
* The AlertingApi service constructor.
|
|
74475
75029
|
* @property {module:purecloud-platform-client-v2/api/AlertingApi}
|
|
@@ -74540,6 +75094,11 @@ class platformClient {
|
|
|
74540
75094
|
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
74541
75095
|
*/
|
|
74542
75096
|
this.EmailsApi = EmailsApi;
|
|
75097
|
+
/**
|
|
75098
|
+
* The EmployeeEngagementApi service constructor.
|
|
75099
|
+
* @property {module:purecloud-platform-client-v2/api/EmployeeEngagementApi}
|
|
75100
|
+
*/
|
|
75101
|
+
this.EmployeeEngagementApi = EmployeeEngagementApi;
|
|
74543
75102
|
/**
|
|
74544
75103
|
* The EventsApi service constructor.
|
|
74545
75104
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|