purecloud-platform-client-v2 173.0.0 → 174.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 (82) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +1432 -106
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1432 -106
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +1432 -106
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +1432 -106
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1278 -218
  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 +5 -4
  13. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +493 -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 +1 -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 +223 -5
  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 -1
  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 +62 -1
  38. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +188 -3
  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/MessagingApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/OutboundApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/QualityApi.js +10 -8
  55. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  56. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/RoutingApi.js +7 -6
  58. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  59. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +2 -2
  69. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TokensApi.js +7 -3
  71. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/UsersApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +10 -5
  79. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  80. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +363 -6
  82. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -9336,7 +9336,7 @@ class Configuration {
9336
9336
 
9337
9337
  /**
9338
9338
  * @module purecloud-platform-client-v2/ApiClient
9339
- * @version 173.0.0
9339
+ * @version 174.0.0
9340
9340
  */
9341
9341
  class ApiClient {
9342
9342
  /**
@@ -10415,7 +10415,7 @@ class AlertingApi {
10415
10415
  /**
10416
10416
  * Alerting service.
10417
10417
  * @module purecloud-platform-client-v2/api/AlertingApi
10418
- * @version 173.0.0
10418
+ * @version 174.0.0
10419
10419
  */
10420
10420
 
10421
10421
  /**
@@ -11065,7 +11065,7 @@ class AnalyticsApi {
11065
11065
  /**
11066
11066
  * Analytics service.
11067
11067
  * @module purecloud-platform-client-v2/api/AnalyticsApi
11068
- * @version 173.0.0
11068
+ * @version 174.0.0
11069
11069
  */
11070
11070
 
11071
11071
  /**
@@ -11213,13 +11213,14 @@ class AnalyticsApi {
11213
11213
 
11214
11214
  /**
11215
11215
  * Get Reporting Turns.
11216
- * 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.
11216
+ * 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 do not persist indefinitely, as they auto delete after a predefined period.
11217
11217
  * @param {String} botFlowId ID of the bot flow.
11218
11218
  * @param {Object} opts Optional parameters
11219
11219
  * @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
11220
11220
  * @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
11221
+ * @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
11221
11222
  * @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
11222
- * @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
11223
+ * @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.
11223
11224
  * @param {String} opts.language Optional language code to get the reporting turns for a particular language
11224
11225
  * @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
11225
11226
  */
@@ -11235,7 +11236,7 @@ class AnalyticsApi {
11235
11236
  '/api/v2/analytics/botflows/{botFlowId}/reportingturns',
11236
11237
  'GET',
11237
11238
  { 'botFlowId': botFlowId },
11238
- { 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
11239
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
11239
11240
  { },
11240
11241
  { },
11241
11242
  null,
@@ -13510,7 +13511,7 @@ class ArchitectApi {
13510
13511
  /**
13511
13512
  * Architect service.
13512
13513
  * @module purecloud-platform-client-v2/api/ArchitectApi
13513
- * @version 173.0.0
13514
+ * @version 174.0.0
13514
13515
  */
13515
13516
 
13516
13517
  /**
@@ -13550,6 +13551,125 @@ class ArchitectApi {
13550
13551
  );
13551
13552
  }
13552
13553
 
13554
+ /**
13555
+ * Delete a grammar.
13556
+ *
13557
+ * @param {String} grammarId grammar ID
13558
+ * deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13559
+ */
13560
+ deleteArchitectGrammar(grammarId) {
13561
+ // verify the required parameter 'grammarId' is set
13562
+ if (grammarId === undefined || grammarId === null) {
13563
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
13564
+ }
13565
+
13566
+ return this.apiClient.callApi(
13567
+ '/api/v2/architect/grammars/{grammarId}',
13568
+ 'DELETE',
13569
+ { 'grammarId': grammarId },
13570
+ { },
13571
+ { },
13572
+ { },
13573
+ null,
13574
+ ['PureCloud OAuth'],
13575
+ ['application/json'],
13576
+ ['application/json']
13577
+ );
13578
+ }
13579
+
13580
+ /**
13581
+ * Delete specified grammar language
13582
+ *
13583
+ * @param {String} grammarId Grammar ID
13584
+ * @param {String} languageCode Language
13585
+ * deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13586
+ */
13587
+ deleteArchitectGrammarLanguage(grammarId, languageCode) {
13588
+ // verify the required parameter 'grammarId' is set
13589
+ if (grammarId === undefined || grammarId === null) {
13590
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
13591
+ }
13592
+ // verify the required parameter 'languageCode' is set
13593
+ if (languageCode === undefined || languageCode === null) {
13594
+ throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
13595
+ }
13596
+
13597
+ return this.apiClient.callApi(
13598
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
13599
+ 'DELETE',
13600
+ { 'grammarId': grammarId,'languageCode': languageCode },
13601
+ { },
13602
+ { },
13603
+ { },
13604
+ null,
13605
+ ['PureCloud OAuth'],
13606
+ ['application/json'],
13607
+ ['application/json']
13608
+ );
13609
+ }
13610
+
13611
+ /**
13612
+ * Clear the DTMF mode file for the grammar language if there is one
13613
+ *
13614
+ * @param {String} grammarId Grammar ID
13615
+ * @param {String} languageCode Language
13616
+ * deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13617
+ */
13618
+ deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
13619
+ // verify the required parameter 'grammarId' is set
13620
+ if (grammarId === undefined || grammarId === null) {
13621
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
13622
+ }
13623
+ // verify the required parameter 'languageCode' is set
13624
+ if (languageCode === undefined || languageCode === null) {
13625
+ throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
13626
+ }
13627
+
13628
+ return this.apiClient.callApi(
13629
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
13630
+ 'DELETE',
13631
+ { 'grammarId': grammarId,'languageCode': languageCode },
13632
+ { },
13633
+ { },
13634
+ { },
13635
+ null,
13636
+ ['PureCloud OAuth'],
13637
+ ['application/json'],
13638
+ ['application/json']
13639
+ );
13640
+ }
13641
+
13642
+ /**
13643
+ * Clear the voice mode file for the grammar language if there is one
13644
+ *
13645
+ * @param {String} grammarId Grammar ID
13646
+ * @param {String} languageCode Language
13647
+ * deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
13648
+ */
13649
+ deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
13650
+ // verify the required parameter 'grammarId' is set
13651
+ if (grammarId === undefined || grammarId === null) {
13652
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
13653
+ }
13654
+ // verify the required parameter 'languageCode' is set
13655
+ if (languageCode === undefined || languageCode === null) {
13656
+ throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
13657
+ }
13658
+
13659
+ return this.apiClient.callApi(
13660
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
13661
+ 'DELETE',
13662
+ { 'grammarId': grammarId,'languageCode': languageCode },
13663
+ { },
13664
+ { },
13665
+ { },
13666
+ null,
13667
+ ['PureCloud OAuth'],
13668
+ ['application/json'],
13669
+ ['application/json']
13670
+ );
13671
+ }
13672
+
13553
13673
  /**
13554
13674
  * Delete an IVR Config.
13555
13675
  *
@@ -14234,6 +14354,130 @@ class ArchitectApi {
14234
14354
  );
14235
14355
  }
14236
14356
 
14357
+ /**
14358
+ * Get a pageable list of basic emergency group objects filterable by query parameters.
14359
+ * This returns emergency groups consisting of name and division. If one or more IDs are specified, the search will fetch flow outcomes that match the given ID(s) and not use any additional supplied query parameters in the search.
14360
+ * @param {Object} opts Optional parameters
14361
+ * @param {Number} opts.pageNumber Page number (default to 1)
14362
+ * @param {Number} opts.pageSize Page size (default to 25)
14363
+ * @param {String} opts.sortBy Sort by (default to name)
14364
+ * @param {String} opts.sortOrder Sort order (default to ASC)
14365
+ * @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
14366
+ * @param {String} opts.name Name of the Emergency Group to filter by.
14367
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
14368
+ */
14369
+ getArchitectEmergencygroupsDivisionviews(opts) {
14370
+ opts = opts || {};
14371
+
14372
+
14373
+ return this.apiClient.callApi(
14374
+ '/api/v2/architect/emergencygroups/divisionviews',
14375
+ 'GET',
14376
+ { },
14377
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
14378
+ { },
14379
+ { },
14380
+ null,
14381
+ ['PureCloud OAuth'],
14382
+ ['application/json'],
14383
+ ['application/json']
14384
+ );
14385
+ }
14386
+
14387
+ /**
14388
+ * Get a grammar
14389
+ * Returns a specified grammar
14390
+ * @param {String} grammarId grammar ID
14391
+ * @param {Object} opts Optional parameters
14392
+ * @param {Boolean} opts.includeFileUrls Include grammar language file URLs
14393
+ * getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14394
+ */
14395
+ getArchitectGrammar(grammarId, opts) {
14396
+ opts = opts || {};
14397
+
14398
+ // verify the required parameter 'grammarId' is set
14399
+ if (grammarId === undefined || grammarId === null) {
14400
+ throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
14401
+ }
14402
+
14403
+ return this.apiClient.callApi(
14404
+ '/api/v2/architect/grammars/{grammarId}',
14405
+ 'GET',
14406
+ { 'grammarId': grammarId },
14407
+ { 'includeFileUrls': opts['includeFileUrls'] },
14408
+ { },
14409
+ { },
14410
+ null,
14411
+ ['PureCloud OAuth'],
14412
+ ['application/json'],
14413
+ ['application/json']
14414
+ );
14415
+ }
14416
+
14417
+ /**
14418
+ * Get a grammar language.
14419
+ *
14420
+ * @param {String} grammarId Grammar ID
14421
+ * @param {String} languageCode Language
14422
+ * getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14423
+ */
14424
+ getArchitectGrammarLanguage(grammarId, languageCode) {
14425
+ // verify the required parameter 'grammarId' is set
14426
+ if (grammarId === undefined || grammarId === null) {
14427
+ throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
14428
+ }
14429
+ // verify the required parameter 'languageCode' is set
14430
+ if (languageCode === undefined || languageCode === null) {
14431
+ throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
14432
+ }
14433
+
14434
+ return this.apiClient.callApi(
14435
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
14436
+ 'GET',
14437
+ { 'grammarId': grammarId,'languageCode': languageCode },
14438
+ { },
14439
+ { },
14440
+ { },
14441
+ null,
14442
+ ['PureCloud OAuth'],
14443
+ ['application/json'],
14444
+ ['application/json']
14445
+ );
14446
+ }
14447
+
14448
+ /**
14449
+ * Get a pageable list of grammars, filtered by query parameters
14450
+ * Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
14451
+ * @param {Object} opts Optional parameters
14452
+ * @param {Number} opts.pageNumber Page number (default to 1)
14453
+ * @param {Number} opts.pageSize Page size (default to 25)
14454
+ * @param {Object} opts.sortBy Sort by (default to id)
14455
+ * @param {Object} opts.sortOrder Sort order (default to asc)
14456
+ * @param {Array.<String>} opts.id ID
14457
+ * @param {String} opts.name Name
14458
+ * @param {String} opts.description Description
14459
+ * @param {String} opts.nameOrDescription Name or description
14460
+ * @param {Boolean} opts.includeFileUrls Include grammar language file URLs
14461
+ * getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14462
+ */
14463
+ getArchitectGrammars(opts) {
14464
+ opts = opts || {};
14465
+
14466
+
14467
+ return this.apiClient.callApi(
14468
+ '/api/v2/architect/grammars',
14469
+ 'GET',
14470
+ { },
14471
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'description': opts['description'],'nameOrDescription': opts['nameOrDescription'],'includeFileUrls': opts['includeFileUrls'] },
14472
+ { },
14473
+ { },
14474
+ null,
14475
+ ['PureCloud OAuth'],
14476
+ ['application/json'],
14477
+ ['application/json']
14478
+ );
14479
+ }
14480
+
14237
14481
  /**
14238
14482
  * Get an IVR config.
14239
14483
  *
@@ -14289,6 +14533,36 @@ class ArchitectApi {
14289
14533
  );
14290
14534
  }
14291
14535
 
14536
+ /**
14537
+ * Get a pageable list of basic ivr configuration information objects filterable by query parameters.
14538
+ *
14539
+ * @param {Object} opts Optional parameters
14540
+ * @param {Number} opts.pageNumber Page number (default to 1)
14541
+ * @param {Number} opts.pageSize Page size (default to 25)
14542
+ * @param {String} opts.sortBy Sort by (default to name)
14543
+ * @param {String} opts.sortOrder Sort order (default to ASC)
14544
+ * @param {Array.<String>} opts.id ID of the IVR to filter by.
14545
+ * @param {String} opts.name Name of the IVR to filter by.
14546
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
14547
+ */
14548
+ getArchitectIvrsDivisionviews(opts) {
14549
+ opts = opts || {};
14550
+
14551
+
14552
+ return this.apiClient.callApi(
14553
+ '/api/v2/architect/ivrs/divisionviews',
14554
+ 'GET',
14555
+ { },
14556
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
14557
+ { },
14558
+ { },
14559
+ null,
14560
+ ['PureCloud OAuth'],
14561
+ ['application/json'],
14562
+ ['application/json']
14563
+ );
14564
+ }
14565
+
14292
14566
  /**
14293
14567
  * Get specified user prompt
14294
14568
  *
@@ -14522,6 +14796,36 @@ class ArchitectApi {
14522
14796
  );
14523
14797
  }
14524
14798
 
14799
+ /**
14800
+ * Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
14801
+ *
14802
+ * @param {Object} opts Optional parameters
14803
+ * @param {Number} opts.pageNumber Page number (default to 1)
14804
+ * @param {Number} opts.pageSize Page size (default to 25)
14805
+ * @param {String} opts.sortBy Sort by (default to name)
14806
+ * @param {String} opts.sortOrder Sort order (default to ASC)
14807
+ * @param {Array.<String>} opts.id ID of the schedule group to filter by.
14808
+ * @param {String} opts.name Name of the schedule group to filter by.
14809
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
14810
+ */
14811
+ getArchitectSchedulegroupsDivisionviews(opts) {
14812
+ opts = opts || {};
14813
+
14814
+
14815
+ return this.apiClient.callApi(
14816
+ '/api/v2/architect/schedulegroups/divisionviews',
14817
+ 'GET',
14818
+ { },
14819
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
14820
+ { },
14821
+ { },
14822
+ null,
14823
+ ['PureCloud OAuth'],
14824
+ ['application/json'],
14825
+ ['application/json']
14826
+ );
14827
+ }
14828
+
14525
14829
  /**
14526
14830
  * Get a list of schedules.
14527
14831
  *
@@ -14551,6 +14855,36 @@ class ArchitectApi {
14551
14855
  );
14552
14856
  }
14553
14857
 
14858
+ /**
14859
+ * Get a pageable list of basic schedule configuration information objects filterable by query parameters.
14860
+ *
14861
+ * @param {Object} opts Optional parameters
14862
+ * @param {Number} opts.pageNumber Page number (default to 1)
14863
+ * @param {Number} opts.pageSize Page size (default to 25)
14864
+ * @param {String} opts.sortBy Sort by (default to name)
14865
+ * @param {String} opts.sortOrder Sort order (default to ASC)
14866
+ * @param {Array.<String>} opts.id ID of the schedule group to filter by.
14867
+ * @param {String} opts.name Name of the schedule group to filter by.
14868
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
14869
+ */
14870
+ getArchitectSchedulesDivisionviews(opts) {
14871
+ opts = opts || {};
14872
+
14873
+
14874
+ return this.apiClient.callApi(
14875
+ '/api/v2/architect/schedules/divisionviews',
14876
+ 'GET',
14877
+ { },
14878
+ { 'pageNumber': opts['pageNumber'],'pageSize': opts['pageSize'],'sortBy': opts['sortBy'],'sortOrder': opts['sortOrder'],'id': this.apiClient.buildCollectionParam(opts['id'], 'multi'),'name': opts['name'],'divisionId': this.apiClient.buildCollectionParam(opts['divisionId'], 'multi') },
14879
+ { },
14880
+ { },
14881
+ null,
14882
+ ['PureCloud OAuth'],
14883
+ ['application/json'],
14884
+ ['application/json']
14885
+ );
14886
+ }
14887
+
14554
14888
  /**
14555
14889
  * Get a system prompt
14556
14890
  *
@@ -15561,6 +15895,36 @@ class ArchitectApi {
15561
15895
  );
15562
15896
  }
15563
15897
 
15898
+ /**
15899
+ * Updates a grammar
15900
+ *
15901
+ * @param {String} grammarId grammar ID
15902
+ * @param {Object} opts Optional parameters
15903
+ * @param {Object} opts.body
15904
+ * patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15905
+ */
15906
+ patchArchitectGrammar(grammarId, opts) {
15907
+ opts = opts || {};
15908
+
15909
+ // verify the required parameter 'grammarId' is set
15910
+ if (grammarId === undefined || grammarId === null) {
15911
+ throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
15912
+ }
15913
+
15914
+ return this.apiClient.callApi(
15915
+ '/api/v2/architect/grammars/{grammarId}',
15916
+ 'PATCH',
15917
+ { 'grammarId': grammarId },
15918
+ { },
15919
+ { },
15920
+ { },
15921
+ opts['body'],
15922
+ ['PureCloud OAuth'],
15923
+ ['application/json'],
15924
+ ['application/json']
15925
+ );
15926
+ }
15927
+
15564
15928
  /**
15565
15929
  * Rebuild Dependency Tracking data for an organization
15566
15930
  * Asynchronous. Notification topic: v2.architect.dependencytracking.build
@@ -15606,6 +15970,135 @@ class ArchitectApi {
15606
15970
  );
15607
15971
  }
15608
15972
 
15973
+ /**
15974
+ * Creates a presigned URL for uploading a grammar DTMF mode file
15975
+ *
15976
+ * @param {String} grammarId Grammar ID
15977
+ * @param {String} languageCode Language
15978
+ * @param {Object} body query
15979
+ * postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
15980
+ */
15981
+ postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
15982
+ // verify the required parameter 'grammarId' is set
15983
+ if (grammarId === undefined || grammarId === null) {
15984
+ throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
15985
+ }
15986
+ // verify the required parameter 'languageCode' is set
15987
+ if (languageCode === undefined || languageCode === null) {
15988
+ throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
15989
+ }
15990
+ // verify the required parameter 'body' is set
15991
+ if (body === undefined || body === null) {
15992
+ throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
15993
+ }
15994
+
15995
+ return this.apiClient.callApi(
15996
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
15997
+ 'POST',
15998
+ { 'grammarId': grammarId,'languageCode': languageCode },
15999
+ { },
16000
+ { },
16001
+ { },
16002
+ body,
16003
+ ['PureCloud OAuth'],
16004
+ ['application/json'],
16005
+ ['application/json']
16006
+ );
16007
+ }
16008
+
16009
+ /**
16010
+ * Creates a presigned URL for uploading a grammar voice mode file
16011
+ *
16012
+ * @param {String} grammarId Grammar ID
16013
+ * @param {String} languageCode Language
16014
+ * @param {Object} body query
16015
+ * postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16016
+ */
16017
+ postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
16018
+ // verify the required parameter 'grammarId' is set
16019
+ if (grammarId === undefined || grammarId === null) {
16020
+ throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
16021
+ }
16022
+ // verify the required parameter 'languageCode' is set
16023
+ if (languageCode === undefined || languageCode === null) {
16024
+ throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
16025
+ }
16026
+ // verify the required parameter 'body' is set
16027
+ if (body === undefined || body === null) {
16028
+ throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
16029
+ }
16030
+
16031
+ return this.apiClient.callApi(
16032
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
16033
+ 'POST',
16034
+ { 'grammarId': grammarId,'languageCode': languageCode },
16035
+ { },
16036
+ { },
16037
+ { },
16038
+ body,
16039
+ ['PureCloud OAuth'],
16040
+ ['application/json'],
16041
+ ['application/json']
16042
+ );
16043
+ }
16044
+
16045
+ /**
16046
+ * Create a new language for a given grammar
16047
+ *
16048
+ * @param {String} grammarId Grammar ID
16049
+ * @param {Object} body
16050
+ * postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16051
+ */
16052
+ postArchitectGrammarLanguages(grammarId, body) {
16053
+ // verify the required parameter 'grammarId' is set
16054
+ if (grammarId === undefined || grammarId === null) {
16055
+ throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
16056
+ }
16057
+ // verify the required parameter 'body' is set
16058
+ if (body === undefined || body === null) {
16059
+ throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
16060
+ }
16061
+
16062
+ return this.apiClient.callApi(
16063
+ '/api/v2/architect/grammars/{grammarId}/languages',
16064
+ 'POST',
16065
+ { 'grammarId': grammarId },
16066
+ { },
16067
+ { },
16068
+ { },
16069
+ body,
16070
+ ['PureCloud OAuth'],
16071
+ ['application/json'],
16072
+ ['application/json']
16073
+ );
16074
+ }
16075
+
16076
+ /**
16077
+ * Create a new grammar
16078
+ *
16079
+ * @param {Object} body
16080
+ * postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
16081
+ */
16082
+ postArchitectGrammars(body) {
16083
+ // verify the required parameter 'body' is set
16084
+ if (body === undefined || body === null) {
16085
+ throw 'Missing the required parameter "body" when calling postArchitectGrammars';
16086
+ }
16087
+
16088
+ return this.apiClient.callApi(
16089
+ '/api/v2/architect/grammars',
16090
+ 'POST',
16091
+ { },
16092
+ { },
16093
+ { },
16094
+ { },
16095
+ body,
16096
+ ['PureCloud OAuth'],
16097
+ ['application/json'],
16098
+ ['application/json']
16099
+ );
16100
+ }
16101
+
15609
16102
  /**
15610
16103
  * Create IVR config.
15611
16104
  *
@@ -16699,7 +17192,7 @@ class AuditApi {
16699
17192
  /**
16700
17193
  * Audit service.
16701
17194
  * @module purecloud-platform-client-v2/api/AuditApi
16702
- * @version 173.0.0
17195
+ * @version 174.0.0
16703
17196
  */
