purecloud-platform-client-v2 196.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 +649 -116
- package/dist/web-amd/purecloud-platform-client-v2.js +649 -116
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +234 -98
- package/dist/web-cjs/purecloud-platform-client-v2.js +235 -98
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +271 -92
- 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 +3 -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 +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 +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
|
@@ -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 197.0.0
|
|
406
406
|
*/
|
|
407
407
|
class ApiClient {
|
|
408
408
|
/**
|
|
@@ -1820,11 +1820,142 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1820
1820
|
}
|
|
1821
1821
|
}
|
|
1822
1822
|
|
|
1823
|
+
class AgentUIApi {
|
|
1824
|
+
/**
|
|
1825
|
+
* AgentUI service.
|
|
1826
|
+
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1827
|
+
* @version 197.0.0
|
|
1828
|
+
*/
|
|
1829
|
+
|
|
1830
|
+
/**
|
|
1831
|
+
* Constructs a new AgentUIApi.
|
|
1832
|
+
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
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 agent auto answer settings
|
|
1844
|
+
*
|
|
1845
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1846
|
+
*/
|
|
1847
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
1848
|
+
// verify the required parameter 'agentId' is set
|
|
1849
|
+
if (agentId === undefined || agentId === null) {
|
|
1850
|
+
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1851
|
+
}
|
|
1852
|
+
|
|
1853
|
+
return this.apiClient.callApi(
|
|
1854
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1855
|
+
'DELETE',
|
|
1856
|
+
{ 'agentId': agentId },
|
|
1857
|
+
{ },
|
|
1858
|
+
{ },
|
|
1859
|
+
{ },
|
|
1860
|
+
null,
|
|
1861
|
+
['PureCloud OAuth'],
|
|
1862
|
+
['application/json'],
|
|
1863
|
+
['application/json']
|
|
1864
|
+
);
|
|
1865
|
+
}
|
|
1866
|
+
|
|
1867
|
+
/**
|
|
1868
|
+
* Get agent auto answer settings
|
|
1869
|
+
*
|
|
1870
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1871
|
+
*/
|
|
1872
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
1873
|
+
// verify the required parameter 'agentId' is set
|
|
1874
|
+
if (agentId === undefined || agentId === null) {
|
|
1875
|
+
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1876
|
+
}
|
|
1877
|
+
|
|
1878
|
+
return this.apiClient.callApi(
|
|
1879
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1880
|
+
'GET',
|
|
1881
|
+
{ 'agentId': agentId },
|
|
1882
|
+
{ },
|
|
1883
|
+
{ },
|
|
1884
|
+
{ },
|
|
1885
|
+
null,
|
|
1886
|
+
['PureCloud OAuth'],
|
|
1887
|
+
['application/json'],
|
|
1888
|
+
['application/json']
|
|
1889
|
+
);
|
|
1890
|
+
}
|
|
1891
|
+
|
|
1892
|
+
/**
|
|
1893
|
+
* Update agent auto answer settings
|
|
1894
|
+
*
|
|
1895
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1896
|
+
* @param {Object} body AutoAnswerSettings
|
|
1897
|
+
*/
|
|
1898
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
1899
|
+
// verify the required parameter 'agentId' is set
|
|
1900
|
+
if (agentId === undefined || agentId === null) {
|
|
1901
|
+
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1902
|
+
}
|
|
1903
|
+
// verify the required parameter 'body' is set
|
|
1904
|
+
if (body === undefined || body === null) {
|
|
1905
|
+
throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1906
|
+
}
|
|
1907
|
+
|
|
1908
|
+
return this.apiClient.callApi(
|
|
1909
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1910
|
+
'PATCH',
|
|
1911
|
+
{ 'agentId': agentId },
|
|
1912
|
+
{ },
|
|
1913
|
+
{ },
|
|
1914
|
+
{ },
|
|
1915
|
+
body,
|
|
1916
|
+
['PureCloud OAuth'],
|
|
1917
|
+
['application/json'],
|
|
1918
|
+
['application/json']
|
|
1919
|
+
);
|
|
1920
|
+
}
|
|
1921
|
+
|
|
1922
|
+
/**
|
|
1923
|
+
* Set agent auto answer settings
|
|
1924
|
+
*
|
|
1925
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1926
|
+
* @param {Object} body AutoAnswerSettings
|
|
1927
|
+
*/
|
|
1928
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
1929
|
+
// verify the required parameter 'agentId' is set
|
|
1930
|
+
if (agentId === undefined || agentId === null) {
|
|
1931
|
+
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1932
|
+
}
|
|
1933
|
+
// verify the required parameter 'body' is set
|
|
1934
|
+
if (body === undefined || body === null) {
|
|
1935
|
+
throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1936
|
+
}
|
|
1937
|
+
|
|
1938
|
+
return this.apiClient.callApi(
|
|
1939
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1940
|
+
'PUT',
|
|
1941
|
+
{ 'agentId': agentId },
|
|
1942
|
+
{ },
|
|
1943
|
+
{ },
|
|
1944
|
+
{ },
|
|
1945
|
+
body,
|
|
1946
|
+
['PureCloud OAuth'],
|
|
1947
|
+
['application/json'],
|
|
1948
|
+
['application/json']
|
|
1949
|
+
);
|
|
1950
|
+
}
|
|
1951
|
+
|
|
1952
|
+
}
|
|
1953
|
+
|
|
1823
1954
|
class AlertingApi {
|
|
1824
1955
|
/**
|
|
1825
1956
|
* Alerting service.
|
|
1826
1957
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1827
|
-
* @version
|
|
1958
|
+
* @version 197.0.0
|
|
1828
1959
|
*/
|
|
1829
1960
|
|
|
1830
1961
|
/**
|
|
@@ -2485,7 +2616,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2485
2616
|
/**
|
|
2486
2617
|
* Analytics service.
|
|
2487
2618
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2488
|
-
* @version
|
|
2619
|
+
* @version 197.0.0
|
|
2489
2620
|
*/
|
|
2490
2621
|
|
|
2491
2622
|
/**
|
|
@@ -5097,7 +5228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5097
5228
|
/**
|
|
5098
5229
|
* Architect service.
|
|
5099
5230
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5100
|
-
* @version
|
|
5231
|
+
* @version 197.0.0
|
|
5101
5232
|
*/
|
|
5102
5233
|
|
|
5103
5234
|
/**
|
|
@@ -9243,7 +9374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9243
9374
|
/**
|
|
9244
9375
|
* Audit service.
|
|
9245
9376
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9246
|
-
* @version
|
|
9377
|
+
* @version 197.0.0
|
|
9247
9378
|
*/
|
|
9248
9379
|
|
|
9249
9380
|
/**
|
|
@@ -9443,7 +9574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
9443
9574
|
/**
|
|
9444
9575
|
* Authorization service.
|
|
9445
9576
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9446
|
-
* @version
|
|
9577
|
+
* @version 197.0.0
|
|
9447
9578
|
*/
|
|
9448
9579
|
|
|
9449
9580
|
/**
|
|
@@ -10681,7 +10812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10681
10812
|
/**
|
|
10682
10813
|
* Billing service.
|
|
10683
10814
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10684
|
-
* @version
|
|
10815
|
+
* @version 197.0.0
|
|
10685
10816
|
*/
|
|
10686
10817
|
|
|
10687
10818
|
/**
|
|
@@ -10761,7 +10892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10761
10892
|
/**
|
|
10762
10893
|
* CarrierServices service.
|
|
10763
10894
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10764
|
-
* @version
|
|
10895
|
+
* @version 197.0.0
|
|
10765
10896
|
*/
|
|
10766
10897
|
|
|
10767
10898
|
/**
|
|
@@ -10831,7 +10962,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10831
10962
|
/**
|
|
10832
10963
|
* Chat service.
|
|
10833
10964
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10834
|
-
* @version
|
|
10965
|
+
* @version 197.0.0
|
|
10835
10966
|
*/
|
|
10836
10967
|
|
|
10837
10968
|
/**
|
|
@@ -11767,7 +11898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
11767
11898
|
/**
|
|
11768
11899
|
* Coaching service.
|
|
11769
11900
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11770
|
-
* @version
|
|
11901
|
+
* @version 197.0.0
|
|
11771
11902
|
*/
|
|
11772
11903
|
|
|
11773
11904
|
/**
|
|
@@ -12344,7 +12475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12344
12475
|
/**
|
|
12345
12476
|
* ContentManagement service.
|
|
12346
12477
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12347
|
-
* @version
|
|
12478
|
+
* @version 197.0.0
|
|
12348
12479
|
*/
|
|
12349
12480
|
|
|
12350
12481
|
/**
|
|
@@ -13426,7 +13557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13426
13557
|
/**
|
|
13427
13558
|
* Conversations service.
|
|
13428
13559
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13429
|
-
* @version
|
|
13560
|
+
* @version 197.0.0
|
|
13430
13561
|
*/
|
|
13431
13562
|
|
|
13432
13563
|
/**
|
|
@@ -14145,6 +14276,69 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14145
14276
|
);
|
|
14146
14277
|
}
|
|
14147
14278
|
|
|
14279
|
+
/**
|
|
14280
|
+
* Get Suggestion.
|
|
14281
|
+
*
|
|
14282
|
+
* @param {String} conversationId Conversation ID
|
|
14283
|
+
* @param {String} suggestionId Suggestion ID
|
|
14284
|
+
*/
|
|
14285
|
+
getConversationSuggestion(conversationId, suggestionId) {
|
|
14286
|
+
// verify the required parameter 'conversationId' is set
|
|
14287
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14288
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSuggestion';
|
|
14289
|
+
}
|
|
14290
|
+
// verify the required parameter 'suggestionId' is set
|
|
14291
|
+
if (suggestionId === undefined || suggestionId === null) {
|
|
14292
|
+
throw 'Missing the required parameter "suggestionId" when calling getConversationSuggestion';
|
|
14293
|
+
}
|
|
14294
|
+
|
|
14295
|
+
return this.apiClient.callApi(
|
|
14296
|
+
'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}',
|
|
14297
|
+
'GET',
|
|
14298
|
+
{ 'conversationId': conversationId,'suggestionId': suggestionId },
|
|
14299
|
+
{ },
|
|
14300
|
+
{ },
|
|
14301
|
+
{ },
|
|
14302
|
+
null,
|
|
14303
|
+
['PureCloud OAuth'],
|
|
14304
|
+
['application/json'],
|
|
14305
|
+
['application/json']
|
|
14306
|
+
);
|
|
14307
|
+
}
|
|
14308
|
+
|
|
14309
|
+
/**
|
|
14310
|
+
* Get all suggestions for a conversation.
|
|
14311
|
+
*
|
|
14312
|
+
* @param {String} conversationId Conversation ID
|
|
14313
|
+
* @param {Object} opts Optional parameters
|
|
14314
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
14315
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14316
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14317
|
+
* @param {Object} opts.type Suggestion type to filter by.
|
|
14318
|
+
* @param {Object} opts.state Suggestion state to filter Copilot suggestions.
|
|
14319
|
+
*/
|
|
14320
|
+
getConversationSuggestions(conversationId, opts) {
|
|
14321
|
+
opts = opts || {};
|
|
14322
|
+
|
|
14323
|
+
// verify the required parameter 'conversationId' is set
|
|
14324
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14325
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSuggestions';
|
|
14326
|
+
}
|
|
14327
|
+
|
|
14328
|
+
return this.apiClient.callApi(
|
|
14329
|
+
'/api/v2/conversations/{conversationId}/suggestions',
|
|
14330
|
+
'GET',
|
|
14331
|
+
{ 'conversationId': conversationId },
|
|
14332
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'type': opts['type'],'state': opts['state'] },
|
|
14333
|
+
{ },
|
|
14334
|
+
{ },
|
|
14335
|
+
null,
|
|
14336
|
+
['PureCloud OAuth'],
|
|
14337
|
+
['application/json'],
|
|
14338
|
+
['application/json']
|
|
14339
|
+
);
|
|
14340
|
+
}
|
|
14341
|
+
|
|
14148
14342
|
/**
|
|
14149
14343
|
* Get active conversations for the logged in user
|
|
14150
14344
|
*
|
|
@@ -17960,6 +18154,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17960
18154
|
);
|
|
17961
18155
|
}
|
|
17962
18156
|
|
|
18157
|
+
/**
|
|
18158
|
+
* Save an engagement on the suggestion.
|
|
18159
|
+
*
|
|
18160
|
+
* @param {String} conversationId Conversation ID
|
|
18161
|
+
* @param {String} suggestionId Suggestion ID
|
|
18162
|
+
* @param {Object} body
|
|
18163
|
+
*/
|
|
18164
|
+
postConversationSuggestionEngagement(conversationId, suggestionId, body) {
|
|
18165
|
+
// verify the required parameter 'conversationId' is set
|
|
18166
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18167
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionEngagement';
|
|
18168
|
+
}
|
|
18169
|
+
// verify the required parameter 'suggestionId' is set
|
|
18170
|
+
if (suggestionId === undefined || suggestionId === null) {
|
|
18171
|
+
throw 'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';
|
|
18172
|
+
}
|
|
18173
|
+
// verify the required parameter 'body' is set
|
|
18174
|
+
if (body === undefined || body === null) {
|
|
18175
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionEngagement';
|
|
18176
|
+
}
|
|
18177
|
+
|
|
18178
|
+
return this.apiClient.callApi(
|
|
18179
|
+
'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement',
|
|
18180
|
+
'POST',
|
|
18181
|
+
{ 'conversationId': conversationId,'suggestionId': suggestionId },
|
|
18182
|
+
{ },
|
|
18183
|
+
{ },
|
|
18184
|
+
{ },
|
|
18185
|
+
body,
|
|
18186
|
+
['PureCloud OAuth'],
|
|
18187
|
+
['application/json'],
|
|
18188
|
+
['application/json']
|
|
18189
|
+
);
|
|
18190
|
+
}
|
|
18191
|
+
|
|
18192
|
+
/**
|
|
18193
|
+
* Suggestion feedback.
|
|
18194
|
+
*
|
|
18195
|
+
* @param {String} conversationId Conversation ID
|
|
18196
|
+
* @param {Object} body SuggestionFeedback
|
|
18197
|
+
*/
|
|
18198
|
+
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18199
|
+
// verify the required parameter 'conversationId' is set
|
|
18200
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18201
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';
|
|
18202
|
+
}
|
|
18203
|
+
// verify the required parameter 'body' is set
|
|
18204
|
+
if (body === undefined || body === null) {
|
|
18205
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';
|
|
18206
|
+
}
|
|
18207
|
+
|
|
18208
|
+
return this.apiClient.callApi(
|
|
18209
|
+
'/api/v2/conversations/{conversationId}/suggestions/feedback',
|
|
18210
|
+
'POST',
|
|
18211
|
+
{ 'conversationId': conversationId },
|
|
18212
|
+
{ },
|
|
18213
|
+
{ },
|
|
18214
|
+
{ },
|
|
18215
|
+
body,
|
|
18216
|
+
['PureCloud OAuth'],
|
|
18217
|
+
['application/json'],
|
|
18218
|
+
['application/json']
|
|
18219
|
+
);
|
|
18220
|
+
}
|
|
18221
|
+
|
|
17963
18222
|
/**
|
|
17964
18223
|
* Submit feedback for the summary.
|
|
17965
18224
|
*
|
|
@@ -20377,7 +20636,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20377
20636
|
/**
|
|
20378
20637
|
* DataExtensions service.
|
|
20379
20638
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20380
|
-
* @version
|
|
20639
|
+
* @version 197.0.0
|
|
20381
20640
|
*/
|
|
20382
20641
|
|
|
20383
20642
|
/**
|
|
@@ -20463,7 +20722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20463
20722
|
/**
|
|
20464
20723
|
* Downloads service.
|
|
20465
20724
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20466
|
-
* @version
|
|
20725
|
+
* @version 197.0.0
|
|
20467
20726
|
*/
|
|
20468
20727
|
|
|
20469
20728
|
/**
|
|
@@ -20515,7 +20774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20515
20774
|
/**
|
|
20516
20775
|
* Emails service.
|
|
20517
20776
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20518
|
-
* @version
|
|
20777
|
+
* @version 197.0.0
|
|
20519
20778
|
*/
|
|
20520
20779
|
|
|
20521
20780
|
/**
|
|
@@ -20576,11 +20835,162 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20576
20835
|
|
|
20577
20836
|
}
|
|
20578
20837
|
|
|
20838
|
+
class EmployeeEngagementApi {
|
|
20839
|
+
/**
|
|
20840
|
+
* EmployeeEngagement service.
|
|
20841
|
+
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20842
|
+
* @version 197.0.0
|
|
20843
|
+
*/
|
|
20844
|
+
|
|
20845
|
+
/**
|
|
20846
|
+
* Constructs a new EmployeeEngagementApi.
|
|
20847
|
+
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20848
|
+
* @class
|
|
20849
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20850
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20851
|
+
*/
|
|
20852
|
+
constructor(apiClient) {
|
|
20853
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
20854
|
+
}
|
|
20855
|
+
|
|
20856
|
+
|
|
20857
|
+
/**
|
|
20858
|
+
* Deletes a celebration
|
|
20859
|
+
*
|
|
20860
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20861
|
+
*/
|
|
20862
|
+
deleteEmployeeengagementCelebration(celebrationId) {
|
|
20863
|
+
// verify the required parameter 'celebrationId' is set
|
|
20864
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20865
|
+
throw 'Missing the required parameter "celebrationId" when calling deleteEmployeeengagementCelebration';
|
|
20866
|
+
}
|
|
20867
|
+
|
|
20868
|
+
return this.apiClient.callApi(
|
|
20869
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20870
|
+
'DELETE',
|
|
20871
|
+
{ 'celebrationId': celebrationId },
|
|
20872
|
+
{ },
|
|
20873
|
+
{ },
|
|
20874
|
+
{ },
|
|
20875
|
+
null,
|
|
20876
|
+
['PureCloud OAuth'],
|
|
20877
|
+
['application/json'],
|
|
20878
|
+
['application/json']
|
|
20879
|
+
);
|
|
20880
|
+
}
|
|
20881
|
+
|
|
20882
|
+
/**
|
|
20883
|
+
* Get all celebrations
|
|
20884
|
+
*
|
|
20885
|
+
* @param {Object} opts Optional parameters
|
|
20886
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
20887
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
20888
|
+
*/
|
|
20889
|
+
getEmployeeengagementCelebrations(opts) {
|
|
20890
|
+
opts = opts || {};
|
|
20891
|
+
|
|
20892
|
+
|
|
20893
|
+
return this.apiClient.callApi(
|
|
20894
|
+
'/api/v2/employeeengagement/celebrations',
|
|
20895
|
+
'GET',
|
|
20896
|
+
{ },
|
|
20897
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
20898
|
+
{ },
|
|
20899
|
+
{ },
|
|
20900
|
+
null,
|
|
20901
|
+
['PureCloud OAuth'],
|
|
20902
|
+
['application/json'],
|
|
20903
|
+
['application/json']
|
|
20904
|
+
);
|
|
20905
|
+
}
|
|
20906
|
+
|
|
20907
|
+
/**
|
|
20908
|
+
* Gets a single recognition
|
|
20909
|
+
*
|
|
20910
|
+
* @param {String} recognitionId The Recognition ID
|
|
20911
|
+
*/
|
|
20912
|
+
getEmployeeengagementRecognition(recognitionId) {
|
|
20913
|
+
// verify the required parameter 'recognitionId' is set
|
|
20914
|
+
if (recognitionId === undefined || recognitionId === null) {
|
|
20915
|
+
throw 'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';
|
|
20916
|
+
}
|
|
20917
|
+
|
|
20918
|
+
return this.apiClient.callApi(
|
|
20919
|
+
'/api/v2/employeeengagement/recognitions/{recognitionId}',
|
|
20920
|
+
'GET',
|
|
20921
|
+
{ 'recognitionId': recognitionId },
|
|
20922
|
+
{ },
|
|
20923
|
+
{ },
|
|
20924
|
+
{ },
|
|
20925
|
+
null,
|
|
20926
|
+
['PureCloud OAuth'],
|
|
20927
|
+
['application/json'],
|
|
20928
|
+
['application/json']
|
|
20929
|
+
);
|
|
20930
|
+
}
|
|
20931
|
+
|
|
20932
|
+
/**
|
|
20933
|
+
* Set a state for a celebration
|
|
20934
|
+
*
|
|
20935
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20936
|
+
* @param {Object} body Patch Celebration state
|
|
20937
|
+
*/
|
|
20938
|
+
patchEmployeeengagementCelebration(celebrationId, body) {
|
|
20939
|
+
// verify the required parameter 'celebrationId' is set
|
|
20940
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20941
|
+
throw 'Missing the required parameter "celebrationId" when calling patchEmployeeengagementCelebration';
|
|
20942
|
+
}
|
|
20943
|
+
// verify the required parameter 'body' is set
|
|
20944
|
+
if (body === undefined || body === null) {
|
|
20945
|
+
throw 'Missing the required parameter "body" when calling patchEmployeeengagementCelebration';
|
|
20946
|
+
}
|
|
20947
|
+
|
|
20948
|
+
return this.apiClient.callApi(
|
|
20949
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20950
|
+
'PATCH',
|
|
20951
|
+
{ 'celebrationId': celebrationId },
|
|
20952
|
+
{ },
|
|
20953
|
+
{ },
|
|
20954
|
+
{ },
|
|
20955
|
+
body,
|
|
20956
|
+
['PureCloud OAuth'],
|
|
20957
|
+
['application/json'],
|
|
20958
|
+
['application/json']
|
|
20959
|
+
);
|
|
20960
|
+
}
|
|
20961
|
+
|
|
20962
|
+
/**
|
|
20963
|
+
* Creates a recognition
|
|
20964
|
+
*
|
|
20965
|
+
* @param {Object} body Create Recognition
|
|
20966
|
+
*/
|
|
20967
|
+
postEmployeeengagementRecognitions(body) {
|
|
20968
|
+
// verify the required parameter 'body' is set
|
|
20969
|
+
if (body === undefined || body === null) {
|
|
20970
|
+
throw 'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';
|
|
20971
|
+
}
|
|
20972
|
+
|
|
20973
|
+
return this.apiClient.callApi(
|
|
20974
|
+
'/api/v2/employeeengagement/recognitions',
|
|
20975
|
+
'POST',
|
|
20976
|
+
{ },
|
|
20977
|
+
{ },
|
|
20978
|
+
{ },
|
|
20979
|
+
{ },
|
|
20980
|
+
body,
|
|
20981
|
+
['PureCloud OAuth'],
|
|
20982
|
+
['application/json'],
|
|
20983
|
+
['application/json']
|
|
20984
|
+
);
|
|
20985
|
+
}
|
|
20986
|
+
|
|
20987
|
+
}
|
|
20988
|
+
|
|
20579
20989
|
class EventsApi {
|
|
20580
20990
|
/**
|
|
20581
20991
|
* Events service.
|
|
20582
20992
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20583
|
-
* @version
|
|
20993
|
+
* @version 197.0.0
|
|
20584
20994
|
*/
|
|
20585
20995
|
|
|
20586
20996
|
/**
|
|
@@ -20676,7 +21086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20676
21086
|
/**
|
|
20677
21087
|
* ExternalContacts service.
|
|
20678
21088
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20679
|
-
* @version
|
|
21089
|
+
* @version 197.0.0
|
|
20680
21090
|
*/
|
|
20681
21091
|
|
|
20682
21092
|
/**
|
|
@@ -20881,7 +21291,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20881
21291
|
*
|
|
20882
21292
|
* @param {String} contactId ExternalContact ID
|
|
20883
21293
|
* @param {Object} opts Optional parameters
|
|
20884
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21294
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
20885
21295
|
*/
|
|
20886
21296
|
getExternalcontactsContact(contactId, opts) {
|
|
20887
21297
|
opts = opts || {};
|
|
@@ -22197,8 +22607,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22197
22607
|
* Fetch a contact using an identifier type and value.
|
|
22198
22608
|
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
22199
22609
|
* @param {Object} identifier
|
|
22610
|
+
* @param {Object} opts Optional parameters
|
|
22611
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
22200
22612
|
*/
|
|
22201
|
-
postExternalcontactsIdentifierlookup(identifier) {
|
|
22613
|
+
postExternalcontactsIdentifierlookup(identifier, opts) {
|
|
22614
|
+
opts = opts || {};
|
|
22615
|
+
|
|
22202
22616
|
// verify the required parameter 'identifier' is set
|
|
22203
22617
|
if (identifier === undefined || identifier === null) {
|
|
22204
22618
|
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
@@ -22208,7 +22622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22208
22622
|
'/api/v2/externalcontacts/identifierlookup',
|
|
22209
22623
|
'POST',
|
|
22210
22624
|
{ },
|
|
22211
|
-
{
|
|
22625
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
22212
22626
|
{ },
|
|
22213
22627
|
{ },
|
|
22214
22628
|
identifier,
|
|
@@ -22634,7 +23048,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22634
23048
|
/**
|
|
22635
23049
|
* Fax service.
|
|
22636
23050
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22637
|
-
* @version
|
|
23051
|
+
* @version 197.0.0
|
|
22638
23052
|
*/
|
|
22639
23053
|
|
|
22640
23054
|
/**
|
|
@@ -22849,7 +23263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22849
23263
|
/**
|
|
22850
23264
|
* Flows service.
|
|
22851
23265
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22852
|
-
* @version
|
|
23266
|
+
* @version 197.0.0
|
|
22853
23267
|
*/
|
|
22854
23268
|
|
|
22855
23269
|
/**
|
|
@@ -23032,7 +23446,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23032
23446
|
/**
|
|
23033
23447
|
* Gamification service.
|
|
23034
23448
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23035
|
-
* @version
|
|
23449
|
+
* @version 197.0.0
|
|
23036
23450
|
*/
|
|
23037
23451
|
|
|
23038
23452
|
/**
|
|
@@ -25118,7 +25532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25118
25532
|
/**
|
|
25119
25533
|
* GeneralDataProtectionRegulation service.
|
|
25120
25534
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25121
|
-
* @version
|
|
25535
|
+
* @version 197.0.0
|
|
25122
25536
|
*/
|
|
25123
25537
|
|
|
25124
25538
|
/**
|
|
@@ -25248,7 +25662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25248
25662
|
/**
|
|
25249
25663
|
* Geolocation service.
|
|
25250
25664
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25251
|
-
* @version
|
|
25665
|
+
* @version 197.0.0
|
|
25252
25666
|
*/
|
|
25253
25667
|
|
|
25254
25668
|
/**
|
|
@@ -25379,7 +25793,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25379
25793
|
/**
|
|
25380
25794
|
* Greetings service.
|
|
25381
25795
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25382
|
-
* @version
|
|
25796
|
+
* @version 197.0.0
|
|
25383
25797
|
*/
|
|
25384
25798
|
|
|
25385
25799
|
/**
|
|
@@ -25834,7 +26248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25834
26248
|
/**
|
|
25835
26249
|
* Groups service.
|
|
25836
26250
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25837
|
-
* @version
|
|
26251
|
+
* @version 197.0.0
|
|
25838
26252
|
*/
|
|
25839
26253
|
|
|
25840
26254
|
/**
|
|
@@ -26353,7 +26767,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26353
26767
|
/**
|
|
26354
26768
|
* IdentityProvider service.
|
|
26355
26769
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26356
|
-
* @version
|
|
26770
|
+
* @version 197.0.0
|
|
26357
26771
|
*/
|
|
26358
26772
|
|
|
26359
26773
|
/**
|
|
@@ -27214,7 +27628,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27214
27628
|
/**
|
|
27215
27629
|
* InfrastructureAsCode service.
|
|
27216
27630
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27217
|
-
* @version
|
|
27631
|
+
* @version 197.0.0
|
|
27218
27632
|
*/
|
|
27219
27633
|
|
|
27220
27634
|
/**
|
|
@@ -27381,7 +27795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27381
27795
|
/**
|
|
27382
27796
|
* Integrations service.
|
|
27383
27797
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27384
|
-
* @version
|
|
27798
|
+
* @version 197.0.0
|
|
27385
27799
|
*/
|
|
27386
27800
|
|
|
27387
27801
|
/**
|
|
@@ -29733,7 +30147,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29733
30147
|
/**
|
|
29734
30148
|
* Journey service.
|
|
29735
30149
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29736
|
-
* @version
|
|
30150
|
+
* @version 197.0.0
|
|
29737
30151
|
*/
|
|
29738
30152
|
|
|
29739
30153
|
/**
|
|
@@ -30477,6 +30891,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30477
30891
|
* @param {Object} opts Optional parameters
|
|
30478
30892
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
30479
30893
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
30894
|
+
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
30480
30895
|
* getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
30481
30896
|
*/
|
|
30482
30897
|
getJourneySessionEvents(sessionId, opts) {
|
|
@@ -30491,7 +30906,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30491
30906
|
'/api/v2/journey/sessions/{sessionId}/events',
|
|
30492
30907
|
'GET',
|
|
30493
30908
|
{ 'sessionId': sessionId },
|
|
30494
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
30909
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'eventType': opts['eventType'] },
|
|
30495
30910
|
{ },
|
|
30496
30911
|
{ },
|
|
30497
30912
|
null,
|
|
@@ -31350,7 +31765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31350
31765
|
/**
|
|
31351
31766
|
* Knowledge service.
|
|
31352
31767
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31353
|
-
* @version
|
|
31768
|
+
* @version 197.0.0
|
|
31354
31769
|
*/
|
|
31355
31770
|
|
|
31356
31771
|
/**
|
|
@@ -34594,7 +35009,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34594
35009
|
/**
|
|
34595
35010
|
* LanguageUnderstanding service.
|
|
34596
35011
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34597
|
-
* @version
|
|
35012
|
+
* @version 197.0.0
|
|
34598
35013
|
*/
|
|
34599
35014
|
|
|
34600
35015
|
/**
|
|
@@ -35628,7 +36043,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35628
36043
|
/**
|
|
35629
36044
|
* Languages service.
|
|
35630
36045
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35631
|
-
* @version
|
|
36046
|
+
* @version 197.0.0
|
|
35632
36047
|
*/
|
|
35633
36048
|
|
|
35634
36049
|
/**
|
|
@@ -35850,7 +36265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35850
36265
|
/**
|
|
35851
36266
|
* Learning service.
|
|
35852
36267
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35853
|
-
* @version
|
|
36268
|
+
* @version 197.0.0
|
|
35854
36269
|
*/
|
|
35855
36270
|
|
|
35856
36271
|
/**
|
|
@@ -35951,6 +36366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35951
36366
|
* @param {String} stepId The ID of Learning Assignment Step
|
|
35952
36367
|
* @param {Object} opts Optional parameters
|
|
35953
36368
|
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
36369
|
+
* @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
|
|
35954
36370
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35955
36371
|
*/
|
|
35956
36372
|
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
@@ -35969,7 +36385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35969
36385
|
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35970
36386
|
'GET',
|
|
35971
36387
|
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35972
|
-
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
36388
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'defaultShareableContentObject': opts['defaultShareableContentObject'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35973
36389
|
{ },
|
|
35974
36390
|
{ },
|
|
35975
36391
|
null,
|
|
@@ -36878,7 +37294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36878
37294
|
/**
|
|
36879
37295
|
* License service.
|
|
36880
37296
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36881
|
-
* @version
|
|
37297
|
+
* @version 197.0.0
|
|
36882
37298
|
*/
|
|
36883
37299
|
|
|
36884
37300
|
/**
|
|
@@ -37116,7 +37532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37116
37532
|
/**
|
|
37117
37533
|
* Locations service.
|
|
37118
37534
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37119
|
-
* @version
|
|
37535
|
+
* @version 197.0.0
|
|
37120
37536
|
*/
|
|
37121
37537
|
|
|
37122
37538
|
/**
|
|
@@ -37352,7 +37768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37352
37768
|
/**
|
|
37353
37769
|
* LogCapture service.
|
|
37354
37770
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37355
|
-
* @version
|
|
37771
|
+
* @version 197.0.0
|
|
37356
37772
|
*/
|
|
37357
37773
|
|
|
37358
37774
|
/**
|
|
@@ -37552,7 +37968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37552
37968
|
/**
|
|
37553
37969
|
* Messaging service.
|
|
37554
37970
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37555
|
-
* @version
|
|
37971
|
+
* @version 197.0.0
|
|
37556
37972
|
*/
|
|
37557
37973
|
|
|
37558
37974
|
/**
|
|
@@ -37911,7 +38327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37911
38327
|
/**
|
|
37912
38328
|
* MobileDevices service.
|
|
37913
38329
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37914
|
-
* @version
|
|
38330
|
+
* @version 197.0.0
|
|
37915
38331
|
*/
|
|
37916
38332
|
|
|
37917
38333
|
/**
|
|
@@ -38062,7 +38478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38062
38478
|
/**
|
|
38063
38479
|
* Notifications service.
|
|
38064
38480
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38065
|
-
* @version
|
|
38481
|
+
* @version 197.0.0
|
|
38066
38482
|
*/
|
|
38067
38483
|
|
|
38068
38484
|
/**
|
|
@@ -38295,7 +38711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38295
38711
|
/**
|
|
38296
38712
|
* OAuth service.
|
|
38297
38713
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38298
|
-
* @version
|
|
38714
|
+
* @version 197.0.0
|
|
38299
38715
|
*/
|
|
38300
38716
|
|
|
38301
38717
|
/**
|
|
@@ -38661,7 +39077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38661
39077
|
/**
|
|
38662
39078
|
* Objects service.
|
|
38663
39079
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38664
|
-
* @version
|
|
39080
|
+
* @version 197.0.0
|
|
38665
39081
|
*/
|
|
38666
39082
|
|
|
38667
39083
|
/**
|
|
@@ -38931,7 +39347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38931
39347
|
/**
|
|
38932
39348
|
* OperationalEvents service.
|
|
38933
39349
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38934
|
-
* @version
|
|
39350
|
+
* @version 197.0.0
|
|
38935
39351
|
*/
|
|
38936
39352
|
|
|
38937
39353
|
/**
|
|
@@ -38997,7 +39413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38997
39413
|
/**
|
|
38998
39414
|
* Organization service.
|
|
38999
39415
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39000
|
-
* @version
|
|
39416
|
+
* @version 197.0.0
|
|
39001
39417
|
*/
|
|
39002
39418
|
|
|
39003
39419
|
/**
|
|
@@ -39472,7 +39888,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39472
39888
|
/**
|
|
39473
39889
|
* OrganizationAuthorization service.
|
|
39474
39890
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39475
|
-
* @version
|
|
39891
|
+
* @version 197.0.0
|
|
39476
39892
|
*/
|
|
39477
39893
|
|
|
39478
39894
|
/**
|
|
@@ -40819,7 +41235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40819
41235
|
/**
|
|
40820
41236
|
* Outbound service.
|
|
40821
41237
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40822
|
-
* @version
|
|
41238
|
+
* @version 197.0.0
|
|
40823
41239
|
*/
|
|
40824
41240
|
|
|
40825
41241
|
/**
|
|
@@ -43435,6 +43851,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43435
43851
|
);
|
|
43436
43852
|
}
|
|
43437
43853
|
|
|
43854
|
+
/**
|
|
43855
|
+
* Update a campaign.
|
|
43856
|
+
*
|
|
43857
|
+
* @param {String} campaignId Campaign ID
|
|
43858
|
+
* @param {Object} body CampaignPatchRequest
|
|
43859
|
+
*/
|
|
43860
|
+
patchOutboundCampaign(campaignId, body) {
|
|
43861
|
+
// verify the required parameter 'campaignId' is set
|
|
43862
|
+
if (campaignId === undefined || campaignId === null) {
|
|
43863
|
+
throw 'Missing the required parameter "campaignId" when calling patchOutboundCampaign';
|
|
43864
|
+
}
|
|
43865
|
+
// verify the required parameter 'body' is set
|
|
43866
|
+
if (body === undefined || body === null) {
|
|
43867
|
+
throw 'Missing the required parameter "body" when calling patchOutboundCampaign';
|
|
43868
|
+
}
|
|
43869
|
+
|
|
43870
|
+
return this.apiClient.callApi(
|
|
43871
|
+
'/api/v2/outbound/campaigns/{campaignId}',
|
|
43872
|
+
'PATCH',
|
|
43873
|
+
{ 'campaignId': campaignId },
|
|
43874
|
+
{ },
|
|
43875
|
+
{ },
|
|
43876
|
+
{ },
|
|
43877
|
+
body,
|
|
43878
|
+
['PureCloud OAuth'],
|
|
43879
|
+
['application/json'],
|
|
43880
|
+
['application/json']
|
|
43881
|
+
);
|
|
43882
|
+
}
|
|
43883
|
+
|
|
43438
43884
|
/**
|
|
43439
43885
|
* Add entries to or delete entries from a DNC list.
|
|
43440
43886
|
* Only Internal DNC lists may be deleted from
|
|
@@ -43575,40 +44021,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43575
44021
|
);
|
|
43576
44022
|
}
|
|
43577
44023
|
|
|
43578
|
-
/**
|
|
43579
|
-
* Retrieves audits for dialer. (Deprecated)
|
|
43580
|
-
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
43581
|
-
* @param {Object} body AuditSearch
|
|
43582
|
-
* @param {Object} opts Optional parameters
|
|
43583
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43584
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43585
|
-
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
43586
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
43587
|
-
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
43588
|
-
* @deprecated
|
|
43589
|
-
*/
|
|
43590
|
-
postOutboundAudits(body, opts) {
|
|
43591
|
-
opts = opts || {};
|
|
43592
|
-
|
|
43593
|
-
// verify the required parameter 'body' is set
|
|
43594
|
-
if (body === undefined || body === null) {
|
|
43595
|
-
throw 'Missing the required parameter "body" when calling postOutboundAudits';
|
|
43596
|
-
}
|
|
43597
|
-
|
|
43598
|
-
return this.apiClient.callApi(
|
|
43599
|
-
'/api/v2/outbound/audits',
|
|
43600
|
-
'POST',
|
|
43601
|
-
{ },
|
|
43602
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'facetsOnly': opts['facetsOnly'] },
|
|
43603
|
-
{ },
|
|
43604
|
-
{ },
|
|
43605
|
-
body,
|
|
43606
|
-
['PureCloud OAuth'],
|
|
43607
|
-
['application/json'],
|
|
43608
|
-
['application/json']
|
|
43609
|
-
);
|
|
43610
|
-
}
|
|
43611
|
-
|
|
43612
44024
|
/**
|
|
43613
44025
|
* Create callable time set
|
|
43614
44026
|
*
|
|
@@ -45185,7 +45597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45185
45597
|
/**
|
|
45186
45598
|
* Presence service.
|
|
45187
45599
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45188
|
-
* @version
|
|
45600
|
+
* @version 197.0.0
|
|
45189
45601
|
*/
|
|
45190
45602
|
|
|
45191
45603
|
/**
|
|
@@ -45929,7 +46341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45929
46341
|
/**
|
|
45930
46342
|
* ProcessAutomation service.
|
|
45931
46343
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45932
|
-
* @version
|
|
46344
|
+
* @version 197.0.0
|
|
45933
46345
|
*/
|
|
45934
46346
|
|
|
45935
46347
|
/**
|
|
@@ -46168,7 +46580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46168
46580
|
/**
|
|
46169
46581
|
* Quality service.
|
|
46170
46582
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46171
|
-
* @version
|
|
46583
|
+
* @version 197.0.0
|
|
46172
46584
|
*/
|
|
46173
46585
|
|
|
46174
46586
|
/**
|
|
@@ -47923,7 +48335,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47923
48335
|
/**
|
|
47924
48336
|
* Recording service.
|
|
47925
48337
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47926
|
-
* @version
|
|
48338
|
+
* @version 197.0.0
|
|
47927
48339
|
*/
|
|
47928
48340
|
|
|
47929
48341
|
/**
|
|
@@ -49581,7 +49993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49581
49993
|
/**
|
|
49582
49994
|
* ResponseManagement service.
|
|
49583
49995
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49584
|
-
* @version
|
|
49996
|
+
* @version 197.0.0
|
|
49585
49997
|
*/
|
|
49586
49998
|
|
|
49587
49999
|
/**
|
|
@@ -50091,7 +50503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50091
50503
|
/**
|
|
50092
50504
|
* Routing service.
|
|
50093
50505
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50094
|
-
* @version
|
|
50506
|
+
* @version 197.0.0
|
|
50095
50507
|
*/
|
|
50096
50508
|
|
|
50097
50509
|
/**
|
|
@@ -52002,6 +52414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52002
52414
|
* @param {Object} opts.sortOrder Sort order
|
|
52003
52415
|
* @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)
|
|
52004
52416
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
52417
|
+
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
52005
52418
|
*/
|
|
52006
52419
|
getRoutingSmsPhonenumbers(opts) {
|
|
52007
52420
|
opts = opts || {};
|
|
@@ -52011,7 +52424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52011
52424
|
'/api/v2/routing/sms/phonenumbers',
|
|
52012
52425
|
'GET',
|
|
52013
52426
|
{ },
|
|
52014
|
-
{ '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'] },
|
|
52427
|
+
{ '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'] },
|
|
52015
52428
|
{ },
|
|
52016
52429
|
{ },
|
|
52017
52430
|
null,
|
|
@@ -54064,7 +54477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54064
54477
|
/**
|
|
54065
54478
|
* SCIM service.
|
|
54066
54479
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54067
|
-
* @version
|
|
54480
|
+
* @version 197.0.0
|
|
54068
54481
|
*/
|
|
54069
54482
|
|
|
54070
54483
|
/**
|
|
@@ -54941,7 +55354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54941
55354
|
/**
|
|
54942
55355
|
* ScreenRecording service.
|
|
54943
55356
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54944
|
-
* @version
|
|
55357
|
+
* @version 197.0.0
|
|
54945
55358
|
*/
|
|
54946
55359
|
|
|
54947
55360
|
/**
|
|
@@ -54986,7 +55399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54986
55399
|
/**
|
|
54987
55400
|
* Scripts service.
|
|
54988
55401
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54989
|
-
* @version
|
|
55402
|
+
* @version 197.0.0
|
|
54990
55403
|
*/
|
|
54991
55404
|
|
|
54992
55405
|
/**
|
|
@@ -55430,7 +55843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55430
55843
|
/**
|
|
55431
55844
|
* Search service.
|
|
55432
55845
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55433
|
-
* @version
|
|
55846
|
+
* @version 197.0.0
|
|
55434
55847
|
*/
|
|
55435
55848
|
|
|
55436
55849
|
/**
|
|
@@ -56119,7 +56532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56119
56532
|
/**
|
|
56120
56533
|
* Settings service.
|
|
56121
56534
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56122
|
-
* @version
|
|
56535
|
+
* @version 197.0.0
|
|
56123
56536
|
*/
|
|
56124
56537
|
|
|
56125
56538
|
/**
|
|
@@ -56134,6 +56547,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56134
56547
|
}
|
|
56135
56548
|
|
|
56136
56549
|
|
|
56550
|
+
/**
|
|
56551
|
+
* Delete agent auto answer settings
|
|
56552
|
+
*
|
|
56553
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56554
|
+
*/
|
|
56555
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56556
|
+
// verify the required parameter 'agentId' is set
|
|
56557
|
+
if (agentId === undefined || agentId === null) {
|
|
56558
|
+
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56559
|
+
}
|
|
56560
|
+
|
|
56561
|
+
return this.apiClient.callApi(
|
|
56562
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56563
|
+
'DELETE',
|
|
56564
|
+
{ 'agentId': agentId },
|
|
56565
|
+
{ },
|
|
56566
|
+
{ },
|
|
56567
|
+
{ },
|
|
56568
|
+
null,
|
|
56569
|
+
['PureCloud OAuth'],
|
|
56570
|
+
['application/json'],
|
|
56571
|
+
['application/json']
|
|
56572
|
+
);
|
|
56573
|
+
}
|
|
56574
|
+
|
|
56137
56575
|
/**
|
|
56138
56576
|
* Get email Contact Center settings
|
|
56139
56577
|
*
|
|
@@ -56175,6 +56613,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56175
56613
|
);
|
|
56176
56614
|
}
|
|
56177
56615
|
|
|
56616
|
+
/**
|
|
56617
|
+
* Get agent auto answer settings
|
|
56618
|
+
*
|
|
56619
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56620
|
+
*/
|
|
56621
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56622
|
+
// verify the required parameter 'agentId' is set
|
|
56623
|
+
if (agentId === undefined || agentId === null) {
|
|
56624
|
+
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56625
|
+
}
|
|
56626
|
+
|
|
56627
|
+
return this.apiClient.callApi(
|
|
56628
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56629
|
+
'GET',
|
|
56630
|
+
{ 'agentId': agentId },
|
|
56631
|
+
{ },
|
|
56632
|
+
{ },
|
|
56633
|
+
{ },
|
|
56634
|
+
null,
|
|
56635
|
+
['PureCloud OAuth'],
|
|
56636
|
+
['application/json'],
|
|
56637
|
+
['application/json']
|
|
56638
|
+
);
|
|
56639
|
+
}
|
|
56640
|
+
|
|
56178
56641
|
/**
|
|
56179
56642
|
* Patch email Contact Center settings
|
|
56180
56643
|
*
|
|
@@ -56225,13 +56688,73 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56225
56688
|
);
|
|
56226
56689
|
}
|
|
56227
56690
|
|
|
56691
|
+
/**
|
|
56692
|
+
* Update agent auto answer settings
|
|
56693
|
+
*
|
|
56694
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56695
|
+
* @param {Object} body AutoAnswerSettings
|
|
56696
|
+
*/
|
|
56697
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56698
|
+
// verify the required parameter 'agentId' is set
|
|
56699
|
+
if (agentId === undefined || agentId === null) {
|
|
56700
|
+
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56701
|
+
}
|
|
56702
|
+
// verify the required parameter 'body' is set
|
|
56703
|
+
if (body === undefined || body === null) {
|
|
56704
|
+
throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56705
|
+
}
|
|
56706
|
+
|
|
56707
|
+
return this.apiClient.callApi(
|
|
56708
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56709
|
+
'PATCH',
|
|
56710
|
+
{ 'agentId': agentId },
|
|
56711
|
+
{ },
|
|
56712
|
+
{ },
|
|
56713
|
+
{ },
|
|
56714
|
+
body,
|
|
56715
|
+
['PureCloud OAuth'],
|
|
56716
|
+
['application/json'],
|
|
56717
|
+
['application/json']
|
|
56718
|
+
);
|
|
56719
|
+
}
|
|
56720
|
+
|
|
56721
|
+
/**
|
|
56722
|
+
* Set agent auto answer settings
|
|
56723
|
+
*
|
|
56724
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56725
|
+
* @param {Object} body AutoAnswerSettings
|
|
56726
|
+
*/
|
|
56727
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56728
|
+
// verify the required parameter 'agentId' is set
|
|
56729
|
+
if (agentId === undefined || agentId === null) {
|
|
56730
|
+
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56731
|
+
}
|
|
56732
|
+
// verify the required parameter 'body' is set
|
|
56733
|
+
if (body === undefined || body === null) {
|
|
56734
|
+
throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56735
|
+
}
|
|
56736
|
+
|
|
56737
|
+
return this.apiClient.callApi(
|
|
56738
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56739
|
+
'PUT',
|
|
56740
|
+
{ 'agentId': agentId },
|
|
56741
|
+
{ },
|
|
56742
|
+
{ },
|
|
56743
|
+
{ },
|
|
56744
|
+
body,
|
|
56745
|
+
['PureCloud OAuth'],
|
|
56746
|
+
['application/json'],
|
|
56747
|
+
['application/json']
|
|
56748
|
+
);
|
|
56749
|
+
}
|
|
56750
|
+
|
|
56228
56751
|
}
|
|
56229
56752
|
|
|
56230
56753
|
class SpeechTextAnalyticsApi {
|
|
56231
56754
|
/**
|
|
56232
56755
|
* SpeechTextAnalytics service.
|
|
56233
56756
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56234
|
-
* @version
|
|
56757
|
+
* @version 197.0.0
|
|
56235
56758
|
*/
|
|
56236
56759
|
|
|
56237
56760
|
/**
|
|
@@ -57509,7 +58032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57509
58032
|
/**
|
|
57510
58033
|
* Stations service.
|
|
57511
58034
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57512
|
-
* @version
|
|
58035
|
+
* @version 197.0.0
|
|
57513
58036
|
*/
|
|
57514
58037
|
|
|
57515
58038
|
/**
|
|
@@ -57611,7 +58134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57611
58134
|
/**
|
|
57612
58135
|
* Suggest service.
|
|
57613
58136
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57614
|
-
* @version
|
|
58137
|
+
* @version 197.0.0
|
|
57615
58138
|
*/
|
|
57616
58139
|
|
|
57617
58140
|
/**
|
|
@@ -57750,7 +58273,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57750
58273
|
/**
|
|
57751
58274
|
* TaskManagement service.
|
|
57752
58275
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57753
|
-
* @version
|
|
58276
|
+
* @version 197.0.0
|
|
57754
58277
|
*/
|
|
57755
58278
|
|
|
57756
58279
|
/**
|
|
@@ -59098,7 +59621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59098
59621
|
/**
|
|
59099
59622
|
* Teams service.
|
|
59100
59623
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59101
|
-
* @version
|
|
59624
|
+
* @version 197.0.0
|
|
59102
59625
|
*/
|
|
59103
59626
|
|
|
59104
59627
|
/**
|
|
@@ -59399,7 +59922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59399
59922
|
/**
|
|
59400
59923
|
* Telephony service.
|
|
59401
59924
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59402
|
-
* @version
|
|
59925
|
+
* @version 197.0.0
|
|
59403
59926
|
*/
|
|
59404
59927
|
|
|
59405
59928
|
/**
|
|
@@ -59581,7 +60104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59581
60104
|
/**
|
|
59582
60105
|
* TelephonyProvidersEdge service.
|
|
59583
60106
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59584
|
-
* @version
|
|
60107
|
+
* @version 197.0.0
|
|
59585
60108
|
*/
|
|
59586
60109
|
|
|
59587
60110
|
/**
|
|
@@ -62909,7 +63432,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62909
63432
|
/**
|
|
62910
63433
|
* Textbots service.
|
|
62911
63434
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62912
|
-
* @version
|
|
63435
|
+
* @version 197.0.0
|
|
62913
63436
|
*/
|
|
62914
63437
|
|
|
62915
63438
|
/**
|
|
@@ -63037,7 +63560,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63037
63560
|
/**
|
|
63038
63561
|
* Tokens service.
|
|
63039
63562
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63040
|
-
* @version
|
|
63563
|
+
* @version 197.0.0
|
|
63041
63564
|
*/
|
|
63042
63565
|
|
|
63043
63566
|
/**
|
|
@@ -63191,7 +63714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63191
63714
|
/**
|
|
63192
63715
|
* Uploads service.
|
|
63193
63716
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63194
|
-
* @version
|
|
63717
|
+
* @version 197.0.0
|
|
63195
63718
|
*/
|
|
63196
63719
|
|
|
63197
63720
|
/**
|
|
@@ -63460,7 +63983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63460
63983
|
/**
|
|
63461
63984
|
* Usage service.
|
|
63462
63985
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63463
|
-
* @version
|
|
63986
|
+
* @version 197.0.0
|
|
63464
63987
|
*/
|
|
63465
63988
|
|
|
63466
63989
|
/**
|
|
@@ -63675,7 +64198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63675
64198
|
/**
|
|
63676
64199
|
* UserRecordings service.
|
|
63677
64200
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63678
|
-
* @version
|
|
64201
|
+
* @version 197.0.0
|
|
63679
64202
|
*/
|
|
63680
64203
|
|
|
63681
64204
|
/**
|
|
@@ -63860,7 +64383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63860
64383
|
/**
|
|
63861
64384
|
* Users service.
|
|
63862
64385
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63863
|
-
* @version
|
|
64386
|
+
* @version 197.0.0
|
|
63864
64387
|
*/
|
|
63865
64388
|
|
|
63866
64389
|
/**
|
|
@@ -66518,7 +67041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66518
67041
|
/**
|
|
66519
67042
|
* Utilities service.
|
|
66520
67043
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66521
|
-
* @version
|
|
67044
|
+
* @version 197.0.0
|
|
66522
67045
|
*/
|
|
66523
67046
|
|
|
66524
67047
|
/**
|
|
@@ -66629,7 +67152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66629
67152
|
/**
|
|
66630
67153
|
* Voicemail service.
|
|
66631
67154
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66632
|
-
* @version
|
|
67155
|
+
* @version 197.0.0
|
|
66633
67156
|
*/
|
|
66634
67157
|
|
|
66635
67158
|
/**
|
|
@@ -67296,7 +67819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67296
67819
|
/**
|
|
67297
67820
|
* WebChat service.
|
|
67298
67821
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67299
|
-
* @version
|
|
67822
|
+
* @version 197.0.0
|
|
67300
67823
|
*/
|
|
67301
67824
|
|
|
67302
67825
|
/**
|
|
@@ -67847,7 +68370,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67847
68370
|
/**
|
|
67848
68371
|
* WebDeployments service.
|
|
67849
68372
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67850
|
-
* @version
|
|
68373
|
+
* @version 197.0.0
|
|
67851
68374
|
*/
|
|
67852
68375
|
|
|
67853
68376
|
/**
|
|
@@ -68374,7 +68897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68374
68897
|
/**
|
|
68375
68898
|
* WebMessaging service.
|
|
68376
68899
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68377
|
-
* @version
|
|
68900
|
+
* @version 197.0.0
|
|
68378
68901
|
*/
|
|
68379
68902
|
|
|
68380
68903
|
/**
|
|
@@ -68420,7 +68943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68420
68943
|
/**
|
|
68421
68944
|
* Widgets service.
|
|
68422
68945
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68423
|
-
* @version
|
|
68946
|
+
* @version 197.0.0
|
|
68424
68947
|
*/
|
|
68425
68948
|
|
|
68426
68949
|
/**
|
|
@@ -68566,7 +69089,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68566
69089
|
/**
|
|
68567
69090
|
* WorkforceManagement service.
|
|
68568
69091
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68569
|
-
* @version
|
|
69092
|
+
* @version 197.0.0
|
|
68570
69093
|
*/
|
|
68571
69094
|
|
|
68572
69095
|
/**
|
|
@@ -74479,7 +75002,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74479
75002
|
* </pre>
|
|
74480
75003
|
* </p>
|
|
74481
75004
|
* @module purecloud-platform-client-v2/index
|
|
74482
|
-
* @version
|
|
75005
|
+
* @version 197.0.0
|
|
74483
75006
|
*/
|
|
74484
75007
|
class platformClient {
|
|
74485
75008
|
constructor() {
|
|
@@ -74493,6 +75016,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74493
75016
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
74494
75017
|
*/
|
|
74495
75018
|
this.ApiClientClass = ApiClient;
|
|
75019
|
+
/**
|
|
75020
|
+
* The AgentUIApi service constructor.
|
|
75021
|
+
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|
|
75022
|
+
*/
|
|
75023
|
+
this.AgentUIApi = AgentUIApi;
|
|
74496
75024
|
/**
|
|
74497
75025
|
* The AlertingApi service constructor.
|
|
74498
75026
|
* @property {module:purecloud-platform-client-v2/api/AlertingApi}
|
|
@@ -74563,6 +75091,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74563
75091
|
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
74564
75092
|
*/
|
|
74565
75093
|
this.EmailsApi = EmailsApi;
|
|
75094
|
+
/**
|
|
75095
|
+
* The EmployeeEngagementApi service constructor.
|
|
75096
|
+
* @property {module:purecloud-platform-client-v2/api/EmployeeEngagementApi}
|
|
75097
|
+
*/
|
|
75098
|
+
this.EmployeeEngagementApi = EmployeeEngagementApi;
|
|
74566
75099
|
/**
|
|
74567
75100
|
* The EventsApi service constructor.
|
|
74568
75101
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|