purecloud-platform-client-v2 196.0.0 → 198.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 +972 -148
- package/dist/web-amd/purecloud-platform-client-v2.js +972 -148
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +323 -110
- package/dist/web-cjs/purecloud-platform-client-v2.js +327 -111
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +791 -121
- 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 +165 -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 +9 -5
- 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 +32 -3
- 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 +32 -36
- 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 +32 -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 +3 -2
- 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 +3 -3
- 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 +222 -27
- package/src/purecloud-platform-client-v2/index.js +13 -1
|
@@ -405,7 +405,7 @@ class Configuration {
|
|
|
405
405
|
|
|
406
406
|
/**
|
|
407
407
|
* @module purecloud-platform-client-v2/ApiClient
|
|
408
|
-
* @version
|
|
408
|
+
* @version 198.0.0
|
|
409
409
|
*/
|
|
410
410
|
class ApiClient {
|
|
411
411
|
/**
|
|
@@ -1823,11 +1823,142 @@ class ApiClient {
|
|
|
1823
1823
|
}
|
|
1824
1824
|
}
|
|
1825
1825
|
|
|
1826
|
+
class AgentUIApi {
|
|
1827
|
+
/**
|
|
1828
|
+
* AgentUI service.
|
|
1829
|
+
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
1830
|
+
* @version 198.0.0
|
|
1831
|
+
*/
|
|
1832
|
+
|
|
1833
|
+
/**
|
|
1834
|
+
* Constructs a new AgentUIApi.
|
|
1835
|
+
* @alias module:purecloud-platform-client-v2/api/AgentUIApi
|
|
1836
|
+
* @class
|
|
1837
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
1838
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
1839
|
+
*/
|
|
1840
|
+
constructor(apiClient) {
|
|
1841
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
1842
|
+
}
|
|
1843
|
+
|
|
1844
|
+
|
|
1845
|
+
/**
|
|
1846
|
+
* Delete agent auto answer settings
|
|
1847
|
+
*
|
|
1848
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1849
|
+
*/
|
|
1850
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
1851
|
+
// verify the required parameter 'agentId' is set
|
|
1852
|
+
if (agentId === undefined || agentId === null) {
|
|
1853
|
+
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1854
|
+
}
|
|
1855
|
+
|
|
1856
|
+
return this.apiClient.callApi(
|
|
1857
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1858
|
+
'DELETE',
|
|
1859
|
+
{ 'agentId': agentId },
|
|
1860
|
+
{ },
|
|
1861
|
+
{ },
|
|
1862
|
+
{ },
|
|
1863
|
+
null,
|
|
1864
|
+
['PureCloud OAuth'],
|
|
1865
|
+
['application/json'],
|
|
1866
|
+
['application/json']
|
|
1867
|
+
);
|
|
1868
|
+
}
|
|
1869
|
+
|
|
1870
|
+
/**
|
|
1871
|
+
* Get agent auto answer settings
|
|
1872
|
+
*
|
|
1873
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1874
|
+
*/
|
|
1875
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
1876
|
+
// verify the required parameter 'agentId' is set
|
|
1877
|
+
if (agentId === undefined || agentId === null) {
|
|
1878
|
+
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1879
|
+
}
|
|
1880
|
+
|
|
1881
|
+
return this.apiClient.callApi(
|
|
1882
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1883
|
+
'GET',
|
|
1884
|
+
{ 'agentId': agentId },
|
|
1885
|
+
{ },
|
|
1886
|
+
{ },
|
|
1887
|
+
{ },
|
|
1888
|
+
null,
|
|
1889
|
+
['PureCloud OAuth'],
|
|
1890
|
+
['application/json'],
|
|
1891
|
+
['application/json']
|
|
1892
|
+
);
|
|
1893
|
+
}
|
|
1894
|
+
|
|
1895
|
+
/**
|
|
1896
|
+
* Update agent auto answer settings
|
|
1897
|
+
*
|
|
1898
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1899
|
+
* @param {Object} body AutoAnswerSettings
|
|
1900
|
+
*/
|
|
1901
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
1902
|
+
// verify the required parameter 'agentId' is set
|
|
1903
|
+
if (agentId === undefined || agentId === null) {
|
|
1904
|
+
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1905
|
+
}
|
|
1906
|
+
// verify the required parameter 'body' is set
|
|
1907
|
+
if (body === undefined || body === null) {
|
|
1908
|
+
throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1909
|
+
}
|
|
1910
|
+
|
|
1911
|
+
return this.apiClient.callApi(
|
|
1912
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1913
|
+
'PATCH',
|
|
1914
|
+
{ 'agentId': agentId },
|
|
1915
|
+
{ },
|
|
1916
|
+
{ },
|
|
1917
|
+
{ },
|
|
1918
|
+
body,
|
|
1919
|
+
['PureCloud OAuth'],
|
|
1920
|
+
['application/json'],
|
|
1921
|
+
['application/json']
|
|
1922
|
+
);
|
|
1923
|
+
}
|
|
1924
|
+
|
|
1925
|
+
/**
|
|
1926
|
+
* Set agent auto answer settings
|
|
1927
|
+
*
|
|
1928
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
1929
|
+
* @param {Object} body AutoAnswerSettings
|
|
1930
|
+
*/
|
|
1931
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
1932
|
+
// verify the required parameter 'agentId' is set
|
|
1933
|
+
if (agentId === undefined || agentId === null) {
|
|
1934
|
+
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1935
|
+
}
|
|
1936
|
+
// verify the required parameter 'body' is set
|
|
1937
|
+
if (body === undefined || body === null) {
|
|
1938
|
+
throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
1939
|
+
}
|
|
1940
|
+
|
|
1941
|
+
return this.apiClient.callApi(
|
|
1942
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
1943
|
+
'PUT',
|
|
1944
|
+
{ 'agentId': agentId },
|
|
1945
|
+
{ },
|
|
1946
|
+
{ },
|
|
1947
|
+
{ },
|
|
1948
|
+
body,
|
|
1949
|
+
['PureCloud OAuth'],
|
|
1950
|
+
['application/json'],
|
|
1951
|
+
['application/json']
|
|
1952
|
+
);
|
|
1953
|
+
}
|
|
1954
|
+
|
|
1955
|
+
}
|
|
1956
|
+
|
|
1826
1957
|
class AlertingApi {
|
|
1827
1958
|
/**
|
|
1828
1959
|
* Alerting service.
|
|
1829
1960
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
1830
|
-
* @version
|
|
1961
|
+
* @version 198.0.0
|
|
1831
1962
|
*/
|
|
1832
1963
|
|
|
1833
1964
|
/**
|
|
@@ -2488,7 +2619,7 @@ class AnalyticsApi {
|
|
|
2488
2619
|
/**
|
|
2489
2620
|
* Analytics service.
|
|
2490
2621
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
2491
|
-
* @version
|
|
2622
|
+
* @version 198.0.0
|
|
2492
2623
|
*/
|
|
2493
2624
|
|
|
2494
2625
|
/**
|
|
@@ -5100,7 +5231,7 @@ class ArchitectApi {
|
|
|
5100
5231
|
/**
|
|
5101
5232
|
* Architect service.
|
|
5102
5233
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
5103
|
-
* @version
|
|
5234
|
+
* @version 198.0.0
|
|
5104
5235
|
*/
|
|
5105
5236
|
|
|
5106
5237
|
/**
|
|
@@ -9246,7 +9377,7 @@ class AuditApi {
|
|
|
9246
9377
|
/**
|
|
9247
9378
|
* Audit service.
|
|
9248
9379
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
9249
|
-
* @version
|
|
9380
|
+
* @version 198.0.0
|
|
9250
9381
|
*/
|
|
9251
9382
|
|
|
9252
9383
|
/**
|
|
@@ -9446,7 +9577,7 @@ class AuthorizationApi {
|
|
|
9446
9577
|
/**
|
|
9447
9578
|
* Authorization service.
|
|
9448
9579
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
9449
|
-
* @version
|
|
9580
|
+
* @version 198.0.0
|
|
9450
9581
|
*/
|
|
9451
9582
|
|
|
9452
9583
|
/**
|
|
@@ -10684,7 +10815,7 @@ class BillingApi {
|
|
|
10684
10815
|
/**
|
|
10685
10816
|
* Billing service.
|
|
10686
10817
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
10687
|
-
* @version
|
|
10818
|
+
* @version 198.0.0
|
|
10688
10819
|
*/
|
|
10689
10820
|
|
|
10690
10821
|
/**
|
|
@@ -10764,7 +10895,7 @@ class CarrierServicesApi {
|
|
|
10764
10895
|
/**
|
|
10765
10896
|
* CarrierServices service.
|
|
10766
10897
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
10767
|
-
* @version
|
|
10898
|
+
* @version 198.0.0
|
|
10768
10899
|
*/
|
|
10769
10900
|
|
|
10770
10901
|
/**
|
|
@@ -10834,7 +10965,7 @@ class ChatApi {
|
|
|
10834
10965
|
/**
|
|
10835
10966
|
* Chat service.
|
|
10836
10967
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
10837
|
-
* @version
|
|
10968
|
+
* @version 198.0.0
|
|
10838
10969
|
*/
|
|
10839
10970
|
|
|
10840
10971
|
/**
|
|
@@ -11770,7 +11901,7 @@ class CoachingApi {
|
|
|
11770
11901
|
/**
|
|
11771
11902
|
* Coaching service.
|
|
11772
11903
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
11773
|
-
* @version
|
|
11904
|
+
* @version 198.0.0
|
|
11774
11905
|
*/
|
|
11775
11906
|
|
|
11776
11907
|
/**
|
|
@@ -12347,7 +12478,7 @@ class ContentManagementApi {
|
|
|
12347
12478
|
/**
|
|
12348
12479
|
* ContentManagement service.
|
|
12349
12480
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
12350
|
-
* @version
|
|
12481
|
+
* @version 198.0.0
|
|
12351
12482
|
*/
|
|
12352
12483
|
|
|
12353
12484
|
/**
|
|
@@ -13429,7 +13560,7 @@ class ConversationsApi {
|
|
|
13429
13560
|
/**
|
|
13430
13561
|
* Conversations service.
|
|
13431
13562
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
13432
|
-
* @version
|
|
13563
|
+
* @version 198.0.0
|
|
13433
13564
|
*/
|
|
13434
13565
|
|
|
13435
13566
|
/**
|
|
@@ -14148,6 +14279,69 @@ class ConversationsApi {
|
|
|
14148
14279
|
);
|
|
14149
14280
|
}
|
|
14150
14281
|
|
|
14282
|
+
/**
|
|
14283
|
+
* Get Suggestion.
|
|
14284
|
+
*
|
|
14285
|
+
* @param {String} conversationId Conversation ID
|
|
14286
|
+
* @param {String} suggestionId Suggestion ID
|
|
14287
|
+
*/
|
|
14288
|
+
getConversationSuggestion(conversationId, suggestionId) {
|
|
14289
|
+
// verify the required parameter 'conversationId' is set
|
|
14290
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14291
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSuggestion';
|
|
14292
|
+
}
|
|
14293
|
+
// verify the required parameter 'suggestionId' is set
|
|
14294
|
+
if (suggestionId === undefined || suggestionId === null) {
|
|
14295
|
+
throw 'Missing the required parameter "suggestionId" when calling getConversationSuggestion';
|
|
14296
|
+
}
|
|
14297
|
+
|
|
14298
|
+
return this.apiClient.callApi(
|
|
14299
|
+
'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}',
|
|
14300
|
+
'GET',
|
|
14301
|
+
{ 'conversationId': conversationId,'suggestionId': suggestionId },
|
|
14302
|
+
{ },
|
|
14303
|
+
{ },
|
|
14304
|
+
{ },
|
|
14305
|
+
null,
|
|
14306
|
+
['PureCloud OAuth'],
|
|
14307
|
+
['application/json'],
|
|
14308
|
+
['application/json']
|
|
14309
|
+
);
|
|
14310
|
+
}
|
|
14311
|
+
|
|
14312
|
+
/**
|
|
14313
|
+
* Get all suggestions for a conversation.
|
|
14314
|
+
*
|
|
14315
|
+
* @param {String} conversationId Conversation ID
|
|
14316
|
+
* @param {Object} opts Optional parameters
|
|
14317
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
14318
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
14319
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
14320
|
+
* @param {Object} opts.type Suggestion type to filter by.
|
|
14321
|
+
* @param {Object} opts.state Suggestion state to filter Copilot suggestions.
|
|
14322
|
+
*/
|
|
14323
|
+
getConversationSuggestions(conversationId, opts) {
|
|
14324
|
+
opts = opts || {};
|
|
14325
|
+
|
|
14326
|
+
// verify the required parameter 'conversationId' is set
|
|
14327
|
+
if (conversationId === undefined || conversationId === null) {
|
|
14328
|
+
throw 'Missing the required parameter "conversationId" when calling getConversationSuggestions';
|
|
14329
|
+
}
|
|
14330
|
+
|
|
14331
|
+
return this.apiClient.callApi(
|
|
14332
|
+
'/api/v2/conversations/{conversationId}/suggestions',
|
|
14333
|
+
'GET',
|
|
14334
|
+
{ 'conversationId': conversationId },
|
|
14335
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'type': opts['type'],'state': opts['state'] },
|
|
14336
|
+
{ },
|
|
14337
|
+
{ },
|
|
14338
|
+
null,
|
|
14339
|
+
['PureCloud OAuth'],
|
|
14340
|
+
['application/json'],
|
|
14341
|
+
['application/json']
|
|
14342
|
+
);
|
|
14343
|
+
}
|
|
14344
|
+
|
|
14151
14345
|
/**
|
|
14152
14346
|
* Get active conversations for the logged in user
|
|
14153
14347
|
*
|
|
@@ -17081,6 +17275,42 @@ class ConversationsApi {
|
|
|
17081
17275
|
);
|
|
17082
17276
|
}
|
|
17083
17277
|
|
|
17278
|
+
/**
|
|
17279
|
+
* Update conversation by setting its parking state
|
|
17280
|
+
*
|
|
17281
|
+
* @param {String} conversationId conversationId
|
|
17282
|
+
* @param {String} participantId participantId
|
|
17283
|
+
* @param {Object} body Parking update request
|
|
17284
|
+
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17285
|
+
*/
|
|
17286
|
+
patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) {
|
|
17287
|
+
// verify the required parameter 'conversationId' is set
|
|
17288
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17289
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';
|
|
17290
|
+
}
|
|
17291
|
+
// verify the required parameter 'participantId' is set
|
|
17292
|
+
if (participantId === undefined || participantId === null) {
|
|
17293
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';
|
|
17294
|
+
}
|
|
17295
|
+
// verify the required parameter 'body' is set
|
|
17296
|
+
if (body === undefined || body === null) {
|
|
17297
|
+
throw 'Missing the required parameter "body" when calling patchConversationsEmailParticipantParkingstate';
|
|
17298
|
+
}
|
|
17299
|
+
|
|
17300
|
+
return this.apiClient.callApi(
|
|
17301
|
+
'/api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate',
|
|
17302
|
+
'PATCH',
|
|
17303
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
17304
|
+
{ },
|
|
17305
|
+
{ },
|
|
17306
|
+
{ },
|
|
17307
|
+
body,
|
|
17308
|
+
['PureCloud OAuth'],
|
|
17309
|
+
['application/json'],
|
|
17310
|
+
['application/json']
|
|
17311
|
+
);
|
|
17312
|
+
}
|
|
17313
|
+
|
|
17084
17314
|
/**
|
|
17085
17315
|
* Update a conversation by disconnecting all of the participants
|
|
17086
17316
|
*
|
|
@@ -17963,6 +18193,71 @@ class ConversationsApi {
|
|
|
17963
18193
|
);
|
|
17964
18194
|
}
|
|
17965
18195
|
|
|
18196
|
+
/**
|
|
18197
|
+
* Save an engagement on the suggestion.
|
|
18198
|
+
*
|
|
18199
|
+
* @param {String} conversationId Conversation ID
|
|
18200
|
+
* @param {String} suggestionId Suggestion ID
|
|
18201
|
+
* @param {Object} body
|
|
18202
|
+
*/
|
|
18203
|
+
postConversationSuggestionEngagement(conversationId, suggestionId, body) {
|
|
18204
|
+
// verify the required parameter 'conversationId' is set
|
|
18205
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18206
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionEngagement';
|
|
18207
|
+
}
|
|
18208
|
+
// verify the required parameter 'suggestionId' is set
|
|
18209
|
+
if (suggestionId === undefined || suggestionId === null) {
|
|
18210
|
+
throw 'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';
|
|
18211
|
+
}
|
|
18212
|
+
// verify the required parameter 'body' is set
|
|
18213
|
+
if (body === undefined || body === null) {
|
|
18214
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionEngagement';
|
|
18215
|
+
}
|
|
18216
|
+
|
|
18217
|
+
return this.apiClient.callApi(
|
|
18218
|
+
'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement',
|
|
18219
|
+
'POST',
|
|
18220
|
+
{ 'conversationId': conversationId,'suggestionId': suggestionId },
|
|
18221
|
+
{ },
|
|
18222
|
+
{ },
|
|
18223
|
+
{ },
|
|
18224
|
+
body,
|
|
18225
|
+
['PureCloud OAuth'],
|
|
18226
|
+
['application/json'],
|
|
18227
|
+
['application/json']
|
|
18228
|
+
);
|
|
18229
|
+
}
|
|
18230
|
+
|
|
18231
|
+
/**
|
|
18232
|
+
* Suggestion feedback.
|
|
18233
|
+
*
|
|
18234
|
+
* @param {String} conversationId Conversation ID
|
|
18235
|
+
* @param {Object} body SuggestionFeedback
|
|
18236
|
+
*/
|
|
18237
|
+
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18238
|
+
// verify the required parameter 'conversationId' is set
|
|
18239
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18240
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';
|
|
18241
|
+
}
|
|
18242
|
+
// verify the required parameter 'body' is set
|
|
18243
|
+
if (body === undefined || body === null) {
|
|
18244
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';
|
|
18245
|
+
}
|
|
18246
|
+
|
|
18247
|
+
return this.apiClient.callApi(
|
|
18248
|
+
'/api/v2/conversations/{conversationId}/suggestions/feedback',
|
|
18249
|
+
'POST',
|
|
18250
|
+
{ 'conversationId': conversationId },
|
|
18251
|
+
{ },
|
|
18252
|
+
{ },
|
|
18253
|
+
{ },
|
|
18254
|
+
body,
|
|
18255
|
+
['PureCloud OAuth'],
|
|
18256
|
+
['application/json'],
|
|
18257
|
+
['application/json']
|
|
18258
|
+
);
|
|
18259
|
+
}
|
|
18260
|
+
|
|
17966
18261
|
/**
|
|
17967
18262
|
* Submit feedback for the summary.
|
|
17968
18263
|
*
|
|
@@ -20380,7 +20675,7 @@ class DataExtensionsApi {
|
|
|
20380
20675
|
/**
|
|
20381
20676
|
* DataExtensions service.
|
|
20382
20677
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20383
|
-
* @version
|
|
20678
|
+
* @version 198.0.0
|
|
20384
20679
|
*/
|
|
20385
20680
|
|
|
20386
20681
|
/**
|
|
@@ -20466,7 +20761,7 @@ class DownloadsApi {
|
|
|
20466
20761
|
/**
|
|
20467
20762
|
* Downloads service.
|
|
20468
20763
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20469
|
-
* @version
|
|
20764
|
+
* @version 198.0.0
|
|
20470
20765
|
*/
|
|
20471
20766
|
|
|
20472
20767
|
/**
|
|
@@ -20518,7 +20813,7 @@ class EmailsApi {
|
|
|
20518
20813
|
/**
|
|
20519
20814
|
* Emails service.
|
|
20520
20815
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20521
|
-
* @version
|
|
20816
|
+
* @version 198.0.0
|
|
20522
20817
|
*/
|
|
20523
20818
|
|
|
20524
20819
|
/**
|
|
@@ -20579,11 +20874,162 @@ class EmailsApi {
|
|
|
20579
20874
|
|
|
20580
20875
|
}
|
|
20581
20876
|
|
|
20877
|
+
class EmployeeEngagementApi {
|
|
20878
|
+
/**
|
|
20879
|
+
* EmployeeEngagement service.
|
|
20880
|
+
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20881
|
+
* @version 198.0.0
|
|
20882
|
+
*/
|
|
20883
|
+
|
|
20884
|
+
/**
|
|
20885
|
+
* Constructs a new EmployeeEngagementApi.
|
|
20886
|
+
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20887
|
+
* @class
|
|
20888
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20889
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20890
|
+
*/
|
|
20891
|
+
constructor(apiClient) {
|
|
20892
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
20893
|
+
}
|
|
20894
|
+
|
|
20895
|
+
|
|
20896
|
+
/**
|
|
20897
|
+
* Deletes a celebration
|
|
20898
|
+
*
|
|
20899
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20900
|
+
*/
|
|
20901
|
+
deleteEmployeeengagementCelebration(celebrationId) {
|
|
20902
|
+
// verify the required parameter 'celebrationId' is set
|
|
20903
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20904
|
+
throw 'Missing the required parameter "celebrationId" when calling deleteEmployeeengagementCelebration';
|
|
20905
|
+
}
|
|
20906
|
+
|
|
20907
|
+
return this.apiClient.callApi(
|
|
20908
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20909
|
+
'DELETE',
|
|
20910
|
+
{ 'celebrationId': celebrationId },
|
|
20911
|
+
{ },
|
|
20912
|
+
{ },
|
|
20913
|
+
{ },
|
|
20914
|
+
null,
|
|
20915
|
+
['PureCloud OAuth'],
|
|
20916
|
+
['application/json'],
|
|
20917
|
+
['application/json']
|
|
20918
|
+
);
|
|
20919
|
+
}
|
|
20920
|
+
|
|
20921
|
+
/**
|
|
20922
|
+
* Get all celebrations
|
|
20923
|
+
*
|
|
20924
|
+
* @param {Object} opts Optional parameters
|
|
20925
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
20926
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
20927
|
+
*/
|
|
20928
|
+
getEmployeeengagementCelebrations(opts) {
|
|
20929
|
+
opts = opts || {};
|
|
20930
|
+
|
|
20931
|
+
|
|
20932
|
+
return this.apiClient.callApi(
|
|
20933
|
+
'/api/v2/employeeengagement/celebrations',
|
|
20934
|
+
'GET',
|
|
20935
|
+
{ },
|
|
20936
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
20937
|
+
{ },
|
|
20938
|
+
{ },
|
|
20939
|
+
null,
|
|
20940
|
+
['PureCloud OAuth'],
|
|
20941
|
+
['application/json'],
|
|
20942
|
+
['application/json']
|
|
20943
|
+
);
|
|
20944
|
+
}
|
|
20945
|
+
|
|
20946
|
+
/**
|
|
20947
|
+
* Gets a single recognition
|
|
20948
|
+
*
|
|
20949
|
+
* @param {String} recognitionId The Recognition ID
|
|
20950
|
+
*/
|
|
20951
|
+
getEmployeeengagementRecognition(recognitionId) {
|
|
20952
|
+
// verify the required parameter 'recognitionId' is set
|
|
20953
|
+
if (recognitionId === undefined || recognitionId === null) {
|
|
20954
|
+
throw 'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';
|
|
20955
|
+
}
|
|
20956
|
+
|
|
20957
|
+
return this.apiClient.callApi(
|
|
20958
|
+
'/api/v2/employeeengagement/recognitions/{recognitionId}',
|
|
20959
|
+
'GET',
|
|
20960
|
+
{ 'recognitionId': recognitionId },
|
|
20961
|
+
{ },
|
|
20962
|
+
{ },
|
|
20963
|
+
{ },
|
|
20964
|
+
null,
|
|
20965
|
+
['PureCloud OAuth'],
|
|
20966
|
+
['application/json'],
|
|
20967
|
+
['application/json']
|
|
20968
|
+
);
|
|
20969
|
+
}
|
|
20970
|
+
|
|
20971
|
+
/**
|
|
20972
|
+
* Set a state for a celebration
|
|
20973
|
+
*
|
|
20974
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20975
|
+
* @param {Object} body Patch Celebration state
|
|
20976
|
+
*/
|
|
20977
|
+
patchEmployeeengagementCelebration(celebrationId, body) {
|
|
20978
|
+
// verify the required parameter 'celebrationId' is set
|
|
20979
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20980
|
+
throw 'Missing the required parameter "celebrationId" when calling patchEmployeeengagementCelebration';
|
|
20981
|
+
}
|
|
20982
|
+
// verify the required parameter 'body' is set
|
|
20983
|
+
if (body === undefined || body === null) {
|
|
20984
|
+
throw 'Missing the required parameter "body" when calling patchEmployeeengagementCelebration';
|
|
20985
|
+
}
|
|
20986
|
+
|
|
20987
|
+
return this.apiClient.callApi(
|
|
20988
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20989
|
+
'PATCH',
|
|
20990
|
+
{ 'celebrationId': celebrationId },
|
|
20991
|
+
{ },
|
|
20992
|
+
{ },
|
|
20993
|
+
{ },
|
|
20994
|
+
body,
|
|
20995
|
+
['PureCloud OAuth'],
|
|
20996
|
+
['application/json'],
|
|
20997
|
+
['application/json']
|
|
20998
|
+
);
|
|
20999
|
+
}
|
|
21000
|
+
|
|
21001
|
+
/**
|
|
21002
|
+
* Creates a recognition
|
|
21003
|
+
*
|
|
21004
|
+
* @param {Object} body Create Recognition
|
|
21005
|
+
*/
|
|
21006
|
+
postEmployeeengagementRecognitions(body) {
|
|
21007
|
+
// verify the required parameter 'body' is set
|
|
21008
|
+
if (body === undefined || body === null) {
|
|
21009
|
+
throw 'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';
|
|
21010
|
+
}
|
|
21011
|
+
|
|
21012
|
+
return this.apiClient.callApi(
|
|
21013
|
+
'/api/v2/employeeengagement/recognitions',
|
|
21014
|
+
'POST',
|
|
21015
|
+
{ },
|
|
21016
|
+
{ },
|
|
21017
|
+
{ },
|
|
21018
|
+
{ },
|
|
21019
|
+
body,
|
|
21020
|
+
['PureCloud OAuth'],
|
|
21021
|
+
['application/json'],
|
|
21022
|
+
['application/json']
|
|
21023
|
+
);
|
|
21024
|
+
}
|
|
21025
|
+
|
|
21026
|
+
}
|
|
21027
|
+
|
|
20582
21028
|
class EventsApi {
|
|
20583
21029
|
/**
|
|
20584
21030
|
* Events service.
|
|
20585
21031
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20586
|
-
* @version
|
|
21032
|
+
* @version 198.0.0
|
|
20587
21033
|
*/
|
|
20588
21034
|
|
|
20589
21035
|
/**
|
|
@@ -20679,7 +21125,7 @@ class ExternalContactsApi {
|
|
|
20679
21125
|
/**
|
|
20680
21126
|
* ExternalContacts service.
|
|
20681
21127
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20682
|
-
* @version
|
|
21128
|
+
* @version 198.0.0
|
|
20683
21129
|
*/
|
|
20684
21130
|
|
|
20685
21131
|
/**
|
|
@@ -20884,7 +21330,7 @@ class ExternalContactsApi {
|
|
|
20884
21330
|
*
|
|
20885
21331
|
* @param {String} contactId ExternalContact ID
|
|
20886
21332
|
* @param {Object} opts Optional parameters
|
|
20887
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21333
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
20888
21334
|
*/
|
|
20889
21335
|
getExternalcontactsContact(contactId, opts) {
|
|
20890
21336
|
opts = opts || {};
|
|
@@ -21035,7 +21481,7 @@ class ExternalContactsApi {
|
|
|
21035
21481
|
*
|
|
21036
21482
|
* @param {String} contactId ExternalContact ID
|
|
21037
21483
|
* @param {Object} opts Optional parameters
|
|
21038
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21484
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
21039
21485
|
*/
|
|
21040
21486
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
21041
21487
|
opts = opts || {};
|
|
@@ -22200,8 +22646,12 @@ class ExternalContactsApi {
|
|
|
22200
22646
|
* Fetch a contact using an identifier type and value.
|
|
22201
22647
|
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
22202
22648
|
* @param {Object} identifier
|
|
22649
|
+
* @param {Object} opts Optional parameters
|
|
22650
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
22203
22651
|
*/
|
|
22204
|
-
postExternalcontactsIdentifierlookup(identifier) {
|
|
22652
|
+
postExternalcontactsIdentifierlookup(identifier, opts) {
|
|
22653
|
+
opts = opts || {};
|
|
22654
|
+
|
|
22205
22655
|
// verify the required parameter 'identifier' is set
|
|
22206
22656
|
if (identifier === undefined || identifier === null) {
|
|
22207
22657
|
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
@@ -22211,7 +22661,7 @@ class ExternalContactsApi {
|
|
|
22211
22661
|
'/api/v2/externalcontacts/identifierlookup',
|
|
22212
22662
|
'POST',
|
|
22213
22663
|
{ },
|
|
22214
|
-
{
|
|
22664
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
22215
22665
|
{ },
|
|
22216
22666
|
{ },
|
|
22217
22667
|
identifier,
|
|
@@ -22637,7 +23087,7 @@ class FaxApi {
|
|
|
22637
23087
|
/**
|
|
22638
23088
|
* Fax service.
|
|
22639
23089
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22640
|
-
* @version
|
|
23090
|
+
* @version 198.0.0
|
|
22641
23091
|
*/
|
|
22642
23092
|
|
|
22643
23093
|
/**
|
|
@@ -22852,7 +23302,7 @@ class FlowsApi {
|
|
|
22852
23302
|
/**
|
|
22853
23303
|
* Flows service.
|
|
22854
23304
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22855
|
-
* @version
|
|
23305
|
+
* @version 198.0.0
|
|
22856
23306
|
*/
|
|
22857
23307
|
|
|
22858
23308
|
/**
|
|
@@ -23035,7 +23485,7 @@ class GamificationApi {
|
|
|
23035
23485
|
/**
|
|
23036
23486
|
* Gamification service.
|
|
23037
23487
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23038
|
-
* @version
|
|
23488
|
+
* @version 198.0.0
|
|
23039
23489
|
*/
|
|
23040
23490
|
|
|
23041
23491
|
/**
|
|
@@ -25121,7 +25571,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
25121
25571
|
/**
|
|
25122
25572
|
* GeneralDataProtectionRegulation service.
|
|
25123
25573
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25124
|
-
* @version
|
|
25574
|
+
* @version 198.0.0
|
|
25125
25575
|
*/
|
|
25126
25576
|
|
|
25127
25577
|
/**
|
|
@@ -25251,7 +25701,7 @@ class GeolocationApi {
|
|
|
25251
25701
|
/**
|
|
25252
25702
|
* Geolocation service.
|
|
25253
25703
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25254
|
-
* @version
|
|
25704
|
+
* @version 198.0.0
|
|
25255
25705
|
*/
|
|
25256
25706
|
|
|
25257
25707
|
/**
|
|
@@ -25382,7 +25832,7 @@ class GreetingsApi {
|
|
|
25382
25832
|
/**
|
|
25383
25833
|
* Greetings service.
|
|
25384
25834
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25385
|
-
* @version
|
|
25835
|
+
* @version 198.0.0
|
|
25386
25836
|
*/
|
|
25387
25837
|
|
|
25388
25838
|
/**
|
|
@@ -25837,7 +26287,7 @@ class GroupsApi {
|
|
|
25837
26287
|
/**
|
|
25838
26288
|
* Groups service.
|
|
25839
26289
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25840
|
-
* @version
|
|
26290
|
+
* @version 198.0.0
|
|
25841
26291
|
*/
|
|
25842
26292
|
|
|
25843
26293
|
/**
|
|
@@ -26356,7 +26806,7 @@ class IdentityProviderApi {
|
|
|
26356
26806
|
/**
|
|
26357
26807
|
* IdentityProvider service.
|
|
26358
26808
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26359
|
-
* @version
|
|
26809
|
+
* @version 198.0.0
|
|
26360
26810
|
*/
|
|
26361
26811
|
|
|
26362
26812
|
/**
|
|
@@ -27217,7 +27667,7 @@ class InfrastructureAsCodeApi {
|
|
|
27217
27667
|
/**
|
|
27218
27668
|
* InfrastructureAsCode service.
|
|
27219
27669
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27220
|
-
* @version
|
|
27670
|
+
* @version 198.0.0
|
|
27221
27671
|
*/
|
|
27222
27672
|
|
|
27223
27673
|
/**
|
|
@@ -27384,7 +27834,7 @@ class IntegrationsApi {
|
|
|
27384
27834
|
/**
|
|
27385
27835
|
* Integrations service.
|
|
27386
27836
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27387
|
-
* @version
|
|
27837
|
+
* @version 198.0.0
|
|
27388
27838
|
*/
|
|
27389
27839
|
|
|
27390
27840
|
/**
|
|
@@ -29736,7 +30186,7 @@ class JourneyApi {
|
|
|
29736
30186
|
/**
|
|
29737
30187
|
* Journey service.
|
|
29738
30188
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29739
|
-
* @version
|
|
30189
|
+
* @version 198.0.0
|
|
29740
30190
|
*/
|
|
29741
30191
|
|
|
29742
30192
|
/**
|
|
@@ -30480,7 +30930,7 @@ class JourneyApi {
|
|
|
30480
30930
|
* @param {Object} opts Optional parameters
|
|
30481
30931
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
30482
30932
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
30483
|
-
*
|
|
30933
|
+
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
30484
30934
|
*/
|
|
30485
30935
|
getJourneySessionEvents(sessionId, opts) {
|
|
30486
30936
|
opts = opts || {};
|
|
@@ -30494,7 +30944,7 @@ class JourneyApi {
|
|
|
30494
30944
|
'/api/v2/journey/sessions/{sessionId}/events',
|
|
30495
30945
|
'GET',
|
|
30496
30946
|
{ 'sessionId': sessionId },
|
|
30497
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
30947
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'eventType': opts['eventType'] },
|
|
30498
30948
|
{ },
|
|
30499
30949
|
{ },
|
|
30500
30950
|
null,
|
|
@@ -31113,6 +31563,35 @@ class JourneyApi {
|
|
|
31113
31563
|
);
|
|
31114
31564
|
}
|
|
31115
31565
|
|
|
31566
|
+
/**
|
|
31567
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
31568
|
+
*
|
|
31569
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
31570
|
+
* @param {Object} opts Optional parameters
|
|
31571
|
+
* @param {Object} opts.body
|
|
31572
|
+
*/
|
|
31573
|
+
postJourneyDeploymentWebevents(deploymentId, opts) {
|
|
31574
|
+
opts = opts || {};
|
|
31575
|
+
|
|
31576
|
+
// verify the required parameter 'deploymentId' is set
|
|
31577
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
31578
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';
|
|
31579
|
+
}
|
|
31580
|
+
|
|
31581
|
+
return this.apiClient.callApi(
|
|
31582
|
+
'/api/v2/journey/deployments/{deploymentId}/webevents',
|
|
31583
|
+
'POST',
|
|
31584
|
+
{ 'deploymentId': deploymentId },
|
|
31585
|
+
{ },
|
|
31586
|
+
{ },
|
|
31587
|
+
{ },
|
|
31588
|
+
opts['body'],
|
|
31589
|
+
['PureCloud OAuth'],
|
|
31590
|
+
['application/json'],
|
|
31591
|
+
['application/json']
|
|
31592
|
+
);
|
|
31593
|
+
}
|
|
31594
|
+
|
|
31116
31595
|
/**
|
|
31117
31596
|
* Query for flow paths.
|
|
31118
31597
|
*
|
|
@@ -31353,7 +31832,7 @@ class KnowledgeApi {
|
|
|
31353
31832
|
/**
|
|
31354
31833
|
* Knowledge service.
|
|
31355
31834
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31356
|
-
* @version
|
|
31835
|
+
* @version 198.0.0
|
|
31357
31836
|
*/
|
|
31358
31837
|
|
|
31359
31838
|
/**
|
|
@@ -34597,7 +35076,7 @@ class LanguageUnderstandingApi {
|
|
|
34597
35076
|
/**
|
|
34598
35077
|
* LanguageUnderstanding service.
|
|
34599
35078
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34600
|
-
* @version
|
|
35079
|
+
* @version 198.0.0
|
|
34601
35080
|
*/
|
|
34602
35081
|
|
|
34603
35082
|
/**
|
|
@@ -35631,7 +36110,7 @@ class LanguagesApi {
|
|
|
35631
36110
|
/**
|
|
35632
36111
|
* Languages service.
|
|
35633
36112
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35634
|
-
* @version
|
|
36113
|
+
* @version 198.0.0
|
|
35635
36114
|
*/
|
|
35636
36115
|
|
|
35637
36116
|
/**
|
|
@@ -35853,7 +36332,7 @@ class LearningApi {
|
|
|
35853
36332
|
/**
|
|
35854
36333
|
* Learning service.
|
|
35855
36334
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35856
|
-
* @version
|
|
36335
|
+
* @version 198.0.0
|
|
35857
36336
|
*/
|
|
35858
36337
|
|
|
35859
36338
|
/**
|
|
@@ -35954,6 +36433,7 @@ class LearningApi {
|
|
|
35954
36433
|
* @param {String} stepId The ID of Learning Assignment Step
|
|
35955
36434
|
* @param {Object} opts Optional parameters
|
|
35956
36435
|
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
36436
|
+
* @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
|
|
35957
36437
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35958
36438
|
*/
|
|
35959
36439
|
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
@@ -35972,7 +36452,7 @@ class LearningApi {
|
|
|
35972
36452
|
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35973
36453
|
'GET',
|
|
35974
36454
|
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35975
|
-
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
36455
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'defaultShareableContentObject': opts['defaultShareableContentObject'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35976
36456
|
{ },
|
|
35977
36457
|
{ },
|
|
35978
36458
|
null,
|
|
@@ -36881,7 +37361,7 @@ class LicenseApi {
|
|
|
36881
37361
|
/**
|
|
36882
37362
|
* License service.
|
|
36883
37363
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36884
|
-
* @version
|
|
37364
|
+
* @version 198.0.0
|
|
36885
37365
|
*/
|
|
36886
37366
|
|
|
36887
37367
|
/**
|
|
@@ -37119,7 +37599,7 @@ class LocationsApi {
|
|
|
37119
37599
|
/**
|
|
37120
37600
|
* Locations service.
|
|
37121
37601
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37122
|
-
* @version
|
|
37602
|
+
* @version 198.0.0
|
|
37123
37603
|
*/
|
|
37124
37604
|
|
|
37125
37605
|
/**
|
|
@@ -37355,7 +37835,7 @@ class LogCaptureApi {
|
|
|
37355
37835
|
/**
|
|
37356
37836
|
* LogCapture service.
|
|
37357
37837
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37358
|
-
* @version
|
|
37838
|
+
* @version 198.0.0
|
|
37359
37839
|
*/
|
|
37360
37840
|
|
|
37361
37841
|
/**
|
|
@@ -37555,7 +38035,7 @@ class MessagingApi {
|
|
|
37555
38035
|
/**
|
|
37556
38036
|
* Messaging service.
|
|
37557
38037
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37558
|
-
* @version
|
|
38038
|
+
* @version 198.0.0
|
|
37559
38039
|
*/
|
|
37560
38040
|
|
|
37561
38041
|
/**
|
|
@@ -37914,7 +38394,7 @@ class MobileDevicesApi {
|
|
|
37914
38394
|
/**
|
|
37915
38395
|
* MobileDevices service.
|
|
37916
38396
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37917
|
-
* @version
|
|
38397
|
+
* @version 198.0.0
|
|
37918
38398
|
*/
|
|
37919
38399
|
|
|
37920
38400
|
/**
|
|
@@ -38065,7 +38545,7 @@ class NotificationsApi {
|
|
|
38065
38545
|
/**
|
|
38066
38546
|
* Notifications service.
|
|
38067
38547
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38068
|
-
* @version
|
|
38548
|
+
* @version 198.0.0
|
|
38069
38549
|
*/
|
|
38070
38550
|
|
|
38071
38551
|
/**
|
|
@@ -38298,7 +38778,7 @@ class OAuthApi {
|
|
|
38298
38778
|
/**
|
|
38299
38779
|
* OAuth service.
|
|
38300
38780
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38301
|
-
* @version
|
|
38781
|
+
* @version 198.0.0
|
|
38302
38782
|
*/
|
|
38303
38783
|
|
|
38304
38784
|
/**
|
|
@@ -38664,7 +39144,7 @@ class ObjectsApi {
|
|
|
38664
39144
|
/**
|
|
38665
39145
|
* Objects service.
|
|
38666
39146
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38667
|
-
* @version
|
|
39147
|
+
* @version 198.0.0
|
|
38668
39148
|
*/
|
|
38669
39149
|
|
|
38670
39150
|
/**
|
|
@@ -38934,7 +39414,7 @@ class OperationalEventsApi {
|
|
|
38934
39414
|
/**
|
|
38935
39415
|
* OperationalEvents service.
|
|
38936
39416
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38937
|
-
* @version
|
|
39417
|
+
* @version 198.0.0
|
|
38938
39418
|
*/
|
|
38939
39419
|
|
|
38940
39420
|
/**
|
|
@@ -39000,7 +39480,7 @@ class OrganizationApi {
|
|
|
39000
39480
|
/**
|
|
39001
39481
|
* Organization service.
|
|
39002
39482
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39003
|
-
* @version
|
|
39483
|
+
* @version 198.0.0
|
|
39004
39484
|
*/
|
|
39005
39485
|
|
|
39006
39486
|
/**
|
|
@@ -39475,7 +39955,7 @@ class OrganizationAuthorizationApi {
|
|
|
39475
39955
|
/**
|
|
39476
39956
|
* OrganizationAuthorization service.
|
|
39477
39957
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39478
|
-
* @version
|
|
39958
|
+
* @version 198.0.0
|
|
39479
39959
|
*/
|
|
39480
39960
|
|
|
39481
39961
|
/**
|
|
@@ -40822,7 +41302,7 @@ class OutboundApi {
|
|
|
40822
41302
|
/**
|
|
40823
41303
|
* Outbound service.
|
|
40824
41304
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40825
|
-
* @version
|
|
41305
|
+
* @version 198.0.0
|
|
40826
41306
|
*/
|
|
40827
41307
|
|
|
40828
41308
|
/**
|
|
@@ -41436,7 +41916,7 @@ class OutboundApi {
|
|
|
41436
41916
|
|
|
41437
41917
|
/**
|
|
41438
41918
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
41439
|
-
*
|
|
41919
|
+
* Documented permissions are applicable based on campaign type.
|
|
41440
41920
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
41441
41921
|
*/
|
|
41442
41922
|
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
@@ -43438,6 +43918,36 @@ class OutboundApi {
|
|
|
43438
43918
|
);
|
|
43439
43919
|
}
|
|
43440
43920
|
|
|
43921
|
+
/**
|
|
43922
|
+
* Update a campaign.
|
|
43923
|
+
*
|
|
43924
|
+
* @param {String} campaignId Campaign ID
|
|
43925
|
+
* @param {Object} body CampaignPatchRequest
|
|
43926
|
+
*/
|
|
43927
|
+
patchOutboundCampaign(campaignId, body) {
|
|
43928
|
+
// verify the required parameter 'campaignId' is set
|
|
43929
|
+
if (campaignId === undefined || campaignId === null) {
|
|
43930
|
+
throw 'Missing the required parameter "campaignId" when calling patchOutboundCampaign';
|
|
43931
|
+
}
|
|
43932
|
+
// verify the required parameter 'body' is set
|
|
43933
|
+
if (body === undefined || body === null) {
|
|
43934
|
+
throw 'Missing the required parameter "body" when calling patchOutboundCampaign';
|
|
43935
|
+
}
|
|
43936
|
+
|
|
43937
|
+
return this.apiClient.callApi(
|
|
43938
|
+
'/api/v2/outbound/campaigns/{campaignId}',
|
|
43939
|
+
'PATCH',
|
|
43940
|
+
{ 'campaignId': campaignId },
|
|
43941
|
+
{ },
|
|
43942
|
+
{ },
|
|
43943
|
+
{ },
|
|
43944
|
+
body,
|
|
43945
|
+
['PureCloud OAuth'],
|
|
43946
|
+
['application/json'],
|
|
43947
|
+
['application/json']
|
|
43948
|
+
);
|
|
43949
|
+
}
|
|
43950
|
+
|
|
43441
43951
|
/**
|
|
43442
43952
|
* Add entries to or delete entries from a DNC list.
|
|
43443
43953
|
* Only Internal DNC lists may be deleted from
|
|
@@ -43578,40 +44088,6 @@ class OutboundApi {
|
|
|
43578
44088
|
);
|
|
43579
44089
|
}
|
|
43580
44090
|
|
|
43581
|
-
/**
|
|
43582
|
-
* Retrieves audits for dialer. (Deprecated)
|
|
43583
|
-
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
43584
|
-
* @param {Object} body AuditSearch
|
|
43585
|
-
* @param {Object} opts Optional parameters
|
|
43586
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43587
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43588
|
-
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
43589
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
43590
|
-
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
43591
|
-
* @deprecated
|
|
43592
|
-
*/
|
|
43593
|
-
postOutboundAudits(body, opts) {
|
|
43594
|
-
opts = opts || {};
|
|
43595
|
-
|
|
43596
|
-
// verify the required parameter 'body' is set
|
|
43597
|
-
if (body === undefined || body === null) {
|
|
43598
|
-
throw 'Missing the required parameter "body" when calling postOutboundAudits';
|
|
43599
|
-
}
|
|
43600
|
-
|
|
43601
|
-
return this.apiClient.callApi(
|
|
43602
|
-
'/api/v2/outbound/audits',
|
|
43603
|
-
'POST',
|
|
43604
|
-
{ },
|
|
43605
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'facetsOnly': opts['facetsOnly'] },
|
|
43606
|
-
{ },
|
|
43607
|
-
{ },
|
|
43608
|
-
body,
|
|
43609
|
-
['PureCloud OAuth'],
|
|
43610
|
-
['application/json'],
|
|
43611
|
-
['application/json']
|
|
43612
|
-
);
|
|
43613
|
-
}
|
|
43614
|
-
|
|
43615
44091
|
/**
|
|
43616
44092
|
* Create callable time set
|
|
43617
44093
|
*
|
|
@@ -45188,7 +45664,7 @@ class PresenceApi {
|
|
|
45188
45664
|
/**
|
|
45189
45665
|
* Presence service.
|
|
45190
45666
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45191
|
-
* @version
|
|
45667
|
+
* @version 198.0.0
|
|
45192
45668
|
*/
|
|
45193
45669
|
|
|
45194
45670
|
/**
|
|
@@ -45932,7 +46408,7 @@ class ProcessAutomationApi {
|
|
|
45932
46408
|
/**
|
|
45933
46409
|
* ProcessAutomation service.
|
|
45934
46410
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45935
|
-
* @version
|
|
46411
|
+
* @version 198.0.0
|
|
45936
46412
|
*/
|
|
45937
46413
|
|
|
45938
46414
|
/**
|
|
@@ -46171,7 +46647,7 @@ class QualityApi {
|
|
|
46171
46647
|
/**
|
|
46172
46648
|
* Quality service.
|
|
46173
46649
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46174
|
-
* @version
|
|
46650
|
+
* @version 198.0.0
|
|
46175
46651
|
*/
|
|
46176
46652
|
|
|
46177
46653
|
/**
|
|
@@ -47860,6 +48336,37 @@ class QualityApi {
|
|
|
47860
48336
|
);
|
|
47861
48337
|
}
|
|
47862
48338
|
|
|
48339
|
+
/**
|
|
48340
|
+
* Update the Predictive Scoring settings of an evaluation form.
|
|
48341
|
+
*
|
|
48342
|
+
* @param {String} formId Form ID
|
|
48343
|
+
* @param {Object} body Predictive Scoring Settings
|
|
48344
|
+
* putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48345
|
+
*/
|
|
48346
|
+
putQualityFormsEvaluationPredictivescoringSettings(formId, body) {
|
|
48347
|
+
// verify the required parameter 'formId' is set
|
|
48348
|
+
if (formId === undefined || formId === null) {
|
|
48349
|
+
throw 'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';
|
|
48350
|
+
}
|
|
48351
|
+
// verify the required parameter 'body' is set
|
|
48352
|
+
if (body === undefined || body === null) {
|
|
48353
|
+
throw 'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';
|
|
48354
|
+
}
|
|
48355
|
+
|
|
48356
|
+
return this.apiClient.callApi(
|
|
48357
|
+
'/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings',
|
|
48358
|
+
'PUT',
|
|
48359
|
+
{ 'formId': formId },
|
|
48360
|
+
{ },
|
|
48361
|
+
{ },
|
|
48362
|
+
{ },
|
|
48363
|
+
body,
|
|
48364
|
+
['PureCloud OAuth'],
|
|
48365
|
+
['application/json'],
|
|
48366
|
+
['application/json']
|
|
48367
|
+
);
|
|
48368
|
+
}
|
|
48369
|
+
|
|
47863
48370
|
/**
|
|
47864
48371
|
* Update a survey form.
|
|
47865
48372
|
*
|
|
@@ -47926,7 +48433,7 @@ class RecordingApi {
|
|
|
47926
48433
|
/**
|
|
47927
48434
|
* Recording service.
|
|
47928
48435
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47929
|
-
* @version
|
|
48436
|
+
* @version 198.0.0
|
|
47930
48437
|
*/
|
|
47931
48438
|
|
|
47932
48439
|
/**
|
|
@@ -49584,7 +50091,7 @@ class ResponseManagementApi {
|
|
|
49584
50091
|
/**
|
|
49585
50092
|
* ResponseManagement service.
|
|
49586
50093
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49587
|
-
* @version
|
|
50094
|
+
* @version 198.0.0
|
|
49588
50095
|
*/
|
|
49589
50096
|
|
|
49590
50097
|
/**
|
|
@@ -50094,7 +50601,7 @@ class RoutingApi {
|
|
|
50094
50601
|
/**
|
|
50095
50602
|
* Routing service.
|
|
50096
50603
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50097
|
-
* @version
|
|
50604
|
+
* @version 198.0.0
|
|
50098
50605
|
*/
|
|
50099
50606
|
|
|
50100
50607
|
/**
|
|
@@ -52005,6 +52512,7 @@ class RoutingApi {
|
|
|
52005
52512
|
* @param {Object} opts.sortOrder Sort order
|
|
52006
52513
|
* @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)
|
|
52007
52514
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
52515
|
+
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
52008
52516
|
*/
|
|
52009
52517
|
getRoutingSmsPhonenumbers(opts) {
|
|
52010
52518
|
opts = opts || {};
|
|
@@ -52014,7 +52522,7 @@ class RoutingApi {
|
|
|
52014
52522
|
'/api/v2/routing/sms/phonenumbers',
|
|
52015
52523
|
'GET',
|
|
52016
52524
|
{ },
|
|
52017
|
-
{ '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'] },
|
|
52525
|
+
{ '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'] },
|
|
52018
52526
|
{ },
|
|
52019
52527
|
{ },
|
|
52020
52528
|
null,
|
|
@@ -54067,7 +54575,7 @@ class SCIMApi {
|
|
|
54067
54575
|
/**
|
|
54068
54576
|
* SCIM service.
|
|
54069
54577
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54070
|
-
* @version
|
|
54578
|
+
* @version 198.0.0
|
|
54071
54579
|
*/
|
|
54072
54580
|
|
|
54073
54581
|
/**
|
|
@@ -54944,7 +55452,7 @@ class ScreenRecordingApi {
|
|
|
54944
55452
|
/**
|
|
54945
55453
|
* ScreenRecording service.
|
|
54946
55454
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54947
|
-
* @version
|
|
55455
|
+
* @version 198.0.0
|
|
54948
55456
|
*/
|
|
54949
55457
|
|
|
54950
55458
|
/**
|
|
@@ -54989,7 +55497,7 @@ class ScriptsApi {
|
|
|
54989
55497
|
/**
|
|
54990
55498
|
* Scripts service.
|
|
54991
55499
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54992
|
-
* @version
|
|
55500
|
+
* @version 198.0.0
|
|
54993
55501
|
*/
|
|
54994
55502
|
|
|
54995
55503
|
/**
|
|
@@ -55433,7 +55941,7 @@ class SearchApi {
|
|
|
55433
55941
|
/**
|
|
55434
55942
|
* Search service.
|
|
55435
55943
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55436
|
-
* @version
|
|
55944
|
+
* @version 198.0.0
|
|
55437
55945
|
*/
|
|
55438
55946
|
|
|
55439
55947
|
/**
|
|
@@ -56122,7 +56630,7 @@ class SettingsApi {
|
|
|
56122
56630
|
/**
|
|
56123
56631
|
* Settings service.
|
|
56124
56632
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56125
|
-
* @version
|
|
56633
|
+
* @version 198.0.0
|
|
56126
56634
|
*/
|
|
56127
56635
|
|
|
56128
56636
|
/**
|
|
@@ -56137,6 +56645,31 @@ class SettingsApi {
|
|
|
56137
56645
|
}
|
|
56138
56646
|
|
|
56139
56647
|
|
|
56648
|
+
/**
|
|
56649
|
+
* Delete agent auto answer settings
|
|
56650
|
+
*
|
|
56651
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56652
|
+
*/
|
|
56653
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56654
|
+
// verify the required parameter 'agentId' is set
|
|
56655
|
+
if (agentId === undefined || agentId === null) {
|
|
56656
|
+
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56657
|
+
}
|
|
56658
|
+
|
|
56659
|
+
return this.apiClient.callApi(
|
|
56660
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56661
|
+
'DELETE',
|
|
56662
|
+
{ 'agentId': agentId },
|
|
56663
|
+
{ },
|
|
56664
|
+
{ },
|
|
56665
|
+
{ },
|
|
56666
|
+
null,
|
|
56667
|
+
['PureCloud OAuth'],
|
|
56668
|
+
['application/json'],
|
|
56669
|
+
['application/json']
|
|
56670
|
+
);
|
|
56671
|
+
}
|
|
56672
|
+
|
|
56140
56673
|
/**
|
|
56141
56674
|
* Get email Contact Center settings
|
|
56142
56675
|
*
|
|
@@ -56178,6 +56711,31 @@ class SettingsApi {
|
|
|
56178
56711
|
);
|
|
56179
56712
|
}
|
|
56180
56713
|
|
|
56714
|
+
/**
|
|
56715
|
+
* Get agent auto answer settings
|
|
56716
|
+
*
|
|
56717
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56718
|
+
*/
|
|
56719
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56720
|
+
// verify the required parameter 'agentId' is set
|
|
56721
|
+
if (agentId === undefined || agentId === null) {
|
|
56722
|
+
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56723
|
+
}
|
|
56724
|
+
|
|
56725
|
+
return this.apiClient.callApi(
|
|
56726
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56727
|
+
'GET',
|
|
56728
|
+
{ 'agentId': agentId },
|
|
56729
|
+
{ },
|
|
56730
|
+
{ },
|
|
56731
|
+
{ },
|
|
56732
|
+
null,
|
|
56733
|
+
['PureCloud OAuth'],
|
|
56734
|
+
['application/json'],
|
|
56735
|
+
['application/json']
|
|
56736
|
+
);
|
|
56737
|
+
}
|
|
56738
|
+
|
|
56181
56739
|
/**
|
|
56182
56740
|
* Patch email Contact Center settings
|
|
56183
56741
|
*
|
|
@@ -56228,13 +56786,73 @@ class SettingsApi {
|
|
|
56228
56786
|
);
|
|
56229
56787
|
}
|
|
56230
56788
|
|
|
56789
|
+
/**
|
|
56790
|
+
* Update agent auto answer settings
|
|
56791
|
+
*
|
|
56792
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56793
|
+
* @param {Object} body AutoAnswerSettings
|
|
56794
|
+
*/
|
|
56795
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56796
|
+
// verify the required parameter 'agentId' is set
|
|
56797
|
+
if (agentId === undefined || agentId === null) {
|
|
56798
|
+
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56799
|
+
}
|
|
56800
|
+
// verify the required parameter 'body' is set
|
|
56801
|
+
if (body === undefined || body === null) {
|
|
56802
|
+
throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56803
|
+
}
|
|
56804
|
+
|
|
56805
|
+
return this.apiClient.callApi(
|
|
56806
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56807
|
+
'PATCH',
|
|
56808
|
+
{ 'agentId': agentId },
|
|
56809
|
+
{ },
|
|
56810
|
+
{ },
|
|
56811
|
+
{ },
|
|
56812
|
+
body,
|
|
56813
|
+
['PureCloud OAuth'],
|
|
56814
|
+
['application/json'],
|
|
56815
|
+
['application/json']
|
|
56816
|
+
);
|
|
56817
|
+
}
|
|
56818
|
+
|
|
56819
|
+
/**
|
|
56820
|
+
* Set agent auto answer settings
|
|
56821
|
+
*
|
|
56822
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56823
|
+
* @param {Object} body AutoAnswerSettings
|
|
56824
|
+
*/
|
|
56825
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56826
|
+
// verify the required parameter 'agentId' is set
|
|
56827
|
+
if (agentId === undefined || agentId === null) {
|
|
56828
|
+
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56829
|
+
}
|
|
56830
|
+
// verify the required parameter 'body' is set
|
|
56831
|
+
if (body === undefined || body === null) {
|
|
56832
|
+
throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56833
|
+
}
|
|
56834
|
+
|
|
56835
|
+
return this.apiClient.callApi(
|
|
56836
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56837
|
+
'PUT',
|
|
56838
|
+
{ 'agentId': agentId },
|
|
56839
|
+
{ },
|
|
56840
|
+
{ },
|
|
56841
|
+
{ },
|
|
56842
|
+
body,
|
|
56843
|
+
['PureCloud OAuth'],
|
|
56844
|
+
['application/json'],
|
|
56845
|
+
['application/json']
|
|
56846
|
+
);
|
|
56847
|
+
}
|
|
56848
|
+
|
|
56231
56849
|
}
|
|
56232
56850
|
|
|
56233
56851
|
class SpeechTextAnalyticsApi {
|
|
56234
56852
|
/**
|
|
56235
56853
|
* SpeechTextAnalytics service.
|
|
56236
56854
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56237
|
-
* @version
|
|
56855
|
+
* @version 198.0.0
|
|
56238
56856
|
*/
|
|
56239
56857
|
|
|
56240
56858
|
/**
|
|
@@ -57512,7 +58130,7 @@ class StationsApi {
|
|
|
57512
58130
|
/**
|
|
57513
58131
|
* Stations service.
|
|
57514
58132
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57515
|
-
* @version
|
|
58133
|
+
* @version 198.0.0
|
|
57516
58134
|
*/
|
|
57517
58135
|
|
|
57518
58136
|
/**
|
|
@@ -57614,7 +58232,7 @@ class SuggestApi {
|
|
|
57614
58232
|
/**
|
|
57615
58233
|
* Suggest service.
|
|
57616
58234
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57617
|
-
* @version
|
|
58235
|
+
* @version 198.0.0
|
|
57618
58236
|
*/
|
|
57619
58237
|
|
|
57620
58238
|
/**
|
|
@@ -57753,7 +58371,7 @@ class TaskManagementApi {
|
|
|
57753
58371
|
/**
|
|
57754
58372
|
* TaskManagement service.
|
|
57755
58373
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57756
|
-
* @version
|
|
58374
|
+
* @version 198.0.0
|
|
57757
58375
|
*/
|
|
57758
58376
|
|
|
57759
58377
|
/**
|
|
@@ -58398,6 +59016,7 @@ class TaskManagementApi {
|
|
|
58398
59016
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58399
59017
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
|
|
58400
59018
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59019
|
+
* @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
|
|
58401
59020
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58402
59021
|
*/
|
|
58403
59022
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
@@ -58412,7 +59031,7 @@ class TaskManagementApi {
|
|
|
58412
59031
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/history',
|
|
58413
59032
|
'GET',
|
|
58414
59033
|
{ 'worktypeId': worktypeId },
|
|
58415
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
|
|
59034
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
58416
59035
|
{ },
|
|
58417
59036
|
{ },
|
|
58418
59037
|
null,
|
|
@@ -59101,7 +59720,7 @@ class TeamsApi {
|
|
|
59101
59720
|
/**
|
|
59102
59721
|
* Teams service.
|
|
59103
59722
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59104
|
-
* @version
|
|
59723
|
+
* @version 198.0.0
|
|
59105
59724
|
*/
|
|
59106
59725
|
|
|
59107
59726
|
/**
|
|
@@ -59402,7 +60021,7 @@ class TelephonyApi {
|
|
|
59402
60021
|
/**
|
|
59403
60022
|
* Telephony service.
|
|
59404
60023
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59405
|
-
* @version
|
|
60024
|
+
* @version 198.0.0
|
|
59406
60025
|
*/
|
|
59407
60026
|
|
|
59408
60027
|
/**
|
|
@@ -59584,7 +60203,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
59584
60203
|
/**
|
|
59585
60204
|
* TelephonyProvidersEdge service.
|
|
59586
60205
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59587
|
-
* @version
|
|
60206
|
+
* @version 198.0.0
|
|
59588
60207
|
*/
|
|
59589
60208
|
|
|
59590
60209
|
/**
|
|
@@ -62912,7 +63531,7 @@ class TextbotsApi {
|
|
|
62912
63531
|
/**
|
|
62913
63532
|
* Textbots service.
|
|
62914
63533
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62915
|
-
* @version
|
|
63534
|
+
* @version 198.0.0
|
|
62916
63535
|
*/
|
|
62917
63536
|
|
|
62918
63537
|
/**
|
|
@@ -63040,7 +63659,7 @@ class TokensApi {
|
|
|
63040
63659
|
/**
|
|
63041
63660
|
* Tokens service.
|
|
63042
63661
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63043
|
-
* @version
|
|
63662
|
+
* @version 198.0.0
|
|
63044
63663
|
*/
|
|
63045
63664
|
|
|
63046
63665
|
/**
|
|
@@ -63194,7 +63813,7 @@ class UploadsApi {
|
|
|
63194
63813
|
/**
|
|
63195
63814
|
* Uploads service.
|
|
63196
63815
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63197
|
-
* @version
|
|
63816
|
+
* @version 198.0.0
|
|
63198
63817
|
*/
|
|
63199
63818
|
|
|
63200
63819
|
/**
|
|
@@ -63463,7 +64082,7 @@ class UsageApi {
|
|
|
63463
64082
|
/**
|
|
63464
64083
|
* Usage service.
|
|
63465
64084
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63466
|
-
* @version
|
|
64085
|
+
* @version 198.0.0
|
|
63467
64086
|
*/
|
|
63468
64087
|
|
|
63469
64088
|
/**
|
|
@@ -63678,7 +64297,7 @@ class UserRecordingsApi {
|
|
|
63678
64297
|
/**
|
|
63679
64298
|
* UserRecordings service.
|
|
63680
64299
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63681
|
-
* @version
|
|
64300
|
+
* @version 198.0.0
|
|
63682
64301
|
*/
|
|
63683
64302
|
|
|
63684
64303
|
/**
|
|
@@ -63863,7 +64482,7 @@ class UsersApi {
|
|
|
63863
64482
|
/**
|
|
63864
64483
|
* Users service.
|
|
63865
64484
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63866
|
-
* @version
|
|
64485
|
+
* @version 198.0.0
|
|
63867
64486
|
*/
|
|
63868
64487
|
|
|
63869
64488
|
/**
|
|
@@ -64495,7 +65114,7 @@ class UsersApi {
|
|
|
64495
65114
|
*
|
|
64496
65115
|
* @param {String} userId User ID
|
|
64497
65116
|
* @param {Object} opts Optional parameters
|
|
64498
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65117
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
64499
65118
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
64500
65119
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
64501
65120
|
*/
|
|
@@ -65066,7 +65685,7 @@ class UsersApi {
|
|
|
65066
65685
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
65067
65686
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
65068
65687
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
65069
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65688
|
+
* @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
|
|
65070
65689
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
|
|
65071
65690
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
65072
65691
|
*/
|
|
@@ -66521,7 +67140,7 @@ class UtilitiesApi {
|
|
|
66521
67140
|
/**
|
|
66522
67141
|
* Utilities service.
|
|
66523
67142
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66524
|
-
* @version
|
|
67143
|
+
* @version 198.0.0
|
|
66525
67144
|
*/
|
|
66526
67145
|
|
|
66527
67146
|
/**
|
|
@@ -66632,7 +67251,7 @@ class VoicemailApi {
|
|
|
66632
67251
|
/**
|
|
66633
67252
|
* Voicemail service.
|
|
66634
67253
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66635
|
-
* @version
|
|
67254
|
+
* @version 198.0.0
|
|
66636
67255
|
*/
|
|
66637
67256
|
|
|
66638
67257
|
/**
|
|
@@ -67299,7 +67918,7 @@ class WebChatApi {
|
|
|
67299
67918
|
/**
|
|
67300
67919
|
* WebChat service.
|
|
67301
67920
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67302
|
-
* @version
|
|
67921
|
+
* @version 198.0.0
|
|
67303
67922
|
*/
|
|
67304
67923
|
|
|
67305
67924
|
/**
|
|
@@ -67850,7 +68469,7 @@ class WebDeploymentsApi {
|
|
|
67850
68469
|
/**
|
|
67851
68470
|
* WebDeployments service.
|
|
67852
68471
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67853
|
-
* @version
|
|
68472
|
+
* @version 198.0.0
|
|
67854
68473
|
*/
|
|
67855
68474
|
|
|
67856
68475
|
/**
|
|
@@ -68377,7 +68996,7 @@ class WebMessagingApi {
|
|
|
68377
68996
|
/**
|
|
68378
68997
|
* WebMessaging service.
|
|
68379
68998
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68380
|
-
* @version
|
|
68999
|
+
* @version 198.0.0
|
|
68381
69000
|
*/
|
|
68382
69001
|
|
|
68383
69002
|
/**
|
|
@@ -68423,7 +69042,7 @@ class WidgetsApi {
|
|
|
68423
69042
|
/**
|
|
68424
69043
|
* Widgets service.
|
|
68425
69044
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68426
|
-
* @version
|
|
69045
|
+
* @version 198.0.0
|
|
68427
69046
|
*/
|
|
68428
69047
|
|
|
68429
69048
|
/**
|
|
@@ -68569,7 +69188,7 @@ class WorkforceManagementApi {
|
|
|
68569
69188
|
/**
|
|
68570
69189
|
* WorkforceManagement service.
|
|
68571
69190
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68572
|
-
* @version
|
|
69191
|
+
* @version 198.0.0
|
|
68573
69192
|
*/
|
|
68574
69193
|
|
|
68575
69194
|
/**
|
|
@@ -69179,32 +69798,6 @@ class WorkforceManagementApi {
|
|
|
69179
69798
|
);
|
|
69180
69799
|
}
|
|
69181
69800
|
|
|
69182
|
-
/**
|
|
69183
|
-
* To get status of the modeling job.
|
|
69184
|
-
* This Endpoint is Deprecated, and not recommended to be used.
|
|
69185
|
-
* @param {String} jobId The id of the modeling job
|
|
69186
|
-
* @deprecated
|
|
69187
|
-
*/
|
|
69188
|
-
getWorkforcemanagementAdhocmodelingjob(jobId) {
|
|
69189
|
-
// verify the required parameter 'jobId' is set
|
|
69190
|
-
if (jobId === undefined || jobId === null) {
|
|
69191
|
-
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';
|
|
69192
|
-
}
|
|
69193
|
-
|
|
69194
|
-
return this.apiClient.callApi(
|
|
69195
|
-
'/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}',
|
|
69196
|
-
'GET',
|
|
69197
|
-
{ 'jobId': jobId },
|
|
69198
|
-
{ },
|
|
69199
|
-
{ },
|
|
69200
|
-
{ },
|
|
69201
|
-
null,
|
|
69202
|
-
['PureCloud OAuth'],
|
|
69203
|
-
['application/json'],
|
|
69204
|
-
['application/json']
|
|
69205
|
-
);
|
|
69206
|
-
}
|
|
69207
|
-
|
|
69208
69801
|
/**
|
|
69209
69802
|
* Get an adherence explanation
|
|
69210
69803
|
*
|
|
@@ -69368,6 +69961,129 @@ class WorkforceManagementApi {
|
|
|
69368
69961
|
);
|
|
69369
69962
|
}
|
|
69370
69963
|
|
|
69964
|
+
/**
|
|
69965
|
+
* Get an activity plan
|
|
69966
|
+
*
|
|
69967
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69968
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
69969
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69970
|
+
*/
|
|
69971
|
+
getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
|
|
69972
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69973
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69974
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69975
|
+
}
|
|
69976
|
+
// verify the required parameter 'activityPlanId' is set
|
|
69977
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
69978
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69979
|
+
}
|
|
69980
|
+
|
|
69981
|
+
return this.apiClient.callApi(
|
|
69982
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
69983
|
+
'GET',
|
|
69984
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
69985
|
+
{ },
|
|
69986
|
+
{ },
|
|
69987
|
+
{ },
|
|
69988
|
+
null,
|
|
69989
|
+
['PureCloud OAuth'],
|
|
69990
|
+
['application/json'],
|
|
69991
|
+
['application/json']
|
|
69992
|
+
);
|
|
69993
|
+
}
|
|
69994
|
+
|
|
69995
|
+
/**
|
|
69996
|
+
* Gets an activity plan run job
|
|
69997
|
+
*
|
|
69998
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69999
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
70000
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
70001
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70002
|
+
*/
|
|
70003
|
+
getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
|
|
70004
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70005
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70006
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70007
|
+
}
|
|
70008
|
+
// verify the required parameter 'activityPlanId' is set
|
|
70009
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
70010
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70011
|
+
}
|
|
70012
|
+
// verify the required parameter 'jobId' is set
|
|
70013
|
+
if (jobId === undefined || jobId === null) {
|
|
70014
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70015
|
+
}
|
|
70016
|
+
|
|
70017
|
+
return this.apiClient.callApi(
|
|
70018
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}',
|
|
70019
|
+
'GET',
|
|
70020
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId,'jobId': jobId },
|
|
70021
|
+
{ },
|
|
70022
|
+
{ },
|
|
70023
|
+
{ },
|
|
70024
|
+
null,
|
|
70025
|
+
['PureCloud OAuth'],
|
|
70026
|
+
['application/json'],
|
|
70027
|
+
['application/json']
|
|
70028
|
+
);
|
|
70029
|
+
}
|
|
70030
|
+
|
|
70031
|
+
/**
|
|
70032
|
+
* Get activity plans
|
|
70033
|
+
*
|
|
70034
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70035
|
+
* @param {Object} opts Optional parameters
|
|
70036
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
70037
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70038
|
+
*/
|
|
70039
|
+
getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
|
|
70040
|
+
opts = opts || {};
|
|
70041
|
+
|
|
70042
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70043
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70044
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';
|
|
70045
|
+
}
|
|
70046
|
+
|
|
70047
|
+
return this.apiClient.callApi(
|
|
70048
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
70049
|
+
'GET',
|
|
70050
|
+
{ 'businessUnitId': businessUnitId },
|
|
70051
|
+
{ 'state': opts['state'] },
|
|
70052
|
+
{ },
|
|
70053
|
+
{ },
|
|
70054
|
+
null,
|
|
70055
|
+
['PureCloud OAuth'],
|
|
70056
|
+
['application/json'],
|
|
70057
|
+
['application/json']
|
|
70058
|
+
);
|
|
70059
|
+
}
|
|
70060
|
+
|
|
70061
|
+
/**
|
|
70062
|
+
* Gets the latest job for all activity plans in the business unit
|
|
70063
|
+
*
|
|
70064
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70065
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70066
|
+
*/
|
|
70067
|
+
getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
|
|
70068
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70069
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70070
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';
|
|
70071
|
+
}
|
|
70072
|
+
|
|
70073
|
+
return this.apiClient.callApi(
|
|
70074
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs',
|
|
70075
|
+
'GET',
|
|
70076
|
+
{ 'businessUnitId': businessUnitId },
|
|
70077
|
+
{ },
|
|
70078
|
+
{ },
|
|
70079
|
+
{ },
|
|
70080
|
+
null,
|
|
70081
|
+
['PureCloud OAuth'],
|
|
70082
|
+
['application/json'],
|
|
70083
|
+
['application/json']
|
|
70084
|
+
);
|
|
70085
|
+
}
|
|
70086
|
+
|
|
69371
70087
|
/**
|
|
69372
70088
|
* Get intraday planning groups for the given date
|
|
69373
70089
|
*
|
|
@@ -71531,6 +72247,42 @@ class WorkforceManagementApi {
|
|
|
71531
72247
|
);
|
|
71532
72248
|
}
|
|
71533
72249
|
|
|
72250
|
+
/**
|
|
72251
|
+
* Update an activity plan
|
|
72252
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
72253
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72254
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
72255
|
+
* @param {Object} body body
|
|
72256
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
72257
|
+
*/
|
|
72258
|
+
patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
|
|
72259
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72260
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72261
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72262
|
+
}
|
|
72263
|
+
// verify the required parameter 'activityPlanId' is set
|
|
72264
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
72265
|
+
throw 'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72266
|
+
}
|
|
72267
|
+
// verify the required parameter 'body' is set
|
|
72268
|
+
if (body === undefined || body === null) {
|
|
72269
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72270
|
+
}
|
|
72271
|
+
|
|
72272
|
+
return this.apiClient.callApi(
|
|
72273
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
72274
|
+
'PATCH',
|
|
72275
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
72276
|
+
{ },
|
|
72277
|
+
{ },
|
|
72278
|
+
{ },
|
|
72279
|
+
body,
|
|
72280
|
+
['PureCloud OAuth'],
|
|
72281
|
+
['application/json'],
|
|
72282
|
+
['application/json']
|
|
72283
|
+
);
|
|
72284
|
+
}
|
|
72285
|
+
|
|
71534
72286
|
/**
|
|
71535
72287
|
* Updates the planning group
|
|
71536
72288
|
*
|
|
@@ -72338,6 +73090,68 @@ class WorkforceManagementApi {
|
|
|
72338
73090
|
);
|
|
72339
73091
|
}
|
|
72340
73092
|
|
|
73093
|
+
/**
|
|
73094
|
+
* Run an activity plan manually
|
|
73095
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
73096
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73097
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
73098
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73099
|
+
*/
|
|
73100
|
+
postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
|
|
73101
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73102
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73103
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73104
|
+
}
|
|
73105
|
+
// verify the required parameter 'activityPlanId' is set
|
|
73106
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
73107
|
+
throw 'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73108
|
+
}
|
|
73109
|
+
|
|
73110
|
+
return this.apiClient.callApi(
|
|
73111
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs',
|
|
73112
|
+
'POST',
|
|
73113
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
73114
|
+
{ },
|
|
73115
|
+
{ },
|
|
73116
|
+
{ },
|
|
73117
|
+
null,
|
|
73118
|
+
['PureCloud OAuth'],
|
|
73119
|
+
['application/json'],
|
|
73120
|
+
['application/json']
|
|
73121
|
+
);
|
|
73122
|
+
}
|
|
73123
|
+
|
|
73124
|
+
/**
|
|
73125
|
+
* Create an activity plan
|
|
73126
|
+
*
|
|
73127
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73128
|
+
* @param {Object} body body
|
|
73129
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73130
|
+
*/
|
|
73131
|
+
postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
|
|
73132
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73133
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73134
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73135
|
+
}
|
|
73136
|
+
// verify the required parameter 'body' is set
|
|
73137
|
+
if (body === undefined || body === null) {
|
|
73138
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73139
|
+
}
|
|
73140
|
+
|
|
73141
|
+
return this.apiClient.callApi(
|
|
73142
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
73143
|
+
'POST',
|
|
73144
|
+
{ 'businessUnitId': businessUnitId },
|
|
73145
|
+
{ },
|
|
73146
|
+
{ },
|
|
73147
|
+
{ },
|
|
73148
|
+
body,
|
|
73149
|
+
['PureCloud OAuth'],
|
|
73150
|
+
['application/json'],
|
|
73151
|
+
['application/json']
|
|
73152
|
+
);
|
|
73153
|
+
}
|
|
73154
|
+
|
|
72341
73155
|
/**
|
|
72342
73156
|
* Query adherence explanations across an entire business unit for the requested period
|
|
72343
73157
|
*
|
|
@@ -74482,7 +75296,7 @@ class WorkforceManagementApi {
|
|
|
74482
75296
|
* </pre>
|
|
74483
75297
|
* </p>
|
|
74484
75298
|
* @module purecloud-platform-client-v2/index
|
|
74485
|
-
* @version
|
|
75299
|
+
* @version 198.0.0
|
|
74486
75300
|
*/
|
|
74487
75301
|
class platformClient {
|
|
74488
75302
|
constructor() {
|
|
@@ -74496,6 +75310,11 @@ class platformClient {
|
|
|
74496
75310
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
74497
75311
|
*/
|
|
74498
75312
|
this.ApiClientClass = ApiClient;
|
|
75313
|
+
/**
|
|
75314
|
+
* The AgentUIApi service constructor.
|
|
75315
|
+
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|
|
75316
|
+
*/
|
|
75317
|
+
this.AgentUIApi = AgentUIApi;
|
|
74499
75318
|
/**
|
|
74500
75319
|
* The AlertingApi service constructor.
|
|
74501
75320
|
* @property {module:purecloud-platform-client-v2/api/AlertingApi}
|
|
@@ -74566,6 +75385,11 @@ class platformClient {
|
|
|
74566
75385
|
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
74567
75386
|
*/
|
|
74568
75387
|
this.EmailsApi = EmailsApi;
|
|
75388
|
+
/**
|
|
75389
|
+
* The EmployeeEngagementApi service constructor.
|
|
75390
|
+
* @property {module:purecloud-platform-client-v2/api/EmployeeEngagementApi}
|
|
75391
|
+
*/
|
|
75392
|
+
this.EmployeeEngagementApi = EmployeeEngagementApi;
|
|
74569
75393
|
/**
|
|
74570
75394
|
* The EventsApi service constructor.
|
|
74571
75395
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|