16704
17197
 
16705
17198
  /**
@@ -16870,7 +17363,7 @@ class AuthorizationApi {
16870
17363
  /**
16871
17364
  * Authorization service.
16872
17365
  * @module purecloud-platform-client-v2/api/AuthorizationApi
16873
- * @version 173.0.0
17366
+ * @version 174.0.0
16874
17367
  */
16875
17368
 
16876
17369
  /**
@@ -18101,7 +18594,7 @@ class BillingApi {
18101
18594
  /**
18102
18595
  * Billing service.
18103
18596
  * @module purecloud-platform-client-v2/api/BillingApi
18104
- * @version 173.0.0
18597
+ * @version 174.0.0
18105
18598
  */
18106
18599
 
18107
18600
  /**
@@ -18181,7 +18674,7 @@ class CarrierServicesApi {
18181
18674
  /**
18182
18675
  * CarrierServices service.
18183
18676
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
18184
- * @version 173.0.0
18677
+ * @version 174.0.0
18185
18678
  */
18186
18679
 
18187
18680
  /**
@@ -18251,7 +18744,7 @@ class ChatApi {
18251
18744
  /**
18252
18745
  * Chat service.
18253
18746
  * @module purecloud-platform-client-v2/api/ChatApi
18254
- * @version 173.0.0
18747
+ * @version 174.0.0
18255
18748
  */
