purecloud-platform-client-v2 252.1.0 → 254.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 +1979 -556
- package/dist/web-amd/purecloud-platform-client-v2.js +1979 -556
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +686 -393
- package/dist/web-cjs/purecloud-platform-client-v2.js +686 -393
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +1094 -117
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +6 -6
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -62
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +3 -2
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +435 -1
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +207 -125
- package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +2 -6
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -5
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +122 -11
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +42 -1
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/QualityApi.js +1 -9
- 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 +333 -158
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +268 -1
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -47
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -5
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +481 -43
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -745,7 +745,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
745
745
|
|
|
746
746
|
/**
|
|
747
747
|
* @module purecloud-platform-client-v2/ApiClient
|
|
748
|
-
* @version
|
|
748
|
+
* @version 254.0.0
|
|
749
749
|
*/
|
|
750
750
|
class ApiClient {
|
|
751
751
|
/**
|
|
@@ -2436,7 +2436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2436
2436
|
/**
|
|
2437
2437
|
* AIStudio service.
|
|
2438
2438
|
* @module purecloud-platform-client-v2/api/AIStudioApi
|
|
2439
|
-
* @version
|
|
2439
|
+
* @version 254.0.0
|
|
2440
2440
|
*/
|
|
2441
2441
|
|
|
2442
2442
|
/**
|
|
@@ -2545,12 +2545,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2545
2545
|
* Get all summary settings.
|
|
2546
2546
|
*
|
|
2547
2547
|
* @param {Object} opts Optional parameters
|
|
2548
|
-
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2549
|
-
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2550
|
-
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2551
|
-
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2552
2548
|
* @param {Number} opts.pageNumber Page number. (default to 1)
|
|
2553
2549
|
* @param {Number} opts.pageSize Page size. The maximum page size is 100. (default to 25)
|
|
2550
|
+
* @param {String} opts.name Filter by partially matching name - case insensitive.
|
|
2551
|
+
* @param {Object} opts.sortOrder Sort Order. Default value desc. (default to desc)
|
|
2552
|
+
* @param {String} opts.language Filter by matching language - case insensitive.
|
|
2553
|
+
* @param {Object} opts.sortBy Sort by. Default value dateModified. (default to dateModified)
|
|
2554
2554
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2555
2555
|
*/
|
|
2556
2556
|
getConversationsSummariesSettings(opts) {
|
|
@@ -2561,7 +2561,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
2561
2561
|
'/api/v2/conversations/summaries/settings',
|
|
2562
2562
|
'GET',
|
|
2563
2563
|
{ },
|
|
2564
|
-
{ '
|
|
2564
|
+
{ 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'name': opts['name'],'sortOrder': opts['sortOrder'],'language': opts['language'],'sortBy': opts['sortBy'] },
|
|
2565
2565
|
{ },
|
|
2566
2566
|
{ },
|
|
2567
2567
|
null,
|
|
@@ -3151,7 +3151,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3151
3151
|
/**
|
|
3152
3152
|
* AgentAssistants service.
|
|
3153
3153
|
* @module purecloud-platform-client-v2/api/AgentAssistantsApi
|
|
3154
|
-
* @version
|
|
3154
|
+
* @version 254.0.0
|
|
3155
3155
|
*/
|
|
3156
3156
|
|
|
3157
3157
|
/**
|
|
@@ -3507,6 +3507,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3507
3507
|
* @param {String} opts.language The agent checklist language filter applied to the listing.
|
|
3508
3508
|
* @param {Object} opts.sortOrder The sort order for the listing
|
|
3509
3509
|
* @param {Object} opts.sortBy The field to sort by for the listing.
|
|
3510
|
+
* @param {Array.<String>} opts.agentChecklistIds Agent checklist IDs (repeat param or comma-separated). Do not use with other optional filters.
|
|
3510
3511
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3511
3512
|
*/
|
|
3512
3513
|
getAssistantsAgentchecklists(opts) {
|
|
@@ -3517,7 +3518,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3517
3518
|
'/api/v2/assistants/agentchecklists',
|
|
3518
3519
|
'GET',
|
|
3519
3520
|
{ },
|
|
3520
|
-
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'] },
|
|
3521
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'namePrefix': opts['namePrefix'],'language': opts['language'],'sortOrder': opts['sortOrder'],'sortBy': opts['sortBy'],'agentChecklistIds': this.apiClient.buildCollectionParam(opts['agentChecklistIds'], 'multi') },
|
|
3521
3522
|
{ },
|
|
3522
3523
|
{ },
|
|
3523
3524
|
null,
|
|
@@ -3955,7 +3956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
3955
3956
|
/**
|
|
3956
3957
|
* AgentCopilot service.
|
|
3957
3958
|
* @module purecloud-platform-client-v2/api/AgentCopilotApi
|
|
3958
|
-
* @version
|
|
3959
|
+
* @version 254.0.0
|
|
3959
3960
|
*/
|
|
3960
3961
|
|
|
3961
3962
|
/**
|
|
@@ -4067,7 +4068,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4067
4068
|
/**
|
|
4068
4069
|
* AgentUI service.
|
|
4069
4070
|
* @module purecloud-platform-client-v2/api/AgentUIApi
|
|
4070
|
-
* @version
|
|
4071
|
+
* @version 254.0.0
|
|
4071
4072
|
*/
|
|
4072
4073
|
|
|
4073
4074
|
/**
|
|
@@ -4218,7 +4219,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4218
4219
|
/**
|
|
4219
4220
|
* Alerting service.
|
|
4220
4221
|
* @module purecloud-platform-client-v2/api/AlertingApi
|
|
4221
|
-
* @version
|
|
4222
|
+
* @version 254.0.0
|
|
4222
4223
|
*/
|
|
4223
4224
|
|
|
4224
4225
|
/**
|
|
@@ -4679,7 +4680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4679
4680
|
/**
|
|
4680
4681
|
* Analytics service.
|
|
4681
4682
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
4682
|
-
* @version
|
|
4683
|
+
* @version 254.0.0
|
|
4683
4684
|
*/
|
|
4684
4685
|
|
|
4685
4686
|
/**
|
|
@@ -4700,7 +4701,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4700
4701
|
* @param {String} jobId jobId
|
|
4701
4702
|
* @param {Object} opts Optional parameters
|
|
4702
4703
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4703
|
-
* deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4704
4704
|
*/
|
|
4705
4705
|
deleteAnalyticsActionsAggregatesJob(jobId, opts) {
|
|
4706
4706
|
opts = opts || {};
|
|
@@ -4793,7 +4793,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4793
4793
|
* @param {String} jobId jobId
|
|
4794
4794
|
* @param {Object} opts Optional parameters
|
|
4795
4795
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4796
|
-
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4797
4796
|
*/
|
|
4798
4797
|
deleteAnalyticsBotsAggregatesJob(jobId, opts) {
|
|
4799
4798
|
opts = opts || {};
|
|
@@ -4824,7 +4823,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4824
4823
|
* @param {String} jobId jobId
|
|
4825
4824
|
* @param {Object} opts Optional parameters
|
|
4826
4825
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4827
|
-
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4828
4826
|
*/
|
|
4829
4827
|
deleteAnalyticsCasemanagementAggregatesJob(jobId, opts) {
|
|
4830
4828
|
opts = opts || {};
|
|
@@ -4855,7 +4853,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4855
4853
|
* @param {String} jobId jobId
|
|
4856
4854
|
* @param {Object} opts Optional parameters
|
|
4857
4855
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4858
|
-
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4859
4856
|
*/
|
|
4860
4857
|
deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
4861
4858
|
opts = opts || {};
|
|
@@ -4947,7 +4944,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4947
4944
|
* @param {String} jobId jobId
|
|
4948
4945
|
* @param {Object} opts Optional parameters
|
|
4949
4946
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4950
|
-
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4951
4947
|
*/
|
|
4952
4948
|
deleteAnalyticsEvaluationsAggregatesJob(jobId, opts) {
|
|
4953
4949
|
opts = opts || {};
|
|
@@ -4978,7 +4974,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
4978
4974
|
* @param {String} jobId jobId
|
|
4979
4975
|
* @param {Object} opts Optional parameters
|
|
4980
4976
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
4981
|
-
* deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
4982
4977
|
*/
|
|
4983
4978
|
deleteAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
|
|
4984
4979
|
opts = opts || {};
|
|
@@ -5009,7 +5004,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5009
5004
|
* @param {String} jobId jobId
|
|
5010
5005
|
* @param {Object} opts Optional parameters
|
|
5011
5006
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5012
|
-
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5013
5007
|
*/
|
|
5014
5008
|
deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
5015
5009
|
opts = opts || {};
|
|
@@ -5040,7 +5034,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5040
5034
|
* @param {String} jobId jobId
|
|
5041
5035
|
* @param {Object} opts Optional parameters
|
|
5042
5036
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5043
|
-
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5044
5037
|
*/
|
|
5045
5038
|
deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
5046
5039
|
opts = opts || {};
|
|
@@ -5071,7 +5064,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5071
5064
|
* @param {String} jobId jobId
|
|
5072
5065
|
* @param {Object} opts Optional parameters
|
|
5073
5066
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5074
|
-
* deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5075
5067
|
*/
|
|
5076
5068
|
deleteAnalyticsKnowledgeAggregatesJob(jobId, opts) {
|
|
5077
5069
|
opts = opts || {};
|
|
@@ -5102,7 +5094,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5102
5094
|
* @param {String} jobId jobId
|
|
5103
5095
|
* @param {Object} opts Optional parameters
|
|
5104
5096
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5105
|
-
* deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5106
5097
|
*/
|
|
5107
5098
|
deleteAnalyticsResolutionsAggregatesJob(jobId, opts) {
|
|
5108
5099
|
opts = opts || {};
|
|
@@ -5133,7 +5124,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5133
5124
|
* @param {String} jobId jobId
|
|
5134
5125
|
* @param {Object} opts Optional parameters
|
|
5135
5126
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5136
|
-
* deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5137
5127
|
*/
|
|
5138
5128
|
deleteAnalyticsSummariesAggregatesJob(jobId, opts) {
|
|
5139
5129
|
opts = opts || {};
|
|
@@ -5164,7 +5154,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5164
5154
|
* @param {String} jobId jobId
|
|
5165
5155
|
* @param {Object} opts Optional parameters
|
|
5166
5156
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5167
|
-
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5168
5157
|
*/
|
|
5169
5158
|
deleteAnalyticsSurveysAggregatesJob(jobId, opts) {
|
|
5170
5159
|
opts = opts || {};
|
|
@@ -5195,7 +5184,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5195
5184
|
* @param {String} jobId jobId
|
|
5196
5185
|
* @param {Object} opts Optional parameters
|
|
5197
5186
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5198
|
-
* deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5199
5187
|
*/
|
|
5200
5188
|
deleteAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
|
|
5201
5189
|
opts = opts || {};
|
|
@@ -5226,7 +5214,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5226
5214
|
* @param {String} jobId jobId
|
|
5227
5215
|
* @param {Object} opts Optional parameters
|
|
5228
5216
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5229
|
-
* deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5230
5217
|
*/
|
|
5231
5218
|
deleteAnalyticsTranscriptsAggregatesJob(jobId, opts) {
|
|
5232
5219
|
opts = opts || {};
|
|
@@ -5257,7 +5244,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5257
5244
|
* @param {String} jobId jobId
|
|
5258
5245
|
* @param {Object} opts Optional parameters
|
|
5259
5246
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5260
|
-
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5261
5247
|
*/
|
|
5262
5248
|
deleteAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
5263
5249
|
opts = opts || {};
|
|
@@ -5318,7 +5304,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5318
5304
|
* @param {String} jobId jobId
|
|
5319
5305
|
* @param {Object} opts Optional parameters
|
|
5320
5306
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5321
|
-
* getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5322
5307
|
*/
|
|
5323
5308
|
getAnalyticsActionsAggregatesJob(jobId, opts) {
|
|
5324
5309
|
opts = opts || {};
|
|
@@ -5350,7 +5335,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5350
5335
|
* @param {Object} opts Optional parameters
|
|
5351
5336
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5352
5337
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5353
|
-
* getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5354
5338
|
*/
|
|
5355
5339
|
getAnalyticsActionsAggregatesJobResults(jobId, opts) {
|
|
5356
5340
|
opts = opts || {};
|
|
@@ -5647,7 +5631,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5647
5631
|
* @param {String} jobId jobId
|
|
5648
5632
|
* @param {Object} opts Optional parameters
|
|
5649
5633
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5650
|
-
* getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5651
5634
|
*/
|
|
5652
5635
|
getAnalyticsBotsAggregatesJob(jobId, opts) {
|
|
5653
5636
|
opts = opts || {};
|
|
@@ -5679,7 +5662,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5679
5662
|
* @param {Object} opts Optional parameters
|
|
5680
5663
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5681
5664
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5682
|
-
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5683
5665
|
*/
|
|
5684
5666
|
getAnalyticsBotsAggregatesJobResults(jobId, opts) {
|
|
5685
5667
|
opts = opts || {};
|
|
@@ -5710,7 +5692,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5710
5692
|
* @param {String} jobId jobId
|
|
5711
5693
|
* @param {Object} opts Optional parameters
|
|
5712
5694
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5713
|
-
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5714
5695
|
*/
|
|
5715
5696
|
getAnalyticsCasemanagementAggregatesJob(jobId, opts) {
|
|
5716
5697
|
opts = opts || {};
|
|
@@ -5742,7 +5723,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5742
5723
|
* @param {Object} opts Optional parameters
|
|
5743
5724
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5744
5725
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5745
|
-
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5746
5726
|
*/
|
|
5747
5727
|
getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
|
|
5748
5728
|
opts = opts || {};
|
|
@@ -5803,7 +5783,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5803
5783
|
* @param {String} jobId jobId
|
|
5804
5784
|
* @param {Object} opts Optional parameters
|
|
5805
5785
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5806
|
-
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5807
5786
|
*/
|
|
5808
5787
|
getAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
5809
5788
|
opts = opts || {};
|
|
@@ -5835,7 +5814,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
5835
5814
|
* @param {Object} opts Optional parameters
|
|
5836
5815
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
5837
5816
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
5838
|
-
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
5839
5817
|
*/
|
|
5840
5818
|
getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
|
|
5841
5819
|
opts = opts || {};
|
|
@@ -6130,7 +6108,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6130
6108
|
* @param {String} jobId jobId
|
|
6131
6109
|
* @param {Object} opts Optional parameters
|
|
6132
6110
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6133
|
-
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6134
6111
|
*/
|
|
6135
6112
|
getAnalyticsEvaluationsAggregatesJob(jobId, opts) {
|
|
6136
6113
|
opts = opts || {};
|
|
@@ -6162,7 +6139,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6162
6139
|
* @param {Object} opts Optional parameters
|
|
6163
6140
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6164
6141
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6165
|
-
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6166
6142
|
*/
|
|
6167
6143
|
getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
|
|
6168
6144
|
opts = opts || {};
|
|
@@ -6193,7 +6169,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6193
6169
|
* @param {String} jobId jobId
|
|
6194
6170
|
* @param {Object} opts Optional parameters
|
|
6195
6171
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6196
|
-
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6197
6172
|
*/
|
|
6198
6173
|
getAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
|
|
6199
6174
|
opts = opts || {};
|
|
@@ -6225,7 +6200,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6225
6200
|
* @param {Object} opts Optional parameters
|
|
6226
6201
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6227
6202
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6228
|
-
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6229
6203
|
*/
|
|
6230
6204
|
getAnalyticsFlowexecutionsAggregatesJobResults(jobId, opts) {
|
|
6231
6205
|
opts = opts || {};
|
|
@@ -6256,7 +6230,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6256
6230
|
* @param {String} jobId jobId
|
|
6257
6231
|
* @param {Object} opts Optional parameters
|
|
6258
6232
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6259
|
-
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6260
6233
|
*/
|
|
6261
6234
|
getAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
6262
6235
|
opts = opts || {};
|
|
@@ -6288,7 +6261,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6288
6261
|
* @param {Object} opts Optional parameters
|
|
6289
6262
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6290
6263
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6291
|
-
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6292
6264
|
*/
|
|
6293
6265
|
getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
|
|
6294
6266
|
opts = opts || {};
|
|
@@ -6319,7 +6291,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6319
6291
|
* @param {String} jobId jobId
|
|
6320
6292
|
* @param {Object} opts Optional parameters
|
|
6321
6293
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6322
|
-
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6323
6294
|
*/
|
|
6324
6295
|
getAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
6325
6296
|
opts = opts || {};
|
|
@@ -6351,7 +6322,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6351
6322
|
* @param {Object} opts Optional parameters
|
|
6352
6323
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6353
6324
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6354
|
-
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6355
6325
|
*/
|
|
6356
6326
|
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
6357
6327
|
opts = opts || {};
|
|
@@ -6382,7 +6352,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6382
6352
|
* @param {String} jobId jobId
|
|
6383
6353
|
* @param {Object} opts Optional parameters
|
|
6384
6354
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6385
|
-
* getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6386
6355
|
*/
|
|
6387
6356
|
getAnalyticsKnowledgeAggregatesJob(jobId, opts) {
|
|
6388
6357
|
opts = opts || {};
|
|
@@ -6414,7 +6383,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6414
6383
|
* @param {Object} opts Optional parameters
|
|
6415
6384
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6416
6385
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6417
|
-
* getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6418
6386
|
*/
|
|
6419
6387
|
getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
|
|
6420
6388
|
opts = opts || {};
|
|
@@ -6660,7 +6628,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6660
6628
|
* @param {String} jobId jobId
|
|
6661
6629
|
* @param {Object} opts Optional parameters
|
|
6662
6630
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6663
|
-
* getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6664
6631
|
*/
|
|
6665
6632
|
getAnalyticsResolutionsAggregatesJob(jobId, opts) {
|
|
6666
6633
|
opts = opts || {};
|
|
@@ -6692,7 +6659,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6692
6659
|
* @param {Object} opts Optional parameters
|
|
6693
6660
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6694
6661
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6695
|
-
* getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6696
6662
|
*/
|
|
6697
6663
|
getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
|
|
6698
6664
|
opts = opts || {};
|
|
@@ -6723,7 +6689,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6723
6689
|
* @param {String} jobId jobId
|
|
6724
6690
|
* @param {Object} opts Optional parameters
|
|
6725
6691
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6726
|
-
* getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6727
6692
|
*/
|
|
6728
6693
|
getAnalyticsSummariesAggregatesJob(jobId, opts) {
|
|
6729
6694
|
opts = opts || {};
|
|
@@ -6755,7 +6720,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6755
6720
|
* @param {Object} opts Optional parameters
|
|
6756
6721
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6757
6722
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6758
|
-
* getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6759
6723
|
*/
|
|
6760
6724
|
getAnalyticsSummariesAggregatesJobResults(jobId, opts) {
|
|
6761
6725
|
opts = opts || {};
|
|
@@ -6786,7 +6750,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6786
6750
|
* @param {String} jobId jobId
|
|
6787
6751
|
* @param {Object} opts Optional parameters
|
|
6788
6752
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6789
|
-
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6790
6753
|
*/
|
|
6791
6754
|
getAnalyticsSurveysAggregatesJob(jobId, opts) {
|
|
6792
6755
|
opts = opts || {};
|
|
@@ -6818,7 +6781,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6818
6781
|
* @param {Object} opts Optional parameters
|
|
6819
6782
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6820
6783
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6821
|
-
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6822
6784
|
*/
|
|
6823
6785
|
getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
|
|
6824
6786
|
opts = opts || {};
|
|
@@ -6849,7 +6811,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6849
6811
|
* @param {String} jobId jobId
|
|
6850
6812
|
* @param {Object} opts Optional parameters
|
|
6851
6813
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6852
|
-
* getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6853
6814
|
*/
|
|
6854
6815
|
getAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
|
|
6855
6816
|
opts = opts || {};
|
|
@@ -6881,7 +6842,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6881
6842
|
* @param {Object} opts Optional parameters
|
|
6882
6843
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6883
6844
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6884
|
-
* getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6885
6845
|
*/
|
|
6886
6846
|
getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
|
|
6887
6847
|
opts = opts || {};
|
|
@@ -6912,7 +6872,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6912
6872
|
* @param {String} jobId jobId
|
|
6913
6873
|
* @param {Object} opts Optional parameters
|
|
6914
6874
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6915
|
-
* getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6916
6875
|
*/
|
|
6917
6876
|
getAnalyticsTranscriptsAggregatesJob(jobId, opts) {
|
|
6918
6877
|
opts = opts || {};
|
|
@@ -6944,7 +6903,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6944
6903
|
* @param {Object} opts Optional parameters
|
|
6945
6904
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
6946
6905
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6947
|
-
* getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6948
6906
|
*/
|
|
6949
6907
|
getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
|
|
6950
6908
|
opts = opts || {};
|
|
@@ -6975,7 +6933,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
6975
6933
|
* @param {String} jobId jobId
|
|
6976
6934
|
* @param {Object} opts Optional parameters
|
|
6977
6935
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
6978
|
-
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
6979
6936
|
*/
|
|
6980
6937
|
getAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
6981
6938
|
opts = opts || {};
|
|
@@ -7007,7 +6964,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7007
6964
|
* @param {Object} opts Optional parameters
|
|
7008
6965
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
7009
6966
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7010
|
-
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7011
6967
|
*/
|
|
7012
6968
|
getAnalyticsUsersAggregatesJobResults(jobId, opts) {
|
|
7013
6969
|
opts = opts || {};
|
|
@@ -7155,7 +7111,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7155
7111
|
* @param {Object} body query
|
|
7156
7112
|
* @param {Object} opts Optional parameters
|
|
7157
7113
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7158
|
-
* postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7159
7114
|
*/
|
|
7160
7115
|
postAnalyticsActionsAggregatesJobs(body, opts) {
|
|
7161
7116
|
opts = opts || {};
|
|
@@ -7400,7 +7355,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7400
7355
|
* @param {Object} body query
|
|
7401
7356
|
* @param {Object} opts Optional parameters
|
|
7402
7357
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7403
|
-
* postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7404
7358
|
*/
|
|
7405
7359
|
postAnalyticsBotsAggregatesJobs(body, opts) {
|
|
7406
7360
|
opts = opts || {};
|
|
@@ -7461,7 +7415,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7461
7415
|
* @param {Object} body query
|
|
7462
7416
|
* @param {Object} opts Optional parameters
|
|
7463
7417
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7464
|
-
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7465
7418
|
*/
|
|
7466
7419
|
postAnalyticsCasemanagementAggregatesJobs(body, opts) {
|
|
7467
7420
|
opts = opts || {};
|
|
@@ -7492,7 +7445,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7492
7445
|
* @param {Object} body query
|
|
7493
7446
|
* @param {Object} opts Optional parameters
|
|
7494
7447
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7495
|
-
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7496
7448
|
*/
|
|
7497
7449
|
postAnalyticsCasemanagementAggregatesQuery(body, opts) {
|
|
7498
7450
|
opts = opts || {};
|
|
@@ -7590,7 +7542,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7590
7542
|
* @param {Object} body query
|
|
7591
7543
|
* @param {Object} opts Optional parameters
|
|
7592
7544
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7593
|
-
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7594
7545
|
*/
|
|
7595
7546
|
postAnalyticsConversationsAggregatesJobs(body, opts) {
|
|
7596
7547
|
opts = opts || {};
|
|
@@ -7804,7 +7755,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7804
7755
|
* @param {Object} body query
|
|
7805
7756
|
* @param {Object} opts Optional parameters
|
|
7806
7757
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7807
|
-
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7808
7758
|
*/
|
|
7809
7759
|
postAnalyticsEvaluationsAggregatesJobs(body, opts) {
|
|
7810
7760
|
opts = opts || {};
|
|
@@ -7865,7 +7815,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7865
7815
|
* @param {Object} body query
|
|
7866
7816
|
* @param {Object} opts Optional parameters
|
|
7867
7817
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7868
|
-
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7869
7818
|
*/
|
|
7870
7819
|
postAnalyticsFlowexecutionsAggregatesJobs(body, opts) {
|
|
7871
7820
|
opts = opts || {};
|
|
@@ -7958,7 +7907,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
7958
7907
|
* @param {Object} body query
|
|
7959
7908
|
* @param {Object} opts Optional parameters
|
|
7960
7909
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
7961
|
-
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
7962
7910
|
*/
|
|
7963
7911
|
postAnalyticsFlowsAggregatesJobs(body, opts) {
|
|
7964
7912
|
opts = opts || {};
|
|
@@ -8049,7 +7997,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8049
7997
|
* @param {Object} body query
|
|
8050
7998
|
* @param {Object} opts Optional parameters
|
|
8051
7999
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8052
|
-
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8053
8000
|
*/
|
|
8054
8001
|
postAnalyticsJourneysAggregatesJobs(body, opts) {
|
|
8055
8002
|
opts = opts || {};
|
|
@@ -8110,7 +8057,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8110
8057
|
* @param {Object} body query
|
|
8111
8058
|
* @param {Object} opts Optional parameters
|
|
8112
8059
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8113
|
-
* postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8114
8060
|
*/
|
|
8115
8061
|
postAnalyticsKnowledgeAggregatesJobs(body, opts) {
|
|
8116
8062
|
opts = opts || {};
|
|
@@ -8351,7 +8297,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8351
8297
|
* @param {Object} body query
|
|
8352
8298
|
* @param {Object} opts Optional parameters
|
|
8353
8299
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8354
|
-
* postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8355
8300
|
*/
|
|
8356
8301
|
postAnalyticsResolutionsAggregatesJobs(body, opts) {
|
|
8357
8302
|
opts = opts || {};
|
|
@@ -8444,7 +8389,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8444
8389
|
* @param {Object} body query
|
|
8445
8390
|
* @param {Object} opts Optional parameters
|
|
8446
8391
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8447
|
-
* postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8448
8392
|
*/
|
|
8449
8393
|
postAnalyticsSummariesAggregatesJobs(body, opts) {
|
|
8450
8394
|
opts = opts || {};
|
|
@@ -8505,7 +8449,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8505
8449
|
* @param {Object} body query
|
|
8506
8450
|
* @param {Object} opts Optional parameters
|
|
8507
8451
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8508
|
-
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8509
8452
|
*/
|
|
8510
8453
|
postAnalyticsSurveysAggregatesJobs(body, opts) {
|
|
8511
8454
|
opts = opts || {};
|
|
@@ -8566,7 +8509,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8566
8509
|
* @param {Object} body query
|
|
8567
8510
|
* @param {Object} opts Optional parameters
|
|
8568
8511
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8569
|
-
* postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8570
8512
|
*/
|
|
8571
8513
|
postAnalyticsTaskmanagementAggregatesJobs(body, opts) {
|
|
8572
8514
|
opts = opts || {};
|
|
@@ -8691,7 +8633,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8691
8633
|
* @param {Object} body query
|
|
8692
8634
|
* @param {Object} opts Optional parameters
|
|
8693
8635
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8694
|
-
* postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8695
8636
|
*/
|
|
8696
8637
|
postAnalyticsTranscriptsAggregatesJobs(body, opts) {
|
|
8697
8638
|
opts = opts || {};
|
|
@@ -8784,7 +8725,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8784
8725
|
* @param {Object} body query
|
|
8785
8726
|
* @param {Object} opts Optional parameters
|
|
8786
8727
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
8787
|
-
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
8788
8728
|
*/
|
|
8789
8729
|
postAnalyticsUsersAggregatesJobs(body, opts) {
|
|
8790
8730
|
opts = opts || {};
|
|
@@ -8965,7 +8905,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
8965
8905
|
/**
|
|
8966
8906
|
* Architect service.
|
|
8967
8907
|
* @module purecloud-platform-client-v2/api/ArchitectApi
|
|
8968
|
-
* @version
|
|
8908
|
+
* @version 254.0.0
|
|
8969
8909
|
*/
|
|
8970
8910
|
|
|
8971
8911
|
/**
|
|
@@ -13219,6 +13159,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13219
13159
|
* Register Architect Job. Returns a URL where a file, such as an Architect flow YAML file, can be PUT which will then initiate the job.
|
|
13220
13160
|
*
|
|
13221
13161
|
* @param {Object} opts Optional parameters
|
|
13162
|
+
* @param {Object} opts.body
|
|
13222
13163
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
13223
13164
|
*/
|
|
13224
13165
|
postFlowsJobs(opts) {
|
|
@@ -13232,7 +13173,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13232
13173
|
{ },
|
|
13233
13174
|
{ },
|
|
13234
13175
|
{ },
|
|
13235
|
-
|
|
13176
|
+
opts['body'],
|
|
13236
13177
|
['PureCloud OAuth'],
|
|
13237
13178
|
['application/json'],
|
|
13238
13179
|
['application/json'],
|
|
@@ -13824,7 +13765,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
13824
13765
|
/**
|
|
13825
13766
|
* AssistantCopilotVariations service.
|
|
13826
13767
|
* @module purecloud-platform-client-v2/api/AssistantCopilotVariationsApi
|
|
13827
|
-
* @version
|
|
13768
|
+
* @version 254.0.0
|
|
13828
13769
|
*/
|
|
13829
13770
|
|
|
13830
13771
|
/**
|
|
@@ -14020,7 +13961,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14020
13961
|
/**
|
|
14021
13962
|
* Audit service.
|
|
14022
13963
|
* @module purecloud-platform-client-v2/api/AuditApi
|
|
14023
|
-
* @version
|
|
13964
|
+
* @version 254.0.0
|
|
14024
13965
|
*/
|
|
14025
13966
|
|
|
14026
13967
|
/**
|
|
@@ -14247,7 +14188,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
14247
14188
|
/**
|
|
14248
14189
|
* Authorization service.
|
|
14249
14190
|
* @module purecloud-platform-client-v2/api/AuthorizationApi
|
|
14250
|
-
* @version
|
|
14191
|
+
* @version 254.0.0
|
|
14251
14192
|
*/
|
|
14252
14193
|
|
|
14253
14194
|
/**
|
|
@@ -16172,7 +16113,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16172
16113
|
/**
|
|
16173
16114
|
* BackgroundAssistant service.
|
|
16174
16115
|
* @module purecloud-platform-client-v2/api/BackgroundAssistantApi
|
|
16175
|
-
* @version
|
|
16116
|
+
* @version 254.0.0
|
|
16176
16117
|
*/
|
|
16177
16118
|
|
|
16178
16119
|
/**
|
|
@@ -16246,7 +16187,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16246
16187
|
/**
|
|
16247
16188
|
* Billing service.
|
|
16248
16189
|
* @module purecloud-platform-client-v2/api/BillingApi
|
|
16249
|
-
* @version
|
|
16190
|
+
* @version 254.0.0
|
|
16250
16191
|
*/
|
|
16251
16192
|
|
|
16252
16193
|
/**
|
|
@@ -16530,7 +16471,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16530
16471
|
/**
|
|
16531
16472
|
* BusinessRules service.
|
|
16532
16473
|
* @module purecloud-platform-client-v2/api/BusinessRulesApi
|
|
16533
|
-
* @version
|
|
16474
|
+
* @version 254.0.0
|
|
16534
16475
|
*/
|
|
16535
16476
|
|
|
16536
16477
|
/**
|
|
@@ -16576,6 +16517,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16576
16517
|
);
|
|
16577
16518
|
}
|
|
16578
16519
|
|
|
16520
|
+
/**
|
|
16521
|
+
* Delete an export job for a decision table
|
|
16522
|
+
*
|
|
16523
|
+
* @param {String} tableId Table ID
|
|
16524
|
+
* @param {String} exportJobId Export Job ID
|
|
16525
|
+
* @param {Object} opts Optional parameters
|
|
16526
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16527
|
+
*/
|
|
16528
|
+
deleteBusinessrulesDecisiontableExport(tableId, exportJobId, opts) {
|
|
16529
|
+
opts = opts || {};
|
|
16530
|
+
|
|
16531
|
+
// verify the required parameter 'tableId' is set
|
|
16532
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
16533
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableExport';
|
|
16534
|
+
}
|
|
16535
|
+
// verify the required parameter 'exportJobId' is set
|
|
16536
|
+
if (exportJobId === undefined || exportJobId === null || exportJobId === '') {
|
|
16537
|
+
throw 'Missing the required parameter "exportJobId" when calling deleteBusinessrulesDecisiontableExport';
|
|
16538
|
+
}
|
|
16539
|
+
|
|
16540
|
+
return this.apiClient.callApi(
|
|
16541
|
+
'/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}',
|
|
16542
|
+
'DELETE',
|
|
16543
|
+
{ 'tableId': tableId,'exportJobId': exportJobId },
|
|
16544
|
+
{ },
|
|
16545
|
+
{ },
|
|
16546
|
+
{ },
|
|
16547
|
+
null,
|
|
16548
|
+
['PureCloud OAuth'],
|
|
16549
|
+
['application/json'],
|
|
16550
|
+
['application/json'],
|
|
16551
|
+
opts['customHeaders']
|
|
16552
|
+
);
|
|
16553
|
+
}
|
|
16554
|
+
|
|
16555
|
+
/**
|
|
16556
|
+
* Delete decision table row import job
|
|
16557
|
+
*
|
|
16558
|
+
* @param {String} tableId Table ID
|
|
16559
|
+
* @param {String} importJobId Import job ID
|
|
16560
|
+
* @param {Object} opts Optional parameters
|
|
16561
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16562
|
+
*/
|
|
16563
|
+
deleteBusinessrulesDecisiontableImport(tableId, importJobId, opts) {
|
|
16564
|
+
opts = opts || {};
|
|
16565
|
+
|
|
16566
|
+
// verify the required parameter 'tableId' is set
|
|
16567
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
16568
|
+
throw 'Missing the required parameter "tableId" when calling deleteBusinessrulesDecisiontableImport';
|
|
16569
|
+
}
|
|
16570
|
+
// verify the required parameter 'importJobId' is set
|
|
16571
|
+
if (importJobId === undefined || importJobId === null || importJobId === '') {
|
|
16572
|
+
throw 'Missing the required parameter "importJobId" when calling deleteBusinessrulesDecisiontableImport';
|
|
16573
|
+
}
|
|
16574
|
+
|
|
16575
|
+
return this.apiClient.callApi(
|
|
16576
|
+
'/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
|
|
16577
|
+
'DELETE',
|
|
16578
|
+
{ 'tableId': tableId,'importJobId': importJobId },
|
|
16579
|
+
{ },
|
|
16580
|
+
{ },
|
|
16581
|
+
{ },
|
|
16582
|
+
null,
|
|
16583
|
+
['PureCloud OAuth'],
|
|
16584
|
+
['application/json'],
|
|
16585
|
+
['application/json'],
|
|
16586
|
+
opts['customHeaders']
|
|
16587
|
+
);
|
|
16588
|
+
}
|
|
16589
|
+
|
|
16579
16590
|
/**
|
|
16580
16591
|
* Delete a decision table version
|
|
16581
16592
|
*
|
|
@@ -16711,6 +16722,140 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
16711
16722
|
);
|
|
16712
16723
|
}
|
|
16713
16724
|
|
|
16725
|
+
/**
|
|
16726
|
+
* Get an export job for a decision table
|
|
16727
|
+
*
|
|
16728
|
+
* @param {String} tableId Table ID
|
|
16729
|
+
* @param {String} exportJobId Export Job ID
|
|
16730
|
+
* @param {Object} opts Optional parameters
|
|
16731
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16732
|
+
*/
|
|
16733
|
+
getBusinessrulesDecisiontableExport(tableId, exportJobId, opts) {
|
|
16734
|
+
opts = opts || {};
|
|
16735
|
+
|
|
16736
|
+
// verify the required parameter 'tableId' is set
|
|
16737
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
16738
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExport';
|
|
16739
|
+
}
|
|
16740
|
+
// verify the required parameter 'exportJobId' is set
|
|
16741
|
+
if (exportJobId === undefined || exportJobId === null || exportJobId === '') {
|
|
16742
|
+
throw 'Missing the required parameter "exportJobId" when calling getBusinessrulesDecisiontableExport';
|
|
16743
|
+
}
|
|
16744
|
+
|
|
16745
|
+
return this.apiClient.callApi(
|
|
16746
|
+
'/api/v2/businessrules/decisiontables/{tableId}/exports/{exportJobId}',
|
|
16747
|
+
'GET',
|
|
16748
|
+
{ 'tableId': tableId,'exportJobId': exportJobId },
|
|
16749
|
+
{ },
|
|
16750
|
+
{ },
|
|
16751
|
+
{ },
|
|
16752
|
+
null,
|
|
16753
|
+
['PureCloud OAuth'],
|
|
16754
|
+
['application/json'],
|
|
16755
|
+
['application/json'],
|
|
16756
|
+
opts['customHeaders']
|
|
16757
|
+
);
|
|
16758
|
+
}
|
|
16759
|
+
|
|
16760
|
+
/**
|
|
16761
|
+
* List export jobs for a decision table
|
|
16762
|
+
*
|
|
16763
|
+
* @param {String} tableId Table ID
|
|
16764
|
+
* @param {Object} opts Optional parameters
|
|
16765
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16766
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
16767
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16768
|
+
*/
|
|
16769
|
+
getBusinessrulesDecisiontableExports(tableId, opts) {
|
|
16770
|
+
opts = opts || {};
|
|
16771
|
+
|
|
16772
|
+
// verify the required parameter 'tableId' is set
|
|
16773
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
16774
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableExports';
|
|
16775
|
+
}
|
|
16776
|
+
|
|
16777
|
+
return this.apiClient.callApi(
|
|
16778
|
+
'/api/v2/businessrules/decisiontables/{tableId}/exports',
|
|
16779
|
+
'GET',
|
|
16780
|
+
{ 'tableId': tableId },
|
|
16781
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
16782
|
+
{ },
|
|
16783
|
+
{ },
|
|
16784
|
+
null,
|
|
16785
|
+
['PureCloud OAuth'],
|
|
16786
|
+
['application/json'],
|
|
16787
|
+
['application/json'],
|
|
16788
|
+
opts['customHeaders']
|
|
16789
|
+
);
|
|
16790
|
+
}
|
|
16791
|
+
|
|
16792
|
+
/**
|
|
16793
|
+
* Get decision table row import job
|
|
16794
|
+
*
|
|
16795
|
+
* @param {String} tableId Table ID
|
|
16796
|
+
* @param {String} importJobId Import job ID
|
|
16797
|
+
* @param {Object} opts Optional parameters
|
|
16798
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16799
|
+
*/
|
|
16800
|
+
getBusinessrulesDecisiontableImport(tableId, importJobId, opts) {
|
|
16801
|
+
opts = opts || {};
|
|
16802
|
+
|
|
16803
|
+
// verify the required parameter 'tableId' is set
|
|
16804
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
16805
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImport';
|
|
16806
|
+
}
|
|
16807
|
+
// verify the required parameter 'importJobId' is set
|
|
16808
|
+
if (importJobId === undefined || importJobId === null || importJobId === '') {
|
|
16809
|
+
throw 'Missing the required parameter "importJobId" when calling getBusinessrulesDecisiontableImport';
|
|
16810
|
+
}
|
|
16811
|
+
|
|
16812
|
+
return this.apiClient.callApi(
|
|
16813
|
+
'/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
|
|
16814
|
+
'GET',
|
|
16815
|
+
{ 'tableId': tableId,'importJobId': importJobId },
|
|
16816
|
+
{ },
|
|
16817
|
+
{ },
|
|
16818
|
+
{ },
|
|
16819
|
+
null,
|
|
16820
|
+
['PureCloud OAuth'],
|
|
16821
|
+
['application/json'],
|
|
16822
|
+
['application/json'],
|
|
16823
|
+
opts['customHeaders']
|
|
16824
|
+
);
|
|
16825
|
+
}
|
|
16826
|
+
|
|
16827
|
+
/**
|
|
16828
|
+
* List decision table row import jobs
|
|
16829
|
+
*
|
|
16830
|
+
* @param {String} tableId Table ID
|
|
16831
|
+
* @param {Object} opts Optional parameters
|
|
16832
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
16833
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 100.
|
|
16834
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
16835
|
+
*/
|
|
16836
|
+
getBusinessrulesDecisiontableImports(tableId, opts) {
|
|
16837
|
+
opts = opts || {};
|
|
16838
|
+
|
|
16839
|
+
// verify the required parameter 'tableId' is set
|
|
16840
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
16841
|
+
throw 'Missing the required parameter "tableId" when calling getBusinessrulesDecisiontableImports';
|
|
16842
|
+
}
|
|
16843
|
+
|
|
16844
|
+
return this.apiClient.callApi(
|
|
16845
|
+
'/api/v2/businessrules/decisiontables/{tableId}/imports',
|
|
16846
|
+
'GET',
|
|
16847
|
+
{ 'tableId': tableId },
|
|
16848
|
+
{ 'after': opts['after'],'pageSize': opts['pageSize'] },
|
|
16849
|
+
{ },
|
|
16850
|
+
{ },
|
|
16851
|
+
null,
|
|
16852
|
+
['PureCloud OAuth'],
|
|
16853
|
+
['application/json'],
|
|
16854
|
+
['application/json'],
|
|
16855
|
+
opts['customHeaders']
|
|
16856
|
+
);
|
|
16857
|
+
}
|
|
16858
|
+
|
|
16714
16859
|
/**
|
|
16715
16860
|
* Get a decision table version
|
|
16716
16861
|
*
|
|
@@ -17061,6 +17206,46 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17061
17206
|
);
|
|
17062
17207
|
}
|
|
17063
17208
|
|
|
17209
|
+
/**
|
|
17210
|
+
* Update decision table row import job
|
|
17211
|
+
*
|
|
17212
|
+
* @param {String} tableId Table ID
|
|
17213
|
+
* @param {String} importJobId Import job ID
|
|
17214
|
+
* @param {Object} body Import job update request
|
|
17215
|
+
* @param {Object} opts Optional parameters
|
|
17216
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17217
|
+
*/
|
|
17218
|
+
patchBusinessrulesDecisiontableImport(tableId, importJobId, body, opts) {
|
|
17219
|
+
opts = opts || {};
|
|
17220
|
+
|
|
17221
|
+
// verify the required parameter 'tableId' is set
|
|
17222
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
17223
|
+
throw 'Missing the required parameter "tableId" when calling patchBusinessrulesDecisiontableImport';
|
|
17224
|
+
}
|
|
17225
|
+
// verify the required parameter 'importJobId' is set
|
|
17226
|
+
if (importJobId === undefined || importJobId === null || importJobId === '') {
|
|
17227
|
+
throw 'Missing the required parameter "importJobId" when calling patchBusinessrulesDecisiontableImport';
|
|
17228
|
+
}
|
|
17229
|
+
// verify the required parameter 'body' is set
|
|
17230
|
+
if (body === undefined || body === null) {
|
|
17231
|
+
throw 'Missing the required parameter "body" when calling patchBusinessrulesDecisiontableImport';
|
|
17232
|
+
}
|
|
17233
|
+
|
|
17234
|
+
return this.apiClient.callApi(
|
|
17235
|
+
'/api/v2/businessrules/decisiontables/{tableId}/imports/{importJobId}',
|
|
17236
|
+
'PATCH',
|
|
17237
|
+
{ 'tableId': tableId,'importJobId': importJobId },
|
|
17238
|
+
{ },
|
|
17239
|
+
{ },
|
|
17240
|
+
{ },
|
|
17241
|
+
body,
|
|
17242
|
+
['PureCloud OAuth'],
|
|
17243
|
+
['application/json'],
|
|
17244
|
+
['application/json'],
|
|
17245
|
+
opts['customHeaders']
|
|
17246
|
+
);
|
|
17247
|
+
}
|
|
17248
|
+
|
|
17064
17249
|
/**
|
|
17065
17250
|
* Update a decision table version
|
|
17066
17251
|
*
|
|
@@ -17136,6 +17321,76 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17136
17321
|
);
|
|
17137
17322
|
}
|
|
17138
17323
|
|
|
17324
|
+
/**
|
|
17325
|
+
* Create an export job for a decision table version
|
|
17326
|
+
*
|
|
17327
|
+
* @param {String} tableId Table ID
|
|
17328
|
+
* @param {Object} body Export job request
|
|
17329
|
+
* @param {Object} opts Optional parameters
|
|
17330
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17331
|
+
*/
|
|
17332
|
+
postBusinessrulesDecisiontableExports(tableId, body, opts) {
|
|
17333
|
+
opts = opts || {};
|
|
17334
|
+
|
|
17335
|
+
// verify the required parameter 'tableId' is set
|
|
17336
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
17337
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableExports';
|
|
17338
|
+
}
|
|
17339
|
+
// verify the required parameter 'body' is set
|
|
17340
|
+
if (body === undefined || body === null) {
|
|
17341
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableExports';
|
|
17342
|
+
}
|
|
17343
|
+
|
|
17344
|
+
return this.apiClient.callApi(
|
|
17345
|
+
'/api/v2/businessrules/decisiontables/{tableId}/exports',
|
|
17346
|
+
'POST',
|
|
17347
|
+
{ 'tableId': tableId },
|
|
17348
|
+
{ },
|
|
17349
|
+
{ },
|
|
17350
|
+
{ },
|
|
17351
|
+
body,
|
|
17352
|
+
['PureCloud OAuth'],
|
|
17353
|
+
['application/json'],
|
|
17354
|
+
['application/json'],
|
|
17355
|
+
opts['customHeaders']
|
|
17356
|
+
);
|
|
17357
|
+
}
|
|
17358
|
+
|
|
17359
|
+
/**
|
|
17360
|
+
* Create a decision table row import job
|
|
17361
|
+
*
|
|
17362
|
+
* @param {String} tableId Table ID
|
|
17363
|
+
* @param {Object} body Import job create request
|
|
17364
|
+
* @param {Object} opts Optional parameters
|
|
17365
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17366
|
+
*/
|
|
17367
|
+
postBusinessrulesDecisiontableImports(tableId, body, opts) {
|
|
17368
|
+
opts = opts || {};
|
|
17369
|
+
|
|
17370
|
+
// verify the required parameter 'tableId' is set
|
|
17371
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
17372
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableImports';
|
|
17373
|
+
}
|
|
17374
|
+
// verify the required parameter 'body' is set
|
|
17375
|
+
if (body === undefined || body === null) {
|
|
17376
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableImports';
|
|
17377
|
+
}
|
|
17378
|
+
|
|
17379
|
+
return this.apiClient.callApi(
|
|
17380
|
+
'/api/v2/businessrules/decisiontables/{tableId}/imports',
|
|
17381
|
+
'POST',
|
|
17382
|
+
{ 'tableId': tableId },
|
|
17383
|
+
{ },
|
|
17384
|
+
{ },
|
|
17385
|
+
{ },
|
|
17386
|
+
body,
|
|
17387
|
+
['PureCloud OAuth'],
|
|
17388
|
+
['application/json'],
|
|
17389
|
+
['application/json'],
|
|
17390
|
+
opts['customHeaders']
|
|
17391
|
+
);
|
|
17392
|
+
}
|
|
17393
|
+
|
|
17139
17394
|
/**
|
|
17140
17395
|
* Copy a decision table version
|
|
17141
17396
|
*
|
|
@@ -17256,6 +17511,126 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17256
17511
|
);
|
|
17257
17512
|
}
|
|
17258
17513
|
|
|
17514
|
+
/**
|
|
17515
|
+
* Bulk add decision table rows
|
|
17516
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
17517
|
+
* @param {String} tableId Table ID
|
|
17518
|
+
* @param {Number} tableVersion Table Version
|
|
17519
|
+
* @param {Object} body Bulk add decision table rows request
|
|
17520
|
+
* @param {Object} opts Optional parameters
|
|
17521
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17522
|
+
*/
|
|
17523
|
+
postBusinessrulesDecisiontableVersionRowsBulkAdd(tableId, tableVersion, body, opts) {
|
|
17524
|
+
opts = opts || {};
|
|
17525
|
+
|
|
17526
|
+
// verify the required parameter 'tableId' is set
|
|
17527
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
17528
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
|
|
17529
|
+
}
|
|
17530
|
+
// verify the required parameter 'tableVersion' is set
|
|
17531
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
17532
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
|
|
17533
|
+
}
|
|
17534
|
+
// verify the required parameter 'body' is set
|
|
17535
|
+
if (body === undefined || body === null) {
|
|
17536
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkAdd';
|
|
17537
|
+
}
|
|
17538
|
+
|
|
17539
|
+
return this.apiClient.callApi(
|
|
17540
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/add',
|
|
17541
|
+
'POST',
|
|
17542
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
17543
|
+
{ },
|
|
17544
|
+
{ },
|
|
17545
|
+
{ },
|
|
17546
|
+
body,
|
|
17547
|
+
['PureCloud OAuth'],
|
|
17548
|
+
['application/json'],
|
|
17549
|
+
['application/json'],
|
|
17550
|
+
opts['customHeaders']
|
|
17551
|
+
);
|
|
17552
|
+
}
|
|
17553
|
+
|
|
17554
|
+
/**
|
|
17555
|
+
* Bulk delete decision table rows
|
|
17556
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
17557
|
+
* @param {String} tableId Table ID
|
|
17558
|
+
* @param {Number} tableVersion Table Version
|
|
17559
|
+
* @param {Object} body
|
|
17560
|
+
* @param {Object} opts Optional parameters
|
|
17561
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17562
|
+
*/
|
|
17563
|
+
postBusinessrulesDecisiontableVersionRowsBulkRemove(tableId, tableVersion, body, opts) {
|
|
17564
|
+
opts = opts || {};
|
|
17565
|
+
|
|
17566
|
+
// verify the required parameter 'tableId' is set
|
|
17567
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
17568
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
|
|
17569
|
+
}
|
|
17570
|
+
// verify the required parameter 'tableVersion' is set
|
|
17571
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
17572
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
|
|
17573
|
+
}
|
|
17574
|
+
// verify the required parameter 'body' is set
|
|
17575
|
+
if (body === undefined || body === null) {
|
|
17576
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkRemove';
|
|
17577
|
+
}
|
|
17578
|
+
|
|
17579
|
+
return this.apiClient.callApi(
|
|
17580
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/remove',
|
|
17581
|
+
'POST',
|
|
17582
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
17583
|
+
{ },
|
|
17584
|
+
{ },
|
|
17585
|
+
{ },
|
|
17586
|
+
body,
|
|
17587
|
+
['PureCloud OAuth'],
|
|
17588
|
+
['application/json'],
|
|
17589
|
+
['application/json'],
|
|
17590
|
+
opts['customHeaders']
|
|
17591
|
+
);
|
|
17592
|
+
}
|
|
17593
|
+
|
|
17594
|
+
/**
|
|
17595
|
+
* Bulk update decision table rows
|
|
17596
|
+
* Required permissions depend on table content: if the table or row contains queue references, routing:queue:view is required in each queues division. Future platform objects will require their associated permissions in the relevant divisions when the table or row contains references to them.
|
|
17597
|
+
* @param {String} tableId Table ID
|
|
17598
|
+
* @param {Number} tableVersion Table Version
|
|
17599
|
+
* @param {Object} body Bulk update decision table rows request
|
|
17600
|
+
* @param {Object} opts Optional parameters
|
|
17601
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17602
|
+
*/
|
|
17603
|
+
postBusinessrulesDecisiontableVersionRowsBulkUpdate(tableId, tableVersion, body, opts) {
|
|
17604
|
+
opts = opts || {};
|
|
17605
|
+
|
|
17606
|
+
// verify the required parameter 'tableId' is set
|
|
17607
|
+
if (tableId === undefined || tableId === null || tableId === '') {
|
|
17608
|
+
throw 'Missing the required parameter "tableId" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
|
|
17609
|
+
}
|
|
17610
|
+
// verify the required parameter 'tableVersion' is set
|
|
17611
|
+
if (tableVersion === undefined || tableVersion === null) {
|
|
17612
|
+
throw 'Missing the required parameter "tableVersion" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
|
|
17613
|
+
}
|
|
17614
|
+
// verify the required parameter 'body' is set
|
|
17615
|
+
if (body === undefined || body === null) {
|
|
17616
|
+
throw 'Missing the required parameter "body" when calling postBusinessrulesDecisiontableVersionRowsBulkUpdate';
|
|
17617
|
+
}
|
|
17618
|
+
|
|
17619
|
+
return this.apiClient.callApi(
|
|
17620
|
+
'/api/v2/businessrules/decisiontables/{tableId}/versions/{tableVersion}/rows/bulk/update',
|
|
17621
|
+
'POST',
|
|
17622
|
+
{ 'tableId': tableId,'tableVersion': tableVersion },
|
|
17623
|
+
{ },
|
|
17624
|
+
{ },
|
|
17625
|
+
{ },
|
|
17626
|
+
body,
|
|
17627
|
+
['PureCloud OAuth'],
|
|
17628
|
+
['application/json'],
|
|
17629
|
+
['application/json'],
|
|
17630
|
+
opts['customHeaders']
|
|
17631
|
+
);
|
|
17632
|
+
}
|
|
17633
|
+
|
|
17259
17634
|
/**
|
|
17260
17635
|
* Search for decision table rows
|
|
17261
17636
|
*
|
|
@@ -17544,7 +17919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17544
17919
|
/**
|
|
17545
17920
|
* CarrierServices service.
|
|
17546
17921
|
* @module purecloud-platform-client-v2/api/CarrierServicesApi
|
|
17547
|
-
* @version
|
|
17922
|
+
* @version 254.0.0
|
|
17548
17923
|
*/
|
|
17549
17924
|
|
|
17550
17925
|
/**
|
|
@@ -17621,7 +17996,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17621
17996
|
/**
|
|
17622
17997
|
* CaseManagement service.
|
|
17623
17998
|
* @module purecloud-platform-client-v2/api/CaseManagementApi
|
|
17624
|
-
* @version
|
|
17999
|
+
* @version 254.0.0
|
|
17625
18000
|
*/
|
|
17626
18001
|
|
|
17627
18002
|
/**
|
|
@@ -17639,10 +18014,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17639
18014
|
/**
|
|
17640
18015
|
* Delete a Case.
|
|
17641
18016
|
*
|
|
17642
|
-
* @param {String} caseId Case
|
|
18017
|
+
* @param {String} caseId Case identifier.
|
|
17643
18018
|
* @param {Object} opts Optional parameters
|
|
17644
18019
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17645
|
-
* deleteCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17646
18020
|
*/
|
|
17647
18021
|
deleteCasemanagementCase(caseId, opts) {
|
|
17648
18022
|
opts = opts || {};
|
|
@@ -17670,10 +18044,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17670
18044
|
/**
|
|
17671
18045
|
* Delete a Caseplan.
|
|
17672
18046
|
*
|
|
17673
|
-
* @param {String} caseplanId Caseplan
|
|
18047
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
17674
18048
|
* @param {Object} opts Optional parameters
|
|
17675
18049
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17676
|
-
* deleteCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17677
18050
|
*/
|
|
17678
18051
|
deleteCasemanagementCaseplan(caseplanId, opts) {
|
|
17679
18052
|
opts = opts || {};
|
|
@@ -17698,14 +18071,48 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17698
18071
|
);
|
|
17699
18072
|
}
|
|
17700
18073
|
|
|
18074
|
+
/**
|
|
18075
|
+
* Remove a data schema from a draft Caseplan.
|
|
18076
|
+
*
|
|
18077
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18078
|
+
* @param {String} schemaKeyName Schema key (for example default).
|
|
18079
|
+
* @param {Object} opts Optional parameters
|
|
18080
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18081
|
+
*/
|
|
18082
|
+
deleteCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, opts) {
|
|
18083
|
+
opts = opts || {};
|
|
18084
|
+
|
|
18085
|
+
// verify the required parameter 'caseplanId' is set
|
|
18086
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
18087
|
+
throw 'Missing the required parameter "caseplanId" when calling deleteCasemanagementCaseplanDataschema';
|
|
18088
|
+
}
|
|
18089
|
+
// verify the required parameter 'schemaKeyName' is set
|
|
18090
|
+
if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
|
|
18091
|
+
throw 'Missing the required parameter "schemaKeyName" when calling deleteCasemanagementCaseplanDataschema';
|
|
18092
|
+
}
|
|
18093
|
+
|
|
18094
|
+
return this.apiClient.callApi(
|
|
18095
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
|
|
18096
|
+
'DELETE',
|
|
18097
|
+
{ 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
|
|
18098
|
+
{ },
|
|
18099
|
+
{ },
|
|
18100
|
+
{ },
|
|
18101
|
+
null,
|
|
18102
|
+
['PureCloud OAuth'],
|
|
18103
|
+
['application/json'],
|
|
18104
|
+
['application/json'],
|
|
18105
|
+
opts['customHeaders']
|
|
18106
|
+
);
|
|
18107
|
+
}
|
|
18108
|
+
|
|
17701
18109
|
/**
|
|
17702
18110
|
* Get a Case.
|
|
17703
18111
|
*
|
|
17704
|
-
* @param {String} caseId Case
|
|
18112
|
+
* @param {String} caseId Case identifier.
|
|
17705
18113
|
* @param {Object} opts Optional parameters
|
|
17706
|
-
* @param {Object} opts.expands
|
|
18114
|
+
* @param {Object} opts.expands Fields to expand.
|
|
17707
18115
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17708
|
-
* getCasemanagementCase is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17709
18116
|
*/
|
|
17710
18117
|
getCasemanagementCase(caseId, opts) {
|
|
17711
18118
|
opts = opts || {};
|
|
@@ -17733,11 +18140,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17733
18140
|
/**
|
|
17734
18141
|
* Get a Case Association.
|
|
17735
18142
|
*
|
|
17736
|
-
* @param {String} caseId Case
|
|
17737
|
-
* @param {String} associationId Case
|
|
18143
|
+
* @param {String} caseId Case identifier.
|
|
18144
|
+
* @param {String} associationId Case association identifier.
|
|
17738
18145
|
* @param {Object} opts Optional parameters
|
|
17739
18146
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17740
|
-
* getCasemanagementCaseAssociation is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17741
18147
|
*/
|
|
17742
18148
|
getCasemanagementCaseAssociation(caseId, associationId, opts) {
|
|
17743
18149
|
opts = opts || {};
|
|
@@ -17767,15 +18173,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17767
18173
|
}
|
|
17768
18174
|
|
|
17769
18175
|
/**
|
|
17770
|
-
* Get a list of
|
|
18176
|
+
* Get a list of Case associations for the Case.
|
|
17771
18177
|
*
|
|
17772
|
-
* @param {String} caseId Case
|
|
18178
|
+
* @param {String} caseId Case identifier.
|
|
17773
18179
|
* @param {Object} opts Optional parameters
|
|
17774
18180
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
17775
18181
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17776
18182
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17777
18183
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17778
|
-
* getCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17779
18184
|
*/
|
|
17780
18185
|
getCasemanagementCaseAssociations(caseId, opts) {
|
|
17781
18186
|
opts = opts || {};
|
|
@@ -17803,11 +18208,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17803
18208
|
/**
|
|
17804
18209
|
* Get a Stage.
|
|
17805
18210
|
*
|
|
17806
|
-
* @param {String} caseId Case
|
|
17807
|
-
* @param {String} stageId Stage
|
|
18211
|
+
* @param {String} caseId Case identifier.
|
|
18212
|
+
* @param {String} stageId Stage identifier.
|
|
17808
18213
|
* @param {Object} opts Optional parameters
|
|
17809
18214
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17810
|
-
* getCasemanagementCaseStage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17811
18215
|
*/
|
|
17812
18216
|
getCasemanagementCaseStage(caseId, stageId, opts) {
|
|
17813
18217
|
opts = opts || {};
|
|
@@ -17839,12 +18243,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17839
18243
|
/**
|
|
17840
18244
|
* Get a Step.
|
|
17841
18245
|
*
|
|
17842
|
-
* @param {String} caseId Case
|
|
17843
|
-
* @param {String} stageId Stage
|
|
17844
|
-
* @param {String} stepId Step
|
|
18246
|
+
* @param {String} caseId Case identifier.
|
|
18247
|
+
* @param {String} stageId Stage identifier.
|
|
18248
|
+
* @param {String} stepId Step identifier.
|
|
17845
18249
|
* @param {Object} opts Optional parameters
|
|
17846
18250
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17847
|
-
* getCasemanagementCaseStageStep is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17848
18251
|
*/
|
|
17849
18252
|
getCasemanagementCaseStageStep(caseId, stageId, stepId, opts) {
|
|
17850
18253
|
opts = opts || {};
|
|
@@ -17880,14 +18283,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17880
18283
|
/**
|
|
17881
18284
|
* Get a list of Steps.
|
|
17882
18285
|
*
|
|
17883
|
-
* @param {String} caseId Case
|
|
17884
|
-
* @param {String} stageId Stage
|
|
18286
|
+
* @param {String} caseId Case identifier.
|
|
18287
|
+
* @param {String} stageId Stage identifier.
|
|
17885
18288
|
* @param {Object} opts Optional parameters
|
|
17886
18289
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
17887
18290
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17888
18291
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17889
18292
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17890
|
-
* getCasemanagementCaseStageSteps is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17891
18293
|
*/
|
|
17892
18294
|
getCasemanagementCaseStageSteps(caseId, stageId, opts) {
|
|
17893
18295
|
opts = opts || {};
|
|
@@ -17919,13 +18321,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17919
18321
|
/**
|
|
17920
18322
|
* Get a list of Stages.
|
|
17921
18323
|
*
|
|
17922
|
-
* @param {String} caseId Case
|
|
18324
|
+
* @param {String} caseId Case identifier.
|
|
17923
18325
|
* @param {Object} opts Optional parameters
|
|
17924
18326
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
17925
18327
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
17926
18328
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
17927
18329
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17928
|
-
* getCasemanagementCaseStages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17929
18330
|
*/
|
|
17930
18331
|
getCasemanagementCaseStages(caseId, opts) {
|
|
17931
18332
|
opts = opts || {};
|
|
@@ -17953,11 +18354,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17953
18354
|
/**
|
|
17954
18355
|
* Get a Terminate Job for a Case.
|
|
17955
18356
|
*
|
|
17956
|
-
* @param {String} caseId Case
|
|
17957
|
-
* @param {String} jobId Job
|
|
18357
|
+
* @param {String} caseId Case identifier.
|
|
18358
|
+
* @param {String} jobId Terminate Job identifier.
|
|
17958
18359
|
* @param {Object} opts Optional parameters
|
|
17959
18360
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17960
|
-
* getCasemanagementCaseTerminateJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17961
18361
|
*/
|
|
17962
18362
|
getCasemanagementCaseTerminateJob(caseId, jobId, opts) {
|
|
17963
18363
|
opts = opts || {};
|
|
@@ -17989,10 +18389,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
17989
18389
|
/**
|
|
17990
18390
|
* Get a Caseplan.
|
|
17991
18391
|
*
|
|
17992
|
-
* @param {String} caseplanId Caseplan
|
|
18392
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
17993
18393
|
* @param {Object} opts Optional parameters
|
|
17994
18394
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
17995
|
-
* getCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
17996
18395
|
*/
|
|
17997
18396
|
getCasemanagementCaseplan(caseplanId, opts) {
|
|
17998
18397
|
opts = opts || {};
|
|
@@ -18020,11 +18419,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18020
18419
|
/**
|
|
18021
18420
|
* Get a Caseplan version.
|
|
18022
18421
|
*
|
|
18023
|
-
* @param {String} caseplanId Caseplan
|
|
18024
|
-
* @param {String} versionId
|
|
18422
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18423
|
+
* @param {String} versionId Caseplan version identifier.
|
|
18025
18424
|
* @param {Object} opts Optional parameters
|
|
18026
18425
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18027
|
-
* getCasemanagementCaseplanVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18028
18426
|
*/
|
|
18029
18427
|
getCasemanagementCaseplanVersion(caseplanId, versionId, opts) {
|
|
18030
18428
|
opts = opts || {};
|
|
@@ -18054,13 +18452,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18054
18452
|
}
|
|
18055
18453
|
|
|
18056
18454
|
/**
|
|
18057
|
-
* Get the
|
|
18455
|
+
* Get the data schemas for a Caseplan version.
|
|
18058
18456
|
*
|
|
18059
|
-
* @param {String} caseplanId Caseplan
|
|
18060
|
-
* @param {String} versionId
|
|
18457
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18458
|
+
* @param {String} versionId Caseplan version identifier.
|
|
18061
18459
|
* @param {Object} opts Optional parameters
|
|
18062
18460
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18063
|
-
* getCasemanagementCaseplanVersionDataschemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18064
18461
|
*/
|
|
18065
18462
|
getCasemanagementCaseplanVersionDataschemas(caseplanId, versionId, opts) {
|
|
18066
18463
|
opts = opts || {};
|
|
@@ -18092,11 +18489,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18092
18489
|
/**
|
|
18093
18490
|
* Get the intake settings for a Caseplan version.
|
|
18094
18491
|
*
|
|
18095
|
-
* @param {String} caseplanId Caseplan
|
|
18096
|
-
* @param {String} versionId
|
|
18492
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18493
|
+
* @param {String} versionId Caseplan version identifier.
|
|
18097
18494
|
* @param {Object} opts Optional parameters
|
|
18098
18495
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18099
|
-
* getCasemanagementCaseplanVersionIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18100
18496
|
*/
|
|
18101
18497
|
getCasemanagementCaseplanVersionIntakesettings(caseplanId, versionId, opts) {
|
|
18102
18498
|
opts = opts || {};
|
|
@@ -18128,13 +18524,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18128
18524
|
/**
|
|
18129
18525
|
* Get a Stageplan.
|
|
18130
18526
|
*
|
|
18131
|
-
* @param {String} caseplanId Caseplan
|
|
18132
|
-
* @param {String} versionId
|
|
18133
|
-
* @param {String} stageplanId Stageplan
|
|
18527
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18528
|
+
* @param {String} versionId Caseplan version identifier.
|
|
18529
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
18134
18530
|
* @param {Object} opts Optional parameters
|
|
18135
|
-
* @param {Array.<String>} opts.expands
|
|
18531
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
18136
18532
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18137
|
-
* getCasemanagementCaseplanVersionStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18138
18533
|
*/
|
|
18139
18534
|
getCasemanagementCaseplanVersionStageplan(caseplanId, versionId, stageplanId, opts) {
|
|
18140
18535
|
opts = opts || {};
|
|
@@ -18170,14 +18565,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18170
18565
|
/**
|
|
18171
18566
|
* Get a Stepplan.
|
|
18172
18567
|
*
|
|
18173
|
-
* @param {String} caseplanId Caseplan
|
|
18174
|
-
* @param {String} versionId
|
|
18175
|
-
* @param {String} stageplanId Stageplan
|
|
18176
|
-
* @param {String} stepplanId Stepplan
|
|
18568
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18569
|
+
* @param {String} versionId Caseplan version identifier.
|
|
18570
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
18571
|
+
* @param {String} stepplanId Stepplan identifier.
|
|
18177
18572
|
* @param {Object} opts Optional parameters
|
|
18178
|
-
* @param {Array.<String>} opts.expands
|
|
18573
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
18179
18574
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18180
|
-
* getCasemanagementCaseplanVersionStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18181
18575
|
*/
|
|
18182
18576
|
getCasemanagementCaseplanVersionStageplanStepplan(caseplanId, versionId, stageplanId, stepplanId, opts) {
|
|
18183
18577
|
opts = opts || {};
|
|
@@ -18217,16 +18611,15 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18217
18611
|
/**
|
|
18218
18612
|
* Get a list of Stepplans.
|
|
18219
18613
|
*
|
|
18220
|
-
* @param {String} caseplanId Caseplan
|
|
18221
|
-
* @param {String} versionId
|
|
18222
|
-
* @param {String} stageplanId Stageplan
|
|
18614
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18615
|
+
* @param {String} versionId Caseplan version identifier.
|
|
18616
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
18223
18617
|
* @param {Object} opts Optional parameters
|
|
18224
18618
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
18225
18619
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
18226
18620
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
18227
|
-
* @param {Array.<String>} opts.expands
|
|
18621
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
18228
18622
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18229
|
-
* getCasemanagementCaseplanVersionStageplanStepplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18230
18623
|
*/
|
|
18231
18624
|
getCasemanagementCaseplanVersionStageplanStepplans(caseplanId, versionId, stageplanId, opts) {
|
|
18232
18625
|
opts = opts || {};
|
|
@@ -18262,15 +18655,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18262
18655
|
/**
|
|
18263
18656
|
* Get a list of Stageplans.
|
|
18264
18657
|
*
|
|
18265
|
-
* @param {String} caseplanId Caseplan
|
|
18266
|
-
* @param {String} versionId
|
|
18658
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18659
|
+
* @param {String} versionId Caseplan version identifier.
|
|
18267
18660
|
* @param {Object} opts Optional parameters
|
|
18268
18661
|
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
18269
18662
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
18270
18663
|
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
18271
|
-
* @param {Array.<String>} opts.expands
|
|
18664
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
18272
18665
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18273
|
-
* getCasemanagementCaseplanVersionStageplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18274
18666
|
*/
|
|
18275
18667
|
getCasemanagementCaseplanVersionStageplans(caseplanId, versionId, opts) {
|
|
18276
18668
|
opts = opts || {};
|
|
@@ -18303,12 +18695,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18303
18695
|
* Get a list of Caseplans.
|
|
18304
18696
|
*
|
|
18305
18697
|
* @param {Object} opts Optional parameters
|
|
18306
|
-
* @param {String} opts.after
|
|
18307
|
-
* @param {Number} opts.pageSize Number of
|
|
18308
|
-
* @param {String} opts.customerIntentId Filter by
|
|
18309
|
-
* @param {String} opts.divisionIds Filter by
|
|
18698
|
+
* @param {String} opts.after Cursor that points to the end of the previously returned set of Caseplans.
|
|
18699
|
+
* @param {Number} opts.pageSize Number of Caseplans to return. Maximum is 200.
|
|
18700
|
+
* @param {String} opts.customerIntentId Filter by customer intent.
|
|
18701
|
+
* @param {String} opts.divisionIds Filter by divisions.
|
|
18310
18702
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18311
|
-
* getCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18312
18703
|
*/
|
|
18313
18704
|
getCasemanagementCaseplans(opts) {
|
|
18314
18705
|
opts = opts || {};
|
|
@@ -18330,16 +18721,15 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18330
18721
|
}
|
|
18331
18722
|
|
|
18332
18723
|
/**
|
|
18333
|
-
* Get a list of
|
|
18724
|
+
* Get a list of Cases for an External Contact.
|
|
18334
18725
|
*
|
|
18335
|
-
* @param {String} externalContactId External
|
|
18726
|
+
* @param {String} externalContactId External contact identifier.
|
|
18336
18727
|
* @param {Object} opts Optional parameters
|
|
18337
|
-
* @param {String} opts.after
|
|
18338
|
-
* @param {Number} opts.pageSize Number of
|
|
18339
|
-
* @param {String} opts.divisionIds Filter by
|
|
18340
|
-
* @param {Array.<String>} opts.expands
|
|
18728
|
+
* @param {String} opts.after Cursor pointing to the end of the previously returned page of Cases.
|
|
18729
|
+
* @param {Number} opts.pageSize Number of Cases to return (maximum 200).
|
|
18730
|
+
* @param {String} opts.divisionIds Filter by divisions.
|
|
18731
|
+
* @param {Array.<String>} opts.expands Fields to expand.
|
|
18341
18732
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18342
|
-
* getCasemanagementCasesExternalcontact is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18343
18733
|
*/
|
|
18344
18734
|
getCasemanagementCasesExternalcontact(externalContactId, opts) {
|
|
18345
18735
|
opts = opts || {};
|
|
@@ -18367,11 +18757,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18367
18757
|
/**
|
|
18368
18758
|
* Get a Case by reference.
|
|
18369
18759
|
*
|
|
18370
|
-
* @param {String} referenceId
|
|
18760
|
+
* @param {String} referenceId Case reference.
|
|
18371
18761
|
* @param {Object} opts Optional parameters
|
|
18372
|
-
* @param {Object} opts.expands
|
|
18762
|
+
* @param {Object} opts.expands Fields to expand.
|
|
18373
18763
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18374
|
-
* getCasemanagementCasesReference is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18375
18764
|
*/
|
|
18376
18765
|
getCasemanagementCasesReference(referenceId, opts) {
|
|
18377
18766
|
opts = opts || {};
|
|
@@ -18397,13 +18786,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18397
18786
|
}
|
|
18398
18787
|
|
|
18399
18788
|
/**
|
|
18400
|
-
* Update
|
|
18789
|
+
* Update the due date of a Case.
|
|
18401
18790
|
*
|
|
18402
|
-
* @param {String} caseId Case
|
|
18403
|
-
* @param {Object} body
|
|
18791
|
+
* @param {String} caseId Case identifier.
|
|
18792
|
+
* @param {Object} body Due date update.
|
|
18404
18793
|
* @param {Object} opts Optional parameters
|
|
18405
18794
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18406
|
-
* patchCasemanagementCaseDatedue is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18407
18795
|
*/
|
|
18408
18796
|
patchCasemanagementCaseDatedue(caseId, body, opts) {
|
|
18409
18797
|
opts = opts || {};
|
|
@@ -18435,11 +18823,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18435
18823
|
/**
|
|
18436
18824
|
* Update priority of a Case.
|
|
18437
18825
|
*
|
|
18438
|
-
* @param {String} caseId Case
|
|
18439
|
-
* @param {Object} body Priority
|
|
18826
|
+
* @param {String} caseId Case identifier.
|
|
18827
|
+
* @param {Object} body Priority update.
|
|
18440
18828
|
* @param {Object} opts Optional parameters
|
|
18441
18829
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18442
|
-
* patchCasemanagementCasePriority is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18443
18830
|
*/
|
|
18444
18831
|
patchCasemanagementCasePriority(caseId, body, opts) {
|
|
18445
18832
|
opts = opts || {};
|
|
@@ -18471,11 +18858,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18471
18858
|
/**
|
|
18472
18859
|
* Update summary of a Case.
|
|
18473
18860
|
*
|
|
18474
|
-
* @param {String} caseId Case
|
|
18475
|
-
* @param {Object} body Summary
|
|
18861
|
+
* @param {String} caseId Case identifier.
|
|
18862
|
+
* @param {Object} body Summary update.
|
|
18476
18863
|
* @param {Object} opts Optional parameters
|
|
18477
18864
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18478
|
-
* patchCasemanagementCaseSummary is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18479
18865
|
*/
|
|
18480
18866
|
patchCasemanagementCaseSummary(caseId, body, opts) {
|
|
18481
18867
|
opts = opts || {};
|
|
@@ -18507,11 +18893,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18507
18893
|
/**
|
|
18508
18894
|
* Update the attributes of a Caseplan.
|
|
18509
18895
|
*
|
|
18510
|
-
* @param {String} caseplanId Caseplan
|
|
18511
|
-
* @param {Object} body Caseplan
|
|
18896
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18897
|
+
* @param {Object} body Caseplan update.
|
|
18512
18898
|
* @param {Object} opts Optional parameters
|
|
18513
18899
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18514
|
-
* patchCasemanagementCaseplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18515
18900
|
*/
|
|
18516
18901
|
patchCasemanagementCaseplan(caseplanId, body, opts) {
|
|
18517
18902
|
opts = opts || {};
|
|
@@ -18543,12 +18928,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18543
18928
|
/**
|
|
18544
18929
|
* Update the attributes of a Stageplan.
|
|
18545
18930
|
*
|
|
18546
|
-
* @param {String} caseplanId Caseplan
|
|
18547
|
-
* @param {String} stageplanId Stageplan
|
|
18548
|
-
* @param {Object} body Stageplan
|
|
18931
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18932
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
18933
|
+
* @param {Object} body Stageplan update.
|
|
18549
18934
|
* @param {Object} opts Optional parameters
|
|
18550
18935
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18551
|
-
* patchCasemanagementCaseplanStageplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18552
18936
|
*/
|
|
18553
18937
|
patchCasemanagementCaseplanStageplan(caseplanId, stageplanId, body, opts) {
|
|
18554
18938
|
opts = opts || {};
|
|
@@ -18584,13 +18968,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18584
18968
|
/**
|
|
18585
18969
|
* Update the attributes of a Stepplan.
|
|
18586
18970
|
*
|
|
18587
|
-
* @param {String} caseplanId Caseplan
|
|
18588
|
-
* @param {String} stageplanId Stageplan
|
|
18589
|
-
* @param {String} stepplanId Stepplan
|
|
18590
|
-
* @param {Object} body Stepplan
|
|
18971
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18972
|
+
* @param {String} stageplanId Stageplan identifier.
|
|
18973
|
+
* @param {String} stepplanId Stepplan identifier.
|
|
18974
|
+
* @param {Object} body Stepplan update.
|
|
18591
18975
|
* @param {Object} opts Optional parameters
|
|
18592
18976
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18593
|
-
* patchCasemanagementCaseplanStageplanStepplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18594
18977
|
*/
|
|
18595
18978
|
patchCasemanagementCaseplanStageplanStepplan(caseplanId, stageplanId, stepplanId, body, opts) {
|
|
18596
18979
|
opts = opts || {};
|
|
@@ -18628,21 +19011,24 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18628
19011
|
}
|
|
18629
19012
|
|
|
18630
19013
|
/**
|
|
18631
|
-
* Create a
|
|
19014
|
+
* Create a Case association.
|
|
18632
19015
|
*
|
|
18633
|
-
* @param {String} caseId Case
|
|
19016
|
+
* @param {String} caseId Case identifier.
|
|
19017
|
+
* @param {Object} body Case association create request.
|
|
18634
19018
|
* @param {Object} opts Optional parameters
|
|
18635
|
-
* @param {Object} opts.body Case Association
|
|
18636
19019
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18637
|
-
* postCasemanagementCaseAssociations is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18638
19020
|
*/
|
|
18639
|
-
postCasemanagementCaseAssociations(caseId, opts) {
|
|
19021
|
+
postCasemanagementCaseAssociations(caseId, body, opts) {
|
|
18640
19022
|
opts = opts || {};
|
|
18641
19023
|
|
|
18642
19024
|
// verify the required parameter 'caseId' is set
|
|
18643
19025
|
if (caseId === undefined || caseId === null || caseId === '') {
|
|
18644
19026
|
throw 'Missing the required parameter "caseId" when calling postCasemanagementCaseAssociations';
|
|
18645
19027
|
}
|
|
19028
|
+
// verify the required parameter 'body' is set
|
|
19029
|
+
if (body === undefined || body === null) {
|
|
19030
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseAssociations';
|
|
19031
|
+
}
|
|
18646
19032
|
|
|
18647
19033
|
return this.apiClient.callApi(
|
|
18648
19034
|
'/api/v2/casemanagement/cases/{caseId}/associations',
|
|
@@ -18651,7 +19037,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18651
19037
|
{ },
|
|
18652
19038
|
{ },
|
|
18653
19039
|
{ },
|
|
18654
|
-
|
|
19040
|
+
body,
|
|
18655
19041
|
['PureCloud OAuth'],
|
|
18656
19042
|
['application/json'],
|
|
18657
19043
|
['application/json'],
|
|
@@ -18662,10 +19048,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18662
19048
|
/**
|
|
18663
19049
|
* Create a Terminate Job for a Case.
|
|
18664
19050
|
*
|
|
18665
|
-
* @param {String} caseId Case
|
|
19051
|
+
* @param {String} caseId Case identifier.
|
|
18666
19052
|
* @param {Object} opts Optional parameters
|
|
18667
19053
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18668
|
-
* postCasemanagementCaseTerminateJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18669
19054
|
*/
|
|
18670
19055
|
postCasemanagementCaseTerminateJobs(caseId, opts) {
|
|
18671
19056
|
opts = opts || {};
|
|
@@ -18690,13 +19075,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18690
19075
|
);
|
|
18691
19076
|
}
|
|
18692
19077
|
|
|
19078
|
+
/**
|
|
19079
|
+
* Add a data schema to a draft Caseplan.
|
|
19080
|
+
*
|
|
19081
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
19082
|
+
* @param {Object} body Data schema reference.
|
|
19083
|
+
* @param {Object} opts Optional parameters
|
|
19084
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19085
|
+
*/
|
|
19086
|
+
postCasemanagementCaseplanDataschemas(caseplanId, body, opts) {
|
|
19087
|
+
opts = opts || {};
|
|
19088
|
+
|
|
19089
|
+
// verify the required parameter 'caseplanId' is set
|
|
19090
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
19091
|
+
throw 'Missing the required parameter "caseplanId" when calling postCasemanagementCaseplanDataschemas';
|
|
19092
|
+
}
|
|
19093
|
+
// verify the required parameter 'body' is set
|
|
19094
|
+
if (body === undefined || body === null) {
|
|
19095
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCaseplanDataschemas';
|
|
19096
|
+
}
|
|
19097
|
+
|
|
19098
|
+
return this.apiClient.callApi(
|
|
19099
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas',
|
|
19100
|
+
'POST',
|
|
19101
|
+
{ 'caseplanId': caseplanId },
|
|
19102
|
+
{ },
|
|
19103
|
+
{ },
|
|
19104
|
+
{ },
|
|
19105
|
+
body,
|
|
19106
|
+
['PureCloud OAuth'],
|
|
19107
|
+
['application/json'],
|
|
19108
|
+
['application/json'],
|
|
19109
|
+
opts['customHeaders']
|
|
19110
|
+
);
|
|
19111
|
+
}
|
|
19112
|
+
|
|
18693
19113
|
/**
|
|
18694
19114
|
* Publish Caseplan.
|
|
18695
19115
|
*
|
|
18696
|
-
* @param {String} caseplanId Caseplan
|
|
19116
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18697
19117
|
* @param {Object} opts Optional parameters
|
|
18698
19118
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18699
|
-
* postCasemanagementCaseplanPublish is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18700
19119
|
*/
|
|
18701
19120
|
postCasemanagementCaseplanPublish(caseplanId, opts) {
|
|
18702
19121
|
opts = opts || {};
|
|
@@ -18724,10 +19143,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18724
19143
|
/**
|
|
18725
19144
|
* Create Caseplan version.
|
|
18726
19145
|
*
|
|
18727
|
-
* @param {String} caseplanId Caseplan
|
|
19146
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
18728
19147
|
* @param {Object} opts Optional parameters
|
|
18729
19148
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18730
|
-
* postCasemanagementCaseplanVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18731
19149
|
*/
|
|
18732
19150
|
postCasemanagementCaseplanVersions(caseplanId, opts) {
|
|
18733
19151
|
opts = opts || {};
|
|
@@ -18755,10 +19173,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18755
19173
|
/**
|
|
18756
19174
|
* Create a Caseplan.
|
|
18757
19175
|
*
|
|
18758
|
-
* @param {Object} body Caseplan
|
|
19176
|
+
* @param {Object} body Caseplan create request.
|
|
18759
19177
|
* @param {Object} opts Optional parameters
|
|
18760
19178
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18761
|
-
* postCasemanagementCaseplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18762
19179
|
*/
|
|
18763
19180
|
postCasemanagementCaseplans(body, opts) {
|
|
18764
19181
|
opts = opts || {};
|
|
@@ -18784,12 +19201,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18784
19201
|
}
|
|
18785
19202
|
|
|
18786
19203
|
/**
|
|
18787
|
-
* Query for
|
|
19204
|
+
* Query for Caseplans.
|
|
18788
19205
|
*
|
|
18789
|
-
* @param {Object} body
|
|
19206
|
+
* @param {Object} body Caseplan query request.
|
|
18790
19207
|
* @param {Object} opts Optional parameters
|
|
18791
19208
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18792
|
-
* postCasemanagementCaseplansQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18793
19209
|
*/
|
|
18794
19210
|
postCasemanagementCaseplansQuery(body, opts) {
|
|
18795
19211
|
opts = opts || {};
|
|
@@ -18817,10 +19233,9 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18817
19233
|
/**
|
|
18818
19234
|
* Create a Case.
|
|
18819
19235
|
*
|
|
18820
|
-
* @param {Object} body Case
|
|
19236
|
+
* @param {Object} body Case create request.
|
|
18821
19237
|
* @param {Object} opts Optional parameters
|
|
18822
19238
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18823
|
-
* postCasemanagementCases is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18824
19239
|
*/
|
|
18825
19240
|
postCasemanagementCases(body, opts) {
|
|
18826
19241
|
opts = opts || {};
|
|
@@ -18846,16 +19261,19 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18846
19261
|
}
|
|
18847
19262
|
|
|
18848
19263
|
/**
|
|
18849
|
-
* Query for
|
|
19264
|
+
* Query for Case associations by interaction.
|
|
18850
19265
|
*
|
|
19266
|
+
* @param {Object} body Case association query request.
|
|
18851
19267
|
* @param {Object} opts Optional parameters
|
|
18852
|
-
* @param {Object} opts.body Case Association
|
|
18853
19268
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18854
|
-
* postCasemanagementCasesAssociationsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18855
19269
|
*/
|
|
18856
|
-
postCasemanagementCasesAssociationsQuery(opts) {
|
|
19270
|
+
postCasemanagementCasesAssociationsQuery(body, opts) {
|
|
18857
19271
|
opts = opts || {};
|
|
18858
19272
|
|
|
19273
|
+
// verify the required parameter 'body' is set
|
|
19274
|
+
if (body === undefined || body === null) {
|
|
19275
|
+
throw 'Missing the required parameter "body" when calling postCasemanagementCasesAssociationsQuery';
|
|
19276
|
+
}
|
|
18859
19277
|
|
|
18860
19278
|
return this.apiClient.callApi(
|
|
18861
19279
|
'/api/v2/casemanagement/cases/associations/query',
|
|
@@ -18864,7 +19282,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18864
19282
|
{ },
|
|
18865
19283
|
{ },
|
|
18866
19284
|
{ },
|
|
18867
|
-
|
|
19285
|
+
body,
|
|
19286
|
+
['PureCloud OAuth'],
|
|
19287
|
+
['application/json'],
|
|
19288
|
+
['application/json'],
|
|
19289
|
+
opts['customHeaders']
|
|
19290
|
+
);
|
|
19291
|
+
}
|
|
19292
|
+
|
|
19293
|
+
/**
|
|
19294
|
+
* Update a data schema on a draft Caseplan.
|
|
19295
|
+
*
|
|
19296
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
19297
|
+
* @param {String} schemaKeyName Schema key (for example default).
|
|
19298
|
+
* @param {Object} body Data schema reference.
|
|
19299
|
+
* @param {Object} opts Optional parameters
|
|
19300
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
19301
|
+
*/
|
|
19302
|
+
putCasemanagementCaseplanDataschema(caseplanId, schemaKeyName, body, opts) {
|
|
19303
|
+
opts = opts || {};
|
|
19304
|
+
|
|
19305
|
+
// verify the required parameter 'caseplanId' is set
|
|
19306
|
+
if (caseplanId === undefined || caseplanId === null || caseplanId === '') {
|
|
19307
|
+
throw 'Missing the required parameter "caseplanId" when calling putCasemanagementCaseplanDataschema';
|
|
19308
|
+
}
|
|
19309
|
+
// verify the required parameter 'schemaKeyName' is set
|
|
19310
|
+
if (schemaKeyName === undefined || schemaKeyName === null || schemaKeyName === '') {
|
|
19311
|
+
throw 'Missing the required parameter "schemaKeyName" when calling putCasemanagementCaseplanDataschema';
|
|
19312
|
+
}
|
|
19313
|
+
// verify the required parameter 'body' is set
|
|
19314
|
+
if (body === undefined || body === null) {
|
|
19315
|
+
throw 'Missing the required parameter "body" when calling putCasemanagementCaseplanDataschema';
|
|
19316
|
+
}
|
|
19317
|
+
|
|
19318
|
+
return this.apiClient.callApi(
|
|
19319
|
+
'/api/v2/casemanagement/caseplans/{caseplanId}/dataschemas/{schemaKeyName}',
|
|
19320
|
+
'PUT',
|
|
19321
|
+
{ 'caseplanId': caseplanId,'schemaKeyName': schemaKeyName },
|
|
19322
|
+
{ },
|
|
19323
|
+
{ },
|
|
19324
|
+
{ },
|
|
19325
|
+
body,
|
|
18868
19326
|
['PureCloud OAuth'],
|
|
18869
19327
|
['application/json'],
|
|
18870
19328
|
['application/json'],
|
|
@@ -18875,11 +19333,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18875
19333
|
/**
|
|
18876
19334
|
* Update the intake settings for a Caseplan.
|
|
18877
19335
|
*
|
|
18878
|
-
* @param {String} caseplanId Caseplan
|
|
18879
|
-
* @param {Object} body Intake
|
|
19336
|
+
* @param {String} caseplanId Caseplan identifier.
|
|
19337
|
+
* @param {Object} body Intake settings update.
|
|
18880
19338
|
* @param {Object} opts Optional parameters
|
|
18881
19339
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
18882
|
-
* putCasemanagementCaseplanIntakesettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
18883
19340
|
*/
|
|
18884
19341
|
putCasemanagementCaseplanIntakesettings(caseplanId, body, opts) {
|
|
18885
19342
|
opts = opts || {};
|
|
@@ -18914,7 +19371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
18914
19371
|
/**
|
|
18915
19372
|
* Chat service.
|
|
18916
19373
|
* @module purecloud-platform-client-v2/api/ChatApi
|
|
18917
|
-
* @version
|
|
19374
|
+
* @version 254.0.0
|
|
18918
19375
|
*/
|
|
18919
19376
|
|
|
18920
19377
|
/**
|
|
@@ -20053,7 +20510,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20053
20510
|
/**
|
|
20054
20511
|
* Coaching service.
|
|
20055
20512
|
* @module purecloud-platform-client-v2/api/CoachingApi
|
|
20056
|
-
* @version
|
|
20513
|
+
* @version 254.0.0
|
|
20057
20514
|
*/
|
|
20058
20515
|
|
|
20059
20516
|
/**
|
|
@@ -20767,7 +21224,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
20767
21224
|
/**
|
|
20768
21225
|
* ContentManagement service.
|
|
20769
21226
|
* @module purecloud-platform-client-v2/api/ContentManagementApi
|
|
20770
|
-
* @version
|
|
21227
|
+
* @version 254.0.0
|
|
20771
21228
|
*/
|
|
20772
21229
|
|
|
20773
21230
|
/**
|
|
@@ -21962,7 +22419,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21962
22419
|
/**
|
|
21963
22420
|
* Conversations service.
|
|
21964
22421
|
* @module purecloud-platform-client-v2/api/ConversationsApi
|
|
21965
|
-
* @version
|
|
22422
|
+
* @version 254.0.0
|
|
21966
22423
|
*/
|
|
21967
22424
|
|
|
21968
22425
|
/**
|
|
@@ -21983,7 +22440,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
21983
22440
|
* @param {String} jobId jobId
|
|
21984
22441
|
* @param {Object} opts Optional parameters
|
|
21985
22442
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
21986
|
-
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
21987
22443
|
*/
|
|
21988
22444
|
deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
21989
22445
|
opts = opts || {};
|
|
@@ -22650,7 +23106,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22650
23106
|
* @param {String} jobId jobId
|
|
22651
23107
|
* @param {Object} opts Optional parameters
|
|
22652
23108
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
22653
|
-
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22654
23109
|
*/
|
|
22655
23110
|
getAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
22656
23111
|
opts = opts || {};
|
|
@@ -22682,7 +23137,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
22682
23137
|
* @param {Object} opts Optional parameters
|
|
22683
23138
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
22684
23139
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
22685
|
-
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
22686
23140
|
*/
|
|
22687
23141
|
getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
|
|
22688
23142
|
opts = opts || {};
|
|
@@ -28529,7 +28983,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
28529
28983
|
* @param {Object} body query
|
|
28530
28984
|
* @param {Object} opts Optional parameters
|
|
28531
28985
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
28532
|
-
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28533
28986
|
*/
|
|
28534
28987
|
postAnalyticsConversationsAggregatesJobs(body, opts) {
|
|
28535
28988
|
opts = opts || {};
|
|
@@ -31514,7 +31967,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
31514
31967
|
|
|
31515
31968
|
/**
|
|
31516
31969
|
* Send an agentless outbound message
|
|
31517
|
-
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and
|
|
31970
|
+
* Send an agentless (api participant) outbound message using a client credential grant. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. If there is already a connected conversation between the fromAddress and recipient specified, the useExistingActiveConversation param can be used to barge in to the ongoing conversation.
|
|
31518
31971
|
* @param {Object} body Create agentless outbound messaging request
|
|
31519
31972
|
* @param {Object} opts Optional parameters
|
|
31520
31973
|
* @param {Boolean} opts.useNormalizedMessage If true, response removes deprecated fields (textBody, messagingTemplate) (default to false)
|
|
@@ -33068,7 +33521,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33068
33521
|
/**
|
|
33069
33522
|
* DataExtensions service.
|
|
33070
33523
|
* @module purecloud-platform-client-v2/api/DataExtensionsApi
|
|
33071
|
-
* @version
|
|
33524
|
+
* @version 254.0.0
|
|
33072
33525
|
*/
|
|
33073
33526
|
|
|
33074
33527
|
/**
|
|
@@ -33169,7 +33622,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33169
33622
|
/**
|
|
33170
33623
|
* DataPrivacy service.
|
|
33171
33624
|
* @module purecloud-platform-client-v2/api/DataPrivacyApi
|
|
33172
|
-
* @version
|
|
33625
|
+
* @version 254.0.0
|
|
33173
33626
|
*/
|
|
33174
33627
|
|
|
33175
33628
|
/**
|
|
@@ -33366,7 +33819,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33366
33819
|
/**
|
|
33367
33820
|
* Downloads service.
|
|
33368
33821
|
* @module purecloud-platform-client-v2/api/DownloadsApi
|
|
33369
|
-
* @version
|
|
33822
|
+
* @version 254.0.0
|
|
33370
33823
|
*/
|
|
33371
33824
|
|
|
33372
33825
|
/**
|
|
@@ -33420,7 +33873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33420
33873
|
/**
|
|
33421
33874
|
* Emails service.
|
|
33422
33875
|
* @module purecloud-platform-client-v2/api/EmailsApi
|
|
33423
|
-
* @version
|
|
33876
|
+
* @version 254.0.0
|
|
33424
33877
|
*/
|
|
33425
33878
|
|
|
33426
33879
|
/**
|
|
@@ -33568,7 +34021,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33568
34021
|
/**
|
|
33569
34022
|
* EmployeeEngagement service.
|
|
33570
34023
|
* @module purecloud-platform-client-v2/api/EmployeeEngagementApi
|
|
33571
|
-
* @version
|
|
34024
|
+
* @version 254.0.0
|
|
33572
34025
|
*/
|
|
33573
34026
|
|
|
33574
34027
|
/**
|
|
@@ -33772,7 +34225,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33772
34225
|
/**
|
|
33773
34226
|
* Events service.
|
|
33774
34227
|
* @module purecloud-platform-client-v2/api/EventsApi
|
|
33775
|
-
* @version
|
|
34228
|
+
* @version 254.0.0
|
|
33776
34229
|
*/
|
|
33777
34230
|
|
|
33778
34231
|
/**
|
|
@@ -33914,7 +34367,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
33914
34367
|
/**
|
|
33915
34368
|
* ExternalContacts service.
|
|
33916
34369
|
* @module purecloud-platform-client-v2/api/ExternalContactsApi
|
|
33917
|
-
* @version
|
|
34370
|
+
* @version 254.0.0
|
|
33918
34371
|
*/
|
|
33919
34372
|
|
|
33920
34373
|
/**
|
|
@@ -37685,7 +38138,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37685
38138
|
/**
|
|
37686
38139
|
* Fax service.
|
|
37687
38140
|
* @module purecloud-platform-client-v2/api/FaxApi
|
|
37688
|
-
* @version
|
|
38141
|
+
* @version 254.0.0
|
|
37689
38142
|
*/
|
|
37690
38143
|
|
|
37691
38144
|
/**
|
|
@@ -37934,7 +38387,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37934
38387
|
/**
|
|
37935
38388
|
* Flows service.
|
|
37936
38389
|
* @module purecloud-platform-client-v2/api/FlowsApi
|
|
37937
|
-
* @version
|
|
38390
|
+
* @version 254.0.0
|
|
37938
38391
|
*/
|
|
37939
38392
|
|
|
37940
38393
|
/**
|
|
@@ -37955,7 +38408,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37955
38408
|
* @param {String} jobId jobId
|
|
37956
38409
|
* @param {Object} opts Optional parameters
|
|
37957
38410
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
37958
|
-
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37959
38411
|
*/
|
|
37960
38412
|
deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
37961
38413
|
opts = opts || {};
|
|
@@ -37986,7 +38438,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
37986
38438
|
* @param {String} jobId jobId
|
|
37987
38439
|
* @param {Object} opts Optional parameters
|
|
37988
38440
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
37989
|
-
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
37990
38441
|
*/
|
|
37991
38442
|
getAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
37992
38443
|
opts = opts || {};
|
|
@@ -38018,7 +38469,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38018
38469
|
* @param {Object} opts Optional parameters
|
|
38019
38470
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
38020
38471
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
38021
|
-
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38022
38472
|
*/
|
|
38023
38473
|
getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
|
|
38024
38474
|
opts = opts || {};
|
|
@@ -38081,7 +38531,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38081
38531
|
* @param {Object} body query
|
|
38082
38532
|
* @param {Object} opts Optional parameters
|
|
38083
38533
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
38084
|
-
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
38085
38534
|
*/
|
|
38086
38535
|
postAnalyticsFlowsAggregatesJobs(body, opts) {
|
|
38087
38536
|
opts = opts || {};
|
|
@@ -38172,7 +38621,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
38172
38621
|
/**
|
|
38173
38622
|
* Gamification service.
|
|
38174
38623
|
* @module purecloud-platform-client-v2/api/GamificationApi
|
|
38175
|
-
* @version
|
|
38624
|
+
* @version 254.0.0
|
|
38176
38625
|
*/
|
|
38177
38626
|
|
|
38178
38627
|
/**
|
|
@@ -41024,7 +41473,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41024
41473
|
/**
|
|
41025
41474
|
* GeneralDataProtectionRegulation service.
|
|
41026
41475
|
* @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
|
|
41027
|
-
* @version
|
|
41476
|
+
* @version 254.0.0
|
|
41028
41477
|
*/
|
|
41029
41478
|
|
|
41030
41479
|
/**
|
|
@@ -41168,7 +41617,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41168
41617
|
/**
|
|
41169
41618
|
* Geolocation service.
|
|
41170
41619
|
* @module purecloud-platform-client-v2/api/GeolocationApi
|
|
41171
|
-
* @version
|
|
41620
|
+
* @version 254.0.0
|
|
41172
41621
|
*/
|
|
41173
41622
|
|
|
41174
41623
|
/**
|
|
@@ -41319,7 +41768,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41319
41768
|
/**
|
|
41320
41769
|
* Greetings service.
|
|
41321
41770
|
* @module purecloud-platform-client-v2/api/GreetingsApi
|
|
41322
|
-
* @version
|
|
41771
|
+
* @version 254.0.0
|
|
41323
41772
|
*/
|
|
41324
41773
|
|
|
41325
41774
|
/**
|
|
@@ -41935,7 +42384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
41935
42384
|
/**
|
|
41936
42385
|
* Groups service.
|
|
41937
42386
|
* @module purecloud-platform-client-v2/api/GroupsApi
|
|
41938
|
-
* @version
|
|
42387
|
+
* @version 254.0.0
|
|
41939
42388
|
*/
|
|
41940
42389
|
|
|
41941
42390
|
/**
|
|
@@ -42526,7 +42975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
42526
42975
|
/**
|
|
42527
42976
|
* IdentityProvider service.
|
|
42528
42977
|
* @module purecloud-platform-client-v2/api/IdentityProviderApi
|
|
42529
|
-
* @version
|
|
42978
|
+
* @version 254.0.0
|
|
42530
42979
|
*/
|
|
42531
42980
|
|
|
42532
42981
|
/**
|
|
@@ -43577,7 +44026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43577
44026
|
/**
|
|
43578
44027
|
* InfrastructureAsCode service.
|
|
43579
44028
|
* @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
|
|
43580
|
-
* @version
|
|
44029
|
+
* @version 254.0.0
|
|
43581
44030
|
*/
|
|
43582
44031
|
|
|
43583
44032
|
/**
|
|
@@ -43757,7 +44206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
43757
44206
|
/**
|
|
43758
44207
|
* Integrations service.
|
|
43759
44208
|
* @module purecloud-platform-client-v2/api/IntegrationsApi
|
|
43760
|
-
* @version
|
|
44209
|
+
* @version 254.0.0
|
|
43761
44210
|
*/
|
|
43762
44211
|
|
|
43763
44212
|
/**
|
|
@@ -46729,7 +47178,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
46729
47178
|
/**
|
|
46730
47179
|
* Intents service.
|
|
46731
47180
|
* @module purecloud-platform-client-v2/api/IntentsApi
|
|
46732
|
-
* @version
|
|
47181
|
+
* @version 254.0.0
|
|
46733
47182
|
*/
|
|
46734
47183
|
|
|
46735
47184
|
/**
|
|
@@ -47261,7 +47710,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47261
47710
|
/**
|
|
47262
47711
|
* Journey service.
|
|
47263
47712
|
* @module purecloud-platform-client-v2/api/JourneyApi
|
|
47264
|
-
* @version
|
|
47713
|
+
* @version 254.0.0
|
|
47265
47714
|
*/
|
|
47266
47715
|
|
|
47267
47716
|
/**
|
|
@@ -47282,7 +47731,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47282
47731
|
* @param {String} jobId jobId
|
|
47283
47732
|
* @param {Object} opts Optional parameters
|
|
47284
47733
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47285
|
-
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
47286
47734
|
*/
|
|
47287
47735
|
deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
47288
47736
|
opts = opts || {};
|
|
@@ -47586,7 +48034,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47586
48034
|
* @param {String} jobId jobId
|
|
47587
48035
|
* @param {Object} opts Optional parameters
|
|
47588
48036
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47589
|
-
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
47590
48037
|
*/
|
|
47591
48038
|
getAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
47592
48039
|
opts = opts || {};
|
|
@@ -47618,7 +48065,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47618
48065
|
* @param {Object} opts Optional parameters
|
|
47619
48066
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
47620
48067
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
47621
|
-
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
47622
48068
|
*/
|
|
47623
48069
|
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
47624
48070
|
opts = opts || {};
|
|
@@ -47834,11 +48280,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47834
48280
|
}
|
|
47835
48281
|
|
|
47836
48282
|
/**
|
|
47837
|
-
* Retrieve a single action target.
|
|
47838
|
-
*
|
|
48283
|
+
* Deprecated. Retrieve a single action target.
|
|
48284
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
47839
48285
|
* @param {String} actionTargetId ID of the action target.
|
|
47840
48286
|
* @param {Object} opts Optional parameters
|
|
47841
48287
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48288
|
+
* @deprecated
|
|
47842
48289
|
*/
|
|
47843
48290
|
getJourneyActiontarget(actionTargetId, opts) {
|
|
47844
48291
|
opts = opts || {};
|
|
@@ -47864,12 +48311,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
47864
48311
|
}
|
|
47865
48312
|
|
|
47866
48313
|
/**
|
|
47867
|
-
* Retrieve all action targets.
|
|
47868
|
-
*
|
|
48314
|
+
* Deprecated. Retrieve all action targets.
|
|
48315
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
47869
48316
|
* @param {Object} opts Optional parameters
|
|
47870
48317
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
47871
48318
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
47872
48319
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
48320
|
+
* @deprecated
|
|
47873
48321
|
*/
|
|
47874
48322
|
getJourneyActiontargets(opts) {
|
|
47875
48323
|
opts = opts || {};
|
|
@@ -49039,6 +49487,56 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49039
49487
|
);
|
|
49040
49488
|
}
|
|
49041
49489
|
|
|
49490
|
+
/**
|
|
49491
|
+
* Get external events for journey views
|
|
49492
|
+
*
|
|
49493
|
+
* @param {Object} opts Optional parameters
|
|
49494
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49495
|
+
*/
|
|
49496
|
+
getJourneyViewsEventdefinitionsExternal(opts) {
|
|
49497
|
+
opts = opts || {};
|
|
49498
|
+
|
|
49499
|
+
|
|
49500
|
+
return this.apiClient.callApi(
|
|
49501
|
+
'/api/v2/journey/views/eventdefinitions/external',
|
|
49502
|
+
'GET',
|
|
49503
|
+
{ },
|
|
49504
|
+
{ },
|
|
49505
|
+
{ },
|
|
49506
|
+
{ },
|
|
49507
|
+
null,
|
|
49508
|
+
['PureCloud OAuth'],
|
|
49509
|
+
['application/json'],
|
|
49510
|
+
['application/json'],
|
|
49511
|
+
opts['customHeaders']
|
|
49512
|
+
);
|
|
49513
|
+
}
|
|
49514
|
+
|
|
49515
|
+
/**
|
|
49516
|
+
* Get changes in external event definitions
|
|
49517
|
+
*
|
|
49518
|
+
* @param {Object} opts Optional parameters
|
|
49519
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49520
|
+
*/
|
|
49521
|
+
getJourneyViewsEventdefinitionsExternalChanges(opts) {
|
|
49522
|
+
opts = opts || {};
|
|
49523
|
+
|
|
49524
|
+
|
|
49525
|
+
return this.apiClient.callApi(
|
|
49526
|
+
'/api/v2/journey/views/eventdefinitions/external/changes',
|
|
49527
|
+
'GET',
|
|
49528
|
+
{ },
|
|
49529
|
+
{ },
|
|
49530
|
+
{ },
|
|
49531
|
+
{ },
|
|
49532
|
+
null,
|
|
49533
|
+
['PureCloud OAuth'],
|
|
49534
|
+
['application/json'],
|
|
49535
|
+
['application/json'],
|
|
49536
|
+
opts['customHeaders']
|
|
49537
|
+
);
|
|
49538
|
+
}
|
|
49539
|
+
|
|
49042
49540
|
/**
|
|
49043
49541
|
* Get the jobs for an organization.
|
|
49044
49542
|
*
|
|
@@ -49156,12 +49654,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49156
49654
|
}
|
|
49157
49655
|
|
|
49158
49656
|
/**
|
|
49159
|
-
* Update a single action target.
|
|
49160
|
-
*
|
|
49657
|
+
* Deprecated. Update a single action target.
|
|
49658
|
+
* ACD Chat v2.0 in Genesys Predictive Engagement is deprecated and being removed. See https://community.genesys.com/discussion/deprecation-acd-chat-v20-support-in-genesys-predictive-engagement
|
|
49161
49659
|
* @param {String} actionTargetId ID of the action target.
|
|
49162
49660
|
* @param {Object} opts Optional parameters
|
|
49163
49661
|
* @param {Object} opts.body
|
|
49164
49662
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49663
|
+
* @deprecated
|
|
49165
49664
|
*/
|
|
49166
49665
|
patchJourneyActiontarget(actionTargetId, opts) {
|
|
49167
49666
|
opts = opts || {};
|
|
@@ -49362,7 +49861,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
49362
49861
|
* @param {Object} body query
|
|
49363
49862
|
* @param {Object} opts Optional parameters
|
|
49364
49863
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
49365
|
-
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
49366
49864
|
*/
|
|
49367
49865
|
postAnalyticsJourneysAggregatesJobs(body, opts) {
|
|
49368
49866
|
opts = opts || {};
|
|
@@ -50120,13 +50618,75 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
50120
50618
|
);
|
|
50121
50619
|
}
|
|
50122
50620
|
|
|
50621
|
+
/**
|
|
50622
|
+
* Update external event for journey views
|
|
50623
|
+
*
|
|
50624
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
50625
|
+
* @param {Object} opts Optional parameters
|
|
50626
|
+
* @param {Object} opts.body
|
|
50627
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50628
|
+
*/
|
|
50629
|
+
putJourneyViewsEventdefinition(eventDefinitionId, opts) {
|
|
50630
|
+
opts = opts || {};
|
|
50631
|
+
|
|
50632
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
50633
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
50634
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinition';
|
|
50635
|
+
}
|
|
50636
|
+
|
|
50637
|
+
return this.apiClient.callApi(
|
|
50638
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}',
|
|
50639
|
+
'PUT',
|
|
50640
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
50641
|
+
{ },
|
|
50642
|
+
{ },
|
|
50643
|
+
{ },
|
|
50644
|
+
opts['body'],
|
|
50645
|
+
['PureCloud OAuth'],
|
|
50646
|
+
['application/json'],
|
|
50647
|
+
['application/json'],
|
|
50648
|
+
opts['customHeaders']
|
|
50649
|
+
);
|
|
50650
|
+
}
|
|
50651
|
+
|
|
50652
|
+
/**
|
|
50653
|
+
* Activate external event for journey views
|
|
50654
|
+
*
|
|
50655
|
+
* @param {String} eventDefinitionId Event Definition ID
|
|
50656
|
+
* @param {Object} opts Optional parameters
|
|
50657
|
+
* @param {Object} opts.body
|
|
50658
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
50659
|
+
*/
|
|
50660
|
+
putJourneyViewsEventdefinitionActivate(eventDefinitionId, opts) {
|
|
50661
|
+
opts = opts || {};
|
|
50662
|
+
|
|
50663
|
+
// verify the required parameter 'eventDefinitionId' is set
|
|
50664
|
+
if (eventDefinitionId === undefined || eventDefinitionId === null || eventDefinitionId === '') {
|
|
50665
|
+
throw 'Missing the required parameter "eventDefinitionId" when calling putJourneyViewsEventdefinitionActivate';
|
|
50666
|
+
}
|
|
50667
|
+
|
|
50668
|
+
return this.apiClient.callApi(
|
|
50669
|
+
'/api/v2/journey/views/eventdefinitions/{eventDefinitionId}/activate',
|
|
50670
|
+
'PUT',
|
|
50671
|
+
{ 'eventDefinitionId': eventDefinitionId },
|
|
50672
|
+
{ },
|
|
50673
|
+
{ },
|
|
50674
|
+
{ },
|
|
50675
|
+
opts['body'],
|
|
50676
|
+
['PureCloud OAuth'],
|
|
50677
|
+
['application/json'],
|
|
50678
|
+
['application/json'],
|
|
50679
|
+
opts['customHeaders']
|
|
50680
|
+
);
|
|
50681
|
+
}
|
|
50682
|
+
|
|
50123
50683
|
}
|
|
50124
50684
|
|
|
50125
50685
|
class KnowledgeApi {
|
|
50126
50686
|
/**
|
|
50127
50687
|
* Knowledge service.
|
|
50128
50688
|
* @module purecloud-platform-client-v2/api/KnowledgeApi
|
|
50129
|
-
* @version
|
|
50689
|
+
* @version 254.0.0
|
|
50130
50690
|
*/
|
|
50131
50691
|
|
|
50132
50692
|
/**
|
|
@@ -51325,6 +51885,47 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
51325
51885
|
);
|
|
51326
51886
|
}
|
|
51327
51887
|
|
|
51888
|
+
/**
|
|
51889
|
+
* Get a list of feedback records given on documents in a knowledge base
|
|
51890
|
+
*
|
|
51891
|
+
* @param {String} knowledgeBaseId Knowledge base ID.
|
|
51892
|
+
* @param {Object} opts Optional parameters
|
|
51893
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
51894
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
51895
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
51896
|
+
* @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
|
|
51897
|
+
* @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
|
|
51898
|
+
* @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
|
|
51899
|
+
* @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
|
|
51900
|
+
* @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
|
|
51901
|
+
* @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
|
|
51902
|
+
* @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
|
|
51903
|
+
* @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
|
|
51904
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
51905
|
+
*/
|
|
51906
|
+
getKnowledgeKnowledgebaseDocumentsFeedback(knowledgeBaseId, opts) {
|
|
51907
|
+
opts = opts || {};
|
|
51908
|
+
|
|
51909
|
+
// verify the required parameter 'knowledgeBaseId' is set
|
|
51910
|
+
if (knowledgeBaseId === undefined || knowledgeBaseId === null || knowledgeBaseId === '') {
|
|
51911
|
+
throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentsFeedback';
|
|
51912
|
+
}
|
|
51913
|
+
|
|
51914
|
+
return this.apiClient.callApi(
|
|
51915
|
+
'/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/feedback',
|
|
51916
|
+
'GET',
|
|
51917
|
+
{ 'knowledgeBaseId': knowledgeBaseId },
|
|
51918
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'onlyCommented': opts['onlyCommented'],'documentVersionId': opts['documentVersionId'],'documentVariationId': opts['documentVariationId'],'appType': opts['appType'],'queryType': opts['queryType'],'userId': opts['userId'],'queueId': opts['queueId'],'state': opts['state'] },
|
|
51919
|
+
{ },
|
|
51920
|
+
{ },
|
|
51921
|
+
null,
|
|
51922
|
+
['PureCloud OAuth'],
|
|
51923
|
+
['application/json'],
|
|
51924
|
+
['application/json'],
|
|
51925
|
+
opts['customHeaders']
|
|
51926
|
+
);
|
|
51927
|
+
}
|
|
51928
|
+
|
|
51328
51929
|
/**
|
|
51329
51930
|
* Get export job report
|
|
51330
51931
|
*
|
|
@@ -54336,7 +54937,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
54336
54937
|
/**
|
|
54337
54938
|
* LanguageUnderstanding service.
|
|
54338
54939
|
* @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
|
|
54339
|
-
* @version
|
|
54940
|
+
* @version 254.0.0
|
|
54340
54941
|
*/
|
|
54341
54942
|
|
|
54342
54943
|
/**
|
|
@@ -55710,7 +56311,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55710
56311
|
/**
|
|
55711
56312
|
* Languages service.
|
|
55712
56313
|
* @module purecloud-platform-client-v2/api/LanguagesApi
|
|
55713
|
-
* @version
|
|
56314
|
+
* @version 254.0.0
|
|
55714
56315
|
*/
|
|
55715
56316
|
|
|
55716
56317
|
/**
|
|
@@ -55969,7 +56570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
55969
56570
|
/**
|
|
55970
56571
|
* Learning service.
|
|
55971
56572
|
* @module purecloud-platform-client-v2/api/LearningApi
|
|
55972
|
-
* @version
|
|
56573
|
+
* @version 254.0.0
|
|
55973
56574
|
*/
|
|
55974
56575
|
|
|
55975
56576
|
/**
|
|
@@ -57217,7 +57818,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57217
57818
|
/**
|
|
57218
57819
|
* License service.
|
|
57219
57820
|
* @module purecloud-platform-client-v2/api/LicenseApi
|
|
57220
|
-
* @version
|
|
57821
|
+
* @version 254.0.0
|
|
57221
57822
|
*/
|
|
57222
57823
|
|
|
57223
57824
|
/**
|
|
@@ -57515,7 +58116,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57515
58116
|
/**
|
|
57516
58117
|
* Locations service.
|
|
57517
58118
|
* @module purecloud-platform-client-v2/api/LocationsApi
|
|
57518
|
-
* @version
|
|
58119
|
+
* @version 254.0.0
|
|
57519
58120
|
*/
|
|
57520
58121
|
|
|
57521
58122
|
/**
|
|
@@ -57782,7 +58383,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
57782
58383
|
/**
|
|
57783
58384
|
* LogCapture service.
|
|
57784
58385
|
* @module purecloud-platform-client-v2/api/LogCaptureApi
|
|
57785
|
-
* @version
|
|
58386
|
+
* @version 254.0.0
|
|
57786
58387
|
*/
|
|
57787
58388
|
|
|
57788
58389
|
/**
|
|
@@ -58004,7 +58605,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58004
58605
|
/**
|
|
58005
58606
|
* Messaging service.
|
|
58006
58607
|
* @module purecloud-platform-client-v2/api/MessagingApi
|
|
58007
|
-
* @version
|
|
58608
|
+
* @version 254.0.0
|
|
58008
58609
|
*/
|
|
58009
58610
|
|
|
58010
58611
|
/**
|
|
@@ -58422,7 +59023,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58422
59023
|
/**
|
|
58423
59024
|
* MobileDevices service.
|
|
58424
59025
|
* @module purecloud-platform-client-v2/api/MobileDevicesApi
|
|
58425
|
-
* @version
|
|
59026
|
+
* @version 254.0.0
|
|
58426
59027
|
*/
|
|
58427
59028
|
|
|
58428
59029
|
/**
|
|
@@ -58592,7 +59193,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58592
59193
|
/**
|
|
58593
59194
|
* Notifications service.
|
|
58594
59195
|
* @module purecloud-platform-client-v2/api/NotificationsApi
|
|
58595
|
-
* @version
|
|
59196
|
+
* @version 254.0.0
|
|
58596
59197
|
*/
|
|
58597
59198
|
|
|
58598
59199
|
/**
|
|
@@ -58853,7 +59454,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
58853
59454
|
/**
|
|
58854
59455
|
* OAuth service.
|
|
58855
59456
|
* @module purecloud-platform-client-v2/api/OAuthApi
|
|
58856
|
-
* @version
|
|
59457
|
+
* @version 254.0.0
|
|
58857
59458
|
*/
|
|
58858
59459
|
|
|
58859
59460
|
/**
|
|
@@ -59269,7 +59870,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59269
59870
|
/**
|
|
59270
59871
|
* Objects service.
|
|
59271
59872
|
* @module purecloud-platform-client-v2/api/ObjectsApi
|
|
59272
|
-
* @version
|
|
59873
|
+
* @version 254.0.0
|
|
59273
59874
|
*/
|
|
59274
59875
|
|
|
59275
59876
|
/**
|
|
@@ -59633,7 +60234,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59633
60234
|
/**
|
|
59634
60235
|
* OperationalEvents service.
|
|
59635
60236
|
* @module purecloud-platform-client-v2/api/OperationalEventsApi
|
|
59636
|
-
* @version
|
|
60237
|
+
* @version 254.0.0
|
|
59637
60238
|
*/
|
|
59638
60239
|
|
|
59639
60240
|
/**
|
|
@@ -59764,7 +60365,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
59764
60365
|
/**
|
|
59765
60366
|
* Organization service.
|
|
59766
60367
|
* @module purecloud-platform-client-v2/api/OrganizationApi
|
|
59767
|
-
* @version
|
|
60368
|
+
* @version 254.0.0
|
|
59768
60369
|
*/
|
|
59769
60370
|
|
|
59770
60371
|
/**
|
|
@@ -60325,7 +60926,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
60325
60926
|
/**
|
|
60326
60927
|
* OrganizationAuthorization service.
|
|
60327
60928
|
* @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
|
|
60328
|
-
* @version
|
|
60929
|
+
* @version 254.0.0
|
|
60329
60930
|
*/
|
|
60330
60931
|
|
|
60331
60932
|
/**
|
|
@@ -61929,7 +62530,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
61929
62530
|
/**
|
|
61930
62531
|
* Outbound service.
|
|
61931
62532
|
* @module purecloud-platform-client-v2/api/OutboundApi
|
|
61932
|
-
* @version
|
|
62533
|
+
* @version 254.0.0
|
|
61933
62534
|
*/
|
|
61934
62535
|
|
|
61935
62536
|
/**
|
|
@@ -67516,7 +68117,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
67516
68117
|
/**
|
|
67517
68118
|
* Presence service.
|
|
67518
68119
|
* @module purecloud-platform-client-v2/api/PresenceApi
|
|
67519
|
-
* @version
|
|
68120
|
+
* @version 254.0.0
|
|
67520
68121
|
*/
|
|
67521
68122
|
|
|
67522
68123
|
/**
|
|
@@ -68374,7 +68975,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68374
68975
|
/**
|
|
68375
68976
|
* ProcessAutomation service.
|
|
68376
68977
|
* @module purecloud-platform-client-v2/api/ProcessAutomationApi
|
|
68377
|
-
* @version
|
|
68978
|
+
* @version 254.0.0
|
|
68378
68979
|
*/
|
|
68379
68980
|
|
|
68380
68981
|
/**
|
|
@@ -68795,7 +69396,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68795
69396
|
/**
|
|
68796
69397
|
* Quality service.
|
|
68797
69398
|
* @module purecloud-platform-client-v2/api/QualityApi
|
|
68798
|
-
* @version
|
|
69399
|
+
* @version 254.0.0
|
|
68799
69400
|
*/
|
|
68800
69401
|
|
|
68801
69402
|
/**
|
|
@@ -68816,7 +69417,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68816
69417
|
* @param {String} jobId jobId
|
|
68817
69418
|
* @param {Object} opts Optional parameters
|
|
68818
69419
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
68819
|
-
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
68820
69420
|
*/
|
|
68821
69421
|
deleteAnalyticsEvaluationsAggregatesJob(jobId, opts) {
|
|
68822
69422
|
opts = opts || {};
|
|
@@ -68847,7 +69447,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
68847
69447
|
* @param {String} jobId jobId
|
|
68848
69448
|
* @param {Object} opts Optional parameters
|
|
68849
69449
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
68850
|
-
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
68851
69450
|
*/
|
|
68852
69451
|
deleteAnalyticsSurveysAggregatesJob(jobId, opts) {
|
|
68853
69452
|
opts = opts || {};
|
|
@@ -69075,7 +69674,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69075
69674
|
* @param {String} jobId jobId
|
|
69076
69675
|
* @param {Object} opts Optional parameters
|
|
69077
69676
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
69078
|
-
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69079
69677
|
*/
|
|
69080
69678
|
getAnalyticsEvaluationsAggregatesJob(jobId, opts) {
|
|
69081
69679
|
opts = opts || {};
|
|
@@ -69107,7 +69705,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69107
69705
|
* @param {Object} opts Optional parameters
|
|
69108
69706
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
69109
69707
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
69110
|
-
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69111
69708
|
*/
|
|
69112
69709
|
getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
|
|
69113
69710
|
opts = opts || {};
|
|
@@ -69138,7 +69735,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69138
69735
|
* @param {String} jobId jobId
|
|
69139
69736
|
* @param {Object} opts Optional parameters
|
|
69140
69737
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
69141
|
-
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69142
69738
|
*/
|
|
69143
69739
|
getAnalyticsSurveysAggregatesJob(jobId, opts) {
|
|
69144
69740
|
opts = opts || {};
|
|
@@ -69170,7 +69766,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
69170
69766
|
* @param {Object} opts Optional parameters
|
|
69171
69767
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
69172
69768
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
69173
|
-
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
69174
69769
|
*/
|
|
69175
69770
|
getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
|
|
69176
69771
|
opts = opts || {};
|
|
@@ -70274,7 +70869,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70274
70869
|
* @param {Object} body query
|
|
70275
70870
|
* @param {Object} opts Optional parameters
|
|
70276
70871
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
70277
|
-
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70278
70872
|
*/
|
|
70279
70873
|
postAnalyticsEvaluationsAggregatesJobs(body, opts) {
|
|
70280
70874
|
opts = opts || {};
|
|
@@ -70335,7 +70929,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
70335
70929
|
* @param {Object} body query
|
|
70336
70930
|
* @param {Object} opts Optional parameters
|
|
70337
70931
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
70338
|
-
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
70339
70932
|
*/
|
|
70340
70933
|
postAnalyticsSurveysAggregatesJobs(body, opts) {
|
|
70341
70934
|
opts = opts || {};
|
|
@@ -71153,7 +71746,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
71153
71746
|
/**
|
|
71154
71747
|
* Recording service.
|
|
71155
71748
|
* @module purecloud-platform-client-v2/api/RecordingApi
|
|
71156
|
-
* @version
|
|
71749
|
+
* @version 254.0.0
|
|
71157
71750
|
*/
|
|
71158
71751
|
|
|
71159
71752
|
/**
|
|
@@ -73001,7 +73594,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73001
73594
|
/**
|
|
73002
73595
|
* ResponseManagement service.
|
|
73003
73596
|
* @module purecloud-platform-client-v2/api/ResponseManagementApi
|
|
73004
|
-
* @version
|
|
73597
|
+
* @version 254.0.0
|
|
73005
73598
|
*/
|
|
73006
73599
|
|
|
73007
73600
|
/**
|
|
@@ -73645,7 +74238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73645
74238
|
/**
|
|
73646
74239
|
* Routing service.
|
|
73647
74240
|
* @module purecloud-platform-client-v2/api/RoutingApi
|
|
73648
|
-
* @version
|
|
74241
|
+
* @version 254.0.0
|
|
73649
74242
|
*/
|
|
73650
74243
|
|
|
73651
74244
|
/**
|
|
@@ -73810,6 +74403,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
73810
74403
|
);
|
|
73811
74404
|
}
|
|
73812
74405
|
|
|
74406
|
+
/**
|
|
74407
|
+
* Delete an email setting. Removes the email setting and its associated settings
|
|
74408
|
+
*
|
|
74409
|
+
* @param {String} emailSettingId Email Setting ID
|
|
74410
|
+
* @param {Object} opts Optional parameters
|
|
74411
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74412
|
+
*/
|
|
74413
|
+
deleteRoutingEmailSettingEmailSettingId(emailSettingId, opts) {
|
|
74414
|
+
opts = opts || {};
|
|
74415
|
+
|
|
74416
|
+
// verify the required parameter 'emailSettingId' is set
|
|
74417
|
+
if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
|
|
74418
|
+
throw 'Missing the required parameter "emailSettingId" when calling deleteRoutingEmailSettingEmailSettingId';
|
|
74419
|
+
}
|
|
74420
|
+
|
|
74421
|
+
return this.apiClient.callApi(
|
|
74422
|
+
'/api/v2/routing/email/setting/{emailSettingId}',
|
|
74423
|
+
'DELETE',
|
|
74424
|
+
{ 'emailSettingId': emailSettingId },
|
|
74425
|
+
{ },
|
|
74426
|
+
{ },
|
|
74427
|
+
{ },
|
|
74428
|
+
null,
|
|
74429
|
+
['PureCloud OAuth'],
|
|
74430
|
+
['application/json'],
|
|
74431
|
+
['application/json'],
|
|
74432
|
+
opts['customHeaders']
|
|
74433
|
+
);
|
|
74434
|
+
}
|
|
74435
|
+
|
|
73813
74436
|
/**
|
|
73814
74437
|
* Delete a routing language
|
|
73815
74438
|
*
|
|
@@ -74093,6 +74716,62 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74093
74716
|
);
|
|
74094
74717
|
}
|
|
74095
74718
|
|
|
74719
|
+
/**
|
|
74720
|
+
* Archive a skill expression to remove it from the set of active expressions
|
|
74721
|
+
*
|
|
74722
|
+
* @param {String} expressionId Expression ID
|
|
74723
|
+
* @param {Object} opts Optional parameters
|
|
74724
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74725
|
+
*/
|
|
74726
|
+
deleteRoutingSkillexpression(expressionId, opts) {
|
|
74727
|
+
opts = opts || {};
|
|
74728
|
+
|
|
74729
|
+
// verify the required parameter 'expressionId' is set
|
|
74730
|
+
if (expressionId === undefined || expressionId === null || expressionId === '') {
|
|
74731
|
+
throw 'Missing the required parameter "expressionId" when calling deleteRoutingSkillexpression';
|
|
74732
|
+
}
|
|
74733
|
+
|
|
74734
|
+
return this.apiClient.callApi(
|
|
74735
|
+
'/api/v2/routing/skillexpressions/{expressionId}',
|
|
74736
|
+
'DELETE',
|
|
74737
|
+
{ 'expressionId': expressionId },
|
|
74738
|
+
{ },
|
|
74739
|
+
{ },
|
|
74740
|
+
{ },
|
|
74741
|
+
null,
|
|
74742
|
+
['PureCloud OAuth'],
|
|
74743
|
+
['application/json'],
|
|
74744
|
+
['application/json'],
|
|
74745
|
+
opts['customHeaders']
|
|
74746
|
+
);
|
|
74747
|
+
}
|
|
74748
|
+
|
|
74749
|
+
/**
|
|
74750
|
+
* Archive a set of skill expressions to remove them from the set of active expressions
|
|
74751
|
+
*
|
|
74752
|
+
* @param {Object} opts Optional parameters
|
|
74753
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
74754
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74755
|
+
*/
|
|
74756
|
+
deleteRoutingSkillexpressions(opts) {
|
|
74757
|
+
opts = opts || {};
|
|
74758
|
+
|
|
74759
|
+
|
|
74760
|
+
return this.apiClient.callApi(
|
|
74761
|
+
'/api/v2/routing/skillexpressions',
|
|
74762
|
+
'DELETE',
|
|
74763
|
+
{ },
|
|
74764
|
+
{ 'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
74765
|
+
{ },
|
|
74766
|
+
{ },
|
|
74767
|
+
null,
|
|
74768
|
+
['PureCloud OAuth'],
|
|
74769
|
+
['application/json'],
|
|
74770
|
+
['application/json'],
|
|
74771
|
+
opts['customHeaders']
|
|
74772
|
+
);
|
|
74773
|
+
}
|
|
74774
|
+
|
|
74096
74775
|
/**
|
|
74097
74776
|
* Remove skill group definition
|
|
74098
74777
|
*
|
|
@@ -74299,38 +74978,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74299
74978
|
);
|
|
74300
74979
|
}
|
|
74301
74980
|
|
|
74302
|
-
/**
|
|
74303
|
-
* Delete an utilization tag
|
|
74304
|
-
*
|
|
74305
|
-
* @param {String} tagId Utilization Tag ID
|
|
74306
|
-
* @param {Object} opts Optional parameters
|
|
74307
|
-
* @param {Boolean} opts.forceDelete Remove all tag usages (if found) without warning (default to false)
|
|
74308
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
74309
|
-
* deleteRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
74310
|
-
*/
|
|
74311
|
-
deleteRoutingUtilizationTag(tagId, opts) {
|
|
74312
|
-
opts = opts || {};
|
|
74313
|
-
|
|
74314
|
-
// verify the required parameter 'tagId' is set
|
|
74315
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
74316
|
-
throw 'Missing the required parameter "tagId" when calling deleteRoutingUtilizationTag';
|
|
74317
|
-
}
|
|
74318
|
-
|
|
74319
|
-
return this.apiClient.callApi(
|
|
74320
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
74321
|
-
'DELETE',
|
|
74322
|
-
{ 'tagId': tagId },
|
|
74323
|
-
{ 'forceDelete': opts['forceDelete'] },
|
|
74324
|
-
{ },
|
|
74325
|
-
{ },
|
|
74326
|
-
null,
|
|
74327
|
-
['PureCloud OAuth'],
|
|
74328
|
-
['application/json'],
|
|
74329
|
-
['application/json'],
|
|
74330
|
-
opts['customHeaders']
|
|
74331
|
-
);
|
|
74332
|
-
}
|
|
74333
|
-
|
|
74334
74981
|
/**
|
|
74335
74982
|
* Delete wrap-up code
|
|
74336
74983
|
*
|
|
@@ -74943,6 +75590,63 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
74943
75590
|
);
|
|
74944
75591
|
}
|
|
74945
75592
|
|
|
75593
|
+
/**
|
|
75594
|
+
* Get a paged list of email routing settings.
|
|
75595
|
+
*
|
|
75596
|
+
* @param {Object} opts Optional parameters
|
|
75597
|
+
* @param {Number} opts.pageSize Page size (default to 25)
|
|
75598
|
+
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
75599
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
75600
|
+
*/
|
|
75601
|
+
getRoutingEmailSetting(opts) {
|
|
75602
|
+
opts = opts || {};
|
|
75603
|
+
|
|
75604
|
+
|
|
75605
|
+
return this.apiClient.callApi(
|
|
75606
|
+
'/api/v2/routing/email/setting',
|
|
75607
|
+
'GET',
|
|
75608
|
+
{ },
|
|
75609
|
+
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
|
|
75610
|
+
{ },
|
|
75611
|
+
{ },
|
|
75612
|
+
null,
|
|
75613
|
+
['PureCloud OAuth'],
|
|
75614
|
+
['application/json'],
|
|
75615
|
+
['application/json'],
|
|
75616
|
+
opts['customHeaders']
|
|
75617
|
+
);
|
|
75618
|
+
}
|
|
75619
|
+
|
|
75620
|
+
/**
|
|
75621
|
+
* Get email setting. Returns the specified email setting that defines settings for email
|
|
75622
|
+
*
|
|
75623
|
+
* @param {String} emailSettingId Email Setting ID
|
|
75624
|
+
* @param {Object} opts Optional parameters
|
|
75625
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
75626
|
+
*/
|
|
75627
|
+
getRoutingEmailSettingEmailSettingId(emailSettingId, opts) {
|
|
75628
|
+
opts = opts || {};
|
|
75629
|
+
|
|
75630
|
+
// verify the required parameter 'emailSettingId' is set
|
|
75631
|
+
if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
|
|
75632
|
+
throw 'Missing the required parameter "emailSettingId" when calling getRoutingEmailSettingEmailSettingId';
|
|
75633
|
+
}
|
|
75634
|
+
|
|
75635
|
+
return this.apiClient.callApi(
|
|
75636
|
+
'/api/v2/routing/email/setting/{emailSettingId}',
|
|
75637
|
+
'GET',
|
|
75638
|
+
{ 'emailSettingId': emailSettingId },
|
|
75639
|
+
{ },
|
|
75640
|
+
{ },
|
|
75641
|
+
{ },
|
|
75642
|
+
null,
|
|
75643
|
+
['PureCloud OAuth'],
|
|
75644
|
+
['application/json'],
|
|
75645
|
+
['application/json'],
|
|
75646
|
+
opts['customHeaders']
|
|
75647
|
+
);
|
|
75648
|
+
}
|
|
75649
|
+
|
|
74946
75650
|
/**
|
|
74947
75651
|
* Get email setup
|
|
74948
75652
|
*
|
|
@@ -75687,7 +76391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75687
76391
|
* @param {Object} opts.sortOrder Sort order (default to asc)
|
|
75688
76392
|
* @param {String} opts.name Name
|
|
75689
76393
|
* @param {Array.<String>} opts.id Queue ID(s)
|
|
75690
|
-
* @param {Array.<String>} opts.divisionId Division ID(s)
|
|
76394
|
+
* @param {Array.<String>} opts.divisionId Division ID(s). Including '*' will query for all divisions
|
|
75691
76395
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
75692
76396
|
*/
|
|
75693
76397
|
getRoutingQueuesDivisionviews(opts) {
|
|
@@ -75871,6 +76575,98 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75871
76575
|
);
|
|
75872
76576
|
}
|
|
75873
76577
|
|
|
76578
|
+
/**
|
|
76579
|
+
* Get a skill expression by ID
|
|
76580
|
+
*
|
|
76581
|
+
* @param {String} expressionId Expression ID
|
|
76582
|
+
* @param {Object} opts Optional parameters
|
|
76583
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76584
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76585
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76586
|
+
*/
|
|
76587
|
+
getRoutingSkillexpression(expressionId, opts) {
|
|
76588
|
+
opts = opts || {};
|
|
76589
|
+
|
|
76590
|
+
// verify the required parameter 'expressionId' is set
|
|
76591
|
+
if (expressionId === undefined || expressionId === null || expressionId === '') {
|
|
76592
|
+
throw 'Missing the required parameter "expressionId" when calling getRoutingSkillexpression';
|
|
76593
|
+
}
|
|
76594
|
+
|
|
76595
|
+
return this.apiClient.callApi(
|
|
76596
|
+
'/api/v2/routing/skillexpressions/{expressionId}',
|
|
76597
|
+
'GET',
|
|
76598
|
+
{ 'expressionId': expressionId },
|
|
76599
|
+
{ 'includeArchived': opts['includeArchived'],'format': opts['format'] },
|
|
76600
|
+
{ },
|
|
76601
|
+
{ },
|
|
76602
|
+
null,
|
|
76603
|
+
['PureCloud OAuth'],
|
|
76604
|
+
['application/json'],
|
|
76605
|
+
['application/json'],
|
|
76606
|
+
opts['customHeaders']
|
|
76607
|
+
);
|
|
76608
|
+
}
|
|
76609
|
+
|
|
76610
|
+
/**
|
|
76611
|
+
* Get skill expressions
|
|
76612
|
+
*
|
|
76613
|
+
* @param {Object} opts Optional parameters
|
|
76614
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76615
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76616
|
+
* @param {Array.<String>} opts.id Expression ID(s) to filter. Repeat for multiple or use comma-separated list.
|
|
76617
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76618
|
+
*/
|
|
76619
|
+
getRoutingSkillexpressions(opts) {
|
|
76620
|
+
opts = opts || {};
|
|
76621
|
+
|
|
76622
|
+
|
|
76623
|
+
return this.apiClient.callApi(
|
|
76624
|
+
'/api/v2/routing/skillexpressions',
|
|
76625
|
+
'GET',
|
|
76626
|
+
{ },
|
|
76627
|
+
{ 'format': opts['format'],'includeArchived': opts['includeArchived'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi') },
|
|
76628
|
+
{ },
|
|
76629
|
+
{ },
|
|
76630
|
+
null,
|
|
76631
|
+
['PureCloud OAuth'],
|
|
76632
|
+
['application/json'],
|
|
76633
|
+
['application/json'],
|
|
76634
|
+
opts['customHeaders']
|
|
76635
|
+
);
|
|
76636
|
+
}
|
|
76637
|
+
|
|
76638
|
+
/**
|
|
76639
|
+
* Get skill expressions associated with a queue
|
|
76640
|
+
*
|
|
76641
|
+
* @param {String} queueId Queue ID
|
|
76642
|
+
* @param {Object} opts Optional parameters
|
|
76643
|
+
* @param {Object} opts.format Response format: raw expression or normalized (default to Raw)
|
|
76644
|
+
* @param {Boolean} opts.includeArchived Include archived (default to false)
|
|
76645
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76646
|
+
*/
|
|
76647
|
+
getRoutingSkillexpressionsQueueQueueId(queueId, opts) {
|
|
76648
|
+
opts = opts || {};
|
|
76649
|
+
|
|
76650
|
+
// verify the required parameter 'queueId' is set
|
|
76651
|
+
if (queueId === undefined || queueId === null || queueId === '') {
|
|
76652
|
+
throw 'Missing the required parameter "queueId" when calling getRoutingSkillexpressionsQueueQueueId';
|
|
76653
|
+
}
|
|
76654
|
+
|
|
76655
|
+
return this.apiClient.callApi(
|
|
76656
|
+
'/api/v2/routing/skillexpressions/queue/{queueId}',
|
|
76657
|
+
'GET',
|
|
76658
|
+
{ 'queueId': queueId },
|
|
76659
|
+
{ 'format': opts['format'],'includeArchived': opts['includeArchived'] },
|
|
76660
|
+
{ },
|
|
76661
|
+
{ },
|
|
76662
|
+
null,
|
|
76663
|
+
['PureCloud OAuth'],
|
|
76664
|
+
['application/json'],
|
|
76665
|
+
['application/json'],
|
|
76666
|
+
opts['customHeaders']
|
|
76667
|
+
);
|
|
76668
|
+
}
|
|
76669
|
+
|
|
75874
76670
|
/**
|
|
75875
76671
|
* Get skill group
|
|
75876
76672
|
*
|
|
@@ -75996,7 +76792,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
75996
76792
|
}
|
|
75997
76793
|
|
|
75998
76794
|
/**
|
|
75999
|
-
* Get the list of routing skills.
|
|
76795
|
+
* Get the list of routing skills. View permission enforcement only applies to skills assigned to a division.
|
|
76000
76796
|
*
|
|
76001
76797
|
* @param {Object} opts Optional parameters
|
|
76002
76798
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
@@ -76393,98 +77189,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76393
77189
|
);
|
|
76394
77190
|
}
|
|
76395
77191
|
|
|
76396
|
-
/**
|
|
76397
|
-
* Get details about this utilization tag
|
|
76398
|
-
*
|
|
76399
|
-
* @param {String} tagId Utilization Tag ID
|
|
76400
|
-
* @param {Object} opts Optional parameters
|
|
76401
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76402
|
-
* getRoutingUtilizationTag is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76403
|
-
*/
|
|
76404
|
-
getRoutingUtilizationTag(tagId, opts) {
|
|
76405
|
-
opts = opts || {};
|
|
76406
|
-
|
|
76407
|
-
// verify the required parameter 'tagId' is set
|
|
76408
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76409
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTag';
|
|
76410
|
-
}
|
|
76411
|
-
|
|
76412
|
-
return this.apiClient.callApi(
|
|
76413
|
-
'/api/v2/routing/utilization/tags/{tagId}',
|
|
76414
|
-
'GET',
|
|
76415
|
-
{ 'tagId': tagId },
|
|
76416
|
-
{ },
|
|
76417
|
-
{ },
|
|
76418
|
-
{ },
|
|
76419
|
-
null,
|
|
76420
|
-
['PureCloud OAuth'],
|
|
76421
|
-
['application/json'],
|
|
76422
|
-
['application/json'],
|
|
76423
|
-
opts['customHeaders']
|
|
76424
|
-
);
|
|
76425
|
-
}
|
|
76426
|
-
|
|
76427
|
-
/**
|
|
76428
|
-
* Get list of agent ids associated with a utilization tag
|
|
76429
|
-
*
|
|
76430
|
-
* @param {String} tagId Utilization Tag ID
|
|
76431
|
-
* @param {Object} opts Optional parameters
|
|
76432
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76433
|
-
* getRoutingUtilizationTagAgents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76434
|
-
*/
|
|
76435
|
-
getRoutingUtilizationTagAgents(tagId, opts) {
|
|
76436
|
-
opts = opts || {};
|
|
76437
|
-
|
|
76438
|
-
// verify the required parameter 'tagId' is set
|
|
76439
|
-
if (tagId === undefined || tagId === null || tagId === '') {
|
|
76440
|
-
throw 'Missing the required parameter "tagId" when calling getRoutingUtilizationTagAgents';
|
|
76441
|
-
}
|
|
76442
|
-
|
|
76443
|
-
return this.apiClient.callApi(
|
|
76444
|
-
'/api/v2/routing/utilization/tags/{tagId}/agents',
|
|
76445
|
-
'GET',
|
|
76446
|
-
{ 'tagId': tagId },
|
|
76447
|
-
{ },
|
|
76448
|
-
{ },
|
|
76449
|
-
{ },
|
|
76450
|
-
null,
|
|
76451
|
-
['PureCloud OAuth'],
|
|
76452
|
-
['application/json'],
|
|
76453
|
-
['application/json'],
|
|
76454
|
-
opts['customHeaders']
|
|
76455
|
-
);
|
|
76456
|
-
}
|
|
76457
|
-
|
|
76458
|
-
/**
|
|
76459
|
-
* Get list of utilization tags
|
|
76460
|
-
*
|
|
76461
|
-
* @param {Object} opts Optional parameters
|
|
76462
|
-
* @param {Number} opts.pageSize Page size (default to 25)
|
|
76463
|
-
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
76464
|
-
* @param {Object} opts.sortOrder Sort order by name (default to ascending)
|
|
76465
|
-
* @param {String} opts.name Utilization tag's name (Wildcard is supported, e.g., 'tag1*')
|
|
76466
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
76467
|
-
* getRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
76468
|
-
*/
|
|
76469
|
-
getRoutingUtilizationTags(opts) {
|
|
76470
|
-
opts = opts || {};
|
|
76471
|
-
|
|
76472
|
-
|
|
76473
|
-
return this.apiClient.callApi(
|
|
76474
|
-
'/api/v2/routing/utilization/tags',
|
|
76475
|
-
'GET',
|
|
76476
|
-
{ },
|
|
76477
|
-
{ 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortOrder': opts['sortOrder'],'name': opts['name'] },
|
|
76478
|
-
{ },
|
|
76479
|
-
{ },
|
|
76480
|
-
null,
|
|
76481
|
-
['PureCloud OAuth'],
|
|
76482
|
-
['application/json'],
|
|
76483
|
-
['application/json'],
|
|
76484
|
-
opts['customHeaders']
|
|
76485
|
-
);
|
|
76486
|
-
}
|
|
76487
|
-
|
|
76488
77192
|
/**
|
|
76489
77193
|
* Get details about this wrap-up code.
|
|
76490
77194
|
*
|
|
@@ -76881,6 +77585,41 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
76881
77585
|
);
|
|
76882
77586
|
}
|
|
76883
77587
|
|
|
77588
|
+
/**
|
|
77589
|
+
* Update an email setting. Modifies the settings for email setting
|
|
77590
|
+
*
|
|
77591
|
+
* @param {String} emailSettingId Email Setting ID
|
|
77592
|
+
* @param {Object} body EmailSetting
|
|
77593
|
+
* @param {Object} opts Optional parameters
|
|
77594
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
77595
|
+
*/
|
|
77596
|
+
patchRoutingEmailSettingEmailSettingId(emailSettingId, body, opts) {
|
|
77597
|
+
opts = opts || {};
|
|
77598
|
+
|
|
77599
|
+
// verify the required parameter 'emailSettingId' is set
|
|
77600
|
+
if (emailSettingId === undefined || emailSettingId === null || emailSettingId === '') {
|
|
77601
|
+
throw 'Missing the required parameter "emailSettingId" when calling patchRoutingEmailSettingEmailSettingId';
|
|
77602
|
+
}
|
|
77603
|
+
// verify the required parameter 'body' is set
|
|
77604
|
+
if (body === undefined || body === null) {
|
|
77605
|
+
throw 'Missing the required parameter "body" when calling patchRoutingEmailSettingEmailSettingId';
|
|
77606
|
+
}
|
|
77607
|
+
|
|
77608
|
+
return this.apiClient.callApi(
|
|
77609
|
+
'/api/v2/routing/email/setting/{emailSettingId}',
|
|
77610
|
+
'PATCH',
|
|
77611
|
+
{ 'emailSettingId': emailSettingId },
|
|
77612
|
+
{ },
|
|
77613
|
+
{ },
|
|
77614
|
+
{ },
|
|
77615
|
+
body,
|
|
77616
|
+
['PureCloud OAuth'],
|
|
77617
|
+
['application/json'],
|
|
77618
|
+
['application/json'],
|
|
77619
|
+
opts['customHeaders']
|
|
77620
|
+
);
|
|
77621
|
+
}
|
|
77622
|
+
|
|
76884
77623
|
/**
|
|
76885
77624
|
* Update single predictor.
|
|
76886
77625
|
*
|
|
@@ -77843,6 +78582,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
77843
78582
|
);
|
|
77844
78583
|
}
|
|
77845
78584
|
|
|
78585
|
+
/**
|
|
78586
|
+
* Create a new email setting. Used to define various settings, that can then be associated with email domains
|
|
78587
|
+
*
|
|
78588
|
+
* @param {Object} body EmailSetting
|
|
78589
|
+
* @param {Object} opts Optional parameters
|
|
78590
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78591
|
+
*/
|
|
78592
|
+
postRoutingEmailSetting(body, opts) {
|
|
78593
|
+
opts = opts || {};
|
|
78594
|
+
|
|
78595
|
+
// verify the required parameter 'body' is set
|
|
78596
|
+
if (body === undefined || body === null) {
|
|
78597
|
+
throw 'Missing the required parameter "body" when calling postRoutingEmailSetting';
|
|
78598
|
+
}
|
|
78599
|
+
|
|
78600
|
+
return this.apiClient.callApi(
|
|
78601
|
+
'/api/v2/routing/email/setting',
|
|
78602
|
+
'POST',
|
|
78603
|
+
{ },
|
|
78604
|
+
{ },
|
|
78605
|
+
{ },
|
|
78606
|
+
{ },
|
|
78607
|
+
body,
|
|
78608
|
+
['PureCloud OAuth'],
|
|
78609
|
+
['application/json'],
|
|
78610
|
+
['application/json'],
|
|
78611
|
+
opts['customHeaders']
|
|
78612
|
+
);
|
|
78613
|
+
}
|
|
78614
|
+
|
|
77846
78615
|
/**
|
|
77847
78616
|
* Create Language
|
|
77848
78617
|
*
|
|
@@ -78068,6 +78837,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78068
78837
|
);
|
|
78069
78838
|
}
|
|
78070
78839
|
|
|
78840
|
+
/**
|
|
78841
|
+
* Validate and normalize a skill expression
|
|
78842
|
+
*
|
|
78843
|
+
* @param {Object} body Skill expression data to validate
|
|
78844
|
+
* @param {Object} opts Optional parameters
|
|
78845
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78846
|
+
*/
|
|
78847
|
+
postRoutingSkillexpressionsValidate(body, opts) {
|
|
78848
|
+
opts = opts || {};
|
|
78849
|
+
|
|
78850
|
+
// verify the required parameter 'body' is set
|
|
78851
|
+
if (body === undefined || body === null) {
|
|
78852
|
+
throw 'Missing the required parameter "body" when calling postRoutingSkillexpressionsValidate';
|
|
78853
|
+
}
|
|
78854
|
+
|
|
78855
|
+
return this.apiClient.callApi(
|
|
78856
|
+
'/api/v2/routing/skillexpressions/validate',
|
|
78857
|
+
'POST',
|
|
78858
|
+
{ },
|
|
78859
|
+
{ },
|
|
78860
|
+
{ },
|
|
78861
|
+
{ },
|
|
78862
|
+
body,
|
|
78863
|
+
['PureCloud OAuth'],
|
|
78864
|
+
['application/json'],
|
|
78865
|
+
['application/json'],
|
|
78866
|
+
opts['customHeaders']
|
|
78867
|
+
);
|
|
78868
|
+
}
|
|
78869
|
+
|
|
78071
78870
|
/**
|
|
78072
78871
|
* Add or remove member divisions for this skill group.
|
|
78073
78872
|
*
|
|
@@ -78310,37 +79109,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
78310
79109
|
);
|
|
78311
79110
|
}
|
|
78312
79111
|
|
|
78313
|
-
/**
|
|
78314
|
-
* Create an utilization tag
|
|
78315
|
-
*
|
|
78316
|
-
* @param {Object} body UtilizationTag
|
|
78317
|
-
* @param {Object} opts Optional parameters
|
|
78318
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
78319
|
-
* postRoutingUtilizationTags is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
78320
|
-
*/
|
|
78321
|
-
postRoutingUtilizationTags(body, opts) {
|
|
78322
|
-
opts = opts || {};
|
|
78323
|
-
|
|
78324
|
-
// verify the required parameter 'body' is set
|
|
78325
|
-
if (body === undefined || body === null) {
|
|
78326
|
-
throw 'Missing the required parameter "body" when calling postRoutingUtilizationTags';
|
|
78327
|
-
}
|
|
78328
|
-
|
|
78329
|
-
return this.apiClient.callApi(
|
|
78330
|
-
'/api/v2/routing/utilization/tags',
|
|
78331
|
-
'POST',
|
|
78332
|
-
{ },
|
|
78333
|
-
{ },
|
|
78334
|
-
{ },
|
|
78335
|
-
{ },
|
|
78336
|
-
body,
|
|
78337
|
-
['PureCloud OAuth'],
|
|
78338
|
-
['application/json'],
|
|
78339
|
-
['application/json'],
|
|
78340
|
-
opts['customHeaders']
|
|
78341
|
-
);
|
|
78342
|
-
}
|
|
78343
|
-
|
|
78344
79112
|
/**
|
|
78345
79113
|
* Create a wrap-up code
|
|
78346
79114
|
*
|
|
@@ -79032,7 +79800,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79032
79800
|
/**
|
|
79033
79801
|
* SCIM service.
|
|
79034
79802
|
* @module purecloud-platform-client-v2/api/SCIMApi
|
|
79035
|
-
* @version
|
|
79803
|
+
* @version 254.0.0
|
|
79036
79804
|
*/
|
|
79037
79805
|
|
|
79038
79806
|
/**
|
|
@@ -79993,7 +80761,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
79993
80761
|
/**
|
|
79994
80762
|
* Scripts service.
|
|
79995
80763
|
* @module purecloud-platform-client-v2/api/ScriptsApi
|
|
79996
|
-
* @version
|
|
80764
|
+
* @version 254.0.0
|
|
79997
80765
|
*/
|
|
79998
80766
|
|
|
79999
80767
|
/**
|
|
@@ -80502,7 +81270,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
80502
81270
|
/**
|
|
80503
81271
|
* Search service.
|
|
80504
81272
|
* @module purecloud-platform-client-v2/api/SearchApi
|
|
80505
|
-
* @version
|
|
81273
|
+
* @version 254.0.0
|
|
80506
81274
|
*/
|
|
80507
81275
|
|
|
80508
81276
|
/**
|
|
@@ -81318,7 +82086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81318
82086
|
/**
|
|
81319
82087
|
* Settings service.
|
|
81320
82088
|
* @module purecloud-platform-client-v2/api/SettingsApi
|
|
81321
|
-
* @version
|
|
82089
|
+
* @version 254.0.0
|
|
81322
82090
|
*/
|
|
81323
82091
|
|
|
81324
82092
|
/**
|
|
@@ -81727,7 +82495,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
81727
82495
|
/**
|
|
81728
82496
|
* SocialMedia service.
|
|
81729
82497
|
* @module purecloud-platform-client-v2/api/SocialMediaApi
|
|
81730
|
-
* @version
|
|
82498
|
+
* @version 254.0.0
|
|
81731
82499
|
*/
|
|
81732
82500
|
|
|
81733
82501
|
/**
|
|
@@ -83712,7 +84480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
83712
84480
|
/**
|
|
83713
84481
|
* SpeechTextAnalytics service.
|
|
83714
84482
|
* @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
|
|
83715
|
-
* @version
|
|
84483
|
+
* @version 254.0.0
|
|
83716
84484
|
*/
|
|
83717
84485
|
|
|
83718
84486
|
/**
|
|
@@ -85664,7 +86432,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85664
86432
|
/**
|
|
85665
86433
|
* Stations service.
|
|
85666
86434
|
* @module purecloud-platform-client-v2/api/StationsApi
|
|
85667
|
-
* @version
|
|
86435
|
+
* @version 254.0.0
|
|
85668
86436
|
*/
|
|
85669
86437
|
|
|
85670
86438
|
/**
|
|
@@ -85778,7 +86546,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85778
86546
|
/**
|
|
85779
86547
|
* Suggest service.
|
|
85780
86548
|
* @module purecloud-platform-client-v2/api/SuggestApi
|
|
85781
|
-
* @version
|
|
86549
|
+
* @version 254.0.0
|
|
85782
86550
|
*/
|
|
85783
86551
|
|
|
85784
86552
|
/**
|
|
@@ -85925,7 +86693,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
85925
86693
|
/**
|
|
85926
86694
|
* TaskManagement service.
|
|
85927
86695
|
* @module purecloud-platform-client-v2/api/TaskManagementApi
|
|
85928
|
-
* @version
|
|
86696
|
+
* @version 254.0.0
|
|
85929
86697
|
*/
|
|
85930
86698
|
|
|
85931
86699
|
/**
|
|
@@ -88421,7 +89189,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88421
89189
|
/**
|
|
88422
89190
|
* Teams service.
|
|
88423
89191
|
* @module purecloud-platform-client-v2/api/TeamsApi
|
|
88424
|
-
* @version
|
|
89192
|
+
* @version 254.0.0
|
|
88425
89193
|
*/
|
|
88426
89194
|
|
|
88427
89195
|
/**
|
|
@@ -88764,7 +89532,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88764
89532
|
/**
|
|
88765
89533
|
* Telephony service.
|
|
88766
89534
|
* @module purecloud-platform-client-v2/api/TelephonyApi
|
|
88767
|
-
* @version
|
|
89535
|
+
* @version 254.0.0
|
|
88768
89536
|
*/
|
|
88769
89537
|
|
|
88770
89538
|
/**
|
|
@@ -88779,6 +89547,36 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88779
89547
|
}
|
|
88780
89548
|
|
|
88781
89549
|
|
|
89550
|
+
/**
|
|
89551
|
+
* Delete a link
|
|
89552
|
+
*
|
|
89553
|
+
* @param {String} targetOrganizationId targetOrganizationId
|
|
89554
|
+
* @param {Object} opts Optional parameters
|
|
89555
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
89556
|
+
*/
|
|
89557
|
+
deleteTelephonyOrganizationLinkTargetOrganizationId(targetOrganizationId, opts) {
|
|
89558
|
+
opts = opts || {};
|
|
89559
|
+
|
|
89560
|
+
// verify the required parameter 'targetOrganizationId' is set
|
|
89561
|
+
if (targetOrganizationId === undefined || targetOrganizationId === null || targetOrganizationId === '') {
|
|
89562
|
+
throw 'Missing the required parameter "targetOrganizationId" when calling deleteTelephonyOrganizationLinkTargetOrganizationId';
|
|
89563
|
+
}
|
|
89564
|
+
|
|
89565
|
+
return this.apiClient.callApi(
|
|
89566
|
+
'/api/v2/telephony/organization/link/{targetOrganizationId}',
|
|
89567
|
+
'DELETE',
|
|
89568
|
+
{ 'targetOrganizationId': targetOrganizationId },
|
|
89569
|
+
{ },
|
|
89570
|
+
{ },
|
|
89571
|
+
{ },
|
|
89572
|
+
null,
|
|
89573
|
+
['PureCloud OAuth'],
|
|
89574
|
+
['application/json'],
|
|
89575
|
+
['application/json'],
|
|
89576
|
+
opts['customHeaders']
|
|
89577
|
+
);
|
|
89578
|
+
}
|
|
89579
|
+
|
|
88782
89580
|
/**
|
|
88783
89581
|
* Get an agent's greetings.
|
|
88784
89582
|
*
|
|
@@ -88885,6 +89683,88 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
88885
89683
|
);
|
|
88886
89684
|
}
|
|
88887
89685
|
|
|
89686
|
+
/**
|
|
89687
|
+
* Get Number Routings by organizationId
|
|
89688
|
+
*
|
|
89689
|
+
* @param {Object} opts Optional parameters
|
|
89690
|
+
* @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
|
|
89691
|
+
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
|
|
89692
|
+
* @param {String} opts.pageSize Number of entities to return. Maximum of 200.
|
|
89693
|
+
* @param {String} opts.numberId numberId
|
|
89694
|
+
* @param {String} opts.activeRoutingOrganizationId activeRoutingOrganizationId
|
|
89695
|
+
* @param {String} opts.ownerOrganizationId ownerOrganizationId
|
|
89696
|
+
* @param {Object} opts.status status
|
|
89697
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
89698
|
+
*/
|
|
89699
|
+
getTelephonyNumbersRouting(opts) {
|
|
89700
|
+
opts = opts || {};
|
|
89701
|
+
|
|
89702
|
+
|
|
89703
|
+
return this.apiClient.callApi(
|
|
89704
|
+
'/api/v2/telephony/numbers/routing',
|
|
89705
|
+
'GET',
|
|
89706
|
+
{ },
|
|
89707
|
+
{ 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'numberId': opts['numberId'],'activeRoutingOrganizationId': opts['activeRoutingOrganizationId'],'ownerOrganizationId': opts['ownerOrganizationId'],'status': opts['status'] },
|
|
89708
|
+
{ },
|
|
89709
|
+
{ },
|
|
89710
|
+
null,
|
|
89711
|
+
['PureCloud OAuth'],
|
|
89712
|
+
['application/json'],
|
|
89713
|
+
['application/json'],
|
|
89714
|
+
opts['customHeaders']
|
|
89715
|
+
);
|
|
89716
|
+
}
|
|
89717
|
+
|
|
89718
|
+
/**
|
|
89719
|
+
* Get organization links
|
|
89720
|
+
*
|
|
89721
|
+
* @param {Object} opts Optional parameters
|
|
89722
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
89723
|
+
*/
|
|
89724
|
+
getTelephonyOrganizationLink(opts) {
|
|
89725
|
+
opts = opts || {};
|
|
89726
|
+
|
|
89727
|
+
|
|
89728
|
+
return this.apiClient.callApi(
|
|
89729
|
+
'/api/v2/telephony/organization/link',
|
|
89730
|
+
'GET',
|
|
89731
|
+
{ },
|
|
89732
|
+
{ },
|
|
89733
|
+
{ },
|
|
89734
|
+
{ },
|
|
89735
|
+
null,
|
|
89736
|
+
['PureCloud OAuth'],
|
|
89737
|
+
['application/json'],
|
|
89738
|
+
['application/json'],
|
|
89739
|
+
opts['customHeaders']
|
|
89740
|
+
);
|
|
89741
|
+
}
|
|
89742
|
+
|
|
89743
|
+
/**
|
|
89744
|
+
* Get all the replica regions by primary region
|
|
89745
|
+
*
|
|
89746
|
+
* @param {Object} opts Optional parameters
|
|
89747
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
89748
|
+
*/
|
|
89749
|
+
getTelephonyOrganizationLinkRegions(opts) {
|
|
89750
|
+
opts = opts || {};
|
|
89751
|
+
|
|
89752
|
+
|
|
89753
|
+
return this.apiClient.callApi(
|
|
89754
|
+
'/api/v2/telephony/organization/link/regions',
|
|
89755
|
+
'GET',
|
|
89756
|
+
{ },
|
|
89757
|
+
{ },
|
|
89758
|
+
{ },
|
|
89759
|
+
{ },
|
|
89760
|
+
null,
|
|
89761
|
+
['PureCloud OAuth'],
|
|
89762
|
+
['application/json'],
|
|
89763
|
+
['application/json'],
|
|
89764
|
+
opts['customHeaders']
|
|
89765
|
+
);
|
|
89766
|
+
}
|
|
89767
|
+
|
|
88888
89768
|
/**
|
|
88889
89769
|
* Get the global telephony configuration.
|
|
88890
89770
|
*
|
|
@@ -89040,6 +89920,161 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89040
89920
|
);
|
|
89041
89921
|
}
|
|
89042
89922
|
|
|
89923
|
+
/**
|
|
89924
|
+
* Approving a requested link
|
|
89925
|
+
*
|
|
89926
|
+
* @param {String} requestingOrganizationId requestingOrganizationId
|
|
89927
|
+
* @param {Object} body Approval request body
|
|
89928
|
+
* @param {Object} opts Optional parameters
|
|
89929
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
89930
|
+
*/
|
|
89931
|
+
patchTelephonyOrganizationLinkApproveRequestingOrganizationId(requestingOrganizationId, body, opts) {
|
|
89932
|
+
opts = opts || {};
|
|
89933
|
+
|
|
89934
|
+
// verify the required parameter 'requestingOrganizationId' is set
|
|
89935
|
+
if (requestingOrganizationId === undefined || requestingOrganizationId === null || requestingOrganizationId === '') {
|
|
89936
|
+
throw 'Missing the required parameter "requestingOrganizationId" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';
|
|
89937
|
+
}
|
|
89938
|
+
// verify the required parameter 'body' is set
|
|
89939
|
+
if (body === undefined || body === null) {
|
|
89940
|
+
throw 'Missing the required parameter "body" when calling patchTelephonyOrganizationLinkApproveRequestingOrganizationId';
|
|
89941
|
+
}
|
|
89942
|
+
|
|
89943
|
+
return this.apiClient.callApi(
|
|
89944
|
+
'/api/v2/telephony/organization/link/approve/{requestingOrganizationId}',
|
|
89945
|
+
'PATCH',
|
|
89946
|
+
{ 'requestingOrganizationId': requestingOrganizationId },
|
|
89947
|
+
{ },
|
|
89948
|
+
{ },
|
|
89949
|
+
{ },
|
|
89950
|
+
body,
|
|
89951
|
+
['PureCloud OAuth'],
|
|
89952
|
+
['application/json'],
|
|
89953
|
+
['application/json'],
|
|
89954
|
+
opts['customHeaders']
|
|
89955
|
+
);
|
|
89956
|
+
}
|
|
89957
|
+
|
|
89958
|
+
/**
|
|
89959
|
+
* Update the routing of numbers for one or multiple organizations
|
|
89960
|
+
*
|
|
89961
|
+
* @param {Array.<Object>} body drRoutingList
|
|
89962
|
+
* @param {Object} opts Optional parameters
|
|
89963
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
89964
|
+
*/
|
|
89965
|
+
postTelephonyNumbersRouting(body, opts) {
|
|
89966
|
+
opts = opts || {};
|
|
89967
|
+
|
|
89968
|
+
// verify the required parameter 'body' is set
|
|
89969
|
+
if (body === undefined || body === null) {
|
|
89970
|
+
throw 'Missing the required parameter "body" when calling postTelephonyNumbersRouting';
|
|
89971
|
+
}
|
|
89972
|
+
|
|
89973
|
+
return this.apiClient.callApi(
|
|
89974
|
+
'/api/v2/telephony/numbers/routing',
|
|
89975
|
+
'POST',
|
|
89976
|
+
{ },
|
|
89977
|
+
{ },
|
|
89978
|
+
{ },
|
|
89979
|
+
{ },
|
|
89980
|
+
body,
|
|
89981
|
+
['PureCloud OAuth'],
|
|
89982
|
+
['application/json'],
|
|
89983
|
+
['application/json'],
|
|
89984
|
+
opts['customHeaders']
|
|
89985
|
+
);
|
|
89986
|
+
}
|
|
89987
|
+
|
|
89988
|
+
/**
|
|
89989
|
+
* Re-route all numbers on an organization
|
|
89990
|
+
*
|
|
89991
|
+
* @param {Object} body Value for all routing request body
|
|
89992
|
+
* @param {Object} opts Optional parameters
|
|
89993
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
89994
|
+
*/
|
|
89995
|
+
postTelephonyNumbersRoutingAll(body, opts) {
|
|
89996
|
+
opts = opts || {};
|
|
89997
|
+
|
|
89998
|
+
// verify the required parameter 'body' is set
|
|
89999
|
+
if (body === undefined || body === null) {
|
|
90000
|
+
throw 'Missing the required parameter "body" when calling postTelephonyNumbersRoutingAll';
|
|
90001
|
+
}
|
|
90002
|
+
|
|
90003
|
+
return this.apiClient.callApi(
|
|
90004
|
+
'/api/v2/telephony/numbers/routing/all',
|
|
90005
|
+
'POST',
|
|
90006
|
+
{ },
|
|
90007
|
+
{ },
|
|
90008
|
+
{ },
|
|
90009
|
+
{ },
|
|
90010
|
+
body,
|
|
90011
|
+
['PureCloud OAuth'],
|
|
90012
|
+
['application/json'],
|
|
90013
|
+
['application/json'],
|
|
90014
|
+
opts['customHeaders']
|
|
90015
|
+
);
|
|
90016
|
+
}
|
|
90017
|
+
|
|
90018
|
+
/**
|
|
90019
|
+
* Reset routing for organization
|
|
90020
|
+
*
|
|
90021
|
+
* @param {Object} body Value for bulk routing request body
|
|
90022
|
+
* @param {Object} opts Optional parameters
|
|
90023
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
90024
|
+
*/
|
|
90025
|
+
postTelephonyNumbersRoutingReset(body, opts) {
|
|
90026
|
+
opts = opts || {};
|
|
90027
|
+
|
|
90028
|
+
// verify the required parameter 'body' is set
|
|
90029
|
+
if (body === undefined || body === null) {
|
|
90030
|
+
throw 'Missing the required parameter "body" when calling postTelephonyNumbersRoutingReset';
|
|
90031
|
+
}
|
|
90032
|
+
|
|
90033
|
+
return this.apiClient.callApi(
|
|
90034
|
+
'/api/v2/telephony/numbers/routing/reset',
|
|
90035
|
+
'POST',
|
|
90036
|
+
{ },
|
|
90037
|
+
{ },
|
|
90038
|
+
{ },
|
|
90039
|
+
{ },
|
|
90040
|
+
body,
|
|
90041
|
+
['PureCloud OAuth'],
|
|
90042
|
+
['application/json'],
|
|
90043
|
+
['application/json'],
|
|
90044
|
+
opts['customHeaders']
|
|
90045
|
+
);
|
|
90046
|
+
}
|
|
90047
|
+
|
|
90048
|
+
/**
|
|
90049
|
+
* Create a link with an organization
|
|
90050
|
+
*
|
|
90051
|
+
* @param {Object} body CreateLinkOrg body
|
|
90052
|
+
* @param {Object} opts Optional parameters
|
|
90053
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
90054
|
+
*/
|
|
90055
|
+
postTelephonyOrganizationLink(body, opts) {
|
|
90056
|
+
opts = opts || {};
|
|
90057
|
+
|
|
90058
|
+
// verify the required parameter 'body' is set
|
|
90059
|
+
if (body === undefined || body === null) {
|
|
90060
|
+
throw 'Missing the required parameter "body" when calling postTelephonyOrganizationLink';
|
|
90061
|
+
}
|
|
90062
|
+
|
|
90063
|
+
return this.apiClient.callApi(
|
|
90064
|
+
'/api/v2/telephony/organization/link',
|
|
90065
|
+
'POST',
|
|
90066
|
+
{ },
|
|
90067
|
+
{ },
|
|
90068
|
+
{ },
|
|
90069
|
+
{ },
|
|
90070
|
+
body,
|
|
90071
|
+
['PureCloud OAuth'],
|
|
90072
|
+
['application/json'],
|
|
90073
|
+
['application/json'],
|
|
90074
|
+
opts['customHeaders']
|
|
90075
|
+
);
|
|
90076
|
+
}
|
|
90077
|
+
|
|
89043
90078
|
/**
|
|
89044
90079
|
* Request a download of a pcap file to S3
|
|
89045
90080
|
*
|
|
@@ -89171,7 +90206,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
89171
90206
|
/**
|
|
89172
90207
|
* TelephonyProvidersEdge service.
|
|
89173
90208
|
* @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
|
|
89174
|
-
* @version
|
|
90209
|
+
* @version 254.0.0
|
|
89175
90210
|
*/
|
|
89176
90211
|
|
|
89177
90212
|
/**
|
|
@@ -92363,52 +93398,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
92363
93398
|
);
|
|
92364
93399
|
}
|
|
92365
93400
|
|
|
92366
|
-
/**
|
|
92367
|
-
* Post media endpoint statistics event.
|
|
92368
|
-
*
|
|
92369
|
-
* @param {String} conversationId Identifier of the conversation
|
|
92370
|
-
* @param {String} communicationId Identifier of the media session
|
|
92371
|
-
* @param {String} mediaResourceId Identifier of the media resource of the endpoint
|
|
92372
|
-
* @param {Object} body MediaStatisticsPostRequest
|
|
92373
|
-
* @param {Object} opts Optional parameters
|
|
92374
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
92375
|
-
* postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
92376
|
-
*/
|
|
92377
|
-
postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource(conversationId, communicationId, mediaResourceId, body, opts) {
|
|
92378
|
-
opts = opts || {};
|
|
92379
|
-
|
|
92380
|
-
// verify the required parameter 'conversationId' is set
|
|
92381
|
-
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
92382
|
-
throw 'Missing the required parameter "conversationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92383
|
-
}
|
|
92384
|
-
// verify the required parameter 'communicationId' is set
|
|
92385
|
-
if (communicationId === undefined || communicationId === null || communicationId === '') {
|
|
92386
|
-
throw 'Missing the required parameter "communicationId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92387
|
-
}
|
|
92388
|
-
// verify the required parameter 'mediaResourceId' is set
|
|
92389
|
-
if (mediaResourceId === undefined || mediaResourceId === null || mediaResourceId === '') {
|
|
92390
|
-
throw 'Missing the required parameter "mediaResourceId" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92391
|
-
}
|
|
92392
|
-
// verify the required parameter 'body' is set
|
|
92393
|
-
if (body === undefined || body === null) {
|
|
92394
|
-
throw 'Missing the required parameter "body" when calling postTelephonyProvidersEdgesMediastatisticsConversationCommunicationMediaresource';
|
|
92395
|
-
}
|
|
92396
|
-
|
|
92397
|
-
return this.apiClient.callApi(
|
|
92398
|
-
'/api/v2/telephony/providers/edges/mediastatistics/conversations/{conversationId}/communications/{communicationId}/mediaresources/{mediaResourceId}',
|
|
92399
|
-
'POST',
|
|
92400
|
-
{ 'conversationId': conversationId,'communicationId': communicationId,'mediaResourceId': mediaResourceId },
|
|
92401
|
-
{ },
|
|
92402
|
-
{ },
|
|
92403
|
-
{ },
|
|
92404
|
-
body,
|
|
92405
|
-
['PureCloud OAuth'],
|
|
92406
|
-
['application/json'],
|
|
92407
|
-
['application/json'],
|
|
92408
|
-
opts['customHeaders']
|
|
92409
|
-
);
|
|
92410
|
-
}
|
|
92411
|
-
|
|
92412
93401
|
/**
|
|
92413
93402
|
* Reboot a Phone
|
|
92414
93403
|
*
|
|
@@ -93195,7 +94184,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93195
94184
|
/**
|
|
93196
94185
|
* Textbots service.
|
|
93197
94186
|
* @module purecloud-platform-client-v2/api/TextbotsApi
|
|
93198
|
-
* @version
|
|
94187
|
+
* @version 254.0.0
|
|
93199
94188
|
*/
|
|
93200
94189
|
|
|
93201
94190
|
/**
|
|
@@ -93341,7 +94330,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93341
94330
|
/**
|
|
93342
94331
|
* Tokens service.
|
|
93343
94332
|
* @module purecloud-platform-client-v2/api/TokensApi
|
|
93344
|
-
* @version
|
|
94333
|
+
* @version 254.0.0
|
|
93345
94334
|
*/
|
|
93346
94335
|
|
|
93347
94336
|
/**
|
|
@@ -93519,7 +94508,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93519
94508
|
/**
|
|
93520
94509
|
* Uploads service.
|
|
93521
94510
|
* @module purecloud-platform-client-v2/api/UploadsApi
|
|
93522
|
-
* @version
|
|
94511
|
+
* @version 254.0.0
|
|
93523
94512
|
*/
|
|
93524
94513
|
|
|
93525
94514
|
/**
|
|
@@ -93890,7 +94879,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
93890
94879
|
/**
|
|
93891
94880
|
* Usage service.
|
|
93892
94881
|
* @module purecloud-platform-client-v2/api/UsageApi
|
|
93893
|
-
* @version
|
|
94882
|
+
* @version 254.0.0
|
|
93894
94883
|
*/
|
|
93895
94884
|
|
|
93896
94885
|
/**
|
|
@@ -94268,7 +95257,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94268
95257
|
/**
|
|
94269
95258
|
* UserRecordings service.
|
|
94270
95259
|
* @module purecloud-platform-client-v2/api/UserRecordingsApi
|
|
94271
|
-
* @version
|
|
95260
|
+
* @version 254.0.0
|
|
94272
95261
|
*/
|
|
94273
95262
|
|
|
94274
95263
|
/**
|
|
@@ -94470,7 +95459,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94470
95459
|
/**
|
|
94471
95460
|
* Users service.
|
|
94472
95461
|
* @module purecloud-platform-client-v2/api/UsersApi
|
|
94473
|
-
* @version
|
|
95462
|
+
* @version 254.0.0
|
|
94474
95463
|
*/
|
|
94475
95464
|
|
|
94476
95465
|
/**
|
|
@@ -94491,7 +95480,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
94491
95480
|
* @param {String} jobId jobId
|
|
94492
95481
|
* @param {Object} opts Optional parameters
|
|
94493
95482
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
94494
|
-
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
94495
95483
|
*/
|
|
94496
95484
|
deleteAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
94497
95485
|
opts = opts || {};
|
|
@@ -95002,7 +95990,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95002
95990
|
* @param {String} jobId jobId
|
|
95003
95991
|
* @param {Object} opts Optional parameters
|
|
95004
95992
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95005
|
-
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95006
95993
|
*/
|
|
95007
95994
|
getAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
95008
95995
|
opts = opts || {};
|
|
@@ -95034,7 +96021,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
95034
96021
|
* @param {Object} opts Optional parameters
|
|
95035
96022
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
95036
96023
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
95037
|
-
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
95038
96024
|
*/
|
|
95039
96025
|
getAnalyticsUsersAggregatesJobResults(jobId, opts) {
|
|
95040
96026
|
opts = opts || {};
|
|
@@ -97182,7 +98168,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
97182
98168
|
* @param {Object} body query
|
|
97183
98169
|
* @param {Object} opts Optional parameters
|
|
97184
98170
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
97185
|
-
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
97186
98171
|
*/
|
|
97187
98172
|
postAnalyticsUsersAggregatesJobs(body, opts) {
|
|
97188
98173
|
opts = opts || {};
|
|
@@ -98489,7 +99474,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98489
99474
|
/**
|
|
98490
99475
|
* UsersRules service.
|
|
98491
99476
|
* @module purecloud-platform-client-v2/api/UsersRulesApi
|
|
98492
|
-
* @version
|
|
99477
|
+
* @version 254.0.0
|
|
98493
99478
|
*/
|
|
98494
99479
|
|
|
98495
99480
|
/**
|
|
@@ -98806,7 +99791,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98806
99791
|
/**
|
|
98807
99792
|
* Utilities service.
|
|
98808
99793
|
* @module purecloud-platform-client-v2/api/UtilitiesApi
|
|
98809
|
-
* @version
|
|
99794
|
+
* @version 254.0.0
|
|
98810
99795
|
*/
|
|
98811
99796
|
|
|
98812
99797
|
/**
|
|
@@ -98934,7 +99919,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
98934
99919
|
/**
|
|
98935
99920
|
* Voicemail service.
|
|
98936
99921
|
* @module purecloud-platform-client-v2/api/VoicemailApi
|
|
98937
|
-
* @version
|
|
99922
|
+
* @version 254.0.0
|
|
98938
99923
|
*/
|
|
98939
99924
|
|
|
98940
99925
|
/**
|
|
@@ -99764,7 +100749,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
99764
100749
|
/**
|
|
99765
100750
|
* WebChat service.
|
|
99766
100751
|
* @module purecloud-platform-client-v2/api/WebChatApi
|
|
99767
|
-
* @version
|
|
100752
|
+
* @version 254.0.0
|
|
99768
100753
|
*/
|
|
99769
100754
|
|
|
99770
100755
|
/**
|
|
@@ -100416,7 +101401,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
100416
101401
|
/**
|
|
100417
101402
|
* WebDeployments service.
|
|
100418
101403
|
* @module purecloud-platform-client-v2/api/WebDeploymentsApi
|
|
100419
|
-
* @version
|
|
101404
|
+
* @version 254.0.0
|
|
100420
101405
|
*/
|
|
100421
101406
|
|
|
100422
101407
|
/**
|
|
@@ -101094,7 +102079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101094
102079
|
/**
|
|
101095
102080
|
* WebMessaging service.
|
|
101096
102081
|
* @module purecloud-platform-client-v2/api/WebMessagingApi
|
|
101097
|
-
* @version
|
|
102082
|
+
* @version 254.0.0
|
|
101098
102083
|
*/
|
|
101099
102084
|
|
|
101100
102085
|
/**
|
|
@@ -101257,7 +102242,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101257
102242
|
/**
|
|
101258
102243
|
* Widgets service.
|
|
101259
102244
|
* @module purecloud-platform-client-v2/api/WidgetsApi
|
|
101260
|
-
* @version
|
|
102245
|
+
* @version 254.0.0
|
|
101261
102246
|
*/
|
|
101262
102247
|
|
|
101263
102248
|
/**
|
|
@@ -101433,7 +102418,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
101433
102418
|
/**
|
|
101434
102419
|
* WorkforceManagement service.
|
|
101435
102420
|
* @module purecloud-platform-client-v2/api/WorkforceManagementApi
|
|
101436
|
-
* @version
|
|
102421
|
+
* @version 254.0.0
|
|
101437
102422
|
*/
|
|
101438
102423
|
|
|
101439
102424
|
/**
|
|
@@ -103296,6 +104281,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
103296
104281
|
);
|
|
103297
104282
|
}
|
|
103298
104283
|
|
|
104284
|
+
/**
|
|
104285
|
+
* Get opportunity details
|
|
104286
|
+
*
|
|
104287
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
104288
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
104289
|
+
* @param {Object} opts Optional parameters
|
|
104290
|
+
* @param {Object} opts.expand List of resources to expand
|
|
104291
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
104292
|
+
*/
|
|
104293
|
+
getWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, opts) {
|
|
104294
|
+
opts = opts || {};
|
|
104295
|
+
|
|
104296
|
+
// verify the required parameter 'businessUnitId' is set
|
|
104297
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
104298
|
+
throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitOpportunity';
|
|
104299
|
+
}
|
|
104300
|
+
// verify the required parameter 'opportunityId' is set
|
|
104301
|
+
if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
|
|
104302
|
+
throw 'Missing the required parameter "opportunityId" when calling getWorkforcemanagementBusinessunitOpportunity';
|
|
104303
|
+
}
|
|
104304
|
+
|
|
104305
|
+
return this.apiClient.callApi(
|
|
104306
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
|
|
104307
|
+
'GET',
|
|
104308
|
+
{ 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
|
|
104309
|
+
{ 'expand': opts['expand'] },
|
|
104310
|
+
{ },
|
|
104311
|
+
{ },
|
|
104312
|
+
null,
|
|
104313
|
+
['PureCloud OAuth'],
|
|
104314
|
+
['application/json'],
|
|
104315
|
+
['application/json'],
|
|
104316
|
+
opts['customHeaders']
|
|
104317
|
+
);
|
|
104318
|
+
}
|
|
104319
|
+
|
|
103299
104320
|
/**
|
|
103300
104321
|
* Get a planning group
|
|
103301
104322
|
*
|
|
@@ -103918,6 +104939,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
103918
104939
|
* @param {Object} opts Optional parameters
|
|
103919
104940
|
* @param {String} opts.managementUnitId The ID of the management unit to get management unit specific staffing groups
|
|
103920
104941
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
104942
|
+
* @param {Array.<String>} opts.expand Include to access additional data for the time-off plans
|
|
103921
104943
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
103922
104944
|
*/
|
|
103923
104945
|
getWorkforcemanagementBusinessunitTimeoffplans(businessUnitId, opts) {
|
|
@@ -103932,7 +104954,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
103932
104954
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/timeoffplans',
|
|
103933
104955
|
'GET',
|
|
103934
104956
|
{ 'businessUnitId': businessUnitId },
|
|
103935
|
-
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'] },
|
|
104957
|
+
{ 'managementUnitId': opts['managementUnitId'],'forceDownloadService': opts['forceDownloadService'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
|
|
103936
104958
|
{ },
|
|
103937
104959
|
{ },
|
|
103938
104960
|
null,
|
|
@@ -104232,6 +105254,8 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
104232
105254
|
* @param {String} businessUnitId The ID of the business unit
|
|
104233
105255
|
* @param {String} weekId First day of schedule week in yyyy-MM-dd format, or 'recent' (without quotes) to get recent schedules
|
|
104234
105256
|
* @param {Object} opts Optional parameters
|
|
105257
|
+
* @param {String} opts.earliestWeekDate If weekId == 'recent', specify the earliest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
105258
|
+
* @param {String} opts.latestWeekDate If weekId == 'recent', specify the latest schedule start week date (inclusive) to include in the 'recent' range, in yyyy-MM-dd format. Ignored if weekId != 'recent'. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
104235
105259
|
* @param {Boolean} opts.includeOnlyPublished includeOnlyPublished
|
|
104236
105260
|
* @param {Object} opts.expand expand
|
|
104237
105261
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
@@ -104252,7 +105276,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
104252
105276
|
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/weeks/{weekId}/schedules',
|
|
104253
105277
|
'GET',
|
|
104254
105278
|
{ 'businessUnitId': businessUnitId,'weekId': weekId },
|
|
104255
|
-
{ 'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
|
|
105279
|
+
{ 'earliestWeekDate': opts['earliestWeekDate'],'latestWeekDate': opts['latestWeekDate'],'includeOnlyPublished': opts['includeOnlyPublished'],'expand': opts['expand'] },
|
|
104256
105280
|
{ },
|
|
104257
105281
|
{ },
|
|
104258
105282
|
null,
|
|
@@ -105129,11 +106153,12 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105129
106153
|
|
|
105130
106154
|
/**
|
|
105131
106155
|
* Gets all the shift trades for a given agent
|
|
105132
|
-
*
|
|
106156
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/query/jobs)
|
|
105133
106157
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105134
106158
|
* @param {String} agentId The agent id
|
|
105135
106159
|
* @param {Object} opts Optional parameters
|
|
105136
106160
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106161
|
+
* @deprecated
|
|
105137
106162
|
*/
|
|
105138
106163
|
getWorkforcemanagementManagementunitAgentShifttrades(managementUnitId, agentId, opts) {
|
|
105139
106164
|
opts = opts || {};
|
|
@@ -105164,10 +106189,11 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105164
106189
|
|
|
105165
106190
|
/**
|
|
105166
106191
|
* Gets a summary of all shift trades in the matched state
|
|
105167
|
-
*
|
|
106192
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/weeks/summary/jobs)
|
|
105168
106193
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105169
106194
|
* @param {Object} opts Optional parameters
|
|
105170
106195
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106196
|
+
* @deprecated
|
|
105171
106197
|
*/
|
|
105172
106198
|
getWorkforcemanagementManagementunitShifttradesMatched(managementUnitId, opts) {
|
|
105173
106199
|
opts = opts || {};
|
|
@@ -105581,7 +106607,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105581
106607
|
|
|
105582
106608
|
/**
|
|
105583
106609
|
* Gets all the shift trades for a given week
|
|
105584
|
-
*
|
|
106610
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/trades/evaluate/jobs)
|
|
105585
106611
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
105586
106612
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
105587
106613
|
* @param {Object} opts Optional parameters
|
|
@@ -105589,6 +106615,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105589
106615
|
* @param {Boolean} opts.includeCrossWeekShifts Whether to include all shift trades with either the initiating shift or the receiving shift in the week (default to false)
|
|
105590
106616
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
105591
106617
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106618
|
+
* @deprecated
|
|
105592
106619
|
*/
|
|
105593
106620
|
getWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, opts) {
|
|
105594
106621
|
opts = opts || {};
|
|
@@ -105864,9 +106891,10 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
105864
106891
|
|
|
105865
106892
|
/**
|
|
105866
106893
|
* Gets all of my shift trades
|
|
105867
|
-
*
|
|
106894
|
+
* Deprecated. Use new route instead (/shifttrading/trades/mine/query/jobs)
|
|
105868
106895
|
* @param {Object} opts Optional parameters
|
|
105869
106896
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
106897
|
+
* @deprecated
|
|
105870
106898
|
*/
|
|
105871
106899
|
getWorkforcemanagementShifttrades(opts) {
|
|
105872
106900
|
opts = opts || {};
|
|
@@ -106728,9 +107756,49 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
106728
107756
|
);
|
|
106729
107757
|
}
|
|
106730
107758
|
|
|
107759
|
+
/**
|
|
107760
|
+
* Update the opportunity
|
|
107761
|
+
* Only opportunities with Draft status can be updated.
|
|
107762
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
107763
|
+
* @param {String} opportunityId The ID of the opportunity
|
|
107764
|
+
* @param {Object} body body
|
|
107765
|
+
* @param {Object} opts Optional parameters
|
|
107766
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107767
|
+
*/
|
|
107768
|
+
patchWorkforcemanagementBusinessunitOpportunity(businessUnitId, opportunityId, body, opts) {
|
|
107769
|
+
opts = opts || {};
|
|
107770
|
+
|
|
107771
|
+
// verify the required parameter 'businessUnitId' is set
|
|
107772
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
107773
|
+
throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
107774
|
+
}
|
|
107775
|
+
// verify the required parameter 'opportunityId' is set
|
|
107776
|
+
if (opportunityId === undefined || opportunityId === null || opportunityId === '') {
|
|
107777
|
+
throw 'Missing the required parameter "opportunityId" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
107778
|
+
}
|
|
107779
|
+
// verify the required parameter 'body' is set
|
|
107780
|
+
if (body === undefined || body === null) {
|
|
107781
|
+
throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitOpportunity';
|
|
107782
|
+
}
|
|
107783
|
+
|
|
107784
|
+
return this.apiClient.callApi(
|
|
107785
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/{opportunityId}',
|
|
107786
|
+
'PATCH',
|
|
107787
|
+
{ 'businessUnitId': businessUnitId,'opportunityId': opportunityId },
|
|
107788
|
+
{ },
|
|
107789
|
+
{ },
|
|
107790
|
+
{ },
|
|
107791
|
+
body,
|
|
107792
|
+
['PureCloud OAuth'],
|
|
107793
|
+
['application/json'],
|
|
107794
|
+
['application/json'],
|
|
107795
|
+
opts['customHeaders']
|
|
107796
|
+
);
|
|
107797
|
+
}
|
|
107798
|
+
|
|
106731
107799
|
/**
|
|
106732
107800
|
* Updates the planning group
|
|
106733
|
-
*
|
|
107801
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
106734
107802
|
* @param {String} businessUnitId The ID of the business unit.
|
|
106735
107803
|
* @param {String} planningGroupId The ID of a planning group to update
|
|
106736
107804
|
* @param {Object} body body
|
|
@@ -107405,13 +108473,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
107405
108473
|
|
|
107406
108474
|
/**
|
|
107407
108475
|
* Updates a shift trade. This route can only be called by the initiating agent
|
|
107408
|
-
*
|
|
108476
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/jobs)
|
|
107409
108477
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
107410
108478
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
107411
108479
|
* @param {String} tradeId The ID of the shift trade to update
|
|
107412
108480
|
* @param {Object} body body
|
|
107413
108481
|
* @param {Object} opts Optional parameters
|
|
107414
108482
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
108483
|
+
* @deprecated
|
|
107415
108484
|
*/
|
|
107416
108485
|
patchWorkforcemanagementManagementunitWeekShifttrade(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
107417
108486
|
opts = opts || {};
|
|
@@ -107756,33 +108825,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
107756
108825
|
);
|
|
107757
108826
|
}
|
|
107758
108827
|
|
|
107759
|
-
/**
|
|
107760
|
-
* Deprecated. Use bulk routes instead (/adherence/historical/bulk)
|
|
107761
|
-
*
|
|
107762
|
-
* @param {Object} opts Optional parameters
|
|
107763
|
-
* @param {Object} opts.body body
|
|
107764
|
-
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
107765
|
-
* @deprecated
|
|
107766
|
-
*/
|
|
107767
|
-
postWorkforcemanagementAdherenceHistorical(opts) {
|
|
107768
|
-
opts = opts || {};
|
|
107769
|
-
|
|
107770
|
-
|
|
107771
|
-
return this.apiClient.callApi(
|
|
107772
|
-
'/api/v2/workforcemanagement/adherence/historical',
|
|
107773
|
-
'POST',
|
|
107774
|
-
{ },
|
|
107775
|
-
{ },
|
|
107776
|
-
{ },
|
|
107777
|
-
{ },
|
|
107778
|
-
opts['body'],
|
|
107779
|
-
['PureCloud OAuth'],
|
|
107780
|
-
['application/json'],
|
|
107781
|
-
['application/json'],
|
|
107782
|
-
opts['customHeaders']
|
|
107783
|
-
);
|
|
107784
|
-
}
|
|
107785
|
-
|
|
107786
108828
|
/**
|
|
107787
108829
|
* Request a historical adherence report in bulk
|
|
107788
108830
|
*
|
|
@@ -108037,6 +109079,98 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
108037
109079
|
);
|
|
108038
109080
|
}
|
|
108039
109081
|
|
|
109082
|
+
/**
|
|
109083
|
+
* Bulk add enrollments to opportunities for the authenticated agent
|
|
109084
|
+
* Allows an agent to enroll in opportunities. This endpoint can return partial success.
|
|
109085
|
+
* @param {Object} body body
|
|
109086
|
+
* @param {Object} opts Optional parameters
|
|
109087
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109088
|
+
*/
|
|
109089
|
+
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd(body, opts) {
|
|
109090
|
+
opts = opts || {};
|
|
109091
|
+
|
|
109092
|
+
// verify the required parameter 'body' is set
|
|
109093
|
+
if (body === undefined || body === null) {
|
|
109094
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkAdd';
|
|
109095
|
+
}
|
|
109096
|
+
|
|
109097
|
+
return this.apiClient.callApi(
|
|
109098
|
+
'/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/add',
|
|
109099
|
+
'POST',
|
|
109100
|
+
{ },
|
|
109101
|
+
{ },
|
|
109102
|
+
{ },
|
|
109103
|
+
{ },
|
|
109104
|
+
body,
|
|
109105
|
+
['PureCloud OAuth'],
|
|
109106
|
+
['application/json'],
|
|
109107
|
+
['application/json'],
|
|
109108
|
+
opts['customHeaders']
|
|
109109
|
+
);
|
|
109110
|
+
}
|
|
109111
|
+
|
|
109112
|
+
/**
|
|
109113
|
+
* Bulk update enrollment status for the authenticated agent
|
|
109114
|
+
* Allows an agent to update the status of their enrollments (e.g. withdraw). Returns partial success if some enrollments cannot be updated.
|
|
109115
|
+
* @param {Object} body body
|
|
109116
|
+
* @param {Object} opts Optional parameters
|
|
109117
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109118
|
+
*/
|
|
109119
|
+
postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate(body, opts) {
|
|
109120
|
+
opts = opts || {};
|
|
109121
|
+
|
|
109122
|
+
// verify the required parameter 'body' is set
|
|
109123
|
+
if (body === undefined || body === null) {
|
|
109124
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
109125
|
+
}
|
|
109126
|
+
|
|
109127
|
+
return this.apiClient.callApi(
|
|
109128
|
+
'/api/v2/workforcemanagement/agents/opportunities/enrollments/bulk/statuses/update',
|
|
109129
|
+
'POST',
|
|
109130
|
+
{ },
|
|
109131
|
+
{ },
|
|
109132
|
+
{ },
|
|
109133
|
+
{ },
|
|
109134
|
+
body,
|
|
109135
|
+
['PureCloud OAuth'],
|
|
109136
|
+
['application/json'],
|
|
109137
|
+
['application/json'],
|
|
109138
|
+
opts['customHeaders']
|
|
109139
|
+
);
|
|
109140
|
+
}
|
|
109141
|
+
|
|
109142
|
+
/**
|
|
109143
|
+
* Query opportunities for the authenticated agent
|
|
109144
|
+
* Queries within the specified date range. Each opportunity includes the agents enrollment details if they have enrolled.
|
|
109145
|
+
* @param {Object} body body
|
|
109146
|
+
* @param {Object} opts Optional parameters
|
|
109147
|
+
* @param {Object} opts.expand List of resources to expand
|
|
109148
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
109149
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109150
|
+
*/
|
|
109151
|
+
postWorkforcemanagementAgentsOpportunitiesQuery(body, opts) {
|
|
109152
|
+
opts = opts || {};
|
|
109153
|
+
|
|
109154
|
+
// verify the required parameter 'body' is set
|
|
109155
|
+
if (body === undefined || body === null) {
|
|
109156
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementAgentsOpportunitiesQuery';
|
|
109157
|
+
}
|
|
109158
|
+
|
|
109159
|
+
return this.apiClient.callApi(
|
|
109160
|
+
'/api/v2/workforcemanagement/agents/opportunities/query',
|
|
109161
|
+
'POST',
|
|
109162
|
+
{ },
|
|
109163
|
+
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
109164
|
+
{ },
|
|
109165
|
+
{ },
|
|
109166
|
+
body,
|
|
109167
|
+
['PureCloud OAuth'],
|
|
109168
|
+
['application/json'],
|
|
109169
|
+
['application/json'],
|
|
109170
|
+
opts['customHeaders']
|
|
109171
|
+
);
|
|
109172
|
+
}
|
|
109173
|
+
|
|
108040
109174
|
/**
|
|
108041
109175
|
* Fetch agent schedules for the logged in user's management unit
|
|
108042
109176
|
*
|
|
@@ -108706,8 +109840,291 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
108706
109840
|
}
|
|
108707
109841
|
|
|
108708
109842
|
/**
|
|
108709
|
-
*
|
|
109843
|
+
* Bulk add opportunities
|
|
108710
109844
|
*
|
|
109845
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109846
|
+
* @param {Object} body body
|
|
109847
|
+
* @param {Object} opts Optional parameters
|
|
109848
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109849
|
+
*/
|
|
109850
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkAdd(businessUnitId, body, opts) {
|
|
109851
|
+
opts = opts || {};
|
|
109852
|
+
|
|
109853
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109854
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109855
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
|
|
109856
|
+
}
|
|
109857
|
+
// verify the required parameter 'body' is set
|
|
109858
|
+
if (body === undefined || body === null) {
|
|
109859
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkAdd';
|
|
109860
|
+
}
|
|
109861
|
+
|
|
109862
|
+
return this.apiClient.callApi(
|
|
109863
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/add',
|
|
109864
|
+
'POST',
|
|
109865
|
+
{ 'businessUnitId': businessUnitId },
|
|
109866
|
+
{ },
|
|
109867
|
+
{ },
|
|
109868
|
+
{ },
|
|
109869
|
+
body,
|
|
109870
|
+
['PureCloud OAuth'],
|
|
109871
|
+
['application/json'],
|
|
109872
|
+
['application/json'],
|
|
109873
|
+
opts['customHeaders']
|
|
109874
|
+
);
|
|
109875
|
+
}
|
|
109876
|
+
|
|
109877
|
+
/**
|
|
109878
|
+
* Bulk publish opportunities
|
|
109879
|
+
* Published opportunities become available for agent enrollment when they open. Returns partial success if some opportunities cannot be published.
|
|
109880
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109881
|
+
* @param {Object} body body
|
|
109882
|
+
* @param {Object} opts Optional parameters
|
|
109883
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109884
|
+
*/
|
|
109885
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkPublish(businessUnitId, body, opts) {
|
|
109886
|
+
opts = opts || {};
|
|
109887
|
+
|
|
109888
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109889
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109890
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
|
|
109891
|
+
}
|
|
109892
|
+
// verify the required parameter 'body' is set
|
|
109893
|
+
if (body === undefined || body === null) {
|
|
109894
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkPublish';
|
|
109895
|
+
}
|
|
109896
|
+
|
|
109897
|
+
return this.apiClient.callApi(
|
|
109898
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/publish',
|
|
109899
|
+
'POST',
|
|
109900
|
+
{ 'businessUnitId': businessUnitId },
|
|
109901
|
+
{ },
|
|
109902
|
+
{ },
|
|
109903
|
+
{ },
|
|
109904
|
+
body,
|
|
109905
|
+
['PureCloud OAuth'],
|
|
109906
|
+
['application/json'],
|
|
109907
|
+
['application/json'],
|
|
109908
|
+
opts['customHeaders']
|
|
109909
|
+
);
|
|
109910
|
+
}
|
|
109911
|
+
|
|
109912
|
+
/**
|
|
109913
|
+
* Bulk remove opportunities
|
|
109914
|
+
* This operation is permanent and cannot be undone. Returns partial success if some opportunities cannot be removed.
|
|
109915
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109916
|
+
* @param {Object} body body
|
|
109917
|
+
* @param {Object} opts Optional parameters
|
|
109918
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109919
|
+
*/
|
|
109920
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkRemove(businessUnitId, body, opts) {
|
|
109921
|
+
opts = opts || {};
|
|
109922
|
+
|
|
109923
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109924
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109925
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
|
|
109926
|
+
}
|
|
109927
|
+
// verify the required parameter 'body' is set
|
|
109928
|
+
if (body === undefined || body === null) {
|
|
109929
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkRemove';
|
|
109930
|
+
}
|
|
109931
|
+
|
|
109932
|
+
return this.apiClient.callApi(
|
|
109933
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/remove',
|
|
109934
|
+
'POST',
|
|
109935
|
+
{ 'businessUnitId': businessUnitId },
|
|
109936
|
+
{ },
|
|
109937
|
+
{ },
|
|
109938
|
+
{ },
|
|
109939
|
+
body,
|
|
109940
|
+
['PureCloud OAuth'],
|
|
109941
|
+
['application/json'],
|
|
109942
|
+
['application/json'],
|
|
109943
|
+
opts['customHeaders']
|
|
109944
|
+
);
|
|
109945
|
+
}
|
|
109946
|
+
|
|
109947
|
+
/**
|
|
109948
|
+
* Bulk update opportunities status
|
|
109949
|
+
* If status is Closed, pending enrollments are automatically denied; approved enrollments remain in schedules. Returns partial success if some opportunities cannot be updated.
|
|
109950
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109951
|
+
* @param {Object} body body
|
|
109952
|
+
* @param {Object} opts Optional parameters
|
|
109953
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109954
|
+
*/
|
|
109955
|
+
postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate(businessUnitId, body, opts) {
|
|
109956
|
+
opts = opts || {};
|
|
109957
|
+
|
|
109958
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109959
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109960
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
|
|
109961
|
+
}
|
|
109962
|
+
// verify the required parameter 'body' is set
|
|
109963
|
+
if (body === undefined || body === null) {
|
|
109964
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesBulkStatusesUpdate';
|
|
109965
|
+
}
|
|
109966
|
+
|
|
109967
|
+
return this.apiClient.callApi(
|
|
109968
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/bulk/statuses/update',
|
|
109969
|
+
'POST',
|
|
109970
|
+
{ 'businessUnitId': businessUnitId },
|
|
109971
|
+
{ },
|
|
109972
|
+
{ },
|
|
109973
|
+
{ },
|
|
109974
|
+
body,
|
|
109975
|
+
['PureCloud OAuth'],
|
|
109976
|
+
['application/json'],
|
|
109977
|
+
['application/json'],
|
|
109978
|
+
opts['customHeaders']
|
|
109979
|
+
);
|
|
109980
|
+
}
|
|
109981
|
+
|
|
109982
|
+
/**
|
|
109983
|
+
* Bulk update enrollment status
|
|
109984
|
+
* Updates the status of enrollments (approve/deny). Returns partial success if some enrollments cannot be updated.
|
|
109985
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
109986
|
+
* @param {Object} body body
|
|
109987
|
+
* @param {Object} opts Optional parameters
|
|
109988
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
109989
|
+
*/
|
|
109990
|
+
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate(businessUnitId, body, opts) {
|
|
109991
|
+
opts = opts || {};
|
|
109992
|
+
|
|
109993
|
+
// verify the required parameter 'businessUnitId' is set
|
|
109994
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
109995
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
109996
|
+
}
|
|
109997
|
+
// verify the required parameter 'body' is set
|
|
109998
|
+
if (body === undefined || body === null) {
|
|
109999
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsBulkStatusesUpdate';
|
|
110000
|
+
}
|
|
110001
|
+
|
|
110002
|
+
return this.apiClient.callApi(
|
|
110003
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/bulk/statuses/update',
|
|
110004
|
+
'POST',
|
|
110005
|
+
{ 'businessUnitId': businessUnitId },
|
|
110006
|
+
{ },
|
|
110007
|
+
{ },
|
|
110008
|
+
{ },
|
|
110009
|
+
body,
|
|
110010
|
+
['PureCloud OAuth'],
|
|
110011
|
+
['application/json'],
|
|
110012
|
+
['application/json'],
|
|
110013
|
+
opts['customHeaders']
|
|
110014
|
+
);
|
|
110015
|
+
}
|
|
110016
|
+
|
|
110017
|
+
/**
|
|
110018
|
+
* Query enrollments
|
|
110019
|
+
* For more information about opportunities, use the expand parameter.
|
|
110020
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
110021
|
+
* @param {Object} body body
|
|
110022
|
+
* @param {Object} opts Optional parameters
|
|
110023
|
+
* @param {Object} opts.expand List of resources to expand
|
|
110024
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110025
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110026
|
+
*/
|
|
110027
|
+
postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery(businessUnitId, body, opts) {
|
|
110028
|
+
opts = opts || {};
|
|
110029
|
+
|
|
110030
|
+
// verify the required parameter 'businessUnitId' is set
|
|
110031
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
110032
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
|
|
110033
|
+
}
|
|
110034
|
+
// verify the required parameter 'body' is set
|
|
110035
|
+
if (body === undefined || body === null) {
|
|
110036
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesEnrollmentsQuery';
|
|
110037
|
+
}
|
|
110038
|
+
|
|
110039
|
+
return this.apiClient.callApi(
|
|
110040
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/enrollments/query',
|
|
110041
|
+
'POST',
|
|
110042
|
+
{ 'businessUnitId': businessUnitId },
|
|
110043
|
+
{ 'expand': opts['expand'],'forceDownloadService': opts['forceDownloadService'] },
|
|
110044
|
+
{ },
|
|
110045
|
+
{ },
|
|
110046
|
+
body,
|
|
110047
|
+
['PureCloud OAuth'],
|
|
110048
|
+
['application/json'],
|
|
110049
|
+
['application/json'],
|
|
110050
|
+
opts['customHeaders']
|
|
110051
|
+
);
|
|
110052
|
+
}
|
|
110053
|
+
|
|
110054
|
+
/**
|
|
110055
|
+
* Query opportunities by external activity IDs
|
|
110056
|
+
*
|
|
110057
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
110058
|
+
* @param {Object} body body
|
|
110059
|
+
* @param {Object} opts Optional parameters
|
|
110060
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110061
|
+
*/
|
|
110062
|
+
postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery(businessUnitId, body, opts) {
|
|
110063
|
+
opts = opts || {};
|
|
110064
|
+
|
|
110065
|
+
// verify the required parameter 'businessUnitId' is set
|
|
110066
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
110067
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
|
|
110068
|
+
}
|
|
110069
|
+
// verify the required parameter 'body' is set
|
|
110070
|
+
if (body === undefined || body === null) {
|
|
110071
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesExternalactivitiesQuery';
|
|
110072
|
+
}
|
|
110073
|
+
|
|
110074
|
+
return this.apiClient.callApi(
|
|
110075
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/externalactivities/query',
|
|
110076
|
+
'POST',
|
|
110077
|
+
{ 'businessUnitId': businessUnitId },
|
|
110078
|
+
{ },
|
|
110079
|
+
{ },
|
|
110080
|
+
{ },
|
|
110081
|
+
body,
|
|
110082
|
+
['PureCloud OAuth'],
|
|
110083
|
+
['application/json'],
|
|
110084
|
+
['application/json'],
|
|
110085
|
+
opts['customHeaders']
|
|
110086
|
+
);
|
|
110087
|
+
}
|
|
110088
|
+
|
|
110089
|
+
/**
|
|
110090
|
+
* Query opportunities within the specified date range
|
|
110091
|
+
*
|
|
110092
|
+
* @param {String} businessUnitId The ID of the business unit
|
|
110093
|
+
* @param {Object} body body
|
|
110094
|
+
* @param {Object} opts Optional parameters
|
|
110095
|
+
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110096
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110097
|
+
*/
|
|
110098
|
+
postWorkforcemanagementBusinessunitOpportunitiesQuery(businessUnitId, body, opts) {
|
|
110099
|
+
opts = opts || {};
|
|
110100
|
+
|
|
110101
|
+
// verify the required parameter 'businessUnitId' is set
|
|
110102
|
+
if (businessUnitId === undefined || businessUnitId === null || businessUnitId === '') {
|
|
110103
|
+
throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
|
|
110104
|
+
}
|
|
110105
|
+
// verify the required parameter 'body' is set
|
|
110106
|
+
if (body === undefined || body === null) {
|
|
110107
|
+
throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitOpportunitiesQuery';
|
|
110108
|
+
}
|
|
110109
|
+
|
|
110110
|
+
return this.apiClient.callApi(
|
|
110111
|
+
'/api/v2/workforcemanagement/businessunits/{businessUnitId}/opportunities/query',
|
|
110112
|
+
'POST',
|
|
110113
|
+
{ 'businessUnitId': businessUnitId },
|
|
110114
|
+
{ 'forceDownloadService': opts['forceDownloadService'] },
|
|
110115
|
+
{ },
|
|
110116
|
+
{ },
|
|
110117
|
+
body,
|
|
110118
|
+
['PureCloud OAuth'],
|
|
110119
|
+
['application/json'],
|
|
110120
|
+
['application/json'],
|
|
110121
|
+
opts['customHeaders']
|
|
110122
|
+
);
|
|
110123
|
+
}
|
|
110124
|
+
|
|
110125
|
+
/**
|
|
110126
|
+
* Adds a new planning group
|
|
110127
|
+
* If the request body contains queue references in route paths, routing:queue:view is required in each referenced queues division.
|
|
108711
110128
|
* @param {String} businessUnitId The ID of the business unit.
|
|
108712
110129
|
* @param {Object} body body
|
|
108713
110130
|
* @param {Object} opts Optional parameters
|
|
@@ -110693,6 +112110,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110693
112110
|
* @param {String} userId The id of the user for whom the time off request estimate is requested
|
|
110694
112111
|
* @param {Object} body body
|
|
110695
112112
|
* @param {Object} opts Optional parameters
|
|
112113
|
+
* @param {Object} opts.includeOnly Limit response to the specified field
|
|
110696
112114
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
110697
112115
|
*/
|
|
110698
112116
|
postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, body, opts) {
|
|
@@ -110715,7 +112133,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110715
112133
|
'/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
|
|
110716
112134
|
'POST',
|
|
110717
112135
|
{ 'managementUnitId': managementUnitId,'userId': userId },
|
|
110718
|
-
{
|
|
112136
|
+
{ 'includeOnly': opts['includeOnly'] },
|
|
110719
112137
|
{ },
|
|
110720
112138
|
{ },
|
|
110721
112139
|
body,
|
|
@@ -110728,13 +112146,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110728
112146
|
|
|
110729
112147
|
/**
|
|
110730
112148
|
* Matches a shift trade. This route can only be called by the receiving agent
|
|
110731
|
-
*
|
|
112149
|
+
* Deprecated. Use new route instead (/shifttrading/trades/{tradeId}/match/jobs)
|
|
110732
112150
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110733
112151
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110734
112152
|
* @param {String} tradeId The ID of the shift trade to update
|
|
110735
112153
|
* @param {Object} body body
|
|
110736
112154
|
* @param {Object} opts Optional parameters
|
|
110737
112155
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
112156
|
+
* @deprecated
|
|
110738
112157
|
*/
|
|
110739
112158
|
postWorkforcemanagementManagementunitWeekShifttradeMatch(managementUnitId, weekDateId, tradeId, body, opts) {
|
|
110740
112159
|
opts = opts || {};
|
|
@@ -110773,12 +112192,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110773
112192
|
|
|
110774
112193
|
/**
|
|
110775
112194
|
* Adds a shift trade
|
|
110776
|
-
*
|
|
112195
|
+
* Deprecated. Use new route instead (/shifttrading/trades/jobs)
|
|
110777
112196
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110778
112197
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110779
112198
|
* @param {Object} body body
|
|
110780
112199
|
* @param {Object} opts Optional parameters
|
|
110781
112200
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
112201
|
+
* @deprecated
|
|
110782
112202
|
*/
|
|
110783
112203
|
postWorkforcemanagementManagementunitWeekShifttrades(managementUnitId, weekDateId, body, opts) {
|
|
110784
112204
|
opts = opts || {};
|
|
@@ -110813,13 +112233,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110813
112233
|
|
|
110814
112234
|
/**
|
|
110815
112235
|
* Searches for potential shift trade matches for the current agent
|
|
110816
|
-
*
|
|
112236
|
+
* Deprecated. Use new route instead (/businessunits/{businessUnitId}/shifttrading/unmatched/search/jobs)
|
|
110817
112237
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110818
112238
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110819
112239
|
* @param {Object} body body
|
|
110820
112240
|
* @param {Object} opts Optional parameters
|
|
110821
112241
|
* @param {Boolean} opts.forceDownloadService Force the result of this operation to be sent via download service. For testing/app development purposes
|
|
110822
112242
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
112243
|
+
* @deprecated
|
|
110823
112244
|
*/
|
|
110824
112245
|
postWorkforcemanagementManagementunitWeekShifttradesSearch(managementUnitId, weekDateId, body, opts) {
|
|
110825
112246
|
opts = opts || {};
|
|
@@ -110854,13 +112275,14 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
110854
112275
|
|
|
110855
112276
|
/**
|
|
110856
112277
|
* Updates the state of a batch of shift trades
|
|
110857
|
-
* Admin functionality is not supported with "mine".
|
|
112278
|
+
* Admin functionality is not supported with "mine". Deprecated. Use new route instead (/businessunits/{buId}/shifttrading/trades/state/bulk/jobs)
|
|
110858
112279
|
* @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
|
|
110859
112280
|
* @param {String} weekDateId The start week date of the initiating shift in yyyy-MM-dd format. Dates are represented as an ISO-8601 string. For example: yyyy-MM-dd
|
|
110860
112281
|
* @param {Object} body body
|
|
110861
112282
|
* @param {Object} opts Optional parameters
|
|
110862
112283
|
* @param {Boolean} opts.forceAsync Force the result of this operation to be sent asynchronously via notification. For testing/app development purposes
|
|
110863
112284
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
112285
|
+
* @deprecated
|
|
110864
112286
|
*/
|
|
110865
112287
|
postWorkforcemanagementManagementunitWeekShifttradesStateBulk(managementUnitId, weekDateId, body, opts) {
|
|
110866
112288
|
opts = opts || {};
|
|
@@ -111508,6 +112930,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
111508
112930
|
*
|
|
111509
112931
|
* @param {Object} body body
|
|
111510
112932
|
* @param {Object} opts Optional parameters
|
|
112933
|
+
* @param {Object} opts.includeOnly Limit response to the specified field
|
|
111511
112934
|
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
111512
112935
|
*/
|
|
111513
112936
|
postWorkforcemanagementTimeoffrequestsEstimate(body, opts) {
|
|
@@ -111522,7 +112945,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
111522
112945
|
'/api/v2/workforcemanagement/timeoffrequests/estimate',
|
|
111523
112946
|
'POST',
|
|
111524
112947
|
{ },
|
|
111525
|
-
{
|
|
112948
|
+
{ 'includeOnly': opts['includeOnly'] },
|
|
111526
112949
|
{ },
|
|
111527
112950
|
{ },
|
|
111528
112951
|
body,
|
|
@@ -111769,7 +113192,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
|
|
|
111769
113192
|
* </pre>
|
|
111770
113193
|
* </p>
|
|
111771
113194
|
* @module purecloud-platform-client-v2/index
|
|
111772
|
-
* @version
|
|
113195
|
+
* @version 254.0.0
|
|
111773
113196
|
*/
|
|
111774
113197
|
class platformClient {
|
|
111775
113198
|
constructor() {
|