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
|
@@ -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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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
|
*
|
|
@@ -17078,6 +17272,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17078
17272
|
);
|
|
17079
17273
|
}
|
|
17080
17274
|
|
|
17275
|
+
/**
|
|
17276
|
+
* Update conversation by setting its parking state
|
|
17277
|
+
*
|
|
17278
|
+
* @param {String} conversationId conversationId
|
|
17279
|
+
* @param {String} participantId participantId
|
|
17280
|
+
* @param {Object} body Parking update request
|
|
17281
|
+
* patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17282
|
+
*/
|
|
17283
|
+
patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) {
|
|
17284
|
+
// verify the required parameter 'conversationId' is set
|
|
17285
|
+
if (conversationId === undefined || conversationId === null) {
|
|
17286
|
+
throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';
|
|
17287
|
+
}
|
|
17288
|
+
// verify the required parameter 'participantId' is set
|
|
17289
|
+
if (participantId === undefined || participantId === null) {
|
|
17290
|
+
throw 'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';
|
|
17291
|
+
}
|
|
17292
|
+
// verify the required parameter 'body' is set
|
|
17293
|
+
if (body === undefined || body === null) {
|
|
17294
|
+
throw 'Missing the required parameter "body" when calling patchConversationsEmailParticipantParkingstate';
|
|
17295
|
+
}
|
|
17296
|
+
|
|
17297
|
+
return this.apiClient.callApi(
|
|
17298
|
+
'/api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate',
|
|
17299
|
+
'PATCH',
|
|
17300
|
+
{ 'conversationId': conversationId,'participantId': participantId },
|
|
17301
|
+
{ },
|
|
17302
|
+
{ },
|
|
17303
|
+
{ },
|
|
17304
|
+
body,
|
|
17305
|
+
['PureCloud OAuth'],
|
|
17306
|
+
['application/json'],
|
|
17307
|
+
['application/json']
|
|
17308
|
+
);
|
|
17309
|
+
}
|
|
17310
|
+
|
|
17081
17311
|
/**
|
|
17082
17312
|
* Update a conversation by disconnecting all of the participants
|
|
17083
17313
|
*
|
|
@@ -17960,6 +18190,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17960
18190
|
);
|
|
17961
18191
|
}
|
|
17962
18192
|
|
|
18193
|
+
/**
|
|
18194
|
+
* Save an engagement on the suggestion.
|
|
18195
|
+
*
|
|
18196
|
+
* @param {String} conversationId Conversation ID
|
|
18197
|
+
* @param {String} suggestionId Suggestion ID
|
|
18198
|
+
* @param {Object} body
|
|
18199
|
+
*/
|
|
18200
|
+
postConversationSuggestionEngagement(conversationId, suggestionId, body) {
|
|
18201
|
+
// verify the required parameter 'conversationId' is set
|
|
18202
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18203
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionEngagement';
|
|
18204
|
+
}
|
|
18205
|
+
// verify the required parameter 'suggestionId' is set
|
|
18206
|
+
if (suggestionId === undefined || suggestionId === null) {
|
|
18207
|
+
throw 'Missing the required parameter "suggestionId" when calling postConversationSuggestionEngagement';
|
|
18208
|
+
}
|
|
18209
|
+
// verify the required parameter 'body' is set
|
|
18210
|
+
if (body === undefined || body === null) {
|
|
18211
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionEngagement';
|
|
18212
|
+
}
|
|
18213
|
+
|
|
18214
|
+
return this.apiClient.callApi(
|
|
18215
|
+
'/api/v2/conversations/{conversationId}/suggestions/{suggestionId}/engagement',
|
|
18216
|
+
'POST',
|
|
18217
|
+
{ 'conversationId': conversationId,'suggestionId': suggestionId },
|
|
18218
|
+
{ },
|
|
18219
|
+
{ },
|
|
18220
|
+
{ },
|
|
18221
|
+
body,
|
|
18222
|
+
['PureCloud OAuth'],
|
|
18223
|
+
['application/json'],
|
|
18224
|
+
['application/json']
|
|
18225
|
+
);
|
|
18226
|
+
}
|
|
18227
|
+
|
|
18228
|
+
/**
|
|
18229
|
+
* Suggestion feedback.
|
|
18230
|
+
*
|
|
18231
|
+
* @param {String} conversationId Conversation ID
|
|
18232
|
+
* @param {Object} body SuggestionFeedback
|
|
18233
|
+
*/
|
|
18234
|
+
postConversationSuggestionsFeedback(conversationId, body) {
|
|
18235
|
+
// verify the required parameter 'conversationId' is set
|
|
18236
|
+
if (conversationId === undefined || conversationId === null) {
|
|
18237
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationSuggestionsFeedback';
|
|
18238
|
+
}
|
|
18239
|
+
// verify the required parameter 'body' is set
|
|
18240
|
+
if (body === undefined || body === null) {
|
|
18241
|
+
throw 'Missing the required parameter "body" when calling postConversationSuggestionsFeedback';
|
|
18242
|
+
}
|
|
18243
|
+
|
|
18244
|
+
return this.apiClient.callApi(
|
|
18245
|
+
'/api/v2/conversations/{conversationId}/suggestions/feedback',
|
|
18246
|
+
'POST',
|
|
18247
|
+
{ 'conversationId': conversationId },
|
|
18248
|
+
{ },
|
|
18249
|
+
{ },
|
|
18250
|
+
{ },
|
|
18251
|
+
body,
|
|
18252
|
+
['PureCloud OAuth'],
|
|
18253
|
+
['application/json'],
|
|
18254
|
+
['application/json']
|
|
18255
|
+
);
|
|
18256
|
+
}
|
|
18257
|
+
|
|
17963
18258
|
/**
|
|
17964
18259
|
* Submit feedback for the summary.
|
|
17965
18260
|
*
|
|
@@ -20377,7 +20672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20377
20672
|
/**
|
|
20378
20673
|
* DataExtensions service.
|
|
20379
20674
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
20380
|
-
* @version
|
|
20675
|
+
* @version 198.0.0
|
|
20381
20676
|
*/
|
|
20382
20677
|
|
|
20383
20678
|
/**
|
|
@@ -20463,7 +20758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20463
20758
|
/**
|
|
20464
20759
|
* Downloads service.
|
|
20465
20760
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
20466
|
-
* @version
|
|
20761
|
+
* @version 198.0.0
|
|
20467
20762
|
*/
|
|
20468
20763
|
|
|
20469
20764
|
/**
|
|
@@ -20515,7 +20810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20515
20810
|
/**
|
|
20516
20811
|
* Emails service.
|
|
20517
20812
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
20518
|
-
* @version
|
|
20813
|
+
* @version 198.0.0
|
|
20519
20814
|
*/
|
|
20520
20815
|
|
|
20521
20816
|
/**
|
|
@@ -20576,11 +20871,162 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20576
20871
|
|
|
20577
20872
|
}
|
|
20578
20873
|
|
|
20874
|
+
class EmployeeEngagementApi {
|
|
20875
|
+
/**
|
|
20876
|
+
* EmployeeEngagement service.
|
|
20877
|
+
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20878
|
+
* @version 198.0.0
|
|
20879
|
+
*/
|
|
20880
|
+
|
|
20881
|
+
/**
|
|
20882
|
+
* Constructs a new EmployeeEngagementApi.
|
|
20883
|
+
* @alias module:purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
20884
|
+
* @class
|
|
20885
|
+
* @param {module:purecloud-platform-client-v2/ApiClient} apiClient Optional API client implementation to use,
|
|
20886
|
+
* default to {@link module:purecloud-platform-client-v2/ApiClient#instance} if unspecified.
|
|
20887
|
+
*/
|
|
20888
|
+
constructor(apiClient) {
|
|
20889
|
+
this.apiClient = apiClient || ApiClient.instance;
|
|
20890
|
+
}
|
|
20891
|
+
|
|
20892
|
+
|
|
20893
|
+
/**
|
|
20894
|
+
* Deletes a celebration
|
|
20895
|
+
*
|
|
20896
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20897
|
+
*/
|
|
20898
|
+
deleteEmployeeengagementCelebration(celebrationId) {
|
|
20899
|
+
// verify the required parameter 'celebrationId' is set
|
|
20900
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20901
|
+
throw 'Missing the required parameter "celebrationId" when calling deleteEmployeeengagementCelebration';
|
|
20902
|
+
}
|
|
20903
|
+
|
|
20904
|
+
return this.apiClient.callApi(
|
|
20905
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20906
|
+
'DELETE',
|
|
20907
|
+
{ 'celebrationId': celebrationId },
|
|
20908
|
+
{ },
|
|
20909
|
+
{ },
|
|
20910
|
+
{ },
|
|
20911
|
+
null,
|
|
20912
|
+
['PureCloud OAuth'],
|
|
20913
|
+
['application/json'],
|
|
20914
|
+
['application/json']
|
|
20915
|
+
);
|
|
20916
|
+
}
|
|
20917
|
+
|
|
20918
|
+
/**
|
|
20919
|
+
* Get all celebrations
|
|
20920
|
+
*
|
|
20921
|
+
* @param {Object} opts Optional parameters
|
|
20922
|
+
* @param {Number} opts.pageNumber (default to 1)
|
|
20923
|
+
* @param {Number} opts.pageSize (default to 25)
|
|
20924
|
+
*/
|
|
20925
|
+
getEmployeeengagementCelebrations(opts) {
|
|
20926
|
+
opts = opts || {};
|
|
20927
|
+
|
|
20928
|
+
|
|
20929
|
+
return this.apiClient.callApi(
|
|
20930
|
+
'/api/v2/employeeengagement/celebrations',
|
|
20931
|
+
'GET',
|
|
20932
|
+
{ },
|
|
20933
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
20934
|
+
{ },
|
|
20935
|
+
{ },
|
|
20936
|
+
null,
|
|
20937
|
+
['PureCloud OAuth'],
|
|
20938
|
+
['application/json'],
|
|
20939
|
+
['application/json']
|
|
20940
|
+
);
|
|
20941
|
+
}
|
|
20942
|
+
|
|
20943
|
+
/**
|
|
20944
|
+
* Gets a single recognition
|
|
20945
|
+
*
|
|
20946
|
+
* @param {String} recognitionId The Recognition ID
|
|
20947
|
+
*/
|
|
20948
|
+
getEmployeeengagementRecognition(recognitionId) {
|
|
20949
|
+
// verify the required parameter 'recognitionId' is set
|
|
20950
|
+
if (recognitionId === undefined || recognitionId === null) {
|
|
20951
|
+
throw 'Missing the required parameter "recognitionId" when calling getEmployeeengagementRecognition';
|
|
20952
|
+
}
|
|
20953
|
+
|
|
20954
|
+
return this.apiClient.callApi(
|
|
20955
|
+
'/api/v2/employeeengagement/recognitions/{recognitionId}',
|
|
20956
|
+
'GET',
|
|
20957
|
+
{ 'recognitionId': recognitionId },
|
|
20958
|
+
{ },
|
|
20959
|
+
{ },
|
|
20960
|
+
{ },
|
|
20961
|
+
null,
|
|
20962
|
+
['PureCloud OAuth'],
|
|
20963
|
+
['application/json'],
|
|
20964
|
+
['application/json']
|
|
20965
|
+
);
|
|
20966
|
+
}
|
|
20967
|
+
|
|
20968
|
+
/**
|
|
20969
|
+
* Set a state for a celebration
|
|
20970
|
+
*
|
|
20971
|
+
* @param {String} celebrationId The ID of the celebration
|
|
20972
|
+
* @param {Object} body Patch Celebration state
|
|
20973
|
+
*/
|
|
20974
|
+
patchEmployeeengagementCelebration(celebrationId, body) {
|
|
20975
|
+
// verify the required parameter 'celebrationId' is set
|
|
20976
|
+
if (celebrationId === undefined || celebrationId === null) {
|
|
20977
|
+
throw 'Missing the required parameter "celebrationId" when calling patchEmployeeengagementCelebration';
|
|
20978
|
+
}
|
|
20979
|
+
// verify the required parameter 'body' is set
|
|
20980
|
+
if (body === undefined || body === null) {
|
|
20981
|
+
throw 'Missing the required parameter "body" when calling patchEmployeeengagementCelebration';
|
|
20982
|
+
}
|
|
20983
|
+
|
|
20984
|
+
return this.apiClient.callApi(
|
|
20985
|
+
'/api/v2/employeeengagement/celebrations/{celebrationId}',
|
|
20986
|
+
'PATCH',
|
|
20987
|
+
{ 'celebrationId': celebrationId },
|
|
20988
|
+
{ },
|
|
20989
|
+
{ },
|
|
20990
|
+
{ },
|
|
20991
|
+
body,
|
|
20992
|
+
['PureCloud OAuth'],
|
|
20993
|
+
['application/json'],
|
|
20994
|
+
['application/json']
|
|
20995
|
+
);
|
|
20996
|
+
}
|
|
20997
|
+
|
|
20998
|
+
/**
|
|
20999
|
+
* Creates a recognition
|
|
21000
|
+
*
|
|
21001
|
+
* @param {Object} body Create Recognition
|
|
21002
|
+
*/
|
|
21003
|
+
postEmployeeengagementRecognitions(body) {
|
|
21004
|
+
// verify the required parameter 'body' is set
|
|
21005
|
+
if (body === undefined || body === null) {
|
|
21006
|
+
throw 'Missing the required parameter "body" when calling postEmployeeengagementRecognitions';
|
|
21007
|
+
}
|
|
21008
|
+
|
|
21009
|
+
return this.apiClient.callApi(
|
|
21010
|
+
'/api/v2/employeeengagement/recognitions',
|
|
21011
|
+
'POST',
|
|
21012
|
+
{ },
|
|
21013
|
+
{ },
|
|
21014
|
+
{ },
|
|
21015
|
+
{ },
|
|
21016
|
+
body,
|
|
21017
|
+
['PureCloud OAuth'],
|
|
21018
|
+
['application/json'],
|
|
21019
|
+
['application/json']
|
|
21020
|
+
);
|
|
21021
|
+
}
|
|
21022
|
+
|
|
21023
|
+
}
|
|
21024
|
+
|
|
20579
21025
|
class EventsApi {
|
|
20580
21026
|
/**
|
|
20581
21027
|
* Events service.
|
|
20582
21028
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
20583
|
-
* @version
|
|
21029
|
+
* @version 198.0.0
|
|
20584
21030
|
*/
|
|
20585
21031
|
|
|
20586
21032
|
/**
|
|
@@ -20676,7 +21122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20676
21122
|
/**
|
|
20677
21123
|
* ExternalContacts service.
|
|
20678
21124
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
20679
|
-
* @version
|
|
21125
|
+
* @version 198.0.0
|
|
20680
21126
|
*/
|
|
20681
21127
|
|
|
20682
21128
|
/**
|
|
@@ -20881,7 +21327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20881
21327
|
*
|
|
20882
21328
|
* @param {String} contactId ExternalContact ID
|
|
20883
21329
|
* @param {Object} opts Optional parameters
|
|
20884
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21330
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
20885
21331
|
*/
|
|
20886
21332
|
getExternalcontactsContact(contactId, opts) {
|
|
20887
21333
|
opts = opts || {};
|
|
@@ -21032,7 +21478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21032
21478
|
*
|
|
21033
21479
|
* @param {String} contactId ExternalContact ID
|
|
21034
21480
|
* @param {Object} opts Optional parameters
|
|
21035
|
-
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
|
|
21481
|
+
* @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
|
|
21036
21482
|
*/
|
|
21037
21483
|
getExternalcontactsContactUnresolved(contactId, opts) {
|
|
21038
21484
|
opts = opts || {};
|
|
@@ -22197,8 +22643,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22197
22643
|
* Fetch a contact using an identifier type and value.
|
|
22198
22644
|
* Phone number identifier values must be provided with the country code and a leading + symbol. Example: "+1 704 298 4733"
|
|
22199
22645
|
* @param {Object} identifier
|
|
22646
|
+
* @param {Object} opts Optional parameters
|
|
22647
|
+
* @param {Array.<String>} opts.expand which field, if any, to expand
|
|
22200
22648
|
*/
|
|
22201
|
-
postExternalcontactsIdentifierlookup(identifier) {
|
|
22649
|
+
postExternalcontactsIdentifierlookup(identifier, opts) {
|
|
22650
|
+
opts = opts || {};
|
|
22651
|
+
|
|
22202
22652
|
// verify the required parameter 'identifier' is set
|
|
22203
22653
|
if (identifier === undefined || identifier === null) {
|
|
22204
22654
|
throw 'Missing the required parameter "identifier" when calling postExternalcontactsIdentifierlookup';
|
|
@@ -22208,7 +22658,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22208
22658
|
'/api/v2/externalcontacts/identifierlookup',
|
|
22209
22659
|
'POST',
|
|
22210
22660
|
{ },
|
|
22211
|
-
{
|
|
22661
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
22212
22662
|
{ },
|
|
22213
22663
|
{ },
|
|
22214
22664
|
identifier,
|
|
@@ -22634,7 +23084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22634
23084
|
/**
|
|
22635
23085
|
* Fax service.
|
|
22636
23086
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
22637
|
-
* @version
|
|
23087
|
+
* @version 198.0.0
|
|
22638
23088
|
*/
|
|
22639
23089
|
|
|
22640
23090
|
/**
|
|
@@ -22849,7 +23299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22849
23299
|
/**
|
|
22850
23300
|
* Flows service.
|
|
22851
23301
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
22852
|
-
* @version
|
|
23302
|
+
* @version 198.0.0
|
|
22853
23303
|
*/
|
|
22854
23304
|
|
|
22855
23305
|
/**
|
|
@@ -23032,7 +23482,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23032
23482
|
/**
|
|
23033
23483
|
* Gamification service.
|
|
23034
23484
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
23035
|
-
* @version
|
|
23485
|
+
* @version 198.0.0
|
|
23036
23486
|
*/
|
|
23037
23487
|
|
|
23038
23488
|
/**
|
|
@@ -25118,7 +25568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25118
25568
|
/**
|
|
25119
25569
|
* GeneralDataProtectionRegulation service.
|
|
25120
25570
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
25121
|
-
* @version
|
|
25571
|
+
* @version 198.0.0
|
|
25122
25572
|
*/
|
|
25123
25573
|
|
|
25124
25574
|
/**
|
|
@@ -25248,7 +25698,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25248
25698
|
/**
|
|
25249
25699
|
* Geolocation service.
|
|
25250
25700
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
25251
|
-
* @version
|
|
25701
|
+
* @version 198.0.0
|
|
25252
25702
|
*/
|
|
25253
25703
|
|
|
25254
25704
|
/**
|
|
@@ -25379,7 +25829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25379
25829
|
/**
|
|
25380
25830
|
* Greetings service.
|
|
25381
25831
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
25382
|
-
* @version
|
|
25832
|
+
* @version 198.0.0
|
|
25383
25833
|
*/
|
|
25384
25834
|
|
|
25385
25835
|
/**
|
|
@@ -25834,7 +26284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25834
26284
|
/**
|
|
25835
26285
|
* Groups service.
|
|
25836
26286
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
25837
|
-
* @version
|
|
26287
|
+
* @version 198.0.0
|
|
25838
26288
|
*/
|
|
25839
26289
|
|
|
25840
26290
|
/**
|
|
@@ -26353,7 +26803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
26353
26803
|
/**
|
|
26354
26804
|
* IdentityProvider service.
|
|
26355
26805
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
26356
|
-
* @version
|
|
26806
|
+
* @version 198.0.0
|
|
26357
26807
|
*/
|
|
26358
26808
|
|
|
26359
26809
|
/**
|
|
@@ -27214,7 +27664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27214
27664
|
/**
|
|
27215
27665
|
* InfrastructureAsCode service.
|
|
27216
27666
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
27217
|
-
* @version
|
|
27667
|
+
* @version 198.0.0
|
|
27218
27668
|
*/
|
|
27219
27669
|
|
|
27220
27670
|
/**
|
|
@@ -27381,7 +27831,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27381
27831
|
/**
|
|
27382
27832
|
* Integrations service.
|
|
27383
27833
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
27384
|
-
* @version
|
|
27834
|
+
* @version 198.0.0
|
|
27385
27835
|
*/
|
|
27386
27836
|
|
|
27387
27837
|
/**
|
|
@@ -29733,7 +30183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29733
30183
|
/**
|
|
29734
30184
|
* Journey service.
|
|
29735
30185
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
29736
|
-
* @version
|
|
30186
|
+
* @version 198.0.0
|
|
29737
30187
|
*/
|
|
29738
30188
|
|
|
29739
30189
|
/**
|
|
@@ -30477,7 +30927,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30477
30927
|
* @param {Object} opts Optional parameters
|
|
30478
30928
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
30479
30929
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
30480
|
-
*
|
|
30930
|
+
* @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
|
|
30481
30931
|
*/
|
|
30482
30932
|
getJourneySessionEvents(sessionId, opts) {
|
|
30483
30933
|
opts = opts || {};
|
|
@@ -30491,7 +30941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
30491
30941
|
'/api/v2/journey/sessions/{sessionId}/events',
|
|
30492
30942
|
'GET',
|
|
30493
30943
|
{ 'sessionId': sessionId },
|
|
30494
|
-
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
30944
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'],'eventType': opts['eventType'] },
|
|
30495
30945
|
{ },
|
|
30496
30946
|
{ },
|
|
30497
30947
|
null,
|
|
@@ -31110,6 +31560,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31110
31560
|
);
|
|
31111
31561
|
}
|
|
31112
31562
|
|
|
31563
|
+
/**
|
|
31564
|
+
* Send a journey web event, used for tracking customer activity on a website.
|
|
31565
|
+
*
|
|
31566
|
+
* @param {String} deploymentId The ID of the deployment sending the web event.
|
|
31567
|
+
* @param {Object} opts Optional parameters
|
|
31568
|
+
* @param {Object} opts.body
|
|
31569
|
+
*/
|
|
31570
|
+
postJourneyDeploymentWebevents(deploymentId, opts) {
|
|
31571
|
+
opts = opts || {};
|
|
31572
|
+
|
|
31573
|
+
// verify the required parameter 'deploymentId' is set
|
|
31574
|
+
if (deploymentId === undefined || deploymentId === null) {
|
|
31575
|
+
throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';
|
|
31576
|
+
}
|
|
31577
|
+
|
|
31578
|
+
return this.apiClient.callApi(
|
|
31579
|
+
'/api/v2/journey/deployments/{deploymentId}/webevents',
|
|
31580
|
+
'POST',
|
|
31581
|
+
{ 'deploymentId': deploymentId },
|
|
31582
|
+
{ },
|
|
31583
|
+
{ },
|
|
31584
|
+
{ },
|
|
31585
|
+
opts['body'],
|
|
31586
|
+
['PureCloud OAuth'],
|
|
31587
|
+
['application/json'],
|
|
31588
|
+
['application/json']
|
|
31589
|
+
);
|
|
31590
|
+
}
|
|
31591
|
+
|
|
31113
31592
|
/**
|
|
31114
31593
|
* Query for flow paths.
|
|
31115
31594
|
*
|
|
@@ -31350,7 +31829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31350
31829
|
/**
|
|
31351
31830
|
* Knowledge service.
|
|
31352
31831
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
31353
|
-
* @version
|
|
31832
|
+
* @version 198.0.0
|
|
31354
31833
|
*/
|
|
31355
31834
|
|
|
31356
31835
|
/**
|
|
@@ -34594,7 +35073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
34594
35073
|
/**
|
|
34595
35074
|
* LanguageUnderstanding service.
|
|
34596
35075
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
34597
|
-
* @version
|
|
35076
|
+
* @version 198.0.0
|
|
34598
35077
|
*/
|
|
34599
35078
|
|
|
34600
35079
|
/**
|
|
@@ -35628,7 +36107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35628
36107
|
/**
|
|
35629
36108
|
* Languages service.
|
|
35630
36109
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
35631
|
-
* @version
|
|
36110
|
+
* @version 198.0.0
|
|
35632
36111
|
*/
|
|
35633
36112
|
|
|
35634
36113
|
/**
|
|
@@ -35850,7 +36329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35850
36329
|
/**
|
|
35851
36330
|
* Learning service.
|
|
35852
36331
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
35853
|
-
* @version
|
|
36332
|
+
* @version 198.0.0
|
|
35854
36333
|
*/
|
|
35855
36334
|
|
|
35856
36335
|
/**
|
|
@@ -35951,6 +36430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35951
36430
|
* @param {String} stepId The ID of Learning Assignment Step
|
|
35952
36431
|
* @param {Object} opts Optional parameters
|
|
35953
36432
|
* @param {String} opts.shareableContentObjectId The ID of SCO to load
|
|
36433
|
+
* @param {Object} opts.defaultShareableContentObject The default SCO to retrieve
|
|
35954
36434
|
* @param {Array.<String>} opts.expand Fields to expand in response
|
|
35955
36435
|
*/
|
|
35956
36436
|
getLearningAssignmentStep(assignmentId, stepId, opts) {
|
|
@@ -35969,7 +36449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
35969
36449
|
'/api/v2/learning/assignments/{assignmentId}/steps/{stepId}',
|
|
35970
36450
|
'GET',
|
|
35971
36451
|
{ 'assignmentId': assignmentId,'stepId': stepId },
|
|
35972
|
-
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
36452
|
+
{ 'shareableContentObjectId': opts['shareableContentObjectId'],'defaultShareableContentObject': opts['defaultShareableContentObject'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
35973
36453
|
{ },
|
|
35974
36454
|
{ },
|
|
35975
36455
|
null,
|
|
@@ -36878,7 +37358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36878
37358
|
/**
|
|
36879
37359
|
* License service.
|
|
36880
37360
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
36881
|
-
* @version
|
|
37361
|
+
* @version 198.0.0
|
|
36882
37362
|
*/
|
|
36883
37363
|
|
|
36884
37364
|
/**
|
|
@@ -37116,7 +37596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37116
37596
|
/**
|
|
37117
37597
|
* Locations service.
|
|
37118
37598
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
37119
|
-
* @version
|
|
37599
|
+
* @version 198.0.0
|
|
37120
37600
|
*/
|
|
37121
37601
|
|
|
37122
37602
|
/**
|
|
@@ -37352,7 +37832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37352
37832
|
/**
|
|
37353
37833
|
* LogCapture service.
|
|
37354
37834
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
37355
|
-
* @version
|
|
37835
|
+
* @version 198.0.0
|
|
37356
37836
|
*/
|
|
37357
37837
|
|
|
37358
37838
|
/**
|
|
@@ -37552,7 +38032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37552
38032
|
/**
|
|
37553
38033
|
* Messaging service.
|
|
37554
38034
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
37555
|
-
* @version
|
|
38035
|
+
* @version 198.0.0
|
|
37556
38036
|
*/
|
|
37557
38037
|
|
|
37558
38038
|
/**
|
|
@@ -37911,7 +38391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37911
38391
|
/**
|
|
37912
38392
|
* MobileDevices service.
|
|
37913
38393
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
37914
|
-
* @version
|
|
38394
|
+
* @version 198.0.0
|
|
37915
38395
|
*/
|
|
37916
38396
|
|
|
37917
38397
|
/**
|
|
@@ -38062,7 +38542,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38062
38542
|
/**
|
|
38063
38543
|
* Notifications service.
|
|
38064
38544
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
38065
|
-
* @version
|
|
38545
|
+
* @version 198.0.0
|
|
38066
38546
|
*/
|
|
38067
38547
|
|
|
38068
38548
|
/**
|
|
@@ -38295,7 +38775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38295
38775
|
/**
|
|
38296
38776
|
* OAuth service.
|
|
38297
38777
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
38298
|
-
* @version
|
|
38778
|
+
* @version 198.0.0
|
|
38299
38779
|
*/
|
|
38300
38780
|
|
|
38301
38781
|
/**
|
|
@@ -38661,7 +39141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38661
39141
|
/**
|
|
38662
39142
|
* Objects service.
|
|
38663
39143
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
38664
|
-
* @version
|
|
39144
|
+
* @version 198.0.0
|
|
38665
39145
|
*/
|
|
38666
39146
|
|
|
38667
39147
|
/**
|
|
@@ -38931,7 +39411,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38931
39411
|
/**
|
|
38932
39412
|
* OperationalEvents service.
|
|
38933
39413
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
38934
|
-
* @version
|
|
39414
|
+
* @version 198.0.0
|
|
38935
39415
|
*/
|
|
38936
39416
|
|
|
38937
39417
|
/**
|
|
@@ -38997,7 +39477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38997
39477
|
/**
|
|
38998
39478
|
* Organization service.
|
|
38999
39479
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
39000
|
-
* @version
|
|
39480
|
+
* @version 198.0.0
|
|
39001
39481
|
*/
|
|
39002
39482
|
|
|
39003
39483
|
/**
|
|
@@ -39472,7 +39952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
39472
39952
|
/**
|
|
39473
39953
|
* OrganizationAuthorization service.
|
|
39474
39954
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
39475
|
-
* @version
|
|
39955
|
+
* @version 198.0.0
|
|
39476
39956
|
*/
|
|
39477
39957
|
|
|
39478
39958
|
/**
|
|
@@ -40819,7 +41299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
40819
41299
|
/**
|
|
40820
41300
|
* Outbound service.
|
|
40821
41301
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
40822
|
-
* @version
|
|
41302
|
+
* @version 198.0.0
|
|
40823
41303
|
*/
|
|
40824
41304
|
|
|
40825
41305
|
/**
|
|
@@ -41433,7 +41913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41433
41913
|
|
|
41434
41914
|
/**
|
|
41435
41915
|
* Reset messaging campaign progress and recycle the messaging campaign
|
|
41436
|
-
*
|
|
41916
|
+
* Documented permissions are applicable based on campaign type.
|
|
41437
41917
|
* @param {String} messagingCampaignId The Messaging Campaign ID
|
|
41438
41918
|
*/
|
|
41439
41919
|
deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
|
|
@@ -43435,6 +43915,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43435
43915
|
);
|
|
43436
43916
|
}
|
|
43437
43917
|
|
|
43918
|
+
/**
|
|
43919
|
+
* Update a campaign.
|
|
43920
|
+
*
|
|
43921
|
+
* @param {String} campaignId Campaign ID
|
|
43922
|
+
* @param {Object} body CampaignPatchRequest
|
|
43923
|
+
*/
|
|
43924
|
+
patchOutboundCampaign(campaignId, body) {
|
|
43925
|
+
// verify the required parameter 'campaignId' is set
|
|
43926
|
+
if (campaignId === undefined || campaignId === null) {
|
|
43927
|
+
throw 'Missing the required parameter "campaignId" when calling patchOutboundCampaign';
|
|
43928
|
+
}
|
|
43929
|
+
// verify the required parameter 'body' is set
|
|
43930
|
+
if (body === undefined || body === null) {
|
|
43931
|
+
throw 'Missing the required parameter "body" when calling patchOutboundCampaign';
|
|
43932
|
+
}
|
|
43933
|
+
|
|
43934
|
+
return this.apiClient.callApi(
|
|
43935
|
+
'/api/v2/outbound/campaigns/{campaignId}',
|
|
43936
|
+
'PATCH',
|
|
43937
|
+
{ 'campaignId': campaignId },
|
|
43938
|
+
{ },
|
|
43939
|
+
{ },
|
|
43940
|
+
{ },
|
|
43941
|
+
body,
|
|
43942
|
+
['PureCloud OAuth'],
|
|
43943
|
+
['application/json'],
|
|
43944
|
+
['application/json']
|
|
43945
|
+
);
|
|
43946
|
+
}
|
|
43947
|
+
|
|
43438
43948
|
/**
|
|
43439
43949
|
* Add entries to or delete entries from a DNC list.
|
|
43440
43950
|
* Only Internal DNC lists may be deleted from
|
|
@@ -43575,40 +44085,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43575
44085
|
);
|
|
43576
44086
|
}
|
|
43577
44087
|
|
|
43578
|
-
/**
|
|
43579
|
-
* Retrieves audits for dialer. (Deprecated)
|
|
43580
|
-
* This endpoint is deprecated as a result of this functionality being moved to the Audit Service. Please use "/api/v2/audits/query" instead.
|
|
43581
|
-
* @param {Object} body AuditSearch
|
|
43582
|
-
* @param {Object} opts Optional parameters
|
|
43583
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
43584
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
43585
|
-
* @param {String} opts.sortBy Sort by (default to entity.name)
|
|
43586
|
-
* @param {String} opts.sortOrder Sort order (default to ascending)
|
|
43587
|
-
* @param {Boolean} opts.facetsOnly Facets only (default to false)
|
|
43588
|
-
* @deprecated
|
|
43589
|
-
*/
|
|
43590
|
-
postOutboundAudits(body, opts) {
|
|
43591
|
-
opts = opts || {};
|
|
43592
|
-
|
|
43593
|
-
// verify the required parameter 'body' is set
|
|
43594
|
-
if (body === undefined || body === null) {
|
|
43595
|
-
throw 'Missing the required parameter "body" when calling postOutboundAudits';
|
|
43596
|
-
}
|
|
43597
|
-
|
|
43598
|
-
return this.apiClient.callApi(
|
|
43599
|
-
'/api/v2/outbound/audits',
|
|
43600
|
-
'POST',
|
|
43601
|
-
{ },
|
|
43602
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'facetsOnly': opts['facetsOnly'] },
|
|
43603
|
-
{ },
|
|
43604
|
-
{ },
|
|
43605
|
-
body,
|
|
43606
|
-
['PureCloud OAuth'],
|
|
43607
|
-
['application/json'],
|
|
43608
|
-
['application/json']
|
|
43609
|
-
);
|
|
43610
|
-
}
|
|
43611
|
-
|
|
43612
44088
|
/**
|
|
43613
44089
|
* Create callable time set
|
|
43614
44090
|
*
|
|
@@ -45185,7 +45661,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45185
45661
|
/**
|
|
45186
45662
|
* Presence service.
|
|
45187
45663
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
45188
|
-
* @version
|
|
45664
|
+
* @version 198.0.0
|
|
45189
45665
|
*/
|
|
45190
45666
|
|
|
45191
45667
|
/**
|
|
@@ -45929,7 +46405,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45929
46405
|
/**
|
|
45930
46406
|
* ProcessAutomation service.
|
|
45931
46407
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
45932
|
-
* @version
|
|
46408
|
+
* @version 198.0.0
|
|
45933
46409
|
*/
|
|
45934
46410
|
|
|
45935
46411
|
/**
|
|
@@ -46168,7 +46644,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46168
46644
|
/**
|
|
46169
46645
|
* Quality service.
|
|
46170
46646
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
46171
|
-
* @version
|
|
46647
|
+
* @version 198.0.0
|
|
46172
46648
|
*/
|
|
46173
46649
|
|
|
46174
46650
|
/**
|
|
@@ -47857,6 +48333,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47857
48333
|
);
|
|
47858
48334
|
}
|
|
47859
48335
|
|
|
48336
|
+
/**
|
|
48337
|
+
* Update the Predictive Scoring settings of an evaluation form.
|
|
48338
|
+
*
|
|
48339
|
+
* @param {String} formId Form ID
|
|
48340
|
+
* @param {Object} body Predictive Scoring Settings
|
|
48341
|
+
* putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
48342
|
+
*/
|
|
48343
|
+
putQualityFormsEvaluationPredictivescoringSettings(formId, body) {
|
|
48344
|
+
// verify the required parameter 'formId' is set
|
|
48345
|
+
if (formId === undefined || formId === null) {
|
|
48346
|
+
throw 'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';
|
|
48347
|
+
}
|
|
48348
|
+
// verify the required parameter 'body' is set
|
|
48349
|
+
if (body === undefined || body === null) {
|
|
48350
|
+
throw 'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';
|
|
48351
|
+
}
|
|
48352
|
+
|
|
48353
|
+
return this.apiClient.callApi(
|
|
48354
|
+
'/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings',
|
|
48355
|
+
'PUT',
|
|
48356
|
+
{ 'formId': formId },
|
|
48357
|
+
{ },
|
|
48358
|
+
{ },
|
|
48359
|
+
{ },
|
|
48360
|
+
body,
|
|
48361
|
+
['PureCloud OAuth'],
|
|
48362
|
+
['application/json'],
|
|
48363
|
+
['application/json']
|
|
48364
|
+
);
|
|
48365
|
+
}
|
|
48366
|
+
|
|
47860
48367
|
/**
|
|
47861
48368
|
* Update a survey form.
|
|
47862
48369
|
*
|
|
@@ -47923,7 +48430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47923
48430
|
/**
|
|
47924
48431
|
* Recording service.
|
|
47925
48432
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
47926
|
-
* @version
|
|
48433
|
+
* @version 198.0.0
|
|
47927
48434
|
*/
|
|
47928
48435
|
|
|
47929
48436
|
/**
|
|
@@ -49581,7 +50088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49581
50088
|
/**
|
|
49582
50089
|
* ResponseManagement service.
|
|
49583
50090
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
49584
|
-
* @version
|
|
50091
|
+
* @version 198.0.0
|
|
49585
50092
|
*/
|
|
49586
50093
|
|
|
49587
50094
|
/**
|
|
@@ -50091,7 +50598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50091
50598
|
/**
|
|
50092
50599
|
* Routing service.
|
|
50093
50600
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
50094
|
-
* @version
|
|
50601
|
+
* @version 198.0.0
|
|
50095
50602
|
*/
|
|
50096
50603
|
|
|
50097
50604
|
/**
|
|
@@ -52002,6 +52509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52002
52509
|
* @param {Object} opts.sortOrder Sort order
|
|
52003
52510
|
* @param {String} opts.language A language tag (which is sometimes referred to as a locale identifier) to use to localize country field and sort operations (default to en-US)
|
|
52004
52511
|
* @param {String} opts.integrationId Filter on the Genesys Cloud integration id to which the phone number belongs to
|
|
52512
|
+
* @param {String} opts.supportedContentId Filter based on the supported content ID
|
|
52005
52513
|
*/
|
|
52006
52514
|
getRoutingSmsPhonenumbers(opts) {
|
|
52007
52515
|
opts = opts || {};
|
|
@@ -52011,7 +52519,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
52011
52519
|
'/api/v2/routing/sms/phonenumbers',
|
|
52012
52520
|
'GET',
|
|
52013
52521
|
{ },
|
|
52014
|
-
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'] },
|
|
52522
|
+
{ 'phoneNumber': opts['phoneNumber'],'phoneNumberType': this.apiClient.buildCollectionParam(opts['phoneNumberType'], 'multi'),'phoneNumberStatus': this.apiClient.buildCollectionParam(opts['phoneNumberStatus'], 'multi'),'countryCode': this.apiClient.buildCollectionParam(opts['countryCode'], 'multi'),'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'language': opts['language'],'integration.id': opts['integrationId'],'supportedContent.id': opts['supportedContentId'] },
|
|
52015
52523
|
{ },
|
|
52016
52524
|
{ },
|
|
52017
52525
|
null,
|
|
@@ -54064,7 +54572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54064
54572
|
/**
|
|
54065
54573
|
* SCIM service.
|
|
54066
54574
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
54067
|
-
* @version
|
|
54575
|
+
* @version 198.0.0
|
|
54068
54576
|
*/
|
|
54069
54577
|
|
|
54070
54578
|
/**
|
|
@@ -54941,7 +55449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54941
55449
|
/**
|
|
54942
55450
|
* ScreenRecording service.
|
|
54943
55451
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
54944
|
-
* @version
|
|
55452
|
+
* @version 198.0.0
|
|
54945
55453
|
*/
|
|
54946
55454
|
|
|
54947
55455
|
/**
|
|
@@ -54986,7 +55494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54986
55494
|
/**
|
|
54987
55495
|
* Scripts service.
|
|
54988
55496
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
54989
|
-
* @version
|
|
55497
|
+
* @version 198.0.0
|
|
54990
55498
|
*/
|
|
54991
55499
|
|
|
54992
55500
|
/**
|
|
@@ -55430,7 +55938,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55430
55938
|
/**
|
|
55431
55939
|
* Search service.
|
|
55432
55940
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
55433
|
-
* @version
|
|
55941
|
+
* @version 198.0.0
|
|
55434
55942
|
*/
|
|
55435
55943
|
|
|
55436
55944
|
/**
|
|
@@ -56119,7 +56627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56119
56627
|
/**
|
|
56120
56628
|
* Settings service.
|
|
56121
56629
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
56122
|
-
* @version
|
|
56630
|
+
* @version 198.0.0
|
|
56123
56631
|
*/
|
|
56124
56632
|
|
|
56125
56633
|
/**
|
|
@@ -56134,6 +56642,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56134
56642
|
}
|
|
56135
56643
|
|
|
56136
56644
|
|
|
56645
|
+
/**
|
|
56646
|
+
* Delete agent auto answer settings
|
|
56647
|
+
*
|
|
56648
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56649
|
+
*/
|
|
56650
|
+
deleteUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56651
|
+
// verify the required parameter 'agentId' is set
|
|
56652
|
+
if (agentId === undefined || agentId === null) {
|
|
56653
|
+
throw 'Missing the required parameter "agentId" when calling deleteUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56654
|
+
}
|
|
56655
|
+
|
|
56656
|
+
return this.apiClient.callApi(
|
|
56657
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56658
|
+
'DELETE',
|
|
56659
|
+
{ 'agentId': agentId },
|
|
56660
|
+
{ },
|
|
56661
|
+
{ },
|
|
56662
|
+
{ },
|
|
56663
|
+
null,
|
|
56664
|
+
['PureCloud OAuth'],
|
|
56665
|
+
['application/json'],
|
|
56666
|
+
['application/json']
|
|
56667
|
+
);
|
|
56668
|
+
}
|
|
56669
|
+
|
|
56137
56670
|
/**
|
|
56138
56671
|
* Get email Contact Center settings
|
|
56139
56672
|
*
|
|
@@ -56175,6 +56708,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56175
56708
|
);
|
|
56176
56709
|
}
|
|
56177
56710
|
|
|
56711
|
+
/**
|
|
56712
|
+
* Get agent auto answer settings
|
|
56713
|
+
*
|
|
56714
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56715
|
+
*/
|
|
56716
|
+
getUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId) {
|
|
56717
|
+
// verify the required parameter 'agentId' is set
|
|
56718
|
+
if (agentId === undefined || agentId === null) {
|
|
56719
|
+
throw 'Missing the required parameter "agentId" when calling getUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56720
|
+
}
|
|
56721
|
+
|
|
56722
|
+
return this.apiClient.callApi(
|
|
56723
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56724
|
+
'GET',
|
|
56725
|
+
{ 'agentId': agentId },
|
|
56726
|
+
{ },
|
|
56727
|
+
{ },
|
|
56728
|
+
{ },
|
|
56729
|
+
null,
|
|
56730
|
+
['PureCloud OAuth'],
|
|
56731
|
+
['application/json'],
|
|
56732
|
+
['application/json']
|
|
56733
|
+
);
|
|
56734
|
+
}
|
|
56735
|
+
|
|
56178
56736
|
/**
|
|
56179
56737
|
* Patch email Contact Center settings
|
|
56180
56738
|
*
|
|
@@ -56225,13 +56783,73 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56225
56783
|
);
|
|
56226
56784
|
}
|
|
56227
56785
|
|
|
56786
|
+
/**
|
|
56787
|
+
* Update agent auto answer settings
|
|
56788
|
+
*
|
|
56789
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56790
|
+
* @param {Object} body AutoAnswerSettings
|
|
56791
|
+
*/
|
|
56792
|
+
patchUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56793
|
+
// verify the required parameter 'agentId' is set
|
|
56794
|
+
if (agentId === undefined || agentId === null) {
|
|
56795
|
+
throw 'Missing the required parameter "agentId" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56796
|
+
}
|
|
56797
|
+
// verify the required parameter 'body' is set
|
|
56798
|
+
if (body === undefined || body === null) {
|
|
56799
|
+
throw 'Missing the required parameter "body" when calling patchUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56800
|
+
}
|
|
56801
|
+
|
|
56802
|
+
return this.apiClient.callApi(
|
|
56803
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56804
|
+
'PATCH',
|
|
56805
|
+
{ 'agentId': agentId },
|
|
56806
|
+
{ },
|
|
56807
|
+
{ },
|
|
56808
|
+
{ },
|
|
56809
|
+
body,
|
|
56810
|
+
['PureCloud OAuth'],
|
|
56811
|
+
['application/json'],
|
|
56812
|
+
['application/json']
|
|
56813
|
+
);
|
|
56814
|
+
}
|
|
56815
|
+
|
|
56816
|
+
/**
|
|
56817
|
+
* Set agent auto answer settings
|
|
56818
|
+
*
|
|
56819
|
+
* @param {String} agentId The agent to apply the auto answer settings to
|
|
56820
|
+
* @param {Object} body AutoAnswerSettings
|
|
56821
|
+
*/
|
|
56822
|
+
putUsersAgentuiAgentsAutoanswerAgentIdSettings(agentId, body) {
|
|
56823
|
+
// verify the required parameter 'agentId' is set
|
|
56824
|
+
if (agentId === undefined || agentId === null) {
|
|
56825
|
+
throw 'Missing the required parameter "agentId" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56826
|
+
}
|
|
56827
|
+
// verify the required parameter 'body' is set
|
|
56828
|
+
if (body === undefined || body === null) {
|
|
56829
|
+
throw 'Missing the required parameter "body" when calling putUsersAgentuiAgentsAutoanswerAgentIdSettings';
|
|
56830
|
+
}
|
|
56831
|
+
|
|
56832
|
+
return this.apiClient.callApi(
|
|
56833
|
+
'/api/v2/users/agentui/agents/autoanswer/{agentId}/settings',
|
|
56834
|
+
'PUT',
|
|
56835
|
+
{ 'agentId': agentId },
|
|
56836
|
+
{ },
|
|
56837
|
+
{ },
|
|
56838
|
+
{ },
|
|
56839
|
+
body,
|
|
56840
|
+
['PureCloud OAuth'],
|
|
56841
|
+
['application/json'],
|
|
56842
|
+
['application/json']
|
|
56843
|
+
);
|
|
56844
|
+
}
|
|
56845
|
+
|
|
56228
56846
|
}
|
|
56229
56847
|
|
|
56230
56848
|
class SpeechTextAnalyticsApi {
|
|
56231
56849
|
/**
|
|
56232
56850
|
* SpeechTextAnalytics service.
|
|
56233
56851
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
56234
|
-
* @version
|
|
56852
|
+
* @version 198.0.0
|
|
56235
56853
|
*/
|
|
56236
56854
|
|
|
56237
56855
|
/**
|
|
@@ -57509,7 +58127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57509
58127
|
/**
|
|
57510
58128
|
* Stations service.
|
|
57511
58129
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
57512
|
-
* @version
|
|
58130
|
+
* @version 198.0.0
|
|
57513
58131
|
*/
|
|
57514
58132
|
|
|
57515
58133
|
/**
|
|
@@ -57611,7 +58229,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57611
58229
|
/**
|
|
57612
58230
|
* Suggest service.
|
|
57613
58231
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
57614
|
-
* @version
|
|
58232
|
+
* @version 198.0.0
|
|
57615
58233
|
*/
|
|
57616
58234
|
|
|
57617
58235
|
/**
|
|
@@ -57750,7 +58368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57750
58368
|
/**
|
|
57751
58369
|
* TaskManagement service.
|
|
57752
58370
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
57753
|
-
* @version
|
|
58371
|
+
* @version 198.0.0
|
|
57754
58372
|
*/
|
|
57755
58373
|
|
|
57756
58374
|
/**
|
|
@@ -58395,6 +59013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58395
59013
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
58396
59014
|
* @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)
|
|
58397
59015
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
|
|
59016
|
+
* @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.
|
|
58398
59017
|
* getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
58399
59018
|
*/
|
|
58400
59019
|
getTaskmanagementWorktypeHistory(worktypeId, opts) {
|
|
@@ -58409,7 +59028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58409
59028
|
'/api/v2/taskmanagement/worktypes/{worktypeId}/history',
|
|
58410
59029
|
'GET',
|
|
58411
59030
|
{ 'worktypeId': worktypeId },
|
|
58412
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
|
|
59031
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
|
|
58413
59032
|
{ },
|
|
58414
59033
|
{ },
|
|
58415
59034
|
null,
|
|
@@ -59098,7 +59717,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59098
59717
|
/**
|
|
59099
59718
|
* Teams service.
|
|
59100
59719
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
59101
|
-
* @version
|
|
59720
|
+
* @version 198.0.0
|
|
59102
59721
|
*/
|
|
59103
59722
|
|
|
59104
59723
|
/**
|
|
@@ -59399,7 +60018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59399
60018
|
/**
|
|
59400
60019
|
* Telephony service.
|
|
59401
60020
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
59402
|
-
* @version
|
|
60021
|
+
* @version 198.0.0
|
|
59403
60022
|
*/
|
|
59404
60023
|
|
|
59405
60024
|
/**
|
|
@@ -59581,7 +60200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59581
60200
|
/**
|
|
59582
60201
|
* TelephonyProvidersEdge service.
|
|
59583
60202
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
59584
|
-
* @version
|
|
60203
|
+
* @version 198.0.0
|
|
59585
60204
|
*/
|
|
59586
60205
|
|
|
59587
60206
|
/**
|
|
@@ -62909,7 +63528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62909
63528
|
/**
|
|
62910
63529
|
* Textbots service.
|
|
62911
63530
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
62912
|
-
* @version
|
|
63531
|
+
* @version 198.0.0
|
|
62913
63532
|
*/
|
|
62914
63533
|
|
|
62915
63534
|
/**
|
|
@@ -63037,7 +63656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63037
63656
|
/**
|
|
63038
63657
|
* Tokens service.
|
|
63039
63658
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
63040
|
-
* @version
|
|
63659
|
+
* @version 198.0.0
|
|
63041
63660
|
*/
|
|
63042
63661
|
|
|
63043
63662
|
/**
|
|
@@ -63191,7 +63810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63191
63810
|
/**
|
|
63192
63811
|
* Uploads service.
|
|
63193
63812
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
63194
|
-
* @version
|
|
63813
|
+
* @version 198.0.0
|
|
63195
63814
|
*/
|
|
63196
63815
|
|
|
63197
63816
|
/**
|
|
@@ -63460,7 +64079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63460
64079
|
/**
|
|
63461
64080
|
* Usage service.
|
|
63462
64081
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
63463
|
-
* @version
|
|
64082
|
+
* @version 198.0.0
|
|
63464
64083
|
*/
|
|
63465
64084
|
|
|
63466
64085
|
/**
|
|
@@ -63675,7 +64294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63675
64294
|
/**
|
|
63676
64295
|
* UserRecordings service.
|
|
63677
64296
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
63678
|
-
* @version
|
|
64297
|
+
* @version 198.0.0
|
|
63679
64298
|
*/
|
|
63680
64299
|
|
|
63681
64300
|
/**
|
|
@@ -63860,7 +64479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63860
64479
|
/**
|
|
63861
64480
|
* Users service.
|
|
63862
64481
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
63863
|
-
* @version
|
|
64482
|
+
* @version 198.0.0
|
|
63864
64483
|
*/
|
|
63865
64484
|
|
|
63866
64485
|
/**
|
|
@@ -64492,7 +65111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64492
65111
|
*
|
|
64493
65112
|
* @param {String} userId User ID
|
|
64494
65113
|
* @param {Object} opts Optional parameters
|
|
64495
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65114
|
+
* @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.
|
|
64496
65115
|
* @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
|
|
64497
65116
|
* @param {Object} opts.state Search for a user with this state (default to active)
|
|
64498
65117
|
*/
|
|
@@ -65063,7 +65682,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65063
65682
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
65064
65683
|
* @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
|
|
65065
65684
|
* @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
|
|
65066
|
-
* @param {Array.<String>} opts.expand Which fields, if any, to expand
|
|
65685
|
+
* @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.
|
|
65067
65686
|
* @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.
|
|
65068
65687
|
* @param {Object} opts.state Only list users of this state (default to active)
|
|
65069
65688
|
*/
|
|
@@ -66518,7 +67137,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66518
67137
|
/**
|
|
66519
67138
|
* Utilities service.
|
|
66520
67139
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
66521
|
-
* @version
|
|
67140
|
+
* @version 198.0.0
|
|
66522
67141
|
*/
|
|
66523
67142
|
|
|
66524
67143
|
/**
|
|
@@ -66629,7 +67248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66629
67248
|
/**
|
|
66630
67249
|
* Voicemail service.
|
|
66631
67250
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
66632
|
-
* @version
|
|
67251
|
+
* @version 198.0.0
|
|
66633
67252
|
*/
|
|
66634
67253
|
|
|
66635
67254
|
/**
|
|
@@ -67296,7 +67915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67296
67915
|
/**
|
|
67297
67916
|
* WebChat service.
|
|
67298
67917
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
67299
|
-
* @version
|
|
67918
|
+
* @version 198.0.0
|
|
67300
67919
|
*/
|
|
67301
67920
|
|
|
67302
67921
|
/**
|
|
@@ -67847,7 +68466,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67847
68466
|
/**
|
|
67848
68467
|
* WebDeployments service.
|
|
67849
68468
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
67850
|
-
* @version
|
|
68469
|
+
* @version 198.0.0
|
|
67851
68470
|
*/
|
|
67852
68471
|
|
|
67853
68472
|
/**
|
|
@@ -68374,7 +68993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68374
68993
|
/**
|
|
68375
68994
|
* WebMessaging service.
|
|
68376
68995
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
68377
|
-
* @version
|
|
68996
|
+
* @version 198.0.0
|
|
68378
68997
|
*/
|
|
68379
68998
|
|
|
68380
68999
|
/**
|
|
@@ -68420,7 +69039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68420
69039
|
/**
|
|
68421
69040
|
* Widgets service.
|
|
68422
69041
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
68423
|
-
* @version
|
|
69042
|
+
* @version 198.0.0
|
|
68424
69043
|
*/
|
|
68425
69044
|
|
|
68426
69045
|
/**
|
|
@@ -68566,7 +69185,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68566
69185
|
/**
|
|
68567
69186
|
* WorkforceManagement service.
|
|
68568
69187
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
68569
|
-
* @version
|
|
69188
|
+
* @version 198.0.0
|
|
68570
69189
|
*/
|
|
68571
69190
|
|
|
68572
69191
|
/**
|
|
@@ -69176,32 +69795,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69176
69795
|
);
|
|
69177
69796
|
}
|
|
69178
69797
|
|
|
69179
|
-
/**
|
|
69180
|
-
* To get status of the modeling job.
|
|
69181
|
-
* This Endpoint is Deprecated, and not recommended to be used.
|
|
69182
|
-
* @param {String} jobId The id of the modeling job
|
|
69183
|
-
* @deprecated
|
|
69184
|
-
*/
|
|
69185
|
-
getWorkforcemanagementAdhocmodelingjob(jobId) {
|
|
69186
|
-
// verify the required parameter 'jobId' is set
|
|
69187
|
-
if (jobId === undefined || jobId === null) {
|
|
69188
|
-
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';
|
|
69189
|
-
}
|
|
69190
|
-
|
|
69191
|
-
return this.apiClient.callApi(
|
|
69192
|
-
'/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}',
|
|
69193
|
-
'GET',
|
|
69194
|
-
{ 'jobId': jobId },
|
|
69195
|
-
{ },
|
|
69196
|
-
{ },
|
|
69197
|
-
{ },
|
|
69198
|
-
null,
|
|
69199
|
-
['PureCloud OAuth'],
|
|
69200
|
-
['application/json'],
|
|
69201
|
-
['application/json']
|
|
69202
|
-
);
|
|
69203
|
-
}
|
|
69204
|
-
|
|
69205
69798
|
/**
|
|
69206
69799
|
* Get an adherence explanation
|
|
69207
69800
|
*
|
|
@@ -69365,6 +69958,129 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69365
69958
|
);
|
|
69366
69959
|
}
|
|
69367
69960
|
|
|
69961
|
+
/**
|
|
69962
|
+
* Get an activity plan
|
|
69963
|
+
*
|
|
69964
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69965
|
+
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
69966
|
+
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69967
|
+
*/
|
|
69968
|
+
getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
|
|
69969
|
+
// verify the required parameter 'businessUnitId' is set
|
|
69970
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
69971
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69972
|
+
}
|
|
69973
|
+
// verify the required parameter 'activityPlanId' is set
|
|
69974
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
69975
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';
|
|
69976
|
+
}
|
|
69977
|
+
|
|
69978
|
+
return this.apiClient.callApi(
|
|
69979
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
69980
|
+
'GET',
|
|
69981
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
69982
|
+
{ },
|
|
69983
|
+
{ },
|
|
69984
|
+
{ },
|
|
69985
|
+
null,
|
|
69986
|
+
['PureCloud OAuth'],
|
|
69987
|
+
['application/json'],
|
|
69988
|
+
['application/json']
|
|
69989
|
+
);
|
|
69990
|
+
}
|
|
69991
|
+
|
|
69992
|
+
/**
|
|
69993
|
+
* Gets an activity plan run job
|
|
69994
|
+
*
|
|
69995
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
69996
|
+
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
69997
|
+
* @param {String} jobId The ID of the activity plan run job
|
|
69998
|
+
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69999
|
+
*/
|
|
70000
|
+
getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
|
|
70001
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70002
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70003
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70004
|
+
}
|
|
70005
|
+
// verify the required parameter 'activityPlanId' is set
|
|
70006
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
70007
|
+
throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70008
|
+
}
|
|
70009
|
+
// verify the required parameter 'jobId' is set
|
|
70010
|
+
if (jobId === undefined || jobId === null) {
|
|
70011
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
|
|
70012
|
+
}
|
|
70013
|
+
|
|
70014
|
+
return this.apiClient.callApi(
|
|
70015
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}',
|
|
70016
|
+
'GET',
|
|
70017
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId,'jobId': jobId },
|
|
70018
|
+
{ },
|
|
70019
|
+
{ },
|
|
70020
|
+
{ },
|
|
70021
|
+
null,
|
|
70022
|
+
['PureCloud OAuth'],
|
|
70023
|
+
['application/json'],
|
|
70024
|
+
['application/json']
|
|
70025
|
+
);
|
|
70026
|
+
}
|
|
70027
|
+
|
|
70028
|
+
/**
|
|
70029
|
+
* Get activity plans
|
|
70030
|
+
*
|
|
70031
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70032
|
+
* @param {Object} opts Optional parameters
|
|
70033
|
+
* @param {Object} opts.state Optionally filter by activity plan state
|
|
70034
|
+
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70035
|
+
*/
|
|
70036
|
+
getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
|
|
70037
|
+
opts = opts || {};
|
|
70038
|
+
|
|
70039
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70040
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70041
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';
|
|
70042
|
+
}
|
|
70043
|
+
|
|
70044
|
+
return this.apiClient.callApi(
|
|
70045
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
70046
|
+
'GET',
|
|
70047
|
+
{ 'businessUnitId': businessUnitId },
|
|
70048
|
+
{ 'state': opts['state'] },
|
|
70049
|
+
{ },
|
|
70050
|
+
{ },
|
|
70051
|
+
null,
|
|
70052
|
+
['PureCloud OAuth'],
|
|
70053
|
+
['application/json'],
|
|
70054
|
+
['application/json']
|
|
70055
|
+
);
|
|
70056
|
+
}
|
|
70057
|
+
|
|
70058
|
+
/**
|
|
70059
|
+
* Gets the latest job for all activity plans in the business unit
|
|
70060
|
+
*
|
|
70061
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
70062
|
+
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70063
|
+
*/
|
|
70064
|
+
getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
|
|
70065
|
+
// verify the required parameter 'businessUnitId' is set
|
|
70066
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
70067
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';
|
|
70068
|
+
}
|
|
70069
|
+
|
|
70070
|
+
return this.apiClient.callApi(
|
|
70071
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs',
|
|
70072
|
+
'GET',
|
|
70073
|
+
{ 'businessUnitId': businessUnitId },
|
|
70074
|
+
{ },
|
|
70075
|
+
{ },
|
|
70076
|
+
{ },
|
|
70077
|
+
null,
|
|
70078
|
+
['PureCloud OAuth'],
|
|
70079
|
+
['application/json'],
|
|
70080
|
+
['application/json']
|
|
70081
|
+
);
|
|
70082
|
+
}
|
|
70083
|
+
|
|
69368
70084
|
/**
|
|
69369
70085
|
* Get intraday planning groups for the given date
|
|
69370
70086
|
*
|
|
@@ -71528,6 +72244,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71528
72244
|
);
|
|
71529
72245
|
}
|
|
71530
72246
|
|
|
72247
|
+
/**
|
|
72248
|
+
* Update an activity plan
|
|
72249
|
+
* If a job associated with the activity plan is in Processing state the activity plan cannot be updated
|
|
72250
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
72251
|
+
* @param {String} activityPlanId The ID of the activity plan to update
|
|
72252
|
+
* @param {Object} body body
|
|
72253
|
+
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
72254
|
+
*/
|
|
72255
|
+
patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
|
|
72256
|
+
// verify the required parameter 'businessUnitId' is set
|
|
72257
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
72258
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72259
|
+
}
|
|
72260
|
+
// verify the required parameter 'activityPlanId' is set
|
|
72261
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
72262
|
+
throw 'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72263
|
+
}
|
|
72264
|
+
// verify the required parameter 'body' is set
|
|
72265
|
+
if (body === undefined || body === null) {
|
|
72266
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
|
|
72267
|
+
}
|
|
72268
|
+
|
|
72269
|
+
return this.apiClient.callApi(
|
|
72270
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
|
|
72271
|
+
'PATCH',
|
|
72272
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
72273
|
+
{ },
|
|
72274
|
+
{ },
|
|
72275
|
+
{ },
|
|
72276
|
+
body,
|
|
72277
|
+
['PureCloud OAuth'],
|
|
72278
|
+
['application/json'],
|
|
72279
|
+
['application/json']
|
|
72280
|
+
);
|
|
72281
|
+
}
|
|
72282
|
+
|
|
71531
72283
|
/**
|
|
71532
72284
|
* Updates the planning group
|
|
71533
72285
|
*
|
|
@@ -72335,6 +73087,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72335
73087
|
);
|
|
72336
73088
|
}
|
|
72337
73089
|
|
|
73090
|
+
/**
|
|
73091
|
+
* Run an activity plan manually
|
|
73092
|
+
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
73093
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73094
|
+
* @param {String} activityPlanId The ID of the activity plan to run
|
|
73095
|
+
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73096
|
+
*/
|
|
73097
|
+
postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
|
|
73098
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73099
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73100
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73101
|
+
}
|
|
73102
|
+
// verify the required parameter 'activityPlanId' is set
|
|
73103
|
+
if (activityPlanId === undefined || activityPlanId === null) {
|
|
73104
|
+
throw 'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
|
|
73105
|
+
}
|
|
73106
|
+
|
|
73107
|
+
return this.apiClient.callApi(
|
|
73108
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs',
|
|
73109
|
+
'POST',
|
|
73110
|
+
{ 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
|
|
73111
|
+
{ },
|
|
73112
|
+
{ },
|
|
73113
|
+
{ },
|
|
73114
|
+
null,
|
|
73115
|
+
['PureCloud OAuth'],
|
|
73116
|
+
['application/json'],
|
|
73117
|
+
['application/json']
|
|
73118
|
+
);
|
|
73119
|
+
}
|
|
73120
|
+
|
|
73121
|
+
/**
|
|
73122
|
+
* Create an activity plan
|
|
73123
|
+
*
|
|
73124
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
73125
|
+
* @param {Object} body body
|
|
73126
|
+
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
73127
|
+
*/
|
|
73128
|
+
postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
|
|
73129
|
+
// verify the required parameter 'businessUnitId' is set
|
|
73130
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
73131
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73132
|
+
}
|
|
73133
|
+
// verify the required parameter 'body' is set
|
|
73134
|
+
if (body === undefined || body === null) {
|
|
73135
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';
|
|
73136
|
+
}
|
|
73137
|
+
|
|
73138
|
+
return this.apiClient.callApi(
|
|
73139
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
|
|
73140
|
+
'POST',
|
|
73141
|
+
{ 'businessUnitId': businessUnitId },
|
|
73142
|
+
{ },
|
|
73143
|
+
{ },
|
|
73144
|
+
{ },
|
|
73145
|
+
body,
|
|
73146
|
+
['PureCloud OAuth'],
|
|
73147
|
+
['application/json'],
|
|
73148
|
+
['application/json']
|
|
73149
|
+
);
|
|
73150
|
+
}
|
|
73151
|
+
|
|
72338
73152
|
/**
|
|
72339
73153
|
* Query adherence explanations across an entire business unit for the requested period
|
|
72340
73154
|
*
|
|
@@ -74479,7 +75293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74479
75293
|
* </pre>
|
|
74480
75294
|
* </p>
|
|
74481
75295
|
* @module purecloud-platform-client-v2/index
|
|
74482
|
-
* @version
|
|
75296
|
+
* @version 198.0.0
|
|
74483
75297
|
*/
|
|
74484
75298
|
class platformClient {
|
|
74485
75299
|
constructor() {
|
|
@@ -74493,6 +75307,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74493
75307
|
* @property {module:purecloud-platform-client-v2/ApiClient}
|
|
74494
75308
|
*/
|
|
74495
75309
|
this.ApiClientClass = ApiClient;
|
|
75310
|
+
/**
|
|
75311
|
+
* The AgentUIApi service constructor.
|
|
75312
|
+
* @property {module:purecloud-platform-client-v2/api/AgentUIApi}
|
|
75313
|
+
*/
|
|
75314
|
+
this.AgentUIApi = AgentUIApi;
|
|
74496
75315
|
/**
|
|
74497
75316
|
* The AlertingApi service constructor.
|
|
74498
75317
|
* @property {module:purecloud-platform-client-v2/api/AlertingApi}
|
|
@@ -74563,6 +75382,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74563
75382
|
* @property {module:purecloud-platform-client-v2/api/EmailsApi}
|
|
74564
75383
|
*/
|
|
74565
75384
|
this.EmailsApi = EmailsApi;
|
|
75385
|
+
/**
|
|
75386
|
+
* The EmployeeEngagementApi service constructor.
|
|
75387
|
+
* @property {module:purecloud-platform-client-v2/api/EmployeeEngagementApi}
|
|
75388
|
+
*/
|
|
75389
|
+
this.EmployeeEngagementApi = EmployeeEngagementApi;
|
|
74566
75390
|
/**
|
|
74567
75391
|
* The EventsApi service constructor.
|
|
74568
75392
|
* @property {module:purecloud-platform-client-v2/api/EventsApi}
|