purecloud-platform-client-v2 248.0.0 → 249.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 +3 -3
- package/dist/node/purecloud-platform-client-v2.js +2010 -100
- package/dist/web-amd/purecloud-platform-client-v2.js +2010 -100
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +602 -105
- package/dist/web-cjs/purecloud-platform-client-v2.js +602 -105
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1061 -82
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- 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/AssistantCopilotVariationsApi.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/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1100 -0
- 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 +8 -4
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +31 -1
- 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/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +477 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +26 -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 +37 -2
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +57 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +5 -5
- package/src/purecloud-platform-client-v2/api/SCIMApi.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 +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +46 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +140 -1
- package/src/purecloud-platform-client-v2/index.js +7 -1
|
@@ -5,7 +5,7 @@ class WorkforceManagementApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* WorkforceManagement service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 249.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -1587,6 +1587,31 @@ class WorkforceManagementApi {
|
|
|
1587
1587
|
);
|
|
1588
1588
|
}
|
|
1589
1589
|
|
|
1590
|
+
/**
|
|
1591
|
+
* Get minimum staffing settings for a business unit
|
|
1592
|
+
*
|
|
1593
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1594
|
+
*/
|
|
1595
|
+
getWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId) {
|
|
1596
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1597
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
1598
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
1599
|
+
}
|
|
1600
|
+
|
|
1601
|
+
return this.apiClient.callApi(
|
|
1602
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings',
|
|
1603
|
+
'GET',
|
|
1604
|
+
{ 'businessUnitId': businessUnitId },
|
|
1605
|
+
{ },
|
|
1606
|
+
{ },
|
|
1607
|
+
{ },
|
|
1608
|
+
null,
|
|
1609
|
+
['PureCloud OAuth'],
|
|
1610
|
+
['application/json'],
|
|
1611
|
+
['application/json']
|
|
1612
|
+
);
|
|
1613
|
+
}
|
|
1614
|
+
|
|
1590
1615
|
/**
|
|
1591
1616
|
* Get a planning group
|
|
1592
1617
|
*
|
|
@@ -1642,6 +1667,31 @@ class WorkforceManagementApi {
|
|
|
1642
1667
|
);
|
|
1643
1668
|
}
|
|
1644
1669
|
|
|
1670
|
+
/**
|
|
1671
|
+
* Get scheduler settings for a business unit
|
|
1672
|
+
*
|
|
1673
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1674
|
+
*/
|
|
1675
|
+
getWorkforcemanagementBusinessunitSchedulerSettings(businessUnitId) {
|
|
1676
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1677
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
1678
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitSchedulerSettings';
|
|
1679
|
+
}
|
|
1680
|
+
|
|
1681
|
+
return this.apiClient.callApi(
|
|
1682
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings',
|
|
1683
|
+
'GET',
|
|
1684
|
+
{ 'businessUnitId': businessUnitId },
|
|
1685
|
+
{ },
|
|
1686
|
+
{ },
|
|
1687
|
+
{ },
|
|
1688
|
+
null,
|
|
1689
|
+
['PureCloud OAuth'],
|
|
1690
|
+
['application/json'],
|
|
1691
|
+
['application/json']
|
|
1692
|
+
);
|
|
1693
|
+
}
|
|
1694
|
+
|
|
1645
1695
|
/**
|
|
1646
1696
|
* Get a scheduling run
|
|
1647
1697
|
*
|
|
@@ -1979,6 +2029,35 @@ class WorkforceManagementApi {
|
|
|
1979
2029
|
);
|
|
1980
2030
|
}
|
|
1981
2031
|
|
|
2032
|
+
/**
|
|
2033
|
+
* Get users in the business unit
|
|
2034
|
+
*
|
|
2035
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2036
|
+
* @param {Object} opts Optional parameters
|
|
2037
|
+
* @param {Array.<String>} opts.managementUnitIds The IDs of the management units for which to retrieve users
|
|
2038
|
+
*/
|
|
2039
|
+
getWorkforcemanagementBusinessunitUsers(businessUnitId, opts) {
|
|
2040
|
+
opts = opts || {};
|
|
2041
|
+
|
|
2042
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2043
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
2044
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitUsers';
|
|
2045
|
+
}
|
|
2046
|
+
|
|
2047
|
+
return this.apiClient.callApi(
|
|
2048
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/users',
|
|
2049
|
+
'GET',
|
|
2050
|
+
{ 'businessUnitId': businessUnitId },
|
|
2051
|
+
{ 'managementUnitIds': this.apiClient.buildCollectionParam(opts['managementUnitIds'], 'multi') },
|
|
2052
|
+
{ },
|
|
2053
|
+
{ },
|
|
2054
|
+
null,
|
|
2055
|
+
['PureCloud OAuth'],
|
|
2056
|
+
['application/json'],
|
|
2057
|
+
['application/json']
|
|
2058
|
+
);
|
|
2059
|
+
}
|
|
2060
|
+
|
|
1982
2061
|
/**
|
|
1983
2062
|
* Get the metadata for the schedule, describing which management units and agents are in the scheduleSchedule data can then be loaded with the query route
|
|
1984
2063
|
*
|
|
@@ -4216,6 +4295,36 @@ class WorkforceManagementApi {
|
|
|
4216
4295
|
);
|
|
4217
4296
|
}
|
|
4218
4297
|
|
|
4298
|
+
/**
|
|
4299
|
+
* Update minimum staffing settings for a business unit
|
|
4300
|
+
*
|
|
4301
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
4302
|
+
* @param {Object} body body
|
|
4303
|
+
*/
|
|
4304
|
+
patchWorkforcemanagementBusinessunitMinimumstaffingSettings(businessUnitId, body) {
|
|
4305
|
+
// verify the required parameter 'businessUnitId' is set
|
|
4306
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
4307
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
4308
|
+
}
|
|
4309
|
+
// verify the required parameter 'body' is set
|
|
4310
|
+
if (body === undefined || body === null) {
|
|
4311
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitMinimumstaffingSettings';
|
|
4312
|
+
}
|
|
4313
|
+
|
|
4314
|
+
return this.apiClient.callApi(
|
|
4315
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/minimumstaffing/settings',
|
|
4316
|
+
'PATCH',
|
|
4317
|
+
{ 'businessUnitId': businessUnitId },
|
|
4318
|
+
{ },
|
|
4319
|
+
{ },
|
|
4320
|
+
{ },
|
|
4321
|
+
body,
|
|
4322
|
+
['PureCloud OAuth'],
|
|
4323
|
+
['application/json'],
|
|
4324
|
+
['application/json']
|
|
4325
|
+
);
|
|
4326
|
+
}
|
|
4327
|
+
|
|
4219
4328
|
/**
|
|
4220
4329
|
* Updates the planning group
|
|
4221
4330
|
*
|
|
@@ -4251,6 +4360,36 @@ class WorkforceManagementApi {
|
|
|
4251
4360
|
);
|
|
4252
4361
|
}
|
|
4253
4362
|
|
|
4363
|
+
/**
|
|
4364
|
+
* Update scheduler settings for a business unit
|
|
4365
|
+
*
|
|
4366
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
4367
|
+
* @param {Object} body body
|
|
4368
|
+
*/
|
|
4369
|
+
patchWorkforcemanagementBusinessunitSchedulerSettings(businessUnitId, body) {
|
|
4370
|
+
// verify the required parameter 'businessUnitId' is set
|
|
4371
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
4372
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulerSettings';
|
|
4373
|
+
}
|
|
4374
|
+
// verify the required parameter 'body' is set
|
|
4375
|
+
if (body === undefined || body === null) {
|
|
4376
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulerSettings';
|
|
4377
|
+
}
|
|
4378
|
+
|
|
4379
|
+
return this.apiClient.callApi(
|
|
4380
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduler/settings',
|
|
4381
|
+
'PATCH',
|
|
4382
|
+
{ 'businessUnitId': businessUnitId },
|
|
4383
|
+
{ },
|
|
4384
|
+
{ },
|
|
4385
|
+
{ },
|
|
4386
|
+
body,
|
|
4387
|
+
['PureCloud OAuth'],
|
|
4388
|
+
['application/json'],
|
|
4389
|
+
['application/json']
|
|
4390
|
+
);
|
|
4391
|
+
}
|
|
4392
|
+
|
|
4254
4393
|
/**
|
|
4255
4394
|
* Mark a schedule run as applied
|
|
4256
4395
|
*
|
|
@@ -18,6 +18,7 @@ import BackgroundAssistantApi from './api/BackgroundAssistantApi.js';
|
|
|
18
18
|
import BillingApi from './api/BillingApi.js';
|
|
19
19
|
import BusinessRulesApi from './api/BusinessRulesApi.js';
|
|
20
20
|
import CarrierServicesApi from './api/CarrierServicesApi.js';
|
|
21
|
+
import CaseManagementApi from './api/CaseManagementApi.js';
|
|
21
22
|
import ChatApi from './api/ChatApi.js';
|
|
22
23
|
import CoachingApi from './api/CoachingApi.js';
|
|
23
24
|
import ContentManagementApi from './api/ContentManagementApi.js';
|
|
@@ -121,7 +122,7 @@ import WorkforceManagementApi from './api/WorkforceManagementApi.js';
|
|
|
121
122
|
* </pre>
|
|
122
123
|
* </p>
|
|
123
124
|
* @module purecloud-platform-client-v2/index
|
|
124
|
-
* @version
|
|
125
|
+
* @version 249.0.0
|
|
125
126
|
*/
|
|
126
127
|
class platformClient {
|
|
127
128
|
constructor() {
|
|
@@ -205,6 +206,11 @@ class platformClient {
|
|
|
205
206
|
* @property {module:purecloud-platform-client-v2/api/CarrierServicesApi}
|
|
206
207
|
*/
|
|
207
208
|
this.CarrierServicesApi = CarrierServicesApi;
|
|
209
|
+
/**
|
|
210
|
+
* The CaseManagementApi service constructor.
|
|
211
|
+
* @property {module:purecloud-platform-client-v2/api/CaseManagementApi}
|
|
212
|
+
*/
|
|
213
|
+
this.CaseManagementApi = CaseManagementApi;
|
|
208
214
|
/**
|
|
209
215
|
* The ChatApi service constructor.
|
|
210
216
|
* @property {module:purecloud-platform-client-v2/api/ChatApi}
|