purecloud-platform-client-v2 200.0.0 → 201.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.
Files changed (87) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +1262 -116
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1262 -116
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +410 -124
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +526 -156
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +584 -21
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +3 -3
  14. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +21 -1
  39. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LearningApi.js +4 -4
  44. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +68 -1
  54. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +36 -31
  71. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/UsersApi.js +4 -4
  80. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +1080 -26
  87. 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 200.0.0
8
+ * @version 201.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).
@@ -901,6 +1135,91 @@ class WorkforceManagementApi {
901
1135
  );
902
1136
  }
903
1137
 
1138
+ /**
1139
+ * Get alternative shifts settings for a business unit
1140
+ *
1141
+ * @param {String} businessUnitId The ID of the business unit
1142
+ */
1143
+ getWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId) {
1144
+ // verify the required parameter 'businessUnitId' is set
1145
+ if (businessUnitId === undefined || businessUnitId === null) {
1146
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsSettings';
1147
+ }
1148
+
1149
+ return this.apiClient.callApi(
1150
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
1151
+ 'GET',
1152
+ { 'businessUnitId': businessUnitId },
1153
+ { },
1154
+ { },
1155
+ { },
1156
+ null,
1157
+ ['PureCloud OAuth'],
1158
+ ['application/json'],
1159
+ ['application/json']
1160
+ );
1161
+ }
1162
+
1163
+ /**
1164
+ * Get an alternative shifts trade in a business unit for a given trade ID
1165
+ *
1166
+ * @param {String} businessUnitId The ID of the business unit
1167
+ * @param {String} tradeId The ID of the alternative shift trade
1168
+ */
1169
+ getWorkforcemanagementBusinessunitAlternativeshiftsTrade(businessUnitId, tradeId) {
1170
+ // verify the required parameter 'businessUnitId' is set
1171
+ if (businessUnitId === undefined || businessUnitId === null) {
1172
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
1173
+ }
1174
+ // verify the required parameter 'tradeId' is set
1175
+ if (tradeId === undefined || tradeId === null) {
1176
+ throw 'Missing the required parameter "tradeId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTrade';
1177
+ }
1178
+
1179
+ return this.apiClient.callApi(
1180
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/{tradeId}',
1181
+ 'GET',
1182
+ { 'businessUnitId': businessUnitId,'tradeId': tradeId },
1183
+ { },
1184
+ { },
1185
+ { },
1186
+ null,
1187
+ ['PureCloud OAuth'],
1188
+ ['application/json'],
1189
+ ['application/json']
1190
+ );
1191
+ }
1192
+
1193
+ /**
1194
+ * Query the status of an alternative shift search trade operation. Only the user who started the operation can query the status
1195
+ * Job details are only retained if the initial request returned a 202 ACCEPTED response
1196
+ * @param {String} businessUnitId The ID of the business unit
1197
+ * @param {String} jobId The ID of the job
1198
+ */
1199
+ getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob(businessUnitId, jobId) {
1200
+ // verify the required parameter 'businessUnitId' is set
1201
+ if (businessUnitId === undefined || businessUnitId === null) {
1202
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
1203
+ }
1204
+ // verify the required parameter 'jobId' is set
1205
+ if (jobId === undefined || jobId === null) {
1206
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitAlternativeshiftsTradesSearchJob';
1207
+ }
1208
+
1209
+ return this.apiClient.callApi(
1210
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search/jobs/{jobId}',
1211
+ 'GET',
1212
+ { 'businessUnitId': businessUnitId,'jobId': jobId },
1213
+ { },
1214
+ { },
1215
+ { },
1216
+ null,
1217
+ ['PureCloud OAuth'],
1218
+ ['application/json'],
1219
+ ['application/json']
1220
+ );
1221
+ }
1222
+
904
1223
  /**
905
1224
  * Get intraday planning groups for the given date
906
1225
  *
@@ -1873,11 +2192,166 @@ class WorkforceManagementApi {
1873
2192
  }
1874
2193
 
1875
2194
  /**
1876
- * Get business units
2195
+ * Get a work plan bid
1877
2196
  *
1878
- * @param {Object} opts Optional parameters
1879
- * @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
1880
- * @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
2197
+ * @param {String} businessUnitId The ID of the business unit
2198
+ * @param {String} bidId The id of the workplanbid
2199
+ */
2200
+ getWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId) {
2201
+ // verify the required parameter 'businessUnitId' is set
2202
+ if (businessUnitId === undefined || businessUnitId === null) {
2203
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
2204
+ }
2205
+ // verify the required parameter 'bidId' is set
2206
+ if (bidId === undefined || bidId === null) {
2207
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbid';
2208
+ }
2209
+
2210
+ return this.apiClient.callApi(
2211
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
2212
+ 'GET',
2213
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
2214
+ { },
2215
+ { },
2216
+ { },
2217
+ null,
2218
+ ['PureCloud OAuth'],
2219
+ ['application/json'],
2220
+ ['application/json']
2221
+ );
2222
+ }
2223
+
2224
+ /**
2225
+ * Get a bid group by bid group Id
2226
+ *
2227
+ * @param {String} businessUnitId The ID of the business unit
2228
+ * @param {String} bidId The work plan bid id of the bid groups
2229
+ * @param {String} bidGroupId Work Plan Bid Group id
2230
+ */
2231
+ getWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId) {
2232
+ // verify the required parameter 'businessUnitId' is set
2233
+ if (businessUnitId === undefined || businessUnitId === null) {
2234
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
2235
+ }
2236
+ // verify the required parameter 'bidId' is set
2237
+ if (bidId === undefined || bidId === null) {
2238
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
2239
+ }
2240
+ // verify the required parameter 'bidGroupId' is set
2241
+ if (bidGroupId === undefined || bidGroupId === null) {
2242
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroup';
2243
+ }
2244
+
2245
+ return this.apiClient.callApi(
2246
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
2247
+ 'GET',
2248
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
2249
+ { },
2250
+ { },
2251
+ { },
2252
+ null,
2253
+ ['PureCloud OAuth'],
2254
+ ['application/json'],
2255
+ ['application/json']
2256
+ );
2257
+ }
2258
+
2259
+ /**
2260
+ * Gets the work plan preferences of all the agents in the work plan bid group
2261
+ *
2262
+ * @param {String} businessUnitId The ID of the business unit
2263
+ * @param {String} bidId The work plan bid id of the bid groups
2264
+ * @param {String} bidGroupId The ID of the work plan bid group
2265
+ */
2266
+ getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId) {
2267
+ // verify the required parameter 'businessUnitId' is set
2268
+ if (businessUnitId === undefined || businessUnitId === null) {
2269
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
2270
+ }
2271
+ // verify the required parameter 'bidId' is set
2272
+ if (bidId === undefined || bidId === null) {
2273
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
2274
+ }
2275
+ // verify the required parameter 'bidGroupId' is set
2276
+ if (bidGroupId === undefined || bidGroupId === null) {
2277
+ throw 'Missing the required parameter "bidGroupId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
2278
+ }
2279
+
2280
+ return this.apiClient.callApi(
2281
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
2282
+ 'GET',
2283
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
2284
+ { },
2285
+ { },
2286
+ { },
2287
+ null,
2288
+ ['PureCloud OAuth'],
2289
+ ['application/json'],
2290
+ ['application/json']
2291
+ );
2292
+ }
2293
+
2294
+ /**
2295
+ * Get summary of bid groups that belong to a work plan bid
2296
+ *
2297
+ * @param {String} businessUnitId The ID of the business unit
2298
+ * @param {String} bidId The work plan bid id of the bid groups
2299
+ */
2300
+ getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary(businessUnitId, bidId) {
2301
+ // verify the required parameter 'businessUnitId' is set
2302
+ if (businessUnitId === undefined || businessUnitId === null) {
2303
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
2304
+ }
2305
+ // verify the required parameter 'bidId' is set
2306
+ if (bidId === undefined || bidId === null) {
2307
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementBusinessunitWorkplanbidGroupsSummary';
2308
+ }
2309
+
2310
+ return this.apiClient.callApi(
2311
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/summary',
2312
+ 'GET',
2313
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
2314
+ { },
2315
+ { },
2316
+ { },
2317
+ null,
2318
+ ['PureCloud OAuth'],
2319
+ ['application/json'],
2320
+ ['application/json']
2321
+ );
2322
+ }
2323
+
2324
+ /**
2325
+ * Get list of work plan bids
2326
+ *
2327
+ * @param {String} businessUnitId The ID of the business unit
2328
+ */
2329
+ getWorkforcemanagementBusinessunitWorkplanbids(businessUnitId) {
2330
+ // verify the required parameter 'businessUnitId' is set
2331
+ if (businessUnitId === undefined || businessUnitId === null) {
2332
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitWorkplanbids';
2333
+ }
2334
+
2335
+ return this.apiClient.callApi(
2336
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
2337
+ 'GET',
2338
+ { 'businessUnitId': businessUnitId },
2339
+ { },
2340
+ { },
2341
+ { },
2342
+ null,
2343
+ ['PureCloud OAuth'],
2344
+ ['application/json'],
2345
+ ['application/json']
2346
+ );
2347
+ }
2348
+
2349
+ /**
2350
+ * Get business units
2351
+ *
2352
+ * @param {Object} opts Optional parameters
2353
+ * @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
2354
+ * @param {String} opts.divisionId If specified, the list of business units belonging to the specified division will be returned
1881
2355
  */
