purecloud-platform-client-v2 173.1.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 +1427 -101
  3. package/dist/web-amd/purecloud-platform-client-v2.js +1427 -101
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +1427 -101
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +1427 -101
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +1076 -18
  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 +3 -2
  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 +362 -5
  82. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -402,7 +402,7 @@ class Configuration {
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 173.1.0
405
+ * @version 174.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1488,7 +1488,7 @@ class AlertingApi {
1488
1488
  /**
1489
1489
  * Alerting service.
1490
1490
  * @module purecloud-platform-client-v2/api/AlertingApi
1491
- * @version 173.1.0
1491
+ * @version 174.0.0
1492
1492
  */
1493
1493
 
1494
1494
  /**
@@ -2138,7 +2138,7 @@ class AnalyticsApi {
2138
2138
  /**
2139
2139
  * Analytics service.
2140
2140
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2141
- * @version 173.1.0
2141
+ * @version 174.0.0
2142
2142
  */
2143
2143
 
2144
2144
  /**
@@ -2286,13 +2286,14 @@ class AnalyticsApi {
2286
2286
 
2287
2287
  /**
2288
2288
  * Get Reporting Turns.
2289
- * 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.
2289
+ * 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.
2290
2290
  * @param {String} botFlowId ID of the bot flow.
2291
2291
  * @param {Object} opts Optional parameters
2292
2292
  * @param {String} opts.after The cursor that points to the ID of the last item in the list of entities that has been returned.
2293
2293
  * @param {String} opts.pageSize Max number of entities to return. Maximum of 250 (default to 50)
2294
+ * @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
2294
2295
  * @param {String} opts.actionId Optional action ID to get the reporting turns associated to a particular flow action
2295
- * @param {String} opts.sessionId Optional session ID to get the reporting turns for a particular session
2296
+ * @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.
2296
2297
  * @param {String} opts.language Optional language code to get the reporting turns for a particular language
2297
2298
  * @param {Object} opts.askActionResults Optional case-insensitive comma separated list of ask action results to filter the reporting turns.
2298
2299
  */
@@ -2308,7 +2309,7 @@ class AnalyticsApi {
2308
2309
  '/api/v2/analytics/botflows/{botFlowId}/reportingturns',
2309
2310
  'GET',
2310
2311
  { 'botFlowId': botFlowId },
2311
- { 'after': opts['after'],'pageSize': opts['pageSize'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
2312
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'interval': opts['interval'],'actionId': opts['actionId'],'sessionId': opts['sessionId'],'language': opts['language'],'askActionResults': opts['askActionResults'] },
2312
2313
  { },
2313
2314
  { },
2314
2315
  null,
@@ -4583,7 +4584,7 @@ class ArchitectApi {
4583
4584
  /**
4584
4585
  * Architect service.
4585
4586
  * @module purecloud-platform-client-v2/api/ArchitectApi
4586
- * @version 173.1.0
4587
+ * @version 174.0.0
4587
4588
  */
4588
4589
 
4589
4590
  /**
@@ -4623,6 +4624,125 @@ class ArchitectApi {
4623
4624
  );
4624
4625
  }
4625
4626
 
4627
+ /**
4628
+ * Delete a grammar.
4629
+ *
4630
+ * @param {String} grammarId grammar ID
4631
+ * deleteArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4632
+ */
4633
+ deleteArchitectGrammar(grammarId) {
4634
+ // verify the required parameter 'grammarId' is set
4635
+ if (grammarId === undefined || grammarId === null) {
4636
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammar';
4637
+ }
4638
+
4639
+ return this.apiClient.callApi(
4640
+ '/api/v2/architect/grammars/{grammarId}',
4641
+ 'DELETE',
4642
+ { 'grammarId': grammarId },
4643
+ { },
4644
+ { },
4645
+ { },
4646
+ null,
4647
+ ['PureCloud OAuth'],
4648
+ ['application/json'],
4649
+ ['application/json']
4650
+ );
4651
+ }
4652
+
4653
+ /**
4654
+ * Delete specified grammar language
4655
+ *
4656
+ * @param {String} grammarId Grammar ID
4657
+ * @param {String} languageCode Language
4658
+ * deleteArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4659
+ */
4660
+ deleteArchitectGrammarLanguage(grammarId, languageCode) {
4661
+ // verify the required parameter 'grammarId' is set
4662
+ if (grammarId === undefined || grammarId === null) {
4663
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguage';
4664
+ }
4665
+ // verify the required parameter 'languageCode' is set
4666
+ if (languageCode === undefined || languageCode === null) {
4667
+ throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguage';
4668
+ }
4669
+
4670
+ return this.apiClient.callApi(
4671
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
4672
+ 'DELETE',
4673
+ { 'grammarId': grammarId,'languageCode': languageCode },
4674
+ { },
4675
+ { },
4676
+ { },
4677
+ null,
4678
+ ['PureCloud OAuth'],
4679
+ ['application/json'],
4680
+ ['application/json']
4681
+ );
4682
+ }
4683
+
4684
+ /**
4685
+ * Clear the DTMF mode file for the grammar language if there is one
4686
+ *
4687
+ * @param {String} grammarId Grammar ID
4688
+ * @param {String} languageCode Language
4689
+ * deleteArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4690
+ */
4691
+ deleteArchitectGrammarLanguageFilesDtmf(grammarId, languageCode) {
4692
+ // verify the required parameter 'grammarId' is set
4693
+ if (grammarId === undefined || grammarId === null) {
4694
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesDtmf';
4695
+ }
4696
+ // verify the required parameter 'languageCode' is set
4697
+ if (languageCode === undefined || languageCode === null) {
4698
+ throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesDtmf';
4699
+ }
4700
+
4701
+ return this.apiClient.callApi(
4702
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
4703
+ 'DELETE',
4704
+ { 'grammarId': grammarId,'languageCode': languageCode },
4705
+ { },
4706
+ { },
4707
+ { },
4708
+ null,
4709
+ ['PureCloud OAuth'],
4710
+ ['application/json'],
4711
+ ['application/json']
4712
+ );
4713
+ }
4714
+
4715
+ /**
4716
+ * Clear the voice mode file for the grammar language if there is one
4717
+ *
4718
+ * @param {String} grammarId Grammar ID
4719
+ * @param {String} languageCode Language
4720
+ * deleteArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
4721
+ */
4722
+ deleteArchitectGrammarLanguageFilesVoice(grammarId, languageCode) {
4723
+ // verify the required parameter 'grammarId' is set
4724
+ if (grammarId === undefined || grammarId === null) {
4725
+ throw 'Missing the required parameter "grammarId" when calling deleteArchitectGrammarLanguageFilesVoice';
4726
+ }
4727
+ // verify the required parameter 'languageCode' is set
4728
+ if (languageCode === undefined || languageCode === null) {
4729
+ throw 'Missing the required parameter "languageCode" when calling deleteArchitectGrammarLanguageFilesVoice';
4730
+ }
4731
+
4732
+ return this.apiClient.callApi(
4733
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
4734
+ 'DELETE',
4735
+ { 'grammarId': grammarId,'languageCode': languageCode },
4736
+ { },
4737
+ { },
4738
+ { },
4739
+ null,
4740
+ ['PureCloud OAuth'],
4741
+ ['application/json'],
4742
+ ['application/json']
4743
+ );
4744
+ }
4745
+
4626
4746
  /**
4627
4747
  * Delete an IVR Config.
4628
4748
  *
@@ -5307,6 +5427,130 @@ class ArchitectApi {
5307
5427
  );
5308
5428
  }
5309
5429
 
5430
+ /**
5431
+ * Get a pageable list of basic emergency group objects filterable by query parameters.
5432
+ * 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.
5433
+ * @param {Object} opts Optional parameters
5434
+ * @param {Number} opts.pageNumber Page number (default to 1)
5435
+ * @param {Number} opts.pageSize Page size (default to 25)
5436
+ * @param {String} opts.sortBy Sort by (default to name)
5437
+ * @param {String} opts.sortOrder Sort order (default to ASC)
5438
+ * @param {Array.<String>} opts.id ID of the Emergency Groups to filter by.
5439
+ * @param {String} opts.name Name of the Emergency Group to filter by.
5440
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
5441
+ */
5442
+ getArchitectEmergencygroupsDivisionviews(opts) {
5443
+ opts = opts || {};
5444
+
5445
+
5446
+ return this.apiClient.callApi(
5447
+ '/api/v2/architect/emergencygroups/divisionviews',
5448
+ 'GET',
5449
+ { },
5450
+ { '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') },
5451
+ { },
5452
+ { },
5453
+ null,
5454
+ ['PureCloud OAuth'],
5455
+ ['application/json'],
5456
+ ['application/json']
5457
+ );
5458
+ }
5459
+
5460
+ /**
5461
+ * Get a grammar
5462
+ * Returns a specified grammar
5463
+ * @param {String} grammarId grammar ID
5464
+ * @param {Object} opts Optional parameters
5465
+ * @param {Boolean} opts.includeFileUrls Include grammar language file URLs
5466
+ * getArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5467
+ */
5468
+ getArchitectGrammar(grammarId, opts) {
5469
+ opts = opts || {};
5470
+
5471
+ // verify the required parameter 'grammarId' is set
5472
+ if (grammarId === undefined || grammarId === null) {
5473
+ throw 'Missing the required parameter "grammarId" when calling getArchitectGrammar';
5474
+ }
5475
+
5476
+ return this.apiClient.callApi(
5477
+ '/api/v2/architect/grammars/{grammarId}',
5478
+ 'GET',
5479
+ { 'grammarId': grammarId },
5480
+ { 'includeFileUrls': opts['includeFileUrls'] },
5481
+ { },
5482
+ { },
5483
+ null,
5484
+ ['PureCloud OAuth'],
5485
+ ['application/json'],
5486
+ ['application/json']
5487
+ );
5488
+ }
5489
+
5490
+ /**
5491
+ * Get a grammar language.
5492
+ *
5493
+ * @param {String} grammarId Grammar ID
5494
+ * @param {String} languageCode Language
5495
+ * getArchitectGrammarLanguage is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5496
+ */
5497
+ getArchitectGrammarLanguage(grammarId, languageCode) {
5498
+ // verify the required parameter 'grammarId' is set
5499
+ if (grammarId === undefined || grammarId === null) {
5500
+ throw 'Missing the required parameter "grammarId" when calling getArchitectGrammarLanguage';
5501
+ }
5502
+ // verify the required parameter 'languageCode' is set
5503
+ if (languageCode === undefined || languageCode === null) {
5504
+ throw 'Missing the required parameter "languageCode" when calling getArchitectGrammarLanguage';
5505
+ }
5506
+
5507
+ return this.apiClient.callApi(
5508
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}',
5509
+ 'GET',
5510
+ { 'grammarId': grammarId,'languageCode': languageCode },
5511
+ { },
5512
+ { },
5513
+ { },
5514
+ null,
5515
+ ['PureCloud OAuth'],
5516
+ ['application/json'],
5517
+ ['application/json']
5518
+ );
5519
+ }
5520
+
5521
+ /**
5522
+ * Get a pageable list of grammars, filtered by query parameters
5523
+ * Multiple IDs can be specified, in which case all matching grammars will be returned, and no other parameters will be evaluated.
5524
+ * @param {Object} opts Optional parameters
5525
+ * @param {Number} opts.pageNumber Page number (default to 1)
5526
+ * @param {Number} opts.pageSize Page size (default to 25)
5527
+ * @param {Object} opts.sortBy Sort by (default to id)
5528
+ * @param {Object} opts.sortOrder Sort order (default to asc)
5529
+ * @param {Array.<String>} opts.id ID
5530
+ * @param {String} opts.name Name
5531
+ * @param {String} opts.description Description
5532
+ * @param {String} opts.nameOrDescription Name or description
5533
+ * @param {Boolean} opts.includeFileUrls Include grammar language file URLs
5534
+ * getArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
5535
+ */
5536
+ getArchitectGrammars(opts) {
5537
+ opts = opts || {};
5538
+
5539
+
5540
+ return this.apiClient.callApi(
5541
+ '/api/v2/architect/grammars',
5542
+ 'GET',
5543
+ { },
5544
+ { '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'] },
5545
+ { },
5546
+ { },
5547
+ null,
5548
+ ['PureCloud OAuth'],
5549
+ ['application/json'],
5550
+ ['application/json']
5551
+ );
5552
+ }
5553
+
5310
5554
  /**
5311
5555
  * Get an IVR config.
5312
5556
  *
@@ -5362,6 +5606,36 @@ class ArchitectApi {
5362
5606
  );
5363
5607
  }
5364
5608
 
5609
+ /**
5610
+ * Get a pageable list of basic ivr configuration information objects filterable by query parameters.
5611
+ *
5612
+ * @param {Object} opts Optional parameters
5613
+ * @param {Number} opts.pageNumber Page number (default to 1)
5614
+ * @param {Number} opts.pageSize Page size (default to 25)
5615
+ * @param {String} opts.sortBy Sort by (default to name)
5616
+ * @param {String} opts.sortOrder Sort order (default to ASC)
5617
+ * @param {Array.<String>} opts.id ID of the IVR to filter by.
5618
+ * @param {String} opts.name Name of the IVR to filter by.
5619
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
5620
+ */
5621
+ getArchitectIvrsDivisionviews(opts) {
5622
+ opts = opts || {};
5623
+
5624
+
5625
+ return this.apiClient.callApi(
5626
+ '/api/v2/architect/ivrs/divisionviews',
5627
+ 'GET',
5628
+ { },
5629
+ { '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') },
5630
+ { },
5631
+ { },
5632
+ null,
5633
+ ['PureCloud OAuth'],
5634
+ ['application/json'],
5635
+ ['application/json']
5636
+ );
5637
+ }
5638
+
5365
5639
  /**
5366
5640
  * Get specified user prompt
5367
5641
  *
@@ -5595,6 +5869,36 @@ class ArchitectApi {
5595
5869
  );
5596
5870
  }
5597
5871
 
5872
+ /**
5873
+ * Get a pageable list of basic schedule group configuration information objects filterable by query parameters.
5874
+ *
5875
+ * @param {Object} opts Optional parameters
5876
+ * @param {Number} opts.pageNumber Page number (default to 1)
5877
+ * @param {Number} opts.pageSize Page size (default to 25)
5878
+ * @param {String} opts.sortBy Sort by (default to name)
5879
+ * @param {String} opts.sortOrder Sort order (default to ASC)
5880
+ * @param {Array.<String>} opts.id ID of the schedule group to filter by.
5881
+ * @param {String} opts.name Name of the schedule group to filter by.
5882
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
5883
+ */
5884
+ getArchitectSchedulegroupsDivisionviews(opts) {
5885
+ opts = opts || {};
5886
+
5887
+
5888
+ return this.apiClient.callApi(
5889
+ '/api/v2/architect/schedulegroups/divisionviews',
5890
+ 'GET',
5891
+ { },
5892
+ { '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') },
5893
+ { },
5894
+ { },
5895
+ null,
5896
+ ['PureCloud OAuth'],
5897
+ ['application/json'],
5898
+ ['application/json']
5899
+ );
5900
+ }
5901
+
5598
5902
  /**
5599
5903
  * Get a list of schedules.
5600
5904
  *
@@ -5624,6 +5928,36 @@ class ArchitectApi {
5624
5928
  );
5625
5929
  }
5626
5930
 
5931
+ /**
5932
+ * Get a pageable list of basic schedule configuration information objects filterable by query parameters.
5933
+ *
5934
+ * @param {Object} opts Optional parameters
5935
+ * @param {Number} opts.pageNumber Page number (default to 1)
5936
+ * @param {Number} opts.pageSize Page size (default to 25)
5937
+ * @param {String} opts.sortBy Sort by (default to name)
5938
+ * @param {String} opts.sortOrder Sort order (default to ASC)
5939
+ * @param {Array.<String>} opts.id ID of the schedule group to filter by.
5940
+ * @param {String} opts.name Name of the schedule group to filter by.
5941
+ * @param {Array.<String>} opts.divisionId List of divisionIds on which to filter.
5942
+ */
5943
+ getArchitectSchedulesDivisionviews(opts) {
5944
+ opts = opts || {};
5945
+
5946
+
5947
+ return this.apiClient.callApi(
5948
+ '/api/v2/architect/schedules/divisionviews',
5949
+ 'GET',
5950
+ { },
5951
+ { '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') },
5952
+ { },
5953
+ { },
5954
+ null,
5955
+ ['PureCloud OAuth'],
5956
+ ['application/json'],
5957
+ ['application/json']
5958
+ );
5959
+ }
5960
+
5627
5961
  /**
5628
5962
  * Get a system prompt
5629
5963
  *
@@ -6634,6 +6968,36 @@ class ArchitectApi {
6634
6968
  );
6635
6969
  }
6636
6970
 
6971
+ /**
6972
+ * Updates a grammar
6973
+ *
6974
+ * @param {String} grammarId grammar ID
6975
+ * @param {Object} opts Optional parameters
6976
+ * @param {Object} opts.body
6977
+ * patchArchitectGrammar is a preview method and is subject to both breaking and non-breaking changes at any time without notice
6978
+ */
6979
+ patchArchitectGrammar(grammarId, opts) {
6980
+ opts = opts || {};
6981
+
6982
+ // verify the required parameter 'grammarId' is set
6983
+ if (grammarId === undefined || grammarId === null) {
6984
+ throw 'Missing the required parameter "grammarId" when calling patchArchitectGrammar';
6985
+ }
6986
+
6987
+ return this.apiClient.callApi(
6988
+ '/api/v2/architect/grammars/{grammarId}',
6989
+ 'PATCH',
6990
+ { 'grammarId': grammarId },
6991
+ { },
6992
+ { },
6993
+ { },
6994
+ opts['body'],
6995
+ ['PureCloud OAuth'],
6996
+ ['application/json'],
6997
+ ['application/json']
6998
+ );
6999
+ }
7000
+
6637
7001
  /**
6638
7002
  * Rebuild Dependency Tracking data for an organization
6639
7003
  * Asynchronous. Notification topic: v2.architect.dependencytracking.build
@@ -6679,6 +7043,135 @@ class ArchitectApi {
6679
7043
  );
6680
7044
  }
6681
7045
 
7046
+ /**
7047
+ * Creates a presigned URL for uploading a grammar DTMF mode file
7048
+ *
7049
+ * @param {String} grammarId Grammar ID
7050
+ * @param {String} languageCode Language
7051
+ * @param {Object} body query
7052
+ * postArchitectGrammarLanguageFilesDtmf is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7053
+ */
7054
+ postArchitectGrammarLanguageFilesDtmf(grammarId, languageCode, body) {
7055
+ // verify the required parameter 'grammarId' is set
7056
+ if (grammarId === undefined || grammarId === null) {
7057
+ throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesDtmf';
7058
+ }
7059
+ // verify the required parameter 'languageCode' is set
7060
+ if (languageCode === undefined || languageCode === null) {
7061
+ throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesDtmf';
7062
+ }
7063
+ // verify the required parameter 'body' is set
7064
+ if (body === undefined || body === null) {
7065
+ throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesDtmf';
7066
+ }
7067
+
7068
+ return this.apiClient.callApi(
7069
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/dtmf',
7070
+ 'POST',
7071
+ { 'grammarId': grammarId,'languageCode': languageCode },
7072
+ { },
7073
+ { },
7074
+ { },
7075
+ body,
7076
+ ['PureCloud OAuth'],
7077
+ ['application/json'],
7078
+ ['application/json']
7079
+ );
7080
+ }
7081
+
7082
+ /**
7083
+ * Creates a presigned URL for uploading a grammar voice mode file
7084
+ *
7085
+ * @param {String} grammarId Grammar ID
7086
+ * @param {String} languageCode Language
7087
+ * @param {Object} body query
7088
+ * postArchitectGrammarLanguageFilesVoice is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7089
+ */
7090
+ postArchitectGrammarLanguageFilesVoice(grammarId, languageCode, body) {
7091
+ // verify the required parameter 'grammarId' is set
7092
+ if (grammarId === undefined || grammarId === null) {
7093
+ throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguageFilesVoice';
7094
+ }
7095
+ // verify the required parameter 'languageCode' is set
7096
+ if (languageCode === undefined || languageCode === null) {
7097
+ throw 'Missing the required parameter "languageCode" when calling postArchitectGrammarLanguageFilesVoice';
7098
+ }
7099
+ // verify the required parameter 'body' is set
7100
+ if (body === undefined || body === null) {
7101
+ throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguageFilesVoice';
7102
+ }
7103
+
7104
+ return this.apiClient.callApi(
7105
+ '/api/v2/architect/grammars/{grammarId}/languages/{languageCode}/files/voice',
7106
+ 'POST',
7107
+ { 'grammarId': grammarId,'languageCode': languageCode },
7108
+ { },
7109
+ { },
7110
+ { },
7111
+ body,
7112
+ ['PureCloud OAuth'],
7113
+ ['application/json'],
7114
+ ['application/json']
7115
+ );
7116
+ }
7117
+
7118
+ /**
7119
+ * Create a new language for a given grammar
7120
+ *
7121
+ * @param {String} grammarId Grammar ID
7122
+ * @param {Object} body
7123
+ * postArchitectGrammarLanguages is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7124
+ */
7125
+ postArchitectGrammarLanguages(grammarId, body) {
7126
+ // verify the required parameter 'grammarId' is set
7127
+ if (grammarId === undefined || grammarId === null) {
7128
+ throw 'Missing the required parameter "grammarId" when calling postArchitectGrammarLanguages';
7129
+ }
7130
+ // verify the required parameter 'body' is set
7131
+ if (body === undefined || body === null) {
7132
+ throw 'Missing the required parameter "body" when calling postArchitectGrammarLanguages';
7133
+ }
7134
+
7135
+ return this.apiClient.callApi(
7136
+ '/api/v2/architect/grammars/{grammarId}/languages',
7137
+ 'POST',
7138
+ { 'grammarId': grammarId },
7139
+ { },
7140
+ { },
7141
+ { },
7142
+ body,
7143
+ ['PureCloud OAuth'],
7144
+ ['application/json'],
7145
+ ['application/json']
7146
+ );
7147
+ }
7148
+
7149
+ /**
7150
+ * Create a new grammar
7151
+ *
7152
+ * @param {Object} body
7153
+ * postArchitectGrammars is a preview method and is subject to both breaking and non-breaking changes at any time without notice
7154
+ */
7155
+ postArchitectGrammars(body) {
7156
+ // verify the required parameter 'body' is set
7157
+ if (body === undefined || body === null) {
7158
+ throw 'Missing the required parameter "body" when calling postArchitectGrammars';
7159
+ }
7160
+
7161
+ return this.apiClient.callApi(
7162
+ '/api/v2/architect/grammars',
7163
+ 'POST',
7164
+ { },
7165
+ { },
7166
+ { },
7167
+ { },
7168
+ body,
7169
+ ['PureCloud OAuth'],
7170
+ ['application/json'],
7171
+ ['application/json']
7172
+ );
7173
+ }
7174
+
6682
7175
  /**
6683
7176
  * Create IVR config.
6684
7177
  *
@@ -7772,7 +8265,7 @@ class AuditApi {
7772
8265
  /**
7773
8266
  * Audit service.
7774
8267
  * @module purecloud-platform-client-v2/api/AuditApi
7775
- * @version 173.1.0
8268
+ * @version 174.0.0
7776
8269
  */
