purecloud-platform-client-v2 169.0.0 → 170.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.
Files changed (80) hide show
  1. package/README.md +6 -4
  2. package/dist/node/purecloud-platform-client-v2.js +25367 -20288
  3. package/dist/web-amd/purecloud-platform-client-v2.js +25367 -20288
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +25367 -20288
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +25367 -20288
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +2519 -31
  9. package/package.json +1 -1
  10. package/src/purecloud-platform-client-v2/ApiClient.js +1 -1
  11. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1418 -227
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +142 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +3 -3
  16. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/ChatApi.js +4 -4
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +6 -4
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +526 -1
  22. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  23. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FlowsApi.js +114 -1
  28. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  29. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GroupsApi.js +114 -4
  33. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +363 -1
  36. package/src/purecloud-platform-client-v2/api/JourneyApi.js +224 -1
  37. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +200 -22
  38. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +5 -5
  40. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/MessagingApi.js +6 -6
  44. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +8 -8
  49. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +53 -1
  50. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  51. package/src/purecloud-platform-client-v2/api/PresenceApi.js +189 -1
  52. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/QualityApi.js +174 -10
  54. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/RoutingApi.js +199 -6
  57. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/SearchApi.js +80 -2
  60. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1286 -0
  64. package/src/purecloud-platform-client-v2/api/TeamsApi.js +32 -1
  65. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +34 -3
  67. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TokensApi.js +47 -1
  69. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsersApi.js +172 -7
  73. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/WebChatApi.js +6 -6
  76. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +6 -6
  80. package/src/purecloud-platform-client-v2/index.js +7 -1
