purecloud-platform-client-v2 227.0.0 → 228.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 +1841 -237
- package/dist/web-amd/purecloud-platform-client-v2.js +1841 -237
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +583 -188
- package/dist/web-cjs/purecloud-platform-client-v2.js +583 -188
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1320 -290
- package/package.json +4 -4
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +32 -1
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +1 -1
- 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 +391 -26
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +4 -46
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ChatApi.js +7 -4
- 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 +61 -35
- 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 +60 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +27 -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/JourneyApi.js +86 -1
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +30 -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 +101 -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 +53 -1
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -26
- 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 +158 -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 +105 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +121 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +27 -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 +12 -12
- 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 +6 -6
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +494 -6
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -746,7 +746,7 @@ class Configuration {
|
|
|
746
746
|
|
|
747
747
|
/**
|
|
748
748
|
* @module purecloud-platform-client-v2/ApiClient
|
|
749
|
-
* @version
|
|
749
|
+
* @version 228.0.0
|
|
750
750
|
*/
|
|
751
751
|
class ApiClient {
|
|
752
752
|
/**
|
|
@@ -2290,7 +2290,7 @@ class AIStudioApi {
|
|
|
2290
2290
|
/**
|
|
2291
2291
|
* AIStudio service.
|
|
2292
2292
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2293
|
-
* @version
|
|
2293
|
+
* @version 228.0.0
|
|
2294
2294
|
*/
|
|
2295
2295
|
|
|
2296
2296
|
/**
|
|
@@ -2512,6 +2512,37 @@ class AIStudioApi {
|
|
|
2512
2512
|
);
|
|
2513
2513
|
}
|
|
2514
2514
|
|
|
2515
|
+
/**
|
|
2516
|
+
* Update a guide.
|
|
2517
|
+
*
|
|
2518
|
+
* @param {String} guideId Guide ID
|
|
2519
|
+
* @param {Object} body
|
|
2520
|
+
* patchGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2521
|
+
*/
|
|
2522
|
+
patchGuide(guideId, body) {
|
|
2523
|
+
// verify the required parameter 'guideId' is set
|
|
2524
|
+
if (guideId === undefined || guideId === null || guideId === '') {
|
|
2525
|
+
throw 'Missing the required parameter "guideId" when calling patchGuide';
|
|
2526
|
+
}
|
|
2527
|
+
// verify the required parameter 'body' is set
|
|
2528
|
+
if (body === undefined || body === null) {
|
|
2529
|
+
throw 'Missing the required parameter "body" when calling patchGuide';
|
|
2530
|
+
}
|
|
2531
|
+
|
|
2532
|
+
return this.apiClient.callApi(
|
|
2533
|
+
'/api/v2/guides/{guideId}',
|
|
2534
|
+
'PATCH',
|
|
2535
|
+
{ 'guideId': guideId },
|
|
2536
|
+
{ },
|
|
2537
|
+
{ },
|
|
2538
|
+
{ },
|
|
2539
|
+
body,
|
|
2540
|
+
['PureCloud OAuth'],
|
|
2541
|
+
['application/json'],
|
|
2542
|
+
['application/json']
|
|
2543
|
+
);
|
|
2544
|
+
}
|
|
2545
|
+
|
|
2515
2546
|
/**
|
|
2516
2547
|
* Update a guide version.
|
|
2517
2548
|
*
|
|
@@ -2672,7 +2703,7 @@ class AgentAssistantsApi {
|
|
|
2672
2703
|
/**
|
|
2673
2704
|
* AgentAssistants service.
|
|
2674
2705
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2675
|
-
* @version
|
|
2706
|
+
* @version 228.0.0
|
|
2676
2707
|
*/
|
|
2677
2708
|
|
|
2678
2709
|
/**
|
|
@@ -3049,7 +3080,7 @@ class AgentCopilotApi {
|
|
|
3049
3080
|
/**
|
|
3050
3081
|
* AgentCopilot service.
|
|
3051
3082
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3052
|
-
* @version
|
|
3083
|
+
* @version 228.0.0
|
|
3053
3084
|
*/
|
|
3054
3085
|
|
|
3055
3086
|
/**
|
|
@@ -3125,7 +3156,7 @@ class AgentUIApi {
|
|
|
3125
3156
|
/**
|
|
3126
3157
|
* AgentUI service.
|
|
3127
3158
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3128
|
-
* @version
|
|
3159
|
+
* @version 228.0.0
|
|
3129
3160
|
*/
|
|
3130
3161
|
|
|
3131
3162
|
/**
|
|
@@ -3256,7 +3287,7 @@ class AlertingApi {
|
|
|
3256
3287
|
/**
|
|
3257
3288
|
* Alerting service.
|
|
3258
3289
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3259
|
-
* @version
|
|
3290
|
+
* @version 228.0.0
|
|
3260
3291
|
*/
|
|
3261
3292
|
|
|
3262
3293
|
/**
|
|
@@ -3657,7 +3688,7 @@ class AnalyticsApi {
|
|
|
3657
3688
|
/**
|
|
3658
3689
|
* Analytics service.
|
|
3659
3690
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3660
|
-
* @version
|
|
3691
|
+
* @version 228.0.0
|
|
3661
3692
|
*/
|
|
3662
3693
|
|
|
3663
3694
|
/**
|
|
@@ -3672,6 +3703,110 @@ class AnalyticsApi {
|
|
|
3672
3703
|
}
|
|
3673
3704
|
|
|
3674
3705
|
|
|
3706
|
+
/**
|
|
3707
|
+
* Delete/cancel an async request for action aggregates
|
|
3708
|
+
*
|
|
3709
|
+
* @param {String} jobId jobId
|
|
3710
|
+
* deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3711
|
+
*/
|
|
3712
|
+
deleteAnalyticsActionsAggregatesJob(jobId) {
|
|
3713
|
+
// verify the required parameter 'jobId' is set
|
|
3714
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3715
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsActionsAggregatesJob';
|
|
3716
|
+
}
|
|
3717
|
+
|
|
3718
|
+
return this.apiClient.callApi(
|
|
3719
|
+
'/api/v2/analytics/actions/aggregates/jobs/{jobId}',
|
|
3720
|
+
'DELETE',
|
|
3721
|
+
{ 'jobId': jobId },
|
|
3722
|
+
{ },
|
|
3723
|
+
{ },
|
|
3724
|
+
{ },
|
|
3725
|
+
null,
|
|
3726
|
+
['PureCloud OAuth'],
|
|
3727
|
+
['application/json'],
|
|
3728
|
+
['application/json']
|
|
3729
|
+
);
|
|
3730
|
+
}
|
|
3731
|
+
|
|
3732
|
+
/**
|
|
3733
|
+
* Delete/cancel an async request for agent copilot aggregates
|
|
3734
|
+
*
|
|
3735
|
+
* @param {String} jobId jobId
|
|
3736
|
+
* deleteAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3737
|
+
*/
|
|
3738
|
+
deleteAnalyticsAgentcopilotsAggregatesJob(jobId) {
|
|
3739
|
+
// verify the required parameter 'jobId' is set
|
|
3740
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3741
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsAgentcopilotsAggregatesJob';
|
|
3742
|
+
}
|
|
3743
|
+
|
|
3744
|
+
return this.apiClient.callApi(
|
|
3745
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}',
|
|
3746
|
+
'DELETE',
|
|
3747
|
+
{ 'jobId': jobId },
|
|
3748
|
+
{ },
|
|
3749
|
+
{ },
|
|
3750
|
+
{ },
|
|
3751
|
+
null,
|
|
3752
|
+
['PureCloud OAuth'],
|
|
3753
|
+
['application/json'],
|
|
3754
|
+
['application/json']
|
|
3755
|
+
);
|
|
3756
|
+
}
|
|
3757
|
+
|
|
3758
|
+
/**
|
|
3759
|
+
* Delete/cancel an async request for bot aggregates
|
|
3760
|
+
*
|
|
3761
|
+
* @param {String} jobId jobId
|
|
3762
|
+
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3763
|
+
*/
|
|
3764
|
+
deleteAnalyticsBotsAggregatesJob(jobId) {
|
|
3765
|
+
// verify the required parameter 'jobId' is set
|
|
3766
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3767
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsBotsAggregatesJob';
|
|
3768
|
+
}
|
|
3769
|
+
|
|
3770
|
+
return this.apiClient.callApi(
|
|
3771
|
+
'/api/v2/analytics/bots/aggregates/jobs/{jobId}',
|
|
3772
|
+
'DELETE',
|
|
3773
|
+
{ 'jobId': jobId },
|
|
3774
|
+
{ },
|
|
3775
|
+
{ },
|
|
3776
|
+
{ },
|
|
3777
|
+
null,
|
|
3778
|
+
['PureCloud OAuth'],
|
|
3779
|
+
['application/json'],
|
|
3780
|
+
['application/json']
|
|
3781
|
+
);
|
|
3782
|
+
}
|
|
3783
|
+
|
|
3784
|
+
/**
|
|
3785
|
+
* Delete/cancel an async request for conversation aggregates
|
|
3786
|
+
*
|
|
3787
|
+
* @param {String} jobId jobId
|
|
3788
|
+
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3789
|
+
*/
|
|
3790
|
+
deleteAnalyticsConversationsAggregatesJob(jobId) {
|
|
3791
|
+
// verify the required parameter 'jobId' is set
|
|
3792
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3793
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';
|
|
3794
|
+
}
|
|
3795
|
+
|
|
3796
|
+
return this.apiClient.callApi(
|
|
3797
|
+
'/api/v2/analytics/conversations/aggregates/jobs/{jobId}',
|
|
3798
|
+
'DELETE',
|
|
3799
|
+
{ 'jobId': jobId },
|
|
3800
|
+
{ },
|
|
3801
|
+
{ },
|
|
3802
|
+
{ },
|
|
3803
|
+
null,
|
|
3804
|
+
['PureCloud OAuth'],
|
|
3805
|
+
['application/json'],
|
|
3806
|
+
['application/json']
|
|
3807
|
+
);
|
|
3808
|
+
}
|
|
3809
|
+
|
|
3675
3810
|
/**
|
|
3676
3811
|
* Delete/cancel an async details job
|
|
3677
3812
|
*
|
|
@@ -3697,6 +3832,292 @@ class AnalyticsApi {
|
|
|
3697
3832
|
);
|
|
3698
3833
|
}
|
|
3699
3834
|
|
|
3835
|
+
/**
|
|
3836
|
+
* Delete/cancel an async request for evaluation aggregates
|
|
3837
|
+
*
|
|
3838
|
+
* @param {String} jobId jobId
|
|
3839
|
+
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3840
|
+
*/
|
|
3841
|
+
deleteAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
3842
|
+
// verify the required parameter 'jobId' is set
|
|
3843
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3844
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';
|
|
3845
|
+
}
|
|
3846
|
+
|
|
3847
|
+
return this.apiClient.callApi(
|
|
3848
|
+
'/api/v2/analytics/evaluations/aggregates/jobs/{jobId}',
|
|
3849
|
+
'DELETE',
|
|
3850
|
+
{ 'jobId': jobId },
|
|
3851
|
+
{ },
|
|
3852
|
+
{ },
|
|
3853
|
+
{ },
|
|
3854
|
+
null,
|
|
3855
|
+
['PureCloud OAuth'],
|
|
3856
|
+
['application/json'],
|
|
3857
|
+
['application/json']
|
|
3858
|
+
);
|
|
3859
|
+
}
|
|
3860
|
+
|
|
3861
|
+
/**
|
|
3862
|
+
* Delete/cancel an async request for flow execution aggregates
|
|
3863
|
+
*
|
|
3864
|
+
* @param {String} jobId jobId
|
|
3865
|
+
* deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3866
|
+
*/
|
|
3867
|
+
deleteAnalyticsFlowexecutionsAggregatesJob(jobId) {
|
|
3868
|
+
// verify the required parameter 'jobId' is set
|
|
3869
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3870
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowexecutionsAggregatesJob';
|
|
3871
|
+
}
|
|
3872
|
+
|
|
3873
|
+
return this.apiClient.callApi(
|
|
3874
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}',
|
|
3875
|
+
'DELETE',
|
|
3876
|
+
{ 'jobId': jobId },
|
|
3877
|
+
{ },
|
|
3878
|
+
{ },
|
|
3879
|
+
{ },
|
|
3880
|
+
null,
|
|
3881
|
+
['PureCloud OAuth'],
|
|
3882
|
+
['application/json'],
|
|
3883
|
+
['application/json']
|
|
3884
|
+
);
|
|
3885
|
+
}
|
|
3886
|
+
|
|
3887
|
+
/**
|
|
3888
|
+
* Delete/cancel an async request for flow aggregates
|
|
3889
|
+
*
|
|
3890
|
+
* @param {String} jobId jobId
|
|
3891
|
+
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3892
|
+
*/
|
|
3893
|
+
deleteAnalyticsFlowsAggregatesJob(jobId) {
|
|
3894
|
+
// verify the required parameter 'jobId' is set
|
|
3895
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3896
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';
|
|
3897
|
+
}
|
|
3898
|
+
|
|
3899
|
+
return this.apiClient.callApi(
|
|
3900
|
+
'/api/v2/analytics/flows/aggregates/jobs/{jobId}',
|
|
3901
|
+
'DELETE',
|
|
3902
|
+
{ 'jobId': jobId },
|
|
3903
|
+
{ },
|
|
3904
|
+
{ },
|
|
3905
|
+
{ },
|
|
3906
|
+
null,
|
|
3907
|
+
['PureCloud OAuth'],
|
|
3908
|
+
['application/json'],
|
|
3909
|
+
['application/json']
|
|
3910
|
+
);
|
|
3911
|
+
}
|
|
3912
|
+
|
|
3913
|
+
/**
|
|
3914
|
+
* Delete/cancel an async request for journey aggregates
|
|
3915
|
+
*
|
|
3916
|
+
* @param {String} jobId jobId
|
|
3917
|
+
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3918
|
+
*/
|
|
3919
|
+
deleteAnalyticsJourneysAggregatesJob(jobId) {
|
|
3920
|
+
// verify the required parameter 'jobId' is set
|
|
3921
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3922
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';
|
|
3923
|
+
}
|
|
3924
|
+
|
|
3925
|
+
return this.apiClient.callApi(
|
|
3926
|
+
'/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
|
|
3927
|
+
'DELETE',
|
|
3928
|
+
{ 'jobId': jobId },
|
|
3929
|
+
{ },
|
|
3930
|
+
{ },
|
|
3931
|
+
{ },
|
|
3932
|
+
null,
|
|
3933
|
+
['PureCloud OAuth'],
|
|
3934
|
+
['application/json'],
|
|
3935
|
+
['application/json']
|
|
3936
|
+
);
|
|
3937
|
+
}
|
|
3938
|
+
|
|
3939
|
+
/**
|
|
3940
|
+
* Delete/cancel an async request for knowledge aggregates
|
|
3941
|
+
*
|
|
3942
|
+
* @param {String} jobId jobId
|
|
3943
|
+
* deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3944
|
+
*/
|
|
3945
|
+
deleteAnalyticsKnowledgeAggregatesJob(jobId) {
|
|
3946
|
+
// verify the required parameter 'jobId' is set
|
|
3947
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3948
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsKnowledgeAggregatesJob';
|
|
3949
|
+
}
|
|
3950
|
+
|
|
3951
|
+
return this.apiClient.callApi(
|
|
3952
|
+
'/api/v2/analytics/knowledge/aggregates/jobs/{jobId}',
|
|
3953
|
+
'DELETE',
|
|
3954
|
+
{ 'jobId': jobId },
|
|
3955
|
+
{ },
|
|
3956
|
+
{ },
|
|
3957
|
+
{ },
|
|
3958
|
+
null,
|
|
3959
|
+
['PureCloud OAuth'],
|
|
3960
|
+
['application/json'],
|
|
3961
|
+
['application/json']
|
|
3962
|
+
);
|
|
3963
|
+
}
|
|
3964
|
+
|
|
3965
|
+
/**
|
|
3966
|
+
* Delete/cancel an async request for resolution aggregates
|
|
3967
|
+
*
|
|
3968
|
+
* @param {String} jobId jobId
|
|
3969
|
+
* deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3970
|
+
*/
|
|
3971
|
+
deleteAnalyticsResolutionsAggregatesJob(jobId) {
|
|
3972
|
+
// verify the required parameter 'jobId' is set
|
|
3973
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3974
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsResolutionsAggregatesJob';
|
|
3975
|
+
}
|
|
3976
|
+
|
|
3977
|
+
return this.apiClient.callApi(
|
|
3978
|
+
'/api/v2/analytics/resolutions/aggregates/jobs/{jobId}',
|
|
3979
|
+
'DELETE',
|
|
3980
|
+
{ 'jobId': jobId },
|
|
3981
|
+
{ },
|
|
3982
|
+
{ },
|
|
3983
|
+
{ },
|
|
3984
|
+
null,
|
|
3985
|
+
['PureCloud OAuth'],
|
|
3986
|
+
['application/json'],
|
|
3987
|
+
['application/json']
|
|
3988
|
+
);
|
|
3989
|
+
}
|
|
3990
|
+
|
|
3991
|
+
/**
|
|
3992
|
+
* Delete/cancel an async request for summary aggregates
|
|
3993
|
+
*
|
|
3994
|
+
* @param {String} jobId jobId
|
|
3995
|
+
* deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3996
|
+
*/
|
|
3997
|
+
deleteAnalyticsSummariesAggregatesJob(jobId) {
|
|
3998
|
+
// verify the required parameter 'jobId' is set
|
|
3999
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4000
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSummariesAggregatesJob';
|
|
4001
|
+
}
|
|
4002
|
+
|
|
4003
|
+
return this.apiClient.callApi(
|
|
4004
|
+
'/api/v2/analytics/summaries/aggregates/jobs/{jobId}',
|
|
4005
|
+
'DELETE',
|
|
4006
|
+
{ 'jobId': jobId },
|
|
4007
|
+
{ },
|
|
4008
|
+
{ },
|
|
4009
|
+
{ },
|
|
4010
|
+
null,
|
|
4011
|
+
['PureCloud OAuth'],
|
|
4012
|
+
['application/json'],
|
|
4013
|
+
['application/json']
|
|
4014
|
+
);
|
|
4015
|
+
}
|
|
4016
|
+
|
|
4017
|
+
/**
|
|
4018
|
+
* Delete/cancel an async request for survey aggregates
|
|
4019
|
+
*
|
|
4020
|
+
* @param {String} jobId jobId
|
|
4021
|
+
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4022
|
+
*/
|
|
4023
|
+
deleteAnalyticsSurveysAggregatesJob(jobId) {
|
|
4024
|
+
// verify the required parameter 'jobId' is set
|
|
4025
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4026
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';
|
|
4027
|
+
}
|
|
4028
|
+
|
|
4029
|
+
return this.apiClient.callApi(
|
|
4030
|
+
'/api/v2/analytics/surveys/aggregates/jobs/{jobId}',
|
|
4031
|
+
'DELETE',
|
|
4032
|
+
{ 'jobId': jobId },
|
|
4033
|
+
{ },
|
|
4034
|
+
{ },
|
|
4035
|
+
{ },
|
|
4036
|
+
null,
|
|
4037
|
+
['PureCloud OAuth'],
|
|
4038
|
+
['application/json'],
|
|
4039
|
+
['application/json']
|
|
4040
|
+
);
|
|
4041
|
+
}
|
|
4042
|
+
|
|
4043
|
+
/**
|
|
4044
|
+
* Delete/cancel an async request for task management aggregates
|
|
4045
|
+
*
|
|
4046
|
+
* @param {String} jobId jobId
|
|
4047
|
+
* deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4048
|
+
*/
|
|
4049
|
+
deleteAnalyticsTaskmanagementAggregatesJob(jobId) {
|
|
4050
|
+
// verify the required parameter 'jobId' is set
|
|
4051
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4052
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTaskmanagementAggregatesJob';
|
|
4053
|
+
}
|
|
4054
|
+
|
|
4055
|
+
return this.apiClient.callApi(
|
|
4056
|
+
'/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}',
|
|
4057
|
+
'DELETE',
|
|
4058
|
+
{ 'jobId': jobId },
|
|
4059
|
+
{ },
|
|
4060
|
+
{ },
|
|
4061
|
+
{ },
|
|
4062
|
+
null,
|
|
4063
|
+
['PureCloud OAuth'],
|
|
4064
|
+
['application/json'],
|
|
4065
|
+
['application/json']
|
|
4066
|
+
);
|
|
4067
|
+
}
|
|
4068
|
+
|
|
4069
|
+
/**
|
|
4070
|
+
* Delete/cancel an async request for transcript aggregates
|
|
4071
|
+
*
|
|
4072
|
+
* @param {String} jobId jobId
|
|
4073
|
+
* deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4074
|
+
*/
|
|
4075
|
+
deleteAnalyticsTranscriptsAggregatesJob(jobId) {
|
|
4076
|
+
// verify the required parameter 'jobId' is set
|
|
4077
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4078
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTranscriptsAggregatesJob';
|
|
4079
|
+
}
|
|
4080
|
+
|
|
4081
|
+
return this.apiClient.callApi(
|
|
4082
|
+
'/api/v2/analytics/transcripts/aggregates/jobs/{jobId}',
|
|
4083
|
+
'DELETE',
|
|
4084
|
+
{ 'jobId': jobId },
|
|
4085
|
+
{ },
|
|
4086
|
+
{ },
|
|
4087
|
+
{ },
|
|
4088
|
+
null,
|
|
4089
|
+
['PureCloud OAuth'],
|
|
4090
|
+
['application/json'],
|
|
4091
|
+
['application/json']
|
|
4092
|
+
);
|
|
4093
|
+
}
|
|
4094
|
+
|
|
4095
|
+
/**
|
|
4096
|
+
* Delete/cancel an async request for user aggregates
|
|
4097
|
+
*
|
|
4098
|
+
* @param {String} jobId jobId
|
|
4099
|
+
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4100
|
+
*/
|
|
4101
|
+
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
4102
|
+
// verify the required parameter 'jobId' is set
|
|
4103
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4104
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
4105
|
+
}
|
|
4106
|
+
|
|
4107
|
+
return this.apiClient.callApi(
|
|
4108
|
+
'/api/v2/analytics/users/aggregates/jobs/{jobId}',
|
|
4109
|
+
'DELETE',
|
|
4110
|
+
{ 'jobId': jobId },
|
|
4111
|
+
{ },
|
|
4112
|
+
{ },
|
|
4113
|
+
{ },
|
|
4114
|
+
null,
|
|
4115
|
+
['PureCloud OAuth'],
|
|
4116
|
+
['application/json'],
|
|
4117
|
+
['application/json']
|
|
4118
|
+
);
|
|
4119
|
+
}
|
|
4120
|
+
|
|
3700
4121
|
/**
|
|
3701
4122
|
* Delete/cancel an async request
|
|
3702
4123
|
*
|
|
@@ -5491,31 +5912,6 @@ class AnalyticsApi {
|
|
|
5491
5912
|
);
|
|
5492
5913
|
}
|
|
5493
5914
|
|
|
5494
|
-
/**
|
|
5495
|
-
* Search resources.
|
|
5496
|
-
*
|
|
5497
|
-
* @param {Object} body Search request options
|
|
5498
|
-
*/
|
|
5499
|
-
postAnalyticsConversationsTranscriptsQuery(body) {
|
|
5500
|
-
// verify the required parameter 'body' is set
|
|
5501
|
-
if (body === undefined || body === null) {
|
|
5502
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';
|
|
5503
|
-
}
|
|
5504
|
-
|
|
5505
|
-
return this.apiClient.callApi(
|
|
5506
|
-
'/api/v2/analytics/conversations/transcripts/query',
|
|
5507
|
-
'POST',
|
|
5508
|
-
{ },
|
|
5509
|
-
{ },
|
|
5510
|
-
{ },
|
|
5511
|
-
{ },
|
|
5512
|
-
body,
|
|
5513
|
-
['PureCloud OAuth'],
|
|
5514
|
-
['application/json'],
|
|
5515
|
-
['application/json']
|
|
5516
|
-
);
|
|
5517
|
-
}
|
|
5518
|
-
|
|
5519
5915
|
/**
|
|
5520
5916
|
* Query for evaluation aggregates asynchronously
|
|
5521
5917
|
*
|
|
@@ -6478,7 +6874,7 @@ class ArchitectApi {
|
|
|
6478
6874
|
/**
|
|
6479
6875
|
* Architect service.
|
|
6480
6876
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6481
|
-
* @version
|
|
6877
|
+
* @version 228.0.0
|
|
6482
6878
|
*/
|
|
6483
6879
|
|
|
6484
6880
|
/**
|
|
@@ -10773,7 +11169,7 @@ class AuditApi {
|
|
|
10773
11169
|
/**
|
|
10774
11170
|
* Audit service.
|
|
10775
11171
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10776
|
-
* @version
|
|
11172
|
+
* @version 228.0.0
|
|
10777
11173
|
*/
|
|
10778
11174
|
|
|
10779
11175
|
/**
|
|
@@ -10974,7 +11370,7 @@ class AuthorizationApi {
|
|
|
10974
11370
|
/**
|
|
10975
11371
|
* Authorization service.
|
|
10976
11372
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10977
|
-
* @version
|
|
11373
|
+
* @version 228.0.0
|
|
10978
11374
|
*/
|
|
10979
11375
|
|
|
10980
11376
|
/**
|
|
@@ -12689,7 +13085,7 @@ class BillingApi {
|
|
|
12689
13085
|
/**
|
|
12690
13086
|
* Billing service.
|
|
12691
13087
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12692
|
-
* @version
|
|
13088
|
+
* @version 228.0.0
|
|
12693
13089
|
*/
|
|
12694
13090
|
|
|
12695
13091
|
/**
|
|
@@ -12945,7 +13341,7 @@ class BusinessRulesApi {
|
|
|
12945
13341
|
/**
|
|
12946
13342
|
* BusinessRules service.
|
|
12947
13343
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12948
|
-
* @version
|
|
13344
|
+
* @version 228.0.0
|
|
12949
13345
|
*/
|
|
12950
13346
|
|
|
12951
13347
|
/**
|
|
@@ -13219,7 +13615,6 @@ class BusinessRulesApi {
|
|
|
13219
13615
|
* @param {Object} opts Optional parameters
|
|
13220
13616
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13221
13617
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
13222
|
-
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
13223
13618
|
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13224
13619
|
*/
|
|
13225
13620
|
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
@@ -13234,7 +13629,7 @@ class BusinessRulesApi {
|
|
|
13234
13629
|
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
13235
13630
|
'GET',
|
|
13236
13631
|
{ 'tableId': tableId },
|
|
13237
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize']
|
|
13632
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
13238
13633
|
{ },
|
|
13239
13634
|
{ },
|
|
13240
13635
|
null,
|
|
@@ -13251,6 +13646,7 @@ class BusinessRulesApi {
|
|
|
13251
13646
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13252
13647
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
13253
13648
|
* @param {Array.<String>} opts.divisionIds One or more comma separated divisions to filters decision tables by. If nothing is provided, the decision tables associated with the list of divisions that the user has access to will be returned.
|
|
13649
|
+
* @param {String} opts.name Search for decision tables with a name that contains the given search string. Search is case insensitive and will match any table that contains this string in any part of the name.
|
|
13254
13650
|
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13255
13651
|
*/
|
|
13256
13652
|
getBusinessrulesDecisiontables(opts) {
|
|
@@ -13261,7 +13657,7 @@ class BusinessRulesApi {
|
|
|
13261
13657
|
'/api/v2/businessrules/decisiontables',
|
|
13262
13658
|
'GET',
|
|
13263
13659
|
{ },
|
|
13264
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
13660
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'name': opts['name'] },
|
|
13265
13661
|
{ },
|
|
13266
13662
|
{ },
|
|
13267
13663
|
null,
|
|
@@ -13463,48 +13859,6 @@ class BusinessRulesApi {
|
|
|
13463
13859
|
);
|
|
13464
13860
|
}
|
|
13465
13861
|
|
|
13466
|
-
/**
|
|
13467
|
-
* Partially update a decision table row. Will be deprecated, we should use PUT request.
|
|
13468
|
-
*
|
|
13469
|
-
* @param {String} tableId Table ID
|
|
13470
|
-
* @param {Number} tableVersion Table Version
|
|
13471
|
-
* @param {String} rowId Row ID
|
|
13472
|
-
* @param {Object} body Partially update decision table row request
|
|
13473
|
-
* @deprecated
|
|
13474
|
-
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13475
|
-
*/
|
|
13476
|
-
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
13477
|
-
// verify the required parameter 'tableId' is set
|
|
13478
|
-
if (tableId === undefined || tableId === null || tableId === '') {
|
|
13479
|
-
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13480
|
-
}
|
|
13481
|
-
// verify the required parameter 'tableVersion' is set
|
|
13482
|
-
if (tableVersion === undefined || tableVersion === null) {
|
|
13483
|
-
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13484
|
-
}
|
|
13485
|
-
// verify the required parameter 'rowId' is set
|
|
13486
|
-
if (rowId === undefined || rowId === null || rowId === '') {
|
|
13487
|
-
throw 'Missing the required parameter "rowId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13488
|
-
}
|
|
13489
|
-
// verify the required parameter 'body' is set
|
|
13490
|
-
if (body === undefined || body === null) {
|
|
13491
|
-
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13492
|
-
}
|
|
13493
|
-
|
|
13494
|
-
return this.apiClient.callApi(
|
|
13495
|
-
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
13496
|
-
'PATCH',
|
|
13497
|
-
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
13498
|
-
{ },
|
|
13499
|
-
{ },
|
|
13500
|
-
{ },
|
|
13501
|
-
body,
|
|
13502
|
-
['PureCloud OAuth'],
|
|
13503
|
-
['application/json'],
|
|
13504
|
-
['application/json']
|
|
13505
|
-
);
|
|
13506
|
-
}
|
|
13507
|
-
|
|
13508
13862
|
/**
|
|
13509
13863
|
* Execute a published decision table
|
|
13510
13864
|
*
|
|
@@ -13903,7 +14257,7 @@ class CarrierServicesApi {
|
|
|
13903
14257
|
/**
|
|
13904
14258
|
* CarrierServices service.
|
|
13905
14259
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
13906
|
-
* @version
|
|
14260
|
+
* @version 228.0.0
|
|
13907
14261
|
*/
|
|
13908
14262
|
|
|
13909
14263
|
/**
|
|
@@ -13973,7 +14327,7 @@ class ChatApi {
|
|
|
13973
14327
|
/**
|
|
13974
14328
|
* Chat service.
|
|
13975
14329
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
13976
|
-
* @version
|
|
14330
|
+
* @version 228.0.0
|
|
13977
14331
|
*/
|
|
13978
14332
|
|
|
13979
14333
|
/**
|
|
@@ -14246,6 +14600,7 @@ class ChatApi {
|
|
|
14246
14600
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
14247
14601
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
14248
14602
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
14603
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
14249
14604
|
*/
|
|
14250
14605
|
getChatsRoomMessages(roomJid, opts) {
|
|
14251
14606
|
opts = opts || {};
|
|
@@ -14259,7 +14614,7 @@ class ChatApi {
|
|
|
14259
14614
|
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
14260
14615
|
'GET',
|
|
14261
14616
|
{ 'roomJid': roomJid },
|
|
14262
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
14617
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
14263
14618
|
{ },
|
|
14264
14619
|
{ },
|
|
14265
14620
|
null,
|
|
@@ -14356,6 +14711,7 @@ class ChatApi {
|
|
|
14356
14711
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
14357
14712
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
14358
14713
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
14714
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
14359
14715
|
*/
|
|
14360
14716
|
getChatsThreadMessages(threadId, opts) {
|
|
14361
14717
|
opts = opts || {};
|
|
@@ -14369,7 +14725,7 @@ class ChatApi {
|
|
|
14369
14725
|
'/api/v2/chats/threads/{threadId}/messages',
|
|
14370
14726
|
'GET',
|
|
14371
14727
|
{ 'threadId': threadId },
|
|
14372
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
14728
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
14373
14729
|
{ },
|
|
14374
14730
|
{ },
|
|
14375
14731
|
null,
|
|
@@ -14442,6 +14798,7 @@ class ChatApi {
|
|
|
14442
14798
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
14443
14799
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
14444
14800
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
14801
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
14445
14802
|
*/
|
|
14446
14803
|
getChatsUserMessages(userId, opts) {
|
|
14447
14804
|
opts = opts || {};
|
|
@@ -14455,7 +14812,7 @@ class ChatApi {
|
|
|
14455
14812
|
'/api/v2/chats/users/{userId}/messages',
|
|
14456
14813
|
'GET',
|
|
14457
14814
|
{ 'userId': userId },
|
|
14458
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
14815
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
14459
14816
|
{ },
|
|
14460
14817
|
{ },
|
|
14461
14818
|
null,
|
|
@@ -14951,7 +15308,7 @@ class CoachingApi {
|
|
|
14951
15308
|
/**
|
|
14952
15309
|
* Coaching service.
|
|
14953
15310
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
14954
|
-
* @version
|
|
15311
|
+
* @version 228.0.0
|
|
14955
15312
|
*/
|
|
14956
15313
|
|
|
14957
15314
|
/**
|
|
@@ -15528,7 +15885,7 @@ class ContentManagementApi {
|
|
|
15528
15885
|
/**
|
|
15529
15886
|
* ContentManagement service.
|
|
15530
15887
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15531
|
-
* @version
|
|
15888
|
+
* @version 228.0.0
|
|
15532
15889
|
*/
|
|
15533
15890
|
|
|
15534
15891
|
/**
|
|
@@ -16609,7 +16966,7 @@ class ConversationsApi {
|
|
|
16609
16966
|
/**
|
|
16610
16967
|
* Conversations service.
|
|
16611
16968
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16612
|
-
* @version
|
|
16969
|
+
* @version 228.0.0
|
|
16613
16970
|
*/
|
|
16614
16971
|
|
|
16615
16972
|
/**
|
|
@@ -16624,6 +16981,32 @@ class ConversationsApi {
|
|
|
16624
16981
|
}
|
|
16625
16982
|
|
|
16626
16983
|
|
|
16984
|
+
/**
|
|
16985
|
+
* Delete/cancel an async request for conversation aggregates
|
|
16986
|
+
*
|
|
16987
|
+
* @param {String} jobId jobId
|
|
16988
|
+
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16989
|
+
*/
|
|
16990
|
+
deleteAnalyticsConversationsAggregatesJob(jobId) {
|
|
16991
|
+
// verify the required parameter 'jobId' is set
|
|
16992
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
16993
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';
|
|
16994
|
+
}
|
|
16995
|
+
|
|
16996
|
+
return this.apiClient.callApi(
|
|
16997
|
+
'/api/v2/analytics/conversations/aggregates/jobs/{jobId}',
|
|
16998
|
+
'DELETE',
|
|
16999
|
+
{ 'jobId': jobId },
|
|
17000
|
+
{ },
|
|
17001
|
+
{ },
|
|
17002
|
+
{ },
|
|
17003
|
+
null,
|
|
17004
|
+
['PureCloud OAuth'],
|
|
17005
|
+
['application/json'],
|
|
17006
|
+
['application/json']
|
|
17007
|
+
);
|
|
17008
|
+
}
|
|
17009
|
+
|
|
16627
17010
|
/**
|
|
16628
17011
|
* Delete/cancel an async details job
|
|
16629
17012
|
*
|
|
@@ -17882,7 +18265,7 @@ class ConversationsApi {
|
|
|
17882
18265
|
|
|
17883
18266
|
/**
|
|
17884
18267
|
* Get chat conversation
|
|
17885
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18268
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17886
18269
|
* @param {String} conversationId conversationId
|
|
17887
18270
|
* @deprecated
|
|
17888
18271
|
*/
|
|
@@ -17908,7 +18291,7 @@ class ConversationsApi {
|
|
|
17908
18291
|
|
|
17909
18292
|
/**
|
|
17910
18293
|
* Get a web chat conversation message
|
|
17911
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18294
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
17912
18295
|
* @param {String} conversationId conversationId
|
|
17913
18296
|
* @param {String} messageId messageId
|
|
17914
18297
|
* @deprecated
|
|
@@ -17939,7 +18322,7 @@ class ConversationsApi {
|
|
|
17939
18322
|
|
|
17940
18323
|
/**
|
|
17941
18324
|
* Get the messages of a chat conversation.
|
|
17942
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18325
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. The current user must be involved with the conversation to get its messages.
|
|
17943
18326
|
* @param {String} conversationId conversationId
|
|
17944
18327
|
* @param {Object} opts Optional parameters
|
|
17945
18328
|
* @param {String} opts.after If specified, get the messages chronologically after the id of this message
|
|
@@ -17972,7 +18355,7 @@ class ConversationsApi {
|
|
|
17972
18355
|
|
|
17973
18356
|
/**
|
|
17974
18357
|
* Get the wrap-up for this conversation communication.
|
|
17975
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18358
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17976
18359
|
* @param {String} conversationId conversationId
|
|
17977
18360
|
* @param {String} participantId participantId
|
|
17978
18361
|
* @param {String} communicationId communicationId
|
|
@@ -18012,7 +18395,7 @@ class ConversationsApi {
|
|
|
18012
18395
|
|
|
18013
18396
|
/**
|
|
18014
18397
|
* Get the wrap-up for this conversation participant.
|
|
18015
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18398
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
18016
18399
|
* @param {String} conversationId conversationId
|
|
18017
18400
|
* @param {String} participantId participantId
|
|
18018
18401
|
* @param {Object} opts Optional parameters
|
|
@@ -18047,7 +18430,7 @@ class ConversationsApi {
|
|
|
18047
18430
|
|
|
18048
18431
|
/**
|
|
18049
18432
|
* Get list of wrapup codes for this conversation participant
|
|
18050
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18433
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
18051
18434
|
* @param {String} conversationId conversationId
|
|
18052
18435
|
* @param {String} participantId participantId
|
|
18053
18436
|
* @deprecated
|
|
@@ -18078,7 +18461,7 @@ class ConversationsApi {
|
|
|
18078
18461
|
|
|
18079
18462
|
/**
|
|
18080
18463
|
* Get active chat conversations for the logged in user
|
|
18081
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18464
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
18082
18465
|
* @deprecated
|
|
18083
18466
|
*/
|
|
18084
18467
|
getConversationsChats() {
|
|
@@ -18124,7 +18507,7 @@ class ConversationsApi {
|
|
|
18124
18507
|
|
|
18125
18508
|
/**
|
|
18126
18509
|
* Get the wrap-up for this conversation communication.
|
|
18127
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18510
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18128
18511
|
* @param {String} conversationId conversationId
|
|
18129
18512
|
* @param {String} participantId participantId
|
|
18130
18513
|
* @param {String} communicationId communicationId
|
|
@@ -18164,7 +18547,7 @@ class ConversationsApi {
|
|
|
18164
18547
|
|
|
18165
18548
|
/**
|
|
18166
18549
|
* Get the wrap-up for this conversation participant.
|
|
18167
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18550
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18168
18551
|
* @param {String} conversationId conversationId
|
|
18169
18552
|
* @param {String} participantId participantId
|
|
18170
18553
|
* @param {Object} opts Optional parameters
|
|
@@ -18199,7 +18582,7 @@ class ConversationsApi {
|
|
|
18199
18582
|
|
|
18200
18583
|
/**
|
|
18201
18584
|
* Get list of wrapup codes for this conversation participant
|
|
18202
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18585
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18203
18586
|
* @param {String} conversationId conversationId
|
|
18204
18587
|
* @param {String} participantId participantId
|
|
18205
18588
|
* @deprecated
|
|
@@ -19601,7 +19984,7 @@ class ConversationsApi {
|
|
|
19601
19984
|
|
|
19602
19985
|
/**
|
|
19603
19986
|
* Get the wrap-up for this conversation communication.
|
|
19604
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
19987
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
19605
19988
|
* @param {String} conversationId conversationId
|
|
19606
19989
|
* @param {String} participantId participantId
|
|
19607
19990
|
* @param {String} communicationId communicationId
|
|
@@ -20128,7 +20511,7 @@ class ConversationsApi {
|
|
|
20128
20511
|
}
|
|
20129
20512
|
|
|
20130
20513
|
/**
|
|
20131
|
-
* Update conversation participant's communication by disconnecting it.
|
|
20514
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20132
20515
|
*
|
|
20133
20516
|
* @param {String} conversationId conversationId
|
|
20134
20517
|
* @param {String} participantId participantId
|
|
@@ -20369,7 +20752,7 @@ class ConversationsApi {
|
|
|
20369
20752
|
|
|
20370
20753
|
/**
|
|
20371
20754
|
* Update a conversation by disconnecting all of the participants
|
|
20372
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20755
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20373
20756
|
* @param {String} conversationId conversationId
|
|
20374
20757
|
* @param {Object} body Conversation
|
|
20375
20758
|
* @deprecated
|
|
@@ -20400,7 +20783,7 @@ class ConversationsApi {
|
|
|
20400
20783
|
|
|
20401
20784
|
/**
|
|
20402
20785
|
* Update conversation participant
|
|
20403
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20786
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20404
20787
|
* @param {String} conversationId conversationId
|
|
20405
20788
|
* @param {String} participantId participantId
|
|
20406
20789
|
* @param {Object} body Update request
|
|
@@ -20436,7 +20819,7 @@ class ConversationsApi {
|
|
|
20436
20819
|
|
|
20437
20820
|
/**
|
|
20438
20821
|
* Update the attributes on a conversation participant.
|
|
20439
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20822
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20440
20823
|
* @param {String} conversationId conversationId
|
|
20441
20824
|
* @param {String} participantId participantId
|
|
20442
20825
|
* @param {Object} body Participant attributes
|
|
@@ -20471,8 +20854,8 @@ class ConversationsApi {
|
|
|
20471
20854
|
}
|
|
20472
20855
|
|
|
20473
20856
|
/**
|
|
20474
|
-
* Update conversation participant's communication by disconnecting it.
|
|
20475
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20857
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20858
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20476
20859
|
* @param {String} conversationId conversationId
|
|
20477
20860
|
* @param {String} participantId participantId
|
|
20478
20861
|
* @param {String} communicationId communicationId
|
|
@@ -20513,7 +20896,7 @@ class ConversationsApi {
|
|
|
20513
20896
|
|
|
20514
20897
|
/**
|
|
20515
20898
|
* Update a conversation by disconnecting all of the participants
|
|
20516
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20899
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20517
20900
|
* @param {String} conversationId conversationId
|
|
20518
20901
|
* @param {Object} body Conversation
|
|
20519
20902
|
* @deprecated
|
|
@@ -20544,7 +20927,7 @@ class ConversationsApi {
|
|
|
20544
20927
|
|
|
20545
20928
|
/**
|
|
20546
20929
|
* Update conversation participant
|
|
20547
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20930
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20548
20931
|
* @param {String} conversationId conversationId
|
|
20549
20932
|
* @param {String} participantId participantId
|
|
20550
20933
|
* @param {Object} opts Optional parameters
|
|
@@ -20579,7 +20962,7 @@ class ConversationsApi {
|
|
|
20579
20962
|
|
|
20580
20963
|
/**
|
|
20581
20964
|
* Update the attributes on a conversation participant.
|
|
20582
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20965
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20583
20966
|
* @param {String} conversationId conversationId
|
|
20584
20967
|
* @param {String} participantId participantId
|
|
20585
20968
|
* @param {Object} opts Optional parameters
|
|
@@ -20614,7 +20997,7 @@ class ConversationsApi {
|
|
|
20614
20997
|
|
|
20615
20998
|
/**
|
|
20616
20999
|
* Update conversation participant's communication by disconnecting it.
|
|
20617
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
21000
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20618
21001
|
* @param {String} conversationId conversationId
|
|
20619
21002
|
* @param {String} participantId participantId
|
|
20620
21003
|
* @param {String} communicationId communicationId
|
|
@@ -20785,7 +21168,7 @@ class ConversationsApi {
|
|
|
20785
21168
|
}
|
|
20786
21169
|
|
|
20787
21170
|
/**
|
|
20788
|
-
* Update conversation participant's communication by disconnecting it.
|
|
21171
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20789
21172
|
*
|
|
20790
21173
|
* @param {String} conversationId conversationId
|
|
20791
21174
|
* @param {String} participantId participantId
|
|
@@ -20958,7 +21341,7 @@ class ConversationsApi {
|
|
|
20958
21341
|
}
|
|
20959
21342
|
|
|
20960
21343
|
/**
|
|
20961
|
-
* Update conversation participant's communication by disconnecting it.
|
|
21344
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20962
21345
|
*
|
|
20963
21346
|
* @param {String} conversationId conversationId
|
|
20964
21347
|
* @param {String} participantId participantId
|
|
@@ -22626,7 +23009,7 @@ class ConversationsApi {
|
|
|
22626
23009
|
|
|
22627
23010
|
/**
|
|
22628
23011
|
* Send a message on behalf of a communication in a chat conversation.
|
|
22629
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23012
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22630
23013
|
* @param {String} conversationId conversationId
|
|
22631
23014
|
* @param {String} communicationId communicationId
|
|
22632
23015
|
* @param {Object} body Message
|
|
@@ -22662,7 +23045,7 @@ class ConversationsApi {
|
|
|
22662
23045
|
|
|
22663
23046
|
/**
|
|
22664
23047
|
* Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
22665
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23048
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22666
23049
|
* @param {String} conversationId conversationId
|
|
22667
23050
|
* @param {String} communicationId communicationId
|
|
22668
23051
|
* @deprecated
|
|
@@ -22693,7 +23076,7 @@ class ConversationsApi {
|
|
|
22693
23076
|
|
|
22694
23077
|
/**
|
|
22695
23078
|
* Apply wrap-up for this conversation communication
|
|
22696
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23079
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22697
23080
|
* @param {String} conversationId conversationId
|
|
22698
23081
|
* @param {String} participantId participantId
|
|
22699
23082
|
* @param {String} communicationId communicationId
|
|
@@ -22733,7 +23116,7 @@ class ConversationsApi {
|
|
|
22733
23116
|
|
|
22734
23117
|
/**
|
|
22735
23118
|
* Replace this participant with the specified user and/or address
|
|
22736
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23119
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22737
23120
|
* @param {String} conversationId conversationId
|
|
22738
23121
|
* @param {String} participantId participantId
|
|
22739
23122
|
* @param {Object} body Transfer request
|
|
@@ -22769,7 +23152,7 @@ class ConversationsApi {
|
|
|
22769
23152
|
|
|
22770
23153
|
/**
|
|
22771
23154
|
* Create a web chat conversation
|
|
22772
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23155
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22773
23156
|
* @param {Object} body Create web chat request
|
|
22774
23157
|
* @deprecated
|
|
22775
23158
|
*/
|
|
@@ -22795,7 +23178,7 @@ class ConversationsApi {
|
|
|
22795
23178
|
|
|
22796
23179
|
/**
|
|
22797
23180
|
* Apply wrap-up for this conversation communication
|
|
22798
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23181
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
22799
23182
|
* @param {String} conversationId conversationId
|
|
22800
23183
|
* @param {String} participantId participantId
|
|
22801
23184
|
* @param {String} communicationId communicationId
|
|
@@ -22835,7 +23218,7 @@ class ConversationsApi {
|
|
|
22835
23218
|
|
|
22836
23219
|
/**
|
|
22837
23220
|
* Replace this participant with the specified user and/or address
|
|
22838
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23221
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
22839
23222
|
* @param {String} conversationId conversationId
|
|
22840
23223
|
* @param {String} participantId participantId
|
|
22841
23224
|
* @param {Object} opts Optional parameters
|
|
@@ -23923,7 +24306,7 @@ class ConversationsApi {
|
|
|
23923
24306
|
|
|
23924
24307
|
/**
|
|
23925
24308
|
* Apply wrap-up for this conversation communication
|
|
23926
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
24309
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
23927
24310
|
* @param {String} conversationId conversationId
|
|
23928
24311
|
* @param {String} participantId participantId
|
|
23929
24312
|
* @param {String} communicationId communicationId
|
|
@@ -24288,7 +24671,7 @@ class ConversationsApi {
|
|
|
24288
24671
|
|
|
24289
24672
|
/**
|
|
24290
24673
|
* Update a conversation by setting its recording state
|
|
24291
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
24674
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
24292
24675
|
* @param {String} conversationId conversationId
|
|
24293
24676
|
* @param {Object} body SetRecordingState
|
|
24294
24677
|
* @deprecated
|
|
@@ -24319,7 +24702,7 @@ class ConversationsApi {
|
|
|
24319
24702
|
|
|
24320
24703
|
/**
|
|
24321
24704
|
* Update a conversation by setting its recording state
|
|
24322
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
24705
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
24323
24706
|
* @param {String} conversationId conversationId
|
|
24324
24707
|
* @param {Object} body SetRecordingState
|
|
24325
24708
|
* @deprecated
|
|
@@ -24726,7 +25109,7 @@ class ConversationsApi {
|
|
|
24726
25109
|
|
|
24727
25110
|
/**
|
|
24728
25111
|
* Update a conversation by setting its recording state
|
|
24729
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
25112
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
24730
25113
|
* @param {String} conversationId conversationId
|
|
24731
25114
|
* @param {Object} body SetRecordingState
|
|
24732
25115
|
* @deprecated
|
|
@@ -24821,7 +25204,7 @@ class DataExtensionsApi {
|
|
|
24821
25204
|
/**
|
|
24822
25205
|
* DataExtensions service.
|
|
24823
25206
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
24824
|
-
* @version
|
|
25207
|
+
* @version 228.0.0
|
|
24825
25208
|
*/
|
|
24826
25209
|
|
|
24827
25210
|
/**
|
|
@@ -24907,7 +25290,7 @@ class DataPrivacyApi {
|
|
|
24907
25290
|
/**
|
|
24908
25291
|
* DataPrivacy service.
|
|
24909
25292
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
24910
|
-
* @version
|
|
25293
|
+
* @version 228.0.0
|
|
24911
25294
|
*/
|
|
24912
25295
|
|
|
24913
25296
|
/**
|
|
@@ -25077,7 +25460,7 @@ class DownloadsApi {
|
|
|
25077
25460
|
/**
|
|
25078
25461
|
* Downloads service.
|
|
25079
25462
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25080
|
-
* @version
|
|
25463
|
+
* @version 228.0.0
|
|
25081
25464
|
*/
|
|
25082
25465
|
|
|
25083
25466
|
/**
|
|
@@ -25129,7 +25512,7 @@ class EmailsApi {
|
|
|
25129
25512
|
/**
|
|
25130
25513
|
* Emails service.
|
|
25131
25514
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
25132
|
-
* @version
|
|
25515
|
+
* @version 228.0.0
|
|
25133
25516
|
*/
|
|
25134
25517
|
|
|
25135
25518
|
/**
|
|
@@ -25258,7 +25641,7 @@ class EmployeeEngagementApi {
|
|
|
25258
25641
|
/**
|
|
25259
25642
|
* EmployeeEngagement service.
|
|
25260
25643
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
25261
|
-
* @version
|
|
25644
|
+
* @version 228.0.0
|
|
25262
25645
|
*/
|
|
25263
25646
|
|
|
25264
25647
|
/**
|
|
@@ -25409,7 +25792,7 @@ class EventsApi {
|
|
|
25409
25792
|
/**
|
|
25410
25793
|
* Events service.
|
|
25411
25794
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
25412
|
-
* @version
|
|
25795
|
+
* @version 228.0.0
|
|
25413
25796
|
*/
|
|
25414
25797
|
|
|
25415
25798
|
/**
|
|
@@ -25505,7 +25888,7 @@ class ExternalContactsApi {
|
|
|
25505
25888
|
/**
|
|
25506
25889
|
* ExternalContacts service.
|
|
25507
25890
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
25508
|
-
* @version
|
|
25891
|
+
* @version 228.0.0
|
|
25509
25892
|
*/
|
|
25510
25893
|
|
|
25511
25894
|
/**
|
|
@@ -25834,6 +26217,36 @@ class ExternalContactsApi {
|
|
|
25834
26217
|
);
|
|
25835
26218
|
}
|
|
25836
26219
|
|
|
26220
|
+
/**
|
|
26221
|
+
* Retrieve segment assignments by external contact ID.
|
|
26222
|
+
*
|
|
26223
|
+
* @param {String} contactId ExternalContact ID
|
|
26224
|
+
* @param {Object} opts Optional parameters
|
|
26225
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
|
|
26226
|
+
* @param {Number} opts.limit Number of entities to return. Default of 25, maximum of 500.
|
|
26227
|
+
*/
|
|
26228
|
+
getExternalcontactsContactJourneySegments(contactId, opts) {
|
|
26229
|
+
opts = opts || {};
|
|
26230
|
+
|
|
26231
|
+
// verify the required parameter 'contactId' is set
|
|
26232
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
26233
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySegments';
|
|
26234
|
+
}
|
|
26235
|
+
|
|
26236
|
+
return this.apiClient.callApi(
|
|
26237
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
26238
|
+
'GET',
|
|
26239
|
+
{ 'contactId': contactId },
|
|
26240
|
+
{ 'includeMerged': opts['includeMerged'],'limit': opts['limit'] },
|
|
26241
|
+
{ },
|
|
26242
|
+
{ },
|
|
26243
|
+
null,
|
|
26244
|
+
['PureCloud OAuth'],
|
|
26245
|
+
['application/json'],
|
|
26246
|
+
['application/json']
|
|
26247
|
+
);
|
|
26248
|
+
}
|
|
26249
|
+
|
|
25837
26250
|
/**
|
|
25838
26251
|
* Retrieve all sessions for a given external contact.
|
|
25839
26252
|
*
|
|
@@ -27705,6 +28118,35 @@ class ExternalContactsApi {
|
|
|
27705
28118
|
);
|
|
27706
28119
|
}
|
|
27707
28120
|
|
|
28121
|
+
/**
|
|
28122
|
+
* Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
|
|
28123
|
+
*
|
|
28124
|
+
* @param {String} contactId ExternalContact ID
|
|
28125
|
+
* @param {Object} opts Optional parameters
|
|
28126
|
+
* @param {Object} opts.body
|
|
28127
|
+
*/
|
|
28128
|
+
postExternalcontactsContactJourneySegments(contactId, opts) {
|
|
28129
|
+
opts = opts || {};
|
|
28130
|
+
|
|
28131
|
+
// verify the required parameter 'contactId' is set
|
|
28132
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
28133
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactJourneySegments';
|
|
28134
|
+
}
|
|
28135
|
+
|
|
28136
|
+
return this.apiClient.callApi(
|
|
28137
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
28138
|
+
'POST',
|
|
28139
|
+
{ 'contactId': contactId },
|
|
28140
|
+
{ },
|
|
28141
|
+
{ },
|
|
28142
|
+
{ },
|
|
28143
|
+
opts['body'],
|
|
28144
|
+
['PureCloud OAuth'],
|
|
28145
|
+
['application/json'],
|
|
28146
|
+
['application/json']
|
|
28147
|
+
);
|
|
28148
|
+
}
|
|
28149
|
+
|
|
27708
28150
|
/**
|
|
27709
28151
|
* Create a note for an external contact
|
|
27710
28152
|
*
|
|
@@ -28693,7 +29135,7 @@ class FaxApi {
|
|
|
28693
29135
|
/**
|
|
28694
29136
|
* Fax service.
|
|
28695
29137
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
28696
|
-
* @version
|
|
29138
|
+
* @version 228.0.0
|
|
28697
29139
|
*/
|
|
28698
29140
|
|
|
28699
29141
|
/**
|
|
@@ -28908,7 +29350,7 @@ class FlowsApi {
|
|
|
28908
29350
|
/**
|
|
28909
29351
|
* Flows service.
|
|
28910
29352
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
28911
|
-
* @version
|
|
29353
|
+
* @version 228.0.0
|
|
28912
29354
|
*/
|
|
28913
29355
|
|
|
28914
29356
|
/**
|
|
@@ -28923,6 +29365,32 @@ class FlowsApi {
|
|
|
28923
29365
|
}
|
|
28924
29366
|
|
|
28925
29367
|
|
|
29368
|
+
/**
|
|
29369
|
+
* Delete/cancel an async request for flow aggregates
|
|
29370
|
+
*
|
|
29371
|
+
* @param {String} jobId jobId
|
|
29372
|
+
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29373
|
+
*/
|
|
29374
|
+
deleteAnalyticsFlowsAggregatesJob(jobId) {
|
|
29375
|
+
// verify the required parameter 'jobId' is set
|
|
29376
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
29377
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';
|
|
29378
|
+
}
|
|
29379
|
+
|
|
29380
|
+
return this.apiClient.callApi(
|
|
29381
|
+
'/api/v2/analytics/flows/aggregates/jobs/{jobId}',
|
|
29382
|
+
'DELETE',
|
|
29383
|
+
{ 'jobId': jobId },
|
|
29384
|
+
{ },
|
|
29385
|
+
{ },
|
|
29386
|
+
{ },
|
|
29387
|
+
null,
|
|
29388
|
+
['PureCloud OAuth'],
|
|
29389
|
+
['application/json'],
|
|
29390
|
+
['application/json']
|
|
29391
|
+
);
|
|
29392
|
+
}
|
|
29393
|
+
|
|
28926
29394
|
/**
|
|
28927
29395
|
* Get status for async query for Flow aggregates
|
|
28928
29396
|
*
|
|
@@ -29091,7 +29559,7 @@ class GamificationApi {
|
|
|
29091
29559
|
/**
|
|
29092
29560
|
* Gamification service.
|
|
29093
29561
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29094
|
-
* @version
|
|
29562
|
+
* @version 228.0.0
|
|
29095
29563
|
*/
|
|
29096
29564
|
|
|
29097
29565
|
/**
|
|
@@ -31598,7 +32066,7 @@ class GeneralDataProtectionRegulationApi {
|
|
|
31598
32066
|
/**
|
|
31599
32067
|
* GeneralDataProtectionRegulation service.
|
|
31600
32068
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
31601
|
-
* @version
|
|
32069
|
+
* @version 228.0.0
|
|
31602
32070
|
*/
|
|
31603
32071
|
|
|
31604
32072
|
/**
|
|
@@ -31728,7 +32196,7 @@ class GeolocationApi {
|
|
|
31728
32196
|
/**
|
|
31729
32197
|
* Geolocation service.
|
|
31730
32198
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
31731
|
-
* @version
|
|
32199
|
+
* @version 228.0.0
|
|
31732
32200
|
*/
|
|
31733
32201
|
|
|
31734
32202
|
/**
|
|
@@ -31859,7 +32327,7 @@ class GreetingsApi {
|
|
|
31859
32327
|
/**
|
|
31860
32328
|
* Greetings service.
|
|
31861
32329
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
31862
|
-
* @version
|
|
32330
|
+
* @version 228.0.0
|
|
31863
32331
|
*/
|
|
31864
32332
|
|
|
31865
32333
|
/**
|
|
@@ -32401,7 +32869,7 @@ class GroupsApi {
|
|
|
32401
32869
|
/**
|
|
32402
32870
|
* Groups service.
|
|
32403
32871
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
32404
|
-
* @version
|
|
32872
|
+
* @version 228.0.0
|
|
32405
32873
|
*/
|
|
32406
32874
|
|
|
32407
32875
|
/**
|
|
@@ -32920,7 +33388,7 @@ class IdentityProviderApi {
|
|
|
32920
33388
|
/**
|
|
32921
33389
|
* IdentityProvider service.
|
|
32922
33390
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
32923
|
-
* @version
|
|
33391
|
+
* @version 228.0.0
|
|
32924
33392
|
*/
|
|
32925
33393
|
|
|
32926
33394
|
/**
|
|
@@ -33781,7 +34249,7 @@ class InfrastructureAsCodeApi {
|
|
|
33781
34249
|
/**
|
|
33782
34250
|
* InfrastructureAsCode service.
|
|
33783
34251
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
33784
|
-
* @version
|
|
34252
|
+
* @version 228.0.0
|
|
33785
34253
|
*/
|
|
33786
34254
|
|
|
33787
34255
|
/**
|
|
@@ -33948,7 +34416,7 @@ class IntegrationsApi {
|
|
|
33948
34416
|
/**
|
|
33949
34417
|
* Integrations service.
|
|
33950
34418
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
33951
|
-
* @version
|
|
34419
|
+
* @version 228.0.0
|
|
33952
34420
|
*/
|
|
33953
34421
|
|
|
33954
34422
|
/**
|
|
@@ -36593,7 +37061,7 @@ class JourneyApi {
|
|
|
36593
37061
|
/**
|
|
36594
37062
|
* Journey service.
|
|
36595
37063
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
36596
|
-
* @version
|
|
37064
|
+
* @version 228.0.0
|
|
36597
37065
|
*/
|
|
36598
37066
|
|
|
36599
37067
|
/**
|
|
@@ -36608,6 +37076,32 @@ class JourneyApi {
|
|
|
36608
37076
|
}
|
|
36609
37077
|
|
|
36610
37078
|
|
|
37079
|
+
/**
|
|
37080
|
+
* Delete/cancel an async request for journey aggregates
|
|
37081
|
+
*
|
|
37082
|
+
* @param {String} jobId jobId
|
|
37083
|
+
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37084
|
+
*/
|
|
37085
|
+
deleteAnalyticsJourneysAggregatesJob(jobId) {
|
|
37086
|
+
// verify the required parameter 'jobId' is set
|
|
37087
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
37088
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';
|
|
37089
|
+
}
|
|
37090
|
+
|
|
37091
|
+
return this.apiClient.callApi(
|
|
37092
|
+
'/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
|
|
37093
|
+
'DELETE',
|
|
37094
|
+
{ 'jobId': jobId },
|
|
37095
|
+
{ },
|
|
37096
|
+
{ },
|
|
37097
|
+
{ },
|
|
37098
|
+
null,
|
|
37099
|
+
['PureCloud OAuth'],
|
|
37100
|
+
['application/json'],
|
|
37101
|
+
['application/json']
|
|
37102
|
+
);
|
|
37103
|
+
}
|
|
37104
|
+
|
|
36611
37105
|
/**
|
|
36612
37106
|
* Delete single action map.
|
|
36613
37107
|
*
|
|
@@ -36843,6 +37337,36 @@ class JourneyApi {
|
|
|
36843
37337
|
);
|
|
36844
37338
|
}
|
|
36845
37339
|
|
|
37340
|
+
/**
|
|
37341
|
+
* Retrieve segment assignments by external contact ID.
|
|
37342
|
+
*
|
|
37343
|
+
* @param {String} contactId ExternalContact ID
|
|
37344
|
+
* @param {Object} opts Optional parameters
|
|
37345
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
|
|
37346
|
+
* @param {Number} opts.limit Number of entities to return. Default of 25, maximum of 500.
|
|
37347
|
+
*/
|
|
37348
|
+
getExternalcontactsContactJourneySegments(contactId, opts) {
|
|
37349
|
+
opts = opts || {};
|
|
37350
|
+
|
|
37351
|
+
// verify the required parameter 'contactId' is set
|
|
37352
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
37353
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySegments';
|
|
37354
|
+
}
|
|
37355
|
+
|
|
37356
|
+
return this.apiClient.callApi(
|
|
37357
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
37358
|
+
'GET',
|
|
37359
|
+
{ 'contactId': contactId },
|
|
37360
|
+
{ 'includeMerged': opts['includeMerged'],'limit': opts['limit'] },
|
|
37361
|
+
{ },
|
|
37362
|
+
{ },
|
|
37363
|
+
null,
|
|
37364
|
+
['PureCloud OAuth'],
|
|
37365
|
+
['application/json'],
|
|
37366
|
+
['application/json']
|
|
37367
|
+
);
|
|
37368
|
+
}
|
|
37369
|
+
|
|
36846
37370
|
/**
|
|
36847
37371
|
* Retrieve all sessions for a given external contact.
|
|
36848
37372
|
*
|
|
@@ -38086,6 +38610,35 @@ class JourneyApi {
|
|
|
38086
38610
|
);
|
|
38087
38611
|
}
|
|
38088
38612
|
|
|
38613
|
+
/**
|
|
38614
|
+
* Assign/Unassign up to 10 segments to/from an external contact or, if a segment is already assigned, update the expiry date of the segment assignment. Any unprocessed segment assignments are returned in the body for the client to retry, in the event of a partial success.
|
|
38615
|
+
*
|
|
38616
|
+
* @param {String} contactId ExternalContact ID
|
|
38617
|
+
* @param {Object} opts Optional parameters
|
|
38618
|
+
* @param {Object} opts.body
|
|
38619
|
+
*/
|
|
38620
|
+
postExternalcontactsContactJourneySegments(contactId, opts) {
|
|
38621
|
+
opts = opts || {};
|
|
38622
|
+
|
|
38623
|
+
// verify the required parameter 'contactId' is set
|
|
38624
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
38625
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactJourneySegments';
|
|
38626
|
+
}
|
|
38627
|
+
|
|
38628
|
+
return this.apiClient.callApi(
|
|
38629
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
38630
|
+
'POST',
|
|
38631
|
+
{ 'contactId': contactId },
|
|
38632
|
+
{ },
|
|
38633
|
+
{ },
|
|
38634
|
+
{ },
|
|
38635
|
+
opts['body'],
|
|
38636
|
+
['PureCloud OAuth'],
|
|
38637
|
+
['application/json'],
|
|
38638
|
+
['application/json']
|
|
38639
|
+
);
|
|
38640
|
+
}
|
|
38641
|
+
|
|
38089
38642
|
/**
|
|
38090
38643
|
* Create an action map.
|
|
38091
38644
|
*
|
|
@@ -38578,7 +39131,7 @@ class KnowledgeApi {
|
|
|
38578
39131
|
/**
|
|
38579
39132
|
* Knowledge service.
|
|
38580
39133
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
38581
|
-
* @version
|
|
39134
|
+
* @version 228.0.0
|
|
38582
39135
|
*/
|
|
38583
39136
|
|
|
38584
39137
|
/**
|
|
@@ -41321,6 +41874,35 @@ class KnowledgeApi {
|
|
|
41321
41874
|
);
|
|
41322
41875
|
}
|
|
41323
41876
|
|
|
41877
|
+
/**
|
|
41878
|
+
* Search for chunks in a knowledge base
|
|
41879
|
+
*
|
|
41880
|
+
* @param {String} knowledgeBaseId Knowledge Base ID
|
|
41881
|
+
* @param {Object} opts Optional parameters
|
|
41882
|
+
* @param {Object} opts.body
|
|
41883
|
+
*/
|
|
41884
|
+
postKnowledgeKnowledgebaseChunksSearch(knowledgeBaseId, opts) {
|
|
41885
|
+
opts = opts || {};
|
|
41886
|
+
|
|
41887
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
41888
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41889
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseChunksSearch';
|
|
41890
|
+
}
|
|
41891
|
+
|
|
41892
|
+
return this.apiClient.callApi(
|
|
41893
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search',
|
|
41894
|
+
'POST',
|
|
41895
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
41896
|
+
{ },
|
|
41897
|
+
{ },
|
|
41898
|
+
{ },
|
|
41899
|
+
opts['body'],
|
|
41900
|
+
['PureCloud OAuth'],
|
|
41901
|
+
['application/json'],
|
|
41902
|
+
['application/json']
|
|
41903
|
+
);
|
|
41904
|
+
}
|
|
41905
|
+
|
|
41324
41906
|
/**
|
|
41325
41907
|
* Indicate that the document was copied by the user.
|
|
41326
41908
|
*
|
|
@@ -42451,7 +43033,7 @@ class LanguageUnderstandingApi {
|
|
|
42451
43033
|
/**
|
|
42452
43034
|
* LanguageUnderstanding service.
|
|
42453
43035
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
42454
|
-
* @version
|
|
43036
|
+
* @version 228.0.0
|
|
42455
43037
|
*/
|
|
42456
43038
|
|
|
42457
43039
|
/**
|
|
@@ -43484,7 +44066,7 @@ class LanguagesApi {
|
|
|
43484
44066
|
/**
|
|
43485
44067
|
* Languages service.
|
|
43486
44068
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
43487
|
-
* @version
|
|
44069
|
+
* @version 228.0.0
|
|
43488
44070
|
*/
|
|
43489
44071
|
|
|
43490
44072
|
/**
|
|
@@ -43706,7 +44288,7 @@ class LearningApi {
|
|
|
43706
44288
|
/**
|
|
43707
44289
|
* Learning service.
|
|
43708
44290
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
43709
|
-
* @version
|
|
44291
|
+
* @version 228.0.0
|
|
43710
44292
|
*/
|
|
43711
44293
|
|
|
43712
44294
|
/**
|
|
@@ -44735,7 +45317,7 @@ class LicenseApi {
|
|
|
44735
45317
|
/**
|
|
44736
45318
|
* License service.
|
|
44737
45319
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
44738
|
-
* @version
|
|
45320
|
+
* @version 228.0.0
|
|
44739
45321
|
*/
|
|
44740
45322
|
|
|
44741
45323
|
/**
|
|
@@ -44973,7 +45555,7 @@ class LocationsApi {
|
|
|
44973
45555
|
/**
|
|
44974
45556
|
* Locations service.
|
|
44975
45557
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
44976
|
-
* @version
|
|
45558
|
+
* @version 228.0.0
|
|
44977
45559
|
*/
|
|
44978
45560
|
|
|
44979
45561
|
/**
|
|
@@ -45209,7 +45791,7 @@ class LogCaptureApi {
|
|
|
45209
45791
|
/**
|
|
45210
45792
|
* LogCapture service.
|
|
45211
45793
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45212
|
-
* @version
|
|
45794
|
+
* @version 228.0.0
|
|
45213
45795
|
*/
|
|
45214
45796
|
|
|
45215
45797
|
/**
|
|
@@ -45408,7 +45990,7 @@ class MessagingApi {
|
|
|
45408
45990
|
/**
|
|
45409
45991
|
* Messaging service.
|
|
45410
45992
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
45411
|
-
* @version
|
|
45993
|
+
* @version 228.0.0
|
|
45412
45994
|
*/
|
|
45413
45995
|
|
|
45414
45996
|
/**
|
|
@@ -45767,7 +46349,7 @@ class MobileDevicesApi {
|
|
|
45767
46349
|
/**
|
|
45768
46350
|
* MobileDevices service.
|
|
45769
46351
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
45770
|
-
* @version
|
|
46352
|
+
* @version 228.0.0
|
|
45771
46353
|
*/
|
|
45772
46354
|
|
|
45773
46355
|
/**
|
|
@@ -45918,7 +46500,7 @@ class NotificationsApi {
|
|
|
45918
46500
|
/**
|
|
45919
46501
|
* Notifications service.
|
|
45920
46502
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
45921
|
-
* @version
|
|
46503
|
+
* @version 228.0.0
|
|
45922
46504
|
*/
|
|
45923
46505
|
|
|
45924
46506
|
/**
|
|
@@ -46151,7 +46733,7 @@ class OAuthApi {
|
|
|
46151
46733
|
/**
|
|
46152
46734
|
* OAuth service.
|
|
46153
46735
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46154
|
-
* @version
|
|
46736
|
+
* @version 228.0.0
|
|
46155
46737
|
*/
|
|
46156
46738
|
|
|
46157
46739
|
/**
|
|
@@ -46517,7 +47099,7 @@ class ObjectsApi {
|
|
|
46517
47099
|
/**
|
|
46518
47100
|
* Objects service.
|
|
46519
47101
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
46520
|
-
* @version
|
|
47102
|
+
* @version 228.0.0
|
|
46521
47103
|
*/
|
|
46522
47104
|
|
|
46523
47105
|
/**
|
|
@@ -46841,7 +47423,7 @@ class OperationalEventsApi {
|
|
|
46841
47423
|
/**
|
|
46842
47424
|
* OperationalEvents service.
|
|
46843
47425
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
46844
|
-
* @version
|
|
47426
|
+
* @version 228.0.0
|
|
46845
47427
|
*/
|
|
46846
47428
|
|
|
46847
47429
|
/**
|
|
@@ -46958,7 +47540,7 @@ class OrganizationApi {
|
|
|
46958
47540
|
/**
|
|
46959
47541
|
* Organization service.
|
|
46960
47542
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
46961
|
-
* @version
|
|
47543
|
+
* @version 228.0.0
|
|
46962
47544
|
*/
|
|
46963
47545
|
|
|
46964
47546
|
/**
|
|
@@ -47433,7 +48015,7 @@ class OrganizationAuthorizationApi {
|
|
|
47433
48015
|
/**
|
|
47434
48016
|
* OrganizationAuthorization service.
|
|
47435
48017
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
47436
|
-
* @version
|
|
48018
|
+
* @version 228.0.0
|
|
47437
48019
|
*/
|
|
47438
48020
|
|
|
47439
48021
|
/**
|
|
@@ -48827,7 +49409,7 @@ class OutboundApi {
|
|
|
48827
49409
|
/**
|
|
48828
49410
|
* Outbound service.
|
|
48829
49411
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
48830
|
-
* @version
|
|
49412
|
+
* @version 228.0.0
|
|
48831
49413
|
*/
|
|
48832
49414
|
|
|
48833
49415
|
/**
|
|
@@ -49618,6 +50200,31 @@ class OutboundApi {
|
|
|
49618
50200
|
);
|
|
49619
50201
|
}
|
|
49620
50202
|
|
|
50203
|
+
/**
|
|
50204
|
+
* Delete a WhatsApp campaign schedule.
|
|
50205
|
+
*
|
|
50206
|
+
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
50207
|
+
*/
|
|
50208
|
+
deleteOutboundSchedulesWhatsappcampaign(whatsAppCampaignId) {
|
|
50209
|
+
// verify the required parameter 'whatsAppCampaignId' is set
|
|
50210
|
+
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
50211
|
+
throw 'Missing the required parameter "whatsAppCampaignId" when calling deleteOutboundSchedulesWhatsappcampaign';
|
|
50212
|
+
}
|
|
50213
|
+
|
|
50214
|
+
return this.apiClient.callApi(
|
|
50215
|
+
'/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}',
|
|
50216
|
+
'DELETE',
|
|
50217
|
+
{ 'whatsAppCampaignId': whatsAppCampaignId },
|
|
50218
|
+
{ },
|
|
50219
|
+
{ },
|
|
50220
|
+
{ },
|
|
50221
|
+
null,
|
|
50222
|
+
['PureCloud OAuth'],
|
|
50223
|
+
['application/json'],
|
|
50224
|
+
['application/json']
|
|
50225
|
+
);
|
|
50226
|
+
}
|
|
50227
|
+
|
|
49621
50228
|
/**
|
|
49622
50229
|
* Delete a dialer campaign sequence.
|
|
49623
50230
|
*
|
|
@@ -51466,6 +52073,51 @@ class OutboundApi {
|
|
|
51466
52073
|
);
|
|
51467
52074
|
}
|
|
51468
52075
|
|
|
52076
|
+
/**
|
|
52077
|
+
* Get a WhatsApp campaign schedule.
|
|
52078
|
+
*
|
|
52079
|
+
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
52080
|
+
*/
|
|
52081
|
+
getOutboundSchedulesWhatsappcampaign(whatsAppCampaignId) {
|
|
52082
|
+
// verify the required parameter 'whatsAppCampaignId' is set
|
|
52083
|
+
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
52084
|
+
throw 'Missing the required parameter "whatsAppCampaignId" when calling getOutboundSchedulesWhatsappcampaign';
|
|
52085
|
+
}
|
|
52086
|
+
|
|
52087
|
+
return this.apiClient.callApi(
|
|
52088
|
+
'/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}',
|
|
52089
|
+
'GET',
|
|
52090
|
+
{ 'whatsAppCampaignId': whatsAppCampaignId },
|
|
52091
|
+
{ },
|
|
52092
|
+
{ },
|
|
52093
|
+
{ },
|
|
52094
|
+
null,
|
|
52095
|
+
['PureCloud OAuth'],
|
|
52096
|
+
['application/json'],
|
|
52097
|
+
['application/json']
|
|
52098
|
+
);
|
|
52099
|
+
}
|
|
52100
|
+
|
|
52101
|
+
/**
|
|
52102
|
+
* Query for a list of WhatsApp campaign schedules.
|
|
52103
|
+
*
|
|
52104
|
+
*/
|
|
52105
|
+
getOutboundSchedulesWhatsappcampaigns() {
|
|
52106
|
+
|
|
52107
|
+
return this.apiClient.callApi(
|
|
52108
|
+
'/api/v2/outbound/schedules/whatsappcampaigns',
|
|
52109
|
+
'GET',
|
|
52110
|
+
{ },
|
|
52111
|
+
{ },
|
|
52112
|
+
{ },
|
|
52113
|
+
{ },
|
|
52114
|
+
null,
|
|
52115
|
+
['PureCloud OAuth'],
|
|
52116
|
+
['application/json'],
|
|
52117
|
+
['application/json']
|
|
52118
|
+
);
|
|
52119
|
+
}
|
|
52120
|
+
|
|
51469
52121
|
/**
|
|
51470
52122
|
* Get a dialer campaign sequence.
|
|
51471
52123
|
*
|
|
@@ -53388,6 +54040,36 @@ class OutboundApi {
|
|
|
53388
54040
|
);
|
|
53389
54041
|
}
|
|
53390
54042
|
|
|
54043
|
+
/**
|
|
54044
|
+
* Update a WhatsApp campaign schedule.
|
|
54045
|
+
*
|
|
54046
|
+
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
54047
|
+
* @param {Object} body WhatsAppCampaignSchedule
|
|
54048
|
+
*/
|
|
54049
|
+
putOutboundSchedulesWhatsappcampaign(whatsAppCampaignId, body) {
|
|
54050
|
+
// verify the required parameter 'whatsAppCampaignId' is set
|
|
54051
|
+
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
54052
|
+
throw 'Missing the required parameter "whatsAppCampaignId" when calling putOutboundSchedulesWhatsappcampaign';
|
|
54053
|
+
}
|
|
54054
|
+
// verify the required parameter 'body' is set
|
|
54055
|
+
if (body === undefined || body === null) {
|
|
54056
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesWhatsappcampaign';
|
|
54057
|
+
}
|
|
54058
|
+
|
|
54059
|
+
return this.apiClient.callApi(
|
|
54060
|
+
'/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}',
|
|
54061
|
+
'PUT',
|
|
54062
|
+
{ 'whatsAppCampaignId': whatsAppCampaignId },
|
|
54063
|
+
{ },
|
|
54064
|
+
{ },
|
|
54065
|
+
{ },
|
|
54066
|
+
body,
|
|
54067
|
+
['PureCloud OAuth'],
|
|
54068
|
+
['application/json'],
|
|
54069
|
+
['application/json']
|
|
54070
|
+
);
|
|
54071
|
+
}
|
|
54072
|
+
|
|
53391
54073
|
/**
|
|
53392
54074
|
* Update a new campaign sequence.
|
|
53393
54075
|
*
|
|
@@ -53449,7 +54131,7 @@ class PresenceApi {
|
|
|
53449
54131
|
/**
|
|
53450
54132
|
* Presence service.
|
|
53451
54133
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
53452
|
-
* @version
|
|
54134
|
+
* @version 228.0.0
|
|
53453
54135
|
*/
|
|
53454
54136
|
|
|
53455
54137
|
/**
|
|
@@ -54193,7 +54875,7 @@ class ProcessAutomationApi {
|
|
|
54193
54875
|
/**
|
|
54194
54876
|
* ProcessAutomation service.
|
|
54195
54877
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
54196
|
-
* @version
|
|
54878
|
+
* @version 228.0.0
|
|
54197
54879
|
*/
|
|
54198
54880
|
|
|
54199
54881
|
/**
|
|
@@ -54432,7 +55114,7 @@ class QualityApi {
|
|
|
54432
55114
|
/**
|
|
54433
55115
|
* Quality service.
|
|
54434
55116
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
54435
|
-
* @version
|
|
55117
|
+
* @version 228.0.0
|
|
54436
55118
|
*/
|
|
54437
55119
|
|
|
54438
55120
|
/**
|
|
@@ -54447,6 +55129,58 @@ class QualityApi {
|
|
|
54447
55129
|
}
|
|
54448
55130
|
|
|
54449
55131
|
|
|
55132
|
+
/**
|
|
55133
|
+
* Delete/cancel an async request for evaluation aggregates
|
|
55134
|
+
*
|
|
55135
|
+
* @param {String} jobId jobId
|
|
55136
|
+
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55137
|
+
*/
|
|
55138
|
+
deleteAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
55139
|
+
// verify the required parameter 'jobId' is set
|
|
55140
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
55141
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';
|
|
55142
|
+
}
|
|
55143
|
+
|
|
55144
|
+
return this.apiClient.callApi(
|
|
55145
|
+
'/api/v2/analytics/evaluations/aggregates/jobs/{jobId}',
|
|
55146
|
+
'DELETE',
|
|
55147
|
+
{ 'jobId': jobId },
|
|
55148
|
+
{ },
|
|
55149
|
+
{ },
|
|
55150
|
+
{ },
|
|
55151
|
+
null,
|
|
55152
|
+
['PureCloud OAuth'],
|
|
55153
|
+
['application/json'],
|
|
55154
|
+
['application/json']
|
|
55155
|
+
);
|
|
55156
|
+
}
|
|
55157
|
+
|
|
55158
|
+
/**
|
|
55159
|
+
* Delete/cancel an async request for survey aggregates
|
|
55160
|
+
*
|
|
55161
|
+
* @param {String} jobId jobId
|
|
55162
|
+
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55163
|
+
*/
|
|
55164
|
+
deleteAnalyticsSurveysAggregatesJob(jobId) {
|
|
55165
|
+
// verify the required parameter 'jobId' is set
|
|
55166
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
55167
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';
|
|
55168
|
+
}
|
|
55169
|
+
|
|
55170
|
+
return this.apiClient.callApi(
|
|
55171
|
+
'/api/v2/analytics/surveys/aggregates/jobs/{jobId}',
|
|
55172
|
+
'DELETE',
|
|
55173
|
+
{ 'jobId': jobId },
|
|
55174
|
+
{ },
|
|
55175
|
+
{ },
|
|
55176
|
+
{ },
|
|
55177
|
+
null,
|
|
55178
|
+
['PureCloud OAuth'],
|
|
55179
|
+
['application/json'],
|
|
55180
|
+
['application/json']
|
|
55181
|
+
);
|
|
55182
|
+
}
|
|
55183
|
+
|
|
54450
55184
|
/**
|
|
54451
55185
|
* Delete a calibration by id.
|
|
54452
55186
|
*
|
|
@@ -56219,7 +56953,7 @@ class RecordingApi {
|
|
|
56219
56953
|
/**
|
|
56220
56954
|
* Recording service.
|
|
56221
56955
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
56222
|
-
* @version
|
|
56956
|
+
* @version 228.0.0
|
|
56223
56957
|
*/
|
|
56224
56958
|
|
|
56225
56959
|
/**
|
|
@@ -57824,7 +58558,7 @@ class ResponseManagementApi {
|
|
|
57824
58558
|
/**
|
|
57825
58559
|
* ResponseManagement service.
|
|
57826
58560
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
57827
|
-
* @version
|
|
58561
|
+
* @version 228.0.0
|
|
57828
58562
|
*/
|
|
57829
58563
|
|
|
57830
58564
|
/**
|
|
@@ -58334,7 +59068,7 @@ class RoutingApi {
|
|
|
58334
59068
|
/**
|
|
58335
59069
|
* Routing service.
|
|
58336
59070
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
58337
|
-
* @version
|
|
59071
|
+
* @version 228.0.0
|
|
58338
59072
|
*/
|
|
58339
59073
|
|
|
58340
59074
|
/**
|
|
@@ -62675,7 +63409,7 @@ class SCIMApi {
|
|
|
62675
63409
|
/**
|
|
62676
63410
|
* SCIM service.
|
|
62677
63411
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
62678
|
-
* @version
|
|
63412
|
+
* @version 228.0.0
|
|
62679
63413
|
*/
|
|
62680
63414
|
|
|
62681
63415
|
/**
|
|
@@ -63552,7 +64286,7 @@ class ScreenRecordingApi {
|
|
|
63552
64286
|
/**
|
|
63553
64287
|
* ScreenRecording service.
|
|
63554
64288
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
63555
|
-
* @version
|
|
64289
|
+
* @version 228.0.0
|
|
63556
64290
|
*/
|
|
63557
64291
|
|
|
63558
64292
|
/**
|
|
@@ -63597,7 +64331,7 @@ class ScriptsApi {
|
|
|
63597
64331
|
/**
|
|
63598
64332
|
* Scripts service.
|
|
63599
64333
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
63600
|
-
* @version
|
|
64334
|
+
* @version 228.0.0
|
|
63601
64335
|
*/
|
|
63602
64336
|
|
|
63603
64337
|
/**
|
|
@@ -64073,7 +64807,7 @@ class SearchApi {
|
|
|
64073
64807
|
/**
|
|
64074
64808
|
* Search service.
|
|
64075
64809
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
64076
|
-
* @version
|
|
64810
|
+
* @version 228.0.0
|
|
64077
64811
|
*/
|
|
64078
64812
|
|
|
64079
64813
|
/**
|
|
@@ -64344,31 +65078,6 @@ class SearchApi {
|
|
|
64344
65078
|
);
|
|
64345
65079
|
}
|
|
64346
65080
|
|
|
64347
|
-
/**
|
|
64348
|
-
* Search resources.
|
|
64349
|
-
*
|
|
64350
|
-
* @param {Object} body Search request options
|
|
64351
|
-
*/
|
|
64352
|
-
postAnalyticsConversationsTranscriptsQuery(body) {
|
|
64353
|
-
// verify the required parameter 'body' is set
|
|
64354
|
-
if (body === undefined || body === null) {
|
|
64355
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';
|
|
64356
|
-
}
|
|
64357
|
-
|
|
64358
|
-
return this.apiClient.callApi(
|
|
64359
|
-
'/api/v2/analytics/conversations/transcripts/query',
|
|
64360
|
-
'POST',
|
|
64361
|
-
{ },
|
|
64362
|
-
{ },
|
|
64363
|
-
{ },
|
|
64364
|
-
{ },
|
|
64365
|
-
body,
|
|
64366
|
-
['PureCloud OAuth'],
|
|
64367
|
-
['application/json'],
|
|
64368
|
-
['application/json']
|
|
64369
|
-
);
|
|
64370
|
-
}
|
|
64371
|
-
|
|
64372
65081
|
/**
|
|
64373
65082
|
* Search conversations
|
|
64374
65083
|
*
|
|
@@ -64816,7 +65525,7 @@ class SettingsApi {
|
|
|
64816
65525
|
/**
|
|
64817
65526
|
* Settings service.
|
|
64818
65527
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
64819
|
-
* @version
|
|
65528
|
+
* @version 228.0.0
|
|
64820
65529
|
*/
|
|
64821
65530
|
|
|
64822
65531
|
/**
|
|
@@ -65164,7 +65873,7 @@ class SocialMediaApi {
|
|
|
65164
65873
|
/**
|
|
65165
65874
|
* SocialMedia service.
|
|
65166
65875
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
65167
|
-
* @version
|
|
65876
|
+
* @version 228.0.0
|
|
65168
65877
|
*/
|
|
65169
65878
|
|
|
65170
65879
|
/**
|
|
@@ -66515,7 +67224,7 @@ class SpeechTextAnalyticsApi {
|
|
|
66515
67224
|
/**
|
|
66516
67225
|
* SpeechTextAnalytics service.
|
|
66517
67226
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
66518
|
-
* @version
|
|
67227
|
+
* @version 228.0.0
|
|
66519
67228
|
*/
|
|
66520
67229
|
|
|
66521
67230
|
/**
|
|
@@ -66609,6 +67318,32 @@ class SpeechTextAnalyticsApi {
|
|
|
66609
67318
|
);
|
|
66610
67319
|
}
|
|
66611
67320
|
|
|
67321
|
+
/**
|
|
67322
|
+
* Delete a Speech and Text Analytics Reprocessing job by Id
|
|
67323
|
+
*
|
|
67324
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
67325
|
+
* deleteSpeechandtextanalyticsReprocessingJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67326
|
+
*/
|
|
67327
|
+
deleteSpeechandtextanalyticsReprocessingJob(jobId) {
|
|
67328
|
+
// verify the required parameter 'jobId' is set
|
|
67329
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
67330
|
+
throw 'Missing the required parameter "jobId" when calling deleteSpeechandtextanalyticsReprocessingJob';
|
|
67331
|
+
}
|
|
67332
|
+
|
|
67333
|
+
return this.apiClient.callApi(
|
|
67334
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}',
|
|
67335
|
+
'DELETE',
|
|
67336
|
+
{ 'jobId': jobId },
|
|
67337
|
+
{ },
|
|
67338
|
+
{ },
|
|
67339
|
+
{ },
|
|
67340
|
+
null,
|
|
67341
|
+
['PureCloud OAuth'],
|
|
67342
|
+
['application/json'],
|
|
67343
|
+
['application/json']
|
|
67344
|
+
);
|
|
67345
|
+
}
|
|
67346
|
+
|
|
66612
67347
|
/**
|
|
66613
67348
|
* Delete All Speech and Text Analytics SentimentFeedback
|
|
66614
67349
|
*
|
|
@@ -66848,6 +67583,31 @@ class SpeechTextAnalyticsApi {
|
|
|
66848
67583
|
);
|
|
66849
67584
|
}
|
|
66850
67585
|
|
|
67586
|
+
/**
|
|
67587
|
+
* Get sentiment data
|
|
67588
|
+
*
|
|
67589
|
+
* @param {String} conversationId The conversation ID of the sentiment data
|
|
67590
|
+
*/
|
|
67591
|
+
getSpeechandtextanalyticsConversationSentiments(conversationId) {
|
|
67592
|
+
// verify the required parameter 'conversationId' is set
|
|
67593
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
67594
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationSentiments';
|
|
67595
|
+
}
|
|
67596
|
+
|
|
67597
|
+
return this.apiClient.callApi(
|
|
67598
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/sentiments',
|
|
67599
|
+
'GET',
|
|
67600
|
+
{ 'conversationId': conversationId },
|
|
67601
|
+
{ },
|
|
67602
|
+
{ },
|
|
67603
|
+
{ },
|
|
67604
|
+
null,
|
|
67605
|
+
['PureCloud OAuth'],
|
|
67606
|
+
['application/json'],
|
|
67607
|
+
['application/json']
|
|
67608
|
+
);
|
|
67609
|
+
}
|
|
67610
|
+
|
|
66851
67611
|
/**
|
|
66852
67612
|
* Get conversation summaries by conversation id.
|
|
66853
67613
|
*
|
|
@@ -67196,6 +67956,86 @@ class SpeechTextAnalyticsApi {
|
|
|
67196
67956
|
);
|
|
67197
67957
|
}
|
|
67198
67958
|
|
|
67959
|
+
/**
|
|
67960
|
+
* Get a Speech and Text Analytics reprocess job by id
|
|
67961
|
+
*
|
|
67962
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
67963
|
+
* getSpeechandtextanalyticsReprocessingJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67964
|
+
*/
|
|
67965
|
+
getSpeechandtextanalyticsReprocessingJob(jobId) {
|
|
67966
|
+
// verify the required parameter 'jobId' is set
|
|
67967
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
67968
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsReprocessingJob';
|
|
67969
|
+
}
|
|
67970
|
+
|
|
67971
|
+
return this.apiClient.callApi(
|
|
67972
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}',
|
|
67973
|
+
'GET',
|
|
67974
|
+
{ 'jobId': jobId },
|
|
67975
|
+
{ },
|
|
67976
|
+
{ },
|
|
67977
|
+
{ },
|
|
67978
|
+
null,
|
|
67979
|
+
['PureCloud OAuth'],
|
|
67980
|
+
['application/json'],
|
|
67981
|
+
['application/json']
|
|
67982
|
+
);
|
|
67983
|
+
}
|
|
67984
|
+
|
|
67985
|
+
/**
|
|
67986
|
+
* Get a Speech and Text Analytics Reprocessing interactions statuses by job id
|
|
67987
|
+
*
|
|
67988
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
67989
|
+
* getSpeechandtextanalyticsReprocessingJobInteractions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67990
|
+
*/
|
|
67991
|
+
getSpeechandtextanalyticsReprocessingJobInteractions(jobId) {
|
|
67992
|
+
// verify the required parameter 'jobId' is set
|
|
67993
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
67994
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsReprocessingJobInteractions';
|
|
67995
|
+
}
|
|
67996
|
+
|
|
67997
|
+
return this.apiClient.callApi(
|
|
67998
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}/interactions',
|
|
67999
|
+
'GET',
|
|
68000
|
+
{ 'jobId': jobId },
|
|
68001
|
+
{ },
|
|
68002
|
+
{ },
|
|
68003
|
+
{ },
|
|
68004
|
+
null,
|
|
68005
|
+
['PureCloud OAuth'],
|
|
68006
|
+
['application/json'],
|
|
68007
|
+
['application/json']
|
|
68008
|
+
);
|
|
68009
|
+
}
|
|
68010
|
+
|
|
68011
|
+
/**
|
|
68012
|
+
* Get the list of Speech and Text Analytics reprocess jobs
|
|
68013
|
+
*
|
|
68014
|
+
* @param {Object} opts Optional parameters
|
|
68015
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 100. Default is 25.
|
|
68016
|
+
* @param {Number} opts.pageNumber The page number for the listing. Defaults to 1.
|
|
68017
|
+
* @param {Object} opts.sortOrder Results are sorted by dateCreated. Please choose the sort order. The default is descending (desc).
|
|
68018
|
+
* @param {String} opts.name Case insensitive partial name to filter by.
|
|
68019
|
+
* getSpeechandtextanalyticsReprocessingJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
68020
|
+
*/
|
|
68021
|
+
getSpeechandtextanalyticsReprocessingJobs(opts) {
|
|
68022
|
+
opts = opts || {};
|
|
68023
|
+
|
|
68024
|
+
|
|
68025
|
+
return this.apiClient.callApi(
|
|
68026
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs',
|
|
68027
|
+
'GET',
|
|
68028
|
+
{ },
|
|
68029
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
68030
|
+
{ },
|
|
68031
|
+
{ },
|
|
68032
|
+
null,
|
|
68033
|
+
['PureCloud OAuth'],
|
|
68034
|
+
['application/json'],
|
|
68035
|
+
['application/json']
|
|
68036
|
+
);
|
|
68037
|
+
}
|
|
68038
|
+
|
|
67199
68039
|
/**
|
|
67200
68040
|
* Get the list of Speech and Text Analytics sentiment supported dialects
|
|
67201
68041
|
*
|
|
@@ -67639,6 +68479,32 @@ class SpeechTextAnalyticsApi {
|
|
|
67639
68479
|
);
|
|
67640
68480
|
}
|
|
67641
68481
|
|
|
68482
|
+
/**
|
|
68483
|
+
* Create a Speech and Text Analytics reprocess job.
|
|
68484
|
+
*
|
|
68485
|
+
* @param {Object} body The ReprocessJob to create
|
|
68486
|
+
* postSpeechandtextanalyticsReprocessingJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
68487
|
+
*/
|
|
68488
|
+
postSpeechandtextanalyticsReprocessingJobs(body) {
|
|
68489
|
+
// verify the required parameter 'body' is set
|
|
68490
|
+
if (body === undefined || body === null) {
|
|
68491
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsReprocessingJobs';
|
|
68492
|
+
}
|
|
68493
|
+
|
|
68494
|
+
return this.apiClient.callApi(
|
|
68495
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs',
|
|
68496
|
+
'POST',
|
|
68497
|
+
{ },
|
|
68498
|
+
{ },
|
|
68499
|
+
{ },
|
|
68500
|
+
{ },
|
|
68501
|
+
body,
|
|
68502
|
+
['PureCloud OAuth'],
|
|
68503
|
+
['application/json'],
|
|
68504
|
+
['application/json']
|
|
68505
|
+
);
|
|
68506
|
+
}
|
|
68507
|
+
|
|
67642
68508
|
/**
|
|
67643
68509
|
* Create a Speech and Text Analytics SentimentFeedback
|
|
67644
68510
|
*
|
|
@@ -68004,7 +68870,7 @@ class StationsApi {
|
|
|
68004
68870
|
/**
|
|
68005
68871
|
* Stations service.
|
|
68006
68872
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
68007
|
-
* @version
|
|
68873
|
+
* @version 228.0.0
|
|
68008
68874
|
*/
|
|
68009
68875
|
|
|
68010
68876
|
/**
|
|
@@ -68106,7 +68972,7 @@ class SuggestApi {
|
|
|
68106
68972
|
/**
|
|
68107
68973
|
* Suggest service.
|
|
68108
68974
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
68109
|
-
* @version
|
|
68975
|
+
* @version 228.0.0
|
|
68110
68976
|
*/
|
|
68111
68977
|
|
|
68112
68978
|
/**
|
|
@@ -68245,7 +69111,7 @@ class TaskManagementApi {
|
|
|
68245
69111
|
/**
|
|
68246
69112
|
* TaskManagement service.
|
|
68247
69113
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
68248
|
-
* @version
|
|
69114
|
+
* @version 228.0.0
|
|
68249
69115
|
*/
|
|
68250
69116
|
|
|
68251
69117
|
/**
|
|
@@ -70407,7 +71273,7 @@ class TeamsApi {
|
|
|
70407
71273
|
/**
|
|
70408
71274
|
* Teams service.
|
|
70409
71275
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
70410
|
-
* @version
|
|
71276
|
+
* @version 228.0.0
|
|
70411
71277
|
*/
|
|
70412
71278
|
|
|
70413
71279
|
/**
|
|
@@ -70712,7 +71578,7 @@ class TelephonyApi {
|
|
|
70712
71578
|
/**
|
|
70713
71579
|
* Telephony service.
|
|
70714
71580
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
70715
|
-
* @version
|
|
71581
|
+
* @version 228.0.0
|
|
70716
71582
|
*/
|
|
70717
71583
|
|
|
70718
71584
|
/**
|
|
@@ -70727,6 +71593,53 @@ class TelephonyApi {
|
|
|
70727
71593
|
}
|
|
70728
71594
|
|
|
70729
71595
|
|
|
71596
|
+
/**
|
|
71597
|
+
* Get an agent's greetings.
|
|
71598
|
+
*
|
|
71599
|
+
* @param {String} agentId User ID
|
|
71600
|
+
* getTelephonyAgentGreetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71601
|
+
*/
|
|
71602
|
+
getTelephonyAgentGreetings(agentId) {
|
|
71603
|
+
// verify the required parameter 'agentId' is set
|
|
71604
|
+
if (agentId === undefined || agentId === null || agentId === '') {
|
|
71605
|
+
throw 'Missing the required parameter "agentId" when calling getTelephonyAgentGreetings';
|
|
71606
|
+
}
|
|
71607
|
+
|
|
71608
|
+
return this.apiClient.callApi(
|
|
71609
|
+
'/api/v2/telephony/agents/{agentId}/greetings',
|
|
71610
|
+
'GET',
|
|
71611
|
+
{ 'agentId': agentId },
|
|
71612
|
+
{ },
|
|
71613
|
+
{ },
|
|
71614
|
+
{ },
|
|
71615
|
+
null,
|
|
71616
|
+
['PureCloud OAuth'],
|
|
71617
|
+
['application/json'],
|
|
71618
|
+
['application/json']
|
|
71619
|
+
);
|
|
71620
|
+
}
|
|
71621
|
+
|
|
71622
|
+
/**
|
|
71623
|
+
* Get the agent's own greetings.
|
|
71624
|
+
*
|
|
71625
|
+
* getTelephonyAgentsGreetingsMe is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71626
|
+
*/
|
|
71627
|
+
getTelephonyAgentsGreetingsMe() {
|
|
71628
|
+
|
|
71629
|
+
return this.apiClient.callApi(
|
|
71630
|
+
'/api/v2/telephony/agents/greetings/me',
|
|
71631
|
+
'GET',
|
|
71632
|
+
{ },
|
|
71633
|
+
{ },
|
|
71634
|
+
{ },
|
|
71635
|
+
{ },
|
|
71636
|
+
null,
|
|
71637
|
+
['PureCloud OAuth'],
|
|
71638
|
+
['application/json'],
|
|
71639
|
+
['application/json']
|
|
71640
|
+
);
|
|
71641
|
+
}
|
|
71642
|
+
|
|
70730
71643
|
/**
|
|
70731
71644
|
* Retrieve the list of AWS regions media can stream through.
|
|
70732
71645
|
*
|
|
@@ -70888,13 +71801,70 @@ class TelephonyApi {
|
|
|
70888
71801
|
);
|
|
70889
71802
|
}
|
|
70890
71803
|
|
|
71804
|
+
/**
|
|
71805
|
+
* Updates an agent's greetings.
|
|
71806
|
+
*
|
|
71807
|
+
* @param {String} agentId User ID
|
|
71808
|
+
* @param {Object} body Agent Greeting
|
|
71809
|
+
* putTelephonyAgentGreetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71810
|
+
*/
|
|
71811
|
+
putTelephonyAgentGreetings(agentId, body) {
|
|
71812
|
+
// verify the required parameter 'agentId' is set
|
|
71813
|
+
if (agentId === undefined || agentId === null || agentId === '') {
|
|
71814
|
+
throw 'Missing the required parameter "agentId" when calling putTelephonyAgentGreetings';
|
|
71815
|
+
}
|
|
71816
|
+
// verify the required parameter 'body' is set
|
|
71817
|
+
if (body === undefined || body === null) {
|
|
71818
|
+
throw 'Missing the required parameter "body" when calling putTelephonyAgentGreetings';
|
|
71819
|
+
}
|
|
71820
|
+
|
|
71821
|
+
return this.apiClient.callApi(
|
|
71822
|
+
'/api/v2/telephony/agents/{agentId}/greetings',
|
|
71823
|
+
'PUT',
|
|
71824
|
+
{ 'agentId': agentId },
|
|
71825
|
+
{ },
|
|
71826
|
+
{ },
|
|
71827
|
+
{ },
|
|
71828
|
+
body,
|
|
71829
|
+
['PureCloud OAuth'],
|
|
71830
|
+
['application/json'],
|
|
71831
|
+
['application/json']
|
|
71832
|
+
);
|
|
71833
|
+
}
|
|
71834
|
+
|
|
71835
|
+
/**
|
|
71836
|
+
* Updates the agent's own greetings.
|
|
71837
|
+
*
|
|
71838
|
+
* @param {Object} body Agent Greeting
|
|
71839
|
+
* putTelephonyAgentsGreetingsMe is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71840
|
+
*/
|
|
71841
|
+
putTelephonyAgentsGreetingsMe(body) {
|
|
71842
|
+
// verify the required parameter 'body' is set
|
|
71843
|
+
if (body === undefined || body === null) {
|
|
71844
|
+
throw 'Missing the required parameter "body" when calling putTelephonyAgentsGreetingsMe';
|
|
71845
|
+
}
|
|
71846
|
+
|
|
71847
|
+
return this.apiClient.callApi(
|
|
71848
|
+
'/api/v2/telephony/agents/greetings/me',
|
|
71849
|
+
'PUT',
|
|
71850
|
+
{ },
|
|
71851
|
+
{ },
|
|
71852
|
+
{ },
|
|
71853
|
+
{ },
|
|
71854
|
+
body,
|
|
71855
|
+
['PureCloud OAuth'],
|
|
71856
|
+
['application/json'],
|
|
71857
|
+
['application/json']
|
|
71858
|
+
);
|
|
71859
|
+
}
|
|
71860
|
+
|
|
70891
71861
|
}
|
|
70892
71862
|
|
|
70893
71863
|
class TelephonyProvidersEdgeApi {
|
|
70894
71864
|
/**
|
|
70895
71865
|
* TelephonyProvidersEdge service.
|
|
70896
71866
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
70897
|
-
* @version
|
|
71867
|
+
* @version 228.0.0
|
|
70898
71868
|
*/
|
|
70899
71869
|
|
|
70900
71870
|
/**
|
|
@@ -74387,7 +75357,7 @@ class TextbotsApi {
|
|
|
74387
75357
|
/**
|
|
74388
75358
|
* Textbots service.
|
|
74389
75359
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
74390
|
-
* @version
|
|
75360
|
+
* @version 228.0.0
|
|
74391
75361
|
*/
|
|
74392
75362
|
|
|
74393
75363
|
/**
|
|
@@ -74516,7 +75486,7 @@ class TokensApi {
|
|
|
74516
75486
|
/**
|
|
74517
75487
|
* Tokens service.
|
|
74518
75488
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
74519
|
-
* @version
|
|
75489
|
+
* @version 228.0.0
|
|
74520
75490
|
*/
|
|
74521
75491
|
|
|
74522
75492
|
/**
|
|
@@ -74670,7 +75640,7 @@ class UploadsApi {
|
|
|
74670
75640
|
/**
|
|
74671
75641
|
* Uploads service.
|
|
74672
75642
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
74673
|
-
* @version
|
|
75643
|
+
* @version 228.0.0
|
|
74674
75644
|
*/
|
|
74675
75645
|
|
|
74676
75646
|
/**
|
|
@@ -74961,7 +75931,7 @@ class UsageApi {
|
|
|
74961
75931
|
/**
|
|
74962
75932
|
* Usage service.
|
|
74963
75933
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
74964
|
-
* @version
|
|
75934
|
+
* @version 228.0.0
|
|
74965
75935
|
*/
|
|
74966
75936
|
|
|
74967
75937
|
/**
|
|
@@ -75035,6 +76005,71 @@ class UsageApi {
|
|
|
75035
76005
|
);
|
|
75036
76006
|
}
|
|
75037
76007
|
|
|
76008
|
+
/**
|
|
76009
|
+
* Get the status and results of the usage query
|
|
76010
|
+
*
|
|
76011
|
+
* @param {String} jobId jobId
|
|
76012
|
+
* @param {Object} opts Optional parameters
|
|
76013
|
+
* @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
|
|
76014
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
76015
|
+
*/
|
|
76016
|
+
getUsageAggregatesQueryJob(jobId, opts) {
|
|
76017
|
+
opts = opts || {};
|
|
76018
|
+
|
|
76019
|
+
// verify the required parameter 'jobId' is set
|
|
76020
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
76021
|
+
throw 'Missing the required parameter "jobId" when calling getUsageAggregatesQueryJob';
|
|
76022
|
+
}
|
|
76023
|
+
|
|
76024
|
+
return this.apiClient.callApi(
|
|
76025
|
+
'/api/v2/usage/aggregates/query/jobs/{jobId}',
|
|
76026
|
+
'GET',
|
|
76027
|
+
{ 'jobId': jobId },
|
|
76028
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
76029
|
+
{ },
|
|
76030
|
+
{ },
|
|
76031
|
+
null,
|
|
76032
|
+
['PureCloud OAuth'],
|
|
76033
|
+
['application/json'],
|
|
76034
|
+
['application/json']
|
|
76035
|
+
);
|
|
76036
|
+
}
|
|
76037
|
+
|
|
76038
|
+
/**
|
|
76039
|
+
* Get the status and results of the usage query
|
|
76040
|
+
*
|
|
76041
|
+
* @param {String} clientId clientId
|
|
76042
|
+
* @param {String} jobId jobId
|
|
76043
|
+
* @param {Object} opts Optional parameters
|
|
76044
|
+
* @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
|
|
76045
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
76046
|
+
*/
|
|
76047
|
+
getUsageClientClientIdAggregatesQueryJob(clientId, jobId, opts) {
|
|
76048
|
+
opts = opts || {};
|
|
76049
|
+
|
|
76050
|
+
// verify the required parameter 'clientId' is set
|
|
76051
|
+
if (clientId === undefined || clientId === null || clientId === '') {
|
|
76052
|
+
throw 'Missing the required parameter "clientId" when calling getUsageClientClientIdAggregatesQueryJob';
|
|
76053
|
+
}
|
|
76054
|
+
// verify the required parameter 'jobId' is set
|
|
76055
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
76056
|
+
throw 'Missing the required parameter "jobId" when calling getUsageClientClientIdAggregatesQueryJob';
|
|
76057
|
+
}
|
|
76058
|
+
|
|
76059
|
+
return this.apiClient.callApi(
|
|
76060
|
+
'/api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}',
|
|
76061
|
+
'GET',
|
|
76062
|
+
{ 'clientId': clientId,'jobId': jobId },
|
|
76063
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
76064
|
+
{ },
|
|
76065
|
+
{ },
|
|
76066
|
+
null,
|
|
76067
|
+
['PureCloud OAuth'],
|
|
76068
|
+
['application/json'],
|
|
76069
|
+
['application/json']
|
|
76070
|
+
);
|
|
76071
|
+
}
|
|
76072
|
+
|
|
75038
76073
|
/**
|
|
75039
76074
|
* Get the results of a usage query
|
|
75040
76075
|
*
|
|
@@ -75120,6 +76155,61 @@ class UsageApi {
|
|
|
75120
76155
|
);
|
|
75121
76156
|
}
|
|
75122
76157
|
|
|
76158
|
+
/**
|
|
76159
|
+
* Query your organization's public api usage.
|
|
76160
|
+
* After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
|
|
76161
|
+
* @param {Object} body Query
|
|
76162
|
+
*/
|
|
76163
|
+
postUsageAggregatesQueryJobs(body) {
|
|
76164
|
+
// verify the required parameter 'body' is set
|
|
76165
|
+
if (body === undefined || body === null) {
|
|
76166
|
+
throw 'Missing the required parameter "body" when calling postUsageAggregatesQueryJobs';
|
|
76167
|
+
}
|
|
76168
|
+
|
|
76169
|
+
return this.apiClient.callApi(
|
|
76170
|
+
'/api/v2/usage/aggregates/query/jobs',
|
|
76171
|
+
'POST',
|
|
76172
|
+
{ },
|
|
76173
|
+
{ },
|
|
76174
|
+
{ },
|
|
76175
|
+
{ },
|
|
76176
|
+
body,
|
|
76177
|
+
['PureCloud OAuth'],
|
|
76178
|
+
['application/json'],
|
|
76179
|
+
['application/json']
|
|
76180
|
+
);
|
|
76181
|
+
}
|
|
76182
|
+
|
|
76183
|
+
/**
|
|
76184
|
+
* Query your client's public api usage.
|
|
76185
|
+
* After calling this method, you will need to save the queryExecutionId from the response and use it in a call to the results endpoint to get the results
|
|
76186
|
+
* @param {String} clientId clientId
|
|
76187
|
+
* @param {Object} body Query
|
|
76188
|
+
*/
|
|
76189
|
+
postUsageClientClientIdAggregatesQueryJobs(clientId, body) {
|
|
76190
|
+
// verify the required parameter 'clientId' is set
|
|
76191
|
+
if (clientId === undefined || clientId === null || clientId === '') {
|
|
76192
|
+
throw 'Missing the required parameter "clientId" when calling postUsageClientClientIdAggregatesQueryJobs';
|
|
76193
|
+
}
|
|
76194
|
+
// verify the required parameter 'body' is set
|
|
76195
|
+
if (body === undefined || body === null) {
|
|
76196
|
+
throw 'Missing the required parameter "body" when calling postUsageClientClientIdAggregatesQueryJobs';
|
|
76197
|
+
}
|
|
76198
|
+
|
|
76199
|
+
return this.apiClient.callApi(
|
|
76200
|
+
'/api/v2/usage/client/{clientId}/aggregates/query/jobs',
|
|
76201
|
+
'POST',
|
|
76202
|
+
{ 'clientId': clientId },
|
|
76203
|
+
{ },
|
|
76204
|
+
{ },
|
|
76205
|
+
{ },
|
|
76206
|
+
body,
|
|
76207
|
+
['PureCloud OAuth'],
|
|
76208
|
+
['application/json'],
|
|
76209
|
+
['application/json']
|
|
76210
|
+
);
|
|
76211
|
+
}
|
|
76212
|
+
|
|
75123
76213
|
/**
|
|
75124
76214
|
* Query organization API Usage -
|
|
75125
76215
|
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
@@ -75176,7 +76266,7 @@ class UserRecordingsApi {
|
|
|
75176
76266
|
/**
|
|
75177
76267
|
* UserRecordings service.
|
|
75178
76268
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
75179
|
-
* @version
|
|
76269
|
+
* @version 228.0.0
|
|
75180
76270
|
*/
|
|
75181
76271
|
|
|
75182
76272
|
/**
|
|
@@ -75391,7 +76481,7 @@ class UsersApi {
|
|
|
75391
76481
|
/**
|
|
75392
76482
|
* Users service.
|
|
75393
76483
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
75394
|
-
* @version
|
|
76484
|
+
* @version 228.0.0
|
|
75395
76485
|
*/
|
|
75396
76486
|
|
|
75397
76487
|
/**
|
|
@@ -75406,6 +76496,32 @@ class UsersApi {
|
|
|
75406
76496
|
}
|
|
75407
76497
|
|
|
75408
76498
|
|
|
76499
|
+
/**
|
|
76500
|
+
* Delete/cancel an async request for user aggregates
|
|
76501
|
+
*
|
|
76502
|
+
* @param {String} jobId jobId
|
|
76503
|
+
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76504
|
+
*/
|
|
76505
|
+
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
76506
|
+
// verify the required parameter 'jobId' is set
|
|
76507
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
76508
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
76509
|
+
}
|
|
76510
|
+
|
|
76511
|
+
return this.apiClient.callApi(
|
|
76512
|
+
'/api/v2/analytics/users/aggregates/jobs/{jobId}',
|
|
76513
|
+
'DELETE',
|
|
76514
|
+
{ 'jobId': jobId },
|
|
76515
|
+
{ },
|
|
76516
|
+
{ },
|
|
76517
|
+
{ },
|
|
76518
|
+
null,
|
|
76519
|
+
['PureCloud OAuth'],
|
|
76520
|
+
['application/json'],
|
|
76521
|
+
['application/json']
|
|
76522
|
+
);
|
|
76523
|
+
}
|
|
76524
|
+
|
|
75409
76525
|
/**
|
|
75410
76526
|
* Delete/cancel an async request
|
|
75411
76527
|
*
|
|
@@ -78374,7 +79490,7 @@ class UtilitiesApi {
|
|
|
78374
79490
|
/**
|
|
78375
79491
|
* Utilities service.
|
|
78376
79492
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
78377
|
-
* @version
|
|
79493
|
+
* @version 228.0.0
|
|
78378
79494
|
*/
|
|
78379
79495
|
|
|
78380
79496
|
/**
|
|
@@ -78485,7 +79601,7 @@ class VoicemailApi {
|
|
|
78485
79601
|
/**
|
|
78486
79602
|
* Voicemail service.
|
|
78487
79603
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
78488
|
-
* @version
|
|
79604
|
+
* @version 228.0.0
|
|
78489
79605
|
*/
|
|
78490
79606
|
|
|
78491
79607
|
/**
|
|
@@ -79207,7 +80323,7 @@ class WebChatApi {
|
|
|
79207
80323
|
/**
|
|
79208
80324
|
* WebChat service.
|
|
79209
80325
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
79210
|
-
* @version
|
|
80326
|
+
* @version 228.0.0
|
|
79211
80327
|
*/
|
|
79212
80328
|
|
|
79213
80329
|
/**
|
|
@@ -79250,7 +80366,7 @@ class WebChatApi {
|
|
|
79250
80366
|
|
|
79251
80367
|
/**
|
|
79252
80368
|
* Remove a member from a chat conversation
|
|
79253
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80369
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79254
80370
|
* @param {String} conversationId conversationId
|
|
79255
80371
|
* @param {String} memberId memberId
|
|
79256
80372
|
* @deprecated
|
|
@@ -79348,7 +80464,7 @@ class WebChatApi {
|
|
|
79348
80464
|
|
|
79349
80465
|
/**
|
|
79350
80466
|
* Get a media request in the conversation
|
|
79351
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80467
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
79352
80468
|
* @param {String} conversationId conversationId
|
|
79353
80469
|
* @param {String} mediaRequestId mediaRequestId
|
|
79354
80470
|
* @deprecated
|
|
@@ -79379,7 +80495,7 @@ class WebChatApi {
|
|
|
79379
80495
|
|
|
79380
80496
|
/**
|
|
79381
80497
|
* Get all media requests to the guest in the conversation
|
|
79382
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80498
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79383
80499
|
* @param {String} conversationId conversationId
|
|
79384
80500
|
* @deprecated
|
|
79385
80501
|
*/
|
|
@@ -79405,7 +80521,7 @@ class WebChatApi {
|
|
|
79405
80521
|
|
|
79406
80522
|
/**
|
|
79407
80523
|
* Get a web chat conversation member
|
|
79408
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80524
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79409
80525
|
* @param {String} conversationId conversationId
|
|
79410
80526
|
* @param {String} memberId memberId
|
|
79411
80527
|
* @deprecated
|
|
@@ -79436,7 +80552,7 @@ class WebChatApi {
|
|
|
79436
80552
|
|
|
79437
80553
|
/**
|
|
79438
80554
|
* Get the members of a chat conversation.
|
|
79439
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80555
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79440
80556
|
* @param {String} conversationId conversationId
|
|
79441
80557
|
* @param {Object} opts Optional parameters
|
|
79442
80558
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
@@ -79468,7 +80584,7 @@ class WebChatApi {
|
|
|
79468
80584
|
|
|
79469
80585
|
/**
|
|
79470
80586
|
* Get a web chat conversation message
|
|
79471
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80587
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79472
80588
|
* @param {String} conversationId conversationId
|
|
79473
80589
|
* @param {String} messageId messageId
|
|
79474
80590
|
* @deprecated
|
|
@@ -79499,7 +80615,7 @@ class WebChatApi {
|
|
|
79499
80615
|
|
|
79500
80616
|
/**
|
|
79501
80617
|
* Get the messages of a chat conversation.
|
|
79502
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80618
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79503
80619
|
* @param {String} conversationId conversationId
|
|
79504
80620
|
* @param {Object} opts Optional parameters
|
|
79505
80621
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
@@ -79552,7 +80668,7 @@ class WebChatApi {
|
|
|
79552
80668
|
|
|
79553
80669
|
/**
|
|
79554
80670
|
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
79555
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80671
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
79556
80672
|
* @param {String} conversationId conversationId
|
|
79557
80673
|
* @param {String} mediaRequestId mediaRequestId
|
|
79558
80674
|
* @param {Object} body Request
|
|
@@ -79614,7 +80730,7 @@ class WebChatApi {
|
|
|
79614
80730
|
|
|
79615
80731
|
/**
|
|
79616
80732
|
* Send a message in a chat conversation.
|
|
79617
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80733
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79618
80734
|
* @param {String} conversationId conversationId
|
|
79619
80735
|
* @param {String} memberId memberId
|
|
79620
80736
|
* @param {Object} body Message
|
|
@@ -79650,7 +80766,7 @@ class WebChatApi {
|
|
|
79650
80766
|
|
|
79651
80767
|
/**
|
|
79652
80768
|
* Send a typing-indicator in a chat conversation.
|
|
79653
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80769
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79654
80770
|
* @param {String} conversationId conversationId
|
|
79655
80771
|
* @param {String} memberId memberId
|
|
79656
80772
|
* @deprecated
|
|
@@ -79681,7 +80797,7 @@ class WebChatApi {
|
|
|
79681
80797
|
|
|
79682
80798
|
/**
|
|
79683
80799
|
* Create an ACD chat conversation from an external customer.
|
|
79684
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80800
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/. This endpoint will create a new ACD Chat conversation under the specified Chat Deployment. The conversation will begin with a guest member in it (with a role=CUSTOMER) according to the customer information that is supplied. If the guest member is authenticated, the memberAuthToken field should include his JWT as generated by the POST /api/v2/signeddata resource; if the guest member is anonymous (and the Deployment permits it) this field can be omitted. The returned data includes the IDs of the conversation created, along with a newly-create JWT token that you can supply to all future endpoints as authentication to perform operations against that conversation. After successfully creating a conversation, you should connect a websocket to the event stream named in the eventStreamUri field of the response; the conversation is not routed until the event stream is attached.
|
|
79685
80801
|
* @param {Object} body CreateConversationRequest
|
|
79686
80802
|
* @deprecated
|
|
79687
80803
|
*/
|
|
@@ -79767,7 +80883,7 @@ class WebDeploymentsApi {
|
|
|
79767
80883
|
/**
|
|
79768
80884
|
* WebDeployments service.
|
|
79769
80885
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
79770
|
-
* @version
|
|
80886
|
+
* @version 228.0.0
|
|
79771
80887
|
*/
|
|
79772
80888
|
|
|
79773
80889
|
/**
|
|
@@ -80349,7 +81465,7 @@ class WebMessagingApi {
|
|
|
80349
81465
|
/**
|
|
80350
81466
|
* WebMessaging service.
|
|
80351
81467
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
80352
|
-
* @version
|
|
81468
|
+
* @version 228.0.0
|
|
80353
81469
|
*/
|
|
80354
81470
|
|
|
80355
81471
|
/**
|
|
@@ -80395,7 +81511,7 @@ class WidgetsApi {
|
|
|
80395
81511
|
/**
|
|
80396
81512
|
* Widgets service.
|
|
80397
81513
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
80398
|
-
* @version
|
|
81514
|
+
* @version 228.0.0
|
|
80399
81515
|
*/
|
|
80400
81516
|
|
|
80401
81517
|
/**
|
|
@@ -80412,7 +81528,7 @@ class WidgetsApi {
|
|
|
80412
81528
|
|
|
80413
81529
|
/**
|
|
80414
81530
|
* Delete a Widget deployment
|
|
80415
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81531
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80416
81532
|
* @param {String} deploymentId Widget Config Id
|
|
80417
81533
|
* @deprecated
|
|
80418
81534
|
*/
|
|
@@ -80438,7 +81554,7 @@ class WidgetsApi {
|
|
|
80438
81554
|
|
|
80439
81555
|
/**
|
|
80440
81556
|
* Get a Widget deployment
|
|
80441
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81557
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80442
81558
|
* @param {String} deploymentId Widget Config Id
|
|
80443
81559
|
* @deprecated
|
|
80444
81560
|
*/
|
|
@@ -80464,7 +81580,7 @@ class WidgetsApi {
|
|
|
80464
81580
|
|
|
80465
81581
|
/**
|
|
80466
81582
|
* List Widget deployments
|
|
80467
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81583
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80468
81584
|
* @deprecated
|
|
80469
81585
|
*/
|
|
80470
81586
|
getWidgetsDeployments() {
|
|
@@ -80485,7 +81601,7 @@ class WidgetsApi {
|
|
|
80485
81601
|
|
|
80486
81602
|
/**
|
|
80487
81603
|
* Create Widget deployment
|
|
80488
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81604
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80489
81605
|
* @param {Object} body Deployment
|
|
80490
81606
|
* @deprecated
|
|
80491
81607
|
*/
|
|
@@ -80511,7 +81627,7 @@ class WidgetsApi {
|
|
|
80511
81627
|
|
|
80512
81628
|
/**
|
|
80513
81629
|
* Update a Widget deployment
|
|
80514
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81630
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80515
81631
|
* @param {String} deploymentId Widget Config Id
|
|
80516
81632
|
* @param {Object} body Deployment
|
|
80517
81633
|
* @deprecated
|
|
@@ -80546,7 +81662,7 @@ class WorkforceManagementApi {
|
|
|
80546
81662
|
/**
|
|
80547
81663
|
* WorkforceManagement service.
|
|
80548
81664
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
80549
|
-
* @version
|
|
81665
|
+
* @version 228.0.0
|
|
80550
81666
|
*/
|
|
80551
81667
|
|
|
80552
81668
|
/**
|
|
@@ -80616,6 +81732,40 @@ class WorkforceManagementApi {
|
|
|
80616
81732
|
);
|
|
80617
81733
|
}
|
|
80618
81734
|
|
|
81735
|
+
/**
|
|
81736
|
+
* Delete staffing group allocations history created for a capacity plan before the given date
|
|
81737
|
+
*
|
|
81738
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
81739
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
81740
|
+
* @param {Object} opts Optional parameters
|
|
81741
|
+
* @param {String} opts.beforeDateId The date to delete records that are created on or before this date in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
81742
|
+
*/
|
|
81743
|
+
deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory(businessUnitId, capacityPlanId, opts) {
|
|
81744
|
+
opts = opts || {};
|
|
81745
|
+
|
|
81746
|
+
// verify the required parameter 'businessUnitId' is set
|
|
81747
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
81748
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory';
|
|
81749
|
+
}
|
|
81750
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
81751
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
81752
|
+
throw 'Missing the required parameter "capacityPlanId" when calling deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory';
|
|
81753
|
+
}
|
|
81754
|
+
|
|
81755
|
+
return this.apiClient.callApi(
|
|
81756
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory',
|
|
81757
|
+
'DELETE',
|
|
81758
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
81759
|
+
{ 'beforeDateId': opts['beforeDateId'] },
|
|
81760
|
+
{ },
|
|
81761
|
+
{ },
|
|
81762
|
+
null,
|
|
81763
|
+
['PureCloud OAuth'],
|
|
81764
|
+
['application/json'],
|
|
81765
|
+
['application/json']
|
|
81766
|
+
);
|
|
81767
|
+
}
|
|
81768
|
+
|
|
80619
81769
|
/**
|
|
80620
81770
|
* Deletes the planning group
|
|
80621
81771
|
*
|
|
@@ -81471,6 +82621,7 @@ class WorkforceManagementApi {
|
|
|
81471
82621
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
81472
82622
|
* @param {Object} opts Optional parameters
|
|
81473
82623
|
* @param {Array.<String>} opts.expand Include to access additional data on the business unit
|
|
82624
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
81474
82625
|
*/
|
|
81475
82626
|
getWorkforcemanagementBusinessunit(businessUnitId, opts) {
|
|
81476
82627
|
opts = opts || {};
|
|
@@ -81484,7 +82635,7 @@ class WorkforceManagementApi {
|
|
|
81484
82635
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
81485
82636
|
'GET',
|
|
81486
82637
|
{ 'businessUnitId': businessUnitId },
|
|
81487
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
82638
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
81488
82639
|
{ },
|
|
81489
82640
|
{ },
|
|
81490
82641
|
null,
|
|
@@ -81757,6 +82908,156 @@ class WorkforceManagementApi {
|
|
|
81757
82908
|
);
|
|
81758
82909
|
}
|
|
81759
82910
|
|
|
82911
|
+
/**
|
|
82912
|
+
* Get a capacity plan
|
|
82913
|
+
*
|
|
82914
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
82915
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
82916
|
+
*/
|
|
82917
|
+
getWorkforcemanagementBusinessunitCapacityplan(businessUnitId, capacityPlanId) {
|
|
82918
|
+
// verify the required parameter 'businessUnitId' is set
|
|
82919
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
82920
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplan';
|
|
82921
|
+
}
|
|
82922
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
82923
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
82924
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplan';
|
|
82925
|
+
}
|
|
82926
|
+
|
|
82927
|
+
return this.apiClient.callApi(
|
|
82928
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}',
|
|
82929
|
+
'GET',
|
|
82930
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
82931
|
+
{ },
|
|
82932
|
+
{ },
|
|
82933
|
+
{ },
|
|
82934
|
+
null,
|
|
82935
|
+
['PureCloud OAuth'],
|
|
82936
|
+
['application/json'],
|
|
82937
|
+
['application/json']
|
|
82938
|
+
);
|
|
82939
|
+
}
|
|
82940
|
+
|
|
82941
|
+
/**
|
|
82942
|
+
* Get a capacity plan's staffing group allocations
|
|
82943
|
+
*
|
|
82944
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
82945
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
82946
|
+
*/
|
|
82947
|
+
getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId) {
|
|
82948
|
+
// verify the required parameter 'businessUnitId' is set
|
|
82949
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
82950
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
82951
|
+
}
|
|
82952
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
82953
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
82954
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
82955
|
+
}
|
|
82956
|
+
|
|
82957
|
+
return this.apiClient.callApi(
|
|
82958
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
|
|
82959
|
+
'GET',
|
|
82960
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
82961
|
+
{ },
|
|
82962
|
+
{ },
|
|
82963
|
+
{ },
|
|
82964
|
+
null,
|
|
82965
|
+
['PureCloud OAuth'],
|
|
82966
|
+
['application/json'],
|
|
82967
|
+
['application/json']
|
|
82968
|
+
);
|
|
82969
|
+
}
|
|
82970
|
+
|
|
82971
|
+
/**
|
|
82972
|
+
* Get a capacity plan's staffing requirements
|
|
82973
|
+
*
|
|
82974
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
82975
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
82976
|
+
*/
|
|
82977
|
+
getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements(businessUnitId, capacityPlanId) {
|
|
82978
|
+
// verify the required parameter 'businessUnitId' is set
|
|
82979
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
82980
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements';
|
|
82981
|
+
}
|
|
82982
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
82983
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
82984
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements';
|
|
82985
|
+
}
|
|
82986
|
+
|
|
82987
|
+
return this.apiClient.callApi(
|
|
82988
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffingrequirements',
|
|
82989
|
+
'GET',
|
|
82990
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
82991
|
+
{ },
|
|
82992
|
+
{ },
|
|
82993
|
+
{ },
|
|
82994
|
+
null,
|
|
82995
|
+
['PureCloud OAuth'],
|
|
82996
|
+
['application/json'],
|
|
82997
|
+
['application/json']
|
|
82998
|
+
);
|
|
82999
|
+
}
|
|
83000
|
+
|
|
83001
|
+
/**
|
|
83002
|
+
* Get the latest long term staffing requirements for a business unit
|
|
83003
|
+
*
|
|
83004
|
+
* @param {String} businessUnitId
|
|
83005
|
+
* @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
83006
|
+
* @param {String} forecastId forecastId of forecast
|
|
83007
|
+
*/
|
|
83008
|
+
getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(businessUnitId, weekDateId, forecastId) {
|
|
83009
|
+
// verify the required parameter 'businessUnitId' is set
|
|
83010
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
83011
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
83012
|
+
}
|
|
83013
|
+
// verify the required parameter 'weekDateId' is set
|
|
83014
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
83015
|
+
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
83016
|
+
}
|
|
83017
|
+
// verify the required parameter 'forecastId' is set
|
|
83018
|
+
if (forecastId === undefined || forecastId === null || forecastId === '') {
|
|
83019
|
+
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
83020
|
+
}
|
|
83021
|
+
|
|
83022
|
+
return this.apiClient.callApi(
|
|
83023
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}',
|
|
83024
|
+
'GET',
|
|
83025
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
83026
|
+
{ },
|
|
83027
|
+
{ },
|
|
83028
|
+
{ },
|
|
83029
|
+
null,
|
|
83030
|
+
['PureCloud OAuth'],
|
|
83031
|
+
['application/json'],
|
|
83032
|
+
['application/json']
|
|
83033
|
+
);
|
|
83034
|
+
}
|
|
83035
|
+
|
|
83036
|
+
/**
|
|
83037
|
+
* Get list of capacity plans for a business unit
|
|
83038
|
+
*
|
|
83039
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
83040
|
+
*/
|
|
83041
|
+
getWorkforcemanagementBusinessunitCapacityplans(businessUnitId) {
|
|
83042
|
+
// verify the required parameter 'businessUnitId' is set
|
|
83043
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
83044
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplans';
|
|
83045
|
+
}
|
|
83046
|
+
|
|
83047
|
+
return this.apiClient.callApi(
|
|
83048
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans',
|
|
83049
|
+
'GET',
|
|
83050
|
+
{ 'businessUnitId': businessUnitId },
|
|
83051
|
+
{ },
|
|
83052
|
+
{ },
|
|
83053
|
+
{ },
|
|
83054
|
+
null,
|
|
83055
|
+
['PureCloud OAuth'],
|
|
83056
|
+
['application/json'],
|
|
83057
|
+
['application/json']
|
|
83058
|
+
);
|
|
83059
|
+
}
|
|
83060
|
+
|
|
81760
83061
|
/**
|
|
81761
83062
|
* Get intraday planning groups for the given date
|
|
81762
83063
|
*
|
|
@@ -84329,8 +85630,12 @@ class WorkforceManagementApi {
|
|
|
84329
85630
|
*
|
|
84330
85631
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
84331
85632
|
* @param {Object} body body
|
|
85633
|
+
* @param {Object} opts Optional parameters
|
|
85634
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
84332
85635
|
*/
|
|
84333
|
-
patchWorkforcemanagementBusinessunit(businessUnitId, body) {
|
|
85636
|
+
patchWorkforcemanagementBusinessunit(businessUnitId, body, opts) {
|
|
85637
|
+
opts = opts || {};
|
|
85638
|
+
|
|
84334
85639
|
// verify the required parameter 'businessUnitId' is set
|
|
84335
85640
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
84336
85641
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';
|
|
@@ -84344,7 +85649,7 @@ class WorkforceManagementApi {
|
|
|
84344
85649
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
84345
85650
|
'PATCH',
|
|
84346
85651
|
{ 'businessUnitId': businessUnitId },
|
|
84347
|
-
{
|
|
85652
|
+
{ 'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
84348
85653
|
{ },
|
|
84349
85654
|
{ },
|
|
84350
85655
|
body,
|
|
@@ -84454,6 +85759,41 @@ class WorkforceManagementApi {
|
|
|
84454
85759
|
);
|
|
84455
85760
|
}
|
|
84456
85761
|
|
|
85762
|
+
/**
|
|
85763
|
+
* Update a capacity plan configuration
|
|
85764
|
+
*
|
|
85765
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
85766
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
85767
|
+
* @param {Object} body body
|
|
85768
|
+
*/
|
|
85769
|
+
patchWorkforcemanagementBusinessunitCapacityplan(businessUnitId, capacityPlanId, body) {
|
|
85770
|
+
// verify the required parameter 'businessUnitId' is set
|
|
85771
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
85772
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
85773
|
+
}
|
|
85774
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
85775
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
85776
|
+
throw 'Missing the required parameter "capacityPlanId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
85777
|
+
}
|
|
85778
|
+
// verify the required parameter 'body' is set
|
|
85779
|
+
if (body === undefined || body === null) {
|
|
85780
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
85781
|
+
}
|
|
85782
|
+
|
|
85783
|
+
return this.apiClient.callApi(
|
|
85784
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}',
|
|
85785
|
+
'PATCH',
|
|
85786
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
85787
|
+
{ },
|
|
85788
|
+
{ },
|
|
85789
|
+
{ },
|
|
85790
|
+
body,
|
|
85791
|
+
['PureCloud OAuth'],
|
|
85792
|
+
['application/json'],
|
|
85793
|
+
['application/json']
|
|
85794
|
+
);
|
|
85795
|
+
}
|
|
85796
|
+
|
|
84457
85797
|
/**
|
|
84458
85798
|
* Updates the planning group
|
|
84459
85799
|
*
|
|
@@ -85752,6 +87092,236 @@ class WorkforceManagementApi {
|
|
|
85752
87092
|
);
|
|
85753
87093
|
}
|
|
85754
87094
|
|
|
87095
|
+
/**
|
|
87096
|
+
* Copy a capacity plan
|
|
87097
|
+
*
|
|
87098
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87099
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87100
|
+
* @param {Object} body body
|
|
87101
|
+
*/
|
|
87102
|
+
postWorkforcemanagementBusinessunitCapacityplanCopy(businessUnitId, capacityPlanId, body) {
|
|
87103
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87104
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87105
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
87106
|
+
}
|
|
87107
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87108
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87109
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
87110
|
+
}
|
|
87111
|
+
// verify the required parameter 'body' is set
|
|
87112
|
+
if (body === undefined || body === null) {
|
|
87113
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
87114
|
+
}
|
|
87115
|
+
|
|
87116
|
+
return this.apiClient.callApi(
|
|
87117
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/copy',
|
|
87118
|
+
'POST',
|
|
87119
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87120
|
+
{ },
|
|
87121
|
+
{ },
|
|
87122
|
+
{ },
|
|
87123
|
+
body,
|
|
87124
|
+
['PureCloud OAuth'],
|
|
87125
|
+
['application/json'],
|
|
87126
|
+
['application/json']
|
|
87127
|
+
);
|
|
87128
|
+
}
|
|
87129
|
+
|
|
87130
|
+
/**
|
|
87131
|
+
* Regenerate requirements for capacity plan
|
|
87132
|
+
*
|
|
87133
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87134
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87135
|
+
*/
|
|
87136
|
+
postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate(businessUnitId, capacityPlanId) {
|
|
87137
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87138
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87139
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate';
|
|
87140
|
+
}
|
|
87141
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87142
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87143
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate';
|
|
87144
|
+
}
|
|
87145
|
+
|
|
87146
|
+
return this.apiClient.callApi(
|
|
87147
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/requirement/generate',
|
|
87148
|
+
'POST',
|
|
87149
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87150
|
+
{ },
|
|
87151
|
+
{ },
|
|
87152
|
+
{ },
|
|
87153
|
+
null,
|
|
87154
|
+
['PureCloud OAuth'],
|
|
87155
|
+
['application/json'],
|
|
87156
|
+
['application/json']
|
|
87157
|
+
);
|
|
87158
|
+
}
|
|
87159
|
+
|
|
87160
|
+
/**
|
|
87161
|
+
* Create staffing group allocations for a capacity plan
|
|
87162
|
+
*
|
|
87163
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87164
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87165
|
+
* @param {Object} body
|
|
87166
|
+
*/
|
|
87167
|
+
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId, body) {
|
|
87168
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87169
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87170
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
87171
|
+
}
|
|
87172
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87173
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87174
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
87175
|
+
}
|
|
87176
|
+
// verify the required parameter 'body' is set
|
|
87177
|
+
if (body === undefined || body === null) {
|
|
87178
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
87179
|
+
}
|
|
87180
|
+
|
|
87181
|
+
return this.apiClient.callApi(
|
|
87182
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
|
|
87183
|
+
'POST',
|
|
87184
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87185
|
+
{ },
|
|
87186
|
+
{ },
|
|
87187
|
+
{ },
|
|
87188
|
+
body,
|
|
87189
|
+
['PureCloud OAuth'],
|
|
87190
|
+
['application/json'],
|
|
87191
|
+
['application/json']
|
|
87192
|
+
);
|
|
87193
|
+
}
|
|
87194
|
+
|
|
87195
|
+
/**
|
|
87196
|
+
* Query staffing groups allocations history for a capacity plan
|
|
87197
|
+
*
|
|
87198
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87199
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87200
|
+
* @param {Object} body
|
|
87201
|
+
*/
|
|
87202
|
+
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery(businessUnitId, capacityPlanId, body) {
|
|
87203
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87204
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87205
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
87206
|
+
}
|
|
87207
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87208
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87209
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
87210
|
+
}
|
|
87211
|
+
// verify the required parameter 'body' is set
|
|
87212
|
+
if (body === undefined || body === null) {
|
|
87213
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
87214
|
+
}
|
|
87215
|
+
|
|
87216
|
+
return this.apiClient.callApi(
|
|
87217
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory/query',
|
|
87218
|
+
'POST',
|
|
87219
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87220
|
+
{ },
|
|
87221
|
+
{ },
|
|
87222
|
+
{ },
|
|
87223
|
+
body,
|
|
87224
|
+
['PureCloud OAuth'],
|
|
87225
|
+
['application/json'],
|
|
87226
|
+
['application/json']
|
|
87227
|
+
);
|
|
87228
|
+
}
|
|
87229
|
+
|
|
87230
|
+
/**
|
|
87231
|
+
* Force regenerate the latest long term staffing requirements for a business unit
|
|
87232
|
+
*
|
|
87233
|
+
* @param {String} businessUnitId
|
|
87234
|
+
* @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
87235
|
+
* @param {String} forecastId forecastId of forecast
|
|
87236
|
+
*/
|
|
87237
|
+
postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate(businessUnitId, weekDateId, forecastId) {
|
|
87238
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87239
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87240
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
87241
|
+
}
|
|
87242
|
+
// verify the required parameter 'weekDateId' is set
|
|
87243
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
87244
|
+
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
87245
|
+
}
|
|
87246
|
+
// verify the required parameter 'forecastId' is set
|
|
87247
|
+
if (forecastId === undefined || forecastId === null || forecastId === '') {
|
|
87248
|
+
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
87249
|
+
}
|
|
87250
|
+
|
|
87251
|
+
return this.apiClient.callApi(
|
|
87252
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}/forceregenerate',
|
|
87253
|
+
'POST',
|
|
87254
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
87255
|
+
{ },
|
|
87256
|
+
{ },
|
|
87257
|
+
{ },
|
|
87258
|
+
null,
|
|
87259
|
+
['PureCloud OAuth'],
|
|
87260
|
+
['application/json'],
|
|
87261
|
+
['application/json']
|
|
87262
|
+
);
|
|
87263
|
+
}
|
|
87264
|
+
|
|
87265
|
+
/**
|
|
87266
|
+
* Create a new capacity plan
|
|
87267
|
+
*
|
|
87268
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87269
|
+
* @param {Object} body body
|
|
87270
|
+
*/
|
|
87271
|
+
postWorkforcemanagementBusinessunitCapacityplans(businessUnitId, body) {
|
|
87272
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87273
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87274
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplans';
|
|
87275
|
+
}
|
|
87276
|
+
// verify the required parameter 'body' is set
|
|
87277
|
+
if (body === undefined || body === null) {
|
|
87278
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplans';
|
|
87279
|
+
}
|
|
87280
|
+
|
|
87281
|
+
return this.apiClient.callApi(
|
|
87282
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans',
|
|
87283
|
+
'POST',
|
|
87284
|
+
{ 'businessUnitId': businessUnitId },
|
|
87285
|
+
{ },
|
|
87286
|
+
{ },
|
|
87287
|
+
{ },
|
|
87288
|
+
body,
|
|
87289
|
+
['PureCloud OAuth'],
|
|
87290
|
+
['application/json'],
|
|
87291
|
+
['application/json']
|
|
87292
|
+
);
|
|
87293
|
+
}
|
|
87294
|
+
|
|
87295
|
+
/**
|
|
87296
|
+
* Delete capacity plans in a business unit
|
|
87297
|
+
*
|
|
87298
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87299
|
+
* @param {Object} body body
|
|
87300
|
+
*/
|
|
87301
|
+
postWorkforcemanagementBusinessunitCapacityplansBulkRemove(businessUnitId, body) {
|
|
87302
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87303
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87304
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplansBulkRemove';
|
|
87305
|
+
}
|
|
87306
|
+
// verify the required parameter 'body' is set
|
|
87307
|
+
if (body === undefined || body === null) {
|
|
87308
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplansBulkRemove';
|
|
87309
|
+
}
|
|
87310
|
+
|
|
87311
|
+
return this.apiClient.callApi(
|
|
87312
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/bulk/remove',
|
|
87313
|
+
'POST',
|
|
87314
|
+
{ 'businessUnitId': businessUnitId },
|
|
87315
|
+
{ },
|
|
87316
|
+
{ },
|
|
87317
|
+
{ },
|
|
87318
|
+
body,
|
|
87319
|
+
['PureCloud OAuth'],
|
|
87320
|
+
['application/json'],
|
|
87321
|
+
['application/json']
|
|
87322
|
+
);
|
|
87323
|
+
}
|
|
87324
|
+
|
|
85755
87325
|
/**
|
|
85756
87326
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
85757
87327
|
*
|
|
@@ -85876,6 +87446,36 @@ class WorkforceManagementApi {
|
|
|
85876
87446
|
);
|
|
85877
87447
|
}
|
|
85878
87448
|
|
|
87449
|
+
/**
|
|
87450
|
+
* Gets a list of planning group to staffing groups list association
|
|
87451
|
+
*
|
|
87452
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87453
|
+
* @param {Object} body body
|
|
87454
|
+
*/
|
|
87455
|
+
postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery(businessUnitId, body) {
|
|
87456
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87457
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87458
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery';
|
|
87459
|
+
}
|
|
87460
|
+
// verify the required parameter 'body' is set
|
|
87461
|
+
if (body === undefined || body === null) {
|
|
87462
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery';
|
|
87463
|
+
}
|
|
87464
|
+
|
|
87465
|
+
return this.apiClient.callApi(
|
|
87466
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/planninggroups/query',
|
|
87467
|
+
'POST',
|
|
87468
|
+
{ 'businessUnitId': businessUnitId },
|
|
87469
|
+
{ },
|
|
87470
|
+
{ },
|
|
87471
|
+
{ },
|
|
87472
|
+
body,
|
|
87473
|
+
['PureCloud OAuth'],
|
|
87474
|
+
['application/json'],
|
|
87475
|
+
['application/json']
|
|
87476
|
+
);
|
|
87477
|
+
}
|
|
87478
|
+
|
|
85879
87479
|
/**
|
|
85880
87480
|
* Gets staffing group associations for a list of user IDs
|
|
85881
87481
|
*
|
|
@@ -86682,8 +88282,12 @@ class WorkforceManagementApi {
|
|
|
86682
88282
|
* Add a new business unit
|
|
86683
88283
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
86684
88284
|
* @param {Object} body body
|
|
88285
|
+
* @param {Object} opts Optional parameters
|
|
88286
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
86685
88287
|
*/
|
|
86686
|
-
postWorkforcemanagementBusinessunits(body) {
|
|
88288
|
+
postWorkforcemanagementBusinessunits(body, opts) {
|
|
88289
|
+
opts = opts || {};
|
|
88290
|
+
|
|
86687
88291
|
// verify the required parameter 'body' is set
|
|
86688
88292
|
if (body === undefined || body === null) {
|
|
86689
88293
|
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunits';
|
|
@@ -86693,7 +88297,7 @@ class WorkforceManagementApi {
|
|
|
86693
88297
|
'/api/v2/workforcemanagement/businessunits',
|
|
86694
88298
|
'POST',
|
|
86695
88299
|
{ },
|
|
86696
|
-
{
|
|
88300
|
+
{ 'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
86697
88301
|
{ },
|
|
86698
88302
|
{ },
|
|
86699
88303
|
body,
|
|
@@ -88028,7 +89632,7 @@ class WorkforceManagementApi {
|
|
|
88028
89632
|
* </pre>
|
|
88029
89633
|
* </p>
|
|
88030
89634
|
* @module purecloud-platform-client-v2/index
|
|
88031
|
-
* @version
|
|
89635
|
+
* @version 228.0.0
|
|
88032
89636
|
*/
|
|
88033
89637
|
class platformClient {
|
|
88034
89638
|
constructor() {
|