7777
8270
 
7778
8271
  /**
@@ -7943,7 +8436,7 @@ class AuthorizationApi {
7943
8436
  /**
7944
8437
  * Authorization service.
7945
8438
  * @module purecloud-platform-client-v2/api/AuthorizationApi
7946
- * @version 173.1.0
8439
+ * @version 174.0.0
7947
8440
  */
7948
8441
 
7949
8442
  /**
@@ -9174,7 +9667,7 @@ class BillingApi {
9174
9667
  /**
9175
9668
  * Billing service.
9176
9669
  * @module purecloud-platform-client-v2/api/BillingApi
9177
- * @version 173.1.0
9670
+ * @version 174.0.0
9178
9671
  */
9179
9672
 
9180
9673
  /**
@@ -9254,7 +9747,7 @@ class CarrierServicesApi {
9254
9747
  /**
9255
9748
  * CarrierServices service.
9256
9749
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
9257
- * @version 173.1.0
9750
+ * @version 174.0.0
9258
9751
  */
9259
9752
 
9260
9753
  /**
@@ -9324,7 +9817,7 @@ class ChatApi {
9324
9817
  /**
9325
9818
  * Chat service.
9326
9819
  * @module purecloud-platform-client-v2/api/ChatApi
9327
- * @version 173.1.0
9820
+ * @version 174.0.0
9328
9821
  */