1882
2356
  getWorkforcemanagementBusinessunits(opts) {
1883
2357
  opts = opts || {};
@@ -2966,6 +3440,101 @@ class WorkforceManagementApi {
2966
3440
  );
2967
3441
  }
2968
3442
 
3443
+ /**
3444
+ * Get work plan bid ranks for a user
3445
+ *
3446
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
3447
+ */
3448
+ getWorkforcemanagementUserWorkplanbidranks(userId) {
3449
+ // verify the required parameter 'userId' is set
3450
+ if (userId === undefined || userId === null) {
3451
+ throw 'Missing the required parameter "userId" when calling getWorkforcemanagementUserWorkplanbidranks';
3452
+ }
3453
+
3454
+ return this.apiClient.callApi(
3455
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
3456
+ 'GET',
3457
+ { 'userId': userId },
3458
+ { },
3459
+ { },
3460
+ { },
3461
+ null,
3462
+ ['PureCloud OAuth'],
3463
+ ['application/json'],
3464
+ ['application/json']
3465
+ );
3466
+ }
3467
+
3468
+ /**
3469
+ * Gets an agent's work plan bidding preference
3470
+ *
3471
+ * @param {String} bidId The ID of the work plan bid
3472
+ */
3473
+ getWorkforcemanagementWorkplanbidPreferences(bidId) {
3474
+ // verify the required parameter 'bidId' is set
3475
+ if (bidId === undefined || bidId === null) {
3476
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidPreferences';
3477
+ }
3478
+
3479
+ return this.apiClient.callApi(
3480
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
3481
+ 'GET',
3482
+ { 'bidId': bidId },
3483
+ { },
3484
+ { },
3485
+ { },
3486
+ null,
3487
+ ['PureCloud OAuth'],
3488
+ ['application/json'],
3489
+ ['application/json']
3490
+ );
3491
+ }
3492
+
3493
+ /**
3494
+ * Gets an agent's work plans for a bid
3495
+ *
3496
+ * @param {String} bidId The ID of the work plan bid
3497
+ */
3498
+ getWorkforcemanagementWorkplanbidWorkplans(bidId) {
3499
+ // verify the required parameter 'bidId' is set
3500
+ if (bidId === undefined || bidId === null) {
3501
+ throw 'Missing the required parameter "bidId" when calling getWorkforcemanagementWorkplanbidWorkplans';
3502
+ }
3503
+
3504
+ return this.apiClient.callApi(
3505
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/workplans',
3506
+ 'GET',
3507
+ { 'bidId': bidId },
3508
+ { },
3509
+ { },
3510
+ { },
3511
+ null,
3512
+ ['PureCloud OAuth'],
3513
+ ['application/json'],
3514
+ ['application/json']
3515
+ );
3516
+ }
3517
+
3518
+ /**
3519
+ * Gets the list of work plan bids that belong to an agent
3520
+ *
3521
+ */
3522
+ getWorkforcemanagementWorkplanbids() {
3523
+
3524
+ return this.apiClient.callApi(
3525
+ '/api/v2/workforcemanagement/workplanbids',
3526
+ 'GET',
3527
+ { },
3528
+ { },
3529
+ { },
3530
+ { },
3531
+ null,
3532
+ ['PureCloud OAuth'],
3533
+ ['application/json'],
3534
+ ['application/json']
3535
+ );
3536
+ }
3537
+
2969
3538
  /**
2970
3539
  * Update an adherence explanation
2971
3540
  *
@@ -3001,6 +3570,60 @@ class WorkforceManagementApi {
3001
3570
  );
3002
3571
  }
3003
3572
 
3573
+ /**
3574
+ * Update my alternative shifts trade by trade ID
3575
+ *
3576
+ * @param {String} tradeId The ID of the alternative shift trade
3577
+ * @param {Object} opts Optional parameters
3578
+ * @param {Object} opts.body body
3579
+ */
3580
+ patchWorkforcemanagementAlternativeshiftsTrade(tradeId, opts) {
3581
+ opts = opts || {};
3582
+
3583
+ // verify the required parameter 'tradeId' is set
3584
+ if (tradeId === undefined || tradeId === null) {
3585
+ throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
3586
+ }
3587
+
3588
+ return this.apiClient.callApi(
3589
+ '/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
3590
+ 'PATCH',
3591
+ { 'tradeId': tradeId },
3592
+ { },
3593
+ { },
3594
+ { },
3595
+ opts['body'],
3596
+ ['PureCloud OAuth'],
3597
+ ['application/json'],
3598
+ ['application/json']
3599
+ );
3600
+ }
3601
+
3602
+ /**
3603
+ * Bulk update alternative shift trade states
3604
+ *
3605
+ * @param {Object} body The request body
3606
+ */
3607
+ patchWorkforcemanagementAlternativeshiftsTradesStateJobs(body) {
3608
+ // verify the required parameter 'body' is set
3609
+ if (body === undefined || body === null) {
3610
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTradesStateJobs';
3611
+ }
3612
+
3613
+ return this.apiClient.callApi(
3614
+ '/api/v2/workforcemanagement/alternativeshifts/trades/state/jobs',
3615
+ 'PATCH',
3616
+ { },
3617
+ { },
3618
+ { },
3619
+ { },
3620
+ body,
3621
+ ['PureCloud OAuth'],
3622
+ ['application/json'],
3623
+ ['application/json']
3624
+ );
3625
+ }
3626
+
3004
3627
  /**
3005
3628
  * Update business unit
3006
3629
  *
@@ -3100,6 +3723,35 @@ class WorkforceManagementApi {
3100
3723
  );
3101
3724
  }
3102
3725
 
3726
+ /**
3727
+ * Update alternative shifts settings for a business unit
3728
+ *
3729
+ * @param {String} businessUnitId The ID of the business unit
3730
+ * @param {Object} opts Optional parameters
3731
+ * @param {Object} opts.body body
3732
+ */
3733
+ patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, opts) {
3734
+ opts = opts || {};
3735
+
3736
+ // verify the required parameter 'businessUnitId' is set
3737
+ if (businessUnitId === undefined || businessUnitId === null) {
3738
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
3739
+ }
3740
+
3741
+ return this.apiClient.callApi(
3742
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
3743
+ 'PATCH',
3744
+ { 'businessUnitId': businessUnitId },
3745
+ { },
3746
+ { },
3747
+ { },
3748
+ opts['body'],
3749
+ ['PureCloud OAuth'],
3750
+ ['application/json'],
3751
+ ['application/json']
3752
+ );
3753
+ }
3754
+
3103
3755
  /**
3104
3756
  * Updates the planning group
3105
3757
  *
@@ -3189,13 +3841,116 @@ class WorkforceManagementApi {
3189
3841
  }
3190
3842
 
3191
3843
  return this.apiClient.callApi(
3192
- '/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
3844
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
3845
+ 'PATCH',
3846
+ { 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
3847
+ { },
3848
+ { },
3849
+ { },
3850
+ opts['body'],
3851
+ ['PureCloud OAuth'],
3852
+ ['application/json'],
3853
+ ['application/json']
3854
+ );
3855
+ }
3856
+
3857
+ /**
3858
+ * Updates a staffing group
3859
+ *
3860
+ * @param {String} businessUnitId The ID of the business unit
3861
+ * @param {String} staffingGroupId The ID of the staffing group to update
3862
+ * @param {Object} opts Optional parameters
3863
+ * @param {Object} opts.body body
3864
+ */
3865
+ patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
3866
+ opts = opts || {};
3867
+
3868
+ // verify the required parameter 'businessUnitId' is set
3869
+ if (businessUnitId === undefined || businessUnitId === null) {
3870
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
3871
+ }
3872
+ // verify the required parameter 'staffingGroupId' is set
3873
+ if (staffingGroupId === undefined || staffingGroupId === null) {
3874
+ throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
3875
+ }
3876
+
3877
+ return this.apiClient.callApi(
3878
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
3879
+ 'PATCH',
3880
+ { 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
3881
+ { },
3882
+ { },
3883
+ { },
3884
+ opts['body'],
3885
+ ['PureCloud OAuth'],
3886
+ ['application/json'],
3887
+ ['application/json']
3888
+ );
3889
+ }
3890
+
3891
+ /**
3892
+ * Updates a time-off plan
3893
+ *
3894
+ * @param {String} businessUnitId The ID of the business unit
3895
+ * @param {String} timeOffPlanId The ID of the time-off plan to update
3896
+ * @param {Object} opts Optional parameters
3897
+ * @param {Object} opts.body body
3898
+ */
3899
+ patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
3900
+ opts = opts || {};
3901
+
3902
+ // verify the required parameter 'businessUnitId' is set
3903
+ if (businessUnitId === undefined || businessUnitId === null) {
3904
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
3905
+ }
3906
+ // verify the required parameter 'timeOffPlanId' is set
3907
+ if (timeOffPlanId === undefined || timeOffPlanId === null) {
3908
+ throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
3909
+ }
3910
+
3911
+ return this.apiClient.callApi(
3912
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
3913
+ 'PATCH',
3914
+ { 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
3915
+ { },
3916
+ { },
3917
+ { },
3918
+ opts['body'],
3919
+ ['PureCloud OAuth'],
3920
+ ['application/json'],
3921
+ ['application/json']
3922
+ );
3923
+ }
3924
+
3925
+ /**
3926
+ * Update work plan bid
3927
+ *
3928
+ * @param {String} businessUnitId The ID of the business unit
3929
+ * @param {String} bidId The id of the workplanbid
3930
+ * @param {Object} body The work plan bid to be updated
3931
+ */
3932
+ patchWorkforcemanagementBusinessunitWorkplanbid(businessUnitId, bidId, body) {
3933
+ // verify the required parameter 'businessUnitId' is set
3934
+ if (businessUnitId === undefined || businessUnitId === null) {
3935
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
3936
+ }
3937
+ // verify the required parameter 'bidId' is set
3938
+ if (bidId === undefined || bidId === null) {
3939
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
3940
+ }
3941
+ // verify the required parameter 'body' is set
3942
+ if (body === undefined || body === null) {
3943
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbid';
3944
+ }
3945
+
3946
+ return this.apiClient.callApi(
3947
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}',
3193
3948
  'PATCH',
3194
- { 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
3949
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
3195
3950
  { },
3196
3951
  { },
3197
3952
  { },
3198
- opts['body'],
3953
+ body,
3199
3954
  ['PureCloud OAuth'],
3200
3955
  ['application/json'],
3201
3956
  ['application/json']
@@ -3203,29 +3958,34 @@ class WorkforceManagementApi {
3203
3958
  }
3204
3959
 
3205
3960
  /**
3206
- * Updates a staffing group
3961
+ * Update a bid group by bid group Id
3207
3962
  *
3208
3963
  * @param {String} businessUnitId The ID of the business unit
3209
- * @param {String} staffingGroupId The ID of the staffing group to update
3964
+ * @param {String} bidId The work plan bid id of the bid groups
3965
+ * @param {String} bidGroupId Work Plan Bid Group id
3210
3966
  * @param {Object} opts Optional parameters
3211
3967
  * @param {Object} opts.body body
3212
3968
  */
3213
- patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, opts) {
3969
+ patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, opts) {
3214
3970
  opts = opts || {};
3215
3971
 
3216
3972
  // verify the required parameter 'businessUnitId' is set
3217
3973
  if (businessUnitId === undefined || businessUnitId === null) {
3218
- throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
3974
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
3219
3975
  }
3220
- // verify the required parameter 'staffingGroupId' is set
3221
- if (staffingGroupId === undefined || staffingGroupId === null) {
3222
- throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
3976
+ // verify the required parameter 'bidId' is set
3977
+ if (bidId === undefined || bidId === null) {
3978
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
3979
+ }
3980
+ // verify the required parameter 'bidGroupId' is set
3981
+ if (bidGroupId === undefined || bidGroupId === null) {
3982
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
3223
3983
  }
3224
3984
 
3225
3985
  return this.apiClient.callApi(
3226
- '/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
3986
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
3227
3987
  'PATCH',
3228
- { 'businessUnitId': businessUnitId,'staffingGroupId': staffingGroupId },
3988
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
3229
3989
  { },
3230
3990
  { },
3231
3991
  { },
@@ -3237,29 +3997,34 @@ class WorkforceManagementApi {
3237
3997
  }
3238
3998
 
3239
3999
  /**
3240
- * Updates a time-off plan
4000
+ * Overrides the assigned work plan for the specified agents
3241
4001
  *
3242
4002
  * @param {String} businessUnitId The ID of the business unit
3243
- * @param {String} timeOffPlanId The ID of the time-off plan to update
4003
+ * @param {String} bidId The work plan bid id of the bid groups
4004
+ * @param {String} bidGroupId The ID of the work plan bid group
3244
4005
  * @param {Object} opts Optional parameters
3245
4006
  * @param {Object} opts.body body
3246
4007
  */
3247
- patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, opts) {
4008
+ patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, opts) {
3248
4009
  opts = opts || {};
3249
4010
 
3250
4011
  // verify the required parameter 'businessUnitId' is set
3251
4012
  if (businessUnitId === undefined || businessUnitId === null) {
3252
- throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
4013
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
3253
4014
  }
3254
- // verify the required parameter 'timeOffPlanId' is set
3255
- if (timeOffPlanId === undefined || timeOffPlanId === null) {
3256
- throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
4015
+ // verify the required parameter 'bidId' is set
4016
+ if (bidId === undefined || bidId === null) {
4017
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
4018
+ }
4019
+ // verify the required parameter 'bidGroupId' is set
4020
+ if (bidGroupId === undefined || bidGroupId === null) {
4021
+ throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
3257
4022
  }
3258
4023
 
3259
4024
  return this.apiClient.callApi(
3260
- '/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
4025
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
3261
4026
  'PATCH',
3262
- { 'businessUnitId': businessUnitId,'timeOffPlanId': timeOffPlanId },
4027
+ { 'businessUnitId': businessUnitId,'bidId': bidId,'bidGroupId': bidGroupId },
3263
4028
  { },
3264
4029
  { },
3265
4030
  { },
@@ -3612,6 +4377,89 @@ class WorkforceManagementApi {
3612
4377
  );
3613
4378
  }
3614
4379
 
4380
+ /**
4381
+ * Update work plan bid ranks for a user
4382
+ *
4383
+ * @param {String} userId The userId to whom the work plan bid ranks apply.
4384
+ * @param {Object} opts Optional parameters
4385
+ * @param {Object} opts.body body
4386
+ */
4387
+ patchWorkforcemanagementUserWorkplanbidranks(userId, opts) {
4388
+ opts = opts || {};
4389
+
4390
+ // verify the required parameter 'userId' is set
4391
+ if (userId === undefined || userId === null) {
4392
+ throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
4393
+ }
4394
+
4395
+ return this.apiClient.callApi(
4396
+ '/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
4397
+ 'PATCH',
4398
+ { 'userId': userId },
4399
+ { },
4400
+ { },
4401
+ { },
4402
+ opts['body'],
4403
+ ['PureCloud OAuth'],
4404
+ ['application/json'],
4405
+ ['application/json']
4406
+ );
4407
+ }
4408
+
4409
+ /**
4410
+ * Update bulk work plan bid ranks on users. Max 50 users can be updated at a time.
4411
+ *
4412
+ * @param {Array.<Object>} body Users
4413
+ */
4414
+ patchWorkforcemanagementUsersWorkplanbidranksBulk(body) {
4415
+ // verify the required parameter 'body' is set
4416
+ if (body === undefined || body === null) {
4417
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUsersWorkplanbidranksBulk';
4418
+ }
4419
+
4420
+ return this.apiClient.callApi(
4421
+ '/api/v2/workforcemanagement/users/workplanbidranks/bulk',
4422
+ 'PATCH',
4423
+ { },
4424
+ { },
4425
+ { },
4426
+ { },
4427
+ body,
4428
+ ['PureCloud OAuth'],
4429
+ ['application/json'],
4430
+ ['application/json']
4431
+ );
4432
+ }
4433
+
4434
+ /**
4435
+ * Update an agent's work plan bidding preference
4436
+ *
4437
+ * @param {String} bidId The ID of the work plan bid
4438
+ * @param {Object} opts Optional parameters
4439
+ * @param {Object} opts.body body
4440
+ */
4441
+ patchWorkforcemanagementWorkplanbidPreferences(bidId, opts) {
4442
+ opts = opts || {};
4443
+
4444
+ // verify the required parameter 'bidId' is set
4445
+ if (bidId === undefined || bidId === null) {
4446
+ throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
4447
+ }
4448
+
4449
+ return this.apiClient.callApi(
4450
+ '/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
4451
+ 'PATCH',
4452
+ { 'bidId': bidId },
4453
+ { },
4454
+ { },
4455
+ { },
4456
+ opts['body'],
4457
+ ['PureCloud OAuth'],
4458
+ ['application/json'],
4459
+ ['application/json']
4460
+ );
4461
+ }
4462
+
3615
4463
  /**
3616
4464
  * Submit an adherence explanation for the current user
3617
4465
  *
@@ -3878,6 +4726,81 @@ class WorkforceManagementApi {
3878
4726
  );
3879
4727
  }
3880
4728
 
4729
+ /**
4730
+ * Request a list of alternative shift offers for a given schedule
4731
+ *
4732
+ * @param {Object} body The request body
4733
+ */
4734
+ postWorkforcemanagementAlternativeshiftsOffersJobs(body) {
4735
+ // verify the required parameter 'body' is set
4736
+ if (body === undefined || body === null) {
4737
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersJobs';
4738
+ }
4739
+
4740
+ return this.apiClient.callApi(
4741
+ '/api/v2/workforcemanagement/alternativeshifts/offers/jobs',
4742
+ 'POST',
4743
+ { },
4744
+ { },
4745
+ { },
4746
+ { },
4747
+ body,
4748
+ ['PureCloud OAuth'],
4749
+ ['application/json'],
4750
+ ['application/json']
4751
+ );
4752
+ }
4753
+
4754
+ /**
4755
+ * Request a search of alternative shift offers for a given shift
4756
+ *
4757
+ * @param {Object} body The request body
4758
+ */
4759
+ postWorkforcemanagementAlternativeshiftsOffersSearchJobs(body) {
4760
+ // verify the required parameter 'body' is set
4761
+ if (body === undefined || body === null) {
4762
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsOffersSearchJobs';
4763
+ }
4764
+
4765
+ return this.apiClient.callApi(
4766
+ '/api/v2/workforcemanagement/alternativeshifts/offers/search/jobs',
4767
+ 'POST',
4768
+ { },
4769
+ { },
4770
+ { },
4771
+ { },
4772
+ body,
4773
+ ['PureCloud OAuth'],
4774
+ ['application/json'],
4775
+ ['application/json']
4776
+ );
4777
+ }
4778
+
4779
+ /**
4780
+ * Create my alternative shift trade using an existing offer's jobId
4781
+ *
4782
+ * @param {Object} body The request body
4783
+ */
4784
+ postWorkforcemanagementAlternativeshiftsTrades(body) {
4785
+ // verify the required parameter 'body' is set
4786
+ if (body === undefined || body === null) {
4787
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementAlternativeshiftsTrades';
4788
+ }
4789
+
4790
+ return this.apiClient.callApi(
4791
+ '/api/v2/workforcemanagement/alternativeshifts/trades',
4792
+ 'POST',
4793
+ { },
4794
+ { },
4795
+ { },
4796
+ { },
4797
+ body,
4798
+ ['PureCloud OAuth'],
4799
+ ['application/json'],
4800
+ ['application/json']
4801
+ );
4802
+ }
4803
+
3881
4804
  /**
3882
4805
  * Create a new activity code
3883
4806
  *
@@ -4035,6 +4958,40 @@ class WorkforceManagementApi {
4035
4958
  );
4036
4959
  }
4037
4960
 
4961
+ /**
4962
+ * List alternative shifts trades for a given management unit or agent
4963
+ *
4964
+ * @param {String} businessUnitId The ID of the business unit
4965
+ * @param {Object} body The request body
4966
+ * @param {Object} opts Optional parameters
4967
+ * @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
4968
+ */
4969
+ postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch(businessUnitId, body, opts) {
4970
+ opts = opts || {};
4971
+
4972
+ // verify the required parameter 'businessUnitId' is set
4973
+ if (businessUnitId === undefined || businessUnitId === null) {
4974
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
4975
+ }
4976
+ // verify the required parameter 'body' is set
4977
+ if (body === undefined || body === null) {
4978
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAlternativeshiftsTradesSearch';
4979
+ }
4980
+
4981
+ return this.apiClient.callApi(
4982
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/trades/search',
4983
+ 'POST',
4984
+ { 'businessUnitId': businessUnitId },
4985
+ { 'forceAsync': opts['forceAsync'] },
4986
+ { },
4987
+ { },
4988
+ body,
4989
+ ['PureCloud OAuth'],
4990
+ ['application/json'],
4991
+ ['application/json']
4992
+ );
4993
+ }
4994
+
4038
4995
  /**
4039
4996
  * Get intraday data for the given date for the requested planningGroupIds
4040
4997
  *
@@ -4844,6 +5801,103 @@ class WorkforceManagementApi {
4844
5801
  );
4845
5802
  }
4846
5803
 
5804
+ /**
5805
+ * Copy a work plan bid
5806
+ *
5807
+ * @param {String} businessUnitId The ID of the business unit
5808
+ * @param {String} bidId The ID of the work plan bid to copy
5809
+ * @param {Object} opts Optional parameters
5810
+ * @param {Object} opts.body body
5811
+ */
5812
+ postWorkforcemanagementBusinessunitWorkplanbidCopy(businessUnitId, bidId, opts) {
5813
+ opts = opts || {};
5814
+
5815
+ // verify the required parameter 'businessUnitId' is set
5816
+ if (businessUnitId === undefined || businessUnitId === null) {
5817
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
5818
+ }
5819
+ // verify the required parameter 'bidId' is set
5820
+ if (bidId === undefined || bidId === null) {
5821
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidCopy';
5822
+ }
5823
+
5824
+ return this.apiClient.callApi(
5825
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/copy',
5826
+ 'POST',
5827
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
5828
+ { },
5829
+ { },
5830
+ { },
5831
+ opts['body'],
5832
+ ['PureCloud OAuth'],
5833
+ ['application/json'],
5834
+ ['application/json']
5835
+ );
5836
+ }
5837
+
5838
+ /**
5839
+ * Add a bid group in a given work plan bid
5840
+ *
5841
+ * @param {String} businessUnitId The ID of the business unit
5842
+ * @param {String} bidId The work plan bid id of the bid groups
5843
+ * @param {Object} opts Optional parameters
5844
+ * @param {Object} opts.body body
5845
+ */
5846
+ postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, opts) {
5847
+ opts = opts || {};
5848
+
5849
+ // verify the required parameter 'businessUnitId' is set
5850
+ if (businessUnitId === undefined || businessUnitId === null) {
5851
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
5852
+ }
5853
+ // verify the required parameter 'bidId' is set
5854
+ if (bidId === undefined || bidId === null) {
5855
+ throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
5856
+ }
5857
+
5858
+ return this.apiClient.callApi(
5859
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
5860
+ 'POST',
5861
+ { 'businessUnitId': businessUnitId,'bidId': bidId },
5862
+ { },
5863
+ { },
5864
+ { },
5865
+ opts['body'],
5866
+ ['PureCloud OAuth'],
5867
+ ['application/json'],
5868
+ ['application/json']
5869
+ );
5870
+ }
5871
+
5872
+ /**
5873
+ * Create a new work plan bid
5874
+ *
5875
+ * @param {String} businessUnitId The ID of the business unit
5876
+ * @param {Object} opts Optional parameters
5877
+ * @param {Object} opts.body The work plan bid to be created
5878
+ */
5879
+ postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, opts) {
5880
+ opts = opts || {};
5881
+
5882
+ // verify the required parameter 'businessUnitId' is set
5883
+ if (businessUnitId === undefined || businessUnitId === null) {
5884
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
5885
+ }
5886
+
5887
+ return this.apiClient.callApi(
5888
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
5889
+ 'POST',
5890
+ { 'businessUnitId': businessUnitId },
5891
+ { },
5892
+ { },
5893
+ { },
5894
+ opts['body'],
5895
+ ['PureCloud OAuth'],
5896
+ ['application/json'],
5897
+ ['application/json']
5898
+ );
5899
+ }
5900
+
4847
5901
  /**
4848
5902
  * Add a new business unit
4849
5903
  * It may take a minute or two for a new business unit to be available for api operations