purecloud-platform-client-v2 252.1.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 +908 -340
- package/dist/web-amd/purecloud-platform-client-v2.js +908 -340
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +336 -177
- package/dist/web-cjs/purecloud-platform-client-v2.js +336 -177
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +632 -102
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- 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
|
/**
|
|
@@ -2436,7 +2436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2436
2436
|
/**
|
|
2437
2437
|
* AIStudio service.
|
|
2438
2438
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2439
|
-
* @version
|
|
2439
|
+
* @version 253.0.0
|
|
2440
2440
|
*/
|
|
2441
2441
|
|
|
2442
2442
|
/**
|
|
@@ -2545,12 +2545,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2545
2545
|
* Get all summary settings.
|
|
2546
2546
|
*
|
|
2547
2547
|
* @param {Object} opts Optional parameters
|
|
2548
|
-
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2549
|
-
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2550
|
-
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2551
|
-
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2552
2548
|
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2553
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)
|
|
2554
2554
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2555
2555
|
*/
|
|
2556
2556
|
getConversationsSummariesSettings(opts) {
|
|
@@ -2561,7 +2561,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2561
2561
|
'/api/v2/conversations/summaries/settings',
|
|
2562
2562
|
'GET',
|
|
2563
2563
|
{ },
|
|
2564
|
-
{ '
|
|
2564
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'],'sortOrder': opts['sortOrder'],'language': opts['language'],'sortBy': opts['sortBy'] },
|
|
2565
2565
|
{ },
|
|
2566
2566
|
{ },
|
|
2567
2567
|
null,
|
|
@@ -3151,7 +3151,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3151
3151
|
/**
|
|
3152
3152
|
* AgentAssistants service.
|
|
3153
3153
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3154
|
-
* @version
|
|
3154
|
+
* @version 253.0.0
|
|
3155
3155
|
*/
|
|
3156
3156
|
|
|
3157
3157
|
/**
|
|
@@ -3507,6 +3507,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3507
3507
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
3508
3508
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
3509
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.
|
|
3510
3511
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3511
3512
|
*/
|
|
3512
3513
|
getAssistantsAgentchecklists(opts) {
|
|
@@ -3517,7 +3518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3517
3518
|
'/api/v2/assistants/agentchecklists',
|
|
3518
3519
|
'GET',
|
|
3519
3520
|
{ },
|
|
3520
|
-
{ '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') },
|
|
3521
3522
|
{ },
|
|
3522
3523
|
{ },
|
|
3523
3524
|
null,
|
|
@@ -3955,7 +3956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3955
3956
|
/**
|
|
3956
3957
|
* AgentCopilot service.
|
|
3957
3958
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3958
|
-
* @version
|
|
3959
|
+
* @version 253.0.0
|
|
3959
3960
|
*/
|
|
3960
3961
|
|
|
3961
3962
|
/**
|
|
@@ -4067,7 +4068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4067
4068
|
/**
|
|
4068
4069
|
* AgentUI service.
|
|
4069
4070
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4070
|
-
* @version
|
|
4071
|
+
* @version 253.0.0
|
|
4071
4072
|
*/
|
|
4072
4073
|
|
|
4073
4074
|
/**
|
|
@@ -4218,7 +4219,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4218
4219
|
/**
|
|
4219
4220
|
* Alerting service.
|
|
4220
4221
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4221
|
-
* @version
|
|
4222
|
+
* @version 253.0.0
|
|
4222
4223
|
*/
|
|
4223
4224
|
|
|
4224
4225
|
/**
|
|
@@ -4679,7 +4680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4679
4680
|
/**
|
|
4680
4681
|
* Analytics service.
|
|
4681
4682
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4682
|
-
* @version
|
|
4683
|
+
* @version 253.0.0
|
|
4683
4684
|
*/
|
|
4684
4685
|
|
|
4685
4686
|
/**
|
|
@@ -8965,7 +8966,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8965
8966
|
/**
|
|
8966
8967
|
* Architect service.
|
|
8967
8968
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8968
|
-
* @version
|
|
8969
|
+
* @version 253.0.0
|
|
8969
8970
|
*/
|
|
8970
8971
|
|
|
8971
8972
|
/**
|
|
@@ -13219,6 +13220,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13219
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.
|
|
13220
13221
|
*
|
|
13221
13222
|
* @param {Object} opts Optional parameters
|
|
13223
|
+
* @param {Object} opts.body
|
|
13222
13224
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13223
13225
|
*/
|
|
13224
13226
|
postFlowsJobs(opts) {
|
|
@@ -13232,7 +13234,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13232
13234
|
{ },
|
|
13233
13235
|
{ },
|
|
13234
13236
|
{ },
|
|
13235
|
-
|
|
13237
|
+
opts['body'],
|
|
13236
13238
|
['PureCloud OAuth'],
|
|
13237
13239
|
['application/json'],
|
|
13238
13240
|
['application/json'],
|
|
@@ -13824,7 +13826,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13824
13826
|
/**
|
|
13825
13827
|
* AssistantCopilotVariations service.
|
|
13826
13828
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13827
|
-
* @version
|
|
13829
|
+
* @version 253.0.0
|
|
13828
13830
|
*/
|
|
13829
13831
|
|
|
13830
13832
|
/**
|
|
@@ -14020,7 +14022,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14020
14022
|
/**
|
|
14021
14023
|
* Audit service.
|
|
14022
14024
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14023
|
-
* @version
|
|
14025
|
+
* @version 253.0.0
|
|
14024
14026
|
*/
|
|
14025
14027
|
|
|
14026
14028
|
/**
|
|
@@ -14247,7 +14249,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14247
14249
|
/**
|
|
14248
14250
|
* Authorization service.
|
|
14249
14251
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14250
|
-
* @version
|
|
14252
|
+
* @version 253.0.0
|
|
14251
14253
|
*/
|
|
14252
14254
|
|
|
14253
14255
|
/**
|
|
@@ -16172,7 +16174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16172
16174
|
/**
|
|
16173
16175
|
* BackgroundAssistant service.
|
|
16174
16176
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16175
|
-
* @version
|
|
16177
|
+
* @version 253.0.0
|
|
16176
16178
|
*/
|
|
16177
16179
|
|
|
16178
16180
|
/**
|
|
@@ -16246,7 +16248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16246
16248
|
/**
|
|
16247
16249
|
* Billing service.
|
|
16248
16250
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16249
|
-
* @version
|
|
16251
|
+
* @version 253.0.0
|
|
16250
16252
|
*/
|
|
16251
16253
|
|
|
16252
16254
|
/**
|
|
@@ -16530,7 +16532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16530
16532
|
/**
|
|
16531
16533
|
* BusinessRules service.
|
|
16532
16534
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16533
|
-
* @version
|
|
16535
|
+
* @version 253.0.0
|
|
16534
16536
|
*/
|
|
16535
16537
|
|
|
16536
16538
|
/**
|
|
@@ -17544,7 +17546,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17544
17546
|
/**
|
|
17545
17547
|
* CarrierServices service.
|
|
17546
17548
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17547
|
-
* @version
|
|
17549
|
+
* @version 253.0.0
|
|
17548
17550
|
*/
|
|
17549
17551
|
|
|
17550
17552
|
/**
|
|
@@ -17621,7 +17623,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17621
17623
|
/**
|
|
17622
17624
|
* CaseManagement service.
|
|
17623
17625
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17624
|
-
* @version
|
|
17626
|
+
* @version 253.0.0
|
|
17625
17627
|
*/
|
|
17626
17628
|
|
|
17627
17629
|
/**
|
|
@@ -18914,7 +18916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18914
18916
|
/**
|
|
18915
18917
|
* Chat service.
|
|
18916
18918
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18917
|
-
* @version
|
|
18919
|
+
* @version 253.0.0
|
|
18918
18920
|
*/
|
|
18919
18921
|
|
|
18920
18922
|
/**
|
|
@@ -20053,7 +20055,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20053
20055
|
/**
|
|
20054
20056
|
* Coaching service.
|
|
20055
20057
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
20056
|
-
* @version
|
|
20058
|
+
* @version 253.0.0
|
|
20057
20059
|
*/
|
|
20058
20060
|
|
|
20059
20061
|
/**
|
|
@@ -20767,7 +20769,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20767
20769
|
/**
|
|
20768
20770
|
* ContentManagement service.
|
|
20769
20771
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20770
|
-
* @version
|
|
20772
|
+
* @version 253.0.0
|
|
20771
20773
|
*/
|
|
20772
20774
|
|
|
20773
20775
|
/**
|
|
@@ -21962,7 +21964,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21962
21964
|
/**
|
|
21963
21965
|
* Conversations service.
|
|
21964
21966
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21965
|
-
* @version
|
|
21967
|
+
* @version 253.0.0
|
|
21966
21968
|
*/
|
|
21967
21969
|
|
|
21968
21970
|
/**
|
|
@@ -33068,7 +33070,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33068
33070
|
/**
|
|
33069
33071
|
* DataExtensions service.
|
|
33070
33072
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
33071
|
-
* @version
|
|
33073
|
+
* @version 253.0.0
|
|
33072
33074
|
*/
|
|
33073
33075
|
|
|
33074
33076
|
/**
|
|
@@ -33169,7 +33171,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33169
33171
|
/**
|
|
33170
33172
|
* DataPrivacy service.
|
|
33171
33173
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33172
|
-
* @version
|
|
33174
|
+
* @version 253.0.0
|
|
33173
33175
|
*/
|
|
33174
33176
|
|
|
33175
33177
|
/**
|
|
@@ -33366,7 +33368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33366
33368
|
/**
|
|
33367
33369
|
* Downloads service.
|
|
33368
33370
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33369
|
-
* @version
|
|
33371
|
+
* @version 253.0.0
|
|
33370
33372
|
*/
|
|
33371
33373
|
|
|
33372
33374
|
/**
|
|
@@ -33420,7 +33422,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33420
33422
|
/**
|
|
33421
33423
|
* Emails service.
|
|
33422
33424
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33423
|
-
* @version
|
|
33425
|
+
* @version 253.0.0
|
|
33424
33426
|
*/
|
|
33425
33427
|
|
|
33426
33428
|
/**
|
|
@@ -33568,7 +33570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33568
33570
|
/**
|
|
33569
33571
|
* EmployeeEngagement service.
|
|
33570
33572
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33571
|
-
* @version
|
|
33573
|
+
* @version 253.0.0
|
|
33572
33574
|
*/
|
|
33573
33575
|
|
|
33574
33576
|
/**
|
|
@@ -33772,7 +33774,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33772
33774
|
/**
|
|
33773
33775
|
* Events service.
|
|
33774
33776
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33775
|
-
* @version
|
|
33777
|
+
* @version 253.0.0
|
|
33776
33778
|
*/
|
|
33777
33779
|
|
|
33778
33780
|
/**
|
|
@@ -33914,7 +33916,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33914
33916
|
/**
|
|
33915
33917
|
* ExternalContacts service.
|
|
33916
33918
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33917
|
-
* @version
|
|
33919
|
+
* @version 253.0.0
|
|
33918
33920
|
*/
|
|
33919
33921
|
|
|
33920
33922
|
/**
|
|
@@ -37685,7 +37687,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37685
37687
|
/**
|
|
37686
37688
|
* Fax service.
|
|
37687
37689
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37688
|
-
* @version
|
|
37690
|
+
* @version 253.0.0
|
|
37689
37691
|
*/
|
|
37690
37692
|
|
|
37691
37693
|
/**
|
|
@@ -37934,7 +37936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37934
37936
|
/**
|
|
37935
37937
|
* Flows service.
|
|
37936
37938
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37937
|
-
* @version
|
|
37939
|
+
* @version 253.0.0
|
|
37938
37940
|
*/
|
|
37939
37941
|
|
|
37940
37942
|
/**
|
|
@@ -38172,7 +38174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38172
38174
|
/**
|
|
38173
38175
|
* Gamification service.
|
|
38174
38176
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38175
|
-
* @version
|
|
38177
|
+
* @version 253.0.0
|
|
38176
38178
|
*/
|
|
38177
38179
|
|
|
38178
38180
|
/**
|
|
@@ -41024,7 +41026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41024
41026
|
/**
|
|
41025
41027
|
* GeneralDataProtectionRegulation service.
|
|
41026
41028
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
41027
|
-
* @version
|
|
41029
|
+
* @version 253.0.0
|
|
41028
41030
|
*/
|
|
41029
41031
|
|
|
41030
41032
|
/**
|
|
@@ -41168,7 +41170,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41168
41170
|
/**
|
|
41169
41171
|
* Geolocation service.
|
|
41170
41172
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
41171
|
-
* @version
|
|
41173
|
+
* @version 253.0.0
|
|
41172
41174
|
*/
|
|
41173
41175
|
|
|
41174
41176
|
/**
|
|
@@ -41319,7 +41321,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41319
41321
|
/**
|
|
41320
41322
|
* Greetings service.
|
|
41321
41323
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41322
|
-
* @version
|
|
41324
|
+
* @version 253.0.0
|
|
41323
41325
|
*/
|
|
41324
41326
|
|
|
41325
41327
|
/**
|
|
@@ -41935,7 +41937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41935
41937
|
/**
|
|
41936
41938
|
* Groups service.
|
|
41937
41939
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41938
|
-
* @version
|
|
41940
|
+
* @version 253.0.0
|
|
41939
41941
|
*/
|
|
41940
41942
|
|
|
41941
41943
|
/**
|
|
@@ -42526,7 +42528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42526
42528
|
/**
|
|
42527
42529
|
* IdentityProvider service.
|
|
42528
42530
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
42529
|
-
* @version
|
|
42531
|
+
* @version 253.0.0
|
|
42530
42532
|
*/
|
|
42531
42533
|
|
|
42532
42534
|
/**
|
|
@@ -43577,7 +43579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43577
43579
|
/**
|
|
43578
43580
|
* InfrastructureAsCode service.
|
|
43579
43581
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43580
|
-
* @version
|
|
43582
|
+
* @version 253.0.0
|
|
43581
43583
|
*/
|
|
43582
43584
|
|
|
43583
43585
|
/**
|
|
@@ -43757,7 +43759,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43757
43759
|
/**
|
|
43758
43760
|
* Integrations service.
|
|
43759
43761
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43760
|
-
* @version
|
|
43762
|
+
* @version 253.0.0
|
|
43761
43763
|
*/
|
|
43762
43764
|
|
|
43763
43765
|
/**
|
|
@@ -46729,7 +46731,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46729
46731
|
/**
|
|
46730
46732
|
* Intents service.
|
|
46731
46733
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46732
|
-
* @version
|
|
46734
|
+
* @version 253.0.0
|
|
46733
46735
|
*/
|
|
46734
46736
|
|
|
46735
46737
|
/**
|
|
@@ -47261,7 +47263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47261
47263
|
/**
|
|
47262
47264
|
* Journey service.
|
|
47263
47265
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47264
|
-
* @version
|
|
47266
|
+
* @version 253.0.0
|
|
47265
47267
|
*/
|
|
47266
47268
|
|
|
47267
47269
|
/**
|
|
@@ -47834,11 +47836,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47834
47836
|
}
|
|
47835
47837
|
|
|
47836
47838
|
/**
|
|
47837
|
-
* Retrieve a single action target.
|
|
47838
|
-
*
|
|
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
|
|
47839
47841
|
* @param {String} actionTargetId ID of the action target.
|
|
47840
47842
|
* @param {Object} opts Optional parameters
|
|
47841
47843
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47844
|
+
* @deprecated
|
|
47842
47845
|
*/
|
|
47843
47846
|
getJourneyActiontarget(actionTargetId, opts) {
|
|
47844
47847
|
opts = opts || {};
|
|
@@ -47864,12 +47867,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47864
47867
|
}
|
|
47865
47868
|
|
|
47866
47869
|
/**
|
|
47867
|
-
* Retrieve all action targets.
|
|
47868
|
-
*
|
|
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
|
|
47869
47872
|
* @param {Object} opts Optional parameters
|
|
47870
47873
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47871
47874
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47872
47875
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47876
|
+
* @deprecated
|
|
47873
47877
|
*/
|
|
47874
47878
|
getJourneyActiontargets(opts) {
|
|
47875
47879
|
opts = opts || {};
|
|
@@ -49039,6 +49043,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49039
49043
|
);
|
|
49040
49044
|
}
|
|
49041
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
|
+
|
|
49042
49096
|
/**
|
|
49043
49097
|
* Get the jobs for an organization.
|
|
49044
49098
|
*
|
|
@@ -49156,12 +49210,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49156
49210
|
}
|
|
49157
49211
|
|
|
49158
49212
|
/**
|
|
49159
|
-
* Update a single action target.
|
|
49160
|
-
*
|
|
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
|
|
49161
49215
|
* @param {String} actionTargetId ID of the action target.
|
|
49162
49216
|
* @param {Object} opts Optional parameters
|
|
49163
49217
|
* @param {Object} opts.body
|
|
49164
49218
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49219
|
+
* @deprecated
|
|
49165
49220
|
*/
|
|
49166
49221
|
patchJourneyActiontarget(actionTargetId, opts) {
|
|
49167
49222
|
opts = opts || {};
|
|
@@ -50120,13 +50175,75 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50120
50175
|
);
|
|
50121
50176
|
}
|
|
50122
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
|
+
|
|
50123
50240
|
}
|
|
50124
50241
|
|
|
50125
50242
|
class KnowledgeApi {
|
|
50126
50243
|
/**
|
|
50127
50244
|
* Knowledge service.
|
|
50128
50245
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
50129
|
-
* @version
|
|
50246
|
+
* @version 253.0.0
|
|
50130
50247
|
*/
|
|
50131
50248
|
|
|
50132
50249
|
/**
|
|
@@ -51325,6 +51442,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51325
51442
|
);
|
|
51326
51443
|
}
|
|
51327
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
|
+
|
|
51328
51486
|
/**
|
|
51329
51487
|
* Get export job report
|
|
51330
51488
|
*
|
|
@@ -54336,7 +54494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54336
54494
|
/**
|
|
54337
54495
|
* LanguageUnderstanding service.
|
|
54338
54496
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
54339
|
-
* @version
|
|
54497
|
+
* @version 253.0.0
|
|
54340
54498
|
*/
|
|
54341
54499
|
|
|
54342
54500
|
/**
|
|
@@ -55710,7 +55868,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55710
55868
|
/**
|
|
55711
55869
|
* Languages service.
|
|
55712
55870
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
55713
|
-
* @version
|
|
55871
|
+
* @version 253.0.0
|
|
55714
55872
|
*/
|
|
55715
55873
|
|
|
55716
55874
|
/**
|
|
@@ -55969,7 +56127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55969
56127
|
/**
|
|
55970
56128
|
* Learning service.
|
|
55971
56129
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
55972
|
-
* @version
|
|
56130
|
+
* @version 253.0.0
|
|
55973
56131
|
*/
|
|
55974
56132
|
|
|
55975
56133
|
/**
|
|
@@ -57217,7 +57375,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57217
57375
|
/**
|
|
57218
57376
|
* License service.
|
|
57219
57377
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57220
|
-
* @version
|
|
57378
|
+
* @version 253.0.0
|
|
57221
57379
|
*/
|
|
57222
57380
|
|
|
57223
57381
|
/**
|
|
@@ -57515,7 +57673,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57515
57673
|
/**
|
|
57516
57674
|
* Locations service.
|
|
57517
57675
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
57518
|
-
* @version
|
|
57676
|
+
* @version 253.0.0
|
|
57519
57677
|
*/
|
|
57520
57678
|
|
|
57521
57679
|
/**
|
|
@@ -57782,7 +57940,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57782
57940
|
/**
|
|
57783
57941
|
* LogCapture service.
|
|
57784
57942
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
57785
|
-
* @version
|
|
57943
|
+
* @version 253.0.0
|
|
57786
57944
|
*/
|
|
57787
57945
|
|
|
57788
57946
|
/**
|
|
@@ -58004,7 +58162,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58004
58162
|
/**
|
|
58005
58163
|
* Messaging service.
|
|
58006
58164
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
58007
|
-
* @version
|
|
58165
|
+
* @version 253.0.0
|
|
58008
58166
|
*/
|
|
58009
58167
|
|
|
58010
58168
|
/**
|
|
@@ -58422,7 +58580,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58422
58580
|
/**
|
|
58423
58581
|
* MobileDevices service.
|
|
58424
58582
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
58425
|
-
* @version
|
|
58583
|
+
* @version 253.0.0
|
|
58426
58584
|
*/
|
|
58427
58585
|
|
|
58428
58586
|
/**
|
|
@@ -58592,7 +58750,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58592
58750
|
/**
|
|
58593
58751
|
* Notifications service.
|
|
58594
58752
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
58595
|
-
* @version
|
|
58753
|
+
* @version 253.0.0
|
|
58596
58754
|
*/
|
|
58597
58755
|
|
|
58598
58756
|
/**
|
|
@@ -58853,7 +59011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58853
59011
|
/**
|
|
58854
59012
|
* OAuth service.
|
|
58855
59013
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
58856
|
-
* @version
|
|
59014
|
+
* @version 253.0.0
|
|
58857
59015
|
*/
|
|
58858
59016
|
|
|
58859
59017
|
/**
|
|
@@ -59269,7 +59427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59269
59427
|
/**
|
|
59270
59428
|
* Objects service.
|
|
59271
59429
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59272
|
-
* @version
|
|
59430
|
+
* @version 253.0.0
|
|
59273
59431
|
*/
|
|
59274
59432
|
|
|
59275
59433
|
/**
|
|
@@ -59633,7 +59791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59633
59791
|
/**
|
|
59634
59792
|
* OperationalEvents service.
|
|
59635
59793
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
59636
|
-
* @version
|
|
59794
|
+
* @version 253.0.0
|
|
59637
59795
|
*/
|
|
59638
59796
|
|
|
59639
59797
|
/**
|
|
@@ -59764,7 +59922,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59764
59922
|
/**
|
|
59765
59923
|
* Organization service.
|
|
59766
59924
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
59767
|
-
* @version
|
|
59925
|
+
* @version 253.0.0
|
|
59768
59926
|
*/
|
|
59769
59927
|
|
|
59770
59928
|
/**
|
|
@@ -60325,7 +60483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60325
60483
|
/**
|
|
60326
60484
|
* OrganizationAuthorization service.
|
|
60327
60485
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60328
|
-
* @version
|
|
60486
|
+
* @version 253.0.0
|
|
60329
60487
|
*/
|
|
60330
60488
|
|
|
60331
60489
|
/**
|
|
@@ -61929,7 +62087,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61929
62087
|
/**
|
|
61930
62088
|
* Outbound service.
|
|
61931
62089
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
61932
|
-
* @version
|
|
62090
|
+
* @version 253.0.0
|
|
61933
62091
|
*/
|
|
61934
62092
|
|
|
61935
62093
|
/**
|
|
@@ -67516,7 +67674,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67516
67674
|
/**
|
|
67517
67675
|
* Presence service.
|
|
67518
67676
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
67519
|
-
* @version
|
|
67677
|
+
* @version 253.0.0
|
|
67520
67678
|
*/
|
|
67521
67679
|
|
|
67522
67680
|
/**
|
|
@@ -68374,7 +68532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68374
68532
|
/**
|
|
68375
68533
|
* ProcessAutomation service.
|
|
68376
68534
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
68377
|
-
* @version
|
|
68535
|
+
* @version 253.0.0
|
|
68378
68536
|
*/
|
|
68379
68537
|
|
|
68380
68538
|
/**
|
|
@@ -68795,7 +68953,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68795
68953
|
/**
|
|
68796
68954
|
* Quality service.
|
|
68797
68955
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
68798
|
-
* @version
|
|
68956
|
+
* @version 253.0.0
|
|
68799
68957
|
*/
|
|
68800
68958
|
|
|
68801
68959
|
/**
|
|
@@ -71153,7 +71311,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71153
71311
|
/**
|
|
71154
71312
|
* Recording service.
|
|
71155
71313
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
71156
|
-
* @version
|
|
71314
|
+
* @version 253.0.0
|
|
71157
71315
|
*/
|
|
71158
71316
|
|
|
71159
71317
|
/**
|
|
@@ -73001,7 +73159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73001
73159
|
/**
|
|
73002
73160
|
* ResponseManagement service.
|
|
73003
73161
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
73004
|
-
* @version
|
|
73162
|
+
* @version 253.0.0
|
|
73005
73163
|
*/
|
|
73006
73164
|
|
|
73007
73165
|
/**
|
|
@@ -73645,7 +73803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73645
73803
|
/**
|
|
73646
73804
|
* Routing service.
|
|
73647
73805
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
73648
|
-
* @version
|
|
73806
|
+
* @version 253.0.0
|
|
73649
73807
|
*/
|
|
73650
73808
|
|
|
73651
73809
|
/**
|
|
@@ -74093,6 +74251,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74093
74251
|
);
|
|
74094
74252
|
}
|
|
74095
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
|
+
|
|
74096
74310
|
/**
|
|
74097
74311
|
* Remove skill group definition
|
|
74098
74312
|
*
|
|
@@ -74299,38 +74513,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74299
74513
|
);
|
|
74300
74514
|
}
|
|
74301
74515
|
|
|
74302
|
-
/**
|
|
74303
|
-
* Delete an utilization tag
|
|
74304
|
-
*
|
|
74305
|
-
* @param {String} tagId Utilization Tag ID
|
|
74306
|
-
* @param {Object} opts Optional parameters
|
|
74307
|
-
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
74308
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74309
|
-
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
74310
|
-
*/
|
|
74311
|
-
deleteRoutingUtilizationTag(tagId, opts) {
|
|
74312
|
-
opts = opts || {};
|
|
74313
|
-
|
|
74314
|
-
// verify the required parameter 'tagId' is set
|
|
74315
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
74316
|
-
throw 'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';
|
|
74317
|
-
}
|
|
74318
|
-
|
|
74319
|
-
return this.apiClient.callApi(
|
|
74320
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
74321
|
-
'DELETE',
|
|
74322
|
-
{ 'tagId': tagId },
|
|
74323
|
-
{ 'forceDelete': opts['forceDelete'] },
|
|
74324
|
-
{ },
|
|
74325
|
-
{ },
|
|
74326
|
-
null,
|
|
74327
|
-
['PureCloud OAuth'],
|
|
74328
|
-
['application/json'],
|
|
74329
|
-
['application/json'],
|
|
74330
|
-
opts['customHeaders']
|
|
74331
|
-
);
|
|
74332
|
-
}
|
|
74333
|
-
|
|
74334
74516
|
/**
|
|
74335
74517
|
* Delete wrap-up code
|
|
74336
74518
|
*
|
|
@@ -75871,6 +76053,98 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75871
76053
|
);
|
|
75872
76054
|
}
|
|
75873
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
|
+
|
|
75874
76148
|
/**
|
|
75875
76149
|
* Get skill group
|
|
75876
76150
|
*
|
|
@@ -76393,98 +76667,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76393
76667
|
);
|
|
76394
76668
|
}
|
|
76395
76669
|
|
|
76396
|
-
/**
|
|
76397
|
-
* Get details about this utilization tag
|
|
76398
|
-
*
|
|
76399
|
-
* @param {String} tagId Utilization Tag ID
|
|
76400
|
-
* @param {Object} opts Optional parameters
|
|
76401
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76402
|
-
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76403
|
-
*/
|
|
76404
|
-
getRoutingUtilizationTag(tagId, opts) {
|
|
76405
|
-
opts = opts || {};
|
|
76406
|
-
|
|
76407
|
-
// verify the required parameter 'tagId' is set
|
|
76408
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76409
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';
|
|
76410
|
-
}
|
|
76411
|
-
|
|
76412
|
-
return this.apiClient.callApi(
|
|
76413
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
76414
|
-
'GET',
|
|
76415
|
-
{ 'tagId': tagId },
|
|
76416
|
-
{ },
|
|
76417
|
-
{ },
|
|
76418
|
-
{ },
|
|
76419
|
-
null,
|
|
76420
|
-
['PureCloud OAuth'],
|
|
76421
|
-
['application/json'],
|
|
76422
|
-
['application/json'],
|
|
76423
|
-
opts['customHeaders']
|
|
76424
|
-
);
|
|
76425
|
-
}
|
|
76426
|
-
|
|
76427
|
-
/**
|
|
76428
|
-
* Get list of agent ids associated with a utilization tag
|
|
76429
|
-
*
|
|
76430
|
-
* @param {String} tagId Utilization Tag ID
|
|
76431
|
-
* @param {Object} opts Optional parameters
|
|
76432
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76433
|
-
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76434
|
-
*/
|
|
76435
|
-
getRoutingUtilizationTagAgents(tagId, opts) {
|
|
76436
|
-
opts = opts || {};
|
|
76437
|
-
|
|
76438
|
-
// verify the required parameter 'tagId' is set
|
|
76439
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76440
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';
|
|
76441
|
-
}
|
|
76442
|
-
|
|
76443
|
-
return this.apiClient.callApi(
|
|
76444
|
-
'/api/v2/routing/utilization/tags/{tagId}/agents',
|
|
76445
|
-
'GET',
|
|
76446
|
-
{ 'tagId': tagId },
|
|
76447
|
-
{ },
|
|
76448
|
-
{ },
|
|
76449
|
-
{ },
|
|
76450
|
-
null,
|
|
76451
|
-
['PureCloud OAuth'],
|
|
76452
|
-
['application/json'],
|
|
76453
|
-
['application/json'],
|
|
76454
|
-
opts['customHeaders']
|
|
76455
|
-
);
|
|
76456
|
-
}
|
|
76457
|
-
|
|
76458
|
-
/**
|
|
76459
|
-
* Get list of utilization tags
|
|
76460
|
-
*
|
|
76461
|
-
* @param {Object} opts Optional parameters
|
|
76462
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
76463
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
76464
|
-
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
76465
|
-
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
76466
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76467
|
-
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76468
|
-
*/
|
|
76469
|
-
getRoutingUtilizationTags(opts) {
|
|
76470
|
-
opts = opts || {};
|
|
76471
|
-
|
|
76472
|
-
|
|
76473
|
-
return this.apiClient.callApi(
|
|
76474
|
-
'/api/v2/routing/utilization/tags',
|
|
76475
|
-
'GET',
|
|
76476
|
-
{ },
|
|
76477
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
76478
|
-
{ },
|
|
76479
|
-
{ },
|
|
76480
|
-
null,
|
|
76481
|
-
['PureCloud OAuth'],
|
|
76482
|
-
['application/json'],
|
|
76483
|
-
['application/json'],
|
|
76484
|
-
opts['customHeaders']
|
|
76485
|
-
);
|
|
76486
|
-
}
|
|
76487
|
-
|
|
76488
76670
|
/**
|
|
76489
76671
|
* Get details about this wrap-up code.
|
|
76490
76672
|
*
|
|
@@ -78068,6 +78250,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78068
78250
|
);
|
|
78069
78251
|
}
|
|
78070
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
|
+
|
|
78071
78283
|
/**
|
|
78072
78284
|
* Add or remove member divisions for this skill group.
|
|
78073
78285
|
*
|
|
@@ -78310,37 +78522,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78310
78522
|
);
|
|
78311
78523
|
}
|
|
78312
78524
|
|
|
78313
|
-
/**
|
|
78314
|
-
* Create an utilization tag
|
|
78315
|
-
*
|
|
78316
|
-
* @param {Object} body UtilizationTag
|
|
78317
|
-
* @param {Object} opts Optional parameters
|
|
78318
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78319
|
-
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
78320
|
-
*/
|
|
78321
|
-
postRoutingUtilizationTags(body, opts) {
|
|
78322
|
-
opts = opts || {};
|
|
78323
|
-
|
|
78324
|
-
// verify the required parameter 'body' is set
|
|
78325
|
-
if (body === undefined || body === null) {
|
|
78326
|
-
throw 'Missing the required parameter "body" when calling postRoutingUtilizationTags';
|
|
78327
|
-
}
|
|
78328
|
-
|
|
78329
|
-
return this.apiClient.callApi(
|
|
78330
|
-
'/api/v2/routing/utilization/tags',
|
|
78331
|
-
'POST',
|
|
78332
|
-
{ },
|
|
78333
|
-
{ },
|
|
78334
|
-
{ },
|
|
78335
|
-
{ },
|
|
78336
|
-
body,
|
|
78337
|
-
['PureCloud OAuth'],
|
|
78338
|
-
['application/json'],
|
|
78339
|
-
['application/json'],
|
|
78340
|
-
opts['customHeaders']
|
|
78341
|
-
);
|
|
78342
|
-
}
|
|
78343
|
-
|
|
78344
78525
|
/**
|
|
78345
78526
|
* Create a wrap-up code
|
|
78346
78527
|
*
|
|
@@ -79032,7 +79213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79032
79213
|
/**
|
|
79033
79214
|
* SCIM service.
|
|
79034
79215
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
79035
|
-
* @version
|
|
79216
|
+
* @version 253.0.0
|
|
79036
79217
|
*/
|
|
79037
79218
|
|
|
79038
79219
|
/**
|
|
@@ -79993,7 +80174,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79993
80174
|
/**
|
|
79994
80175
|
* Scripts service.
|
|
79995
80176
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
79996
|
-
* @version
|
|
80177
|
+
* @version 253.0.0
|
|
79997
80178
|
*/
|
|
79998
80179
|
|
|
79999
80180
|
/**
|
|
@@ -80502,7 +80683,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80502
80683
|
/**
|
|
80503
80684
|
* Search service.
|
|
80504
80685
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
80505
|
-
* @version
|
|
80686
|
+
* @version 253.0.0
|
|
80506
80687
|
*/
|
|
80507
80688
|
|
|
80508
80689
|
/**
|
|
@@ -81318,7 +81499,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81318
81499
|
/**
|
|
81319
81500
|
* Settings service.
|
|
81320
81501
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
81321
|
-
* @version
|
|
81502
|
+
* @version 253.0.0
|
|
81322
81503
|
*/
|
|
81323
81504
|
|
|
81324
81505
|
/**
|
|
@@ -81727,7 +81908,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81727
81908
|
/**
|
|
81728
81909
|
* SocialMedia service.
|
|
81729
81910
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
81730
|
-
* @version
|
|
81911
|
+
* @version 253.0.0
|
|
81731
81912
|
*/
|
|
81732
81913
|
|
|
81733
81914
|
/**
|
|
@@ -83712,7 +83893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83712
83893
|
/**
|
|
83713
83894
|
* SpeechTextAnalytics service.
|
|
83714
83895
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
83715
|
-
* @version
|
|
83896
|
+
* @version 253.0.0
|
|
83716
83897
|
*/
|
|
83717
83898
|
|
|
83718
83899
|
/**
|
|
@@ -85664,7 +85845,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85664
85845
|
/**
|
|
85665
85846
|
* Stations service.
|
|
85666
85847
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
85667
|
-
* @version
|
|
85848
|
+
* @version 253.0.0
|
|
85668
85849
|
*/
|
|
85669
85850
|
|
|
85670
85851
|
/**
|
|
@@ -85778,7 +85959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85778
85959
|
/**
|
|
85779
85960
|
* Suggest service.
|
|
85780
85961
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
85781
|
-
* @version
|
|
85962
|
+
* @version 253.0.0
|
|
85782
85963
|
*/
|
|
85783
85964
|
|
|
85784
85965
|
/**
|
|
@@ -85925,7 +86106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85925
86106
|
/**
|
|
85926
86107
|
* TaskManagement service.
|
|
85927
86108
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
85928
|
-
* @version
|
|
86109
|
+
* @version 253.0.0
|
|
85929
86110
|
*/
|
|
85930
86111
|
|
|
85931
86112
|
/**
|
|
@@ -88421,7 +88602,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88421
88602
|
/**
|
|
88422
88603
|
* Teams service.
|
|
88423
88604
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
88424
|
-
* @version
|
|
88605
|
+
* @version 253.0.0
|
|
88425
88606
|
*/
|
|
88426
88607
|
|
|
88427
88608
|
/**
|
|
@@ -88764,7 +88945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88764
88945
|
/**
|
|
88765
88946
|
* Telephony service.
|
|
88766
88947
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
88767
|
-
* @version
|
|
88948
|
+
* @version 253.0.0
|
|
88768
88949
|
*/
|
|
88769
88950
|
|
|
88770
88951
|
/**
|
|
@@ -89171,7 +89352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89171
89352
|
/**
|
|
89172
89353
|
* TelephonyProvidersEdge service.
|
|
89173
89354
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
89174
|
-
* @version
|
|
89355
|
+
* @version 253.0.0
|
|
89175
89356
|
*/
|
|
89176
89357
|
|
|
89177
89358
|
/**
|
|
@@ -92363,52 +92544,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
92363
92544
|
);
|
|
92364
92545
|
}
|
|
92365
92546
|
|
|
92366
|
-
/**
|
|
92367
|
-
* Post media endpoint statistics event.
|
|
92368
|
-
*
|
|
92369
|
-
* @param {String} conversationId Identifier of the conversation
|
|
92370
|
-
* @param {String} communicationId Identifier of the media session
|
|
92371
|
-
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
92372
|
-
* @param {Object} body MediaStatisticsPostRequest
|
|
92373
|
-
* @param {Object} opts Optional parameters
|
|
92374
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
92375
|
-
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
92376
|
-
*/
|
|
92377
|
-
postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body, opts) {
|
|
92378
|
-
opts = opts || {};
|
|
92379
|
-
|
|
92380
|
-
// verify the required parameter 'conversationId' is set
|
|
92381
|
-
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
92382
|
-
throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92383
|
-
}
|
|
92384
|
-
// verify the required parameter 'communicationId' is set
|
|
92385
|
-
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
92386
|
-
throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92387
|
-
}
|
|
92388
|
-
// verify the required parameter 'mediaResourceId' is set
|
|
92389
|
-
if (mediaResourceId === undefined || mediaResourceId === null || mediaResourceId === '') {
|
|
92390
|
-
throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92391
|
-
}
|
|
92392
|
-
// verify the required parameter 'body' is set
|
|
92393
|
-
if (body === undefined || body === null) {
|
|
92394
|
-
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92395
|
-
}
|
|
92396
|
-
|
|
92397
|
-
return this.apiClient.callApi(
|
|
92398
|
-
'/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
|
|
92399
|
-
'POST',
|
|
92400
|
-
{ 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
|
|
92401
|
-
{ },
|
|
92402
|
-
{ },
|
|
92403
|
-
{ },
|
|
92404
|
-
body,
|
|
92405
|
-
['PureCloud OAuth'],
|
|
92406
|
-
['application/json'],
|
|
92407
|
-
['application/json'],
|
|
92408
|
-
opts['customHeaders']
|
|
92409
|
-
);
|
|
92410
|
-
}
|
|
92411
|
-
|
|
92412
92547
|
/**
|
|
92413
92548
|
* Reboot a Phone
|
|
92414
92549
|
*
|
|
@@ -93195,7 +93330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93195
93330
|
/**
|
|
93196
93331
|
* Textbots service.
|
|
93197
93332
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
93198
|
-
* @version
|
|
93333
|
+
* @version 253.0.0
|
|
93199
93334
|
*/
|
|
93200
93335
|
|
|
93201
93336
|
/**
|
|
@@ -93341,7 +93476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93341
93476
|
/**
|
|
93342
93477
|
* Tokens service.
|
|
93343
93478
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
93344
|
-
* @version
|
|
93479
|
+
* @version 253.0.0
|
|
93345
93480
|
*/
|
|
93346
93481
|
|
|
93347
93482
|
/**
|
|
@@ -93519,7 +93654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93519
93654
|
/**
|
|
93520
93655
|
* Uploads service.
|
|
93521
93656
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
93522
|
-
* @version
|
|
93657
|
+
* @version 253.0.0
|
|
93523
93658
|
*/
|
|
93524
93659
|
|
|
93525
93660
|
/**
|
|
@@ -93890,7 +94025,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93890
94025
|
/**
|
|
93891
94026
|
* Usage service.
|
|
93892
94027
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
93893
|
-
* @version
|
|
94028
|
+
* @version 253.0.0
|
|
93894
94029
|
*/
|
|
93895
94030
|
|
|
93896
94031
|
/**
|
|
@@ -94268,7 +94403,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94268
94403
|
/**
|
|
94269
94404
|
* UserRecordings service.
|
|
94270
94405
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
94271
|
-
* @version
|
|
94406
|
+
* @version 253.0.0
|
|
94272
94407
|
*/
|
|
94273
94408
|
|
|
94274
94409
|
/**
|
|
@@ -94470,7 +94605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94470
94605
|
/**
|
|
94471
94606
|
* Users service.
|
|
94472
94607
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
94473
|
-
* @version
|
|
94608
|
+
* @version 253.0.0
|
|
94474
94609
|
*/
|
|
94475
94610
|
|
|
94476
94611
|
/**
|
|
@@ -98489,7 +98624,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98489
98624
|
/**
|
|
98490
98625
|
* UsersRules service.
|
|
98491
98626
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
98492
|
-
* @version
|
|
98627
|
+
* @version 253.0.0
|
|
98493
98628
|
*/
|
|
98494
98629
|
|
|
98495
98630
|
/**
|
|
@@ -98806,7 +98941,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98806
98941
|
/**
|
|
98807
98942
|
* Utilities service.
|
|
98808
98943
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
98809
|
-
* @version
|
|
98944
|
+
* @version 253.0.0
|
|
98810
98945
|
*/
|
|
98811
98946
|
|
|
98812
98947
|
/**
|
|
@@ -98934,7 +99069,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98934
99069
|
/**
|
|
98935
99070
|
* Voicemail service.
|
|
98936
99071
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
98937
|
-
* @version
|
|
99072
|
+
* @version 253.0.0
|
|
98938
99073
|
*/
|
|
98939
99074
|
|
|
98940
99075
|
/**
|
|
@@ -99764,7 +99899,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99764
99899
|
/**
|
|
99765
99900
|
* WebChat service.
|
|
99766
99901
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
99767
|
-
* @version
|
|
99902
|
+
* @version 253.0.0
|
|
99768
99903
|
*/
|
|
99769
99904
|
|
|
99770
99905
|
/**
|
|
@@ -100416,7 +100551,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100416
100551
|
/**
|
|
100417
100552
|
* WebDeployments service.
|
|
100418
100553
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
100419
|
-
* @version
|
|
100554
|
+
* @version 253.0.0
|
|
100420
100555
|
*/
|
|
100421
100556
|
|
|
100422
100557
|
/**
|
|
@@ -101094,7 +101229,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101094
101229
|
/**
|
|
101095
101230
|
* WebMessaging service.
|
|
101096
101231
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
101097
|
-
* @version
|
|
101232
|
+
* @version 253.0.0
|
|
101098
101233
|
*/
|
|
101099
101234
|
|
|
101100
101235
|
/**
|
|
@@ -101257,7 +101392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101257
101392
|
/**
|
|
101258
101393
|
* Widgets service.
|
|
101259
101394
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
101260
|
-
* @version
|
|
101395
|
+
* @version 253.0.0
|
|
101261
101396
|
*/
|
|
101262
101397
|
|
|
101263
101398
|
/**
|
|
@@ -101433,7 +101568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101433
101568
|
/**
|
|
101434
101569
|
* WorkforceManagement service.
|
|
101435
101570
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
101436
|
-
* @version
|
|
101571
|
+
* @version 253.0.0
|
|
101437
101572
|
*/
|
|
101438
101573
|
|
|
101439
101574
|
/**
|
|
@@ -103296,6 +103431,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
103296
103431
|
);
|
|
103297
103432
|
}
|
|
103298
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
|
+
|
|
103299
103470
|
/**
|
|
103300
103471
|
* Get a planning group
|
|
103301
103472
|
*
|
|
@@ -105129,11 +105300,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105129
105300
|
|
|
105130
105301
|
/**
|
|
105131
105302
|
* Gets all the shift trades for a given agent
|
|
105132
|
-
*
|
|
105303
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
105133
105304
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105134
105305
|
* @param {String} agentId The agent id
|
|
105135
105306
|
* @param {Object} opts Optional parameters
|
|
105136
105307
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105308
|
+
* @deprecated
|
|
105137
105309
|
*/
|
|
105138
105310
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId, opts) {
|
|
105139
105311
|
opts = opts || {};
|
|
@@ -105164,10 +105336,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105164
105336
|
|
|
105165
105337
|
/**
|
|
105166
105338
|
* Gets a summary of all shift trades in the matched state
|
|
105167
|
-
*
|
|
105339
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
105168
105340
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105169
105341
|
* @param {Object} opts Optional parameters
|
|
105170
105342
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105343
|
+
* @deprecated
|
|
105171
105344
|
*/
|
|
105172
105345
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId, opts) {
|
|
105173
105346
|
opts = opts || {};
|
|
@@ -105581,7 +105754,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105581
105754
|
|
|
105582
105755
|
/**
|
|
105583
105756
|
* Gets all the shift trades for a given week
|
|
105584
|
-
*
|
|
105757
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
105585
105758
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105586
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
|
|
105587
105760
|
* @param {Object} opts Optional parameters
|
|
@@ -105589,6 +105762,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105589
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)
|
|
105590
105763
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
105591
105764
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105765
|
+
* @deprecated
|
|
105592
105766
|
*/
|
|
105593
105767
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
105594
105768
|
opts = opts || {};
|
|
@@ -105864,9 +106038,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105864
106038
|
|
|
105865
106039
|
/**
|
|
105866
106040
|
* Gets all of my shift trades
|
|
105867
|
-
*
|
|
106041
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
105868
106042
|
* @param {Object} opts Optional parameters
|
|
105869
106043
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106044
|
+
* @deprecated
|
|
105870
106045
|
*/
|
|
105871
106046
|
getWorkforcemanagementShifttrades(opts) {
|
|
105872
106047
|
opts = opts || {};
|
|
@@ -106728,9 +106903,49 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
106728
106903
|
);
|
|
106729
106904
|
}
|
|
106730
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
|
+
|
|
106731
106946
|
/**
|
|
106732
106947
|
* Updates the planning group
|
|
106733
|
-
*
|
|
106948
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
106734
106949
|
* @param {String} businessUnitId The ID of the business unit.
|
|
106735
106950
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
106736
106951
|
* @param {Object} body body
|
|
@@ -107405,13 +107620,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
107405
107620
|
|
|
107406
107621
|
/**
|
|
107407
107622
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
107408
|
-
*
|
|
107623
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
107409
107624
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
107410
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
|
|
107411
107626
|
* @param {String} tradeId The ID of the shift trade to update
|
|
107412
107627
|
* @param {Object} body body
|
|
107413
107628
|
* @param {Object} opts Optional parameters
|
|
107414
107629
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107630
|
+
* @deprecated
|
|
107415
107631
|
*/
|
|
107416
107632
|
patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
107417
107633
|
opts = opts || {};
|
|
@@ -107756,33 +107972,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
107756
107972
|
);
|
|
107757
107973
|
}
|
|
107758
107974
|
|
|
107759
|
-
/**
|
|
107760
|
-
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
107761
|
-
*
|
|
107762
|
-
* @param {Object} opts Optional parameters
|
|
107763
|
-
* @param {Object} opts.body body
|
|
107764
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107765
|
-
* @deprecated
|
|
107766
|
-
*/
|
|
107767
|
-
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
107768
|
-
opts = opts || {};
|
|
107769
|
-
|
|
107770
|
-
|
|
107771
|
-
return this.apiClient.callApi(
|
|
107772
|
-
'/api/v2/workforcemanagement/adherence/historical',
|
|
107773
|
-
'POST',
|
|
107774
|
-
{ },
|
|
107775
|
-
{ },
|
|
107776
|
-
{ },
|
|
107777
|
-
{ },
|
|
107778
|
-
opts['body'],
|
|
107779
|
-
['PureCloud OAuth'],
|
|
107780
|
-
['application/json'],
|
|
107781
|
-
['application/json'],
|
|
107782
|
-
opts['customHeaders']
|
|
107783
|
-
);
|
|
107784
|
-
}
|
|
107785
|
-
|
|
107786
107975
|
/**
|
|
107787
107976
|
* Request a historical adherence report in bulk
|
|
107788
107977
|
*
|
|
@@ -108037,6 +108226,98 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
108037
108226
|
);
|
|
108038
108227
|
}
|
|
108039
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
|
+
|
|
108040
108321
|
/**
|
|
108041
108322
|
* Fetch agent schedules for the logged in user's management unit
|
|
108042
108323
|
*
|
|
@@ -108706,8 +108987,291 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
108706
108987
|
}
|
|
108707
108988
|
|
|
108708
108989
|
/**
|
|
108709
|
-
*
|
|
108990
|
+
* Bulk add opportunities
|
|
108710
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.
|
|
108711
109275
|
* @param {String} businessUnitId The ID of the business unit.
|
|
108712
109276
|
* @param {Object} body body
|
|
108713
109277
|
* @param {Object} opts Optional parameters
|
|
@@ -110728,13 +111292,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110728
111292
|
|
|
110729
111293
|
/**
|
|
110730
111294
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
110731
|
-
*
|
|
111295
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
110732
111296
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110733
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
|
|
110734
111298
|
* @param {String} tradeId The ID of the shift trade to update
|
|
110735
111299
|
* @param {Object} body body
|
|
110736
111300
|
* @param {Object} opts Optional parameters
|
|
110737
111301
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111302
|
+
* @deprecated
|
|
110738
111303
|
*/
|
|
110739
111304
|
postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
110740
111305
|
opts = opts || {};
|
|
@@ -110773,12 +111338,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110773
111338
|
|
|
110774
111339
|
/**
|
|
110775
111340
|
* Adds a shift trade
|
|
110776
|
-
*
|
|
111341
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
110777
111342
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110778
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
|
|
110779
111344
|
* @param {Object} body body
|
|
110780
111345
|
* @param {Object} opts Optional parameters
|
|
110781
111346
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111347
|
+
* @deprecated
|
|
110782
111348
|
*/
|
|
110783
111349
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body, opts) {
|
|
110784
111350
|
opts = opts || {};
|
|
@@ -110813,13 +111379,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110813
111379
|
|
|
110814
111380
|
/**
|
|
110815
111381
|
* Searches for potential shift trade matches for the current agent
|
|
110816
|
-
*
|
|
111382
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
110817
111383
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110818
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
|
|
110819
111385
|
* @param {Object} body body
|
|
110820
111386
|
* @param {Object} opts Optional parameters
|
|
110821
111387
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110822
111388
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111389
|
+
* @deprecated
|
|
110823
111390
|
*/
|
|
110824
111391
|
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
110825
111392
|
opts = opts || {};
|
|
@@ -110854,13 +111421,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110854
111421
|
|
|
110855
111422
|
/**
|
|
110856
111423
|
* Updates the state of a batch of shift trades
|
|
110857
|
-
* 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)
|
|
110858
111425
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110859
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
|
|
110860
111427
|
* @param {Object} body body
|
|
110861
111428
|
* @param {Object} opts Optional parameters
|
|
110862
111429
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110863
111430
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111431
|
+
* @deprecated
|
|
110864
111432
|
*/
|
|
110865
111433
|
postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, opts) {
|
|
110866
111434
|
opts = opts || {};
|
|
@@ -111769,7 +112337,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
111769
112337
|
* </pre>
|
|
111770
112338
|
* </p>
|
|
111771
112339
|
* @module purecloud-platform-client-v2/index
|
|
111772
|
-
* @version
|
|
112340
|
+
* @version 253.0.0
|
|
111773
112341
|
*/
|
|
111774
112342
|
class platformClient {
|
|
111775
112343
|
constructor() {
|