9329
9822
 
9330
9823
  /**
@@ -9488,7 +9981,7 @@ class CoachingApi {
9488
9981
  /**
9489
9982
  * Coaching service.
9490
9983
  * @module purecloud-platform-client-v2/api/CoachingApi
9491
- * @version 173.1.0
9984
+ * @version 174.0.0
9492
9985
  */
9493
9986
 
9494
9987
  /**
@@ -10065,7 +10558,7 @@ class ContentManagementApi {
10065
10558
  /**
10066
10559
  * ContentManagement service.
10067
10560
  * @module purecloud-platform-client-v2/api/ContentManagementApi
10068
- * @version 173.1.0
10561
+ * @version 174.0.0
10069
10562
  */
10070
10563
 
10071
10564
  /**
@@ -11208,7 +11701,7 @@ class ConversationsApi {
11208
11701
  /**
11209
11702
  * Conversations service.
11210
11703
  * @module purecloud-platform-client-v2/api/ConversationsApi
11211
- * @version 173.1.0
11704
+ * @version 174.0.0
11212
11705
  */
11213
11706
 
11214
11707
  /**
@@ -11373,6 +11866,31 @@ class ConversationsApi {
11373
11866
  );
11374
11867
  }
11375
11868
 
11869
+ /**
11870
+ * Remove a cached media item asychronously
11871
+ *
11872
+ * @param {String} cachedMediaItemId cachedMediaItemId
11873
+ */
11874
+ deleteConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
11875
+ // verify the required parameter 'cachedMediaItemId' is set
11876
+ if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
11877
+ throw 'Missing the required parameter "cachedMediaItemId" when calling deleteConversationsMessagesCachedmediaCachedMediaItemId';
11878
+ }
11879
+
11880
+ return this.apiClient.callApi(
11881
+ '/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
11882
+ 'DELETE',
11883
+ { 'cachedMediaItemId': cachedMediaItemId },
11884
+ { },
11885
+ { },
11886
+ { },
11887
+ null,
11888
+ ['PureCloud OAuth'],
11889
+ ['application/json'],
11890
+ ['application/json']
11891
+ );
11892
+ }
11893
+
11376
11894
  /**
11377
11895
  * Delete a Facebook messaging integration
11378
11896
  *
@@ -13174,7 +13692,7 @@ class ConversationsApi {
13174
13692
  /**
13175
13693
  * Get list of wrapup codes for this conversation participant
13176
13694
  *
13177
- * @param {String} conversationId conversationId
13695
+ * @param {String} conversationId conversationId
13178
13696
  * @param {String} participantId participantId
13179
13697
  */
13180
13698
  getConversationsMessageParticipantWrapupcodes(conversationId, participantId) {
@@ -13221,6 +13739,57 @@ class ConversationsApi {
13221
13739
  );
13222
13740
  }
13223
13741
 
13742
+ /**
13743
+ * Get a list of cached media items
13744
+ *
13745
+ * @param {Object} opts Optional parameters
13746
+ * @param {Number} opts.pageSize Page size (default to 25)
13747
+ * @param {Number} opts.pageNumber Page number (default to 1)
13748
+ * @param {String} opts.url URL to search for
13749
+ */
13750
+ getConversationsMessagesCachedmedia(opts) {
13751
+ opts = opts || {};
13752
+
13753
+
13754
+ return this.apiClient.callApi(
13755
+ '/api/v2/conversations/messages/cachedmedia',
13756
+ 'GET',
13757
+ { },
13758
+ { 'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'],'url': opts['url'] },
13759
+ { },
13760
+ { },
13761
+ null,
13762
+ ['PureCloud OAuth'],
13763
+ ['application/json'],
13764
+ ['application/json']
13765
+ );
13766
+ }
13767
+
13768
+ /**
13769
+ * Get a cached media item
13770
+ *
13771
+ * @param {String} cachedMediaItemId cachedMediaItemId
13772
+ */
13773
+ getConversationsMessagesCachedmediaCachedMediaItemId(cachedMediaItemId) {
13774
+ // verify the required parameter 'cachedMediaItemId' is set
13775
+ if (cachedMediaItemId === undefined || cachedMediaItemId === null) {
13776
+ throw 'Missing the required parameter "cachedMediaItemId" when calling getConversationsMessagesCachedmediaCachedMediaItemId';
13777
+ }
13778
+
13779
+ return this.apiClient.callApi(
13780
+ '/api/v2/conversations/messages/cachedmedia/{cachedMediaItemId}',
13781
+ 'GET',
13782
+ { 'cachedMediaItemId': cachedMediaItemId },
13783
+ { },
13784
+ { },
13785
+ { },
13786
+ null,
13787
+ ['PureCloud OAuth'],
13788
+ ['application/json'],
13789
+ ['application/json']
13790
+ );
13791
+ }
13792
+
13224
13793
  /**
13225
13794
  * Get Genesys Facebook App Id
13226
13795
  *
@@ -13964,6 +14533,32 @@ class ConversationsApi {
13964
14533
  );
13965
14534
  }
13966
14535
 
14536
+ /**
14537
+ * Gets a record for a given meetingId
14538
+ *
14539
+ * @param {String} meetingId meetingId
14540
+ * getConversationsVideosMeeting is a preview method and is subject to both breaking and non-breaking changes at any time without notice
14541
+ */
14542
+ getConversationsVideosMeeting(meetingId) {
14543
+ // verify the required parameter 'meetingId' is set
14544
+ if (meetingId === undefined || meetingId === null) {
14545
+ throw 'Missing the required parameter "meetingId" when calling getConversationsVideosMeeting';
14546
+ }
14547
+
14548
+ return this.apiClient.callApi(
14549
+ '/api/v2/conversations/videos/meetings/{meetingId}',
14550
+ 'GET',
14551
+ { 'meetingId': meetingId },
14552
+ { },
14553
+ { },
14554
+ { },
14555
+ null,
14556
+ ['PureCloud OAuth'],
14557
+ ['application/json'],
14558
+ ['application/json']
14559
+ );
14560
+ }
14561
+
13967
14562
  /**
13968
14563
  * Update a participant.
13969
14564
  * Update conversation participant.
@@ -14926,7 +15521,7 @@ class ConversationsApi {
14926
15521
  /**
14927
15522
  * Update conversation participant
14928
15523
  *
14929
- * @param {String} conversationId conversationId
15524
+ * @param {String} conversationId conversationId
14930
15525
  * @param {String} participantId participantId
14931
15526
  * @param {Object} opts Optional parameters
14932
15527
  * @param {Object} opts.body
@@ -14960,7 +15555,7 @@ class ConversationsApi {
14960
15555
  /**
14961
15556
  * Update the attributes on a conversation participant.
14962
15557
  *
14963
- * @param {String} conversationId conversationId
15558
+ * @param {String} conversationId conversationId
14964
15559
  * @param {String} participantId participantId
14965
15560
  * @param {Object} opts Optional parameters
14966
15561
  * @param {Object} opts.body
@@ -14994,7 +15589,7 @@ class ConversationsApi {
14994
15589
  /**
14995
15590
  * Update conversation participant's communication by disconnecting it.
14996
15591
  *
14997
- * @param {String} conversationId conversationId
15592
+ * @param {String} conversationId conversationId
14998
15593
  * @param {String} participantId participantId
14999
15594
  * @param {String} communicationId communicationId
15000
15595
  * @param {Object} body Participant
@@ -16951,6 +17546,96 @@ class ConversationsApi {
16951
17546
  );
16952
17547
  }
16953
17548
 
17549
+ /**
17550
+ * Send an inbound Open Event Message
17551
+ * 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.
17552
+ * @param {String} integrationId integrationId
17553
+ * @param {Object} body NormalizedMessage
17554
+ */
17555
+ postConversationsMessageInboundOpenEvent(integrationId, body) {
17556
+ // verify the required parameter 'integrationId' is set
17557
+ if (integrationId === undefined || integrationId === null) {
17558
+ throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenEvent';
17559
+ }
17560
+ // verify the required parameter 'body' is set
17561
+ if (body === undefined || body === null) {
17562
+ throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenEvent';
17563
+ }
17564
+
17565
+ return this.apiClient.callApi(
17566
+ '/api/v2/conversations/messages/{integrationId}/inbound/open/event',
17567
+ 'POST',
17568
+ { 'integrationId': integrationId },
17569
+ { },
17570
+ { },
17571
+ { },
17572
+ body,
17573
+ ['PureCloud OAuth'],
17574
+ ['application/json'],
17575
+ ['application/json']
17576
+ );
17577
+ }
17578
+
17579
+ /**
17580
+ * Send inbound Open Message
17581
+ * 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.
17582
+ * @param {String} integrationId integrationId
17583
+ * @param {Object} body NormalizedMessage
17584
+ */
17585
+ postConversationsMessageInboundOpenMessage(integrationId, body) {
17586
+ // verify the required parameter 'integrationId' is set
17587
+ if (integrationId === undefined || integrationId === null) {
17588
+ throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenMessage';
17589
+ }
17590
+ // verify the required parameter 'body' is set
17591
+ if (body === undefined || body === null) {
17592
+ throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenMessage';
17593
+ }
17594
+
17595
+ return this.apiClient.callApi(
17596
+ '/api/v2/conversations/messages/{integrationId}/inbound/open/message',
17597
+ 'POST',
17598
+ { 'integrationId': integrationId },
17599
+ { },
17600
+ { },
17601
+ { },
17602
+ body,
17603
+ ['PureCloud OAuth'],
17604
+ ['application/json'],
17605
+ ['application/json']
17606
+ );
17607
+ }
17608
+
17609
+ /**
17610
+ * Send an inbound Open Receipt Message
17611
+ * 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.
17612
+ * @param {String} integrationId integrationId
17613
+ * @param {Object} body NormalizedMessage
17614
+ */
17615
+ postConversationsMessageInboundOpenReceipt(integrationId, body) {
17616
+ // verify the required parameter 'integrationId' is set
17617
+ if (integrationId === undefined || integrationId === null) {
17618
+ throw 'Missing the required parameter "integrationId" when calling postConversationsMessageInboundOpenReceipt';
17619
+ }
17620
+ // verify the required parameter 'body' is set
17621
+ if (body === undefined || body === null) {
17622
+ throw 'Missing the required parameter "body" when calling postConversationsMessageInboundOpenReceipt';
17623
+ }
17624
+
17625
+ return this.apiClient.callApi(
17626
+ '/api/v2/conversations/messages/{integrationId}/inbound/open/receipt',
17627
+ 'POST',
17628
+ { 'integrationId': integrationId },
17629
+ { },
17630
+ { },
17631
+ { },
17632
+ body,
17633
+ ['PureCloud OAuth'],
17634
+ ['application/json'],
17635
+ ['application/json']
17636
+ );
17637
+ }
17638
+
16954
17639
  /**
16955
17640
  * Get messages in batch
16956
17641
  * 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"]
@@ -17503,6 +18188,32 @@ class ConversationsApi {
17503
18188
  );
17504
18189
  }
17505
18190
 
18191
+ /**
18192
+ * Generate a meetingId for a given conferenceId
18193
+ *
18194
+ * @param {Object} body MeetingIdRequest
18195
+ * postConversationsVideosMeetings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18196
+ */
18197
+ postConversationsVideosMeetings(body) {
18198
+ // verify the required parameter 'body' is set
18199
+ if (body === undefined || body === null) {
18200
+ throw 'Missing the required parameter "body" when calling postConversationsVideosMeetings';
18201
+ }
18202
+
18203
+ return this.apiClient.callApi(
18204
+ '/api/v2/conversations/videos/meetings',
18205
+ 'POST',
18206
+ { },
18207
+ { },
18208
+ { },
18209
+ { },
18210
+ body,
18211
+ ['PureCloud OAuth'],
18212
+ ['application/json'],
18213
+ ['application/json']
18214
+ );
18215
+ }
18216
+
17506
18217
  /**
17507
18218
  * Set flagged reason on conversation participant to indicate bad conversation quality.
17508
18219
  *
@@ -18074,7 +18785,7 @@ class DataExtensionsApi {
18074
18785
  /**
18075
18786
  * DataExtensions service.
18076
18787
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
18077
- * @version 173.1.0
18788
+ * @version 174.0.0
18078
18789
  */