18256
18749
 
18257
18750
  /**
@@ -18415,7 +18908,7 @@ class CoachingApi {
18415
18908
  /**
18416
18909
  * Coaching service.
18417
18910
  * @module purecloud-platform-client-v2/api/CoachingApi
18418
- * @version 173.0.0
18911
+ * @version 174.0.0
18419
18912
  */
18420
18913
 
18421
18914
  /**
@@ -18992,7 +19485,7 @@ class ContentManagementApi {
18992
19485
  /**
18993
19486
  * ContentManagement service.
18994
19487
  * @module purecloud-platform-client-v2/api/ContentManagementApi
18995
- * @version 173.0.0
19488
+ * @version 174.0.0
18996
19489
  */
18997
19490
 
18998
19491
  /**
@@ -20135,7 +20628,7 @@ class ConversationsApi {
20135
20628
  /**
20136
20629
  * Conversations service.
20137
20630
  * @module purecloud-platform-client-v2/api/ConversationsApi
20138
- * @version 173.0.0
20631
+ * @version 174.0.0
20139
20632
  */
20140
20633
 
20141
20634
  /**
@@ -20300,6 +20793,31 @@ class ConversationsApi {
20300
20793
  );
20301
20794
  }
20302
20795
 
20796
+ /**
20797
+ * Remove a cached media item asychronously
20798
+ *
20799
+ * @param {String} cachedMediaItemId cachedMediaItemId
20800
+ */
20801
+ deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
20802
+ // verify the required parameter 'cachedMediaItemId' is set
20803
+ if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
20804
+ throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
20805
+ }
20806
+
20807
+ return this.apiClient.callApi(
20808
+ '/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
20809
+ 'DELETE',
20810
+ { 'cachedMediaItemId': cachedMediaItemId },
20811
+ { },
20812
+ { },
20813
+ { },
20814
+ null,
20815
+ ['PureCloud OAuth'],
20816
+ ['application/json'],
20817
+ ['application/json']
20818
+ );
20819
+ }
20820
+
20303
20821
  /**
20304
20822
  * Delete a Facebook messaging integration
20305
20823
  *
@@ -22101,7 +22619,7 @@ class ConversationsApi {
22101
22619
  /**
22102
22620
  * Get list of wrapup codes for this conversation participant
22103
22621
  *
22104
- * @param {String} conversationId conversationId
22622
+ * @param {String} conversationId conversationId
22105
22623
  * @param {String} participantId participantId
22106
22624
  */
22107
22625
  getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
@@ -22148,6 +22666,57 @@ class ConversationsApi {
22148
22666
  );
22149
22667
  }
22150
22668
 
22669
+ /**
22670
+ * Get a list of cached media items
22671
+ *
22672
+ * @param {Object} opts Optional parameters
22673
+ * @param {Number} opts.pageSize Page size (default to 25)
22674
+ * @param {Number} opts.pageNumber Page number (default to 1)
22675
+ * @param {String} opts.url URL to search for
22676
+ */
22677
+ getConversationsMessagesCachedmedia(opts) {
22678
+ opts = opts || {};
22679
+
22680
+
22681
+ return this.apiClient.callApi(
22682
+ '/api/v2/conversations/messages/cachedmedia',
22683
+ 'GET',
22684
+ { },
22685
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
22686
+ { },
22687
+ { },
22688
+ null,
22689
+ ['PureCloud OAuth'],
22690
+ ['application/json'],
22691
+ ['application/json']
22692
+ );
22693
+ }
22694
+
22695
+ /**
22696
+ * Get a cached media item
22697
+ *
22698
+ * @param {String} cachedMediaItemId cachedMediaItemId
22699
+ */
22700
+ getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
22701
+ // verify the required parameter 'cachedMediaItemId' is set
22702
+ if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
22703
+ throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
22704
+ }
22705
+
22706
+ return this.apiClient.callApi(
22707
+ '/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
22708
+ 'GET',
22709
+ { 'cachedMediaItemId': cachedMediaItemId },
22710
+ { },
22711
+ { },
22712
+ { },
22713
+ null,
22714
+ ['PureCloud OAuth'],
22715
+ ['application/json'],
22716
+ ['application/json']
22717
+ );
22718
+ }
22719
+
22151
22720
  /**
22152
22721
  * Get Genesys Facebook App Id
22153
22722
  *
@@ -22891,6 +23460,32 @@ class ConversationsApi {
22891
23460
  );
22892
23461
  }
22893
23462
 
23463
+ /**
23464
+ * Gets a record for a given meetingId
23465
+ *
23466
+ * @param {String} meetingId meetingId
23467
+ * getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
23468
+ */
23469
+ getConversationsVideosMeeting(meetingId) {
23470
+ // verify the required parameter 'meetingId' is set
23471
+ if (meetingId === undefined || meetingId === null) {
23472
+ throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
23473
+ }
23474
+
23475
+ return this.apiClient.callApi(
23476
+ '/api/v2/conversations/videos/meetings/{meetingId}',
23477
+ 'GET',
23478
+ { 'meetingId': meetingId },
23479
+ { },
23480
+ { },
23481
+ { },
23482
+ null,
23483
+ ['PureCloud OAuth'],
23484
+ ['application/json'],
23485
+ ['application/json']
23486
+ );
23487
+ }
23488
+
22894
23489
  /**
22895
23490
  * Update a participant.
22896
23491
  * Update conversation participant.
@@ -23853,7 +24448,7 @@ class ConversationsApi {
23853
24448
  /**
23854
24449
  * Update conversation participant
23855
24450
  *
23856
- * @param {String} conversationId conversationId
24451
+ * @param {String} conversationId conversationId
23857
24452
  * @param {String} participantId participantId
23858
24453
  * @param {Object} opts Optional parameters
23859
24454
  * @param {Object} opts.body
@@ -23887,7 +24482,7 @@ class ConversationsApi {
23887
24482
  /**
23888
24483
  * Update the attributes on a conversation participant.
23889
24484
  *
23890
- * @param {String} conversationId conversationId
24485
+ * @param {String} conversationId conversationId
23891
24486
  * @param {String} participantId participantId
23892
24487
  * @param {Object} opts Optional parameters
23893
24488
  * @param {Object} opts.body
@@ -23921,7 +24516,7 @@ class ConversationsApi {
23921
24516
  /**
23922
24517
  * Update conversation participant's communication by disconnecting it.
23923
24518
  *
23924
- * @param {String} conversationId conversationId
24519
+ * @param {String} conversationId conversationId
23925
24520
  * @param {String} participantId participantId
23926
24521
  * @param {String} communicationId communicationId
23927
24522
  * @param {Object} body Participant
@@ -25878,6 +26473,96 @@ class ConversationsApi {
25878
26473
  );
25879
26474
  }
25880
26475
 
26476
+ /**
26477
+ * Send an inbound Open Event Message
26478
+ * Send an inbound event message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
26479
+ * @param {String} integrationId integrationId
26480
+ * @param {Object} body NormalizedMessage
26481
+ */
26482
+ postConversationsMessageInboundOpenEvent(integrationId, body) {
26483
+ // verify the required parameter 'integrationId' is set
26484
+ if (integrationId === undefined || integrationId === null) {
26485
+ throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
26486
+ }
26487
+ // verify the required parameter 'body' is set
26488
+ if (body === undefined || body === null) {
26489
+ throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
26490
+ }
26491
+
26492
+ return this.apiClient.callApi(
26493
+ '/api/v2/conversations/messages/{integrationId}/inbound/open/event',
26494
+ 'POST',
26495
+ { 'integrationId': integrationId },
26496
+ { },
26497
+ { },
26498
+ { },
26499
+ body,
26500
+ ['PureCloud OAuth'],
26501
+ ['application/json'],
26502
+ ['application/json']
26503
+ );
26504
+ }
26505
+
26506
+ /**
26507
+ * Send inbound Open Message
26508
+ * Send an inbound message to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
26509
+ * @param {String} integrationId integrationId
26510
+ * @param {Object} body NormalizedMessage
26511
+ */
26512
+ postConversationsMessageInboundOpenMessage(integrationId, body) {
26513
+ // verify the required parameter 'integrationId' is set
26514
+ if (integrationId === undefined || integrationId === null) {
26515
+ throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
26516
+ }
26517
+ // verify the required parameter 'body' is set
26518
+ if (body === undefined || body === null) {
26519
+ throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
26520
+ }
26521
+
26522
+ return this.apiClient.callApi(
26523
+ '/api/v2/conversations/messages/{integrationId}/inbound/open/message',
26524
+ 'POST',
26525
+ { 'integrationId': integrationId },
26526
+ { },
26527
+ { },
26528
+ { },
26529
+ body,
26530
+ ['PureCloud OAuth'],
26531
+ ['application/json'],
26532
+ ['application/json']
26533
+ );
26534
+ }
26535
+
26536
+ /**
26537
+ * Send an inbound Open Receipt Message
26538
+ * Send an inbound open Receipt to an Open Messaging integration. In order to call this endpoint you will need OAuth token generated using OAuth client credentials authorized with at least messaging scope. This will either generate a new Conversation, or be a part of an existing conversation. See https://developer.genesys.cloud/api/digital/openmessaging/ for example usage.
26539
+ * @param {String} integrationId integrationId
26540
+ * @param {Object} body NormalizedMessage
26541
+ */
26542
+ postConversationsMessageInboundOpenReceipt(integrationId, body) {
26543
+ // verify the required parameter 'integrationId' is set
26544
+ if (integrationId === undefined || integrationId === null) {
26545
+ throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
26546
+ }
26547
+ // verify the required parameter 'body' is set
26548
+ if (body === undefined || body === null) {
26549
+ throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
26550
+ }
26551
+
26552
+ return this.apiClient.callApi(
26553
+ '/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
26554
+ 'POST',
26555
+ { 'integrationId': integrationId },
26556
+ { },
26557
+ { },
26558
+ { },
26559
+ body,
26560
+ ['PureCloud OAuth'],
26561
+ ['application/json'],
26562
+ ['application/json']
26563
+ );
26564
+ }
26565
+
25881
26566
  /**
25882
26567
  * Get messages in batch
25883
26568
  * The path parameter [conversationId] should contain the conversationId of the conversation being filtered. The body should contain the messageId(s) of messages being requested. For example: ["a3069a33b-bbb1-4703-9d68-061d9e9db96e", "55bc6be3-078c-4a49-a4e6-1e05776ed7e8"]
@@ -26430,6 +27115,32 @@ class ConversationsApi {
26430
27115
  );
26431
27116
  }
26432
27117
 
27118
+ /**
27119
+ * Generate a meetingId for a given conferenceId
27120
+ *
27121
+ * @param {Object} body MeetingIdRequest
27122
+ * postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
27123
+ */
27124
+ postConversationsVideosMeetings(body) {
27125
+ // verify the required parameter 'body' is set
27126
+ if (body === undefined || body === null) {
27127
+ throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
27128
+ }
27129
+
27130
+ return this.apiClient.callApi(
27131
+ '/api/v2/conversations/videos/meetings',
27132
+ 'POST',
27133
+ { },
27134
+ { },
27135
+ { },
27136
+ { },
27137
+ body,
27138
+ ['PureCloud OAuth'],
27139
+ ['application/json'],
27140
+ ['application/json']
27141
+ );
27142
+ }
27143
+
26433
27144
  /**
26434
27145
  * Set flagged reason on conversation participant to indicate bad conversation quality.
26435
27146
  *
@@ -27001,7 +27712,7 @@ class DataExtensionsApi {
27001
27712
  /**
27002
27713
  * DataExtensions service.
27003
27714
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
27004
- * @version 173.0.0
27715
+ * @version 174.0.0
27005
27716
  */
