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
|
@@ -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,
|
|
@@ -30754,6 +31169,34 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30754
31169
|
);
|
|
30755
31170
|
}
|
|
30756
31171
|
|
|
31172
|
+
/**
|
|
31173
|
+
* Get the jobs for an organization.
|
|
31174
|
+
*
|
|
31175
|
+
* @param {Object} opts Optional parameters
|
|
31176
|
+
* @param {Number} opts.pageNumber The number of the page to return (default to 1)
|
|
31177
|
+
* @param {Number} opts.pageSize Max number of entities to return (default to 25)
|
|
31178
|
+
* @param {String} opts.interval An absolute timeframe for filtering the jobs, expressed as an ISO 8601 interval.
|
|
31179
|
+
* @param {String} opts.statuses Job statuses to filter for
|
|
31180
|
+
* getJourneyViewsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
31181
|
+
*/
|
|
31182
|
+
getJourneyViewsJobs(opts) {
|
|
31183
|
+
opts = opts || {};
|
|
31184
|
+
|
|
31185
|
+
|
|
31186
|
+
return this.apiClient.callApi(
|
|
31187
|
+
'/api/v2/journey/views/jobs',
|
|
31188
|
+
'GET',
|
|
31189
|
+
{ },
|
|
31190
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'interval': opts['interval'],'statuses': opts['statuses'] },
|
|
31191
|
+
{ },
|
|
31192
|
+
{ },
|
|
31193
|
+
null,
|
|
31194
|
+
['PureCloud OAuth'],
|
|
31195
|
+
['application/json'],
|
|
31196
|
+
['application/json']
|
|
31197
|
+
);
|
|
31198
|
+
}
|
|
31199
|
+
|
|
30757
31200
|
/**
|
|
30758
31201
|
* Update single action map.
|
|
30759
31202
|
*
|
|
@@ -31322,7 +31765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31322
31765
|
/**
|
|
31323
31766
|
* Knowledge service.
|
|
31324
31767
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31325
|
-
* @version
|
|
31768
|
+
* @version 197.0.0
|
|
31326
31769
|
*/
|
|
31327
31770
|
|
|
31328
31771
|
/**
|
|
@@ -34566,7 +35009,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34566
35009
|
/**
|
|
34567
35010
|
* LanguageUnderstanding service.
|
|
34568
35011
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34569
|
-
* @version
|
|
35012
|
+
* @version 197.0.0
|
|
34570
35013
|
*/
|
|
34571
35014
|
|
|
34572
35015
|
/**
|
|
@@ -35600,7 +36043,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35600
36043
|
/**
|
|
35601
36044
|
* Languages service.
|
|
35602
36045
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35603
|
-
* @version
|
|
36046
|
+
* @version 197.0.0
|
|
35604
36047
|
*/
|
|
35605
36048
|
|
|
35606
36049
|
/**
|
|
@@ -35822,7 +36265,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35822
36265
|
/**
|
|
35823
36266
|
* Learning service.
|
|
35824
36267
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35825
|
-
* @version
|
|
36268
|
+
* @version 197.0.0
|
|
35826
36269
|
*/
|
|
35827
36270
|
|
|
35828
36271
|
/**
|
|
@@ -35923,6 +36366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35923
36366
|
* @param {String} stepId The ID of Learning Assignment Step
|
|
35924
36367
|
* @param {Object} opts Optional parameters
|
|
35925
36368
|
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
36369
|
+
* @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
|
|
35926
36370
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35927
36371
|
*/
|
|
35928
36372
|
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
@@ -35941,7 +36385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35941
36385
|
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35942
36386
|
'GET',
|
|
35943
36387
|
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35944
|
-
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
36388
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'defaultShareableContentObject': opts['defaultShareableContentObject'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35945
36389
|
{ },
|
|
35946
36390
|
{ },
|
|
35947
36391
|
null,
|
|
@@ -36850,7 +37294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36850
37294
|
/**
|
|
36851
37295
|
* License service.
|
|
36852
37296
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36853
|
-
* @version
|
|
37297
|
+
* @version 197.0.0
|
|
36854
37298
|
*/
|
|
36855
37299
|
|
|
36856
37300
|
/**
|
|
@@ -37088,7 +37532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37088
37532
|
/**
|
|
37089
37533
|
* Locations service.
|
|
37090
37534
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37091
|
-
* @version
|
|
37535
|
+
* @version 197.0.0
|
|
37092
37536
|
*/
|
|
37093
37537
|
|
|
37094
37538
|
/**
|
|
@@ -37324,7 +37768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37324
37768
|
/**
|
|
37325
37769
|
* LogCapture service.
|
|
37326
37770
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37327
|
-
* @version
|
|
37771
|
+
* @version 197.0.0
|
|
37328
37772
|
*/
|
|
37329
37773
|
|
|
37330
37774
|
/**
|
|
@@ -37524,7 +37968,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37524
37968
|
/**
|
|
37525
37969
|
* Messaging service.
|
|
37526
37970
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37527
|
-
* @version
|
|
37971
|
+
* @version 197.0.0
|
|
37528
37972
|
*/
|
|
37529
37973
|
|
|
37530
37974
|
/**
|
|
@@ -37883,7 +38327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37883
38327
|
/**
|
|
37884
38328
|
* MobileDevices service.
|
|
37885
38329
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37886
|
-
* @version
|
|
38330
|
+
* @version 197.0.0
|
|
37887
38331
|
*/
|
|
37888
38332
|
|
|
37889
38333
|
/**
|
|
@@ -38034,7 +38478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38034
38478
|
/**
|
|
38035
38479
|
* Notifications service.
|
|
38036
38480
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38037
|
-
* @version
|
|
38481
|
+
* @version 197.0.0
|
|
38038
38482
|
*/
|
|
38039
38483
|
|
|
38040
38484
|
/**
|
|
@@ -38267,7 +38711,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38267
38711
|
/**
|
|
38268
38712
|
* OAuth service.
|
|
38269
38713
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38270
|
-
* @version
|
|
38714
|
+
* @version 197.0.0
|
|
38271
38715
|
*/
|
|
38272
38716
|
|
|
38273
38717
|
/**
|
|
@@ -38633,7 +39077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38633
39077
|
/**
|
|
38634
39078
|
* Objects service.
|
|
38635
39079
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38636
|
-
* @version
|
|
39080
|
+
* @version 197.0.0
|
|
38637
39081
|
*/
|
|
38638
39082
|
|
|
38639
39083
|
/**
|
|
@@ -38903,7 +39347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38903
39347
|
/**
|
|
38904
39348
|
* OperationalEvents service.
|
|
38905
39349
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38906
|
-
* @version
|
|
39350
|
+
* @version 197.0.0
|
|
38907
39351
|
*/
|
|
38908
39352
|
|
|
38909
39353
|
/**
|
|
@@ -38969,7 +39413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38969
39413
|
/**
|
|
38970
39414
|
* Organization service.
|
|
38971
39415
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
38972
|
-
* @version
|
|
39416
|
+
* @version 197.0.0
|
|
38973
39417
|
*/
|
|
38974
39418
|
|
|
38975
39419
|
/**
|
|
@@ -39444,7 +39888,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39444
39888
|
/**
|
|
39445
39889
|
* OrganizationAuthorization service.
|
|
39446
39890
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39447
|
-
* @version
|
|
39891
|
+
* @version 197.0.0
|
|
39448
39892
|
*/
|
|
39449
39893
|
|
|
39450
39894
|
/**
|
|
@@ -40791,7 +41235,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40791
41235
|
/**
|
|
40792
41236
|
* Outbound service.
|
|
40793
41237
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40794
|
-
* @version
|
|
41238
|
+
* @version 197.0.0
|
|
40795
41239
|
*/
|
|
40796
41240
|
|
|
40797
41241
|
/**
|
|
@@ -43407,6 +43851,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43407
43851
|
);
|
|
43408
43852
|
}
|
|
43409
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
|
+
|
|
43410
43884
|
/**
|
|
43411
43885
|
* Add entries to or delete entries from a DNC list.
|
|
43412
43886
|
* Only Internal DNC lists may be deleted from
|
|
@@ -43547,40 +44021,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43547
44021
|
);
|
|
43548
44022
|
}
|
|
43549
44023
|
|
|
43550
|
-
/**
|
|
43551
|
-
* Retrieves audits for dialer. (Deprecated)
|
|
43552
|
-
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
43553
|
-
* @param {Object} body AuditSearch
|
|
43554
|
-
* @param {Object} opts Optional parameters
|
|
43555
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43556
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43557
|
-
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
43558
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
43559
|
-
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
43560
|
-
* @deprecated
|
|
43561
|
-
*/
|
|
43562
|
-
postOutboundAudits(body, opts) {
|
|
43563
|
-
opts = opts || {};
|
|
43564
|
-
|
|
43565
|
-
// verify the required parameter 'body' is set
|
|
43566
|
-
if (body === undefined || body === null) {
|
|
43567
|
-
throw 'Missing the required parameter "body" when calling postOutboundAudits';
|
|
43568
|
-
}
|
|
43569
|
-
|
|
43570
|
-
return this.apiClient.callApi(
|
|
43571
|
-
'/api/v2/outbound/audits',
|
|
43572
|
-
'POST',
|
|
43573
|
-
{ },
|
|
43574
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'facetsOnly': opts['facetsOnly'] },
|
|
43575
|
-
{ },
|
|
43576
|
-
{ },
|
|
43577
|
-
body,
|
|
43578
|
-
['PureCloud OAuth'],
|
|
43579
|
-
['application/json'],
|
|
43580
|
-
['application/json']
|
|
43581
|
-
);
|
|
43582
|
-
}
|
|
43583
|
-
|
|
43584
44024
|
/**
|
|
43585
44025
|
* Create callable time set
|
|
43586
44026
|
*
|
|
@@ -45157,7 +45597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45157
45597
|
/**
|
|
45158
45598
|
* Presence service.
|
|
45159
45599
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45160
|
-
* @version
|
|
45600
|
+
* @version 197.0.0
|
|
45161
45601
|
*/
|
|
45162
45602
|
|
|
45163
45603
|
/**
|
|
@@ -45901,7 +46341,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45901
46341
|
/**
|
|
45902
46342
|
* ProcessAutomation service.
|
|
45903
46343
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45904
|
-
* @version
|
|
46344
|
+
* @version 197.0.0
|
|
45905
46345
|
*/
|
|
45906
46346
|
|
|
45907
46347
|
/**
|
|
@@ -46140,7 +46580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46140
46580
|
/**
|
|
46141
46581
|
* Quality service.
|
|
46142
46582
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46143
|
-
* @version
|
|
46583
|
+
* @version 197.0.0
|
|
46144
46584
|
*/
|
|
46145
46585
|
|
|
46146
46586
|
/**
|
|
@@ -46632,9 +47072,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46632
47072
|
* @param {Object} opts Optional parameters
|
|
46633
47073
|
* @param {Number} opts.pageSize The total page size requested (default to 25)
|
|
46634
47074
|
* @param {Number} opts.pageNumber The page number requested (default to 1)
|
|
46635
|
-
* @param {String} opts.sortBy NOTE: Does not work when querying evaluations
|
|
46636
47075
|
* @param {Array.<String>} opts.expand variable name requested by expand list
|
|
46637
|
-
* @param {String} opts.nextPage NOTE: Does not work when querying evaluations
|
|
46638
47076
|
* @param {String} opts.previousPage Previous page token
|
|
46639
47077
|
* @param {String} opts.conversationId conversationId specified
|
|
46640
47078
|
* @param {String} opts.agentUserId user id of the agent
|
|
@@ -46660,7 +47098,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46660
47098
|
'/api/v2/quality/evaluations/query',
|
|
46661
47099
|
'GET',
|
|
46662
47100
|
{ },
|
|
46663
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'
|
|
47101
|
+
{ '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'] },
|
|
46664
47102
|
{ },
|
|
46665
47103
|
{ },
|
|
46666
47104
|
null,
|
|
@@ -47897,7 +48335,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47897
48335
|
/**
|
|
47898
48336
|
* Recording service.
|
|
47899
48337
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47900
|
-
* @version
|
|
48338
|
+
* @version 197.0.0
|
|
47901
48339
|
*/
|
|
47902
48340
|
|
|
47903
48341
|
/**
|
|
@@ -49555,7 +49993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49555
49993
|
/**
|
|
49556
49994
|
* ResponseManagement service.
|
|
49557
49995
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49558
|
-
* @version
|
|
49996
|
+
* @version 197.0.0
|
|
49559
49997
|
*/
|
|
49560
49998
|
|
|
49561
49999
|
/**
|
|
@@ -50065,7 +50503,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50065
50503
|
/**
|
|
50066
50504
|
* Routing service.
|
|
50067
50505
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50068
|
-
* @version
|
|
50506
|
+
* @version 197.0.0
|
|
50069
50507
|
*/
|
|
50070
50508
|
|
|
50071
50509
|
/**
|
|
@@ -51976,6 +52414,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51976
52414
|
* @param {Object} opts.sortOrder Sort order
|
|
51977
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)
|
|
51978
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
|
|
51979
52418
|
*/
|
|
51980
52419
|
getRoutingSmsPhonenumbers(opts) {
|
|
51981
52420
|
opts = opts || {};
|
|
@@ -51985,7 +52424,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51985
52424
|
'/api/v2/routing/sms/phonenumbers',
|
|
51986
52425
|
'GET',
|
|
51987
52426
|
{ },
|
|
51988
|
-
{ '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'] },
|
|
51989
52428
|
{ },
|
|
51990
52429
|
{ },
|
|
51991
52430
|
null,
|
|
@@ -54038,7 +54477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54038
54477
|
/**
|
|
54039
54478
|
* SCIM service.
|
|
54040
54479
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54041
|
-
* @version
|
|
54480
|
+
* @version 197.0.0
|
|
54042
54481
|
*/
|
|
54043
54482
|
|
|
54044
54483
|
/**
|
|
@@ -54915,7 +55354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54915
55354
|
/**
|
|
54916
55355
|
* ScreenRecording service.
|
|
54917
55356
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54918
|
-
* @version
|
|
55357
|
+
* @version 197.0.0
|
|
54919
55358
|
*/
|
|
54920
55359
|
|
|
54921
55360
|
/**
|
|
@@ -54960,7 +55399,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54960
55399
|
/**
|
|
54961
55400
|
* Scripts service.
|
|
54962
55401
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54963
|
-
* @version
|
|
55402
|
+
* @version 197.0.0
|
|
54964
55403
|
*/
|
|
54965
55404
|
|
|
54966
55405
|
/**
|
|
@@ -55404,7 +55843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55404
55843
|
/**
|
|
55405
55844
|
* Search service.
|
|
55406
55845
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55407
|
-
* @version
|
|
55846
|
+
* @version 197.0.0
|
|
55408
55847
|
*/
|
|
55409
55848
|
|
|
55410
55849
|
/**
|
|
@@ -56093,7 +56532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56093
56532
|
/**
|
|
56094
56533
|
* Settings service.
|
|
56095
56534
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56096
|
-
* @version
|
|
56535
|
+
* @version 197.0.0
|
|
56097
56536
|
*/
|
|
56098
56537
|
|
|
56099
56538
|
/**
|
|
@@ -56108,6 +56547,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56108
56547
|
}
|
|
56109
56548
|
|
|
56110
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
|
+
|
|
56111
56575
|
/**
|
|
56112
56576
|
* Get email Contact Center settings
|
|
56113
56577
|
*
|
|
@@ -56149,6 +56613,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56149
56613
|
);
|
|
56150
56614
|
}
|
|
56151
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
|
+
|
|
56152
56641
|
/**
|
|
56153
56642
|
* Patch email Contact Center settings
|
|
56154
56643
|
*
|
|
@@ -56199,13 +56688,73 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56199
56688
|
);
|
|
56200
56689
|
}
|
|
56201
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
|
+
|
|
56202
56751
|
}
|
|
56203
56752
|
|
|
56204
56753
|
class SpeechTextAnalyticsApi {
|
|
56205
56754
|
/**
|
|
56206
56755
|
* SpeechTextAnalytics service.
|
|
56207
56756
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56208
|
-
* @version
|
|
56757
|
+
* @version 197.0.0
|
|
56209
56758
|
*/
|
|
56210
56759
|
|
|
56211
56760
|
/**
|
|
@@ -57483,7 +58032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57483
58032
|
/**
|
|
57484
58033
|
* Stations service.
|
|
57485
58034
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57486
|
-
* @version
|
|
58035
|
+
* @version 197.0.0
|
|
57487
58036
|
*/
|
|
57488
58037
|
|
|
57489
58038
|
/**
|
|
@@ -57585,7 +58134,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57585
58134
|
/**
|
|
57586
58135
|
* Suggest service.
|
|
57587
58136
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57588
|
-
* @version
|
|
58137
|
+
* @version 197.0.0
|
|
57589
58138
|
*/
|
|
57590
58139
|
|
|
57591
58140
|
/**
|
|
@@ -57724,7 +58273,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57724
58273
|
/**
|
|
57725
58274
|
* TaskManagement service.
|
|
57726
58275
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57727
|
-
* @version
|
|
58276
|
+
* @version 197.0.0
|
|
57728
58277
|
*/
|
|
57729
58278
|
|
|
57730
58279
|
/**
|
|
@@ -59072,7 +59621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59072
59621
|
/**
|
|
59073
59622
|
* Teams service.
|
|
59074
59623
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59075
|
-
* @version
|
|
59624
|
+
* @version 197.0.0
|
|
59076
59625
|
*/
|
|
59077
59626
|
|
|
59078
59627
|
/**
|
|
@@ -59373,7 +59922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59373
59922
|
/**
|
|
59374
59923
|
* Telephony service.
|
|
59375
59924
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59376
|
-
* @version
|
|
59925
|
+
* @version 197.0.0
|
|
59377
59926
|
*/
|
|
59378
59927
|
|
|
59379
59928
|
/**
|
|
@@ -59555,7 +60104,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59555
60104
|
/**
|
|
59556
60105
|
* TelephonyProvidersEdge service.
|
|
59557
60106
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59558
|
-
* @version
|
|
60107
|
+
* @version 197.0.0
|
|
59559
60108
|
*/
|
|
59560
60109
|
|
|
59561
60110
|
/**
|
|
@@ -62883,7 +63432,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62883
63432
|
/**
|
|
62884
63433
|
* Textbots service.
|
|
62885
63434
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62886
|
-
* @version
|
|
63435
|
+
* @version 197.0.0
|
|
62887
63436
|
*/
|
|
62888
63437
|
|
|
62889
63438
|
/**
|
|
@@ -63011,7 +63560,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63011
63560
|
/**
|
|
63012
63561
|
* Tokens service.
|
|
63013
63562
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63014
|
-
* @version
|
|
63563
|
+
* @version 197.0.0
|
|
63015
63564
|
*/
|
|
63016
63565
|
|
|
63017
63566
|
/**
|
|
@@ -63165,7 +63714,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63165
63714
|
/**
|
|
63166
63715
|
* Uploads service.
|
|
63167
63716
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63168
|
-
* @version
|
|
63717
|
+
* @version 197.0.0
|
|
63169
63718
|
*/
|
|
63170
63719
|
|
|
63171
63720
|
/**
|
|
@@ -63434,7 +63983,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63434
63983
|
/**
|
|
63435
63984
|
* Usage service.
|
|
63436
63985
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63437
|
-
* @version
|
|
63986
|
+
* @version 197.0.0
|
|
63438
63987
|
*/
|
|
63439
63988
|
|
|
63440
63989
|
/**
|
|
@@ -63649,7 +64198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63649
64198
|
/**
|
|
63650
64199
|
* UserRecordings service.
|
|
63651
64200
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63652
|
-
* @version
|
|
64201
|
+
* @version 197.0.0
|
|
63653
64202
|
*/
|
|
63654
64203
|
|
|
63655
64204
|
/**
|
|
@@ -63834,7 +64383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63834
64383
|
/**
|
|
63835
64384
|
* Users service.
|
|
63836
64385
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63837
|
-
* @version
|
|
64386
|
+
* @version 197.0.0
|
|
63838
64387
|
*/
|
|
63839
64388
|
|
|
63840
64389
|
/**
|
|
@@ -66492,7 +67041,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66492
67041
|
/**
|
|
66493
67042
|
* Utilities service.
|
|
66494
67043
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66495
|
-
* @version
|
|
67044
|
+
* @version 197.0.0
|
|
66496
67045
|
*/
|
|
66497
67046
|
|
|
66498
67047
|
/**
|
|
@@ -66603,7 +67152,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66603
67152
|
/**
|
|
66604
67153
|
* Voicemail service.
|
|
66605
67154
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66606
|
-
* @version
|
|
67155
|
+
* @version 197.0.0
|
|
66607
67156
|
*/
|
|
66608
67157
|
|
|
66609
67158
|
/**
|
|
@@ -67270,7 +67819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67270
67819
|
/**
|
|
67271
67820
|
* WebChat service.
|
|
67272
67821
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67273
|
-
* @version
|
|
67822
|
+
* @version 197.0.0
|
|
67274
67823
|
*/
|
|
67275
67824
|
|
|
67276
67825
|
/**
|
|
@@ -67821,7 +68370,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67821
68370
|
/**
|
|
67822
68371
|
* WebDeployments service.
|
|
67823
68372
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67824
|
-
* @version
|
|
68373
|
+
* @version 197.0.0
|
|
67825
68374
|
*/
|
|
67826
68375
|
|
|
67827
68376
|
/**
|
|
@@ -68348,7 +68897,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68348
68897
|
/**
|
|
68349
68898
|
* WebMessaging service.
|
|
68350
68899
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68351
|
-
* @version
|
|
68900
|
+
* @version 197.0.0
|
|
68352
68901
|
*/
|
|
68353
68902
|
|
|
68354
68903
|
/**
|
|
@@ -68394,7 +68943,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68394
68943
|
/**
|
|
68395
68944
|
* Widgets service.
|
|
68396
68945
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68397
|
-
* @version
|
|
68946
|
+
* @version 197.0.0
|
|
68398
68947
|
*/
|
|
68399
68948
|
|
|
68400
68949
|
/**
|
|
@@ -68540,7 +69089,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68540
69089
|
/**
|
|
68541
69090
|
* WorkforceManagement service.
|
|
68542
69091
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68543
|
-
* @version
|
|
69092
|
+
* @version 197.0.0
|
|
68544
69093
|
*/
|
|
68545
69094
|
|
|
68546
69095
|
/**
|
|
@@ -74453,7 +75002,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74453
75002
|
* </pre>
|
|
74454
75003
|
* </p>
|
|
74455
75004
|
* @module purecloud-platform-client-v2/index
|
|
74456
|
-
* @version
|
|
75005
|
+
* @version 197.0.0
|
|
74457
75006
|
*/
|
|
74458
75007
|
class platformClient {
|
|
74459
75008
|
constructor() {
|
|
@@ -74467,6 +75016,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74467
75016
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
74468
75017
|
*/
|
|
74469
75018
|
this.ApiClientClass = ApiClient;
|
|
75019
|
+
/**
|
|
75020
|
+
* The AgentUIApi service constructor.
|
|
75021
|
+
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|
|
75022
|
+
*/
|
|
75023
|
+
this.AgentUIApi = AgentUIApi;
|
|
74470
75024
|
/**
|
|
74471
75025
|
* The AlertingApi service constructor.
|
|
74472
75026
|
* @property {module:purecloud-platform-client-v2/api/AlertingApi}
|
|
@@ -74537,6 +75091,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74537
75091
|
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
74538
75092
|
*/
|
|
74539
75093
|
this.EmailsApi = EmailsApi;
|
|
75094
|
+
/**
|
|
75095
|
+
* The EmployeeEngagementApi service constructor.
|
|
75096
|
+
* @property {module:purecloud-platform-client-v2/api/EmployeeEngagementApi}
|
|
75097
|
+
*/
|
|
75098
|
+
this.EmployeeEngagementApi = EmployeeEngagementApi;
|
|
74540
75099
|
/**
|
|
74541
75100
|
* The EventsApi service constructor.
|
|
74542
75101
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|