18079
18790
 
18080
18791
  /**
@@ -18160,7 +18871,7 @@ class DownloadsApi {
18160
18871
  /**
18161
18872
  * Downloads service.
18162
18873
  * @module purecloud-platform-client-v2/api/DownloadsApi
18163
- * @version 173.1.0
18874
+ * @version 174.0.0
18164
18875
  */
18165
18876
 
18166
18877
  /**
@@ -18212,7 +18923,7 @@ class EmailsApi {
18212
18923
  /**
18213
18924
  * Emails service.
18214
18925
  * @module purecloud-platform-client-v2/api/EmailsApi
18215
- * @version 173.1.0
18926
+ * @version 174.0.0
18216
18927
  */
18217
18928
 
18218
18929
  /**
@@ -18277,7 +18988,7 @@ class EventsApi {
18277
18988
  /**
18278
18989
  * Events service.
18279
18990
  * @module purecloud-platform-client-v2/api/EventsApi
18280
- * @version 173.1.0
18991
+ * @version 174.0.0
18281
18992
  */
18282
18993
 
18283
18994
  /**
@@ -18373,7 +19084,7 @@ class ExternalContactsApi {
18373
19084
  /**
18374
19085
  * ExternalContacts service.
18375
19086
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
18376
- * @version 173.1.0
19087
+ * @version 174.0.0
18377
19088
  */
18378
19089
 
18379
19090
  /**
@@ -20331,7 +21042,7 @@ class FaxApi {
20331
21042
  /**
20332
21043
  * Fax service.
20333
21044
  * @module purecloud-platform-client-v2/api/FaxApi
20334
- * @version 173.1.0
21045
+ * @version 174.0.0
20335
21046
  */
20336
21047
 
20337
21048
  /**
@@ -20502,7 +21213,7 @@ class FlowsApi {
20502
21213
  /**
20503
21214
  * Flows service.
20504
21215
  * @module purecloud-platform-client-v2/api/FlowsApi
20505
- * @version 173.1.0
21216
+ * @version 174.0.0
20506
21217
  */
20507
21218
 
20508
21219
  /**
@@ -20686,7 +21397,7 @@ class GamificationApi {
20686
21397
  /**
20687
21398
  * Gamification service.
20688
21399
  * @module purecloud-platform-client-v2/api/GamificationApi
20689
- * @version 173.1.0
21400
+ * @version 174.0.0
20690
21401
  */
20691
21402
 
20692
21403
  /**
@@ -22772,7 +23483,7 @@ class GeneralDataProtectionRegulationApi {
22772
23483
  /**
22773
23484
  * GeneralDataProtectionRegulation service.
22774
23485
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
22775
- * @version 173.1.0
23486
+ * @version 174.0.0
22776
23487
  */
22777
23488
 
22778
23489
  /**
@@ -22902,7 +23613,7 @@ class GeolocationApi {
22902
23613
  /**
22903
23614
  * Geolocation service.
22904
23615
  * @module purecloud-platform-client-v2/api/GeolocationApi
22905
- * @version 173.1.0
23616
+ * @version 174.0.0
22906
23617
  */
22907
23618
 
22908
23619
  /**
@@ -23033,7 +23744,7 @@ class GreetingsApi {
23033
23744
  /**
23034
23745
  * Greetings service.
23035
23746
  * @module purecloud-platform-client-v2/api/GreetingsApi
23036
- * @version 173.1.0
23747
+ * @version 174.0.0
23037
23748
  */
23038
23749
 
23039
23750
  /**
@@ -23488,7 +24199,7 @@ class GroupsApi {
23488
24199
  /**
23489
24200
  * Groups service.
23490
24201
  * @module purecloud-platform-client-v2/api/GroupsApi
23491
- * @version 173.1.0
24202
+ * @version 174.0.0
23492
24203
  */
23493
24204
 
23494
24205
  /**
@@ -24007,7 +24718,7 @@ class IdentityProviderApi {
24007
24718
  /**
24008
24719
  * IdentityProvider service.
24009
24720
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
24010
- * @version 173.1.0
24721
+ * @version 174.0.0
24011
24722
  */
24012
24723
 
24013
24724
  /**
@@ -24763,7 +25474,7 @@ class InfrastructureAsCodeApi {
24763
25474
  /**
24764
25475
  * InfrastructureAsCode service.
24765
25476
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
24766
- * @version 173.1.0
25477
+ * @version 174.0.0
24767
25478
  */
24768
25479
 
24769
25480
  /**
@@ -24930,7 +25641,7 @@ class IntegrationsApi {
24930
25641
  /**
24931
25642
  * Integrations service.
24932
25643
  * @module purecloud-platform-client-v2/api/IntegrationsApi
24933
- * @version 173.1.0
25644
+ * @version 174.0.0
24934
25645
  */
24935
25646
 
24936
25647
  /**
@@ -26892,7 +27603,7 @@ class JourneyApi {
26892
27603
  /**
26893
27604
  * Journey service.
26894
27605
  * @module purecloud-platform-client-v2/api/JourneyApi
26895
- * @version 173.1.0
27606
+ * @version 174.0.0
26896
27607
  */
26897
27608
 
26898
27609
  /**
@@ -27092,6 +27803,37 @@ class JourneyApi {
27092
27803
  );
27093
27804
  }
27094
27805
 
27806
+ /**
27807
+ * Retrieve all sessions for a given external contact.
27808
+ *
27809
+ * @param {String} contactId ExternalContact ID
27810
+ * @param {Object} opts Optional parameters
27811
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
27812
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
27813
+ * @param {Boolean} opts.includeMerged Indicates whether to return sessions from all external contacts in the merge-set of the given one.
27814
+ */
27815
+ getExternalcontactsContactJourneySessions(contactId, opts) {
27816
+ opts = opts || {};
27817
+
27818
+ // verify the required parameter 'contactId' is set
27819
+ if (contactId === undefined || contactId === null) {
27820
+ throw 'Missing the required parameter "contactId" when calling getExternalcontactsContactJourneySessions';
27821
+ }
27822
+
27823
+ return this.apiClient.callApi(
27824
+ '/api/v2/externalcontacts/contacts/{contactId}/journey/sessions',
27825
+ 'GET',
27826
+ { 'contactId': contactId },
27827
+ { 'pageSize': opts['pageSize'],'after': opts['after'],'includeMerged': opts['includeMerged'] },
27828
+ { },
27829
+ { },
27830
+ null,
27831
+ ['PureCloud OAuth'],
27832
+ ['application/json'],
27833
+ ['application/json']
27834
+ );
27835
+ }
27836
+
27095
27837
  /**
27096
27838
  * Retrieve a single action map.
27097
27839
  *
@@ -27892,6 +28634,36 @@ class JourneyApi {
27892
28634
  );
27893
28635
  }
27894
28636
 
28637
+ /**
28638
+ * Send a journey app event, used for tracking customer activity on an application.
28639
+ *
28640
+ * @param {String} deploymentId The ID of the deployment sending the app event.
28641
+ * @param {Object} opts Optional parameters
28642
+ * @param {Object} opts.body
28643
+ * postJourneyDeploymentAppevents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
28644
+ */
28645
+ postJourneyDeploymentAppevents(deploymentId, opts) {
28646
+ opts = opts || {};
28647
+
28648
+ // verify the required parameter 'deploymentId' is set
28649
+ if (deploymentId === undefined || deploymentId === null) {
28650
+ throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentAppevents';
28651
+ }
28652
+
28653
+ return this.apiClient.callApi(
28654
+ '/api/v2/journey/deployments/{deploymentId}/appevents',
28655
+ 'POST',
28656
+ { 'deploymentId': deploymentId },
28657
+ { },
28658
+ { },
28659
+ { },
28660
+ opts['body'],
28661
+ ['PureCloud OAuth'],
28662
+ ['application/json'],
28663
+ ['application/json']
28664
+ );
28665
+ }
28666
+
27895
28667
  /**
27896
28668
  * Create an outcome.
27897
28669
  *
@@ -27995,7 +28767,7 @@ class KnowledgeApi {
27995
28767
  /**
27996
28768
  * Knowledge service.
27997
28769
  * @module purecloud-platform-client-v2/api/KnowledgeApi
27998
- * @version 173.1.0
28770
+ * @version 174.0.0
27999
28771
  */
28000
28772
 
28001
28773
  /**
@@ -28552,6 +29324,85 @@ class KnowledgeApi {
28552
29324
  );
28553
29325
  }
28554
29326
 
29327
+ /**
29328
+ * Get a list of feedback records given on a document
29329
+ *
29330
+ * @param {String} knowledgeBaseId Knowledge base ID.
29331
+ * @param {String} documentId Document ID.
29332
+ * @param {Object} opts Optional parameters
29333
+ * @param {String} opts.before The cursor that points to the start of the set of entities that has been returned.
29334
+ * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
29335
+ * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
29336
+ * @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.
29337
+ * @param {String} opts.documentVersionId Document version ID to filter by. Supported only if onlyCommented=true is set.
29338
+ * @param {String} opts.documentVariationId Document variation ID to filter by. Supported only if onlyCommented=true is set.
29339
+ * @param {Object} opts.appType Application type to filter by. Supported only if onlyCommented=true is set.
29340
+ * @param {Object} opts.queryType Query type to filter by. Supported only if onlyCommented=true is set.
29341
+ * @param {String} opts.userId The ID of the user, who created the feedback, to filter by. Supported only if onlyCommented=true is set.
29342
+ * @param {String} opts.queueId Queue ID to filter by. Supported only if onlyCommented=true is set.
29343
+ * @param {Object} opts.state State to filter by. Supported only if onlyCommented=true is set. Default: Final
29344
+ */
29345
+ getKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
29346
+ opts = opts || {};
29347
+
29348
+ // verify the required parameter 'knowledgeBaseId' is set
29349
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
29350
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
29351
+ }
29352
+ // verify the required parameter 'documentId' is set
29353
+ if (documentId === undefined || documentId === null) {
29354
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedback';
29355
+ }
29356
+
29357
+ return this.apiClient.callApi(
29358
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
29359
+ 'GET',
29360
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
29361
+ { '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'] },
29362
+ { },
29363
+ { },
29364
+ null,
29365
+ ['PureCloud OAuth'],
29366
+ ['application/json'],
29367
+ ['application/json']
29368
+ );
29369
+ }
29370
+
29371
+ /**
29372
+ * Get a single feedback record given on a document
29373
+ *
29374
+ * @param {String} knowledgeBaseId Knowledge base ID.
29375
+ * @param {String} documentId Document ID.
29376
+ * @param {String} feedbackId Feedback ID.
29377
+ */
29378
+ getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId(knowledgeBaseId, documentId, feedbackId) {
29379
+ // verify the required parameter 'knowledgeBaseId' is set
29380
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
29381
+ throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
29382
+ }
29383
+ // verify the required parameter 'documentId' is set
29384
+ if (documentId === undefined || documentId === null) {
29385
+ throw 'Missing the required parameter "documentId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
29386
+ }
29387
+ // verify the required parameter 'feedbackId' is set
29388
+ if (feedbackId === undefined || feedbackId === null) {
29389
+ throw 'Missing the required parameter "feedbackId" when calling getKnowledgeKnowledgebaseDocumentFeedbackFeedbackId';
29390
+ }
29391
+
29392
+ return this.apiClient.callApi(
29393
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback/{feedbackId}',
29394
+ 'GET',
29395
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId,'feedbackId': feedbackId },
29396
+ { },
29397
+ { },
29398
+ { },
29399
+ null,
29400
+ ['PureCloud OAuth'],
29401
+ ['application/json'],
29402
+ ['application/json']
29403
+ );
29404
+ }
29405
+
28555
29406
  /**
28556
29407
  * Get a variation for a document.
28557
29408
  *
@@ -28859,8 +29710,12 @@ class KnowledgeApi {
28859
29710
  *
28860
29711
  * @param {String} knowledgeBaseId Knowledge base ID
28861
29712
  * @param {String} importJobId Import job ID
29713
+ * @param {Object} opts Optional parameters
29714
+ * @param {Array.<String>} opts.expand If expand contains 'urls' downloadURL and failedEntitiesURL will be filled.
28862
29715
  */
