purecloud-platform-client-v2 227.0.0 → 229.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
|
@@ -743,7 +743,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
743
743
|
|
|
744
744
|
/**
|
|
745
745
|
* @module purecloud-platform-client-v2/ApiClient
|
|
746
|
-
* @version
|
|
746
|
+
* @version 229.0.0
|
|
747
747
|
*/
|
|
748
748
|
class ApiClient {
|
|
749
749
|
/**
|
|
@@ -2287,7 +2287,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2287
2287
|
/**
|
|
2288
2288
|
* AIStudio service.
|
|
2289
2289
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2290
|
-
* @version
|
|
2290
|
+
* @version 229.0.0
|
|
2291
2291
|
*/
|
|
2292
2292
|
|
|
2293
2293
|
/**
|
|
@@ -2509,6 +2509,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2509
2509
|
);
|
|
2510
2510
|
}
|
|
2511
2511
|
|
|
2512
|
+
/**
|
|
2513
|
+
* Update a guide.
|
|
2514
|
+
*
|
|
2515
|
+
* @param {String} guideId Guide ID
|
|
2516
|
+
* @param {Object} body
|
|
2517
|
+
* patchGuide is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2518
|
+
*/
|
|
2519
|
+
patchGuide(guideId, body) {
|
|
2520
|
+
// verify the required parameter 'guideId' is set
|
|
2521
|
+
if (guideId === undefined || guideId === null || guideId === '') {
|
|
2522
|
+
throw 'Missing the required parameter "guideId" when calling patchGuide';
|
|
2523
|
+
}
|
|
2524
|
+
// verify the required parameter 'body' is set
|
|
2525
|
+
if (body === undefined || body === null) {
|
|
2526
|
+
throw 'Missing the required parameter "body" when calling patchGuide';
|
|
2527
|
+
}
|
|
2528
|
+
|
|
2529
|
+
return this.apiClient.callApi(
|
|
2530
|
+
'/api/v2/guides/{guideId}',
|
|
2531
|
+
'PATCH',
|
|
2532
|
+
{ 'guideId': guideId },
|
|
2533
|
+
{ },
|
|
2534
|
+
{ },
|
|
2535
|
+
{ },
|
|
2536
|
+
body,
|
|
2537
|
+
['PureCloud OAuth'],
|
|
2538
|
+
['application/json'],
|
|
2539
|
+
['application/json']
|
|
2540
|
+
);
|
|
2541
|
+
}
|
|
2542
|
+
|
|
2512
2543
|
/**
|
|
2513
2544
|
* Update a guide version.
|
|
2514
2545
|
*
|
|
@@ -2669,7 +2700,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2669
2700
|
/**
|
|
2670
2701
|
* AgentAssistants service.
|
|
2671
2702
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
2672
|
-
* @version
|
|
2703
|
+
* @version 229.0.0
|
|
2673
2704
|
*/
|
|
2674
2705
|
|
|
2675
2706
|
/**
|
|
@@ -3046,7 +3077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3046
3077
|
/**
|
|
3047
3078
|
* AgentCopilot service.
|
|
3048
3079
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3049
|
-
* @version
|
|
3080
|
+
* @version 229.0.0
|
|
3050
3081
|
*/
|
|
3051
3082
|
|
|
3052
3083
|
/**
|
|
@@ -3122,7 +3153,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3122
3153
|
/**
|
|
3123
3154
|
* AgentUI service.
|
|
3124
3155
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
3125
|
-
* @version
|
|
3156
|
+
* @version 229.0.0
|
|
3126
3157
|
*/
|
|
3127
3158
|
|
|
3128
3159
|
/**
|
|
@@ -3253,7 +3284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3253
3284
|
/**
|
|
3254
3285
|
* Alerting service.
|
|
3255
3286
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
3256
|
-
* @version
|
|
3287
|
+
* @version 229.0.0
|
|
3257
3288
|
*/
|
|
3258
3289
|
|
|
3259
3290
|
/**
|
|
@@ -3654,7 +3685,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3654
3685
|
/**
|
|
3655
3686
|
* Analytics service.
|
|
3656
3687
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
3657
|
-
* @version
|
|
3688
|
+
* @version 229.0.0
|
|
3658
3689
|
*/
|
|
3659
3690
|
|
|
3660
3691
|
/**
|
|
@@ -3669,6 +3700,110 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3669
3700
|
}
|
|
3670
3701
|
|
|
3671
3702
|
|
|
3703
|
+
/**
|
|
3704
|
+
* Delete/cancel an async request for action aggregates
|
|
3705
|
+
*
|
|
3706
|
+
* @param {String} jobId jobId
|
|
3707
|
+
* deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3708
|
+
*/
|
|
3709
|
+
deleteAnalyticsActionsAggregatesJob(jobId) {
|
|
3710
|
+
// verify the required parameter 'jobId' is set
|
|
3711
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3712
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsActionsAggregatesJob';
|
|
3713
|
+
}
|
|
3714
|
+
|
|
3715
|
+
return this.apiClient.callApi(
|
|
3716
|
+
'/api/v2/analytics/actions/aggregates/jobs/{jobId}',
|
|
3717
|
+
'DELETE',
|
|
3718
|
+
{ 'jobId': jobId },
|
|
3719
|
+
{ },
|
|
3720
|
+
{ },
|
|
3721
|
+
{ },
|
|
3722
|
+
null,
|
|
3723
|
+
['PureCloud OAuth'],
|
|
3724
|
+
['application/json'],
|
|
3725
|
+
['application/json']
|
|
3726
|
+
);
|
|
3727
|
+
}
|
|
3728
|
+
|
|
3729
|
+
/**
|
|
3730
|
+
* Delete/cancel an async request for agent copilot aggregates
|
|
3731
|
+
*
|
|
3732
|
+
* @param {String} jobId jobId
|
|
3733
|
+
* deleteAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3734
|
+
*/
|
|
3735
|
+
deleteAnalyticsAgentcopilotsAggregatesJob(jobId) {
|
|
3736
|
+
// verify the required parameter 'jobId' is set
|
|
3737
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3738
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsAgentcopilotsAggregatesJob';
|
|
3739
|
+
}
|
|
3740
|
+
|
|
3741
|
+
return this.apiClient.callApi(
|
|
3742
|
+
'/api/v2/analytics/agentcopilots/aggregates/jobs/{jobId}',
|
|
3743
|
+
'DELETE',
|
|
3744
|
+
{ 'jobId': jobId },
|
|
3745
|
+
{ },
|
|
3746
|
+
{ },
|
|
3747
|
+
{ },
|
|
3748
|
+
null,
|
|
3749
|
+
['PureCloud OAuth'],
|
|
3750
|
+
['application/json'],
|
|
3751
|
+
['application/json']
|
|
3752
|
+
);
|
|
3753
|
+
}
|
|
3754
|
+
|
|
3755
|
+
/**
|
|
3756
|
+
* Delete/cancel an async request for bot aggregates
|
|
3757
|
+
*
|
|
3758
|
+
* @param {String} jobId jobId
|
|
3759
|
+
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3760
|
+
*/
|
|
3761
|
+
deleteAnalyticsBotsAggregatesJob(jobId) {
|
|
3762
|
+
// verify the required parameter 'jobId' is set
|
|
3763
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3764
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsBotsAggregatesJob';
|
|
3765
|
+
}
|
|
3766
|
+
|
|
3767
|
+
return this.apiClient.callApi(
|
|
3768
|
+
'/api/v2/analytics/bots/aggregates/jobs/{jobId}',
|
|
3769
|
+
'DELETE',
|
|
3770
|
+
{ 'jobId': jobId },
|
|
3771
|
+
{ },
|
|
3772
|
+
{ },
|
|
3773
|
+
{ },
|
|
3774
|
+
null,
|
|
3775
|
+
['PureCloud OAuth'],
|
|
3776
|
+
['application/json'],
|
|
3777
|
+
['application/json']
|
|
3778
|
+
);
|
|
3779
|
+
}
|
|
3780
|
+
|
|
3781
|
+
/**
|
|
3782
|
+
* Delete/cancel an async request for conversation aggregates
|
|
3783
|
+
*
|
|
3784
|
+
* @param {String} jobId jobId
|
|
3785
|
+
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3786
|
+
*/
|
|
3787
|
+
deleteAnalyticsConversationsAggregatesJob(jobId) {
|
|
3788
|
+
// verify the required parameter 'jobId' is set
|
|
3789
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3790
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';
|
|
3791
|
+
}
|
|
3792
|
+
|
|
3793
|
+
return this.apiClient.callApi(
|
|
3794
|
+
'/api/v2/analytics/conversations/aggregates/jobs/{jobId}',
|
|
3795
|
+
'DELETE',
|
|
3796
|
+
{ 'jobId': jobId },
|
|
3797
|
+
{ },
|
|
3798
|
+
{ },
|
|
3799
|
+
{ },
|
|
3800
|
+
null,
|
|
3801
|
+
['PureCloud OAuth'],
|
|
3802
|
+
['application/json'],
|
|
3803
|
+
['application/json']
|
|
3804
|
+
);
|
|
3805
|
+
}
|
|
3806
|
+
|
|
3672
3807
|
/**
|
|
3673
3808
|
* Delete/cancel an async details job
|
|
3674
3809
|
*
|
|
@@ -3694,6 +3829,292 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3694
3829
|
);
|
|
3695
3830
|
}
|
|
3696
3831
|
|
|
3832
|
+
/**
|
|
3833
|
+
* Delete/cancel an async request for evaluation aggregates
|
|
3834
|
+
*
|
|
3835
|
+
* @param {String} jobId jobId
|
|
3836
|
+
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3837
|
+
*/
|
|
3838
|
+
deleteAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
3839
|
+
// verify the required parameter 'jobId' is set
|
|
3840
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3841
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';
|
|
3842
|
+
}
|
|
3843
|
+
|
|
3844
|
+
return this.apiClient.callApi(
|
|
3845
|
+
'/api/v2/analytics/evaluations/aggregates/jobs/{jobId}',
|
|
3846
|
+
'DELETE',
|
|
3847
|
+
{ 'jobId': jobId },
|
|
3848
|
+
{ },
|
|
3849
|
+
{ },
|
|
3850
|
+
{ },
|
|
3851
|
+
null,
|
|
3852
|
+
['PureCloud OAuth'],
|
|
3853
|
+
['application/json'],
|
|
3854
|
+
['application/json']
|
|
3855
|
+
);
|
|
3856
|
+
}
|
|
3857
|
+
|
|
3858
|
+
/**
|
|
3859
|
+
* Delete/cancel an async request for flow execution aggregates
|
|
3860
|
+
*
|
|
3861
|
+
* @param {String} jobId jobId
|
|
3862
|
+
* deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3863
|
+
*/
|
|
3864
|
+
deleteAnalyticsFlowexecutionsAggregatesJob(jobId) {
|
|
3865
|
+
// verify the required parameter 'jobId' is set
|
|
3866
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3867
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowexecutionsAggregatesJob';
|
|
3868
|
+
}
|
|
3869
|
+
|
|
3870
|
+
return this.apiClient.callApi(
|
|
3871
|
+
'/api/v2/analytics/flowexecutions/aggregates/jobs/{jobId}',
|
|
3872
|
+
'DELETE',
|
|
3873
|
+
{ 'jobId': jobId },
|
|
3874
|
+
{ },
|
|
3875
|
+
{ },
|
|
3876
|
+
{ },
|
|
3877
|
+
null,
|
|
3878
|
+
['PureCloud OAuth'],
|
|
3879
|
+
['application/json'],
|
|
3880
|
+
['application/json']
|
|
3881
|
+
);
|
|
3882
|
+
}
|
|
3883
|
+
|
|
3884
|
+
/**
|
|
3885
|
+
* Delete/cancel an async request for flow aggregates
|
|
3886
|
+
*
|
|
3887
|
+
* @param {String} jobId jobId
|
|
3888
|
+
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3889
|
+
*/
|
|
3890
|
+
deleteAnalyticsFlowsAggregatesJob(jobId) {
|
|
3891
|
+
// verify the required parameter 'jobId' is set
|
|
3892
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3893
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';
|
|
3894
|
+
}
|
|
3895
|
+
|
|
3896
|
+
return this.apiClient.callApi(
|
|
3897
|
+
'/api/v2/analytics/flows/aggregates/jobs/{jobId}',
|
|
3898
|
+
'DELETE',
|
|
3899
|
+
{ 'jobId': jobId },
|
|
3900
|
+
{ },
|
|
3901
|
+
{ },
|
|
3902
|
+
{ },
|
|
3903
|
+
null,
|
|
3904
|
+
['PureCloud OAuth'],
|
|
3905
|
+
['application/json'],
|
|
3906
|
+
['application/json']
|
|
3907
|
+
);
|
|
3908
|
+
}
|
|
3909
|
+
|
|
3910
|
+
/**
|
|
3911
|
+
* Delete/cancel an async request for journey aggregates
|
|
3912
|
+
*
|
|
3913
|
+
* @param {String} jobId jobId
|
|
3914
|
+
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3915
|
+
*/
|
|
3916
|
+
deleteAnalyticsJourneysAggregatesJob(jobId) {
|
|
3917
|
+
// verify the required parameter 'jobId' is set
|
|
3918
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3919
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';
|
|
3920
|
+
}
|
|
3921
|
+
|
|
3922
|
+
return this.apiClient.callApi(
|
|
3923
|
+
'/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
|
|
3924
|
+
'DELETE',
|
|
3925
|
+
{ 'jobId': jobId },
|
|
3926
|
+
{ },
|
|
3927
|
+
{ },
|
|
3928
|
+
{ },
|
|
3929
|
+
null,
|
|
3930
|
+
['PureCloud OAuth'],
|
|
3931
|
+
['application/json'],
|
|
3932
|
+
['application/json']
|
|
3933
|
+
);
|
|
3934
|
+
}
|
|
3935
|
+
|
|
3936
|
+
/**
|
|
3937
|
+
* Delete/cancel an async request for knowledge aggregates
|
|
3938
|
+
*
|
|
3939
|
+
* @param {String} jobId jobId
|
|
3940
|
+
* deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3941
|
+
*/
|
|
3942
|
+
deleteAnalyticsKnowledgeAggregatesJob(jobId) {
|
|
3943
|
+
// verify the required parameter 'jobId' is set
|
|
3944
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3945
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsKnowledgeAggregatesJob';
|
|
3946
|
+
}
|
|
3947
|
+
|
|
3948
|
+
return this.apiClient.callApi(
|
|
3949
|
+
'/api/v2/analytics/knowledge/aggregates/jobs/{jobId}',
|
|
3950
|
+
'DELETE',
|
|
3951
|
+
{ 'jobId': jobId },
|
|
3952
|
+
{ },
|
|
3953
|
+
{ },
|
|
3954
|
+
{ },
|
|
3955
|
+
null,
|
|
3956
|
+
['PureCloud OAuth'],
|
|
3957
|
+
['application/json'],
|
|
3958
|
+
['application/json']
|
|
3959
|
+
);
|
|
3960
|
+
}
|
|
3961
|
+
|
|
3962
|
+
/**
|
|
3963
|
+
* Delete/cancel an async request for resolution aggregates
|
|
3964
|
+
*
|
|
3965
|
+
* @param {String} jobId jobId
|
|
3966
|
+
* deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3967
|
+
*/
|
|
3968
|
+
deleteAnalyticsResolutionsAggregatesJob(jobId) {
|
|
3969
|
+
// verify the required parameter 'jobId' is set
|
|
3970
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3971
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsResolutionsAggregatesJob';
|
|
3972
|
+
}
|
|
3973
|
+
|
|
3974
|
+
return this.apiClient.callApi(
|
|
3975
|
+
'/api/v2/analytics/resolutions/aggregates/jobs/{jobId}',
|
|
3976
|
+
'DELETE',
|
|
3977
|
+
{ 'jobId': jobId },
|
|
3978
|
+
{ },
|
|
3979
|
+
{ },
|
|
3980
|
+
{ },
|
|
3981
|
+
null,
|
|
3982
|
+
['PureCloud OAuth'],
|
|
3983
|
+
['application/json'],
|
|
3984
|
+
['application/json']
|
|
3985
|
+
);
|
|
3986
|
+
}
|
|
3987
|
+
|
|
3988
|
+
/**
|
|
3989
|
+
* Delete/cancel an async request for summary aggregates
|
|
3990
|
+
*
|
|
3991
|
+
* @param {String} jobId jobId
|
|
3992
|
+
* deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3993
|
+
*/
|
|
3994
|
+
deleteAnalyticsSummariesAggregatesJob(jobId) {
|
|
3995
|
+
// verify the required parameter 'jobId' is set
|
|
3996
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
3997
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSummariesAggregatesJob';
|
|
3998
|
+
}
|
|
3999
|
+
|
|
4000
|
+
return this.apiClient.callApi(
|
|
4001
|
+
'/api/v2/analytics/summaries/aggregates/jobs/{jobId}',
|
|
4002
|
+
'DELETE',
|
|
4003
|
+
{ 'jobId': jobId },
|
|
4004
|
+
{ },
|
|
4005
|
+
{ },
|
|
4006
|
+
{ },
|
|
4007
|
+
null,
|
|
4008
|
+
['PureCloud OAuth'],
|
|
4009
|
+
['application/json'],
|
|
4010
|
+
['application/json']
|
|
4011
|
+
);
|
|
4012
|
+
}
|
|
4013
|
+
|
|
4014
|
+
/**
|
|
4015
|
+
* Delete/cancel an async request for survey aggregates
|
|
4016
|
+
*
|
|
4017
|
+
* @param {String} jobId jobId
|
|
4018
|
+
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4019
|
+
*/
|
|
4020
|
+
deleteAnalyticsSurveysAggregatesJob(jobId) {
|
|
4021
|
+
// verify the required parameter 'jobId' is set
|
|
4022
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4023
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';
|
|
4024
|
+
}
|
|
4025
|
+
|
|
4026
|
+
return this.apiClient.callApi(
|
|
4027
|
+
'/api/v2/analytics/surveys/aggregates/jobs/{jobId}',
|
|
4028
|
+
'DELETE',
|
|
4029
|
+
{ 'jobId': jobId },
|
|
4030
|
+
{ },
|
|
4031
|
+
{ },
|
|
4032
|
+
{ },
|
|
4033
|
+
null,
|
|
4034
|
+
['PureCloud OAuth'],
|
|
4035
|
+
['application/json'],
|
|
4036
|
+
['application/json']
|
|
4037
|
+
);
|
|
4038
|
+
}
|
|
4039
|
+
|
|
4040
|
+
/**
|
|
4041
|
+
* Delete/cancel an async request for task management aggregates
|
|
4042
|
+
*
|
|
4043
|
+
* @param {String} jobId jobId
|
|
4044
|
+
* deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4045
|
+
*/
|
|
4046
|
+
deleteAnalyticsTaskmanagementAggregatesJob(jobId) {
|
|
4047
|
+
// verify the required parameter 'jobId' is set
|
|
4048
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4049
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTaskmanagementAggregatesJob';
|
|
4050
|
+
}
|
|
4051
|
+
|
|
4052
|
+
return this.apiClient.callApi(
|
|
4053
|
+
'/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}',
|
|
4054
|
+
'DELETE',
|
|
4055
|
+
{ 'jobId': jobId },
|
|
4056
|
+
{ },
|
|
4057
|
+
{ },
|
|
4058
|
+
{ },
|
|
4059
|
+
null,
|
|
4060
|
+
['PureCloud OAuth'],
|
|
4061
|
+
['application/json'],
|
|
4062
|
+
['application/json']
|
|
4063
|
+
);
|
|
4064
|
+
}
|
|
4065
|
+
|
|
4066
|
+
/**
|
|
4067
|
+
* Delete/cancel an async request for transcript aggregates
|
|
4068
|
+
*
|
|
4069
|
+
* @param {String} jobId jobId
|
|
4070
|
+
* deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4071
|
+
*/
|
|
4072
|
+
deleteAnalyticsTranscriptsAggregatesJob(jobId) {
|
|
4073
|
+
// verify the required parameter 'jobId' is set
|
|
4074
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4075
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTranscriptsAggregatesJob';
|
|
4076
|
+
}
|
|
4077
|
+
|
|
4078
|
+
return this.apiClient.callApi(
|
|
4079
|
+
'/api/v2/analytics/transcripts/aggregates/jobs/{jobId}',
|
|
4080
|
+
'DELETE',
|
|
4081
|
+
{ 'jobId': jobId },
|
|
4082
|
+
{ },
|
|
4083
|
+
{ },
|
|
4084
|
+
{ },
|
|
4085
|
+
null,
|
|
4086
|
+
['PureCloud OAuth'],
|
|
4087
|
+
['application/json'],
|
|
4088
|
+
['application/json']
|
|
4089
|
+
);
|
|
4090
|
+
}
|
|
4091
|
+
|
|
4092
|
+
/**
|
|
4093
|
+
* Delete/cancel an async request for user aggregates
|
|
4094
|
+
*
|
|
4095
|
+
* @param {String} jobId jobId
|
|
4096
|
+
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4097
|
+
*/
|
|
4098
|
+
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
4099
|
+
// verify the required parameter 'jobId' is set
|
|
4100
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
4101
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
4102
|
+
}
|
|
4103
|
+
|
|
4104
|
+
return this.apiClient.callApi(
|
|
4105
|
+
'/api/v2/analytics/users/aggregates/jobs/{jobId}',
|
|
4106
|
+
'DELETE',
|
|
4107
|
+
{ 'jobId': jobId },
|
|
4108
|
+
{ },
|
|
4109
|
+
{ },
|
|
4110
|
+
{ },
|
|
4111
|
+
null,
|
|
4112
|
+
['PureCloud OAuth'],
|
|
4113
|
+
['application/json'],
|
|
4114
|
+
['application/json']
|
|
4115
|
+
);
|
|
4116
|
+
}
|
|
4117
|
+
|
|
3697
4118
|
/**
|
|
3698
4119
|
* Delete/cancel an async request
|
|
3699
4120
|
*
|
|
@@ -5488,31 +5909,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5488
5909
|
);
|
|
5489
5910
|
}
|
|
5490
5911
|
|
|
5491
|
-
/**
|
|
5492
|
-
* Search resources.
|
|
5493
|
-
*
|
|
5494
|
-
* @param {Object} body Search request options
|
|
5495
|
-
*/
|
|
5496
|
-
postAnalyticsConversationsTranscriptsQuery(body) {
|
|
5497
|
-
// verify the required parameter 'body' is set
|
|
5498
|
-
if (body === undefined || body === null) {
|
|
5499
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';
|
|
5500
|
-
}
|
|
5501
|
-
|
|
5502
|
-
return this.apiClient.callApi(
|
|
5503
|
-
'/api/v2/analytics/conversations/transcripts/query',
|
|
5504
|
-
'POST',
|
|
5505
|
-
{ },
|
|
5506
|
-
{ },
|
|
5507
|
-
{ },
|
|
5508
|
-
{ },
|
|
5509
|
-
body,
|
|
5510
|
-
['PureCloud OAuth'],
|
|
5511
|
-
['application/json'],
|
|
5512
|
-
['application/json']
|
|
5513
|
-
);
|
|
5514
|
-
}
|
|
5515
|
-
|
|
5516
5912
|
/**
|
|
5517
5913
|
* Query for evaluation aggregates asynchronously
|
|
5518
5914
|
*
|
|
@@ -6475,7 +6871,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6475
6871
|
/**
|
|
6476
6872
|
* Architect service.
|
|
6477
6873
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
6478
|
-
* @version
|
|
6874
|
+
* @version 229.0.0
|
|
6479
6875
|
*/
|
|
6480
6876
|
|
|
6481
6877
|
/**
|
|
@@ -10770,7 +11166,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10770
11166
|
/**
|
|
10771
11167
|
* Audit service.
|
|
10772
11168
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
10773
|
-
* @version
|
|
11169
|
+
* @version 229.0.0
|
|
10774
11170
|
*/
|
|
10775
11171
|
|
|
10776
11172
|
/**
|
|
@@ -10971,7 +11367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
10971
11367
|
/**
|
|
10972
11368
|
* Authorization service.
|
|
10973
11369
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
10974
|
-
* @version
|
|
11370
|
+
* @version 229.0.0
|
|
10975
11371
|
*/
|
|
10976
11372
|
|
|
10977
11373
|
/**
|
|
@@ -12686,7 +13082,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12686
13082
|
/**
|
|
12687
13083
|
* Billing service.
|
|
12688
13084
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
12689
|
-
* @version
|
|
13085
|
+
* @version 229.0.0
|
|
12690
13086
|
*/
|
|
12691
13087
|
|
|
12692
13088
|
/**
|
|
@@ -12942,7 +13338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
12942
13338
|
/**
|
|
12943
13339
|
* BusinessRules service.
|
|
12944
13340
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
12945
|
-
* @version
|
|
13341
|
+
* @version 229.0.0
|
|
12946
13342
|
*/
|
|
12947
13343
|
|
|
12948
13344
|
/**
|
|
@@ -13216,7 +13612,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13216
13612
|
* @param {Object} opts Optional parameters
|
|
13217
13613
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13218
13614
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
13219
|
-
* @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.
|
|
13220
13615
|
* getBusinessrulesDecisiontableVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13221
13616
|
*/
|
|
13222
13617
|
getBusinessrulesDecisiontableVersions(tableId, opts) {
|
|
@@ -13231,7 +13626,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13231
13626
|
'/api/v2/businessrules/decisiontables/{tableId}/versions',
|
|
13232
13627
|
'GET',
|
|
13233
13628
|
{ 'tableId': tableId },
|
|
13234
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize']
|
|
13629
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
13235
13630
|
{ },
|
|
13236
13631
|
{ },
|
|
13237
13632
|
null,
|
|
@@ -13248,6 +13643,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13248
13643
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
13249
13644
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
13250
13645
|
* @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.
|
|
13646
|
+
* @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.
|
|
13251
13647
|
* getBusinessrulesDecisiontables is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13252
13648
|
*/
|
|
13253
13649
|
getBusinessrulesDecisiontables(opts) {
|
|
@@ -13258,7 +13654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13258
13654
|
'/api/v2/businessrules/decisiontables',
|
|
13259
13655
|
'GET',
|
|
13260
13656
|
{ },
|
|
13261
|
-
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi') },
|
|
13657
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'],'divisionIds': this.apiClient.buildCollectionParam(opts['divisionIds'], 'multi'),'name': opts['name'] },
|
|
13262
13658
|
{ },
|
|
13263
13659
|
{ },
|
|
13264
13660
|
null,
|
|
@@ -13460,48 +13856,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13460
13856
|
);
|
|
13461
13857
|
}
|
|
13462
13858
|
|
|
13463
|
-
/**
|
|
13464
|
-
* Partially update a decision table row. Will be deprecated, we should use PUT request.
|
|
13465
|
-
*
|
|
13466
|
-
* @param {String} tableId Table ID
|
|
13467
|
-
* @param {Number} tableVersion Table Version
|
|
13468
|
-
* @param {String} rowId Row ID
|
|
13469
|
-
* @param {Object} body Partially update decision table row request
|
|
13470
|
-
* @deprecated
|
|
13471
|
-
* patchBusinessrulesDecisiontableVersionRow is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
13472
|
-
*/
|
|
13473
|
-
patchBusinessrulesDecisiontableVersionRow(tableId, tableVersion, rowId, body) {
|
|
13474
|
-
// verify the required parameter 'tableId' is set
|
|
13475
|
-
if (tableId === undefined || tableId === null || tableId === '') {
|
|
13476
|
-
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13477
|
-
}
|
|
13478
|
-
// verify the required parameter 'tableVersion' is set
|
|
13479
|
-
if (tableVersion === undefined || tableVersion === null) {
|
|
13480
|
-
throw 'Missing the required parameter "tableVersion" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13481
|
-
}
|
|
13482
|
-
// verify the required parameter 'rowId' is set
|
|
13483
|
-
if (rowId === undefined || rowId === null || rowId === '') {
|
|
13484
|
-
throw 'Missing the required parameter "rowId" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13485
|
-
}
|
|
13486
|
-
// verify the required parameter 'body' is set
|
|
13487
|
-
if (body === undefined || body === null) {
|
|
13488
|
-
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableVersionRow';
|
|
13489
|
-
}
|
|
13490
|
-
|
|
13491
|
-
return this.apiClient.callApi(
|
|
13492
|
-
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/{rowId}',
|
|
13493
|
-
'PATCH',
|
|
13494
|
-
{ 'tableId': tableId,'tableVersion': tableVersion,'rowId': rowId },
|
|
13495
|
-
{ },
|
|
13496
|
-
{ },
|
|
13497
|
-
{ },
|
|
13498
|
-
body,
|
|
13499
|
-
['PureCloud OAuth'],
|
|
13500
|
-
['application/json'],
|
|
13501
|
-
['application/json']
|
|
13502
|
-
);
|
|
13503
|
-
}
|
|
13504
|
-
|
|
13505
13859
|
/**
|
|
13506
13860
|
* Execute a published decision table
|
|
13507
13861
|
*
|
|
@@ -13900,7 +14254,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13900
14254
|
/**
|
|
13901
14255
|
* CarrierServices service.
|
|
13902
14256
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
13903
|
-
* @version
|
|
14257
|
+
* @version 229.0.0
|
|
13904
14258
|
*/
|
|
13905
14259
|
|
|
13906
14260
|
/**
|
|
@@ -13970,7 +14324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13970
14324
|
/**
|
|
13971
14325
|
* Chat service.
|
|
13972
14326
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
13973
|
-
* @version
|
|
14327
|
+
* @version 229.0.0
|
|
13974
14328
|
*/
|
|
13975
14329
|
|
|
13976
14330
|
/**
|
|
@@ -14243,6 +14597,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14243
14597
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
14244
14598
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
14245
14599
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
14600
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
14246
14601
|
*/
|
|
14247
14602
|
getChatsRoomMessages(roomJid, opts) {
|
|
14248
14603
|
opts = opts || {};
|
|
@@ -14256,7 +14611,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14256
14611
|
'/api/v2/chats/rooms/{roomJid}/messages',
|
|
14257
14612
|
'GET',
|
|
14258
14613
|
{ 'roomJid': roomJid },
|
|
14259
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
14614
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
14260
14615
|
{ },
|
|
14261
14616
|
{ },
|
|
14262
14617
|
null,
|
|
@@ -14353,6 +14708,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14353
14708
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
14354
14709
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
14355
14710
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
14711
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
14356
14712
|
*/
|
|
14357
14713
|
getChatsThreadMessages(threadId, opts) {
|
|
14358
14714
|
opts = opts || {};
|
|
@@ -14366,7 +14722,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14366
14722
|
'/api/v2/chats/threads/{threadId}/messages',
|
|
14367
14723
|
'GET',
|
|
14368
14724
|
{ 'threadId': threadId },
|
|
14369
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
14725
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
14370
14726
|
{ },
|
|
14371
14727
|
{ },
|
|
14372
14728
|
null,
|
|
@@ -14439,6 +14795,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14439
14795
|
* @param {String} opts.limit The maximum number of messages to retrieve
|
|
14440
14796
|
* @param {String} opts.before The cutoff date for messages to retrieve
|
|
14441
14797
|
* @param {String} opts.after The beginning date for messages to retrieve
|
|
14798
|
+
* @param {Boolean} opts.excludeMetadata Whether to exclude metadata for messages
|
|
14442
14799
|
*/
|
|
14443
14800
|
getChatsUserMessages(userId, opts) {
|
|
14444
14801
|
opts = opts || {};
|
|
@@ -14452,7 +14809,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14452
14809
|
'/api/v2/chats/users/{userId}/messages',
|
|
14453
14810
|
'GET',
|
|
14454
14811
|
{ 'userId': userId },
|
|
14455
|
-
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'] },
|
|
14812
|
+
{ 'limit': opts['limit'],'before': opts['before'],'after': opts['after'],'excludeMetadata': opts['excludeMetadata'] },
|
|
14456
14813
|
{ },
|
|
14457
14814
|
{ },
|
|
14458
14815
|
null,
|
|
@@ -14948,7 +15305,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14948
15305
|
/**
|
|
14949
15306
|
* Coaching service.
|
|
14950
15307
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
14951
|
-
* @version
|
|
15308
|
+
* @version 229.0.0
|
|
14952
15309
|
*/
|
|
14953
15310
|
|
|
14954
15311
|
/**
|
|
@@ -15525,7 +15882,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
15525
15882
|
/**
|
|
15526
15883
|
* ContentManagement service.
|
|
15527
15884
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
15528
|
-
* @version
|
|
15885
|
+
* @version 229.0.0
|
|
15529
15886
|
*/
|
|
15530
15887
|
|
|
15531
15888
|
/**
|
|
@@ -16606,7 +16963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16606
16963
|
/**
|
|
16607
16964
|
* Conversations service.
|
|
16608
16965
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
16609
|
-
* @version
|
|
16966
|
+
* @version 229.0.0
|
|
16610
16967
|
*/
|
|
16611
16968
|
|
|
16612
16969
|
/**
|
|
@@ -16621,6 +16978,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16621
16978
|
}
|
|
16622
16979
|
|
|
16623
16980
|
|
|
16981
|
+
/**
|
|
16982
|
+
* Delete/cancel an async request for conversation aggregates
|
|
16983
|
+
*
|
|
16984
|
+
* @param {String} jobId jobId
|
|
16985
|
+
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
16986
|
+
*/
|
|
16987
|
+
deleteAnalyticsConversationsAggregatesJob(jobId) {
|
|
16988
|
+
// verify the required parameter 'jobId' is set
|
|
16989
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
16990
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';
|
|
16991
|
+
}
|
|
16992
|
+
|
|
16993
|
+
return this.apiClient.callApi(
|
|
16994
|
+
'/api/v2/analytics/conversations/aggregates/jobs/{jobId}',
|
|
16995
|
+
'DELETE',
|
|
16996
|
+
{ 'jobId': jobId },
|
|
16997
|
+
{ },
|
|
16998
|
+
{ },
|
|
16999
|
+
{ },
|
|
17000
|
+
null,
|
|
17001
|
+
['PureCloud OAuth'],
|
|
17002
|
+
['application/json'],
|
|
17003
|
+
['application/json']
|
|
17004
|
+
);
|
|
17005
|
+
}
|
|
17006
|
+
|
|
16624
17007
|
/**
|
|
16625
17008
|
* Delete/cancel an async details job
|
|
16626
17009
|
*
|
|
@@ -17879,7 +18262,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17879
18262
|
|
|
17880
18263
|
/**
|
|
17881
18264
|
* Get chat conversation
|
|
17882
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18265
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17883
18266
|
* @param {String} conversationId conversationId
|
|
17884
18267
|
* @deprecated
|
|
17885
18268
|
*/
|
|
@@ -17905,7 +18288,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17905
18288
|
|
|
17906
18289
|
/**
|
|
17907
18290
|
* Get a web chat conversation message
|
|
17908
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18291
|
+
* 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.
|
|
17909
18292
|
* @param {String} conversationId conversationId
|
|
17910
18293
|
* @param {String} messageId messageId
|
|
17911
18294
|
* @deprecated
|
|
@@ -17936,7 +18319,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17936
18319
|
|
|
17937
18320
|
/**
|
|
17938
18321
|
* Get the messages of a chat conversation.
|
|
17939
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18322
|
+
* 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.
|
|
17940
18323
|
* @param {String} conversationId conversationId
|
|
17941
18324
|
* @param {Object} opts Optional parameters
|
|
17942
18325
|
* @param {String} opts.after If specified, get the messages chronologically after the id of this message
|
|
@@ -17969,7 +18352,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17969
18352
|
|
|
17970
18353
|
/**
|
|
17971
18354
|
* Get the wrap-up for this conversation communication.
|
|
17972
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18355
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
17973
18356
|
* @param {String} conversationId conversationId
|
|
17974
18357
|
* @param {String} participantId participantId
|
|
17975
18358
|
* @param {String} communicationId communicationId
|
|
@@ -18009,7 +18392,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18009
18392
|
|
|
18010
18393
|
/**
|
|
18011
18394
|
* Get the wrap-up for this conversation participant.
|
|
18012
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18395
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
18013
18396
|
* @param {String} conversationId conversationId
|
|
18014
18397
|
* @param {String} participantId participantId
|
|
18015
18398
|
* @param {Object} opts Optional parameters
|
|
@@ -18044,7 +18427,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18044
18427
|
|
|
18045
18428
|
/**
|
|
18046
18429
|
* Get list of wrapup codes for this conversation participant
|
|
18047
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18430
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
18048
18431
|
* @param {String} conversationId conversationId
|
|
18049
18432
|
* @param {String} participantId participantId
|
|
18050
18433
|
* @deprecated
|
|
@@ -18075,7 +18458,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18075
18458
|
|
|
18076
18459
|
/**
|
|
18077
18460
|
* Get active chat conversations for the logged in user
|
|
18078
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18461
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
18079
18462
|
* @deprecated
|
|
18080
18463
|
*/
|
|
18081
18464
|
getConversationsChats() {
|
|
@@ -18121,7 +18504,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18121
18504
|
|
|
18122
18505
|
/**
|
|
18123
18506
|
* Get the wrap-up for this conversation communication.
|
|
18124
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18507
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18125
18508
|
* @param {String} conversationId conversationId
|
|
18126
18509
|
* @param {String} participantId participantId
|
|
18127
18510
|
* @param {String} communicationId communicationId
|
|
@@ -18161,7 +18544,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18161
18544
|
|
|
18162
18545
|
/**
|
|
18163
18546
|
* Get the wrap-up for this conversation participant.
|
|
18164
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18547
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18165
18548
|
* @param {String} conversationId conversationId
|
|
18166
18549
|
* @param {String} participantId participantId
|
|
18167
18550
|
* @param {Object} opts Optional parameters
|
|
@@ -18196,7 +18579,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18196
18579
|
|
|
18197
18580
|
/**
|
|
18198
18581
|
* Get list of wrapup codes for this conversation participant
|
|
18199
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
18582
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
18200
18583
|
* @param {String} conversationId conversationId
|
|
18201
18584
|
* @param {String} participantId participantId
|
|
18202
18585
|
* @deprecated
|
|
@@ -19598,7 +19981,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
19598
19981
|
|
|
19599
19982
|
/**
|
|
19600
19983
|
* Get the wrap-up for this conversation communication.
|
|
19601
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
19984
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
19602
19985
|
* @param {String} conversationId conversationId
|
|
19603
19986
|
* @param {String} participantId participantId
|
|
19604
19987
|
* @param {String} communicationId communicationId
|
|
@@ -20125,7 +20508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20125
20508
|
}
|
|
20126
20509
|
|
|
20127
20510
|
/**
|
|
20128
|
-
* Update conversation participant's communication by disconnecting it.
|
|
20511
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20129
20512
|
*
|
|
20130
20513
|
* @param {String} conversationId conversationId
|
|
20131
20514
|
* @param {String} participantId participantId
|
|
@@ -20366,7 +20749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20366
20749
|
|
|
20367
20750
|
/**
|
|
20368
20751
|
* Update a conversation by disconnecting all of the participants
|
|
20369
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20752
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20370
20753
|
* @param {String} conversationId conversationId
|
|
20371
20754
|
* @param {Object} body Conversation
|
|
20372
20755
|
* @deprecated
|
|
@@ -20397,7 +20780,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20397
20780
|
|
|
20398
20781
|
/**
|
|
20399
20782
|
* Update conversation participant
|
|
20400
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20783
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20401
20784
|
* @param {String} conversationId conversationId
|
|
20402
20785
|
* @param {String} participantId participantId
|
|
20403
20786
|
* @param {Object} body Update request
|
|
@@ -20433,7 +20816,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20433
20816
|
|
|
20434
20817
|
/**
|
|
20435
20818
|
* Update the attributes on a conversation participant.
|
|
20436
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20819
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20437
20820
|
* @param {String} conversationId conversationId
|
|
20438
20821
|
* @param {String} participantId participantId
|
|
20439
20822
|
* @param {Object} body Participant attributes
|
|
@@ -20468,8 +20851,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20468
20851
|
}
|
|
20469
20852
|
|
|
20470
20853
|
/**
|
|
20471
|
-
* Update conversation participant's communication by disconnecting it.
|
|
20472
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20854
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20855
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
20473
20856
|
* @param {String} conversationId conversationId
|
|
20474
20857
|
* @param {String} participantId participantId
|
|
20475
20858
|
* @param {String} communicationId communicationId
|
|
@@ -20510,7 +20893,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20510
20893
|
|
|
20511
20894
|
/**
|
|
20512
20895
|
* Update a conversation by disconnecting all of the participants
|
|
20513
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20896
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20514
20897
|
* @param {String} conversationId conversationId
|
|
20515
20898
|
* @param {Object} body Conversation
|
|
20516
20899
|
* @deprecated
|
|
@@ -20541,7 +20924,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20541
20924
|
|
|
20542
20925
|
/**
|
|
20543
20926
|
* Update conversation participant
|
|
20544
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20927
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20545
20928
|
* @param {String} conversationId conversationId
|
|
20546
20929
|
* @param {String} participantId participantId
|
|
20547
20930
|
* @param {Object} opts Optional parameters
|
|
@@ -20576,7 +20959,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20576
20959
|
|
|
20577
20960
|
/**
|
|
20578
20961
|
* Update the attributes on a conversation participant.
|
|
20579
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20962
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20580
20963
|
* @param {String} conversationId conversationId
|
|
20581
20964
|
* @param {String} participantId participantId
|
|
20582
20965
|
* @param {Object} opts Optional parameters
|
|
@@ -20611,7 +20994,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20611
20994
|
|
|
20612
20995
|
/**
|
|
20613
20996
|
* Update conversation participant's communication by disconnecting it.
|
|
20614
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
20997
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
20615
20998
|
* @param {String} conversationId conversationId
|
|
20616
20999
|
* @param {String} participantId participantId
|
|
20617
21000
|
* @param {String} communicationId communicationId
|
|
@@ -20782,7 +21165,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20782
21165
|
}
|
|
20783
21166
|
|
|
20784
21167
|
/**
|
|
20785
|
-
* Update conversation participant's communication by disconnecting it.
|
|
21168
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20786
21169
|
*
|
|
20787
21170
|
* @param {String} conversationId conversationId
|
|
20788
21171
|
* @param {String} participantId participantId
|
|
@@ -20955,7 +21338,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20955
21338
|
}
|
|
20956
21339
|
|
|
20957
21340
|
/**
|
|
20958
|
-
* Update conversation participant's communication by disconnecting it.
|
|
21341
|
+
* Update conversation participant's communication by disconnecting it. This endpoint does not update wrapup.
|
|
20959
21342
|
*
|
|
20960
21343
|
* @param {String} conversationId conversationId
|
|
20961
21344
|
* @param {String} participantId participantId
|
|
@@ -22623,7 +23006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22623
23006
|
|
|
22624
23007
|
/**
|
|
22625
23008
|
* Send a message on behalf of a communication in a chat conversation.
|
|
22626
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23009
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22627
23010
|
* @param {String} conversationId conversationId
|
|
22628
23011
|
* @param {String} communicationId communicationId
|
|
22629
23012
|
* @param {Object} body Message
|
|
@@ -22659,7 +23042,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22659
23042
|
|
|
22660
23043
|
/**
|
|
22661
23044
|
* Send a typing-indicator on behalf of a communication in a chat conversation.
|
|
22662
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23045
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22663
23046
|
* @param {String} conversationId conversationId
|
|
22664
23047
|
* @param {String} communicationId communicationId
|
|
22665
23048
|
* @deprecated
|
|
@@ -22690,7 +23073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22690
23073
|
|
|
22691
23074
|
/**
|
|
22692
23075
|
* Apply wrap-up for this conversation communication
|
|
22693
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23076
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22694
23077
|
* @param {String} conversationId conversationId
|
|
22695
23078
|
* @param {String} participantId participantId
|
|
22696
23079
|
* @param {String} communicationId communicationId
|
|
@@ -22730,7 +23113,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22730
23113
|
|
|
22731
23114
|
/**
|
|
22732
23115
|
* Replace this participant with the specified user and/or address
|
|
22733
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23116
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22734
23117
|
* @param {String} conversationId conversationId
|
|
22735
23118
|
* @param {String} participantId participantId
|
|
22736
23119
|
* @param {Object} body Transfer request
|
|
@@ -22766,7 +23149,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22766
23149
|
|
|
22767
23150
|
/**
|
|
22768
23151
|
* Create a web chat conversation
|
|
22769
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23152
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
22770
23153
|
* @param {Object} body Create web chat request
|
|
22771
23154
|
* @deprecated
|
|
22772
23155
|
*/
|
|
@@ -22792,7 +23175,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22792
23175
|
|
|
22793
23176
|
/**
|
|
22794
23177
|
* Apply wrap-up for this conversation communication
|
|
22795
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23178
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
22796
23179
|
* @param {String} conversationId conversationId
|
|
22797
23180
|
* @param {String} participantId participantId
|
|
22798
23181
|
* @param {String} communicationId communicationId
|
|
@@ -22832,7 +23215,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22832
23215
|
|
|
22833
23216
|
/**
|
|
22834
23217
|
* Replace this participant with the specified user and/or address
|
|
22835
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
23218
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
22836
23219
|
* @param {String} conversationId conversationId
|
|
22837
23220
|
* @param {String} participantId participantId
|
|
22838
23221
|
* @param {Object} opts Optional parameters
|
|
@@ -23920,7 +24303,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
23920
24303
|
|
|
23921
24304
|
/**
|
|
23922
24305
|
* Apply wrap-up for this conversation communication
|
|
23923
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
24306
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
23924
24307
|
* @param {String} conversationId conversationId
|
|
23925
24308
|
* @param {String} participantId participantId
|
|
23926
24309
|
* @param {String} communicationId communicationId
|
|
@@ -24285,7 +24668,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24285
24668
|
|
|
24286
24669
|
/**
|
|
24287
24670
|
* Update a conversation by setting its recording state
|
|
24288
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
24671
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
24289
24672
|
* @param {String} conversationId conversationId
|
|
24290
24673
|
* @param {Object} body SetRecordingState
|
|
24291
24674
|
* @deprecated
|
|
@@ -24316,7 +24699,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24316
24699
|
|
|
24317
24700
|
/**
|
|
24318
24701
|
* Update a conversation by setting its recording state
|
|
24319
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
24702
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
24320
24703
|
* @param {String} conversationId conversationId
|
|
24321
24704
|
* @param {Object} body SetRecordingState
|
|
24322
24705
|
* @deprecated
|
|
@@ -24723,7 +25106,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24723
25106
|
|
|
24724
25107
|
/**
|
|
24725
25108
|
* Update a conversation by setting its recording state
|
|
24726
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
25109
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
24727
25110
|
* @param {String} conversationId conversationId
|
|
24728
25111
|
* @param {Object} body SetRecordingState
|
|
24729
25112
|
* @deprecated
|
|
@@ -24818,7 +25201,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24818
25201
|
/**
|
|
24819
25202
|
* DataExtensions service.
|
|
24820
25203
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
24821
|
-
* @version
|
|
25204
|
+
* @version 229.0.0
|
|
24822
25205
|
*/
|
|
24823
25206
|
|
|
24824
25207
|
/**
|
|
@@ -24904,7 +25287,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
24904
25287
|
/**
|
|
24905
25288
|
* DataPrivacy service.
|
|
24906
25289
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
24907
|
-
* @version
|
|
25290
|
+
* @version 229.0.0
|
|
24908
25291
|
*/
|
|
24909
25292
|
|
|
24910
25293
|
/**
|
|
@@ -25074,7 +25457,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25074
25457
|
/**
|
|
25075
25458
|
* Downloads service.
|
|
25076
25459
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
25077
|
-
* @version
|
|
25460
|
+
* @version 229.0.0
|
|
25078
25461
|
*/
|
|
25079
25462
|
|
|
25080
25463
|
/**
|
|
@@ -25126,7 +25509,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25126
25509
|
/**
|
|
25127
25510
|
* Emails service.
|
|
25128
25511
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
25129
|
-
* @version
|
|
25512
|
+
* @version 229.0.0
|
|
25130
25513
|
*/
|
|
25131
25514
|
|
|
25132
25515
|
/**
|
|
@@ -25255,7 +25638,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25255
25638
|
/**
|
|
25256
25639
|
* EmployeeEngagement service.
|
|
25257
25640
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
25258
|
-
* @version
|
|
25641
|
+
* @version 229.0.0
|
|
25259
25642
|
*/
|
|
25260
25643
|
|
|
25261
25644
|
/**
|
|
@@ -25406,7 +25789,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25406
25789
|
/**
|
|
25407
25790
|
* Events service.
|
|
25408
25791
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
25409
|
-
* @version
|
|
25792
|
+
* @version 229.0.0
|
|
25410
25793
|
*/
|
|
25411
25794
|
|
|
25412
25795
|
/**
|
|
@@ -25502,7 +25885,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25502
25885
|
/**
|
|
25503
25886
|
* ExternalContacts service.
|
|
25504
25887
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
25505
|
-
* @version
|
|
25888
|
+
* @version 229.0.0
|
|
25506
25889
|
*/
|
|
25507
25890
|
|
|
25508
25891
|
/**
|
|
@@ -25831,6 +26214,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
25831
26214
|
);
|
|
25832
26215
|
}
|
|
25833
26216
|
|
|
26217
|
+
/**
|
|
26218
|
+
* Retrieve segment assignments by external contact ID.
|
|
26219
|
+
*
|
|
26220
|
+
* @param {String} contactId ExternalContact ID
|
|
26221
|
+
* @param {Object} opts Optional parameters
|
|
26222
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
|
|
26223
|
+
* @param {Number} opts.limit Number of entities to return. Default of 25, maximum of 500.
|
|
26224
|
+
*/
|
|
26225
|
+
getExternalcontactsContactJourneySegments(contactId, opts) {
|
|
26226
|
+
opts = opts || {};
|
|
26227
|
+
|
|
26228
|
+
// verify the required parameter 'contactId' is set
|
|
26229
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
26230
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySegments';
|
|
26231
|
+
}
|
|
26232
|
+
|
|
26233
|
+
return this.apiClient.callApi(
|
|
26234
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
26235
|
+
'GET',
|
|
26236
|
+
{ 'contactId': contactId },
|
|
26237
|
+
{ 'includeMerged': opts['includeMerged'],'limit': opts['limit'] },
|
|
26238
|
+
{ },
|
|
26239
|
+
{ },
|
|
26240
|
+
null,
|
|
26241
|
+
['PureCloud OAuth'],
|
|
26242
|
+
['application/json'],
|
|
26243
|
+
['application/json']
|
|
26244
|
+
);
|
|
26245
|
+
}
|
|
26246
|
+
|
|
25834
26247
|
/**
|
|
25835
26248
|
* Retrieve all sessions for a given external contact.
|
|
25836
26249
|
*
|
|
@@ -27702,6 +28115,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
27702
28115
|
);
|
|
27703
28116
|
}
|
|
27704
28117
|
|
|
28118
|
+
/**
|
|
28119
|
+
* 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.
|
|
28120
|
+
*
|
|
28121
|
+
* @param {String} contactId ExternalContact ID
|
|
28122
|
+
* @param {Object} opts Optional parameters
|
|
28123
|
+
* @param {Object} opts.body
|
|
28124
|
+
*/
|
|
28125
|
+
postExternalcontactsContactJourneySegments(contactId, opts) {
|
|
28126
|
+
opts = opts || {};
|
|
28127
|
+
|
|
28128
|
+
// verify the required parameter 'contactId' is set
|
|
28129
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
28130
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactJourneySegments';
|
|
28131
|
+
}
|
|
28132
|
+
|
|
28133
|
+
return this.apiClient.callApi(
|
|
28134
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
28135
|
+
'POST',
|
|
28136
|
+
{ 'contactId': contactId },
|
|
28137
|
+
{ },
|
|
28138
|
+
{ },
|
|
28139
|
+
{ },
|
|
28140
|
+
opts['body'],
|
|
28141
|
+
['PureCloud OAuth'],
|
|
28142
|
+
['application/json'],
|
|
28143
|
+
['application/json']
|
|
28144
|
+
);
|
|
28145
|
+
}
|
|
28146
|
+
|
|
27705
28147
|
/**
|
|
27706
28148
|
* Create a note for an external contact
|
|
27707
28149
|
*
|
|
@@ -28690,7 +29132,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28690
29132
|
/**
|
|
28691
29133
|
* Fax service.
|
|
28692
29134
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
28693
|
-
* @version
|
|
29135
|
+
* @version 229.0.0
|
|
28694
29136
|
*/
|
|
28695
29137
|
|
|
28696
29138
|
/**
|
|
@@ -28905,7 +29347,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28905
29347
|
/**
|
|
28906
29348
|
* Flows service.
|
|
28907
29349
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
28908
|
-
* @version
|
|
29350
|
+
* @version 229.0.0
|
|
28909
29351
|
*/
|
|
28910
29352
|
|
|
28911
29353
|
/**
|
|
@@ -28920,6 +29362,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28920
29362
|
}
|
|
28921
29363
|
|
|
28922
29364
|
|
|
29365
|
+
/**
|
|
29366
|
+
* Delete/cancel an async request for flow aggregates
|
|
29367
|
+
*
|
|
29368
|
+
* @param {String} jobId jobId
|
|
29369
|
+
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
29370
|
+
*/
|
|
29371
|
+
deleteAnalyticsFlowsAggregatesJob(jobId) {
|
|
29372
|
+
// verify the required parameter 'jobId' is set
|
|
29373
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
29374
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';
|
|
29375
|
+
}
|
|
29376
|
+
|
|
29377
|
+
return this.apiClient.callApi(
|
|
29378
|
+
'/api/v2/analytics/flows/aggregates/jobs/{jobId}',
|
|
29379
|
+
'DELETE',
|
|
29380
|
+
{ 'jobId': jobId },
|
|
29381
|
+
{ },
|
|
29382
|
+
{ },
|
|
29383
|
+
{ },
|
|
29384
|
+
null,
|
|
29385
|
+
['PureCloud OAuth'],
|
|
29386
|
+
['application/json'],
|
|
29387
|
+
['application/json']
|
|
29388
|
+
);
|
|
29389
|
+
}
|
|
29390
|
+
|
|
28923
29391
|
/**
|
|
28924
29392
|
* Get status for async query for Flow aggregates
|
|
28925
29393
|
*
|
|
@@ -29088,7 +29556,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
29088
29556
|
/**
|
|
29089
29557
|
* Gamification service.
|
|
29090
29558
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
29091
|
-
* @version
|
|
29559
|
+
* @version 229.0.0
|
|
29092
29560
|
*/
|
|
29093
29561
|
|
|
29094
29562
|
/**
|
|
@@ -31595,7 +32063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31595
32063
|
/**
|
|
31596
32064
|
* GeneralDataProtectionRegulation service.
|
|
31597
32065
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
31598
|
-
* @version
|
|
32066
|
+
* @version 229.0.0
|
|
31599
32067
|
*/
|
|
31600
32068
|
|
|
31601
32069
|
/**
|
|
@@ -31725,7 +32193,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31725
32193
|
/**
|
|
31726
32194
|
* Geolocation service.
|
|
31727
32195
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
31728
|
-
* @version
|
|
32196
|
+
* @version 229.0.0
|
|
31729
32197
|
*/
|
|
31730
32198
|
|
|
31731
32199
|
/**
|
|
@@ -31856,7 +32324,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31856
32324
|
/**
|
|
31857
32325
|
* Greetings service.
|
|
31858
32326
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
31859
|
-
* @version
|
|
32327
|
+
* @version 229.0.0
|
|
31860
32328
|
*/
|
|
31861
32329
|
|
|
31862
32330
|
/**
|
|
@@ -32398,7 +32866,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32398
32866
|
/**
|
|
32399
32867
|
* Groups service.
|
|
32400
32868
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
32401
|
-
* @version
|
|
32869
|
+
* @version 229.0.0
|
|
32402
32870
|
*/
|
|
32403
32871
|
|
|
32404
32872
|
/**
|
|
@@ -32917,7 +33385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
32917
33385
|
/**
|
|
32918
33386
|
* IdentityProvider service.
|
|
32919
33387
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
32920
|
-
* @version
|
|
33388
|
+
* @version 229.0.0
|
|
32921
33389
|
*/
|
|
32922
33390
|
|
|
32923
33391
|
/**
|
|
@@ -33778,7 +34246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33778
34246
|
/**
|
|
33779
34247
|
* InfrastructureAsCode service.
|
|
33780
34248
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
33781
|
-
* @version
|
|
34249
|
+
* @version 229.0.0
|
|
33782
34250
|
*/
|
|
33783
34251
|
|
|
33784
34252
|
/**
|
|
@@ -33945,7 +34413,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33945
34413
|
/**
|
|
33946
34414
|
* Integrations service.
|
|
33947
34415
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
33948
|
-
* @version
|
|
34416
|
+
* @version 229.0.0
|
|
33949
34417
|
*/
|
|
33950
34418
|
|
|
33951
34419
|
/**
|
|
@@ -36590,7 +37058,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36590
37058
|
/**
|
|
36591
37059
|
* Journey service.
|
|
36592
37060
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
36593
|
-
* @version
|
|
37061
|
+
* @version 229.0.0
|
|
36594
37062
|
*/
|
|
36595
37063
|
|
|
36596
37064
|
/**
|
|
@@ -36605,6 +37073,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36605
37073
|
}
|
|
36606
37074
|
|
|
36607
37075
|
|
|
37076
|
+
/**
|
|
37077
|
+
* Delete/cancel an async request for journey aggregates
|
|
37078
|
+
*
|
|
37079
|
+
* @param {String} jobId jobId
|
|
37080
|
+
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37081
|
+
*/
|
|
37082
|
+
deleteAnalyticsJourneysAggregatesJob(jobId) {
|
|
37083
|
+
// verify the required parameter 'jobId' is set
|
|
37084
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
37085
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';
|
|
37086
|
+
}
|
|
37087
|
+
|
|
37088
|
+
return this.apiClient.callApi(
|
|
37089
|
+
'/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
|
|
37090
|
+
'DELETE',
|
|
37091
|
+
{ 'jobId': jobId },
|
|
37092
|
+
{ },
|
|
37093
|
+
{ },
|
|
37094
|
+
{ },
|
|
37095
|
+
null,
|
|
37096
|
+
['PureCloud OAuth'],
|
|
37097
|
+
['application/json'],
|
|
37098
|
+
['application/json']
|
|
37099
|
+
);
|
|
37100
|
+
}
|
|
37101
|
+
|
|
36608
37102
|
/**
|
|
36609
37103
|
* Delete single action map.
|
|
36610
37104
|
*
|
|
@@ -36840,6 +37334,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
36840
37334
|
);
|
|
36841
37335
|
}
|
|
36842
37336
|
|
|
37337
|
+
/**
|
|
37338
|
+
* Retrieve segment assignments by external contact ID.
|
|
37339
|
+
*
|
|
37340
|
+
* @param {String} contactId ExternalContact ID
|
|
37341
|
+
* @param {Object} opts Optional parameters
|
|
37342
|
+
* @param {Boolean} opts.includeMerged Indicates whether to return segment assignments from all external contacts in the merge-set of the given one.
|
|
37343
|
+
* @param {Number} opts.limit Number of entities to return. Default of 25, maximum of 500.
|
|
37344
|
+
*/
|
|
37345
|
+
getExternalcontactsContactJourneySegments(contactId, opts) {
|
|
37346
|
+
opts = opts || {};
|
|
37347
|
+
|
|
37348
|
+
// verify the required parameter 'contactId' is set
|
|
37349
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
37350
|
+
throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySegments';
|
|
37351
|
+
}
|
|
37352
|
+
|
|
37353
|
+
return this.apiClient.callApi(
|
|
37354
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
37355
|
+
'GET',
|
|
37356
|
+
{ 'contactId': contactId },
|
|
37357
|
+
{ 'includeMerged': opts['includeMerged'],'limit': opts['limit'] },
|
|
37358
|
+
{ },
|
|
37359
|
+
{ },
|
|
37360
|
+
null,
|
|
37361
|
+
['PureCloud OAuth'],
|
|
37362
|
+
['application/json'],
|
|
37363
|
+
['application/json']
|
|
37364
|
+
);
|
|
37365
|
+
}
|
|
37366
|
+
|
|
36843
37367
|
/**
|
|
36844
37368
|
* Retrieve all sessions for a given external contact.
|
|
36845
37369
|
*
|
|
@@ -38083,6 +38607,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38083
38607
|
);
|
|
38084
38608
|
}
|
|
38085
38609
|
|
|
38610
|
+
/**
|
|
38611
|
+
* 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.
|
|
38612
|
+
*
|
|
38613
|
+
* @param {String} contactId ExternalContact ID
|
|
38614
|
+
* @param {Object} opts Optional parameters
|
|
38615
|
+
* @param {Object} opts.body
|
|
38616
|
+
*/
|
|
38617
|
+
postExternalcontactsContactJourneySegments(contactId, opts) {
|
|
38618
|
+
opts = opts || {};
|
|
38619
|
+
|
|
38620
|
+
// verify the required parameter 'contactId' is set
|
|
38621
|
+
if (contactId === undefined || contactId === null || contactId === '') {
|
|
38622
|
+
throw 'Missing the required parameter "contactId" when calling postExternalcontactsContactJourneySegments';
|
|
38623
|
+
}
|
|
38624
|
+
|
|
38625
|
+
return this.apiClient.callApi(
|
|
38626
|
+
'/api/v2/externalcontacts/contacts/{contactId}/journey/segments',
|
|
38627
|
+
'POST',
|
|
38628
|
+
{ 'contactId': contactId },
|
|
38629
|
+
{ },
|
|
38630
|
+
{ },
|
|
38631
|
+
{ },
|
|
38632
|
+
opts['body'],
|
|
38633
|
+
['PureCloud OAuth'],
|
|
38634
|
+
['application/json'],
|
|
38635
|
+
['application/json']
|
|
38636
|
+
);
|
|
38637
|
+
}
|
|
38638
|
+
|
|
38086
38639
|
/**
|
|
38087
38640
|
* Create an action map.
|
|
38088
38641
|
*
|
|
@@ -38575,7 +39128,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38575
39128
|
/**
|
|
38576
39129
|
* Knowledge service.
|
|
38577
39130
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
38578
|
-
* @version
|
|
39131
|
+
* @version 229.0.0
|
|
38579
39132
|
*/
|
|
38580
39133
|
|
|
38581
39134
|
/**
|
|
@@ -41318,6 +41871,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41318
41871
|
);
|
|
41319
41872
|
}
|
|
41320
41873
|
|
|
41874
|
+
/**
|
|
41875
|
+
* Search for chunks in a knowledge base
|
|
41876
|
+
*
|
|
41877
|
+
* @param {String} knowledgeBaseId Knowledge Base ID
|
|
41878
|
+
* @param {Object} opts Optional parameters
|
|
41879
|
+
* @param {Object} opts.body
|
|
41880
|
+
*/
|
|
41881
|
+
postKnowledgeKnowledgebaseChunksSearch(knowledgeBaseId, opts) {
|
|
41882
|
+
opts = opts || {};
|
|
41883
|
+
|
|
41884
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
41885
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
41886
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseChunksSearch';
|
|
41887
|
+
}
|
|
41888
|
+
|
|
41889
|
+
return this.apiClient.callApi(
|
|
41890
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/chunks/search',
|
|
41891
|
+
'POST',
|
|
41892
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
41893
|
+
{ },
|
|
41894
|
+
{ },
|
|
41895
|
+
{ },
|
|
41896
|
+
opts['body'],
|
|
41897
|
+
['PureCloud OAuth'],
|
|
41898
|
+
['application/json'],
|
|
41899
|
+
['application/json']
|
|
41900
|
+
);
|
|
41901
|
+
}
|
|
41902
|
+
|
|
41321
41903
|
/**
|
|
41322
41904
|
* Indicate that the document was copied by the user.
|
|
41323
41905
|
*
|
|
@@ -42448,7 +43030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42448
43030
|
/**
|
|
42449
43031
|
* LanguageUnderstanding service.
|
|
42450
43032
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
42451
|
-
* @version
|
|
43033
|
+
* @version 229.0.0
|
|
42452
43034
|
*/
|
|
42453
43035
|
|
|
42454
43036
|
/**
|
|
@@ -43481,7 +44063,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43481
44063
|
/**
|
|
43482
44064
|
* Languages service.
|
|
43483
44065
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
43484
|
-
* @version
|
|
44066
|
+
* @version 229.0.0
|
|
43485
44067
|
*/
|
|
43486
44068
|
|
|
43487
44069
|
/**
|
|
@@ -43703,7 +44285,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43703
44285
|
/**
|
|
43704
44286
|
* Learning service.
|
|
43705
44287
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
43706
|
-
* @version
|
|
44288
|
+
* @version 229.0.0
|
|
43707
44289
|
*/
|
|
43708
44290
|
|
|
43709
44291
|
/**
|
|
@@ -44732,7 +45314,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44732
45314
|
/**
|
|
44733
45315
|
* License service.
|
|
44734
45316
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
44735
|
-
* @version
|
|
45317
|
+
* @version 229.0.0
|
|
44736
45318
|
*/
|
|
44737
45319
|
|
|
44738
45320
|
/**
|
|
@@ -44970,7 +45552,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
44970
45552
|
/**
|
|
44971
45553
|
* Locations service.
|
|
44972
45554
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
44973
|
-
* @version
|
|
45555
|
+
* @version 229.0.0
|
|
44974
45556
|
*/
|
|
44975
45557
|
|
|
44976
45558
|
/**
|
|
@@ -45206,7 +45788,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45206
45788
|
/**
|
|
45207
45789
|
* LogCapture service.
|
|
45208
45790
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
45209
|
-
* @version
|
|
45791
|
+
* @version 229.0.0
|
|
45210
45792
|
*/
|
|
45211
45793
|
|
|
45212
45794
|
/**
|
|
@@ -45405,7 +45987,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45405
45987
|
/**
|
|
45406
45988
|
* Messaging service.
|
|
45407
45989
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
45408
|
-
* @version
|
|
45990
|
+
* @version 229.0.0
|
|
45409
45991
|
*/
|
|
45410
45992
|
|
|
45411
45993
|
/**
|
|
@@ -45764,7 +46346,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45764
46346
|
/**
|
|
45765
46347
|
* MobileDevices service.
|
|
45766
46348
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
45767
|
-
* @version
|
|
46349
|
+
* @version 229.0.0
|
|
45768
46350
|
*/
|
|
45769
46351
|
|
|
45770
46352
|
/**
|
|
@@ -45915,7 +46497,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
45915
46497
|
/**
|
|
45916
46498
|
* Notifications service.
|
|
45917
46499
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
45918
|
-
* @version
|
|
46500
|
+
* @version 229.0.0
|
|
45919
46501
|
*/
|
|
45920
46502
|
|
|
45921
46503
|
/**
|
|
@@ -46148,7 +46730,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46148
46730
|
/**
|
|
46149
46731
|
* OAuth service.
|
|
46150
46732
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
46151
|
-
* @version
|
|
46733
|
+
* @version 229.0.0
|
|
46152
46734
|
*/
|
|
46153
46735
|
|
|
46154
46736
|
/**
|
|
@@ -46514,7 +47096,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46514
47096
|
/**
|
|
46515
47097
|
* Objects service.
|
|
46516
47098
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
46517
|
-
* @version
|
|
47099
|
+
* @version 229.0.0
|
|
46518
47100
|
*/
|
|
46519
47101
|
|
|
46520
47102
|
/**
|
|
@@ -46838,7 +47420,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46838
47420
|
/**
|
|
46839
47421
|
* OperationalEvents service.
|
|
46840
47422
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
46841
|
-
* @version
|
|
47423
|
+
* @version 229.0.0
|
|
46842
47424
|
*/
|
|
46843
47425
|
|
|
46844
47426
|
/**
|
|
@@ -46955,7 +47537,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46955
47537
|
/**
|
|
46956
47538
|
* Organization service.
|
|
46957
47539
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
46958
|
-
* @version
|
|
47540
|
+
* @version 229.0.0
|
|
46959
47541
|
*/
|
|
46960
47542
|
|
|
46961
47543
|
/**
|
|
@@ -47430,7 +48012,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47430
48012
|
/**
|
|
47431
48013
|
* OrganizationAuthorization service.
|
|
47432
48014
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
47433
|
-
* @version
|
|
48015
|
+
* @version 229.0.0
|
|
47434
48016
|
*/
|
|
47435
48017
|
|
|
47436
48018
|
/**
|
|
@@ -48824,7 +49406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
48824
49406
|
/**
|
|
48825
49407
|
* Outbound service.
|
|
48826
49408
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
48827
|
-
* @version
|
|
49409
|
+
* @version 229.0.0
|
|
48828
49410
|
*/
|
|
48829
49411
|
|
|
48830
49412
|
/**
|
|
@@ -49615,6 +50197,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49615
50197
|
);
|
|
49616
50198
|
}
|
|
49617
50199
|
|
|
50200
|
+
/**
|
|
50201
|
+
* Delete a WhatsApp campaign schedule.
|
|
50202
|
+
*
|
|
50203
|
+
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
50204
|
+
*/
|
|
50205
|
+
deleteOutboundSchedulesWhatsappcampaign(whatsAppCampaignId) {
|
|
50206
|
+
// verify the required parameter 'whatsAppCampaignId' is set
|
|
50207
|
+
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
50208
|
+
throw 'Missing the required parameter "whatsAppCampaignId" when calling deleteOutboundSchedulesWhatsappcampaign';
|
|
50209
|
+
}
|
|
50210
|
+
|
|
50211
|
+
return this.apiClient.callApi(
|
|
50212
|
+
'/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}',
|
|
50213
|
+
'DELETE',
|
|
50214
|
+
{ 'whatsAppCampaignId': whatsAppCampaignId },
|
|
50215
|
+
{ },
|
|
50216
|
+
{ },
|
|
50217
|
+
{ },
|
|
50218
|
+
null,
|
|
50219
|
+
['PureCloud OAuth'],
|
|
50220
|
+
['application/json'],
|
|
50221
|
+
['application/json']
|
|
50222
|
+
);
|
|
50223
|
+
}
|
|
50224
|
+
|
|
49618
50225
|
/**
|
|
49619
50226
|
* Delete a dialer campaign sequence.
|
|
49620
50227
|
*
|
|
@@ -51463,6 +52070,51 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51463
52070
|
);
|
|
51464
52071
|
}
|
|
51465
52072
|
|
|
52073
|
+
/**
|
|
52074
|
+
* Get a WhatsApp campaign schedule.
|
|
52075
|
+
*
|
|
52076
|
+
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
52077
|
+
*/
|
|
52078
|
+
getOutboundSchedulesWhatsappcampaign(whatsAppCampaignId) {
|
|
52079
|
+
// verify the required parameter 'whatsAppCampaignId' is set
|
|
52080
|
+
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
52081
|
+
throw 'Missing the required parameter "whatsAppCampaignId" when calling getOutboundSchedulesWhatsappcampaign';
|
|
52082
|
+
}
|
|
52083
|
+
|
|
52084
|
+
return this.apiClient.callApi(
|
|
52085
|
+
'/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}',
|
|
52086
|
+
'GET',
|
|
52087
|
+
{ 'whatsAppCampaignId': whatsAppCampaignId },
|
|
52088
|
+
{ },
|
|
52089
|
+
{ },
|
|
52090
|
+
{ },
|
|
52091
|
+
null,
|
|
52092
|
+
['PureCloud OAuth'],
|
|
52093
|
+
['application/json'],
|
|
52094
|
+
['application/json']
|
|
52095
|
+
);
|
|
52096
|
+
}
|
|
52097
|
+
|
|
52098
|
+
/**
|
|
52099
|
+
* Query for a list of WhatsApp campaign schedules.
|
|
52100
|
+
*
|
|
52101
|
+
*/
|
|
52102
|
+
getOutboundSchedulesWhatsappcampaigns() {
|
|
52103
|
+
|
|
52104
|
+
return this.apiClient.callApi(
|
|
52105
|
+
'/api/v2/outbound/schedules/whatsappcampaigns',
|
|
52106
|
+
'GET',
|
|
52107
|
+
{ },
|
|
52108
|
+
{ },
|
|
52109
|
+
{ },
|
|
52110
|
+
{ },
|
|
52111
|
+
null,
|
|
52112
|
+
['PureCloud OAuth'],
|
|
52113
|
+
['application/json'],
|
|
52114
|
+
['application/json']
|
|
52115
|
+
);
|
|
52116
|
+
}
|
|
52117
|
+
|
|
51466
52118
|
/**
|
|
51467
52119
|
* Get a dialer campaign sequence.
|
|
51468
52120
|
*
|
|
@@ -53385,6 +54037,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53385
54037
|
);
|
|
53386
54038
|
}
|
|
53387
54039
|
|
|
54040
|
+
/**
|
|
54041
|
+
* Update a WhatsApp campaign schedule.
|
|
54042
|
+
*
|
|
54043
|
+
* @param {String} whatsAppCampaignId WhatsApp Campaign ID
|
|
54044
|
+
* @param {Object} body WhatsAppCampaignSchedule
|
|
54045
|
+
*/
|
|
54046
|
+
putOutboundSchedulesWhatsappcampaign(whatsAppCampaignId, body) {
|
|
54047
|
+
// verify the required parameter 'whatsAppCampaignId' is set
|
|
54048
|
+
if (whatsAppCampaignId === undefined || whatsAppCampaignId === null || whatsAppCampaignId === '') {
|
|
54049
|
+
throw 'Missing the required parameter "whatsAppCampaignId" when calling putOutboundSchedulesWhatsappcampaign';
|
|
54050
|
+
}
|
|
54051
|
+
// verify the required parameter 'body' is set
|
|
54052
|
+
if (body === undefined || body === null) {
|
|
54053
|
+
throw 'Missing the required parameter "body" when calling putOutboundSchedulesWhatsappcampaign';
|
|
54054
|
+
}
|
|
54055
|
+
|
|
54056
|
+
return this.apiClient.callApi(
|
|
54057
|
+
'/api/v2/outbound/schedules/whatsappcampaigns/{whatsAppCampaignId}',
|
|
54058
|
+
'PUT',
|
|
54059
|
+
{ 'whatsAppCampaignId': whatsAppCampaignId },
|
|
54060
|
+
{ },
|
|
54061
|
+
{ },
|
|
54062
|
+
{ },
|
|
54063
|
+
body,
|
|
54064
|
+
['PureCloud OAuth'],
|
|
54065
|
+
['application/json'],
|
|
54066
|
+
['application/json']
|
|
54067
|
+
);
|
|
54068
|
+
}
|
|
54069
|
+
|
|
53388
54070
|
/**
|
|
53389
54071
|
* Update a new campaign sequence.
|
|
53390
54072
|
*
|
|
@@ -53446,7 +54128,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
53446
54128
|
/**
|
|
53447
54129
|
* Presence service.
|
|
53448
54130
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
53449
|
-
* @version
|
|
54131
|
+
* @version 229.0.0
|
|
53450
54132
|
*/
|
|
53451
54133
|
|
|
53452
54134
|
/**
|
|
@@ -54190,7 +54872,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54190
54872
|
/**
|
|
54191
54873
|
* ProcessAutomation service.
|
|
54192
54874
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
54193
|
-
* @version
|
|
54875
|
+
* @version 229.0.0
|
|
54194
54876
|
*/
|
|
54195
54877
|
|
|
54196
54878
|
/**
|
|
@@ -54429,7 +55111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54429
55111
|
/**
|
|
54430
55112
|
* Quality service.
|
|
54431
55113
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
54432
|
-
* @version
|
|
55114
|
+
* @version 229.0.0
|
|
54433
55115
|
*/
|
|
54434
55116
|
|
|
54435
55117
|
/**
|
|
@@ -54444,6 +55126,58 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54444
55126
|
}
|
|
54445
55127
|
|
|
54446
55128
|
|
|
55129
|
+
/**
|
|
55130
|
+
* Delete/cancel an async request for evaluation aggregates
|
|
55131
|
+
*
|
|
55132
|
+
* @param {String} jobId jobId
|
|
55133
|
+
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55134
|
+
*/
|
|
55135
|
+
deleteAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
55136
|
+
// verify the required parameter 'jobId' is set
|
|
55137
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
55138
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';
|
|
55139
|
+
}
|
|
55140
|
+
|
|
55141
|
+
return this.apiClient.callApi(
|
|
55142
|
+
'/api/v2/analytics/evaluations/aggregates/jobs/{jobId}',
|
|
55143
|
+
'DELETE',
|
|
55144
|
+
{ 'jobId': jobId },
|
|
55145
|
+
{ },
|
|
55146
|
+
{ },
|
|
55147
|
+
{ },
|
|
55148
|
+
null,
|
|
55149
|
+
['PureCloud OAuth'],
|
|
55150
|
+
['application/json'],
|
|
55151
|
+
['application/json']
|
|
55152
|
+
);
|
|
55153
|
+
}
|
|
55154
|
+
|
|
55155
|
+
/**
|
|
55156
|
+
* Delete/cancel an async request for survey aggregates
|
|
55157
|
+
*
|
|
55158
|
+
* @param {String} jobId jobId
|
|
55159
|
+
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
55160
|
+
*/
|
|
55161
|
+
deleteAnalyticsSurveysAggregatesJob(jobId) {
|
|
55162
|
+
// verify the required parameter 'jobId' is set
|
|
55163
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
55164
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';
|
|
55165
|
+
}
|
|
55166
|
+
|
|
55167
|
+
return this.apiClient.callApi(
|
|
55168
|
+
'/api/v2/analytics/surveys/aggregates/jobs/{jobId}',
|
|
55169
|
+
'DELETE',
|
|
55170
|
+
{ 'jobId': jobId },
|
|
55171
|
+
{ },
|
|
55172
|
+
{ },
|
|
55173
|
+
{ },
|
|
55174
|
+
null,
|
|
55175
|
+
['PureCloud OAuth'],
|
|
55176
|
+
['application/json'],
|
|
55177
|
+
['application/json']
|
|
55178
|
+
);
|
|
55179
|
+
}
|
|
55180
|
+
|
|
54447
55181
|
/**
|
|
54448
55182
|
* Delete a calibration by id.
|
|
54449
55183
|
*
|
|
@@ -56216,7 +56950,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
56216
56950
|
/**
|
|
56217
56951
|
* Recording service.
|
|
56218
56952
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
56219
|
-
* @version
|
|
56953
|
+
* @version 229.0.0
|
|
56220
56954
|
*/
|
|
56221
56955
|
|
|
56222
56956
|
/**
|
|
@@ -57821,7 +58555,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57821
58555
|
/**
|
|
57822
58556
|
* ResponseManagement service.
|
|
57823
58557
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
57824
|
-
* @version
|
|
58558
|
+
* @version 229.0.0
|
|
57825
58559
|
*/
|
|
57826
58560
|
|
|
57827
58561
|
/**
|
|
@@ -58331,7 +59065,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58331
59065
|
/**
|
|
58332
59066
|
* Routing service.
|
|
58333
59067
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
58334
|
-
* @version
|
|
59068
|
+
* @version 229.0.0
|
|
58335
59069
|
*/
|
|
58336
59070
|
|
|
58337
59071
|
/**
|
|
@@ -62672,7 +63406,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
62672
63406
|
/**
|
|
62673
63407
|
* SCIM service.
|
|
62674
63408
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
62675
|
-
* @version
|
|
63409
|
+
* @version 229.0.0
|
|
62676
63410
|
*/
|
|
62677
63411
|
|
|
62678
63412
|
/**
|
|
@@ -63549,7 +64283,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63549
64283
|
/**
|
|
63550
64284
|
* ScreenRecording service.
|
|
63551
64285
|
* @module purecloud-platform-client-v2/api/ScreenRecordingApi
|
|
63552
|
-
* @version
|
|
64286
|
+
* @version 229.0.0
|
|
63553
64287
|
*/
|
|
63554
64288
|
|
|
63555
64289
|
/**
|
|
@@ -63594,7 +64328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
63594
64328
|
/**
|
|
63595
64329
|
* Scripts service.
|
|
63596
64330
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
63597
|
-
* @version
|
|
64331
|
+
* @version 229.0.0
|
|
63598
64332
|
*/
|
|
63599
64333
|
|
|
63600
64334
|
/**
|
|
@@ -64070,7 +64804,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64070
64804
|
/**
|
|
64071
64805
|
* Search service.
|
|
64072
64806
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
64073
|
-
* @version
|
|
64807
|
+
* @version 229.0.0
|
|
64074
64808
|
*/
|
|
64075
64809
|
|
|
64076
64810
|
/**
|
|
@@ -64341,31 +65075,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64341
65075
|
);
|
|
64342
65076
|
}
|
|
64343
65077
|
|
|
64344
|
-
/**
|
|
64345
|
-
* Search resources.
|
|
64346
|
-
*
|
|
64347
|
-
* @param {Object} body Search request options
|
|
64348
|
-
*/
|
|
64349
|
-
postAnalyticsConversationsTranscriptsQuery(body) {
|
|
64350
|
-
// verify the required parameter 'body' is set
|
|
64351
|
-
if (body === undefined || body === null) {
|
|
64352
|
-
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';
|
|
64353
|
-
}
|
|
64354
|
-
|
|
64355
|
-
return this.apiClient.callApi(
|
|
64356
|
-
'/api/v2/analytics/conversations/transcripts/query',
|
|
64357
|
-
'POST',
|
|
64358
|
-
{ },
|
|
64359
|
-
{ },
|
|
64360
|
-
{ },
|
|
64361
|
-
{ },
|
|
64362
|
-
body,
|
|
64363
|
-
['PureCloud OAuth'],
|
|
64364
|
-
['application/json'],
|
|
64365
|
-
['application/json']
|
|
64366
|
-
);
|
|
64367
|
-
}
|
|
64368
|
-
|
|
64369
65078
|
/**
|
|
64370
65079
|
* Search conversations
|
|
64371
65080
|
*
|
|
@@ -64813,7 +65522,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
64813
65522
|
/**
|
|
64814
65523
|
* Settings service.
|
|
64815
65524
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
64816
|
-
* @version
|
|
65525
|
+
* @version 229.0.0
|
|
64817
65526
|
*/
|
|
64818
65527
|
|
|
64819
65528
|
/**
|
|
@@ -65161,7 +65870,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
65161
65870
|
/**
|
|
65162
65871
|
* SocialMedia service.
|
|
65163
65872
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
65164
|
-
* @version
|
|
65873
|
+
* @version 229.0.0
|
|
65165
65874
|
*/
|
|
65166
65875
|
|
|
65167
65876
|
/**
|
|
@@ -66512,7 +67221,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66512
67221
|
/**
|
|
66513
67222
|
* SpeechTextAnalytics service.
|
|
66514
67223
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
66515
|
-
* @version
|
|
67224
|
+
* @version 229.0.0
|
|
66516
67225
|
*/
|
|
66517
67226
|
|
|
66518
67227
|
/**
|
|
@@ -66606,6 +67315,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66606
67315
|
);
|
|
66607
67316
|
}
|
|
66608
67317
|
|
|
67318
|
+
/**
|
|
67319
|
+
* Delete a Speech and Text Analytics Reprocessing job by Id
|
|
67320
|
+
*
|
|
67321
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
67322
|
+
* deleteSpeechandtextanalyticsReprocessingJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67323
|
+
*/
|
|
67324
|
+
deleteSpeechandtextanalyticsReprocessingJob(jobId) {
|
|
67325
|
+
// verify the required parameter 'jobId' is set
|
|
67326
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
67327
|
+
throw 'Missing the required parameter "jobId" when calling deleteSpeechandtextanalyticsReprocessingJob';
|
|
67328
|
+
}
|
|
67329
|
+
|
|
67330
|
+
return this.apiClient.callApi(
|
|
67331
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}',
|
|
67332
|
+
'DELETE',
|
|
67333
|
+
{ 'jobId': jobId },
|
|
67334
|
+
{ },
|
|
67335
|
+
{ },
|
|
67336
|
+
{ },
|
|
67337
|
+
null,
|
|
67338
|
+
['PureCloud OAuth'],
|
|
67339
|
+
['application/json'],
|
|
67340
|
+
['application/json']
|
|
67341
|
+
);
|
|
67342
|
+
}
|
|
67343
|
+
|
|
66609
67344
|
/**
|
|
66610
67345
|
* Delete All Speech and Text Analytics SentimentFeedback
|
|
66611
67346
|
*
|
|
@@ -66845,6 +67580,31 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
66845
67580
|
);
|
|
66846
67581
|
}
|
|
66847
67582
|
|
|
67583
|
+
/**
|
|
67584
|
+
* Get sentiment data
|
|
67585
|
+
*
|
|
67586
|
+
* @param {String} conversationId The conversation ID of the sentiment data
|
|
67587
|
+
*/
|
|
67588
|
+
getSpeechandtextanalyticsConversationSentiments(conversationId) {
|
|
67589
|
+
// verify the required parameter 'conversationId' is set
|
|
67590
|
+
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
67591
|
+
throw 'Missing the required parameter "conversationId" when calling getSpeechandtextanalyticsConversationSentiments';
|
|
67592
|
+
}
|
|
67593
|
+
|
|
67594
|
+
return this.apiClient.callApi(
|
|
67595
|
+
'/api/v2/speechandtextanalytics/conversations/{conversationId}/sentiments',
|
|
67596
|
+
'GET',
|
|
67597
|
+
{ 'conversationId': conversationId },
|
|
67598
|
+
{ },
|
|
67599
|
+
{ },
|
|
67600
|
+
{ },
|
|
67601
|
+
null,
|
|
67602
|
+
['PureCloud OAuth'],
|
|
67603
|
+
['application/json'],
|
|
67604
|
+
['application/json']
|
|
67605
|
+
);
|
|
67606
|
+
}
|
|
67607
|
+
|
|
66848
67608
|
/**
|
|
66849
67609
|
* Get conversation summaries by conversation id.
|
|
66850
67610
|
*
|
|
@@ -67193,6 +67953,86 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67193
67953
|
);
|
|
67194
67954
|
}
|
|
67195
67955
|
|
|
67956
|
+
/**
|
|
67957
|
+
* Get a Speech and Text Analytics reprocess job by id
|
|
67958
|
+
*
|
|
67959
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
67960
|
+
* getSpeechandtextanalyticsReprocessingJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67961
|
+
*/
|
|
67962
|
+
getSpeechandtextanalyticsReprocessingJob(jobId) {
|
|
67963
|
+
// verify the required parameter 'jobId' is set
|
|
67964
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
67965
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsReprocessingJob';
|
|
67966
|
+
}
|
|
67967
|
+
|
|
67968
|
+
return this.apiClient.callApi(
|
|
67969
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}',
|
|
67970
|
+
'GET',
|
|
67971
|
+
{ 'jobId': jobId },
|
|
67972
|
+
{ },
|
|
67973
|
+
{ },
|
|
67974
|
+
{ },
|
|
67975
|
+
null,
|
|
67976
|
+
['PureCloud OAuth'],
|
|
67977
|
+
['application/json'],
|
|
67978
|
+
['application/json']
|
|
67979
|
+
);
|
|
67980
|
+
}
|
|
67981
|
+
|
|
67982
|
+
/**
|
|
67983
|
+
* Get a Speech and Text Analytics Reprocessing interactions statuses by job id
|
|
67984
|
+
*
|
|
67985
|
+
* @param {String} jobId The Id of the Reprocessing job
|
|
67986
|
+
* getSpeechandtextanalyticsReprocessingJobInteractions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
67987
|
+
*/
|
|
67988
|
+
getSpeechandtextanalyticsReprocessingJobInteractions(jobId) {
|
|
67989
|
+
// verify the required parameter 'jobId' is set
|
|
67990
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
67991
|
+
throw 'Missing the required parameter "jobId" when calling getSpeechandtextanalyticsReprocessingJobInteractions';
|
|
67992
|
+
}
|
|
67993
|
+
|
|
67994
|
+
return this.apiClient.callApi(
|
|
67995
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs/{jobId}/interactions',
|
|
67996
|
+
'GET',
|
|
67997
|
+
{ 'jobId': jobId },
|
|
67998
|
+
{ },
|
|
67999
|
+
{ },
|
|
68000
|
+
{ },
|
|
68001
|
+
null,
|
|
68002
|
+
['PureCloud OAuth'],
|
|
68003
|
+
['application/json'],
|
|
68004
|
+
['application/json']
|
|
68005
|
+
);
|
|
68006
|
+
}
|
|
68007
|
+
|
|
68008
|
+
/**
|
|
68009
|
+
* Get the list of Speech and Text Analytics reprocess jobs
|
|
68010
|
+
*
|
|
68011
|
+
* @param {Object} opts Optional parameters
|
|
68012
|
+
* @param {Number} opts.pageSize The page size for the listing. The max that will be returned is 100. Default is 25.
|
|
68013
|
+
* @param {Number} opts.pageNumber The page number for the listing. Defaults to 1.
|
|
68014
|
+
* @param {Object} opts.sortOrder Results are sorted by dateCreated. Please choose the sort order. The default is descending (desc).
|
|
68015
|
+
* @param {String} opts.name Case insensitive partial name to filter by.
|
|
68016
|
+
* getSpeechandtextanalyticsReprocessingJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
68017
|
+
*/
|
|
68018
|
+
getSpeechandtextanalyticsReprocessingJobs(opts) {
|
|
68019
|
+
opts = opts || {};
|
|
68020
|
+
|
|
68021
|
+
|
|
68022
|
+
return this.apiClient.callApi(
|
|
68023
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs',
|
|
68024
|
+
'GET',
|
|
68025
|
+
{ },
|
|
68026
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
68027
|
+
{ },
|
|
68028
|
+
{ },
|
|
68029
|
+
null,
|
|
68030
|
+
['PureCloud OAuth'],
|
|
68031
|
+
['application/json'],
|
|
68032
|
+
['application/json']
|
|
68033
|
+
);
|
|
68034
|
+
}
|
|
68035
|
+
|
|
67196
68036
|
/**
|
|
67197
68037
|
* Get the list of Speech and Text Analytics sentiment supported dialects
|
|
67198
68038
|
*
|
|
@@ -67636,6 +68476,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67636
68476
|
);
|
|
67637
68477
|
}
|
|
67638
68478
|
|
|
68479
|
+
/**
|
|
68480
|
+
* Create a Speech and Text Analytics reprocess job.
|
|
68481
|
+
*
|
|
68482
|
+
* @param {Object} body The ReprocessJob to create
|
|
68483
|
+
* postSpeechandtextanalyticsReprocessingJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
68484
|
+
*/
|
|
68485
|
+
postSpeechandtextanalyticsReprocessingJobs(body) {
|
|
68486
|
+
// verify the required parameter 'body' is set
|
|
68487
|
+
if (body === undefined || body === null) {
|
|
68488
|
+
throw 'Missing the required parameter "body" when calling postSpeechandtextanalyticsReprocessingJobs';
|
|
68489
|
+
}
|
|
68490
|
+
|
|
68491
|
+
return this.apiClient.callApi(
|
|
68492
|
+
'/api/v2/speechandtextanalytics/reprocessing/jobs',
|
|
68493
|
+
'POST',
|
|
68494
|
+
{ },
|
|
68495
|
+
{ },
|
|
68496
|
+
{ },
|
|
68497
|
+
{ },
|
|
68498
|
+
body,
|
|
68499
|
+
['PureCloud OAuth'],
|
|
68500
|
+
['application/json'],
|
|
68501
|
+
['application/json']
|
|
68502
|
+
);
|
|
68503
|
+
}
|
|
68504
|
+
|
|
67639
68505
|
/**
|
|
67640
68506
|
* Create a Speech and Text Analytics SentimentFeedback
|
|
67641
68507
|
*
|
|
@@ -68001,7 +68867,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68001
68867
|
/**
|
|
68002
68868
|
* Stations service.
|
|
68003
68869
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
68004
|
-
* @version
|
|
68870
|
+
* @version 229.0.0
|
|
68005
68871
|
*/
|
|
68006
68872
|
|
|
68007
68873
|
/**
|
|
@@ -68103,7 +68969,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68103
68969
|
/**
|
|
68104
68970
|
* Suggest service.
|
|
68105
68971
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
68106
|
-
* @version
|
|
68972
|
+
* @version 229.0.0
|
|
68107
68973
|
*/
|
|
68108
68974
|
|
|
68109
68975
|
/**
|
|
@@ -68242,7 +69108,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68242
69108
|
/**
|
|
68243
69109
|
* TaskManagement service.
|
|
68244
69110
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
68245
|
-
* @version
|
|
69111
|
+
* @version 229.0.0
|
|
68246
69112
|
*/
|
|
68247
69113
|
|
|
68248
69114
|
/**
|
|
@@ -70404,7 +71270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70404
71270
|
/**
|
|
70405
71271
|
* Teams service.
|
|
70406
71272
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
70407
|
-
* @version
|
|
71273
|
+
* @version 229.0.0
|
|
70408
71274
|
*/
|
|
70409
71275
|
|
|
70410
71276
|
/**
|
|
@@ -70709,7 +71575,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70709
71575
|
/**
|
|
70710
71576
|
* Telephony service.
|
|
70711
71577
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
70712
|
-
* @version
|
|
71578
|
+
* @version 229.0.0
|
|
70713
71579
|
*/
|
|
70714
71580
|
|
|
70715
71581
|
/**
|
|
@@ -70724,6 +71590,53 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70724
71590
|
}
|
|
70725
71591
|
|
|
70726
71592
|
|
|
71593
|
+
/**
|
|
71594
|
+
* Get an agent's greetings.
|
|
71595
|
+
*
|
|
71596
|
+
* @param {String} agentId User ID
|
|
71597
|
+
* getTelephonyAgentGreetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71598
|
+
*/
|
|
71599
|
+
getTelephonyAgentGreetings(agentId) {
|
|
71600
|
+
// verify the required parameter 'agentId' is set
|
|
71601
|
+
if (agentId === undefined || agentId === null || agentId === '') {
|
|
71602
|
+
throw 'Missing the required parameter "agentId" when calling getTelephonyAgentGreetings';
|
|
71603
|
+
}
|
|
71604
|
+
|
|
71605
|
+
return this.apiClient.callApi(
|
|
71606
|
+
'/api/v2/telephony/agents/{agentId}/greetings',
|
|
71607
|
+
'GET',
|
|
71608
|
+
{ 'agentId': agentId },
|
|
71609
|
+
{ },
|
|
71610
|
+
{ },
|
|
71611
|
+
{ },
|
|
71612
|
+
null,
|
|
71613
|
+
['PureCloud OAuth'],
|
|
71614
|
+
['application/json'],
|
|
71615
|
+
['application/json']
|
|
71616
|
+
);
|
|
71617
|
+
}
|
|
71618
|
+
|
|
71619
|
+
/**
|
|
71620
|
+
* Get the agent's own greetings.
|
|
71621
|
+
*
|
|
71622
|
+
* getTelephonyAgentsGreetingsMe is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71623
|
+
*/
|
|
71624
|
+
getTelephonyAgentsGreetingsMe() {
|
|
71625
|
+
|
|
71626
|
+
return this.apiClient.callApi(
|
|
71627
|
+
'/api/v2/telephony/agents/greetings/me',
|
|
71628
|
+
'GET',
|
|
71629
|
+
{ },
|
|
71630
|
+
{ },
|
|
71631
|
+
{ },
|
|
71632
|
+
{ },
|
|
71633
|
+
null,
|
|
71634
|
+
['PureCloud OAuth'],
|
|
71635
|
+
['application/json'],
|
|
71636
|
+
['application/json']
|
|
71637
|
+
);
|
|
71638
|
+
}
|
|
71639
|
+
|
|
70727
71640
|
/**
|
|
70728
71641
|
* Retrieve the list of AWS regions media can stream through.
|
|
70729
71642
|
*
|
|
@@ -70885,13 +71798,70 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70885
71798
|
);
|
|
70886
71799
|
}
|
|
70887
71800
|
|
|
71801
|
+
/**
|
|
71802
|
+
* Updates an agent's greetings.
|
|
71803
|
+
*
|
|
71804
|
+
* @param {String} agentId User ID
|
|
71805
|
+
* @param {Object} body Agent Greeting
|
|
71806
|
+
* putTelephonyAgentGreetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71807
|
+
*/
|
|
71808
|
+
putTelephonyAgentGreetings(agentId, body) {
|
|
71809
|
+
// verify the required parameter 'agentId' is set
|
|
71810
|
+
if (agentId === undefined || agentId === null || agentId === '') {
|
|
71811
|
+
throw 'Missing the required parameter "agentId" when calling putTelephonyAgentGreetings';
|
|
71812
|
+
}
|
|
71813
|
+
// verify the required parameter 'body' is set
|
|
71814
|
+
if (body === undefined || body === null) {
|
|
71815
|
+
throw 'Missing the required parameter "body" when calling putTelephonyAgentGreetings';
|
|
71816
|
+
}
|
|
71817
|
+
|
|
71818
|
+
return this.apiClient.callApi(
|
|
71819
|
+
'/api/v2/telephony/agents/{agentId}/greetings',
|
|
71820
|
+
'PUT',
|
|
71821
|
+
{ 'agentId': agentId },
|
|
71822
|
+
{ },
|
|
71823
|
+
{ },
|
|
71824
|
+
{ },
|
|
71825
|
+
body,
|
|
71826
|
+
['PureCloud OAuth'],
|
|
71827
|
+
['application/json'],
|
|
71828
|
+
['application/json']
|
|
71829
|
+
);
|
|
71830
|
+
}
|
|
71831
|
+
|
|
71832
|
+
/**
|
|
71833
|
+
* Updates the agent's own greetings.
|
|
71834
|
+
*
|
|
71835
|
+
* @param {Object} body Agent Greeting
|
|
71836
|
+
* putTelephonyAgentsGreetingsMe is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
71837
|
+
*/
|
|
71838
|
+
putTelephonyAgentsGreetingsMe(body) {
|
|
71839
|
+
// verify the required parameter 'body' is set
|
|
71840
|
+
if (body === undefined || body === null) {
|
|
71841
|
+
throw 'Missing the required parameter "body" when calling putTelephonyAgentsGreetingsMe';
|
|
71842
|
+
}
|
|
71843
|
+
|
|
71844
|
+
return this.apiClient.callApi(
|
|
71845
|
+
'/api/v2/telephony/agents/greetings/me',
|
|
71846
|
+
'PUT',
|
|
71847
|
+
{ },
|
|
71848
|
+
{ },
|
|
71849
|
+
{ },
|
|
71850
|
+
{ },
|
|
71851
|
+
body,
|
|
71852
|
+
['PureCloud OAuth'],
|
|
71853
|
+
['application/json'],
|
|
71854
|
+
['application/json']
|
|
71855
|
+
);
|
|
71856
|
+
}
|
|
71857
|
+
|
|
70888
71858
|
}
|
|
70889
71859
|
|
|
70890
71860
|
class TelephonyProvidersEdgeApi {
|
|
70891
71861
|
/**
|
|
70892
71862
|
* TelephonyProvidersEdge service.
|
|
70893
71863
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
70894
|
-
* @version
|
|
71864
|
+
* @version 229.0.0
|
|
70895
71865
|
*/
|
|
70896
71866
|
|
|
70897
71867
|
/**
|
|
@@ -74384,7 +75354,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74384
75354
|
/**
|
|
74385
75355
|
* Textbots service.
|
|
74386
75356
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
74387
|
-
* @version
|
|
75357
|
+
* @version 229.0.0
|
|
74388
75358
|
*/
|
|
74389
75359
|
|
|
74390
75360
|
/**
|
|
@@ -74513,7 +75483,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74513
75483
|
/**
|
|
74514
75484
|
* Tokens service.
|
|
74515
75485
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
74516
|
-
* @version
|
|
75486
|
+
* @version 229.0.0
|
|
74517
75487
|
*/
|
|
74518
75488
|
|
|
74519
75489
|
/**
|
|
@@ -74667,7 +75637,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74667
75637
|
/**
|
|
74668
75638
|
* Uploads service.
|
|
74669
75639
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
74670
|
-
* @version
|
|
75640
|
+
* @version 229.0.0
|
|
74671
75641
|
*/
|
|
74672
75642
|
|
|
74673
75643
|
/**
|
|
@@ -74958,7 +75928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74958
75928
|
/**
|
|
74959
75929
|
* Usage service.
|
|
74960
75930
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
74961
|
-
* @version
|
|
75931
|
+
* @version 229.0.0
|
|
74962
75932
|
*/
|
|
74963
75933
|
|
|
74964
75934
|
/**
|
|
@@ -75032,6 +76002,71 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75032
76002
|
);
|
|
75033
76003
|
}
|
|
75034
76004
|
|
|
76005
|
+
/**
|
|
76006
|
+
* Get the status and results of the usage query
|
|
76007
|
+
*
|
|
76008
|
+
* @param {String} jobId jobId
|
|
76009
|
+
* @param {Object} opts Optional parameters
|
|
76010
|
+
* @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
|
|
76011
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
76012
|
+
*/
|
|
76013
|
+
getUsageAggregatesQueryJob(jobId, opts) {
|
|
76014
|
+
opts = opts || {};
|
|
76015
|
+
|
|
76016
|
+
// verify the required parameter 'jobId' is set
|
|
76017
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
76018
|
+
throw 'Missing the required parameter "jobId" when calling getUsageAggregatesQueryJob';
|
|
76019
|
+
}
|
|
76020
|
+
|
|
76021
|
+
return this.apiClient.callApi(
|
|
76022
|
+
'/api/v2/usage/aggregates/query/jobs/{jobId}',
|
|
76023
|
+
'GET',
|
|
76024
|
+
{ 'jobId': jobId },
|
|
76025
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
76026
|
+
{ },
|
|
76027
|
+
{ },
|
|
76028
|
+
null,
|
|
76029
|
+
['PureCloud OAuth'],
|
|
76030
|
+
['application/json'],
|
|
76031
|
+
['application/json']
|
|
76032
|
+
);
|
|
76033
|
+
}
|
|
76034
|
+
|
|
76035
|
+
/**
|
|
76036
|
+
* Get the status and results of the usage query
|
|
76037
|
+
*
|
|
76038
|
+
* @param {String} clientId clientId
|
|
76039
|
+
* @param {String} jobId jobId
|
|
76040
|
+
* @param {Object} opts Optional parameters
|
|
76041
|
+
* @param {Number} opts.pageSize Page size of the results. Max is 1000. (default to 100)
|
|
76042
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
76043
|
+
*/
|
|
76044
|
+
getUsageClientClientIdAggregatesQueryJob(clientId, jobId, opts) {
|
|
76045
|
+
opts = opts || {};
|
|
76046
|
+
|
|
76047
|
+
// verify the required parameter 'clientId' is set
|
|
76048
|
+
if (clientId === undefined || clientId === null || clientId === '') {
|
|
76049
|
+
throw 'Missing the required parameter "clientId" when calling getUsageClientClientIdAggregatesQueryJob';
|
|
76050
|
+
}
|
|
76051
|
+
// verify the required parameter 'jobId' is set
|
|
76052
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
76053
|
+
throw 'Missing the required parameter "jobId" when calling getUsageClientClientIdAggregatesQueryJob';
|
|
76054
|
+
}
|
|
76055
|
+
|
|
76056
|
+
return this.apiClient.callApi(
|
|
76057
|
+
'/api/v2/usage/client/{clientId}/aggregates/query/jobs/{jobId}',
|
|
76058
|
+
'GET',
|
|
76059
|
+
{ 'clientId': clientId,'jobId': jobId },
|
|
76060
|
+
{ 'pageSize': opts['pageSize'],'after': opts['after'] },
|
|
76061
|
+
{ },
|
|
76062
|
+
{ },
|
|
76063
|
+
null,
|
|
76064
|
+
['PureCloud OAuth'],
|
|
76065
|
+
['application/json'],
|
|
76066
|
+
['application/json']
|
|
76067
|
+
);
|
|
76068
|
+
}
|
|
76069
|
+
|
|
75035
76070
|
/**
|
|
75036
76071
|
* Get the results of a usage query
|
|
75037
76072
|
*
|
|
@@ -75117,6 +76152,61 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75117
76152
|
);
|
|
75118
76153
|
}
|
|
75119
76154
|
|
|
76155
|
+
/**
|
|
76156
|
+
* Query your organization's public api usage.
|
|
76157
|
+
* 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
|
|
76158
|
+
* @param {Object} body Query
|
|
76159
|
+
*/
|
|
76160
|
+
postUsageAggregatesQueryJobs(body) {
|
|
76161
|
+
// verify the required parameter 'body' is set
|
|
76162
|
+
if (body === undefined || body === null) {
|
|
76163
|
+
throw 'Missing the required parameter "body" when calling postUsageAggregatesQueryJobs';
|
|
76164
|
+
}
|
|
76165
|
+
|
|
76166
|
+
return this.apiClient.callApi(
|
|
76167
|
+
'/api/v2/usage/aggregates/query/jobs',
|
|
76168
|
+
'POST',
|
|
76169
|
+
{ },
|
|
76170
|
+
{ },
|
|
76171
|
+
{ },
|
|
76172
|
+
{ },
|
|
76173
|
+
body,
|
|
76174
|
+
['PureCloud OAuth'],
|
|
76175
|
+
['application/json'],
|
|
76176
|
+
['application/json']
|
|
76177
|
+
);
|
|
76178
|
+
}
|
|
76179
|
+
|
|
76180
|
+
/**
|
|
76181
|
+
* Query your client's public api usage.
|
|
76182
|
+
* 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
|
|
76183
|
+
* @param {String} clientId clientId
|
|
76184
|
+
* @param {Object} body Query
|
|
76185
|
+
*/
|
|
76186
|
+
postUsageClientClientIdAggregatesQueryJobs(clientId, body) {
|
|
76187
|
+
// verify the required parameter 'clientId' is set
|
|
76188
|
+
if (clientId === undefined || clientId === null || clientId === '') {
|
|
76189
|
+
throw 'Missing the required parameter "clientId" when calling postUsageClientClientIdAggregatesQueryJobs';
|
|
76190
|
+
}
|
|
76191
|
+
// verify the required parameter 'body' is set
|
|
76192
|
+
if (body === undefined || body === null) {
|
|
76193
|
+
throw 'Missing the required parameter "body" when calling postUsageClientClientIdAggregatesQueryJobs';
|
|
76194
|
+
}
|
|
76195
|
+
|
|
76196
|
+
return this.apiClient.callApi(
|
|
76197
|
+
'/api/v2/usage/client/{clientId}/aggregates/query/jobs',
|
|
76198
|
+
'POST',
|
|
76199
|
+
{ 'clientId': clientId },
|
|
76200
|
+
{ },
|
|
76201
|
+
{ },
|
|
76202
|
+
{ },
|
|
76203
|
+
body,
|
|
76204
|
+
['PureCloud OAuth'],
|
|
76205
|
+
['application/json'],
|
|
76206
|
+
['application/json']
|
|
76207
|
+
);
|
|
76208
|
+
}
|
|
76209
|
+
|
|
75120
76210
|
/**
|
|
75121
76211
|
* Query organization API Usage -
|
|
75122
76212
|
* After calling this method, you will then need to poll for the query results based on the returned execution Id
|
|
@@ -75173,7 +76263,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75173
76263
|
/**
|
|
75174
76264
|
* UserRecordings service.
|
|
75175
76265
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
75176
|
-
* @version
|
|
76266
|
+
* @version 229.0.0
|
|
75177
76267
|
*/
|
|
75178
76268
|
|
|
75179
76269
|
/**
|
|
@@ -75388,7 +76478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75388
76478
|
/**
|
|
75389
76479
|
* Users service.
|
|
75390
76480
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
75391
|
-
* @version
|
|
76481
|
+
* @version 229.0.0
|
|
75392
76482
|
*/
|
|
75393
76483
|
|
|
75394
76484
|
/**
|
|
@@ -75403,6 +76493,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75403
76493
|
}
|
|
75404
76494
|
|
|
75405
76495
|
|
|
76496
|
+
/**
|
|
76497
|
+
* Delete/cancel an async request for user aggregates
|
|
76498
|
+
*
|
|
76499
|
+
* @param {String} jobId jobId
|
|
76500
|
+
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76501
|
+
*/
|
|
76502
|
+
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
76503
|
+
// verify the required parameter 'jobId' is set
|
|
76504
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
76505
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
76506
|
+
}
|
|
76507
|
+
|
|
76508
|
+
return this.apiClient.callApi(
|
|
76509
|
+
'/api/v2/analytics/users/aggregates/jobs/{jobId}',
|
|
76510
|
+
'DELETE',
|
|
76511
|
+
{ 'jobId': jobId },
|
|
76512
|
+
{ },
|
|
76513
|
+
{ },
|
|
76514
|
+
{ },
|
|
76515
|
+
null,
|
|
76516
|
+
['PureCloud OAuth'],
|
|
76517
|
+
['application/json'],
|
|
76518
|
+
['application/json']
|
|
76519
|
+
);
|
|
76520
|
+
}
|
|
76521
|
+
|
|
75406
76522
|
/**
|
|
75407
76523
|
* Delete/cancel an async request
|
|
75408
76524
|
*
|
|
@@ -78371,7 +79487,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78371
79487
|
/**
|
|
78372
79488
|
* Utilities service.
|
|
78373
79489
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
78374
|
-
* @version
|
|
79490
|
+
* @version 229.0.0
|
|
78375
79491
|
*/
|
|
78376
79492
|
|
|
78377
79493
|
/**
|
|
@@ -78482,7 +79598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78482
79598
|
/**
|
|
78483
79599
|
* Voicemail service.
|
|
78484
79600
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
78485
|
-
* @version
|
|
79601
|
+
* @version 229.0.0
|
|
78486
79602
|
*/
|
|
78487
79603
|
|
|
78488
79604
|
/**
|
|
@@ -79204,7 +80320,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79204
80320
|
/**
|
|
79205
80321
|
* WebChat service.
|
|
79206
80322
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
79207
|
-
* @version
|
|
80323
|
+
* @version 229.0.0
|
|
79208
80324
|
*/
|
|
79209
80325
|
|
|
79210
80326
|
/**
|
|
@@ -79247,7 +80363,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79247
80363
|
|
|
79248
80364
|
/**
|
|
79249
80365
|
* Remove a member from a chat conversation
|
|
79250
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80366
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79251
80367
|
* @param {String} conversationId conversationId
|
|
79252
80368
|
* @param {String} memberId memberId
|
|
79253
80369
|
* @deprecated
|
|
@@ -79345,7 +80461,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79345
80461
|
|
|
79346
80462
|
/**
|
|
79347
80463
|
* Get a media request in the conversation
|
|
79348
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80464
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
79349
80465
|
* @param {String} conversationId conversationId
|
|
79350
80466
|
* @param {String} mediaRequestId mediaRequestId
|
|
79351
80467
|
* @deprecated
|
|
@@ -79376,7 +80492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79376
80492
|
|
|
79377
80493
|
/**
|
|
79378
80494
|
* Get all media requests to the guest in the conversation
|
|
79379
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80495
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79380
80496
|
* @param {String} conversationId conversationId
|
|
79381
80497
|
* @deprecated
|
|
79382
80498
|
*/
|
|
@@ -79402,7 +80518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79402
80518
|
|
|
79403
80519
|
/**
|
|
79404
80520
|
* Get a web chat conversation member
|
|
79405
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80521
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79406
80522
|
* @param {String} conversationId conversationId
|
|
79407
80523
|
* @param {String} memberId memberId
|
|
79408
80524
|
* @deprecated
|
|
@@ -79433,7 +80549,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79433
80549
|
|
|
79434
80550
|
/**
|
|
79435
80551
|
* Get the members of a chat conversation.
|
|
79436
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80552
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79437
80553
|
* @param {String} conversationId conversationId
|
|
79438
80554
|
* @param {Object} opts Optional parameters
|
|
79439
80555
|
* @param {Number} opts.pageSize The number of entries to return per page, or omitted for the default. (default to 25)
|
|
@@ -79465,7 +80581,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79465
80581
|
|
|
79466
80582
|
/**
|
|
79467
80583
|
* Get a web chat conversation message
|
|
79468
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80584
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79469
80585
|
* @param {String} conversationId conversationId
|
|
79470
80586
|
* @param {String} messageId messageId
|
|
79471
80587
|
* @deprecated
|
|
@@ -79496,7 +80612,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79496
80612
|
|
|
79497
80613
|
/**
|
|
79498
80614
|
* Get the messages of a chat conversation.
|
|
79499
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80615
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79500
80616
|
* @param {String} conversationId conversationId
|
|
79501
80617
|
* @param {Object} opts Optional parameters
|
|
79502
80618
|
* @param {String} opts.after If available, get the messages chronologically after the id of this message
|
|
@@ -79549,7 +80665,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79549
80665
|
|
|
79550
80666
|
/**
|
|
79551
80667
|
* Update a media request in the conversation, setting the state to ACCEPTED/DECLINED/ERRORED
|
|
79552
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80668
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-legacy-co-browse-and-screenshare/
|
|
79553
80669
|
* @param {String} conversationId conversationId
|
|
79554
80670
|
* @param {String} mediaRequestId mediaRequestId
|
|
79555
80671
|
* @param {Object} body Request
|
|
@@ -79611,7 +80727,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79611
80727
|
|
|
79612
80728
|
/**
|
|
79613
80729
|
* Send a message in a chat conversation.
|
|
79614
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80730
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79615
80731
|
* @param {String} conversationId conversationId
|
|
79616
80732
|
* @param {String} memberId memberId
|
|
79617
80733
|
* @param {Object} body Message
|
|
@@ -79647,7 +80763,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79647
80763
|
|
|
79648
80764
|
/**
|
|
79649
80765
|
* Send a typing-indicator in a chat conversation.
|
|
79650
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80766
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/
|
|
79651
80767
|
* @param {String} conversationId conversationId
|
|
79652
80768
|
* @param {String} memberId memberId
|
|
79653
80769
|
* @deprecated
|
|
@@ -79678,7 +80794,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79678
80794
|
|
|
79679
80795
|
/**
|
|
79680
80796
|
* Create an ACD chat conversation from an external customer.
|
|
79681
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
80797
|
+
* 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.
|
|
79682
80798
|
* @param {Object} body CreateConversationRequest
|
|
79683
80799
|
* @deprecated
|
|
79684
80800
|
*/
|
|
@@ -79764,7 +80880,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79764
80880
|
/**
|
|
79765
80881
|
* WebDeployments service.
|
|
79766
80882
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
79767
|
-
* @version
|
|
80883
|
+
* @version 229.0.0
|
|
79768
80884
|
*/
|
|
79769
80885
|
|
|
79770
80886
|
/**
|
|
@@ -80346,7 +81462,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80346
81462
|
/**
|
|
80347
81463
|
* WebMessaging service.
|
|
80348
81464
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
80349
|
-
* @version
|
|
81465
|
+
* @version 229.0.0
|
|
80350
81466
|
*/
|
|
80351
81467
|
|
|
80352
81468
|
/**
|
|
@@ -80392,7 +81508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80392
81508
|
/**
|
|
80393
81509
|
* Widgets service.
|
|
80394
81510
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
80395
|
-
* @version
|
|
81511
|
+
* @version 229.0.0
|
|
80396
81512
|
*/
|
|
80397
81513
|
|
|
80398
81514
|
/**
|
|
@@ -80409,7 +81525,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80409
81525
|
|
|
80410
81526
|
/**
|
|
80411
81527
|
* Delete a Widget deployment
|
|
80412
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81528
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80413
81529
|
* @param {String} deploymentId Widget Config Id
|
|
80414
81530
|
* @deprecated
|
|
80415
81531
|
*/
|
|
@@ -80435,7 +81551,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80435
81551
|
|
|
80436
81552
|
/**
|
|
80437
81553
|
* Get a Widget deployment
|
|
80438
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81554
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80439
81555
|
* @param {String} deploymentId Widget Config Id
|
|
80440
81556
|
* @deprecated
|
|
80441
81557
|
*/
|
|
@@ -80461,7 +81577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80461
81577
|
|
|
80462
81578
|
/**
|
|
80463
81579
|
* List Widget deployments
|
|
80464
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81580
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80465
81581
|
* @deprecated
|
|
80466
81582
|
*/
|
|
80467
81583
|
getWidgetsDeployments() {
|
|
@@ -80482,7 +81598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80482
81598
|
|
|
80483
81599
|
/**
|
|
80484
81600
|
* Create Widget deployment
|
|
80485
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81601
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80486
81602
|
* @param {Object} body Deployment
|
|
80487
81603
|
* @deprecated
|
|
80488
81604
|
*/
|
|
@@ -80508,7 +81624,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80508
81624
|
|
|
80509
81625
|
/**
|
|
80510
81626
|
* Update a Widget deployment
|
|
80511
|
-
* This endpoint is deprecated. Please see the article https://help.
|
|
81627
|
+
* This endpoint is deprecated. Please see the article https://help.genesys.cloud/articles/deprecation-removal-of-acd-web-chat-version-2/.
|
|
80512
81628
|
* @param {String} deploymentId Widget Config Id
|
|
80513
81629
|
* @param {Object} body Deployment
|
|
80514
81630
|
* @deprecated
|
|
@@ -80543,7 +81659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80543
81659
|
/**
|
|
80544
81660
|
* WorkforceManagement service.
|
|
80545
81661
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
80546
|
-
* @version
|
|
81662
|
+
* @version 229.0.0
|
|
80547
81663
|
*/
|
|
80548
81664
|
|
|
80549
81665
|
/**
|
|
@@ -80613,6 +81729,40 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80613
81729
|
);
|
|
80614
81730
|
}
|
|
80615
81731
|
|
|
81732
|
+
/**
|
|
81733
|
+
* Delete staffing group allocations history created for a capacity plan before the given date
|
|
81734
|
+
*
|
|
81735
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
81736
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
81737
|
+
* @param {Object} opts Optional parameters
|
|
81738
|
+
* @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
|
|
81739
|
+
*/
|
|
81740
|
+
deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory(businessUnitId, capacityPlanId, opts) {
|
|
81741
|
+
opts = opts || {};
|
|
81742
|
+
|
|
81743
|
+
// verify the required parameter 'businessUnitId' is set
|
|
81744
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
81745
|
+
throw 'Missing the required parameter "businessUnitId" when calling deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory';
|
|
81746
|
+
}
|
|
81747
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
81748
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
81749
|
+
throw 'Missing the required parameter "capacityPlanId" when calling deleteWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistory';
|
|
81750
|
+
}
|
|
81751
|
+
|
|
81752
|
+
return this.apiClient.callApi(
|
|
81753
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory',
|
|
81754
|
+
'DELETE',
|
|
81755
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
81756
|
+
{ 'beforeDateId': opts['beforeDateId'] },
|
|
81757
|
+
{ },
|
|
81758
|
+
{ },
|
|
81759
|
+
null,
|
|
81760
|
+
['PureCloud OAuth'],
|
|
81761
|
+
['application/json'],
|
|
81762
|
+
['application/json']
|
|
81763
|
+
);
|
|
81764
|
+
}
|
|
81765
|
+
|
|
80616
81766
|
/**
|
|
80617
81767
|
* Deletes the planning group
|
|
80618
81768
|
*
|
|
@@ -81468,6 +82618,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81468
82618
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
81469
82619
|
* @param {Object} opts Optional parameters
|
|
81470
82620
|
* @param {Array.<String>} opts.expand Include to access additional data on the business unit
|
|
82621
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
81471
82622
|
*/
|
|
81472
82623
|
getWorkforcemanagementBusinessunit(businessUnitId, opts) {
|
|
81473
82624
|
opts = opts || {};
|
|
@@ -81481,7 +82632,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81481
82632
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
81482
82633
|
'GET',
|
|
81483
82634
|
{ 'businessUnitId': businessUnitId },
|
|
81484
|
-
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
82635
|
+
{ 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
81485
82636
|
{ },
|
|
81486
82637
|
{ },
|
|
81487
82638
|
null,
|
|
@@ -81754,6 +82905,156 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81754
82905
|
);
|
|
81755
82906
|
}
|
|
81756
82907
|
|
|
82908
|
+
/**
|
|
82909
|
+
* Get a capacity plan
|
|
82910
|
+
*
|
|
82911
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
82912
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
82913
|
+
*/
|
|
82914
|
+
getWorkforcemanagementBusinessunitCapacityplan(businessUnitId, capacityPlanId) {
|
|
82915
|
+
// verify the required parameter 'businessUnitId' is set
|
|
82916
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
82917
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplan';
|
|
82918
|
+
}
|
|
82919
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
82920
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
82921
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplan';
|
|
82922
|
+
}
|
|
82923
|
+
|
|
82924
|
+
return this.apiClient.callApi(
|
|
82925
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}',
|
|
82926
|
+
'GET',
|
|
82927
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
82928
|
+
{ },
|
|
82929
|
+
{ },
|
|
82930
|
+
{ },
|
|
82931
|
+
null,
|
|
82932
|
+
['PureCloud OAuth'],
|
|
82933
|
+
['application/json'],
|
|
82934
|
+
['application/json']
|
|
82935
|
+
);
|
|
82936
|
+
}
|
|
82937
|
+
|
|
82938
|
+
/**
|
|
82939
|
+
* Get a capacity plan's staffing group allocations
|
|
82940
|
+
*
|
|
82941
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
82942
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
82943
|
+
*/
|
|
82944
|
+
getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId) {
|
|
82945
|
+
// verify the required parameter 'businessUnitId' is set
|
|
82946
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
82947
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
82948
|
+
}
|
|
82949
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
82950
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
82951
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
82952
|
+
}
|
|
82953
|
+
|
|
82954
|
+
return this.apiClient.callApi(
|
|
82955
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
|
|
82956
|
+
'GET',
|
|
82957
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
82958
|
+
{ },
|
|
82959
|
+
{ },
|
|
82960
|
+
{ },
|
|
82961
|
+
null,
|
|
82962
|
+
['PureCloud OAuth'],
|
|
82963
|
+
['application/json'],
|
|
82964
|
+
['application/json']
|
|
82965
|
+
);
|
|
82966
|
+
}
|
|
82967
|
+
|
|
82968
|
+
/**
|
|
82969
|
+
* Get a capacity plan's staffing requirements
|
|
82970
|
+
*
|
|
82971
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
82972
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
82973
|
+
*/
|
|
82974
|
+
getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements(businessUnitId, capacityPlanId) {
|
|
82975
|
+
// verify the required parameter 'businessUnitId' is set
|
|
82976
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
82977
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements';
|
|
82978
|
+
}
|
|
82979
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
82980
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
82981
|
+
throw 'Missing the required parameter "capacityPlanId" when calling getWorkforcemanagementBusinessunitCapacityplanStaffingrequirements';
|
|
82982
|
+
}
|
|
82983
|
+
|
|
82984
|
+
return this.apiClient.callApi(
|
|
82985
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffingrequirements',
|
|
82986
|
+
'GET',
|
|
82987
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
82988
|
+
{ },
|
|
82989
|
+
{ },
|
|
82990
|
+
{ },
|
|
82991
|
+
null,
|
|
82992
|
+
['PureCloud OAuth'],
|
|
82993
|
+
['application/json'],
|
|
82994
|
+
['application/json']
|
|
82995
|
+
);
|
|
82996
|
+
}
|
|
82997
|
+
|
|
82998
|
+
/**
|
|
82999
|
+
* Get the latest long term staffing requirements for a business unit
|
|
83000
|
+
*
|
|
83001
|
+
* @param {String} businessUnitId
|
|
83002
|
+
* @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
83003
|
+
* @param {String} forecastId forecastId of forecast
|
|
83004
|
+
*/
|
|
83005
|
+
getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast(businessUnitId, weekDateId, forecastId) {
|
|
83006
|
+
// verify the required parameter 'businessUnitId' is set
|
|
83007
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
83008
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
83009
|
+
}
|
|
83010
|
+
// verify the required parameter 'weekDateId' is set
|
|
83011
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
83012
|
+
throw 'Missing the required parameter "weekDateId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
83013
|
+
}
|
|
83014
|
+
// verify the required parameter 'forecastId' is set
|
|
83015
|
+
if (forecastId === undefined || forecastId === null || forecastId === '') {
|
|
83016
|
+
throw 'Missing the required parameter "forecastId" when calling getWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecast';
|
|
83017
|
+
}
|
|
83018
|
+
|
|
83019
|
+
return this.apiClient.callApi(
|
|
83020
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}',
|
|
83021
|
+
'GET',
|
|
83022
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
83023
|
+
{ },
|
|
83024
|
+
{ },
|
|
83025
|
+
{ },
|
|
83026
|
+
null,
|
|
83027
|
+
['PureCloud OAuth'],
|
|
83028
|
+
['application/json'],
|
|
83029
|
+
['application/json']
|
|
83030
|
+
);
|
|
83031
|
+
}
|
|
83032
|
+
|
|
83033
|
+
/**
|
|
83034
|
+
* Get list of capacity plans for a business unit
|
|
83035
|
+
*
|
|
83036
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
83037
|
+
*/
|
|
83038
|
+
getWorkforcemanagementBusinessunitCapacityplans(businessUnitId) {
|
|
83039
|
+
// verify the required parameter 'businessUnitId' is set
|
|
83040
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
83041
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitCapacityplans';
|
|
83042
|
+
}
|
|
83043
|
+
|
|
83044
|
+
return this.apiClient.callApi(
|
|
83045
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans',
|
|
83046
|
+
'GET',
|
|
83047
|
+
{ 'businessUnitId': businessUnitId },
|
|
83048
|
+
{ },
|
|
83049
|
+
{ },
|
|
83050
|
+
{ },
|
|
83051
|
+
null,
|
|
83052
|
+
['PureCloud OAuth'],
|
|
83053
|
+
['application/json'],
|
|
83054
|
+
['application/json']
|
|
83055
|
+
);
|
|
83056
|
+
}
|
|
83057
|
+
|
|
81757
83058
|
/**
|
|
81758
83059
|
* Get intraday planning groups for the given date
|
|
81759
83060
|
*
|
|
@@ -84326,8 +85627,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84326
85627
|
*
|
|
84327
85628
|
* @param {String} businessUnitId The ID of the business unit, or 'mine' for the business unit of the logged-in user.
|
|
84328
85629
|
* @param {Object} body body
|
|
85630
|
+
* @param {Object} opts Optional parameters
|
|
85631
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
84329
85632
|
*/
|
|
84330
|
-
patchWorkforcemanagementBusinessunit(businessUnitId, body) {
|
|
85633
|
+
patchWorkforcemanagementBusinessunit(businessUnitId, body, opts) {
|
|
85634
|
+
opts = opts || {};
|
|
85635
|
+
|
|
84331
85636
|
// verify the required parameter 'businessUnitId' is set
|
|
84332
85637
|
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
84333
85638
|
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunit';
|
|
@@ -84341,7 +85646,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84341
85646
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}',
|
|
84342
85647
|
'PATCH',
|
|
84343
85648
|
{ 'businessUnitId': businessUnitId },
|
|
84344
|
-
{
|
|
85649
|
+
{ 'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
84345
85650
|
{ },
|
|
84346
85651
|
{ },
|
|
84347
85652
|
body,
|
|
@@ -84451,6 +85756,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
84451
85756
|
);
|
|
84452
85757
|
}
|
|
84453
85758
|
|
|
85759
|
+
/**
|
|
85760
|
+
* Update a capacity plan configuration
|
|
85761
|
+
*
|
|
85762
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
85763
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
85764
|
+
* @param {Object} body body
|
|
85765
|
+
*/
|
|
85766
|
+
patchWorkforcemanagementBusinessunitCapacityplan(businessUnitId, capacityPlanId, body) {
|
|
85767
|
+
// verify the required parameter 'businessUnitId' is set
|
|
85768
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
85769
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
85770
|
+
}
|
|
85771
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
85772
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
85773
|
+
throw 'Missing the required parameter "capacityPlanId" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
85774
|
+
}
|
|
85775
|
+
// verify the required parameter 'body' is set
|
|
85776
|
+
if (body === undefined || body === null) {
|
|
85777
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitCapacityplan';
|
|
85778
|
+
}
|
|
85779
|
+
|
|
85780
|
+
return this.apiClient.callApi(
|
|
85781
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}',
|
|
85782
|
+
'PATCH',
|
|
85783
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
85784
|
+
{ },
|
|
85785
|
+
{ },
|
|
85786
|
+
{ },
|
|
85787
|
+
body,
|
|
85788
|
+
['PureCloud OAuth'],
|
|
85789
|
+
['application/json'],
|
|
85790
|
+
['application/json']
|
|
85791
|
+
);
|
|
85792
|
+
}
|
|
85793
|
+
|
|
84454
85794
|
/**
|
|
84455
85795
|
* Updates the planning group
|
|
84456
85796
|
*
|
|
@@ -85749,6 +87089,236 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85749
87089
|
);
|
|
85750
87090
|
}
|
|
85751
87091
|
|
|
87092
|
+
/**
|
|
87093
|
+
* Copy a capacity plan
|
|
87094
|
+
*
|
|
87095
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87096
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87097
|
+
* @param {Object} body body
|
|
87098
|
+
*/
|
|
87099
|
+
postWorkforcemanagementBusinessunitCapacityplanCopy(businessUnitId, capacityPlanId, body) {
|
|
87100
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87101
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87102
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
87103
|
+
}
|
|
87104
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87105
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87106
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
87107
|
+
}
|
|
87108
|
+
// verify the required parameter 'body' is set
|
|
87109
|
+
if (body === undefined || body === null) {
|
|
87110
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanCopy';
|
|
87111
|
+
}
|
|
87112
|
+
|
|
87113
|
+
return this.apiClient.callApi(
|
|
87114
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/copy',
|
|
87115
|
+
'POST',
|
|
87116
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87117
|
+
{ },
|
|
87118
|
+
{ },
|
|
87119
|
+
{ },
|
|
87120
|
+
body,
|
|
87121
|
+
['PureCloud OAuth'],
|
|
87122
|
+
['application/json'],
|
|
87123
|
+
['application/json']
|
|
87124
|
+
);
|
|
87125
|
+
}
|
|
87126
|
+
|
|
87127
|
+
/**
|
|
87128
|
+
* Regenerate requirements for capacity plan
|
|
87129
|
+
*
|
|
87130
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87131
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87132
|
+
*/
|
|
87133
|
+
postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate(businessUnitId, capacityPlanId) {
|
|
87134
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87135
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87136
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate';
|
|
87137
|
+
}
|
|
87138
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87139
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87140
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanRequirementGenerate';
|
|
87141
|
+
}
|
|
87142
|
+
|
|
87143
|
+
return this.apiClient.callApi(
|
|
87144
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/requirement/generate',
|
|
87145
|
+
'POST',
|
|
87146
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87147
|
+
{ },
|
|
87148
|
+
{ },
|
|
87149
|
+
{ },
|
|
87150
|
+
null,
|
|
87151
|
+
['PureCloud OAuth'],
|
|
87152
|
+
['application/json'],
|
|
87153
|
+
['application/json']
|
|
87154
|
+
);
|
|
87155
|
+
}
|
|
87156
|
+
|
|
87157
|
+
/**
|
|
87158
|
+
* Create staffing group allocations for a capacity plan
|
|
87159
|
+
*
|
|
87160
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87161
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87162
|
+
* @param {Object} body
|
|
87163
|
+
*/
|
|
87164
|
+
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations(businessUnitId, capacityPlanId, body) {
|
|
87165
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87166
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87167
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
87168
|
+
}
|
|
87169
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87170
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87171
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
87172
|
+
}
|
|
87173
|
+
// verify the required parameter 'body' is set
|
|
87174
|
+
if (body === undefined || body === null) {
|
|
87175
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocations';
|
|
87176
|
+
}
|
|
87177
|
+
|
|
87178
|
+
return this.apiClient.callApi(
|
|
87179
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocations',
|
|
87180
|
+
'POST',
|
|
87181
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87182
|
+
{ },
|
|
87183
|
+
{ },
|
|
87184
|
+
{ },
|
|
87185
|
+
body,
|
|
87186
|
+
['PureCloud OAuth'],
|
|
87187
|
+
['application/json'],
|
|
87188
|
+
['application/json']
|
|
87189
|
+
);
|
|
87190
|
+
}
|
|
87191
|
+
|
|
87192
|
+
/**
|
|
87193
|
+
* Query staffing groups allocations history for a capacity plan
|
|
87194
|
+
*
|
|
87195
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87196
|
+
* @param {String} capacityPlanId The ID of the capacity plan
|
|
87197
|
+
* @param {Object} body
|
|
87198
|
+
*/
|
|
87199
|
+
postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery(businessUnitId, capacityPlanId, body) {
|
|
87200
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87201
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87202
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
87203
|
+
}
|
|
87204
|
+
// verify the required parameter 'capacityPlanId' is set
|
|
87205
|
+
if (capacityPlanId === undefined || capacityPlanId === null || capacityPlanId === '') {
|
|
87206
|
+
throw 'Missing the required parameter "capacityPlanId" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
87207
|
+
}
|
|
87208
|
+
// verify the required parameter 'body' is set
|
|
87209
|
+
if (body === undefined || body === null) {
|
|
87210
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplanStaffinggroupallocationshistoryQuery';
|
|
87211
|
+
}
|
|
87212
|
+
|
|
87213
|
+
return this.apiClient.callApi(
|
|
87214
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/{capacityPlanId}/staffinggroupallocationshistory/query',
|
|
87215
|
+
'POST',
|
|
87216
|
+
{ 'businessUnitId': businessUnitId,'capacityPlanId': capacityPlanId },
|
|
87217
|
+
{ },
|
|
87218
|
+
{ },
|
|
87219
|
+
{ },
|
|
87220
|
+
body,
|
|
87221
|
+
['PureCloud OAuth'],
|
|
87222
|
+
['application/json'],
|
|
87223
|
+
['application/json']
|
|
87224
|
+
);
|
|
87225
|
+
}
|
|
87226
|
+
|
|
87227
|
+
/**
|
|
87228
|
+
* Force regenerate the latest long term staffing requirements for a business unit
|
|
87229
|
+
*
|
|
87230
|
+
* @param {String} businessUnitId
|
|
87231
|
+
* @param {String} weekDateId weekDateId of forecast, format yyyy-MM-dd. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
87232
|
+
* @param {String} forecastId forecastId of forecast
|
|
87233
|
+
*/
|
|
87234
|
+
postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate(businessUnitId, weekDateId, forecastId) {
|
|
87235
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87236
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87237
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
87238
|
+
}
|
|
87239
|
+
// verify the required parameter 'weekDateId' is set
|
|
87240
|
+
if (weekDateId === undefined || weekDateId === null) {
|
|
87241
|
+
throw 'Missing the required parameter "weekDateId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
87242
|
+
}
|
|
87243
|
+
// verify the required parameter 'forecastId' is set
|
|
87244
|
+
if (forecastId === undefined || forecastId === null || forecastId === '') {
|
|
87245
|
+
throw 'Missing the required parameter "forecastId" when calling postWorkforcemanagementBusinessunitCapacityplanningLongtermrequirementsAutomaticbestmethodWeekForecastForceregenerate';
|
|
87246
|
+
}
|
|
87247
|
+
|
|
87248
|
+
return this.apiClient.callApi(
|
|
87249
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplanning/longtermrequirements/automaticbestmethod/weeks/{weekDateId}/forecasts/{forecastId}/forceregenerate',
|
|
87250
|
+
'POST',
|
|
87251
|
+
{ 'businessUnitId': businessUnitId,'weekDateId': weekDateId,'forecastId': forecastId },
|
|
87252
|
+
{ },
|
|
87253
|
+
{ },
|
|
87254
|
+
{ },
|
|
87255
|
+
null,
|
|
87256
|
+
['PureCloud OAuth'],
|
|
87257
|
+
['application/json'],
|
|
87258
|
+
['application/json']
|
|
87259
|
+
);
|
|
87260
|
+
}
|
|
87261
|
+
|
|
87262
|
+
/**
|
|
87263
|
+
* Create a new capacity plan
|
|
87264
|
+
*
|
|
87265
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87266
|
+
* @param {Object} body body
|
|
87267
|
+
*/
|
|
87268
|
+
postWorkforcemanagementBusinessunitCapacityplans(businessUnitId, body) {
|
|
87269
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87270
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87271
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplans';
|
|
87272
|
+
}
|
|
87273
|
+
// verify the required parameter 'body' is set
|
|
87274
|
+
if (body === undefined || body === null) {
|
|
87275
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplans';
|
|
87276
|
+
}
|
|
87277
|
+
|
|
87278
|
+
return this.apiClient.callApi(
|
|
87279
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans',
|
|
87280
|
+
'POST',
|
|
87281
|
+
{ 'businessUnitId': businessUnitId },
|
|
87282
|
+
{ },
|
|
87283
|
+
{ },
|
|
87284
|
+
{ },
|
|
87285
|
+
body,
|
|
87286
|
+
['PureCloud OAuth'],
|
|
87287
|
+
['application/json'],
|
|
87288
|
+
['application/json']
|
|
87289
|
+
);
|
|
87290
|
+
}
|
|
87291
|
+
|
|
87292
|
+
/**
|
|
87293
|
+
* Delete capacity plans in a business unit
|
|
87294
|
+
*
|
|
87295
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87296
|
+
* @param {Object} body body
|
|
87297
|
+
*/
|
|
87298
|
+
postWorkforcemanagementBusinessunitCapacityplansBulkRemove(businessUnitId, body) {
|
|
87299
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87300
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87301
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitCapacityplansBulkRemove';
|
|
87302
|
+
}
|
|
87303
|
+
// verify the required parameter 'body' is set
|
|
87304
|
+
if (body === undefined || body === null) {
|
|
87305
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitCapacityplansBulkRemove';
|
|
87306
|
+
}
|
|
87307
|
+
|
|
87308
|
+
return this.apiClient.callApi(
|
|
87309
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/capacityplans/bulk/remove',
|
|
87310
|
+
'POST',
|
|
87311
|
+
{ 'businessUnitId': businessUnitId },
|
|
87312
|
+
{ },
|
|
87313
|
+
{ },
|
|
87314
|
+
{ },
|
|
87315
|
+
body,
|
|
87316
|
+
['PureCloud OAuth'],
|
|
87317
|
+
['application/json'],
|
|
87318
|
+
['application/json']
|
|
87319
|
+
);
|
|
87320
|
+
}
|
|
87321
|
+
|
|
85752
87322
|
/**
|
|
85753
87323
|
* Get intraday data for the given date for the requested planningGroupIds
|
|
85754
87324
|
*
|
|
@@ -85873,6 +87443,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85873
87443
|
);
|
|
85874
87444
|
}
|
|
85875
87445
|
|
|
87446
|
+
/**
|
|
87447
|
+
* Gets a list of planning group to staffing groups list association
|
|
87448
|
+
*
|
|
87449
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
87450
|
+
* @param {Object} body body
|
|
87451
|
+
*/
|
|
87452
|
+
postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery(businessUnitId, body) {
|
|
87453
|
+
// verify the required parameter 'businessUnitId' is set
|
|
87454
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
87455
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery';
|
|
87456
|
+
}
|
|
87457
|
+
// verify the required parameter 'body' is set
|
|
87458
|
+
if (body === undefined || body === null) {
|
|
87459
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitStaffinggroupsPlanninggroupsQuery';
|
|
87460
|
+
}
|
|
87461
|
+
|
|
87462
|
+
return this.apiClient.callApi(
|
|
87463
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/staffinggroups/planninggroups/query',
|
|
87464
|
+
'POST',
|
|
87465
|
+
{ 'businessUnitId': businessUnitId },
|
|
87466
|
+
{ },
|
|
87467
|
+
{ },
|
|
87468
|
+
{ },
|
|
87469
|
+
body,
|
|
87470
|
+
['PureCloud OAuth'],
|
|
87471
|
+
['application/json'],
|
|
87472
|
+
['application/json']
|
|
87473
|
+
);
|
|
87474
|
+
}
|
|
87475
|
+
|
|
85876
87476
|
/**
|
|
85877
87477
|
* Gets staffing group associations for a list of user IDs
|
|
85878
87478
|
*
|
|
@@ -86679,8 +88279,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86679
88279
|
* Add a new business unit
|
|
86680
88280
|
* It may take a minute or two for a new business unit to be available for api operations
|
|
86681
88281
|
* @param {Object} body body
|
|
88282
|
+
* @param {Object} opts Optional parameters
|
|
88283
|
+
* @param {Boolean} opts.includeSchedulingDefaultMessageSeverities Whether to include scheduling default message severities
|
|
86682
88284
|
*/
|
|
86683
|
-
postWorkforcemanagementBusinessunits(body) {
|
|
88285
|
+
postWorkforcemanagementBusinessunits(body, opts) {
|
|
88286
|
+
opts = opts || {};
|
|
88287
|
+
|
|
86684
88288
|
// verify the required parameter 'body' is set
|
|
86685
88289
|
if (body === undefined || body === null) {
|
|
86686
88290
|
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunits';
|
|
@@ -86690,7 +88294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
86690
88294
|
'/api/v2/workforcemanagement/businessunits',
|
|
86691
88295
|
'POST',
|
|
86692
88296
|
{ },
|
|
86693
|
-
{
|
|
88297
|
+
{ 'includeSchedulingDefaultMessageSeverities': opts['includeSchedulingDefaultMessageSeverities'] },
|
|
86694
88298
|
{ },
|
|
86695
88299
|
{ },
|
|
86696
88300
|
body,
|
|
@@ -88025,7 +89629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88025
89629
|
* </pre>
|
|
88026
89630
|
* </p>
|
|
88027
89631
|
* @module purecloud-platform-client-v2/index
|
|
88028
|
-
* @version
|
|
89632
|
+
* @version 229.0.0
|
|
88029
89633
|
*/
|
|
88030
89634
|
class platformClient {
|
|
88031
89635
|
constructor() {
|