27006
27717
 
27007
27718
  /**
@@ -27087,7 +27798,7 @@ class DownloadsApi {
27087
27798
  /**
27088
27799
  * Downloads service.
27089
27800
  * @module purecloud-platform-client-v2/api/DownloadsApi
27090
- * @version 173.0.0
27801
+ * @version 174.0.0
27091
27802
  */
27092
27803
 
27093
27804
  /**
@@ -27139,7 +27850,7 @@ class EmailsApi {
27139
27850
  /**
27140
27851
  * Emails service.
27141
27852
  * @module purecloud-platform-client-v2/api/EmailsApi
27142
- * @version 173.0.0
27853
+ * @version 174.0.0
27143
27854
  */
27144
27855
 
27145
27856
  /**
@@ -27204,7 +27915,7 @@ class EventsApi {
27204
27915
  /**
27205
27916
  * Events service.
27206
27917
  * @module purecloud-platform-client-v2/api/EventsApi
27207
- * @version 173.0.0
27918
+ * @version 174.0.0
27208
27919
  */
27209
27920
 
27210
27921
  /**
@@ -27300,7 +28011,7 @@ class ExternalContactsApi {
27300
28011
  /**
27301
28012
  * ExternalContacts service.
27302
28013
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
27303
- * @version 173.0.0
28014
+ * @version 174.0.0
27304
28015
  */
27305
28016
 
27306
28017
  /**
@@ -29258,7 +29969,7 @@ class FaxApi {
29258
29969
  /**
29259
29970
  * Fax service.
29260
29971
  * @module purecloud-platform-client-v2/api/FaxApi
29261
- * @version 173.0.0
29972
+ * @version 174.0.0
29262
29973
  */
29263
29974
 
29264
29975
  /**
@@ -29429,7 +30140,7 @@ class FlowsApi {
29429
30140
  /**
29430
30141
  * Flows service.
29431
30142
  * @module purecloud-platform-client-v2/api/FlowsApi
29432
- * @version 173.0.0
30143
+ * @version 174.0.0
29433
30144
  */
29434
30145
 
29435
30146
  /**
@@ -29613,7 +30324,7 @@ class GamificationApi {
29613
30324
  /**
29614
30325
  * Gamification service.
29615
30326
  * @module purecloud-platform-client-v2/api/GamificationApi
29616
- * @version 173.0.0
30327
+ * @version 174.0.0
29617
30328
  */
29618
30329
 
29619
30330
  /**
@@ -31699,7 +32410,7 @@ class GeneralDataProtectionRegulationApi {
31699
32410
  /**
31700
32411
  * GeneralDataProtectionRegulation service.
31701
32412
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
31702
- * @version 173.0.0
32413
+ * @version 174.0.0
31703
32414
  */
31704
32415
 
31705
32416
  /**
@@ -31829,7 +32540,7 @@ class GeolocationApi {
31829
32540
  /**
31830
32541
  * Geolocation service.
31831
32542
  * @module purecloud-platform-client-v2/api/GeolocationApi
31832
- * @version 173.0.0
32543
+ * @version 174.0.0
31833
32544
  */
31834
32545
 
31835
32546
  /**
@@ -31960,7 +32671,7 @@ class GreetingsApi {
31960
32671
  /**
31961
32672
  * Greetings service.
31962
32673
  * @module purecloud-platform-client-v2/api/GreetingsApi
31963
- * @version 173.0.0
32674
+ * @version 174.0.0
31964
32675
  */
31965
32676
 
31966
32677
  /**
@@ -32415,7 +33126,7 @@ class GroupsApi {
32415
33126
  /**
32416
33127
  * Groups service.
32417
33128
  * @module purecloud-platform-client-v2/api/GroupsApi
32418
- * @version 173.0.0
33129
+ * @version 174.0.0
32419
33130
  */
32420
33131
 
32421
33132
  /**
@@ -32934,7 +33645,7 @@ class IdentityProviderApi {
32934
33645
  /**
32935
33646
  * IdentityProvider service.
32936
33647
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
32937
- * @version 173.0.0
33648
+ * @version 174.0.0
32938
33649
  */
32939
33650
 
32940
33651
  /**
@@ -33690,7 +34401,7 @@ class InfrastructureAsCodeApi {
33690
34401
  /**
33691
34402
  * InfrastructureAsCode service.
33692
34403
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
33693
- * @version 173.0.0
34404
+ * @version 174.0.0
33694
34405
  */
33695
34406
 
33696
34407
  /**
@@ -33857,7 +34568,7 @@ class IntegrationsApi {
33857
34568
  /**
33858
34569
  * Integrations service.
33859
34570
  * @module purecloud-platform-client-v2/api/IntegrationsApi
33860
- * @version 173.0.0
34571
+ * @version 174.0.0
33861
34572
  */
33862
34573
 
33863
34574
  /**
@@ -35819,7 +36530,7 @@ class JourneyApi {
35819
36530
  /**
35820
36531
  * Journey service.
35821
36532
  * @module purecloud-platform-client-v2/api/JourneyApi
35822
- * @version 173.0.0
36533
+ * @version 174.0.0
35823
36534
  */
35824
36535
 
35825
36536
  /**
@@ -36019,6 +36730,37 @@ class JourneyApi {
36019
36730
  );
36020
36731
  }
36021
36732
 
36733
+ /**
36734
+ * Retrieve all sessions for a given external contact.
36735
+ *
36736
+ * @param {String} contactId ExternalContact ID
36737
+ * @param {Object} opts Optional parameters
36738
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
36739
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
36740
+ * @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
36741
+ */
36742
+ getExternalcontactsContactJourneySessions(contactId, opts) {
36743
+ opts = opts || {};
36744
+
36745
+ // verify the required parameter 'contactId' is set
36746
+ if (contactId === undefined || contactId === null) {
36747
+ throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
36748
+ }
36749
+
36750
+ return this.apiClient.callApi(
36751
+ '/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
36752
+ 'GET',
36753
+ { 'contactId': contactId },
36754
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
36755
+ { },
36756
+ { },
36757
+ null,
36758
+ ['PureCloud OAuth'],
36759
+ ['application/json'],
36760
+ ['application/json']
36761
+ );
36762
+ }
36763
+
36022
36764
  /**
36023
36765
  * Retrieve a single action map.
36024
36766
  *
@@ -36819,6 +37561,36 @@ class JourneyApi {
36819
37561
  );
36820
37562
  }
36821
37563
 
37564
+ /**
37565
+ * Send a journey app event, used for tracking customer activity on an application.
37566
+ *
37567
+ * @param {String} deploymentId The ID of the deployment sending the app event.
37568
+ * @param {Object} opts Optional parameters
37569
+ * @param {Object} opts.body
37570
+ * postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
37571
+ */
37572
+ postJourneyDeploymentAppevents(deploymentId, opts) {
37573
+ opts = opts || {};
37574
+
37575
+ // verify the required parameter 'deploymentId' is set
37576
+ if (deploymentId === undefined || deploymentId === null) {
37577
+ throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
37578
+ }
37579
+
37580
+ return this.apiClient.callApi(
37581
+ '/api/v2/journey/deployments/{deploymentId}/appevents',
37582
+ 'POST',
37583
+ { 'deploymentId': deploymentId },
37584
+ { },
37585
+ { },
37586
+ { },
37587
+ opts['body'],
37588
+ ['PureCloud OAuth'],
37589
+ ['application/json'],
37590
+ ['application/json']
37591
+ );
37592
+ }
37593
+
36822
37594
  /**
36823
37595
  * Create an outcome.
36824
37596
  *
@@ -36922,7 +37694,7 @@ class KnowledgeApi {
36922
37694
  /**
36923
37695
  * Knowledge service.
36924
37696
  * @module purecloud-platform-client-v2/api/KnowledgeApi
36925
- * @version 173.0.0
37697
+ * @version 174.0.0
36926
37698
  */
36927
37699
 
36928
37700
  /**
@@ -37479,6 +38251,85 @@ class KnowledgeApi {
37479
38251
  );
37480
38252
  }
37481
38253
 
38254
+ /**
38255
+ * Get a list of feedback records given on a document
38256
+ *
38257
+ * @param {String} knowledgeBaseId Knowledge base ID.
38258
+ * @param {String} documentId Document ID.
38259
+ * @param {Object} opts Optional parameters
38260
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
38261
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
38262
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
38263
+ * @param {Boolean} opts.onlyCommented If true, only feedback records that have comment are returned. If false, feedback records with and without comment are returned. Default: false.
38264
+ * @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
38265
+ * @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
38266
+ * @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
38267
+ * @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
38268
+ * @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
38269
+ * @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
38270
+ * @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
38271
+ */
38272
+ getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
38273
+ opts = opts || {};
38274
+
38275
+ // verify the required parameter 'knowledgeBaseId' is set
38276
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
38277
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
38278
+ }
38279
+ // verify the required parameter 'documentId' is set
38280
+ if (documentId === undefined || documentId === null) {
38281
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
38282
+ }
38283
+
38284
+ return this.apiClient.callApi(
38285
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
38286
+ 'GET',
38287
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
38288
+ { 'before': opts['before'],'after': opts['after'],'pageSize': opts['pageSize'],'onlyCommented': opts['onlyCommented'],'documentVersionId': opts['documentVersionId'],'documentVariationId': opts['documentVariationId'],'appType': opts['appType'],'queryType': opts['queryType'],'userId': opts['userId'],'queueId': opts['queueId'],'state': opts['state'] },
38289
+ { },
38290
+ { },
38291
+ null,
38292
+ ['PureCloud OAuth'],
38293
+ ['application/json'],
38294
+ ['application/json']
38295
+ );
38296
+ }
38297
+
38298
+ /**
38299
+ * Get a single feedback record given on a document
38300
+ *
38301
+ * @param {String} knowledgeBaseId Knowledge base ID.
38302
+ * @param {String} documentId Document ID.
38303
+ * @param {String} feedbackId Feedback ID.
38304
+ */
38305
+ getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
38306
+ // verify the required parameter 'knowledgeBaseId' is set
38307
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
38308
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
38309
+ }
38310
+ // verify the required parameter 'documentId' is set
38311
+ if (documentId === undefined || documentId === null) {
38312
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
38313
+ }
38314
+ // verify the required parameter 'feedbackId' is set
38315
+ if (feedbackId === undefined || feedbackId === null) {
38316
+ throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
38317
+ }
38318
+
38319
+ return this.apiClient.callApi(
38320
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
38321
+ 'GET',
38322
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
38323
+ { },
38324
+ { },
38325
+ { },
38326
+ null,
38327
+ ['PureCloud OAuth'],
38328
+ ['application/json'],
38329
+ ['application/json']
38330
+ );
38331
+ }
38332
+
37482
38333
  /**
37483
38334
  * Get a variation for a document.
37484
38335
  *
@@ -37786,8 +38637,12 @@ class KnowledgeApi {
37786
38637
  *
37787
38638
  * @param {String} knowledgeBaseId Knowledge base ID
37788
38639
  * @param {String} importJobId Import job ID
38640
+ * @param {Object} opts Optional parameters
38641
+ * @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
37789
38642
  */
