purecloud-platform-client-v2 192.2.0 → 193.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 (85) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +188 -467
  3. package/dist/web-amd/purecloud-platform-client-v2.js +188 -467
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +193 -278
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +193 -278
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +583 -602
  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 +40 -346
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  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 +48 -1
  19. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +1 -2
  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/EmailsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -2
  29. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/JourneyApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  40. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +21 -1
  52. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/QualityApi.js +3 -3
  57. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -2
  60. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -38
  69. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -2
  70. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  71. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -2
  78. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +5 -3
  85. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -402,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 192.2.0
405
+ * @version 193.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1821,7 +1821,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1821
1821
  /**
1822
1822
  * Alerting service.
1823
1823
  * @module purecloud-platform-client-v2/api/AlertingApi
1824
- * @version 192.2.0
1824
+ * @version 193.0.0
1825
1825
  */
1826
1826
 
1827
1827
  /**
@@ -2482,7 +2482,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2482
2482
  /**
2483
2483
  * Analytics service.
2484
2484
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2485
- * @version 192.2.0
2485
+ * @version 193.0.0
2486
2486
  */
2487
2487
 
2488
2488
  /**
@@ -2522,31 +2522,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2522
2522
  );
2523
2523
  }
2524
2524
 
2525
- /**
2526
- * Delete a scheduled report job.
2527
- *
2528
- * @param {String} scheduleId Schedule ID
2529
- */
2530
- deleteAnalyticsReportingSchedule(scheduleId) {
2531
- // verify the required parameter 'scheduleId' is set
2532
- if (scheduleId === undefined || scheduleId === null) {
2533
- throw 'Missing the required parameter "scheduleId" when calling deleteAnalyticsReportingSchedule';
2534
- }
2535
-
2536
- return this.apiClient.callApi(
2537
- '/api/v2/analytics/reporting/schedules/{scheduleId}',
2538
- 'DELETE',
2539
- { 'scheduleId': scheduleId },
2540
- { },
2541
- { },
2542
- { },
2543
- null,
2544
- ['PureCloud OAuth'],
2545
- ['application/json'],
2546
- ['application/json']
2547
- );
2548
- }
2549
-
2550
2525
  /**
2551
2526
  * Delete/cancel an async request
2552
2527
  *
@@ -2628,9 +2603,44 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2628
2603
  );
2629
2604
  }
2630
2605
 
2606
+ /**
2607
+ * Get Reporting Turns (division aware).
2608
+ * Returns the reporting turns for the specified flow, filtered by the clients divisions and 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. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
2609
+ * @param {String} botFlowId ID of the bot flow.
2610
+ * @param {Object} opts Optional parameters
2611
+ * @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
2612
+ * @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
2613
+ * @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
2614
+ * @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
2615
+ * @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.
2616
+ * @param {String} opts.language Optional language code to get the reporting turns for a particular language
2617
+ * @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
2618
+ */
2619
+ getAnalyticsBotflowDivisionsReportingturns(botFlowId, opts) {
2620
+ opts = opts || {};
2621
+
2622
+ // verify the required parameter 'botFlowId' is set
2623
+ if (botFlowId === undefined || botFlowId === null) {
2624
+ throw 'Missing the required parameter "botFlowId" when calling getAnalyticsBotflowDivisionsReportingturns';
2625
+ }
2626
+
2627
+ return this.apiClient.callApi(
2628
+ '/api/v2/analytics/botflows/{botFlowId}/divisions/reportingturns',
2629
+ 'GET',
2630
+ { 'botFlowId': botFlowId },
2631
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
2632
+ { },
2633
+ { },
2634
+ null,
2635
+ ['PureCloud OAuth'],
2636
+ ['application/json'],
2637
+ ['application/json']
2638
+ );
2639
+ }
2640
+
2631
2641
  /**
2632
2642
  * Get Reporting Turns.
2633
- * 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. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
2643
+ * Deprecated: Please use GET /analytics/botflows/{botFlowId}/divisions/reportingturns instead. 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. For pagination, clients should keep sending requests using the value of nextUri in the response, until its no longer present, only then have all items have been returned. Note: resources returned by this endpoint are not persisted indefinitely, as they are deleted after approximately, but not before, 10 days.
2634
2644
  * @param {String} botFlowId ID of the bot flow.
2635
2645
  * @param {Object} opts Optional parameters
2636
2646
  * @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
@@ -2640,6 +2650,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2640
2650
  * @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.
2641
2651
  * @param {String} opts.language Optional language code to get the reporting turns for a particular language
2642
2652
  * @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
2653
+ * @deprecated
2643
2654
  */
2644
2655
  getAnalyticsBotflowReportingturns(botFlowId, opts) {
2645
2656
  opts = opts || {};
@@ -3330,216 +3341,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3330
3341
  );
3331
3342
  }
3332
3343
 
