purecloud-platform-client-v2 249.0.0 → 250.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 +34 -3
- package/dist/node/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.js +20042 -5569
- package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
- package/dist/web-cjs/bundle.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.js +11159 -5369
- package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
- package/index.d.ts +10600 -2242
- package/package.json +1 -1
- package/src/purecloud-platform-client-v2/ApiClient.js +26 -2
- package/src/purecloud-platform-client-v2/api/AIStudioApi.js +136 -40
- package/src/purecloud-platform-client-v2/api/AgentAssistantsApi.js +130 -39
- package/src/purecloud-platform-client-v2/api/AgentCopilotApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/AgentUIApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/AlertingApi.js +86 -26
- package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +917 -224
- package/src/purecloud-platform-client-v2/api/ArchitectApi.js +754 -226
- package/src/purecloud-platform-client-v2/api/AssistantCopilotVariationsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/AuditApi.js +38 -12
- package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +302 -91
- package/src/purecloud-platform-client-v2/api/BackgroundAssistantApi.js +7 -3
- package/src/purecloud-platform-client-v2/api/BillingApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/BusinessRulesApi.js +180 -53
- package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +11 -4
- package/src/purecloud-platform-client-v2/api/CaseManagementApi.js +187 -56
- package/src/purecloud-platform-client-v2/api/ChatApi.js +223 -65
- package/src/purecloud-platform-client-v2/api/CoachingApi.js +124 -37
- package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +165 -51
- package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1992 -578
- package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/DataPrivacyApi.js +39 -12
- package/src/purecloud-platform-client-v2/api/DownloadsApi.js +4 -2
- package/src/purecloud-platform-client-v2/api/EmailsApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/EventsApi.js +22 -7
- package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +700 -206
- package/src/purecloud-platform-client-v2/api/FaxApi.js +49 -15
- package/src/purecloud-platform-client-v2/api/FlowsApi.js +42 -13
- package/src/purecloud-platform-client-v2/api/GamificationApi.js +419 -125
- package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/GeolocationApi.js +29 -9
- package/src/purecloud-platform-client-v2/api/GreetingsApi.js +106 -32
- package/src/purecloud-platform-client-v2/api/GroupsApi.js +103 -31
- package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +267 -77
- package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +20 -7
- package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +461 -139
- package/src/purecloud-platform-client-v2/api/IntentsApi.js +93 -28
- package/src/purecloud-platform-client-v2/api/JourneyApi.js +872 -120
- package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +618 -185
- package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +221 -66
- package/src/purecloud-platform-client-v2/api/LanguagesApi.js +53 -16
- package/src/purecloud-platform-client-v2/api/LearningApi.js +199 -60
- package/src/purecloud-platform-client-v2/api/LicenseApi.js +51 -16
- package/src/purecloud-platform-client-v2/api/LocationsApi.js +45 -14
- package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +34 -11
- package/src/purecloud-platform-client-v2/api/MessagingApi.js +84 -25
- package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +28 -9
- package/src/purecloud-platform-client-v2/api/NotificationsApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/OAuthApi.js +72 -22
- package/src/purecloud-platform-client-v2/api/ObjectsApi.js +58 -18
- package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +21 -7
- package/src/purecloud-platform-client-v2/api/OrganizationApi.js +122 -36
- package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +297 -87
- package/src/purecloud-platform-client-v2/api/OutboundApi.js +1066 -312
- package/src/purecloud-platform-client-v2/api/PresenceApi.js +162 -48
- package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +41 -13
- package/src/purecloud-platform-client-v2/api/QualityApi.js +409 -121
- package/src/purecloud-platform-client-v2/api/RecordingApi.js +351 -108
- package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +113 -34
- package/src/purecloud-platform-client-v2/api/RoutingApi.js +964 -284
- package/src/purecloud-platform-client-v2/api/SCIMApi.js +123 -39
- package/src/purecloud-platform-client-v2/api/ScriptsApi.js +50 -17
- package/src/purecloud-platform-client-v2/api/SearchApi.js +147 -44
- package/src/purecloud-platform-client-v2/api/SettingsApi.js +87 -26
- package/src/purecloud-platform-client-v2/api/SocialMediaApi.js +208 -67
- package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +389 -114
- package/src/purecloud-platform-client-v2/api/StationsApi.js +18 -6
- package/src/purecloud-platform-client-v2/api/SuggestApi.js +13 -5
- package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +473 -138
- package/src/purecloud-platform-client-v2/api/TeamsApi.js +55 -17
- package/src/purecloud-platform-client-v2/api/TelephonyApi.js +80 -24
- package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +751 -220
- package/src/purecloud-platform-client-v2/api/TextbotsApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/TokensApi.js +35 -11
- package/src/purecloud-platform-client-v2/api/UploadsApi.js +78 -23
- package/src/purecloud-platform-client-v2/api/UsageApi.js +62 -19
- package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +27 -9
- package/src/purecloud-platform-client-v2/api/UsersApi.js +717 -228
- package/src/purecloud-platform-client-v2/api/UsersRulesApi.js +52 -16
- package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/VoicemailApi.js +154 -46
- package/src/purecloud-platform-client-v2/api/WebChatApi.js +126 -37
- package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +120 -36
- package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +25 -8
- package/src/purecloud-platform-client-v2/api/WidgetsApi.js +36 -11
- package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +2475 -577
- package/src/purecloud-platform-client-v2/index.js +1 -1
|
@@ -5,7 +5,7 @@ class AnalyticsApi {
|
|
|
5
5
|
/**
|
|
6
6
|
* Analytics service.
|
|
7
7
|
* @module purecloud-platform-client-v2/api/AnalyticsApi
|
|
8
|
-
* @version
|
|
8
|
+
* @version 250.0.0
|
|
9
9
|
*/
|
|
10
10
|
|
|
11
11
|
/**
|
|
@@ -24,9 +24,13 @@ class AnalyticsApi {
|
|
|
24
24
|
* Delete/cancel an async request for action aggregates
|
|
25
25
|
*
|
|
26
26
|
* @param {String} jobId jobId
|
|
27
|
+
* @param {Object} opts Optional parameters
|
|
28
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
27
29
|
* deleteAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
28
30
|
*/
|
|
29
|
-
deleteAnalyticsActionsAggregatesJob(jobId) {
|
|
31
|
+
deleteAnalyticsActionsAggregatesJob(jobId, opts) {
|
|
32
|
+
opts = opts || {};
|
|
33
|
+
|
|
30
34
|
// verify the required parameter 'jobId' is set
|
|
31
35
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
32
36
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsActionsAggregatesJob';
|
|
@@ -42,7 +46,8 @@ class AnalyticsApi {
|
|
|
42
46
|
null,
|
|
43
47
|
['PureCloud OAuth'],
|
|
44
48
|
['application/json'],
|
|
45
|
-
['application/json']
|
|
49
|
+
['application/json'],
|
|
50
|
+
opts['customHeaders']
|
|
46
51
|
);
|
|
47
52
|
}
|
|
48
53
|
|
|
@@ -50,9 +55,13 @@ class AnalyticsApi {
|
|
|
50
55
|
* Delete/cancel an async request for agent copilot aggregates
|
|
51
56
|
*
|
|
52
57
|
* @param {String} jobId jobId
|
|
58
|
+
* @param {Object} opts Optional parameters
|
|
59
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
53
60
|
* deleteAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
54
61
|
*/
|
|
55
|
-
deleteAnalyticsAgentcopilotsAggregatesJob(jobId) {
|
|
62
|
+
deleteAnalyticsAgentcopilotsAggregatesJob(jobId, opts) {
|
|
63
|
+
opts = opts || {};
|
|
64
|
+
|
|
56
65
|
// verify the required parameter 'jobId' is set
|
|
57
66
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
58
67
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsAgentcopilotsAggregatesJob';
|
|
@@ -68,7 +77,8 @@ class AnalyticsApi {
|
|
|
68
77
|
null,
|
|
69
78
|
['PureCloud OAuth'],
|
|
70
79
|
['application/json'],
|
|
71
|
-
['application/json']
|
|
80
|
+
['application/json'],
|
|
81
|
+
opts['customHeaders']
|
|
72
82
|
);
|
|
73
83
|
}
|
|
74
84
|
|
|
@@ -76,9 +86,13 @@ class AnalyticsApi {
|
|
|
76
86
|
* Delete/cancel an async request for bot aggregates
|
|
77
87
|
*
|
|
78
88
|
* @param {String} jobId jobId
|
|
89
|
+
* @param {Object} opts Optional parameters
|
|
90
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
79
91
|
* deleteAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
80
92
|
*/
|
|
81
|
-
deleteAnalyticsBotsAggregatesJob(jobId) {
|
|
93
|
+
deleteAnalyticsBotsAggregatesJob(jobId, opts) {
|
|
94
|
+
opts = opts || {};
|
|
95
|
+
|
|
82
96
|
// verify the required parameter 'jobId' is set
|
|
83
97
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
84
98
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsBotsAggregatesJob';
|
|
@@ -94,7 +108,8 @@ class AnalyticsApi {
|
|
|
94
108
|
null,
|
|
95
109
|
['PureCloud OAuth'],
|
|
96
110
|
['application/json'],
|
|
97
|
-
['application/json']
|
|
111
|
+
['application/json'],
|
|
112
|
+
opts['customHeaders']
|
|
98
113
|
);
|
|
99
114
|
}
|
|
100
115
|
|
|
@@ -102,9 +117,13 @@ class AnalyticsApi {
|
|
|
102
117
|
* Delete/cancel an async request for case management aggregates
|
|
103
118
|
*
|
|
104
119
|
* @param {String} jobId jobId
|
|
120
|
+
* @param {Object} opts Optional parameters
|
|
121
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
105
122
|
* deleteAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
106
123
|
*/
|
|
107
|
-
deleteAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
124
|
+
deleteAnalyticsCasemanagementAggregatesJob(jobId, opts) {
|
|
125
|
+
opts = opts || {};
|
|
126
|
+
|
|
108
127
|
// verify the required parameter 'jobId' is set
|
|
109
128
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
110
129
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCasemanagementAggregatesJob';
|
|
@@ -120,7 +139,8 @@ class AnalyticsApi {
|
|
|
120
139
|
null,
|
|
121
140
|
['PureCloud OAuth'],
|
|
122
141
|
['application/json'],
|
|
123
|
-
['application/json']
|
|
142
|
+
['application/json'],
|
|
143
|
+
opts['customHeaders']
|
|
124
144
|
);
|
|
125
145
|
}
|
|
126
146
|
|
|
@@ -128,9 +148,13 @@ class AnalyticsApi {
|
|
|
128
148
|
* Delete/cancel an async request for conversation aggregates
|
|
129
149
|
*
|
|
130
150
|
* @param {String} jobId jobId
|
|
151
|
+
* @param {Object} opts Optional parameters
|
|
152
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
131
153
|
* deleteAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
132
154
|
*/
|
|
133
|
-
deleteAnalyticsConversationsAggregatesJob(jobId) {
|
|
155
|
+
deleteAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
156
|
+
opts = opts || {};
|
|
157
|
+
|
|
134
158
|
// verify the required parameter 'jobId' is set
|
|
135
159
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
136
160
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsAggregatesJob';
|
|
@@ -146,7 +170,8 @@ class AnalyticsApi {
|
|
|
146
170
|
null,
|
|
147
171
|
['PureCloud OAuth'],
|
|
148
172
|
['application/json'],
|
|
149
|
-
['application/json']
|
|
173
|
+
['application/json'],
|
|
174
|
+
opts['customHeaders']
|
|
150
175
|
);
|
|
151
176
|
}
|
|
152
177
|
|
|
@@ -154,8 +179,12 @@ class AnalyticsApi {
|
|
|
154
179
|
* Delete/cancel an async details job
|
|
155
180
|
*
|
|
156
181
|
* @param {String} jobId jobId
|
|
182
|
+
* @param {Object} opts Optional parameters
|
|
183
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
157
184
|
*/
|
|
158
|
-
deleteAnalyticsConversationsDetailsJob(jobId) {
|
|
185
|
+
deleteAnalyticsConversationsDetailsJob(jobId, opts) {
|
|
186
|
+
opts = opts || {};
|
|
187
|
+
|
|
159
188
|
// verify the required parameter 'jobId' is set
|
|
160
189
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
161
190
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsConversationsDetailsJob';
|
|
@@ -171,7 +200,39 @@ class AnalyticsApi {
|
|
|
171
200
|
null,
|
|
172
201
|
['PureCloud OAuth'],
|
|
173
202
|
['application/json'],
|
|
174
|
-
['application/json']
|
|
203
|
+
['application/json'],
|
|
204
|
+
opts['customHeaders']
|
|
205
|
+
);
|
|
206
|
+
}
|
|
207
|
+
|
|
208
|
+
/**
|
|
209
|
+
* Delete/cancel an async request for copilot aggregates
|
|
210
|
+
*
|
|
211
|
+
* @param {String} jobId jobId
|
|
212
|
+
* @param {Object} opts Optional parameters
|
|
213
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
214
|
+
* deleteAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
215
|
+
*/
|
|
216
|
+
deleteAnalyticsCopilotsAggregatesJob(jobId, opts) {
|
|
217
|
+
opts = opts || {};
|
|
218
|
+
|
|
219
|
+
// verify the required parameter 'jobId' is set
|
|
220
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
221
|
+
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsCopilotsAggregatesJob';
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
return this.apiClient.callApi(
|
|
225
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
|
|
226
|
+
'DELETE',
|
|
227
|
+
{ 'jobId': jobId },
|
|
228
|
+
{ },
|
|
229
|
+
{ },
|
|
230
|
+
{ },
|
|
231
|
+
null,
|
|
232
|
+
['PureCloud OAuth'],
|
|
233
|
+
['application/json'],
|
|
234
|
+
['application/json'],
|
|
235
|
+
opts['customHeaders']
|
|
175
236
|
);
|
|
176
237
|
}
|
|
177
238
|
|
|
@@ -179,9 +240,13 @@ class AnalyticsApi {
|
|
|
179
240
|
* Delete/cancel an async request for evaluation aggregates
|
|
180
241
|
*
|
|
181
242
|
* @param {String} jobId jobId
|
|
243
|
+
* @param {Object} opts Optional parameters
|
|
244
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
182
245
|
* deleteAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
183
246
|
*/
|
|
184
|
-
deleteAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
247
|
+
deleteAnalyticsEvaluationsAggregatesJob(jobId, opts) {
|
|
248
|
+
opts = opts || {};
|
|
249
|
+
|
|
185
250
|
// verify the required parameter 'jobId' is set
|
|
186
251
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
187
252
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsEvaluationsAggregatesJob';
|
|
@@ -197,7 +262,8 @@ class AnalyticsApi {
|
|
|
197
262
|
null,
|
|
198
263
|
['PureCloud OAuth'],
|
|
199
264
|
['application/json'],
|
|
200
|
-
['application/json']
|
|
265
|
+
['application/json'],
|
|
266
|
+
opts['customHeaders']
|
|
201
267
|
);
|
|
202
268
|
}
|
|
203
269
|
|
|
@@ -205,9 +271,13 @@ class AnalyticsApi {
|
|
|
205
271
|
* Delete/cancel an async request for flow execution aggregates
|
|
206
272
|
*
|
|
207
273
|
* @param {String} jobId jobId
|
|
274
|
+
* @param {Object} opts Optional parameters
|
|
275
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
208
276
|
* deleteAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
209
277
|
*/
|
|
210
|
-
deleteAnalyticsFlowexecutionsAggregatesJob(jobId) {
|
|
278
|
+
deleteAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
|
|
279
|
+
opts = opts || {};
|
|
280
|
+
|
|
211
281
|
// verify the required parameter 'jobId' is set
|
|
212
282
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
213
283
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowexecutionsAggregatesJob';
|
|
@@ -223,7 +293,8 @@ class AnalyticsApi {
|
|
|
223
293
|
null,
|
|
224
294
|
['PureCloud OAuth'],
|
|
225
295
|
['application/json'],
|
|
226
|
-
['application/json']
|
|
296
|
+
['application/json'],
|
|
297
|
+
opts['customHeaders']
|
|
227
298
|
);
|
|
228
299
|
}
|
|
229
300
|
|
|
@@ -231,9 +302,13 @@ class AnalyticsApi {
|
|
|
231
302
|
* Delete/cancel an async request for flow aggregates
|
|
232
303
|
*
|
|
233
304
|
* @param {String} jobId jobId
|
|
305
|
+
* @param {Object} opts Optional parameters
|
|
306
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
234
307
|
* deleteAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
235
308
|
*/
|
|
236
|
-
deleteAnalyticsFlowsAggregatesJob(jobId) {
|
|
309
|
+
deleteAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
310
|
+
opts = opts || {};
|
|
311
|
+
|
|
237
312
|
// verify the required parameter 'jobId' is set
|
|
238
313
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
239
314
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsFlowsAggregatesJob';
|
|
@@ -249,7 +324,8 @@ class AnalyticsApi {
|
|
|
249
324
|
null,
|
|
250
325
|
['PureCloud OAuth'],
|
|
251
326
|
['application/json'],
|
|
252
|
-
['application/json']
|
|
327
|
+
['application/json'],
|
|
328
|
+
opts['customHeaders']
|
|
253
329
|
);
|
|
254
330
|
}
|
|
255
331
|
|
|
@@ -257,9 +333,13 @@ class AnalyticsApi {
|
|
|
257
333
|
* Delete/cancel an async request for journey aggregates
|
|
258
334
|
*
|
|
259
335
|
* @param {String} jobId jobId
|
|
336
|
+
* @param {Object} opts Optional parameters
|
|
337
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
260
338
|
* deleteAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
261
339
|
*/
|
|
262
|
-
deleteAnalyticsJourneysAggregatesJob(jobId) {
|
|
340
|
+
deleteAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
341
|
+
opts = opts || {};
|
|
342
|
+
|
|
263
343
|
// verify the required parameter 'jobId' is set
|
|
264
344
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
265
345
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsJourneysAggregatesJob';
|
|
@@ -275,7 +355,8 @@ class AnalyticsApi {
|
|
|
275
355
|
null,
|
|
276
356
|
['PureCloud OAuth'],
|
|
277
357
|
['application/json'],
|
|
278
|
-
['application/json']
|
|
358
|
+
['application/json'],
|
|
359
|
+
opts['customHeaders']
|
|
279
360
|
);
|
|
280
361
|
}
|
|
281
362
|
|
|
@@ -283,9 +364,13 @@ class AnalyticsApi {
|
|
|
283
364
|
* Delete/cancel an async request for knowledge aggregates
|
|
284
365
|
*
|
|
285
366
|
* @param {String} jobId jobId
|
|
367
|
+
* @param {Object} opts Optional parameters
|
|
368
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
286
369
|
* deleteAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
287
370
|
*/
|
|
288
|
-
deleteAnalyticsKnowledgeAggregatesJob(jobId) {
|
|
371
|
+
deleteAnalyticsKnowledgeAggregatesJob(jobId, opts) {
|
|
372
|
+
opts = opts || {};
|
|
373
|
+
|
|
289
374
|
// verify the required parameter 'jobId' is set
|
|
290
375
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
291
376
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsKnowledgeAggregatesJob';
|
|
@@ -301,7 +386,8 @@ class AnalyticsApi {
|
|
|
301
386
|
null,
|
|
302
387
|
['PureCloud OAuth'],
|
|
303
388
|
['application/json'],
|
|
304
|
-
['application/json']
|
|
389
|
+
['application/json'],
|
|
390
|
+
opts['customHeaders']
|
|
305
391
|
);
|
|
306
392
|
}
|
|
307
393
|
|
|
@@ -309,9 +395,13 @@ class AnalyticsApi {
|
|
|
309
395
|
* Delete/cancel an async request for resolution aggregates
|
|
310
396
|
*
|
|
311
397
|
* @param {String} jobId jobId
|
|
398
|
+
* @param {Object} opts Optional parameters
|
|
399
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
312
400
|
* deleteAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
313
401
|
*/
|
|
314
|
-
deleteAnalyticsResolutionsAggregatesJob(jobId) {
|
|
402
|
+
deleteAnalyticsResolutionsAggregatesJob(jobId, opts) {
|
|
403
|
+
opts = opts || {};
|
|
404
|
+
|
|
315
405
|
// verify the required parameter 'jobId' is set
|
|
316
406
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
317
407
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsResolutionsAggregatesJob';
|
|
@@ -327,7 +417,8 @@ class AnalyticsApi {
|
|
|
327
417
|
null,
|
|
328
418
|
['PureCloud OAuth'],
|
|
329
419
|
['application/json'],
|
|
330
|
-
['application/json']
|
|
420
|
+
['application/json'],
|
|
421
|
+
opts['customHeaders']
|
|
331
422
|
);
|
|
332
423
|
}
|
|
333
424
|
|
|
@@ -335,9 +426,13 @@ class AnalyticsApi {
|
|
|
335
426
|
* Delete/cancel an async request for summary aggregates
|
|
336
427
|
*
|
|
337
428
|
* @param {String} jobId jobId
|
|
429
|
+
* @param {Object} opts Optional parameters
|
|
430
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
338
431
|
* deleteAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
339
432
|
*/
|
|
340
|
-
deleteAnalyticsSummariesAggregatesJob(jobId) {
|
|
433
|
+
deleteAnalyticsSummariesAggregatesJob(jobId, opts) {
|
|
434
|
+
opts = opts || {};
|
|
435
|
+
|
|
341
436
|
// verify the required parameter 'jobId' is set
|
|
342
437
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
343
438
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSummariesAggregatesJob';
|
|
@@ -353,7 +448,8 @@ class AnalyticsApi {
|
|
|
353
448
|
null,
|
|
354
449
|
['PureCloud OAuth'],
|
|
355
450
|
['application/json'],
|
|
356
|
-
['application/json']
|
|
451
|
+
['application/json'],
|
|
452
|
+
opts['customHeaders']
|
|
357
453
|
);
|
|
358
454
|
}
|
|
359
455
|
|
|
@@ -361,9 +457,13 @@ class AnalyticsApi {
|
|
|
361
457
|
* Delete/cancel an async request for survey aggregates
|
|
362
458
|
*
|
|
363
459
|
* @param {String} jobId jobId
|
|
460
|
+
* @param {Object} opts Optional parameters
|
|
461
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
364
462
|
* deleteAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
365
463
|
*/
|
|
366
|
-
deleteAnalyticsSurveysAggregatesJob(jobId) {
|
|
464
|
+
deleteAnalyticsSurveysAggregatesJob(jobId, opts) {
|
|
465
|
+
opts = opts || {};
|
|
466
|
+
|
|
367
467
|
// verify the required parameter 'jobId' is set
|
|
368
468
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
369
469
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsSurveysAggregatesJob';
|
|
@@ -379,7 +479,8 @@ class AnalyticsApi {
|
|
|
379
479
|
null,
|
|
380
480
|
['PureCloud OAuth'],
|
|
381
481
|
['application/json'],
|
|
382
|
-
['application/json']
|
|
482
|
+
['application/json'],
|
|
483
|
+
opts['customHeaders']
|
|
383
484
|
);
|
|
384
485
|
}
|
|
385
486
|
|
|
@@ -387,9 +488,13 @@ class AnalyticsApi {
|
|
|
387
488
|
* Delete/cancel an async request for task management aggregates
|
|
388
489
|
*
|
|
389
490
|
* @param {String} jobId jobId
|
|
491
|
+
* @param {Object} opts Optional parameters
|
|
492
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
390
493
|
* deleteAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
391
494
|
*/
|
|
392
|
-
deleteAnalyticsTaskmanagementAggregatesJob(jobId) {
|
|
495
|
+
deleteAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
|
|
496
|
+
opts = opts || {};
|
|
497
|
+
|
|
393
498
|
// verify the required parameter 'jobId' is set
|
|
394
499
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
395
500
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTaskmanagementAggregatesJob';
|
|
@@ -405,7 +510,8 @@ class AnalyticsApi {
|
|
|
405
510
|
null,
|
|
406
511
|
['PureCloud OAuth'],
|
|
407
512
|
['application/json'],
|
|
408
|
-
['application/json']
|
|
513
|
+
['application/json'],
|
|
514
|
+
opts['customHeaders']
|
|
409
515
|
);
|
|
410
516
|
}
|
|
411
517
|
|
|
@@ -413,9 +519,13 @@ class AnalyticsApi {
|
|
|
413
519
|
* Delete/cancel an async request for transcript aggregates
|
|
414
520
|
*
|
|
415
521
|
* @param {String} jobId jobId
|
|
522
|
+
* @param {Object} opts Optional parameters
|
|
523
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
416
524
|
* deleteAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
417
525
|
*/
|
|
418
|
-
deleteAnalyticsTranscriptsAggregatesJob(jobId) {
|
|
526
|
+
deleteAnalyticsTranscriptsAggregatesJob(jobId, opts) {
|
|
527
|
+
opts = opts || {};
|
|
528
|
+
|
|
419
529
|
// verify the required parameter 'jobId' is set
|
|
420
530
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
421
531
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsTranscriptsAggregatesJob';
|
|
@@ -431,7 +541,8 @@ class AnalyticsApi {
|
|
|
431
541
|
null,
|
|
432
542
|
['PureCloud OAuth'],
|
|
433
543
|
['application/json'],
|
|
434
|
-
['application/json']
|
|
544
|
+
['application/json'],
|
|
545
|
+
opts['customHeaders']
|
|
435
546
|
);
|
|
436
547
|
}
|
|
437
548
|
|
|
@@ -439,9 +550,13 @@ class AnalyticsApi {
|
|
|
439
550
|
* Delete/cancel an async request for user aggregates
|
|
440
551
|
*
|
|
441
552
|
* @param {String} jobId jobId
|
|
553
|
+
* @param {Object} opts Optional parameters
|
|
554
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
442
555
|
* deleteAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
443
556
|
*/
|
|
444
|
-
deleteAnalyticsUsersAggregatesJob(jobId) {
|
|
557
|
+
deleteAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
558
|
+
opts = opts || {};
|
|
559
|
+
|
|
445
560
|
// verify the required parameter 'jobId' is set
|
|
446
561
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
447
562
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersAggregatesJob';
|
|
@@ -457,7 +572,8 @@ class AnalyticsApi {
|
|
|
457
572
|
null,
|
|
458
573
|
['PureCloud OAuth'],
|
|
459
574
|
['application/json'],
|
|
460
|
-
['application/json']
|
|
575
|
+
['application/json'],
|
|
576
|
+
opts['customHeaders']
|
|
461
577
|
);
|
|
462
578
|
}
|
|
463
579
|
|
|
@@ -465,8 +581,12 @@ class AnalyticsApi {
|
|
|
465
581
|
* Delete/cancel an async request
|
|
466
582
|
*
|
|
467
583
|
* @param {String} jobId jobId
|
|
584
|
+
* @param {Object} opts Optional parameters
|
|
585
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
468
586
|
*/
|
|
469
|
-
deleteAnalyticsUsersDetailsJob(jobId) {
|
|
587
|
+
deleteAnalyticsUsersDetailsJob(jobId, opts) {
|
|
588
|
+
opts = opts || {};
|
|
589
|
+
|
|
470
590
|
// verify the required parameter 'jobId' is set
|
|
471
591
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
472
592
|
throw 'Missing the required parameter "jobId" when calling deleteAnalyticsUsersDetailsJob';
|
|
@@ -482,7 +602,8 @@ class AnalyticsApi {
|
|
|
482
602
|
null,
|
|
483
603
|
['PureCloud OAuth'],
|
|
484
604
|
['application/json'],
|
|
485
|
-
['application/json']
|
|
605
|
+
['application/json'],
|
|
606
|
+
opts['customHeaders']
|
|
486
607
|
);
|
|
487
608
|
}
|
|
488
609
|
|
|
@@ -490,9 +611,13 @@ class AnalyticsApi {
|
|
|
490
611
|
* Get status for async query for action aggregates
|
|
491
612
|
*
|
|
492
613
|
* @param {String} jobId jobId
|
|
614
|
+
* @param {Object} opts Optional parameters
|
|
615
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
493
616
|
* getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
494
617
|
*/
|
|
495
|
-
getAnalyticsActionsAggregatesJob(jobId) {
|
|
618
|
+
getAnalyticsActionsAggregatesJob(jobId, opts) {
|
|
619
|
+
opts = opts || {};
|
|
620
|
+
|
|
496
621
|
// verify the required parameter 'jobId' is set
|
|
497
622
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
498
623
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJob';
|
|
@@ -508,7 +633,8 @@ class AnalyticsApi {
|
|
|
508
633
|
null,
|
|
509
634
|
['PureCloud OAuth'],
|
|
510
635
|
['application/json'],
|
|
511
|
-
['application/json']
|
|
636
|
+
['application/json'],
|
|
637
|
+
opts['customHeaders']
|
|
512
638
|
);
|
|
513
639
|
}
|
|
514
640
|
|
|
@@ -518,6 +644,7 @@ class AnalyticsApi {
|
|
|
518
644
|
* @param {String} jobId jobId
|
|
519
645
|
* @param {Object} opts Optional parameters
|
|
520
646
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
647
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
521
648
|
* getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
522
649
|
*/
|
|
523
650
|
getAnalyticsActionsAggregatesJobResults(jobId, opts) {
|
|
@@ -538,7 +665,8 @@ class AnalyticsApi {
|
|
|
538
665
|
null,
|
|
539
666
|
['PureCloud OAuth'],
|
|
540
667
|
['application/json'],
|
|
541
|
-
['application/json']
|
|
668
|
+
['application/json'],
|
|
669
|
+
opts['customHeaders']
|
|
542
670
|
);
|
|
543
671
|
}
|
|
544
672
|
|
|
@@ -546,8 +674,12 @@ class AnalyticsApi {
|
|
|
546
674
|
* Get an agent and their active sessions by user ID
|
|
547
675
|
*
|
|
548
676
|
* @param {String} userId userId
|
|
677
|
+
* @param {Object} opts Optional parameters
|
|
678
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
549
679
|
*/
|
|
550
|
-
getAnalyticsAgentStatus(userId) {
|
|
680
|
+
getAnalyticsAgentStatus(userId, opts) {
|
|
681
|
+
opts = opts || {};
|
|
682
|
+
|
|
551
683
|
// verify the required parameter 'userId' is set
|
|
552
684
|
if (userId === undefined || userId === null || userId === '') {
|
|
553
685
|
throw 'Missing the required parameter "userId" when calling getAnalyticsAgentStatus';
|
|
@@ -563,7 +695,8 @@ class AnalyticsApi {
|
|
|
563
695
|
null,
|
|
564
696
|
['PureCloud OAuth'],
|
|
565
697
|
['application/json'],
|
|
566
|
-
['application/json']
|
|
698
|
+
['application/json'],
|
|
699
|
+
opts['customHeaders']
|
|
567
700
|
);
|
|
568
701
|
}
|
|
569
702
|
|
|
@@ -571,9 +704,13 @@ class AnalyticsApi {
|
|
|
571
704
|
* Get status for async query for agent copilot aggregates
|
|
572
705
|
*
|
|
573
706
|
* @param {String} jobId jobId
|
|
707
|
+
* @param {Object} opts Optional parameters
|
|
708
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
574
709
|
* getAnalyticsAgentcopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
575
710
|
*/
|
|
576
|
-
getAnalyticsAgentcopilotsAggregatesJob(jobId) {
|
|
711
|
+
getAnalyticsAgentcopilotsAggregatesJob(jobId, opts) {
|
|
712
|
+
opts = opts || {};
|
|
713
|
+
|
|
577
714
|
// verify the required parameter 'jobId' is set
|
|
578
715
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
579
716
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsAgentcopilotsAggregatesJob';
|
|
@@ -589,7 +726,8 @@ class AnalyticsApi {
|
|
|
589
726
|
null,
|
|
590
727
|
['PureCloud OAuth'],
|
|
591
728
|
['application/json'],
|
|
592
|
-
['application/json']
|
|
729
|
+
['application/json'],
|
|
730
|
+
opts['customHeaders']
|
|
593
731
|
);
|
|
594
732
|
}
|
|
595
733
|
|
|
@@ -599,6 +737,7 @@ class AnalyticsApi {
|
|
|
599
737
|
* @param {String} jobId jobId
|
|
600
738
|
* @param {Object} opts Optional parameters
|
|
601
739
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
740
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
602
741
|
* getAnalyticsAgentcopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
603
742
|
*/
|
|
604
743
|
getAnalyticsAgentcopilotsAggregatesJobResults(jobId, opts) {
|
|
@@ -619,7 +758,8 @@ class AnalyticsApi {
|
|
|
619
758
|
null,
|
|
620
759
|
['PureCloud OAuth'],
|
|
621
760
|
['application/json'],
|
|
622
|
-
['application/json']
|
|
761
|
+
['application/json'],
|
|
762
|
+
opts['customHeaders']
|
|
623
763
|
);
|
|
624
764
|
}
|
|
625
765
|
|
|
@@ -635,6 +775,7 @@ class AnalyticsApi {
|
|
|
635
775
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
636
776
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
637
777
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
778
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
638
779
|
*/
|
|
639
780
|
getAnalyticsBotflowDivisionsReportingturns(botFlowId, opts) {
|
|
640
781
|
opts = opts || {};
|
|
@@ -654,7 +795,8 @@ class AnalyticsApi {
|
|
|
654
795
|
null,
|
|
655
796
|
['PureCloud OAuth'],
|
|
656
797
|
['application/json'],
|
|
657
|
-
['application/json']
|
|
798
|
+
['application/json'],
|
|
799
|
+
opts['customHeaders']
|
|
658
800
|
);
|
|
659
801
|
}
|
|
660
802
|
|
|
@@ -670,6 +812,7 @@ class AnalyticsApi {
|
|
|
670
812
|
* @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session. Specifying a session ID alongside an action ID or a language or any ask action results is not allowed.
|
|
671
813
|
* @param {String} opts.language Optional language code to get the reporting turns for a particular language
|
|
672
814
|
* @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
|
|
815
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
673
816
|
* @deprecated
|
|
674
817
|
*/
|
|
675
818
|
getAnalyticsBotflowReportingturns(botFlowId, opts) {
|
|
@@ -690,7 +833,8 @@ class AnalyticsApi {
|
|
|
690
833
|
null,
|
|
691
834
|
['PureCloud OAuth'],
|
|
692
835
|
['application/json'],
|
|
693
|
-
['application/json']
|
|
836
|
+
['application/json'],
|
|
837
|
+
opts['customHeaders']
|
|
694
838
|
);
|
|
695
839
|
}
|
|
696
840
|
|
|
@@ -704,6 +848,7 @@ class AnalyticsApi {
|
|
|
704
848
|
* @param {String} opts.interval Date range filter based on the date the individual resources were completed. UTC is the default if no TZ is supplied, however alternate timezones can be used e.g: '2022-11-22T09:11:11.111+08:00/2022-11-30T07:17:44.586-07'. . Intervals are represented as an ISO-8601 string. For example: YYYY-MM-DDThh:mm:ss/YYYY-MM-DDThh:mm:ss
|
|
705
849
|
* @param {Object} opts.botResultCategories Optional case-insensitive comma separated list of Bot Result Categories to filter sessions by.
|
|
706
850
|
* @param {String} opts.endLanguage Optional case-insensitive language code to filter sessions by the language the sessions ended in.
|
|
851
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
707
852
|
*/
|
|
708
853
|
getAnalyticsBotflowSessions(botFlowId, opts) {
|
|
709
854
|
opts = opts || {};
|
|
@@ -723,7 +868,8 @@ class AnalyticsApi {
|
|
|
723
868
|
null,
|
|
724
869
|
['PureCloud OAuth'],
|
|
725
870
|
['application/json'],
|
|
726
|
-
['application/json']
|
|
871
|
+
['application/json'],
|
|
872
|
+
opts['customHeaders']
|
|
727
873
|
);
|
|
728
874
|
}
|
|
729
875
|
|
|
@@ -731,9 +877,13 @@ class AnalyticsApi {
|
|
|
731
877
|
* Get status for async query for bot aggregates
|
|
732
878
|
*
|
|
733
879
|
* @param {String} jobId jobId
|
|
880
|
+
* @param {Object} opts Optional parameters
|
|
881
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
734
882
|
* getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
735
883
|
*/
|
|
736
|
-
getAnalyticsBotsAggregatesJob(jobId) {
|
|
884
|
+
getAnalyticsBotsAggregatesJob(jobId, opts) {
|
|
885
|
+
opts = opts || {};
|
|
886
|
+
|
|
737
887
|
// verify the required parameter 'jobId' is set
|
|
738
888
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
739
889
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJob';
|
|
@@ -749,7 +899,8 @@ class AnalyticsApi {
|
|
|
749
899
|
null,
|
|
750
900
|
['PureCloud OAuth'],
|
|
751
901
|
['application/json'],
|
|
752
|
-
['application/json']
|
|
902
|
+
['application/json'],
|
|
903
|
+
opts['customHeaders']
|
|
753
904
|
);
|
|
754
905
|
}
|
|
755
906
|
|
|
@@ -759,6 +910,7 @@ class AnalyticsApi {
|
|
|
759
910
|
* @param {String} jobId jobId
|
|
760
911
|
* @param {Object} opts Optional parameters
|
|
761
912
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
913
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
762
914
|
* getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
763
915
|
*/
|
|
764
916
|
getAnalyticsBotsAggregatesJobResults(jobId, opts) {
|
|
@@ -779,7 +931,8 @@ class AnalyticsApi {
|
|
|
779
931
|
null,
|
|
780
932
|
['PureCloud OAuth'],
|
|
781
933
|
['application/json'],
|
|
782
|
-
['application/json']
|
|
934
|
+
['application/json'],
|
|
935
|
+
opts['customHeaders']
|
|
783
936
|
);
|
|
784
937
|
}
|
|
785
938
|
|
|
@@ -787,9 +940,13 @@ class AnalyticsApi {
|
|
|
787
940
|
* Get status for async query for case management aggregates
|
|
788
941
|
*
|
|
789
942
|
* @param {String} jobId jobId
|
|
943
|
+
* @param {Object} opts Optional parameters
|
|
944
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
790
945
|
* getAnalyticsCasemanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
791
946
|
*/
|
|
792
|
-
getAnalyticsCasemanagementAggregatesJob(jobId) {
|
|
947
|
+
getAnalyticsCasemanagementAggregatesJob(jobId, opts) {
|
|
948
|
+
opts = opts || {};
|
|
949
|
+
|
|
793
950
|
// verify the required parameter 'jobId' is set
|
|
794
951
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
795
952
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsCasemanagementAggregatesJob';
|
|
@@ -805,7 +962,8 @@ class AnalyticsApi {
|
|
|
805
962
|
null,
|
|
806
963
|
['PureCloud OAuth'],
|
|
807
964
|
['application/json'],
|
|
808
|
-
['application/json']
|
|
965
|
+
['application/json'],
|
|
966
|
+
opts['customHeaders']
|
|
809
967
|
);
|
|
810
968
|
}
|
|
811
969
|
|
|
@@ -815,6 +973,7 @@ class AnalyticsApi {
|
|
|
815
973
|
* @param {String} jobId jobId
|
|
816
974
|
* @param {Object} opts Optional parameters
|
|
817
975
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
976
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
818
977
|
* getAnalyticsCasemanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
819
978
|
*/
|
|
820
979
|
getAnalyticsCasemanagementAggregatesJobResults(jobId, opts) {
|
|
@@ -835,7 +994,8 @@ class AnalyticsApi {
|
|
|
835
994
|
null,
|
|
836
995
|
['PureCloud OAuth'],
|
|
837
996
|
['application/json'],
|
|
838
|
-
['application/json']
|
|
997
|
+
['application/json'],
|
|
998
|
+
opts['customHeaders']
|
|
839
999
|
);
|
|
840
1000
|
}
|
|
841
1001
|
|
|
@@ -843,8 +1003,12 @@ class AnalyticsApi {
|
|
|
843
1003
|
* Get a conversation by id
|
|
844
1004
|
*
|
|
845
1005
|
* @param {String} conversationId conversationId
|
|
1006
|
+
* @param {Object} opts Optional parameters
|
|
1007
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
846
1008
|
*/
|
|
847
|
-
getAnalyticsConversationDetails(conversationId) {
|
|
1009
|
+
getAnalyticsConversationDetails(conversationId, opts) {
|
|
1010
|
+
opts = opts || {};
|
|
1011
|
+
|
|
848
1012
|
// verify the required parameter 'conversationId' is set
|
|
849
1013
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
850
1014
|
throw 'Missing the required parameter "conversationId" when calling getAnalyticsConversationDetails';
|
|
@@ -860,7 +1024,8 @@ class AnalyticsApi {
|
|
|
860
1024
|
null,
|
|
861
1025
|
['PureCloud OAuth'],
|
|
862
1026
|
['application/json'],
|
|
863
|
-
['application/json']
|
|
1027
|
+
['application/json'],
|
|
1028
|
+
opts['customHeaders']
|
|
864
1029
|
);
|
|
865
1030
|
}
|
|
866
1031
|
|
|
@@ -868,9 +1033,13 @@ class AnalyticsApi {
|
|
|
868
1033
|
* Get status for async query for conversation aggregates
|
|
869
1034
|
*
|
|
870
1035
|
* @param {String} jobId jobId
|
|
1036
|
+
* @param {Object} opts Optional parameters
|
|
1037
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
871
1038
|
* getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
872
1039
|
*/
|
|
873
|
-
getAnalyticsConversationsAggregatesJob(jobId) {
|
|
1040
|
+
getAnalyticsConversationsAggregatesJob(jobId, opts) {
|
|
1041
|
+
opts = opts || {};
|
|
1042
|
+
|
|
874
1043
|
// verify the required parameter 'jobId' is set
|
|
875
1044
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
876
1045
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';
|
|
@@ -886,7 +1055,8 @@ class AnalyticsApi {
|
|
|
886
1055
|
null,
|
|
887
1056
|
['PureCloud OAuth'],
|
|
888
1057
|
['application/json'],
|
|
889
|
-
['application/json']
|
|
1058
|
+
['application/json'],
|
|
1059
|
+
opts['customHeaders']
|
|
890
1060
|
);
|
|
891
1061
|
}
|
|
892
1062
|
|
|
@@ -896,6 +1066,7 @@ class AnalyticsApi {
|
|
|
896
1066
|
* @param {String} jobId jobId
|
|
897
1067
|
* @param {Object} opts Optional parameters
|
|
898
1068
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1069
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
899
1070
|
* getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
900
1071
|
*/
|
|
901
1072
|
getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
|
|
@@ -916,7 +1087,8 @@ class AnalyticsApi {
|
|
|
916
1087
|
null,
|
|
917
1088
|
['PureCloud OAuth'],
|
|
918
1089
|
['application/json'],
|
|
919
|
-
['application/json']
|
|
1090
|
+
['application/json'],
|
|
1091
|
+
opts['customHeaders']
|
|
920
1092
|
);
|
|
921
1093
|
}
|
|
922
1094
|
|
|
@@ -925,6 +1097,7 @@ class AnalyticsApi {
|
|
|
925
1097
|
*
|
|
926
1098
|
* @param {Object} opts Optional parameters
|
|
927
1099
|
* @param {Array.<String>} opts.id Comma-separated conversation ids
|
|
1100
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
928
1101
|
*/
|
|
929
1102
|
getAnalyticsConversationsDetails(opts) {
|
|
930
1103
|
opts = opts || {};
|
|
@@ -940,7 +1113,8 @@ class AnalyticsApi {
|
|
|
940
1113
|
null,
|
|
941
1114
|
['PureCloud OAuth'],
|
|
942
1115
|
['application/json'],
|
|
943
|
-
['application/json']
|
|
1116
|
+
['application/json'],
|
|
1117
|
+
opts['customHeaders']
|
|
944
1118
|
);
|
|
945
1119
|
}
|
|
946
1120
|
|
|
@@ -948,8 +1122,12 @@ class AnalyticsApi {
|
|
|
948
1122
|
* Get status for async query for conversation details
|
|
949
1123
|
*
|
|
950
1124
|
* @param {String} jobId jobId
|
|
1125
|
+
* @param {Object} opts Optional parameters
|
|
1126
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
951
1127
|
*/
|
|
952
|
-
getAnalyticsConversationsDetailsJob(jobId) {
|
|
1128
|
+
getAnalyticsConversationsDetailsJob(jobId, opts) {
|
|
1129
|
+
opts = opts || {};
|
|
1130
|
+
|
|
953
1131
|
// verify the required parameter 'jobId' is set
|
|
954
1132
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
955
1133
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsConversationsDetailsJob';
|
|
@@ -965,7 +1143,8 @@ class AnalyticsApi {
|
|
|
965
1143
|
null,
|
|
966
1144
|
['PureCloud OAuth'],
|
|
967
1145
|
['application/json'],
|
|
968
|
-
['application/json']
|
|
1146
|
+
['application/json'],
|
|
1147
|
+
opts['customHeaders']
|
|
969
1148
|
);
|
|
970
1149
|
}
|
|
971
1150
|
|
|
@@ -976,6 +1155,7 @@ class AnalyticsApi {
|
|
|
976
1155
|
* @param {Object} opts Optional parameters
|
|
977
1156
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
978
1157
|
* @param {Number} opts.pageSize The desired maximum number of results
|
|
1158
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
979
1159
|
*/
|
|
980
1160
|
getAnalyticsConversationsDetailsJobResults(jobId, opts) {
|
|
981
1161
|
opts = opts || {};
|
|
@@ -995,15 +1175,20 @@ class AnalyticsApi {
|
|
|
995
1175
|
null,
|
|
996
1176
|
['PureCloud OAuth'],
|
|
997
1177
|
['application/json'],
|
|
998
|
-
['application/json']
|
|
1178
|
+
['application/json'],
|
|
1179
|
+
opts['customHeaders']
|
|
999
1180
|
);
|
|
1000
1181
|
}
|
|
1001
1182
|
|
|
1002
1183
|
/**
|
|
1003
1184
|
* Lookup the datalake availability date and time
|
|
1004
1185
|
*
|
|
1186
|
+
* @param {Object} opts Optional parameters
|
|
1187
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1005
1188
|
*/
|
|
1006
|
-
getAnalyticsConversationsDetailsJobsAvailability() {
|
|
1189
|
+
getAnalyticsConversationsDetailsJobsAvailability(opts) {
|
|
1190
|
+
opts = opts || {};
|
|
1191
|
+
|
|
1007
1192
|
|
|
1008
1193
|
return this.apiClient.callApi(
|
|
1009
1194
|
'/api/v2/analytics/conversations/details/jobs/availability',
|
|
@@ -1015,7 +1200,71 @@ class AnalyticsApi {
|
|
|
1015
1200
|
null,
|
|
1016
1201
|
['PureCloud OAuth'],
|
|
1017
1202
|
['application/json'],
|
|
1018
|
-
['application/json']
|
|
1203
|
+
['application/json'],
|
|
1204
|
+
opts['customHeaders']
|
|
1205
|
+
);
|
|
1206
|
+
}
|
|
1207
|
+
|
|
1208
|
+
/**
|
|
1209
|
+
* Get status for async query for copilot aggregates
|
|
1210
|
+
*
|
|
1211
|
+
* @param {String} jobId jobId
|
|
1212
|
+
* @param {Object} opts Optional parameters
|
|
1213
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1214
|
+
* getAnalyticsCopilotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1215
|
+
*/
|
|
1216
|
+
getAnalyticsCopilotsAggregatesJob(jobId, opts) {
|
|
1217
|
+
opts = opts || {};
|
|
1218
|
+
|
|
1219
|
+
// verify the required parameter 'jobId' is set
|
|
1220
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1221
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJob';
|
|
1222
|
+
}
|
|
1223
|
+
|
|
1224
|
+
return this.apiClient.callApi(
|
|
1225
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}',
|
|
1226
|
+
'GET',
|
|
1227
|
+
{ 'jobId': jobId },
|
|
1228
|
+
{ },
|
|
1229
|
+
{ },
|
|
1230
|
+
{ },
|
|
1231
|
+
null,
|
|
1232
|
+
['PureCloud OAuth'],
|
|
1233
|
+
['application/json'],
|
|
1234
|
+
['application/json'],
|
|
1235
|
+
opts['customHeaders']
|
|
1236
|
+
);
|
|
1237
|
+
}
|
|
1238
|
+
|
|
1239
|
+
/**
|
|
1240
|
+
* Fetch a page of results for an async aggregates query
|
|
1241
|
+
*
|
|
1242
|
+
* @param {String} jobId jobId
|
|
1243
|
+
* @param {Object} opts Optional parameters
|
|
1244
|
+
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1245
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1246
|
+
* getAnalyticsCopilotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1247
|
+
*/
|
|
1248
|
+
getAnalyticsCopilotsAggregatesJobResults(jobId, opts) {
|
|
1249
|
+
opts = opts || {};
|
|
1250
|
+
|
|
1251
|
+
// verify the required parameter 'jobId' is set
|
|
1252
|
+
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1253
|
+
throw 'Missing the required parameter "jobId" when calling getAnalyticsCopilotsAggregatesJobResults';
|
|
1254
|
+
}
|
|
1255
|
+
|
|
1256
|
+
return this.apiClient.callApi(
|
|
1257
|
+
'/api/v2/analytics/copilots/aggregates/jobs/{jobId}/results',
|
|
1258
|
+
'GET',
|
|
1259
|
+
{ 'jobId': jobId },
|
|
1260
|
+
{ 'cursor': opts['cursor'] },
|
|
1261
|
+
{ },
|
|
1262
|
+
{ },
|
|
1263
|
+
null,
|
|
1264
|
+
['PureCloud OAuth'],
|
|
1265
|
+
['application/json'],
|
|
1266
|
+
['application/json'],
|
|
1267
|
+
opts['customHeaders']
|
|
1019
1268
|
);
|
|
1020
1269
|
}
|
|
1021
1270
|
|
|
@@ -1023,9 +1272,13 @@ class AnalyticsApi {
|
|
|
1023
1272
|
* Get analytics data warehouse file download
|
|
1024
1273
|
*
|
|
1025
1274
|
* @param {String} downloadId Unique file Id to download
|
|
1275
|
+
* @param {Object} opts Optional parameters
|
|
1276
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1026
1277
|
* getAnalyticsDataextractionDownload is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1027
1278
|
*/
|
|
1028
|
-
getAnalyticsDataextractionDownload(downloadId) {
|
|
1279
|
+
getAnalyticsDataextractionDownload(downloadId, opts) {
|
|
1280
|
+
opts = opts || {};
|
|
1281
|
+
|
|
1029
1282
|
// verify the required parameter 'downloadId' is set
|
|
1030
1283
|
if (downloadId === undefined || downloadId === null || downloadId === '') {
|
|
1031
1284
|
throw 'Missing the required parameter "downloadId" when calling getAnalyticsDataextractionDownload';
|
|
@@ -1041,7 +1294,8 @@ class AnalyticsApi {
|
|
|
1041
1294
|
null,
|
|
1042
1295
|
['PureCloud OAuth'],
|
|
1043
1296
|
['application/json'],
|
|
1044
|
-
['application/json']
|
|
1297
|
+
['application/json'],
|
|
1298
|
+
opts['customHeaders']
|
|
1045
1299
|
);
|
|
1046
1300
|
}
|
|
1047
1301
|
|
|
@@ -1055,6 +1309,7 @@ class AnalyticsApi {
|
|
|
1055
1309
|
* @param {String} opts.dataSchema Data schema like conversations
|
|
1056
1310
|
* @param {Date} opts.dateStart Start DateTime filter. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
1057
1311
|
* @param {Date} opts.dateEnd End DateTime filter. Date time is represented as an ISO-8601 string. For example: yyyy-MM-ddTHH:mm:ss[.mmm]Z
|
|
1312
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1058
1313
|
* getAnalyticsDataextractionDownloadsMetadata is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1059
1314
|
*/
|
|
1060
1315
|
getAnalyticsDataextractionDownloadsMetadata(opts) {
|
|
@@ -1071,15 +1326,20 @@ class AnalyticsApi {
|
|
|
1071
1326
|
null,
|
|
1072
1327
|
['PureCloud OAuth'],
|
|
1073
1328
|
['application/json'],
|
|
1074
|
-
['application/json']
|
|
1329
|
+
['application/json'],
|
|
1330
|
+
opts['customHeaders']
|
|
1075
1331
|
);
|
|
1076
1332
|
}
|
|
1077
1333
|
|
|
1078
1334
|
/**
|
|
1079
1335
|
* Get analytics data retention setting
|
|
1080
1336
|
*
|
|
1337
|
+
* @param {Object} opts Optional parameters
|
|
1338
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1081
1339
|
*/
|
|
1082
|
-
getAnalyticsDataretentionSettings() {
|
|
1340
|
+
getAnalyticsDataretentionSettings(opts) {
|
|
1341
|
+
opts = opts || {};
|
|
1342
|
+
|
|
1083
1343
|
|
|
1084
1344
|
return this.apiClient.callApi(
|
|
1085
1345
|
'/api/v2/analytics/dataretention/settings',
|
|
@@ -1091,7 +1351,8 @@ class AnalyticsApi {
|
|
|
1091
1351
|
null,
|
|
1092
1352
|
['PureCloud OAuth'],
|
|
1093
1353
|
['application/json'],
|
|
1094
|
-
['application/json']
|
|
1354
|
+
['application/json'],
|
|
1355
|
+
opts['customHeaders']
|
|
1095
1356
|
);
|
|
1096
1357
|
}
|
|
1097
1358
|
|
|
@@ -1099,9 +1360,13 @@ class AnalyticsApi {
|
|
|
1099
1360
|
* Get status for async query for evaluation aggregates
|
|
1100
1361
|
*
|
|
1101
1362
|
* @param {String} jobId jobId
|
|
1363
|
+
* @param {Object} opts Optional parameters
|
|
1364
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1102
1365
|
* getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1103
1366
|
*/
|
|
1104
|
-
getAnalyticsEvaluationsAggregatesJob(jobId) {
|
|
1367
|
+
getAnalyticsEvaluationsAggregatesJob(jobId, opts) {
|
|
1368
|
+
opts = opts || {};
|
|
1369
|
+
|
|
1105
1370
|
// verify the required parameter 'jobId' is set
|
|
1106
1371
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1107
1372
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';
|
|
@@ -1117,7 +1382,8 @@ class AnalyticsApi {
|
|
|
1117
1382
|
null,
|
|
1118
1383
|
['PureCloud OAuth'],
|
|
1119
1384
|
['application/json'],
|
|
1120
|
-
['application/json']
|
|
1385
|
+
['application/json'],
|
|
1386
|
+
opts['customHeaders']
|
|
1121
1387
|
);
|
|
1122
1388
|
}
|
|
1123
1389
|
|
|
@@ -1127,6 +1393,7 @@ class AnalyticsApi {
|
|
|
1127
1393
|
* @param {String} jobId jobId
|
|
1128
1394
|
* @param {Object} opts Optional parameters
|
|
1129
1395
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1396
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1130
1397
|
* getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1131
1398
|
*/
|
|
1132
1399
|
getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
|
|
@@ -1147,7 +1414,8 @@ class AnalyticsApi {
|
|
|
1147
1414
|
null,
|
|
1148
1415
|
['PureCloud OAuth'],
|
|
1149
1416
|
['application/json'],
|
|
1150
|
-
['application/json']
|
|
1417
|
+
['application/json'],
|
|
1418
|
+
opts['customHeaders']
|
|
1151
1419
|
);
|
|
1152
1420
|
}
|
|
1153
1421
|
|
|
@@ -1155,9 +1423,13 @@ class AnalyticsApi {
|
|
|
1155
1423
|
* Get status for async query for flow execution aggregates
|
|
1156
1424
|
*
|
|
1157
1425
|
* @param {String} jobId jobId
|
|
1426
|
+
* @param {Object} opts Optional parameters
|
|
1427
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1158
1428
|
* getAnalyticsFlowexecutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1159
1429
|
*/
|
|
1160
|
-
getAnalyticsFlowexecutionsAggregatesJob(jobId) {
|
|
1430
|
+
getAnalyticsFlowexecutionsAggregatesJob(jobId, opts) {
|
|
1431
|
+
opts = opts || {};
|
|
1432
|
+
|
|
1161
1433
|
// verify the required parameter 'jobId' is set
|
|
1162
1434
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1163
1435
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowexecutionsAggregatesJob';
|
|
@@ -1173,7 +1445,8 @@ class AnalyticsApi {
|
|
|
1173
1445
|
null,
|
|
1174
1446
|
['PureCloud OAuth'],
|
|
1175
1447
|
['application/json'],
|
|
1176
|
-
['application/json']
|
|
1448
|
+
['application/json'],
|
|
1449
|
+
opts['customHeaders']
|
|
1177
1450
|
);
|
|
1178
1451
|
}
|
|
1179
1452
|
|
|
@@ -1183,6 +1456,7 @@ class AnalyticsApi {
|
|
|
1183
1456
|
* @param {String} jobId jobId
|
|
1184
1457
|
* @param {Object} opts Optional parameters
|
|
1185
1458
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1459
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1186
1460
|
* getAnalyticsFlowexecutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1187
1461
|
*/
|
|
1188
1462
|
getAnalyticsFlowexecutionsAggregatesJobResults(jobId, opts) {
|
|
@@ -1203,7 +1477,8 @@ class AnalyticsApi {
|
|
|
1203
1477
|
null,
|
|
1204
1478
|
['PureCloud OAuth'],
|
|
1205
1479
|
['application/json'],
|
|
1206
|
-
['application/json']
|
|
1480
|
+
['application/json'],
|
|
1481
|
+
opts['customHeaders']
|
|
1207
1482
|
);
|
|
1208
1483
|
}
|
|
1209
1484
|
|
|
@@ -1211,9 +1486,13 @@ class AnalyticsApi {
|
|
|
1211
1486
|
* Get status for async query for Flow aggregates
|
|
1212
1487
|
*
|
|
1213
1488
|
* @param {String} jobId jobId
|
|
1489
|
+
* @param {Object} opts Optional parameters
|
|
1490
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1214
1491
|
* getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1215
1492
|
*/
|
|
1216
|
-
getAnalyticsFlowsAggregatesJob(jobId) {
|
|
1493
|
+
getAnalyticsFlowsAggregatesJob(jobId, opts) {
|
|
1494
|
+
opts = opts || {};
|
|
1495
|
+
|
|
1217
1496
|
// verify the required parameter 'jobId' is set
|
|
1218
1497
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1219
1498
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';
|
|
@@ -1229,7 +1508,8 @@ class AnalyticsApi {
|
|
|
1229
1508
|
null,
|
|
1230
1509
|
['PureCloud OAuth'],
|
|
1231
1510
|
['application/json'],
|
|
1232
|
-
['application/json']
|
|
1511
|
+
['application/json'],
|
|
1512
|
+
opts['customHeaders']
|
|
1233
1513
|
);
|
|
1234
1514
|
}
|
|
1235
1515
|
|
|
@@ -1239,6 +1519,7 @@ class AnalyticsApi {
|
|
|
1239
1519
|
* @param {String} jobId jobId
|
|
1240
1520
|
* @param {Object} opts Optional parameters
|
|
1241
1521
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1522
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1242
1523
|
* getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1243
1524
|
*/
|
|
1244
1525
|
getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
|
|
@@ -1259,7 +1540,8 @@ class AnalyticsApi {
|
|
|
1259
1540
|
null,
|
|
1260
1541
|
['PureCloud OAuth'],
|
|
1261
1542
|
['application/json'],
|
|
1262
|
-
['application/json']
|
|
1543
|
+
['application/json'],
|
|
1544
|
+
opts['customHeaders']
|
|
1263
1545
|
);
|
|
1264
1546
|
}
|
|
1265
1547
|
|
|
@@ -1267,9 +1549,13 @@ class AnalyticsApi {
|
|
|
1267
1549
|
* Get status for async query for journey aggregates
|
|
1268
1550
|
*
|
|
1269
1551
|
* @param {String} jobId jobId
|
|
1552
|
+
* @param {Object} opts Optional parameters
|
|
1553
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1270
1554
|
* getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1271
1555
|
*/
|
|
1272
|
-
getAnalyticsJourneysAggregatesJob(jobId) {
|
|
1556
|
+
getAnalyticsJourneysAggregatesJob(jobId, opts) {
|
|
1557
|
+
opts = opts || {};
|
|
1558
|
+
|
|
1273
1559
|
// verify the required parameter 'jobId' is set
|
|
1274
1560
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1275
1561
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';
|
|
@@ -1285,7 +1571,8 @@ class AnalyticsApi {
|
|
|
1285
1571
|
null,
|
|
1286
1572
|
['PureCloud OAuth'],
|
|
1287
1573
|
['application/json'],
|
|
1288
|
-
['application/json']
|
|
1574
|
+
['application/json'],
|
|
1575
|
+
opts['customHeaders']
|
|
1289
1576
|
);
|
|
1290
1577
|
}
|
|
1291
1578
|
|
|
@@ -1295,6 +1582,7 @@ class AnalyticsApi {
|
|
|
1295
1582
|
* @param {String} jobId jobId
|
|
1296
1583
|
* @param {Object} opts Optional parameters
|
|
1297
1584
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1585
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1298
1586
|
* getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1299
1587
|
*/
|
|
1300
1588
|
getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
|
|
@@ -1315,7 +1603,8 @@ class AnalyticsApi {
|
|
|
1315
1603
|
null,
|
|
1316
1604
|
['PureCloud OAuth'],
|
|
1317
1605
|
['application/json'],
|
|
1318
|
-
['application/json']
|
|
1606
|
+
['application/json'],
|
|
1607
|
+
opts['customHeaders']
|
|
1319
1608
|
);
|
|
1320
1609
|
}
|
|
1321
1610
|
|
|
@@ -1323,9 +1612,13 @@ class AnalyticsApi {
|
|
|
1323
1612
|
* Get status for async query for knowledge aggregates
|
|
1324
1613
|
*
|
|
1325
1614
|
* @param {String} jobId jobId
|
|
1615
|
+
* @param {Object} opts Optional parameters
|
|
1616
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1326
1617
|
* getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1327
1618
|
*/
|
|
1328
|
-
getAnalyticsKnowledgeAggregatesJob(jobId) {
|
|
1619
|
+
getAnalyticsKnowledgeAggregatesJob(jobId, opts) {
|
|
1620
|
+
opts = opts || {};
|
|
1621
|
+
|
|
1329
1622
|
// verify the required parameter 'jobId' is set
|
|
1330
1623
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1331
1624
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJob';
|
|
@@ -1341,7 +1634,8 @@ class AnalyticsApi {
|
|
|
1341
1634
|
null,
|
|
1342
1635
|
['PureCloud OAuth'],
|
|
1343
1636
|
['application/json'],
|
|
1344
|
-
['application/json']
|
|
1637
|
+
['application/json'],
|
|
1638
|
+
opts['customHeaders']
|
|
1345
1639
|
);
|
|
1346
1640
|
}
|
|
1347
1641
|
|
|
@@ -1351,6 +1645,7 @@ class AnalyticsApi {
|
|
|
1351
1645
|
* @param {String} jobId jobId
|
|
1352
1646
|
* @param {Object} opts Optional parameters
|
|
1353
1647
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1648
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1354
1649
|
* getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1355
1650
|
*/
|
|
1356
1651
|
getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
|
|
@@ -1371,7 +1666,8 @@ class AnalyticsApi {
|
|
|
1371
1666
|
null,
|
|
1372
1667
|
['PureCloud OAuth'],
|
|
1373
1668
|
['application/json'],
|
|
1374
|
-
['application/json']
|
|
1669
|
+
['application/json'],
|
|
1670
|
+
opts['customHeaders']
|
|
1375
1671
|
);
|
|
1376
1672
|
}
|
|
1377
1673
|
|
|
@@ -1379,8 +1675,12 @@ class AnalyticsApi {
|
|
|
1379
1675
|
* Get dashboards summary for a user
|
|
1380
1676
|
*
|
|
1381
1677
|
* @param {String} userId User ID
|
|
1678
|
+
* @param {Object} opts Optional parameters
|
|
1679
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1382
1680
|
*/
|
|
1383
|
-
getAnalyticsReportingDashboardsUser(userId) {
|
|
1681
|
+
getAnalyticsReportingDashboardsUser(userId, opts) {
|
|
1682
|
+
opts = opts || {};
|
|
1683
|
+
|
|
1384
1684
|
// verify the required parameter 'userId' is set
|
|
1385
1685
|
if (userId === undefined || userId === null || userId === '') {
|
|
1386
1686
|
throw 'Missing the required parameter "userId" when calling getAnalyticsReportingDashboardsUser';
|
|
@@ -1396,7 +1696,8 @@ class AnalyticsApi {
|
|
|
1396
1696
|
null,
|
|
1397
1697
|
['PureCloud OAuth'],
|
|
1398
1698
|
['application/json'],
|
|
1399
|
-
['application/json']
|
|
1699
|
+
['application/json'],
|
|
1700
|
+
opts['customHeaders']
|
|
1400
1701
|
);
|
|
1401
1702
|
}
|
|
1402
1703
|
|
|
@@ -1410,6 +1711,7 @@ class AnalyticsApi {
|
|
|
1410
1711
|
* @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
|
|
1411
1712
|
* @param {Object} opts.state Only list users of this state
|
|
1412
1713
|
* @param {Boolean} opts.deletedOnly Only list users with deleted dashboards
|
|
1714
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1413
1715
|
*/
|
|
1414
1716
|
getAnalyticsReportingDashboardsUsers(opts) {
|
|
1415
1717
|
opts = opts || {};
|
|
@@ -1425,7 +1727,8 @@ class AnalyticsApi {
|
|
|
1425
1727
|
null,
|
|
1426
1728
|
['PureCloud OAuth'],
|
|
1427
1729
|
['application/json'],
|
|
1428
|
-
['application/json']
|
|
1730
|
+
['application/json'],
|
|
1731
|
+
opts['customHeaders']
|
|
1429
1732
|
);
|
|
1430
1733
|
}
|
|
1431
1734
|
|
|
@@ -1435,6 +1738,7 @@ class AnalyticsApi {
|
|
|
1435
1738
|
* @param {Object} opts Optional parameters
|
|
1436
1739
|
* @param {Number} opts.pageNumber Page number (default to 1)
|
|
1437
1740
|
* @param {Number} opts.pageSize Page size (default to 25)
|
|
1741
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1438
1742
|
*/
|
|
1439
1743
|
getAnalyticsReportingExports(opts) {
|
|
1440
1744
|
opts = opts || {};
|
|
@@ -1450,15 +1754,20 @@ class AnalyticsApi {
|
|
|
1450
1754
|
null,
|
|
1451
1755
|
['PureCloud OAuth'],
|
|
1452
1756
|
['application/json'],
|
|
1453
|
-
['application/json']
|
|
1757
|
+
['application/json'],
|
|
1758
|
+
opts['customHeaders']
|
|
1454
1759
|
);
|
|
1455
1760
|
}
|
|
1456
1761
|
|
|
1457
1762
|
/**
|
|
1458
1763
|
* Get all export metadata
|
|
1459
1764
|
*
|
|
1765
|
+
* @param {Object} opts Optional parameters
|
|
1766
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1460
1767
|
*/
|
|
1461
|
-
getAnalyticsReportingExportsMetadata() {
|
|
1768
|
+
getAnalyticsReportingExportsMetadata(opts) {
|
|
1769
|
+
opts = opts || {};
|
|
1770
|
+
|
|
1462
1771
|
|
|
1463
1772
|
return this.apiClient.callApi(
|
|
1464
1773
|
'/api/v2/analytics/reporting/exports/metadata',
|
|
@@ -1470,15 +1779,20 @@ class AnalyticsApi {
|
|
|
1470
1779
|
null,
|
|
1471
1780
|
['PureCloud OAuth'],
|
|
1472
1781
|
['application/json'],
|
|
1473
|
-
['application/json']
|
|
1782
|
+
['application/json'],
|
|
1783
|
+
opts['customHeaders']
|
|
1474
1784
|
);
|
|
1475
1785
|
}
|
|
1476
1786
|
|
|
1477
1787
|
/**
|
|
1478
1788
|
* Get AnalyticsReportingSettings for an organization
|
|
1479
1789
|
*
|
|
1790
|
+
* @param {Object} opts Optional parameters
|
|
1791
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1480
1792
|
*/
|
|
1481
|
-
getAnalyticsReportingSettings() {
|
|
1793
|
+
getAnalyticsReportingSettings(opts) {
|
|
1794
|
+
opts = opts || {};
|
|
1795
|
+
|
|
1482
1796
|
|
|
1483
1797
|
return this.apiClient.callApi(
|
|
1484
1798
|
'/api/v2/analytics/reporting/settings',
|
|
@@ -1490,7 +1804,8 @@ class AnalyticsApi {
|
|
|
1490
1804
|
null,
|
|
1491
1805
|
['PureCloud OAuth'],
|
|
1492
1806
|
['application/json'],
|
|
1493
|
-
['application/json']
|
|
1807
|
+
['application/json'],
|
|
1808
|
+
opts['customHeaders']
|
|
1494
1809
|
);
|
|
1495
1810
|
}
|
|
1496
1811
|
|
|
@@ -1505,6 +1820,7 @@ class AnalyticsApi {
|
|
|
1505
1820
|
* @param {String} opts.sortBy (default to desc)
|
|
1506
1821
|
* @param {Number} opts.pageNumber (default to 1)
|
|
1507
1822
|
* @param {Number} opts.pageSize (default to 9)
|
|
1823
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1508
1824
|
*/
|
|
1509
1825
|
getAnalyticsReportingSettingsDashboardsQuery(dashboardType, dashboardAccessFilter, opts) {
|
|
1510
1826
|
opts = opts || {};
|
|
@@ -1528,7 +1844,8 @@ class AnalyticsApi {
|
|
|
1528
1844
|
null,
|
|
1529
1845
|
['PureCloud OAuth'],
|
|
1530
1846
|
['application/json'],
|
|
1531
|
-
['application/json']
|
|
1847
|
+
['application/json'],
|
|
1848
|
+
opts['customHeaders']
|
|
1532
1849
|
);
|
|
1533
1850
|
}
|
|
1534
1851
|
|
|
@@ -1544,6 +1861,7 @@ class AnalyticsApi {
|
|
|
1544
1861
|
* @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
|
|
1545
1862
|
* @param {Boolean} opts.deletedOnly If true, retrieve only deleted dashboards that are still recoverable
|
|
1546
1863
|
* @param {String} opts.name retrieve dashboards that match with given name
|
|
1864
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1547
1865
|
*/
|
|
1548
1866
|
getAnalyticsReportingSettingsUserDashboards(userId, opts) {
|
|
1549
1867
|
opts = opts || {};
|
|
@@ -1563,7 +1881,8 @@ class AnalyticsApi {
|
|
|
1563
1881
|
null,
|
|
1564
1882
|
['PureCloud OAuth'],
|
|
1565
1883
|
['application/json'],
|
|
1566
|
-
['application/json']
|
|
1884
|
+
['application/json'],
|
|
1885
|
+
opts['customHeaders']
|
|
1567
1886
|
);
|
|
1568
1887
|
}
|
|
1569
1888
|
|
|
@@ -1571,9 +1890,13 @@ class AnalyticsApi {
|
|
|
1571
1890
|
* Get status for async query for resolution aggregates
|
|
1572
1891
|
*
|
|
1573
1892
|
* @param {String} jobId jobId
|
|
1893
|
+
* @param {Object} opts Optional parameters
|
|
1894
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1574
1895
|
* getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1575
1896
|
*/
|
|
1576
|
-
getAnalyticsResolutionsAggregatesJob(jobId) {
|
|
1897
|
+
getAnalyticsResolutionsAggregatesJob(jobId, opts) {
|
|
1898
|
+
opts = opts || {};
|
|
1899
|
+
|
|
1577
1900
|
// verify the required parameter 'jobId' is set
|
|
1578
1901
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1579
1902
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJob';
|
|
@@ -1589,7 +1912,8 @@ class AnalyticsApi {
|
|
|
1589
1912
|
null,
|
|
1590
1913
|
['PureCloud OAuth'],
|
|
1591
1914
|
['application/json'],
|
|
1592
|
-
['application/json']
|
|
1915
|
+
['application/json'],
|
|
1916
|
+
opts['customHeaders']
|
|
1593
1917
|
);
|
|
1594
1918
|
}
|
|
1595
1919
|
|
|
@@ -1599,6 +1923,7 @@ class AnalyticsApi {
|
|
|
1599
1923
|
* @param {String} jobId jobId
|
|
1600
1924
|
* @param {Object} opts Optional parameters
|
|
1601
1925
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1926
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1602
1927
|
* getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1603
1928
|
*/
|
|
1604
1929
|
getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
|
|
@@ -1619,7 +1944,8 @@ class AnalyticsApi {
|
|
|
1619
1944
|
null,
|
|
1620
1945
|
['PureCloud OAuth'],
|
|
1621
1946
|
['application/json'],
|
|
1622
|
-
['application/json']
|
|
1947
|
+
['application/json'],
|
|
1948
|
+
opts['customHeaders']
|
|
1623
1949
|
);
|
|
1624
1950
|
}
|
|
1625
1951
|
|
|
@@ -1627,9 +1953,13 @@ class AnalyticsApi {
|
|
|
1627
1953
|
* Get status for async query for summary aggregates
|
|
1628
1954
|
*
|
|
1629
1955
|
* @param {String} jobId jobId
|
|
1956
|
+
* @param {Object} opts Optional parameters
|
|
1957
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1630
1958
|
* getAnalyticsSummariesAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1631
1959
|
*/
|
|
1632
|
-
getAnalyticsSummariesAggregatesJob(jobId) {
|
|
1960
|
+
getAnalyticsSummariesAggregatesJob(jobId, opts) {
|
|
1961
|
+
opts = opts || {};
|
|
1962
|
+
|
|
1633
1963
|
// verify the required parameter 'jobId' is set
|
|
1634
1964
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1635
1965
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsSummariesAggregatesJob';
|
|
@@ -1645,7 +1975,8 @@ class AnalyticsApi {
|
|
|
1645
1975
|
null,
|
|
1646
1976
|
['PureCloud OAuth'],
|
|
1647
1977
|
['application/json'],
|
|
1648
|
-
['application/json']
|
|
1978
|
+
['application/json'],
|
|
1979
|
+
opts['customHeaders']
|
|
1649
1980
|
);
|
|
1650
1981
|
}
|
|
1651
1982
|
|
|
@@ -1655,6 +1986,7 @@ class AnalyticsApi {
|
|
|
1655
1986
|
* @param {String} jobId jobId
|
|
1656
1987
|
* @param {Object} opts Optional parameters
|
|
1657
1988
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
1989
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1658
1990
|
* getAnalyticsSummariesAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1659
1991
|
*/
|
|
1660
1992
|
getAnalyticsSummariesAggregatesJobResults(jobId, opts) {
|
|
@@ -1675,7 +2007,8 @@ class AnalyticsApi {
|
|
|
1675
2007
|
null,
|
|
1676
2008
|
['PureCloud OAuth'],
|
|
1677
2009
|
['application/json'],
|
|
1678
|
-
['application/json']
|
|
2010
|
+
['application/json'],
|
|
2011
|
+
opts['customHeaders']
|
|
1679
2012
|
);
|
|
1680
2013
|
}
|
|
1681
2014
|
|
|
@@ -1683,9 +2016,13 @@ class AnalyticsApi {
|
|
|
1683
2016
|
* Get status for async query for survey aggregates
|
|
1684
2017
|
*
|
|
1685
2018
|
* @param {String} jobId jobId
|
|
2019
|
+
* @param {Object} opts Optional parameters
|
|
2020
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1686
2021
|
* getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1687
2022
|
*/
|
|
1688
|
-
getAnalyticsSurveysAggregatesJob(jobId) {
|
|
2023
|
+
getAnalyticsSurveysAggregatesJob(jobId, opts) {
|
|
2024
|
+
opts = opts || {};
|
|
2025
|
+
|
|
1689
2026
|
// verify the required parameter 'jobId' is set
|
|
1690
2027
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1691
2028
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';
|
|
@@ -1701,7 +2038,8 @@ class AnalyticsApi {
|
|
|
1701
2038
|
null,
|
|
1702
2039
|
['PureCloud OAuth'],
|
|
1703
2040
|
['application/json'],
|
|
1704
|
-
['application/json']
|
|
2041
|
+
['application/json'],
|
|
2042
|
+
opts['customHeaders']
|
|
1705
2043
|
);
|
|
1706
2044
|
}
|
|
1707
2045
|
|
|
@@ -1711,6 +2049,7 @@ class AnalyticsApi {
|
|
|
1711
2049
|
* @param {String} jobId jobId
|
|
1712
2050
|
* @param {Object} opts Optional parameters
|
|
1713
2051
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2052
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1714
2053
|
* getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1715
2054
|
*/
|
|
1716
2055
|
getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
|
|
@@ -1731,7 +2070,8 @@ class AnalyticsApi {
|
|
|
1731
2070
|
null,
|
|
1732
2071
|
['PureCloud OAuth'],
|
|
1733
2072
|
['application/json'],
|
|
1734
|
-
['application/json']
|
|
2073
|
+
['application/json'],
|
|
2074
|
+
opts['customHeaders']
|
|
1735
2075
|
);
|
|
1736
2076
|
}
|
|
1737
2077
|
|
|
@@ -1739,9 +2079,13 @@ class AnalyticsApi {
|
|
|
1739
2079
|
* Get status for async query for task management aggregates
|
|
1740
2080
|
*
|
|
1741
2081
|
* @param {String} jobId jobId
|
|
2082
|
+
* @param {Object} opts Optional parameters
|
|
2083
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1742
2084
|
* getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1743
2085
|
*/
|
|
1744
|
-
getAnalyticsTaskmanagementAggregatesJob(jobId) {
|
|
2086
|
+
getAnalyticsTaskmanagementAggregatesJob(jobId, opts) {
|
|
2087
|
+
opts = opts || {};
|
|
2088
|
+
|
|
1745
2089
|
// verify the required parameter 'jobId' is set
|
|
1746
2090
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1747
2091
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJob';
|
|
@@ -1757,7 +2101,8 @@ class AnalyticsApi {
|
|
|
1757
2101
|
null,
|
|
1758
2102
|
['PureCloud OAuth'],
|
|
1759
2103
|
['application/json'],
|
|
1760
|
-
['application/json']
|
|
2104
|
+
['application/json'],
|
|
2105
|
+
opts['customHeaders']
|
|
1761
2106
|
);
|
|
1762
2107
|
}
|
|
1763
2108
|
|
|
@@ -1767,6 +2112,7 @@ class AnalyticsApi {
|
|
|
1767
2112
|
* @param {String} jobId jobId
|
|
1768
2113
|
* @param {Object} opts Optional parameters
|
|
1769
2114
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2115
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1770
2116
|
* getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1771
2117
|
*/
|
|
1772
2118
|
getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
|
|
@@ -1787,7 +2133,8 @@ class AnalyticsApi {
|
|
|
1787
2133
|
null,
|
|
1788
2134
|
['PureCloud OAuth'],
|
|
1789
2135
|
['application/json'],
|
|
1790
|
-
['application/json']
|
|
2136
|
+
['application/json'],
|
|
2137
|
+
opts['customHeaders']
|
|
1791
2138
|
);
|
|
1792
2139
|
}
|
|
1793
2140
|
|
|
@@ -1795,9 +2142,13 @@ class AnalyticsApi {
|
|
|
1795
2142
|
* Get status for async query for transcript aggregates
|
|
1796
2143
|
*
|
|
1797
2144
|
* @param {String} jobId jobId
|
|
2145
|
+
* @param {Object} opts Optional parameters
|
|
2146
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1798
2147
|
* getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1799
2148
|
*/
|
|
1800
|
-
getAnalyticsTranscriptsAggregatesJob(jobId) {
|
|
2149
|
+
getAnalyticsTranscriptsAggregatesJob(jobId, opts) {
|
|
2150
|
+
opts = opts || {};
|
|
2151
|
+
|
|
1801
2152
|
// verify the required parameter 'jobId' is set
|
|
1802
2153
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1803
2154
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJob';
|
|
@@ -1813,7 +2164,8 @@ class AnalyticsApi {
|
|
|
1813
2164
|
null,
|
|
1814
2165
|
['PureCloud OAuth'],
|
|
1815
2166
|
['application/json'],
|
|
1816
|
-
['application/json']
|
|
2167
|
+
['application/json'],
|
|
2168
|
+
opts['customHeaders']
|
|
1817
2169
|
);
|
|
1818
2170
|
}
|
|
1819
2171
|
|
|
@@ -1823,6 +2175,7 @@ class AnalyticsApi {
|
|
|
1823
2175
|
* @param {String} jobId jobId
|
|
1824
2176
|
* @param {Object} opts Optional parameters
|
|
1825
2177
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2178
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1826
2179
|
* getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1827
2180
|
*/
|
|
1828
2181
|
getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
|
|
@@ -1843,7 +2196,8 @@ class AnalyticsApi {
|
|
|
1843
2196
|
null,
|
|
1844
2197
|
['PureCloud OAuth'],
|
|
1845
2198
|
['application/json'],
|
|
1846
|
-
['application/json']
|
|
2199
|
+
['application/json'],
|
|
2200
|
+
opts['customHeaders']
|
|
1847
2201
|
);
|
|
1848
2202
|
}
|
|
1849
2203
|
|
|
@@ -1851,9 +2205,13 @@ class AnalyticsApi {
|
|
|
1851
2205
|
* Get status for async query for user aggregates
|
|
1852
2206
|
*
|
|
1853
2207
|
* @param {String} jobId jobId
|
|
2208
|
+
* @param {Object} opts Optional parameters
|
|
2209
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1854
2210
|
* getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1855
2211
|
*/
|
|
1856
|
-
getAnalyticsUsersAggregatesJob(jobId) {
|
|
2212
|
+
getAnalyticsUsersAggregatesJob(jobId, opts) {
|
|
2213
|
+
opts = opts || {};
|
|
2214
|
+
|
|
1857
2215
|
// verify the required parameter 'jobId' is set
|
|
1858
2216
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1859
2217
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';
|
|
@@ -1869,7 +2227,8 @@ class AnalyticsApi {
|
|
|
1869
2227
|
null,
|
|
1870
2228
|
['PureCloud OAuth'],
|
|
1871
2229
|
['application/json'],
|
|
1872
|
-
['application/json']
|
|
2230
|
+
['application/json'],
|
|
2231
|
+
opts['customHeaders']
|
|
1873
2232
|
);
|
|
1874
2233
|
}
|
|
1875
2234
|
|
|
@@ -1879,6 +2238,7 @@ class AnalyticsApi {
|
|
|
1879
2238
|
* @param {String} jobId jobId
|
|
1880
2239
|
* @param {Object} opts Optional parameters
|
|
1881
2240
|
* @param {String} opts.cursor Cursor token to retrieve next page
|
|
2241
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1882
2242
|
* getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
1883
2243
|
*/
|
|
1884
2244
|
getAnalyticsUsersAggregatesJobResults(jobId, opts) {
|
|
@@ -1899,7 +2259,8 @@ class AnalyticsApi {
|
|
|
1899
2259
|
null,
|
|
1900
2260
|
['PureCloud OAuth'],
|
|
1901
2261
|
['application/json'],
|
|
1902
|
-
['application/json']
|
|
2262
|
+
['application/json'],
|
|
2263
|
+
opts['customHeaders']
|
|
1903
2264
|
);
|
|
1904
2265
|
}
|
|
1905
2266
|
|
|
@@ -1907,8 +2268,12 @@ class AnalyticsApi {
|
|
|
1907
2268
|
* Get status for async query for user details
|
|
1908
2269
|
*
|
|
1909
2270
|
* @param {String} jobId jobId
|
|
2271
|
+
* @param {Object} opts Optional parameters
|
|
2272
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1910
2273
|
*/
|
|
1911
|
-
getAnalyticsUsersDetailsJob(jobId) {
|
|
2274
|
+
getAnalyticsUsersDetailsJob(jobId, opts) {
|
|
2275
|
+
opts = opts || {};
|
|
2276
|
+
|
|
1912
2277
|
// verify the required parameter 'jobId' is set
|
|
1913
2278
|
if (jobId === undefined || jobId === null || jobId === '') {
|
|
1914
2279
|
throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';
|
|
@@ -1924,7 +2289,8 @@ class AnalyticsApi {
|
|
|
1924
2289
|
null,
|
|
1925
2290
|
['PureCloud OAuth'],
|
|
1926
2291
|
['application/json'],
|
|
1927
|
-
['application/json']
|
|
2292
|
+
['application/json'],
|
|
2293
|
+
opts['customHeaders']
|
|
1928
2294
|
);
|
|
1929
2295
|
}
|
|
1930
2296
|
|
|
@@ -1935,6 +2301,7 @@ class AnalyticsApi {
|
|
|
1935
2301
|
* @param {Object} opts Optional parameters
|
|
1936
2302
|
* @param {String} opts.cursor Indicates where to resume query results (not required for first page)
|
|
1937
2303
|
* @param {Number} opts.pageSize The desired maximum number of results
|
|
2304
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1938
2305
|
*/
|
|
1939
2306
|
getAnalyticsUsersDetailsJobResults(jobId, opts) {
|
|
1940
2307
|
opts = opts || {};
|
|
@@ -1954,15 +2321,20 @@ class AnalyticsApi {
|
|
|
1954
2321
|
null,
|
|
1955
2322
|
['PureCloud OAuth'],
|
|
1956
2323
|
['application/json'],
|
|
1957
|
-
['application/json']
|
|
2324
|
+
['application/json'],
|
|
2325
|
+
opts['customHeaders']
|
|
1958
2326
|
);
|
|
1959
2327
|
}
|
|
1960
2328
|
|
|
1961
2329
|
/**
|
|
1962
2330
|
* Lookup the datalake availability date and time
|
|
1963
2331
|
*
|
|
2332
|
+
* @param {Object} opts Optional parameters
|
|
2333
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1964
2334
|
*/
|
|
1965
|
-
getAnalyticsUsersDetailsJobsAvailability() {
|
|
2335
|
+
getAnalyticsUsersDetailsJobsAvailability(opts) {
|
|
2336
|
+
opts = opts || {};
|
|
2337
|
+
|
|
1966
2338
|
|
|
1967
2339
|
return this.apiClient.callApi(
|
|
1968
2340
|
'/api/v2/analytics/users/details/jobs/availability',
|
|
@@ -1974,7 +2346,8 @@ class AnalyticsApi {
|
|
|
1974
2346
|
null,
|
|
1975
2347
|
['PureCloud OAuth'],
|
|
1976
2348
|
['application/json'],
|
|
1977
|
-
['application/json']
|
|
2349
|
+
['application/json'],
|
|
2350
|
+
opts['customHeaders']
|
|
1978
2351
|
);
|
|
1979
2352
|
}
|
|
1980
2353
|
|
|
@@ -1982,8 +2355,12 @@ class AnalyticsApi {
|
|
|
1982
2355
|
* Patch AnalyticsReportingSettings values for an organization
|
|
1983
2356
|
*
|
|
1984
2357
|
* @param {Object} body AnalyticsReportingSettingsRequest
|
|
2358
|
+
* @param {Object} opts Optional parameters
|
|
2359
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
1985
2360
|
*/
|
|
1986
|
-
patchAnalyticsReportingSettings(body) {
|
|
2361
|
+
patchAnalyticsReportingSettings(body, opts) {
|
|
2362
|
+
opts = opts || {};
|
|
2363
|
+
|
|
1987
2364
|
// verify the required parameter 'body' is set
|
|
1988
2365
|
if (body === undefined || body === null) {
|
|
1989
2366
|
throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
|
|
@@ -1999,7 +2376,8 @@ class AnalyticsApi {
|
|
|
1999
2376
|
body,
|
|
2000
2377
|
['PureCloud OAuth'],
|
|
2001
2378
|
['application/json'],
|
|
2002
|
-
['application/json']
|
|
2379
|
+
['application/json'],
|
|
2380
|
+
opts['customHeaders']
|
|
2003
2381
|
);
|
|
2004
2382
|
}
|
|
2005
2383
|
|
|
@@ -2007,9 +2385,13 @@ class AnalyticsApi {
|
|
|
2007
2385
|
* Query for action aggregates asynchronously
|
|
2008
2386
|
*
|
|
2009
2387
|
* @param {Object} body query
|
|
2388
|
+
* @param {Object} opts Optional parameters
|
|
2389
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2010
2390
|
* postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2011
2391
|
*/
|
|
2012
|
-
postAnalyticsActionsAggregatesJobs(body) {
|
|
2392
|
+
postAnalyticsActionsAggregatesJobs(body, opts) {
|
|
2393
|
+
opts = opts || {};
|
|
2394
|
+
|
|
2013
2395
|
// verify the required parameter 'body' is set
|
|
2014
2396
|
if (body === undefined || body === null) {
|
|
2015
2397
|
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesJobs';
|
|
@@ -2025,7 +2407,8 @@ class AnalyticsApi {
|
|
|
2025
2407
|
body,
|
|
2026
2408
|
['PureCloud OAuth'],
|
|
2027
2409
|
['application/json'],
|
|
2028
|
-
['application/json']
|
|
2410
|
+
['application/json'],
|
|
2411
|
+
opts['customHeaders']
|
|
2029
2412
|
);
|
|
2030
2413
|
}
|
|
2031
2414
|
|
|
@@ -2033,8 +2416,12 @@ class AnalyticsApi {
|
|
|
2033
2416
|
* Query for action aggregates
|
|
2034
2417
|
*
|
|
2035
2418
|
* @param {Object} body query
|
|
2419
|
+
* @param {Object} opts Optional parameters
|
|
2420
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2036
2421
|
*/
|
|
2037
|
-
postAnalyticsActionsAggregatesQuery(body) {
|
|
2422
|
+
postAnalyticsActionsAggregatesQuery(body, opts) {
|
|
2423
|
+
opts = opts || {};
|
|
2424
|
+
|
|
2038
2425
|
// verify the required parameter 'body' is set
|
|
2039
2426
|
if (body === undefined || body === null) {
|
|
2040
2427
|
throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
|
|
@@ -2050,7 +2437,8 @@ class AnalyticsApi {
|
|
|
2050
2437
|
body,
|
|
2051
2438
|
['PureCloud OAuth'],
|
|
2052
2439
|
['application/json'],
|
|
2053
|
-
['application/json']
|
|
2440
|
+
['application/json'],
|
|
2441
|
+
opts['customHeaders']
|
|
2054
2442
|
);
|
|
2055
2443
|
}
|
|
2056
2444
|
|
|
@@ -2058,9 +2446,13 @@ class AnalyticsApi {
|
|
|
2058
2446
|
* Query for agent copilot aggregates asynchronously
|
|
2059
2447
|
*
|
|
2060
2448
|
* @param {Object} body query
|
|
2449
|
+
* @param {Object} opts Optional parameters
|
|
2450
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2061
2451
|
* postAnalyticsAgentcopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2062
2452
|
*/
|
|
2063
|
-
postAnalyticsAgentcopilotsAggregatesJobs(body) {
|
|
2453
|
+
postAnalyticsAgentcopilotsAggregatesJobs(body, opts) {
|
|
2454
|
+
opts = opts || {};
|
|
2455
|
+
|
|
2064
2456
|
// verify the required parameter 'body' is set
|
|
2065
2457
|
if (body === undefined || body === null) {
|
|
2066
2458
|
throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesJobs';
|
|
@@ -2076,7 +2468,8 @@ class AnalyticsApi {
|
|
|
2076
2468
|
body,
|
|
2077
2469
|
['PureCloud OAuth'],
|
|
2078
2470
|
['application/json'],
|
|
2079
|
-
['application/json']
|
|
2471
|
+
['application/json'],
|
|
2472
|
+
opts['customHeaders']
|
|
2080
2473
|
);
|
|
2081
2474
|
}
|
|
2082
2475
|
|
|
@@ -2084,8 +2477,12 @@ class AnalyticsApi {
|
|
|
2084
2477
|
* Query for agent copilot aggregates
|
|
2085
2478
|
*
|
|
2086
2479
|
* @param {Object} body query
|
|
2480
|
+
* @param {Object} opts Optional parameters
|
|
2481
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2087
2482
|
*/
|
|
2088
|
-
postAnalyticsAgentcopilotsAggregatesQuery(body) {
|
|
2483
|
+
postAnalyticsAgentcopilotsAggregatesQuery(body, opts) {
|
|
2484
|
+
opts = opts || {};
|
|
2485
|
+
|
|
2089
2486
|
// verify the required parameter 'body' is set
|
|
2090
2487
|
if (body === undefined || body === null) {
|
|
2091
2488
|
throw 'Missing the required parameter "body" when calling postAnalyticsAgentcopilotsAggregatesQuery';
|
|
@@ -2101,7 +2498,8 @@ class AnalyticsApi {
|
|
|
2101
2498
|
body,
|
|
2102
2499
|
['PureCloud OAuth'],
|
|
2103
2500
|
['application/json'],
|
|
2104
|
-
['application/json']
|
|
2501
|
+
['application/json'],
|
|
2502
|
+
opts['customHeaders']
|
|
2105
2503
|
);
|
|
2106
2504
|
}
|
|
2107
2505
|
|
|
@@ -2111,6 +2509,7 @@ class AnalyticsApi {
|
|
|
2111
2509
|
* @param {Object} body query
|
|
2112
2510
|
* @param {Object} opts Optional parameters
|
|
2113
2511
|
* @param {Array.<String>} opts.groupBy Include to choose which groupings to count by and return. If not included it will return only counts grouped by segmentType
|
|
2512
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2114
2513
|
*/
|
|
2115
2514
|
postAnalyticsAgentsStatusCounts(body, opts) {
|
|
2116
2515
|
opts = opts || {};
|
|
@@ -2130,7 +2529,8 @@ class AnalyticsApi {
|
|
|
2130
2529
|
body,
|
|
2131
2530
|
['PureCloud OAuth'],
|
|
2132
2531
|
['application/json'],
|
|
2133
|
-
['application/json']
|
|
2532
|
+
['application/json'],
|
|
2533
|
+
opts['customHeaders']
|
|
2134
2534
|
);
|
|
2135
2535
|
}
|
|
2136
2536
|
|
|
@@ -2138,8 +2538,12 @@ class AnalyticsApi {
|
|
|
2138
2538
|
* Retrieve the top 50 agents matching the query filters
|
|
2139
2539
|
*
|
|
2140
2540
|
* @param {Object} body query
|
|
2541
|
+
* @param {Object} opts Optional parameters
|
|
2542
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2141
2543
|
*/
|
|
2142
|
-
postAnalyticsAgentsStatusQuery(body) {
|
|
2544
|
+
postAnalyticsAgentsStatusQuery(body, opts) {
|
|
2545
|
+
opts = opts || {};
|
|
2546
|
+
|
|
2143
2547
|
// verify the required parameter 'body' is set
|
|
2144
2548
|
if (body === undefined || body === null) {
|
|
2145
2549
|
throw 'Missing the required parameter "body" when calling postAnalyticsAgentsStatusQuery';
|
|
@@ -2155,7 +2559,8 @@ class AnalyticsApi {
|
|
|
2155
2559
|
body,
|
|
2156
2560
|
['PureCloud OAuth'],
|
|
2157
2561
|
['application/json'],
|
|
2158
|
-
['application/json']
|
|
2562
|
+
['application/json'],
|
|
2563
|
+
opts['customHeaders']
|
|
2159
2564
|
);
|
|
2160
2565
|
}
|
|
2161
2566
|
|
|
@@ -2163,9 +2568,13 @@ class AnalyticsApi {
|
|
|
2163
2568
|
* Query for bot aggregates asynchronously
|
|
2164
2569
|
*
|
|
2165
2570
|
* @param {Object} body query
|
|
2571
|
+
* @param {Object} opts Optional parameters
|
|
2572
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2166
2573
|
* postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2167
2574
|
*/
|
|
2168
|
-
postAnalyticsBotsAggregatesJobs(body) {
|
|
2575
|
+
postAnalyticsBotsAggregatesJobs(body, opts) {
|
|
2576
|
+
opts = opts || {};
|
|
2577
|
+
|
|
2169
2578
|
// verify the required parameter 'body' is set
|
|
2170
2579
|
if (body === undefined || body === null) {
|
|
2171
2580
|
throw 'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesJobs';
|
|
@@ -2181,7 +2590,8 @@ class AnalyticsApi {
|
|
|
2181
2590
|
body,
|
|
2182
2591
|
['PureCloud OAuth'],
|
|
2183
2592
|
['application/json'],
|
|
2184
|
-
['application/json']
|
|
2593
|
+
['application/json'],
|
|
2594
|
+
opts['customHeaders']
|
|
2185
2595
|
);
|
|
2186
2596
|
}
|
|
2187
2597
|
|
|
@@ -2189,8 +2599,12 @@ class AnalyticsApi {
|
|
|
2189
2599
|
* Query for bot aggregates
|
|
2190
2600
|
*
|
|
2191
2601
|
* @param {Object} body query
|
|
2602
|
+
* @param {Object} opts Optional parameters
|
|
2603
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2192
2604
|
*/
|
|
2193
|
-
postAnalyticsBotsAggregatesQuery(body) {
|
|
2605
|
+
postAnalyticsBotsAggregatesQuery(body, opts) {
|
|
2606
|
+
opts = opts || {};
|
|
2607
|
+
|
|
2194
2608
|
// verify the required parameter 'body' is set
|
|
2195
2609
|
if (body === undefined || body === null) {
|
|
2196
2610
|
throw 'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesQuery';
|
|
@@ -2206,7 +2620,8 @@ class AnalyticsApi {
|
|
|
2206
2620
|
body,
|
|
2207
2621
|
['PureCloud OAuth'],
|
|
2208
2622
|
['application/json'],
|
|
2209
|
-
['application/json']
|
|
2623
|
+
['application/json'],
|
|
2624
|
+
opts['customHeaders']
|
|
2210
2625
|
);
|
|
2211
2626
|
}
|
|
2212
2627
|
|
|
@@ -2214,9 +2629,13 @@ class AnalyticsApi {
|
|
|
2214
2629
|
* Query for case management aggregates asynchronously
|
|
2215
2630
|
*
|
|
2216
2631
|
* @param {Object} body query
|
|
2632
|
+
* @param {Object} opts Optional parameters
|
|
2633
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2217
2634
|
* postAnalyticsCasemanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2218
2635
|
*/
|
|
2219
|
-
postAnalyticsCasemanagementAggregatesJobs(body) {
|
|
2636
|
+
postAnalyticsCasemanagementAggregatesJobs(body, opts) {
|
|
2637
|
+
opts = opts || {};
|
|
2638
|
+
|
|
2220
2639
|
// verify the required parameter 'body' is set
|
|
2221
2640
|
if (body === undefined || body === null) {
|
|
2222
2641
|
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesJobs';
|
|
@@ -2232,7 +2651,8 @@ class AnalyticsApi {
|
|
|
2232
2651
|
body,
|
|
2233
2652
|
['PureCloud OAuth'],
|
|
2234
2653
|
['application/json'],
|
|
2235
|
-
['application/json']
|
|
2654
|
+
['application/json'],
|
|
2655
|
+
opts['customHeaders']
|
|
2236
2656
|
);
|
|
2237
2657
|
}
|
|
2238
2658
|
|
|
@@ -2240,9 +2660,13 @@ class AnalyticsApi {
|
|
|
2240
2660
|
* Query for case management aggregates
|
|
2241
2661
|
*
|
|
2242
2662
|
* @param {Object} body query
|
|
2663
|
+
* @param {Object} opts Optional parameters
|
|
2664
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2243
2665
|
* postAnalyticsCasemanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2244
2666
|
*/
|
|
2245
|
-
postAnalyticsCasemanagementAggregatesQuery(body) {
|
|
2667
|
+
postAnalyticsCasemanagementAggregatesQuery(body, opts) {
|
|
2668
|
+
opts = opts || {};
|
|
2669
|
+
|
|
2246
2670
|
// verify the required parameter 'body' is set
|
|
2247
2671
|
if (body === undefined || body === null) {
|
|
2248
2672
|
throw 'Missing the required parameter "body" when calling postAnalyticsCasemanagementAggregatesQuery';
|
|
@@ -2258,7 +2682,8 @@ class AnalyticsApi {
|
|
|
2258
2682
|
body,
|
|
2259
2683
|
['PureCloud OAuth'],
|
|
2260
2684
|
['application/json'],
|
|
2261
|
-
['application/json']
|
|
2685
|
+
['application/json'],
|
|
2686
|
+
opts['customHeaders']
|
|
2262
2687
|
);
|
|
2263
2688
|
}
|
|
2264
2689
|
|
|
@@ -2267,8 +2692,12 @@ class AnalyticsApi {
|
|
|
2267
2692
|
*
|
|
2268
2693
|
* @param {String} conversationId conversationId
|
|
2269
2694
|
* @param {Object} body request
|
|
2695
|
+
* @param {Object} opts Optional parameters
|
|
2696
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2270
2697
|
*/
|
|
2271
|
-
postAnalyticsConversationDetailsProperties(conversationId, body) {
|
|
2698
|
+
postAnalyticsConversationDetailsProperties(conversationId, body, opts) {
|
|
2699
|
+
opts = opts || {};
|
|
2700
|
+
|
|
2272
2701
|
// verify the required parameter 'conversationId' is set
|
|
2273
2702
|
if (conversationId === undefined || conversationId === null || conversationId === '') {
|
|
2274
2703
|
throw 'Missing the required parameter "conversationId" when calling postAnalyticsConversationDetailsProperties';
|
|
@@ -2288,7 +2717,8 @@ class AnalyticsApi {
|
|
|
2288
2717
|
body,
|
|
2289
2718
|
['PureCloud OAuth'],
|
|
2290
2719
|
['application/json'],
|
|
2291
|
-
['application/json']
|
|
2720
|
+
['application/json'],
|
|
2721
|
+
opts['customHeaders']
|
|
2292
2722
|
);
|
|
2293
2723
|
}
|
|
2294
2724
|
|
|
@@ -2299,6 +2729,7 @@ class AnalyticsApi {
|
|
|
2299
2729
|
* @param {Object} opts Optional parameters
|
|
2300
2730
|
* @param {Number} opts.pageSize The desired page size
|
|
2301
2731
|
* @param {Number} opts.pageNumber The desired page number
|
|
2732
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2302
2733
|
*/
|
|
2303
2734
|
postAnalyticsConversationsActivityQuery(body, opts) {
|
|
2304
2735
|
opts = opts || {};
|
|
@@ -2318,7 +2749,8 @@ class AnalyticsApi {
|
|
|
2318
2749
|
body,
|
|
2319
2750
|
['PureCloud OAuth'],
|
|
2320
2751
|
['application/json'],
|
|
2321
|
-
['application/json']
|
|
2752
|
+
['application/json'],
|
|
2753
|
+
opts['customHeaders']
|
|
2322
2754
|
);
|
|
2323
2755
|
}
|
|
2324
2756
|
|
|
@@ -2326,9 +2758,13 @@ class AnalyticsApi {
|
|
|
2326
2758
|
* Query for conversation aggregates asynchronously
|
|
2327
2759
|
*
|
|
2328
2760
|
* @param {Object} body query
|
|
2761
|
+
* @param {Object} opts Optional parameters
|
|
2762
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2329
2763
|
* postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2330
2764
|
*/
|
|
2331
|
-
postAnalyticsConversationsAggregatesJobs(body) {
|
|
2765
|
+
postAnalyticsConversationsAggregatesJobs(body, opts) {
|
|
2766
|
+
opts = opts || {};
|
|
2767
|
+
|
|
2332
2768
|
// verify the required parameter 'body' is set
|
|
2333
2769
|
if (body === undefined || body === null) {
|
|
2334
2770
|
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';
|
|
@@ -2344,7 +2780,8 @@ class AnalyticsApi {
|
|
|
2344
2780
|
body,
|
|
2345
2781
|
['PureCloud OAuth'],
|
|
2346
2782
|
['application/json'],
|
|
2347
|
-
['application/json']
|
|
2783
|
+
['application/json'],
|
|
2784
|
+
opts['customHeaders']
|
|
2348
2785
|
);
|
|
2349
2786
|
}
|
|
2350
2787
|
|
|
@@ -2352,8 +2789,12 @@ class AnalyticsApi {
|
|
|
2352
2789
|
* Query for conversation aggregates
|
|
2353
2790
|
*
|
|
2354
2791
|
* @param {Object} body query
|
|
2792
|
+
* @param {Object} opts Optional parameters
|
|
2793
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2355
2794
|
*/
|
|
2356
|
-
postAnalyticsConversationsAggregatesQuery(body) {
|
|
2795
|
+
postAnalyticsConversationsAggregatesQuery(body, opts) {
|
|
2796
|
+
opts = opts || {};
|
|
2797
|
+
|
|
2357
2798
|
// verify the required parameter 'body' is set
|
|
2358
2799
|
if (body === undefined || body === null) {
|
|
2359
2800
|
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesQuery';
|
|
@@ -2369,7 +2810,8 @@ class AnalyticsApi {
|
|
|
2369
2810
|
body,
|
|
2370
2811
|
['PureCloud OAuth'],
|
|
2371
2812
|
['application/json'],
|
|
2372
|
-
['application/json']
|
|
2813
|
+
['application/json'],
|
|
2814
|
+
opts['customHeaders']
|
|
2373
2815
|
);
|
|
2374
2816
|
}
|
|
2375
2817
|
|
|
@@ -2377,8 +2819,12 @@ class AnalyticsApi {
|
|
|
2377
2819
|
* Query for conversation details asynchronously
|
|
2378
2820
|
*
|
|
2379
2821
|
* @param {Object} body query
|
|
2822
|
+
* @param {Object} opts Optional parameters
|
|
2823
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2380
2824
|
*/
|
|
2381
|
-
postAnalyticsConversationsDetailsJobs(body) {
|
|
2825
|
+
postAnalyticsConversationsDetailsJobs(body, opts) {
|
|
2826
|
+
opts = opts || {};
|
|
2827
|
+
|
|
2382
2828
|
// verify the required parameter 'body' is set
|
|
2383
2829
|
if (body === undefined || body === null) {
|
|
2384
2830
|
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsJobs';
|
|
@@ -2394,7 +2840,8 @@ class AnalyticsApi {
|
|
|
2394
2840
|
body,
|
|
2395
2841
|
['PureCloud OAuth'],
|
|
2396
2842
|
['application/json'],
|
|
2397
|
-
['application/json']
|
|
2843
|
+
['application/json'],
|
|
2844
|
+
opts['customHeaders']
|
|
2398
2845
|
);
|
|
2399
2846
|
}
|
|
2400
2847
|
|
|
@@ -2402,8 +2849,12 @@ class AnalyticsApi {
|
|
|
2402
2849
|
* Query for conversation details
|
|
2403
2850
|
*
|
|
2404
2851
|
* @param {Object} body query
|
|
2852
|
+
* @param {Object} opts Optional parameters
|
|
2853
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2405
2854
|
*/
|
|
2406
|
-
postAnalyticsConversationsDetailsQuery(body) {
|
|
2855
|
+
postAnalyticsConversationsDetailsQuery(body, opts) {
|
|
2856
|
+
opts = opts || {};
|
|
2857
|
+
|
|
2407
2858
|
// verify the required parameter 'body' is set
|
|
2408
2859
|
if (body === undefined || body === null) {
|
|
2409
2860
|
throw 'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsQuery';
|
|
@@ -2419,7 +2870,70 @@ class AnalyticsApi {
|
|
|
2419
2870
|
body,
|
|
2420
2871
|
['PureCloud OAuth'],
|
|
2421
2872
|
['application/json'],
|
|
2422
|
-
['application/json']
|
|
2873
|
+
['application/json'],
|
|
2874
|
+
opts['customHeaders']
|
|
2875
|
+
);
|
|
2876
|
+
}
|
|
2877
|
+
|
|
2878
|
+
/**
|
|
2879
|
+
* Query for copilot aggregates asynchronously
|
|
2880
|
+
*
|
|
2881
|
+
* @param {Object} body query
|
|
2882
|
+
* @param {Object} opts Optional parameters
|
|
2883
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2884
|
+
* postAnalyticsCopilotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2885
|
+
*/
|
|
2886
|
+
postAnalyticsCopilotsAggregatesJobs(body, opts) {
|
|
2887
|
+
opts = opts || {};
|
|
2888
|
+
|
|
2889
|
+
// verify the required parameter 'body' is set
|
|
2890
|
+
if (body === undefined || body === null) {
|
|
2891
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesJobs';
|
|
2892
|
+
}
|
|
2893
|
+
|
|
2894
|
+
return this.apiClient.callApi(
|
|
2895
|
+
'/api/v2/analytics/copilots/aggregates/jobs',
|
|
2896
|
+
'POST',
|
|
2897
|
+
{ },
|
|
2898
|
+
{ },
|
|
2899
|
+
{ },
|
|
2900
|
+
{ },
|
|
2901
|
+
body,
|
|
2902
|
+
['PureCloud OAuth'],
|
|
2903
|
+
['application/json'],
|
|
2904
|
+
['application/json'],
|
|
2905
|
+
opts['customHeaders']
|
|
2906
|
+
);
|
|
2907
|
+
}
|
|
2908
|
+
|
|
2909
|
+
/**
|
|
2910
|
+
* Query for copilot aggregates
|
|
2911
|
+
*
|
|
2912
|
+
* @param {Object} body query
|
|
2913
|
+
* @param {Object} opts Optional parameters
|
|
2914
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2915
|
+
* postAnalyticsCopilotsAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2916
|
+
*/
|
|
2917
|
+
postAnalyticsCopilotsAggregatesQuery(body, opts) {
|
|
2918
|
+
opts = opts || {};
|
|
2919
|
+
|
|
2920
|
+
// verify the required parameter 'body' is set
|
|
2921
|
+
if (body === undefined || body === null) {
|
|
2922
|
+
throw 'Missing the required parameter "body" when calling postAnalyticsCopilotsAggregatesQuery';
|
|
2923
|
+
}
|
|
2924
|
+
|
|
2925
|
+
return this.apiClient.callApi(
|
|
2926
|
+
'/api/v2/analytics/copilots/aggregates/query',
|
|
2927
|
+
'POST',
|
|
2928
|
+
{ },
|
|
2929
|
+
{ },
|
|
2930
|
+
{ },
|
|
2931
|
+
{ },
|
|
2932
|
+
body,
|
|
2933
|
+
['PureCloud OAuth'],
|
|
2934
|
+
['application/json'],
|
|
2935
|
+
['application/json'],
|
|
2936
|
+
opts['customHeaders']
|
|
2423
2937
|
);
|
|
2424
2938
|
}
|
|
2425
2939
|
|
|
@@ -2427,9 +2941,13 @@ class AnalyticsApi {
|
|
|
2427
2941
|
* Get download URLs for analytics data warehouse files
|
|
2428
2942
|
*
|
|
2429
2943
|
* @param {Object} body request
|
|
2944
|
+
* @param {Object} opts Optional parameters
|
|
2945
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2430
2946
|
* postAnalyticsDataextractionDownloadsBulk is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2431
2947
|
*/
|
|
2432
|
-
postAnalyticsDataextractionDownloadsBulk(body) {
|
|
2948
|
+
postAnalyticsDataextractionDownloadsBulk(body, opts) {
|
|
2949
|
+
opts = opts || {};
|
|
2950
|
+
|
|
2433
2951
|
// verify the required parameter 'body' is set
|
|
2434
2952
|
if (body === undefined || body === null) {
|
|
2435
2953
|
throw 'Missing the required parameter "body" when calling postAnalyticsDataextractionDownloadsBulk';
|
|
@@ -2445,7 +2963,8 @@ class AnalyticsApi {
|
|
|
2445
2963
|
body,
|
|
2446
2964
|
['PureCloud OAuth'],
|
|
2447
2965
|
['application/json'],
|
|
2448
|
-
['application/json']
|
|
2966
|
+
['application/json'],
|
|
2967
|
+
opts['customHeaders']
|
|
2449
2968
|
);
|
|
2450
2969
|
}
|
|
2451
2970
|
|
|
@@ -2453,9 +2972,13 @@ class AnalyticsApi {
|
|
|
2453
2972
|
* Query for evaluation aggregates asynchronously
|
|
2454
2973
|
*
|
|
2455
2974
|
* @param {Object} body query
|
|
2975
|
+
* @param {Object} opts Optional parameters
|
|
2976
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2456
2977
|
* postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2457
2978
|
*/
|
|
2458
|
-
postAnalyticsEvaluationsAggregatesJobs(body) {
|
|
2979
|
+
postAnalyticsEvaluationsAggregatesJobs(body, opts) {
|
|
2980
|
+
opts = opts || {};
|
|
2981
|
+
|
|
2459
2982
|
// verify the required parameter 'body' is set
|
|
2460
2983
|
if (body === undefined || body === null) {
|
|
2461
2984
|
throw 'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';
|
|
@@ -2471,7 +2994,8 @@ class AnalyticsApi {
|
|
|
2471
2994
|
body,
|
|
2472
2995
|
['PureCloud OAuth'],
|
|
2473
2996
|
['application/json'],
|
|
2474
|
-
['application/json']
|
|
2997
|
+
['application/json'],
|
|
2998
|
+
opts['customHeaders']
|
|
2475
2999
|
);
|
|
2476
3000
|
}
|
|
2477
3001
|
|
|
@@ -2479,8 +3003,12 @@ class AnalyticsApi {
|
|
|
2479
3003
|
* Query for evaluation aggregates
|
|
2480
3004
|
*
|
|
2481
3005
|
* @param {Object} body query
|
|
3006
|
+
* @param {Object} opts Optional parameters
|
|
3007
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2482
3008
|
*/
|
|
2483
|
-
postAnalyticsEvaluationsAggregatesQuery(body) {
|
|
3009
|
+
postAnalyticsEvaluationsAggregatesQuery(body, opts) {
|
|
3010
|
+
opts = opts || {};
|
|
3011
|
+
|
|
2484
3012
|
// verify the required parameter 'body' is set
|
|
2485
3013
|
if (body === undefined || body === null) {
|
|
2486
3014
|
throw 'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';
|
|
@@ -2496,7 +3024,8 @@ class AnalyticsApi {
|
|
|
2496
3024
|
body,
|
|
2497
3025
|
['PureCloud OAuth'],
|
|
2498
3026
|
['application/json'],
|
|
2499
|
-
['application/json']
|
|
3027
|
+
['application/json'],
|
|
3028
|
+
opts['customHeaders']
|
|
2500
3029
|
);
|
|
2501
3030
|
}
|
|
2502
3031
|
|
|
@@ -2504,9 +3033,13 @@ class AnalyticsApi {
|
|
|
2504
3033
|
* Query for flow execution aggregates asynchronously
|
|
2505
3034
|
*
|
|
2506
3035
|
* @param {Object} body query
|
|
3036
|
+
* @param {Object} opts Optional parameters
|
|
3037
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2507
3038
|
* postAnalyticsFlowexecutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2508
3039
|
*/
|
|
2509
|
-
postAnalyticsFlowexecutionsAggregatesJobs(body) {
|
|
3040
|
+
postAnalyticsFlowexecutionsAggregatesJobs(body, opts) {
|
|
3041
|
+
opts = opts || {};
|
|
3042
|
+
|
|
2510
3043
|
// verify the required parameter 'body' is set
|
|
2511
3044
|
if (body === undefined || body === null) {
|
|
2512
3045
|
throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesJobs';
|
|
@@ -2522,7 +3055,8 @@ class AnalyticsApi {
|
|
|
2522
3055
|
body,
|
|
2523
3056
|
['PureCloud OAuth'],
|
|
2524
3057
|
['application/json'],
|
|
2525
|
-
['application/json']
|
|
3058
|
+
['application/json'],
|
|
3059
|
+
opts['customHeaders']
|
|
2526
3060
|
);
|
|
2527
3061
|
}
|
|
2528
3062
|
|
|
@@ -2530,8 +3064,12 @@ class AnalyticsApi {
|
|
|
2530
3064
|
* Query for flow execution aggregates
|
|
2531
3065
|
*
|
|
2532
3066
|
* @param {Object} body query
|
|
3067
|
+
* @param {Object} opts Optional parameters
|
|
3068
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2533
3069
|
*/
|
|
2534
|
-
postAnalyticsFlowexecutionsAggregatesQuery(body) {
|
|
3070
|
+
postAnalyticsFlowexecutionsAggregatesQuery(body, opts) {
|
|
3071
|
+
opts = opts || {};
|
|
3072
|
+
|
|
2535
3073
|
// verify the required parameter 'body' is set
|
|
2536
3074
|
if (body === undefined || body === null) {
|
|
2537
3075
|
throw 'Missing the required parameter "body" when calling postAnalyticsFlowexecutionsAggregatesQuery';
|
|
@@ -2547,7 +3085,8 @@ class AnalyticsApi {
|
|
|
2547
3085
|
body,
|
|
2548
3086
|
['PureCloud OAuth'],
|
|
2549
3087
|
['application/json'],
|
|
2550
|
-
['application/json']
|
|
3088
|
+
['application/json'],
|
|
3089
|
+
opts['customHeaders']
|
|
2551
3090
|
);
|
|
2552
3091
|
}
|
|
2553
3092
|
|
|
@@ -2558,6 +3097,7 @@ class AnalyticsApi {
|
|
|
2558
3097
|
* @param {Object} opts Optional parameters
|
|
2559
3098
|
* @param {Number} opts.pageSize The desired page size
|
|
2560
3099
|
* @param {Number} opts.pageNumber The desired page number
|
|
3100
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2561
3101
|
*/
|
|
2562
3102
|
postAnalyticsFlowsActivityQuery(body, opts) {
|
|
2563
3103
|
opts = opts || {};
|
|
@@ -2577,7 +3117,8 @@ class AnalyticsApi {
|
|
|
2577
3117
|
body,
|
|
2578
3118
|
['PureCloud OAuth'],
|
|
2579
3119
|
['application/json'],
|
|
2580
|
-
['application/json']
|
|
3120
|
+
['application/json'],
|
|
3121
|
+
opts['customHeaders']
|
|
2581
3122
|
);
|
|
2582
3123
|
}
|
|
2583
3124
|
|
|
@@ -2585,9 +3126,13 @@ class AnalyticsApi {
|
|
|
2585
3126
|
* Query for flow aggregates asynchronously
|
|
2586
3127
|
*
|
|
2587
3128
|
* @param {Object} body query
|
|
3129
|
+
* @param {Object} opts Optional parameters
|
|
3130
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2588
3131
|
* postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2589
3132
|
*/
|
|
2590
|
-
postAnalyticsFlowsAggregatesJobs(body) {
|
|
3133
|
+
postAnalyticsFlowsAggregatesJobs(body, opts) {
|
|
3134
|
+
opts = opts || {};
|
|
3135
|
+
|
|
2591
3136
|
// verify the required parameter 'body' is set
|
|
2592
3137
|
if (body === undefined || body === null) {
|
|
2593
3138
|
throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';
|
|
@@ -2603,7 +3148,8 @@ class AnalyticsApi {
|
|
|
2603
3148
|
body,
|
|
2604
3149
|
['PureCloud OAuth'],
|
|
2605
3150
|
['application/json'],
|
|
2606
|
-
['application/json']
|
|
3151
|
+
['application/json'],
|
|
3152
|
+
opts['customHeaders']
|
|
2607
3153
|
);
|
|
2608
3154
|
}
|
|
2609
3155
|
|
|
@@ -2611,8 +3157,12 @@ class AnalyticsApi {
|
|
|
2611
3157
|
* Query for flow aggregates
|
|
2612
3158
|
*
|
|
2613
3159
|
* @param {Object} body query
|
|
3160
|
+
* @param {Object} opts Optional parameters
|
|
3161
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2614
3162
|
*/
|
|
2615
|
-
postAnalyticsFlowsAggregatesQuery(body) {
|
|
3163
|
+
postAnalyticsFlowsAggregatesQuery(body, opts) {
|
|
3164
|
+
opts = opts || {};
|
|
3165
|
+
|
|
2616
3166
|
// verify the required parameter 'body' is set
|
|
2617
3167
|
if (body === undefined || body === null) {
|
|
2618
3168
|
throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';
|
|
@@ -2628,7 +3178,8 @@ class AnalyticsApi {
|
|
|
2628
3178
|
body,
|
|
2629
3179
|
['PureCloud OAuth'],
|
|
2630
3180
|
['application/json'],
|
|
2631
|
-
['application/json']
|
|
3181
|
+
['application/json'],
|
|
3182
|
+
opts['customHeaders']
|
|
2632
3183
|
);
|
|
2633
3184
|
}
|
|
2634
3185
|
|
|
@@ -2636,8 +3187,12 @@ class AnalyticsApi {
|
|
|
2636
3187
|
* Query for flow observations
|
|
2637
3188
|
*
|
|
2638
3189
|
* @param {Object} body query
|
|
3190
|
+
* @param {Object} opts Optional parameters
|
|
3191
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2639
3192
|
*/
|
|
2640
|
-
postAnalyticsFlowsObservationsQuery(body) {
|
|
3193
|
+
postAnalyticsFlowsObservationsQuery(body, opts) {
|
|
3194
|
+
opts = opts || {};
|
|
3195
|
+
|
|
2641
3196
|
// verify the required parameter 'body' is set
|
|
2642
3197
|
if (body === undefined || body === null) {
|
|
2643
3198
|
throw 'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';
|
|
@@ -2653,7 +3208,8 @@ class AnalyticsApi {
|
|
|
2653
3208
|
body,
|
|
2654
3209
|
['PureCloud OAuth'],
|
|
2655
3210
|
['application/json'],
|
|
2656
|
-
['application/json']
|
|
3211
|
+
['application/json'],
|
|
3212
|
+
opts['customHeaders']
|
|
2657
3213
|
);
|
|
2658
3214
|
}
|
|
2659
3215
|
|
|
@@ -2661,9 +3217,13 @@ class AnalyticsApi {
|
|
|
2661
3217
|
* Query for journey aggregates asynchronously
|
|
2662
3218
|
*
|
|
2663
3219
|
* @param {Object} body query
|
|
3220
|
+
* @param {Object} opts Optional parameters
|
|
3221
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2664
3222
|
* postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2665
3223
|
*/
|
|
2666
|
-
postAnalyticsJourneysAggregatesJobs(body) {
|
|
3224
|
+
postAnalyticsJourneysAggregatesJobs(body, opts) {
|
|
3225
|
+
opts = opts || {};
|
|
3226
|
+
|
|
2667
3227
|
// verify the required parameter 'body' is set
|
|
2668
3228
|
if (body === undefined || body === null) {
|
|
2669
3229
|
throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';
|
|
@@ -2679,7 +3239,8 @@ class AnalyticsApi {
|
|
|
2679
3239
|
body,
|
|
2680
3240
|
['PureCloud OAuth'],
|
|
2681
3241
|
['application/json'],
|
|
2682
|
-
['application/json']
|
|
3242
|
+
['application/json'],
|
|
3243
|
+
opts['customHeaders']
|
|
2683
3244
|
);
|
|
2684
3245
|
}
|
|
2685
3246
|
|
|
@@ -2687,8 +3248,12 @@ class AnalyticsApi {
|
|
|
2687
3248
|
* Query for journey aggregates
|
|
2688
3249
|
*
|
|
2689
3250
|
* @param {Object} body query
|
|
3251
|
+
* @param {Object} opts Optional parameters
|
|
3252
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2690
3253
|
*/
|
|
2691
|
-
postAnalyticsJourneysAggregatesQuery(body) {
|
|
3254
|
+
postAnalyticsJourneysAggregatesQuery(body, opts) {
|
|
3255
|
+
opts = opts || {};
|
|
3256
|
+
|
|
2692
3257
|
// verify the required parameter 'body' is set
|
|
2693
3258
|
if (body === undefined || body === null) {
|
|
2694
3259
|
throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';
|
|
@@ -2704,7 +3269,8 @@ class AnalyticsApi {
|
|
|
2704
3269
|
body,
|
|
2705
3270
|
['PureCloud OAuth'],
|
|
2706
3271
|
['application/json'],
|
|
2707
|
-
['application/json']
|
|
3272
|
+
['application/json'],
|
|
3273
|
+
opts['customHeaders']
|
|
2708
3274
|
);
|
|
2709
3275
|
}
|
|
2710
3276
|
|
|
@@ -2712,9 +3278,13 @@ class AnalyticsApi {
|
|
|
2712
3278
|
* Query for knowledge aggregates asynchronously
|
|
2713
3279
|
*
|
|
2714
3280
|
* @param {Object} body query
|
|
3281
|
+
* @param {Object} opts Optional parameters
|
|
3282
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2715
3283
|
* postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2716
3284
|
*/
|
|
2717
|
-
postAnalyticsKnowledgeAggregatesJobs(body) {
|
|
3285
|
+
postAnalyticsKnowledgeAggregatesJobs(body, opts) {
|
|
3286
|
+
opts = opts || {};
|
|
3287
|
+
|
|
2718
3288
|
// verify the required parameter 'body' is set
|
|
2719
3289
|
if (body === undefined || body === null) {
|
|
2720
3290
|
throw 'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesJobs';
|
|
@@ -2730,7 +3300,8 @@ class AnalyticsApi {
|
|
|
2730
3300
|
body,
|
|
2731
3301
|
['PureCloud OAuth'],
|
|
2732
3302
|
['application/json'],
|
|
2733
|
-
['application/json']
|
|
3303
|
+
['application/json'],
|
|
3304
|
+
opts['customHeaders']
|
|
2734
3305
|
);
|
|
2735
3306
|
}
|
|
2736
3307
|
|
|
@@ -2738,8 +3309,12 @@ class AnalyticsApi {
|
|
|
2738
3309
|
* Query for knowledge aggregates
|
|
2739
3310
|
*
|
|
2740
3311
|
* @param {Object} body query
|
|
3312
|
+
* @param {Object} opts Optional parameters
|
|
3313
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2741
3314
|
*/
|
|
2742
|
-
postAnalyticsKnowledgeAggregatesQuery(body) {
|
|
3315
|
+
postAnalyticsKnowledgeAggregatesQuery(body, opts) {
|
|
3316
|
+
opts = opts || {};
|
|
3317
|
+
|
|
2743
3318
|
// verify the required parameter 'body' is set
|
|
2744
3319
|
if (body === undefined || body === null) {
|
|
2745
3320
|
throw 'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesQuery';
|
|
@@ -2755,7 +3330,8 @@ class AnalyticsApi {
|
|
|
2755
3330
|
body,
|
|
2756
3331
|
['PureCloud OAuth'],
|
|
2757
3332
|
['application/json'],
|
|
2758
|
-
['application/json']
|
|
3333
|
+
['application/json'],
|
|
3334
|
+
opts['customHeaders']
|
|
2759
3335
|
);
|
|
2760
3336
|
}
|
|
2761
3337
|
|
|
@@ -2763,8 +3339,12 @@ class AnalyticsApi {
|
|
|
2763
3339
|
* Query for queue observations
|
|
2764
3340
|
*
|
|
2765
3341
|
* @param {Object} body query
|
|
3342
|
+
* @param {Object} opts Optional parameters
|
|
3343
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2766
3344
|
*/
|
|
2767
|
-
postAnalyticsQueuesObservationsQuery(body) {
|
|
3345
|
+
postAnalyticsQueuesObservationsQuery(body, opts) {
|
|
3346
|
+
opts = opts || {};
|
|
3347
|
+
|
|
2768
3348
|
// verify the required parameter 'body' is set
|
|
2769
3349
|
if (body === undefined || body === null) {
|
|
2770
3350
|
throw 'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';
|
|
@@ -2780,7 +3360,8 @@ class AnalyticsApi {
|
|
|
2780
3360
|
body,
|
|
2781
3361
|
['PureCloud OAuth'],
|
|
2782
3362
|
['application/json'],
|
|
2783
|
-
['application/json']
|
|
3363
|
+
['application/json'],
|
|
3364
|
+
opts['customHeaders']
|
|
2784
3365
|
);
|
|
2785
3366
|
}
|
|
2786
3367
|
|
|
@@ -2788,8 +3369,12 @@ class AnalyticsApi {
|
|
|
2788
3369
|
* Query for limits rate limit aggregates. Data populated when limits reach 90% of the maximum. Not a source of truth for limits hit but a best effort estimate.
|
|
2789
3370
|
* The max property can be used to determine estimated rate limit value hit. See https://developer.genesys.cloud/organization/organization/limits#available-limits for limits that are trackable (Operational Events Enabled).
|
|
2790
3371
|
* @param {Object} body query
|
|
3372
|
+
* @param {Object} opts Optional parameters
|
|
3373
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2791
3374
|
*/
|
|
2792
|
-
postAnalyticsRatelimitsAggregatesQuery(body) {
|
|
3375
|
+
postAnalyticsRatelimitsAggregatesQuery(body, opts) {
|
|
3376
|
+
opts = opts || {};
|
|
3377
|
+
|
|
2793
3378
|
// verify the required parameter 'body' is set
|
|
2794
3379
|
if (body === undefined || body === null) {
|
|
2795
3380
|
throw 'Missing the required parameter "body" when calling postAnalyticsRatelimitsAggregatesQuery';
|
|
@@ -2805,7 +3390,8 @@ class AnalyticsApi {
|
|
|
2805
3390
|
body,
|
|
2806
3391
|
['PureCloud OAuth'],
|
|
2807
3392
|
['application/json'],
|
|
2808
|
-
['application/json']
|
|
3393
|
+
['application/json'],
|
|
3394
|
+
opts['customHeaders']
|
|
2809
3395
|
);
|
|
2810
3396
|
}
|
|
2811
3397
|
|
|
@@ -2813,8 +3399,12 @@ class AnalyticsApi {
|
|
|
2813
3399
|
* Bulk soft delete dashboards owned by other user(s)
|
|
2814
3400
|
*
|
|
2815
3401
|
* @param {Array.<String>} body List of userIds
|
|
3402
|
+
* @param {Object} opts Optional parameters
|
|
3403
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2816
3404
|
*/
|
|
2817
|
-
postAnalyticsReportingDashboardsUsersBulkRemove(body) {
|
|
3405
|
+
postAnalyticsReportingDashboardsUsersBulkRemove(body, opts) {
|
|
3406
|
+
opts = opts || {};
|
|
3407
|
+
|
|
2818
3408
|
// verify the required parameter 'body' is set
|
|
2819
3409
|
if (body === undefined || body === null) {
|
|
2820
3410
|
throw 'Missing the required parameter "body" when calling postAnalyticsReportingDashboardsUsersBulkRemove';
|
|
@@ -2830,7 +3420,8 @@ class AnalyticsApi {
|
|
|
2830
3420
|
body,
|
|
2831
3421
|
['PureCloud OAuth'],
|
|
2832
3422
|
['application/json'],
|
|
2833
|
-
['application/json']
|
|
3423
|
+
['application/json'],
|
|
3424
|
+
opts['customHeaders']
|
|
2834
3425
|
);
|
|
2835
3426
|
}
|
|
2836
3427
|
|
|
@@ -2838,8 +3429,12 @@ class AnalyticsApi {
|
|
|
2838
3429
|
* Generate a view export request
|
|
2839
3430
|
* This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
|
|
2840
3431
|
* @param {Object} body ReportingExportJobRequest
|
|
3432
|
+
* @param {Object} opts Optional parameters
|
|
3433
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2841
3434
|
*/
|
|
2842
|
-
postAnalyticsReportingExports(body) {
|
|
3435
|
+
postAnalyticsReportingExports(body, opts) {
|
|
3436
|
+
opts = opts || {};
|
|
3437
|
+
|
|
2843
3438
|
// verify the required parameter 'body' is set
|
|
2844
3439
|
if (body === undefined || body === null) {
|
|
2845
3440
|
throw 'Missing the required parameter "body" when calling postAnalyticsReportingExports';
|
|
@@ -2855,7 +3450,8 @@ class AnalyticsApi {
|
|
|
2855
3450
|
body,
|
|
2856
3451
|
['PureCloud OAuth'],
|
|
2857
3452
|
['application/json'],
|
|
2858
|
-
['application/json']
|
|
3453
|
+
['application/json'],
|
|
3454
|
+
opts['customHeaders']
|
|
2859
3455
|
);
|
|
2860
3456
|
}
|
|
2861
3457
|
|
|
@@ -2863,8 +3459,12 @@ class AnalyticsApi {
|
|
|
2863
3459
|
* Bulk soft delete dashboard configurations
|
|
2864
3460
|
*
|
|
2865
3461
|
* @param {Object} body
|
|
3462
|
+
* @param {Object} opts Optional parameters
|
|
3463
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2866
3464
|
*/
|
|
2867
|
-
postAnalyticsReportingSettingsDashboardsBulkRemove(body) {
|
|
3465
|
+
postAnalyticsReportingSettingsDashboardsBulkRemove(body, opts) {
|
|
3466
|
+
opts = opts || {};
|
|
3467
|
+
|
|
2868
3468
|
// verify the required parameter 'body' is set
|
|
2869
3469
|
if (body === undefined || body === null) {
|
|
2870
3470
|
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsBulkRemove';
|
|
@@ -2880,7 +3480,8 @@ class AnalyticsApi {
|
|
|
2880
3480
|
body,
|
|
2881
3481
|
['PureCloud OAuth'],
|
|
2882
3482
|
['application/json'],
|
|
2883
|
-
['application/json']
|
|
3483
|
+
['application/json'],
|
|
3484
|
+
opts['customHeaders']
|
|
2884
3485
|
);
|
|
2885
3486
|
}
|
|
2886
3487
|
|
|
@@ -2888,8 +3489,12 @@ class AnalyticsApi {
|
|
|
2888
3489
|
* Query dashboard configurations
|
|
2889
3490
|
*
|
|
2890
3491
|
* @param {Object} body
|
|
3492
|
+
* @param {Object} opts Optional parameters
|
|
3493
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2891
3494
|
*/
|
|
2892
|
-
postAnalyticsReportingSettingsDashboardsQuery(body) {
|
|
3495
|
+
postAnalyticsReportingSettingsDashboardsQuery(body, opts) {
|
|
3496
|
+
opts = opts || {};
|
|
3497
|
+
|
|
2893
3498
|
// verify the required parameter 'body' is set
|
|
2894
3499
|
if (body === undefined || body === null) {
|
|
2895
3500
|
throw 'Missing the required parameter "body" when calling postAnalyticsReportingSettingsDashboardsQuery';
|
|
@@ -2905,7 +3510,8 @@ class AnalyticsApi {
|
|
|
2905
3510
|
body,
|
|
2906
3511
|
['PureCloud OAuth'],
|
|
2907
3512
|
['application/json'],
|
|
2908
|
-
['application/json']
|
|
3513
|
+
['application/json'],
|
|
3514
|
+
opts['customHeaders']
|
|
2909
3515
|
);
|
|
2910
3516
|
}
|
|
2911
3517
|
|
|
@@ -2913,9 +3519,13 @@ class AnalyticsApi {
|
|
|
2913
3519
|
* Query for resolution aggregates asynchronously
|
|
2914
3520
|
*
|
|
2915
3521
|
* @param {Object} body query
|
|
3522
|
+
* @param {Object} opts Optional parameters
|
|
3523
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2916
3524
|
* postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2917
3525
|
*/
|
|
2918
|
-
postAnalyticsResolutionsAggregatesJobs(body) {
|
|
3526
|
+
postAnalyticsResolutionsAggregatesJobs(body, opts) {
|
|
3527
|
+
opts = opts || {};
|
|
3528
|
+
|
|
2919
3529
|
// verify the required parameter 'body' is set
|
|
2920
3530
|
if (body === undefined || body === null) {
|
|
2921
3531
|
throw 'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesJobs';
|
|
@@ -2931,7 +3541,8 @@ class AnalyticsApi {
|
|
|
2931
3541
|
body,
|
|
2932
3542
|
['PureCloud OAuth'],
|
|
2933
3543
|
['application/json'],
|
|
2934
|
-
['application/json']
|
|
3544
|
+
['application/json'],
|
|
3545
|
+
opts['customHeaders']
|
|
2935
3546
|
);
|
|
2936
3547
|
}
|
|
2937
3548
|
|
|
@@ -2939,8 +3550,12 @@ class AnalyticsApi {
|
|
|
2939
3550
|
* Query for resolution aggregates
|
|
2940
3551
|
*
|
|
2941
3552
|
* @param {Object} body query
|
|
3553
|
+
* @param {Object} opts Optional parameters
|
|
3554
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2942
3555
|
*/
|
|
2943
|
-
postAnalyticsResolutionsAggregatesQuery(body) {
|
|
3556
|
+
postAnalyticsResolutionsAggregatesQuery(body, opts) {
|
|
3557
|
+
opts = opts || {};
|
|
3558
|
+
|
|
2944
3559
|
// verify the required parameter 'body' is set
|
|
2945
3560
|
if (body === undefined || body === null) {
|
|
2946
3561
|
throw 'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesQuery';
|
|
@@ -2956,7 +3571,8 @@ class AnalyticsApi {
|
|
|
2956
3571
|
body,
|
|
2957
3572
|
['PureCloud OAuth'],
|
|
2958
3573
|
['application/json'],
|
|
2959
|
-
['application/json']
|
|
3574
|
+
['application/json'],
|
|
3575
|
+
opts['customHeaders']
|
|
2960
3576
|
);
|
|
2961
3577
|
}
|
|
2962
3578
|
|
|
@@ -2967,6 +3583,7 @@ class AnalyticsApi {
|
|
|
2967
3583
|
* @param {Object} opts Optional parameters
|
|
2968
3584
|
* @param {Number} opts.pageSize The desired page size
|
|
2969
3585
|
* @param {Number} opts.pageNumber The desired page number
|
|
3586
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2970
3587
|
*/
|
|
2971
3588
|
postAnalyticsRoutingActivityQuery(body, opts) {
|
|
2972
3589
|
opts = opts || {};
|
|
@@ -2986,7 +3603,8 @@ class AnalyticsApi {
|
|
|
2986
3603
|
body,
|
|
2987
3604
|
['PureCloud OAuth'],
|
|
2988
3605
|
['application/json'],
|
|
2989
|
-
['application/json']
|
|
3606
|
+
['application/json'],
|
|
3607
|
+
opts['customHeaders']
|
|
2990
3608
|
);
|
|
2991
3609
|
}
|
|
2992
3610
|
|
|
@@ -2994,9 +3612,13 @@ class AnalyticsApi {
|
|
|
2994
3612
|
* Query for summary aggregates asynchronously
|
|
2995
3613
|
*
|
|
2996
3614
|
* @param {Object} body query
|
|
3615
|
+
* @param {Object} opts Optional parameters
|
|
3616
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
2997
3617
|
* postAnalyticsSummariesAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
2998
3618
|
*/
|
|
2999
|
-
postAnalyticsSummariesAggregatesJobs(body) {
|
|
3619
|
+
postAnalyticsSummariesAggregatesJobs(body, opts) {
|
|
3620
|
+
opts = opts || {};
|
|
3621
|
+
|
|
3000
3622
|
// verify the required parameter 'body' is set
|
|
3001
3623
|
if (body === undefined || body === null) {
|
|
3002
3624
|
throw 'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesJobs';
|
|
@@ -3012,7 +3634,8 @@ class AnalyticsApi {
|
|
|
3012
3634
|
body,
|
|
3013
3635
|
['PureCloud OAuth'],
|
|
3014
3636
|
['application/json'],
|
|
3015
|
-
['application/json']
|
|
3637
|
+
['application/json'],
|
|
3638
|
+
opts['customHeaders']
|
|
3016
3639
|
);
|
|
3017
3640
|
}
|
|
3018
3641
|
|
|
@@ -3020,8 +3643,12 @@ class AnalyticsApi {
|
|
|
3020
3643
|
* Query for summary aggregates
|
|
3021
3644
|
*
|
|
3022
3645
|
* @param {Object} body query
|
|
3646
|
+
* @param {Object} opts Optional parameters
|
|
3647
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3023
3648
|
*/
|
|
3024
|
-
postAnalyticsSummariesAggregatesQuery(body) {
|
|
3649
|
+
postAnalyticsSummariesAggregatesQuery(body, opts) {
|
|
3650
|
+
opts = opts || {};
|
|
3651
|
+
|
|
3025
3652
|
// verify the required parameter 'body' is set
|
|
3026
3653
|
if (body === undefined || body === null) {
|
|
3027
3654
|
throw 'Missing the required parameter "body" when calling postAnalyticsSummariesAggregatesQuery';
|
|
@@ -3037,7 +3664,8 @@ class AnalyticsApi {
|
|
|
3037
3664
|
body,
|
|
3038
3665
|
['PureCloud OAuth'],
|
|
3039
3666
|
['application/json'],
|
|
3040
|
-
['application/json']
|
|
3667
|
+
['application/json'],
|
|
3668
|
+
opts['customHeaders']
|
|
3041
3669
|
);
|
|
3042
3670
|
}
|
|
3043
3671
|
|
|
@@ -3045,9 +3673,13 @@ class AnalyticsApi {
|
|
|
3045
3673
|
* Query for survey aggregates asynchronously
|
|
3046
3674
|
*
|
|
3047
3675
|
* @param {Object} body query
|
|
3676
|
+
* @param {Object} opts Optional parameters
|
|
3677
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3048
3678
|
* postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3049
3679
|
*/
|
|
3050
|
-
postAnalyticsSurveysAggregatesJobs(body) {
|
|
3680
|
+
postAnalyticsSurveysAggregatesJobs(body, opts) {
|
|
3681
|
+
opts = opts || {};
|
|
3682
|
+
|
|
3051
3683
|
// verify the required parameter 'body' is set
|
|
3052
3684
|
if (body === undefined || body === null) {
|
|
3053
3685
|
throw 'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';
|
|
@@ -3063,7 +3695,8 @@ class AnalyticsApi {
|
|
|
3063
3695
|
body,
|
|
3064
3696
|
['PureCloud OAuth'],
|
|
3065
3697
|
['application/json'],
|
|
3066
|
-
['application/json']
|
|
3698
|
+
['application/json'],
|
|
3699
|
+
opts['customHeaders']
|
|
3067
3700
|
);
|
|
3068
3701
|
}
|
|
3069
3702
|
|
|
@@ -3071,8 +3704,12 @@ class AnalyticsApi {
|
|
|
3071
3704
|
* Query for survey aggregates
|
|
3072
3705
|
*
|
|
3073
3706
|
* @param {Object} body query
|
|
3707
|
+
* @param {Object} opts Optional parameters
|
|
3708
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3074
3709
|
*/
|
|
3075
|
-
postAnalyticsSurveysAggregatesQuery(body) {
|
|
3710
|
+
postAnalyticsSurveysAggregatesQuery(body, opts) {
|
|
3711
|
+
opts = opts || {};
|
|
3712
|
+
|
|
3076
3713
|
// verify the required parameter 'body' is set
|
|
3077
3714
|
if (body === undefined || body === null) {
|
|
3078
3715
|
throw 'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesQuery';
|
|
@@ -3088,7 +3725,8 @@ class AnalyticsApi {
|
|
|
3088
3725
|
body,
|
|
3089
3726
|
['PureCloud OAuth'],
|
|
3090
3727
|
['application/json'],
|
|
3091
|
-
['application/json']
|
|
3728
|
+
['application/json'],
|
|
3729
|
+
opts['customHeaders']
|
|
3092
3730
|
);
|
|
3093
3731
|
}
|
|
3094
3732
|
|
|
@@ -3096,9 +3734,13 @@ class AnalyticsApi {
|
|
|
3096
3734
|
* Query for task management aggregates asynchronously
|
|
3097
3735
|
*
|
|
3098
3736
|
* @param {Object} body query
|
|
3737
|
+
* @param {Object} opts Optional parameters
|
|
3738
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3099
3739
|
* postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3100
3740
|
*/
|
|
3101
|
-
postAnalyticsTaskmanagementAggregatesJobs(body) {
|
|
3741
|
+
postAnalyticsTaskmanagementAggregatesJobs(body, opts) {
|
|
3742
|
+
opts = opts || {};
|
|
3743
|
+
|
|
3102
3744
|
// verify the required parameter 'body' is set
|
|
3103
3745
|
if (body === undefined || body === null) {
|
|
3104
3746
|
throw 'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesJobs';
|
|
@@ -3114,7 +3756,8 @@ class AnalyticsApi {
|
|
|
3114
3756
|
body,
|
|
3115
3757
|
['PureCloud OAuth'],
|
|
3116
3758
|
['application/json'],
|
|
3117
|
-
['application/json']
|
|
3759
|
+
['application/json'],
|
|
3760
|
+
opts['customHeaders']
|
|
3118
3761
|
);
|
|
3119
3762
|
}
|
|
3120
3763
|
|
|
@@ -3122,8 +3765,12 @@ class AnalyticsApi {
|
|
|
3122
3765
|
* Query for task management aggregates
|
|
3123
3766
|
*
|
|
3124
3767
|
* @param {Object} body query
|
|
3768
|
+
* @param {Object} opts Optional parameters
|
|
3769
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3125
3770
|
*/
|
|
3126
|
-
postAnalyticsTaskmanagementAggregatesQuery(body) {
|
|
3771
|
+
postAnalyticsTaskmanagementAggregatesQuery(body, opts) {
|
|
3772
|
+
opts = opts || {};
|
|
3773
|
+
|
|
3127
3774
|
// verify the required parameter 'body' is set
|
|
3128
3775
|
if (body === undefined || body === null) {
|
|
3129
3776
|
throw 'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesQuery';
|
|
@@ -3139,7 +3786,8 @@ class AnalyticsApi {
|
|
|
3139
3786
|
body,
|
|
3140
3787
|
['PureCloud OAuth'],
|
|
3141
3788
|
['application/json'],
|
|
3142
|
-
['application/json']
|
|
3789
|
+
['application/json'],
|
|
3790
|
+
opts['customHeaders']
|
|
3143
3791
|
);
|
|
3144
3792
|
}
|
|
3145
3793
|
|
|
@@ -3150,7 +3798,7 @@ class AnalyticsApi {
|
|
|
3150
3798
|
* @param {Object} opts Optional parameters
|
|
3151
3799
|
* @param {String} opts.after The cursor that points to the end of the set of entities that has been returned. Used for pagination.
|
|
3152
3800
|
* @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200.
|
|
3153
|
-
*
|
|
3801
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3154
3802
|
*/
|
|
3155
3803
|
postAnalyticsTaskmanagementMetricsQuery(body, opts) {
|
|
3156
3804
|
opts = opts || {};
|
|
@@ -3170,7 +3818,8 @@ class AnalyticsApi {
|
|
|
3170
3818
|
body,
|
|
3171
3819
|
['PureCloud OAuth'],
|
|
3172
3820
|
['application/json'],
|
|
3173
|
-
['application/json']
|
|
3821
|
+
['application/json'],
|
|
3822
|
+
opts['customHeaders']
|
|
3174
3823
|
);
|
|
3175
3824
|
}
|
|
3176
3825
|
|
|
@@ -3181,6 +3830,7 @@ class AnalyticsApi {
|
|
|
3181
3830
|
* @param {Object} opts Optional parameters
|
|
3182
3831
|
* @param {Number} opts.pageSize The desired page size
|
|
3183
3832
|
* @param {Number} opts.pageNumber The desired page number
|
|
3833
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3184
3834
|
*/
|
|
3185
3835
|
postAnalyticsTeamsActivityQuery(body, opts) {
|
|
3186
3836
|
opts = opts || {};
|
|
@@ -3200,7 +3850,8 @@ class AnalyticsApi {
|
|
|
3200
3850
|
body,
|
|
3201
3851
|
['PureCloud OAuth'],
|
|
3202
3852
|
['application/json'],
|
|
3203
|
-
['application/json']
|
|
3853
|
+
['application/json'],
|
|
3854
|
+
opts['customHeaders']
|
|
3204
3855
|
);
|
|
3205
3856
|
}
|
|
3206
3857
|
|
|
@@ -3208,9 +3859,13 @@ class AnalyticsApi {
|
|
|
3208
3859
|
* Query for transcript aggregates asynchronously
|
|
3209
3860
|
*
|
|
3210
3861
|
* @param {Object} body query
|
|
3862
|
+
* @param {Object} opts Optional parameters
|
|
3863
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3211
3864
|
* postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3212
3865
|
*/
|
|
3213
|
-
postAnalyticsTranscriptsAggregatesJobs(body) {
|
|
3866
|
+
postAnalyticsTranscriptsAggregatesJobs(body, opts) {
|
|
3867
|
+
opts = opts || {};
|
|
3868
|
+
|
|
3214
3869
|
// verify the required parameter 'body' is set
|
|
3215
3870
|
if (body === undefined || body === null) {
|
|
3216
3871
|
throw 'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesJobs';
|
|
@@ -3226,7 +3881,8 @@ class AnalyticsApi {
|
|
|
3226
3881
|
body,
|
|
3227
3882
|
['PureCloud OAuth'],
|
|
3228
3883
|
['application/json'],
|
|
3229
|
-
['application/json']
|
|
3884
|
+
['application/json'],
|
|
3885
|
+
opts['customHeaders']
|
|
3230
3886
|
);
|
|
3231
3887
|
}
|
|
3232
3888
|
|
|
@@ -3234,8 +3890,12 @@ class AnalyticsApi {
|
|
|
3234
3890
|
* Query for transcript aggregates
|
|
3235
3891
|
*
|
|
3236
3892
|
* @param {Object} body query
|
|
3893
|
+
* @param {Object} opts Optional parameters
|
|
3894
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3237
3895
|
*/
|
|
3238
|
-
postAnalyticsTranscriptsAggregatesQuery(body) {
|
|
3896
|
+
postAnalyticsTranscriptsAggregatesQuery(body, opts) {
|
|
3897
|
+
opts = opts || {};
|
|
3898
|
+
|
|
3239
3899
|
// verify the required parameter 'body' is set
|
|
3240
3900
|
if (body === undefined || body === null) {
|
|
3241
3901
|
throw 'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesQuery';
|
|
@@ -3251,7 +3911,8 @@ class AnalyticsApi {
|
|
|
3251
3911
|
body,
|
|
3252
3912
|
['PureCloud OAuth'],
|
|
3253
3913
|
['application/json'],
|
|
3254
|
-
['application/json']
|
|
3914
|
+
['application/json'],
|
|
3915
|
+
opts['customHeaders']
|
|
3255
3916
|
);
|
|
3256
3917
|
}
|
|
3257
3918
|
|
|
@@ -3262,6 +3923,7 @@ class AnalyticsApi {
|
|
|
3262
3923
|
* @param {Object} opts Optional parameters
|
|
3263
3924
|
* @param {Number} opts.pageSize The desired page size
|
|
3264
3925
|
* @param {Number} opts.pageNumber The desired page number
|
|
3926
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3265
3927
|
*/
|
|
3266
3928
|
postAnalyticsUsersActivityQuery(body, opts) {
|
|
3267
3929
|
opts = opts || {};
|
|
@@ -3281,7 +3943,8 @@ class AnalyticsApi {
|
|
|
3281
3943
|
body,
|
|
3282
3944
|
['PureCloud OAuth'],
|
|
3283
3945
|
['application/json'],
|
|
3284
|
-
['application/json']
|
|
3946
|
+
['application/json'],
|
|
3947
|
+
opts['customHeaders']
|
|
3285
3948
|
);
|
|
3286
3949
|
}
|
|
3287
3950
|
|
|
@@ -3289,9 +3952,13 @@ class AnalyticsApi {
|
|
|
3289
3952
|
* Query for user aggregates asynchronously
|
|
3290
3953
|
*
|
|
3291
3954
|
* @param {Object} body query
|
|
3955
|
+
* @param {Object} opts Optional parameters
|
|
3956
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3292
3957
|
* postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
|
|
3293
3958
|
*/
|
|
3294
|
-
postAnalyticsUsersAggregatesJobs(body) {
|
|
3959
|
+
postAnalyticsUsersAggregatesJobs(body, opts) {
|
|
3960
|
+
opts = opts || {};
|
|
3961
|
+
|
|
3295
3962
|
// verify the required parameter 'body' is set
|
|
3296
3963
|
if (body === undefined || body === null) {
|
|
3297
3964
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';
|
|
@@ -3307,7 +3974,8 @@ class AnalyticsApi {
|
|
|
3307
3974
|
body,
|
|
3308
3975
|
['PureCloud OAuth'],
|
|
3309
3976
|
['application/json'],
|
|
3310
|
-
['application/json']
|
|
3977
|
+
['application/json'],
|
|
3978
|
+
opts['customHeaders']
|
|
3311
3979
|
);
|
|
3312
3980
|
}
|
|
3313
3981
|
|
|
@@ -3315,8 +3983,12 @@ class AnalyticsApi {
|
|
|
3315
3983
|
* Query for user aggregates
|
|
3316
3984
|
*
|
|
3317
3985
|
* @param {Object} body query
|
|
3986
|
+
* @param {Object} opts Optional parameters
|
|
3987
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3318
3988
|
*/
|
|
3319
|
-
postAnalyticsUsersAggregatesQuery(body) {
|
|
3989
|
+
postAnalyticsUsersAggregatesQuery(body, opts) {
|
|
3990
|
+
opts = opts || {};
|
|
3991
|
+
|
|
3320
3992
|
// verify the required parameter 'body' is set
|
|
3321
3993
|
if (body === undefined || body === null) {
|
|
3322
3994
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesQuery';
|
|
@@ -3332,7 +4004,8 @@ class AnalyticsApi {
|
|
|
3332
4004
|
body,
|
|
3333
4005
|
['PureCloud OAuth'],
|
|
3334
4006
|
['application/json'],
|
|
3335
|
-
['application/json']
|
|
4007
|
+
['application/json'],
|
|
4008
|
+
opts['customHeaders']
|
|
3336
4009
|
);
|
|
3337
4010
|
}
|
|
3338
4011
|
|
|
@@ -3340,8 +4013,12 @@ class AnalyticsApi {
|
|
|
3340
4013
|
* Query for user details asynchronously
|
|
3341
4014
|
*
|
|
3342
4015
|
* @param {Object} body query
|
|
4016
|
+
* @param {Object} opts Optional parameters
|
|
4017
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3343
4018
|
*/
|
|
3344
|
-
postAnalyticsUsersDetailsJobs(body) {
|
|
4019
|
+
postAnalyticsUsersDetailsJobs(body, opts) {
|
|
4020
|
+
opts = opts || {};
|
|
4021
|
+
|
|
3345
4022
|
// verify the required parameter 'body' is set
|
|
3346
4023
|
if (body === undefined || body === null) {
|
|
3347
4024
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersDetailsJobs';
|
|
@@ -3357,7 +4034,8 @@ class AnalyticsApi {
|
|
|
3357
4034
|
body,
|
|
3358
4035
|
['PureCloud OAuth'],
|
|
3359
4036
|
['application/json'],
|
|
3360
|
-
['application/json']
|
|
4037
|
+
['application/json'],
|
|
4038
|
+
opts['customHeaders']
|
|
3361
4039
|
);
|
|
3362
4040
|
}
|
|
3363
4041
|
|
|
@@ -3365,8 +4043,12 @@ class AnalyticsApi {
|
|
|
3365
4043
|
* Query for user details
|
|
3366
4044
|
*
|
|
3367
4045
|
* @param {Object} body query
|
|
4046
|
+
* @param {Object} opts Optional parameters
|
|
4047
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3368
4048
|
*/
|
|
3369
|
-
postAnalyticsUsersDetailsQuery(body) {
|
|
4049
|
+
postAnalyticsUsersDetailsQuery(body, opts) {
|
|
4050
|
+
opts = opts || {};
|
|
4051
|
+
|
|
3370
4052
|
// verify the required parameter 'body' is set
|
|
3371
4053
|
if (body === undefined || body === null) {
|
|
3372
4054
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersDetailsQuery';
|
|
@@ -3382,7 +4064,8 @@ class AnalyticsApi {
|
|
|
3382
4064
|
body,
|
|
3383
4065
|
['PureCloud OAuth'],
|
|
3384
4066
|
['application/json'],
|
|
3385
|
-
['application/json']
|
|
4067
|
+
['application/json'],
|
|
4068
|
+
opts['customHeaders']
|
|
3386
4069
|
);
|
|
3387
4070
|
}
|
|
3388
4071
|
|
|
@@ -3390,8 +4073,12 @@ class AnalyticsApi {
|
|
|
3390
4073
|
* Query for user observations
|
|
3391
4074
|
*
|
|
3392
4075
|
* @param {Object} body query
|
|
4076
|
+
* @param {Object} opts Optional parameters
|
|
4077
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3393
4078
|
*/
|
|
3394
|
-
postAnalyticsUsersObservationsQuery(body) {
|
|
4079
|
+
postAnalyticsUsersObservationsQuery(body, opts) {
|
|
4080
|
+
opts = opts || {};
|
|
4081
|
+
|
|
3395
4082
|
// verify the required parameter 'body' is set
|
|
3396
4083
|
if (body === undefined || body === null) {
|
|
3397
4084
|
throw 'Missing the required parameter "body" when calling postAnalyticsUsersObservationsQuery';
|
|
@@ -3407,7 +4094,8 @@ class AnalyticsApi {
|
|
|
3407
4094
|
body,
|
|
3408
4095
|
['PureCloud OAuth'],
|
|
3409
4096
|
['application/json'],
|
|
3410
|
-
['application/json']
|
|
4097
|
+
['application/json'],
|
|
4098
|
+
opts['customHeaders']
|
|
3411
4099
|
);
|
|
3412
4100
|
}
|
|
3413
4101
|
|
|
@@ -3415,8 +4103,12 @@ class AnalyticsApi {
|
|
|
3415
4103
|
* Update analytics data retention setting
|
|
3416
4104
|
*
|
|
3417
4105
|
* @param {Object} body retentionDays
|
|
4106
|
+
* @param {Object} opts Optional parameters
|
|
4107
|
+
* @param {Object.<string, string>} opts.customHeaders Per-request HTTP headers
|
|
3418
4108
|
*/
|
|
3419
|
-
putAnalyticsDataretentionSettings(body) {
|
|
4109
|
+
putAnalyticsDataretentionSettings(body, opts) {
|
|
4110
|
+
opts = opts || {};
|
|
4111
|
+
|
|
3420
4112
|
// verify the required parameter 'body' is set
|
|
3421
4113
|
if (body === undefined || body === null) {
|
|
3422
4114
|
throw 'Missing the required parameter "body" when calling putAnalyticsDataretentionSettings';
|
|
@@ -3432,7 +4124,8 @@ class AnalyticsApi {
|
|
|
3432
4124
|
body,
|
|
3433
4125
|
['PureCloud OAuth'],
|
|
3434
4126
|
['application/json'],
|
|
3435
|
-
['application/json']
|
|
4127
|
+
['application/json'],
|
|
4128
|
+
opts['customHeaders']
|
|
3436
4129
|
);
|
|
3437
4130
|
}
|
|
3438
4131
|
|