37790
- getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
38643
+ getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
38644
+ opts = opts || {};
38645
+
37791
38646
  // verify the required parameter 'knowledgeBaseId' is set
37792
38647
  if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
37793
38648
  throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
@@ -37801,7 +38656,7 @@ class KnowledgeApi {
37801
38656
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
37802
38657
  'GET',
37803
38658
  { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
37804
- { },
38659
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
37805
38660
  { },
37806
38661
  { },
37807
38662
  null,
@@ -38824,6 +39679,40 @@ class KnowledgeApi {
38824
39679
  );
38825
39680
  }
38826
39681
 
39682
+ /**
39683
+ * Give feedback on a document
39684
+ *
39685
+ * @param {String} sessionId Knowledge guest session ID.
39686
+ * @param {String} documentId Document ID.
39687
+ * @param {Object} opts Optional parameters
39688
+ * @param {Object} opts.body
39689
+ */
39690
+ postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
39691
+ opts = opts || {};
39692
+
39693
+ // verify the required parameter 'sessionId' is set
39694
+ if (sessionId === undefined || sessionId === null) {
39695
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
39696
+ }
39697
+ // verify the required parameter 'documentId' is set
39698
+ if (documentId === undefined || documentId === null) {
39699
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
39700
+ }
39701
+
39702
+ return this.apiClient.callApi(
39703
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
39704
+ 'POST',
39705
+ { 'sessionId': sessionId,'documentId': documentId },
39706
+ { },
39707
+ { },
39708
+ { },
39709
+ opts['body'],
39710
+ ['PureCloud OAuth'],
39711
+ ['application/json'],
39712
+ ['application/json']
39713
+ );
39714
+ }
39715
+
38827
39716
  /**
38828
39717
  * Search the documents in a guest session.
38829
39718
  *
@@ -38938,6 +39827,40 @@ class KnowledgeApi {
38938
39827
  );
38939
39828
  }
38940
39829
 
39830
+ /**
39831
+ * Give feedback on a document
39832
+ *
39833
+ * @param {String} knowledgeBaseId Knowledge base ID.
39834
+ * @param {String} documentId Document ID.
39835
+ * @param {Object} opts Optional parameters
39836
+ * @param {Object} opts.body
39837
+ */
39838
+ postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
39839
+ opts = opts || {};
39840
+
39841
+ // verify the required parameter 'knowledgeBaseId' is set
39842
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
39843
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
39844
+ }
39845
+ // verify the required parameter 'documentId' is set
39846
+ if (documentId === undefined || documentId === null) {
39847
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
39848
+ }
39849
+
39850
+ return this.apiClient.callApi(
39851
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
39852
+ 'POST',
39853
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
39854
+ { },
39855
+ { },
39856
+ { },
39857
+ opts['body'],
39858
+ ['PureCloud OAuth'],
39859
+ ['application/json'],
39860
+ ['application/json']
39861
+ );
39862
+ }
39863
+
38941
39864
  /**
38942
39865
  * Create a variation for a document.
38943
39866
  *
@@ -39008,6 +39931,40 @@ class KnowledgeApi {
39008
39931
  );
39009
39932
  }
39010
39933
 
39934
+ /**
39935
+ * Create view for a document.
39936
+ *
39937
+ * @param {String} knowledgeBaseId Knowledge base ID.
39938
+ * @param {String} documentId Document ID.
39939
+ * @param {Object} opts Optional parameters
39940
+ * @param {Object} opts.body
39941
+ */
39942
+ postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
39943
+ opts = opts || {};
39944
+
39945
+ // verify the required parameter 'knowledgeBaseId' is set
39946
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
39947
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
39948
+ }
39949
+ // verify the required parameter 'documentId' is set
39950
+ if (documentId === undefined || documentId === null) {
39951
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
39952
+ }
39953
+
39954
+ return this.apiClient.callApi(
39955
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
39956
+ 'POST',
39957
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
39958
+ { },
39959
+ { },
39960
+ { },
39961
+ opts['body'],
39962
+ ['PureCloud OAuth'],
39963
+ ['application/json'],
39964
+ ['application/json']
39965
+ );
39966
+ }
39967
+
39011
39968
  /**
39012
39969
  * Create document.
39013
39970
  *
@@ -39558,7 +40515,7 @@ class LanguageUnderstandingApi {
39558
40515
  /**
39559
40516
  * LanguageUnderstanding service.
39560
40517
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
39561
- * @version 173.0.0
40518
+ * @version 174.0.0
39562
40519
  */
39563
40520
 
39564
40521
  /**
@@ -40571,7 +41528,7 @@ class LanguagesApi {
40571
41528
  /**
40572
41529
  * Languages service.
40573
41530
  * @module purecloud-platform-client-v2/api/LanguagesApi
40574
- * @version 173.0.0
41531
+ * @version 174.0.0
40575
41532
  */
40576
41533
 
40577
41534
  /**
@@ -40793,7 +41750,7 @@ class LearningApi {
40793
41750
  /**
40794
41751
  * Learning service.
40795
41752
  * @module purecloud-platform-client-v2/api/LearningApi
40796
- * @version 173.0.0
41753
+ * @version 174.0.0
40797
41754
  */
40798
41755
 
40799
41756
  /**
@@ -41608,7 +42565,7 @@ class LicenseApi {
41608
42565
  /**
41609
42566
  * License service.
41610
42567
  * @module purecloud-platform-client-v2/api/LicenseApi
41611
- * @version 173.0.0
42568
+ * @version 174.0.0
41612
42569
  */
41613
42570
 
41614
42571
  /**
@@ -41846,7 +42803,7 @@ class LocationsApi {
41846
42803
  /**
41847
42804
  * Locations service.
41848
42805
  * @module purecloud-platform-client-v2/api/LocationsApi
41849
- * @version 173.0.0
42806
+ * @version 174.0.0
41850
42807
  */
41851
42808
 
41852
42809
  /**
@@ -42082,7 +43039,7 @@ class MessagingApi {
42082
43039
  /**
42083
43040
  * Messaging service.
42084
43041
  * @module purecloud-platform-client-v2/api/MessagingApi
42085
- * @version 173.0.0
43042
+ * @version 174.0.0
42086
43043
  */
42087
43044
 
42088
43045
  /**
@@ -42441,7 +43398,7 @@ class MobileDevicesApi {
42441
43398
  /**
42442
43399
  * MobileDevices service.
42443
43400
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
42444
- * @version 173.0.0
43401
+ * @version 174.0.0
42445
43402
  */
42446
43403
 
42447
43404
  /**
@@ -42592,7 +43549,7 @@ class NotificationsApi {
42592
43549
  /**
42593
43550
  * Notifications service.
42594
43551
  * @module purecloud-platform-client-v2/api/NotificationsApi
42595
- * @version 173.0.0
43552
+ * @version 174.0.0
42596
43553
  */
42597
43554
 
42598
43555
  /**
@@ -42825,7 +43782,7 @@ class OAuthApi {
42825
43782
  /**
42826
43783
  * OAuth service.
42827
43784
  * @module purecloud-platform-client-v2/api/OAuthApi
42828
- * @version 173.0.0
43785
+ * @version 174.0.0
42829
43786
  */
42830
43787
 
42831
43788
  /**
@@ -43191,7 +44148,7 @@ class ObjectsApi {
43191
44148
  /**
43192
44149
  * Objects service.
43193
44150
  * @module purecloud-platform-client-v2/api/ObjectsApi
43194
- * @version 173.0.0
44151
+ * @version 174.0.0
43195
44152
  */
43196
44153
 
43197
44154
  /**
@@ -43462,7 +44419,7 @@ class OrganizationApi {
43462
44419
  /**
43463
44420
  * Organization service.
43464
44421
  * @module purecloud-platform-client-v2/api/OrganizationApi
43465
- * @version 173.0.0
44422
+ * @version 174.0.0
43466
44423
  */
43467
44424
 
43468
44425
  /**
@@ -43917,7 +44874,7 @@ class OrganizationAuthorizationApi {
43917
44874
  /**
43918
44875
  * OrganizationAuthorization service.
43919
44876
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
43920
- * @version 173.0.0
44877
+ * @version 174.0.0
43921
44878
  */
43922
44879
 
43923
44880
  /**
@@ -45264,7 +46221,7 @@ class OutboundApi {
45264
46221
  /**
45265
46222
  * Outbound service.
45266
46223
  * @module purecloud-platform-client-v2/api/OutboundApi
45267
- * @version 173.0.0
46224
+ * @version 174.0.0
45268
46225
  */
45269
46226
 
45270
46227
  /**
@@ -48886,7 +49843,7 @@ class PresenceApi {
48886
49843
  /**
48887
49844
  * Presence service.
48888
49845
  * @module purecloud-platform-client-v2/api/PresenceApi
48889
- * @version 173.0.0
49846
+ * @version 174.0.0
48890
49847
  */
48891
49848
 
48892
49849
  /**
@@ -49625,7 +50582,7 @@ class ProcessAutomationApi {
49625
50582
  /**
49626
50583
  * ProcessAutomation service.
49627
50584
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
49628
- * @version 173.0.0
50585
+ * @version 174.0.0
49629
50586
  */
49630
50587
 
49631
50588
  /**
@@ -49864,7 +50821,7 @@ class QualityApi {
49864
50821
  /**
49865
50822
  * Quality service.
49866
50823
  * @module purecloud-platform-client-v2/api/QualityApi
49867
- * @version 173.0.0
50824
+ * @version 174.0.0
49868
50825
  */
49869
50826
 
49870
50827
  /**
@@ -50147,6 +51104,7 @@ class QualityApi {
50147
51104
  * @param {String} opts.evaluatorUserId user id of the evaluator
50148
51105
  * @param {String} opts.name name
50149
51106
  * @param {String} opts.group group id
51107
+ * @param {String} opts.formContextId shared id between form versions
50150
51108
  */