@@ -5,7 +5,7 @@ class AnalyticsApi {
5
5
  /**
6
6
  * Analytics service.
7
7
  * @module purecloud-platform-client-v2/api/AnalyticsApi
8
- * @version 169.0.0
8
+ * @version 170.0.0
9
9
  */
10
10
 
11
11
  /**
@@ -95,6 +95,62 @@ class AnalyticsApi {
95
95
  );
96
96
  }
97
97
 
98
+ /**
99
+ * Get status for async query for action aggregates
100
+ *
101
+ * @param {String} jobId jobId
102
+ * getAnalyticsActionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
103
+ */
104
+ getAnalyticsActionsAggregatesJob(jobId) {
105
+ // verify the required parameter 'jobId' is set
106
+ if (jobId === undefined || jobId === null) {
107
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJob';
108
+ }
109
+
110
+ return this.apiClient.callApi(
111
+ '/api/v2/analytics/actions/aggregates/jobs/{jobId}',
112
+ 'GET',
113
+ { 'jobId': jobId },
114
+ { },
115
+ { },
116
+ { },
117
+ null,
118
+ ['PureCloud OAuth'],
119
+ ['application/json'],
120
+ ['application/json']
121
+ );
122
+ }
123
+
124
+ /**
125
+ * Fetch a page of results for an async aggregates query
126
+ *
127
+ * @param {String} jobId jobId
128
+ * @param {Object} opts Optional parameters
129
+ * @param {String} opts.cursor Cursor token to retrieve next page
130
+ * getAnalyticsActionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
131
+ */
132
+ getAnalyticsActionsAggregatesJobResults(jobId, opts) {
133
+ opts = opts || {};
134
+
135
+ // verify the required parameter 'jobId' is set
136
+ if (jobId === undefined || jobId === null) {
137
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsActionsAggregatesJobResults';
138
+ }
139
+
140
+ return this.apiClient.callApi(
141
+ '/api/v2/analytics/actions/aggregates/jobs/{jobId}/results',
142
+ 'GET',
143
+ { 'jobId': jobId },
144
+ { 'cursor': opts['cursor'] },
145
+ { },
146
+ { },
147
+ null,
148
+ ['PureCloud OAuth'],
149
+ ['application/json'],
150
+ ['application/json']
151
+ );
152
+ }
153
+
98
154
  /**
99
155
  * Get Reporting Turns.
100
156
  * Returns the reporting turns grouped by session, in reverse chronological order from the date the session was created, with the reporting turns from the most recent session appearing at the start of the list.
@@ -129,6 +185,62 @@ class AnalyticsApi {
129
185
  );
130
186
  }
131
187
 
188
+ /**
189
+ * Get status for async query for bot aggregates
190
+ *
191
+ * @param {String} jobId jobId
192
+ * getAnalyticsBotsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
193
+ */
194
+ getAnalyticsBotsAggregatesJob(jobId) {
195
+ // verify the required parameter 'jobId' is set
196
+ if (jobId === undefined || jobId === null) {
197
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJob';
198
+ }
199
+
200
+ return this.apiClient.callApi(
201
+ '/api/v2/analytics/bots/aggregates/jobs/{jobId}',
202
+ 'GET',
203
+ { 'jobId': jobId },
204
+ { },
205
+ { },
206
+ { },
207
+ null,
208
+ ['PureCloud OAuth'],
209
+ ['application/json'],
210
+ ['application/json']
211
+ );
212
+ }
213
+
214
+ /**
215
+ * Fetch a page of results for an async aggregates query
216
+ *
217
+ * @param {String} jobId jobId
218
+ * @param {Object} opts Optional parameters
219
+ * @param {String} opts.cursor Cursor token to retrieve next page
220
+ * getAnalyticsBotsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
221
+ */
222
+ getAnalyticsBotsAggregatesJobResults(jobId, opts) {
223
+ opts = opts || {};
224
+
225
+ // verify the required parameter 'jobId' is set
226
+ if (jobId === undefined || jobId === null) {
227
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsBotsAggregatesJobResults';
228
+ }
229
+
230
+ return this.apiClient.callApi(
231
+ '/api/v2/analytics/bots/aggregates/jobs/{jobId}/results',
232
+ 'GET',
233
+ { 'jobId': jobId },
234
+ { 'cursor': opts['cursor'] },
235
+ { },
236
+ { },
237
+ null,
238
+ ['PureCloud OAuth'],
239
+ ['application/json'],
240
+ ['application/json']
241
+ );
242
+ }
243
+
132
244
  /**
133
245
  * Get a conversation by id
134
246
  *
@@ -154,6 +266,62 @@ class AnalyticsApi {
154
266
  );
155
267
  }
156
268
 
269
+ /**
270
+ * Get status for async query for conversation aggregates
271
+ *
272
+ * @param {String} jobId jobId
273
+ * getAnalyticsConversationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
274
+ */
275
+ getAnalyticsConversationsAggregatesJob(jobId) {
276
+ // verify the required parameter 'jobId' is set
277
+ if (jobId === undefined || jobId === null) {
278
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJob';
279
+ }
280
+
281
+ return this.apiClient.callApi(
282
+ '/api/v2/analytics/conversations/aggregates/jobs/{jobId}',
283
+ 'GET',
284
+ { 'jobId': jobId },
285
+ { },
286
+ { },
287
+ { },
288
+ null,
289
+ ['PureCloud OAuth'],
290
+ ['application/json'],
291
+ ['application/json']
292
+ );
293
+ }
294
+
295
+ /**
296
+ * Fetch a page of results for an async aggregates query
297
+ *
298
+ * @param {String} jobId jobId
299
+ * @param {Object} opts Optional parameters
300
+ * @param {String} opts.cursor Cursor token to retrieve next page
301
+ * getAnalyticsConversationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
302
+ */
303
+ getAnalyticsConversationsAggregatesJobResults(jobId, opts) {
304
+ opts = opts || {};
305
+
306
+ // verify the required parameter 'jobId' is set
307
+ if (jobId === undefined || jobId === null) {
308
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsConversationsAggregatesJobResults';
309
+ }
310
+
311
+ return this.apiClient.callApi(
312
+ '/api/v2/analytics/conversations/aggregates/jobs/{jobId}/results',
313
+ 'GET',
314
+ { 'jobId': jobId },
315
+ { 'cursor': opts['cursor'] },
316
+ { },
317
+ { },
318
+ null,
319
+ ['PureCloud OAuth'],
320
+ ['application/json'],
321
+ ['application/json']
322
+ );
323
+ }
324
+
157
325
  /**
158
326
  * Gets multiple conversations by id
159
327
  *
@@ -274,21 +442,22 @@ class AnalyticsApi {
274
442
  }
275
443
 
276
444
  /**
277
- * Get all view export requests for a user
445
+ * Get status for async query for evaluation aggregates
278
446
  *
279
- * @param {Object} opts Optional parameters
280
- * @param {Number} opts.pageNumber Page number (default to 1)
281
- * @param {Number} opts.pageSize Page size (default to 25)
447
+ * @param {String} jobId jobId
448
+ * getAnalyticsEvaluationsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
282
449
  */
283
- getAnalyticsReportingExports(opts) {
284
- opts = opts || {};
285
-
450
+ getAnalyticsEvaluationsAggregatesJob(jobId) {
451
+ // verify the required parameter 'jobId' is set
452
+ if (jobId === undefined || jobId === null) {
453
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJob';
454
+ }
286
455
 
287
456
  return this.apiClient.callApi(
288
- '/api/v2/analytics/reporting/exports',
457
+ '/api/v2/analytics/evaluations/aggregates/jobs/{jobId}',
289
458
  'GET',
459
+ { 'jobId': jobId },
290
460
  { },
291
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
292
461
  { },
293
462
  { },
294
463
  null,
@@ -299,16 +468,26 @@ class AnalyticsApi {
299
468
  }
300
469
 
301
470
  /**
302
- * Get all export metadata
471
+ * Fetch a page of results for an async aggregates query
303
472
  *
473
+ * @param {String} jobId jobId
474
+ * @param {Object} opts Optional parameters
475
+ * @param {String} opts.cursor Cursor token to retrieve next page
476
+ * getAnalyticsEvaluationsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
304
477
  */
305
- getAnalyticsReportingExportsMetadata() {
478
+ getAnalyticsEvaluationsAggregatesJobResults(jobId, opts) {
479
+ opts = opts || {};
480
+
481
+ // verify the required parameter 'jobId' is set
482
+ if (jobId === undefined || jobId === null) {
483
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsEvaluationsAggregatesJobResults';
484
+ }
306
485
 
307
486
  return this.apiClient.callApi(
308
- '/api/v2/analytics/reporting/exports/metadata',
487
+ '/api/v2/analytics/evaluations/aggregates/jobs/{jobId}/results',
309
488
  'GET',
310
- { },
311
- { },
489
+ { 'jobId': jobId },
490
+ { 'cursor': opts['cursor'] },
312
491
  { },
313
492
  { },
314
493
  null,
@@ -319,22 +498,22 @@ class AnalyticsApi {
319
498
  }
320
499
 
321
500
  /**
322
- * Get list of reporting metadata.
501
+ * Get status for async query for Flow aggregates
323
502
  *
324
- * @param {Object} opts Optional parameters
325
- * @param {Number} opts.pageNumber Page number (default to 1)
326
- * @param {Number} opts.pageSize Page size (default to 25)
327
- * @param {String} opts.locale Locale
503
+ * @param {String} jobId jobId
504
+ * getAnalyticsFlowsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
328
505
  */
329
- getAnalyticsReportingMetadata(opts) {
330
- opts = opts || {};
331
-
506
+ getAnalyticsFlowsAggregatesJob(jobId) {
507
+ // verify the required parameter 'jobId' is set
508
+ if (jobId === undefined || jobId === null) {
509
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJob';
510
+ }
332
511
 
333
512
  return this.apiClient.callApi(
334
- '/api/v2/analytics/reporting/metadata',
513
+ '/api/v2/analytics/flows/aggregates/jobs/{jobId}',
335
514
  'GET',
515
+ { 'jobId': jobId },
336
516
  { },
337
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'locale': opts['locale'] },
338
517
  { },
339
518
  { },
340
519
  null,
@@ -345,25 +524,26 @@ class AnalyticsApi {
345
524
  }
346
525
 
347
526
  /**
348
- * Get a reporting metadata.
527
+ * Fetch a page of results for an async aggregates query
349
528
  *
350
- * @param {String} reportId Report ID
529
+ * @param {String} jobId jobId
351
530
  * @param {Object} opts Optional parameters
352
- * @param {String} opts.locale Locale
531
+ * @param {String} opts.cursor Cursor token to retrieve next page
532
+ * getAnalyticsFlowsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
353
533
  */
354
- getAnalyticsReportingReportIdMetadata(reportId, opts) {
534
+ getAnalyticsFlowsAggregatesJobResults(jobId, opts) {
355
535
  opts = opts || {};
356
536
 
357
- // verify the required parameter 'reportId' is set
358
- if (reportId === undefined || reportId === null) {
359
- throw 'Missing the required parameter "reportId" when calling getAnalyticsReportingReportIdMetadata';
537
+ // verify the required parameter 'jobId' is set
538
+ if (jobId === undefined || jobId === null) {
539
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsFlowsAggregatesJobResults';
360
540
  }
361
541
 
362
542
  return this.apiClient.callApi(
363
- '/api/v2/analytics/reporting/{reportId}/metadata',
543
+ '/api/v2/analytics/flows/aggregates/jobs/{jobId}/results',
364
544
  'GET',
365
- { 'reportId': reportId },
366
- { 'locale': opts['locale'] },
545
+ { 'jobId': jobId },
546
+ { 'cursor': opts['cursor'] },
367
547
  { },
368
548
  { },
369
549
  null,
@@ -374,15 +554,21 @@ class AnalyticsApi {
374
554
  }
375
555
 
376
556
  /**
377
- * Get a list of report formats
378
- * Get a list of report formats.
557
+ * Get status for async query for journey aggregates
558
+ *
559
+ * @param {String} jobId jobId
560
+ * getAnalyticsJourneysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
379
561
  */
380
- getAnalyticsReportingReportformats() {
562
+ getAnalyticsJourneysAggregatesJob(jobId) {
563
+ // verify the required parameter 'jobId' is set
564
+ if (jobId === undefined || jobId === null) {
565
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJob';
566
+ }
381
567
 
382
568
  return this.apiClient.callApi(
383
- '/api/v2/analytics/reporting/reportformats',
569
+ '/api/v2/analytics/journeys/aggregates/jobs/{jobId}',
384
570
  'GET',
385
- { },
571
+ { 'jobId': jobId },
386
572
  { },
387
573
  { },
388
574
  { },
@@ -394,21 +580,26 @@ class AnalyticsApi {
394
580
  }
395
581
 
396
582
  /**
397
- * Get a scheduled report job.
583
+ * Fetch a page of results for an async aggregates query
398
584
  *
399
- * @param {String} scheduleId Schedule ID
585
+ * @param {String} jobId jobId
586
+ * @param {Object} opts Optional parameters
587
+ * @param {String} opts.cursor Cursor token to retrieve next page
588
+ * getAnalyticsJourneysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
400
589
  */
401
- getAnalyticsReportingSchedule(scheduleId) {
402
- // verify the required parameter 'scheduleId' is set
403
- if (scheduleId === undefined || scheduleId === null) {
404
- throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingSchedule';
590
+ getAnalyticsJourneysAggregatesJobResults(jobId, opts) {
591
+ opts = opts || {};
592
+
593
+ // verify the required parameter 'jobId' is set
594
+ if (jobId === undefined || jobId === null) {
595
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsJourneysAggregatesJobResults';
405
596
  }
406
597
 
407
598
  return this.apiClient.callApi(
408
- '/api/v2/analytics/reporting/schedules/{scheduleId}',
599
+ '/api/v2/analytics/journeys/aggregates/jobs/{jobId}/results',
409
600
  'GET',
410
- { 'scheduleId': scheduleId },
411
- { },
601
+ { 'jobId': jobId },
602
+ { 'cursor': opts['cursor'] },
412
603
  { },
413
604
  { },
414
605
  null,
@@ -419,26 +610,22 @@ class AnalyticsApi {
419
610
  }
420
611
 
421
612
  /**
422
- * Get list of completed scheduled report jobs.
613
+ * Get status for async query for knowledge aggregates
423
614
  *
424
- * @param {String} scheduleId Schedule ID
425
- * @param {Object} opts Optional parameters
426
- * @param {Number} opts.pageNumber (default to 1)
427
- * @param {Number} opts.pageSize (default to 25)
615
+ * @param {String} jobId jobId
616
+ * getAnalyticsKnowledgeAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
428
617
  */
429
- getAnalyticsReportingScheduleHistory(scheduleId, opts) {
430
- opts = opts || {};
431
-
432
- // verify the required parameter 'scheduleId' is set
433
- if (scheduleId === undefined || scheduleId === null) {
434
- throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistory';
618
+ getAnalyticsKnowledgeAggregatesJob(jobId) {
619
+ // verify the required parameter 'jobId' is set
620
+ if (jobId === undefined || jobId === null) {
621
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJob';
435
622
  }
436
623
 
437
624
  return this.apiClient.callApi(
438
- '/api/v2/analytics/reporting/schedules/{scheduleId}/history',
625
+ '/api/v2/analytics/knowledge/aggregates/jobs/{jobId}',
439
626
  'GET',
440
- { 'scheduleId': scheduleId },
441
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
627
+ { 'jobId': jobId },
628
+ { },
442
629
  { },
443
630
  { },
444
631
  null,
@@ -449,21 +636,26 @@ class AnalyticsApi {
449
636
  }
450
637
 
451
638
  /**
452
- * Get most recently completed scheduled report job.
639
+ * Fetch a page of results for an async aggregates query
453
640
  *
454
- * @param {String} scheduleId Schedule ID
641
+ * @param {String} jobId jobId
642
+ * @param {Object} opts Optional parameters
643
+ * @param {String} opts.cursor Cursor token to retrieve next page
644
+ * getAnalyticsKnowledgeAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
455
645
  */
456
- getAnalyticsReportingScheduleHistoryLatest(scheduleId) {
457
- // verify the required parameter 'scheduleId' is set
458
- if (scheduleId === undefined || scheduleId === null) {
459
- throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryLatest';
646
+ getAnalyticsKnowledgeAggregatesJobResults(jobId, opts) {
647
+ opts = opts || {};
648
+
649
+ // verify the required parameter 'jobId' is set
650
+ if (jobId === undefined || jobId === null) {
651
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsKnowledgeAggregatesJobResults';
460
652
  }
461
653
 
462
654
  return this.apiClient.callApi(
463
- '/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest',
655
+ '/api/v2/analytics/knowledge/aggregates/jobs/{jobId}/results',
464
656
  'GET',
465
- { 'scheduleId': scheduleId },
466
- { },
657
+ { 'jobId': jobId },
658
+ { 'cursor': opts['cursor'] },
467
659
  { },
468
660
  { },
469
661
  null,
@@ -474,12 +666,212 @@ class AnalyticsApi {
474
666
  }
475
667
 
476
668
  /**
477
- * A completed scheduled report job
478
- * A completed scheduled report job.
479
- * @param {String} runId Run ID
480
- * @param {String} scheduleId Schedule ID
481
- */
482
- getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId) {
669
+ * Get all view export requests for a user
670
+ *
671
+ * @param {Object} opts Optional parameters
672
+ * @param {Number} opts.pageNumber Page number (default to 1)
673
+ * @param {Number} opts.pageSize Page size (default to 25)
674
+ */
675
+ getAnalyticsReportingExports(opts) {
676
+ opts = opts || {};
677
+
678
+
679
+ return this.apiClient.callApi(
680
+ '/api/v2/analytics/reporting/exports',
681
+ 'GET',
682
+ { },
683
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
684
+ { },
685
+ { },
686
+ null,
687
+ ['PureCloud OAuth'],
688
+ ['application/json'],
689
+ ['application/json']
690
+ );
691
+ }
692
+
693
+ /**
694
+ * Get all export metadata
695
+ *
696
+ */
697
+ getAnalyticsReportingExportsMetadata() {
698
+
699
+ return this.apiClient.callApi(
700
+ '/api/v2/analytics/reporting/exports/metadata',
701
+ 'GET',
702
+ { },
703
+ { },
704
+ { },
705
+ { },
706
+ null,
707
+ ['PureCloud OAuth'],
708
+ ['application/json'],
709
+ ['application/json']
710
+ );
711
+ }
712
+
713
+ /**
714
+ * Get list of reporting metadata.
715
+ *
716
+ * @param {Object} opts Optional parameters
717
+ * @param {Number} opts.pageNumber Page number (default to 1)
718
+ * @param {Number} opts.pageSize Page size (default to 25)
719
+ * @param {String} opts.locale Locale
720
+ */
721
+ getAnalyticsReportingMetadata(opts) {
722
+ opts = opts || {};
723
+
724
+
725
+ return this.apiClient.callApi(
726
+ '/api/v2/analytics/reporting/metadata',
727
+ 'GET',
728
+ { },
729
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'locale': opts['locale'] },
730
+ { },
731
+ { },
732
+ null,
733
+ ['PureCloud OAuth'],
734
+ ['application/json'],
735
+ ['application/json']
736
+ );
737
+ }
738
+
739
+ /**
740
+ * Get a reporting metadata.
741
+ *
742
+ * @param {String} reportId Report ID
743
+ * @param {Object} opts Optional parameters
744
+ * @param {String} opts.locale Locale
745
+ */
746
+ getAnalyticsReportingReportIdMetadata(reportId, opts) {
747
+ opts = opts || {};
748
+
749
+ // verify the required parameter 'reportId' is set
750
+ if (reportId === undefined || reportId === null) {
751
+ throw 'Missing the required parameter "reportId" when calling getAnalyticsReportingReportIdMetadata';
752
+ }
753
+
754
+ return this.apiClient.callApi(
755
+ '/api/v2/analytics/reporting/{reportId}/metadata',
756
+ 'GET',
757
+ { 'reportId': reportId },
758
+ { 'locale': opts['locale'] },
759
+ { },
760
+ { },
761
+ null,
762
+ ['PureCloud OAuth'],
763
+ ['application/json'],
764
+ ['application/json']
765
+ );
766
+ }
767
+
768
+ /**
769
+ * Get a list of report formats
770
+ * Get a list of report formats.
771
+ */
772
+ getAnalyticsReportingReportformats() {
773
+
774
+ return this.apiClient.callApi(
775
+ '/api/v2/analytics/reporting/reportformats',
776
+ 'GET',
777
+ { },
778
+ { },
779
+ { },
780
+ { },
781
+ null,
782
+ ['PureCloud OAuth'],
783
+ ['application/json'],
784
+ ['application/json']
785
+ );
786
+ }
787
+
788
+ /**
789
+ * Get a scheduled report job.
790
+ *
791
+ * @param {String} scheduleId Schedule ID
792
+ */
793
+ getAnalyticsReportingSchedule(scheduleId) {
794
+ // verify the required parameter 'scheduleId' is set
795
+ if (scheduleId === undefined || scheduleId === null) {
796
+ throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingSchedule';
797
+ }
798
+
799
+ return this.apiClient.callApi(
800
+ '/api/v2/analytics/reporting/schedules/{scheduleId}',
801
+ 'GET',
802
+ { 'scheduleId': scheduleId },
803
+ { },
804
+ { },
805
+ { },
806
+ null,
807
+ ['PureCloud OAuth'],
808
+ ['application/json'],
809
+ ['application/json']
810
+ );
811
+ }
812
+
813
+ /**
814
+ * Get list of completed scheduled report jobs.
815
+ *
816
+ * @param {String} scheduleId Schedule ID
817
+ * @param {Object} opts Optional parameters
818
+ * @param {Number} opts.pageNumber (default to 1)
819
+ * @param {Number} opts.pageSize (default to 25)
820
+ */
821
+ getAnalyticsReportingScheduleHistory(scheduleId, opts) {
822
+ opts = opts || {};
823
+
824
+ // verify the required parameter 'scheduleId' is set
825
+ if (scheduleId === undefined || scheduleId === null) {
826
+ throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistory';
827
+ }
828
+
829
+ return this.apiClient.callApi(
830
+ '/api/v2/analytics/reporting/schedules/{scheduleId}/history',
831
+ 'GET',
832
+ { 'scheduleId': scheduleId },
833
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
834
+ { },
835
+ { },
836
+ null,
837
+ ['PureCloud OAuth'],
838
+ ['application/json'],
839
+ ['application/json']
840
+ );
841
+ }
842
+
843
+ /**
844
+ * Get most recently completed scheduled report job.
845
+ *
846
+ * @param {String} scheduleId Schedule ID
847
+ */
848
+ getAnalyticsReportingScheduleHistoryLatest(scheduleId) {
849
+ // verify the required parameter 'scheduleId' is set
850
+ if (scheduleId === undefined || scheduleId === null) {
851
+ throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryLatest';
852
+ }
853
+
854
+ return this.apiClient.callApi(
855
+ '/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest',
856
+ 'GET',
857
+ { 'scheduleId': scheduleId },
858
+ { },
859
+ { },
860
+ { },
861
+ null,
862
+ ['PureCloud OAuth'],
863
+ ['application/json'],
864
+ ['application/json']
865
+ );
866
+ }
867
+
868
+ /**
869
+ * A completed scheduled report job
870
+ * A completed scheduled report job.
871
+ * @param {String} runId Run ID
872
+ * @param {String} scheduleId Schedule ID
873
+ */
874
+ getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId) {
483
875
  // verify the required parameter 'runId' is set
484
876
  if (runId === undefined || runId === null) {
485
877
  throw 'Missing the required parameter "runId" when calling getAnalyticsReportingScheduleHistoryRunId';
@@ -515,13 +907,773 @@ class AnalyticsApi {
515
907
 
516
908
 
517
909
  return this.apiClient.callApi(
518
- '/api/v2/analytics/reporting/schedules',
519
- 'GET',
910
+ '/api/v2/analytics/reporting/schedules',
911
+ 'GET',
912
+ { },
913
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
914
+ { },
915
+ { },
916
+ null,
917
+ ['PureCloud OAuth'],
918
+ ['application/json'],
919
+ ['application/json']
920
+ );
921
+ }
922
+
923
+ /**
924
+ * Get AnalyticsReportingSettings for an organization
925
+ *
926
+ */
927
+ getAnalyticsReportingSettings() {
928
+
929
+ return this.apiClient.callApi(
930
+ '/api/v2/analytics/reporting/settings',
931
+ 'GET',
932
+ { },
933
+ { },
934
+ { },
935
+ { },
936
+ null,
937
+ ['PureCloud OAuth'],
938
+ ['application/json'],
939
+ ['application/json']
940
+ );
941
+ }
942
+
943
+ /**
944
+ * Get a list of report time periods.
945
+ *
946
+ */
947
+ getAnalyticsReportingTimeperiods() {
948
+
949
+ return this.apiClient.callApi(
950
+ '/api/v2/analytics/reporting/timeperiods',
951
+ 'GET',
952
+ { },
953
+ { },
954
+ { },
955
+ { },
956
+ null,
957
+ ['PureCloud OAuth'],
958
+ ['application/json'],
959
+ ['application/json']
960
+ );
961
+ }
962
+
963
+ /**
964
+ * Get status for async query for resolution aggregates
965
+ *
966
+ * @param {String} jobId jobId
967
+ * getAnalyticsResolutionsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
968
+ */
969
+ getAnalyticsResolutionsAggregatesJob(jobId) {
970
+ // verify the required parameter 'jobId' is set
971
+ if (jobId === undefined || jobId === null) {
972
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJob';
973
+ }
974
+
975
+ return this.apiClient.callApi(
976
+ '/api/v2/analytics/resolutions/aggregates/jobs/{jobId}',
977
+ 'GET',
978
+ { 'jobId': jobId },
979
+ { },
980
+ { },
981
+ { },
982
+ null,
983
+ ['PureCloud OAuth'],
984
+ ['application/json'],
985
+ ['application/json']
986
+ );
987
+ }
988
+
989
+ /**
990
+ * Fetch a page of results for an async aggregates query
991
+ *
992
+ * @param {String} jobId jobId
993
+ * @param {Object} opts Optional parameters
994
+ * @param {String} opts.cursor Cursor token to retrieve next page
995
+ * getAnalyticsResolutionsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
996
+ */
997
+ getAnalyticsResolutionsAggregatesJobResults(jobId, opts) {
998
+ opts = opts || {};
999
+
1000
+ // verify the required parameter 'jobId' is set
1001
+ if (jobId === undefined || jobId === null) {
1002
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsResolutionsAggregatesJobResults';
1003
+ }
1004
+
1005
+ return this.apiClient.callApi(
1006
+ '/api/v2/analytics/resolutions/aggregates/jobs/{jobId}/results',
1007
+ 'GET',
1008
+ { 'jobId': jobId },
1009
+ { 'cursor': opts['cursor'] },
1010
+ { },
1011
+ { },
1012
+ null,
1013
+ ['PureCloud OAuth'],
1014
+ ['application/json'],
1015
+ ['application/json']
1016
+ );
1017
+ }
1018
+
1019
+ /**
1020
+ * Get status for async query for survey aggregates
1021
+ *
1022
+ * @param {String} jobId jobId
1023
+ * getAnalyticsSurveysAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1024
+ */
1025
+ getAnalyticsSurveysAggregatesJob(jobId) {
1026
+ // verify the required parameter 'jobId' is set
1027
+ if (jobId === undefined || jobId === null) {
1028
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJob';
1029
+ }
1030
+
1031
+ return this.apiClient.callApi(
1032
+ '/api/v2/analytics/surveys/aggregates/jobs/{jobId}',
1033
+ 'GET',
1034
+ { 'jobId': jobId },
1035
+ { },
1036
+ { },
1037
+ { },
1038
+ null,
1039
+ ['PureCloud OAuth'],
1040
+ ['application/json'],
1041
+ ['application/json']
1042
+ );
1043
+ }
1044
+
1045
+ /**
1046
+ * Fetch a page of results for an async aggregates query
1047
+ *
1048
+ * @param {String} jobId jobId
1049
+ * @param {Object} opts Optional parameters
1050
+ * @param {String} opts.cursor Cursor token to retrieve next page
1051
+ * getAnalyticsSurveysAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1052
+ */
1053
+ getAnalyticsSurveysAggregatesJobResults(jobId, opts) {
1054
+ opts = opts || {};
1055
+
1056
+ // verify the required parameter 'jobId' is set
1057
+ if (jobId === undefined || jobId === null) {
1058
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsSurveysAggregatesJobResults';
1059
+ }
1060
+
1061
+ return this.apiClient.callApi(
1062
+ '/api/v2/analytics/surveys/aggregates/jobs/{jobId}/results',
1063
+ 'GET',
1064
+ { 'jobId': jobId },
1065
+ { 'cursor': opts['cursor'] },
1066
+ { },
1067
+ { },
1068
+ null,
1069
+ ['PureCloud OAuth'],
1070
+ ['application/json'],
1071
+ ['application/json']
1072
+ );
1073
+ }
1074
+
1075
+ /**
1076
+ * Get status for async query for task management aggregates
1077
+ *
1078
+ * @param {String} jobId jobId
1079
+ * getAnalyticsTaskmanagementAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1080
+ */
1081
+ getAnalyticsTaskmanagementAggregatesJob(jobId) {
1082
+ // verify the required parameter 'jobId' is set
1083
+ if (jobId === undefined || jobId === null) {
1084
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJob';
1085
+ }
1086
+
1087
+ return this.apiClient.callApi(
1088
+ '/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}',
1089
+ 'GET',
1090
+ { 'jobId': jobId },
1091
+ { },
1092
+ { },
1093
+ { },
1094
+ null,
1095
+ ['PureCloud OAuth'],
1096
+ ['application/json'],
1097
+ ['application/json']
1098
+ );
1099
+ }
1100
+
1101
+ /**
1102
+ * Fetch a page of results for an async task management query
1103
+ *
1104
+ * @param {String} jobId jobId
1105
+ * @param {Object} opts Optional parameters
1106
+ * @param {String} opts.cursor Cursor token to retrieve next page
1107
+ * getAnalyticsTaskmanagementAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1108
+ */
1109
+ getAnalyticsTaskmanagementAggregatesJobResults(jobId, opts) {
1110
+ opts = opts || {};
1111
+
1112
+ // verify the required parameter 'jobId' is set
1113
+ if (jobId === undefined || jobId === null) {
1114
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsTaskmanagementAggregatesJobResults';
1115
+ }
1116
+
1117
+ return this.apiClient.callApi(
1118
+ '/api/v2/analytics/taskmanagement/aggregates/jobs/{jobId}/results',
1119
+ 'GET',
1120
+ { 'jobId': jobId },
1121
+ { 'cursor': opts['cursor'] },
1122
+ { },
1123
+ { },
1124
+ null,
1125
+ ['PureCloud OAuth'],
1126
+ ['application/json'],
1127
+ ['application/json']
1128
+ );
1129
+ }
1130
+
1131
+ /**
1132
+ * Get status for async query for transcript aggregates
1133
+ *
1134
+ * @param {String} jobId jobId
1135
+ * getAnalyticsTranscriptsAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1136
+ */
1137
+ getAnalyticsTranscriptsAggregatesJob(jobId) {
1138
+ // verify the required parameter 'jobId' is set
1139
+ if (jobId === undefined || jobId === null) {
1140
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJob';
1141
+ }
1142
+
1143
+ return this.apiClient.callApi(
1144
+ '/api/v2/analytics/transcripts/aggregates/jobs/{jobId}',
1145
+ 'GET',
1146
+ { 'jobId': jobId },
1147
+ { },
1148
+ { },
1149
+ { },
1150
+ null,
1151
+ ['PureCloud OAuth'],
1152
+ ['application/json'],
1153
+ ['application/json']
1154
+ );
1155
+ }
1156
+
1157
+ /**
1158
+ * Fetch a page of results for an async aggregates query
1159
+ *
1160
+ * @param {String} jobId jobId
1161
+ * @param {Object} opts Optional parameters
1162
+ * @param {String} opts.cursor Cursor token to retrieve next page
1163
+ * getAnalyticsTranscriptsAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1164
+ */
1165
+ getAnalyticsTranscriptsAggregatesJobResults(jobId, opts) {
1166
+ opts = opts || {};
1167
+
1168
+ // verify the required parameter 'jobId' is set
1169
+ if (jobId === undefined || jobId === null) {
1170
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsTranscriptsAggregatesJobResults';
1171
+ }
1172
+
1173
+ return this.apiClient.callApi(
1174
+ '/api/v2/analytics/transcripts/aggregates/jobs/{jobId}/results',
1175
+ 'GET',
1176
+ { 'jobId': jobId },
1177
+ { 'cursor': opts['cursor'] },
1178
+ { },
1179
+ { },
1180
+ null,
1181
+ ['PureCloud OAuth'],
1182
+ ['application/json'],
1183
+ ['application/json']
1184
+ );
1185
+ }
1186
+
1187
+ /**
1188
+ * Get status for async query for user aggregates
1189
+ *
1190
+ * @param {String} jobId jobId
1191
+ * getAnalyticsUsersAggregatesJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1192
+ */
1193
+ getAnalyticsUsersAggregatesJob(jobId) {
1194
+ // verify the required parameter 'jobId' is set
1195
+ if (jobId === undefined || jobId === null) {
1196
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJob';
1197
+ }
1198
+
1199
+ return this.apiClient.callApi(
1200
+ '/api/v2/analytics/users/aggregates/jobs/{jobId}',
1201
+ 'GET',
1202
+ { 'jobId': jobId },
1203
+ { },
1204
+ { },
1205
+ { },
1206
+ null,
1207
+ ['PureCloud OAuth'],
1208
+ ['application/json'],
1209
+ ['application/json']
1210
+ );
1211
+ }
1212
+
1213
+ /**
1214
+ * Fetch a page of results for an async aggregates query
1215
+ *
1216
+ * @param {String} jobId jobId
1217
+ * @param {Object} opts Optional parameters
1218
+ * @param {String} opts.cursor Cursor token to retrieve next page
1219
+ * getAnalyticsUsersAggregatesJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1220
+ */
1221
+ getAnalyticsUsersAggregatesJobResults(jobId, opts) {
1222
+ opts = opts || {};
1223
+
1224
+ // verify the required parameter 'jobId' is set
1225
+ if (jobId === undefined || jobId === null) {
1226
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersAggregatesJobResults';
1227
+ }
1228
+
1229
+ return this.apiClient.callApi(
1230
+ '/api/v2/analytics/users/aggregates/jobs/{jobId}/results',
1231
+ 'GET',
1232
+ { 'jobId': jobId },
1233
+ { 'cursor': opts['cursor'] },
1234
+ { },
1235
+ { },
1236
+ null,
1237
+ ['PureCloud OAuth'],
1238
+ ['application/json'],
1239
+ ['application/json']
1240
+ );
1241
+ }
1242
+
1243
+ /**
1244
+ * Get status for async query for user details
1245
+ *
1246
+ * @param {String} jobId jobId
1247
+ */
1248
+ getAnalyticsUsersDetailsJob(jobId) {
1249
+ // verify the required parameter 'jobId' is set
1250
+ if (jobId === undefined || jobId === null) {
1251
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';
1252
+ }
1253
+
1254
+ return this.apiClient.callApi(
1255
+ '/api/v2/analytics/users/details/jobs/{jobId}',
1256
+ 'GET',
1257
+ { 'jobId': jobId },
1258
+ { },
1259
+ { },
1260
+ { },
1261
+ null,
1262
+ ['PureCloud OAuth'],
1263
+ ['application/json'],
1264
+ ['application/json']
1265
+ );
1266
+ }
1267
+
1268
+ /**
1269
+ * Fetch a page of results for an async query
1270
+ *
1271
+ * @param {String} jobId jobId
1272
+ * @param {Object} opts Optional parameters
1273
+ * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
1274
+ * @param {Number} opts.pageSize The desired maximum number of results
1275
+ */
1276
+ getAnalyticsUsersDetailsJobResults(jobId, opts) {
1277
+ opts = opts || {};
1278
+
1279
+ // verify the required parameter 'jobId' is set
1280
+ if (jobId === undefined || jobId === null) {
1281
+ throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJobResults';
1282
+ }
1283
+
1284
+ return this.apiClient.callApi(
1285
+ '/api/v2/analytics/users/details/jobs/{jobId}/results',
1286
+ 'GET',
1287
+ { 'jobId': jobId },
1288
+ { 'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
1289
+ { },
1290
+ { },
1291
+ null,
1292
+ ['PureCloud OAuth'],
1293
+ ['application/json'],
1294
+ ['application/json']
1295
+ );
1296
+ }
1297
+
1298
+ /**
1299
+ * Lookup the datalake availability date and time
1300
+ *
1301
+ */
1302
+ getAnalyticsUsersDetailsJobsAvailability() {
1303
+
1304
+ return this.apiClient.callApi(
1305
+ '/api/v2/analytics/users/details/jobs/availability',
1306
+ 'GET',
1307
+ { },
1308
+ { },
1309
+ { },
1310
+ { },
1311
+ null,
1312
+ ['PureCloud OAuth'],
1313
+ ['application/json'],
1314
+ ['application/json']
1315
+ );
1316
+ }
1317
+
1318
+ /**
1319
+ * Patch AnalyticsReportingSettings values for an organization
1320
+ *
1321
+ * @param {Object} body AnalyticsReportingSettingsRequest
1322
+ */
1323
+ patchAnalyticsReportingSettings(body) {
1324
+ // verify the required parameter 'body' is set
1325
+ if (body === undefined || body === null) {
1326
+ throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
1327
+ }
1328
+
1329
+ return this.apiClient.callApi(
1330
+ '/api/v2/analytics/reporting/settings',
1331
+ 'PATCH',
1332
+ { },
1333
+ { },
1334
+ { },
1335
+ { },
1336
+ body,
1337
+ ['PureCloud OAuth'],
1338
+ ['application/json'],
1339
+ ['application/json']
1340
+ );
1341
+ }
1342
+
1343
+ /**
1344
+ * Query for action aggregates asynchronously
1345
+ *
1346
+ * @param {Object} body query
1347
+ * postAnalyticsActionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1348
+ */
1349
+ postAnalyticsActionsAggregatesJobs(body) {
1350
+ // verify the required parameter 'body' is set
1351
+ if (body === undefined || body === null) {
1352
+ throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesJobs';
1353
+ }
1354
+
1355
+ return this.apiClient.callApi(
1356
+ '/api/v2/analytics/actions/aggregates/jobs',
1357
+ 'POST',
1358
+ { },
1359
+ { },
1360
+ { },
1361
+ { },
1362
+ body,
1363
+ ['PureCloud OAuth'],
1364
+ ['application/json'],
1365
+ ['application/json']
1366
+ );
1367
+ }
1368
+
1369
+ /**
1370
+ * Query for action aggregates
1371
+ *
1372
+ * @param {Object} body query
1373
+ */
1374
+ postAnalyticsActionsAggregatesQuery(body) {
1375
+ // verify the required parameter 'body' is set
1376
+ if (body === undefined || body === null) {
1377
+ throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
1378
+ }
1379
+
1380
+ return this.apiClient.callApi(
1381
+ '/api/v2/analytics/actions/aggregates/query',
1382
+ 'POST',
1383
+ { },
1384
+ { },
1385
+ { },
1386
+ { },
1387
+ body,
1388
+ ['PureCloud OAuth'],
1389
+ ['application/json'],
1390
+ ['application/json']
1391
+ );
1392
+ }
1393
+
1394
+ /**
1395
+ * Query for bot aggregates asynchronously
1396
+ *
1397
+ * @param {Object} body query
1398
+ * postAnalyticsBotsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1399
+ */
1400
+ postAnalyticsBotsAggregatesJobs(body) {
1401
+ // verify the required parameter 'body' is set
1402
+ if (body === undefined || body === null) {
1403
+ throw 'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesJobs';
1404
+ }
1405
+
1406
+ return this.apiClient.callApi(
1407
+ '/api/v2/analytics/bots/aggregates/jobs',
1408
+ 'POST',
1409
+ { },
1410
+ { },
1411
+ { },
1412
+ { },
1413
+ body,
1414
+ ['PureCloud OAuth'],
1415
+ ['application/json'],
1416
+ ['application/json']
1417
+ );
1418
+ }
1419
+
1420
+ /**
1421
+ * Query for bot aggregates
1422
+ *
1423
+ * @param {Object} body query
1424
+ */
1425
+ postAnalyticsBotsAggregatesQuery(body) {
1426
+ // verify the required parameter 'body' is set
1427
+ if (body === undefined || body === null) {
1428
+ throw 'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesQuery';
1429
+ }
1430
+
1431
+ return this.apiClient.callApi(
1432
+ '/api/v2/analytics/bots/aggregates/query',
1433
+ 'POST',
1434
+ { },
1435
+ { },
1436
+ { },
1437
+ { },
1438
+ body,
1439
+ ['PureCloud OAuth'],
1440
+ ['application/json'],
1441
+ ['application/json']
1442
+ );
1443
+ }
1444
+
1445
+ /**
1446
+ * Index conversation properties
1447
+ *
1448
+ * @param {String} conversationId conversationId
1449
+ * @param {Object} body request
1450
+ */
1451
+ postAnalyticsConversationDetailsProperties(conversationId, body) {
1452
+ // verify the required parameter 'conversationId' is set
1453
+ if (conversationId === undefined || conversationId === null) {
1454
+ throw 'Missing the required parameter "conversationId" when calling postAnalyticsConversationDetailsProperties';
1455
+ }
1456
+ // verify the required parameter 'body' is set
1457
+ if (body === undefined || body === null) {
1458
+ throw 'Missing the required parameter "body" when calling postAnalyticsConversationDetailsProperties';
1459
+ }
1460
+
1461
+ return this.apiClient.callApi(
1462
+ '/api/v2/analytics/conversations/{conversationId}/details/properties',
1463
+ 'POST',
1464
+ { 'conversationId': conversationId },
1465
+ { },
1466
+ { },
1467
+ { },
1468
+ body,
1469
+ ['PureCloud OAuth'],
1470
+ ['application/json'],
1471
+ ['application/json']
1472
+ );
1473
+ }
1474
+
1475
+ /**
1476
+ * Query for conversation activity observations
1477
+ *
1478
+ * @param {Object} body query
1479
+ * @param {Object} opts Optional parameters
1480
+ * @param {Number} opts.pageSize The desired page size
1481
+ * @param {Number} opts.pageNumber The desired page number
1482
+ * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1483
+ */
1484
+ postAnalyticsConversationsActivityQuery(body, opts) {
1485
+ opts = opts || {};
1486
+
1487
+ // verify the required parameter 'body' is set
1488
+ if (body === undefined || body === null) {
1489
+ throw 'Missing the required parameter "body" when calling postAnalyticsConversationsActivityQuery';
1490
+ }
1491
+
1492
+ return this.apiClient.callApi(
1493
+ '/api/v2/analytics/conversations/activity/query',
1494
+ 'POST',
1495
+ { },
1496
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
1497
+ { },
1498
+ { },
1499
+ body,
1500
+ ['PureCloud OAuth'],
1501
+ ['application/json'],
1502
+ ['application/json']
1503
+ );
1504
+ }
1505
+
1506
+ /**
1507
+ * Query for conversation aggregates asynchronously
1508
+ *
1509
+ * @param {Object} body query
1510
+ * postAnalyticsConversationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1511
+ */
1512
+ postAnalyticsConversationsAggregatesJobs(body) {
1513
+ // verify the required parameter 'body' is set
1514
+ if (body === undefined || body === null) {
1515
+ throw 'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesJobs';
1516
+ }
1517
+
1518
+ return this.apiClient.callApi(
1519
+ '/api/v2/analytics/conversations/aggregates/jobs',
1520
+ 'POST',
1521
+ { },
1522
+ { },
1523
+ { },
1524
+ { },
1525
+ body,
1526
+ ['PureCloud OAuth'],
1527
+ ['application/json'],
1528
+ ['application/json']
1529
+ );
1530
+ }
1531
+
1532
+ /**
1533
+ * Query for conversation aggregates
1534
+ *
1535
+ * @param {Object} body query
1536
+ */
1537
+ postAnalyticsConversationsAggregatesQuery(body) {
1538
+ // verify the required parameter 'body' is set
1539
+ if (body === undefined || body === null) {
1540
+ throw 'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesQuery';
1541
+ }
1542
+
1543
+ return this.apiClient.callApi(
1544
+ '/api/v2/analytics/conversations/aggregates/query',
1545
+ 'POST',
1546
+ { },
1547
+ { },
1548
+ { },
1549
+ { },
1550
+ body,
1551
+ ['PureCloud OAuth'],
1552
+ ['application/json'],
1553
+ ['application/json']
1554
+ );
1555
+ }
1556
+
1557
+ /**
1558
+ * Query for conversation details asynchronously
1559
+ *
1560
+ * @param {Object} body query
1561
+ */
1562
+ postAnalyticsConversationsDetailsJobs(body) {
1563
+ // verify the required parameter 'body' is set
1564
+ if (body === undefined || body === null) {
1565
+ throw 'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsJobs';
1566
+ }
1567
+
1568
+ return this.apiClient.callApi(
1569
+ '/api/v2/analytics/conversations/details/jobs',
1570
+ 'POST',
1571
+ { },
1572
+ { },
1573
+ { },
1574
+ { },
1575
+ body,
1576
+ ['PureCloud OAuth'],
1577
+ ['application/json'],
1578
+ ['application/json']
1579
+ );
1580
+ }
1581
+
1582
+ /**
1583
+ * Query for conversation details
1584
+ *
1585
+ * @param {Object} body query
1586
+ */
1587
+ postAnalyticsConversationsDetailsQuery(body) {
1588
+ // verify the required parameter 'body' is set
1589
+ if (body === undefined || body === null) {
1590
+ throw 'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsQuery';
1591
+ }
1592
+
1593
+ return this.apiClient.callApi(
1594
+ '/api/v2/analytics/conversations/details/query',
1595
+ 'POST',
1596
+ { },
1597
+ { },
1598
+ { },
1599
+ { },
1600
+ body,
1601
+ ['PureCloud OAuth'],
1602
+ ['application/json'],
1603
+ ['application/json']
1604
+ );
1605
+ }
1606
+
1607
+ /**
1608
+ * Search resources.
1609
+ *
1610
+ * @param {Object} body Search request options
1611
+ */
1612
+ postAnalyticsConversationsTranscriptsQuery(body) {
1613
+ // verify the required parameter 'body' is set
1614
+ if (body === undefined || body === null) {
1615
+ throw 'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';
1616
+ }
1617
+
1618
+ return this.apiClient.callApi(
1619
+ '/api/v2/analytics/conversations/transcripts/query',
1620
+ 'POST',
1621
+ { },
1622
+ { },
1623
+ { },
1624
+ { },
1625
+ body,
1626
+ ['PureCloud OAuth'],
1627
+ ['application/json'],
1628
+ ['application/json']
1629
+ );
1630
+ }
1631
+
1632
+ /**
1633
+ * Query for evaluation aggregates asynchronously
1634
+ *
1635
+ * @param {Object} body query
1636
+ * postAnalyticsEvaluationsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1637
+ */
1638
+ postAnalyticsEvaluationsAggregatesJobs(body) {
1639
+ // verify the required parameter 'body' is set
1640
+ if (body === undefined || body === null) {
1641
+ throw 'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesJobs';
1642
+ }
1643
+
1644
+ return this.apiClient.callApi(
1645
+ '/api/v2/analytics/evaluations/aggregates/jobs',
1646
+ 'POST',
1647
+ { },
1648
+ { },
1649
+ { },
1650
+ { },
1651
+ body,
1652
+ ['PureCloud OAuth'],
1653
+ ['application/json'],
1654
+ ['application/json']
1655
+ );
1656
+ }
1657
+
1658
+ /**
1659
+ * Query for evaluation aggregates
1660
+ *
1661
+ * @param {Object} body query
1662
+ */
1663
+ postAnalyticsEvaluationsAggregatesQuery(body) {
1664
+ // verify the required parameter 'body' is set
1665
+ if (body === undefined || body === null) {
1666
+ throw 'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';
1667
+ }
1668
+
1669
+ return this.apiClient.callApi(
1670
+ '/api/v2/analytics/evaluations/aggregates/query',
1671
+ 'POST',
520
1672
  { },
521
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
522
1673
  { },
523
1674
  { },
524
- null,
1675
+ { },
1676
+ body,
525
1677
  ['PureCloud OAuth'],
526
1678
  ['application/json'],
527
1679
  ['application/json']
@@ -529,19 +1681,30 @@ class AnalyticsApi {
529
1681
  }
530
1682
 
531
1683
  /**
532
- * Get AnalyticsReportingSettings for an organization
1684
+ * Query for flow activity observations
533
1685
  *
1686
+ * @param {Object} body query
1687
+ * @param {Object} opts Optional parameters
1688
+ * @param {Number} opts.pageSize The desired page size
1689
+ * @param {Number} opts.pageNumber The desired page number
1690
+ * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
534
1691
  */
535
- getAnalyticsReportingSettings() {
1692
+ postAnalyticsFlowsActivityQuery(body, opts) {
1693
+ opts = opts || {};
1694
+
1695
+ // verify the required parameter 'body' is set
1696
+ if (body === undefined || body === null) {
1697
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowsActivityQuery';
1698
+ }
536
1699
 
537
1700
  return this.apiClient.callApi(
538
- '/api/v2/analytics/reporting/settings',
539
- 'GET',
540
- { },
1701
+ '/api/v2/analytics/flows/activity/query',
1702
+ 'POST',
541
1703
  { },
1704
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
542
1705
  { },
543
1706
  { },
544
- null,
1707
+ body,
545
1708
  ['PureCloud OAuth'],
546
1709
  ['application/json'],
547
1710
  ['application/json']
@@ -549,19 +1712,25 @@ class AnalyticsApi {
549
1712
  }
550
1713
 
551
1714
  /**
552
- * Get a list of report time periods.
1715
+ * Query for flow aggregates asynchronously
553
1716
  *
1717
+ * @param {Object} body query
1718
+ * postAnalyticsFlowsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
554
1719
  */
555
- getAnalyticsReportingTimeperiods() {
1720
+ postAnalyticsFlowsAggregatesJobs(body) {
1721
+ // verify the required parameter 'body' is set
1722
+ if (body === undefined || body === null) {
1723
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesJobs';
1724
+ }
556
1725
 
557
1726
  return this.apiClient.callApi(
558
- '/api/v2/analytics/reporting/timeperiods',
559
- 'GET',
1727
+ '/api/v2/analytics/flows/aggregates/jobs',
1728
+ 'POST',
560
1729
  { },
561
1730
  { },
562
1731
  { },
563
1732
  { },
564
- null,
1733
+ body,
565
1734
  ['PureCloud OAuth'],
566
1735
  ['application/json'],
567
1736
  ['application/json']
@@ -569,24 +1738,24 @@ class AnalyticsApi {
569
1738
  }
570
1739
 
571
1740
  /**
572
- * Get status for async query for user details
1741
+ * Query for flow aggregates
573
1742
  *
574
- * @param {String} jobId jobId
1743
+ * @param {Object} body query
575
1744
  */
576
- getAnalyticsUsersDetailsJob(jobId) {
577
- // verify the required parameter 'jobId' is set
578
- if (jobId === undefined || jobId === null) {
579
- throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJob';
1745
+ postAnalyticsFlowsAggregatesQuery(body) {
1746
+ // verify the required parameter 'body' is set
1747
+ if (body === undefined || body === null) {
1748
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';
580
1749
  }
581
1750
 
582
1751
  return this.apiClient.callApi(
583
- '/api/v2/analytics/users/details/jobs/{jobId}',
584
- 'GET',
585
- { 'jobId': jobId },
1752
+ '/api/v2/analytics/flows/aggregates/query',
1753
+ 'POST',
586
1754
  { },
587
1755
  { },
588
1756
  { },
589
- null,
1757
+ { },
1758
+ body,
590
1759
  ['PureCloud OAuth'],
591
1760
  ['application/json'],
592
1761
  ['application/json']
@@ -594,29 +1763,24 @@ class AnalyticsApi {
594
1763
  }
595
1764
 
596
1765
  /**
597
- * Fetch a page of results for an async query
1766
+ * Query for flow observations
598
1767
  *
599
- * @param {String} jobId jobId
600
- * @param {Object} opts Optional parameters
601
- * @param {String} opts.cursor Indicates where to resume query results (not required for first page)
602
- * @param {Number} opts.pageSize The desired maximum number of results
1768
+ * @param {Object} body query
603
1769
  */
604
- getAnalyticsUsersDetailsJobResults(jobId, opts) {
605
- opts = opts || {};
606
-
607
- // verify the required parameter 'jobId' is set
608
- if (jobId === undefined || jobId === null) {
609
- throw 'Missing the required parameter "jobId" when calling getAnalyticsUsersDetailsJobResults';
1770
+ postAnalyticsFlowsObservationsQuery(body) {
1771
+ // verify the required parameter 'body' is set
1772
+ if (body === undefined || body === null) {
1773
+ throw 'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';
610
1774
  }
611
1775
 
612
1776
  return this.apiClient.callApi(
613
- '/api/v2/analytics/users/details/jobs/{jobId}/results',
614
- 'GET',
615
- { 'jobId': jobId },
616
- { 'cursor': opts['cursor'],'pageSize': opts['pageSize'] },
1777
+ '/api/v2/analytics/flows/observations/query',
1778
+ 'POST',
617
1779
  { },
618
1780
  { },
619
- null,
1781
+ { },
1782
+ { },
1783
+ body,
620
1784
  ['PureCloud OAuth'],
621
1785
  ['application/json'],
622
1786
  ['application/json']
@@ -624,19 +1788,25 @@ class AnalyticsApi {
624
1788
  }
625
1789
 
626
1790
  /**
627
- * Lookup the datalake availability date and time
1791
+ * Query for journey aggregates asynchronously
628
1792
  *
1793
+ * @param {Object} body query
1794
+ * postAnalyticsJourneysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
629
1795
  */
630
- getAnalyticsUsersDetailsJobsAvailability() {
1796
+ postAnalyticsJourneysAggregatesJobs(body) {
1797
+ // verify the required parameter 'body' is set
1798
+ if (body === undefined || body === null) {
1799
+ throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesJobs';
1800
+ }
631
1801
 
632
1802
  return this.apiClient.callApi(
633
- '/api/v2/analytics/users/details/jobs/availability',
634
- 'GET',
1803
+ '/api/v2/analytics/journeys/aggregates/jobs',
1804
+ 'POST',
635
1805
  { },
636
1806
  { },
637
1807
  { },
638
1808
  { },
639
- null,
1809
+ body,
640
1810
  ['PureCloud OAuth'],
641
1811
  ['application/json'],
642
1812
  ['application/json']
@@ -644,19 +1814,19 @@ class AnalyticsApi {
644
1814
  }
645
1815
 
646
1816
  /**
647
- * Patch AnalyticsReportingSettings values for an organization
1817
+ * Query for journey aggregates
648
1818
  *
649
- * @param {Object} body AnalyticsReportingSettingsRequest
1819
+ * @param {Object} body query
650
1820
  */
651
- patchAnalyticsReportingSettings(body) {
1821
+ postAnalyticsJourneysAggregatesQuery(body) {
652
1822
  // verify the required parameter 'body' is set
653
1823
  if (body === undefined || body === null) {
654
- throw 'Missing the required parameter "body" when calling patchAnalyticsReportingSettings';
1824
+ throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';
655
1825
  }
656
1826
 
657
1827
  return this.apiClient.callApi(
658
- '/api/v2/analytics/reporting/settings',
659
- 'PATCH',
1828
+ '/api/v2/analytics/journeys/aggregates/query',
1829
+ 'POST',
660
1830
  { },
661
1831
  { },
662
1832
  { },
@@ -669,18 +1839,19 @@ class AnalyticsApi {
669
1839
  }
670
1840
 
671
1841
  /**
672
- * Query for action aggregates
1842
+ * Query for knowledge aggregates asynchronously
673
1843
  *
674
1844
  * @param {Object} body query
1845
+ * postAnalyticsKnowledgeAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
675
1846
  */
676
- postAnalyticsActionsAggregatesQuery(body) {
1847
+ postAnalyticsKnowledgeAggregatesJobs(body) {
677
1848
  // verify the required parameter 'body' is set
678
1849
  if (body === undefined || body === null) {
679
- throw 'Missing the required parameter "body" when calling postAnalyticsActionsAggregatesQuery';
1850
+ throw 'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesJobs';
680
1851
  }
681
1852
 
682
1853
  return this.apiClient.callApi(
683
- '/api/v2/analytics/actions/aggregates/query',
1854
+ '/api/v2/analytics/knowledge/aggregates/jobs',
684
1855
  'POST',
685
1856
  { },
686
1857
  { },
@@ -694,18 +1865,19 @@ class AnalyticsApi {
694
1865
  }
695
1866
 
696
1867
  /**
697
- * Query for bot aggregates
1868
+ * Query for knowledge aggregates
698
1869
  *
699
1870
  * @param {Object} body query
1871
+ * postAnalyticsKnowledgeAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
700
1872
  */
701
- postAnalyticsBotsAggregatesQuery(body) {
1873
+ postAnalyticsKnowledgeAggregatesQuery(body) {
702
1874
  // verify the required parameter 'body' is set
703
1875
  if (body === undefined || body === null) {
704
- throw 'Missing the required parameter "body" when calling postAnalyticsBotsAggregatesQuery';
1876
+ throw 'Missing the required parameter "body" when calling postAnalyticsKnowledgeAggregatesQuery';
705
1877
  }
706
1878
 
707
1879
  return this.apiClient.callApi(
708
- '/api/v2/analytics/bots/aggregates/query',
1880
+ '/api/v2/analytics/knowledge/aggregates/query',
709
1881
  'POST',
710
1882
  { },
711
1883
  { },
@@ -719,25 +1891,20 @@ class AnalyticsApi {
719
1891
  }
720
1892
 
721
1893
  /**
722
- * Index conversation properties
1894
+ * Query for queue observations
723
1895
  *
724
- * @param {String} conversationId conversationId
725
- * @param {Object} body request
1896
+ * @param {Object} body query
726
1897
  */
727
- postAnalyticsConversationDetailsProperties(conversationId, body) {
728
- // verify the required parameter 'conversationId' is set
729
- if (conversationId === undefined || conversationId === null) {
730
- throw 'Missing the required parameter "conversationId" when calling postAnalyticsConversationDetailsProperties';
731
- }
1898
+ postAnalyticsQueuesObservationsQuery(body) {
732
1899
  // verify the required parameter 'body' is set
733
1900
  if (body === undefined || body === null) {
734
- throw 'Missing the required parameter "body" when calling postAnalyticsConversationDetailsProperties';
1901
+ throw 'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';
735
1902
  }
736
1903
 
737
1904
  return this.apiClient.callApi(
738
- '/api/v2/analytics/conversations/{conversationId}/details/properties',
1905
+ '/api/v2/analytics/queues/observations/query',
739
1906
  'POST',
740
- { 'conversationId': conversationId },
1907
+ { },
741
1908
  { },
742
1909
  { },
743
1910
  { },
@@ -749,18 +1916,18 @@ class AnalyticsApi {
749
1916
  }
750
1917
 
751
1918
  /**
752
- * Query for conversation aggregates
753
- *
754
- * @param {Object} body query
1919
+ * Generate a view export request
1920
+ * This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
1921
+ * @param {Object} body ReportingExportJobRequest
755
1922
  */
756
- postAnalyticsConversationsAggregatesQuery(body) {
1923
+ postAnalyticsReportingExports(body) {
757
1924
  // verify the required parameter 'body' is set
758
1925
  if (body === undefined || body === null) {
759
- throw 'Missing the required parameter "body" when calling postAnalyticsConversationsAggregatesQuery';
1926
+ throw 'Missing the required parameter "body" when calling postAnalyticsReportingExports';
760
1927
  }
761
1928
 
762
1929
  return this.apiClient.callApi(
763
- '/api/v2/analytics/conversations/aggregates/query',
1930
+ '/api/v2/analytics/reporting/exports',
764
1931
  'POST',
765
1932
  { },
766
1933
  { },
@@ -774,24 +1941,24 @@ class AnalyticsApi {
774
1941
  }
775
1942
 
776
1943
  /**
777
- * Query for conversation details asynchronously
1944
+ * Place a scheduled report immediately into the reporting queue
778
1945
  *
779
- * @param {Object} body query
1946
+ * @param {String} scheduleId Schedule ID
780
1947
  */
781
- postAnalyticsConversationsDetailsJobs(body) {
782
- // verify the required parameter 'body' is set
783
- if (body === undefined || body === null) {
784
- throw 'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsJobs';
1948
+ postAnalyticsReportingScheduleRunreport(scheduleId) {
1949
+ // verify the required parameter 'scheduleId' is set
1950
+ if (scheduleId === undefined || scheduleId === null) {
1951
+ throw 'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';
785
1952
  }
786
1953
 
787
1954
  return this.apiClient.callApi(
788
- '/api/v2/analytics/conversations/details/jobs',
1955
+ '/api/v2/analytics/reporting/schedules/{scheduleId}/runreport',
789
1956
  'POST',
1957
+ { 'scheduleId': scheduleId },
790
1958
  { },
791
1959
  { },
792
1960
  { },
793
- { },
794
- body,
1961
+ null,
795
1962
  ['PureCloud OAuth'],
796
1963
  ['application/json'],
797
1964
  ['application/json']
@@ -799,18 +1966,18 @@ class AnalyticsApi {
799
1966
  }
800
1967
 
801
1968
  /**
802
- * Query for conversation details
803
- *
804
- * @param {Object} body query
1969
+ * Create a scheduled report job
1970
+ * Create a scheduled report job.
1971
+ * @param {Object} body ReportSchedule
805
1972
  */
806
- postAnalyticsConversationsDetailsQuery(body) {
1973
+ postAnalyticsReportingSchedules(body) {
807
1974
  // verify the required parameter 'body' is set
808
1975
  if (body === undefined || body === null) {
809
- throw 'Missing the required parameter "body" when calling postAnalyticsConversationsDetailsQuery';
1976
+ throw 'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';
810
1977
  }
811
1978
 
812
1979
  return this.apiClient.callApi(
813
- '/api/v2/analytics/conversations/details/query',
1980
+ '/api/v2/analytics/reporting/schedules',
814
1981
  'POST',
815
1982
  { },
816
1983
  { },
@@ -824,18 +1991,19 @@ class AnalyticsApi {
824
1991
  }
825
1992
 
826
1993
  /**
827
- * Search resources.
1994
+ * Query for resolution aggregates asynchronously
828
1995
  *
829
- * @param {Object} body Search request options
1996
+ * @param {Object} body query
1997
+ * postAnalyticsResolutionsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
830
1998
  */
831
- postAnalyticsConversationsTranscriptsQuery(body) {
1999
+ postAnalyticsResolutionsAggregatesJobs(body) {
832
2000
  // verify the required parameter 'body' is set
833
2001
  if (body === undefined || body === null) {
834
- throw 'Missing the required parameter "body" when calling postAnalyticsConversationsTranscriptsQuery';
2002
+ throw 'Missing the required parameter "body" when calling postAnalyticsResolutionsAggregatesJobs';
835
2003
  }
836
2004
 
837
2005
  return this.apiClient.callApi(
838
- '/api/v2/analytics/conversations/transcripts/query',
2006
+ '/api/v2/analytics/resolutions/aggregates/jobs',
839
2007
  'POST',
840
2008
  { },
841
2009
  { },
@@ -849,21 +2017,27 @@ class AnalyticsApi {
849
2017
  }
850
2018
 
851
2019
  /**
852
- * Query for evaluation aggregates
2020
+ * Query for user activity observations
853
2021
  *
854
2022
  * @param {Object} body query
2023
+ * @param {Object} opts Optional parameters
2024
+ * @param {Number} opts.pageSize The desired page size
2025
+ * @param {Number} opts.pageNumber The desired page number
2026
+ * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
855
2027
  */
856
- postAnalyticsEvaluationsAggregatesQuery(body) {
2028
+ postAnalyticsRoutingActivityQuery(body, opts) {
2029
+ opts = opts || {};
2030
+
857
2031
  // verify the required parameter 'body' is set
858
2032
  if (body === undefined || body === null) {
859
- throw 'Missing the required parameter "body" when calling postAnalyticsEvaluationsAggregatesQuery';
2033
+ throw 'Missing the required parameter "body" when calling postAnalyticsRoutingActivityQuery';
860
2034
  }
861
2035
 
862
2036
  return this.apiClient.callApi(
863
- '/api/v2/analytics/evaluations/aggregates/query',
2037
+ '/api/v2/analytics/routing/activity/query',
864
2038
  'POST',
865
2039
  { },
866
- { },
2040
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
867
2041
  { },
868
2042
  { },
869
2043
  body,
@@ -874,18 +2048,19 @@ class AnalyticsApi {
874
2048
  }
875
2049
 
876
2050
  /**
877
- * Query for flow aggregates
2051
+ * Query for survey aggregates asynchronously
878
2052
  *
879
2053
  * @param {Object} body query
2054
+ * postAnalyticsSurveysAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
880
2055
  */
881
- postAnalyticsFlowsAggregatesQuery(body) {
2056
+ postAnalyticsSurveysAggregatesJobs(body) {
882
2057
  // verify the required parameter 'body' is set
883
2058
  if (body === undefined || body === null) {
884
- throw 'Missing the required parameter "body" when calling postAnalyticsFlowsAggregatesQuery';
2059
+ throw 'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesJobs';
885
2060
  }
886
2061
 
887
2062
  return this.apiClient.callApi(
888
- '/api/v2/analytics/flows/aggregates/query',
2063
+ '/api/v2/analytics/surveys/aggregates/jobs',
889
2064
  'POST',
890
2065
  { },
891
2066
  { },
@@ -899,18 +2074,18 @@ class AnalyticsApi {
899
2074
  }
900
2075
 
901
2076
  /**
902
- * Query for flow observations
2077
+ * Query for survey aggregates
903
2078
  *
904
2079
  * @param {Object} body query
905
2080
  */
906
- postAnalyticsFlowsObservationsQuery(body) {
2081
+ postAnalyticsSurveysAggregatesQuery(body) {
907
2082
  // verify the required parameter 'body' is set
908
2083
  if (body === undefined || body === null) {
909
- throw 'Missing the required parameter "body" when calling postAnalyticsFlowsObservationsQuery';
2084
+ throw 'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesQuery';
910
2085
  }
911
2086
 
912
2087
  return this.apiClient.callApi(
913
- '/api/v2/analytics/flows/observations/query',
2088
+ '/api/v2/analytics/surveys/aggregates/query',
914
2089
  'POST',
915
2090
  { },
916
2091
  { },
@@ -924,18 +2099,19 @@ class AnalyticsApi {
924
2099
  }
925
2100
 
926
2101
  /**
927
- * Query for journey aggregates
2102
+ * Query for task management aggregates asynchronously
928
2103
  *
929
2104
  * @param {Object} body query
2105
+ * postAnalyticsTaskmanagementAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
930
2106
  */
931
- postAnalyticsJourneysAggregatesQuery(body) {
2107
+ postAnalyticsTaskmanagementAggregatesJobs(body) {
932
2108
  // verify the required parameter 'body' is set
933
2109
  if (body === undefined || body === null) {
934
- throw 'Missing the required parameter "body" when calling postAnalyticsJourneysAggregatesQuery';
2110
+ throw 'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesJobs';
935
2111
  }
936
2112
 
937
2113
  return this.apiClient.callApi(
938
- '/api/v2/analytics/journeys/aggregates/query',
2114
+ '/api/v2/analytics/taskmanagement/aggregates/jobs',
939
2115
  'POST',
940
2116
  { },
941
2117
  { },
@@ -949,18 +2125,19 @@ class AnalyticsApi {
949
2125
  }
950
2126
 
951
2127
  /**
952
- * Query for queue observations
2128
+ * Query for task management aggregates
953
2129
  *
954
2130
  * @param {Object} body query
2131
+ * postAnalyticsTaskmanagementAggregatesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
955
2132
  */
956
- postAnalyticsQueuesObservationsQuery(body) {
2133
+ postAnalyticsTaskmanagementAggregatesQuery(body) {
957
2134
  // verify the required parameter 'body' is set
958
2135
  if (body === undefined || body === null) {
959
- throw 'Missing the required parameter "body" when calling postAnalyticsQueuesObservationsQuery';
2136
+ throw 'Missing the required parameter "body" when calling postAnalyticsTaskmanagementAggregatesQuery';
960
2137
  }
961
2138
 
962
2139
  return this.apiClient.callApi(
963
- '/api/v2/analytics/queues/observations/query',
2140
+ '/api/v2/analytics/taskmanagement/aggregates/query',
964
2141
  'POST',
965
2142
  { },
966
2143
  { },
@@ -974,21 +2151,27 @@ class AnalyticsApi {
974
2151
  }
975
2152
 
976
2153
  /**
977
- * Generate a view export request
978
- * This API creates a reporting export but the desired way to export analytics data is to use the analytics query APIs instead
979
- * @param {Object} body ReportingExportJobRequest
2154
+ * Query for team activity observations
2155
+ *
2156
+ * @param {Object} body query
2157
+ * @param {Object} opts Optional parameters
2158
+ * @param {Number} opts.pageSize The desired page size
2159
+ * @param {Number} opts.pageNumber The desired page number
2160
+ * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
980
2161
  */
981
- postAnalyticsReportingExports(body) {
2162
+ postAnalyticsTeamsActivityQuery(body, opts) {
2163
+ opts = opts || {};
2164
+
982
2165
  // verify the required parameter 'body' is set
983
2166
  if (body === undefined || body === null) {
984
- throw 'Missing the required parameter "body" when calling postAnalyticsReportingExports';
2167
+ throw 'Missing the required parameter "body" when calling postAnalyticsTeamsActivityQuery';
985
2168
  }
986
2169
 
987
2170
  return this.apiClient.callApi(
988
- '/api/v2/analytics/reporting/exports',
2171
+ '/api/v2/analytics/teams/activity/query',
989
2172
  'POST',
990
2173
  { },
991
- { },
2174
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
992
2175
  { },
993
2176
  { },
994
2177
  body,
@@ -999,24 +2182,25 @@ class AnalyticsApi {
999
2182
  }
1000
2183
 
1001
2184
  /**
1002
- * Place a scheduled report immediately into the reporting queue
2185
+ * Query for transcript aggregates asynchronously
1003
2186
  *
1004
- * @param {String} scheduleId Schedule ID
2187
+ * @param {Object} body query
2188
+ * postAnalyticsTranscriptsAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1005
2189
  */
1006
- postAnalyticsReportingScheduleRunreport(scheduleId) {
1007
- // verify the required parameter 'scheduleId' is set
1008
- if (scheduleId === undefined || scheduleId === null) {
1009
- throw 'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';
2190
+ postAnalyticsTranscriptsAggregatesJobs(body) {
2191
+ // verify the required parameter 'body' is set
2192
+ if (body === undefined || body === null) {
2193
+ throw 'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesJobs';
1010
2194
  }
1011
2195
 
1012
2196
  return this.apiClient.callApi(
1013
- '/api/v2/analytics/reporting/schedules/{scheduleId}/runreport',
2197
+ '/api/v2/analytics/transcripts/aggregates/jobs',
1014
2198
  'POST',
1015
- { 'scheduleId': scheduleId },
1016
2199
  { },
1017
2200
  { },
1018
2201
  { },
1019
- null,
2202
+ { },
2203
+ body,
1020
2204
  ['PureCloud OAuth'],
1021
2205
  ['application/json'],
1022
2206
  ['application/json']
@@ -1024,18 +2208,18 @@ class AnalyticsApi {
1024
2208
  }
1025
2209
 
1026
2210
  /**
1027
- * Create a scheduled report job
1028
- * Create a scheduled report job.
1029
- * @param {Object} body ReportSchedule
2211
+ * Query for transcript aggregates
2212
+ *
2213
+ * @param {Object} body query
1030
2214
  */
1031
- postAnalyticsReportingSchedules(body) {
2215
+ postAnalyticsTranscriptsAggregatesQuery(body) {
1032
2216
  // verify the required parameter 'body' is set
1033
2217
  if (body === undefined || body === null) {
1034
- throw 'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';
2218
+ throw 'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesQuery';
1035
2219
  }
1036
2220
 
1037
2221
  return this.apiClient.callApi(
1038
- '/api/v2/analytics/reporting/schedules',
2222
+ '/api/v2/analytics/transcripts/aggregates/query',
1039
2223
  'POST',
1040
2224
  { },
1041
2225
  { },
@@ -1049,21 +2233,27 @@ class AnalyticsApi {
1049
2233
  }
1050
2234
 
1051
2235
  /**
1052
- * Query for survey aggregates
2236
+ * Query for user activity observations
1053
2237
  *
1054
2238
  * @param {Object} body query
2239
+ * @param {Object} opts Optional parameters
2240
+ * @param {Number} opts.pageSize The desired page size
2241
+ * @param {Number} opts.pageNumber The desired page number
2242
+ * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1055
2243
  */
1056
- postAnalyticsSurveysAggregatesQuery(body) {
2244
+ postAnalyticsUsersActivityQuery(body, opts) {
2245
+ opts = opts || {};
2246
+
1057
2247
  // verify the required parameter 'body' is set
1058
2248
  if (body === undefined || body === null) {
1059
- throw 'Missing the required parameter "body" when calling postAnalyticsSurveysAggregatesQuery';
2249
+ throw 'Missing the required parameter "body" when calling postAnalyticsUsersActivityQuery';
1060
2250
  }
1061
2251
 
1062
2252
  return this.apiClient.callApi(
1063
- '/api/v2/analytics/surveys/aggregates/query',
2253
+ '/api/v2/analytics/users/activity/query',
1064
2254
  'POST',
1065
2255
  { },
1066
- { },
2256
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
1067
2257
  { },
1068
2258
  { },
1069
2259
  body,
@@ -1074,18 +2264,19 @@ class AnalyticsApi {
1074
2264
  }
1075
2265
 
1076
2266
  /**
1077
- * Query for transcript aggregates
2267
+ * Query for user aggregates asynchronously
1078
2268
  *
1079
2269
  * @param {Object} body query
2270
+ * postAnalyticsUsersAggregatesJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
1080
2271
  */
1081
- postAnalyticsTranscriptsAggregatesQuery(body) {
2272
+ postAnalyticsUsersAggregatesJobs(body) {
1082
2273
  // verify the required parameter 'body' is set
1083
2274
  if (body === undefined || body === null) {
1084
- throw 'Missing the required parameter "body" when calling postAnalyticsTranscriptsAggregatesQuery';
2275
+ throw 'Missing the required parameter "body" when calling postAnalyticsUsersAggregatesJobs';
1085
2276
  }
1086
2277
 
1087
2278
  return this.apiClient.callApi(
1088
- '/api/v2/analytics/transcripts/aggregates/query',
2279
+ '/api/v2/analytics/users/aggregates/jobs',
1089
2280
  'POST',
1090
2281
  { },
1091
2282
  { },