28863
- getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId) {
29716
+ getKnowledgeKnowledgebaseImportJob(knowledgeBaseId, importJobId, opts) {
29717
+ opts = opts || {};
29718
+
28864
29719
  // verify the required parameter 'knowledgeBaseId' is set
28865
29720
  if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
28866
29721
  throw 'Missing the required parameter "knowledgeBaseId" when calling getKnowledgeKnowledgebaseImportJob';
@@ -28874,7 +29729,7 @@ class KnowledgeApi {
28874
29729
  '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/import/jobs/{importJobId}',
28875
29730
  'GET',
28876
29731
  { 'knowledgeBaseId': knowledgeBaseId,'importJobId': importJobId },
28877
- { },
29732
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
28878
29733
  { },
28879
29734
  { },
28880
29735
  null,
@@ -29897,6 +30752,40 @@ class KnowledgeApi {
29897
30752
  );
29898
30753
  }
29899
30754
 
30755
+ /**
30756
+ * Give feedback on a document
30757
+ *
30758
+ * @param {String} sessionId Knowledge guest session ID.
30759
+ * @param {String} documentId Document ID.
30760
+ * @param {Object} opts Optional parameters
30761
+ * @param {Object} opts.body
30762
+ */
30763
+ postKnowledgeGuestSessionDocumentFeedback(sessionId, documentId, opts) {
30764
+ opts = opts || {};
30765
+
30766
+ // verify the required parameter 'sessionId' is set
30767
+ if (sessionId === undefined || sessionId === null) {
30768
+ throw 'Missing the required parameter "sessionId" when calling postKnowledgeGuestSessionDocumentFeedback';
30769
+ }
30770
+ // verify the required parameter 'documentId' is set
30771
+ if (documentId === undefined || documentId === null) {
30772
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeGuestSessionDocumentFeedback';
30773
+ }
30774
+
30775
+ return this.apiClient.callApi(
30776
+ '/api/v2/knowledge/guest/sessions/{sessionId}/documents/{documentId}/feedback',
30777
+ 'POST',
30778
+ { 'sessionId': sessionId,'documentId': documentId },
30779
+ { },
30780
+ { },
30781
+ { },
30782
+ opts['body'],
30783
+ ['PureCloud OAuth'],
30784
+ ['application/json'],
30785
+ ['application/json']
30786
+ );
30787
+ }
30788
+
29900
30789
  /**
29901
30790
  * Search the documents in a guest session.
29902
30791
  *
@@ -30011,6 +30900,40 @@ class KnowledgeApi {
30011
30900
  );
30012
30901
  }
30013
30902
 
30903
+ /**
30904
+ * Give feedback on a document
30905
+ *
30906
+ * @param {String} knowledgeBaseId Knowledge base ID.
30907
+ * @param {String} documentId Document ID.
30908
+ * @param {Object} opts Optional parameters
30909
+ * @param {Object} opts.body
30910
+ */
30911
+ postKnowledgeKnowledgebaseDocumentFeedback(knowledgeBaseId, documentId, opts) {
30912
+ opts = opts || {};
30913
+
30914
+ // verify the required parameter 'knowledgeBaseId' is set
30915
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
30916
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
30917
+ }
30918
+ // verify the required parameter 'documentId' is set
30919
+ if (documentId === undefined || documentId === null) {
30920
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentFeedback';
30921
+ }
30922
+
30923
+ return this.apiClient.callApi(
30924
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/feedback',
30925
+ 'POST',
30926
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
30927
+ { },
30928
+ { },
30929
+ { },
30930
+ opts['body'],
30931
+ ['PureCloud OAuth'],
30932
+ ['application/json'],
30933
+ ['application/json']
30934
+ );
30935
+ }
30936
+
30014
30937
  /**
30015
30938
  * Create a variation for a document.
30016
30939
  *
@@ -30081,6 +31004,40 @@ class KnowledgeApi {
30081
31004
  );
30082
31005
  }
30083
31006
 
31007
+ /**
31008
+ * Create view for a document.
31009
+ *
31010
+ * @param {String} knowledgeBaseId Knowledge base ID.
31011
+ * @param {String} documentId Document ID.
31012
+ * @param {Object} opts Optional parameters
31013
+ * @param {Object} opts.body
31014
+ */
31015
+ postKnowledgeKnowledgebaseDocumentViews(knowledgeBaseId, documentId, opts) {
31016
+ opts = opts || {};
31017
+
31018
+ // verify the required parameter 'knowledgeBaseId' is set
31019
+ if (knowledgeBaseId === undefined || knowledgeBaseId === null) {
31020
+ throw 'Missing the required parameter "knowledgeBaseId" when calling postKnowledgeKnowledgebaseDocumentViews';
31021
+ }
31022
+ // verify the required parameter 'documentId' is set
31023
+ if (documentId === undefined || documentId === null) {
31024
+ throw 'Missing the required parameter "documentId" when calling postKnowledgeKnowledgebaseDocumentViews';
31025
+ }
31026
+
31027
+ return this.apiClient.callApi(
31028
+ '/api/v2/knowledge/knowledgebases/{knowledgeBaseId}/documents/{documentId}/views',
31029
+ 'POST',
31030
+ { 'knowledgeBaseId': knowledgeBaseId,'documentId': documentId },
31031
+ { },
31032
+ { },
31033
+ { },
31034
+ opts['body'],
31035
+ ['PureCloud OAuth'],
31036
+ ['application/json'],
31037
+ ['application/json']
31038
+ );
31039
+ }
31040
+
30084
31041
  /**
30085
31042
  * Create document.
30086
31043
  *
@@ -30631,7 +31588,7 @@ class LanguageUnderstandingApi {
30631
31588
  /**
30632
31589
  * LanguageUnderstanding service.
30633
31590
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
30634
- * @version 173.1.0
31591
+ * @version 174.0.0
30635
31592
  */
30636
31593
 
30637
31594
  /**
@@ -31644,7 +32601,7 @@ class LanguagesApi {
31644
32601
  /**
31645
32602
  * Languages service.
31646
32603
  * @module purecloud-platform-client-v2/api/LanguagesApi
31647
- * @version 173.1.0
32604
+ * @version 174.0.0
31648
32605
  */
31649
32606
 
31650
32607
  /**
@@ -31866,7 +32823,7 @@ class LearningApi {
31866
32823
  /**
31867
32824
  * Learning service.
31868
32825
  * @module purecloud-platform-client-v2/api/LearningApi
31869
- * @version 173.1.0
32826
+ * @version 174.0.0
31870
32827
  */
31871
32828
 
31872
32829
  /**
@@ -32681,7 +33638,7 @@ class LicenseApi {
32681
33638
  /**
32682
33639
  * License service.
32683
33640
  * @module purecloud-platform-client-v2/api/LicenseApi
32684
- * @version 173.1.0
33641
+ * @version 174.0.0
32685
33642
  */
32686
33643
 
32687
33644
  /**
@@ -32919,7 +33876,7 @@ class LocationsApi {
32919
33876
  /**
32920
33877
  * Locations service.
32921
33878
  * @module purecloud-platform-client-v2/api/LocationsApi
32922
- * @version 173.1.0
33879
+ * @version 174.0.0
32923
33880
  */
32924
33881
 
32925
33882
  /**
@@ -33155,7 +34112,7 @@ class MessagingApi {
33155
34112
  /**
33156
34113
  * Messaging service.
33157
34114
  * @module purecloud-platform-client-v2/api/MessagingApi
33158
- * @version 173.1.0
34115
+ * @version 174.0.0
33159
34116
  */
33160
34117
 
33161
34118
  /**
@@ -33514,7 +34471,7 @@ class MobileDevicesApi {
33514
34471
  /**
33515
34472
  * MobileDevices service.
33516
34473
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
33517
- * @version 173.1.0
34474
+ * @version 174.0.0
33518
34475
  */
33519
34476
 
33520
34477
  /**
@@ -33665,7 +34622,7 @@ class NotificationsApi {
33665
34622
  /**
33666
34623
  * Notifications service.
33667
34624
  * @module purecloud-platform-client-v2/api/NotificationsApi
33668
- * @version 173.1.0
34625
+ * @version 174.0.0
33669
34626
  */
33670
34627
 
33671
34628
  /**
@@ -33898,7 +34855,7 @@ class OAuthApi {
33898
34855
  /**
33899
34856
  * OAuth service.
33900
34857
  * @module purecloud-platform-client-v2/api/OAuthApi
33901
- * @version 173.1.0
34858
+ * @version 174.0.0
33902
34859
  */
33903
34860
 
33904
34861
  /**
@@ -34264,7 +35221,7 @@ class ObjectsApi {
34264
35221
  /**
34265
35222
  * Objects service.
34266
35223
  * @module purecloud-platform-client-v2/api/ObjectsApi
34267
- * @version 173.1.0
35224
+ * @version 174.0.0
34268
35225
  */
34269
35226
 
34270
35227
  /**
@@ -34535,7 +35492,7 @@ class OrganizationApi {
34535
35492
  /**
34536
35493
  * Organization service.
34537
35494
  * @module purecloud-platform-client-v2/api/OrganizationApi
34538
- * @version 173.1.0
35495
+ * @version 174.0.0
34539
35496
  */
34540
35497
 
34541
35498
  /**
@@ -34990,7 +35947,7 @@ class OrganizationAuthorizationApi {
34990
35947
  /**
34991
35948
  * OrganizationAuthorization service.
34992
35949
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
34993
- * @version 173.1.0
35950
+ * @version 174.0.0
34994
35951
  */
34995
35952
 
34996
35953
  /**
@@ -36337,7 +37294,7 @@ class OutboundApi {
36337
37294
  /**
36338
37295
  * Outbound service.
36339
37296
  * @module purecloud-platform-client-v2/api/OutboundApi
36340
- * @version 173.1.0
37297
+ * @version 174.0.0
36341
37298
  */
36342
37299
 
36343
37300
  /**
@@ -39959,7 +40916,7 @@ class PresenceApi {
39959
40916
  /**
39960
40917
  * Presence service.
39961
40918
  * @module purecloud-platform-client-v2/api/PresenceApi
39962
- * @version 173.1.0
40919
+ * @version 174.0.0
39963
40920
  */
39964
40921
 
39965
40922
  /**
@@ -40698,7 +41655,7 @@ class ProcessAutomationApi {
40698
41655
  /**
40699
41656
  * ProcessAutomation service.
40700
41657
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
40701
- * @version 173.1.0
41658
+ * @version 174.0.0
40702
41659
  */
40703
41660
 
40704
41661
  /**
@@ -40937,7 +41894,7 @@ class QualityApi {
40937
41894
  /**
40938
41895
  * Quality service.
40939
41896
  * @module purecloud-platform-client-v2/api/QualityApi
40940
- * @version 173.1.0
41897
+ * @version 174.0.0
40941
41898
  */
40942
41899
 
40943
41900
  /**
@@ -41220,6 +42177,7 @@ class QualityApi {
41220
42177
  * @param {String} opts.evaluatorUserId user id of the evaluator
41221
42178
  * @param {String} opts.name name
41222
42179
  * @param {String} opts.group group id
42180
+ * @param {String} opts.formContextId shared id between form versions
41223
42181
  */
41224
42182
  getQualityAgentsActivity(opts) {
41225
42183
  opts = opts || {};
@@ -41229,7 +42187,7 @@ class QualityApi {
41229
42187
  '/api/v2/quality/agents/activity',
41230
42188
  'GET',
41231
42189
  { },
41232
- { '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'] },
42190
+ { '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'] },
41233
42191
  { },
41234
42192
  { },
41235
42193
  null,
@@ -41427,9 +42385,9 @@ class QualityApi {
41427
42385
  * @param {Object} opts Optional parameters
41428
42386
  * @param {Number} opts.pageSize The total page size requested (default to 25)
41429
42387
  * @param {Number} opts.pageNumber The page number requested (default to 1)
41430
- * @param {String} opts.sortBy variable name requested to sort by
42388
+ * @param {String} opts.sortBy NOTE: Does not work when querying evaluations
41431
42389
  * @param {Array.<String>} opts.expand variable name requested by expand list
41432
- * @param {String} opts.nextPage next page token
42390
+ * @param {String} opts.nextPage NOTE: Does not work when querying evaluations
41433
42391
  * @param {String} opts.previousPage Previous page token
41434
42392
  * @param {String} opts.conversationId conversationId specified
41435
42393
  * @param {String} opts.agentUserId user id of the agent
@@ -41438,12 +42396,13 @@ class QualityApi {
41438
42396
  * @param {String} opts.queueId queue id
41439
42397
  * @param {String} opts.startTime start time of the evaluation query
41440
42398
  * @param {String} opts.endTime end time of the evaluation query
42399
+ * @param {String} opts.formContextId shared id between form versions
41441
42400
  * @param {Array.<String>} opts.evaluationState
41442
42401
  * @param {Boolean} opts.isReleased the evaluation has been released
41443
42402
  * @param {Boolean} opts.agentHasRead agent has the evaluation
41444
42403
  * @param {Boolean} opts.expandAnswerTotalScores get the total scores for evaluations
41445
- * @param {Number} opts.maximum maximum
41446
- * @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
42404
+ * @param {Number} opts.maximum the maximum number of results to return
42405
+ * @param {String} opts.sortOrder NOTE: Does not work when conversationId is supplied.
41447
42406
  */
41448
42407
  getQualityEvaluationsQuery(opts) {
41449
42408
  opts = opts || {};
@@ -41453,7 +42412,7 @@ class QualityApi {
41453
42412
  '/api/v2/quality/evaluations/query',
41454
42413
  'GET',
41455
42414
  { },
41456
- { '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'] },
42415
+ { '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'] },
41457
42416
  { },
41458
42417
  { },
41459
42418
  null,
@@ -42530,7 +43489,7 @@ class QualityApi {
42530
43489
  * @param {String} evaluationId evaluationId
42531
43490
  * @param {Object} body evaluation
42532
43491
  * @param {Object} opts Optional parameters
42533
- * @param {String} opts.expand evaluatorId, evaluationForm, assignee
43492
+ * @param {String} opts.expand evaluatorId, evaluationForm, assignee, evaluator
42534
43493
  */
42535
43494
  putQualityConversationEvaluation(conversationId, evaluationId, body, opts) {
42536
43495
  opts = opts || {};
@@ -42689,7 +43648,7 @@ class RecordingApi {
42689
43648
  /**
42690
43649
  * Recording service.
42691
43650
  * @module purecloud-platform-client-v2/api/RecordingApi
42692
- * @version 173.1.0
43651
+ * @version 174.0.0
42693
43652
  */
42694
43653
 
42695
43654
  /**
@@ -44326,7 +45285,7 @@ class ResponseManagementApi {
44326
45285
  /**
44327
45286
  * ResponseManagement service.
44328
45287
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
44329
- * @version 173.1.0
45288
+ * @version 174.0.0
44330
45289
  */
44331
45290
 
44332
45291
  /**
@@ -44811,7 +45770,7 @@ class RoutingApi {
44811
45770
  /**
44812
45771
  * Routing service.
44813
45772
  * @module purecloud-platform-client-v2/api/RoutingApi
44814
- * @version 173.1.0
45773
+ * @version 174.0.0
44815
45774
  */
44816
45775
 
44817
45776
  /**
@@ -45818,6 +46777,7 @@ class RoutingApi {
45818
46777
  *
45819
46778
  * @param {Object} opts Optional parameters
45820
46779
  * @param {Object} opts.messengerType Messenger Type
46780
+ * @param {String} opts.name Recipient Name
45821
46781
  * @param {Number} opts.pageSize Page size (default to 25)
45822
46782
  * @param {Number} opts.pageNumber Page number (default to 1)
45823
46783
  */
@@ -45829,7 +46789,7 @@ class RoutingApi {
45829
46789
  '/api/v2/routing/message/recipients',
45830
46790
  'GET',
45831
46791
  { },
45832
- { 'messengerType': opts['messengerType'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
46792
+ { 'messengerType': opts['messengerType'],'name': opts['name'],'pageSize': opts['pageSize'],'pageNumber': opts['pageNumber'] },
45833
46793
  { },
45834
46794
  { },
45835
46795
  null,
@@ -48518,7 +49478,7 @@ class SCIMApi {
48518
49478
  /**
48519
49479
  * SCIM service.
48520
49480
  * @module purecloud-platform-client-v2/api/SCIMApi
48521
- * @version 173.1.0
49481
+ * @version 174.0.0
48522
49482
  */
48523
49483
 
48524
49484
  /**
@@ -49395,7 +50355,7 @@ class ScriptsApi {
49395
50355
  /**
49396
50356
  * Scripts service.
49397
50357
  * @module purecloud-platform-client-v2/api/ScriptsApi
49398
- * @version 173.1.0
50358
+ * @version 174.0.0
49399
50359
  */
49400
50360
 
49401
50361
  /**
@@ -49839,7 +50799,7 @@ class SearchApi {
49839
50799
  /**
49840
50800
  * Search service.
49841
50801
  * @module purecloud-platform-client-v2/api/SearchApi
49842
- * @version 173.1.0
50802
+ * @version 174.0.0
49843
50803
  */
49844
50804
 
49845
50805
  /**
@@ -50528,7 +51488,7 @@ class SettingsApi {
50528
51488
  /**
50529
51489
  * Settings service.
50530
51490
  * @module purecloud-platform-client-v2/api/SettingsApi
50531
- * @version 173.1.0
51491
+ * @version 174.0.0
50532
51492
  */
50533
51493
 
50534
51494
  /**
@@ -50593,7 +51553,7 @@ class SpeechTextAnalyticsApi {
50593
51553
  /**
50594
51554
  * SpeechTextAnalytics service.
50595
51555
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
50596
- * @version 173.1.0
51556
+ * @version 174.0.0
50597
51557
  */
50598
51558
 
50599
51559
  /**
@@ -51576,7 +52536,7 @@ class StationsApi {
51576
52536
  /**
51577
52537
  * Stations service.
51578
52538
  * @module purecloud-platform-client-v2/api/StationsApi
51579
- * @version 173.1.0
52539
+ * @version 174.0.0
51580
52540
  */
51581
52541
 
51582
52542
  /**
@@ -51678,7 +52638,7 @@ class SuggestApi {
51678
52638
  /**
51679
52639
  * Suggest service.
51680
52640
  * @module purecloud-platform-client-v2/api/SuggestApi
51681
- * @version 173.1.0
52641
+ * @version 174.0.0
51682
52642
  */
51683
52643
 
51684
52644
  /**
@@ -51817,7 +52777,7 @@ class TaskManagementApi {
51817
52777
  /**
51818
52778
  * TaskManagement service.
51819
52779
  * @module purecloud-platform-client-v2/api/TaskManagementApi
51820
- * @version 173.1.0
52780
+ * @version 174.0.0
51821
52781
  */
51822
52782
 
51823
52783
  /**
@@ -53098,7 +54058,7 @@ class TeamsApi {
53098
54058
  /**
53099
54059
  * Teams service.
53100
54060
  * @module purecloud-platform-client-v2/api/TeamsApi
53101
- * @version 173.1.0
54061
+ * @version 174.0.0
53102
54062
  */
53103
54063
 
53104
54064
  /**
@@ -53400,7 +54360,7 @@ class TelephonyApi {
53400
54360
  /**
53401
54361
  * Telephony service.
53402
54362
  * @module purecloud-platform-client-v2/api/TelephonyApi
53403
- * @version 173.1.0
54363
+ * @version 174.0.0
53404
54364
  */
53405
54365
 
53406
54366
  /**
@@ -53528,7 +54488,7 @@ class TelephonyProvidersEdgeApi {
53528
54488
  /**
53529
54489
  * TelephonyProvidersEdge service.
53530
54490
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
53531
- * @version 173.1.0
54491
+ * @version 174.0.0
53532
54492
  */
53533
54493
 
53534
54494
  /**
@@ -55191,7 +56151,7 @@ class TelephonyProvidersEdgeApi {
55191
56151
  }
55192
56152
 
55193
56153
  /**
55194
- * Get a list of Phone Instances
56154
+ * 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.
55195
56155
  *
55196
56156
  * @param {Object} opts Optional parameters
55197
56157
  * @param {Number} opts.pageNumber Page number (default to 1)
@@ -56817,7 +57777,7 @@ class TextbotsApi {
56817
57777
  /**
56818
57778
  * Textbots service.
56819
57779
  * @module purecloud-platform-client-v2/api/TextbotsApi
56820
- * @version 173.1.0
57780
+ * @version 174.0.0
56821
57781
  */
56822
57782
 
56823
57783
  /**
@@ -56945,7 +57905,7 @@ class TokensApi {
56945
57905
  /**
56946
57906
  * Tokens service.
56947
57907
  * @module purecloud-platform-client-v2/api/TokensApi
56948
- * @version 173.1.0
57908
+ * @version 174.0.0
56949
57909
  */
56950
57910
 
56951
57911
  /**
@@ -57008,14 +57968,18 @@ class TokensApi {
57008
57968
  /**
57009
57969
  * Fetch information about the current token
57010
57970
  *
57971
+ * @param {Object} opts Optional parameters
57972
+ * @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.
57011
57973
  */
57012
- getTokensMe() {
57974
+ getTokensMe(opts) {
57975
+ opts = opts || {};
57976
+
57013
57977
 
57014
57978
  return this.apiClient.callApi(
57015
57979
  '/api/v2/tokens/me',
57016
57980
  'GET',
57017
57981
  { },
57018
- { },
57982
+ { 'preserveIdleTTL': opts['preserveIdleTTL'] },
57019
57983
  { },
57020
57984
  { },
57021
57985
  null,
@@ -57097,7 +58061,7 @@ class UploadsApi {
57097
58061
  /**
57098
58062
  * Uploads service.
57099
58063
  * @module purecloud-platform-client-v2/api/UploadsApi
57100
- * @version 173.1.0
58064
+ * @version 174.0.0
57101
58065
  */
57102
58066
 
57103
58067
  /**
@@ -57273,7 +58237,7 @@ class UsageApi {
57273
58237
  /**
57274
58238
  * Usage service.
57275
58239
  * @module purecloud-platform-client-v2/api/UsageApi
57276
- * @version 173.1.0
58240
+ * @version 174.0.0
57277
58241
  */
57278
58242
 
57279
58243
  /**
@@ -57483,7 +58447,7 @@ class UserRecordingsApi {
57483
58447
  /**
57484
58448
  * UserRecordings service.
57485
58449
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
57486
- * @version 173.1.0
58450
+ * @version 174.0.0
57487
58451
  */
57488
58452
 
57489
58453
  /**
@@ -57668,7 +58632,7 @@ class UsersApi {
57668
58632
  /**
57669
58633
  * Users service.
57670
58634
  * @module purecloud-platform-client-v2/api/UsersApi
57671
- * @version 173.1.0
58635
+ * @version 174.0.0
57672
58636
  */
57673
58637
 
57674
58638
  /**
@@ -60229,7 +61193,7 @@ class UtilitiesApi {
60229
61193
  /**
60230
61194
  * Utilities service.
60231
61195
  * @module purecloud-platform-client-v2/api/UtilitiesApi
60232
- * @version 173.1.0
61196
+ * @version 174.0.0
60233
61197
  */
60234
61198
 
60235
61199
  /**
@@ -60340,7 +61304,7 @@ class VoicemailApi {
60340
61304
  /**
60341
61305
  * Voicemail service.
60342
61306
  * @module purecloud-platform-client-v2/api/VoicemailApi
60343
- * @version 173.1.0
61307
+ * @version 174.0.0
60344
61308
  */
60345
61309
 
60346
61310
  /**
@@ -61007,7 +61971,7 @@ class WebChatApi {
61007
61971
  /**
61008
61972
  * WebChat service.
61009
61973
  * @module purecloud-platform-client-v2/api/WebChatApi
61010
- * @version 173.1.0
61974
+ * @version 174.0.0
61011
61975
  */
61012
61976
 
61013
61977
  /**
@@ -61556,7 +62520,7 @@ class WebDeploymentsApi {
61556
62520
  /**
61557
62521
  * WebDeployments service.
61558
62522
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
61559
- * @version 173.1.0
62523
+ * @version 174.0.0
61560
62524
  */
61561
62525
 
61562
62526
  /**
@@ -61784,8 +62748,12 @@ class WebDeploymentsApi {
61784
62748
  * Get a deployment
61785
62749
  *
61786
62750
  * @param {String} deploymentId The deployment ID
62751
+ * @param {Object} opts Optional parameters
62752
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
61787
62753
  */
61788
- getWebdeploymentsDeployment(deploymentId) {
62754
+ getWebdeploymentsDeployment(deploymentId, opts) {
62755
+ opts = opts || {};
62756
+
61789
62757
  // verify the required parameter 'deploymentId' is set
61790
62758
  if (deploymentId === undefined || deploymentId === null) {
61791
62759
  throw 'Missing the required parameter "deploymentId" when calling getWebdeploymentsDeployment';
@@ -61795,7 +62763,7 @@ class WebDeploymentsApi {
61795
62763
  '/api/v2/webdeployments/deployments/{deploymentId}',
61796
62764
  'GET',
61797
62765
  { 'deploymentId': deploymentId },
61798
- { },
62766
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
61799
62767
  { },
61800
62768
  { },
61801
62769
  null,
@@ -61841,6 +62809,7 @@ class WebDeploymentsApi {
61841
62809
  * @param {String} deploymentId The deployment ID
61842
62810
  * @param {Object} opts Optional parameters
61843
62811
  * @param {String} opts.type Get active configuration on a deployment
62812
+ * @param {Array.<String>} opts.expand Expand instructions for the return value
61844
62813
  */
61845
62814
  getWebdeploymentsDeploymentConfigurations(deploymentId, opts) {
61846
62815
  opts = opts || {};
@@ -61854,7 +62823,7 @@ class WebDeploymentsApi {
61854
62823
  '/api/v2/webdeployments/deployments/{deploymentId}/configurations',
61855
62824
  'GET',
61856
62825
  { 'deploymentId': deploymentId },
61857
- { 'type': opts['type'] },
62826
+ { 'type': opts['type'],'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
61858
62827
  { },
61859
62828
  { },
61860
62829
  null,
@@ -61868,7 +62837,7 @@ class WebDeploymentsApi {
61868
62837
  * Get deployments
61869
62838
  *
61870
62839
  * @param {Object} opts Optional parameters
61871
- * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected. Valid values:
62840
+ * @param {Array.<String>} opts.expand The specified entity attributes will be filled. Comma separated values expected.
61872
62841
  */
61873
62842
  getWebdeploymentsDeployments(opts) {
61874
62843
  opts = opts || {};
@@ -62078,7 +63047,7 @@ class WebMessagingApi {
62078
63047
  /**
62079
63048
  * WebMessaging service.
62080
63049
  * @module purecloud-platform-client-v2/api/WebMessagingApi
62081
- * @version 173.1.0
63050
+ * @version 174.0.0
62082
63051
  */
62083
63052
 
62084
63053
  /**
@@ -62124,7 +63093,7 @@ class WidgetsApi {
62124
63093
  /**
62125
63094
  * Widgets service.
62126
63095
  * @module purecloud-platform-client-v2/api/WidgetsApi
62127
- * @version 173.1.0
63096
+ * @version 174.0.0
62128
63097
  */
62129
63098
 
62130
63099
  /**
@@ -62270,7 +63239,7 @@ class WorkforceManagementApi {
62270
63239
  /**
62271
63240
  * WorkforceManagement service.
62272
63241
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
62273
- * @version 173.1.0
63242
+ * @version 174.0.0
62274
63243
  */
62275
63244
 
62276
63245
  /**
@@ -63189,8 +64158,12 @@ class WorkforceManagementApi {
63189
64158
  *
63190
64159
  * @param {String} businessUnitId The ID of the business unit.
63191
64160
  * @param {String} serviceGoalTemplateId The ID of a service goal template to fetch
64161
+ * @param {Object} opts Optional parameters
64162
+ * @param {Array.<String>} opts.expand Include to access additional data on the service goal template
63192
64163
  */
63193
- getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId) {
64164
+ getWorkforcemanagementBusinessunitServicegoaltemplate(businessUnitId, serviceGoalTemplateId, opts) {
64165
+ opts = opts || {};
64166
+
63194
64167
  // verify the required parameter 'businessUnitId' is set
63195
64168
  if (businessUnitId === undefined || businessUnitId === null) {
63196
64169
  throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplate';
@@ -63204,7 +64177,7 @@ class WorkforceManagementApi {
63204
64177
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates/{serviceGoalTemplateId}',
63205
64178
  'GET',
63206
64179
  { 'businessUnitId': businessUnitId,'serviceGoalTemplateId': serviceGoalTemplateId },
63207
- { },
64180
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
63208
64181
  { },
63209
64182
  { },
63210
64183
  null,
@@ -63218,8 +64191,12 @@ class WorkforceManagementApi {
63218
64191
  * Gets list of service goal templates
63219
64192
  *
63220
64193
  * @param {String} businessUnitId The ID of the business unit.
64194
+ * @param {Object} opts Optional parameters
64195
+ * @param {Array.<String>} opts.expand Include to access additional data on the service goal template
63221
64196
  */
63222
- getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId) {
64197
+ getWorkforcemanagementBusinessunitServicegoaltemplates(businessUnitId, opts) {
64198
+ opts = opts || {};
64199
+
63223
64200
  // verify the required parameter 'businessUnitId' is set
63224
64201
  if (businessUnitId === undefined || businessUnitId === null) {
63225
64202
  throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitServicegoaltemplates';
@@ -63229,7 +64206,7 @@ class WorkforceManagementApi {
63229
64206
  '/api/v2/workforcemanagement/businessunits/{businessUnitId}/servicegoaltemplates',
63230
64207
  'GET',
63231
64208
  { 'businessUnitId': businessUnitId },
63232
- { },
64209
+ { 'expand': this.apiClient.buildCollectionParam(opts['expand'], 'multi') },
63233
64210
  { },
63234
64211
  { },
63235
64212
  null,
@@ -63779,6 +64756,51 @@ class WorkforceManagementApi {
63779
64756
  );
63780
64757
  }
63781
64758
 
64759
+ /**
64760
+ * Get integrations
64761
+ *
64762
+ */
64763
+ getWorkforcemanagementIntegrationsHris() {
64764
+
64765
+ return this.apiClient.callApi(
64766
+ '/api/v2/workforcemanagement/integrations/hris',
64767
+ 'GET',
64768
+ { },
64769
+ { },
64770
+ { },
64771
+ { },
64772
+ null,
64773
+ ['PureCloud OAuth'],
64774
+ ['application/json'],
64775
+ ['application/json']
64776
+ );
64777
+ }
64778
+
64779
+ /**
64780
+ * Query the results of time off types job
64781
+ *
64782
+ * @param {String} jobId The ID of the job.
64783
+ */
64784
+ getWorkforcemanagementIntegrationsHrisTimeofftypesJob(jobId) {
64785
+ // verify the required parameter 'jobId' is set
64786
+ if (jobId === undefined || jobId === null) {
64787
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementIntegrationsHrisTimeofftypesJob';
64788
+ }
64789
+
64790
+ return this.apiClient.callApi(
64791
+ '/api/v2/workforcemanagement/integrations/hris/timeofftypes/jobs/{jobId}',
64792
+ 'GET',
64793
+ { 'jobId': jobId },
64794
+ { },
64795
+ { },
64796
+ { },
64797
+ null,
64798
+ ['PureCloud OAuth'],
64799
+ ['application/json'],
64800
+ ['application/json']
64801
+ );
64802
+ }
64803
+
63782
64804
  /**
63783
64805
  * Get management unit
63784
64806
  * settings.shortTermForecasting is deprecated and now lives on the business unit
@@ -64592,6 +65614,31 @@ class WorkforceManagementApi {
64592
65614
  );
64593
65615
  }
64594
65616
 
65617
+ /**
65618
+ * Query the results of time off types job
65619
+ *
65620
+ * @param {String} jobId The ID of the job.
65621
+ */
65622
+ getWorkforcemanagementTimeoffbalanceJob(jobId) {
65623
+ // verify the required parameter 'jobId' is set
65624
+ if (jobId === undefined || jobId === null) {
65625
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementTimeoffbalanceJob';
65626
+ }
65627
+
65628
+ return this.apiClient.callApi(
65629
+ '/api/v2/workforcemanagement/timeoffbalance/jobs/{jobId}',
65630
+ 'GET',
65631
+ { 'jobId': jobId },
65632
+ { },
65633
+ { },
65634
+ { },
65635
+ null,
65636
+ ['PureCloud OAuth'],
65637
+ ['application/json'],
65638
+ ['application/json']
65639
+ );
65640
+ }
65641
+
64595
65642
  /**
64596
65643
  * Get a time off request for the current user
64597
65644
  *
@@ -64963,6 +66010,45 @@ class WorkforceManagementApi {
64963
66010
  );
64964
66011
  }
64965
66012
 
66013
+ /**
66014
+ * Set integration status for a time off request.
66015
+ *
66016
+ * @param {String} managementUnitId The ID of the management unit.
66017
+ * @param {String} timeOffRequestId The ID of the time off request.
66018
+ * @param {String} userId The ID of user to whom the time off request belongs.
66019
+ * @param {Object} opts Optional parameters
66020
+ * @param {Object} opts.body body
66021
+ */
66022
+ patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus(managementUnitId, timeOffRequestId, userId, opts) {
66023
+ opts = opts || {};
66024
+
66025
+ // verify the required parameter 'managementUnitId' is set
66026
+ if (managementUnitId === undefined || managementUnitId === null) {
66027
+ throw 'Missing the required parameter "managementUnitId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
66028
+ }
66029
+ // verify the required parameter 'timeOffRequestId' is set
66030
+ if (timeOffRequestId === undefined || timeOffRequestId === null) {
66031
+ throw 'Missing the required parameter "timeOffRequestId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
66032
+ }
66033
+ // verify the required parameter 'userId' is set
66034
+ if (userId === undefined || userId === null) {
66035
+ throw 'Missing the required parameter "userId" when calling patchWorkforcemanagementManagementunitTimeoffrequestUserIntegrationstatus';
66036
+ }
66037
+
66038
+ return this.apiClient.callApi(
66039
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/{timeOffRequestId}/users/{userId}/integrationstatus',
66040
+ 'PATCH',
66041
+ { 'managementUnitId': managementUnitId,'timeOffRequestId': timeOffRequestId,'userId': userId },
66042
+ { },
66043
+ { },
66044
+ { },
66045
+ opts['body'],
66046
+ ['PureCloud OAuth'],
66047
+ ['application/json'],
66048
+ ['application/json']
66049
+ );
66050
+ }
66051
+
64966
66052
  /**
64967
66053
  * Update a time off request
64968
66054
  *
@@ -65200,6 +66286,7 @@ class WorkforceManagementApi {
65200
66286
  *
65201
66287
  * @param {Object} opts Optional parameters
65202
66288
  * @param {Object} opts.body body
66289
+ * @deprecated
65203
66290
  */
65204
66291
  postWorkforcemanagementAdherenceHistorical(opts) {
65205
66292
  opts = opts || {};
@@ -65308,6 +66395,54 @@ class WorkforceManagementApi {
65308
66395
  );
65309
66396
  }
65310
66397
 
66398
+ /**
66399
+ * Move agents in and out of management unit
66400
+ *
66401
+ * @param {Object} opts Optional parameters
66402
+ * @param {Object} opts.body body
66403
+ */
66404
+ postWorkforcemanagementAgents(opts) {
66405
+ opts = opts || {};
66406
+
66407
+
66408
+ return this.apiClient.callApi(
66409
+ '/api/v2/workforcemanagement/agents',
66410
+ 'POST',
66411
+ { },
66412
+ { },
66413
+ { },
66414
+ { },
66415
+ opts['body'],
66416
+ ['PureCloud OAuth'],
66417
+ ['application/json'],
66418
+ ['application/json']
66419
+ );
66420
+ }
66421
+
66422
+ /**
66423
+ * Query integrations for agents
66424
+ *
66425
+ * @param {Object} opts Optional parameters
66426
+ * @param {Object} opts.body body
66427
+ */
66428
+ postWorkforcemanagementAgentsIntegrationsHrisQuery(opts) {
66429
+ opts = opts || {};
66430
+
66431
+
66432
+ return this.apiClient.callApi(
66433
+ '/api/v2/workforcemanagement/agents/integrations/hris/query',
66434
+ 'POST',
66435
+ { },
66436
+ { },
66437
+ { },
66438
+ { },
66439
+ opts['body'],
66440
+ ['PureCloud OAuth'],
66441
+ ['application/json'],
66442
+ ['application/json']
66443
+ );
66444
+ }
66445
+
65311
66446
  /**
65312
66447
  * Get agent possible work shifts for requested time frame
65313
66448
  *
@@ -66130,6 +67265,31 @@ class WorkforceManagementApi {
66130
67265
  );
66131
67266
  }
66132
67267
 
67268
+ /**
67269
+ * Get list of time off types configured in integration
67270
+ *
67271
+ * @param {String} hrisIntegrationId The ID of the HRIS integration for which time off types are queried.
67272
+ */
67273
+ postWorkforcemanagementIntegrationsHriTimeofftypesJobs(hrisIntegrationId) {
67274
+ // verify the required parameter 'hrisIntegrationId' is set
67275
+ if (hrisIntegrationId === undefined || hrisIntegrationId === null) {
67276
+ throw 'Missing the required parameter "hrisIntegrationId" when calling postWorkforcemanagementIntegrationsHriTimeofftypesJobs';
67277
+ }
67278
+
67279
+ return this.apiClient.callApi(
67280
+ '/api/v2/workforcemanagement/integrations/hris/{hrisIntegrationId}/timeofftypes/jobs',
67281
+ 'POST',
67282
+ { 'hrisIntegrationId': hrisIntegrationId },
67283
+ { },
67284
+ { },
67285
+ { },
67286
+ null,
67287
+ ['PureCloud OAuth'],
67288
+ ['application/json'],
67289
+ ['application/json']
67290
+ );
67291
+ }
67292
+
66133
67293
  /**
66134
67294
  * Query published schedules for given given time range for set of users
66135
67295
  *
@@ -66394,6 +67554,35 @@ class WorkforceManagementApi {
66394
67554
  );
66395
67555
  }
66396
67556
 
67557
+ /**
67558
+ * Retrieves integration statuses for a list of time off requests
67559
+ *
67560
+ * @param {String} managementUnitId The ID of the management unit.
67561
+ * @param {Object} opts Optional parameters
67562
+ * @param {Object} opts.body body
67563
+ */
67564
+ postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery(managementUnitId, opts) {
67565
+ opts = opts || {};
67566
+
67567
+ // verify the required parameter 'managementUnitId' is set
67568
+ if (managementUnitId === undefined || managementUnitId === null) {
67569
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitTimeoffrequestsIntegrationstatusQuery';
67570
+ }
67571
+
67572
+ return this.apiClient.callApi(
67573
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/timeoffrequests/integrationstatus/query',
67574
+ 'POST',
67575
+ { 'managementUnitId': managementUnitId },
67576
+ { },
67577
+ { },
67578
+ { },
67579
+ opts['body'],
67580
+ ['PureCloud OAuth'],
67581
+ ['application/json'],
67582
+ ['application/json']
67583
+ );
67584
+ }
67585
+
66397
67586
  /**
66398
67587
  * Fetches time off requests matching the conditions specified in the request body
66399
67588
  * 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
@@ -66522,6 +67711,40 @@ class WorkforceManagementApi {
66522
67711
  );
66523
67712
  }
66524
67713
 
67714
+ /**
67715
+ * Estimates available time off for an agent
67716
+ *
67717
+ * @param {String} managementUnitId The ID of the management unit
67718
+ * @param {String} userId The id of the user for whom the time off request estimate is requested
67719
+ * @param {Object} opts Optional parameters
67720
+ * @param {Object} opts.body body
67721
+ */
67722
+ postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate(managementUnitId, userId, opts) {
67723
+ opts = opts || {};
67724
+
67725
+ // verify the required parameter 'managementUnitId' is set
67726
+ if (managementUnitId === undefined || managementUnitId === null) {
67727
+ throw 'Missing the required parameter "managementUnitId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
67728
+ }
67729
+ // verify the required parameter 'userId' is set
67730
+ if (userId === undefined || userId === null) {
67731
+ throw 'Missing the required parameter "userId" when calling postWorkforcemanagementManagementunitUserTimeoffrequestsEstimate';
67732
+ }
67733
+
67734
+ return this.apiClient.callApi(
67735
+ '/api/v2/workforcemanagement/managementunits/{managementUnitId}/users/{userId}/timeoffrequests/estimate',
67736
+ 'POST',
67737
+ { 'managementUnitId': managementUnitId,'userId': userId },
67738
+ { },
67739
+ { },
67740
+ { },
67741
+ opts['body'],
67742
+ ['PureCloud OAuth'],
67743
+ ['application/json'],
67744
+ ['application/json']
67745
+ );
67746
+ }
67747
+
66525
67748
  /**
66526
67749
  * Matches a shift trade. This route can only be called by the receiving agent
66527
67750
  *
@@ -66964,6 +68187,31 @@ class WorkforceManagementApi {
66964
68187
  );
66965
68188
  }
66966
68189
 
68190
+ /**
68191
+ * Query time off balances for the current user for specified activity code and dates
68192
+ *
68193
+ * @param {Object} body The request body
68194
+ */
68195
+ postWorkforcemanagementTimeoffbalanceJobs(body) {
68196
+ // verify the required parameter 'body' is set
68197
+ if (body === undefined || body === null) {
68198
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementTimeoffbalanceJobs';
68199
+ }
68200
+
68201
+ return this.apiClient.callApi(
68202
+ '/api/v2/workforcemanagement/timeoffbalance/jobs',
68203
+ 'POST',
68204
+ { },
68205
+ { },
68206
+ { },
68207
+ { },
68208
+ body,
68209
+ ['PureCloud OAuth'],
68210
+ ['application/json'],
68211
+ ['application/json']
68212
+ );
68213
+ }
68214
+
66967
68215
  /**
66968
68216
  * Queries available time off for the current user
66969
68217
  *
@@ -67012,6 +68260,84 @@ class WorkforceManagementApi {
67012
68260
  );
67013
68261
  }
67014
68262
 
68263
+ /**
68264
+ * Estimates available time off for current user
68265
+ *
68266
+ * @param {Object} opts Optional parameters
68267
+ * @param {Object} opts.body body
68268
+ */
68269
+ postWorkforcemanagementTimeoffrequestsEstimate(opts) {
68270
+ opts = opts || {};
68271
+
68272
+
68273
+ return this.apiClient.callApi(
68274
+ '/api/v2/workforcemanagement/timeoffrequests/estimate',
68275
+ 'POST',
68276
+ { },
68277
+ { },
68278
+ { },
68279
+ { },
68280
+ opts['body'],
68281
+ ['PureCloud OAuth'],
68282
+ ['application/json'],
68283
+ ['application/json']
68284
+ );
68285
+ }
68286
+
68287
+ /**
68288
+ * Retrieves integration statuses for a list of current user time off requests
68289
+ *
68290
+ * @param {Object} opts Optional parameters
68291
+ * @param {Object} opts.body body
68292
+ */
68293
+ postWorkforcemanagementTimeoffrequestsIntegrationstatusQuery(opts) {
68294
+ opts = opts || {};
68295
+
68296
+
68297
+ return this.apiClient.callApi(
68298
+ '/api/v2/workforcemanagement/timeoffrequests/integrationstatus/query',
68299
+ 'POST',
68300
+ { },
68301
+ { },
68302
+ { },
68303
+ { },
68304
+ opts['body'],
68305
+ ['PureCloud OAuth'],
68306
+ ['application/json'],
68307
+ ['application/json']
68308
+ );
68309
+ }
68310
+
68311
+ /**
68312
+ * Update integrations for agent
68313
+ *
68314
+ * @param {String} agentId The ID of the agent
68315
+ * @param {Object} body body
68316
+ */
68317
+ putWorkforcemanagementAgentIntegrationsHris(agentId, body) {
68318
+ // verify the required parameter 'agentId' is set
68319
+ if (agentId === undefined || agentId === null) {
68320
+ throw 'Missing the required parameter "agentId" when calling putWorkforcemanagementAgentIntegrationsHris';
68321
+ }
68322
+ // verify the required parameter 'body' is set
68323
+ if (body === undefined || body === null) {
68324
+ throw 'Missing the required parameter "body" when calling putWorkforcemanagementAgentIntegrationsHris';
68325
+ }
68326
+
68327
+ return this.apiClient.callApi(
68328
+ '/api/v2/workforcemanagement/agents/{agentId}/integrations/hris',
68329
+ 'PUT',
68330
+ { 'agentId': agentId },
68331
+ { },
68332
+ { },
68333
+ { },
68334
+ body,
68335
+ ['PureCloud OAuth'],
68336
+ ['application/json'],
68337
+ ['application/json']
68338
+ );
68339
+ }
68340
+
67015
68341
  /**
67016
68342
  * Sets daily values for a date range of time off limit object
67017
68343
  * Note that only limit daily values can be set through API, allocated and waitlisted values are read-only for time off limit API
@@ -67077,7 +68403,7 @@ class WorkforceManagementApi {
67077
68403
  * </pre>
67078
68404
  * </p>
67079
68405
  * @module purecloud-platform-client-v2/index
67080
- * @version 173.1.0
68406
+ * @version 174.0.0
67081
68407
  */
67082
68408
  class platformClient {
67083
68409
  constructor() {