purecloud-platform-client-v2 252.0.0 → 253.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 +916 -345
- package/dist/web-amd/purecloud-platform-client-v2.js +916 -345
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +338 -179
- package/dist/web-cjs/purecloud-platform-client-v2.js +338 -179
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +632 -102
- package/package.json +5 -5
- package/src/purecloud-platform-client-v2/ApiClient.js +9 -6
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +6 -6
- 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 +3 -2
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/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 +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -7
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +42 -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 +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +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 +179 -156
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -47
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +472 -39
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -748,7 +748,7 @@ class Configuration {
|
|
|
748
748
|
|
|
749
749
|
/**
|
|
750
750
|
* @module purecloud-platform-client-v2/ApiClient
|
|
751
|
-
* @version
|
|
751
|
+
* @version 253.0.0
|
|
752
752
|
*/
|
|
753
753
|
class ApiClient {
|
|
754
754
|
/**
|
|
@@ -1422,9 +1422,12 @@ class ApiClient {
|
|
|
1422
1422
|
// Get access token from response
|
|
1423
1423
|
var access_token = response.data.access_token;
|
|
1424
1424
|
|
|
1425
|
-
|
|
1426
|
-
|
|
1427
|
-
|
|
1425
|
+
let optsSettings = { accessToken: access_token };
|
|
1426
|
+
if (response.data['expires_in'] !== null && response.data['expires_in'] !== undefined) {
|
|
1427
|
+
optsSettings.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
|
|
1428
|
+
optsSettings.tokenExpiryTimeString = new Date(optsSettings.tokenExpiryTime).toUTCString();
|
|
1429
|
+
}
|
|
1430
|
+
this._saveSettings(optsSettings);
|
|
1428
1431
|
|
|
1429
1432
|
// Return auth data
|
|
1430
1433
|
resolve(this.authData);
|
|
@@ -1548,9 +1551,9 @@ class ApiClient {
|
|
|
1548
1551
|
return new Promise((resolve, reject) => {
|
|
1549
1552
|
// Abort if org and provider are not set together
|
|
1550
1553
|
if (opts.org && !opts.provider) {
|
|
1551
|
-
reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1554
|
+
return reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1552
1555
|
} else if (opts.provider && !opts.org) {
|
|
1553
|
-
reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1556
|
+
return reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1554
1557
|
}
|
|
1555
1558
|
|
|
1556
1559
|
// Abort on auth error
|
|
@@ -2436,7 +2439,7 @@ class AIStudioApi {
|
|
|
2436
2439
|
/**
|
|
2437
2440
|
* AIStudio service.
|
|
2438
2441
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2439
|
-
* @version
|
|
2442
|
+
* @version 253.0.0
|
|
2440
2443
|
*/
|
|
2441
2444
|
|
|
2442
2445
|
/**
|
|
@@ -2545,12 +2548,12 @@ class AIStudioApi {
|
|
|
2545
2548
|
* Get all summary settings.
|
|
2546
2549
|
*
|
|
2547
2550
|
* @param {Object} opts Optional parameters
|
|
2548
|
-
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2549
|
-
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2550
|
-
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2551
|
-
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2552
2551
|
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2553
2552
|
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2553
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2554
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2555
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2556
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2554
2557
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2555
2558
|
*/
|
|
2556
2559
|
getConversationsSummariesSettings(opts) {
|
|
@@ -2561,7 +2564,7 @@ class AIStudioApi {
|
|
|
2561
2564
|
'/api/v2/conversations/summaries/settings',
|
|
2562
2565
|
'GET',
|
|
2563
2566
|
{ },
|
|
2564
|
-
{ '
|
|
2567
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'],'sortOrder': opts['sortOrder'],'language': opts['language'],'sortBy': opts['sortBy'] },
|
|
2565
2568
|
{ },
|
|
2566
2569
|
{ },
|
|
2567
2570
|
null,
|
|
@@ -3151,7 +3154,7 @@ class AgentAssistantsApi {
|
|
|
3151
3154
|
/**
|
|
3152
3155
|
* AgentAssistants service.
|
|
3153
3156
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3154
|
-
* @version
|
|
3157
|
+
* @version 253.0.0
|
|
3155
3158
|
*/
|
|
3156
3159
|
|
|
3157
3160
|
/**
|
|
@@ -3507,6 +3510,7 @@ class AgentAssistantsApi {
|
|
|
3507
3510
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
3508
3511
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
3509
3512
|
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
3513
|
+
* @param {Array.<String>} opts.agentChecklistIds Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
|
|
3510
3514
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3511
3515
|
*/
|
|
3512
3516
|
getAssistantsAgentchecklists(opts) {
|
|
@@ -3517,7 +3521,7 @@ class AgentAssistantsApi {
|
|
|
3517
3521
|
'/api/v2/assistants/agentchecklists',
|
|
3518
3522
|
'GET',
|
|
3519
3523
|
{ },
|
|
3520
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
3524
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'agentChecklistIds': this.apiClient.buildCollectionParam(opts['agentChecklistIds'], 'multi') },
|
|
3521
3525
|
{ },
|
|
3522
3526
|
{ },
|
|
3523
3527
|
null,
|
|
@@ -3955,7 +3959,7 @@ class AgentCopilotApi {
|
|
|
3955
3959
|
/**
|
|
3956
3960
|
* AgentCopilot service.
|
|
3957
3961
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3958
|
-
* @version
|
|
3962
|
+
* @version 253.0.0
|
|
3959
3963
|
*/
|
|
3960
3964
|
|
|
3961
3965
|
/**
|
|
@@ -4067,7 +4071,7 @@ class AgentUIApi {
|
|
|
4067
4071
|
/**
|
|
4068
4072
|
* AgentUI service.
|
|
4069
4073
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4070
|
-
* @version
|
|
4074
|
+
* @version 253.0.0
|
|
4071
4075
|
*/
|
|
4072
4076
|
|
|
4073
4077
|
/**
|
|
@@ -4218,7 +4222,7 @@ class AlertingApi {
|
|
|
4218
4222
|
/**
|
|
4219
4223
|
* Alerting service.
|
|
4220
4224
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4221
|
-
* @version
|
|
4225
|
+
* @version 253.0.0
|
|
4222
4226
|
*/
|
|
4223
4227
|
|
|
4224
4228
|
/**
|
|
@@ -4679,7 +4683,7 @@ class AnalyticsApi {
|
|
|
4679
4683
|
/**
|
|
4680
4684
|
* Analytics service.
|
|
4681
4685
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4682
|
-
* @version
|
|
4686
|
+
* @version 253.0.0
|
|
4683
4687
|
*/
|
|
4684
4688
|
|
|
4685
4689
|
/**
|
|
@@ -8965,7 +8969,7 @@ class ArchitectApi {
|
|
|
8965
8969
|
/**
|
|
8966
8970
|
* Architect service.
|
|
8967
8971
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8968
|
-
* @version
|
|
8972
|
+
* @version 253.0.0
|
|
8969
8973
|
*/
|
|
8970
8974
|
|
|
8971
8975
|
/**
|
|
@@ -13219,6 +13223,7 @@ class ArchitectApi {
|
|
|
13219
13223
|
* Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
|
|
13220
13224
|
*
|
|
13221
13225
|
* @param {Object} opts Optional parameters
|
|
13226
|
+
* @param {Object} opts.body
|
|
13222
13227
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13223
13228
|
*/
|
|
13224
13229
|
postFlowsJobs(opts) {
|
|
@@ -13232,7 +13237,7 @@ class ArchitectApi {
|
|
|
13232
13237
|
{ },
|
|
13233
13238
|
{ },
|
|
13234
13239
|
{ },
|
|
13235
|
-
|
|
13240
|
+
opts['body'],
|
|
13236
13241
|
['PureCloud OAuth'],
|
|
13237
13242
|
['application/json'],
|
|
13238
13243
|
['application/json'],
|
|
@@ -13824,7 +13829,7 @@ class AssistantCopilotVariationsApi {
|
|
|
13824
13829
|
/**
|
|
13825
13830
|
* AssistantCopilotVariations service.
|
|
13826
13831
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13827
|
-
* @version
|
|
13832
|
+
* @version 253.0.0
|
|
13828
13833
|
*/
|
|
13829
13834
|
|
|
13830
13835
|
/**
|
|
@@ -14020,7 +14025,7 @@ class AuditApi {
|
|
|
14020
14025
|
/**
|
|
14021
14026
|
* Audit service.
|
|
14022
14027
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14023
|
-
* @version
|
|
14028
|
+
* @version 253.0.0
|
|
14024
14029
|
*/
|
|
14025
14030
|
|
|
14026
14031
|
/**
|
|
@@ -14247,7 +14252,7 @@ class AuthorizationApi {
|
|
|
14247
14252
|
/**
|
|
14248
14253
|
* Authorization service.
|
|
14249
14254
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14250
|
-
* @version
|
|
14255
|
+
* @version 253.0.0
|
|
14251
14256
|
*/
|
|
14252
14257
|
|
|
14253
14258
|
/**
|
|
@@ -16172,7 +16177,7 @@ class BackgroundAssistantApi {
|
|
|
16172
16177
|
/**
|
|
16173
16178
|
* BackgroundAssistant service.
|
|
16174
16179
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16175
|
-
* @version
|
|
16180
|
+
* @version 253.0.0
|
|
16176
16181
|
*/
|
|
16177
16182
|
|
|
16178
16183
|
/**
|
|
@@ -16246,7 +16251,7 @@ class BillingApi {
|
|
|
16246
16251
|
/**
|
|
16247
16252
|
* Billing service.
|
|
16248
16253
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16249
|
-
* @version
|
|
16254
|
+
* @version 253.0.0
|
|
16250
16255
|
*/
|
|
16251
16256
|
|
|
16252
16257
|
/**
|
|
@@ -16530,7 +16535,7 @@ class BusinessRulesApi {
|
|
|
16530
16535
|
/**
|
|
16531
16536
|
* BusinessRules service.
|
|
16532
16537
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16533
|
-
* @version
|
|
16538
|
+
* @version 253.0.0
|
|
16534
16539
|
*/
|
|
16535
16540
|
|
|
16536
16541
|
/**
|
|
@@ -17544,7 +17549,7 @@ class CarrierServicesApi {
|
|
|
17544
17549
|
/**
|
|
17545
17550
|
* CarrierServices service.
|
|
17546
17551
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17547
|
-
* @version
|
|
17552
|
+
* @version 253.0.0
|
|
17548
17553
|
*/
|
|
17549
17554
|
|
|
17550
17555
|
/**
|
|
@@ -17621,7 +17626,7 @@ class CaseManagementApi {
|
|
|
17621
17626
|
/**
|
|
17622
17627
|
* CaseManagement service.
|
|
17623
17628
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17624
|
-
* @version
|
|
17629
|
+
* @version 253.0.0
|
|
17625
17630
|
*/
|
|
17626
17631
|
|
|
17627
17632
|
/**
|
|
@@ -18914,7 +18919,7 @@ class ChatApi {
|
|
|
18914
18919
|
/**
|
|
18915
18920
|
* Chat service.
|
|
18916
18921
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18917
|
-
* @version
|
|
18922
|
+
* @version 253.0.0
|
|
18918
18923
|
*/
|
|
18919
18924
|
|
|
18920
18925
|
/**
|
|
@@ -20053,7 +20058,7 @@ class CoachingApi {
|
|
|
20053
20058
|
/**
|
|
20054
20059
|
* Coaching service.
|
|
20055
20060
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
20056
|
-
* @version
|
|
20061
|
+
* @version 253.0.0
|
|
20057
20062
|
*/
|
|
20058
20063
|
|
|
20059
20064
|
/**
|
|
@@ -20767,7 +20772,7 @@ class ContentManagementApi {
|
|
|
20767
20772
|
/**
|
|
20768
20773
|
* ContentManagement service.
|
|
20769
20774
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20770
|
-
* @version
|
|
20775
|
+
* @version 253.0.0
|
|
20771
20776
|
*/
|
|
20772
20777
|
|
|
20773
20778
|
/**
|
|
@@ -21962,7 +21967,7 @@ class ConversationsApi {
|
|
|
21962
21967
|
/**
|
|
21963
21968
|
* Conversations service.
|
|
21964
21969
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21965
|
-
* @version
|
|
21970
|
+
* @version 253.0.0
|
|
21966
21971
|
*/
|
|
21967
21972
|
|
|
21968
21973
|
/**
|
|
@@ -33068,7 +33073,7 @@ class DataExtensionsApi {
|
|
|
33068
33073
|
/**
|
|
33069
33074
|
* DataExtensions service.
|
|
33070
33075
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
33071
|
-
* @version
|
|
33076
|
+
* @version 253.0.0
|
|
33072
33077
|
*/
|
|
33073
33078
|
|
|
33074
33079
|
/**
|
|
@@ -33169,7 +33174,7 @@ class DataPrivacyApi {
|
|
|
33169
33174
|
/**
|
|
33170
33175
|
* DataPrivacy service.
|
|
33171
33176
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33172
|
-
* @version
|
|
33177
|
+
* @version 253.0.0
|
|
33173
33178
|
*/
|
|
33174
33179
|
|
|
33175
33180
|
/**
|
|
@@ -33366,7 +33371,7 @@ class DownloadsApi {
|
|
|
33366
33371
|
/**
|
|
33367
33372
|
* Downloads service.
|
|
33368
33373
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33369
|
-
* @version
|
|
33374
|
+
* @version 253.0.0
|
|
33370
33375
|
*/
|
|
33371
33376
|
|
|
33372
33377
|
/**
|
|
@@ -33420,7 +33425,7 @@ class EmailsApi {
|
|
|
33420
33425
|
/**
|
|
33421
33426
|
* Emails service.
|
|
33422
33427
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33423
|
-
* @version
|
|
33428
|
+
* @version 253.0.0
|
|
33424
33429
|
*/
|
|
33425
33430
|
|
|
33426
33431
|
/**
|
|
@@ -33568,7 +33573,7 @@ class EmployeeEngagementApi {
|
|
|
33568
33573
|
/**
|
|
33569
33574
|
* EmployeeEngagement service.
|
|
33570
33575
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33571
|
-
* @version
|
|
33576
|
+
* @version 253.0.0
|
|
33572
33577
|
*/
|
|
33573
33578
|
|
|
33574
33579
|
/**
|
|
@@ -33772,7 +33777,7 @@ class EventsApi {
|
|
|
33772
33777
|
/**
|
|
33773
33778
|
* Events service.
|
|
33774
33779
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33775
|
-
* @version
|
|
33780
|
+
* @version 253.0.0
|
|
33776
33781
|
*/
|
|
33777
33782
|
|
|
33778
33783
|
/**
|
|
@@ -33914,7 +33919,7 @@ class ExternalContactsApi {
|
|
|
33914
33919
|
/**
|
|
33915
33920
|
* ExternalContacts service.
|
|
33916
33921
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33917
|
-
* @version
|
|
33922
|
+
* @version 253.0.0
|
|
33918
33923
|
*/
|
|
33919
33924
|
|
|
33920
33925
|
/**
|
|
@@ -37685,7 +37690,7 @@ class FaxApi {
|
|
|
37685
37690
|
/**
|
|
37686
37691
|
* Fax service.
|
|
37687
37692
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37688
|
-
* @version
|
|
37693
|
+
* @version 253.0.0
|
|
37689
37694
|
*/
|
|
37690
37695
|
|
|
37691
37696
|
/**
|
|
@@ -37934,7 +37939,7 @@ class FlowsApi {
|
|
|
37934
37939
|
/**
|
|
37935
37940
|
* Flows service.
|
|
37936
37941
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37937
|
-
* @version
|
|
37942
|
+
* @version 253.0.0
|
|
37938
37943
|
*/
|
|
37939
37944
|
|
|
37940
37945
|
/**
|
|
@@ -38172,7 +38177,7 @@ class GamificationApi {
|
|
|
38172
38177
|
/**
|
|
38173
38178
|
* Gamification service.
|
|
38174
38179
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38175
|
-
* @version
|
|
38180
|
+
* @version 253.0.0
|
|
38176
38181
|
*/
|
|
38177
38182
|
|
|
38178
38183
|
/**
|
|
@@ -41024,7 +41029,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
41024
41029
|
/**
|
|
41025
41030
|
* GeneralDataProtectionRegulation service.
|
|
41026
41031
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
41027
|
-
* @version
|
|
41032
|
+
* @version 253.0.0
|
|
41028
41033
|
*/
|
|
41029
41034
|
|
|
41030
41035
|
/**
|
|
@@ -41168,7 +41173,7 @@ class GeolocationApi {
|
|
|
41168
41173
|
/**
|
|
41169
41174
|
* Geolocation service.
|
|
41170
41175
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
41171
|
-
* @version
|
|
41176
|
+
* @version 253.0.0
|
|
41172
41177
|
*/
|
|
41173
41178
|
|
|
41174
41179
|
/**
|
|
@@ -41319,7 +41324,7 @@ class GreetingsApi {
|
|
|
41319
41324
|
/**
|
|
41320
41325
|
* Greetings service.
|
|
41321
41326
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41322
|
-
* @version
|
|
41327
|
+
* @version 253.0.0
|
|
41323
41328
|
*/
|
|
41324
41329
|
|
|
41325
41330
|
/**
|
|
@@ -41935,7 +41940,7 @@ class GroupsApi {
|
|
|
41935
41940
|
/**
|
|
41936
41941
|
* Groups service.
|
|
41937
41942
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41938
|
-
* @version
|
|
41943
|
+
* @version 253.0.0
|
|
41939
41944
|
*/
|
|
41940
41945
|
|
|
41941
41946
|
/**
|
|
@@ -42526,7 +42531,7 @@ class IdentityProviderApi {
|
|
|
42526
42531
|
/**
|
|
42527
42532
|
* IdentityProvider service.
|
|
42528
42533
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
42529
|
-
* @version
|
|
42534
|
+
* @version 253.0.0
|
|
42530
42535
|
*/
|
|
42531
42536
|
|
|
42532
42537
|
/**
|
|
@@ -43577,7 +43582,7 @@ class InfrastructureAsCodeApi {
|
|
|
43577
43582
|
/**
|
|
43578
43583
|
* InfrastructureAsCode service.
|
|
43579
43584
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43580
|
-
* @version
|
|
43585
|
+
* @version 253.0.0
|
|
43581
43586
|
*/
|
|
43582
43587
|
|
|
43583
43588
|
/**
|
|
@@ -43757,7 +43762,7 @@ class IntegrationsApi {
|
|
|
43757
43762
|
/**
|
|
43758
43763
|
* Integrations service.
|
|
43759
43764
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43760
|
-
* @version
|
|
43765
|
+
* @version 253.0.0
|
|
43761
43766
|
*/
|
|
43762
43767
|
|
|
43763
43768
|
/**
|
|
@@ -46729,7 +46734,7 @@ class IntentsApi {
|
|
|
46729
46734
|
/**
|
|
46730
46735
|
* Intents service.
|
|
46731
46736
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46732
|
-
* @version
|
|
46737
|
+
* @version 253.0.0
|
|
46733
46738
|
*/
|
|
46734
46739
|
|
|
46735
46740
|
/**
|
|
@@ -47261,7 +47266,7 @@ class JourneyApi {
|
|
|
47261
47266
|
/**
|
|
47262
47267
|
* Journey service.
|
|
47263
47268
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47264
|
-
* @version
|
|
47269
|
+
* @version 253.0.0
|
|
47265
47270
|
*/
|
|
47266
47271
|
|
|
47267
47272
|
/**
|
|
@@ -47834,11 +47839,12 @@ class JourneyApi {
|
|
|
47834
47839
|
}
|
|
47835
47840
|
|
|
47836
47841
|
/**
|
|
47837
|
-
* Retrieve a single action target.
|
|
47838
|
-
*
|
|
47842
|
+
* Deprecated. Retrieve a single action target.
|
|
47843
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
47839
47844
|
* @param {String} actionTargetId ID of the action target.
|
|
47840
47845
|
* @param {Object} opts Optional parameters
|
|
47841
47846
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47847
|
+
* @deprecated
|
|
47842
47848
|
*/
|
|
47843
47849
|
getJourneyActiontarget(actionTargetId, opts) {
|
|
47844
47850
|
opts = opts || {};
|
|
@@ -47864,12 +47870,13 @@ class JourneyApi {
|
|
|
47864
47870
|
}
|
|
47865
47871
|
|
|
47866
47872
|
/**
|
|
47867
|
-
* Retrieve all action targets.
|
|
47868
|
-
*
|
|
47873
|
+
* Deprecated. Retrieve all action targets.
|
|
47874
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
47869
47875
|
* @param {Object} opts Optional parameters
|
|
47870
47876
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47871
47877
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47872
47878
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47879
|
+
* @deprecated
|
|
47873
47880
|
*/
|
|
47874
47881
|
getJourneyActiontargets(opts) {
|
|
47875
47882
|
opts = opts || {};
|
|
@@ -49039,6 +49046,56 @@ class JourneyApi {
|
|
|
49039
49046
|
);
|
|
49040
49047
|
}
|
|
49041
49048
|
|
|
49049
|
+
/**
|
|
49050
|
+
* Get external events for journey views
|
|
49051
|
+
*
|
|
49052
|
+
* @param {Object} opts Optional parameters
|
|
49053
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49054
|
+
*/
|
|
49055
|
+
getJourneyViewsEventdefinitionsExternal(opts) {
|
|
49056
|
+
opts = opts || {};
|
|
49057
|
+
|
|
49058
|
+
|
|
49059
|
+
return this.apiClient.callApi(
|
|
49060
|
+
'/api/v2/journey/views/eventdefinitions/external',
|
|
49061
|
+
'GET',
|
|
49062
|
+
{ },
|
|
49063
|
+
{ },
|
|
49064
|
+
{ },
|
|
49065
|
+
{ },
|
|
49066
|
+
null,
|
|
49067
|
+
['PureCloud OAuth'],
|
|
49068
|
+
['application/json'],
|
|
49069
|
+
['application/json'],
|
|
49070
|
+
opts['customHeaders']
|
|
49071
|
+
);
|
|
49072
|
+
}
|
|
49073
|
+
|
|
49074
|
+
/**
|
|
49075
|
+
* Get changes in external event definitions
|
|
49076
|
+
*
|
|
49077
|
+
* @param {Object} opts Optional parameters
|
|
49078
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49079
|
+
*/
|
|
49080
|
+
getJourneyViewsEventdefinitionsExternalChanges(opts) {
|
|
49081
|
+
opts = opts || {};
|
|
49082
|
+
|
|
49083
|
+
|
|
49084
|
+
return this.apiClient.callApi(
|
|
49085
|
+
'/api/v2/journey/views/eventdefinitions/external/changes',
|
|
49086
|
+
'GET',
|
|
49087
|
+
{ },
|
|
49088
|
+
{ },
|
|
49089
|
+
{ },
|
|
49090
|
+
{ },
|
|
49091
|
+
null,
|
|
49092
|
+
['PureCloud OAuth'],
|
|
49093
|
+
['application/json'],
|
|
49094
|
+
['application/json'],
|
|
49095
|
+
opts['customHeaders']
|
|
49096
|
+
);
|
|
49097
|
+
}
|
|
49098
|
+
|
|
49042
49099
|
/**
|
|
49043
49100
|
* Get the jobs for an organization.
|
|
49044
49101
|
*
|
|
@@ -49156,12 +49213,13 @@ class JourneyApi {
|
|
|
49156
49213
|
}
|
|
49157
49214
|
|
|
49158
49215
|
/**
|
|
49159
|
-
* Update a single action target.
|
|
49160
|
-
*
|
|
49216
|
+
* Deprecated. Update a single action target.
|
|
49217
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
49161
49218
|
* @param {String} actionTargetId ID of the action target.
|
|
49162
49219
|
* @param {Object} opts Optional parameters
|
|
49163
49220
|
* @param {Object} opts.body
|
|
49164
49221
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49222
|
+
* @deprecated
|
|
49165
49223
|
*/
|
|
49166
49224
|
patchJourneyActiontarget(actionTargetId, opts) {
|
|
49167
49225
|
opts = opts || {};
|
|
@@ -50120,13 +50178,75 @@ class JourneyApi {
|
|
|
50120
50178
|
);
|
|
50121
50179
|
}
|
|
50122
50180
|
|
|
50181
|
+
/**
|
|
50182
|
+
* Update external event for journey views
|
|
50183
|
+
*
|
|
50184
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
50185
|
+
* @param {Object} opts Optional parameters
|
|
50186
|
+
* @param {Object} opts.body
|
|
50187
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50188
|
+
*/
|
|
50189
|
+
putJourneyViewsEventdefinition(eventDefinitionId, opts) {
|
|
50190
|
+
opts = opts || {};
|
|
50191
|
+
|
|
50192
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
50193
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
50194
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';
|
|
50195
|
+
}
|
|
50196
|
+
|
|
50197
|
+
return this.apiClient.callApi(
|
|
50198
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
50199
|
+
'PUT',
|
|
50200
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
50201
|
+
{ },
|
|
50202
|
+
{ },
|
|
50203
|
+
{ },
|
|
50204
|
+
opts['body'],
|
|
50205
|
+
['PureCloud OAuth'],
|
|
50206
|
+
['application/json'],
|
|
50207
|
+
['application/json'],
|
|
50208
|
+
opts['customHeaders']
|
|
50209
|
+
);
|
|
50210
|
+
}
|
|
50211
|
+
|
|
50212
|
+
/**
|
|
50213
|
+
* Activate external event for journey views
|
|
50214
|
+
*
|
|
50215
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
50216
|
+
* @param {Object} opts Optional parameters
|
|
50217
|
+
* @param {Object} opts.body
|
|
50218
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50219
|
+
*/
|
|
50220
|
+
putJourneyViewsEventdefinitionActivate(eventDefinitionId, opts) {
|
|
50221
|
+
opts = opts || {};
|
|
50222
|
+
|
|
50223
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
50224
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
50225
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';
|
|
50226
|
+
}
|
|
50227
|
+
|
|
50228
|
+
return this.apiClient.callApi(
|
|
50229
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate',
|
|
50230
|
+
'PUT',
|
|
50231
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
50232
|
+
{ },
|
|
50233
|
+
{ },
|
|
50234
|
+
{ },
|
|
50235
|
+
opts['body'],
|
|
50236
|
+
['PureCloud OAuth'],
|
|
50237
|
+
['application/json'],
|
|
50238
|
+
['application/json'],
|
|
50239
|
+
opts['customHeaders']
|
|
50240
|
+
);
|
|
50241
|
+
}
|
|
50242
|
+
|
|
50123
50243
|
}
|
|
50124
50244
|
|
|
50125
50245
|
class KnowledgeApi {
|
|
50126
50246
|
/**
|
|
50127
50247
|
* Knowledge service.
|
|
50128
50248
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
50129
|
-
* @version
|
|
50249
|
+
* @version 253.0.0
|
|
50130
50250
|
*/
|
|
50131
50251
|
|
|
50132
50252
|
/**
|
|
@@ -51325,6 +51445,47 @@ class KnowledgeApi {
|
|
|
51325
51445
|
);
|
|
51326
51446
|
}
|
|
51327
51447
|
|
|
51448
|
+
/**
|
|
51449
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
51450
|
+
*
|
|
51451
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
51452
|
+
* @param {Object} opts Optional parameters
|
|
51453
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
51454
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
51455
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
51456
|
+
* @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
|
|
51457
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
51458
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
51459
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
51460
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
51461
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
51462
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
51463
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
51464
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
51465
|
+
*/
|
|
51466
|
+
getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId, opts) {
|
|
51467
|
+
opts = opts || {};
|
|
51468
|
+
|
|
51469
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
51470
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
51471
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentsFeedback';
|
|
51472
|
+
}
|
|
51473
|
+
|
|
51474
|
+
return this.apiClient.callApi(
|
|
51475
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback',
|
|
51476
|
+
'GET',
|
|
51477
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
51478
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'onlyCommented': opts['onlyCommented'],'documentVersionId': opts['documentVersionId'],'documentVariationId': opts['documentVariationId'],'appType': opts['appType'],'queryType': opts['queryType'],'userId': opts['userId'],'queueId': opts['queueId'],'state': opts['state'] },
|
|
51479
|
+
{ },
|
|
51480
|
+
{ },
|
|
51481
|
+
null,
|
|
51482
|
+
['PureCloud OAuth'],
|
|
51483
|
+
['application/json'],
|
|
51484
|
+
['application/json'],
|
|
51485
|
+
opts['customHeaders']
|
|
51486
|
+
);
|
|
51487
|
+
}
|
|
51488
|
+
|
|
51328
51489
|
/**
|
|
51329
51490
|
* Get export job report
|
|
51330
51491
|
*
|
|
@@ -54336,7 +54497,7 @@ class LanguageUnderstandingApi {
|
|
|
54336
54497
|
/**
|
|
54337
54498
|
* LanguageUnderstanding service.
|
|
54338
54499
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
54339
|
-
* @version
|
|
54500
|
+
* @version 253.0.0
|
|
54340
54501
|
*/
|
|
54341
54502
|
|
|
54342
54503
|
/**
|
|
@@ -55710,7 +55871,7 @@ class LanguagesApi {
|
|
|
55710
55871
|
/**
|
|
55711
55872
|
* Languages service.
|
|
55712
55873
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
55713
|
-
* @version
|
|
55874
|
+
* @version 253.0.0
|
|
55714
55875
|
*/
|
|
55715
55876
|
|
|
55716
55877
|
/**
|
|
@@ -55969,7 +56130,7 @@ class LearningApi {
|
|
|
55969
56130
|
/**
|
|
55970
56131
|
* Learning service.
|
|
55971
56132
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
55972
|
-
* @version
|
|
56133
|
+
* @version 253.0.0
|
|
55973
56134
|
*/
|
|
55974
56135
|
|
|
55975
56136
|
/**
|
|
@@ -57217,7 +57378,7 @@ class LicenseApi {
|
|
|
57217
57378
|
/**
|
|
57218
57379
|
* License service.
|
|
57219
57380
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57220
|
-
* @version
|
|
57381
|
+
* @version 253.0.0
|
|
57221
57382
|
*/
|
|
57222
57383
|
|
|
57223
57384
|
/**
|
|
@@ -57515,7 +57676,7 @@ class LocationsApi {
|
|
|
57515
57676
|
/**
|
|
57516
57677
|
* Locations service.
|
|
57517
57678
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
57518
|
-
* @version
|
|
57679
|
+
* @version 253.0.0
|
|
57519
57680
|
*/
|
|
57520
57681
|
|
|
57521
57682
|
/**
|
|
@@ -57782,7 +57943,7 @@ class LogCaptureApi {
|
|
|
57782
57943
|
/**
|
|
57783
57944
|
* LogCapture service.
|
|
57784
57945
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
57785
|
-
* @version
|
|
57946
|
+
* @version 253.0.0
|
|
57786
57947
|
*/
|
|
57787
57948
|
|
|
57788
57949
|
/**
|
|
@@ -58004,7 +58165,7 @@ class MessagingApi {
|
|
|
58004
58165
|
/**
|
|
58005
58166
|
* Messaging service.
|
|
58006
58167
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
58007
|
-
* @version
|
|
58168
|
+
* @version 253.0.0
|
|
58008
58169
|
*/
|
|
58009
58170
|
|
|
58010
58171
|
/**
|
|
@@ -58422,7 +58583,7 @@ class MobileDevicesApi {
|
|
|
58422
58583
|
/**
|
|
58423
58584
|
* MobileDevices service.
|
|
58424
58585
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
58425
|
-
* @version
|
|
58586
|
+
* @version 253.0.0
|
|
58426
58587
|
*/
|
|
58427
58588
|
|
|
58428
58589
|
/**
|
|
@@ -58592,7 +58753,7 @@ class NotificationsApi {
|
|
|
58592
58753
|
/**
|
|
58593
58754
|
* Notifications service.
|
|
58594
58755
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
58595
|
-
* @version
|
|
58756
|
+
* @version 253.0.0
|
|
58596
58757
|
*/
|
|
58597
58758
|
|
|
58598
58759
|
/**
|
|
@@ -58853,7 +59014,7 @@ class OAuthApi {
|
|
|
58853
59014
|
/**
|
|
58854
59015
|
* OAuth service.
|
|
58855
59016
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
58856
|
-
* @version
|
|
59017
|
+
* @version 253.0.0
|
|
58857
59018
|
*/
|
|
58858
59019
|
|
|
58859
59020
|
/**
|
|
@@ -59269,7 +59430,7 @@ class ObjectsApi {
|
|
|
59269
59430
|
/**
|
|
59270
59431
|
* Objects service.
|
|
59271
59432
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59272
|
-
* @version
|
|
59433
|
+
* @version 253.0.0
|
|
59273
59434
|
*/
|
|
59274
59435
|
|
|
59275
59436
|
/**
|
|
@@ -59633,7 +59794,7 @@ class OperationalEventsApi {
|
|
|
59633
59794
|
/**
|
|
59634
59795
|
* OperationalEvents service.
|
|
59635
59796
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
59636
|
-
* @version
|
|
59797
|
+
* @version 253.0.0
|
|
59637
59798
|
*/
|
|
59638
59799
|
|
|
59639
59800
|
/**
|
|
@@ -59764,7 +59925,7 @@ class OrganizationApi {
|
|
|
59764
59925
|
/**
|
|
59765
59926
|
* Organization service.
|
|
59766
59927
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
59767
|
-
* @version
|
|
59928
|
+
* @version 253.0.0
|
|
59768
59929
|
*/
|
|
59769
59930
|
|
|
59770
59931
|
/**
|
|
@@ -60325,7 +60486,7 @@ class OrganizationAuthorizationApi {
|
|
|
60325
60486
|
/**
|
|
60326
60487
|
* OrganizationAuthorization service.
|
|
60327
60488
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60328
|
-
* @version
|
|
60489
|
+
* @version 253.0.0
|
|
60329
60490
|
*/
|
|
60330
60491
|
|
|
60331
60492
|
/**
|
|
@@ -61929,7 +62090,7 @@ class OutboundApi {
|
|
|
61929
62090
|
/**
|
|
61930
62091
|
* Outbound service.
|
|
61931
62092
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
61932
|
-
* @version
|
|
62093
|
+
* @version 253.0.0
|
|
61933
62094
|
*/
|
|
61934
62095
|
|
|
61935
62096
|
/**
|
|
@@ -67516,7 +67677,7 @@ class PresenceApi {
|
|
|
67516
67677
|
/**
|
|
67517
67678
|
* Presence service.
|
|
67518
67679
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
67519
|
-
* @version
|
|
67680
|
+
* @version 253.0.0
|
|
67520
67681
|
*/
|
|
67521
67682
|
|
|
67522
67683
|
/**
|
|
@@ -68374,7 +68535,7 @@ class ProcessAutomationApi {
|
|
|
68374
68535
|
/**
|
|
68375
68536
|
* ProcessAutomation service.
|
|
68376
68537
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
68377
|
-
* @version
|
|
68538
|
+
* @version 253.0.0
|
|
68378
68539
|
*/
|
|
68379
68540
|
|
|
68380
68541
|
/**
|
|
@@ -68795,7 +68956,7 @@ class QualityApi {
|
|
|
68795
68956
|
/**
|
|
68796
68957
|
* Quality service.
|
|
68797
68958
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
68798
|
-
* @version
|
|
68959
|
+
* @version 253.0.0
|
|
68799
68960
|
*/
|
|
68800
68961
|
|
|
68801
68962
|
/**
|
|
@@ -71153,7 +71314,7 @@ class RecordingApi {
|
|
|
71153
71314
|
/**
|
|
71154
71315
|
* Recording service.
|
|
71155
71316
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
71156
|
-
* @version
|
|
71317
|
+
* @version 253.0.0
|
|
71157
71318
|
*/
|
|
71158
71319
|
|
|
71159
71320
|
/**
|
|
@@ -73001,7 +73162,7 @@ class ResponseManagementApi {
|
|
|
73001
73162
|
/**
|
|
73002
73163
|
* ResponseManagement service.
|
|
73003
73164
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
73004
|
-
* @version
|
|
73165
|
+
* @version 253.0.0
|
|
73005
73166
|
*/
|
|
73006
73167
|
|
|
73007
73168
|
/**
|
|
@@ -73645,7 +73806,7 @@ class RoutingApi {
|
|
|
73645
73806
|
/**
|
|
73646
73807
|
* Routing service.
|
|
73647
73808
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
73648
|
-
* @version
|
|
73809
|
+
* @version 253.0.0
|
|
73649
73810
|
*/
|
|
73650
73811
|
|
|
73651
73812
|
/**
|
|
@@ -74093,6 +74254,62 @@ class RoutingApi {
|
|
|
74093
74254
|
);
|
|
74094
74255
|
}
|
|
74095
74256
|
|
|
74257
|
+
/**
|
|
74258
|
+
* Archive a skill expression to remove it from the set of active expressions
|
|
74259
|
+
*
|
|
74260
|
+
* @param {String} expressionId Expression ID
|
|
74261
|
+
* @param {Object} opts Optional parameters
|
|
74262
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74263
|
+
*/
|
|
74264
|
+
deleteRoutingSkillexpression(expressionId, opts) {
|
|
74265
|
+
opts = opts || {};
|
|
74266
|
+
|
|
74267
|
+
// verify the required parameter 'expressionId' is set
|
|
74268
|
+
if (expressionId === undefined || expressionId === null || expressionId === '') {
|
|
74269
|
+
throw 'Missing the required parameter "expressionId" when calling deleteRoutingSkillexpression';
|
|
74270
|
+
}
|
|
74271
|
+
|
|
74272
|
+
return this.apiClient.callApi(
|
|
74273
|
+
'/api/v2/routing/skillexpressions/{expressionId}',
|
|
74274
|
+
'DELETE',
|
|
74275
|
+
{ 'expressionId': expressionId },
|
|
74276
|
+
{ },
|
|
74277
|
+
{ },
|
|
74278
|
+
{ },
|
|
74279
|
+
null,
|
|
74280
|
+
['PureCloud OAuth'],
|
|
74281
|
+
['application/json'],
|
|
74282
|
+
['application/json'],
|
|
74283
|
+
opts['customHeaders']
|
|
74284
|
+
);
|
|
74285
|
+
}
|
|
74286
|
+
|
|
74287
|
+
/**
|
|
74288
|
+
* Archive a set of skill expressions to remove them from the set of active expressions
|
|
74289
|
+
*
|
|
74290
|
+
* @param {Object} opts Optional parameters
|
|
74291
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
74292
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74293
|
+
*/
|
|
74294
|
+
deleteRoutingSkillexpressions(opts) {
|
|
74295
|
+
opts = opts || {};
|
|
74296
|
+
|
|
74297
|
+
|
|
74298
|
+
return this.apiClient.callApi(
|
|
74299
|
+
'/api/v2/routing/skillexpressions',
|
|
74300
|
+
'DELETE',
|
|
74301
|
+
{ },
|
|
74302
|
+
{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
74303
|
+
{ },
|
|
74304
|
+
{ },
|
|
74305
|
+
null,
|
|
74306
|
+
['PureCloud OAuth'],
|
|
74307
|
+
['application/json'],
|
|
74308
|
+
['application/json'],
|
|
74309
|
+
opts['customHeaders']
|
|
74310
|
+
);
|
|
74311
|
+
}
|
|
74312
|
+
|
|
74096
74313
|
/**
|
|
74097
74314
|
* Remove skill group definition
|
|
74098
74315
|
*
|
|
@@ -74299,38 +74516,6 @@ class RoutingApi {
|
|
|
74299
74516
|
);
|
|
74300
74517
|
}
|
|
74301
74518
|
|
|
74302
|
-
/**
|
|
74303
|
-
* Delete an utilization tag
|
|
74304
|
-
*
|
|
74305
|
-
* @param {String} tagId Utilization Tag ID
|
|
74306
|
-
* @param {Object} opts Optional parameters
|
|
74307
|
-
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
74308
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74309
|
-
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
74310
|
-
*/
|
|
74311
|
-
deleteRoutingUtilizationTag(tagId, opts) {
|
|
74312
|
-
opts = opts || {};
|
|
74313
|
-
|
|
74314
|
-
// verify the required parameter 'tagId' is set
|
|
74315
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
74316
|
-
throw 'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';
|
|
74317
|
-
}
|
|
74318
|
-
|
|
74319
|
-
return this.apiClient.callApi(
|
|
74320
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
74321
|
-
'DELETE',
|
|
74322
|
-
{ 'tagId': tagId },
|
|
74323
|
-
{ 'forceDelete': opts['forceDelete'] },
|
|
74324
|
-
{ },
|
|
74325
|
-
{ },
|
|
74326
|
-
null,
|
|
74327
|
-
['PureCloud OAuth'],
|
|
74328
|
-
['application/json'],
|
|
74329
|
-
['application/json'],
|
|
74330
|
-
opts['customHeaders']
|
|
74331
|
-
);
|
|
74332
|
-
}
|
|
74333
|
-
|
|
74334
74519
|
/**
|
|
74335
74520
|
* Delete wrap-up code
|
|
74336
74521
|
*
|
|
@@ -75871,6 +76056,98 @@ class RoutingApi {
|
|
|
75871
76056
|
);
|
|
75872
76057
|
}
|
|
75873
76058
|
|
|
76059
|
+
/**
|
|
76060
|
+
* Get a skill expression by ID
|
|
76061
|
+
*
|
|
76062
|
+
* @param {String} expressionId Expression ID
|
|
76063
|
+
* @param {Object} opts Optional parameters
|
|
76064
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76065
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76066
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76067
|
+
*/
|
|
76068
|
+
getRoutingSkillexpression(expressionId, opts) {
|
|
76069
|
+
opts = opts || {};
|
|
76070
|
+
|
|
76071
|
+
// verify the required parameter 'expressionId' is set
|
|
76072
|
+
if (expressionId === undefined || expressionId === null || expressionId === '') {
|
|
76073
|
+
throw 'Missing the required parameter "expressionId" when calling getRoutingSkillexpression';
|
|
76074
|
+
}
|
|
76075
|
+
|
|
76076
|
+
return this.apiClient.callApi(
|
|
76077
|
+
'/api/v2/routing/skillexpressions/{expressionId}',
|
|
76078
|
+
'GET',
|
|
76079
|
+
{ 'expressionId': expressionId },
|
|
76080
|
+
{ 'includeArchived': opts['includeArchived'],'format': opts['format'] },
|
|
76081
|
+
{ },
|
|
76082
|
+
{ },
|
|
76083
|
+
null,
|
|
76084
|
+
['PureCloud OAuth'],
|
|
76085
|
+
['application/json'],
|
|
76086
|
+
['application/json'],
|
|
76087
|
+
opts['customHeaders']
|
|
76088
|
+
);
|
|
76089
|
+
}
|
|
76090
|
+
|
|
76091
|
+
/**
|
|
76092
|
+
* Get skill expressions
|
|
76093
|
+
*
|
|
76094
|
+
* @param {Object} opts Optional parameters
|
|
76095
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76096
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76097
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
76098
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76099
|
+
*/
|
|
76100
|
+
getRoutingSkillexpressions(opts) {
|
|
76101
|
+
opts = opts || {};
|
|
76102
|
+
|
|
76103
|
+
|
|
76104
|
+
return this.apiClient.callApi(
|
|
76105
|
+
'/api/v2/routing/skillexpressions',
|
|
76106
|
+
'GET',
|
|
76107
|
+
{ },
|
|
76108
|
+
{ 'format': opts['format'],'includeArchived': opts['includeArchived'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
76109
|
+
{ },
|
|
76110
|
+
{ },
|
|
76111
|
+
null,
|
|
76112
|
+
['PureCloud OAuth'],
|
|
76113
|
+
['application/json'],
|
|
76114
|
+
['application/json'],
|
|
76115
|
+
opts['customHeaders']
|
|
76116
|
+
);
|
|
76117
|
+
}
|
|
76118
|
+
|
|
76119
|
+
/**
|
|
76120
|
+
* Get skill expressions associated with a queue
|
|
76121
|
+
*
|
|
76122
|
+
* @param {String} queueId Queue ID
|
|
76123
|
+
* @param {Object} opts Optional parameters
|
|
76124
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76125
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76126
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76127
|
+
*/
|
|
76128
|
+
getRoutingSkillexpressionsQueueQueueId(queueId, opts) {
|
|
76129
|
+
opts = opts || {};
|
|
76130
|
+
|
|
76131
|
+
// verify the required parameter 'queueId' is set
|
|
76132
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
76133
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingSkillexpressionsQueueQueueId';
|
|
76134
|
+
}
|
|
76135
|
+
|
|
76136
|
+
return this.apiClient.callApi(
|
|
76137
|
+
'/api/v2/routing/skillexpressions/queue/{queueId}',
|
|
76138
|
+
'GET',
|
|
76139
|
+
{ 'queueId': queueId },
|
|
76140
|
+
{ 'format': opts['format'],'includeArchived': opts['includeArchived'] },
|
|
76141
|
+
{ },
|
|
76142
|
+
{ },
|
|
76143
|
+
null,
|
|
76144
|
+
['PureCloud OAuth'],
|
|
76145
|
+
['application/json'],
|
|
76146
|
+
['application/json'],
|
|
76147
|
+
opts['customHeaders']
|
|
76148
|
+
);
|
|
76149
|
+
}
|
|
76150
|
+
|
|
75874
76151
|
/**
|
|
75875
76152
|
* Get skill group
|
|
75876
76153
|
*
|
|
@@ -76393,98 +76670,6 @@ class RoutingApi {
|
|
|
76393
76670
|
);
|
|
76394
76671
|
}
|
|
76395
76672
|
|
|
76396
|
-
/**
|
|
76397
|
-
* Get details about this utilization tag
|
|
76398
|
-
*
|
|
76399
|
-
* @param {String} tagId Utilization Tag ID
|
|
76400
|
-
* @param {Object} opts Optional parameters
|
|
76401
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76402
|
-
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76403
|
-
*/
|
|
76404
|
-
getRoutingUtilizationTag(tagId, opts) {
|
|
76405
|
-
opts = opts || {};
|
|
76406
|
-
|
|
76407
|
-
// verify the required parameter 'tagId' is set
|
|
76408
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76409
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';
|
|
76410
|
-
}
|
|
76411
|
-
|
|
76412
|
-
return this.apiClient.callApi(
|
|
76413
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
76414
|
-
'GET',
|
|
76415
|
-
{ 'tagId': tagId },
|
|
76416
|
-
{ },
|
|
76417
|
-
{ },
|
|
76418
|
-
{ },
|
|
76419
|
-
null,
|
|
76420
|
-
['PureCloud OAuth'],
|
|
76421
|
-
['application/json'],
|
|
76422
|
-
['application/json'],
|
|
76423
|
-
opts['customHeaders']
|
|
76424
|
-
);
|
|
76425
|
-
}
|
|
76426
|
-
|
|
76427
|
-
/**
|
|
76428
|
-
* Get list of agent ids associated with a utilization tag
|
|
76429
|
-
*
|
|
76430
|
-
* @param {String} tagId Utilization Tag ID
|
|
76431
|
-
* @param {Object} opts Optional parameters
|
|
76432
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76433
|
-
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76434
|
-
*/
|
|
76435
|
-
getRoutingUtilizationTagAgents(tagId, opts) {
|
|
76436
|
-
opts = opts || {};
|
|
76437
|
-
|
|
76438
|
-
// verify the required parameter 'tagId' is set
|
|
76439
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76440
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';
|
|
76441
|
-
}
|
|
76442
|
-
|
|
76443
|
-
return this.apiClient.callApi(
|
|
76444
|
-
'/api/v2/routing/utilization/tags/{tagId}/agents',
|
|
76445
|
-
'GET',
|
|
76446
|
-
{ 'tagId': tagId },
|
|
76447
|
-
{ },
|
|
76448
|
-
{ },
|
|
76449
|
-
{ },
|
|
76450
|
-
null,
|
|
76451
|
-
['PureCloud OAuth'],
|
|
76452
|
-
['application/json'],
|
|
76453
|
-
['application/json'],
|
|
76454
|
-
opts['customHeaders']
|
|
76455
|
-
);
|
|
76456
|
-
}
|
|
76457
|
-
|
|
76458
|
-
/**
|
|
76459
|
-
* Get list of utilization tags
|
|
76460
|
-
*
|
|
76461
|
-
* @param {Object} opts Optional parameters
|
|
76462
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
76463
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
76464
|
-
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
76465
|
-
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
76466
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76467
|
-
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76468
|
-
*/
|
|
76469
|
-
getRoutingUtilizationTags(opts) {
|
|
76470
|
-
opts = opts || {};
|
|
76471
|
-
|
|
76472
|
-
|
|
76473
|
-
return this.apiClient.callApi(
|
|
76474
|
-
'/api/v2/routing/utilization/tags',
|
|
76475
|
-
'GET',
|
|
76476
|
-
{ },
|
|
76477
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
76478
|
-
{ },
|
|
76479
|
-
{ },
|
|
76480
|
-
null,
|
|
76481
|
-
['PureCloud OAuth'],
|
|
76482
|
-
['application/json'],
|
|
76483
|
-
['application/json'],
|
|
76484
|
-
opts['customHeaders']
|
|
76485
|
-
);
|
|
76486
|
-
}
|
|
76487
|
-
|
|
76488
76673
|
/**
|
|
76489
76674
|
* Get details about this wrap-up code.
|
|
76490
76675
|
*
|
|
@@ -78068,6 +78253,36 @@ class RoutingApi {
|
|
|
78068
78253
|
);
|
|
78069
78254
|
}
|
|
78070
78255
|
|
|
78256
|
+
/**
|
|
78257
|
+
* Validate and normalize a skill expression
|
|
78258
|
+
*
|
|
78259
|
+
* @param {Object} body Skill expression data to validate
|
|
78260
|
+
* @param {Object} opts Optional parameters
|
|
78261
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78262
|
+
*/
|
|
78263
|
+
postRoutingSkillexpressionsValidate(body, opts) {
|
|
78264
|
+
opts = opts || {};
|
|
78265
|
+
|
|
78266
|
+
// verify the required parameter 'body' is set
|
|
78267
|
+
if (body === undefined || body === null) {
|
|
78268
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillexpressionsValidate';
|
|
78269
|
+
}
|
|
78270
|
+
|
|
78271
|
+
return this.apiClient.callApi(
|
|
78272
|
+
'/api/v2/routing/skillexpressions/validate',
|
|
78273
|
+
'POST',
|
|
78274
|
+
{ },
|
|
78275
|
+
{ },
|
|
78276
|
+
{ },
|
|
78277
|
+
{ },
|
|
78278
|
+
body,
|
|
78279
|
+
['PureCloud OAuth'],
|
|
78280
|
+
['application/json'],
|
|
78281
|
+
['application/json'],
|
|
78282
|
+
opts['customHeaders']
|
|
78283
|
+
);
|
|
78284
|
+
}
|
|
78285
|
+
|
|
78071
78286
|
/**
|
|
78072
78287
|
* Add or remove member divisions for this skill group.
|
|
78073
78288
|
*
|
|
@@ -78310,37 +78525,6 @@ class RoutingApi {
|
|
|
78310
78525
|
);
|
|
78311
78526
|
}
|
|
78312
78527
|
|
|
78313
|
-
/**
|
|
78314
|
-
* Create an utilization tag
|
|
78315
|
-
*
|
|
78316
|
-
* @param {Object} body UtilizationTag
|
|
78317
|
-
* @param {Object} opts Optional parameters
|
|
78318
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78319
|
-
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
78320
|
-
*/
|
|
78321
|
-
postRoutingUtilizationTags(body, opts) {
|
|
78322
|
-
opts = opts || {};
|
|
78323
|
-
|
|
78324
|
-
// verify the required parameter 'body' is set
|
|
78325
|
-
if (body === undefined || body === null) {
|
|
78326
|
-
throw 'Missing the required parameter "body" when calling postRoutingUtilizationTags';
|
|
78327
|
-
}
|
|
78328
|
-
|
|
78329
|
-
return this.apiClient.callApi(
|
|
78330
|
-
'/api/v2/routing/utilization/tags',
|
|
78331
|
-
'POST',
|
|
78332
|
-
{ },
|
|
78333
|
-
{ },
|
|
78334
|
-
{ },
|
|
78335
|
-
{ },
|
|
78336
|
-
body,
|
|
78337
|
-
['PureCloud OAuth'],
|
|
78338
|
-
['application/json'],
|
|
78339
|
-
['application/json'],
|
|
78340
|
-
opts['customHeaders']
|
|
78341
|
-
);
|
|
78342
|
-
}
|
|
78343
|
-
|
|
78344
78528
|
/**
|
|
78345
78529
|
* Create a wrap-up code
|
|
78346
78530
|
*
|
|
@@ -79032,7 +79216,7 @@ class SCIMApi {
|
|
|
79032
79216
|
/**
|
|
79033
79217
|
* SCIM service.
|
|
79034
79218
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
79035
|
-
* @version
|
|
79219
|
+
* @version 253.0.0
|
|
79036
79220
|
*/
|
|
79037
79221
|
|
|
79038
79222
|
/**
|
|
@@ -79993,7 +80177,7 @@ class ScriptsApi {
|
|
|
79993
80177
|
/**
|
|
79994
80178
|
* Scripts service.
|
|
79995
80179
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
79996
|
-
* @version
|
|
80180
|
+
* @version 253.0.0
|
|
79997
80181
|
*/
|
|
79998
80182
|
|
|
79999
80183
|
/**
|
|
@@ -80502,7 +80686,7 @@ class SearchApi {
|
|
|
80502
80686
|
/**
|
|
80503
80687
|
* Search service.
|
|
80504
80688
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
80505
|
-
* @version
|
|
80689
|
+
* @version 253.0.0
|
|
80506
80690
|
*/
|
|
80507
80691
|
|
|
80508
80692
|
/**
|
|
@@ -81318,7 +81502,7 @@ class SettingsApi {
|
|
|
81318
81502
|
/**
|
|
81319
81503
|
* Settings service.
|
|
81320
81504
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
81321
|
-
* @version
|
|
81505
|
+
* @version 253.0.0
|
|
81322
81506
|
*/
|
|
81323
81507
|
|
|
81324
81508
|
/**
|
|
@@ -81727,7 +81911,7 @@ class SocialMediaApi {
|
|
|
81727
81911
|
/**
|
|
81728
81912
|
* SocialMedia service.
|
|
81729
81913
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
81730
|
-
* @version
|
|
81914
|
+
* @version 253.0.0
|
|
81731
81915
|
*/
|
|
81732
81916
|
|
|
81733
81917
|
/**
|
|
@@ -83712,7 +83896,7 @@ class SpeechTextAnalyticsApi {
|
|
|
83712
83896
|
/**
|
|
83713
83897
|
* SpeechTextAnalytics service.
|
|
83714
83898
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
83715
|
-
* @version
|
|
83899
|
+
* @version 253.0.0
|
|
83716
83900
|
*/
|
|
83717
83901
|
|
|
83718
83902
|
/**
|
|
@@ -85664,7 +85848,7 @@ class StationsApi {
|
|
|
85664
85848
|
/**
|
|
85665
85849
|
* Stations service.
|
|
85666
85850
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
85667
|
-
* @version
|
|
85851
|
+
* @version 253.0.0
|
|
85668
85852
|
*/
|
|
85669
85853
|
|
|
85670
85854
|
/**
|
|
@@ -85778,7 +85962,7 @@ class SuggestApi {
|
|
|
85778
85962
|
/**
|
|
85779
85963
|
* Suggest service.
|
|
85780
85964
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
85781
|
-
* @version
|
|
85965
|
+
* @version 253.0.0
|
|
85782
85966
|
*/
|
|
85783
85967
|
|
|
85784
85968
|
/**
|
|
@@ -85925,7 +86109,7 @@ class TaskManagementApi {
|
|
|
85925
86109
|
/**
|
|
85926
86110
|
* TaskManagement service.
|
|
85927
86111
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
85928
|
-
* @version
|
|
86112
|
+
* @version 253.0.0
|
|
85929
86113
|
*/
|
|
85930
86114
|
|
|
85931
86115
|
/**
|
|
@@ -88421,7 +88605,7 @@ class TeamsApi {
|
|
|
88421
88605
|
/**
|
|
88422
88606
|
* Teams service.
|
|
88423
88607
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
88424
|
-
* @version
|
|
88608
|
+
* @version 253.0.0
|
|
88425
88609
|
*/
|
|
88426
88610
|
|
|
88427
88611
|
/**
|
|
@@ -88764,7 +88948,7 @@ class TelephonyApi {
|
|
|
88764
88948
|
/**
|
|
88765
88949
|
* Telephony service.
|
|
88766
88950
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
88767
|
-
* @version
|
|
88951
|
+
* @version 253.0.0
|
|
88768
88952
|
*/
|
|
88769
88953
|
|
|
88770
88954
|
/**
|
|
@@ -89171,7 +89355,7 @@ class TelephonyProvidersEdgeApi {
|
|
|
89171
89355
|
/**
|
|
89172
89356
|
* TelephonyProvidersEdge service.
|
|
89173
89357
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
89174
|
-
* @version
|
|
89358
|
+
* @version 253.0.0
|
|
89175
89359
|
*/
|
|
89176
89360
|
|
|
89177
89361
|
/**
|
|
@@ -92363,52 +92547,6 @@ class TelephonyProvidersEdgeApi {
|
|
|
92363
92547
|
);
|
|
92364
92548
|
}
|
|
92365
92549
|
|
|
92366
|
-
/**
|
|
92367
|
-
* Post media endpoint statistics event.
|
|
92368
|
-
*
|
|
92369
|
-
* @param {String} conversationId Identifier of the conversation
|
|
92370
|
-
* @param {String} communicationId Identifier of the media session
|
|
92371
|
-
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
92372
|
-
* @param {Object} body MediaStatisticsPostRequest
|
|
92373
|
-
* @param {Object} opts Optional parameters
|
|
92374
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
92375
|
-
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
92376
|
-
*/
|
|
92377
|
-
postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body, opts) {
|
|
92378
|
-
opts = opts || {};
|
|
92379
|
-
|
|
92380
|
-
// verify the required parameter 'conversationId' is set
|
|
92381
|
-
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
92382
|
-
throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92383
|
-
}
|
|
92384
|
-
// verify the required parameter 'communicationId' is set
|
|
92385
|
-
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
92386
|
-
throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92387
|
-
}
|
|
92388
|
-
// verify the required parameter 'mediaResourceId' is set
|
|
92389
|
-
if (mediaResourceId === undefined || mediaResourceId === null || mediaResourceId === '') {
|
|
92390
|
-
throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92391
|
-
}
|
|
92392
|
-
// verify the required parameter 'body' is set
|
|
92393
|
-
if (body === undefined || body === null) {
|
|
92394
|
-
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92395
|
-
}
|
|
92396
|
-
|
|
92397
|
-
return this.apiClient.callApi(
|
|
92398
|
-
'/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
|
|
92399
|
-
'POST',
|
|
92400
|
-
{ 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
|
|
92401
|
-
{ },
|
|
92402
|
-
{ },
|
|
92403
|
-
{ },
|
|
92404
|
-
body,
|
|
92405
|
-
['PureCloud OAuth'],
|
|
92406
|
-
['application/json'],
|
|
92407
|
-
['application/json'],
|
|
92408
|
-
opts['customHeaders']
|
|
92409
|
-
);
|
|
92410
|
-
}
|
|
92411
|
-
|
|
92412
92550
|
/**
|
|
92413
92551
|
* Reboot a Phone
|
|
92414
92552
|
*
|
|
@@ -93195,7 +93333,7 @@ class TextbotsApi {
|
|
|
93195
93333
|
/**
|
|
93196
93334
|
* Textbots service.
|
|
93197
93335
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
93198
|
-
* @version
|
|
93336
|
+
* @version 253.0.0
|
|
93199
93337
|
*/
|
|
93200
93338
|
|
|
93201
93339
|
/**
|
|
@@ -93341,7 +93479,7 @@ class TokensApi {
|
|
|
93341
93479
|
/**
|
|
93342
93480
|
* Tokens service.
|
|
93343
93481
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
93344
|
-
* @version
|
|
93482
|
+
* @version 253.0.0
|
|
93345
93483
|
*/
|
|
93346
93484
|
|
|
93347
93485
|
/**
|
|
@@ -93519,7 +93657,7 @@ class UploadsApi {
|
|
|
93519
93657
|
/**
|
|
93520
93658
|
* Uploads service.
|
|
93521
93659
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
93522
|
-
* @version
|
|
93660
|
+
* @version 253.0.0
|
|
93523
93661
|
*/
|
|
93524
93662
|
|
|
93525
93663
|
/**
|
|
@@ -93890,7 +94028,7 @@ class UsageApi {
|
|
|
93890
94028
|
/**
|
|
93891
94029
|
* Usage service.
|
|
93892
94030
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
93893
|
-
* @version
|
|
94031
|
+
* @version 253.0.0
|
|
93894
94032
|
*/
|
|
93895
94033
|
|
|
93896
94034
|
/**
|
|
@@ -94268,7 +94406,7 @@ class UserRecordingsApi {
|
|
|
94268
94406
|
/**
|
|
94269
94407
|
* UserRecordings service.
|
|
94270
94408
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
94271
|
-
* @version
|
|
94409
|
+
* @version 253.0.0
|
|
94272
94410
|
*/
|
|
94273
94411
|
|
|
94274
94412
|
/**
|
|
@@ -94470,7 +94608,7 @@ class UsersApi {
|
|
|
94470
94608
|
/**
|
|
94471
94609
|
* Users service.
|
|
94472
94610
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
94473
|
-
* @version
|
|
94611
|
+
* @version 253.0.0
|
|
94474
94612
|
*/
|
|
94475
94613
|
|
|
94476
94614
|
/**
|
|
@@ -98489,7 +98627,7 @@ class UsersRulesApi {
|
|
|
98489
98627
|
/**
|
|
98490
98628
|
* UsersRules service.
|
|
98491
98629
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
98492
|
-
* @version
|
|
98630
|
+
* @version 253.0.0
|
|
98493
98631
|
*/
|
|
98494
98632
|
|
|
98495
98633
|
/**
|
|
@@ -98806,7 +98944,7 @@ class UtilitiesApi {
|
|
|
98806
98944
|
/**
|
|
98807
98945
|
* Utilities service.
|
|
98808
98946
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
98809
|
-
* @version
|
|
98947
|
+
* @version 253.0.0
|
|
98810
98948
|
*/
|
|
98811
98949
|
|
|
98812
98950
|
/**
|
|
@@ -98934,7 +99072,7 @@ class VoicemailApi {
|
|
|
98934
99072
|
/**
|
|
98935
99073
|
* Voicemail service.
|
|
98936
99074
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
98937
|
-
* @version
|
|
99075
|
+
* @version 253.0.0
|
|
98938
99076
|
*/
|
|
98939
99077
|
|
|
98940
99078
|
/**
|
|
@@ -99764,7 +99902,7 @@ class WebChatApi {
|
|
|
99764
99902
|
/**
|
|
99765
99903
|
* WebChat service.
|
|
99766
99904
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
99767
|
-
* @version
|
|
99905
|
+
* @version 253.0.0
|
|
99768
99906
|
*/
|
|
99769
99907
|
|
|
99770
99908
|
/**
|
|
@@ -100416,7 +100554,7 @@ class WebDeploymentsApi {
|
|
|
100416
100554
|
/**
|
|
100417
100555
|
* WebDeployments service.
|
|
100418
100556
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
100419
|
-
* @version
|
|
100557
|
+
* @version 253.0.0
|
|
100420
100558
|
*/
|
|
100421
100559
|
|
|
100422
100560
|
/**
|
|
@@ -101094,7 +101232,7 @@ class WebMessagingApi {
|
|
|
101094
101232
|
/**
|
|
101095
101233
|
* WebMessaging service.
|
|
101096
101234
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
101097
|
-
* @version
|
|
101235
|
+
* @version 253.0.0
|
|
101098
101236
|
*/
|
|
101099
101237
|
|
|
101100
101238
|
/**
|
|
@@ -101257,7 +101395,7 @@ class WidgetsApi {
|
|
|
101257
101395
|
/**
|
|
101258
101396
|
* Widgets service.
|
|
101259
101397
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
101260
|
-
* @version
|
|
101398
|
+
* @version 253.0.0
|
|
101261
101399
|
*/
|
|
101262
101400
|
|
|
101263
101401
|
/**
|
|
@@ -101433,7 +101571,7 @@ class WorkforceManagementApi {
|
|
|
101433
101571
|
/**
|
|
101434
101572
|
* WorkforceManagement service.
|
|
101435
101573
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
101436
|
-
* @version
|
|
101574
|
+
* @version 253.0.0
|
|
101437
101575
|
*/
|
|
101438
101576
|
|
|
101439
101577
|
/**
|
|
@@ -103296,6 +103434,42 @@ class WorkforceManagementApi {
|
|
|
103296
103434
|
);
|
|
103297
103435
|
}
|
|
103298
103436
|
|
|
103437
|
+
/**
|
|
103438
|
+
* Get opportunity details
|
|
103439
|
+
*
|
|
103440
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103441
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
103442
|
+
* @param {Object} opts Optional parameters
|
|
103443
|
+
* @param {Object} opts.expand List of resources to expand
|
|
103444
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103445
|
+
*/
|
|
103446
|
+
getWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, opts) {
|
|
103447
|
+
opts = opts || {};
|
|
103448
|
+
|
|
103449
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103450
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103451
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';
|
|
103452
|
+
}
|
|
103453
|
+
// verify the required parameter 'opportunityId' is set
|
|
103454
|
+
if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
|
|
103455
|
+
throw 'Missing the required parameter "opportunityId" when calling getWorkforcemanagementBusinessunitOpportunity';
|
|
103456
|
+
}
|
|
103457
|
+
|
|
103458
|
+
return this.apiClient.callApi(
|
|
103459
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
|
|
103460
|
+
'GET',
|
|
103461
|
+
{ 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
|
|
103462
|
+
{ 'expand': opts['expand'] },
|
|
103463
|
+
{ },
|
|
103464
|
+
{ },
|
|
103465
|
+
null,
|
|
103466
|
+
['PureCloud OAuth'],
|
|
103467
|
+
['application/json'],
|
|
103468
|
+
['application/json'],
|
|
103469
|
+
opts['customHeaders']
|
|
103470
|
+
);
|
|
103471
|
+
}
|
|
103472
|
+
|
|
103299
103473
|
/**
|
|
103300
103474
|
* Get a planning group
|
|
103301
103475
|
*
|
|
@@ -105129,11 +105303,12 @@ class WorkforceManagementApi {
|
|
|
105129
105303
|
|
|
105130
105304
|
/**
|
|
105131
105305
|
* Gets all the shift trades for a given agent
|
|
105132
|
-
*
|
|
105306
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
105133
105307
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105134
105308
|
* @param {String} agentId The agent id
|
|
105135
105309
|
* @param {Object} opts Optional parameters
|
|
105136
105310
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105311
|
+
* @deprecated
|
|
105137
105312
|
*/
|
|
105138
105313
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId, opts) {
|
|
105139
105314
|
opts = opts || {};
|
|
@@ -105164,10 +105339,11 @@ class WorkforceManagementApi {
|
|
|
105164
105339
|
|
|
105165
105340
|
/**
|
|
105166
105341
|
* Gets a summary of all shift trades in the matched state
|
|
105167
|
-
*
|
|
105342
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
105168
105343
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105169
105344
|
* @param {Object} opts Optional parameters
|
|
105170
105345
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105346
|
+
* @deprecated
|
|
105171
105347
|
*/
|
|
105172
105348
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId, opts) {
|
|
105173
105349
|
opts = opts || {};
|
|
@@ -105581,7 +105757,7 @@ class WorkforceManagementApi {
|
|
|
105581
105757
|
|
|
105582
105758
|
/**
|
|
105583
105759
|
* Gets all the shift trades for a given week
|
|
105584
|
-
*
|
|
105760
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
105585
105761
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105586
105762
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
105587
105763
|
* @param {Object} opts Optional parameters
|
|
@@ -105589,6 +105765,7 @@ class WorkforceManagementApi {
|
|
|
105589
105765
|
* @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
|
|
105590
105766
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
105591
105767
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105768
|
+
* @deprecated
|
|
105592
105769
|
*/
|
|
105593
105770
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
105594
105771
|
opts = opts || {};
|
|
@@ -105864,9 +106041,10 @@ class WorkforceManagementApi {
|
|
|
105864
106041
|
|
|
105865
106042
|
/**
|
|
105866
106043
|
* Gets all of my shift trades
|
|
105867
|
-
*
|
|
106044
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
105868
106045
|
* @param {Object} opts Optional parameters
|
|
105869
106046
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106047
|
+
* @deprecated
|
|
105870
106048
|
*/
|
|
105871
106049
|
getWorkforcemanagementShifttrades(opts) {
|
|
105872
106050
|
opts = opts || {};
|
|
@@ -106728,9 +106906,49 @@ class WorkforceManagementApi {
|
|
|
106728
106906
|
);
|
|
106729
106907
|
}
|
|
106730
106908
|
|
|
106909
|
+
/**
|
|
106910
|
+
* Update the opportunity
|
|
106911
|
+
* Only opportunities with Draft status can be updated.
|
|
106912
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
106913
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
106914
|
+
* @param {Object} body body
|
|
106915
|
+
* @param {Object} opts Optional parameters
|
|
106916
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106917
|
+
*/
|
|
106918
|
+
patchWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, body, opts) {
|
|
106919
|
+
opts = opts || {};
|
|
106920
|
+
|
|
106921
|
+
// verify the required parameter 'businessUnitId' is set
|
|
106922
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
106923
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
106924
|
+
}
|
|
106925
|
+
// verify the required parameter 'opportunityId' is set
|
|
106926
|
+
if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
|
|
106927
|
+
throw 'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
106928
|
+
}
|
|
106929
|
+
// verify the required parameter 'body' is set
|
|
106930
|
+
if (body === undefined || body === null) {
|
|
106931
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
106932
|
+
}
|
|
106933
|
+
|
|
106934
|
+
return this.apiClient.callApi(
|
|
106935
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
|
|
106936
|
+
'PATCH',
|
|
106937
|
+
{ 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
|
|
106938
|
+
{ },
|
|
106939
|
+
{ },
|
|
106940
|
+
{ },
|
|
106941
|
+
body,
|
|
106942
|
+
['PureCloud OAuth'],
|
|
106943
|
+
['application/json'],
|
|
106944
|
+
['application/json'],
|
|
106945
|
+
opts['customHeaders']
|
|
106946
|
+
);
|
|
106947
|
+
}
|
|
106948
|
+
|
|
106731
106949
|
/**
|
|
106732
106950
|
* Updates the planning group
|
|
106733
|
-
*
|
|
106951
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
106734
106952
|
* @param {String} businessUnitId The ID of the business unit.
|
|
106735
106953
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
106736
106954
|
* @param {Object} body body
|
|
@@ -107405,13 +107623,14 @@ class WorkforceManagementApi {
|
|
|
107405
107623
|
|
|
107406
107624
|
/**
|
|
107407
107625
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
107408
|
-
*
|
|
107626
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
107409
107627
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
107410
107628
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
107411
107629
|
* @param {String} tradeId The ID of the shift trade to update
|
|
107412
107630
|
* @param {Object} body body
|
|
107413
107631
|
* @param {Object} opts Optional parameters
|
|
107414
107632
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107633
|
+
* @deprecated
|
|
107415
107634
|
*/
|
|
107416
107635
|
patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
107417
107636
|
opts = opts || {};
|
|
@@ -107756,33 +107975,6 @@ class WorkforceManagementApi {
|
|
|
107756
107975
|
);
|
|
107757
107976
|
}
|
|
107758
107977
|
|
|
107759
|
-
/**
|
|
107760
|
-
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
107761
|
-
*
|
|
107762
|
-
* @param {Object} opts Optional parameters
|
|
107763
|
-
* @param {Object} opts.body body
|
|
107764
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107765
|
-
* @deprecated
|
|
107766
|
-
*/
|
|
107767
|
-
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
107768
|
-
opts = opts || {};
|
|
107769
|
-
|
|
107770
|
-
|
|
107771
|
-
return this.apiClient.callApi(
|
|
107772
|
-
'/api/v2/workforcemanagement/adherence/historical',
|
|
107773
|
-
'POST',
|
|
107774
|
-
{ },
|
|
107775
|
-
{ },
|
|
107776
|
-
{ },
|
|
107777
|
-
{ },
|
|
107778
|
-
opts['body'],
|
|
107779
|
-
['PureCloud OAuth'],
|
|
107780
|
-
['application/json'],
|
|
107781
|
-
['application/json'],
|
|
107782
|
-
opts['customHeaders']
|
|
107783
|
-
);
|
|
107784
|
-
}
|
|
107785
|
-
|
|
107786
107978
|
/**
|
|
107787
107979
|
* Request a historical adherence report in bulk
|
|
107788
107980
|
*
|
|
@@ -108037,6 +108229,98 @@ class WorkforceManagementApi {
|
|
|
108037
108229
|
);
|
|
108038
108230
|
}
|
|
108039
108231
|
|
|
108232
|
+
/**
|
|
108233
|
+
* Bulk add enrollments to opportunities for the authenticated agent
|
|
108234
|
+
* Allows an agent to enroll in opportunities. This endpoint can return partial success.
|
|
108235
|
+
* @param {Object} body body
|
|
108236
|
+
* @param {Object} opts Optional parameters
|
|
108237
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108238
|
+
*/
|
|
108239
|
+
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body, opts) {
|
|
108240
|
+
opts = opts || {};
|
|
108241
|
+
|
|
108242
|
+
// verify the required parameter 'body' is set
|
|
108243
|
+
if (body === undefined || body === null) {
|
|
108244
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';
|
|
108245
|
+
}
|
|
108246
|
+
|
|
108247
|
+
return this.apiClient.callApi(
|
|
108248
|
+
'/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add',
|
|
108249
|
+
'POST',
|
|
108250
|
+
{ },
|
|
108251
|
+
{ },
|
|
108252
|
+
{ },
|
|
108253
|
+
{ },
|
|
108254
|
+
body,
|
|
108255
|
+
['PureCloud OAuth'],
|
|
108256
|
+
['application/json'],
|
|
108257
|
+
['application/json'],
|
|
108258
|
+
opts['customHeaders']
|
|
108259
|
+
);
|
|
108260
|
+
}
|
|
108261
|
+
|
|
108262
|
+
/**
|
|
108263
|
+
* Bulk update enrollment status for the authenticated agent
|
|
108264
|
+
* Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
|
|
108265
|
+
* @param {Object} body body
|
|
108266
|
+
* @param {Object} opts Optional parameters
|
|
108267
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108268
|
+
*/
|
|
108269
|
+
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body, opts) {
|
|
108270
|
+
opts = opts || {};
|
|
108271
|
+
|
|
108272
|
+
// verify the required parameter 'body' is set
|
|
108273
|
+
if (body === undefined || body === null) {
|
|
108274
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
108275
|
+
}
|
|
108276
|
+
|
|
108277
|
+
return this.apiClient.callApi(
|
|
108278
|
+
'/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update',
|
|
108279
|
+
'POST',
|
|
108280
|
+
{ },
|
|
108281
|
+
{ },
|
|
108282
|
+
{ },
|
|
108283
|
+
{ },
|
|
108284
|
+
body,
|
|
108285
|
+
['PureCloud OAuth'],
|
|
108286
|
+
['application/json'],
|
|
108287
|
+
['application/json'],
|
|
108288
|
+
opts['customHeaders']
|
|
108289
|
+
);
|
|
108290
|
+
}
|
|
108291
|
+
|
|
108292
|
+
/**
|
|
108293
|
+
* Query opportunities for the authenticated agent
|
|
108294
|
+
* Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
|
|
108295
|
+
* @param {Object} body body
|
|
108296
|
+
* @param {Object} opts Optional parameters
|
|
108297
|
+
* @param {Object} opts.expand List of resources to expand
|
|
108298
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108299
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108300
|
+
*/
|
|
108301
|
+
postWorkforcemanagementAgentsOpportunitiesQuery(body, opts) {
|
|
108302
|
+
opts = opts || {};
|
|
108303
|
+
|
|
108304
|
+
// verify the required parameter 'body' is set
|
|
108305
|
+
if (body === undefined || body === null) {
|
|
108306
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';
|
|
108307
|
+
}
|
|
108308
|
+
|
|
108309
|
+
return this.apiClient.callApi(
|
|
108310
|
+
'/api/v2/workforcemanagement/agents/opportunities/query',
|
|
108311
|
+
'POST',
|
|
108312
|
+
{ },
|
|
108313
|
+
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108314
|
+
{ },
|
|
108315
|
+
{ },
|
|
108316
|
+
body,
|
|
108317
|
+
['PureCloud OAuth'],
|
|
108318
|
+
['application/json'],
|
|
108319
|
+
['application/json'],
|
|
108320
|
+
opts['customHeaders']
|
|
108321
|
+
);
|
|
108322
|
+
}
|
|
108323
|
+
|
|
108040
108324
|
/**
|
|
108041
108325
|
* Fetch agent schedules for the logged in user's management unit
|
|
108042
108326
|
*
|
|
@@ -108706,8 +108990,291 @@ class WorkforceManagementApi {
|
|
|
108706
108990
|
}
|
|
108707
108991
|
|
|
108708
108992
|
/**
|
|
108709
|
-
*
|
|
108993
|
+
* Bulk add opportunities
|
|
108710
108994
|
*
|
|
108995
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108996
|
+
* @param {Object} body body
|
|
108997
|
+
* @param {Object} opts Optional parameters
|
|
108998
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108999
|
+
*/
|
|
109000
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId, body, opts) {
|
|
109001
|
+
opts = opts || {};
|
|
109002
|
+
|
|
109003
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109004
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109005
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
|
|
109006
|
+
}
|
|
109007
|
+
// verify the required parameter 'body' is set
|
|
109008
|
+
if (body === undefined || body === null) {
|
|
109009
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
|
|
109010
|
+
}
|
|
109011
|
+
|
|
109012
|
+
return this.apiClient.callApi(
|
|
109013
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add',
|
|
109014
|
+
'POST',
|
|
109015
|
+
{ 'businessUnitId': businessUnitId },
|
|
109016
|
+
{ },
|
|
109017
|
+
{ },
|
|
109018
|
+
{ },
|
|
109019
|
+
body,
|
|
109020
|
+
['PureCloud OAuth'],
|
|
109021
|
+
['application/json'],
|
|
109022
|
+
['application/json'],
|
|
109023
|
+
opts['customHeaders']
|
|
109024
|
+
);
|
|
109025
|
+
}
|
|
109026
|
+
|
|
109027
|
+
/**
|
|
109028
|
+
* Bulk publish opportunities
|
|
109029
|
+
* Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
|
|
109030
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109031
|
+
* @param {Object} body body
|
|
109032
|
+
* @param {Object} opts Optional parameters
|
|
109033
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109034
|
+
*/
|
|
109035
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId, body, opts) {
|
|
109036
|
+
opts = opts || {};
|
|
109037
|
+
|
|
109038
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109039
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109040
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
|
|
109041
|
+
}
|
|
109042
|
+
// verify the required parameter 'body' is set
|
|
109043
|
+
if (body === undefined || body === null) {
|
|
109044
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
|
|
109045
|
+
}
|
|
109046
|
+
|
|
109047
|
+
return this.apiClient.callApi(
|
|
109048
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish',
|
|
109049
|
+
'POST',
|
|
109050
|
+
{ 'businessUnitId': businessUnitId },
|
|
109051
|
+
{ },
|
|
109052
|
+
{ },
|
|
109053
|
+
{ },
|
|
109054
|
+
body,
|
|
109055
|
+
['PureCloud OAuth'],
|
|
109056
|
+
['application/json'],
|
|
109057
|
+
['application/json'],
|
|
109058
|
+
opts['customHeaders']
|
|
109059
|
+
);
|
|
109060
|
+
}
|
|
109061
|
+
|
|
109062
|
+
/**
|
|
109063
|
+
* Bulk remove opportunities
|
|
109064
|
+
* This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
|
|
109065
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109066
|
+
* @param {Object} body body
|
|
109067
|
+
* @param {Object} opts Optional parameters
|
|
109068
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109069
|
+
*/
|
|
109070
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId, body, opts) {
|
|
109071
|
+
opts = opts || {};
|
|
109072
|
+
|
|
109073
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109074
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109075
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
|
|
109076
|
+
}
|
|
109077
|
+
// verify the required parameter 'body' is set
|
|
109078
|
+
if (body === undefined || body === null) {
|
|
109079
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
|
|
109080
|
+
}
|
|
109081
|
+
|
|
109082
|
+
return this.apiClient.callApi(
|
|
109083
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove',
|
|
109084
|
+
'POST',
|
|
109085
|
+
{ 'businessUnitId': businessUnitId },
|
|
109086
|
+
{ },
|
|
109087
|
+
{ },
|
|
109088
|
+
{ },
|
|
109089
|
+
body,
|
|
109090
|
+
['PureCloud OAuth'],
|
|
109091
|
+
['application/json'],
|
|
109092
|
+
['application/json'],
|
|
109093
|
+
opts['customHeaders']
|
|
109094
|
+
);
|
|
109095
|
+
}
|
|
109096
|
+
|
|
109097
|
+
/**
|
|
109098
|
+
* Bulk update opportunities status
|
|
109099
|
+
* If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
|
|
109100
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109101
|
+
* @param {Object} body body
|
|
109102
|
+
* @param {Object} opts Optional parameters
|
|
109103
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109104
|
+
*/
|
|
109105
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId, body, opts) {
|
|
109106
|
+
opts = opts || {};
|
|
109107
|
+
|
|
109108
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109109
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109110
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
|
|
109111
|
+
}
|
|
109112
|
+
// verify the required parameter 'body' is set
|
|
109113
|
+
if (body === undefined || body === null) {
|
|
109114
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
|
|
109115
|
+
}
|
|
109116
|
+
|
|
109117
|
+
return this.apiClient.callApi(
|
|
109118
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update',
|
|
109119
|
+
'POST',
|
|
109120
|
+
{ 'businessUnitId': businessUnitId },
|
|
109121
|
+
{ },
|
|
109122
|
+
{ },
|
|
109123
|
+
{ },
|
|
109124
|
+
body,
|
|
109125
|
+
['PureCloud OAuth'],
|
|
109126
|
+
['application/json'],
|
|
109127
|
+
['application/json'],
|
|
109128
|
+
opts['customHeaders']
|
|
109129
|
+
);
|
|
109130
|
+
}
|
|
109131
|
+
|
|
109132
|
+
/**
|
|
109133
|
+
* Bulk update enrollment status
|
|
109134
|
+
* Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
|
|
109135
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109136
|
+
* @param {Object} body body
|
|
109137
|
+
* @param {Object} opts Optional parameters
|
|
109138
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109139
|
+
*/
|
|
109140
|
+
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId, body, opts) {
|
|
109141
|
+
opts = opts || {};
|
|
109142
|
+
|
|
109143
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109144
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109145
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
109146
|
+
}
|
|
109147
|
+
// verify the required parameter 'body' is set
|
|
109148
|
+
if (body === undefined || body === null) {
|
|
109149
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
109150
|
+
}
|
|
109151
|
+
|
|
109152
|
+
return this.apiClient.callApi(
|
|
109153
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update',
|
|
109154
|
+
'POST',
|
|
109155
|
+
{ 'businessUnitId': businessUnitId },
|
|
109156
|
+
{ },
|
|
109157
|
+
{ },
|
|
109158
|
+
{ },
|
|
109159
|
+
body,
|
|
109160
|
+
['PureCloud OAuth'],
|
|
109161
|
+
['application/json'],
|
|
109162
|
+
['application/json'],
|
|
109163
|
+
opts['customHeaders']
|
|
109164
|
+
);
|
|
109165
|
+
}
|
|
109166
|
+
|
|
109167
|
+
/**
|
|
109168
|
+
* Query enrollments
|
|
109169
|
+
* For more information about opportunities, use the expand parameter.
|
|
109170
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109171
|
+
* @param {Object} body body
|
|
109172
|
+
* @param {Object} opts Optional parameters
|
|
109173
|
+
* @param {Object} opts.expand List of resources to expand
|
|
109174
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
109175
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109176
|
+
*/
|
|
109177
|
+
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId, body, opts) {
|
|
109178
|
+
opts = opts || {};
|
|
109179
|
+
|
|
109180
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109181
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109182
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
|
|
109183
|
+
}
|
|
109184
|
+
// verify the required parameter 'body' is set
|
|
109185
|
+
if (body === undefined || body === null) {
|
|
109186
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
|
|
109187
|
+
}
|
|
109188
|
+
|
|
109189
|
+
return this.apiClient.callApi(
|
|
109190
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query',
|
|
109191
|
+
'POST',
|
|
109192
|
+
{ 'businessUnitId': businessUnitId },
|
|
109193
|
+
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
109194
|
+
{ },
|
|
109195
|
+
{ },
|
|
109196
|
+
body,
|
|
109197
|
+
['PureCloud OAuth'],
|
|
109198
|
+
['application/json'],
|
|
109199
|
+
['application/json'],
|
|
109200
|
+
opts['customHeaders']
|
|
109201
|
+
);
|
|
109202
|
+
}
|
|
109203
|
+
|
|
109204
|
+
/**
|
|
109205
|
+
* Query opportunities by external activity IDs
|
|
109206
|
+
*
|
|
109207
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109208
|
+
* @param {Object} body body
|
|
109209
|
+
* @param {Object} opts Optional parameters
|
|
109210
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109211
|
+
*/
|
|
109212
|
+
postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId, body, opts) {
|
|
109213
|
+
opts = opts || {};
|
|
109214
|
+
|
|
109215
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109216
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109217
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
|
|
109218
|
+
}
|
|
109219
|
+
// verify the required parameter 'body' is set
|
|
109220
|
+
if (body === undefined || body === null) {
|
|
109221
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
|
|
109222
|
+
}
|
|
109223
|
+
|
|
109224
|
+
return this.apiClient.callApi(
|
|
109225
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query',
|
|
109226
|
+
'POST',
|
|
109227
|
+
{ 'businessUnitId': businessUnitId },
|
|
109228
|
+
{ },
|
|
109229
|
+
{ },
|
|
109230
|
+
{ },
|
|
109231
|
+
body,
|
|
109232
|
+
['PureCloud OAuth'],
|
|
109233
|
+
['application/json'],
|
|
109234
|
+
['application/json'],
|
|
109235
|
+
opts['customHeaders']
|
|
109236
|
+
);
|
|
109237
|
+
}
|
|
109238
|
+
|
|
109239
|
+
/**
|
|
109240
|
+
* Query opportunities within the specified date range
|
|
109241
|
+
*
|
|
109242
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109243
|
+
* @param {Object} body body
|
|
109244
|
+
* @param {Object} opts Optional parameters
|
|
109245
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
109246
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109247
|
+
*/
|
|
109248
|
+
postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId, body, opts) {
|
|
109249
|
+
opts = opts || {};
|
|
109250
|
+
|
|
109251
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109252
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109253
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
|
|
109254
|
+
}
|
|
109255
|
+
// verify the required parameter 'body' is set
|
|
109256
|
+
if (body === undefined || body === null) {
|
|
109257
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
|
|
109258
|
+
}
|
|
109259
|
+
|
|
109260
|
+
return this.apiClient.callApi(
|
|
109261
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query',
|
|
109262
|
+
'POST',
|
|
109263
|
+
{ 'businessUnitId': businessUnitId },
|
|
109264
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
109265
|
+
{ },
|
|
109266
|
+
{ },
|
|
109267
|
+
body,
|
|
109268
|
+
['PureCloud OAuth'],
|
|
109269
|
+
['application/json'],
|
|
109270
|
+
['application/json'],
|
|
109271
|
+
opts['customHeaders']
|
|
109272
|
+
);
|
|
109273
|
+
}
|
|
109274
|
+
|
|
109275
|
+
/**
|
|
109276
|
+
* Adds a new planning group
|
|
109277
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
108711
109278
|
* @param {String} businessUnitId The ID of the business unit.
|
|
108712
109279
|
* @param {Object} body body
|
|
108713
109280
|
* @param {Object} opts Optional parameters
|
|
@@ -110728,13 +111295,14 @@ class WorkforceManagementApi {
|
|
|
110728
111295
|
|
|
110729
111296
|
/**
|
|
110730
111297
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
110731
|
-
*
|
|
111298
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
110732
111299
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110733
111300
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110734
111301
|
* @param {String} tradeId The ID of the shift trade to update
|
|
110735
111302
|
* @param {Object} body body
|
|
110736
111303
|
* @param {Object} opts Optional parameters
|
|
110737
111304
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111305
|
+
* @deprecated
|
|
110738
111306
|
*/
|
|
110739
111307
|
postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
110740
111308
|
opts = opts || {};
|
|
@@ -110773,12 +111341,13 @@ class WorkforceManagementApi {
|
|
|
110773
111341
|
|
|
110774
111342
|
/**
|
|
110775
111343
|
* Adds a shift trade
|
|
110776
|
-
*
|
|
111344
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
110777
111345
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110778
111346
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110779
111347
|
* @param {Object} body body
|
|
110780
111348
|
* @param {Object} opts Optional parameters
|
|
110781
111349
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111350
|
+
* @deprecated
|
|
110782
111351
|
*/
|
|
110783
111352
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body, opts) {
|
|
110784
111353
|
opts = opts || {};
|
|
@@ -110813,13 +111382,14 @@ class WorkforceManagementApi {
|
|
|
110813
111382
|
|
|
110814
111383
|
/**
|
|
110815
111384
|
* Searches for potential shift trade matches for the current agent
|
|
110816
|
-
*
|
|
111385
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
110817
111386
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110818
111387
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110819
111388
|
* @param {Object} body body
|
|
110820
111389
|
* @param {Object} opts Optional parameters
|
|
110821
111390
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110822
111391
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111392
|
+
* @deprecated
|
|
110823
111393
|
*/
|
|
110824
111394
|
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
110825
111395
|
opts = opts || {};
|
|
@@ -110854,13 +111424,14 @@ class WorkforceManagementApi {
|
|
|
110854
111424
|
|
|
110855
111425
|
/**
|
|
110856
111426
|
* Updates the state of a batch of shift trades
|
|
110857
|
-
* Admin functionality is not supported with "mine".
|
|
111427
|
+
* Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
|
|
110858
111428
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110859
111429
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110860
111430
|
* @param {Object} body body
|
|
110861
111431
|
* @param {Object} opts Optional parameters
|
|
110862
111432
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110863
111433
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111434
|
+
* @deprecated
|
|
110864
111435
|
*/
|
|
110865
111436
|
postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, opts) {
|
|
110866
111437
|
opts = opts || {};
|
|
@@ -111769,7 +112340,7 @@ class WorkforceManagementApi {
|
|
|
111769
112340
|
* </pre>
|
|
111770
112341
|
* </p>
|
|
111771
112342
|
* @module purecloud-platform-client-v2/index
|
|
111772
|
-
* @version
|
|
112343
|
+
* @version 253.0.0
|
|
111773
112344
|
*/
|
|
111774
112345
|
class platformClient {
|
|
111775
112346
|
constructor() {
|