purecloud-platform-client-v2 200.0.0 → 202.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 +1349 -125
- package/dist/web-amd/purecloud-platform-client-v2.js +1349 -125
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +432 -133
- package/dist/web-cjs/purecloud-platform-client-v2.js +548 -165
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1121 -241
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.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 +3 -3
- 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 +1 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -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 +21 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
- 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 +4 -4
- 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 +68 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +56 -1
- 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 +2 -2
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- 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 +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 +36 -31
- 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 +32 -2
- package/src/purecloud-platform-client-v2/api/UsersApi.js +4 -4
- 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 +1080 -33
- package/src/purecloud-platform-client-v2/index.js +1 -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 202.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -325,6 +325,71 @@ class WorkforceManagementApi {
|
|
|
325
325
|
);
|
|
326
326
|
}
|
|
327
327
|
|
|
328
|
+
/**
|
|
329
|
+
* Delete a work plan bid
|
|
330
|
+
*
|
|
331
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
332
|
+
* @param {String} bidId The ID of the work plan bid
|
|
333
|
+
*/
|
|
334
|
+
deleteWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
|
|
335
|
+
// verify the required parameter 'businessUnitId' is set
|
|
336
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
337
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
|
|
338
|
+
}
|
|
339
|
+
// verify the required parameter 'bidId' is set
|
|
340
|
+
if (bidId === undefined || bidId === null) {
|
|
341
|
+
throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbid';
|
|
342
|
+
}
|
|
343
|
+
|
|
344
|
+
return this.apiClient.callApi(
|
|
345
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
|
|
346
|
+
'DELETE',
|
|
347
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
348
|
+
{ },
|
|
349
|
+
{ },
|
|
350
|
+
{ },
|
|
351
|
+
null,
|
|
352
|
+
['PureCloud OAuth'],
|
|
353
|
+
['application/json'],
|
|
354
|
+
['application/json']
|
|
355
|
+
);
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/**
|
|
359
|
+
* Delete a bid group by bid group Id
|
|
360
|
+
*
|
|
361
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
362
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
363
|
+
* @param {String} bidGroupId Work Plan Bid Group id
|
|
364
|
+
*/
|
|
365
|
+
deleteWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
|
|
366
|
+
// verify the required parameter 'businessUnitId' is set
|
|
367
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
368
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
369
|
+
}
|
|
370
|
+
// verify the required parameter 'bidId' is set
|
|
371
|
+
if (bidId === undefined || bidId === null) {
|
|
372
|
+
throw 'Missing the required parameter "bidId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
373
|
+
}
|
|
374
|
+
// verify the required parameter 'bidGroupId' is set
|
|
375
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
376
|
+
throw 'Missing the required parameter "bidGroupId" when calling deleteWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
377
|
+
}
|
|
378
|
+
|
|
379
|
+
return this.apiClient.callApi(
|
|
380
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
381
|
+
'DELETE',
|
|
382
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
383
|
+
{ },
|
|
384
|
+
{ },
|
|
385
|
+
{ },
|
|
386
|
+
null,
|
|
387
|
+
['PureCloud OAuth'],
|
|
388
|
+
['application/json'],
|
|
389
|
+
['application/json']
|
|
390
|
+
);
|
|
391
|
+
}
|
|
392
|
+
|
|
328
393
|
/**
|
|
329
394
|
* Disable generated calendar link for the current user
|
|
330
395
|
*
|
|
@@ -690,6 +755,175 @@ class WorkforceManagementApi {
|
|
|
690
755
|
);
|
|
691
756
|
}
|
|
692
757
|
|
|
758
|
+
/**
|
|
759
|
+
* Query the status of an alternative shift offers operation. Only the user who started the operation can query the status
|
|
760
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
761
|
+
* @param {String} jobId The ID of the job
|
|
762
|
+
*/
|
|
763
|
+
getWorkforcemanagementAlternativeshiftsOffersJob(jobId) {
|
|
764
|
+
// verify the required parameter 'jobId' is set
|
|
765
|
+
if (jobId === undefined || jobId === null) {
|
|
766
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersJob';
|
|
767
|
+
}
|
|
768
|
+
|
|
769
|
+
return this.apiClient.callApi(
|
|
770
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/jobs/{jobId}',
|
|
771
|
+
'GET',
|
|
772
|
+
{ 'jobId': jobId },
|
|
773
|
+
{ },
|
|
774
|
+
{ },
|
|
775
|
+
{ },
|
|
776
|
+
null,
|
|
777
|
+
['PureCloud OAuth'],
|
|
778
|
+
['application/json'],
|
|
779
|
+
['application/json']
|
|
780
|
+
);
|
|
781
|
+
}
|
|
782
|
+
|
|
783
|
+
/**
|
|
784
|
+
* Query the status of an alternative shift search offers operation. Only the user who started the operation can query the status
|
|
785
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
786
|
+
* @param {String} jobId The ID of the job
|
|
787
|
+
*/
|
|
788
|
+
getWorkforcemanagementAlternativeshiftsOffersSearchJob(jobId) {
|
|
789
|
+
// verify the required parameter 'jobId' is set
|
|
790
|
+
if (jobId === undefined || jobId === null) {
|
|
791
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsOffersSearchJob';
|
|
792
|
+
}
|
|
793
|
+
|
|
794
|
+
return this.apiClient.callApi(
|
|
795
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs/{jobId}',
|
|
796
|
+
'GET',
|
|
797
|
+
{ 'jobId': jobId },
|
|
798
|
+
{ },
|
|
799
|
+
{ },
|
|
800
|
+
{ },
|
|
801
|
+
null,
|
|
802
|
+
['PureCloud OAuth'],
|
|
803
|
+
['application/json'],
|
|
804
|
+
['application/json']
|
|
805
|
+
);
|
|
806
|
+
}
|
|
807
|
+
|
|
808
|
+
/**
|
|
809
|
+
* Get alternative shifts settings from the current logged in agent’s business unit
|
|
810
|
+
*
|
|
811
|
+
*/
|
|
812
|
+
getWorkforcemanagementAlternativeshiftsSettings() {
|
|
813
|
+
|
|
814
|
+
return this.apiClient.callApi(
|
|
815
|
+
'/api/v2/workforcemanagement/alternativeshifts/settings',
|
|
816
|
+
'GET',
|
|
817
|
+
{ },
|
|
818
|
+
{ },
|
|
819
|
+
{ },
|
|
820
|
+
{ },
|
|
821
|
+
null,
|
|
822
|
+
['PureCloud OAuth'],
|
|
823
|
+
['application/json'],
|
|
824
|
+
['application/json']
|
|
825
|
+
);
|
|
826
|
+
}
|
|
827
|
+
|
|
828
|
+
/**
|
|
829
|
+
* Get my alternative shift trade by trade ID
|
|
830
|
+
*
|
|
831
|
+
* @param {String} tradeId The ID of the alternative shift trade
|
|
832
|
+
*/
|
|
833
|
+
getWorkforcemanagementAlternativeshiftsTrade(tradeId) {
|
|
834
|
+
// verify the required parameter 'tradeId' is set
|
|
835
|
+
if (tradeId === undefined || tradeId === null) {
|
|
836
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementAlternativeshiftsTrade';
|
|
837
|
+
}
|
|
838
|
+
|
|
839
|
+
return this.apiClient.callApi(
|
|
840
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
|
|
841
|
+
'GET',
|
|
842
|
+
{ 'tradeId': tradeId },
|
|
843
|
+
{ },
|
|
844
|
+
{ },
|
|
845
|
+
{ },
|
|
846
|
+
null,
|
|
847
|
+
['PureCloud OAuth'],
|
|
848
|
+
['application/json'],
|
|
849
|
+
['application/json']
|
|
850
|
+
);
|
|
851
|
+
}
|
|
852
|
+
|
|
853
|
+
/**
|
|
854
|
+
* Get a list of my alternative shifts trades
|
|
855
|
+
*
|
|
856
|
+
* @param {Object} opts Optional parameters
|
|
857
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
858
|
+
*/
|
|
859
|
+
getWorkforcemanagementAlternativeshiftsTrades(opts) {
|
|
860
|
+
opts = opts || {};
|
|
861
|
+
|
|
862
|
+
|
|
863
|
+
return this.apiClient.callApi(
|
|
864
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades',
|
|
865
|
+
'GET',
|
|
866
|
+
{ },
|
|
867
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
868
|
+
{ },
|
|
869
|
+
{ },
|
|
870
|
+
null,
|
|
871
|
+
['PureCloud OAuth'],
|
|
872
|
+
['application/json'],
|
|
873
|
+
['application/json']
|
|
874
|
+
);
|
|
875
|
+
}
|
|
876
|
+
|
|
877
|
+
/**
|
|
878
|
+
* Query the status of an alternative shift trades operation. Only the user who started the operation can query the status
|
|
879
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
880
|
+
* @param {String} jobId The ID of the job
|
|
881
|
+
*/
|
|
882
|
+
getWorkforcemanagementAlternativeshiftsTradesJob(jobId) {
|
|
883
|
+
// verify the required parameter 'jobId' is set
|
|
884
|
+
if (jobId === undefined || jobId === null) {
|
|
885
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesJob';
|
|
886
|
+
}
|
|
887
|
+
|
|
888
|
+
return this.apiClient.callApi(
|
|
889
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/jobs/{jobId}',
|
|
890
|
+
'GET',
|
|
891
|
+
{ 'jobId': jobId },
|
|
892
|
+
{ },
|
|
893
|
+
{ },
|
|
894
|
+
{ },
|
|
895
|
+
null,
|
|
896
|
+
['PureCloud OAuth'],
|
|
897
|
+
['application/json'],
|
|
898
|
+
['application/json']
|
|
899
|
+
);
|
|
900
|
+
}
|
|
901
|
+
|
|
902
|
+
/**
|
|
903
|
+
* Query the status of an alternative shift trade state operation. Only the user who started the operation can query the status
|
|
904
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
905
|
+
* @param {String} jobId The ID of the job
|
|
906
|
+
*/
|
|
907
|
+
getWorkforcemanagementAlternativeshiftsTradesStateJob(jobId) {
|
|
908
|
+
// verify the required parameter 'jobId' is set
|
|
909
|
+
if (jobId === undefined || jobId === null) {
|
|
910
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAlternativeshiftsTradesStateJob';
|
|
911
|
+
}
|
|
912
|
+
|
|
913
|
+
return this.apiClient.callApi(
|
|
914
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs/{jobId}',
|
|
915
|
+
'GET',
|
|
916
|
+
{ 'jobId': jobId },
|
|
917
|
+
{ },
|
|
918
|
+
{ },
|
|
919
|
+
{ },
|
|
920
|
+
null,
|
|
921
|
+
['PureCloud OAuth'],
|
|
922
|
+
['application/json'],
|
|
923
|
+
['application/json']
|
|
924
|
+
);
|
|
925
|
+
}
|
|
926
|
+
|
|
693
927
|
/**
|
|
694
928
|
* Get business unit
|
|
695
929
|
* Expanding "settings" will retrieve all settings. All other expands will retrieve only the requested settings field(s).
|
|
@@ -783,7 +1017,6 @@ class WorkforceManagementApi {
|
|
|
783
1017
|
*
|
|
784
1018
|
* @param {String} businessUnitId The ID of the business unit
|
|
785
1019
|
* @param {String} activityPlanId The ID of the activity plan to fetch
|
|
786
|
-
* getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
787
1020
|
*/
|
|
788
1021
|
getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
|
|
789
1022
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -815,7 +1048,6 @@ class WorkforceManagementApi {
|
|
|
815
1048
|
* @param {String} businessUnitId The ID of the business unit
|
|
816
1049
|
* @param {String} activityPlanId The ID of the activity plan associated with the run job
|
|
817
1050
|
* @param {String} jobId The ID of the activity plan run job
|
|
818
|
-
* getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
819
1051
|
*/
|
|
820
1052
|
getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
|
|
821
1053
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -851,7 +1083,6 @@ class WorkforceManagementApi {
|
|
|
851
1083
|
* @param {String} businessUnitId The ID of the business unit
|
|
852
1084
|
* @param {Object} opts Optional parameters
|
|
853
1085
|
* @param {Object} opts.state Optionally filter by activity plan state
|
|
854
|
-
* getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
855
1086
|
*/
|
|
856
1087
|
getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
|
|
857
1088
|
opts = opts || {};
|
|
@@ -879,7 +1110,6 @@ class WorkforceManagementApi {
|
|
|
879
1110
|
* Gets the latest job for all activity plans in the business unit
|
|
880
1111
|
*
|
|
881
1112
|
* @param {String} businessUnitId The ID of the business unit
|
|
882
|
-
* getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
883
1113
|
*/
|
|
884
1114
|
getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
|
|
885
1115
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -901,6 +1131,91 @@ class WorkforceManagementApi {
|
|
|
901
1131
|
);
|
|
902
1132
|
}
|
|
903
1133
|
|
|
1134
|
+
/**
|
|
1135
|
+
* Get alternative shifts settings for a business unit
|
|
1136
|
+
*
|
|
1137
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1138
|
+
*/
|
|
1139
|
+
getWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId) {
|
|
1140
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1141
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1142
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
1143
|
+
}
|
|
1144
|
+
|
|
1145
|
+
return this.apiClient.callApi(
|
|
1146
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
1147
|
+
'GET',
|
|
1148
|
+
{ 'businessUnitId': businessUnitId },
|
|
1149
|
+
{ },
|
|
1150
|
+
{ },
|
|
1151
|
+
{ },
|
|
1152
|
+
null,
|
|
1153
|
+
['PureCloud OAuth'],
|
|
1154
|
+
['application/json'],
|
|
1155
|
+
['application/json']
|
|
1156
|
+
);
|
|
1157
|
+
}
|
|
1158
|
+
|
|
1159
|
+
/**
|
|
1160
|
+
* Get an alternative shifts trade in a business unit for a given trade ID
|
|
1161
|
+
*
|
|
1162
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1163
|
+
* @param {String} tradeId The ID of the alternative shift trade
|
|
1164
|
+
*/
|
|
1165
|
+
getWorkforcemanagementBusinessunitAlternativeshiftsTrade(businessUnitId, tradeId) {
|
|
1166
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1167
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1168
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
|
|
1169
|
+
}
|
|
1170
|
+
// verify the required parameter 'tradeId' is set
|
|
1171
|
+
if (tradeId === undefined || tradeId === null) {
|
|
1172
|
+
throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
|
|
1173
|
+
}
|
|
1174
|
+
|
|
1175
|
+
return this.apiClient.callApi(
|
|
1176
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}',
|
|
1177
|
+
'GET',
|
|
1178
|
+
{ 'businessUnitId': businessUnitId,'tradeId': tradeId },
|
|
1179
|
+
{ },
|
|
1180
|
+
{ },
|
|
1181
|
+
{ },
|
|
1182
|
+
null,
|
|
1183
|
+
['PureCloud OAuth'],
|
|
1184
|
+
['application/json'],
|
|
1185
|
+
['application/json']
|
|
1186
|
+
);
|
|
1187
|
+
}
|
|
1188
|
+
|
|
1189
|
+
/**
|
|
1190
|
+
* Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status
|
|
1191
|
+
* Job details are only retained if the initial request returned a 202 ACCEPTED response
|
|
1192
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
1193
|
+
* @param {String} jobId The ID of the job
|
|
1194
|
+
*/
|
|
1195
|
+
getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(businessUnitId, jobId) {
|
|
1196
|
+
// verify the required parameter 'businessUnitId' is set
|
|
1197
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
1198
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
|
|
1199
|
+
}
|
|
1200
|
+
// verify the required parameter 'jobId' is set
|
|
1201
|
+
if (jobId === undefined || jobId === null) {
|
|
1202
|
+
throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
|
|
1203
|
+
}
|
|
1204
|
+
|
|
1205
|
+
return this.apiClient.callApi(
|
|
1206
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}',
|
|
1207
|
+
'GET',
|
|
1208
|
+
{ 'businessUnitId': businessUnitId,'jobId': jobId },
|
|
1209
|
+
{ },
|
|
1210
|
+
{ },
|
|
1211
|
+
{ },
|
|
1212
|
+
null,
|
|
1213
|
+
['PureCloud OAuth'],
|
|
1214
|
+
['application/json'],
|
|
1215
|
+
['application/json']
|
|
1216
|
+
);
|
|
1217
|
+
}
|
|
1218
|
+
|
|
904
1219
|
/**
|
|
905
1220
|
* Get intraday planning groups for the given date
|
|
906
1221
|
*
|
|
@@ -1873,11 +2188,166 @@ class WorkforceManagementApi {
|
|
|
1873
2188
|
}
|
|
1874
2189
|
|
|
1875
2190
|
/**
|
|
1876
|
-
* Get
|
|
2191
|
+
* Get a work plan bid
|
|
1877
2192
|
*
|
|
1878
|
-
* @param {
|
|
1879
|
-
* @param {
|
|
1880
|
-
|
|
2193
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2194
|
+
* @param {String} bidId The id of the workplanbid
|
|
2195
|
+
*/
|
|
2196
|
+
getWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
|
|
2197
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2198
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
2199
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
|
|
2200
|
+
}
|
|
2201
|
+
// verify the required parameter 'bidId' is set
|
|
2202
|
+
if (bidId === undefined || bidId === null) {
|
|
2203
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
|
|
2204
|
+
}
|
|
2205
|
+
|
|
2206
|
+
return this.apiClient.callApi(
|
|
2207
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
|
|
2208
|
+
'GET',
|
|
2209
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
2210
|
+
{ },
|
|
2211
|
+
{ },
|
|
2212
|
+
{ },
|
|
2213
|
+
null,
|
|
2214
|
+
['PureCloud OAuth'],
|
|
2215
|
+
['application/json'],
|
|
2216
|
+
['application/json']
|
|
2217
|
+
);
|
|
2218
|
+
}
|
|
2219
|
+
|
|
2220
|
+
/**
|
|
2221
|
+
* Get a bid group by bid group Id
|
|
2222
|
+
*
|
|
2223
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2224
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
2225
|
+
* @param {String} bidGroupId Work Plan Bid Group id
|
|
2226
|
+
*/
|
|
2227
|
+
getWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
|
|
2228
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2229
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
2230
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
2231
|
+
}
|
|
2232
|
+
// verify the required parameter 'bidId' is set
|
|
2233
|
+
if (bidId === undefined || bidId === null) {
|
|
2234
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
2235
|
+
}
|
|
2236
|
+
// verify the required parameter 'bidGroupId' is set
|
|
2237
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
2238
|
+
throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
2239
|
+
}
|
|
2240
|
+
|
|
2241
|
+
return this.apiClient.callApi(
|
|
2242
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
2243
|
+
'GET',
|
|
2244
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
2245
|
+
{ },
|
|
2246
|
+
{ },
|
|
2247
|
+
{ },
|
|
2248
|
+
null,
|
|
2249
|
+
['PureCloud OAuth'],
|
|
2250
|
+
['application/json'],
|
|
2251
|
+
['application/json']
|
|
2252
|
+
);
|
|
2253
|
+
}
|
|
2254
|
+
|
|
2255
|
+
/**
|
|
2256
|
+
* Gets the work plan preferences of all the agents in the work plan bid group
|
|
2257
|
+
*
|
|
2258
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2259
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
2260
|
+
* @param {String} bidGroupId The ID of the work plan bid group
|
|
2261
|
+
*/
|
|
2262
|
+
getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId) {
|
|
2263
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2264
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
2265
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
2266
|
+
}
|
|
2267
|
+
// verify the required parameter 'bidId' is set
|
|
2268
|
+
if (bidId === undefined || bidId === null) {
|
|
2269
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
2270
|
+
}
|
|
2271
|
+
// verify the required parameter 'bidGroupId' is set
|
|
2272
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
2273
|
+
throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
2274
|
+
}
|
|
2275
|
+
|
|
2276
|
+
return this.apiClient.callApi(
|
|
2277
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
|
|
2278
|
+
'GET',
|
|
2279
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
2280
|
+
{ },
|
|
2281
|
+
{ },
|
|
2282
|
+
{ },
|
|
2283
|
+
null,
|
|
2284
|
+
['PureCloud OAuth'],
|
|
2285
|
+
['application/json'],
|
|
2286
|
+
['application/json']
|
|
2287
|
+
);
|
|
2288
|
+
}
|
|
2289
|
+
|
|
2290
|
+
/**
|
|
2291
|
+
* Get summary of bid groups that belong to a work plan bid
|
|
2292
|
+
*
|
|
2293
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2294
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
2295
|
+
*/
|
|
2296
|
+
getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(businessUnitId, bidId) {
|
|
2297
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2298
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
2299
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
|
|
2300
|
+
}
|
|
2301
|
+
// verify the required parameter 'bidId' is set
|
|
2302
|
+
if (bidId === undefined || bidId === null) {
|
|
2303
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
|
|
2304
|
+
}
|
|
2305
|
+
|
|
2306
|
+
return this.apiClient.callApi(
|
|
2307
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary',
|
|
2308
|
+
'GET',
|
|
2309
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
2310
|
+
{ },
|
|
2311
|
+
{ },
|
|
2312
|
+
{ },
|
|
2313
|
+
null,
|
|
2314
|
+
['PureCloud OAuth'],
|
|
2315
|
+
['application/json'],
|
|
2316
|
+
['application/json']
|
|
2317
|
+
);
|
|
2318
|
+
}
|
|
2319
|
+
|
|
2320
|
+
/**
|
|
2321
|
+
* Get list of work plan bids
|
|
2322
|
+
*
|
|
2323
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
2324
|
+
*/
|
|
2325
|
+
getWorkforcemanagementBusinessunitWorkplanbids(businessUnitId) {
|
|
2326
|
+
// verify the required parameter 'businessUnitId' is set
|
|
2327
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
2328
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbids';
|
|
2329
|
+
}
|
|
2330
|
+
|
|
2331
|
+
return this.apiClient.callApi(
|
|
2332
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
|
|
2333
|
+
'GET',
|
|
2334
|
+
{ 'businessUnitId': businessUnitId },
|
|
2335
|
+
{ },
|
|
2336
|
+
{ },
|
|
2337
|
+
{ },
|
|
2338
|
+
null,
|
|
2339
|
+
['PureCloud OAuth'],
|
|
2340
|
+
['application/json'],
|
|
2341
|
+
['application/json']
|
|
2342
|
+
);
|
|
2343
|
+
}
|
|
2344
|
+
|
|
2345
|
+
/**
|
|
2346
|
+
* Get business units
|
|
2347
|
+
*
|
|
2348
|
+
* @param {Object} opts Optional parameters
|
|
2349
|
+
* @param {Object} opts.feature If specified, the list of business units for which the user is authorized to use the requested feature will be returned
|
|
2350
|
+
* @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
|
|
1881
2351
|
*/
|
|
1882
2352
|
getWorkforcemanagementBusinessunits(opts) {
|
|
1883
2353
|
opts = opts || {};
|
|
@@ -2966,6 +3436,101 @@ class WorkforceManagementApi {
|
|
|
2966
3436
|
);
|
|
2967
3437
|
}
|
|
2968
3438
|
|
|
3439
|
+
/**
|
|
3440
|
+
* Get work plan bid ranks for a user
|
|
3441
|
+
*
|
|
3442
|
+
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
3443
|
+
*/
|
|
3444
|
+
getWorkforcemanagementUserWorkplanbidranks(userId) {
|
|
3445
|
+
// verify the required parameter 'userId' is set
|
|
3446
|
+
if (userId === undefined || userId === null) {
|
|
3447
|
+
throw 'Missing the required parameter "userId" when calling getWorkforcemanagementUserWorkplanbidranks';
|
|
3448
|
+
}
|
|
3449
|
+
|
|
3450
|
+
return this.apiClient.callApi(
|
|
3451
|
+
'/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
|
|
3452
|
+
'GET',
|
|
3453
|
+
{ 'userId': userId },
|
|
3454
|
+
{ },
|
|
3455
|
+
{ },
|
|
3456
|
+
{ },
|
|
3457
|
+
null,
|
|
3458
|
+
['PureCloud OAuth'],
|
|
3459
|
+
['application/json'],
|
|
3460
|
+
['application/json']
|
|
3461
|
+
);
|
|
3462
|
+
}
|
|
3463
|
+
|
|
3464
|
+
/**
|
|
3465
|
+
* Gets an agent's work plan bidding preference
|
|
3466
|
+
*
|
|
3467
|
+
* @param {String} bidId The ID of the work plan bid
|
|
3468
|
+
*/
|
|
3469
|
+
getWorkforcemanagementWorkplanbidPreferences(bidId) {
|
|
3470
|
+
// verify the required parameter 'bidId' is set
|
|
3471
|
+
if (bidId === undefined || bidId === null) {
|
|
3472
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidPreferences';
|
|
3473
|
+
}
|
|
3474
|
+
|
|
3475
|
+
return this.apiClient.callApi(
|
|
3476
|
+
'/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
|
|
3477
|
+
'GET',
|
|
3478
|
+
{ 'bidId': bidId },
|
|
3479
|
+
{ },
|
|
3480
|
+
{ },
|
|
3481
|
+
{ },
|
|
3482
|
+
null,
|
|
3483
|
+
['PureCloud OAuth'],
|
|
3484
|
+
['application/json'],
|
|
3485
|
+
['application/json']
|
|
3486
|
+
);
|
|
3487
|
+
}
|
|
3488
|
+
|
|
3489
|
+
/**
|
|
3490
|
+
* Gets an agent's work plans for a bid
|
|
3491
|
+
*
|
|
3492
|
+
* @param {String} bidId The ID of the work plan bid
|
|
3493
|
+
*/
|
|
3494
|
+
getWorkforcemanagementWorkplanbidWorkplans(bidId) {
|
|
3495
|
+
// verify the required parameter 'bidId' is set
|
|
3496
|
+
if (bidId === undefined || bidId === null) {
|
|
3497
|
+
throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidWorkplans';
|
|
3498
|
+
}
|
|
3499
|
+
|
|
3500
|
+
return this.apiClient.callApi(
|
|
3501
|
+
'/api/v2/workforcemanagement/workplanbids/{bidId}/workplans',
|
|
3502
|
+
'GET',
|
|
3503
|
+
{ 'bidId': bidId },
|
|
3504
|
+
{ },
|
|
3505
|
+
{ },
|
|
3506
|
+
{ },
|
|
3507
|
+
null,
|
|
3508
|
+
['PureCloud OAuth'],
|
|
3509
|
+
['application/json'],
|
|
3510
|
+
['application/json']
|
|
3511
|
+
);
|
|
3512
|
+
}
|
|
3513
|
+
|
|
3514
|
+
/**
|
|
3515
|
+
* Gets the list of work plan bids that belong to an agent
|
|
3516
|
+
*
|
|
3517
|
+
*/
|
|
3518
|
+
getWorkforcemanagementWorkplanbids() {
|
|
3519
|
+
|
|
3520
|
+
return this.apiClient.callApi(
|
|
3521
|
+
'/api/v2/workforcemanagement/workplanbids',
|
|
3522
|
+
'GET',
|
|
3523
|
+
{ },
|
|
3524
|
+
{ },
|
|
3525
|
+
{ },
|
|
3526
|
+
{ },
|
|
3527
|
+
null,
|
|
3528
|
+
['PureCloud OAuth'],
|
|
3529
|
+
['application/json'],
|
|
3530
|
+
['application/json']
|
|
3531
|
+
);
|
|
3532
|
+
}
|
|
3533
|
+
|
|
2969
3534
|
/**
|
|
2970
3535
|
* Update an adherence explanation
|
|
2971
3536
|
*
|
|
@@ -3001,6 +3566,60 @@ class WorkforceManagementApi {
|
|
|
3001
3566
|
);
|
|
3002
3567
|
}
|
|
3003
3568
|
|
|
3569
|
+
/**
|
|
3570
|
+
* Update my alternative shifts trade by trade ID
|
|
3571
|
+
*
|
|
3572
|
+
* @param {String} tradeId The ID of the alternative shift trade
|
|
3573
|
+
* @param {Object} opts Optional parameters
|
|
3574
|
+
* @param {Object} opts.body body
|
|
3575
|
+
*/
|
|
3576
|
+
patchWorkforcemanagementAlternativeshiftsTrade(tradeId, opts) {
|
|
3577
|
+
opts = opts || {};
|
|
3578
|
+
|
|
3579
|
+
// verify the required parameter 'tradeId' is set
|
|
3580
|
+
if (tradeId === undefined || tradeId === null) {
|
|
3581
|
+
throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
3582
|
+
}
|
|
3583
|
+
|
|
3584
|
+
return this.apiClient.callApi(
|
|
3585
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
|
|
3586
|
+
'PATCH',
|
|
3587
|
+
{ 'tradeId': tradeId },
|
|
3588
|
+
{ },
|
|
3589
|
+
{ },
|
|
3590
|
+
{ },
|
|
3591
|
+
opts['body'],
|
|
3592
|
+
['PureCloud OAuth'],
|
|
3593
|
+
['application/json'],
|
|
3594
|
+
['application/json']
|
|
3595
|
+
);
|
|
3596
|
+
}
|
|
3597
|
+
|
|
3598
|
+
/**
|
|
3599
|
+
* Bulk update alternative shift trade states
|
|
3600
|
+
*
|
|
3601
|
+
* @param {Object} body The request body
|
|
3602
|
+
*/
|
|
3603
|
+
patchWorkforcemanagementAlternativeshiftsTradesStateJobs(body) {
|
|
3604
|
+
// verify the required parameter 'body' is set
|
|
3605
|
+
if (body === undefined || body === null) {
|
|
3606
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTradesStateJobs';
|
|
3607
|
+
}
|
|
3608
|
+
|
|
3609
|
+
return this.apiClient.callApi(
|
|
3610
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs',
|
|
3611
|
+
'PATCH',
|
|
3612
|
+
{ },
|
|
3613
|
+
{ },
|
|
3614
|
+
{ },
|
|
3615
|
+
{ },
|
|
3616
|
+
body,
|
|
3617
|
+
['PureCloud OAuth'],
|
|
3618
|
+
['application/json'],
|
|
3619
|
+
['application/json']
|
|
3620
|
+
);
|
|
3621
|
+
}
|
|
3622
|
+
|
|
3004
3623
|
/**
|
|
3005
3624
|
* Update business unit
|
|
3006
3625
|
*
|
|
@@ -3070,7 +3689,6 @@ class WorkforceManagementApi {
|
|
|
3070
3689
|
* @param {String} businessUnitId The ID of the business unit
|
|
3071
3690
|
* @param {String} activityPlanId The ID of the activity plan to update
|
|
3072
3691
|
* @param {Object} body body
|
|
3073
|
-
* patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3074
3692
|
*/
|
|
3075
3693
|
patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
|
|
3076
3694
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -3100,6 +3718,35 @@ class WorkforceManagementApi {
|
|
|
3100
3718
|
);
|
|
3101
3719
|
}
|
|
3102
3720
|
|
|
3721
|
+
/**
|
|
3722
|
+
* Update alternative shifts settings for a business unit
|
|
3723
|
+
*
|
|
3724
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3725
|
+
* @param {Object} opts Optional parameters
|
|
3726
|
+
* @param {Object} opts.body body
|
|
3727
|
+
*/
|
|
3728
|
+
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, opts) {
|
|
3729
|
+
opts = opts || {};
|
|
3730
|
+
|
|
3731
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3732
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3733
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
3734
|
+
}
|
|
3735
|
+
|
|
3736
|
+
return this.apiClient.callApi(
|
|
3737
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
3738
|
+
'PATCH',
|
|
3739
|
+
{ 'businessUnitId': businessUnitId },
|
|
3740
|
+
{ },
|
|
3741
|
+
{ },
|
|
3742
|
+
{ },
|
|
3743
|
+
opts['body'],
|
|
3744
|
+
['PureCloud OAuth'],
|
|
3745
|
+
['application/json'],
|
|
3746
|
+
['application/json']
|
|
3747
|
+
);
|
|
3748
|
+
}
|
|
3749
|
+
|
|
3103
3750
|
/**
|
|
3104
3751
|
* Updates the planning group
|
|
3105
3752
|
*
|
|
@@ -3189,13 +3836,116 @@ class WorkforceManagementApi {
|
|
|
3189
3836
|
}
|
|
3190
3837
|
|
|
3191
3838
|
return this.apiClient.callApi(
|
|
3192
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
3839
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
3840
|
+
'PATCH',
|
|
3841
|
+
{ 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
|
|
3842
|
+
{ },
|
|
3843
|
+
{ },
|
|
3844
|
+
{ },
|
|
3845
|
+
opts['body'],
|
|
3846
|
+
['PureCloud OAuth'],
|
|
3847
|
+
['application/json'],
|
|
3848
|
+
['application/json']
|
|
3849
|
+
);
|
|
3850
|
+
}
|
|
3851
|
+
|
|
3852
|
+
/**
|
|
3853
|
+
* Updates a staffing group
|
|
3854
|
+
*
|
|
3855
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3856
|
+
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
3857
|
+
* @param {Object} opts Optional parameters
|
|
3858
|
+
* @param {Object} opts.body body
|
|
3859
|
+
*/
|
|
3860
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
|
|
3861
|
+
opts = opts || {};
|
|
3862
|
+
|
|
3863
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3864
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3865
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
3866
|
+
}
|
|
3867
|
+
// verify the required parameter 'staffingGroupId' is set
|
|
3868
|
+
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
3869
|
+
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
3870
|
+
}
|
|
3871
|
+
|
|
3872
|
+
return this.apiClient.callApi(
|
|
3873
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
3874
|
+
'PATCH',
|
|
3875
|
+
{ 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
|
|
3876
|
+
{ },
|
|
3877
|
+
{ },
|
|
3878
|
+
{ },
|
|
3879
|
+
opts['body'],
|
|
3880
|
+
['PureCloud OAuth'],
|
|
3881
|
+
['application/json'],
|
|
3882
|
+
['application/json']
|
|
3883
|
+
);
|
|
3884
|
+
}
|
|
3885
|
+
|
|
3886
|
+
/**
|
|
3887
|
+
* Updates a time-off plan
|
|
3888
|
+
*
|
|
3889
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3890
|
+
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
3891
|
+
* @param {Object} opts Optional parameters
|
|
3892
|
+
* @param {Object} opts.body body
|
|
3893
|
+
*/
|
|
3894
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
|
|
3895
|
+
opts = opts || {};
|
|
3896
|
+
|
|
3897
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3898
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3899
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
3900
|
+
}
|
|
3901
|
+
// verify the required parameter 'timeOffPlanId' is set
|
|
3902
|
+
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
3903
|
+
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
3904
|
+
}
|
|
3905
|
+
|
|
3906
|
+
return this.apiClient.callApi(
|
|
3907
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
3908
|
+
'PATCH',
|
|
3909
|
+
{ 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
|
|
3910
|
+
{ },
|
|
3911
|
+
{ },
|
|
3912
|
+
{ },
|
|
3913
|
+
opts['body'],
|
|
3914
|
+
['PureCloud OAuth'],
|
|
3915
|
+
['application/json'],
|
|
3916
|
+
['application/json']
|
|
3917
|
+
);
|
|
3918
|
+
}
|
|
3919
|
+
|
|
3920
|
+
/**
|
|
3921
|
+
* Update work plan bid
|
|
3922
|
+
*
|
|
3923
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
3924
|
+
* @param {String} bidId The id of the workplanbid
|
|
3925
|
+
* @param {Object} body The work plan bid to be updated
|
|
3926
|
+
*/
|
|
3927
|
+
patchWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId, body) {
|
|
3928
|
+
// verify the required parameter 'businessUnitId' is set
|
|
3929
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3930
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
|
|
3931
|
+
}
|
|
3932
|
+
// verify the required parameter 'bidId' is set
|
|
3933
|
+
if (bidId === undefined || bidId === null) {
|
|
3934
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
|
|
3935
|
+
}
|
|
3936
|
+
// verify the required parameter 'body' is set
|
|
3937
|
+
if (body === undefined || body === null) {
|
|
3938
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
|
|
3939
|
+
}
|
|
3940
|
+
|
|
3941
|
+
return this.apiClient.callApi(
|
|
3942
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
|
|
3193
3943
|
'PATCH',
|
|
3194
|
-
{ 'businessUnitId': businessUnitId,'
|
|
3944
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
3195
3945
|
{ },
|
|
3196
3946
|
{ },
|
|
3197
3947
|
{ },
|
|
3198
|
-
|
|
3948
|
+
body,
|
|
3199
3949
|
['PureCloud OAuth'],
|
|
3200
3950
|
['application/json'],
|
|
3201
3951
|
['application/json']
|
|
@@ -3203,29 +3953,34 @@ class WorkforceManagementApi {
|
|
|
3203
3953
|
}
|
|
3204
3954
|
|
|
3205
3955
|
/**
|
|
3206
|
-
*
|
|
3956
|
+
* Update a bid group by bid group Id
|
|
3207
3957
|
*
|
|
3208
3958
|
* @param {String} businessUnitId The ID of the business unit
|
|
3209
|
-
* @param {String}
|
|
3959
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
3960
|
+
* @param {String} bidGroupId Work Plan Bid Group id
|
|
3210
3961
|
* @param {Object} opts Optional parameters
|
|
3211
3962
|
* @param {Object} opts.body body
|
|
3212
3963
|
*/
|
|
3213
|
-
|
|
3964
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, opts) {
|
|
3214
3965
|
opts = opts || {};
|
|
3215
3966
|
|
|
3216
3967
|
// verify the required parameter 'businessUnitId' is set
|
|
3217
3968
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3218
|
-
throw 'Missing the required parameter "businessUnitId" when calling
|
|
3969
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
3219
3970
|
}
|
|
3220
|
-
// verify the required parameter '
|
|
3221
|
-
if (
|
|
3222
|
-
throw 'Missing the required parameter "
|
|
3971
|
+
// verify the required parameter 'bidId' is set
|
|
3972
|
+
if (bidId === undefined || bidId === null) {
|
|
3973
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
3974
|
+
}
|
|
3975
|
+
// verify the required parameter 'bidGroupId' is set
|
|
3976
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
3977
|
+
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
3223
3978
|
}
|
|
3224
3979
|
|
|
3225
3980
|
return this.apiClient.callApi(
|
|
3226
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
3981
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
3227
3982
|
'PATCH',
|
|
3228
|
-
{ 'businessUnitId': businessUnitId,'
|
|
3983
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
3229
3984
|
{ },
|
|
3230
3985
|
{ },
|
|
3231
3986
|
{ },
|
|
@@ -3237,29 +3992,34 @@ class WorkforceManagementApi {
|
|
|
3237
3992
|
}
|
|
3238
3993
|
|
|
3239
3994
|
/**
|
|
3240
|
-
*
|
|
3995
|
+
* Overrides the assigned work plan for the specified agents
|
|
3241
3996
|
*
|
|
3242
3997
|
* @param {String} businessUnitId The ID of the business unit
|
|
3243
|
-
* @param {String}
|
|
3998
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
3999
|
+
* @param {String} bidGroupId The ID of the work plan bid group
|
|
3244
4000
|
* @param {Object} opts Optional parameters
|
|
3245
4001
|
* @param {Object} opts.body body
|
|
3246
4002
|
*/
|
|
3247
|
-
|
|
4003
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
|
|
3248
4004
|
opts = opts || {};
|
|
3249
4005
|
|
|
3250
4006
|
// verify the required parameter 'businessUnitId' is set
|
|
3251
4007
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
3252
|
-
throw 'Missing the required parameter "businessUnitId" when calling
|
|
4008
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
3253
4009
|
}
|
|
3254
|
-
// verify the required parameter '
|
|
3255
|
-
if (
|
|
3256
|
-
throw 'Missing the required parameter "
|
|
4010
|
+
// verify the required parameter 'bidId' is set
|
|
4011
|
+
if (bidId === undefined || bidId === null) {
|
|
4012
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
4013
|
+
}
|
|
4014
|
+
// verify the required parameter 'bidGroupId' is set
|
|
4015
|
+
if (bidGroupId === undefined || bidGroupId === null) {
|
|
4016
|
+
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
3257
4017
|
}
|
|
3258
4018
|
|
|
3259
4019
|
return this.apiClient.callApi(
|
|
3260
|
-
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/
|
|
4020
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
|
|
3261
4021
|
'PATCH',
|
|
3262
|
-
{ 'businessUnitId': businessUnitId,'
|
|
4022
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
|
|
3263
4023
|
{ },
|
|
3264
4024
|
{ },
|
|
3265
4025
|
{ },
|
|
@@ -3612,6 +4372,89 @@ class WorkforceManagementApi {
|
|
|
3612
4372
|
);
|
|
3613
4373
|
}
|
|
3614
4374
|
|
|
4375
|
+
/**
|
|
4376
|
+
* Update work plan bid ranks for a user
|
|
4377
|
+
*
|
|
4378
|
+
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
4379
|
+
* @param {Object} opts Optional parameters
|
|
4380
|
+
* @param {Object} opts.body body
|
|
4381
|
+
*/
|
|
4382
|
+
patchWorkforcemanagementUserWorkplanbidranks(userId, opts) {
|
|
4383
|
+
opts = opts || {};
|
|
4384
|
+
|
|
4385
|
+
// verify the required parameter 'userId' is set
|
|
4386
|
+
if (userId === undefined || userId === null) {
|
|
4387
|
+
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
4388
|
+
}
|
|
4389
|
+
|
|
4390
|
+
return this.apiClient.callApi(
|
|
4391
|
+
'/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
|
|
4392
|
+
'PATCH',
|
|
4393
|
+
{ 'userId': userId },
|
|
4394
|
+
{ },
|
|
4395
|
+
{ },
|
|
4396
|
+
{ },
|
|
4397
|
+
opts['body'],
|
|
4398
|
+
['PureCloud OAuth'],
|
|
4399
|
+
['application/json'],
|
|
4400
|
+
['application/json']
|
|
4401
|
+
);
|
|
4402
|
+
}
|
|
4403
|
+
|
|
4404
|
+
/**
|
|
4405
|
+
* Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
|
|
4406
|
+
*
|
|
4407
|
+
* @param {Array.<Object>} body Users
|
|
4408
|
+
*/
|
|
4409
|
+
patchWorkforcemanagementUsersWorkplanbidranksBulk(body) {
|
|
4410
|
+
// verify the required parameter 'body' is set
|
|
4411
|
+
if (body === undefined || body === null) {
|
|
4412
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUsersWorkplanbidranksBulk';
|
|
4413
|
+
}
|
|
4414
|
+
|
|
4415
|
+
return this.apiClient.callApi(
|
|
4416
|
+
'/api/v2/workforcemanagement/users/workplanbidranks/bulk',
|
|
4417
|
+
'PATCH',
|
|
4418
|
+
{ },
|
|
4419
|
+
{ },
|
|
4420
|
+
{ },
|
|
4421
|
+
{ },
|
|
4422
|
+
body,
|
|
4423
|
+
['PureCloud OAuth'],
|
|
4424
|
+
['application/json'],
|
|
4425
|
+
['application/json']
|
|
4426
|
+
);
|
|
4427
|
+
}
|
|
4428
|
+
|
|
4429
|
+
/**
|
|
4430
|
+
* Update an agent's work plan bidding preference
|
|
4431
|
+
*
|
|
4432
|
+
* @param {String} bidId The ID of the work plan bid
|
|
4433
|
+
* @param {Object} opts Optional parameters
|
|
4434
|
+
* @param {Object} opts.body body
|
|
4435
|
+
*/
|
|
4436
|
+
patchWorkforcemanagementWorkplanbidPreferences(bidId, opts) {
|
|
4437
|
+
opts = opts || {};
|
|
4438
|
+
|
|
4439
|
+
// verify the required parameter 'bidId' is set
|
|
4440
|
+
if (bidId === undefined || bidId === null) {
|
|
4441
|
+
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
4442
|
+
}
|
|
4443
|
+
|
|
4444
|
+
return this.apiClient.callApi(
|
|
4445
|
+
'/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
|
|
4446
|
+
'PATCH',
|
|
4447
|
+
{ 'bidId': bidId },
|
|
4448
|
+
{ },
|
|
4449
|
+
{ },
|
|
4450
|
+
{ },
|
|
4451
|
+
opts['body'],
|
|
4452
|
+
['PureCloud OAuth'],
|
|
4453
|
+
['application/json'],
|
|
4454
|
+
['application/json']
|
|
4455
|
+
);
|
|
4456
|
+
}
|
|
4457
|
+
|
|
3615
4458
|
/**
|
|
3616
4459
|
* Submit an adherence explanation for the current user
|
|
3617
4460
|
*
|
|
@@ -3878,6 +4721,81 @@ class WorkforceManagementApi {
|
|
|
3878
4721
|
);
|
|
3879
4722
|
}
|
|
3880
4723
|
|
|
4724
|
+
/**
|
|
4725
|
+
* Request a list of alternative shift offers for a given schedule
|
|
4726
|
+
*
|
|
4727
|
+
* @param {Object} body The request body
|
|
4728
|
+
*/
|
|
4729
|
+
postWorkforcemanagementAlternativeshiftsOffersJobs(body) {
|
|
4730
|
+
// verify the required parameter 'body' is set
|
|
4731
|
+
if (body === undefined || body === null) {
|
|
4732
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersJobs';
|
|
4733
|
+
}
|
|
4734
|
+
|
|
4735
|
+
return this.apiClient.callApi(
|
|
4736
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/jobs',
|
|
4737
|
+
'POST',
|
|
4738
|
+
{ },
|
|
4739
|
+
{ },
|
|
4740
|
+
{ },
|
|
4741
|
+
{ },
|
|
4742
|
+
body,
|
|
4743
|
+
['PureCloud OAuth'],
|
|
4744
|
+
['application/json'],
|
|
4745
|
+
['application/json']
|
|
4746
|
+
);
|
|
4747
|
+
}
|
|
4748
|
+
|
|
4749
|
+
/**
|
|
4750
|
+
* Request a search of alternative shift offers for a given shift
|
|
4751
|
+
*
|
|
4752
|
+
* @param {Object} body The request body
|
|
4753
|
+
*/
|
|
4754
|
+
postWorkforcemanagementAlternativeshiftsOffersSearchJobs(body) {
|
|
4755
|
+
// verify the required parameter 'body' is set
|
|
4756
|
+
if (body === undefined || body === null) {
|
|
4757
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersSearchJobs';
|
|
4758
|
+
}
|
|
4759
|
+
|
|
4760
|
+
return this.apiClient.callApi(
|
|
4761
|
+
'/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs',
|
|
4762
|
+
'POST',
|
|
4763
|
+
{ },
|
|
4764
|
+
{ },
|
|
4765
|
+
{ },
|
|
4766
|
+
{ },
|
|
4767
|
+
body,
|
|
4768
|
+
['PureCloud OAuth'],
|
|
4769
|
+
['application/json'],
|
|
4770
|
+
['application/json']
|
|
4771
|
+
);
|
|
4772
|
+
}
|
|
4773
|
+
|
|
4774
|
+
/**
|
|
4775
|
+
* Create my alternative shift trade using an existing offer's jobId
|
|
4776
|
+
*
|
|
4777
|
+
* @param {Object} body The request body
|
|
4778
|
+
*/
|
|
4779
|
+
postWorkforcemanagementAlternativeshiftsTrades(body) {
|
|
4780
|
+
// verify the required parameter 'body' is set
|
|
4781
|
+
if (body === undefined || body === null) {
|
|
4782
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsTrades';
|
|
4783
|
+
}
|
|
4784
|
+
|
|
4785
|
+
return this.apiClient.callApi(
|
|
4786
|
+
'/api/v2/workforcemanagement/alternativeshifts/trades',
|
|
4787
|
+
'POST',
|
|
4788
|
+
{ },
|
|
4789
|
+
{ },
|
|
4790
|
+
{ },
|
|
4791
|
+
{ },
|
|
4792
|
+
body,
|
|
4793
|
+
['PureCloud OAuth'],
|
|
4794
|
+
['application/json'],
|
|
4795
|
+
['application/json']
|
|
4796
|
+
);
|
|
4797
|
+
}
|
|
4798
|
+
|
|
3881
4799
|
/**
|
|
3882
4800
|
* Create a new activity code
|
|
3883
4801
|
*
|
|
@@ -3912,7 +4830,6 @@ class WorkforceManagementApi {
|
|
|
3912
4830
|
* Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
|
|
3913
4831
|
* @param {String} businessUnitId The ID of the business unit
|
|
3914
4832
|
* @param {String} activityPlanId The ID of the activity plan to run
|
|
3915
|
-
* postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3916
4833
|
*/
|
|
3917
4834
|
postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
|
|
3918
4835
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -3943,7 +4860,6 @@ class WorkforceManagementApi {
|
|
|
3943
4860
|
*
|
|
3944
4861
|
* @param {String} businessUnitId The ID of the business unit
|
|
3945
4862
|
* @param {Object} body body
|
|
3946
|
-
* postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3947
4863
|
*/
|
|
3948
4864
|
postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
|
|
3949
4865
|
// verify the required parameter 'businessUnitId' is set
|
|
@@ -4035,6 +4951,40 @@ class WorkforceManagementApi {
|
|
|
4035
4951
|
);
|
|
4036
4952
|
}
|
|
4037
4953
|
|
|
4954
|
+
/**
|
|
4955
|
+
* List alternative shifts trades for a given management unit or agent
|
|
4956
|
+
*
|
|
4957
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
4958
|
+
* @param {Object} body The request body
|
|
4959
|
+
* @param {Object} opts Optional parameters
|
|
4960
|
+
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
4961
|
+
*/
|
|
4962
|
+
postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(businessUnitId, body, opts) {
|
|
4963
|
+
opts = opts || {};
|
|
4964
|
+
|
|
4965
|
+
// verify the required parameter 'businessUnitId' is set
|
|
4966
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
4967
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
|
|
4968
|
+
}
|
|
4969
|
+
// verify the required parameter 'body' is set
|
|
4970
|
+
if (body === undefined || body === null) {
|
|
4971
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
|
|
4972
|
+
}
|
|
4973
|
+
|
|
4974
|
+
return this.apiClient.callApi(
|
|
4975
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search',
|
|
4976
|
+
'POST',
|
|
4977
|
+
{ 'businessUnitId': businessUnitId },
|
|
4978
|
+
{ 'forceAsync': opts['forceAsync'] },
|
|
4979
|
+
{ },
|
|
4980
|
+
{ },
|
|
4981
|
+
body,
|
|
4982
|
+
['PureCloud OAuth'],
|
|
4983
|
+
['application/json'],
|
|
4984
|
+
['application/json']
|
|
4985
|
+
);
|
|
4986
|
+
}
|
|
4987
|
+
|
|
4038
4988
|
/**
|
|
4039
4989
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
4040
4990
|
*
|
|
@@ -4844,6 +5794,103 @@ class WorkforceManagementApi {
|
|
|
4844
5794
|
);
|
|
4845
5795
|
}
|
|
4846
5796
|
|
|
5797
|
+
/**
|
|
5798
|
+
* Copy a work plan bid
|
|
5799
|
+
*
|
|
5800
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5801
|
+
* @param {String} bidId The ID of the work plan bid to copy
|
|
5802
|
+
* @param {Object} opts Optional parameters
|
|
5803
|
+
* @param {Object} opts.body body
|
|
5804
|
+
*/
|
|
5805
|
+
postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, opts) {
|
|
5806
|
+
opts = opts || {};
|
|
5807
|
+
|
|
5808
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5809
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
5810
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
5811
|
+
}
|
|
5812
|
+
// verify the required parameter 'bidId' is set
|
|
5813
|
+
if (bidId === undefined || bidId === null) {
|
|
5814
|
+
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
|
|
5815
|
+
}
|
|
5816
|
+
|
|
5817
|
+
return this.apiClient.callApi(
|
|
5818
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
|
|
5819
|
+
'POST',
|
|
5820
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
5821
|
+
{ },
|
|
5822
|
+
{ },
|
|
5823
|
+
{ },
|
|
5824
|
+
opts['body'],
|
|
5825
|
+
['PureCloud OAuth'],
|
|
5826
|
+
['application/json'],
|
|
5827
|
+
['application/json']
|
|
5828
|
+
);
|
|
5829
|
+
}
|
|
5830
|
+
|
|
5831
|
+
/**
|
|
5832
|
+
* Add a bid group in a given work plan bid
|
|
5833
|
+
*
|
|
5834
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5835
|
+
* @param {String} bidId The work plan bid id of the bid groups
|
|
5836
|
+
* @param {Object} opts Optional parameters
|
|
5837
|
+
* @param {Object} opts.body body
|
|
5838
|
+
*/
|
|
5839
|
+
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, opts) {
|
|
5840
|
+
opts = opts || {};
|
|
5841
|
+
|
|
5842
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5843
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
5844
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
5845
|
+
}
|
|
5846
|
+
// verify the required parameter 'bidId' is set
|
|
5847
|
+
if (bidId === undefined || bidId === null) {
|
|
5848
|
+
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
5849
|
+
}
|
|
5850
|
+
|
|
5851
|
+
return this.apiClient.callApi(
|
|
5852
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
|
|
5853
|
+
'POST',
|
|
5854
|
+
{ 'businessUnitId': businessUnitId,'bidId': bidId },
|
|
5855
|
+
{ },
|
|
5856
|
+
{ },
|
|
5857
|
+
{ },
|
|
5858
|
+
opts['body'],
|
|
5859
|
+
['PureCloud OAuth'],
|
|
5860
|
+
['application/json'],
|
|
5861
|
+
['application/json']
|
|
5862
|
+
);
|
|
5863
|
+
}
|
|
5864
|
+
|
|
5865
|
+
/**
|
|
5866
|
+
* Create a new work plan bid
|
|
5867
|
+
*
|
|
5868
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
5869
|
+
* @param {Object} opts Optional parameters
|
|
5870
|
+
* @param {Object} opts.body The work plan bid to be created
|
|
5871
|
+
*/
|
|
5872
|
+
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, opts) {
|
|
5873
|
+
opts = opts || {};
|
|
5874
|
+
|
|
5875
|
+
// verify the required parameter 'businessUnitId' is set
|
|
5876
|
+
if (businessUnitId === undefined || businessUnitId === null) {
|
|
5877
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
5878
|
+
}
|
|
5879
|
+
|
|
5880
|
+
return this.apiClient.callApi(
|
|
5881
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
|
|
5882
|
+
'POST',
|
|
5883
|
+
{ 'businessUnitId': businessUnitId },
|
|
5884
|
+
{ },
|
|
5885
|
+
{ },
|
|
5886
|
+
{ },
|
|
5887
|
+
opts['body'],
|
|
5888
|
+
['PureCloud OAuth'],
|
|
5889
|
+
['application/json'],
|
|
5890
|
+
['application/json']
|
|
5891
|
+
);
|
|
5892
|
+
}
|
|
5893
|
+
|
|
4847
5894
|
/**
|
|
4848
5895
|
* Add a new business unit
|
|
4849
5896
|
* It may take a minute or two for a new business unit to be available for api operations
|