50151
51109
  getQualityAgentsActivity(opts) {
50152
51110
  opts = opts || {};
@@ -50156,7 +51114,7 @@ class QualityApi {
50156
51114
  '/api/v2/quality/agents/activity',
50157
51115
  'GET',
50158
51116
  { },
50159
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'] },
51117
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'startTime': opts['startTime'],'endTime': opts['endTime'],'agentUserId': this.apiClient.buildCollectionParam(opts['agentUserId'], 'multi'),'evaluatorUserId': opts['evaluatorUserId'],'name': opts['name'],'group': opts['group'],'formContextId': opts['formContextId'] },
50160
51118
  { },
50161
51119
  { },
50162
51120
  null,
@@ -50354,9 +51312,9 @@ class QualityApi {
50354
51312
  * @param {Object} opts Optional parameters
50355
51313
  * @param {Number} opts.pageSize The total page size requested (default to 25)
50356
51314
  * @param {Number} opts.pageNumber The page number requested (default to 1)
50357
- * @param {String} opts.sortBy variable name requested to sort by
51315
+ * @param {String} opts.sortBy NOTE: Does not work when querying evaluations
50358
51316
  * @param {Array.<String>} opts.expand variable name requested by expand list
50359
- * @param {String} opts.nextPage next page token
51317
+ * @param {String} opts.nextPage NOTE: Does not work when querying evaluations
50360
51318
  * @param {String} opts.previousPage Previous page token
50361
51319
  * @param {String} opts.conversationId conversationId specified
50362
51320
  * @param {String} opts.agentUserId user id of the agent
@@ -50365,12 +51323,13 @@ class QualityApi {
50365
51323
  * @param {String} opts.queueId queue id
50366
51324
  * @param {String} opts.startTime start time of the evaluation query
50367
51325
  * @param {String} opts.endTime end time of the evaluation query
51326
+ * @param {String} opts.formContextId shared id between form versions
50368
51327
  * @param {Array.<String>} opts.evaluationState
50369
51328
  * @param {Boolean} opts.isReleased the evaluation has been released
50370
51329
  * @param {Boolean} opts.agentHasRead agent has the evaluation
50371
51330
  * @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
50372
- * @param {Number} opts.maximum maximum
50373
- * @param {String} opts.sortOrder sort order options for agentUserId or evaluatorUserId query. Valid options are 'a', 'asc', 'ascending', 'd', 'desc', 'descending'. Sorts by assigned date when evaluatorUserId or agentTeamId are supplied, and by released date for agentUserId
51331
+ * @param {Number} opts.maximum the maximum number of results to return
51332
+ * @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
50374
51333
  */
50375
51334
  getQualityEvaluationsQuery(opts) {
50376
51335
  opts = opts || {};
@@ -50380,7 +51339,7 @@ class QualityApi {
50380
51339
  '/api/v2/quality/evaluations/query',
50381
51340
  'GET',
50382
51341
  { },
50383
- { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
51342
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'sortBy': opts['sortBy'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi'),'nextPage': opts['nextPage'],'previousPage': opts['previousPage'],'conversationId': opts['conversationId'],'agentUserId': opts['agentUserId'],'evaluatorUserId': opts['evaluatorUserId'],'assigneeUserId': opts['assigneeUserId'],'queueId': opts['queueId'],'startTime': opts['startTime'],'endTime': opts['endTime'],'formContextId': opts['formContextId'],'evaluationState': this.apiClient.buildCollectionParam(opts['evaluationState'], 'multi'),'isReleased': opts['isReleased'],'agentHasRead': opts['agentHasRead'],'expandAnswerTotalScores': opts['expandAnswerTotalScores'],'maximum': opts['maximum'],'sortOrder': opts['sortOrder'] },
50384
51343
  { },
50385
51344
  { },
50386
51345
  null,
@@ -51457,7 +52416,7 @@ class QualityApi {
51457
52416
  * @param {String} evaluationId evaluationId
51458
52417
  * @param {Object} body evaluation
51459
52418
  * @param {Object} opts Optional parameters
51460
- * @param {String} opts.expand evaluatorId, evaluationForm, assignee
52419
+ * @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
51461
52420
  */
51462
52421
  putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
51463
52422
  opts = opts || {};
@@ -51616,7 +52575,7 @@ class RecordingApi {
51616
52575
  /**
51617
52576
  * Recording service.
51618
52577
  * @module purecloud-platform-client-v2/api/RecordingApi
51619
- * @version 173.0.0
52578
+ * @version 174.0.0
51620
52579
  */
51621
52580
 
51622
52581
  /**
@@ -53253,7 +54212,7 @@ class ResponseManagementApi {
53253
54212
  /**
53254
54213
  * ResponseManagement service.
53255
54214
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
53256
- * @version 173.0.0
54215
+ * @version 174.0.0
53257
54216
  */
53258
54217
 
53259
54218
  /**
@@ -53738,7 +54697,7 @@ class RoutingApi {
53738
54697
  /**
53739
54698
  * Routing service.
53740
54699
  * @module purecloud-platform-client-v2/api/RoutingApi
53741
- * @version 173.0.0
54700
+ * @version 174.0.0
53742
54701
  */
53743
54702
 
53744
54703
  /**
@@ -54745,6 +55704,7 @@ class RoutingApi {
54745
55704
  *
54746
55705
  * @param {Object} opts Optional parameters
54747
55706
  * @param {Object} opts.messengerType Messenger Type
55707
+ * @param {String} opts.name Recipient Name
54748
55708
  * @param {Number} opts.pageSize Page size (default to 25)
54749
55709
  * @param {Number} opts.pageNumber Page number (default to 1)
54750
55710
  */
@@ -54756,7 +55716,7 @@ class RoutingApi {
54756
55716
  '/api/v2/routing/message/recipients',
54757
55717
  'GET',
54758
55718
  { },
54759
- { 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
55719
+ { 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
54760
55720
  { },
54761
55721
  { },
54762
55722
  null,
@@ -55047,10 +56007,10 @@ class RoutingApi {
55047
56007
  * @param {Number} opts.pageSize Max value is 100 (default to 25)
55048
56008
  * @param {Object} opts.sortOrder Note: results are sorted by name. (default to asc)
55049
56009
  * @param {Array.<String>} opts.expand Which fields, if any, to expand.
55050
- * @param {String} opts.name Filter by queue member name
55051
- * @param {Array.<String>} opts.profileSkills Filter by profile skill
55052
- * @param {Array.<String>} opts.skills Filter by skill
55053
- * @param {Array.<String>} opts.languages Filter by language
56010
+ * @param {String} opts.name Filter by queue member name (contains-style search)
56011
+ * @param {Array.<String>} opts.profileSkills Filter by profile skill (contains-style search)
56012
+ * @param {Array.<String>} opts.skills Filter by skill (contains-style search)
56013
+ * @param {Array.<String>} opts.languages Filter by language (contains-style search)
55054
56014
  * @param {Array.<String>} opts.routingStatus Filter by routing status
55055
56015
  * @param {Array.<String>} opts.presence Filter by presence
55056
56016
  * @param {Object} opts.memberBy Filter by member type
@@ -57445,7 +58405,7 @@ class SCIMApi {
57445
58405
  /**
57446
58406
  * SCIM service.
57447
58407
  * @module purecloud-platform-client-v2/api/SCIMApi
57448
- * @version 173.0.0
58408
+ * @version 174.0.0
57449
58409
  */
57450
58410
 
57451
58411
  /**
@@ -58322,7 +59282,7 @@ class ScriptsApi {
58322
59282
  /**
58323
59283
  * Scripts service.
58324
59284
  * @module purecloud-platform-client-v2/api/ScriptsApi
58325
- * @version 173.0.0
59285
+ * @version 174.0.0
58326
59286
  */
58327
59287
 
58328
59288
  /**
@@ -58766,7 +59726,7 @@ class SearchApi {
58766
59726
  /**
58767
59727
  * Search service.
58768
59728
  * @module purecloud-platform-client-v2/api/SearchApi
58769
- * @version 173.0.0
59729
+ * @version 174.0.0
58770
59730
  */
58771
59731
 
58772
59732
  /**
@@ -59455,7 +60415,7 @@ class SettingsApi {
59455
60415
  /**
59456
60416
  * Settings service.
59457
60417
  * @module purecloud-platform-client-v2/api/SettingsApi
59458
- * @version 173.0.0
60418
+ * @version 174.0.0
59459
60419
  */
59460
60420
 
59461
60421
  /**
@@ -59520,7 +60480,7 @@ class SpeechTextAnalyticsApi {
59520
60480
  /**
59521
60481
  * SpeechTextAnalytics service.
59522
60482
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
59523
- * @version 173.0.0
60483
+ * @version 174.0.0
59524
60484
  */
59525
60485
 
59526
60486
  /**
@@ -60503,7 +61463,7 @@ class StationsApi {
60503
61463
  /**
60504
61464
  * Stations service.
60505
61465
  * @module purecloud-platform-client-v2/api/StationsApi
60506
- * @version 173.0.0
61466
+ * @version 174.0.0
60507
61467
  */
60508
61468
 
60509
61469
  /**
@@ -60605,7 +61565,7 @@ class SuggestApi {
60605
61565
  /**
60606
61566
  * Suggest service.
60607
61567
  * @module purecloud-platform-client-v2/api/SuggestApi
60608
- * @version 173.0.0
61568
+ * @version 174.0.0
60609
61569
  */
60610
61570
 
60611
61571
  /**
@@ -60744,7 +61704,7 @@ class TaskManagementApi {
60744
61704
  /**
60745
61705
  * TaskManagement service.
60746
61706
  * @module purecloud-platform-client-v2/api/TaskManagementApi
60747
- * @version 173.0.0
61707
+ * @version 174.0.0
60748
61708
  */
60749
61709
 
60750
61710
  /**
@@ -62025,7 +62985,7 @@ class TeamsApi {
62025
62985
  /**
62026
62986
  * Teams service.
62027
62987
  * @module purecloud-platform-client-v2/api/TeamsApi
62028
- * @version 173.0.0
62988
+ * @version 174.0.0
62029
62989
  */
62030
62990
 
62031
62991
  /**
@@ -62327,7 +63287,7 @@ class TelephonyApi {
62327
63287
  /**
62328
63288
  * Telephony service.
62329
63289
  * @module purecloud-platform-client-v2/api/TelephonyApi
62330
- * @version 173.0.0
63290
+ * @version 174.0.0
62331
63291
  */
62332
63292
 
62333
63293
  /**
@@ -62455,7 +63415,7 @@ class TelephonyProvidersEdgeApi {
62455
63415
  /**
62456
63416
  * TelephonyProvidersEdge service.
62457
63417
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
62458
- * @version 173.0.0
63418
+ * @version 174.0.0
62459
63419
  */
62460
63420
 
62461
63421
  /**
@@ -64118,7 +65078,7 @@ class TelephonyProvidersEdgeApi {
64118
65078
  }
64119
65079
 
64120
65080
  /**
64121
- * Get a list of Phone Instances
65081
+ * Get a list of Phone Instances. A maximum of 10,000 results is returned when filtering the results or sorting by a field other than the ID. Sorting by only the ID has no result limit. Each filter supports a wildcard, *, as a value to search for partial values.
64122
65082
  *
64123
65083
  * @param {Object} opts Optional parameters
64124
65084
  * @param {Number} opts.pageNumber Page number (default to 1)
@@ -65744,7 +66704,7 @@ class TextbotsApi {
65744
66704
  /**
65745
66705
  * Textbots service.
65746
66706
  * @module purecloud-platform-client-v2/api/TextbotsApi
65747
- * @version 173.0.0
66707
+ * @version 174.0.0
65748
66708
  */
65749
66709
 
65750
66710
  /**
@@ -65872,7 +66832,7 @@ class TokensApi {
65872
66832
  /**
65873
66833
  * Tokens service.
65874
66834
  * @module purecloud-platform-client-v2/api/TokensApi
65875
- * @version 173.0.0
66835
+ * @version 174.0.0
65876
66836
  */
65877
66837
 
65878
66838
  /**
@@ -65935,14 +66895,18 @@ class TokensApi {
65935
66895
  /**
65936
66896
  * Fetch information about the current token
65937
66897
  *
66898
+ * @param {Object} opts Optional parameters
66899
+ * @param {Boolean} opts.preserveIdleTTL preserveIdleTTL indicates whether the idle token timeout should be reset or preserved. If preserveIdleTTL is true, then TTL value is not reset. If unset or false, the value is reset.
65938
66900
  */
65939
- getTokensMe() {
66901
+ getTokensMe(opts) {
66902
+ opts = opts || {};
66903
+
65940
66904
 
65941
66905
  return this.apiClient.callApi(
65942
66906
  '/api/v2/tokens/me',
65943
66907
  'GET',
65944
66908
  { },
65945
- { },
66909
+ { 'preserveIdleTTL': opts['preserveIdleTTL'] },
65946
66910
  { },
65947
66911
  { },
65948
66912
  null,
@@ -66024,7 +66988,7 @@ class UploadsApi {
66024
66988
  /**
66025
66989
  * Uploads service.
66026
66990
  * @module purecloud-platform-client-v2/api/UploadsApi
66027
- * @version 173.0.0
66991
+ * @version 174.0.0
66028
66992
  */
66029
66993
 
66030
66994
  /**
@@ -66200,7 +67164,7 @@ class UsageApi {
66200
67164
  /**
66201
67165
  * Usage service.
66202
67166
  * @module purecloud-platform-client-v2/api/UsageApi
66203
- * @version 173.0.0
67167
+ * @version 174.0.0
66204
67168
  */
66205
67169
 
66206
67170
  /**
@@ -66410,7 +67374,7 @@ class UserRecordingsApi {
66410
67374
  /**
66411
67375
  * UserRecordings service.
66412
67376
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
66413
- * @version 173.0.0
67377
+ * @version 174.0.0
66414
67378
  */
66415
67379
 
66416
67380
  /**
@@ -66595,7 +67559,7 @@ class UsersApi {
66595
67559
  /**
66596
67560
  * Users service.
66597
67561
  * @module purecloud-platform-client-v2/api/UsersApi
66598
- * @version 173.0.0
67562
+ * @version 174.0.0
66599
67563
  */
66600
67564
 
66601
67565
  /**
@@ -69156,7 +70120,7 @@ class UtilitiesApi {
69156
70120
  /**
69157
70121
  * Utilities service.
69158
70122
  * @module purecloud-platform-client-v2/api/UtilitiesApi
69159
- * @version 173.0.0
70123
+ * @version 174.0.0
69160
70124
  */
69161
70125
 
69162
70126
  /**
@@ -69267,7 +70231,7 @@ class VoicemailApi {
69267
70231
  /**
69268
70232
  * Voicemail service.
69269
70233
  * @module purecloud-platform-client-v2/api/VoicemailApi
69270
- * @version 173.0.0
70234
+ * @version 174.0.0
69271
70235
  */
69272
70236
 
69273
70237
  /**
@@ -69934,7 +70898,7 @@ class WebChatApi {
69934
70898
  /**
69935
70899
  * WebChat service.
69936
70900
  * @module purecloud-platform-client-v2/api/WebChatApi
69937
- * @version 173.0.0
70901
+ * @version 174.0.0
69938
70902
  */
69939
70903
 
69940
70904
  /**
@@ -70483,7 +71447,7 @@ class WebDeploymentsApi {
70483
71447
  /**
70484
71448
  * WebDeployments service.
70485
71449
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
70486
- * @version 173.0.0
71450
+ * @version 174.0.0
70487
71451
  */
70488
71452
 
70489
71453
  /**
@@ -70711,8 +71675,12 @@ class WebDeploymentsApi {
70711
71675
  * Get a deployment
70712
71676
  *
70713
71677
  * @param {String} deploymentId The deployment ID
71678
+ * @param {Object} opts Optional parameters
71679
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
70714
71680
  */
70715
- getWebdeploymentsDeployment(deploymentId) {
71681
+ getWebdeploymentsDeployment(deploymentId, opts) {
71682
+ opts = opts || {};
71683
+
70716
71684
  // verify the required parameter 'deploymentId' is set
70717
71685
  if (deploymentId === undefined || deploymentId === null) {
70718
71686
  throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
@@ -70722,7 +71690,7 @@ class WebDeploymentsApi {
70722
71690
  '/api/v2/webdeployments/deployments/{deploymentId}',
70723
71691
  'GET',
70724
71692
  { 'deploymentId': deploymentId },
70725
- { },
71693
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
70726
71694
  { },
70727
71695
  { },
70728
71696
  null,
@@ -70768,6 +71736,7 @@ class WebDeploymentsApi {
70768
71736
  * @param {String} deploymentId The deployment ID
70769
71737
  * @param {Object} opts Optional parameters
70770
71738
  * @param {String} opts.type Get active configuration on a deployment
71739
+ * @param {Array.<String>} opts.expand Expand instructions for the return value
70771
71740
  */
70772
71741
  getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
70773
71742
  opts = opts || {};
@@ -70781,7 +71750,7 @@ class WebDeploymentsApi {
70781
71750
  '/api/v2/webdeployments/deployments/{deploymentId}/configurations',
70782
71751
  'GET',
70783
71752
  { 'deploymentId': deploymentId },
70784
- { 'type': opts['type'] },
71753
+ { 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
70785
71754
  { },
70786
71755
  { },
70787
71756
  null,
@@ -70795,7 +71764,7 @@ class WebDeploymentsApi {
70795
71764
  * Get deployments
70796
71765
  *
70797
71766
  * @param {Object} opts Optional parameters
70798
- * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. Valid values:
71767
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
70799
71768
  */
70800
71769
  getWebdeploymentsDeployments(opts) {
70801
71770
  opts = opts || {};
@@ -71005,7 +71974,7 @@ class WebMessagingApi {
71005
71974
  /**
71006
71975
  * WebMessaging service.
71007
71976
  * @module purecloud-platform-client-v2/api/WebMessagingApi
71008
- * @version 173.0.0
71977
+ * @version 174.0.0
71009
71978
  */
71010
71979
 
71011
71980
  /**
@@ -71051,7 +72020,7 @@ class WidgetsApi {
71051
72020
  /**
71052
72021
  * Widgets service.
71053
72022
  * @module purecloud-platform-client-v2/api/WidgetsApi
71054
- * @version 173.0.0
72023
+ * @version 174.0.0
71055
72024
  */
71056
72025
 
71057
72026
  /**
@@ -71197,7 +72166,7 @@ class WorkforceManagementApi {
71197
72166
  /**
71198
72167
  * WorkforceManagement service.
71199
72168
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
71200
- * @version 173.0.0
72169
+ * @version 174.0.0
71201
72170
  */
71202
72171
 
71203
72172
  /**
@@ -72116,8 +73085,12 @@ class WorkforceManagementApi {
72116
73085
  *
72117
73086
  * @param {String} businessUnitId The ID of the business unit.
72118
73087
  * @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
73088
+ * @param {Object} opts Optional parameters
73089
+ * @param {Array.<String>} opts.expand Include to access additional data on the service goal template
72119
73090
  */
72120
- getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
73091
+ getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
73092
+ opts = opts || {};
73093
+
72121
73094
  // verify the required parameter 'businessUnitId' is set
72122
73095
  if (businessUnitId === undefined || businessUnitId === null) {
72123
73096
  throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
@@ -72131,7 +73104,7 @@ class WorkforceManagementApi {
72131
73104
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
72132
73105
  'GET',
72133
73106
  { 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
72134
- { },
73107
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
72135
73108
  { },
72136
73109
  { },
72137
73110
  null,
@@ -72145,8 +73118,12 @@ class WorkforceManagementApi {
72145
73118
  * Gets list of service goal templates
72146
73119
  *
72147
73120
  * @param {String} businessUnitId The ID of the business unit.
73121
+ * @param {Object} opts Optional parameters
73122
+ * @param {Array.<String>} opts.expand Include to access additional data on the service goal template
72148
73123
  */
72149
- getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
73124
+ getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
73125
+ opts = opts || {};
73126
+
72150
73127
  // verify the required parameter 'businessUnitId' is set
72151
73128
  if (businessUnitId === undefined || businessUnitId === null) {
72152
73129
  throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
@@ -72156,7 +73133,7 @@ class WorkforceManagementApi {
72156
73133
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
72157
73134
  'GET',
72158
73135
  { 'businessUnitId': businessUnitId },
72159
- { },
73136
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
72160
73137
  { },
72161
73138
  { },
72162
73139
  null,
@@ -72706,6 +73683,51 @@ class WorkforceManagementApi {
72706
73683
  );
72707
73684
  }
72708
73685
 
73686
+ /**
73687
+ * Get integrations
73688
+ *
73689
+ */
73690
+ getWorkforcemanagementIntegrationsHris() {
73691
+
73692
+ return this.apiClient.callApi(
73693
+ '/api/v2/workforcemanagement/integrations/hris',
73694
+ 'GET',
73695
+ { },
73696
+ { },
73697
+ { },
73698
+ { },
73699
+ null,
73700
+ ['PureCloud OAuth'],
73701
+ ['application/json'],
73702
+ ['application/json']
73703
+ );
73704
+ }
73705
+
73706
+ /**
73707
+ * Query the results of time off types job
73708
+ *
73709
+ * @param {String} jobId The ID of the job.
73710
+ */
73711
+ getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
73712
+ // verify the required parameter 'jobId' is set
73713
+ if (jobId === undefined || jobId === null) {
73714
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
73715
+ }
73716
+
73717
+ return this.apiClient.callApi(
73718
+ '/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
73719
+ 'GET',
73720
+ { 'jobId': jobId },
73721
+ { },
73722
+ { },
73723
+ { },
73724
+ null,
73725
+ ['PureCloud OAuth'],
73726
+ ['application/json'],
73727
+ ['application/json']
73728
+ );
73729
+ }
73730
+
72709
73731
  /**
72710
73732
  * Get management unit
72711
73733
  * settings.shortTermForecasting is deprecated and now lives on the business unit
@@ -72736,7 +73758,7 @@ class WorkforceManagementApi {
72736
73758
  }
72737
73759
 
72738
73760
  /**
72739
- * Get activity codes
73761
+ * Deprecated: Instead use /api/v2/workforcemanagement/businessunits/{businessUnitId}/activitycodes. Get the list of activity codes
72740
73762
  *
72741
73763
  * @param {String} managementUnitId The ID of the management unit, or 'mine' for the management unit of the logged-in user.
72742
73764
  * @deprecated
@@ -73519,6 +74541,31 @@ class WorkforceManagementApi {
73519
74541
  );
73520
74542
  }
73521
74543
 
74544
+ /**
74545
+ * Query the results of time off types job
74546
+ *
74547
+ * @param {String} jobId The ID of the job.
74548
+ */
74549
+ getWorkforcemanagementTimeoffbalanceJob(jobId) {
74550
+ // verify the required parameter 'jobId' is set
74551
+ if (jobId === undefined || jobId === null) {
74552
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
74553
+ }
74554
+
74555
+ return this.apiClient.callApi(
74556
+ '/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
74557
+ 'GET',
74558
+ { 'jobId': jobId },
74559
+ { },
74560
+ { },
74561
+ { },
74562
+ null,
74563
+ ['PureCloud OAuth'],
74564
+ ['application/json'],
74565
+ ['application/json']
74566
+ );
74567
+ }
74568
+
73522
74569
  /**
73523
74570
  * Get a time off request for the current user
73524
74571
  *
@@ -73890,6 +74937,45 @@ class WorkforceManagementApi {
73890
74937
  );
73891
74938
  }
73892
74939
 
74940
+ /**
74941
+ * Set integration status for a time off request.
74942
+ *
74943
+ * @param {String} managementUnitId The ID of the management unit.
74944
+ * @param {String} timeOffRequestId The ID of the time off request.
74945
+ * @param {String} userId The ID of user to whom the time off request belongs.
74946
+ * @param {Object} opts Optional parameters
74947
+ * @param {Object} opts.body body
74948
+ */
74949
+ patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
74950
+ opts = opts || {};
74951
+
74952
+ // verify the required parameter 'managementUnitId' is set
74953
+ if (managementUnitId === undefined || managementUnitId === null) {
74954
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
74955
+ }
74956
+ // verify the required parameter 'timeOffRequestId' is set
74957
+ if (timeOffRequestId === undefined || timeOffRequestId === null) {
74958
+ throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
74959
+ }
74960
+ // verify the required parameter 'userId' is set
74961
+ if (userId === undefined || userId === null) {
74962
+ throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
74963
+ }
74964
+
74965
+ return this.apiClient.callApi(
74966
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
74967
+ 'PATCH',
74968
+ { 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
74969
+ { },
74970
+ { },
74971
+ { },
74972
+ opts['body'],
74973
+ ['PureCloud OAuth'],
74974
+ ['application/json'],
74975
+ ['application/json']
74976
+ );
74977
+ }
74978
+
73893
74979
  /**
73894
74980
  * Update a time off request
73895
74981
  *
@@ -74127,6 +75213,7 @@ class WorkforceManagementApi {
74127
75213
  *
74128
75214
  * @param {Object} opts Optional parameters
74129
75215
  * @param {Object} opts.body body
75216
+ * @deprecated
74130
75217
  */
74131
75218
  postWorkforcemanagementAdherenceHistorical(opts) {
74132
75219
  opts = opts || {};
@@ -74235,6 +75322,54 @@ class WorkforceManagementApi {
74235
75322
  );
74236
75323
  }
74237
75324
 
75325
+ /**
75326
+ * Move agents in and out of management unit
75327
+ *
75328
+ * @param {Object} opts Optional parameters
75329
+ * @param {Object} opts.body body
75330
+ */
75331
+ postWorkforcemanagementAgents(opts) {
75332
+ opts = opts || {};
75333
+
75334
+
75335
+ return this.apiClient.callApi(
75336
+ '/api/v2/workforcemanagement/agents',
75337
+ 'POST',
75338
+ { },
75339
+ { },
75340
+ { },
75341
+ { },
75342
+ opts['body'],
75343
+ ['PureCloud OAuth'],
75344
+ ['application/json'],
75345
+ ['application/json']
75346
+ );
75347
+ }
75348
+
75349
+ /**
75350
+ * Query integrations for agents
75351
+ *
75352
+ * @param {Object} opts Optional parameters
75353
+ * @param {Object} opts.body body
75354
+ */
75355
+ postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
75356
+ opts = opts || {};
75357
+
75358
+
75359
+ return this.apiClient.callApi(
75360
+ '/api/v2/workforcemanagement/agents/integrations/hris/query',
75361
+ 'POST',
75362
+ { },
75363
+ { },
75364
+ { },
75365
+ { },
75366
+ opts['body'],
75367
+ ['PureCloud OAuth'],
75368
+ ['application/json'],
75369
+ ['application/json']
75370
+ );
75371
+ }
75372
+
74238
75373
  /**
74239
75374
  * Get agent possible work shifts for requested time frame
74240
75375
  *
@@ -75057,6 +76192,31 @@ class WorkforceManagementApi {
75057
76192
  );
75058
76193
  }
75059
76194
 
76195
+ /**
76196
+ * Get list of time off types configured in integration
76197
+ *
76198
+ * @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
76199
+ */
76200
+ postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
76201
+ // verify the required parameter 'hrisIntegrationId' is set
76202
+ if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
76203
+ throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
76204
+ }
76205
+
76206
+ return this.apiClient.callApi(
76207
+ '/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
76208
+ 'POST',
76209
+ { 'hrisIntegrationId': hrisIntegrationId },
76210
+ { },
76211
+ { },
76212
+ { },
76213
+ null,
76214
+ ['PureCloud OAuth'],
76215
+ ['application/json'],
76216
+ ['application/json']
76217
+ );
76218
+ }
76219
+
75060
76220
  /**
75061
76221
  * Query published schedules for given given time range for set of users
75062
76222
  *
@@ -75321,6 +76481,35 @@ class WorkforceManagementApi {
75321
76481
  );
75322
76482
  }
75323
76483
 
76484
+ /**
76485
+ * Retrieves integration statuses for a list of time off requests
76486
+ *
76487
+ * @param {String} managementUnitId The ID of the management unit.
76488
+ * @param {Object} opts Optional parameters
76489
+ * @param {Object} opts.body body
76490
+ */
76491
+ postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
76492
+ opts = opts || {};
76493
+
76494
+ // verify the required parameter 'managementUnitId' is set
76495
+ if (managementUnitId === undefined || managementUnitId === null) {
76496
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
76497
+ }
76498
+
76499
+ return this.apiClient.callApi(
76500
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
76501
+ 'POST',
76502
+ { 'managementUnitId': managementUnitId },
76503
+ { },
76504
+ { },
76505
+ { },
76506
+ opts['body'],
76507
+ ['PureCloud OAuth'],
76508
+ ['application/json'],
76509
+ ['application/json']
76510
+ );
76511
+ }
76512
+
75324
76513
  /**
75325
76514
  * Fetches time off requests matching the conditions specified in the request body
75326
76515
  * Request body requires one of the following: User ID is specified, statuses == [Pending] or date range to be specified and less than or equal to 33 days. All other fields are filters
@@ -75449,6 +76638,40 @@ class WorkforceManagementApi {
75449
76638
  );
75450
76639
  }
75451
76640
 
76641
+ /**
76642
+ * Estimates available time off for an agent
76643
+ *
76644
+ * @param {String} managementUnitId The ID of the management unit
76645
+ * @param {String} userId The id of the user for whom the time off request estimate is requested
76646
+ * @param {Object} opts Optional parameters
76647
+ * @param {Object} opts.body body
76648
+ */
76649
+ postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
76650
+ opts = opts || {};
76651
+
76652
+ // verify the required parameter 'managementUnitId' is set
76653
+ if (managementUnitId === undefined || managementUnitId === null) {
76654
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
76655
+ }
76656
+ // verify the required parameter 'userId' is set
76657
+ if (userId === undefined || userId === null) {
76658
+ throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
76659
+ }
76660
+
76661
+ return this.apiClient.callApi(
76662
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
76663
+ 'POST',
76664
+ { 'managementUnitId': managementUnitId,'userId': userId },
76665
+ { },
76666
+ { },
76667
+ { },
76668
+ opts['body'],
76669
+ ['PureCloud OAuth'],
76670
+ ['application/json'],
76671
+ ['application/json']
76672
+ );
76673
+ }
76674
+
75452
76675
  /**
75453
76676
  * Matches a shift trade. This route can only be called by the receiving agent
75454
76677
  *
@@ -75891,6 +77114,31 @@ class WorkforceManagementApi {
75891
77114
  );
75892
77115
  }
75893
77116
 
77117
+ /**
77118
+ * Query time off balances for the current user for specified activity code and dates
77119
+ *
77120
+ * @param {Object} body The request body
77121
+ */
77122
+ postWorkforcemanagementTimeoffbalanceJobs(body) {
77123
+ // verify the required parameter 'body' is set
77124
+ if (body === undefined || body === null) {
77125
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
77126
+ }
77127
+
77128
+ return this.apiClient.callApi(
77129
+ '/api/v2/workforcemanagement/timeoffbalance/jobs',
77130
+ 'POST',
77131
+ { },
77132
+ { },
77133
+ { },
77134
+ { },
77135
+ body,
77136
+ ['PureCloud OAuth'],
77137
+ ['application/json'],
77138
+ ['application/json']
77139
+ );
77140
+ }
77141
+
75894
77142
  /**
75895
77143
  * Queries available time off for the current user
75896
77144
  *
@@ -75939,6 +77187,84 @@ class WorkforceManagementApi {
75939
77187
  );
75940
77188
  }
75941
77189
 
77190
+ /**
77191
+ * Estimates available time off for current user
77192
+ *
77193
+ * @param {Object} opts Optional parameters
77194
+ * @param {Object} opts.body body
77195
+ */
77196
+ postWorkforcemanagementTimeoffrequestsEstimate(opts) {
77197
+ opts = opts || {};
77198
+
77199
+
77200
+ return this.apiClient.callApi(
77201
+ '/api/v2/workforcemanagement/timeoffrequests/estimate',
77202
+ 'POST',
77203
+ { },
77204
+ { },
77205
+ { },
77206
+ { },
77207
+ opts['body'],
77208
+ ['PureCloud OAuth'],
77209
+ ['application/json'],
77210
+ ['application/json']
77211
+ );
77212
+ }
77213
+
77214
+ /**
77215
+ * Retrieves integration statuses for a list of current user time off requests
77216
+ *
77217
+ * @param {Object} opts Optional parameters
77218
+ * @param {Object} opts.body body
77219
+ */
77220
+ postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
77221
+ opts = opts || {};
77222
+
77223
+
77224
+ return this.apiClient.callApi(
77225
+ '/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
77226
+ 'POST',
77227
+ { },
77228
+ { },
77229
+ { },
77230
+ { },
77231
+ opts['body'],
77232
+ ['PureCloud OAuth'],
77233
+ ['application/json'],
77234
+ ['application/json']
77235
+ );
77236
+ }
77237
+
77238
+ /**
77239
+ * Update integrations for agent
77240
+ *
77241
+ * @param {String} agentId The ID of the agent
77242
+ * @param {Object} body body
77243
+ */
77244
+ putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
77245
+ // verify the required parameter 'agentId' is set
77246
+ if (agentId === undefined || agentId === null) {
77247
+ throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
77248
+ }
77249
+ // verify the required parameter 'body' is set
77250
+ if (body === undefined || body === null) {
77251
+ throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
77252
+ }
77253
+
77254
+ return this.apiClient.callApi(
77255
+ '/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
77256
+ 'PUT',
77257
+ { 'agentId': agentId },
77258
+ { },
77259
+ { },
77260
+ { },
77261
+ body,
77262
+ ['PureCloud OAuth'],
77263
+ ['application/json'],
77264
+ ['application/json']
77265
+ );
77266
+ }
77267
+
75942
77268
  /**
75943
77269
  * Sets daily values for a date range of time off limit object
75944
77270
  * Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
@@ -76004,7 +77330,7 @@ class WorkforceManagementApi {
76004
77330
  * </pre>
76005
77331
  * </p>
76006
77332
  * @module purecloud-platform-client-v2/index
76007
- * @version 173.0.0
77333
+ * @version 174.0.0
76008
77334
  */
76009
77335
  class platformClient {
76010
77336
  constructor() {