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
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 253.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -1419,9 +1419,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1419
1419
|
// Get access token from response
|
|
1420
1420
|
var access_token = response.data.access_token;
|
|
1421
1421
|
|
|
1422
|
-
|
|
1423
|
-
|
|
1424
|
-
|
|
1422
|
+
let optsSettings = { accessToken: access_token };
|
|
1423
|
+
if (response.data['expires_in'] !== null && response.data['expires_in'] !== undefined) {
|
|
1424
|
+
optsSettings.tokenExpiryTime = new Date().getTime() + response.data['expires_in'] * 1000;
|
|
1425
|
+
optsSettings.tokenExpiryTimeString = new Date(optsSettings.tokenExpiryTime).toUTCString();
|
|
1426
|
+
}
|
|
1427
|
+
this._saveSettings(optsSettings);
|
|
1425
1428
|
|
|
1426
1429
|
// Return auth data
|
|
1427
1430
|
resolve(this.authData);
|
|
@@ -1545,9 +1548,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
1545
1548
|
return new Promise((resolve, reject) => {
|
|
1546
1549
|
// Abort if org and provider are not set together
|
|
1547
1550
|
if (opts.org && !opts.provider) {
|
|
1548
|
-
reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1551
|
+
return reject(new Error('opts.provider must be set if opts.org is set'));
|
|
1549
1552
|
} else if (opts.provider && !opts.org) {
|
|
1550
|
-
reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1553
|
+
return reject(new Error('opts.org must be set if opts.provider is set'));
|
|
1551
1554
|
}
|
|
1552
1555
|
|
|
1553
1556
|
// Abort on auth error
|
|
@@ -2433,7 +2436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2433
2436
|
/**
|
|
2434
2437
|
* AIStudio service.
|
|
2435
2438
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2436
|
-
* @version
|
|
2439
|
+
* @version 253.0.0
|
|
2437
2440
|
*/
|
|
2438
2441
|
|
|
2439
2442
|
/**
|
|
@@ -2542,12 +2545,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2542
2545
|
* Get all summary settings.
|
|
2543
2546
|
*
|
|
2544
2547
|
* @param {Object} opts Optional parameters
|
|
2545
|
-
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2546
|
-
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2547
|
-
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2548
|
-
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2549
2548
|
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2550
2549
|
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2550
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2551
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2552
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2553
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2551
2554
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2552
2555
|
*/
|
|
2553
2556
|
getConversationsSummariesSettings(opts) {
|
|
@@ -2558,7 +2561,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2558
2561
|
'/api/v2/conversations/summaries/settings',
|
|
2559
2562
|
'GET',
|
|
2560
2563
|
{ },
|
|
2561
|
-
{ '
|
|
2564
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'],'sortOrder': opts['sortOrder'],'language': opts['language'],'sortBy': opts['sortBy'] },
|
|
2562
2565
|
{ },
|
|
2563
2566
|
{ },
|
|
2564
2567
|
null,
|
|
@@ -3148,7 +3151,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3148
3151
|
/**
|
|
3149
3152
|
* AgentAssistants service.
|
|
3150
3153
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3151
|
-
* @version
|
|
3154
|
+
* @version 253.0.0
|
|
3152
3155
|
*/
|
|
3153
3156
|
|
|
3154
3157
|
/**
|
|
@@ -3504,6 +3507,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3504
3507
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
3505
3508
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
3506
3509
|
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
3510
|
+
* @param {Array.<String>} opts.agentChecklistIds Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
|
|
3507
3511
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3508
3512
|
*/
|
|
3509
3513
|
getAssistantsAgentchecklists(opts) {
|
|
@@ -3514,7 +3518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3514
3518
|
'/api/v2/assistants/agentchecklists',
|
|
3515
3519
|
'GET',
|
|
3516
3520
|
{ },
|
|
3517
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
3521
|
+
{ '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') },
|
|
3518
3522
|
{ },
|
|
3519
3523
|
{ },
|
|
3520
3524
|
null,
|
|
@@ -3952,7 +3956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3952
3956
|
/**
|
|
3953
3957
|
* AgentCopilot service.
|
|
3954
3958
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3955
|
-
* @version
|
|
3959
|
+
* @version 253.0.0
|
|
3956
3960
|
*/
|
|
3957
3961
|
|
|
3958
3962
|
/**
|
|
@@ -4064,7 +4068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4064
4068
|
/**
|
|
4065
4069
|
* AgentUI service.
|
|
4066
4070
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4067
|
-
* @version
|
|
4071
|
+
* @version 253.0.0
|
|
4068
4072
|
*/
|
|
4069
4073
|
|
|
4070
4074
|
/**
|
|
@@ -4215,7 +4219,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4215
4219
|
/**
|
|
4216
4220
|
* Alerting service.
|
|
4217
4221
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4218
|
-
* @version
|
|
4222
|
+
* @version 253.0.0
|
|
4219
4223
|
*/
|
|
4220
4224
|
|
|
4221
4225
|
/**
|
|
@@ -4676,7 +4680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4676
4680
|
/**
|
|
4677
4681
|
* Analytics service.
|
|
4678
4682
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4679
|
-
* @version
|
|
4683
|
+
* @version 253.0.0
|
|
4680
4684
|
*/
|
|
4681
4685
|
|
|
4682
4686
|
/**
|
|
@@ -8962,7 +8966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8962
8966
|
/**
|
|
8963
8967
|
* Architect service.
|
|
8964
8968
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8965
|
-
* @version
|
|
8969
|
+
* @version 253.0.0
|
|
8966
8970
|
*/
|
|
8967
8971
|
|
|
8968
8972
|
/**
|
|
@@ -13216,6 +13220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13216
13220
|
* 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.
|
|
13217
13221
|
*
|
|
13218
13222
|
* @param {Object} opts Optional parameters
|
|
13223
|
+
* @param {Object} opts.body
|
|
13219
13224
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13220
13225
|
*/
|
|
13221
13226
|
postFlowsJobs(opts) {
|
|
@@ -13229,7 +13234,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13229
13234
|
{ },
|
|
13230
13235
|
{ },
|
|
13231
13236
|
{ },
|
|
13232
|
-
|
|
13237
|
+
opts['body'],
|
|
13233
13238
|
['PureCloud OAuth'],
|
|
13234
13239
|
['application/json'],
|
|
13235
13240
|
['application/json'],
|
|
@@ -13821,7 +13826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13821
13826
|
/**
|
|
13822
13827
|
* AssistantCopilotVariations service.
|
|
13823
13828
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13824
|
-
* @version
|
|
13829
|
+
* @version 253.0.0
|
|
13825
13830
|
*/
|
|
13826
13831
|
|
|
13827
13832
|
/**
|
|
@@ -14017,7 +14022,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14017
14022
|
/**
|
|
14018
14023
|
* Audit service.
|
|
14019
14024
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14020
|
-
* @version
|
|
14025
|
+
* @version 253.0.0
|
|
14021
14026
|
*/
|
|
14022
14027
|
|
|
14023
14028
|
/**
|
|
@@ -14244,7 +14249,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14244
14249
|
/**
|
|
14245
14250
|
* Authorization service.
|
|
14246
14251
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14247
|
-
* @version
|
|
14252
|
+
* @version 253.0.0
|
|
14248
14253
|
*/
|
|
14249
14254
|
|
|
14250
14255
|
/**
|
|
@@ -16169,7 +16174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16169
16174
|
/**
|
|
16170
16175
|
* BackgroundAssistant service.
|
|
16171
16176
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16172
|
-
* @version
|
|
16177
|
+
* @version 253.0.0
|
|
16173
16178
|
*/
|
|
16174
16179
|
|
|
16175
16180
|
/**
|
|
@@ -16243,7 +16248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16243
16248
|
/**
|
|
16244
16249
|
* Billing service.
|
|
16245
16250
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16246
|
-
* @version
|
|
16251
|
+
* @version 253.0.0
|
|
16247
16252
|
*/
|
|
16248
16253
|
|
|
16249
16254
|
/**
|
|
@@ -16527,7 +16532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16527
16532
|
/**
|
|
16528
16533
|
* BusinessRules service.
|
|
16529
16534
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16530
|
-
* @version
|
|
16535
|
+
* @version 253.0.0
|
|
16531
16536
|
*/
|
|
16532
16537
|
|
|
16533
16538
|
/**
|
|
@@ -17541,7 +17546,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17541
17546
|
/**
|
|
17542
17547
|
* CarrierServices service.
|
|
17543
17548
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17544
|
-
* @version
|
|
17549
|
+
* @version 253.0.0
|
|
17545
17550
|
*/
|
|
17546
17551
|
|
|
17547
17552
|
/**
|
|
@@ -17618,7 +17623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17618
17623
|
/**
|
|
17619
17624
|
* CaseManagement service.
|
|
17620
17625
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17621
|
-
* @version
|
|
17626
|
+
* @version 253.0.0
|
|
17622
17627
|
*/
|
|
17623
17628
|
|
|
17624
17629
|
/**
|
|
@@ -18911,7 +18916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18911
18916
|
/**
|
|
18912
18917
|
* Chat service.
|
|
18913
18918
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18914
|
-
* @version
|
|
18919
|
+
* @version 253.0.0
|
|
18915
18920
|
*/
|
|
18916
18921
|
|
|
18917
18922
|
/**
|
|
@@ -20050,7 +20055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20050
20055
|
/**
|
|
20051
20056
|
* Coaching service.
|
|
20052
20057
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
20053
|
-
* @version
|
|
20058
|
+
* @version 253.0.0
|
|
20054
20059
|
*/
|
|
20055
20060
|
|
|
20056
20061
|
/**
|
|
@@ -20764,7 +20769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20764
20769
|
/**
|
|
20765
20770
|
* ContentManagement service.
|
|
20766
20771
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20767
|
-
* @version
|
|
20772
|
+
* @version 253.0.0
|
|
20768
20773
|
*/
|
|
20769
20774
|
|
|
20770
20775
|
/**
|
|
@@ -21959,7 +21964,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21959
21964
|
/**
|
|
21960
21965
|
* Conversations service.
|
|
21961
21966
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21962
|
-
* @version
|
|
21967
|
+
* @version 253.0.0
|
|
21963
21968
|
*/
|
|
21964
21969
|
|
|
21965
21970
|
/**
|
|
@@ -33065,7 +33070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33065
33070
|
/**
|
|
33066
33071
|
* DataExtensions service.
|
|
33067
33072
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
33068
|
-
* @version
|
|
33073
|
+
* @version 253.0.0
|
|
33069
33074
|
*/
|
|
33070
33075
|
|
|
33071
33076
|
/**
|
|
@@ -33166,7 +33171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33166
33171
|
/**
|
|
33167
33172
|
* DataPrivacy service.
|
|
33168
33173
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33169
|
-
* @version
|
|
33174
|
+
* @version 253.0.0
|
|
33170
33175
|
*/
|
|
33171
33176
|
|
|
33172
33177
|
/**
|
|
@@ -33363,7 +33368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33363
33368
|
/**
|
|
33364
33369
|
* Downloads service.
|
|
33365
33370
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33366
|
-
* @version
|
|
33371
|
+
* @version 253.0.0
|
|
33367
33372
|
*/
|
|
33368
33373
|
|
|
33369
33374
|
/**
|
|
@@ -33417,7 +33422,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33417
33422
|
/**
|
|
33418
33423
|
* Emails service.
|
|
33419
33424
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33420
|
-
* @version
|
|
33425
|
+
* @version 253.0.0
|
|
33421
33426
|
*/
|
|
33422
33427
|
|
|
33423
33428
|
/**
|
|
@@ -33565,7 +33570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33565
33570
|
/**
|
|
33566
33571
|
* EmployeeEngagement service.
|
|
33567
33572
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33568
|
-
* @version
|
|
33573
|
+
* @version 253.0.0
|
|
33569
33574
|
*/
|
|
33570
33575
|
|
|
33571
33576
|
/**
|
|
@@ -33769,7 +33774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33769
33774
|
/**
|
|
33770
33775
|
* Events service.
|
|
33771
33776
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33772
|
-
* @version
|
|
33777
|
+
* @version 253.0.0
|
|
33773
33778
|
*/
|
|
33774
33779
|
|
|
33775
33780
|
/**
|
|
@@ -33911,7 +33916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33911
33916
|
/**
|
|
33912
33917
|
* ExternalContacts service.
|
|
33913
33918
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33914
|
-
* @version
|
|
33919
|
+
* @version 253.0.0
|
|
33915
33920
|
*/
|
|
33916
33921
|
|
|
33917
33922
|
/**
|
|
@@ -37682,7 +37687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37682
37687
|
/**
|
|
37683
37688
|
* Fax service.
|
|
37684
37689
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37685
|
-
* @version
|
|
37690
|
+
* @version 253.0.0
|
|
37686
37691
|
*/
|
|
37687
37692
|
|
|
37688
37693
|
/**
|
|
@@ -37931,7 +37936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37931
37936
|
/**
|
|
37932
37937
|
* Flows service.
|
|
37933
37938
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37934
|
-
* @version
|
|
37939
|
+
* @version 253.0.0
|
|
37935
37940
|
*/
|
|
37936
37941
|
|
|
37937
37942
|
/**
|
|
@@ -38169,7 +38174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38169
38174
|
/**
|
|
38170
38175
|
* Gamification service.
|
|
38171
38176
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38172
|
-
* @version
|
|
38177
|
+
* @version 253.0.0
|
|
38173
38178
|
*/
|
|
38174
38179
|
|
|
38175
38180
|
/**
|
|
@@ -41021,7 +41026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41021
41026
|
/**
|
|
41022
41027
|
* GeneralDataProtectionRegulation service.
|
|
41023
41028
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
41024
|
-
* @version
|
|
41029
|
+
* @version 253.0.0
|
|
41025
41030
|
*/
|
|
41026
41031
|
|
|
41027
41032
|
/**
|
|
@@ -41165,7 +41170,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41165
41170
|
/**
|
|
41166
41171
|
* Geolocation service.
|
|
41167
41172
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
41168
|
-
* @version
|
|
41173
|
+
* @version 253.0.0
|
|
41169
41174
|
*/
|
|
41170
41175
|
|
|
41171
41176
|
/**
|
|
@@ -41316,7 +41321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41316
41321
|
/**
|
|
41317
41322
|
* Greetings service.
|
|
41318
41323
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41319
|
-
* @version
|
|
41324
|
+
* @version 253.0.0
|
|
41320
41325
|
*/
|
|
41321
41326
|
|
|
41322
41327
|
/**
|
|
@@ -41932,7 +41937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41932
41937
|
/**
|
|
41933
41938
|
* Groups service.
|
|
41934
41939
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41935
|
-
* @version
|
|
41940
|
+
* @version 253.0.0
|
|
41936
41941
|
*/
|
|
41937
41942
|
|
|
41938
41943
|
/**
|
|
@@ -42523,7 +42528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42523
42528
|
/**
|
|
42524
42529
|
* IdentityProvider service.
|
|
42525
42530
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
42526
|
-
* @version
|
|
42531
|
+
* @version 253.0.0
|
|
42527
42532
|
*/
|
|
42528
42533
|
|
|
42529
42534
|
/**
|
|
@@ -43574,7 +43579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43574
43579
|
/**
|
|
43575
43580
|
* InfrastructureAsCode service.
|
|
43576
43581
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43577
|
-
* @version
|
|
43582
|
+
* @version 253.0.0
|
|
43578
43583
|
*/
|
|
43579
43584
|
|
|
43580
43585
|
/**
|
|
@@ -43754,7 +43759,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43754
43759
|
/**
|
|
43755
43760
|
* Integrations service.
|
|
43756
43761
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43757
|
-
* @version
|
|
43762
|
+
* @version 253.0.0
|
|
43758
43763
|
*/
|
|
43759
43764
|
|
|
43760
43765
|
/**
|
|
@@ -46726,7 +46731,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46726
46731
|
/**
|
|
46727
46732
|
* Intents service.
|
|
46728
46733
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46729
|
-
* @version
|
|
46734
|
+
* @version 253.0.0
|
|
46730
46735
|
*/
|
|
46731
46736
|
|
|
46732
46737
|
/**
|
|
@@ -47258,7 +47263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47258
47263
|
/**
|
|
47259
47264
|
* Journey service.
|
|
47260
47265
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47261
|
-
* @version
|
|
47266
|
+
* @version 253.0.0
|
|
47262
47267
|
*/
|
|
47263
47268
|
|
|
47264
47269
|
/**
|
|
@@ -47831,11 +47836,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47831
47836
|
}
|
|
47832
47837
|
|
|
47833
47838
|
/**
|
|
47834
|
-
* Retrieve a single action target.
|
|
47835
|
-
*
|
|
47839
|
+
* Deprecated. Retrieve a single action target.
|
|
47840
|
+
* 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
|
|
47836
47841
|
* @param {String} actionTargetId ID of the action target.
|
|
47837
47842
|
* @param {Object} opts Optional parameters
|
|
47838
47843
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47844
|
+
* @deprecated
|
|
47839
47845
|
*/
|
|
47840
47846
|
getJourneyActiontarget(actionTargetId, opts) {
|
|
47841
47847
|
opts = opts || {};
|
|
@@ -47861,12 +47867,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47861
47867
|
}
|
|
47862
47868
|
|
|
47863
47869
|
/**
|
|
47864
|
-
* Retrieve all action targets.
|
|
47865
|
-
*
|
|
47870
|
+
* Deprecated. Retrieve all action targets.
|
|
47871
|
+
* 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
|
|
47866
47872
|
* @param {Object} opts Optional parameters
|
|
47867
47873
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47868
47874
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47869
47875
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47876
|
+
* @deprecated
|
|
47870
47877
|
*/
|
|
47871
47878
|
getJourneyActiontargets(opts) {
|
|
47872
47879
|
opts = opts || {};
|
|
@@ -49036,6 +49043,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49036
49043
|
);
|
|
49037
49044
|
}
|
|
49038
49045
|
|
|
49046
|
+
/**
|
|
49047
|
+
* Get external events for journey views
|
|
49048
|
+
*
|
|
49049
|
+
* @param {Object} opts Optional parameters
|
|
49050
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49051
|
+
*/
|
|
49052
|
+
getJourneyViewsEventdefinitionsExternal(opts) {
|
|
49053
|
+
opts = opts || {};
|
|
49054
|
+
|
|
49055
|
+
|
|
49056
|
+
return this.apiClient.callApi(
|
|
49057
|
+
'/api/v2/journey/views/eventdefinitions/external',
|
|
49058
|
+
'GET',
|
|
49059
|
+
{ },
|
|
49060
|
+
{ },
|
|
49061
|
+
{ },
|
|
49062
|
+
{ },
|
|
49063
|
+
null,
|
|
49064
|
+
['PureCloud OAuth'],
|
|
49065
|
+
['application/json'],
|
|
49066
|
+
['application/json'],
|
|
49067
|
+
opts['customHeaders']
|
|
49068
|
+
);
|
|
49069
|
+
}
|
|
49070
|
+
|
|
49071
|
+
/**
|
|
49072
|
+
* Get changes in external event definitions
|
|
49073
|
+
*
|
|
49074
|
+
* @param {Object} opts Optional parameters
|
|
49075
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49076
|
+
*/
|
|
49077
|
+
getJourneyViewsEventdefinitionsExternalChanges(opts) {
|
|
49078
|
+
opts = opts || {};
|
|
49079
|
+
|
|
49080
|
+
|
|
49081
|
+
return this.apiClient.callApi(
|
|
49082
|
+
'/api/v2/journey/views/eventdefinitions/external/changes',
|
|
49083
|
+
'GET',
|
|
49084
|
+
{ },
|
|
49085
|
+
{ },
|
|
49086
|
+
{ },
|
|
49087
|
+
{ },
|
|
49088
|
+
null,
|
|
49089
|
+
['PureCloud OAuth'],
|
|
49090
|
+
['application/json'],
|
|
49091
|
+
['application/json'],
|
|
49092
|
+
opts['customHeaders']
|
|
49093
|
+
);
|
|
49094
|
+
}
|
|
49095
|
+
|
|
49039
49096
|
/**
|
|
49040
49097
|
* Get the jobs for an organization.
|
|
49041
49098
|
*
|
|
@@ -49153,12 +49210,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49153
49210
|
}
|
|
49154
49211
|
|
|
49155
49212
|
/**
|
|
49156
|
-
* Update a single action target.
|
|
49157
|
-
*
|
|
49213
|
+
* Deprecated. Update a single action target.
|
|
49214
|
+
* 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
|
|
49158
49215
|
* @param {String} actionTargetId ID of the action target.
|
|
49159
49216
|
* @param {Object} opts Optional parameters
|
|
49160
49217
|
* @param {Object} opts.body
|
|
49161
49218
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49219
|
+
* @deprecated
|
|
49162
49220
|
*/
|
|
49163
49221
|
patchJourneyActiontarget(actionTargetId, opts) {
|
|
49164
49222
|
opts = opts || {};
|
|
@@ -50117,13 +50175,75 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50117
50175
|
);
|
|
50118
50176
|
}
|
|
50119
50177
|
|
|
50178
|
+
/**
|
|
50179
|
+
* Update external event for journey views
|
|
50180
|
+
*
|
|
50181
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
50182
|
+
* @param {Object} opts Optional parameters
|
|
50183
|
+
* @param {Object} opts.body
|
|
50184
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50185
|
+
*/
|
|
50186
|
+
putJourneyViewsEventdefinition(eventDefinitionId, opts) {
|
|
50187
|
+
opts = opts || {};
|
|
50188
|
+
|
|
50189
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
50190
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
50191
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';
|
|
50192
|
+
}
|
|
50193
|
+
|
|
50194
|
+
return this.apiClient.callApi(
|
|
50195
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
50196
|
+
'PUT',
|
|
50197
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
50198
|
+
{ },
|
|
50199
|
+
{ },
|
|
50200
|
+
{ },
|
|
50201
|
+
opts['body'],
|
|
50202
|
+
['PureCloud OAuth'],
|
|
50203
|
+
['application/json'],
|
|
50204
|
+
['application/json'],
|
|
50205
|
+
opts['customHeaders']
|
|
50206
|
+
);
|
|
50207
|
+
}
|
|
50208
|
+
|
|
50209
|
+
/**
|
|
50210
|
+
* Activate external event for journey views
|
|
50211
|
+
*
|
|
50212
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
50213
|
+
* @param {Object} opts Optional parameters
|
|
50214
|
+
* @param {Object} opts.body
|
|
50215
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50216
|
+
*/
|
|
50217
|
+
putJourneyViewsEventdefinitionActivate(eventDefinitionId, opts) {
|
|
50218
|
+
opts = opts || {};
|
|
50219
|
+
|
|
50220
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
50221
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
50222
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';
|
|
50223
|
+
}
|
|
50224
|
+
|
|
50225
|
+
return this.apiClient.callApi(
|
|
50226
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate',
|
|
50227
|
+
'PUT',
|
|
50228
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
50229
|
+
{ },
|
|
50230
|
+
{ },
|
|
50231
|
+
{ },
|
|
50232
|
+
opts['body'],
|
|
50233
|
+
['PureCloud OAuth'],
|
|
50234
|
+
['application/json'],
|
|
50235
|
+
['application/json'],
|
|
50236
|
+
opts['customHeaders']
|
|
50237
|
+
);
|
|
50238
|
+
}
|
|
50239
|
+
|
|
50120
50240
|
}
|
|
50121
50241
|
|
|
50122
50242
|
class KnowledgeApi {
|
|
50123
50243
|
/**
|
|
50124
50244
|
* Knowledge service.
|
|
50125
50245
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
50126
|
-
* @version
|
|
50246
|
+
* @version 253.0.0
|
|
50127
50247
|
*/
|
|
50128
50248
|
|
|
50129
50249
|
/**
|
|
@@ -51322,6 +51442,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51322
51442
|
);
|
|
51323
51443
|
}
|
|
51324
51444
|
|
|
51445
|
+
/**
|
|
51446
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
51447
|
+
*
|
|
51448
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
51449
|
+
* @param {Object} opts Optional parameters
|
|
51450
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
51451
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
51452
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
51453
|
+
* @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.
|
|
51454
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
51455
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
51456
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
51457
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
51458
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
51459
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
51460
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
51461
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
51462
|
+
*/
|
|
51463
|
+
getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId, opts) {
|
|
51464
|
+
opts = opts || {};
|
|
51465
|
+
|
|
51466
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
51467
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
51468
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentsFeedback';
|
|
51469
|
+
}
|
|
51470
|
+
|
|
51471
|
+
return this.apiClient.callApi(
|
|
51472
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback',
|
|
51473
|
+
'GET',
|
|
51474
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
51475
|
+
{ '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'] },
|
|
51476
|
+
{ },
|
|
51477
|
+
{ },
|
|
51478
|
+
null,
|
|
51479
|
+
['PureCloud OAuth'],
|
|
51480
|
+
['application/json'],
|
|
51481
|
+
['application/json'],
|
|
51482
|
+
opts['customHeaders']
|
|
51483
|
+
);
|
|
51484
|
+
}
|
|
51485
|
+
|
|
51325
51486
|
/**
|
|
51326
51487
|
* Get export job report
|
|
51327
51488
|
*
|
|
@@ -54333,7 +54494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54333
54494
|
/**
|
|
54334
54495
|
* LanguageUnderstanding service.
|
|
54335
54496
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
54336
|
-
* @version
|
|
54497
|
+
* @version 253.0.0
|
|
54337
54498
|
*/
|
|
54338
54499
|
|
|
54339
54500
|
/**
|
|
@@ -55707,7 +55868,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55707
55868
|
/**
|
|
55708
55869
|
* Languages service.
|
|
55709
55870
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
55710
|
-
* @version
|
|
55871
|
+
* @version 253.0.0
|
|
55711
55872
|
*/
|
|
55712
55873
|
|
|
55713
55874
|
/**
|
|
@@ -55966,7 +56127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55966
56127
|
/**
|
|
55967
56128
|
* Learning service.
|
|
55968
56129
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
55969
|
-
* @version
|
|
56130
|
+
* @version 253.0.0
|
|
55970
56131
|
*/
|
|
55971
56132
|
|
|
55972
56133
|
/**
|
|
@@ -57214,7 +57375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57214
57375
|
/**
|
|
57215
57376
|
* License service.
|
|
57216
57377
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57217
|
-
* @version
|
|
57378
|
+
* @version 253.0.0
|
|
57218
57379
|
*/
|
|
57219
57380
|
|
|
57220
57381
|
/**
|
|
@@ -57512,7 +57673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57512
57673
|
/**
|
|
57513
57674
|
* Locations service.
|
|
57514
57675
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
57515
|
-
* @version
|
|
57676
|
+
* @version 253.0.0
|
|
57516
57677
|
*/
|
|
57517
57678
|
|
|
57518
57679
|
/**
|
|
@@ -57779,7 +57940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57779
57940
|
/**
|
|
57780
57941
|
* LogCapture service.
|
|
57781
57942
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
57782
|
-
* @version
|
|
57943
|
+
* @version 253.0.0
|
|
57783
57944
|
*/
|
|
57784
57945
|
|
|
57785
57946
|
/**
|
|
@@ -58001,7 +58162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58001
58162
|
/**
|
|
58002
58163
|
* Messaging service.
|
|
58003
58164
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
58004
|
-
* @version
|
|
58165
|
+
* @version 253.0.0
|
|
58005
58166
|
*/
|
|
58006
58167
|
|
|
58007
58168
|
/**
|
|
@@ -58419,7 +58580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58419
58580
|
/**
|
|
58420
58581
|
* MobileDevices service.
|
|
58421
58582
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
58422
|
-
* @version
|
|
58583
|
+
* @version 253.0.0
|
|
58423
58584
|
*/
|
|
58424
58585
|
|
|
58425
58586
|
/**
|
|
@@ -58589,7 +58750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58589
58750
|
/**
|
|
58590
58751
|
* Notifications service.
|
|
58591
58752
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
58592
|
-
* @version
|
|
58753
|
+
* @version 253.0.0
|
|
58593
58754
|
*/
|
|
58594
58755
|
|
|
58595
58756
|
/**
|
|
@@ -58850,7 +59011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58850
59011
|
/**
|
|
58851
59012
|
* OAuth service.
|
|
58852
59013
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
58853
|
-
* @version
|
|
59014
|
+
* @version 253.0.0
|
|
58854
59015
|
*/
|
|
58855
59016
|
|
|
58856
59017
|
/**
|
|
@@ -59266,7 +59427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59266
59427
|
/**
|
|
59267
59428
|
* Objects service.
|
|
59268
59429
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59269
|
-
* @version
|
|
59430
|
+
* @version 253.0.0
|
|
59270
59431
|
*/
|
|
59271
59432
|
|
|
59272
59433
|
/**
|
|
@@ -59630,7 +59791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59630
59791
|
/**
|
|
59631
59792
|
* OperationalEvents service.
|
|
59632
59793
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
59633
|
-
* @version
|
|
59794
|
+
* @version 253.0.0
|
|
59634
59795
|
*/
|
|
59635
59796
|
|
|
59636
59797
|
/**
|
|
@@ -59761,7 +59922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59761
59922
|
/**
|
|
59762
59923
|
* Organization service.
|
|
59763
59924
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
59764
|
-
* @version
|
|
59925
|
+
* @version 253.0.0
|
|
59765
59926
|
*/
|
|
59766
59927
|
|
|
59767
59928
|
/**
|
|
@@ -60322,7 +60483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60322
60483
|
/**
|
|
60323
60484
|
* OrganizationAuthorization service.
|
|
60324
60485
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60325
|
-
* @version
|
|
60486
|
+
* @version 253.0.0
|
|
60326
60487
|
*/
|
|
60327
60488
|
|
|
60328
60489
|
/**
|
|
@@ -61926,7 +62087,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61926
62087
|
/**
|
|
61927
62088
|
* Outbound service.
|
|
61928
62089
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
61929
|
-
* @version
|
|
62090
|
+
* @version 253.0.0
|
|
61930
62091
|
*/
|
|
61931
62092
|
|
|
61932
62093
|
/**
|
|
@@ -67513,7 +67674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67513
67674
|
/**
|
|
67514
67675
|
* Presence service.
|
|
67515
67676
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
67516
|
-
* @version
|
|
67677
|
+
* @version 253.0.0
|
|
67517
67678
|
*/
|
|
67518
67679
|
|
|
67519
67680
|
/**
|
|
@@ -68371,7 +68532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68371
68532
|
/**
|
|
68372
68533
|
* ProcessAutomation service.
|
|
68373
68534
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
68374
|
-
* @version
|
|
68535
|
+
* @version 253.0.0
|
|
68375
68536
|
*/
|
|
68376
68537
|
|
|
68377
68538
|
/**
|
|
@@ -68792,7 +68953,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68792
68953
|
/**
|
|
68793
68954
|
* Quality service.
|
|
68794
68955
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
68795
|
-
* @version
|
|
68956
|
+
* @version 253.0.0
|
|
68796
68957
|
*/
|
|
68797
68958
|
|
|
68798
68959
|
/**
|
|
@@ -71150,7 +71311,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71150
71311
|
/**
|
|
71151
71312
|
* Recording service.
|
|
71152
71313
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
71153
|
-
* @version
|
|
71314
|
+
* @version 253.0.0
|
|
71154
71315
|
*/
|
|
71155
71316
|
|
|
71156
71317
|
/**
|
|
@@ -72998,7 +73159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
72998
73159
|
/**
|
|
72999
73160
|
* ResponseManagement service.
|
|
73000
73161
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
73001
|
-
* @version
|
|
73162
|
+
* @version 253.0.0
|
|
73002
73163
|
*/
|
|
73003
73164
|
|
|
73004
73165
|
/**
|
|
@@ -73642,7 +73803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73642
73803
|
/**
|
|
73643
73804
|
* Routing service.
|
|
73644
73805
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
73645
|
-
* @version
|
|
73806
|
+
* @version 253.0.0
|
|
73646
73807
|
*/
|
|
73647
73808
|
|
|
73648
73809
|
/**
|
|
@@ -74090,6 +74251,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74090
74251
|
);
|
|
74091
74252
|
}
|
|
74092
74253
|
|
|
74254
|
+
/**
|
|
74255
|
+
* Archive a skill expression to remove it from the set of active expressions
|
|
74256
|
+
*
|
|
74257
|
+
* @param {String} expressionId Expression ID
|
|
74258
|
+
* @param {Object} opts Optional parameters
|
|
74259
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74260
|
+
*/
|
|
74261
|
+
deleteRoutingSkillexpression(expressionId, opts) {
|
|
74262
|
+
opts = opts || {};
|
|
74263
|
+
|
|
74264
|
+
// verify the required parameter 'expressionId' is set
|
|
74265
|
+
if (expressionId === undefined || expressionId === null || expressionId === '') {
|
|
74266
|
+
throw 'Missing the required parameter "expressionId" when calling deleteRoutingSkillexpression';
|
|
74267
|
+
}
|
|
74268
|
+
|
|
74269
|
+
return this.apiClient.callApi(
|
|
74270
|
+
'/api/v2/routing/skillexpressions/{expressionId}',
|
|
74271
|
+
'DELETE',
|
|
74272
|
+
{ 'expressionId': expressionId },
|
|
74273
|
+
{ },
|
|
74274
|
+
{ },
|
|
74275
|
+
{ },
|
|
74276
|
+
null,
|
|
74277
|
+
['PureCloud OAuth'],
|
|
74278
|
+
['application/json'],
|
|
74279
|
+
['application/json'],
|
|
74280
|
+
opts['customHeaders']
|
|
74281
|
+
);
|
|
74282
|
+
}
|
|
74283
|
+
|
|
74284
|
+
/**
|
|
74285
|
+
* Archive a set of skill expressions to remove them from the set of active expressions
|
|
74286
|
+
*
|
|
74287
|
+
* @param {Object} opts Optional parameters
|
|
74288
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
74289
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74290
|
+
*/
|
|
74291
|
+
deleteRoutingSkillexpressions(opts) {
|
|
74292
|
+
opts = opts || {};
|
|
74293
|
+
|
|
74294
|
+
|
|
74295
|
+
return this.apiClient.callApi(
|
|
74296
|
+
'/api/v2/routing/skillexpressions',
|
|
74297
|
+
'DELETE',
|
|
74298
|
+
{ },
|
|
74299
|
+
{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
74300
|
+
{ },
|
|
74301
|
+
{ },
|
|
74302
|
+
null,
|
|
74303
|
+
['PureCloud OAuth'],
|
|
74304
|
+
['application/json'],
|
|
74305
|
+
['application/json'],
|
|
74306
|
+
opts['customHeaders']
|
|
74307
|
+
);
|
|
74308
|
+
}
|
|
74309
|
+
|
|
74093
74310
|
/**
|
|
74094
74311
|
* Remove skill group definition
|
|
74095
74312
|
*
|
|
@@ -74296,38 +74513,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74296
74513
|
);
|
|
74297
74514
|
}
|
|
74298
74515
|
|
|
74299
|
-
/**
|
|
74300
|
-
* Delete an utilization tag
|
|
74301
|
-
*
|
|
74302
|
-
* @param {String} tagId Utilization Tag ID
|
|
74303
|
-
* @param {Object} opts Optional parameters
|
|
74304
|
-
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
74305
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74306
|
-
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
74307
|
-
*/
|
|
74308
|
-
deleteRoutingUtilizationTag(tagId, opts) {
|
|
74309
|
-
opts = opts || {};
|
|
74310
|
-
|
|
74311
|
-
// verify the required parameter 'tagId' is set
|
|
74312
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
74313
|
-
throw 'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';
|
|
74314
|
-
}
|
|
74315
|
-
|
|
74316
|
-
return this.apiClient.callApi(
|
|
74317
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
74318
|
-
'DELETE',
|
|
74319
|
-
{ 'tagId': tagId },
|
|
74320
|
-
{ 'forceDelete': opts['forceDelete'] },
|
|
74321
|
-
{ },
|
|
74322
|
-
{ },
|
|
74323
|
-
null,
|
|
74324
|
-
['PureCloud OAuth'],
|
|
74325
|
-
['application/json'],
|
|
74326
|
-
['application/json'],
|
|
74327
|
-
opts['customHeaders']
|
|
74328
|
-
);
|
|
74329
|
-
}
|
|
74330
|
-
|
|
74331
74516
|
/**
|
|
74332
74517
|
* Delete wrap-up code
|
|
74333
74518
|
*
|
|
@@ -75868,6 +76053,98 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75868
76053
|
);
|
|
75869
76054
|
}
|
|
75870
76055
|
|
|
76056
|
+
/**
|
|
76057
|
+
* Get a skill expression by ID
|
|
76058
|
+
*
|
|
76059
|
+
* @param {String} expressionId Expression ID
|
|
76060
|
+
* @param {Object} opts Optional parameters
|
|
76061
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76062
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76063
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76064
|
+
*/
|
|
76065
|
+
getRoutingSkillexpression(expressionId, opts) {
|
|
76066
|
+
opts = opts || {};
|
|
76067
|
+
|
|
76068
|
+
// verify the required parameter 'expressionId' is set
|
|
76069
|
+
if (expressionId === undefined || expressionId === null || expressionId === '') {
|
|
76070
|
+
throw 'Missing the required parameter "expressionId" when calling getRoutingSkillexpression';
|
|
76071
|
+
}
|
|
76072
|
+
|
|
76073
|
+
return this.apiClient.callApi(
|
|
76074
|
+
'/api/v2/routing/skillexpressions/{expressionId}',
|
|
76075
|
+
'GET',
|
|
76076
|
+
{ 'expressionId': expressionId },
|
|
76077
|
+
{ 'includeArchived': opts['includeArchived'],'format': opts['format'] },
|
|
76078
|
+
{ },
|
|
76079
|
+
{ },
|
|
76080
|
+
null,
|
|
76081
|
+
['PureCloud OAuth'],
|
|
76082
|
+
['application/json'],
|
|
76083
|
+
['application/json'],
|
|
76084
|
+
opts['customHeaders']
|
|
76085
|
+
);
|
|
76086
|
+
}
|
|
76087
|
+
|
|
76088
|
+
/**
|
|
76089
|
+
* Get skill expressions
|
|
76090
|
+
*
|
|
76091
|
+
* @param {Object} opts Optional parameters
|
|
76092
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76093
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76094
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
76095
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76096
|
+
*/
|
|
76097
|
+
getRoutingSkillexpressions(opts) {
|
|
76098
|
+
opts = opts || {};
|
|
76099
|
+
|
|
76100
|
+
|
|
76101
|
+
return this.apiClient.callApi(
|
|
76102
|
+
'/api/v2/routing/skillexpressions',
|
|
76103
|
+
'GET',
|
|
76104
|
+
{ },
|
|
76105
|
+
{ 'format': opts['format'],'includeArchived': opts['includeArchived'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
76106
|
+
{ },
|
|
76107
|
+
{ },
|
|
76108
|
+
null,
|
|
76109
|
+
['PureCloud OAuth'],
|
|
76110
|
+
['application/json'],
|
|
76111
|
+
['application/json'],
|
|
76112
|
+
opts['customHeaders']
|
|
76113
|
+
);
|
|
76114
|
+
}
|
|
76115
|
+
|
|
76116
|
+
/**
|
|
76117
|
+
* Get skill expressions associated with a queue
|
|
76118
|
+
*
|
|
76119
|
+
* @param {String} queueId Queue ID
|
|
76120
|
+
* @param {Object} opts Optional parameters
|
|
76121
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76122
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76123
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76124
|
+
*/
|
|
76125
|
+
getRoutingSkillexpressionsQueueQueueId(queueId, opts) {
|
|
76126
|
+
opts = opts || {};
|
|
76127
|
+
|
|
76128
|
+
// verify the required parameter 'queueId' is set
|
|
76129
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
76130
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingSkillexpressionsQueueQueueId';
|
|
76131
|
+
}
|
|
76132
|
+
|
|
76133
|
+
return this.apiClient.callApi(
|
|
76134
|
+
'/api/v2/routing/skillexpressions/queue/{queueId}',
|
|
76135
|
+
'GET',
|
|
76136
|
+
{ 'queueId': queueId },
|
|
76137
|
+
{ 'format': opts['format'],'includeArchived': opts['includeArchived'] },
|
|
76138
|
+
{ },
|
|
76139
|
+
{ },
|
|
76140
|
+
null,
|
|
76141
|
+
['PureCloud OAuth'],
|
|
76142
|
+
['application/json'],
|
|
76143
|
+
['application/json'],
|
|
76144
|
+
opts['customHeaders']
|
|
76145
|
+
);
|
|
76146
|
+
}
|
|
76147
|
+
|
|
75871
76148
|
/**
|
|
75872
76149
|
* Get skill group
|
|
75873
76150
|
*
|
|
@@ -76390,98 +76667,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76390
76667
|
);
|
|
76391
76668
|
}
|
|
76392
76669
|
|
|
76393
|
-
/**
|
|
76394
|
-
* Get details about this utilization tag
|
|
76395
|
-
*
|
|
76396
|
-
* @param {String} tagId Utilization Tag ID
|
|
76397
|
-
* @param {Object} opts Optional parameters
|
|
76398
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76399
|
-
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76400
|
-
*/
|
|
76401
|
-
getRoutingUtilizationTag(tagId, opts) {
|
|
76402
|
-
opts = opts || {};
|
|
76403
|
-
|
|
76404
|
-
// verify the required parameter 'tagId' is set
|
|
76405
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76406
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';
|
|
76407
|
-
}
|
|
76408
|
-
|
|
76409
|
-
return this.apiClient.callApi(
|
|
76410
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
76411
|
-
'GET',
|
|
76412
|
-
{ 'tagId': tagId },
|
|
76413
|
-
{ },
|
|
76414
|
-
{ },
|
|
76415
|
-
{ },
|
|
76416
|
-
null,
|
|
76417
|
-
['PureCloud OAuth'],
|
|
76418
|
-
['application/json'],
|
|
76419
|
-
['application/json'],
|
|
76420
|
-
opts['customHeaders']
|
|
76421
|
-
);
|
|
76422
|
-
}
|
|
76423
|
-
|
|
76424
|
-
/**
|
|
76425
|
-
* Get list of agent ids associated with a utilization tag
|
|
76426
|
-
*
|
|
76427
|
-
* @param {String} tagId Utilization Tag ID
|
|
76428
|
-
* @param {Object} opts Optional parameters
|
|
76429
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76430
|
-
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76431
|
-
*/
|
|
76432
|
-
getRoutingUtilizationTagAgents(tagId, opts) {
|
|
76433
|
-
opts = opts || {};
|
|
76434
|
-
|
|
76435
|
-
// verify the required parameter 'tagId' is set
|
|
76436
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76437
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';
|
|
76438
|
-
}
|
|
76439
|
-
|
|
76440
|
-
return this.apiClient.callApi(
|
|
76441
|
-
'/api/v2/routing/utilization/tags/{tagId}/agents',
|
|
76442
|
-
'GET',
|
|
76443
|
-
{ 'tagId': tagId },
|
|
76444
|
-
{ },
|
|
76445
|
-
{ },
|
|
76446
|
-
{ },
|
|
76447
|
-
null,
|
|
76448
|
-
['PureCloud OAuth'],
|
|
76449
|
-
['application/json'],
|
|
76450
|
-
['application/json'],
|
|
76451
|
-
opts['customHeaders']
|
|
76452
|
-
);
|
|
76453
|
-
}
|
|
76454
|
-
|
|
76455
|
-
/**
|
|
76456
|
-
* Get list of utilization tags
|
|
76457
|
-
*
|
|
76458
|
-
* @param {Object} opts Optional parameters
|
|
76459
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
76460
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
76461
|
-
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
76462
|
-
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
76463
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76464
|
-
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76465
|
-
*/
|
|
76466
|
-
getRoutingUtilizationTags(opts) {
|
|
76467
|
-
opts = opts || {};
|
|
76468
|
-
|
|
76469
|
-
|
|
76470
|
-
return this.apiClient.callApi(
|
|
76471
|
-
'/api/v2/routing/utilization/tags',
|
|
76472
|
-
'GET',
|
|
76473
|
-
{ },
|
|
76474
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
76475
|
-
{ },
|
|
76476
|
-
{ },
|
|
76477
|
-
null,
|
|
76478
|
-
['PureCloud OAuth'],
|
|
76479
|
-
['application/json'],
|
|
76480
|
-
['application/json'],
|
|
76481
|
-
opts['customHeaders']
|
|
76482
|
-
);
|
|
76483
|
-
}
|
|
76484
|
-
|
|
76485
76670
|
/**
|
|
76486
76671
|
* Get details about this wrap-up code.
|
|
76487
76672
|
*
|
|
@@ -78065,6 +78250,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78065
78250
|
);
|
|
78066
78251
|
}
|
|
78067
78252
|
|
|
78253
|
+
/**
|
|
78254
|
+
* Validate and normalize a skill expression
|
|
78255
|
+
*
|
|
78256
|
+
* @param {Object} body Skill expression data to validate
|
|
78257
|
+
* @param {Object} opts Optional parameters
|
|
78258
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78259
|
+
*/
|
|
78260
|
+
postRoutingSkillexpressionsValidate(body, opts) {
|
|
78261
|
+
opts = opts || {};
|
|
78262
|
+
|
|
78263
|
+
// verify the required parameter 'body' is set
|
|
78264
|
+
if (body === undefined || body === null) {
|
|
78265
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillexpressionsValidate';
|
|
78266
|
+
}
|
|
78267
|
+
|
|
78268
|
+
return this.apiClient.callApi(
|
|
78269
|
+
'/api/v2/routing/skillexpressions/validate',
|
|
78270
|
+
'POST',
|
|
78271
|
+
{ },
|
|
78272
|
+
{ },
|
|
78273
|
+
{ },
|
|
78274
|
+
{ },
|
|
78275
|
+
body,
|
|
78276
|
+
['PureCloud OAuth'],
|
|
78277
|
+
['application/json'],
|
|
78278
|
+
['application/json'],
|
|
78279
|
+
opts['customHeaders']
|
|
78280
|
+
);
|
|
78281
|
+
}
|
|
78282
|
+
|
|
78068
78283
|
/**
|
|
78069
78284
|
* Add or remove member divisions for this skill group.
|
|
78070
78285
|
*
|
|
@@ -78307,37 +78522,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78307
78522
|
);
|
|
78308
78523
|
}
|
|
78309
78524
|
|
|
78310
|
-
/**
|
|
78311
|
-
* Create an utilization tag
|
|
78312
|
-
*
|
|
78313
|
-
* @param {Object} body UtilizationTag
|
|
78314
|
-
* @param {Object} opts Optional parameters
|
|
78315
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78316
|
-
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
78317
|
-
*/
|
|
78318
|
-
postRoutingUtilizationTags(body, opts) {
|
|
78319
|
-
opts = opts || {};
|
|
78320
|
-
|
|
78321
|
-
// verify the required parameter 'body' is set
|
|
78322
|
-
if (body === undefined || body === null) {
|
|
78323
|
-
throw 'Missing the required parameter "body" when calling postRoutingUtilizationTags';
|
|
78324
|
-
}
|
|
78325
|
-
|
|
78326
|
-
return this.apiClient.callApi(
|
|
78327
|
-
'/api/v2/routing/utilization/tags',
|
|
78328
|
-
'POST',
|
|
78329
|
-
{ },
|
|
78330
|
-
{ },
|
|
78331
|
-
{ },
|
|
78332
|
-
{ },
|
|
78333
|
-
body,
|
|
78334
|
-
['PureCloud OAuth'],
|
|
78335
|
-
['application/json'],
|
|
78336
|
-
['application/json'],
|
|
78337
|
-
opts['customHeaders']
|
|
78338
|
-
);
|
|
78339
|
-
}
|
|
78340
|
-
|
|
78341
78525
|
/**
|
|
78342
78526
|
* Create a wrap-up code
|
|
78343
78527
|
*
|
|
@@ -79029,7 +79213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79029
79213
|
/**
|
|
79030
79214
|
* SCIM service.
|
|
79031
79215
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
79032
|
-
* @version
|
|
79216
|
+
* @version 253.0.0
|
|
79033
79217
|
*/
|
|
79034
79218
|
|
|
79035
79219
|
/**
|
|
@@ -79990,7 +80174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79990
80174
|
/**
|
|
79991
80175
|
* Scripts service.
|
|
79992
80176
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
79993
|
-
* @version
|
|
80177
|
+
* @version 253.0.0
|
|
79994
80178
|
*/
|
|
79995
80179
|
|
|
79996
80180
|
/**
|
|
@@ -80499,7 +80683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80499
80683
|
/**
|
|
80500
80684
|
* Search service.
|
|
80501
80685
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
80502
|
-
* @version
|
|
80686
|
+
* @version 253.0.0
|
|
80503
80687
|
*/
|
|
80504
80688
|
|
|
80505
80689
|
/**
|
|
@@ -81315,7 +81499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81315
81499
|
/**
|
|
81316
81500
|
* Settings service.
|
|
81317
81501
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
81318
|
-
* @version
|
|
81502
|
+
* @version 253.0.0
|
|
81319
81503
|
*/
|
|
81320
81504
|
|
|
81321
81505
|
/**
|
|
@@ -81724,7 +81908,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81724
81908
|
/**
|
|
81725
81909
|
* SocialMedia service.
|
|
81726
81910
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
81727
|
-
* @version
|
|
81911
|
+
* @version 253.0.0
|
|
81728
81912
|
*/
|
|
81729
81913
|
|
|
81730
81914
|
/**
|
|
@@ -83709,7 +83893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83709
83893
|
/**
|
|
83710
83894
|
* SpeechTextAnalytics service.
|
|
83711
83895
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
83712
|
-
* @version
|
|
83896
|
+
* @version 253.0.0
|
|
83713
83897
|
*/
|
|
83714
83898
|
|
|
83715
83899
|
/**
|
|
@@ -85661,7 +85845,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85661
85845
|
/**
|
|
85662
85846
|
* Stations service.
|
|
85663
85847
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
85664
|
-
* @version
|
|
85848
|
+
* @version 253.0.0
|
|
85665
85849
|
*/
|
|
85666
85850
|
|
|
85667
85851
|
/**
|
|
@@ -85775,7 +85959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85775
85959
|
/**
|
|
85776
85960
|
* Suggest service.
|
|
85777
85961
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
85778
|
-
* @version
|
|
85962
|
+
* @version 253.0.0
|
|
85779
85963
|
*/
|
|
85780
85964
|
|
|
85781
85965
|
/**
|
|
@@ -85922,7 +86106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85922
86106
|
/**
|
|
85923
86107
|
* TaskManagement service.
|
|
85924
86108
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
85925
|
-
* @version
|
|
86109
|
+
* @version 253.0.0
|
|
85926
86110
|
*/
|
|
85927
86111
|
|
|
85928
86112
|
/**
|
|
@@ -88418,7 +88602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88418
88602
|
/**
|
|
88419
88603
|
* Teams service.
|
|
88420
88604
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
88421
|
-
* @version
|
|
88605
|
+
* @version 253.0.0
|
|
88422
88606
|
*/
|
|
88423
88607
|
|
|
88424
88608
|
/**
|
|
@@ -88761,7 +88945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88761
88945
|
/**
|
|
88762
88946
|
* Telephony service.
|
|
88763
88947
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
88764
|
-
* @version
|
|
88948
|
+
* @version 253.0.0
|
|
88765
88949
|
*/
|
|
88766
88950
|
|
|
88767
88951
|
/**
|
|
@@ -89168,7 +89352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89168
89352
|
/**
|
|
89169
89353
|
* TelephonyProvidersEdge service.
|
|
89170
89354
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
89171
|
-
* @version
|
|
89355
|
+
* @version 253.0.0
|
|
89172
89356
|
*/
|
|
89173
89357
|
|
|
89174
89358
|
/**
|
|
@@ -92360,52 +92544,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
92360
92544
|
);
|
|
92361
92545
|
}
|
|
92362
92546
|
|
|
92363
|
-
/**
|
|
92364
|
-
* Post media endpoint statistics event.
|
|
92365
|
-
*
|
|
92366
|
-
* @param {String} conversationId Identifier of the conversation
|
|
92367
|
-
* @param {String} communicationId Identifier of the media session
|
|
92368
|
-
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
92369
|
-
* @param {Object} body MediaStatisticsPostRequest
|
|
92370
|
-
* @param {Object} opts Optional parameters
|
|
92371
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
92372
|
-
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
92373
|
-
*/
|
|
92374
|
-
postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body, opts) {
|
|
92375
|
-
opts = opts || {};
|
|
92376
|
-
|
|
92377
|
-
// verify the required parameter 'conversationId' is set
|
|
92378
|
-
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
92379
|
-
throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92380
|
-
}
|
|
92381
|
-
// verify the required parameter 'communicationId' is set
|
|
92382
|
-
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
92383
|
-
throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92384
|
-
}
|
|
92385
|
-
// verify the required parameter 'mediaResourceId' is set
|
|
92386
|
-
if (mediaResourceId === undefined || mediaResourceId === null || mediaResourceId === '') {
|
|
92387
|
-
throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92388
|
-
}
|
|
92389
|
-
// verify the required parameter 'body' is set
|
|
92390
|
-
if (body === undefined || body === null) {
|
|
92391
|
-
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92392
|
-
}
|
|
92393
|
-
|
|
92394
|
-
return this.apiClient.callApi(
|
|
92395
|
-
'/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
|
|
92396
|
-
'POST',
|
|
92397
|
-
{ 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
|
|
92398
|
-
{ },
|
|
92399
|
-
{ },
|
|
92400
|
-
{ },
|
|
92401
|
-
body,
|
|
92402
|
-
['PureCloud OAuth'],
|
|
92403
|
-
['application/json'],
|
|
92404
|
-
['application/json'],
|
|
92405
|
-
opts['customHeaders']
|
|
92406
|
-
);
|
|
92407
|
-
}
|
|
92408
|
-
|
|
92409
92547
|
/**
|
|
92410
92548
|
* Reboot a Phone
|
|
92411
92549
|
*
|
|
@@ -93192,7 +93330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93192
93330
|
/**
|
|
93193
93331
|
* Textbots service.
|
|
93194
93332
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
93195
|
-
* @version
|
|
93333
|
+
* @version 253.0.0
|
|
93196
93334
|
*/
|
|
93197
93335
|
|
|
93198
93336
|
/**
|
|
@@ -93338,7 +93476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93338
93476
|
/**
|
|
93339
93477
|
* Tokens service.
|
|
93340
93478
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
93341
|
-
* @version
|
|
93479
|
+
* @version 253.0.0
|
|
93342
93480
|
*/
|
|
93343
93481
|
|
|
93344
93482
|
/**
|
|
@@ -93516,7 +93654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93516
93654
|
/**
|
|
93517
93655
|
* Uploads service.
|
|
93518
93656
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
93519
|
-
* @version
|
|
93657
|
+
* @version 253.0.0
|
|
93520
93658
|
*/
|
|
93521
93659
|
|
|
93522
93660
|
/**
|
|
@@ -93887,7 +94025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93887
94025
|
/**
|
|
93888
94026
|
* Usage service.
|
|
93889
94027
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
93890
|
-
* @version
|
|
94028
|
+
* @version 253.0.0
|
|
93891
94029
|
*/
|
|
93892
94030
|
|
|
93893
94031
|
/**
|
|
@@ -94265,7 +94403,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94265
94403
|
/**
|
|
94266
94404
|
* UserRecordings service.
|
|
94267
94405
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
94268
|
-
* @version
|
|
94406
|
+
* @version 253.0.0
|
|
94269
94407
|
*/
|
|
94270
94408
|
|
|
94271
94409
|
/**
|
|
@@ -94467,7 +94605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94467
94605
|
/**
|
|
94468
94606
|
* Users service.
|
|
94469
94607
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
94470
|
-
* @version
|
|
94608
|
+
* @version 253.0.0
|
|
94471
94609
|
*/
|
|
94472
94610
|
|
|
94473
94611
|
/**
|
|
@@ -98486,7 +98624,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98486
98624
|
/**
|
|
98487
98625
|
* UsersRules service.
|
|
98488
98626
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
98489
|
-
* @version
|
|
98627
|
+
* @version 253.0.0
|
|
98490
98628
|
*/
|
|
98491
98629
|
|
|
98492
98630
|
/**
|
|
@@ -98803,7 +98941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98803
98941
|
/**
|
|
98804
98942
|
* Utilities service.
|
|
98805
98943
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
98806
|
-
* @version
|
|
98944
|
+
* @version 253.0.0
|
|
98807
98945
|
*/
|
|
98808
98946
|
|
|
98809
98947
|
/**
|
|
@@ -98931,7 +99069,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98931
99069
|
/**
|
|
98932
99070
|
* Voicemail service.
|
|
98933
99071
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
98934
|
-
* @version
|
|
99072
|
+
* @version 253.0.0
|
|
98935
99073
|
*/
|
|
98936
99074
|
|
|
98937
99075
|
/**
|
|
@@ -99761,7 +99899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99761
99899
|
/**
|
|
99762
99900
|
* WebChat service.
|
|
99763
99901
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
99764
|
-
* @version
|
|
99902
|
+
* @version 253.0.0
|
|
99765
99903
|
*/
|
|
99766
99904
|
|
|
99767
99905
|
/**
|
|
@@ -100413,7 +100551,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100413
100551
|
/**
|
|
100414
100552
|
* WebDeployments service.
|
|
100415
100553
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
100416
|
-
* @version
|
|
100554
|
+
* @version 253.0.0
|
|
100417
100555
|
*/
|
|
100418
100556
|
|
|
100419
100557
|
/**
|
|
@@ -101091,7 +101229,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101091
101229
|
/**
|
|
101092
101230
|
* WebMessaging service.
|
|
101093
101231
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
101094
|
-
* @version
|
|
101232
|
+
* @version 253.0.0
|
|
101095
101233
|
*/
|
|
101096
101234
|
|
|
101097
101235
|
/**
|
|
@@ -101254,7 +101392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101254
101392
|
/**
|
|
101255
101393
|
* Widgets service.
|
|
101256
101394
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
101257
|
-
* @version
|
|
101395
|
+
* @version 253.0.0
|
|
101258
101396
|
*/
|
|
101259
101397
|
|
|
101260
101398
|
/**
|
|
@@ -101430,7 +101568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101430
101568
|
/**
|
|
101431
101569
|
* WorkforceManagement service.
|
|
101432
101570
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
101433
|
-
* @version
|
|
101571
|
+
* @version 253.0.0
|
|
101434
101572
|
*/
|
|
101435
101573
|
|
|
101436
101574
|
/**
|
|
@@ -103293,6 +103431,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
103293
103431
|
);
|
|
103294
103432
|
}
|
|
103295
103433
|
|
|
103434
|
+
/**
|
|
103435
|
+
* Get opportunity details
|
|
103436
|
+
*
|
|
103437
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
103438
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
103439
|
+
* @param {Object} opts Optional parameters
|
|
103440
|
+
* @param {Object} opts.expand List of resources to expand
|
|
103441
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103442
|
+
*/
|
|
103443
|
+
getWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, opts) {
|
|
103444
|
+
opts = opts || {};
|
|
103445
|
+
|
|
103446
|
+
// verify the required parameter 'businessUnitId' is set
|
|
103447
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
103448
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';
|
|
103449
|
+
}
|
|
103450
|
+
// verify the required parameter 'opportunityId' is set
|
|
103451
|
+
if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
|
|
103452
|
+
throw 'Missing the required parameter "opportunityId" when calling getWorkforcemanagementBusinessunitOpportunity';
|
|
103453
|
+
}
|
|
103454
|
+
|
|
103455
|
+
return this.apiClient.callApi(
|
|
103456
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
|
|
103457
|
+
'GET',
|
|
103458
|
+
{ 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
|
|
103459
|
+
{ 'expand': opts['expand'] },
|
|
103460
|
+
{ },
|
|
103461
|
+
{ },
|
|
103462
|
+
null,
|
|
103463
|
+
['PureCloud OAuth'],
|
|
103464
|
+
['application/json'],
|
|
103465
|
+
['application/json'],
|
|
103466
|
+
opts['customHeaders']
|
|
103467
|
+
);
|
|
103468
|
+
}
|
|
103469
|
+
|
|
103296
103470
|
/**
|
|
103297
103471
|
* Get a planning group
|
|
103298
103472
|
*
|
|
@@ -105126,11 +105300,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105126
105300
|
|
|
105127
105301
|
/**
|
|
105128
105302
|
* Gets all the shift trades for a given agent
|
|
105129
|
-
*
|
|
105303
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
105130
105304
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105131
105305
|
* @param {String} agentId The agent id
|
|
105132
105306
|
* @param {Object} opts Optional parameters
|
|
105133
105307
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105308
|
+
* @deprecated
|
|
105134
105309
|
*/
|
|
105135
105310
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId, opts) {
|
|
105136
105311
|
opts = opts || {};
|
|
@@ -105161,10 +105336,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105161
105336
|
|
|
105162
105337
|
/**
|
|
105163
105338
|
* Gets a summary of all shift trades in the matched state
|
|
105164
|
-
*
|
|
105339
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
105165
105340
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105166
105341
|
* @param {Object} opts Optional parameters
|
|
105167
105342
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105343
|
+
* @deprecated
|
|
105168
105344
|
*/
|
|
105169
105345
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId, opts) {
|
|
105170
105346
|
opts = opts || {};
|
|
@@ -105578,7 +105754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105578
105754
|
|
|
105579
105755
|
/**
|
|
105580
105756
|
* Gets all the shift trades for a given week
|
|
105581
|
-
*
|
|
105757
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
105582
105758
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105583
105759
|
* @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
|
|
105584
105760
|
* @param {Object} opts Optional parameters
|
|
@@ -105586,6 +105762,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105586
105762
|
* @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)
|
|
105587
105763
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
105588
105764
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105765
|
+
* @deprecated
|
|
105589
105766
|
*/
|
|
105590
105767
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
105591
105768
|
opts = opts || {};
|
|
@@ -105861,9 +106038,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105861
106038
|
|
|
105862
106039
|
/**
|
|
105863
106040
|
* Gets all of my shift trades
|
|
105864
|
-
*
|
|
106041
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
105865
106042
|
* @param {Object} opts Optional parameters
|
|
105866
106043
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106044
|
+
* @deprecated
|
|
105867
106045
|
*/
|
|
105868
106046
|
getWorkforcemanagementShifttrades(opts) {
|
|
105869
106047
|
opts = opts || {};
|
|
@@ -106725,9 +106903,49 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
106725
106903
|
);
|
|
106726
106904
|
}
|
|
106727
106905
|
|
|
106906
|
+
/**
|
|
106907
|
+
* Update the opportunity
|
|
106908
|
+
* Only opportunities with Draft status can be updated.
|
|
106909
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
106910
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
106911
|
+
* @param {Object} body body
|
|
106912
|
+
* @param {Object} opts Optional parameters
|
|
106913
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106914
|
+
*/
|
|
106915
|
+
patchWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, body, opts) {
|
|
106916
|
+
opts = opts || {};
|
|
106917
|
+
|
|
106918
|
+
// verify the required parameter 'businessUnitId' is set
|
|
106919
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
106920
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
106921
|
+
}
|
|
106922
|
+
// verify the required parameter 'opportunityId' is set
|
|
106923
|
+
if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
|
|
106924
|
+
throw 'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
106925
|
+
}
|
|
106926
|
+
// verify the required parameter 'body' is set
|
|
106927
|
+
if (body === undefined || body === null) {
|
|
106928
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
106929
|
+
}
|
|
106930
|
+
|
|
106931
|
+
return this.apiClient.callApi(
|
|
106932
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
|
|
106933
|
+
'PATCH',
|
|
106934
|
+
{ 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
|
|
106935
|
+
{ },
|
|
106936
|
+
{ },
|
|
106937
|
+
{ },
|
|
106938
|
+
body,
|
|
106939
|
+
['PureCloud OAuth'],
|
|
106940
|
+
['application/json'],
|
|
106941
|
+
['application/json'],
|
|
106942
|
+
opts['customHeaders']
|
|
106943
|
+
);
|
|
106944
|
+
}
|
|
106945
|
+
|
|
106728
106946
|
/**
|
|
106729
106947
|
* Updates the planning group
|
|
106730
|
-
*
|
|
106948
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
106731
106949
|
* @param {String} businessUnitId The ID of the business unit.
|
|
106732
106950
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
106733
106951
|
* @param {Object} body body
|
|
@@ -107402,13 +107620,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
107402
107620
|
|
|
107403
107621
|
/**
|
|
107404
107622
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
107405
|
-
*
|
|
107623
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
107406
107624
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
107407
107625
|
* @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
|
|
107408
107626
|
* @param {String} tradeId The ID of the shift trade to update
|
|
107409
107627
|
* @param {Object} body body
|
|
107410
107628
|
* @param {Object} opts Optional parameters
|
|
107411
107629
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107630
|
+
* @deprecated
|
|
107412
107631
|
*/
|
|
107413
107632
|
patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
107414
107633
|
opts = opts || {};
|
|
@@ -107753,33 +107972,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
107753
107972
|
);
|
|
107754
107973
|
}
|
|
107755
107974
|
|
|
107756
|
-
/**
|
|
107757
|
-
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
107758
|
-
*
|
|
107759
|
-
* @param {Object} opts Optional parameters
|
|
107760
|
-
* @param {Object} opts.body body
|
|
107761
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107762
|
-
* @deprecated
|
|
107763
|
-
*/
|
|
107764
|
-
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
107765
|
-
opts = opts || {};
|
|
107766
|
-
|
|
107767
|
-
|
|
107768
|
-
return this.apiClient.callApi(
|
|
107769
|
-
'/api/v2/workforcemanagement/adherence/historical',
|
|
107770
|
-
'POST',
|
|
107771
|
-
{ },
|
|
107772
|
-
{ },
|
|
107773
|
-
{ },
|
|
107774
|
-
{ },
|
|
107775
|
-
opts['body'],
|
|
107776
|
-
['PureCloud OAuth'],
|
|
107777
|
-
['application/json'],
|
|
107778
|
-
['application/json'],
|
|
107779
|
-
opts['customHeaders']
|
|
107780
|
-
);
|
|
107781
|
-
}
|
|
107782
|
-
|
|
107783
107975
|
/**
|
|
107784
107976
|
* Request a historical adherence report in bulk
|
|
107785
107977
|
*
|
|
@@ -108034,6 +108226,98 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
108034
108226
|
);
|
|
108035
108227
|
}
|
|
108036
108228
|
|
|
108229
|
+
/**
|
|
108230
|
+
* Bulk add enrollments to opportunities for the authenticated agent
|
|
108231
|
+
* Allows an agent to enroll in opportunities. This endpoint can return partial success.
|
|
108232
|
+
* @param {Object} body body
|
|
108233
|
+
* @param {Object} opts Optional parameters
|
|
108234
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108235
|
+
*/
|
|
108236
|
+
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body, opts) {
|
|
108237
|
+
opts = opts || {};
|
|
108238
|
+
|
|
108239
|
+
// verify the required parameter 'body' is set
|
|
108240
|
+
if (body === undefined || body === null) {
|
|
108241
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';
|
|
108242
|
+
}
|
|
108243
|
+
|
|
108244
|
+
return this.apiClient.callApi(
|
|
108245
|
+
'/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add',
|
|
108246
|
+
'POST',
|
|
108247
|
+
{ },
|
|
108248
|
+
{ },
|
|
108249
|
+
{ },
|
|
108250
|
+
{ },
|
|
108251
|
+
body,
|
|
108252
|
+
['PureCloud OAuth'],
|
|
108253
|
+
['application/json'],
|
|
108254
|
+
['application/json'],
|
|
108255
|
+
opts['customHeaders']
|
|
108256
|
+
);
|
|
108257
|
+
}
|
|
108258
|
+
|
|
108259
|
+
/**
|
|
108260
|
+
* Bulk update enrollment status for the authenticated agent
|
|
108261
|
+
* Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
|
|
108262
|
+
* @param {Object} body body
|
|
108263
|
+
* @param {Object} opts Optional parameters
|
|
108264
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108265
|
+
*/
|
|
108266
|
+
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body, opts) {
|
|
108267
|
+
opts = opts || {};
|
|
108268
|
+
|
|
108269
|
+
// verify the required parameter 'body' is set
|
|
108270
|
+
if (body === undefined || body === null) {
|
|
108271
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
108272
|
+
}
|
|
108273
|
+
|
|
108274
|
+
return this.apiClient.callApi(
|
|
108275
|
+
'/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update',
|
|
108276
|
+
'POST',
|
|
108277
|
+
{ },
|
|
108278
|
+
{ },
|
|
108279
|
+
{ },
|
|
108280
|
+
{ },
|
|
108281
|
+
body,
|
|
108282
|
+
['PureCloud OAuth'],
|
|
108283
|
+
['application/json'],
|
|
108284
|
+
['application/json'],
|
|
108285
|
+
opts['customHeaders']
|
|
108286
|
+
);
|
|
108287
|
+
}
|
|
108288
|
+
|
|
108289
|
+
/**
|
|
108290
|
+
* Query opportunities for the authenticated agent
|
|
108291
|
+
* Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
|
|
108292
|
+
* @param {Object} body body
|
|
108293
|
+
* @param {Object} opts Optional parameters
|
|
108294
|
+
* @param {Object} opts.expand List of resources to expand
|
|
108295
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
108296
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108297
|
+
*/
|
|
108298
|
+
postWorkforcemanagementAgentsOpportunitiesQuery(body, opts) {
|
|
108299
|
+
opts = opts || {};
|
|
108300
|
+
|
|
108301
|
+
// verify the required parameter 'body' is set
|
|
108302
|
+
if (body === undefined || body === null) {
|
|
108303
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';
|
|
108304
|
+
}
|
|
108305
|
+
|
|
108306
|
+
return this.apiClient.callApi(
|
|
108307
|
+
'/api/v2/workforcemanagement/agents/opportunities/query',
|
|
108308
|
+
'POST',
|
|
108309
|
+
{ },
|
|
108310
|
+
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
108311
|
+
{ },
|
|
108312
|
+
{ },
|
|
108313
|
+
body,
|
|
108314
|
+
['PureCloud OAuth'],
|
|
108315
|
+
['application/json'],
|
|
108316
|
+
['application/json'],
|
|
108317
|
+
opts['customHeaders']
|
|
108318
|
+
);
|
|
108319
|
+
}
|
|
108320
|
+
|
|
108037
108321
|
/**
|
|
108038
108322
|
* Fetch agent schedules for the logged in user's management unit
|
|
108039
108323
|
*
|
|
@@ -108703,8 +108987,291 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
108703
108987
|
}
|
|
108704
108988
|
|
|
108705
108989
|
/**
|
|
108706
|
-
*
|
|
108990
|
+
* Bulk add opportunities
|
|
108707
108991
|
*
|
|
108992
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
108993
|
+
* @param {Object} body body
|
|
108994
|
+
* @param {Object} opts Optional parameters
|
|
108995
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108996
|
+
*/
|
|
108997
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId, body, opts) {
|
|
108998
|
+
opts = opts || {};
|
|
108999
|
+
|
|
109000
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109001
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109002
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
|
|
109003
|
+
}
|
|
109004
|
+
// verify the required parameter 'body' is set
|
|
109005
|
+
if (body === undefined || body === null) {
|
|
109006
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
|
|
109007
|
+
}
|
|
109008
|
+
|
|
109009
|
+
return this.apiClient.callApi(
|
|
109010
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add',
|
|
109011
|
+
'POST',
|
|
109012
|
+
{ 'businessUnitId': businessUnitId },
|
|
109013
|
+
{ },
|
|
109014
|
+
{ },
|
|
109015
|
+
{ },
|
|
109016
|
+
body,
|
|
109017
|
+
['PureCloud OAuth'],
|
|
109018
|
+
['application/json'],
|
|
109019
|
+
['application/json'],
|
|
109020
|
+
opts['customHeaders']
|
|
109021
|
+
);
|
|
109022
|
+
}
|
|
109023
|
+
|
|
109024
|
+
/**
|
|
109025
|
+
* Bulk publish opportunities
|
|
109026
|
+
* Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
|
|
109027
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109028
|
+
* @param {Object} body body
|
|
109029
|
+
* @param {Object} opts Optional parameters
|
|
109030
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109031
|
+
*/
|
|
109032
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId, body, opts) {
|
|
109033
|
+
opts = opts || {};
|
|
109034
|
+
|
|
109035
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109036
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109037
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
|
|
109038
|
+
}
|
|
109039
|
+
// verify the required parameter 'body' is set
|
|
109040
|
+
if (body === undefined || body === null) {
|
|
109041
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
|
|
109042
|
+
}
|
|
109043
|
+
|
|
109044
|
+
return this.apiClient.callApi(
|
|
109045
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish',
|
|
109046
|
+
'POST',
|
|
109047
|
+
{ 'businessUnitId': businessUnitId },
|
|
109048
|
+
{ },
|
|
109049
|
+
{ },
|
|
109050
|
+
{ },
|
|
109051
|
+
body,
|
|
109052
|
+
['PureCloud OAuth'],
|
|
109053
|
+
['application/json'],
|
|
109054
|
+
['application/json'],
|
|
109055
|
+
opts['customHeaders']
|
|
109056
|
+
);
|
|
109057
|
+
}
|
|
109058
|
+
|
|
109059
|
+
/**
|
|
109060
|
+
* Bulk remove opportunities
|
|
109061
|
+
* This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
|
|
109062
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109063
|
+
* @param {Object} body body
|
|
109064
|
+
* @param {Object} opts Optional parameters
|
|
109065
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109066
|
+
*/
|
|
109067
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId, body, opts) {
|
|
109068
|
+
opts = opts || {};
|
|
109069
|
+
|
|
109070
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109071
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109072
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
|
|
109073
|
+
}
|
|
109074
|
+
// verify the required parameter 'body' is set
|
|
109075
|
+
if (body === undefined || body === null) {
|
|
109076
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
|
|
109077
|
+
}
|
|
109078
|
+
|
|
109079
|
+
return this.apiClient.callApi(
|
|
109080
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove',
|
|
109081
|
+
'POST',
|
|
109082
|
+
{ 'businessUnitId': businessUnitId },
|
|
109083
|
+
{ },
|
|
109084
|
+
{ },
|
|
109085
|
+
{ },
|
|
109086
|
+
body,
|
|
109087
|
+
['PureCloud OAuth'],
|
|
109088
|
+
['application/json'],
|
|
109089
|
+
['application/json'],
|
|
109090
|
+
opts['customHeaders']
|
|
109091
|
+
);
|
|
109092
|
+
}
|
|
109093
|
+
|
|
109094
|
+
/**
|
|
109095
|
+
* Bulk update opportunities status
|
|
109096
|
+
* If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
|
|
109097
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109098
|
+
* @param {Object} body body
|
|
109099
|
+
* @param {Object} opts Optional parameters
|
|
109100
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109101
|
+
*/
|
|
109102
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId, body, opts) {
|
|
109103
|
+
opts = opts || {};
|
|
109104
|
+
|
|
109105
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109106
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109107
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
|
|
109108
|
+
}
|
|
109109
|
+
// verify the required parameter 'body' is set
|
|
109110
|
+
if (body === undefined || body === null) {
|
|
109111
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
|
|
109112
|
+
}
|
|
109113
|
+
|
|
109114
|
+
return this.apiClient.callApi(
|
|
109115
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update',
|
|
109116
|
+
'POST',
|
|
109117
|
+
{ 'businessUnitId': businessUnitId },
|
|
109118
|
+
{ },
|
|
109119
|
+
{ },
|
|
109120
|
+
{ },
|
|
109121
|
+
body,
|
|
109122
|
+
['PureCloud OAuth'],
|
|
109123
|
+
['application/json'],
|
|
109124
|
+
['application/json'],
|
|
109125
|
+
opts['customHeaders']
|
|
109126
|
+
);
|
|
109127
|
+
}
|
|
109128
|
+
|
|
109129
|
+
/**
|
|
109130
|
+
* Bulk update enrollment status
|
|
109131
|
+
* Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
|
|
109132
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109133
|
+
* @param {Object} body body
|
|
109134
|
+
* @param {Object} opts Optional parameters
|
|
109135
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109136
|
+
*/
|
|
109137
|
+
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId, body, opts) {
|
|
109138
|
+
opts = opts || {};
|
|
109139
|
+
|
|
109140
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109141
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109142
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
109143
|
+
}
|
|
109144
|
+
// verify the required parameter 'body' is set
|
|
109145
|
+
if (body === undefined || body === null) {
|
|
109146
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
109147
|
+
}
|
|
109148
|
+
|
|
109149
|
+
return this.apiClient.callApi(
|
|
109150
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update',
|
|
109151
|
+
'POST',
|
|
109152
|
+
{ 'businessUnitId': businessUnitId },
|
|
109153
|
+
{ },
|
|
109154
|
+
{ },
|
|
109155
|
+
{ },
|
|
109156
|
+
body,
|
|
109157
|
+
['PureCloud OAuth'],
|
|
109158
|
+
['application/json'],
|
|
109159
|
+
['application/json'],
|
|
109160
|
+
opts['customHeaders']
|
|
109161
|
+
);
|
|
109162
|
+
}
|
|
109163
|
+
|
|
109164
|
+
/**
|
|
109165
|
+
* Query enrollments
|
|
109166
|
+
* For more information about opportunities, use the expand parameter.
|
|
109167
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109168
|
+
* @param {Object} body body
|
|
109169
|
+
* @param {Object} opts Optional parameters
|
|
109170
|
+
* @param {Object} opts.expand List of resources to expand
|
|
109171
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
109172
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109173
|
+
*/
|
|
109174
|
+
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId, body, opts) {
|
|
109175
|
+
opts = opts || {};
|
|
109176
|
+
|
|
109177
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109178
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109179
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
|
|
109180
|
+
}
|
|
109181
|
+
// verify the required parameter 'body' is set
|
|
109182
|
+
if (body === undefined || body === null) {
|
|
109183
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
|
|
109184
|
+
}
|
|
109185
|
+
|
|
109186
|
+
return this.apiClient.callApi(
|
|
109187
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query',
|
|
109188
|
+
'POST',
|
|
109189
|
+
{ 'businessUnitId': businessUnitId },
|
|
109190
|
+
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
109191
|
+
{ },
|
|
109192
|
+
{ },
|
|
109193
|
+
body,
|
|
109194
|
+
['PureCloud OAuth'],
|
|
109195
|
+
['application/json'],
|
|
109196
|
+
['application/json'],
|
|
109197
|
+
opts['customHeaders']
|
|
109198
|
+
);
|
|
109199
|
+
}
|
|
109200
|
+
|
|
109201
|
+
/**
|
|
109202
|
+
* Query opportunities by external activity IDs
|
|
109203
|
+
*
|
|
109204
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109205
|
+
* @param {Object} body body
|
|
109206
|
+
* @param {Object} opts Optional parameters
|
|
109207
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109208
|
+
*/
|
|
109209
|
+
postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId, body, opts) {
|
|
109210
|
+
opts = opts || {};
|
|
109211
|
+
|
|
109212
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109213
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109214
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
|
|
109215
|
+
}
|
|
109216
|
+
// verify the required parameter 'body' is set
|
|
109217
|
+
if (body === undefined || body === null) {
|
|
109218
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
|
|
109219
|
+
}
|
|
109220
|
+
|
|
109221
|
+
return this.apiClient.callApi(
|
|
109222
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query',
|
|
109223
|
+
'POST',
|
|
109224
|
+
{ 'businessUnitId': businessUnitId },
|
|
109225
|
+
{ },
|
|
109226
|
+
{ },
|
|
109227
|
+
{ },
|
|
109228
|
+
body,
|
|
109229
|
+
['PureCloud OAuth'],
|
|
109230
|
+
['application/json'],
|
|
109231
|
+
['application/json'],
|
|
109232
|
+
opts['customHeaders']
|
|
109233
|
+
);
|
|
109234
|
+
}
|
|
109235
|
+
|
|
109236
|
+
/**
|
|
109237
|
+
* Query opportunities within the specified date range
|
|
109238
|
+
*
|
|
109239
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109240
|
+
* @param {Object} body body
|
|
109241
|
+
* @param {Object} opts Optional parameters
|
|
109242
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
109243
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109244
|
+
*/
|
|
109245
|
+
postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId, body, opts) {
|
|
109246
|
+
opts = opts || {};
|
|
109247
|
+
|
|
109248
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109249
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109250
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
|
|
109251
|
+
}
|
|
109252
|
+
// verify the required parameter 'body' is set
|
|
109253
|
+
if (body === undefined || body === null) {
|
|
109254
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
|
|
109255
|
+
}
|
|
109256
|
+
|
|
109257
|
+
return this.apiClient.callApi(
|
|
109258
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query',
|
|
109259
|
+
'POST',
|
|
109260
|
+
{ 'businessUnitId': businessUnitId },
|
|
109261
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
109262
|
+
{ },
|
|
109263
|
+
{ },
|
|
109264
|
+
body,
|
|
109265
|
+
['PureCloud OAuth'],
|
|
109266
|
+
['application/json'],
|
|
109267
|
+
['application/json'],
|
|
109268
|
+
opts['customHeaders']
|
|
109269
|
+
);
|
|
109270
|
+
}
|
|
109271
|
+
|
|
109272
|
+
/**
|
|
109273
|
+
* Adds a new planning group
|
|
109274
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
108708
109275
|
* @param {String} businessUnitId The ID of the business unit.
|
|
108709
109276
|
* @param {Object} body body
|
|
108710
109277
|
* @param {Object} opts Optional parameters
|
|
@@ -110725,13 +111292,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110725
111292
|
|
|
110726
111293
|
/**
|
|
110727
111294
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
110728
|
-
*
|
|
111295
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
110729
111296
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110730
111297
|
* @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
|
|
110731
111298
|
* @param {String} tradeId The ID of the shift trade to update
|
|
110732
111299
|
* @param {Object} body body
|
|
110733
111300
|
* @param {Object} opts Optional parameters
|
|
110734
111301
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111302
|
+
* @deprecated
|
|
110735
111303
|
*/
|
|
110736
111304
|
postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
110737
111305
|
opts = opts || {};
|
|
@@ -110770,12 +111338,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110770
111338
|
|
|
110771
111339
|
/**
|
|
110772
111340
|
* Adds a shift trade
|
|
110773
|
-
*
|
|
111341
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
110774
111342
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110775
111343
|
* @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
|
|
110776
111344
|
* @param {Object} body body
|
|
110777
111345
|
* @param {Object} opts Optional parameters
|
|
110778
111346
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111347
|
+
* @deprecated
|
|
110779
111348
|
*/
|
|
110780
111349
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body, opts) {
|
|
110781
111350
|
opts = opts || {};
|
|
@@ -110810,13 +111379,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110810
111379
|
|
|
110811
111380
|
/**
|
|
110812
111381
|
* Searches for potential shift trade matches for the current agent
|
|
110813
|
-
*
|
|
111382
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
110814
111383
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110815
111384
|
* @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
|
|
110816
111385
|
* @param {Object} body body
|
|
110817
111386
|
* @param {Object} opts Optional parameters
|
|
110818
111387
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110819
111388
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111389
|
+
* @deprecated
|
|
110820
111390
|
*/
|
|
110821
111391
|
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
110822
111392
|
opts = opts || {};
|
|
@@ -110851,13 +111421,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110851
111421
|
|
|
110852
111422
|
/**
|
|
110853
111423
|
* Updates the state of a batch of shift trades
|
|
110854
|
-
* Admin functionality is not supported with "mine".
|
|
111424
|
+
* Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
|
|
110855
111425
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110856
111426
|
* @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
|
|
110857
111427
|
* @param {Object} body body
|
|
110858
111428
|
* @param {Object} opts Optional parameters
|
|
110859
111429
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110860
111430
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111431
|
+
* @deprecated
|
|
110861
111432
|
*/
|
|
110862
111433
|
postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, opts) {
|
|
110863
111434
|
opts = opts || {};
|
|
@@ -111766,7 +112337,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
111766
112337
|
* </pre>
|
|
111767
112338
|
* </p>
|
|
111768
112339
|
* @module purecloud-platform-client-v2/index
|
|
111769
|
-
* @version
|
|
112340
|
+
* @version 253.0.0
|
|
111770
112341
|
*/
|
|
111771
112342
|
class platformClient {
|
|
111772
112343
|
constructor() {
|