3333
- /**
3334
- * Get list of reporting metadata.
3335
- *
3336
- * @param {Object} opts Optional parameters
3337
- * @param {Number} opts.pageNumber Page number (default to 1)
3338
- * @param {Number} opts.pageSize Page size (default to 25)
3339
- * @param {String} opts.locale Locale
3340
- */
3341
- getAnalyticsReportingMetadata(opts) {
3342
- opts = opts || {};
3343
-
3344
-
3345
- return this.apiClient.callApi(
3346
- '/api/v2/analytics/reporting/metadata',
3347
- 'GET',
3348
- { },
3349
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'locale': opts['locale'] },
3350
- { },
3351
- { },
3352
- null,
3353
- ['PureCloud OAuth'],
3354
- ['application/json'],
3355
- ['application/json']
3356
- );
3357
- }
3358
-
3359
- /**
3360
- * Get a reporting metadata.
3361
- *
3362
- * @param {String} reportId Report ID
3363
- * @param {Object} opts Optional parameters
3364
- * @param {String} opts.locale Locale
3365
- */
3366
- getAnalyticsReportingReportIdMetadata(reportId, opts) {
3367
- opts = opts || {};
3368
-
3369
- // verify the required parameter 'reportId' is set
3370
- if (reportId === undefined || reportId === null) {
3371
- throw 'Missing the required parameter "reportId" when calling getAnalyticsReportingReportIdMetadata';
3372
- }
3373
-
3374
- return this.apiClient.callApi(
3375
- '/api/v2/analytics/reporting/{reportId}/metadata',
3376
- 'GET',
3377
- { 'reportId': reportId },
3378
- { 'locale': opts['locale'] },
3379
- { },
3380
- { },
3381
- null,
3382
- ['PureCloud OAuth'],
3383
- ['application/json'],
3384
- ['application/json']
3385
- );
3386
- }
3387
-
3388
- /**
3389
- * Get a list of report formats
3390
- * Get a list of report formats.
3391
- */
3392
- getAnalyticsReportingReportformats() {
3393
-
3394
- return this.apiClient.callApi(
3395
- '/api/v2/analytics/reporting/reportformats',
3396
- 'GET',
3397
- { },
3398
- { },
3399
- { },
3400
- { },
3401
- null,
3402
- ['PureCloud OAuth'],
3403
- ['application/json'],
3404
- ['application/json']
3405
- );
3406
- }
3407
-
3408
- /**
3409
- * Get a scheduled report job.
3410
- *
3411
- * @param {String} scheduleId Schedule ID
3412
- */
3413
- getAnalyticsReportingSchedule(scheduleId) {
3414
- // verify the required parameter 'scheduleId' is set
3415
- if (scheduleId === undefined || scheduleId === null) {
3416
- throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingSchedule';
3417
- }
3418
-
3419
- return this.apiClient.callApi(
3420
- '/api/v2/analytics/reporting/schedules/{scheduleId}',
3421
- 'GET',
3422
- { 'scheduleId': scheduleId },
3423
- { },
3424
- { },
3425
- { },
3426
- null,
3427
- ['PureCloud OAuth'],
3428
- ['application/json'],
3429
- ['application/json']
3430
- );
3431
- }
3432
-
3433
- /**
3434
- * Get list of completed scheduled report jobs.
3435
- *
3436
- * @param {String} scheduleId Schedule ID
3437
- * @param {Object} opts Optional parameters
3438
- * @param {Number} opts.pageNumber (default to 1)
3439
- * @param {Number} opts.pageSize (default to 25)
3440
- */
3441
- getAnalyticsReportingScheduleHistory(scheduleId, opts) {
3442
- opts = opts || {};
3443
-
3444
- // verify the required parameter 'scheduleId' is set
3445
- if (scheduleId === undefined || scheduleId === null) {
3446
- throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistory';
3447
- }
3448
-
3449
- return this.apiClient.callApi(
3450
- '/api/v2/analytics/reporting/schedules/{scheduleId}/history',
3451
- 'GET',
3452
- { 'scheduleId': scheduleId },
3453
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
3454
- { },
3455
- { },
3456
- null,
3457
- ['PureCloud OAuth'],
3458
- ['application/json'],
3459
- ['application/json']
3460
- );
3461
- }
3462
-
3463
- /**
3464
- * Get most recently completed scheduled report job.
3465
- *
3466
- * @param {String} scheduleId Schedule ID
3467
- */
3468
- getAnalyticsReportingScheduleHistoryLatest(scheduleId) {
3469
- // verify the required parameter 'scheduleId' is set
3470
- if (scheduleId === undefined || scheduleId === null) {
3471
- throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryLatest';
3472
- }
3473
-
3474
- return this.apiClient.callApi(
3475
- '/api/v2/analytics/reporting/schedules/{scheduleId}/history/latest',
3476
- 'GET',
3477
- { 'scheduleId': scheduleId },
3478
- { },
3479
- { },
3480
- { },
3481
- null,
3482
- ['PureCloud OAuth'],
3483
- ['application/json'],
3484
- ['application/json']
3485
- );
3486
- }
3487
-
3488
- /**
3489
- * A completed scheduled report job
3490
- * A completed scheduled report job.
3491
- * @param {String} runId Run ID
3492
- * @param {String} scheduleId Schedule ID
3493
- */
3494
- getAnalyticsReportingScheduleHistoryRunId(runId, scheduleId) {
3495
- // verify the required parameter 'runId' is set
3496
- if (runId === undefined || runId === null) {
3497
- throw 'Missing the required parameter "runId" when calling getAnalyticsReportingScheduleHistoryRunId';
3498
- }
3499
- // verify the required parameter 'scheduleId' is set
3500
- if (scheduleId === undefined || scheduleId === null) {
3501
- throw 'Missing the required parameter "scheduleId" when calling getAnalyticsReportingScheduleHistoryRunId';
3502
- }
3503
-
3504
- return this.apiClient.callApi(
3505
- '/api/v2/analytics/reporting/schedules/{scheduleId}/history/{runId}',
3506
- 'GET',
3507
- { 'runId': runId,'scheduleId': scheduleId },
3508
- { },
3509
- { },
3510
- { },
3511
- null,
3512
- ['PureCloud OAuth'],
3513
- ['application/json'],
3514
- ['application/json']
3515
- );
3516
- }
3517
-
3518
- /**
3519
- * Get a list of scheduled report jobs
3520
- * Get a list of scheduled report jobs.
3521
- * @param {Object} opts Optional parameters
3522
- * @param {Number} opts.pageNumber Page number (default to 1)
3523
- * @param {Number} opts.pageSize Page size (default to 25)
3524
- */
3525
- getAnalyticsReportingSchedules(opts) {
3526
- opts = opts || {};
3527
-
3528
-
3529
- return this.apiClient.callApi(
3530
- '/api/v2/analytics/reporting/schedules',
3531
- 'GET',
3532
- { },
3533
- { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'] },
3534
- { },
3535
- { },
3536
- null,
3537
- ['PureCloud OAuth'],
3538
- ['application/json'],
3539
- ['application/json']
3540
- );
3541
- }
3542
-
3543
3344
  /**
3544
3345
  * Get AnalyticsReportingSettings for an organization
3545
3346
  *
@@ -3570,6 +3371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3570
3371
  * @param {Number} opts.pageSize (default to 50)
3571
3372
  * @param {Boolean} opts.publicOnly If true, retrieve only public dashboards
3572
3373
  * @param {Boolean} opts.favoriteOnly If true, retrieve only favorite dashboards
3374
+ * @param {String} opts.name retrieve dashboards that match with given name
3573
3375
  */
3574
3376
  getAnalyticsReportingSettingsUserDashboards(userId, opts) {
3575
3377
  opts = opts || {};
@@ -3583,27 +3385,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
3583
3385
  '/api/v2/analytics/reporting/settings/users/{userId}/dashboards',
3584
3386
  'GET',
3585
3387
  { 'userId': userId },
3586
- { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'] },
3587
- { },
3588
- { },
3589
- null,
3590
- ['PureCloud OAuth'],
3591
- ['application/json'],
3592
- ['application/json']
3593
- );
3594
- }
3595
-
3596
- /**
3597
- * Get a list of report time periods.
3598
- *
3599
- */
3600
- getAnalyticsReportingTimeperiods() {
3601
-
3602
- return this.apiClient.callApi(
3603
- '/api/v2/analytics/reporting/timeperiods',
3604
- 'GET',
3605
- { },
3606
- { },
3388
+ { 'sortBy': opts['sortBy'],'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'publicOnly': opts['publicOnly'],'favoriteOnly': opts['favoriteOnly'],'name': opts['name'] },
3607
3389
  { },
3608
3390
  { },
3609
3391
  null,
@@ -4132,7 +3914,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4132
3914
  * @param {Object} opts Optional parameters
4133
3915
  * @param {Number} opts.pageSize The desired page size
4134
3916
  * @param {Number} opts.pageNumber The desired page number
4135
- * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4136
3917
  */
4137
3918
  postAnalyticsConversationsActivityQuery(body, opts) {
4138
3919
  opts = opts || {};
@@ -4391,7 +4172,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4391
4172
  * @param {Object} opts Optional parameters
4392
4173
  * @param {Number} opts.pageSize The desired page size
4393
4174
  * @param {Number} opts.pageNumber The desired page number
4394
- * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4395
4175
  */
4396
4176
  postAnalyticsFlowsActivityQuery(body, opts) {
4397
4177
  opts = opts || {};
@@ -4693,58 +4473,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4693
4473
  );
4694
4474
  }
4695
4475
 
4696
- /**
4697
- * Place a scheduled report immediately into the reporting queue
4698
- * This route is deprecated, please use POST:api/v2/analytics/reporting/exports/{exportId}/execute instead
4699
- * @param {String} scheduleId Schedule ID
4700
- * @deprecated
4701
- */
4702
- postAnalyticsReportingScheduleRunreport(scheduleId) {
4703
- // verify the required parameter 'scheduleId' is set
4704
- if (scheduleId === undefined || scheduleId === null) {
4705
- throw 'Missing the required parameter "scheduleId" when calling postAnalyticsReportingScheduleRunreport';
4706
- }
4707
-
4708
- return this.apiClient.callApi(
4709
- '/api/v2/analytics/reporting/schedules/{scheduleId}/runreport',
4710
- 'POST',
4711
- { 'scheduleId': scheduleId },
4712
- { },
4713
- { },
4714
- { },
4715
- null,
4716
- ['PureCloud OAuth'],
4717
- ['application/json'],
4718
- ['application/json']
4719
- );
4720
- }
4721
-
4722
- /**
4723
- * Create a scheduled report job
4724
- * This route is deprecated, please use POST:api/v2/analytics/reporting/exports instead
4725
- * @param {Object} body ReportSchedule
4726
- * @deprecated
4727
- */
4728
- postAnalyticsReportingSchedules(body) {
4729
- // verify the required parameter 'body' is set
4730
- if (body === undefined || body === null) {
4731
- throw 'Missing the required parameter "body" when calling postAnalyticsReportingSchedules';
4732
- }
4733
-
4734
- return this.apiClient.callApi(
4735
- '/api/v2/analytics/reporting/schedules',
4736
- 'POST',
4737
- { },
4738
- { },
4739
- { },
4740
- { },
4741
- body,
4742
- ['PureCloud OAuth'],
4743
- ['application/json'],
4744
- ['application/json']
4745
- );
4746
- }
4747
-
4748
4476
  /**
4749
4477
  * Bulk remove dashboard configurations
4750
4478
  *
@@ -4828,7 +4556,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4828
4556
  * @param {Object} opts Optional parameters
4829
4557
  * @param {Number} opts.pageSize The desired page size
4830
4558
  * @param {Number} opts.pageNumber The desired page number
4831
- * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4832
4559
  */
4833
4560
  postAnalyticsRoutingActivityQuery(body, opts) {
4834
4561
  opts = opts || {};
@@ -4962,7 +4689,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
4962
4689
  * @param {Object} opts Optional parameters
4963
4690
  * @param {Number} opts.pageSize The desired page size
4964
4691
  * @param {Number} opts.pageNumber The desired page number
4965
- * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4966
4692
  */
4967
4693
  postAnalyticsTeamsActivityQuery(body, opts) {
4968
4694
  opts = opts || {};
@@ -5044,7 +4770,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5044
4770
  * @param {Object} opts Optional parameters
5045
4771
  * @param {Number} opts.pageSize The desired page size
5046
4772
  * @param {Number} opts.pageNumber The desired page number
5047
- * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5048
4773
  */
5049
4774
  postAnalyticsUsersActivityQuery(body, opts) {
5050
4775
  opts = opts || {};
@@ -5219,44 +4944,13 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5219
4944
  );
5220
4945
  }
5221
4946
 
5222
- /**
5223
- * Update a scheduled report job.
5224
- * This route is deprecated, please use PATCH:api/v2/analytics/reporting/exports/{exportId}/schedule instead
5225
- * @param {String} scheduleId Schedule ID
5226
- * @param {Object} body ReportSchedule
5227
- * @deprecated
5228
- */
5229
- putAnalyticsReportingSchedule(scheduleId, body) {
5230
- // verify the required parameter 'scheduleId' is set
5231
- if (scheduleId === undefined || scheduleId === null) {
5232
- throw 'Missing the required parameter "scheduleId" when calling putAnalyticsReportingSchedule';
5233
- }
5234
- // verify the required parameter 'body' is set
5235
- if (body === undefined || body === null) {
5236
- throw 'Missing the required parameter "body" when calling putAnalyticsReportingSchedule';
5237
- }
5238
-
5239
- return this.apiClient.callApi(
5240
- '/api/v2/analytics/reporting/schedules/{scheduleId}',
5241
- 'PUT',
5242
- { 'scheduleId': scheduleId },
5243
- { },
5244
- { },
5245
- { },
5246
- body,
5247
- ['PureCloud OAuth'],
5248
- ['application/json'],
5249
- ['application/json']
5250
- );
5251
- }
5252
-
5253
4947
  }
5254
4948
 
5255
4949
  class ArchitectApi {
5256
4950
  /**
5257
4951
  * Architect service.
5258
4952
  * @module purecloud-platform-client-v2/api/ArchitectApi
5259
- * @version 192.2.0
4953
+ * @version 193.0.0
5260
4954
  */
5261
4955
 
5262
4956
  /**
@@ -9402,7 +9096,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9402
9096
  /**
9403
9097
  * Audit service.
9404
9098
  * @module purecloud-platform-client-v2/api/AuditApi
9405
- * @version 192.2.0
9099
+ * @version 193.0.0
9406
9100
  */
9407
9101
 
9408
9102
  /**
@@ -9573,7 +9267,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9573
9267
  /**
9574
9268
  * Authorization service.
9575
9269
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9576
- * @version 192.2.0
9270
+ * @version 193.0.0
9577
9271
  */
9578
9272
 
9579
9273
  /**
@@ -10811,7 +10505,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10811
10505
  /**
10812
10506
  * Billing service.
10813
10507
  * @module purecloud-platform-client-v2/api/BillingApi
10814
- * @version 192.2.0
10508
+ * @version 193.0.0
10815
10509
  */
10816
10510
 
10817
10511
  /**
@@ -10891,7 +10585,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10891
10585
  /**
10892
10586
  * CarrierServices service.
10893
10587
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10894
- * @version 192.2.0
10588
+ * @version 193.0.0
10895
10589
  */
10896
10590
 
10897
10591
  /**
@@ -10961,7 +10655,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10961
10655
  /**
10962
10656
  * Chat service.
10963
10657
  * @module purecloud-platform-client-v2/api/ChatApi
10964
- * @version 192.2.0
10658
+ * @version 193.0.0
10965
10659
  */
10966
10660
 
10967
10661
  /**
@@ -11457,6 +11151,27 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11457
11151
  );
11458
11152
  }
11459
11153
 
11154
+ /**
11155
+ * Get a user's chat settings
11156
+ *
11157
+ * getChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11158
+ */
11159
+ getChatsUsersMeSettings() {
11160
+
11161
+ return this.apiClient.callApi(
11162
+ '/api/v2/chats/users/me/settings',
11163
+ 'GET',
11164
+ { },
11165
+ { },
11166
+ { },
11167
+ { },
11168
+ null,
11169
+ ['PureCloud OAuth'],
11170
+ ['application/json'],
11171
+ ['application/json']
11172
+ );
11173
+ }
11174
+
11460
11175
  /**
11461
11176
  * Set properties for a room
11462
11177
  *
@@ -11613,6 +11328,32 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11613
11328
  );
11614
11329
  }
11615
11330
 
11331
+ /**
11332
+ * Update a user's chat settings
11333
+ *
11334
+ * @param {Object} body
11335
+ * patchChatsUsersMeSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
11336
+ */
11337
+ patchChatsUsersMeSettings(body) {
11338
+ // verify the required parameter 'body' is set
11339
+ if (body === undefined || body === null) {
11340
+ throw 'Missing the required parameter "body" when calling patchChatsUsersMeSettings';
11341
+ }
11342
+
11343
+ return this.apiClient.callApi(
11344
+ '/api/v2/chats/users/me/settings',
11345
+ 'PATCH',
11346
+ { },
11347
+ { },
11348
+ { },
11349
+ { },
11350
+ body,
11351
+ ['PureCloud OAuth'],
11352
+ ['application/json'],
11353
+ ['application/json']
11354
+ );
11355
+ }
11356
+
11616
11357
  /**
11617
11358
  * Send a message to a room
11618
11359
  *
@@ -11850,7 +11591,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11850
11591
  /**
11851
11592
  * Coaching service.
11852
11593
  * @module purecloud-platform-client-v2/api/CoachingApi
11853
- * @version 192.2.0
11594
+ * @version 193.0.0
11854
11595
  */
11855
11596
 
11856
11597
  /**
@@ -12427,7 +12168,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12427
12168
  /**
12428
12169
  * ContentManagement service.
12429
12170
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12430
- * @version 192.2.0
12171
+ * @version 193.0.0
12431
12172
  */
12432
12173
 
12433
12174
  /**
@@ -13509,7 +13250,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13509
13250
  /**
13510
13251
  * Conversations service.
13511
13252
  * @module purecloud-platform-client-v2/api/ConversationsApi
13512
- * @version 192.2.0
13253
+ * @version 193.0.0
13513
13254
  */
13514
13255
 
13515
13256
  /**
@@ -17803,7 +17544,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17803
17544
  * @param {Object} opts Optional parameters
17804
17545
  * @param {Number} opts.pageSize The desired page size
17805
17546
  * @param {Number} opts.pageNumber The desired page number
17806
- * postAnalyticsConversationsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17807
17547
  */
17808
17548
  postAnalyticsConversationsActivityQuery(body, opts) {
17809
17549
  opts = opts || {};
@@ -20751,7 +20491,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20751
20491
  /**
20752
20492
  * DataExtensions service.
20753
20493
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20754
- * @version 192.2.0
20494
+ * @version 193.0.0
20755
20495
  */
20756
20496
 
20757
20497
  /**
@@ -20837,7 +20577,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20837
20577
  /**
20838
20578
  * Downloads service.
20839
20579
  * @module purecloud-platform-client-v2/api/DownloadsApi
20840
- * @version 192.2.0
20580
+ * @version 193.0.0
20841
20581
  */
20842
20582
 
20843
20583
  /**
@@ -20889,7 +20629,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20889
20629
  /**
20890
20630
  * Emails service.
20891
20631
  * @module purecloud-platform-client-v2/api/EmailsApi
20892
- * @version 192.2.0
20632
+ * @version 193.0.0
20893
20633
  */
20894
20634
 
20895
20635
  /**
@@ -20954,7 +20694,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20954
20694
  /**
20955
20695
  * Events service.
20956
20696
  * @module purecloud-platform-client-v2/api/EventsApi
20957
- * @version 192.2.0
20697
+ * @version 193.0.0
20958
20698
  */
20959
20699
 
20960
20700
  /**
@@ -21050,7 +20790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21050
20790
  /**
21051
20791
  * ExternalContacts service.
21052
20792
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
21053
- * @version 192.2.0
20793
+ * @version 193.0.0
21054
20794
  */
21055
20795
 
21056
20796
  /**
@@ -23008,7 +22748,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23008
22748
  /**
23009
22749
  * Fax service.
23010
22750
  * @module purecloud-platform-client-v2/api/FaxApi
23011
- * @version 192.2.0
22751
+ * @version 193.0.0
23012
22752
  */
23013
22753
 
23014
22754
  /**
@@ -23223,7 +22963,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23223
22963
  /**
23224
22964
  * Flows service.
23225
22965
  * @module purecloud-platform-client-v2/api/FlowsApi
23226
- * @version 192.2.0
22966
+ * @version 193.0.0
23227
22967
  */
23228
22968
 
23229
22969
  /**
@@ -23301,7 +23041,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23301
23041
  * @param {Object} opts Optional parameters
23302
23042
  * @param {Number} opts.pageSize The desired page size
23303
23043
  * @param {Number} opts.pageNumber The desired page number
23304
- * postAnalyticsFlowsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
23305
23044
  */
23306
23045
  postAnalyticsFlowsActivityQuery(body, opts) {
23307
23046
  opts = opts || {};
@@ -23407,7 +23146,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23407
23146
  /**
23408
23147
  * Gamification service.
23409
23148
  * @module purecloud-platform-client-v2/api/GamificationApi
23410
- * @version 192.2.0
23149
+ * @version 193.0.0
23411
23150
  */
23412
23151
 
23413
23152
  /**
@@ -25493,7 +25232,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25493
25232
  /**
25494
25233
  * GeneralDataProtectionRegulation service.
25495
25234
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25496
- * @version 192.2.0
25235
+ * @version 193.0.0
25497
25236
  */
25498
25237
 
25499
25238
  /**
@@ -25623,7 +25362,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25623
25362
  /**
25624
25363
  * Geolocation service.
25625
25364
  * @module purecloud-platform-client-v2/api/GeolocationApi
25626
- * @version 192.2.0
25365
+ * @version 193.0.0
25627
25366
  */
25628
25367
 
25629
25368
  /**
@@ -25754,7 +25493,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25754
25493
  /**
25755
25494
  * Greetings service.
25756
25495
  * @module purecloud-platform-client-v2/api/GreetingsApi
25757
- * @version 192.2.0
25496
+ * @version 193.0.0
25758
25497
  */
25759
25498
 
25760
25499
  /**
@@ -26209,7 +25948,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26209
25948
  /**
26210
25949
  * Groups service.
26211
25950
  * @module purecloud-platform-client-v2/api/GroupsApi
26212
- * @version 192.2.0
25951
+ * @version 193.0.0
26213
25952
  */
26214
25953
 
26215
25954
  /**
@@ -26728,7 +26467,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26728
26467
  /**
26729
26468
  * IdentityProvider service.
26730
26469
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26731
- * @version 192.2.0
26470
+ * @version 193.0.0
26732
26471
  */
26733
26472
 
26734
26473
  /**
@@ -27589,7 +27328,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27589
27328
  /**
27590
27329
  * InfrastructureAsCode service.
27591
27330
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27592
- * @version 192.2.0
27331
+ * @version 193.0.0
27593
27332
  */
27594
27333
 
27595
27334
  /**
@@ -27756,7 +27495,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27756
27495
  /**
27757
27496
  * Integrations service.
27758
27497
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27759
- * @version 192.2.0
27498
+ * @version 193.0.0
27760
27499
  */
27761
27500
 
27762
27501
  /**
@@ -30108,7 +29847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30108
29847
  /**
30109
29848
  * Journey service.
30110
29849
  * @module purecloud-platform-client-v2/api/JourneyApi
30111
- * @version 192.2.0
29850
+ * @version 193.0.0
30112
29851
  */
30113
29852
 
30114
29853
  /**
@@ -31697,7 +31436,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31697
31436
  /**
31698
31437
  * Knowledge service.
31699
31438
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31700
- * @version 192.2.0
31439
+ * @version 193.0.0
31701
31440
  */
31702
31441
 
31703
31442
  /**
@@ -34940,7 +34679,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
34940
34679
  /**
34941
34680
  * LanguageUnderstanding service.
34942
34681
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
34943
- * @version 192.2.0
34682
+ * @version 193.0.0
34944
34683
  */
34945
34684
 
34946
34685
  /**
@@ -35974,7 +35713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35974
35713
  /**
35975
35714
  * Languages service.
35976
35715
  * @module purecloud-platform-client-v2/api/LanguagesApi
35977
- * @version 192.2.0
35716
+ * @version 193.0.0
35978
35717
  */
35979
35718
 
35980
35719
  /**
@@ -36196,7 +35935,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36196
35935
  /**
36197
35936
  * Learning service.
36198
35937
  * @module purecloud-platform-client-v2/api/LearningApi
36199
- * @version 192.2.0
35938
+ * @version 193.0.0
36200
35939
  */
36201
35940
 
36202
35941
  /**
@@ -37051,7 +36790,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37051
36790
  /**
37052
36791
  * License service.
37053
36792
  * @module purecloud-platform-client-v2/api/LicenseApi
37054
- * @version 192.2.0
36793
+ * @version 193.0.0
37055
36794
  */
37056
36795
 
37057
36796
  /**
@@ -37289,7 +37028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37289
37028
  /**
37290
37029
  * Locations service.
37291
37030
  * @module purecloud-platform-client-v2/api/LocationsApi
37292
- * @version 192.2.0
37031
+ * @version 193.0.0
37293
37032
  */
37294
37033
 
37295
37034
  /**
@@ -37525,7 +37264,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37525
37264
  /**
37526
37265
  * LogCapture service.
37527
37266
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37528
- * @version 192.2.0
37267
+ * @version 193.0.0
37529
37268
  */
37530
37269
 
37531
37270
  /**
@@ -37725,7 +37464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37725
37464
  /**
37726
37465
  * Messaging service.
37727
37466
  * @module purecloud-platform-client-v2/api/MessagingApi
37728
- * @version 192.2.0
37467
+ * @version 193.0.0
37729
37468
  */
37730
37469
 
37731
37470
  /**
@@ -38084,7 +37823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38084
37823
  /**
38085
37824
  * MobileDevices service.
38086
37825
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
38087
- * @version 192.2.0
37826
+ * @version 193.0.0
38088
37827
  */
38089
37828
 
38090
37829
  /**
@@ -38235,7 +37974,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38235
37974
  /**
38236
37975
  * Notifications service.
38237
37976
  * @module purecloud-platform-client-v2/api/NotificationsApi
38238
- * @version 192.2.0
37977
+ * @version 193.0.0
38239
37978
  */
38240
37979
 
38241
37980
  /**
@@ -38468,7 +38207,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38468
38207
  /**
38469
38208
  * OAuth service.
38470
38209
  * @module purecloud-platform-client-v2/api/OAuthApi
38471
- * @version 192.2.0
38210
+ * @version 193.0.0
38472
38211
  */
38473
38212
 
38474
38213
  /**
@@ -38834,7 +38573,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38834
38573
  /**
38835
38574
  * Objects service.
38836
38575
  * @module purecloud-platform-client-v2/api/ObjectsApi
38837
- * @version 192.2.0
38576
+ * @version 193.0.0
38838
38577
  */
38839
38578
 
38840
38579
  /**
@@ -39104,7 +38843,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39104
38843
  /**
39105
38844
  * OperationalEvents service.
39106
38845
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
39107
- * @version 192.2.0
38846
+ * @version 193.0.0
39108
38847
  */
39109
38848
 
39110
38849
  /**
@@ -39170,7 +38909,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39170
38909
  /**
39171
38910
  * Organization service.
39172
38911
  * @module purecloud-platform-client-v2/api/OrganizationApi
39173
- * @version 192.2.0
38912
+ * @version 193.0.0
39174
38913
  */
39175
38914
 
39176
38915
  /**
@@ -39346,6 +39085,26 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39346
39085
  );
39347
39086
  }
39348
39087
 
39088
+ /**
39089
+ * Get free trial limit documentation
39090
+ *
39091
+ */
39092
+ getOrganizationsLimitsDocsFreetrial() {
39093
+
39094
+ return this.apiClient.callApi(
39095
+ '/api/v2/organizations/limits/docs/freetrial',
39096
+ 'GET',
39097
+ { },
39098
+ { },
39099
+ { },
39100
+ { },
39101
+ null,
39102
+ ['PureCloud OAuth'],
39103
+ ['application/json'],
39104
+ ['application/json']
39105
+ );
39106
+ }
39107
+
39349
39108
  /**
39350
39109
  * Get the effective limits in a namespace for an organization
39351
39110
  *
@@ -39625,7 +39384,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39625
39384
  /**
39626
39385
  * OrganizationAuthorization service.
39627
39386
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39628
- * @version 192.2.0
39387
+ * @version 193.0.0
39629
39388
  */
39630
39389
 
39631
39390
  /**
@@ -40972,7 +40731,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
40972
40731
  /**
40973
40732
  * Outbound service.
40974
40733
  * @module purecloud-platform-client-v2/api/OutboundApi
40975
- * @version 192.2.0
40734
+ * @version 193.0.0
40976
40735
  */
40977
40736
 
40978
40737
  /**
@@ -45214,7 +44973,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45214
44973
  /**
45215
44974
  * Presence service.
45216
44975
  * @module purecloud-platform-client-v2/api/PresenceApi
45217
- * @version 192.2.0
44976
+ * @version 193.0.0
45218
44977
  */
45219
44978
 
45220
44979
  /**
@@ -45958,7 +45717,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45958
45717
  /**
45959
45718
  * ProcessAutomation service.
45960
45719
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
45961
- * @version 192.2.0
45720
+ * @version 193.0.0
45962
45721
  */
45963
45722
 
45964
45723
  /**
@@ -46197,7 +45956,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46197
45956
  /**
46198
45957
  * Quality service.
46199
45958
  * @module purecloud-platform-client-v2/api/QualityApi
46200
- * @version 192.2.0
45959
+ * @version 193.0.0
46201
45960
  */
46202
45961
 
46203
45962
  /**
@@ -46685,7 +46444,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46685
46444
 
46686
46445
  /**
46687
46446
  * Queries Evaluations and returns a paged list
46688
- * Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch.
46447
+ * Query params must include one of conversationId, evaluatorUserId, agentUserId or assigneeUserId. When querying by agentUserId (and not conversationId or evaluatorUserId), the results are sorted by release date. Evaluations set to Never Release are omitted in this case. When querying by evaluatorUserId or conversationId (including when combined with agentUserId), the results are sorted by assigned date. NOTE: The count for total and pageCount might not be accurate when querying for a large number of evaluations. nextUri, if present, will indicate that there are more evaluations to fetch. The evaluation entities contained in the response might only contain a subset of all the properties listed below. It is often because a given propertys value has not yet been populated or is not applicable in the current state of the evaluation. It might also be because the missing property in the response was not requested by the user.
46689
46448
  * @param {Object} opts Optional parameters
46690
46449
  * @param {Number} opts.pageSize The total page size requested (default to 25)
46691
46450
  * @param {Number} opts.pageNumber The page number requested (default to 1)
@@ -46705,7 +46464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46705
46464
  * @param {Array.<String>} opts.evaluationState
46706
46465
  * @param {Boolean} opts.isReleased the evaluation has been released
46707
46466
  * @param {Boolean} opts.agentHasRead agent has the evaluation
46708
- * @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
46467
+ * @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations. NOTE: The answers will only be populated if this parameter is set to true in the request.
46709
46468
  * @param {Number} opts.maximum the maximum number of results to return
46710
46469
  * @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
46711
46470
  */
@@ -47954,7 +47713,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
47954
47713
  /**
47955
47714
  * Recording service.
47956
47715
  * @module purecloud-platform-client-v2/api/RecordingApi
47957
- * @version 192.2.0
47716
+ * @version 193.0.0
47958
47717
  */
47959
47718
 
47960
47719
  /**
@@ -49612,7 +49371,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49612
49371
  /**
49613
49372
  * ResponseManagement service.
49614
49373
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
49615
- * @version 192.2.0
49374
+ * @version 193.0.0
49616
49375
  */
49617
49376
 
49618
49377
  /**
@@ -50122,7 +49881,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50122
49881
  /**
50123
49882
  * Routing service.
50124
49883
  * @module purecloud-platform-client-v2/api/RoutingApi
50125
- * @version 192.2.0
49884
+ * @version 193.0.0
50126
49885
  */
50127
49886
 
50128
49887
  /**
@@ -53019,7 +52778,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
53019
52778
  * @param {Object} opts Optional parameters
53020
52779
  * @param {Number} opts.pageSize The desired page size
53021
52780
  * @param {Number} opts.pageNumber The desired page number
53022
- * postAnalyticsRoutingActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
53023
52781
  */
53024
52782
  postAnalyticsRoutingActivityQuery(body, opts) {
53025
52783
  opts = opts || {};
@@ -54102,7 +53860,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54102
53860
  /**
54103
53861
  * SCIM service.
54104
53862
  * @module purecloud-platform-client-v2/api/SCIMApi
54105
- * @version 192.2.0
53863
+ * @version 193.0.0
54106
53864
  */
54107
53865
 
54108
53866
  /**
@@ -54979,7 +54737,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54979
54737
  /**
54980
54738
  * ScreenRecording service.
54981
54739
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
54982
- * @version 192.2.0
54740
+ * @version 193.0.0
54983
54741
  */
54984
54742
 
54985
54743
  /**
@@ -55024,7 +54782,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55024
54782
  /**
55025
54783
  * Scripts service.
55026
54784
  * @module purecloud-platform-client-v2/api/ScriptsApi
55027
- * @version 192.2.0
54785
+ * @version 193.0.0
55028
54786
  */
55029
54787
 
55030
54788
  /**
@@ -55468,7 +55226,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55468
55226
  /**
55469
55227
  * Search service.
55470
55228
  * @module purecloud-platform-client-v2/api/SearchApi
55471
- * @version 192.2.0
55229
+ * @version 193.0.0
55472
55230
  */
55473
55231
 
55474
55232
  /**
@@ -56157,7 +55915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56157
55915
  /**
56158
55916
  * Settings service.
56159
55917
  * @module purecloud-platform-client-v2/api/SettingsApi
56160
- * @version 192.2.0
55918
+ * @version 193.0.0
56161
55919
  */
56162
55920
 
56163
55921
  /**
@@ -56269,7 +56027,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56269
56027
  /**
56270
56028
  * SpeechTextAnalytics service.
56271
56029
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
56272
- * @version 192.2.0
56030
+ * @version 193.0.0
56273
56031
  */
56274
56032
 
56275
56033
  /**
@@ -57383,7 +57141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57383
57141
  /**
57384
57142
  * Stations service.
57385
57143
  * @module purecloud-platform-client-v2/api/StationsApi
57386
- * @version 192.2.0
57144
+ * @version 193.0.0
57387
57145
  */
57388
57146
 
57389
57147
  /**
@@ -57485,7 +57243,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57485
57243
  /**
57486
57244
  * Suggest service.
57487
57245
  * @module purecloud-platform-client-v2/api/SuggestApi
57488
- * @version 192.2.0
57246
+ * @version 193.0.0
57489
57247
  */
57490
57248
 
57491
57249
  /**
@@ -57624,7 +57382,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57624
57382
  /**
57625
57383
  * TaskManagement service.
57626
57384
  * @module purecloud-platform-client-v2/api/TaskManagementApi
57627
- * @version 192.2.0
57385
+ * @version 193.0.0
57628
57386
  */
57629
57387
 
57630
57388
  /**
@@ -57643,7 +57401,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57643
57401
  * Delete a workbin
57644
57402
  *
57645
57403
  * @param {String} workbinId Workbin ID
57646
- * deleteTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57647
57404
  */
57648
57405
  deleteTaskmanagementWorkbin(workbinId) {
57649
57406
  // verify the required parameter 'workbinId' is set
@@ -57669,7 +57426,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57669
57426
  * Delete a workitem
57670
57427
  *
57671
57428
  * @param {String} workitemId Workitem ID
57672
- * deleteTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57673
57429
  */
57674
57430
  deleteTaskmanagementWorkitem(workitemId) {
57675
57431
  // verify the required parameter 'workitemId' is set
@@ -57695,7 +57451,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57695
57451
  * Delete a schema
57696
57452
  *
57697
57453
  * @param {String} schemaId Schema ID
57698
- * deleteTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57699
57454
  */
57700
57455
  deleteTaskmanagementWorkitemsSchema(schemaId) {
57701
57456
  // verify the required parameter 'schemaId' is set
@@ -57721,7 +57476,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57721
57476
  * Delete a worktype
57722
57477
  *
57723
57478
  * @param {String} worktypeId Worktype id
57724
- * deleteTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57725
57479
  */
57726
57480
  deleteTaskmanagementWorktype(worktypeId) {
57727
57481
  // verify the required parameter 'worktypeId' is set
@@ -57748,7 +57502,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57748
57502
  *
57749
57503
  * @param {String} worktypeId Worktype id
57750
57504
  * @param {String} statusId Status id
57751
- * deleteTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57752
57505
  */
57753
57506
  deleteTaskmanagementWorktypeStatus(worktypeId, statusId) {
57754
57507
  // verify the required parameter 'worktypeId' is set
@@ -57778,7 +57531,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57778
57531
  * Get a workbin
57779
57532
  *
57780
57533
  * @param {String} workbinId Workbin ID
57781
- * getTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57782
57534
  */
57783
57535
  getTaskmanagementWorkbin(workbinId) {
57784
57536
  // verify the required parameter 'workbinId' is set
@@ -57901,7 +57653,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57901
57653
  * @param {String} workitemId Workitem ID
57902
57654
  * @param {Object} opts Optional parameters
57903
57655
  * @param {Object} opts.expands Which fields to expand. Comma separated if more than one.
57904
- * getTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57905
57656
  */
57906
57657
  getTaskmanagementWorkitem(workitemId, opts) {
57907
57658
  opts = opts || {};
@@ -57967,7 +57718,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
57967
57718
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
57968
57719
  * @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 50. (default to 25)
57969
57720
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
57970
- * getTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
57971
57721
  */
57972
57722
  getTaskmanagementWorkitemUserWrapups(workitemId, userId, opts) {
57973
57723
  opts = opts || {};
@@ -58067,7 +57817,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58067
57817
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
58068
57818
  * @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 50. (default to 25)
58069
57819
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
58070
- * getTaskmanagementWorkitemWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58071
57820
  */
58072
57821
  getTaskmanagementWorkitemWrapups(workitemId, opts) {
58073
57822
  opts = opts || {};
@@ -58095,7 +57844,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58095
57844
  * Get the workitem query job associated with the job id.
58096
57845
  *
58097
57846
  * @param {String} jobId jobId
58098
- * getTaskmanagementWorkitemsQueryJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58099
57847
  */
58100
57848
  getTaskmanagementWorkitemsQueryJob(jobId) {
58101
57849
  // verify the required parameter 'jobId' is set
@@ -58121,7 +57869,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58121
57869
  * Get results from for workitem query job
58122
57870
  *
58123
57871
  * @param {String} jobId jobId
58124
- * getTaskmanagementWorkitemsQueryJobResults is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58125
57872
  */
58126
57873
  getTaskmanagementWorkitemsQueryJobResults(jobId) {
58127
57874
  // verify the required parameter 'jobId' is set
@@ -58147,7 +57894,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58147
57894
  * Get a schema
58148
57895
  *
58149
57896
  * @param {String} schemaId Schema ID
58150
- * getTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58151
57897
  */
58152
57898
  getTaskmanagementWorkitemsSchema(schemaId) {
58153
57899
  // verify the required parameter 'schemaId' is set
@@ -58174,7 +57920,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58174
57920
  *
58175
57921
  * @param {String} schemaId Schema ID
58176
57922
  * @param {String} versionId Schema version
58177
- * getTaskmanagementWorkitemsSchemaVersion is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58178
57923
  */
58179
57924
  getTaskmanagementWorkitemsSchemaVersion(schemaId, versionId) {
58180
57925
  // verify the required parameter 'schemaId' is set
@@ -58204,7 +57949,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58204
57949
  * Get all versions of a schema
58205
57950
  *
58206
57951
  * @param {String} schemaId Schema ID
58207
- * getTaskmanagementWorkitemsSchemaVersions is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58208
57952
  */
58209
57953
  getTaskmanagementWorkitemsSchemaVersions(schemaId) {
58210
57954
  // verify the required parameter 'schemaId' is set
@@ -58229,7 +57973,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58229
57973
  /**
58230
57974
  * Get a list of schemas.
58231
57975
  *
58232
- * getTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58233
57976
  */
58234
57977
  getTaskmanagementWorkitemsSchemas() {
58235
57978
 
@@ -58253,7 +57996,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58253
57996
  * @param {String} worktypeId Worktype id
58254
57997
  * @param {Object} opts Optional parameters
58255
57998
  * @param {Array.<String>} opts.expands Which fields, if any, to expand.
58256
- * getTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58257
57999
  */
58258
58000
  getTaskmanagementWorktype(worktypeId, opts) {
58259
58001
  opts = opts || {};
@@ -58314,7 +58056,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58314
58056
  *
58315
58057
  * @param {String} worktypeId Worktype id
58316
58058
  * @param {String} statusId Status id
58317
- * getTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58318
58059
  */
58319
58060
  getTaskmanagementWorktypeStatus(worktypeId, statusId) {
58320
58061
  // verify the required parameter 'worktypeId' is set
@@ -58344,7 +58085,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58344
58085
  * Get list of statuses for this worktype.
58345
58086
  *
58346
58087
  * @param {String} worktypeId Worktype id
58347
- * getTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58348
58088
  */
58349
58089
  getTaskmanagementWorktypeStatuses(worktypeId) {
58350
58090
  // verify the required parameter 'worktypeId' is set
@@ -58434,7 +58174,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58434
58174
  *
58435
58175
  * @param {String} workbinId Workbin ID
58436
58176
  * @param {Object} body Json with attributes and their new values: {description:new description, name:new name}.
58437
- * patchTaskmanagementWorkbin is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58438
58177
  */
58439
58178
  patchTaskmanagementWorkbin(workbinId, body) {
58440
58179
  // verify the required parameter 'workbinId' is set
@@ -58465,7 +58204,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58465
58204
  *
58466
58205
  * @param {String} workitemId Workitem ID
58467
58206
  * @param {Object} body Workitem
58468
- * patchTaskmanagementWorkitem is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58469
58207
  */
58470
58208
  patchTaskmanagementWorkitem(workitemId, body) {
58471
58209
  // verify the required parameter 'workitemId' is set
@@ -58496,7 +58234,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58496
58234
  *
58497
58235
  * @param {String} workitemId Workitem ID
58498
58236
  * @param {Object} body Targeted user
58499
- * patchTaskmanagementWorkitemAssignment is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58500
58237
  */
58501
58238
  patchTaskmanagementWorkitemAssignment(workitemId, body) {
58502
58239
  // verify the required parameter 'workitemId' is set
@@ -58528,7 +58265,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58528
58265
  * @param {String} workitemId The ID of the Workitem.
58529
58266
  * @param {String} userId The ID of the user
58530
58267
  * @param {Object} body Request body to add/remove a wrapup code for a workitem
58531
- * patchTaskmanagementWorkitemUserWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58532
58268
  */
58533
58269
  patchTaskmanagementWorkitemUserWrapups(workitemId, userId, body) {
58534
58270
  // verify the required parameter 'workitemId' is set
@@ -58563,7 +58299,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58563
58299
  *
58564
58300
  * @param {String} workitemId The ID of the Workitem.
58565
58301
  * @param {Object} body Request body to add/remove the wrapup code for workitem
58566
- * patchTaskmanagementWorkitemUsersMeWrapups is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58567
58302
  */
58568
58303
  patchTaskmanagementWorkitemUsersMeWrapups(workitemId, body) {
58569
58304
  // verify the required parameter 'workitemId' is set
@@ -58595,7 +58330,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58595
58330
  * @param {String} worktypeId Worktype id
58596
58331
  * @param {Object} opts Optional parameters
58597
58332
  * @param {Object} opts.body body
58598
- * patchTaskmanagementWorktype is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58599
58333
  */
58600
58334
  patchTaskmanagementWorktype(worktypeId, opts) {
58601
58335
  opts = opts || {};
@@ -58626,7 +58360,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58626
58360
  * @param {String} statusId Status id
58627
58361
  * @param {Object} opts Optional parameters
58628
58362
  * @param {Object} opts.body body
58629
- * patchTaskmanagementWorktypeStatus is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58630
58363
  */
58631
58364
  patchTaskmanagementWorktypeStatus(worktypeId, statusId, opts) {
58632
58365
  opts = opts || {};
@@ -58659,7 +58392,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58659
58392
  *
58660
58393
  * @param {Object} opts Optional parameters
58661
58394
  * @param {Object} opts.body body
58662
- * postTaskmanagementWorkbins is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58663
58395
  */
58664
58396
  postTaskmanagementWorkbins(opts) {
58665
58397
  opts = opts || {};
@@ -58683,7 +58415,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58683
58415
  * Query for workbins
58684
58416
  *
58685
58417
  * @param {Object} body QueryPostRequest
58686
- * postTaskmanagementWorkbinsQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58687
58418
  */
58688
58419
  postTaskmanagementWorkbinsQuery(body) {
58689
58420
  // verify the required parameter 'body' is set
@@ -58709,7 +58440,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58709
58440
  * Cancel the assignment process for a workitem that is currently queued for assignment through ACD.
58710
58441
  *
58711
58442
  * @param {String} workitemId Workitem ID
58712
- * postTaskmanagementWorkitemAcdCancel is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58713
58443
  */
58714
58444
  postTaskmanagementWorkitemAcdCancel(workitemId) {
58715
58445
  // verify the required parameter 'workitemId' is set
@@ -58735,7 +58465,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58735
58465
  * Disconnect the assignee of the workitem
58736
58466
  *
58737
58467
  * @param {String} workitemId Workitem ID
58738
- * postTaskmanagementWorkitemDisconnect is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58739
58468
  */
58740
58469
  postTaskmanagementWorkitemDisconnect(workitemId) {
58741
58470
  // verify the required parameter 'workitemId' is set
@@ -58763,7 +58492,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58763
58492
  * @param {String} workitemId Workitem ID
58764
58493
  * @param {Object} opts Optional parameters
58765
58494
  * @param {Object} opts.body Terminated request
58766
- * postTaskmanagementWorkitemTerminate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58767
58495
  */
58768
58496
  postTaskmanagementWorkitemTerminate(workitemId, opts) {
58769
58497
  opts = opts || {};
@@ -58791,7 +58519,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58791
58519
  * Create a workitem
58792
58520
  *
58793
58521
  * @param {Object} body Workitem
58794
- * postTaskmanagementWorkitems is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58795
58522
  */
58796
58523
  postTaskmanagementWorkitems(body) {
58797
58524
  // verify the required parameter 'body' is set
@@ -58843,7 +58570,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58843
58570
  * Create a workitem query job
58844
58571
  *
58845
58572
  * @param {Object} body WorkitemQueryJobCreate
58846
- * postTaskmanagementWorkitemsQueryJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58847
58573
  */
58848
58574
  postTaskmanagementWorkitemsQueryJobs(body) {
58849
58575
  // verify the required parameter 'body' is set
@@ -58869,7 +58595,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58869
58595
  * Create a schema
58870
58596
  *
58871
58597
  * @param {Object} body Schema
58872
- * postTaskmanagementWorkitemsSchemas is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58873
58598
  */
58874
58599
  postTaskmanagementWorkitemsSchemas(body) {
58875
58600
  // verify the required parameter 'body' is set
@@ -58897,7 +58622,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58897
58622
  * @param {String} worktypeId Worktype id
58898
58623
  * @param {Object} opts Optional parameters
58899
58624
  * @param {Object} opts.body body
58900
- * postTaskmanagementWorktypeStatuses is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58901
58625
  */
58902
58626
  postTaskmanagementWorktypeStatuses(worktypeId, opts) {
58903
58627
  opts = opts || {};
@@ -58926,7 +58650,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58926
58650
  *
58927
58651
  * @param {Object} opts Optional parameters
58928
58652
  * @param {Object} opts.body body
58929
- * postTaskmanagementWorktypes is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58930
58653
  */
58931
58654
  postTaskmanagementWorktypes(opts) {
58932
58655
  opts = opts || {};
@@ -58950,7 +58673,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58950
58673
  * Query for worktypes
58951
58674
  *
58952
58675
  * @param {Object} body QueryPostRequest
58953
- * postTaskmanagementWorktypesQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58954
58676
  */
58955
58677
  postTaskmanagementWorktypesQuery(body) {
58956
58678
  // verify the required parameter 'body' is set
@@ -58977,7 +58699,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58977
58699
  *
58978
58700
  * @param {String} schemaId Schema ID
58979
58701
  * @param {Object} body Data Schema
58980
- * putTaskmanagementWorkitemsSchema is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58981
58702
  */
58982
58703
  putTaskmanagementWorkitemsSchema(schemaId, body) {
58983
58704
  // verify the required parameter 'schemaId' is set
@@ -59009,7 +58730,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59009
58730
  /**
59010
58731
  * Teams service.
59011
58732
  * @module purecloud-platform-client-v2/api/TeamsApi
59012
- * @version 192.2.0
58733
+ * @version 193.0.0
59013
58734
  */
59014
58735
 
59015
58736
  /**
@@ -59201,7 +58922,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59201
58922
  * @param {Object} opts Optional parameters
59202
58923
  * @param {Number} opts.pageSize The desired page size
59203
58924
  * @param {Number} opts.pageNumber The desired page number
59204
- * postAnalyticsTeamsActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
59205
58925
  */
59206
58926
  postAnalyticsTeamsActivityQuery(body, opts) {
59207
58927
  opts = opts || {};
@@ -59311,7 +59031,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59311
59031
  /**
59312
59032
  * Telephony service.
59313
59033
  * @module purecloud-platform-client-v2/api/TelephonyApi
59314
- * @version 192.2.0
59034
+ * @version 193.0.0
59315
59035
  */
59316
59036
 
59317
59037
  /**
@@ -59493,7 +59213,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59493
59213
  /**
59494
59214
  * TelephonyProvidersEdge service.
59495
59215
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
59496
- * @version 192.2.0
59216
+ * @version 193.0.0
59497
59217
  */
59498
59218
 
59499
59219
  /**
@@ -62821,7 +62541,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62821
62541
  /**
62822
62542
  * Textbots service.
62823
62543
  * @module purecloud-platform-client-v2/api/TextbotsApi
62824
- * @version 192.2.0
62544
+ * @version 193.0.0
62825
62545
  */
62826
62546
 
62827
62547
  /**
@@ -62949,7 +62669,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
62949
62669
  /**
62950
62670
  * Tokens service.
62951
62671
  * @module purecloud-platform-client-v2/api/TokensApi
62952
- * @version 192.2.0
62672
+ * @version 193.0.0
62953
62673
  */
62954
62674
 
62955
62675
  /**
@@ -63103,7 +62823,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63103
62823
  /**
63104
62824
  * Uploads service.
63105
62825
  * @module purecloud-platform-client-v2/api/UploadsApi
63106
- * @version 192.2.0
62826
+ * @version 193.0.0
63107
62827
  */
63108
62828
 
63109
62829
  /**
@@ -63372,7 +63092,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63372
63092
  /**
63373
63093
  * Usage service.
63374
63094
  * @module purecloud-platform-client-v2/api/UsageApi
63375
- * @version 192.2.0
63095
+ * @version 193.0.0
63376
63096
  */
63377
63097
 
63378
63098
  /**
@@ -63587,7 +63307,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63587
63307
  /**
63588
63308
  * UserRecordings service.
63589
63309
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
63590
- * @version 192.2.0
63310
+ * @version 193.0.0
63591
63311
  */
63592
63312
 
63593
63313
  /**
@@ -63772,7 +63492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63772
63492
  /**
63773
63493
  * Users service.
63774
63494
  * @module purecloud-platform-client-v2/api/UsersApi
63775
- * @version 192.2.0
63495
+ * @version 193.0.0
63776
63496
  */
63777
63497
 
63778
63498
  /**
@@ -65442,7 +65162,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65442
65162
  * @param {Object} opts Optional parameters
65443
65163
  * @param {Number} opts.pageSize The desired page size
65444
65164
  * @param {Number} opts.pageNumber The desired page number
65445
- * postAnalyticsUsersActivityQuery is a preview method and is subject to both breaking and non-breaking changes at any time without notice
65446
65165
  */
65447
65166
  postAnalyticsUsersActivityQuery(body, opts) {
65448
65167
  opts = opts || {};
@@ -66431,7 +66150,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66431
66150
  /**
66432
66151
  * Utilities service.
66433
66152
  * @module purecloud-platform-client-v2/api/UtilitiesApi
66434
- * @version 192.2.0
66153
+ * @version 193.0.0
66435
66154
  */
66436
66155
 
66437
66156
  /**
@@ -66542,7 +66261,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
66542
66261
  /**
66543
66262
  * Voicemail service.
66544
66263
  * @module purecloud-platform-client-v2/api/VoicemailApi
66545
- * @version 192.2.0
66264
+ * @version 193.0.0
66546
66265
  */
66547
66266
 
66548
66267
  /**
@@ -67209,7 +66928,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67209
66928
  /**
67210
66929
  * WebChat service.
67211
66930
  * @module purecloud-platform-client-v2/api/WebChatApi
67212
- * @version 192.2.0
66931
+ * @version 193.0.0
67213
66932
  */
67214
66933
 
67215
66934
  /**
@@ -67760,7 +67479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67760
67479
  /**
67761
67480
  * WebDeployments service.
67762
67481
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
67763
- * @version 192.2.0
67482
+ * @version 193.0.0
67764
67483
  */
67765
67484
 
67766
67485
  /**
@@ -68287,7 +68006,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68287
68006
  /**
68288
68007
  * WebMessaging service.
68289
68008
  * @module purecloud-platform-client-v2/api/WebMessagingApi
68290
- * @version 192.2.0
68009
+ * @version 193.0.0
68291
68010
  */
68292
68011
 
68293
68012
  /**
@@ -68333,7 +68052,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68333
68052
  /**
68334
68053
  * Widgets service.
68335
68054
  * @module purecloud-platform-client-v2/api/WidgetsApi
68336
- * @version 192.2.0
68055
+ * @version 193.0.0
68337
68056
  */
68338
68057
 
68339
68058
  /**
@@ -68479,7 +68198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68479
68198
  /**
68480
68199
  * WorkforceManagement service.
68481
68200
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
68482
- * @version 192.2.0
68201
+ * @version 193.0.0
68483
68202
  */
68484
68203
 
68485
68204
  /**
@@ -70519,6 +70238,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70519
70238
  * @param {String} agentId The agent id
70520
70239
  * @param {Object} opts Optional parameters
70521
70240
  * @param {Boolean} opts.excludeCapabilities Excludes all capabilities of the agent such as queues, languages, and skills
70241
+ * @param {Array.<String>} opts.expand
70522
70242
  */
70523
70243
  getWorkforcemanagementManagementunitAgent(managementUnitId, agentId, opts) {
70524
70244
  opts = opts || {};
@@ -70536,7 +70256,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
70536
70256
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/agents/{agentId}',
70537
70257
  'GET',
70538
70258
  { 'managementUnitId': managementUnitId,'agentId': agentId },
70539
- { 'excludeCapabilities': opts['excludeCapabilities'] },
70259
+ { 'excludeCapabilities': opts['excludeCapabilities'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
70540
70260
  { },
70541
70261
  { },
70542
70262
  null,
@@ -71077,6 +70797,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71077
70797
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
71078
70798
  * @param {Object} opts Optional parameters
71079
70799
  * @param {Array.<String>} opts.expand Include to access additional data on the work plans
70800
+ * @param {Array.<String>} opts.exclude Exclude specific data on the work plans from the response
71080
70801
  */
71081
70802
  getWorkforcemanagementManagementunitWorkplans(managementUnitId, opts) {
71082
70803
  opts = opts || {};
@@ -71090,7 +70811,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
71090
70811
  '/api/v2/workforcemanagement/managementunits/{managementUnitId}/workplans',
71091
70812
  'GET',
71092
70813
  { 'managementUnitId': managementUnitId },
71093
- { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
70814
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'exclude': this.apiClient.buildCollectionParam(opts['exclude'], 'multi') },
71094
70815
  { },
71095
70816
  { },
71096
70817
  null,
@@ -74390,7 +74111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
74390
74111
  * </pre>
74391
74112
  * </p>
74392
74113
  * @module purecloud-platform-client-v2/index
74393
- * @version 192.2.0
74114
+ * @version 193.0.0
74394
74115
  */
74395
74116
  class platformClient {
74396
74117
  constructor() {