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