purecloud-platform-client-v2 222.0.0 → 223.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +3 -3
- package/dist/node/purecloud-platform-client-v2.js +905 -512
- package/dist/web-amd/purecloud-platform-client-v2.js +905 -512
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +457 -380
- package/dist/web-cjs/purecloud-platform-client-v2.js +457 -380
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1194 -992
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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/BusinessRulesApi.js +5 -6
- 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 +36 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +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 +150 -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 +1 -1
- 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 +2 -3
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -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 +1 -1
- 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/SocialMediaApi.js +71 -8
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +51 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +512 -415
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -690,7 +690,7 @@ class Configuration {
|
|
|
690
690
|
|
|
691
691
|
/**
|
|
692
692
|
* @module purecloud-platform-client-v2/ApiClient
|
|
693
|
-
* @version
|
|
693
|
+
* @version 223.0.0
|
|
694
694
|
*/
|
|
695
695
|
class ApiClient {
|
|
696
696
|
/**
|
|
@@ -2234,7 +2234,7 @@ class AgentAssistantsApi {
|
|
|
2234
2234
|
/**
|
|
2235
2235
|
* AgentAssistants service.
|
|
2236
2236
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2237
|
-
* @version
|
|
2237
|
+
* @version 223.0.0
|
|
2238
2238
|
*/
|
|
2239
2239
|
|
|
2240
2240
|
/**
|
|
@@ -2437,6 +2437,7 @@ class AgentAssistantsApi {
|
|
|
2437
2437
|
* @param {String} opts.limit Number of entities to return. Maximum of 200. Deprecated in favour of pageSize
|
|
2438
2438
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
2439
2439
|
* @param {String} opts.name Return the assistant by the given name.
|
|
2440
|
+
* @param {Object} opts.expand Which fields, if any, to expand
|
|
2440
2441
|
*/
|
|
2441
2442
|
getAssistants(opts) {
|
|
2442
2443
|
opts = opts || {};
|
|
@@ -2446,7 +2447,7 @@ class AgentAssistantsApi {
|
|
|
2446
2447
|
'/api/v2/assistants',
|
|
2447
2448
|
'GET',
|
|
2448
2449
|
{ },
|
|
2449
|
-
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'] },
|
|
2450
|
+
{ 'before': opts['before'],'after': opts['after'],'limit': opts['limit'],'pageSize': opts['pageSize'],'name': opts['name'],'expand': opts['expand'] },
|
|
2450
2451
|
{ },
|
|
2451
2452
|
{ },
|
|
2452
2453
|
null,
|
|
@@ -2610,7 +2611,7 @@ class AgentCopilotApi {
|
|
|
2610
2611
|
/**
|
|
2611
2612
|
* AgentCopilot service.
|
|
2612
2613
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
2613
|
-
* @version
|
|
2614
|
+
* @version 223.0.0
|
|
2614
2615
|
*/
|
|
2615
2616
|
|
|
2616
2617
|
/**
|
|
@@ -2686,7 +2687,7 @@ class AgentUIApi {
|
|
|
2686
2687
|
/**
|
|
2687
2688
|
* AgentUI service.
|
|
2688
2689
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
2689
|
-
* @version
|
|
2690
|
+
* @version 223.0.0
|
|
2690
2691
|
*/
|
|
2691
2692
|
|
|
2692
2693
|
/**
|
|
@@ -2817,7 +2818,7 @@ class AlertingApi {
|
|
|
2817
2818
|
/**
|
|
2818
2819
|
* Alerting service.
|
|
2819
2820
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
2820
|
-
* @version
|
|
2821
|
+
* @version 223.0.0
|
|
2821
2822
|
*/
|
|
2822
2823
|
|
|
2823
2824
|
/**
|
|
@@ -3218,7 +3219,7 @@ class AnalyticsApi {
|
|
|
3218
3219
|
/**
|
|
3219
3220
|
* Analytics service.
|
|
3220
3221
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3221
|
-
* @version
|
|
3222
|
+
* @version 223.0.0
|
|
3222
3223
|
*/
|
|
3223
3224
|
|
|
3224
3225
|
/**
|
|
@@ -6039,7 +6040,7 @@ class ArchitectApi {
|
|
|
6039
6040
|
/**
|
|
6040
6041
|
* Architect service.
|
|
6041
6042
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6042
|
-
* @version
|
|
6043
|
+
* @version 223.0.0
|
|
6043
6044
|
*/
|
|
6044
6045
|
|
|
6045
6046
|
/**
|
|
@@ -10332,7 +10333,7 @@ class AuditApi {
|
|
|
10332
10333
|
/**
|
|
10333
10334
|
* Audit service.
|
|
10334
10335
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10335
|
-
* @version
|
|
10336
|
+
* @version 223.0.0
|
|
10336
10337
|
*/
|
|
10337
10338
|
|
|
10338
10339
|
/**
|
|
@@ -10533,7 +10534,7 @@ class AuthorizationApi {
|
|
|
10533
10534
|
/**
|
|
10534
10535
|
* Authorization service.
|
|
10535
10536
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10536
|
-
* @version
|
|
10537
|
+
* @version 223.0.0
|
|
10537
10538
|
*/
|
|
10538
10539
|
|
|
10539
10540
|
/**
|
|
@@ -12248,7 +12249,7 @@ class BillingApi {
|
|
|
12248
12249
|
/**
|
|
12249
12250
|
* Billing service.
|
|
12250
12251
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12251
|
-
* @version
|
|
12252
|
+
* @version 223.0.0
|
|
12252
12253
|
*/
|
|
12253
12254
|
|
|
12254
12255
|
/**
|
|
@@ -12504,7 +12505,7 @@ class BusinessRulesApi {
|
|
|
12504
12505
|
/**
|
|
12505
12506
|
* BusinessRules service.
|
|
12506
12507
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12507
|
-
* @version
|
|
12508
|
+
* @version 223.0.0
|
|
12508
12509
|
*/
|
|
12509
12510
|
|
|
12510
12511
|
/**
|
|
@@ -12777,7 +12778,7 @@ class BusinessRulesApi {
|
|
|
12777
12778
|
* @param {String} tableId Table ID
|
|
12778
12779
|
* @param {Object} opts Optional parameters
|
|
12779
12780
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12780
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
12781
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12781
12782
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
12782
12783
|
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12783
12784
|
*/
|
|
@@ -12808,7 +12809,7 @@ class BusinessRulesApi {
|
|
|
12808
12809
|
*
|
|
12809
12810
|
* @param {Object} opts Optional parameters
|
|
12810
12811
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12811
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
12812
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12812
12813
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
12813
12814
|
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
12814
12815
|
*/
|
|
@@ -12834,9 +12835,8 @@ class BusinessRulesApi {
|
|
|
12834
12835
|
* Search for decision tables.
|
|
12835
12836
|
*
|
|
12836
12837
|
* @param {Object} opts Optional parameters
|
|
12837
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
12838
12838
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
12839
|
-
* @param {String} opts.pageSize Number of entities to return. Maximum of
|
|
12839
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
12840
12840
|
* @param {String} opts.schemaId Search for decision tables that use the schema with this ID. Cannot be combined with name search. Search results will not be paginated if used.
|
|
12841
12841
|
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name. Cannot be combined with schema search. Search results will not be paginated if used.
|
|
12842
12842
|
* getBusinessrulesDecisiontablesSearch is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
@@ -12849,7 +12849,7 @@ class BusinessRulesApi {
|
|
|
12849
12849
|
'/api/v2/businessrules/decisiontables/search',
|
|
12850
12850
|
'GET',
|
|
12851
12851
|
{ },
|
|
12852
|
-
{ '
|
|
12852
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'schemaId': opts['schemaId'],'name': opts['name'] },
|
|
12853
12853
|
{ },
|
|
12854
12854
|
{ },
|
|
12855
12855
|
null,
|
|
@@ -13418,7 +13418,7 @@ class CarrierServicesApi {
|
|
|
13418
13418
|
/**
|
|
13419
13419
|
* CarrierServices service.
|
|
13420
13420
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
13421
|
-
* @version
|
|
13421
|
+
* @version 223.0.0
|
|
13422
13422
|
*/
|
|
13423
13423
|
|
|
13424
13424
|
/**
|
|
@@ -13488,7 +13488,7 @@ class ChatApi {
|
|
|
13488
13488
|
/**
|
|
13489
13489
|
* Chat service.
|
|
13490
13490
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
13491
|
-
* @version
|
|
13491
|
+
* @version 223.0.0
|
|
13492
13492
|
*/
|
|
13493
13493
|
|
|
13494
13494
|
/**
|
|
@@ -14421,7 +14421,7 @@ class CoachingApi {
|
|
|
14421
14421
|
/**
|
|
14422
14422
|
* Coaching service.
|
|
14423
14423
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
14424
|
-
* @version
|
|
14424
|
+
* @version 223.0.0
|
|
14425
14425
|
*/
|
|
14426
14426
|
|
|
14427
14427
|
/**
|
|
@@ -14998,7 +14998,7 @@ class ContentManagementApi {
|
|
|
14998
14998
|
/**
|
|
14999
14999
|
* ContentManagement service.
|
|
15000
15000
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15001
|
-
* @version
|
|
15001
|
+
* @version 223.0.0
|
|
15002
15002
|
*/
|
|
15003
15003
|
|
|
15004
15004
|
/**
|
|
@@ -16079,7 +16079,7 @@ class ConversationsApi {
|
|
|
16079
16079
|
/**
|
|
16080
16080
|
* Conversations service.
|
|
16081
16081
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16082
|
-
* @version
|
|
16082
|
+
* @version 223.0.0
|
|
16083
16083
|
*/
|
|
16084
16084
|
|
|
16085
16085
|
/**
|
|
@@ -22397,6 +22397,41 @@ class ConversationsApi {
|
|
|
22397
22397
|
);
|
|
22398
22398
|
}
|
|
22399
22399
|
|
|
22400
|
+
/**
|
|
22401
|
+
* Send a social media message
|
|
22402
|
+
* Send a social media message on existing conversation/communication.
|
|
22403
|
+
* @param {String} conversationId conversationId
|
|
22404
|
+
* @param {String} communicationId communicationId
|
|
22405
|
+
* @param {Object} body Message
|
|
22406
|
+
*/
|
|
22407
|
+
postConversationsMessageCommunicationSocialmediaMessages(conversationId, communicationId, body) {
|
|
22408
|
+
// verify the required parameter 'conversationId' is set
|
|
22409
|
+
if (conversationId === undefined || conversationId === null) {
|
|
22410
|
+
throw 'Missing the required parameter "conversationId" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
22411
|
+
}
|
|
22412
|
+
// verify the required parameter 'communicationId' is set
|
|
22413
|
+
if (communicationId === undefined || communicationId === null) {
|
|
22414
|
+
throw 'Missing the required parameter "communicationId" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
22415
|
+
}
|
|
22416
|
+
// verify the required parameter 'body' is set
|
|
22417
|
+
if (body === undefined || body === null) {
|
|
22418
|
+
throw 'Missing the required parameter "body" when calling postConversationsMessageCommunicationSocialmediaMessages';
|
|
22419
|
+
}
|
|
22420
|
+
|
|
22421
|
+
return this.apiClient.callApi(
|
|
22422
|
+
'/api/v2/conversations/messages/{conversationId}/communications/{communicationId}/socialmedia/messages',
|
|
22423
|
+
'POST',
|
|
22424
|
+
{ 'conversationId': conversationId,'communicationId': communicationId },
|
|
22425
|
+
{ },
|
|
22426
|
+
{ },
|
|
22427
|
+
{ },
|
|
22428
|
+
body,
|
|
22429
|
+
['PureCloud OAuth'],
|
|
22430
|
+
['application/json'],
|
|
22431
|
+
['application/json']
|
|
22432
|
+
);
|
|
22433
|
+
}
|
|
22434
|
+
|
|
22400
22435
|
/**
|
|
22401
22436
|
* Send message typing event
|
|
22402
22437
|
* Send message typing event for existing conversation/communication.
|
|
@@ -23836,7 +23871,7 @@ class DataExtensionsApi {
|
|
|
23836
23871
|
/**
|
|
23837
23872
|
* DataExtensions service.
|
|
23838
23873
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
23839
|
-
* @version
|
|
23874
|
+
* @version 223.0.0
|
|
23840
23875
|
*/
|
|
23841
23876
|
|
|
23842
23877
|
/**
|
|
@@ -23922,7 +23957,7 @@ class DataPrivacyApi {
|
|
|
23922
23957
|
/**
|
|
23923
23958
|
* DataPrivacy service.
|
|
23924
23959
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
23925
|
-
* @version
|
|
23960
|
+
* @version 223.0.0
|
|
23926
23961
|
*/
|
|
23927
23962
|
|
|
23928
23963
|
/**
|
|
@@ -24092,7 +24127,7 @@ class DownloadsApi {
|
|
|
24092
24127
|
/**
|
|
24093
24128
|
* Downloads service.
|
|
24094
24129
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
24095
|
-
* @version
|
|
24130
|
+
* @version 223.0.0
|
|
24096
24131
|
*/
|
|
24097
24132
|
|
|
24098
24133
|
/**
|
|
@@ -24144,7 +24179,7 @@ class EmailsApi {
|
|
|
24144
24179
|
/**
|
|
24145
24180
|
* Emails service.
|
|
24146
24181
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
24147
|
-
* @version
|
|
24182
|
+
* @version 223.0.0
|
|
24148
24183
|
*/
|
|
24149
24184
|
|
|
24150
24185
|
/**
|
|
@@ -24273,7 +24308,7 @@ class EmployeeEngagementApi {
|
|
|
24273
24308
|
/**
|
|
24274
24309
|
* EmployeeEngagement service.
|
|
24275
24310
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
24276
|
-
* @version
|
|
24311
|
+
* @version 223.0.0
|
|
24277
24312
|
*/
|
|
24278
24313
|
|
|
24279
24314
|
/**
|
|
@@ -24424,7 +24459,7 @@ class EventsApi {
|
|
|
24424
24459
|
/**
|
|
24425
24460
|
* Events service.
|
|
24426
24461
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
24427
|
-
* @version
|
|
24462
|
+
* @version 223.0.0
|
|
24428
24463
|
*/
|
|
24429
24464
|
|
|
24430
24465
|
/**
|
|
@@ -24520,7 +24555,7 @@ class ExternalContactsApi {
|
|
|
24520
24555
|
/**
|
|
24521
24556
|
* ExternalContacts service.
|
|
24522
24557
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
24523
|
-
* @version
|
|
24558
|
+
* @version 223.0.0
|
|
24524
24559
|
*/
|
|
24525
24560
|
|
|
24526
24561
|
/**
|
|
@@ -27708,7 +27743,7 @@ class FaxApi {
|
|
|
27708
27743
|
/**
|
|
27709
27744
|
* Fax service.
|
|
27710
27745
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
27711
|
-
* @version
|
|
27746
|
+
* @version 223.0.0
|
|
27712
27747
|
*/
|
|
27713
27748
|
|
|
27714
27749
|
/**
|
|
@@ -27923,7 +27958,7 @@ class FlowsApi {
|
|
|
27923
27958
|
/**
|
|
27924
27959
|
* Flows service.
|
|
27925
27960
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
27926
|
-
* @version
|
|
27961
|
+
* @version 223.0.0
|
|
27927
27962
|
*/
|
|
27928
27963
|
|
|
27929
27964
|
/**
|
|
@@ -28106,7 +28141,7 @@ class GamificationApi {
|
|
|
28106
28141
|
/**
|
|
28107
28142
|
* Gamification service.
|
|
28108
28143
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
28109
|
-
* @version
|
|
28144
|
+
* @version 223.0.0
|
|
28110
28145
|
*/
|
|
28111
28146
|
|
|
28112
28147
|
/**
|
|
@@ -30613,7 +30648,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
30613
30648
|
/**
|
|
30614
30649
|
* GeneralDataProtectionRegulation service.
|
|
30615
30650
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
30616
|
-
* @version
|
|
30651
|
+
* @version 223.0.0
|
|
30617
30652
|
*/
|
|
30618
30653
|
|
|
30619
30654
|
/**
|
|
@@ -30743,7 +30778,7 @@ class GeolocationApi {
|
|
|
30743
30778
|
/**
|
|
30744
30779
|
* Geolocation service.
|
|
30745
30780
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
30746
|
-
* @version
|
|
30781
|
+
* @version 223.0.0
|
|
30747
30782
|
*/
|
|
30748
30783
|
|
|
30749
30784
|
/**
|
|
@@ -30874,7 +30909,7 @@ class GreetingsApi {
|
|
|
30874
30909
|
/**
|
|
30875
30910
|
* Greetings service.
|
|
30876
30911
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
30877
|
-
* @version
|
|
30912
|
+
* @version 223.0.0
|
|
30878
30913
|
*/
|
|
30879
30914
|
|
|
30880
30915
|
/**
|
|
@@ -31329,7 +31364,7 @@ class GroupsApi {
|
|
|
31329
31364
|
/**
|
|
31330
31365
|
* Groups service.
|
|
31331
31366
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
31332
|
-
* @version
|
|
31367
|
+
* @version 223.0.0
|
|
31333
31368
|
*/
|
|
31334
31369
|
|
|
31335
31370
|
/**
|
|
@@ -31848,7 +31883,7 @@ class IdentityProviderApi {
|
|
|
31848
31883
|
/**
|
|
31849
31884
|
* IdentityProvider service.
|
|
31850
31885
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
31851
|
-
* @version
|
|
31886
|
+
* @version 223.0.0
|
|
31852
31887
|
*/
|
|
31853
31888
|
|
|
31854
31889
|
/**
|
|
@@ -32709,7 +32744,7 @@ class InfrastructureAsCodeApi {
|
|
|
32709
32744
|
/**
|
|
32710
32745
|
* InfrastructureAsCode service.
|
|
32711
32746
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
32712
|
-
* @version
|
|
32747
|
+
* @version 223.0.0
|
|
32713
32748
|
*/
|
|
32714
32749
|
|
|
32715
32750
|
/**
|
|
@@ -32876,7 +32911,7 @@ class IntegrationsApi {
|
|
|
32876
32911
|
/**
|
|
32877
32912
|
* Integrations service.
|
|
32878
32913
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
32879
|
-
* @version
|
|
32914
|
+
* @version 223.0.0
|
|
32880
32915
|
*/
|
|
32881
32916
|
|
|
32882
32917
|
/**
|
|
@@ -33507,6 +33542,103 @@ class IntegrationsApi {
|
|
|
33507
33542
|
);
|
|
33508
33543
|
}
|
|
33509
33544
|
|
|
33545
|
+
/**
|
|
33546
|
+
* Get a specific Bot details
|
|
33547
|
+
*
|
|
33548
|
+
* @param {String} integrationId The integration ID for this group of bots
|
|
33549
|
+
* @param {String} botId The bot ID for this bot
|
|
33550
|
+
* @param {Object} opts Optional parameters
|
|
33551
|
+
* @param {String} opts.version Specific Version
|
|
33552
|
+
* getIntegrationsBotconnectorBot is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33553
|
+
*/
|
|
33554
|
+
getIntegrationsBotconnectorBot(integrationId, botId, opts) {
|
|
33555
|
+
opts = opts || {};
|
|
33556
|
+
|
|
33557
|
+
// verify the required parameter 'integrationId' is set
|
|
33558
|
+
if (integrationId === undefined || integrationId === null) {
|
|
33559
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBot';
|
|
33560
|
+
}
|
|
33561
|
+
// verify the required parameter 'botId' is set
|
|
33562
|
+
if (botId === undefined || botId === null) {
|
|
33563
|
+
throw 'Missing the required parameter "botId" when calling getIntegrationsBotconnectorBot';
|
|
33564
|
+
}
|
|
33565
|
+
|
|
33566
|
+
return this.apiClient.callApi(
|
|
33567
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots/{botId}',
|
|
33568
|
+
'GET',
|
|
33569
|
+
{ 'integrationId': integrationId,'botId': botId },
|
|
33570
|
+
{ 'version': opts['version'] },
|
|
33571
|
+
{ },
|
|
33572
|
+
{ },
|
|
33573
|
+
null,
|
|
33574
|
+
['PureCloud OAuth'],
|
|
33575
|
+
['application/json'],
|
|
33576
|
+
['application/json']
|
|
33577
|
+
);
|
|
33578
|
+
}
|
|
33579
|
+
|
|
33580
|
+
/**
|
|
33581
|
+
* Get the list of bots for this integration.
|
|
33582
|
+
*
|
|
33583
|
+
* @param {String} integrationId The integration ID for this group of bots.
|
|
33584
|
+
* @param {Object} opts Optional parameters
|
|
33585
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33586
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
33587
|
+
* getIntegrationsBotconnectorBots is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33588
|
+
*/
|
|
33589
|
+
getIntegrationsBotconnectorBots(integrationId, opts) {
|
|
33590
|
+
opts = opts || {};
|
|
33591
|
+
|
|
33592
|
+
// verify the required parameter 'integrationId' is set
|
|
33593
|
+
if (integrationId === undefined || integrationId === null) {
|
|
33594
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBots';
|
|
33595
|
+
}
|
|
33596
|
+
|
|
33597
|
+
return this.apiClient.callApi(
|
|
33598
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots',
|
|
33599
|
+
'GET',
|
|
33600
|
+
{ 'integrationId': integrationId },
|
|
33601
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
33602
|
+
{ },
|
|
33603
|
+
{ },
|
|
33604
|
+
null,
|
|
33605
|
+
['PureCloud OAuth'],
|
|
33606
|
+
['application/json'],
|
|
33607
|
+
['application/json']
|
|
33608
|
+
);
|
|
33609
|
+
}
|
|
33610
|
+
|
|
33611
|
+
/**
|
|
33612
|
+
* Get the summary list of bots for this integration.
|
|
33613
|
+
*
|
|
33614
|
+
* @param {String} integrationId The integration ID for this group of bots.
|
|
33615
|
+
* @param {Object} opts Optional parameters
|
|
33616
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
33617
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
33618
|
+
* getIntegrationsBotconnectorBotsSummaries is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
33619
|
+
*/
|
|
33620
|
+
getIntegrationsBotconnectorBotsSummaries(integrationId, opts) {
|
|
33621
|
+
opts = opts || {};
|
|
33622
|
+
|
|
33623
|
+
// verify the required parameter 'integrationId' is set
|
|
33624
|
+
if (integrationId === undefined || integrationId === null) {
|
|
33625
|
+
throw 'Missing the required parameter "integrationId" when calling getIntegrationsBotconnectorBotsSummaries';
|
|
33626
|
+
}
|
|
33627
|
+
|
|
33628
|
+
return this.apiClient.callApi(
|
|
33629
|
+
'/api/v2/integrations/botconnectors/{integrationId}/bots/summaries',
|
|
33630
|
+
'GET',
|
|
33631
|
+
{ 'integrationId': integrationId },
|
|
33632
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
|
|
33633
|
+
{ },
|
|
33634
|
+
{ },
|
|
33635
|
+
null,
|
|
33636
|
+
['PureCloud OAuth'],
|
|
33637
|
+
['application/json'],
|
|
33638
|
+
['application/json']
|
|
33639
|
+
);
|
|
33640
|
+
}
|
|
33641
|
+
|
|
33510
33642
|
/**
|
|
33511
33643
|
* Get a specific botConnector bot, plus versions, for this integration
|
|
33512
33644
|
*
|
|
@@ -34986,6 +35118,58 @@ class IntegrationsApi {
|
|
|
34986
35118
|
);
|
|
34987
35119
|
}
|
|
34988
35120
|
|
|
35121
|
+
/**
|
|
35122
|
+
* Send an incoming message to the bot.
|
|
35123
|
+
*
|
|
35124
|
+
* @param {Object} body Incoming Message Request
|
|
35125
|
+
* postIntegrationsBotconnectorsIncomingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35126
|
+
*/
|
|
35127
|
+
postIntegrationsBotconnectorsIncomingMessages(body) {
|
|
35128
|
+
// verify the required parameter 'body' is set
|
|
35129
|
+
if (body === undefined || body === null) {
|
|
35130
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsBotconnectorsIncomingMessages';
|
|
35131
|
+
}
|
|
35132
|
+
|
|
35133
|
+
return this.apiClient.callApi(
|
|
35134
|
+
'/api/v2/integrations/botconnectors/incoming/messages',
|
|
35135
|
+
'POST',
|
|
35136
|
+
{ },
|
|
35137
|
+
{ },
|
|
35138
|
+
{ },
|
|
35139
|
+
{ },
|
|
35140
|
+
body,
|
|
35141
|
+
['PureCloud OAuth'],
|
|
35142
|
+
['application/json'],
|
|
35143
|
+
['application/json']
|
|
35144
|
+
);
|
|
35145
|
+
}
|
|
35146
|
+
|
|
35147
|
+
/**
|
|
35148
|
+
* Send an outgoing message to the end user.
|
|
35149
|
+
*
|
|
35150
|
+
* @param {Object} body Outgoing Message Request
|
|
35151
|
+
* postIntegrationsBotconnectorsOutgoingMessages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
35152
|
+
*/
|
|
35153
|
+
postIntegrationsBotconnectorsOutgoingMessages(body) {
|
|
35154
|
+
// verify the required parameter 'body' is set
|
|
35155
|
+
if (body === undefined || body === null) {
|
|
35156
|
+
throw 'Missing the required parameter "body" when calling postIntegrationsBotconnectorsOutgoingMessages';
|
|
35157
|
+
}
|
|
35158
|
+
|
|
35159
|
+
return this.apiClient.callApi(
|
|
35160
|
+
'/api/v2/integrations/botconnectors/outgoing/messages',
|
|
35161
|
+
'POST',
|
|
35162
|
+
{ },
|
|
35163
|
+
{ },
|
|
35164
|
+
{ },
|
|
35165
|
+
{ },
|
|
35166
|
+
body,
|
|
35167
|
+
['PureCloud OAuth'],
|
|
35168
|
+
['application/json'],
|
|
35169
|
+
['application/json']
|
|
35170
|
+
);
|
|
35171
|
+
}
|
|
35172
|
+
|
|
34989
35173
|
/**
|
|
34990
35174
|
* Create a set of credentials
|
|
34991
35175
|
*
|
|
@@ -35345,7 +35529,7 @@ class JourneyApi {
|
|
|
35345
35529
|
/**
|
|
35346
35530
|
* Journey service.
|
|
35347
35531
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
35348
|
-
* @version
|
|
35532
|
+
* @version 223.0.0
|
|
35349
35533
|
*/
|
|
35350
35534
|
|
|
35351
35535
|
/**
|
|
@@ -37330,7 +37514,7 @@ class KnowledgeApi {
|
|
|
37330
37514
|
/**
|
|
37331
37515
|
* Knowledge service.
|
|
37332
37516
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
37333
|
-
* @version
|
|
37517
|
+
* @version 223.0.0
|
|
37334
37518
|
*/
|
|
37335
37519
|
|
|
37336
37520
|
/**
|
|
@@ -41203,7 +41387,7 @@ class LanguageUnderstandingApi {
|
|
|
41203
41387
|
/**
|
|
41204
41388
|
* LanguageUnderstanding service.
|
|
41205
41389
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
41206
|
-
* @version
|
|
41390
|
+
* @version 223.0.0
|
|
41207
41391
|
*/
|
|
41208
41392
|
|
|
41209
41393
|
/**
|
|
@@ -42236,7 +42420,7 @@ class LanguagesApi {
|
|
|
42236
42420
|
/**
|
|
42237
42421
|
* Languages service.
|
|
42238
42422
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
42239
|
-
* @version
|
|
42423
|
+
* @version 223.0.0
|
|
42240
42424
|
*/
|
|
42241
42425
|
|
|
42242
42426
|
/**
|
|
@@ -42458,7 +42642,7 @@ class LearningApi {
|
|
|
42458
42642
|
/**
|
|
42459
42643
|
* Learning service.
|
|
42460
42644
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
42461
|
-
* @version
|
|
42645
|
+
* @version 223.0.0
|
|
42462
42646
|
*/
|
|
42463
42647
|
|
|
42464
42648
|
/**
|
|
@@ -43487,7 +43671,7 @@ class LicenseApi {
|
|
|
43487
43671
|
/**
|
|
43488
43672
|
* License service.
|
|
43489
43673
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
43490
|
-
* @version
|
|
43674
|
+
* @version 223.0.0
|
|
43491
43675
|
*/
|
|
43492
43676
|
|
|
43493
43677
|
/**
|
|
@@ -43725,7 +43909,7 @@ class LocationsApi {
|
|
|
43725
43909
|
/**
|
|
43726
43910
|
* Locations service.
|
|
43727
43911
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
43728
|
-
* @version
|
|
43912
|
+
* @version 223.0.0
|
|
43729
43913
|
*/
|
|
43730
43914
|
|
|
43731
43915
|
/**
|
|
@@ -43961,7 +44145,7 @@ class LogCaptureApi {
|
|
|
43961
44145
|
/**
|
|
43962
44146
|
* LogCapture service.
|
|
43963
44147
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
43964
|
-
* @version
|
|
44148
|
+
* @version 223.0.0
|
|
43965
44149
|
*/
|
|
43966
44150
|
|
|
43967
44151
|
/**
|
|
@@ -44103,7 +44287,6 @@ class LogCaptureApi {
|
|
|
44103
44287
|
* Query collected log entries. It returns a limited amount of records, to get all records use download endpoint.
|
|
44104
44288
|
*
|
|
44105
44289
|
* @param {Object} opts Optional parameters
|
|
44106
|
-
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
44107
44290
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
44108
44291
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
44109
44292
|
* @param {Object} opts.body
|
|
@@ -44116,7 +44299,7 @@ class LogCaptureApi {
|
|
|
44116
44299
|
'/api/v2/diagnostics/logcapture/browser/entries/query',
|
|
44117
44300
|
'POST',
|
|
44118
44301
|
{ },
|
|
44119
|
-
{ '
|
|
44302
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
44120
44303
|
{ },
|
|
44121
44304
|
{ },
|
|
44122
44305
|
opts['body'],
|
|
@@ -44161,7 +44344,7 @@ class MessagingApi {
|
|
|
44161
44344
|
/**
|
|
44162
44345
|
* Messaging service.
|
|
44163
44346
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
44164
|
-
* @version
|
|
44347
|
+
* @version 223.0.0
|
|
44165
44348
|
*/
|
|
44166
44349
|
|
|
44167
44350
|
/**
|
|
@@ -44520,7 +44703,7 @@ class MobileDevicesApi {
|
|
|
44520
44703
|
/**
|
|
44521
44704
|
* MobileDevices service.
|
|
44522
44705
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
44523
|
-
* @version
|
|
44706
|
+
* @version 223.0.0
|
|
44524
44707
|
*/
|
|
44525
44708
|
|
|
44526
44709
|
/**
|
|
@@ -44671,7 +44854,7 @@ class NotificationsApi {
|
|
|
44671
44854
|
/**
|
|
44672
44855
|
* Notifications service.
|
|
44673
44856
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
44674
|
-
* @version
|
|
44857
|
+
* @version 223.0.0
|
|
44675
44858
|
*/
|
|
44676
44859
|
|
|
44677
44860
|
/**
|
|
@@ -44904,7 +45087,7 @@ class OAuthApi {
|
|
|
44904
45087
|
/**
|
|
44905
45088
|
* OAuth service.
|
|
44906
45089
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
44907
|
-
* @version
|
|
45090
|
+
* @version 223.0.0
|
|
44908
45091
|
*/
|
|
44909
45092
|
|
|
44910
45093
|
/**
|
|
@@ -45270,7 +45453,7 @@ class ObjectsApi {
|
|
|
45270
45453
|
/**
|
|
45271
45454
|
* Objects service.
|
|
45272
45455
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
45273
|
-
* @version
|
|
45456
|
+
* @version 223.0.0
|
|
45274
45457
|
*/
|
|
45275
45458
|
|
|
45276
45459
|
/**
|
|
@@ -45594,7 +45777,7 @@ class OperationalEventsApi {
|
|
|
45594
45777
|
/**
|
|
45595
45778
|
* OperationalEvents service.
|
|
45596
45779
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
45597
|
-
* @version
|
|
45780
|
+
* @version 223.0.0
|
|
45598
45781
|
*/
|
|
45599
45782
|
|
|
45600
45783
|
/**
|
|
@@ -45711,7 +45894,7 @@ class OrganizationApi {
|
|
|
45711
45894
|
/**
|
|
45712
45895
|
* Organization service.
|
|
45713
45896
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
45714
|
-
* @version
|
|
45897
|
+
* @version 223.0.0
|
|
45715
45898
|
*/
|
|
45716
45899
|
|
|
45717
45900
|
/**
|
|
@@ -46186,7 +46369,7 @@ class OrganizationAuthorizationApi {
|
|
|
46186
46369
|
/**
|
|
46187
46370
|
* OrganizationAuthorization service.
|
|
46188
46371
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
46189
|
-
* @version
|
|
46372
|
+
* @version 223.0.0
|
|
46190
46373
|
*/
|
|
46191
46374
|
|
|
46192
46375
|
/**
|
|
@@ -47580,7 +47763,7 @@ class OutboundApi {
|
|
|
47580
47763
|
/**
|
|
47581
47764
|
* Outbound service.
|
|
47582
47765
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
47583
|
-
* @version
|
|
47766
|
+
* @version 223.0.0
|
|
47584
47767
|
*/
|
|
47585
47768
|
|
|
47586
47769
|
/**
|
|
@@ -52202,7 +52385,7 @@ class PresenceApi {
|
|
|
52202
52385
|
/**
|
|
52203
52386
|
* Presence service.
|
|
52204
52387
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
52205
|
-
* @version
|
|
52388
|
+
* @version 223.0.0
|
|
52206
52389
|
*/
|
|
52207
52390
|
|
|
52208
52391
|
/**
|
|
@@ -52946,7 +53129,7 @@ class ProcessAutomationApi {
|
|
|
52946
53129
|
/**
|
|
52947
53130
|
* ProcessAutomation service.
|
|
52948
53131
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
52949
|
-
* @version
|
|
53132
|
+
* @version 223.0.0
|
|
52950
53133
|
*/
|
|
52951
53134
|
|
|
52952
53135
|
/**
|
|
@@ -53185,7 +53368,7 @@ class QualityApi {
|
|
|
53185
53368
|
/**
|
|
53186
53369
|
* Quality service.
|
|
53187
53370
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
53188
|
-
* @version
|
|
53371
|
+
* @version 223.0.0
|
|
53189
53372
|
*/
|
|
53190
53373
|
|
|
53191
53374
|
/**
|
|
@@ -54972,7 +55155,7 @@ class RecordingApi {
|
|
|
54972
55155
|
/**
|
|
54973
55156
|
* Recording service.
|
|
54974
55157
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
54975
|
-
* @version
|
|
55158
|
+
* @version 223.0.0
|
|
54976
55159
|
*/
|
|
54977
55160
|
|
|
54978
55161
|
/**
|
|
@@ -56577,7 +56760,7 @@ class ResponseManagementApi {
|
|
|
56577
56760
|
/**
|
|
56578
56761
|
* ResponseManagement service.
|
|
56579
56762
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
56580
|
-
* @version
|
|
56763
|
+
* @version 223.0.0
|
|
56581
56764
|
*/
|
|
56582
56765
|
|
|
56583
56766
|
/**
|
|
@@ -57087,7 +57270,7 @@ class RoutingApi {
|
|
|
57087
57270
|
/**
|
|
57088
57271
|
* Routing service.
|
|
57089
57272
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
57090
|
-
* @version
|
|
57273
|
+
* @version 223.0.0
|
|
57091
57274
|
*/
|
|
57092
57275
|
|
|
57093
57276
|
/**
|
|
@@ -61397,7 +61580,7 @@ class SCIMApi {
|
|
|
61397
61580
|
/**
|
|
61398
61581
|
* SCIM service.
|
|
61399
61582
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
61400
|
-
* @version
|
|
61583
|
+
* @version 223.0.0
|
|
61401
61584
|
*/
|
|
61402
61585
|
|
|
61403
61586
|
/**
|
|
@@ -62274,7 +62457,7 @@ class ScreenRecordingApi {
|
|
|
62274
62457
|
/**
|
|
62275
62458
|
* ScreenRecording service.
|
|
62276
62459
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
62277
|
-
* @version
|
|
62460
|
+
* @version 223.0.0
|
|
62278
62461
|
*/
|
|
62279
62462
|
|
|
62280
62463
|
/**
|
|
@@ -62319,7 +62502,7 @@ class ScriptsApi {
|
|
|
62319
62502
|
/**
|
|
62320
62503
|
* Scripts service.
|
|
62321
62504
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
62322
|
-
* @version
|
|
62505
|
+
* @version 223.0.0
|
|
62323
62506
|
*/
|
|
62324
62507
|
|
|
62325
62508
|
/**
|
|
@@ -62795,7 +62978,7 @@ class SearchApi {
|
|
|
62795
62978
|
/**
|
|
62796
62979
|
* Search service.
|
|
62797
62980
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
62798
|
-
* @version
|
|
62981
|
+
* @version 223.0.0
|
|
62799
62982
|
*/
|
|
62800
62983
|
|
|
62801
62984
|
/**
|
|
@@ -63538,7 +63721,7 @@ class SettingsApi {
|
|
|
63538
63721
|
/**
|
|
63539
63722
|
* Settings service.
|
|
63540
63723
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
63541
|
-
* @version
|
|
63724
|
+
* @version 223.0.0
|
|
63542
63725
|
*/
|
|
63543
63726
|
|
|
63544
63727
|
/**
|
|
@@ -63886,7 +64069,7 @@ class SocialMediaApi {
|
|
|
63886
64069
|
/**
|
|
63887
64070
|
* SocialMedia service.
|
|
63888
64071
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
63889
|
-
* @version
|
|
64072
|
+
* @version 223.0.0
|
|
63890
64073
|
*/
|
|
63891
64074
|
|
|
63892
64075
|
/**
|
|
@@ -64022,7 +64205,6 @@ class SocialMediaApi {
|
|
|
64022
64205
|
* @param {String} openId openId
|
|
64023
64206
|
* @param {Object} opts Optional parameters
|
|
64024
64207
|
* @param {Boolean} opts.hardDelete Determines whether a open data ingestion rule should be soft-deleted (have it's state set to deleted) or hard-deleted (permanently removed). Set to false (soft-delete) by default. (default to false)
|
|
64025
|
-
* deleteSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64026
64208
|
*/
|
|
64027
64209
|
deleteSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64028
64210
|
opts = opts || {};
|
|
@@ -64423,7 +64605,6 @@ class SocialMediaApi {
|
|
|
64423
64605
|
* @param {String} openId openId
|
|
64424
64606
|
* @param {Object} opts Optional parameters
|
|
64425
64607
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
64426
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64427
64608
|
*/
|
|
64428
64609
|
getSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64429
64610
|
opts = opts || {};
|
|
@@ -64459,7 +64640,6 @@ class SocialMediaApi {
|
|
|
64459
64640
|
* @param {String} dataIngestionRuleVersion version
|
|
64460
64641
|
* @param {Object} opts Optional parameters
|
|
64461
64642
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted item in the result.
|
|
64462
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64463
64643
|
*/
|
|
64464
64644
|
getSocialmediaTopicDataingestionrulesOpenOpenIdVersion(topicId, openId, dataIngestionRuleVersion, opts) {
|
|
64465
64645
|
opts = opts || {};
|
|
@@ -64500,7 +64680,6 @@ class SocialMediaApi {
|
|
|
64500
64680
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
64501
64681
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
64502
64682
|
* @param {Boolean} opts.includeDeleted Determines whether to include soft-deleted items in the result.
|
|
64503
|
-
* getSocialmediaTopicDataingestionrulesOpenOpenIdVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64504
64683
|
*/
|
|
64505
64684
|
getSocialmediaTopicDataingestionrulesOpenOpenIdVersions(topicId, openId, opts) {
|
|
64506
64685
|
opts = opts || {};
|
|
@@ -64734,7 +64913,6 @@ class SocialMediaApi {
|
|
|
64734
64913
|
* @param {String} openId openId
|
|
64735
64914
|
* @param {Object} opts Optional parameters
|
|
64736
64915
|
* @param {Object} opts.body
|
|
64737
|
-
* patchSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64738
64916
|
*/
|
|
64739
64917
|
patchSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
64740
64918
|
opts = opts || {};
|
|
@@ -64934,7 +65112,6 @@ class SocialMediaApi {
|
|
|
64934
65112
|
* @param {String} topicId topicId
|
|
64935
65113
|
* @param {Object} opts Optional parameters
|
|
64936
65114
|
* @param {Object} opts.body
|
|
64937
|
-
* postSocialmediaTopicDataingestionrulesOpen is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
64938
65115
|
*/
|
|
64939
65116
|
postSocialmediaTopicDataingestionrulesOpen(topicId, opts) {
|
|
64940
65117
|
opts = opts || {};
|
|
@@ -64958,6 +65135,76 @@ class SocialMediaApi {
|
|
|
64958
65135
|
);
|
|
64959
65136
|
}
|
|
64960
65137
|
|
|
65138
|
+
/**
|
|
65139
|
+
* Ingest a list of Open Social Messages
|
|
65140
|
+
* Ingest a list of open social messages to an ingestion rule on a topic. This endpoint will ingest and enrich these messages. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope.
|
|
65141
|
+
* @param {String} topicId Topic ID
|
|
65142
|
+
* @param {String} ruleId Data Ingestion Rule ID
|
|
65143
|
+
* @param {Array.<Object>} body NormalizedMessage
|
|
65144
|
+
*/
|
|
65145
|
+
postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk(topicId, ruleId, body) {
|
|
65146
|
+
// verify the required parameter 'topicId' is set
|
|
65147
|
+
if (topicId === undefined || topicId === null) {
|
|
65148
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
65149
|
+
}
|
|
65150
|
+
// verify the required parameter 'ruleId' is set
|
|
65151
|
+
if (ruleId === undefined || ruleId === null) {
|
|
65152
|
+
throw 'Missing the required parameter "ruleId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
65153
|
+
}
|
|
65154
|
+
// verify the required parameter 'body' is set
|
|
65155
|
+
if (body === undefined || body === null) {
|
|
65156
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdMessagesBulk';
|
|
65157
|
+
}
|
|
65158
|
+
|
|
65159
|
+
return this.apiClient.callApi(
|
|
65160
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/messages/bulk',
|
|
65161
|
+
'POST',
|
|
65162
|
+
{ 'topicId': topicId,'ruleId': ruleId },
|
|
65163
|
+
{ },
|
|
65164
|
+
{ },
|
|
65165
|
+
{ },
|
|
65166
|
+
body,
|
|
65167
|
+
['PureCloud OAuth'],
|
|
65168
|
+
['application/json'],
|
|
65169
|
+
['application/json']
|
|
65170
|
+
);
|
|
65171
|
+
}
|
|
65172
|
+
|
|
65173
|
+
/**
|
|
65174
|
+
* Ingest a list of Open Social Reactions
|
|
65175
|
+
* Ingest a list of open social reactions to an ingestion rule on a topic. This endpoint will ingest these reactions. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least social scope.
|
|
65176
|
+
* @param {String} topicId Topic ID
|
|
65177
|
+
* @param {String} ruleId Data Ingestion Rule ID
|
|
65178
|
+
* @param {Object} body NormalizedEvent
|
|
65179
|
+
*/
|
|
65180
|
+
postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk(topicId, ruleId, body) {
|
|
65181
|
+
// verify the required parameter 'topicId' is set
|
|
65182
|
+
if (topicId === undefined || topicId === null) {
|
|
65183
|
+
throw 'Missing the required parameter "topicId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
65184
|
+
}
|
|
65185
|
+
// verify the required parameter 'ruleId' is set
|
|
65186
|
+
if (ruleId === undefined || ruleId === null) {
|
|
65187
|
+
throw 'Missing the required parameter "ruleId" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
65188
|
+
}
|
|
65189
|
+
// verify the required parameter 'body' is set
|
|
65190
|
+
if (body === undefined || body === null) {
|
|
65191
|
+
throw 'Missing the required parameter "body" when calling postSocialmediaTopicDataingestionrulesOpenRuleIdReactionsBulk';
|
|
65192
|
+
}
|
|
65193
|
+
|
|
65194
|
+
return this.apiClient.callApi(
|
|
65195
|
+
'/api/v2/socialmedia/topics/{topicId}/dataingestionrules/open/{ruleId}/reactions/bulk',
|
|
65196
|
+
'POST',
|
|
65197
|
+
{ 'topicId': topicId,'ruleId': ruleId },
|
|
65198
|
+
{ },
|
|
65199
|
+
{ },
|
|
65200
|
+
{ },
|
|
65201
|
+
body,
|
|
65202
|
+
['PureCloud OAuth'],
|
|
65203
|
+
['application/json'],
|
|
65204
|
+
['application/json']
|
|
65205
|
+
);
|
|
65206
|
+
}
|
|
65207
|
+
|
|
64961
65208
|
/**
|
|
64962
65209
|
* Create an twitter data ingestion rule.
|
|
64963
65210
|
*
|
|
@@ -65106,7 +65353,6 @@ class SocialMediaApi {
|
|
|
65106
65353
|
* @param {String} openId openId
|
|
65107
65354
|
* @param {Object} opts Optional parameters
|
|
65108
65355
|
* @param {Object} opts.body
|
|
65109
|
-
* putSocialmediaTopicDataingestionrulesOpenOpenId is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
65110
65356
|
*/
|
|
65111
65357
|
putSocialmediaTopicDataingestionrulesOpenOpenId(topicId, openId, opts) {
|
|
65112
65358
|
opts = opts || {};
|
|
@@ -65174,7 +65420,7 @@ class SpeechTextAnalyticsApi {
|
|
|
65174
65420
|
/**
|
|
65175
65421
|
* SpeechTextAnalytics service.
|
|
65176
65422
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
65177
|
-
* @version
|
|
65423
|
+
* @version 223.0.0
|
|
65178
65424
|
*/
|
|
65179
65425
|
|
|
65180
65426
|
/**
|
|
@@ -66068,6 +66314,31 @@ class SpeechTextAnalyticsApi {
|
|
|
66068
66314
|
);
|
|
66069
66315
|
}
|
|
66070
66316
|
|
|
66317
|
+
/**
|
|
66318
|
+
* Get a Speech and Text Analytics test topics phrase job by id
|
|
66319
|
+
*
|
|
66320
|
+
* @param {String} jobId the id of the test topic phrase job
|
|
66321
|
+
*/
|
|
66322
|
+
getSpeechandtextanalyticsTopicsTestphraseJob(jobId) {
|
|
66323
|
+
// verify the required parameter 'jobId' is set
|
|
66324
|
+
if (jobId === undefined || jobId === null) {
|
|
66325
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsTopicsTestphraseJob';
|
|
66326
|
+
}
|
|
66327
|
+
|
|
66328
|
+
return this.apiClient.callApi(
|
|
66329
|
+
'/api/v2/speechandtextanalytics/topics/testphrase/jobs/{jobId}',
|
|
66330
|
+
'GET',
|
|
66331
|
+
{ 'jobId': jobId },
|
|
66332
|
+
{ },
|
|
66333
|
+
{ },
|
|
66334
|
+
{ },
|
|
66335
|
+
null,
|
|
66336
|
+
['PureCloud OAuth'],
|
|
66337
|
+
['application/json'],
|
|
66338
|
+
['application/json']
|
|
66339
|
+
);
|
|
66340
|
+
}
|
|
66341
|
+
|
|
66071
66342
|
/**
|
|
66072
66343
|
* Translate a single interaction recording (or an email conversation)
|
|
66073
66344
|
*
|
|
@@ -66348,6 +66619,31 @@ class SpeechTextAnalyticsApi {
|
|
|
66348
66619
|
);
|
|
66349
66620
|
}
|
|
66350
66621
|
|
|
66622
|
+
/**
|
|
66623
|
+
* Create new Speech and Text Analytics publish topics job
|
|
66624
|
+
*
|
|
66625
|
+
* @param {Object} body The publish test topic phrase job to create
|
|
66626
|
+
*/
|
|
66627
|
+
postSpeechandtextanalyticsTopicsTestphraseJobs(body) {
|
|
66628
|
+
// verify the required parameter 'body' is set
|
|
66629
|
+
if (body === undefined || body === null) {
|
|
66630
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsTopicsTestphraseJobs';
|
|
66631
|
+
}
|
|
66632
|
+
|
|
66633
|
+
return this.apiClient.callApi(
|
|
66634
|
+
'/api/v2/speechandtextanalytics/topics/testphrase/jobs',
|
|
66635
|
+
'POST',
|
|
66636
|
+
{ },
|
|
66637
|
+
{ },
|
|
66638
|
+
{ },
|
|
66639
|
+
{ },
|
|
66640
|
+
body,
|
|
66641
|
+
['PureCloud OAuth'],
|
|
66642
|
+
['application/json'],
|
|
66643
|
+
['application/json']
|
|
66644
|
+
);
|
|
66645
|
+
}
|
|
66646
|
+
|
|
66351
66647
|
/**
|
|
66352
66648
|
* Search resources.
|
|
66353
66649
|
*
|
|
@@ -66613,7 +66909,7 @@ class StationsApi {
|
|
|
66613
66909
|
/**
|
|
66614
66910
|
* Stations service.
|
|
66615
66911
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
66616
|
-
* @version
|
|
66912
|
+
* @version 223.0.0
|
|
66617
66913
|
*/
|
|
66618
66914
|
|
|
66619
66915
|
/**
|
|
@@ -66715,7 +67011,7 @@ class SuggestApi {
|
|
|
66715
67011
|
/**
|
|
66716
67012
|
* Suggest service.
|
|
66717
67013
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
66718
|
-
* @version
|
|
67014
|
+
* @version 223.0.0
|
|
66719
67015
|
*/
|
|
66720
67016
|
|
|
66721
67017
|
/**
|
|
@@ -66854,7 +67150,7 @@ class TaskManagementApi {
|
|
|
66854
67150
|
/**
|
|
66855
67151
|
* TaskManagement service.
|
|
66856
67152
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
66857
|
-
* @version
|
|
67153
|
+
* @version 223.0.0
|
|
66858
67154
|
*/
|
|
66859
67155
|
|
|
66860
67156
|
/**
|
|
@@ -69016,7 +69312,7 @@ class TeamsApi {
|
|
|
69016
69312
|
/**
|
|
69017
69313
|
* Teams service.
|
|
69018
69314
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
69019
|
-
* @version
|
|
69315
|
+
* @version 223.0.0
|
|
69020
69316
|
*/
|
|
69021
69317
|
|
|
69022
69318
|
/**
|
|
@@ -69321,7 +69617,7 @@ class TelephonyApi {
|
|
|
69321
69617
|
/**
|
|
69322
69618
|
* Telephony service.
|
|
69323
69619
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
69324
|
-
* @version
|
|
69620
|
+
* @version 223.0.0
|
|
69325
69621
|
*/
|
|
69326
69622
|
|
|
69327
69623
|
/**
|
|
@@ -69503,7 +69799,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
69503
69799
|
/**
|
|
69504
69800
|
* TelephonyProvidersEdge service.
|
|
69505
69801
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
69506
|
-
* @version
|
|
69802
|
+
* @version 223.0.0
|
|
69507
69803
|
*/
|
|
69508
69804
|
|
|
69509
69805
|
/**
|
|
@@ -72955,7 +73251,7 @@ class TextbotsApi {
|
|
|
72955
73251
|
/**
|
|
72956
73252
|
* Textbots service.
|
|
72957
73253
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
72958
|
-
* @version
|
|
73254
|
+
* @version 223.0.0
|
|
72959
73255
|
*/
|
|
72960
73256
|
|
|
72961
73257
|
/**
|
|
@@ -73084,7 +73380,7 @@ class TokensApi {
|
|
|
73084
73380
|
/**
|
|
73085
73381
|
* Tokens service.
|
|
73086
73382
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
73087
|
-
* @version
|
|
73383
|
+
* @version 223.0.0
|
|
73088
73384
|
*/
|
|
73089
73385
|
|
|
73090
73386
|
/**
|
|
@@ -73238,7 +73534,7 @@ class UploadsApi {
|
|
|
73238
73534
|
/**
|
|
73239
73535
|
* Uploads service.
|
|
73240
73536
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
73241
|
-
* @version
|
|
73537
|
+
* @version 223.0.0
|
|
73242
73538
|
*/
|
|
73243
73539
|
|
|
73244
73540
|
/**
|
|
@@ -73529,7 +73825,7 @@ class UsageApi {
|
|
|
73529
73825
|
/**
|
|
73530
73826
|
* Usage service.
|
|
73531
73827
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
73532
|
-
* @version
|
|
73828
|
+
* @version 223.0.0
|
|
73533
73829
|
*/
|
|
73534
73830
|
|
|
73535
73831
|
/**
|
|
@@ -73744,7 +74040,7 @@ class UserRecordingsApi {
|
|
|
73744
74040
|
/**
|
|
73745
74041
|
* UserRecordings service.
|
|
73746
74042
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
73747
|
-
* @version
|
|
74043
|
+
* @version 223.0.0
|
|
73748
74044
|
*/
|
|
73749
74045
|
|
|
73750
74046
|
/**
|
|
@@ -73959,7 +74255,7 @@ class UsersApi {
|
|
|
73959
74255
|
/**
|
|
73960
74256
|
* Users service.
|
|
73961
74257
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
73962
|
-
* @version
|
|
74258
|
+
* @version 223.0.0
|
|
73963
74259
|
*/
|
|
73964
74260
|
|
|
73965
74261
|
/**
|
|
@@ -76912,7 +77208,7 @@ class UtilitiesApi {
|
|
|
76912
77208
|
/**
|
|
76913
77209
|
* Utilities service.
|
|
76914
77210
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
76915
|
-
* @version
|
|
77211
|
+
* @version 223.0.0
|
|
76916
77212
|
*/
|
|
76917
77213
|
|
|
76918
77214
|
/**
|
|
@@ -77023,7 +77319,7 @@ class VoicemailApi {
|
|
|
77023
77319
|
/**
|
|
77024
77320
|
* Voicemail service.
|
|
77025
77321
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
77026
|
-
* @version
|
|
77322
|
+
* @version 223.0.0
|
|
77027
77323
|
*/
|
|
77028
77324
|
|
|
77029
77325
|
/**
|
|
@@ -77745,7 +78041,7 @@ class WebChatApi {
|
|
|
77745
78041
|
/**
|
|
77746
78042
|
* WebChat service.
|
|
77747
78043
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
77748
|
-
* @version
|
|
78044
|
+
* @version 223.0.0
|
|
77749
78045
|
*/
|
|
77750
78046
|
|
|
77751
78047
|
/**
|
|
@@ -78305,7 +78601,7 @@ class WebDeploymentsApi {
|
|
|
78305
78601
|
/**
|
|
78306
78602
|
* WebDeployments service.
|
|
78307
78603
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
78308
|
-
* @version
|
|
78604
|
+
* @version 223.0.0
|
|
78309
78605
|
*/
|
|
78310
78606
|
|
|
78311
78607
|
/**
|
|
@@ -78887,7 +79183,7 @@ class WebMessagingApi {
|
|
|
78887
79183
|
/**
|
|
78888
79184
|
* WebMessaging service.
|
|
78889
79185
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
78890
|
-
* @version
|
|
79186
|
+
* @version 223.0.0
|
|
78891
79187
|
*/
|
|
78892
79188
|
|
|
78893
79189
|
/**
|
|
@@ -78933,7 +79229,7 @@ class WidgetsApi {
|
|
|
78933
79229
|
/**
|
|
78934
79230
|
* Widgets service.
|
|
78935
79231
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
78936
|
-
* @version
|
|
79232
|
+
* @version 223.0.0
|
|
78937
79233
|
*/
|
|
78938
79234
|
|
|
78939
79235
|
/**
|
|
@@ -79084,7 +79380,7 @@ class WorkforceManagementApi {
|
|
|
79084
79380
|
/**
|
|
79085
79381
|
* WorkforceManagement service.
|
|
79086
79382
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
79087
|
-
* @version
|
|
79383
|
+
* @version 223.0.0
|
|
79088
79384
|
*/
|
|
79089
79385
|
|
|
79090
79386
|
/**
|
|
@@ -82806,16 +83102,17 @@ class WorkforceManagementApi {
|
|
|
82806
83102
|
* Update my alternative shifts trade by trade ID
|
|
82807
83103
|
*
|
|
82808
83104
|
* @param {String} tradeId The ID of the alternative shift trade
|
|
82809
|
-
* @param {Object}
|
|
82810
|
-
* @param {Object} opts.body body
|
|
83105
|
+
* @param {Object} body body
|
|
82811
83106
|
*/
|
|
82812
|
-
patchWorkforcemanagementAlternativeshiftsTrade(tradeId,
|
|
82813
|
-
opts = opts || {};
|
|
82814
|
-
|
|
83107
|
+
patchWorkforcemanagementAlternativeshiftsTrade(tradeId, body) {
|
|
82815
83108
|
// verify the required parameter 'tradeId' is set
|
|
82816
83109
|
if (tradeId === undefined || tradeId === null) {
|
|
82817
83110
|
throw 'Missing the required parameter "tradeId" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
82818
83111
|
}
|
|
83112
|
+
// verify the required parameter 'body' is set
|
|
83113
|
+
if (body === undefined || body === null) {
|
|
83114
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementAlternativeshiftsTrade';
|
|
83115
|
+
}
|
|
82819
83116
|
|
|
82820
83117
|
return this.apiClient.callApi(
|
|
82821
83118
|
'/api/v2/workforcemanagement/alternativeshifts/trades/{tradeId}',
|
|
@@ -82824,7 +83121,7 @@ class WorkforceManagementApi {
|
|
|
82824
83121
|
{ },
|
|
82825
83122
|
{ },
|
|
82826
83123
|
{ },
|
|
82827
|
-
|
|
83124
|
+
body,
|
|
82828
83125
|
['PureCloud OAuth'],
|
|
82829
83126
|
['application/json'],
|
|
82830
83127
|
['application/json']
|
|
@@ -82860,16 +83157,17 @@ class WorkforceManagementApi {
|
|
|
82860
83157
|
* Update business unit
|
|
82861
83158
|
*
|
|
82862
83159
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
82863
|
-
* @param {Object}
|
|
82864
|
-
* @param {Object} opts.body body
|
|
83160
|
+
* @param {Object} body body
|
|
82865
83161
|
*/
|
|
82866
|
-
patchWorkforcemanagementBusinessunit(businessUnitId,
|
|
82867
|
-
opts = opts || {};
|
|
82868
|
-
|
|
83162
|
+
patchWorkforcemanagementBusinessunit(businessUnitId, body) {
|
|
82869
83163
|
// verify the required parameter 'businessUnitId' is set
|
|
82870
83164
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82871
83165
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';
|
|
82872
83166
|
}
|
|
83167
|
+
// verify the required parameter 'body' is set
|
|
83168
|
+
if (body === undefined || body === null) {
|
|
83169
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunit';
|
|
83170
|
+
}
|
|
82873
83171
|
|
|
82874
83172
|
return this.apiClient.callApi(
|
|
82875
83173
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
@@ -82878,7 +83176,7 @@ class WorkforceManagementApi {
|
|
|
82878
83176
|
{ },
|
|
82879
83177
|
{ },
|
|
82880
83178
|
{ },
|
|
82881
|
-
|
|
83179
|
+
body,
|
|
82882
83180
|
['PureCloud OAuth'],
|
|
82883
83181
|
['application/json'],
|
|
82884
83182
|
['application/json']
|
|
@@ -82890,12 +83188,9 @@ class WorkforceManagementApi {
|
|
|
82890
83188
|
*
|
|
82891
83189
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
82892
83190
|
* @param {String} activityCodeId The ID of the activity code to update
|
|
82893
|
-
* @param {Object}
|
|
82894
|
-
* @param {Object} opts.body body
|
|
83191
|
+
* @param {Object} body body
|
|
82895
83192
|
*/
|
|
82896
|
-
patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId,
|
|
82897
|
-
opts = opts || {};
|
|
82898
|
-
|
|
83193
|
+
patchWorkforcemanagementBusinessunitActivitycode(businessUnitId, activityCodeId, body) {
|
|
82899
83194
|
// verify the required parameter 'businessUnitId' is set
|
|
82900
83195
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82901
83196
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
@@ -82904,6 +83199,10 @@ class WorkforceManagementApi {
|
|
|
82904
83199
|
if (activityCodeId === undefined || activityCodeId === null) {
|
|
82905
83200
|
throw 'Missing the required parameter "activityCodeId" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
82906
83201
|
}
|
|
83202
|
+
// verify the required parameter 'body' is set
|
|
83203
|
+
if (body === undefined || body === null) {
|
|
83204
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivitycode';
|
|
83205
|
+
}
|
|
82907
83206
|
|
|
82908
83207
|
return this.apiClient.callApi(
|
|
82909
83208
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes/{activityCodeId}',
|
|
@@ -82912,7 +83211,7 @@ class WorkforceManagementApi {
|
|
|
82912
83211
|
{ },
|
|
82913
83212
|
{ },
|
|
82914
83213
|
{ },
|
|
82915
|
-
|
|
83214
|
+
body,
|
|
82916
83215
|
['PureCloud OAuth'],
|
|
82917
83216
|
['application/json'],
|
|
82918
83217
|
['application/json']
|
|
@@ -82958,16 +83257,17 @@ class WorkforceManagementApi {
|
|
|
82958
83257
|
* Update alternative shifts settings for a business unit
|
|
82959
83258
|
*
|
|
82960
83259
|
* @param {String} businessUnitId The ID of the business unit
|
|
82961
|
-
* @param {Object}
|
|
82962
|
-
* @param {Object} opts.body body
|
|
83260
|
+
* @param {Object} body body
|
|
82963
83261
|
*/
|
|
82964
|
-
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId,
|
|
82965
|
-
opts = opts || {};
|
|
82966
|
-
|
|
83262
|
+
patchWorkforcemanagementBusinessunitAlternativeshiftsSettings(businessUnitId, body) {
|
|
82967
83263
|
// verify the required parameter 'businessUnitId' is set
|
|
82968
83264
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82969
83265
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
82970
83266
|
}
|
|
83267
|
+
// verify the required parameter 'body' is set
|
|
83268
|
+
if (body === undefined || body === null) {
|
|
83269
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitAlternativeshiftsSettings';
|
|
83270
|
+
}
|
|
82971
83271
|
|
|
82972
83272
|
return this.apiClient.callApi(
|
|
82973
83273
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/alternativeshifts/settings',
|
|
@@ -82976,7 +83276,7 @@ class WorkforceManagementApi {
|
|
|
82976
83276
|
{ },
|
|
82977
83277
|
{ },
|
|
82978
83278
|
{ },
|
|
82979
|
-
|
|
83279
|
+
body,
|
|
82980
83280
|
['PureCloud OAuth'],
|
|
82981
83281
|
['application/json'],
|
|
82982
83282
|
['application/json']
|
|
@@ -82988,12 +83288,9 @@ class WorkforceManagementApi {
|
|
|
82988
83288
|
*
|
|
82989
83289
|
* @param {String} businessUnitId The ID of the business unit.
|
|
82990
83290
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
82991
|
-
* @param {Object}
|
|
82992
|
-
* @param {Object} opts.body body
|
|
83291
|
+
* @param {Object} body body
|
|
82993
83292
|
*/
|
|
82994
|
-
patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId,
|
|
82995
|
-
opts = opts || {};
|
|
82996
|
-
|
|
83293
|
+
patchWorkforcemanagementBusinessunitPlanninggroup(businessUnitId, planningGroupId, body) {
|
|
82997
83294
|
// verify the required parameter 'businessUnitId' is set
|
|
82998
83295
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
82999
83296
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
@@ -83002,6 +83299,10 @@ class WorkforceManagementApi {
|
|
|
83002
83299
|
if (planningGroupId === undefined || planningGroupId === null) {
|
|
83003
83300
|
throw 'Missing the required parameter "planningGroupId" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
83004
83301
|
}
|
|
83302
|
+
// verify the required parameter 'body' is set
|
|
83303
|
+
if (body === undefined || body === null) {
|
|
83304
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitPlanninggroup';
|
|
83305
|
+
}
|
|
83005
83306
|
|
|
83006
83307
|
return this.apiClient.callApi(
|
|
83007
83308
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups/{planningGroupId}',
|
|
@@ -83010,7 +83311,7 @@ class WorkforceManagementApi {
|
|
|
83010
83311
|
{ },
|
|
83011
83312
|
{ },
|
|
83012
83313
|
{ },
|
|
83013
|
-
|
|
83314
|
+
body,
|
|
83014
83315
|
['PureCloud OAuth'],
|
|
83015
83316
|
['application/json'],
|
|
83016
83317
|
['application/json']
|
|
@@ -83022,12 +83323,9 @@ class WorkforceManagementApi {
|
|
|
83022
83323
|
*
|
|
83023
83324
|
* @param {String} businessUnitId The ID of the business unit
|
|
83024
83325
|
* @param {String} runId The ID of the schedule run
|
|
83025
|
-
* @param {Object}
|
|
83026
|
-
* @param {Object} opts.body body
|
|
83326
|
+
* @param {Object} body body
|
|
83027
83327
|
*/
|
|
83028
|
-
patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId,
|
|
83029
|
-
opts = opts || {};
|
|
83030
|
-
|
|
83328
|
+
patchWorkforcemanagementBusinessunitSchedulingRun(businessUnitId, runId, body) {
|
|
83031
83329
|
// verify the required parameter 'businessUnitId' is set
|
|
83032
83330
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83033
83331
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
@@ -83036,6 +83334,10 @@ class WorkforceManagementApi {
|
|
|
83036
83334
|
if (runId === undefined || runId === null) {
|
|
83037
83335
|
throw 'Missing the required parameter "runId" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
83038
83336
|
}
|
|
83337
|
+
// verify the required parameter 'body' is set
|
|
83338
|
+
if (body === undefined || body === null) {
|
|
83339
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitSchedulingRun';
|
|
83340
|
+
}
|
|
83039
83341
|
|
|
83040
83342
|
return this.apiClient.callApi(
|
|
83041
83343
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/scheduling/runs/{runId}',
|
|
@@ -83044,7 +83346,7 @@ class WorkforceManagementApi {
|
|
|
83044
83346
|
{ },
|
|
83045
83347
|
{ },
|
|
83046
83348
|
{ },
|
|
83047
|
-
|
|
83349
|
+
body,
|
|
83048
83350
|
['PureCloud OAuth'],
|
|
83049
83351
|
['application/json'],
|
|
83050
83352
|
['application/json']
|
|
@@ -83056,12 +83358,9 @@ class WorkforceManagementApi {
|
|
|
83056
83358
|
*
|
|
83057
83359
|
* @param {String} businessUnitId The ID of the business unit.
|
|
83058
83360
|
* @param {String} serviceGoalTemplateId The ID of a service goal template to update
|
|
83059
|
-
* @param {Object}
|
|
83060
|
-
* @param {Object} opts.body body
|
|
83361
|
+
* @param {Object} body body
|
|
83061
83362
|
*/
|
|
83062
|
-
patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId,
|
|
83063
|
-
opts = opts || {};
|
|
83064
|
-
|
|
83363
|
+
patchWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, body) {
|
|
83065
83364
|
// verify the required parameter 'businessUnitId' is set
|
|
83066
83365
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83067
83366
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
@@ -83070,6 +83369,10 @@ class WorkforceManagementApi {
|
|
|
83070
83369
|
if (serviceGoalTemplateId === undefined || serviceGoalTemplateId === null) {
|
|
83071
83370
|
throw 'Missing the required parameter "serviceGoalTemplateId" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
83072
83371
|
}
|
|
83372
|
+
// verify the required parameter 'body' is set
|
|
83373
|
+
if (body === undefined || body === null) {
|
|
83374
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitServicegoaltemplate';
|
|
83375
|
+
}
|
|
83073
83376
|
|
|
83074
83377
|
return this.apiClient.callApi(
|
|
83075
83378
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
|
|
@@ -83078,7 +83381,7 @@ class WorkforceManagementApi {
|
|
|
83078
83381
|
{ },
|
|
83079
83382
|
{ },
|
|
83080
83383
|
{ },
|
|
83081
|
-
|
|
83384
|
+
body,
|
|
83082
83385
|
['PureCloud OAuth'],
|
|
83083
83386
|
['application/json'],
|
|
83084
83387
|
['application/json']
|
|
@@ -83090,12 +83393,9 @@ class WorkforceManagementApi {
|
|
|
83090
83393
|
*
|
|
83091
83394
|
* @param {String} businessUnitId The ID of the business unit
|
|
83092
83395
|
* @param {String} staffingGroupId The ID of the staffing group to update
|
|
83093
|
-
* @param {Object}
|
|
83094
|
-
* @param {Object} opts.body body
|
|
83396
|
+
* @param {Object} body body
|
|
83095
83397
|
*/
|
|
83096
|
-
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId,
|
|
83097
|
-
opts = opts || {};
|
|
83098
|
-
|
|
83398
|
+
patchWorkforcemanagementBusinessunitStaffinggroup(businessUnitId, staffingGroupId, body) {
|
|
83099
83399
|
// verify the required parameter 'businessUnitId' is set
|
|
83100
83400
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83101
83401
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
@@ -83104,6 +83404,10 @@ class WorkforceManagementApi {
|
|
|
83104
83404
|
if (staffingGroupId === undefined || staffingGroupId === null) {
|
|
83105
83405
|
throw 'Missing the required parameter "staffingGroupId" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
83106
83406
|
}
|
|
83407
|
+
// verify the required parameter 'body' is set
|
|
83408
|
+
if (body === undefined || body === null) {
|
|
83409
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitStaffinggroup';
|
|
83410
|
+
}
|
|
83107
83411
|
|
|
83108
83412
|
return this.apiClient.callApi(
|
|
83109
83413
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/{staffingGroupId}',
|
|
@@ -83112,7 +83416,7 @@ class WorkforceManagementApi {
|
|
|
83112
83416
|
{ },
|
|
83113
83417
|
{ },
|
|
83114
83418
|
{ },
|
|
83115
|
-
|
|
83419
|
+
body,
|
|
83116
83420
|
['PureCloud OAuth'],
|
|
83117
83421
|
['application/json'],
|
|
83118
83422
|
['application/json']
|
|
@@ -83124,12 +83428,9 @@ class WorkforceManagementApi {
|
|
|
83124
83428
|
*
|
|
83125
83429
|
* @param {String} businessUnitId The ID of the business unit
|
|
83126
83430
|
* @param {String} timeOffPlanId The ID of the time-off plan to update
|
|
83127
|
-
* @param {Object}
|
|
83128
|
-
* @param {Object} opts.body body
|
|
83431
|
+
* @param {Object} body body
|
|
83129
83432
|
*/
|
|
83130
|
-
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId,
|
|
83131
|
-
opts = opts || {};
|
|
83132
|
-
|
|
83433
|
+
patchWorkforcemanagementBusinessunitTimeoffplan(businessUnitId, timeOffPlanId, body) {
|
|
83133
83434
|
// verify the required parameter 'businessUnitId' is set
|
|
83134
83435
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83135
83436
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
@@ -83138,6 +83439,10 @@ class WorkforceManagementApi {
|
|
|
83138
83439
|
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
83139
83440
|
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
83140
83441
|
}
|
|
83442
|
+
// verify the required parameter 'body' is set
|
|
83443
|
+
if (body === undefined || body === null) {
|
|
83444
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitTimeoffplan';
|
|
83445
|
+
}
|
|
83141
83446
|
|
|
83142
83447
|
return this.apiClient.callApi(
|
|
83143
83448
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans/{timeOffPlanId}',
|
|
@@ -83146,7 +83451,7 @@ class WorkforceManagementApi {
|
|
|
83146
83451
|
{ },
|
|
83147
83452
|
{ },
|
|
83148
83453
|
{ },
|
|
83149
|
-
|
|
83454
|
+
body,
|
|
83150
83455
|
['PureCloud OAuth'],
|
|
83151
83456
|
['application/json'],
|
|
83152
83457
|
['application/json']
|
|
@@ -83194,12 +83499,9 @@ class WorkforceManagementApi {
|
|
|
83194
83499
|
* @param {String} businessUnitId The ID of the business unit
|
|
83195
83500
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
83196
83501
|
* @param {String} bidGroupId Work Plan Bid Group id
|
|
83197
|
-
* @param {Object}
|
|
83198
|
-
* @param {Object} opts.body body
|
|
83502
|
+
* @param {Object} body body
|
|
83199
83503
|
*/
|
|
83200
|
-
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId,
|
|
83201
|
-
opts = opts || {};
|
|
83202
|
-
|
|
83504
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroup(businessUnitId, bidId, bidGroupId, body) {
|
|
83203
83505
|
// verify the required parameter 'businessUnitId' is set
|
|
83204
83506
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83205
83507
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
@@ -83212,6 +83514,10 @@ class WorkforceManagementApi {
|
|
|
83212
83514
|
if (bidGroupId === undefined || bidGroupId === null) {
|
|
83213
83515
|
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
83214
83516
|
}
|
|
83517
|
+
// verify the required parameter 'body' is set
|
|
83518
|
+
if (body === undefined || body === null) {
|
|
83519
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroup';
|
|
83520
|
+
}
|
|
83215
83521
|
|
|
83216
83522
|
return this.apiClient.callApi(
|
|
83217
83523
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}',
|
|
@@ -83220,7 +83526,7 @@ class WorkforceManagementApi {
|
|
|
83220
83526
|
{ },
|
|
83221
83527
|
{ },
|
|
83222
83528
|
{ },
|
|
83223
|
-
|
|
83529
|
+
body,
|
|
83224
83530
|
['PureCloud OAuth'],
|
|
83225
83531
|
['application/json'],
|
|
83226
83532
|
['application/json']
|
|
@@ -83233,12 +83539,9 @@ class WorkforceManagementApi {
|
|
|
83233
83539
|
* @param {String} businessUnitId The ID of the business unit
|
|
83234
83540
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
83235
83541
|
* @param {String} bidGroupId The ID of the work plan bid group
|
|
83236
|
-
* @param {Object}
|
|
83237
|
-
* @param {Object} opts.body body
|
|
83542
|
+
* @param {Object} body body
|
|
83238
83543
|
*/
|
|
83239
|
-
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId,
|
|
83240
|
-
opts = opts || {};
|
|
83241
|
-
|
|
83544
|
+
patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences(businessUnitId, bidId, bidGroupId, body) {
|
|
83242
83545
|
// verify the required parameter 'businessUnitId' is set
|
|
83243
83546
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
83244
83547
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
@@ -83251,6 +83554,10 @@ class WorkforceManagementApi {
|
|
|
83251
83554
|
if (bidGroupId === undefined || bidGroupId === null) {
|
|
83252
83555
|
throw 'Missing the required parameter "bidGroupId" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
83253
83556
|
}
|
|
83557
|
+
// verify the required parameter 'body' is set
|
|
83558
|
+
if (body === undefined || body === null) {
|
|
83559
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitWorkplanbidGroupPreferences';
|
|
83560
|
+
}
|
|
83254
83561
|
|
|
83255
83562
|
return this.apiClient.callApi(
|
|
83256
83563
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups/{bidGroupId}/preferences',
|
|
@@ -83259,7 +83566,7 @@ class WorkforceManagementApi {
|
|
|
83259
83566
|
{ },
|
|
83260
83567
|
{ },
|
|
83261
83568
|
{ },
|
|
83262
|
-
|
|
83569
|
+
body,
|
|
83263
83570
|
['PureCloud OAuth'],
|
|
83264
83571
|
['application/json'],
|
|
83265
83572
|
['application/json']
|
|
@@ -83270,16 +83577,17 @@ class WorkforceManagementApi {
|
|
|
83270
83577
|
* Update the requested management unit
|
|
83271
83578
|
*
|
|
83272
83579
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83273
|
-
* @param {Object}
|
|
83274
|
-
* @param {Object} opts.body body
|
|
83580
|
+
* @param {Object} body body
|
|
83275
83581
|
*/
|
|
83276
|
-
patchWorkforcemanagementManagementunit(managementUnitId,
|
|
83277
|
-
opts = opts || {};
|
|
83278
|
-
|
|
83582
|
+
patchWorkforcemanagementManagementunit(managementUnitId, body) {
|
|
83279
83583
|
// verify the required parameter 'managementUnitId' is set
|
|
83280
83584
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83281
83585
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunit';
|
|
83282
83586
|
}
|
|
83587
|
+
// verify the required parameter 'body' is set
|
|
83588
|
+
if (body === undefined || body === null) {
|
|
83589
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunit';
|
|
83590
|
+
}
|
|
83283
83591
|
|
|
83284
83592
|
return this.apiClient.callApi(
|
|
83285
83593
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}',
|
|
@@ -83288,7 +83596,7 @@ class WorkforceManagementApi {
|
|
|
83288
83596
|
{ },
|
|
83289
83597
|
{ },
|
|
83290
83598
|
{ },
|
|
83291
|
-
|
|
83599
|
+
body,
|
|
83292
83600
|
['PureCloud OAuth'],
|
|
83293
83601
|
['application/json'],
|
|
83294
83602
|
['application/json']
|
|
@@ -83299,16 +83607,17 @@ class WorkforceManagementApi {
|
|
|
83299
83607
|
* Update agent configurations
|
|
83300
83608
|
*
|
|
83301
83609
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83302
|
-
* @param {Object}
|
|
83303
|
-
* @param {Object} opts.body body
|
|
83610
|
+
* @param {Object} body body
|
|
83304
83611
|
*/
|
|
83305
|
-
patchWorkforcemanagementManagementunitAgents(managementUnitId,
|
|
83306
|
-
opts = opts || {};
|
|
83307
|
-
|
|
83612
|
+
patchWorkforcemanagementManagementunitAgents(managementUnitId, body) {
|
|
83308
83613
|
// verify the required parameter 'managementUnitId' is set
|
|
83309
83614
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83310
83615
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgents';
|
|
83311
83616
|
}
|
|
83617
|
+
// verify the required parameter 'body' is set
|
|
83618
|
+
if (body === undefined || body === null) {
|
|
83619
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitAgents';
|
|
83620
|
+
}
|
|
83312
83621
|
|
|
83313
83622
|
return this.apiClient.callApi(
|
|
83314
83623
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents',
|
|
@@ -83317,7 +83626,7 @@ class WorkforceManagementApi {
|
|
|
83317
83626
|
{ },
|
|
83318
83627
|
{ },
|
|
83319
83628
|
{ },
|
|
83320
|
-
|
|
83629
|
+
body,
|
|
83321
83630
|
['PureCloud OAuth'],
|
|
83322
83631
|
['application/json'],
|
|
83323
83632
|
['application/json']
|
|
@@ -83328,16 +83637,17 @@ class WorkforceManagementApi {
|
|
|
83328
83637
|
* Updates agent work plan configuration
|
|
83329
83638
|
*
|
|
83330
83639
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83331
|
-
* @param {Object}
|
|
83332
|
-
* @param {Object} opts.body body
|
|
83640
|
+
* @param {Object} body body
|
|
83333
83641
|
*/
|
|
83334
|
-
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId,
|
|
83335
|
-
opts = opts || {};
|
|
83336
|
-
|
|
83642
|
+
patchWorkforcemanagementManagementunitAgentsWorkplansBulk(managementUnitId, body) {
|
|
83337
83643
|
// verify the required parameter 'managementUnitId' is set
|
|
83338
83644
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83339
83645
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
83340
83646
|
}
|
|
83647
|
+
// verify the required parameter 'body' is set
|
|
83648
|
+
if (body === undefined || body === null) {
|
|
83649
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitAgentsWorkplansBulk';
|
|
83650
|
+
}
|
|
83341
83651
|
|
|
83342
83652
|
return this.apiClient.callApi(
|
|
83343
83653
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/bulk',
|
|
@@ -83346,7 +83656,7 @@ class WorkforceManagementApi {
|
|
|
83346
83656
|
{ },
|
|
83347
83657
|
{ },
|
|
83348
83658
|
{ },
|
|
83349
|
-
|
|
83659
|
+
body,
|
|
83350
83660
|
['PureCloud OAuth'],
|
|
83351
83661
|
['application/json'],
|
|
83352
83662
|
['application/json']
|
|
@@ -83358,12 +83668,9 @@ class WorkforceManagementApi {
|
|
|
83358
83668
|
* Updates time off limit object properties, but not daily values.
|
|
83359
83669
|
* @param {String} managementUnitId The ID of the management unit.
|
|
83360
83670
|
* @param {String} timeOffLimitId The id of time off limit object to update
|
|
83361
|
-
* @param {Object}
|
|
83362
|
-
* @param {Object} opts.body body
|
|
83671
|
+
* @param {Object} body body
|
|
83363
83672
|
*/
|
|
83364
|
-
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId,
|
|
83365
|
-
opts = opts || {};
|
|
83366
|
-
|
|
83673
|
+
patchWorkforcemanagementManagementunitTimeofflimit(managementUnitId, timeOffLimitId, body) {
|
|
83367
83674
|
// verify the required parameter 'managementUnitId' is set
|
|
83368
83675
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83369
83676
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
@@ -83372,6 +83679,10 @@ class WorkforceManagementApi {
|
|
|
83372
83679
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
83373
83680
|
throw 'Missing the required parameter "timeOffLimitId" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
83374
83681
|
}
|
|
83682
|
+
// verify the required parameter 'body' is set
|
|
83683
|
+
if (body === undefined || body === null) {
|
|
83684
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeofflimit';
|
|
83685
|
+
}
|
|
83375
83686
|
|
|
83376
83687
|
return this.apiClient.callApi(
|
|
83377
83688
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}',
|
|
@@ -83380,7 +83691,7 @@ class WorkforceManagementApi {
|
|
|
83380
83691
|
{ },
|
|
83381
83692
|
{ },
|
|
83382
83693
|
{ },
|
|
83383
|
-
|
|
83694
|
+
body,
|
|
83384
83695
|
['PureCloud OAuth'],
|
|
83385
83696
|
['application/json'],
|
|
83386
83697
|
['application/json']
|
|
@@ -83392,12 +83703,9 @@ class WorkforceManagementApi {
|
|
|
83392
83703
|
*
|
|
83393
83704
|
* @param {String} managementUnitId The ID of the management unit
|
|
83394
83705
|
* @param {String} timeOffPlanId The ID of the time off plan to update
|
|
83395
|
-
* @param {Object}
|
|
83396
|
-
* @param {Object} opts.body body
|
|
83706
|
+
* @param {Object} body body
|
|
83397
83707
|
*/
|
|
83398
|
-
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId,
|
|
83399
|
-
opts = opts || {};
|
|
83400
|
-
|
|
83708
|
+
patchWorkforcemanagementManagementunitTimeoffplan(managementUnitId, timeOffPlanId, body) {
|
|
83401
83709
|
// verify the required parameter 'managementUnitId' is set
|
|
83402
83710
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83403
83711
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
@@ -83406,6 +83714,10 @@ class WorkforceManagementApi {
|
|
|
83406
83714
|
if (timeOffPlanId === undefined || timeOffPlanId === null) {
|
|
83407
83715
|
throw 'Missing the required parameter "timeOffPlanId" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
83408
83716
|
}
|
|
83717
|
+
// verify the required parameter 'body' is set
|
|
83718
|
+
if (body === undefined || body === null) {
|
|
83719
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeoffplan';
|
|
83720
|
+
}
|
|
83409
83721
|
|
|
83410
83722
|
return this.apiClient.callApi(
|
|
83411
83723
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans/{timeOffPlanId}',
|
|
@@ -83414,7 +83726,7 @@ class WorkforceManagementApi {
|
|
|
83414
83726
|
{ },
|
|
83415
83727
|
{ },
|
|
83416
83728
|
{ },
|
|
83417
|
-
|
|
83729
|
+
body,
|
|
83418
83730
|
['PureCloud OAuth'],
|
|
83419
83731
|
['application/json'],
|
|
83420
83732
|
['application/json']
|
|
@@ -83427,12 +83739,9 @@ class WorkforceManagementApi {
|
|
|
83427
83739
|
* @param {String} managementUnitId The ID of the management unit.
|
|
83428
83740
|
* @param {String} timeOffRequestId The ID of the time off request.
|
|
83429
83741
|
* @param {String} userId The ID of user to whom the time off request belongs.
|
|
83430
|
-
* @param {Object}
|
|
83431
|
-
* @param {Object} opts.body body
|
|
83742
|
+
* @param {Object} body body
|
|
83432
83743
|
*/
|
|
83433
|
-
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId,
|
|
83434
|
-
opts = opts || {};
|
|
83435
|
-
|
|
83744
|
+
patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, body) {
|
|
83436
83745
|
// verify the required parameter 'managementUnitId' is set
|
|
83437
83746
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83438
83747
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
@@ -83445,6 +83754,10 @@ class WorkforceManagementApi {
|
|
|
83445
83754
|
if (userId === undefined || userId === null) {
|
|
83446
83755
|
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
83447
83756
|
}
|
|
83757
|
+
// verify the required parameter 'body' is set
|
|
83758
|
+
if (body === undefined || body === null) {
|
|
83759
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
|
|
83760
|
+
}
|
|
83448
83761
|
|
|
83449
83762
|
return this.apiClient.callApi(
|
|
83450
83763
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
|
|
@@ -83453,7 +83766,7 @@ class WorkforceManagementApi {
|
|
|
83453
83766
|
{ },
|
|
83454
83767
|
{ },
|
|
83455
83768
|
{ },
|
|
83456
|
-
|
|
83769
|
+
body,
|
|
83457
83770
|
['PureCloud OAuth'],
|
|
83458
83771
|
['application/json'],
|
|
83459
83772
|
['application/json']
|
|
@@ -83466,12 +83779,9 @@ class WorkforceManagementApi {
|
|
|
83466
83779
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83467
83780
|
* @param {String} userId The id of the user the requested time off request belongs to
|
|
83468
83781
|
* @param {String} timeOffRequestId The id of the time off request to update
|
|
83469
|
-
* @param {Object}
|
|
83470
|
-
* @param {Object} opts.body body
|
|
83782
|
+
* @param {Object} body body
|
|
83471
83783
|
*/
|
|
83472
|
-
patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId,
|
|
83473
|
-
opts = opts || {};
|
|
83474
|
-
|
|
83784
|
+
patchWorkforcemanagementManagementunitUserTimeoffrequest(managementUnitId, userId, timeOffRequestId, body) {
|
|
83475
83785
|
// verify the required parameter 'managementUnitId' is set
|
|
83476
83786
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83477
83787
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
@@ -83484,6 +83794,10 @@ class WorkforceManagementApi {
|
|
|
83484
83794
|
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
83485
83795
|
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
83486
83796
|
}
|
|
83797
|
+
// verify the required parameter 'body' is set
|
|
83798
|
+
if (body === undefined || body === null) {
|
|
83799
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitUserTimeoffrequest';
|
|
83800
|
+
}
|
|
83487
83801
|
|
|
83488
83802
|
return this.apiClient.callApi(
|
|
83489
83803
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/{timeOffRequestId}',
|
|
@@ -83492,7 +83806,7 @@ class WorkforceManagementApi {
|
|
|
83492
83806
|
{ },
|
|
83493
83807
|
{ },
|
|
83494
83808
|
{ },
|
|
83495
|
-
|
|
83809
|
+
body,
|
|
83496
83810
|
['PureCloud OAuth'],
|
|
83497
83811
|
['application/json'],
|
|
83498
83812
|
['application/json']
|
|
@@ -83544,11 +83858,11 @@ class WorkforceManagementApi {
|
|
|
83544
83858
|
*
|
|
83545
83859
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83546
83860
|
* @param {String} workPlanId The ID of the work plan to update
|
|
83861
|
+
* @param {Object} body body
|
|
83547
83862
|
* @param {Object} opts Optional parameters
|
|
83548
83863
|
* @param {Object} opts.validationMode Allows to update work plan even if validation result is invalid
|
|
83549
|
-
* @param {Object} opts.body body
|
|
83550
83864
|
*/
|
|
83551
|
-
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, opts) {
|
|
83865
|
+
patchWorkforcemanagementManagementunitWorkplan(managementUnitId, workPlanId, body, opts) {
|
|
83552
83866
|
opts = opts || {};
|
|
83553
83867
|
|
|
83554
83868
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -83559,6 +83873,10 @@ class WorkforceManagementApi {
|
|
|
83559
83873
|
if (workPlanId === undefined || workPlanId === null) {
|
|
83560
83874
|
throw 'Missing the required parameter "workPlanId" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
83561
83875
|
}
|
|
83876
|
+
// verify the required parameter 'body' is set
|
|
83877
|
+
if (body === undefined || body === null) {
|
|
83878
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWorkplan';
|
|
83879
|
+
}
|
|
83562
83880
|
|
|
83563
83881
|
return this.apiClient.callApi(
|
|
83564
83882
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}',
|
|
@@ -83567,7 +83885,7 @@ class WorkforceManagementApi {
|
|
|
83567
83885
|
{ 'validationMode': opts['validationMode'] },
|
|
83568
83886
|
{ },
|
|
83569
83887
|
{ },
|
|
83570
|
-
|
|
83888
|
+
body,
|
|
83571
83889
|
['PureCloud OAuth'],
|
|
83572
83890
|
['application/json'],
|
|
83573
83891
|
['application/json']
|
|
@@ -83579,12 +83897,9 @@ class WorkforceManagementApi {
|
|
|
83579
83897
|
*
|
|
83580
83898
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
83581
83899
|
* @param {String} workPlanRotationId The ID of the work plan rotation to update
|
|
83582
|
-
* @param {Object}
|
|
83583
|
-
* @param {Object} opts.body body
|
|
83900
|
+
* @param {Object} body body
|
|
83584
83901
|
*/
|
|
83585
|
-
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId,
|
|
83586
|
-
opts = opts || {};
|
|
83587
|
-
|
|
83902
|
+
patchWorkforcemanagementManagementunitWorkplanrotation(managementUnitId, workPlanRotationId, body) {
|
|
83588
83903
|
// verify the required parameter 'managementUnitId' is set
|
|
83589
83904
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
83590
83905
|
throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
@@ -83593,6 +83908,10 @@ class WorkforceManagementApi {
|
|
|
83593
83908
|
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
83594
83909
|
throw 'Missing the required parameter "workPlanRotationId" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
83595
83910
|
}
|
|
83911
|
+
// verify the required parameter 'body' is set
|
|
83912
|
+
if (body === undefined || body === null) {
|
|
83913
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementManagementunitWorkplanrotation';
|
|
83914
|
+
}
|
|
83596
83915
|
|
|
83597
83916
|
return this.apiClient.callApi(
|
|
83598
83917
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}',
|
|
@@ -83601,7 +83920,7 @@ class WorkforceManagementApi {
|
|
|
83601
83920
|
{ },
|
|
83602
83921
|
{ },
|
|
83603
83922
|
{ },
|
|
83604
|
-
|
|
83923
|
+
body,
|
|
83605
83924
|
['PureCloud OAuth'],
|
|
83606
83925
|
['application/json'],
|
|
83607
83926
|
['application/json']
|
|
@@ -83612,16 +83931,17 @@ class WorkforceManagementApi {
|
|
|
83612
83931
|
* Update a time off request for the current user
|
|
83613
83932
|
*
|
|
83614
83933
|
* @param {String} timeOffRequestId The ID of the time off request
|
|
83615
|
-
* @param {Object}
|
|
83616
|
-
* @param {Object} opts.body body
|
|
83934
|
+
* @param {Object} body body
|
|
83617
83935
|
*/
|
|
83618
|
-
patchWorkforcemanagementTimeoffrequest(timeOffRequestId,
|
|
83619
|
-
opts = opts || {};
|
|
83620
|
-
|
|
83936
|
+
patchWorkforcemanagementTimeoffrequest(timeOffRequestId, body) {
|
|
83621
83937
|
// verify the required parameter 'timeOffRequestId' is set
|
|
83622
83938
|
if (timeOffRequestId === undefined || timeOffRequestId === null) {
|
|
83623
83939
|
throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementTimeoffrequest';
|
|
83624
83940
|
}
|
|
83941
|
+
// verify the required parameter 'body' is set
|
|
83942
|
+
if (body === undefined || body === null) {
|
|
83943
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementTimeoffrequest';
|
|
83944
|
+
}
|
|
83625
83945
|
|
|
83626
83946
|
return this.apiClient.callApi(
|
|
83627
83947
|
'/api/v2/workforcemanagement/timeoffrequests/{timeOffRequestId}',
|
|
@@ -83630,7 +83950,7 @@ class WorkforceManagementApi {
|
|
|
83630
83950
|
{ },
|
|
83631
83951
|
{ },
|
|
83632
83952
|
{ },
|
|
83633
|
-
|
|
83953
|
+
body,
|
|
83634
83954
|
['PureCloud OAuth'],
|
|
83635
83955
|
['application/json'],
|
|
83636
83956
|
['application/json']
|
|
@@ -83641,16 +83961,17 @@ class WorkforceManagementApi {
|
|
|
83641
83961
|
* Update work plan bid ranks for a user
|
|
83642
83962
|
*
|
|
83643
83963
|
* @param {String} userId The userId to whom the work plan bid ranks apply.
|
|
83644
|
-
* @param {Object}
|
|
83645
|
-
* @param {Object} opts.body body
|
|
83964
|
+
* @param {Object} body body
|
|
83646
83965
|
*/
|
|
83647
|
-
patchWorkforcemanagementUserWorkplanbidranks(userId,
|
|
83648
|
-
opts = opts || {};
|
|
83649
|
-
|
|
83966
|
+
patchWorkforcemanagementUserWorkplanbidranks(userId, body) {
|
|
83650
83967
|
// verify the required parameter 'userId' is set
|
|
83651
83968
|
if (userId === undefined || userId === null) {
|
|
83652
83969
|
throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
83653
83970
|
}
|
|
83971
|
+
// verify the required parameter 'body' is set
|
|
83972
|
+
if (body === undefined || body === null) {
|
|
83973
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementUserWorkplanbidranks';
|
|
83974
|
+
}
|
|
83654
83975
|
|
|
83655
83976
|
return this.apiClient.callApi(
|
|
83656
83977
|
'/api/v2/workforcemanagement/users/{userId}/workplanbidranks',
|
|
@@ -83659,7 +83980,7 @@ class WorkforceManagementApi {
|
|
|
83659
83980
|
{ },
|
|
83660
83981
|
{ },
|
|
83661
83982
|
{ },
|
|
83662
|
-
|
|
83983
|
+
body,
|
|
83663
83984
|
['PureCloud OAuth'],
|
|
83664
83985
|
['application/json'],
|
|
83665
83986
|
['application/json']
|
|
@@ -83695,16 +84016,17 @@ class WorkforceManagementApi {
|
|
|
83695
84016
|
* Update an agent's work plan bidding preference
|
|
83696
84017
|
*
|
|
83697
84018
|
* @param {String} bidId The ID of the work plan bid
|
|
83698
|
-
* @param {Object}
|
|
83699
|
-
* @param {Object} opts.body body
|
|
84019
|
+
* @param {Object} body body
|
|
83700
84020
|
*/
|
|
83701
|
-
patchWorkforcemanagementWorkplanbidPreferences(bidId,
|
|
83702
|
-
opts = opts || {};
|
|
83703
|
-
|
|
84021
|
+
patchWorkforcemanagementWorkplanbidPreferences(bidId, body) {
|
|
83704
84022
|
// verify the required parameter 'bidId' is set
|
|
83705
84023
|
if (bidId === undefined || bidId === null) {
|
|
83706
84024
|
throw 'Missing the required parameter "bidId" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
83707
84025
|
}
|
|
84026
|
+
// verify the required parameter 'body' is set
|
|
84027
|
+
if (body === undefined || body === null) {
|
|
84028
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementWorkplanbidPreferences';
|
|
84029
|
+
}
|
|
83708
84030
|
|
|
83709
84031
|
return this.apiClient.callApi(
|
|
83710
84032
|
'/api/v2/workforcemanagement/workplanbids/{bidId}/preferences',
|
|
@@ -83713,7 +84035,7 @@ class WorkforceManagementApi {
|
|
|
83713
84035
|
{ },
|
|
83714
84036
|
{ },
|
|
83715
84037
|
{ },
|
|
83716
|
-
|
|
84038
|
+
body,
|
|
83717
84039
|
['PureCloud OAuth'],
|
|
83718
84040
|
['application/json'],
|
|
83719
84041
|
['application/json']
|
|
@@ -83803,12 +84125,13 @@ class WorkforceManagementApi {
|
|
|
83803
84125
|
/**
|
|
83804
84126
|
* Request a historical adherence report in bulk
|
|
83805
84127
|
*
|
|
83806
|
-
* @param {Object}
|
|
83807
|
-
* @param {Object} opts.body body
|
|
84128
|
+
* @param {Object} body body
|
|
83808
84129
|
*/
|
|
83809
|
-
postWorkforcemanagementAdherenceHistoricalBulk(
|
|
83810
|
-
|
|
83811
|
-
|
|
84130
|
+
postWorkforcemanagementAdherenceHistoricalBulk(body) {
|
|
84131
|
+
// verify the required parameter 'body' is set
|
|
84132
|
+
if (body === undefined || body === null) {
|
|
84133
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAdherenceHistoricalBulk';
|
|
84134
|
+
}
|
|
83812
84135
|
|
|
83813
84136
|
return this.apiClient.callApi(
|
|
83814
84137
|
'/api/v2/workforcemanagement/adherence/historical/bulk',
|
|
@@ -83817,7 +84140,7 @@ class WorkforceManagementApi {
|
|
|
83817
84140
|
{ },
|
|
83818
84141
|
{ },
|
|
83819
84142
|
{ },
|
|
83820
|
-
|
|
84143
|
+
body,
|
|
83821
84144
|
['PureCloud OAuth'],
|
|
83822
84145
|
['application/json'],
|
|
83823
84146
|
['application/json']
|
|
@@ -83892,12 +84215,13 @@ class WorkforceManagementApi {
|
|
|
83892
84215
|
/**
|
|
83893
84216
|
* Move agents in and out of management unit
|
|
83894
84217
|
*
|
|
83895
|
-
* @param {Object}
|
|
83896
|
-
* @param {Object} opts.body body
|
|
84218
|
+
* @param {Object} body body
|
|
83897
84219
|
*/
|
|
83898
|
-
postWorkforcemanagementAgents(
|
|
83899
|
-
|
|
83900
|
-
|
|
84220
|
+
postWorkforcemanagementAgents(body) {
|
|
84221
|
+
// verify the required parameter 'body' is set
|
|
84222
|
+
if (body === undefined || body === null) {
|
|
84223
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgents';
|
|
84224
|
+
}
|
|
83901
84225
|
|
|
83902
84226
|
return this.apiClient.callApi(
|
|
83903
84227
|
'/api/v2/workforcemanagement/agents',
|
|
@@ -83906,7 +84230,7 @@ class WorkforceManagementApi {
|
|
|
83906
84230
|
{ },
|
|
83907
84231
|
{ },
|
|
83908
84232
|
{ },
|
|
83909
|
-
|
|
84233
|
+
body,
|
|
83910
84234
|
['PureCloud OAuth'],
|
|
83911
84235
|
['application/json'],
|
|
83912
84236
|
['application/json']
|
|
@@ -83916,12 +84240,13 @@ class WorkforceManagementApi {
|
|
|
83916
84240
|
/**
|
|
83917
84241
|
* Query integrations for agents
|
|
83918
84242
|
*
|
|
83919
|
-
* @param {Object}
|
|
83920
|
-
* @param {Object} opts.body body
|
|
84243
|
+
* @param {Object} body body
|
|
83921
84244
|
*/
|
|
83922
|
-
postWorkforcemanagementAgentsIntegrationsHrisQuery(
|
|
83923
|
-
|
|
83924
|
-
|
|
84245
|
+
postWorkforcemanagementAgentsIntegrationsHrisQuery(body) {
|
|
84246
|
+
// verify the required parameter 'body' is set
|
|
84247
|
+
if (body === undefined || body === null) {
|
|
84248
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsIntegrationsHrisQuery';
|
|
84249
|
+
}
|
|
83925
84250
|
|
|
83926
84251
|
return this.apiClient.callApi(
|
|
83927
84252
|
'/api/v2/workforcemanagement/agents/integrations/hris/query',
|
|
@@ -83930,7 +84255,7 @@ class WorkforceManagementApi {
|
|
|
83930
84255
|
{ },
|
|
83931
84256
|
{ },
|
|
83932
84257
|
{ },
|
|
83933
|
-
|
|
84258
|
+
body,
|
|
83934
84259
|
['PureCloud OAuth'],
|
|
83935
84260
|
['application/json'],
|
|
83936
84261
|
['application/json']
|
|
@@ -83965,12 +84290,13 @@ class WorkforceManagementApi {
|
|
|
83965
84290
|
/**
|
|
83966
84291
|
* Get published schedule for the current user
|
|
83967
84292
|
*
|
|
83968
|
-
* @param {Object}
|
|
83969
|
-
* @param {Object} opts.body body
|
|
84293
|
+
* @param {Object} body body
|
|
83970
84294
|
*/
|
|
83971
|
-
postWorkforcemanagementAgentschedulesMine(
|
|
83972
|
-
|
|
83973
|
-
|
|
84295
|
+
postWorkforcemanagementAgentschedulesMine(body) {
|
|
84296
|
+
// verify the required parameter 'body' is set
|
|
84297
|
+
if (body === undefined || body === null) {
|
|
84298
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentschedulesMine';
|
|
84299
|
+
}
|
|
83974
84300
|
|
|
83975
84301
|
return this.apiClient.callApi(
|
|
83976
84302
|
'/api/v2/workforcemanagement/agentschedules/mine',
|
|
@@ -83979,7 +84305,7 @@ class WorkforceManagementApi {
|
|
|
83979
84305
|
{ },
|
|
83980
84306
|
{ },
|
|
83981
84307
|
{ },
|
|
83982
|
-
|
|
84308
|
+
body,
|
|
83983
84309
|
['PureCloud OAuth'],
|
|
83984
84310
|
['application/json'],
|
|
83985
84311
|
['application/json']
|
|
@@ -84065,16 +84391,17 @@ class WorkforceManagementApi {
|
|
|
84065
84391
|
* Create a new activity code
|
|
84066
84392
|
*
|
|
84067
84393
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
84068
|
-
* @param {Object}
|
|
84069
|
-
* @param {Object} opts.body body
|
|
84394
|
+
* @param {Object} body body
|
|
84070
84395
|
*/
|
|
84071
|
-
postWorkforcemanagementBusinessunitActivitycodes(businessUnitId,
|
|
84072
|
-
opts = opts || {};
|
|
84073
|
-
|
|
84396
|
+
postWorkforcemanagementBusinessunitActivitycodes(businessUnitId, body) {
|
|
84074
84397
|
// verify the required parameter 'businessUnitId' is set
|
|
84075
84398
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84076
84399
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivitycodes';
|
|
84077
84400
|
}
|
|
84401
|
+
// verify the required parameter 'body' is set
|
|
84402
|
+
if (body === undefined || body === null) {
|
|
84403
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivitycodes';
|
|
84404
|
+
}
|
|
84078
84405
|
|
|
84079
84406
|
return this.apiClient.callApi(
|
|
84080
84407
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes',
|
|
@@ -84083,7 +84410,7 @@ class WorkforceManagementApi {
|
|
|
84083
84410
|
{ },
|
|
84084
84411
|
{ },
|
|
84085
84412
|
{ },
|
|
84086
|
-
|
|
84413
|
+
body,
|
|
84087
84414
|
['PureCloud OAuth'],
|
|
84088
84415
|
['application/json'],
|
|
84089
84416
|
['application/json']
|
|
@@ -84189,18 +84516,22 @@ class WorkforceManagementApi {
|
|
|
84189
84516
|
* Search published schedules
|
|
84190
84517
|
*
|
|
84191
84518
|
* @param {String} businessUnitId The ID of the business unit
|
|
84519
|
+
* @param {Object} body body
|
|
84192
84520
|
* @param {Object} opts Optional parameters
|
|
84193
84521
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
84194
84522
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
84195
|
-
* @param {Object} opts.body body
|
|
84196
84523
|
*/
|
|
84197
|
-
postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, opts) {
|
|
84524
|
+
postWorkforcemanagementBusinessunitAgentschedulesSearch(businessUnitId, body, opts) {
|
|
84198
84525
|
opts = opts || {};
|
|
84199
84526
|
|
|
84200
84527
|
// verify the required parameter 'businessUnitId' is set
|
|
84201
84528
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84202
84529
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';
|
|
84203
84530
|
}
|
|
84531
|
+
// verify the required parameter 'body' is set
|
|
84532
|
+
if (body === undefined || body === null) {
|
|
84533
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitAgentschedulesSearch';
|
|
84534
|
+
}
|
|
84204
84535
|
|
|
84205
84536
|
return this.apiClient.callApi(
|
|
84206
84537
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/agentschedules/search',
|
|
@@ -84209,7 +84540,7 @@ class WorkforceManagementApi {
|
|
|
84209
84540
|
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
84210
84541
|
{ },
|
|
84211
84542
|
{ },
|
|
84212
|
-
|
|
84543
|
+
body,
|
|
84213
84544
|
['PureCloud OAuth'],
|
|
84214
84545
|
['application/json'],
|
|
84215
84546
|
['application/json']
|
|
@@ -84254,17 +84585,21 @@ class WorkforceManagementApi {
|
|
|
84254
84585
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
84255
84586
|
*
|
|
84256
84587
|
* @param {String} businessUnitId The ID of the business unit
|
|
84588
|
+
* @param {Object} body body
|
|
84257
84589
|
* @param {Object} opts Optional parameters
|
|
84258
84590
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
84259
|
-
* @param {Object} opts.body body
|
|
84260
84591
|
*/
|
|
84261
|
-
postWorkforcemanagementBusinessunitIntraday(businessUnitId, opts) {
|
|
84592
|
+
postWorkforcemanagementBusinessunitIntraday(businessUnitId, body, opts) {
|
|
84262
84593
|
opts = opts || {};
|
|
84263
84594
|
|
|
84264
84595
|
// verify the required parameter 'businessUnitId' is set
|
|
84265
84596
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84266
84597
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitIntraday';
|
|
84267
84598
|
}
|
|
84599
|
+
// verify the required parameter 'body' is set
|
|
84600
|
+
if (body === undefined || body === null) {
|
|
84601
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitIntraday';
|
|
84602
|
+
}
|
|
84268
84603
|
|
|
84269
84604
|
return this.apiClient.callApi(
|
|
84270
84605
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/intraday',
|
|
@@ -84273,7 +84608,7 @@ class WorkforceManagementApi {
|
|
|
84273
84608
|
{ 'forceAsync': opts['forceAsync'] },
|
|
84274
84609
|
{ },
|
|
84275
84610
|
{ },
|
|
84276
|
-
|
|
84611
|
+
body,
|
|
84277
84612
|
['PureCloud OAuth'],
|
|
84278
84613
|
['application/json'],
|
|
84279
84614
|
['application/json']
|
|
@@ -84284,16 +84619,17 @@ class WorkforceManagementApi {
|
|
|
84284
84619
|
* Adds a new planning group
|
|
84285
84620
|
*
|
|
84286
84621
|
* @param {String} businessUnitId The ID of the business unit.
|
|
84287
|
-
* @param {Object}
|
|
84288
|
-
* @param {Object} opts.body body
|
|
84622
|
+
* @param {Object} body body
|
|
84289
84623
|
*/
|
|
84290
|
-
postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId,
|
|
84291
|
-
opts = opts || {};
|
|
84292
|
-
|
|
84624
|
+
postWorkforcemanagementBusinessunitPlanninggroups(businessUnitId, body) {
|
|
84293
84625
|
// verify the required parameter 'businessUnitId' is set
|
|
84294
84626
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84295
84627
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitPlanninggroups';
|
|
84296
84628
|
}
|
|
84629
|
+
// verify the required parameter 'body' is set
|
|
84630
|
+
if (body === undefined || body === null) {
|
|
84631
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitPlanninggroups';
|
|
84632
|
+
}
|
|
84297
84633
|
|
|
84298
84634
|
return this.apiClient.callApi(
|
|
84299
84635
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/planninggroups',
|
|
@@ -84302,7 +84638,7 @@ class WorkforceManagementApi {
|
|
|
84302
84638
|
{ },
|
|
84303
84639
|
{ },
|
|
84304
84640
|
{ },
|
|
84305
|
-
|
|
84641
|
+
body,
|
|
84306
84642
|
['PureCloud OAuth'],
|
|
84307
84643
|
['application/json'],
|
|
84308
84644
|
['application/json']
|
|
@@ -84313,16 +84649,17 @@ class WorkforceManagementApi {
|
|
|
84313
84649
|
* Adds a new service goal template
|
|
84314
84650
|
*
|
|
84315
84651
|
* @param {String} businessUnitId The ID of the business unit.
|
|
84316
|
-
* @param {Object}
|
|
84317
|
-
* @param {Object} opts.body body
|
|
84652
|
+
* @param {Object} body body
|
|
84318
84653
|
*/
|
|
84319
|
-
postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId,
|
|
84320
|
-
opts = opts || {};
|
|
84321
|
-
|
|
84654
|
+
postWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, body) {
|
|
84322
84655
|
// verify the required parameter 'businessUnitId' is set
|
|
84323
84656
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84324
84657
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
84325
84658
|
}
|
|
84659
|
+
// verify the required parameter 'body' is set
|
|
84660
|
+
if (body === undefined || body === null) {
|
|
84661
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitServicegoaltemplates';
|
|
84662
|
+
}
|
|
84326
84663
|
|
|
84327
84664
|
return this.apiClient.callApi(
|
|
84328
84665
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
|
|
@@ -84331,7 +84668,7 @@ class WorkforceManagementApi {
|
|
|
84331
84668
|
{ },
|
|
84332
84669
|
{ },
|
|
84333
84670
|
{ },
|
|
84334
|
-
|
|
84671
|
+
body,
|
|
84335
84672
|
['PureCloud OAuth'],
|
|
84336
84673
|
['application/json'],
|
|
84337
84674
|
['application/json']
|
|
@@ -84342,16 +84679,17 @@ class WorkforceManagementApi {
|
|
|
84342
84679
|
* Creates a new staffing group
|
|
84343
84680
|
*
|
|
84344
84681
|
* @param {String} businessUnitId The ID of the business unit
|
|
84345
|
-
* @param {Object}
|
|
84346
|
-
* @param {Object} opts.body body
|
|
84682
|
+
* @param {Object} body body
|
|
84347
84683
|
*/
|
|
84348
|
-
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId,
|
|
84349
|
-
opts = opts || {};
|
|
84350
|
-
|
|
84684
|
+
postWorkforcemanagementBusinessunitStaffinggroups(businessUnitId, body) {
|
|
84351
84685
|
// verify the required parameter 'businessUnitId' is set
|
|
84352
84686
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84353
84687
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
84354
84688
|
}
|
|
84689
|
+
// verify the required parameter 'body' is set
|
|
84690
|
+
if (body === undefined || body === null) {
|
|
84691
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroups';
|
|
84692
|
+
}
|
|
84355
84693
|
|
|
84356
84694
|
return this.apiClient.callApi(
|
|
84357
84695
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups',
|
|
@@ -84360,7 +84698,7 @@ class WorkforceManagementApi {
|
|
|
84360
84698
|
{ },
|
|
84361
84699
|
{ },
|
|
84362
84700
|
{ },
|
|
84363
|
-
|
|
84701
|
+
body,
|
|
84364
84702
|
['PureCloud OAuth'],
|
|
84365
84703
|
['application/json'],
|
|
84366
84704
|
['application/json']
|
|
@@ -84371,16 +84709,17 @@ class WorkforceManagementApi {
|
|
|
84371
84709
|
* Gets staffing group associations for a list of user IDs
|
|
84372
84710
|
*
|
|
84373
84711
|
* @param {String} businessUnitId The ID of the business unit
|
|
84374
|
-
* @param {Object}
|
|
84375
|
-
* @param {Object} opts.body body
|
|
84712
|
+
* @param {Object} body body
|
|
84376
84713
|
*/
|
|
84377
|
-
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId,
|
|
84378
|
-
opts = opts || {};
|
|
84379
|
-
|
|
84714
|
+
postWorkforcemanagementBusinessunitStaffinggroupsQuery(businessUnitId, body) {
|
|
84380
84715
|
// verify the required parameter 'businessUnitId' is set
|
|
84381
84716
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84382
84717
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
84383
84718
|
}
|
|
84719
|
+
// verify the required parameter 'body' is set
|
|
84720
|
+
if (body === undefined || body === null) {
|
|
84721
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroupsQuery';
|
|
84722
|
+
}
|
|
84384
84723
|
|
|
84385
84724
|
return this.apiClient.callApi(
|
|
84386
84725
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/query',
|
|
@@ -84389,7 +84728,7 @@ class WorkforceManagementApi {
|
|
|
84389
84728
|
{ },
|
|
84390
84729
|
{ },
|
|
84391
84730
|
{ },
|
|
84392
|
-
|
|
84731
|
+
body,
|
|
84393
84732
|
['PureCloud OAuth'],
|
|
84394
84733
|
['application/json'],
|
|
84395
84734
|
['application/json']
|
|
@@ -84400,16 +84739,17 @@ class WorkforceManagementApi {
|
|
|
84400
84739
|
* Creates a new time-off limit object
|
|
84401
84740
|
*
|
|
84402
84741
|
* @param {String} businessUnitId The ID of the business unit
|
|
84403
|
-
* @param {Object}
|
|
84404
|
-
* @param {Object} opts.body body
|
|
84742
|
+
* @param {Object} body body
|
|
84405
84743
|
*/
|
|
84406
|
-
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId,
|
|
84407
|
-
opts = opts || {};
|
|
84408
|
-
|
|
84744
|
+
postWorkforcemanagementBusinessunitTimeofflimits(businessUnitId, body) {
|
|
84409
84745
|
// verify the required parameter 'businessUnitId' is set
|
|
84410
84746
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84411
84747
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
84412
84748
|
}
|
|
84749
|
+
// verify the required parameter 'body' is set
|
|
84750
|
+
if (body === undefined || body === null) {
|
|
84751
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeofflimits';
|
|
84752
|
+
}
|
|
84413
84753
|
|
|
84414
84754
|
return this.apiClient.callApi(
|
|
84415
84755
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits',
|
|
@@ -84418,7 +84758,7 @@ class WorkforceManagementApi {
|
|
|
84418
84758
|
{ },
|
|
84419
84759
|
{ },
|
|
84420
84760
|
{ },
|
|
84421
|
-
|
|
84761
|
+
body,
|
|
84422
84762
|
['PureCloud OAuth'],
|
|
84423
84763
|
['application/json'],
|
|
84424
84764
|
['application/json']
|
|
@@ -84429,16 +84769,17 @@ class WorkforceManagementApi {
|
|
|
84429
84769
|
* Retrieves time-off limit related values based on a given set of filters.
|
|
84430
84770
|
*
|
|
84431
84771
|
* @param {String} businessUnitId The ID of the business unit
|
|
84432
|
-
* @param {Object}
|
|
84433
|
-
* @param {Object} opts.body body
|
|
84772
|
+
* @param {Object} body body
|
|
84434
84773
|
*/
|
|
84435
|
-
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId,
|
|
84436
|
-
opts = opts || {};
|
|
84437
|
-
|
|
84774
|
+
postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery(businessUnitId, body) {
|
|
84438
84775
|
// verify the required parameter 'businessUnitId' is set
|
|
84439
84776
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84440
84777
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
84441
84778
|
}
|
|
84779
|
+
// verify the required parameter 'body' is set
|
|
84780
|
+
if (body === undefined || body === null) {
|
|
84781
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeofflimitsValuesQuery';
|
|
84782
|
+
}
|
|
84442
84783
|
|
|
84443
84784
|
return this.apiClient.callApi(
|
|
84444
84785
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/values/query',
|
|
@@ -84447,7 +84788,7 @@ class WorkforceManagementApi {
|
|
|
84447
84788
|
{ },
|
|
84448
84789
|
{ },
|
|
84449
84790
|
{ },
|
|
84450
|
-
|
|
84791
|
+
body,
|
|
84451
84792
|
['PureCloud OAuth'],
|
|
84452
84793
|
['application/json'],
|
|
84453
84794
|
['application/json']
|
|
@@ -84458,16 +84799,17 @@ class WorkforceManagementApi {
|
|
|
84458
84799
|
* Creates a new time-off plan
|
|
84459
84800
|
*
|
|
84460
84801
|
* @param {String} businessUnitId The ID of the business unit
|
|
84461
|
-
* @param {Object}
|
|
84462
|
-
* @param {Object} opts.body body
|
|
84802
|
+
* @param {Object} body body
|
|
84463
84803
|
*/
|
|
84464
|
-
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId,
|
|
84465
|
-
opts = opts || {};
|
|
84466
|
-
|
|
84804
|
+
postWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, body) {
|
|
84467
84805
|
// verify the required parameter 'businessUnitId' is set
|
|
84468
84806
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84469
84807
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
84470
84808
|
}
|
|
84809
|
+
// verify the required parameter 'body' is set
|
|
84810
|
+
if (body === undefined || body === null) {
|
|
84811
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitTimeoffplans';
|
|
84812
|
+
}
|
|
84471
84813
|
|
|
84472
84814
|
return this.apiClient.callApi(
|
|
84473
84815
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
@@ -84476,7 +84818,7 @@ class WorkforceManagementApi {
|
|
|
84476
84818
|
{ },
|
|
84477
84819
|
{ },
|
|
84478
84820
|
{ },
|
|
84479
|
-
|
|
84821
|
+
body,
|
|
84480
84822
|
['PureCloud OAuth'],
|
|
84481
84823
|
['application/json'],
|
|
84482
84824
|
['application/json']
|
|
@@ -84574,12 +84916,9 @@ class WorkforceManagementApi {
|
|
|
84574
84916
|
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
84575
84917
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
84576
84918
|
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
84577
|
-
* @param {Object}
|
|
84578
|
-
* @param {Object} opts.body body
|
|
84919
|
+
* @param {Object} body body
|
|
84579
84920
|
*/
|
|
84580
|
-
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId,
|
|
84581
|
-
opts = opts || {};
|
|
84582
|
-
|
|
84921
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations(businessUnitId, weekId, scheduleId, body) {
|
|
84583
84922
|
// verify the required parameter 'businessUnitId' is set
|
|
84584
84923
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84585
84924
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
@@ -84592,6 +84931,10 @@ class WorkforceManagementApi {
|
|
|
84592
84931
|
if (scheduleId === undefined || scheduleId === null) {
|
|
84593
84932
|
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
84594
84933
|
}
|
|
84934
|
+
// verify the required parameter 'body' is set
|
|
84935
|
+
if (body === undefined || body === null) {
|
|
84936
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculations';
|
|
84937
|
+
}
|
|
84595
84938
|
|
|
84596
84939
|
return this.apiClient.callApi(
|
|
84597
84940
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations',
|
|
@@ -84600,7 +84943,7 @@ class WorkforceManagementApi {
|
|
|
84600
84943
|
{ },
|
|
84601
84944
|
{ },
|
|
84602
84945
|
{ },
|
|
84603
|
-
|
|
84946
|
+
body,
|
|
84604
84947
|
['PureCloud OAuth'],
|
|
84605
84948
|
['application/json'],
|
|
84606
84949
|
['application/json']
|
|
@@ -84613,12 +84956,9 @@ class WorkforceManagementApi {
|
|
|
84613
84956
|
* @param {String} businessUnitId The ID of the business unit to which the performance prediction belongs
|
|
84614
84957
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format
|
|
84615
84958
|
* @param {String} scheduleId The ID of the schedule the performance prediction belongs to
|
|
84616
|
-
* @param {Object}
|
|
84617
|
-
* @param {Object} opts.body body
|
|
84959
|
+
* @param {Object} body body
|
|
84618
84960
|
*/
|
|
84619
|
-
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId,
|
|
84620
|
-
opts = opts || {};
|
|
84621
|
-
|
|
84961
|
+
postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl(businessUnitId, weekId, scheduleId, body) {
|
|
84622
84962
|
// verify the required parameter 'businessUnitId' is set
|
|
84623
84963
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
84624
84964
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
@@ -84631,6 +84971,10 @@ class WorkforceManagementApi {
|
|
|
84631
84971
|
if (scheduleId === undefined || scheduleId === null) {
|
|
84632
84972
|
throw 'Missing the required parameter "scheduleId" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
84633
84973
|
}
|
|
84974
|
+
// verify the required parameter 'body' is set
|
|
84975
|
+
if (body === undefined || body === null) {
|
|
84976
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWeekSchedulePerformancepredictionsRecalculationsUploadurl';
|
|
84977
|
+
}
|
|
84634
84978
|
|
|
84635
84979
|
return this.apiClient.callApi(
|
|
84636
84980
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules/{scheduleId}/performancepredictions/recalculations/uploadurl',
|
|
@@ -84639,7 +84983,7 @@ class WorkforceManagementApi {
|
|
|
84639
84983
|
{ },
|
|
84640
84984
|
{ },
|
|
84641
84985
|
{ },
|
|
84642
|
-
|
|
84986
|
+
body,
|
|
84643
84987
|
['PureCloud OAuth'],
|
|
84644
84988
|
['application/json'],
|
|
84645
84989
|
['application/json']
|
|
@@ -85098,12 +85442,9 @@ class WorkforceManagementApi {
|
|
|
85098
85442
|
*
|
|
85099
85443
|
* @param {String} businessUnitId The ID of the business unit
|
|
85100
85444
|
* @param {String} bidId The work plan bid id of the bid groups
|
|
85101
|
-
* @param {Object}
|
|
85102
|
-
* @param {Object} opts.body body
|
|
85445
|
+
* @param {Object} body body
|
|
85103
85446
|
*/
|
|
85104
|
-
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId,
|
|
85105
|
-
opts = opts || {};
|
|
85106
|
-
|
|
85447
|
+
postWorkforcemanagementBusinessunitWorkplanbidGroups(businessUnitId, bidId, body) {
|
|
85107
85448
|
// verify the required parameter 'businessUnitId' is set
|
|
85108
85449
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85109
85450
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
@@ -85112,6 +85453,10 @@ class WorkforceManagementApi {
|
|
|
85112
85453
|
if (bidId === undefined || bidId === null) {
|
|
85113
85454
|
throw 'Missing the required parameter "bidId" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
85114
85455
|
}
|
|
85456
|
+
// verify the required parameter 'body' is set
|
|
85457
|
+
if (body === undefined || body === null) {
|
|
85458
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbidGroups';
|
|
85459
|
+
}
|
|
85115
85460
|
|
|
85116
85461
|
return this.apiClient.callApi(
|
|
85117
85462
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids/{bidId}/groups',
|
|
@@ -85120,7 +85465,7 @@ class WorkforceManagementApi {
|
|
|
85120
85465
|
{ },
|
|
85121
85466
|
{ },
|
|
85122
85467
|
{ },
|
|
85123
|
-
|
|
85468
|
+
body,
|
|
85124
85469
|
['PureCloud OAuth'],
|
|
85125
85470
|
['application/json'],
|
|
85126
85471
|
['application/json']
|
|
@@ -85131,16 +85476,17 @@ class WorkforceManagementApi {
|
|
|
85131
85476
|
* Create a new work plan bid
|
|
85132
85477
|
*
|
|
85133
85478
|
* @param {String} businessUnitId The ID of the business unit
|
|
85134
|
-
* @param {Object}
|
|
85135
|
-
* @param {Object} opts.body The work plan bid to be created
|
|
85479
|
+
* @param {Object} body The work plan bid to be created
|
|
85136
85480
|
*/
|
|
85137
|
-
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId,
|
|
85138
|
-
opts = opts || {};
|
|
85139
|
-
|
|
85481
|
+
postWorkforcemanagementBusinessunitWorkplanbids(businessUnitId, body) {
|
|
85140
85482
|
// verify the required parameter 'businessUnitId' is set
|
|
85141
85483
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
85142
85484
|
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
85143
85485
|
}
|
|
85486
|
+
// verify the required parameter 'body' is set
|
|
85487
|
+
if (body === undefined || body === null) {
|
|
85488
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitWorkplanbids';
|
|
85489
|
+
}
|
|
85144
85490
|
|
|
85145
85491
|
return this.apiClient.callApi(
|
|
85146
85492
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/workplanbids',
|
|
@@ -85149,7 +85495,7 @@ class WorkforceManagementApi {
|
|
|
85149
85495
|
{ },
|
|
85150
85496
|
{ },
|
|
85151
85497
|
{ },
|
|
85152
|
-
|
|
85498
|
+
body,
|
|
85153
85499
|
['PureCloud OAuth'],
|
|
85154
85500
|
['application/json'],
|
|
85155
85501
|
['application/json']
|
|
@@ -85159,12 +85505,13 @@ class WorkforceManagementApi {
|
|
|
85159
85505
|
/**
|
|
85160
85506
|
* Add a new business unit
|
|
85161
85507
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
85162
|
-
* @param {Object}
|
|
85163
|
-
* @param {Object} opts.body body
|
|
85508
|
+
* @param {Object} body body
|
|
85164
85509
|
*/
|
|
85165
|
-
postWorkforcemanagementBusinessunits(
|
|
85166
|
-
|
|
85167
|
-
|
|
85510
|
+
postWorkforcemanagementBusinessunits(body) {
|
|
85511
|
+
// verify the required parameter 'body' is set
|
|
85512
|
+
if (body === undefined || body === null) {
|
|
85513
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunits';
|
|
85514
|
+
}
|
|
85168
85515
|
|
|
85169
85516
|
return this.apiClient.callApi(
|
|
85170
85517
|
'/api/v2/workforcemanagement/businessunits',
|
|
@@ -85173,7 +85520,7 @@ class WorkforceManagementApi {
|
|
|
85173
85520
|
{ },
|
|
85174
85521
|
{ },
|
|
85175
85522
|
{ },
|
|
85176
|
-
|
|
85523
|
+
body,
|
|
85177
85524
|
['PureCloud OAuth'],
|
|
85178
85525
|
['application/json'],
|
|
85179
85526
|
['application/json']
|
|
@@ -85207,12 +85554,13 @@ class WorkforceManagementApi {
|
|
|
85207
85554
|
/**
|
|
85208
85555
|
* Delete the list of the historical data import entries
|
|
85209
85556
|
*
|
|
85210
|
-
* @param {Object}
|
|
85211
|
-
* @param {Object} opts.body body
|
|
85557
|
+
* @param {Object} body body
|
|
85212
85558
|
*/
|
|
85213
|
-
postWorkforcemanagementHistoricaldataBulkRemoveJobs(
|
|
85214
|
-
|
|
85215
|
-
|
|
85559
|
+
postWorkforcemanagementHistoricaldataBulkRemoveJobs(body) {
|
|
85560
|
+
// verify the required parameter 'body' is set
|
|
85561
|
+
if (body === undefined || body === null) {
|
|
85562
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementHistoricaldataBulkRemoveJobs';
|
|
85563
|
+
}
|
|
85216
85564
|
|
|
85217
85565
|
return this.apiClient.callApi(
|
|
85218
85566
|
'/api/v2/workforcemanagement/historicaldata/bulk/remove/jobs',
|
|
@@ -85221,7 +85569,7 @@ class WorkforceManagementApi {
|
|
|
85221
85569
|
{ },
|
|
85222
85570
|
{ },
|
|
85223
85571
|
{ },
|
|
85224
|
-
|
|
85572
|
+
body,
|
|
85225
85573
|
['PureCloud OAuth'],
|
|
85226
85574
|
['application/json'],
|
|
85227
85575
|
['application/json']
|
|
@@ -85252,12 +85600,13 @@ class WorkforceManagementApi {
|
|
|
85252
85600
|
/**
|
|
85253
85601
|
* Trigger validation process for historical import
|
|
85254
85602
|
*
|
|
85255
|
-
* @param {Object}
|
|
85256
|
-
* @param {Object} opts.body body
|
|
85603
|
+
* @param {Object} body body
|
|
85257
85604
|
*/
|
|
85258
|
-
postWorkforcemanagementHistoricaldataValidate(
|
|
85259
|
-
|
|
85260
|
-
|
|
85605
|
+
postWorkforcemanagementHistoricaldataValidate(body) {
|
|
85606
|
+
// verify the required parameter 'body' is set
|
|
85607
|
+
if (body === undefined || body === null) {
|
|
85608
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementHistoricaldataValidate';
|
|
85609
|
+
}
|
|
85261
85610
|
|
|
85262
85611
|
return this.apiClient.callApi(
|
|
85263
85612
|
'/api/v2/workforcemanagement/historicaldata/validate',
|
|
@@ -85266,7 +85615,7 @@ class WorkforceManagementApi {
|
|
|
85266
85615
|
{ },
|
|
85267
85616
|
{ },
|
|
85268
85617
|
{ },
|
|
85269
|
-
|
|
85618
|
+
body,
|
|
85270
85619
|
['PureCloud OAuth'],
|
|
85271
85620
|
['application/json'],
|
|
85272
85621
|
['application/json']
|
|
@@ -85302,17 +85651,21 @@ class WorkforceManagementApi {
|
|
|
85302
85651
|
* Get agents work plans configuration
|
|
85303
85652
|
*
|
|
85304
85653
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85654
|
+
* @param {Object} body body
|
|
85305
85655
|
* @param {Object} opts Optional parameters
|
|
85306
85656
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85307
|
-
* @param {Object} opts.body body
|
|
85308
85657
|
*/
|
|
85309
|
-
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, opts) {
|
|
85658
|
+
postWorkforcemanagementManagementunitAgentsWorkplansQuery(managementUnitId, body, opts) {
|
|
85310
85659
|
opts = opts || {};
|
|
85311
85660
|
|
|
85312
85661
|
// verify the required parameter 'managementUnitId' is set
|
|
85313
85662
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85314
85663
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
85315
85664
|
}
|
|
85665
|
+
// verify the required parameter 'body' is set
|
|
85666
|
+
if (body === undefined || body === null) {
|
|
85667
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitAgentsWorkplansQuery';
|
|
85668
|
+
}
|
|
85316
85669
|
|
|
85317
85670
|
return this.apiClient.callApi(
|
|
85318
85671
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/workplans/query',
|
|
@@ -85321,7 +85674,7 @@ class WorkforceManagementApi {
|
|
|
85321
85674
|
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
85322
85675
|
{ },
|
|
85323
85676
|
{ },
|
|
85324
|
-
|
|
85677
|
+
body,
|
|
85325
85678
|
['PureCloud OAuth'],
|
|
85326
85679
|
['application/json'],
|
|
85327
85680
|
['application/json']
|
|
@@ -85332,18 +85685,22 @@ class WorkforceManagementApi {
|
|
|
85332
85685
|
* Query published schedules for given given time range for set of users
|
|
85333
85686
|
*
|
|
85334
85687
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85688
|
+
* @param {Object} body body
|
|
85335
85689
|
* @param {Object} opts Optional parameters
|
|
85336
85690
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
85337
85691
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85338
|
-
* @param {Object} opts.body body
|
|
85339
85692
|
*/
|
|
85340
|
-
postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, opts) {
|
|
85693
|
+
postWorkforcemanagementManagementunitAgentschedulesSearch(managementUnitId, body, opts) {
|
|
85341
85694
|
opts = opts || {};
|
|
85342
85695
|
|
|
85343
85696
|
// verify the required parameter 'managementUnitId' is set
|
|
85344
85697
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85345
85698
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
85346
85699
|
}
|
|
85700
|
+
// verify the required parameter 'body' is set
|
|
85701
|
+
if (body === undefined || body === null) {
|
|
85702
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitAgentschedulesSearch';
|
|
85703
|
+
}
|
|
85347
85704
|
|
|
85348
85705
|
return this.apiClient.callApi(
|
|
85349
85706
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/agentschedules/search',
|
|
@@ -85352,7 +85709,7 @@ class WorkforceManagementApi {
|
|
|
85352
85709
|
{ 'forceAsync': opts['forceAsync'],'forceDownloadService': opts['forceDownloadService'] },
|
|
85353
85710
|
{ },
|
|
85354
85711
|
{ },
|
|
85355
|
-
|
|
85712
|
+
body,
|
|
85356
85713
|
['PureCloud OAuth'],
|
|
85357
85714
|
['application/json'],
|
|
85358
85715
|
['application/json']
|
|
@@ -85363,16 +85720,17 @@ class WorkforceManagementApi {
|
|
|
85363
85720
|
* Request a historical adherence report
|
|
85364
85721
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
85365
85722
|
* @param {String} managementUnitId The ID of the management unit
|
|
85366
|
-
* @param {Object}
|
|
85367
|
-
* @param {Object} opts.body body
|
|
85723
|
+
* @param {Object} body body
|
|
85368
85724
|
*/
|
|
85369
|
-
postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId,
|
|
85370
|
-
opts = opts || {};
|
|
85371
|
-
|
|
85725
|
+
postWorkforcemanagementManagementunitHistoricaladherencequery(managementUnitId, body) {
|
|
85372
85726
|
// verify the required parameter 'managementUnitId' is set
|
|
85373
85727
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85374
85728
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
85375
85729
|
}
|
|
85730
|
+
// verify the required parameter 'body' is set
|
|
85731
|
+
if (body === undefined || body === null) {
|
|
85732
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitHistoricaladherencequery';
|
|
85733
|
+
}
|
|
85376
85734
|
|
|
85377
85735
|
return this.apiClient.callApi(
|
|
85378
85736
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/historicaladherencequery',
|
|
@@ -85381,7 +85739,7 @@ class WorkforceManagementApi {
|
|
|
85381
85739
|
{ },
|
|
85382
85740
|
{ },
|
|
85383
85741
|
{ },
|
|
85384
|
-
|
|
85742
|
+
body,
|
|
85385
85743
|
['PureCloud OAuth'],
|
|
85386
85744
|
['application/json'],
|
|
85387
85745
|
['application/json']
|
|
@@ -85392,16 +85750,17 @@ class WorkforceManagementApi {
|
|
|
85392
85750
|
* Move the requested management unit to a new business unit
|
|
85393
85751
|
* Returns status 200 if the management unit is already in the requested business unit
|
|
85394
85752
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85395
|
-
* @param {Object}
|
|
85396
|
-
* @param {Object} opts.body body
|
|
85753
|
+
* @param {Object} body body
|
|
85397
85754
|
*/
|
|
85398
|
-
postWorkforcemanagementManagementunitMove(managementUnitId,
|
|
85399
|
-
opts = opts || {};
|
|
85400
|
-
|
|
85755
|
+
postWorkforcemanagementManagementunitMove(managementUnitId, body) {
|
|
85401
85756
|
// verify the required parameter 'managementUnitId' is set
|
|
85402
85757
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85403
85758
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitMove';
|
|
85404
85759
|
}
|
|
85760
|
+
// verify the required parameter 'body' is set
|
|
85761
|
+
if (body === undefined || body === null) {
|
|
85762
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitMove';
|
|
85763
|
+
}
|
|
85405
85764
|
|
|
85406
85765
|
return this.apiClient.callApi(
|
|
85407
85766
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/move',
|
|
@@ -85410,7 +85769,7 @@ class WorkforceManagementApi {
|
|
|
85410
85769
|
{ },
|
|
85411
85770
|
{ },
|
|
85412
85771
|
{ },
|
|
85413
|
-
|
|
85772
|
+
body,
|
|
85414
85773
|
['PureCloud OAuth'],
|
|
85415
85774
|
['application/json'],
|
|
85416
85775
|
['application/json']
|
|
@@ -85421,17 +85780,18 @@ class WorkforceManagementApi {
|
|
|
85421
85780
|
* Query published schedules for given given time range for set of users
|
|
85422
85781
|
*
|
|
85423
85782
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85424
|
-
* @param {Object}
|
|
85425
|
-
* @param {Object} opts.body body
|
|
85783
|
+
* @param {Object} body body
|
|
85426
85784
|
* @deprecated
|
|
85427
85785
|
*/
|
|
85428
|
-
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId,
|
|
85429
|
-
opts = opts || {};
|
|
85430
|
-
|
|
85786
|
+
postWorkforcemanagementManagementunitSchedulesSearch(managementUnitId, body) {
|
|
85431
85787
|
// verify the required parameter 'managementUnitId' is set
|
|
85432
85788
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85433
85789
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
85434
85790
|
}
|
|
85791
|
+
// verify the required parameter 'body' is set
|
|
85792
|
+
if (body === undefined || body === null) {
|
|
85793
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitSchedulesSearch';
|
|
85794
|
+
}
|
|
85435
85795
|
|
|
85436
85796
|
return this.apiClient.callApi(
|
|
85437
85797
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/schedules/search',
|
|
@@ -85440,7 +85800,7 @@ class WorkforceManagementApi {
|
|
|
85440
85800
|
{ },
|
|
85441
85801
|
{ },
|
|
85442
85802
|
{ },
|
|
85443
|
-
|
|
85803
|
+
body,
|
|
85444
85804
|
['PureCloud OAuth'],
|
|
85445
85805
|
['application/json'],
|
|
85446
85806
|
['application/json']
|
|
@@ -85451,16 +85811,17 @@ class WorkforceManagementApi {
|
|
|
85451
85811
|
* Request a historical shrinkage report
|
|
85452
85812
|
* The maximum supported range for historical shrinkage queries is up to 32 days. Historical Shrinkage for a given date range can be queried in two modes - granular and aggregated. To see granular shrinkage information, provide granularity in the request body.
|
|
85453
85813
|
* @param {String} managementUnitId The ID of the management unit
|
|
85454
|
-
* @param {Object}
|
|
85455
|
-
* @param {Object} opts.body body
|
|
85814
|
+
* @param {Object} body body
|
|
85456
85815
|
*/
|
|
85457
|
-
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId,
|
|
85458
|
-
opts = opts || {};
|
|
85459
|
-
|
|
85816
|
+
postWorkforcemanagementManagementunitShrinkageJobs(managementUnitId, body) {
|
|
85460
85817
|
// verify the required parameter 'managementUnitId' is set
|
|
85461
85818
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85462
85819
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
85463
85820
|
}
|
|
85821
|
+
// verify the required parameter 'body' is set
|
|
85822
|
+
if (body === undefined || body === null) {
|
|
85823
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitShrinkageJobs';
|
|
85824
|
+
}
|
|
85464
85825
|
|
|
85465
85826
|
return this.apiClient.callApi(
|
|
85466
85827
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/shrinkage/jobs',
|
|
@@ -85469,7 +85830,7 @@ class WorkforceManagementApi {
|
|
|
85469
85830
|
{ },
|
|
85470
85831
|
{ },
|
|
85471
85832
|
{ },
|
|
85472
|
-
|
|
85833
|
+
body,
|
|
85473
85834
|
['PureCloud OAuth'],
|
|
85474
85835
|
['application/json'],
|
|
85475
85836
|
['application/json']
|
|
@@ -85480,16 +85841,17 @@ class WorkforceManagementApi {
|
|
|
85480
85841
|
* Creates a new time off limit object under management unit.
|
|
85481
85842
|
* Only one limit object is allowed under management unit, so an attempt to create second object will fail.
|
|
85482
85843
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85483
|
-
* @param {Object}
|
|
85484
|
-
* @param {Object} opts.body body
|
|
85844
|
+
* @param {Object} body body
|
|
85485
85845
|
*/
|
|
85486
|
-
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId,
|
|
85487
|
-
opts = opts || {};
|
|
85488
|
-
|
|
85846
|
+
postWorkforcemanagementManagementunitTimeofflimits(managementUnitId, body) {
|
|
85489
85847
|
// verify the required parameter 'managementUnitId' is set
|
|
85490
85848
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85491
85849
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
85492
85850
|
}
|
|
85851
|
+
// verify the required parameter 'body' is set
|
|
85852
|
+
if (body === undefined || body === null) {
|
|
85853
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeofflimits';
|
|
85854
|
+
}
|
|
85493
85855
|
|
|
85494
85856
|
return this.apiClient.callApi(
|
|
85495
85857
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits',
|
|
@@ -85498,7 +85860,7 @@ class WorkforceManagementApi {
|
|
|
85498
85860
|
{ },
|
|
85499
85861
|
{ },
|
|
85500
85862
|
{ },
|
|
85501
|
-
|
|
85863
|
+
body,
|
|
85502
85864
|
['PureCloud OAuth'],
|
|
85503
85865
|
['application/json'],
|
|
85504
85866
|
['application/json']
|
|
@@ -85509,16 +85871,17 @@ class WorkforceManagementApi {
|
|
|
85509
85871
|
* Retrieves time off limit related values based on a given set of filters.
|
|
85510
85872
|
*
|
|
85511
85873
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85512
|
-
* @param {Object}
|
|
85513
|
-
* @param {Object} opts.body body
|
|
85874
|
+
* @param {Object} body body
|
|
85514
85875
|
*/
|
|
85515
|
-
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId,
|
|
85516
|
-
opts = opts || {};
|
|
85517
|
-
|
|
85876
|
+
postWorkforcemanagementManagementunitTimeofflimitsValuesQuery(managementUnitId, body) {
|
|
85518
85877
|
// verify the required parameter 'managementUnitId' is set
|
|
85519
85878
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85520
85879
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
85521
85880
|
}
|
|
85881
|
+
// verify the required parameter 'body' is set
|
|
85882
|
+
if (body === undefined || body === null) {
|
|
85883
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeofflimitsValuesQuery';
|
|
85884
|
+
}
|
|
85522
85885
|
|
|
85523
85886
|
return this.apiClient.callApi(
|
|
85524
85887
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/values/query',
|
|
@@ -85527,7 +85890,7 @@ class WorkforceManagementApi {
|
|
|
85527
85890
|
{ },
|
|
85528
85891
|
{ },
|
|
85529
85892
|
{ },
|
|
85530
|
-
|
|
85893
|
+
body,
|
|
85531
85894
|
['PureCloud OAuth'],
|
|
85532
85895
|
['application/json'],
|
|
85533
85896
|
['application/json']
|
|
@@ -85538,16 +85901,17 @@ class WorkforceManagementApi {
|
|
|
85538
85901
|
* Creates a new time off plan
|
|
85539
85902
|
*
|
|
85540
85903
|
* @param {String} managementUnitId The ID of the management unit
|
|
85541
|
-
* @param {Object}
|
|
85542
|
-
* @param {Object} opts.body body
|
|
85904
|
+
* @param {Object} body body
|
|
85543
85905
|
*/
|
|
85544
|
-
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId,
|
|
85545
|
-
opts = opts || {};
|
|
85546
|
-
|
|
85906
|
+
postWorkforcemanagementManagementunitTimeoffplans(managementUnitId, body) {
|
|
85547
85907
|
// verify the required parameter 'managementUnitId' is set
|
|
85548
85908
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85549
85909
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
85550
85910
|
}
|
|
85911
|
+
// verify the required parameter 'body' is set
|
|
85912
|
+
if (body === undefined || body === null) {
|
|
85913
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffplans';
|
|
85914
|
+
}
|
|
85551
85915
|
|
|
85552
85916
|
return this.apiClient.callApi(
|
|
85553
85917
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffplans',
|
|
@@ -85556,7 +85920,7 @@ class WorkforceManagementApi {
|
|
|
85556
85920
|
{ },
|
|
85557
85921
|
{ },
|
|
85558
85922
|
{ },
|
|
85559
|
-
|
|
85923
|
+
body,
|
|
85560
85924
|
['PureCloud OAuth'],
|
|
85561
85925
|
['application/json'],
|
|
85562
85926
|
['application/json']
|
|
@@ -85567,16 +85931,17 @@ class WorkforceManagementApi {
|
|
|
85567
85931
|
* Create a new time off request
|
|
85568
85932
|
*
|
|
85569
85933
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85570
|
-
* @param {Object}
|
|
85571
|
-
* @param {Object} opts.body body
|
|
85934
|
+
* @param {Object} body body
|
|
85572
85935
|
*/
|
|
85573
|
-
postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId,
|
|
85574
|
-
opts = opts || {};
|
|
85575
|
-
|
|
85936
|
+
postWorkforcemanagementManagementunitTimeoffrequests(managementUnitId, body) {
|
|
85576
85937
|
// verify the required parameter 'managementUnitId' is set
|
|
85577
85938
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85578
85939
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
85579
85940
|
}
|
|
85941
|
+
// verify the required parameter 'body' is set
|
|
85942
|
+
if (body === undefined || body === null) {
|
|
85943
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequests';
|
|
85944
|
+
}
|
|
85580
85945
|
|
|
85581
85946
|
return this.apiClient.callApi(
|
|
85582
85947
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests',
|
|
@@ -85585,7 +85950,7 @@ class WorkforceManagementApi {
|
|
|
85585
85950
|
{ },
|
|
85586
85951
|
{ },
|
|
85587
85952
|
{ },
|
|
85588
|
-
|
|
85953
|
+
body,
|
|
85589
85954
|
['PureCloud OAuth'],
|
|
85590
85955
|
['application/json'],
|
|
85591
85956
|
['application/json']
|
|
@@ -85596,16 +85961,17 @@ class WorkforceManagementApi {
|
|
|
85596
85961
|
* Retrieves integration statuses for a list of time off requests
|
|
85597
85962
|
*
|
|
85598
85963
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85599
|
-
* @param {Object}
|
|
85600
|
-
* @param {Object} opts.body body
|
|
85964
|
+
* @param {Object} body body
|
|
85601
85965
|
*/
|
|
85602
|
-
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId,
|
|
85603
|
-
opts = opts || {};
|
|
85604
|
-
|
|
85966
|
+
postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, body) {
|
|
85605
85967
|
// verify the required parameter 'managementUnitId' is set
|
|
85606
85968
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85607
85969
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
85608
85970
|
}
|
|
85971
|
+
// verify the required parameter 'body' is set
|
|
85972
|
+
if (body === undefined || body === null) {
|
|
85973
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
|
|
85974
|
+
}
|
|
85609
85975
|
|
|
85610
85976
|
return this.apiClient.callApi(
|
|
85611
85977
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
|
|
@@ -85614,7 +85980,7 @@ class WorkforceManagementApi {
|
|
|
85614
85980
|
{ },
|
|
85615
85981
|
{ },
|
|
85616
85982
|
{ },
|
|
85617
|
-
|
|
85983
|
+
body,
|
|
85618
85984
|
['PureCloud OAuth'],
|
|
85619
85985
|
['application/json'],
|
|
85620
85986
|
['application/json']
|
|
@@ -85625,17 +85991,21 @@ class WorkforceManagementApi {
|
|
|
85625
85991
|
* Fetches time off requests matching the conditions specified in the request body
|
|
85626
85992
|
* Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
|
|
85627
85993
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85994
|
+
* @param {Object} body body
|
|
85628
85995
|
* @param {Object} opts Optional parameters
|
|
85629
85996
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
85630
|
-
* @param {Object} opts.body body
|
|
85631
85997
|
*/
|
|
85632
|
-
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, opts) {
|
|
85998
|
+
postWorkforcemanagementManagementunitTimeoffrequestsQuery(managementUnitId, body, opts) {
|
|
85633
85999
|
opts = opts || {};
|
|
85634
86000
|
|
|
85635
86001
|
// verify the required parameter 'managementUnitId' is set
|
|
85636
86002
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85637
86003
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
|
|
85638
86004
|
}
|
|
86005
|
+
// verify the required parameter 'body' is set
|
|
86006
|
+
if (body === undefined || body === null) {
|
|
86007
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsQuery';
|
|
86008
|
+
}
|
|
85639
86009
|
|
|
85640
86010
|
return this.apiClient.callApi(
|
|
85641
86011
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/query',
|
|
@@ -85644,7 +86014,7 @@ class WorkforceManagementApi {
|
|
|
85644
86014
|
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
85645
86015
|
{ },
|
|
85646
86016
|
{ },
|
|
85647
|
-
|
|
86017
|
+
body,
|
|
85648
86018
|
['PureCloud OAuth'],
|
|
85649
86019
|
['application/json'],
|
|
85650
86020
|
['application/json']
|
|
@@ -85655,16 +86025,17 @@ class WorkforceManagementApi {
|
|
|
85655
86025
|
* Retrieves daily waitlist position for a list of time off requests
|
|
85656
86026
|
*
|
|
85657
86027
|
* @param {String} managementUnitId The ID of the management unit.
|
|
85658
|
-
* @param {Object}
|
|
85659
|
-
* @param {Object} opts.body body
|
|
86028
|
+
* @param {Object} body body
|
|
85660
86029
|
*/
|
|
85661
|
-
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId,
|
|
85662
|
-
opts = opts || {};
|
|
85663
|
-
|
|
86030
|
+
postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery(managementUnitId, body) {
|
|
85664
86031
|
// verify the required parameter 'managementUnitId' is set
|
|
85665
86032
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85666
86033
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
85667
86034
|
}
|
|
86035
|
+
// verify the required parameter 'body' is set
|
|
86036
|
+
if (body === undefined || body === null) {
|
|
86037
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitTimeoffrequestsWaitlistpositionsQuery';
|
|
86038
|
+
}
|
|
85668
86039
|
|
|
85669
86040
|
return this.apiClient.callApi(
|
|
85670
86041
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/waitlistpositions/query',
|
|
@@ -85673,7 +86044,7 @@ class WorkforceManagementApi {
|
|
|
85673
86044
|
{ },
|
|
85674
86045
|
{ },
|
|
85675
86046
|
{ },
|
|
85676
|
-
|
|
86047
|
+
body,
|
|
85677
86048
|
['PureCloud OAuth'],
|
|
85678
86049
|
['application/json'],
|
|
85679
86050
|
['application/json']
|
|
@@ -85755,12 +86126,9 @@ class WorkforceManagementApi {
|
|
|
85755
86126
|
*
|
|
85756
86127
|
* @param {String} managementUnitId The ID of the management unit
|
|
85757
86128
|
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
85758
|
-
* @param {Object}
|
|
85759
|
-
* @param {Object} opts.body body
|
|
86129
|
+
* @param {Object} body body
|
|
85760
86130
|
*/
|
|
85761
|
-
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId,
|
|
85762
|
-
opts = opts || {};
|
|
85763
|
-
|
|
86131
|
+
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body) {
|
|
85764
86132
|
// verify the required parameter 'managementUnitId' is set
|
|
85765
86133
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85766
86134
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
@@ -85769,6 +86137,10 @@ class WorkforceManagementApi {
|
|
|
85769
86137
|
if (userId === undefined || userId === null) {
|
|
85770
86138
|
throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
85771
86139
|
}
|
|
86140
|
+
// verify the required parameter 'body' is set
|
|
86141
|
+
if (body === undefined || body === null) {
|
|
86142
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
|
|
86143
|
+
}
|
|
85772
86144
|
|
|
85773
86145
|
return this.apiClient.callApi(
|
|
85774
86146
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
@@ -85777,7 +86149,7 @@ class WorkforceManagementApi {
|
|
|
85777
86149
|
{ },
|
|
85778
86150
|
{ },
|
|
85779
86151
|
{ },
|
|
85780
|
-
|
|
86152
|
+
body,
|
|
85781
86153
|
['PureCloud OAuth'],
|
|
85782
86154
|
['application/json'],
|
|
85783
86155
|
['application/json']
|
|
@@ -85942,12 +86314,9 @@ class WorkforceManagementApi {
|
|
|
85942
86314
|
*
|
|
85943
86315
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85944
86316
|
* @param {String} workPlanId The ID of the work plan to create a copy
|
|
85945
|
-
* @param {Object}
|
|
85946
|
-
* @param {Object} opts.body body
|
|
86317
|
+
* @param {Object} body body
|
|
85947
86318
|
*/
|
|
85948
|
-
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId,
|
|
85949
|
-
opts = opts || {};
|
|
85950
|
-
|
|
86319
|
+
postWorkforcemanagementManagementunitWorkplanCopy(managementUnitId, workPlanId, body) {
|
|
85951
86320
|
// verify the required parameter 'managementUnitId' is set
|
|
85952
86321
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
85953
86322
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
@@ -85956,6 +86325,10 @@ class WorkforceManagementApi {
|
|
|
85956
86325
|
if (workPlanId === undefined || workPlanId === null) {
|
|
85957
86326
|
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
85958
86327
|
}
|
|
86328
|
+
// verify the required parameter 'body' is set
|
|
86329
|
+
if (body === undefined || body === null) {
|
|
86330
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanCopy';
|
|
86331
|
+
}
|
|
85959
86332
|
|
|
85960
86333
|
return this.apiClient.callApi(
|
|
85961
86334
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/copy',
|
|
@@ -85964,7 +86337,7 @@ class WorkforceManagementApi {
|
|
|
85964
86337
|
{ },
|
|
85965
86338
|
{ },
|
|
85966
86339
|
{ },
|
|
85967
|
-
|
|
86340
|
+
body,
|
|
85968
86341
|
['PureCloud OAuth'],
|
|
85969
86342
|
['application/json'],
|
|
85970
86343
|
['application/json']
|
|
@@ -85976,11 +86349,11 @@ class WorkforceManagementApi {
|
|
|
85976
86349
|
*
|
|
85977
86350
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
85978
86351
|
* @param {String} workPlanId The ID of the work plan to validate. For new work plan, use the word 'new' for the ID.
|
|
86352
|
+
* @param {Object} body body
|
|
85979
86353
|
* @param {Object} opts Optional parameters
|
|
85980
86354
|
* @param {Array.<String>} opts.expand
|
|
85981
|
-
* @param {Object} opts.body body
|
|
85982
86355
|
*/
|
|
85983
|
-
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, opts) {
|
|
86356
|
+
postWorkforcemanagementManagementunitWorkplanValidate(managementUnitId, workPlanId, body, opts) {
|
|
85984
86357
|
opts = opts || {};
|
|
85985
86358
|
|
|
85986
86359
|
// verify the required parameter 'managementUnitId' is set
|
|
@@ -85991,6 +86364,10 @@ class WorkforceManagementApi {
|
|
|
85991
86364
|
if (workPlanId === undefined || workPlanId === null) {
|
|
85992
86365
|
throw 'Missing the required parameter "workPlanId" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
85993
86366
|
}
|
|
86367
|
+
// verify the required parameter 'body' is set
|
|
86368
|
+
if (body === undefined || body === null) {
|
|
86369
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanValidate';
|
|
86370
|
+
}
|
|
85994
86371
|
|
|
85995
86372
|
return this.apiClient.callApi(
|
|
85996
86373
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans/{workPlanId}/validate',
|
|
@@ -85999,7 +86376,7 @@ class WorkforceManagementApi {
|
|
|
85999
86376
|
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
86000
86377
|
{ },
|
|
86001
86378
|
{ },
|
|
86002
|
-
|
|
86379
|
+
body,
|
|
86003
86380
|
['PureCloud OAuth'],
|
|
86004
86381
|
['application/json'],
|
|
86005
86382
|
['application/json']
|
|
@@ -86011,12 +86388,9 @@ class WorkforceManagementApi {
|
|
|
86011
86388
|
*
|
|
86012
86389
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86013
86390
|
* @param {String} workPlanRotationId The ID of the work plan rotation to create a copy
|
|
86014
|
-
* @param {Object}
|
|
86015
|
-
* @param {Object} opts.body body
|
|
86391
|
+
* @param {Object} body body
|
|
86016
86392
|
*/
|
|
86017
|
-
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId,
|
|
86018
|
-
opts = opts || {};
|
|
86019
|
-
|
|
86393
|
+
postWorkforcemanagementManagementunitWorkplanrotationCopy(managementUnitId, workPlanRotationId, body) {
|
|
86020
86394
|
// verify the required parameter 'managementUnitId' is set
|
|
86021
86395
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86022
86396
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
@@ -86025,6 +86399,10 @@ class WorkforceManagementApi {
|
|
|
86025
86399
|
if (workPlanRotationId === undefined || workPlanRotationId === null) {
|
|
86026
86400
|
throw 'Missing the required parameter "workPlanRotationId" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
86027
86401
|
}
|
|
86402
|
+
// verify the required parameter 'body' is set
|
|
86403
|
+
if (body === undefined || body === null) {
|
|
86404
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanrotationCopy';
|
|
86405
|
+
}
|
|
86028
86406
|
|
|
86029
86407
|
return this.apiClient.callApi(
|
|
86030
86408
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations/{workPlanRotationId}/copy',
|
|
@@ -86033,7 +86411,7 @@ class WorkforceManagementApi {
|
|
|
86033
86411
|
{ },
|
|
86034
86412
|
{ },
|
|
86035
86413
|
{ },
|
|
86036
|
-
|
|
86414
|
+
body,
|
|
86037
86415
|
['PureCloud OAuth'],
|
|
86038
86416
|
['application/json'],
|
|
86039
86417
|
['application/json']
|
|
@@ -86044,16 +86422,17 @@ class WorkforceManagementApi {
|
|
|
86044
86422
|
* Create a new work plan rotation
|
|
86045
86423
|
*
|
|
86046
86424
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86047
|
-
* @param {Object}
|
|
86048
|
-
* @param {Object} opts.body body
|
|
86425
|
+
* @param {Object} body body
|
|
86049
86426
|
*/
|
|
86050
|
-
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId,
|
|
86051
|
-
opts = opts || {};
|
|
86052
|
-
|
|
86427
|
+
postWorkforcemanagementManagementunitWorkplanrotations(managementUnitId, body) {
|
|
86053
86428
|
// verify the required parameter 'managementUnitId' is set
|
|
86054
86429
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86055
86430
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
86056
86431
|
}
|
|
86432
|
+
// verify the required parameter 'body' is set
|
|
86433
|
+
if (body === undefined || body === null) {
|
|
86434
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplanrotations';
|
|
86435
|
+
}
|
|
86057
86436
|
|
|
86058
86437
|
return this.apiClient.callApi(
|
|
86059
86438
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplanrotations',
|
|
@@ -86062,7 +86441,7 @@ class WorkforceManagementApi {
|
|
|
86062
86441
|
{ },
|
|
86063
86442
|
{ },
|
|
86064
86443
|
{ },
|
|
86065
|
-
|
|
86444
|
+
body,
|
|
86066
86445
|
['PureCloud OAuth'],
|
|
86067
86446
|
['application/json'],
|
|
86068
86447
|
['application/json']
|
|
@@ -86073,17 +86452,21 @@ class WorkforceManagementApi {
|
|
|
86073
86452
|
* Create a new work plan
|
|
86074
86453
|
*
|
|
86075
86454
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
86455
|
+
* @param {Object} body body
|
|
86076
86456
|
* @param {Object} opts Optional parameters
|
|
86077
86457
|
* @param {Object} opts.validationMode Allows to create work plan even if the validation result is invalid
|
|
86078
|
-
* @param {Object} opts.body body
|
|
86079
86458
|
*/
|
|
86080
|
-
postWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
|
|
86459
|
+
postWorkforcemanagementManagementunitWorkplans(managementUnitId, body, opts) {
|
|
86081
86460
|
opts = opts || {};
|
|
86082
86461
|
|
|
86083
86462
|
// verify the required parameter 'managementUnitId' is set
|
|
86084
86463
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86085
86464
|
throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitWorkplans';
|
|
86086
86465
|
}
|
|
86466
|
+
// verify the required parameter 'body' is set
|
|
86467
|
+
if (body === undefined || body === null) {
|
|
86468
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunitWorkplans';
|
|
86469
|
+
}
|
|
86087
86470
|
|
|
86088
86471
|
return this.apiClient.callApi(
|
|
86089
86472
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
|
|
@@ -86092,7 +86475,7 @@ class WorkforceManagementApi {
|
|
|
86092
86475
|
{ 'validationMode': opts['validationMode'] },
|
|
86093
86476
|
{ },
|
|
86094
86477
|
{ },
|
|
86095
|
-
|
|
86478
|
+
body,
|
|
86096
86479
|
['PureCloud OAuth'],
|
|
86097
86480
|
['application/json'],
|
|
86098
86481
|
['application/json']
|
|
@@ -86102,12 +86485,13 @@ class WorkforceManagementApi {
|
|
|
86102
86485
|
/**
|
|
86103
86486
|
* Add a management unit
|
|
86104
86487
|
* It may take a minute or two for a new management unit to be available for api operations
|
|
86105
|
-
* @param {Object}
|
|
86106
|
-
* @param {Object} opts.body body
|
|
86488
|
+
* @param {Object} body body
|
|
86107
86489
|
*/
|
|
86108
|
-
postWorkforcemanagementManagementunits(
|
|
86109
|
-
|
|
86110
|
-
|
|
86490
|
+
postWorkforcemanagementManagementunits(body) {
|
|
86491
|
+
// verify the required parameter 'body' is set
|
|
86492
|
+
if (body === undefined || body === null) {
|
|
86493
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementManagementunits';
|
|
86494
|
+
}
|
|
86111
86495
|
|
|
86112
86496
|
return this.apiClient.callApi(
|
|
86113
86497
|
'/api/v2/workforcemanagement/managementunits',
|
|
@@ -86116,7 +86500,7 @@ class WorkforceManagementApi {
|
|
|
86116
86500
|
{ },
|
|
86117
86501
|
{ },
|
|
86118
86502
|
{ },
|
|
86119
|
-
|
|
86503
|
+
body,
|
|
86120
86504
|
['PureCloud OAuth'],
|
|
86121
86505
|
['application/json'],
|
|
86122
86506
|
['application/json']
|
|
@@ -86126,12 +86510,13 @@ class WorkforceManagementApi {
|
|
|
86126
86510
|
/**
|
|
86127
86511
|
* Mark a list of notifications as read or unread
|
|
86128
86512
|
*
|
|
86129
|
-
* @param {Object}
|
|
86130
|
-
* @param {Object} opts.body body
|
|
86513
|
+
* @param {Object} body body
|
|
86131
86514
|
*/
|
|
86132
|
-
postWorkforcemanagementNotificationsUpdate(
|
|
86133
|
-
|
|
86134
|
-
|
|
86515
|
+
postWorkforcemanagementNotificationsUpdate(body) {
|
|
86516
|
+
// verify the required parameter 'body' is set
|
|
86517
|
+
if (body === undefined || body === null) {
|
|
86518
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementNotificationsUpdate';
|
|
86519
|
+
}
|
|
86135
86520
|
|
|
86136
86521
|
return this.apiClient.callApi(
|
|
86137
86522
|
'/api/v2/workforcemanagement/notifications/update',
|
|
@@ -86140,7 +86525,7 @@ class WorkforceManagementApi {
|
|
|
86140
86525
|
{ },
|
|
86141
86526
|
{ },
|
|
86142
86527
|
{ },
|
|
86143
|
-
|
|
86528
|
+
body,
|
|
86144
86529
|
['PureCloud OAuth'],
|
|
86145
86530
|
['application/json'],
|
|
86146
86531
|
['application/json']
|
|
@@ -86176,16 +86561,17 @@ class WorkforceManagementApi {
|
|
|
86176
86561
|
* Request a teams historical adherence report
|
|
86177
86562
|
* The maximum supported range for historical adherence queries is 31 days, or 7 days with includeExceptions = true
|
|
86178
86563
|
* @param {String} teamId The ID of the team
|
|
86179
|
-
* @param {Object}
|
|
86180
|
-
* @param {Object} opts.body body
|
|
86564
|
+
* @param {Object} body body
|
|
86181
86565
|
*/
|
|
86182
|
-
postWorkforcemanagementTeamAdherenceHistorical(teamId,
|
|
86183
|
-
opts = opts || {};
|
|
86184
|
-
|
|
86566
|
+
postWorkforcemanagementTeamAdherenceHistorical(teamId, body) {
|
|
86185
86567
|
// verify the required parameter 'teamId' is set
|
|
86186
86568
|
if (teamId === undefined || teamId === null) {
|
|
86187
86569
|
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
86188
86570
|
}
|
|
86571
|
+
// verify the required parameter 'body' is set
|
|
86572
|
+
if (body === undefined || body === null) {
|
|
86573
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTeamAdherenceHistorical';
|
|
86574
|
+
}
|
|
86189
86575
|
|
|
86190
86576
|
return this.apiClient.callApi(
|
|
86191
86577
|
'/api/v2/workforcemanagement/teams/{teamId}/adherence/historical',
|
|
@@ -86194,7 +86580,7 @@ class WorkforceManagementApi {
|
|
|
86194
86580
|
{ },
|
|
86195
86581
|
{ },
|
|
86196
86582
|
{ },
|
|
86197
|
-
|
|
86583
|
+
body,
|
|
86198
86584
|
['PureCloud OAuth'],
|
|
86199
86585
|
['application/json'],
|
|
86200
86586
|
['application/json']
|
|
@@ -86205,16 +86591,17 @@ class WorkforceManagementApi {
|
|
|
86205
86591
|
* Request a historical shrinkage report
|
|
86206
86592
|
* The maximum supported range for historical shrinkage queries is up to 32 days
|
|
86207
86593
|
* @param {String} teamId The ID of the team
|
|
86208
|
-
* @param {Object}
|
|
86209
|
-
* @param {Object} opts.body body
|
|
86594
|
+
* @param {Object} body body
|
|
86210
86595
|
*/
|
|
86211
|
-
postWorkforcemanagementTeamShrinkageJobs(teamId,
|
|
86212
|
-
opts = opts || {};
|
|
86213
|
-
|
|
86596
|
+
postWorkforcemanagementTeamShrinkageJobs(teamId, body) {
|
|
86214
86597
|
// verify the required parameter 'teamId' is set
|
|
86215
86598
|
if (teamId === undefined || teamId === null) {
|
|
86216
86599
|
throw 'Missing the required parameter "teamId" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
86217
86600
|
}
|
|
86601
|
+
// verify the required parameter 'body' is set
|
|
86602
|
+
if (body === undefined || body === null) {
|
|
86603
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTeamShrinkageJobs';
|
|
86604
|
+
}
|
|
86218
86605
|
|
|
86219
86606
|
return this.apiClient.callApi(
|
|
86220
86607
|
'/api/v2/workforcemanagement/teams/{teamId}/shrinkage/jobs',
|
|
@@ -86223,7 +86610,7 @@ class WorkforceManagementApi {
|
|
|
86223
86610
|
{ },
|
|
86224
86611
|
{ },
|
|
86225
86612
|
{ },
|
|
86226
|
-
|
|
86613
|
+
body,
|
|
86227
86614
|
['PureCloud OAuth'],
|
|
86228
86615
|
['application/json'],
|
|
86229
86616
|
['application/json']
|
|
@@ -86258,12 +86645,13 @@ class WorkforceManagementApi {
|
|
|
86258
86645
|
/**
|
|
86259
86646
|
* Queries available time off for the current user
|
|
86260
86647
|
*
|
|
86261
|
-
* @param {Object}
|
|
86262
|
-
* @param {Object} opts.body body
|
|
86648
|
+
* @param {Object} body body
|
|
86263
86649
|
*/
|
|
86264
|
-
postWorkforcemanagementTimeofflimitsAvailableQuery(
|
|
86265
|
-
|
|
86266
|
-
|
|
86650
|
+
postWorkforcemanagementTimeofflimitsAvailableQuery(body) {
|
|
86651
|
+
// verify the required parameter 'body' is set
|
|
86652
|
+
if (body === undefined || body === null) {
|
|
86653
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeofflimitsAvailableQuery';
|
|
86654
|
+
}
|
|
86267
86655
|
|
|
86268
86656
|
return this.apiClient.callApi(
|
|
86269
86657
|
'/api/v2/workforcemanagement/timeofflimits/available/query',
|
|
@@ -86272,7 +86660,7 @@ class WorkforceManagementApi {
|
|
|
86272
86660
|
{ },
|
|
86273
86661
|
{ },
|
|
86274
86662
|
{ },
|
|
86275
|
-
|
|
86663
|
+
body,
|
|
86276
86664
|
['PureCloud OAuth'],
|
|
86277
86665
|
['application/json'],
|
|
86278
86666
|
['application/json']
|
|
@@ -86282,12 +86670,13 @@ class WorkforceManagementApi {
|
|
|
86282
86670
|
/**
|
|
86283
86671
|
* Create a time off request for the current user
|
|
86284
86672
|
*
|
|
86285
|
-
* @param {Object}
|
|
86286
|
-
* @param {Object} opts.body body
|
|
86673
|
+
* @param {Object} body body
|
|
86287
86674
|
*/
|
|
86288
|
-
postWorkforcemanagementTimeoffrequests(
|
|
86289
|
-
|
|
86290
|
-
|
|
86675
|
+
postWorkforcemanagementTimeoffrequests(body) {
|
|
86676
|
+
// verify the required parameter 'body' is set
|
|
86677
|
+
if (body === undefined || body === null) {
|
|
86678
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequests';
|
|
86679
|
+
}
|
|
86291
86680
|
|
|
86292
86681
|
return this.apiClient.callApi(
|
|
86293
86682
|
'/api/v2/workforcemanagement/timeoffrequests',
|
|
@@ -86296,7 +86685,7 @@ class WorkforceManagementApi {
|
|
|
86296
86685
|
{ },
|
|
86297
86686
|
{ },
|
|
86298
86687
|
{ },
|
|
86299
|
-
|
|
86688
|
+
body,
|
|
86300
86689
|
['PureCloud OAuth'],
|
|
86301
86690
|
['application/json'],
|
|
86302
86691
|
['application/json']
|
|
@@ -86306,12 +86695,13 @@ class WorkforceManagementApi {
|
|
|
86306
86695
|
/**
|
|
86307
86696
|
* Estimates available time off for current user
|
|
86308
86697
|
*
|
|
86309
|
-
* @param {Object}
|
|
86310
|
-
* @param {Object} opts.body body
|
|
86698
|
+
* @param {Object} body body
|
|
86311
86699
|
*/
|
|
86312
|
-
postWorkforcemanagementTimeoffrequestsEstimate(
|
|
86313
|
-
|
|
86314
|
-
|
|
86700
|
+
postWorkforcemanagementTimeoffrequestsEstimate(body) {
|
|
86701
|
+
// verify the required parameter 'body' is set
|
|
86702
|
+
if (body === undefined || body === null) {
|
|
86703
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsEstimate';
|
|
86704
|
+
}
|
|
86315
86705
|
|
|
86316
86706
|
return this.apiClient.callApi(
|
|
86317
86707
|
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
@@ -86320,7 +86710,7 @@ class WorkforceManagementApi {
|
|
|
86320
86710
|
{ },
|
|
86321
86711
|
{ },
|
|
86322
86712
|
{ },
|
|
86323
|
-
|
|
86713
|
+
body,
|
|
86324
86714
|
['PureCloud OAuth'],
|
|
86325
86715
|
['application/json'],
|
|
86326
86716
|
['application/json']
|
|
@@ -86330,12 +86720,13 @@ class WorkforceManagementApi {
|
|
|
86330
86720
|
/**
|
|
86331
86721
|
* Retrieves integration statuses for a list of current user time off requests
|
|
86332
86722
|
*
|
|
86333
|
-
* @param {Object}
|
|
86334
|
-
* @param {Object} opts.body body
|
|
86723
|
+
* @param {Object} body body
|
|
86335
86724
|
*/
|
|
86336
|
-
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(
|
|
86337
|
-
|
|
86338
|
-
|
|
86725
|
+
postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(body) {
|
|
86726
|
+
// verify the required parameter 'body' is set
|
|
86727
|
+
if (body === undefined || body === null) {
|
|
86728
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery';
|
|
86729
|
+
}
|
|
86339
86730
|
|
|
86340
86731
|
return this.apiClient.callApi(
|
|
86341
86732
|
'/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
|
|
@@ -86344,7 +86735,7 @@ class WorkforceManagementApi {
|
|
|
86344
86735
|
{ },
|
|
86345
86736
|
{ },
|
|
86346
86737
|
{ },
|
|
86347
|
-
|
|
86738
|
+
body,
|
|
86348
86739
|
['PureCloud OAuth'],
|
|
86349
86740
|
['application/json'],
|
|
86350
86741
|
['application/json']
|
|
@@ -86386,12 +86777,9 @@ class WorkforceManagementApi {
|
|
|
86386
86777
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time-off limit API
|
|
86387
86778
|
* @param {String} businessUnitId The ID of the business unit
|
|
86388
86779
|
* @param {String} timeOffLimitId The ID of the time-off limit object to set values for
|
|
86389
|
-
* @param {Object}
|
|
86390
|
-
* @param {Object} opts.body body
|
|
86780
|
+
* @param {Object} body body
|
|
86391
86781
|
*/
|
|
86392
|
-
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId,
|
|
86393
|
-
opts = opts || {};
|
|
86394
|
-
|
|
86782
|
+
putWorkforcemanagementBusinessunitTimeofflimitValues(businessUnitId, timeOffLimitId, body) {
|
|
86395
86783
|
// verify the required parameter 'businessUnitId' is set
|
|
86396
86784
|
if (businessUnitId === undefined || businessUnitId === null) {
|
|
86397
86785
|
throw 'Missing the required parameter "businessUnitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
@@ -86400,6 +86788,10 @@ class WorkforceManagementApi {
|
|
|
86400
86788
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
86401
86789
|
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
86402
86790
|
}
|
|
86791
|
+
// verify the required parameter 'body' is set
|
|
86792
|
+
if (body === undefined || body === null) {
|
|
86793
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementBusinessunitTimeofflimitValues';
|
|
86794
|
+
}
|
|
86403
86795
|
|
|
86404
86796
|
return this.apiClient.callApi(
|
|
86405
86797
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
@@ -86408,7 +86800,7 @@ class WorkforceManagementApi {
|
|
|
86408
86800
|
{ },
|
|
86409
86801
|
{ },
|
|
86410
86802
|
{ },
|
|
86411
|
-
|
|
86803
|
+
body,
|
|
86412
86804
|
['PureCloud OAuth'],
|
|
86413
86805
|
['application/json'],
|
|
86414
86806
|
['application/json']
|
|
@@ -86420,12 +86812,9 @@ class WorkforceManagementApi {
|
|
|
86420
86812
|
* Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
|
|
86421
86813
|
* @param {String} managementUnitId The ID of the management unit.
|
|
86422
86814
|
* @param {String} timeOffLimitId The ID of the time off limit object to set values for
|
|
86423
|
-
* @param {Object}
|
|
86424
|
-
* @param {Object} opts.body body
|
|
86815
|
+
* @param {Object} body body
|
|
86425
86816
|
*/
|
|
86426
|
-
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId,
|
|
86427
|
-
opts = opts || {};
|
|
86428
|
-
|
|
86817
|
+
putWorkforcemanagementManagementunitTimeofflimitValues(managementUnitId, timeOffLimitId, body) {
|
|
86429
86818
|
// verify the required parameter 'managementUnitId' is set
|
|
86430
86819
|
if (managementUnitId === undefined || managementUnitId === null) {
|
|
86431
86820
|
throw 'Missing the required parameter "managementUnitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
@@ -86434,6 +86823,10 @@ class WorkforceManagementApi {
|
|
|
86434
86823
|
if (timeOffLimitId === undefined || timeOffLimitId === null) {
|
|
86435
86824
|
throw 'Missing the required parameter "timeOffLimitId" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
86436
86825
|
}
|
|
86826
|
+
// verify the required parameter 'body' is set
|
|
86827
|
+
if (body === undefined || body === null) {
|
|
86828
|
+
throw 'Missing the required parameter "body" when calling putWorkforcemanagementManagementunitTimeofflimitValues';
|
|
86829
|
+
}
|
|
86437
86830
|
|
|
86438
86831
|
return this.apiClient.callApi(
|
|
86439
86832
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeofflimits/{timeOffLimitId}/values',
|
|
@@ -86442,7 +86835,7 @@ class WorkforceManagementApi {
|
|
|
86442
86835
|
{ },
|
|
86443
86836
|
{ },
|
|
86444
86837
|
{ },
|
|
86445
|
-
|
|
86838
|
+
body,
|
|
86446
86839
|
['PureCloud OAuth'],
|
|
86447
86840
|
['application/json'],
|
|
86448
86841
|
['application/json']
|
|
@@ -86480,7 +86873,7 @@ class WorkforceManagementApi {
|
|
|
86480
86873
|
* </pre>
|
|
86481
86874
|
* </p>
|
|
86482
86875
|
* @module purecloud-platform-client-v2/index
|
|
86483
|
-
* @version
|
|
86876
|
+
* @version 223.0.0
|
|
86484
86877
|
*/
|
|
86485
86878
|
class platformClient {
|
|
86486
86879
|
constructor() {
|