purecloud-platform-client-v2 197.0.0 → 199.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 (87) hide show
  1. package/README.md +2 -2
  2. package/dist/node/purecloud-platform-client-v2.js +401 -112
  3. package/dist/web-amd/purecloud-platform-client-v2.js +401 -112
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +167 -92
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +170 -93
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +733 -238
  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/AgentUIApi.js +1 -1
  12. package/src/purecloud-platform-client-v2/api/AlertingApi.js +1 -1
  13. package/src/purecloud-platform-client-v2/api/AnalyticsApi.js +1 -1
  14. package/src/purecloud-platform-client-v2/api/ArchitectApi.js +1 -1
  15. package/src/purecloud-platform-client-v2/api/AuditApi.js +1 -1
  16. package/src/purecloud-platform-client-v2/api/AuthorizationApi.js +1 -1
  17. package/src/purecloud-platform-client-v2/api/BillingApi.js +1 -1
  18. package/src/purecloud-platform-client-v2/api/CarrierServicesApi.js +1 -1
  19. package/src/purecloud-platform-client-v2/api/ChatApi.js +1 -1
  20. package/src/purecloud-platform-client-v2/api/CoachingApi.js +1 -1
  21. package/src/purecloud-platform-client-v2/api/ContentManagementApi.js +1 -1
  22. package/src/purecloud-platform-client-v2/api/ConversationsApi.js +37 -3
  23. package/src/purecloud-platform-client-v2/api/DataExtensionsApi.js +1 -1
  24. package/src/purecloud-platform-client-v2/api/DownloadsApi.js +1 -1
  25. package/src/purecloud-platform-client-v2/api/EmailsApi.js +1 -1
  26. package/src/purecloud-platform-client-v2/api/EmployeeEngagementApi.js +1 -1
  27. package/src/purecloud-platform-client-v2/api/EventsApi.js +1 -1
  28. package/src/purecloud-platform-client-v2/api/ExternalContactsApi.js +2 -2
  29. package/src/purecloud-platform-client-v2/api/FaxApi.js +1 -1
  30. package/src/purecloud-platform-client-v2/api/FlowsApi.js +1 -1
  31. package/src/purecloud-platform-client-v2/api/GamificationApi.js +1 -1
  32. package/src/purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi.js +1 -1
  33. package/src/purecloud-platform-client-v2/api/GeolocationApi.js +1 -1
  34. package/src/purecloud-platform-client-v2/api/GreetingsApi.js +1 -1
  35. package/src/purecloud-platform-client-v2/api/GroupsApi.js +1 -1
  36. package/src/purecloud-platform-client-v2/api/IdentityProviderApi.js +1 -1
  37. package/src/purecloud-platform-client-v2/api/InfrastructureAsCodeApi.js +1 -1
  38. package/src/purecloud-platform-client-v2/api/IntegrationsApi.js +1 -1
  39. package/src/purecloud-platform-client-v2/api/JourneyApi.js +30 -2
  40. package/src/purecloud-platform-client-v2/api/KnowledgeApi.js +1 -1
  41. package/src/purecloud-platform-client-v2/api/LanguageUnderstandingApi.js +1 -1
  42. package/src/purecloud-platform-client-v2/api/LanguagesApi.js +1 -1
  43. package/src/purecloud-platform-client-v2/api/LearningApi.js +1 -1
  44. package/src/purecloud-platform-client-v2/api/LicenseApi.js +1 -1
  45. package/src/purecloud-platform-client-v2/api/LocationsApi.js +1 -1
  46. package/src/purecloud-platform-client-v2/api/LogCaptureApi.js +1 -1
  47. package/src/purecloud-platform-client-v2/api/MessagingApi.js +1 -1
  48. package/src/purecloud-platform-client-v2/api/MobileDevicesApi.js +1 -1
  49. package/src/purecloud-platform-client-v2/api/NotificationsApi.js +1 -1
  50. package/src/purecloud-platform-client-v2/api/OAuthApi.js +1 -1
  51. package/src/purecloud-platform-client-v2/api/ObjectsApi.js +1 -1
  52. package/src/purecloud-platform-client-v2/api/OperationalEventsApi.js +1 -1
  53. package/src/purecloud-platform-client-v2/api/OrganizationApi.js +1 -1
  54. package/src/purecloud-platform-client-v2/api/OrganizationAuthorizationApi.js +1 -1
  55. package/src/purecloud-platform-client-v2/api/OutboundApi.js +2 -2
  56. package/src/purecloud-platform-client-v2/api/PresenceApi.js +1 -1
  57. package/src/purecloud-platform-client-v2/api/ProcessAutomationApi.js +1 -1
  58. package/src/purecloud-platform-client-v2/api/QualityApi.js +32 -1
  59. package/src/purecloud-platform-client-v2/api/RecordingApi.js +1 -1
  60. package/src/purecloud-platform-client-v2/api/ResponseManagementApi.js +1 -1
  61. package/src/purecloud-platform-client-v2/api/RoutingApi.js +1 -1
  62. package/src/purecloud-platform-client-v2/api/SCIMApi.js +1 -1
  63. package/src/purecloud-platform-client-v2/api/ScreenRecordingApi.js +1 -1
  64. package/src/purecloud-platform-client-v2/api/ScriptsApi.js +1 -1
  65. package/src/purecloud-platform-client-v2/api/SearchApi.js +1 -1
  66. package/src/purecloud-platform-client-v2/api/SettingsApi.js +1 -1
  67. package/src/purecloud-platform-client-v2/api/SpeechTextAnalyticsApi.js +1 -1
  68. package/src/purecloud-platform-client-v2/api/StationsApi.js +1 -1
  69. package/src/purecloud-platform-client-v2/api/SuggestApi.js +1 -1
  70. package/src/purecloud-platform-client-v2/api/TaskManagementApi.js +3 -2
  71. package/src/purecloud-platform-client-v2/api/TeamsApi.js +1 -1
  72. package/src/purecloud-platform-client-v2/api/TelephonyApi.js +1 -1
  73. package/src/purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi.js +1 -1
  74. package/src/purecloud-platform-client-v2/api/TextbotsApi.js +1 -1
  75. package/src/purecloud-platform-client-v2/api/TokensApi.js +1 -1
  76. package/src/purecloud-platform-client-v2/api/UploadsApi.js +1 -1
  77. package/src/purecloud-platform-client-v2/api/UsageApi.js +1 -1
  78. package/src/purecloud-platform-client-v2/api/UserRecordingsApi.js +1 -1
  79. package/src/purecloud-platform-client-v2/api/UsersApi.js +3 -3
  80. package/src/purecloud-platform-client-v2/api/UtilitiesApi.js +1 -1
  81. package/src/purecloud-platform-client-v2/api/VoicemailApi.js +1 -1
  82. package/src/purecloud-platform-client-v2/api/WebChatApi.js +1 -1
  83. package/src/purecloud-platform-client-v2/api/WebDeploymentsApi.js +1 -1
  84. package/src/purecloud-platform-client-v2/api/WebMessagingApi.js +1 -1
  85. package/src/purecloud-platform-client-v2/api/WidgetsApi.js +1 -1
  86. package/src/purecloud-platform-client-v2/api/WorkforceManagementApi.js +222 -27
  87. package/src/purecloud-platform-client-v2/index.js +1 -1
@@ -402,7 +402,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
402
402
 
403
403
  /**
404
404
  * @module purecloud-platform-client-v2/ApiClient
405
- * @version 197.0.0
405
+ * @version 199.0.0
406
406
  */
407
407
  class ApiClient {
408
408
  /**
@@ -1824,7 +1824,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1824
1824
  /**
1825
1825
  * AgentUI service.
1826
1826
  * @module purecloud-platform-client-v2/api/AgentUIApi
1827
- * @version 197.0.0
1827
+ * @version 199.0.0
1828
1828
  */
1829
1829
 
1830
1830
  /**
@@ -1955,7 +1955,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
1955
1955
  /**
1956
1956
  * Alerting service.
1957
1957
  * @module purecloud-platform-client-v2/api/AlertingApi
1958
- * @version 197.0.0
1958
+ * @version 199.0.0
1959
1959
  */
1960
1960
 
1961
1961
  /**
@@ -2616,7 +2616,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
2616
2616
  /**
2617
2617
  * Analytics service.
2618
2618
  * @module purecloud-platform-client-v2/api/AnalyticsApi
2619
- * @version 197.0.0
2619
+ * @version 199.0.0
2620
2620
  */
2621
2621
 
2622
2622
  /**
@@ -5228,7 +5228,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
5228
5228
  /**
5229
5229
  * Architect service.
5230
5230
  * @module purecloud-platform-client-v2/api/ArchitectApi
5231
- * @version 197.0.0
5231
+ * @version 199.0.0
5232
5232
  */
5233
5233
 
5234
5234
  /**
@@ -9374,7 +9374,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9374
9374
  /**
9375
9375
  * Audit service.
9376
9376
  * @module purecloud-platform-client-v2/api/AuditApi
9377
- * @version 197.0.0
9377
+ * @version 199.0.0
9378
9378
  */
9379
9379
 
9380
9380
  /**
@@ -9574,7 +9574,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
9574
9574
  /**
9575
9575
  * Authorization service.
9576
9576
  * @module purecloud-platform-client-v2/api/AuthorizationApi
9577
- * @version 197.0.0
9577
+ * @version 199.0.0
9578
9578
  */
9579
9579
 
9580
9580
  /**
@@ -10812,7 +10812,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10812
10812
  /**
10813
10813
  * Billing service.
10814
10814
  * @module purecloud-platform-client-v2/api/BillingApi
10815
- * @version 197.0.0
10815
+ * @version 199.0.0
10816
10816
  */
10817
10817
 
10818
10818
  /**
@@ -10892,7 +10892,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10892
10892
  /**
10893
10893
  * CarrierServices service.
10894
10894
  * @module purecloud-platform-client-v2/api/CarrierServicesApi
10895
- * @version 197.0.0
10895
+ * @version 199.0.0
10896
10896
  */
10897
10897
 
10898
10898
  /**
@@ -10962,7 +10962,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
10962
10962
  /**
10963
10963
  * Chat service.
10964
10964
  * @module purecloud-platform-client-v2/api/ChatApi
10965
- * @version 197.0.0
10965
+ * @version 199.0.0
10966
10966
  */
10967
10967
 
10968
10968
  /**
@@ -11898,7 +11898,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
11898
11898
  /**
11899
11899
  * Coaching service.
11900
11900
  * @module purecloud-platform-client-v2/api/CoachingApi
11901
- * @version 197.0.0
11901
+ * @version 199.0.0
11902
11902
  */
11903
11903
 
11904
11904
  /**
@@ -12475,7 +12475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
12475
12475
  /**
12476
12476
  * ContentManagement service.
12477
12477
  * @module purecloud-platform-client-v2/api/ContentManagementApi
12478
- * @version 197.0.0
12478
+ * @version 199.0.0
12479
12479
  */
12480
12480
 
12481
12481
  /**
@@ -13557,7 +13557,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
13557
13557
  /**
13558
13558
  * Conversations service.
13559
13559
  * @module purecloud-platform-client-v2/api/ConversationsApi
13560
- * @version 197.0.0
13560
+ * @version 199.0.0
13561
13561
  */
13562
13562
 
13563
13563
  /**
@@ -17272,6 +17272,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17272
17272
  );
17273
17273
  }
17274
17274
 
17275
+ /**
17276
+ * Update conversation by setting its parking state
17277
+ *
17278
+ * @param {String} conversationId conversationId
17279
+ * @param {String} participantId participantId
17280
+ * @param {Object} body Parking update request
17281
+ * patchConversationsEmailParticipantParkingstate is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17282
+ */
17283
+ patchConversationsEmailParticipantParkingstate(conversationId, participantId, body) {
17284
+ // verify the required parameter 'conversationId' is set
17285
+ if (conversationId === undefined || conversationId === null) {
17286
+ throw 'Missing the required parameter "conversationId" when calling patchConversationsEmailParticipantParkingstate';
17287
+ }
17288
+ // verify the required parameter 'participantId' is set
17289
+ if (participantId === undefined || participantId === null) {
17290
+ throw 'Missing the required parameter "participantId" when calling patchConversationsEmailParticipantParkingstate';
17291
+ }
17292
+ // verify the required parameter 'body' is set
17293
+ if (body === undefined || body === null) {
17294
+ throw 'Missing the required parameter "body" when calling patchConversationsEmailParticipantParkingstate';
17295
+ }
17296
+
17297
+ return this.apiClient.callApi(
17298
+ '/api/v2/conversations/emails/{conversationId}/participants/{participantId}/parkingstate',
17299
+ 'PATCH',
17300
+ { 'conversationId': conversationId,'participantId': participantId },
17301
+ { },
17302
+ { },
17303
+ { },
17304
+ body,
17305
+ ['PureCloud OAuth'],
17306
+ ['application/json'],
17307
+ ['application/json']
17308
+ );
17309
+ }
17310
+
17275
17311
  /**
17276
17312
  * Update a conversation by disconnecting all of the participants
17277
17313
  *
@@ -17840,7 +17876,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
17840
17876
  * Barge a conversation creating a barged in conference of connected participants.
17841
17877
  *
17842
17878
  * @param {String} conversationId conversation ID
17843
- * postConversationBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
17844
17879
  */
17845
17880
  postConversationBarge(conversationId) {
17846
17881
  // verify the required parameter 'conversationId' is set
@@ -18288,7 +18323,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
18288
18323
  *
18289
18324
  * @param {String} conversationId conversationId
18290
18325
  * @param {String} participantId participantId
18291
- * postConversationsCallParticipantBarge is a preview method and is subject to both breaking and non-breaking changes at any time without notice
18292
18326
  */
18293
18327
  postConversationsCallParticipantBarge(conversationId, participantId) {
18294
18328
  // verify the required parameter 'conversationId' is set
@@ -20636,7 +20670,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20636
20670
  /**
20637
20671
  * DataExtensions service.
20638
20672
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20639
- * @version 197.0.0
20673
+ * @version 199.0.0
20640
20674
  */
20641
20675
 
20642
20676
  /**
@@ -20722,7 +20756,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20722
20756
  /**
20723
20757
  * Downloads service.
20724
20758
  * @module purecloud-platform-client-v2/api/DownloadsApi
20725
- * @version 197.0.0
20759
+ * @version 199.0.0
20726
20760
  */
20727
20761
 
20728
20762
  /**
@@ -20774,7 +20808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20774
20808
  /**
20775
20809
  * Emails service.
20776
20810
  * @module purecloud-platform-client-v2/api/EmailsApi
20777
- * @version 197.0.0
20811
+ * @version 199.0.0
20778
20812
  */
20779
20813
 
20780
20814
  /**
@@ -20839,7 +20873,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20839
20873
  /**
20840
20874
  * EmployeeEngagement service.
20841
20875
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
20842
- * @version 197.0.0
20876
+ * @version 199.0.0
20843
20877
  */
20844
20878
 
20845
20879
  /**
@@ -20990,7 +21024,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20990
21024
  /**
20991
21025
  * Events service.
20992
21026
  * @module purecloud-platform-client-v2/api/EventsApi
20993
- * @version 197.0.0
21027
+ * @version 199.0.0
20994
21028
  */
20995
21029
 
20996
21030
  /**
@@ -21086,7 +21120,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21086
21120
  /**
21087
21121
  * ExternalContacts service.
21088
21122
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
21089
- * @version 197.0.0
21123
+ * @version 199.0.0
21090
21124
  */
21091
21125
 
21092
21126
  /**
@@ -21442,7 +21476,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21442
21476
  *
21443
21477
  * @param {String} contactId ExternalContact ID
21444
21478
  * @param {Object} opts Optional parameters
21445
- * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
21479
+ * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
21446
21480
  */
21447
21481
  getExternalcontactsContactUnresolved(contactId, opts) {
21448
21482
  opts = opts || {};
@@ -23048,7 +23082,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23048
23082
  /**
23049
23083
  * Fax service.
23050
23084
  * @module purecloud-platform-client-v2/api/FaxApi
23051
- * @version 197.0.0
23085
+ * @version 199.0.0
23052
23086
  */
23053
23087
 
23054
23088
  /**
@@ -23263,7 +23297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23263
23297
  /**
23264
23298
  * Flows service.
23265
23299
  * @module purecloud-platform-client-v2/api/FlowsApi
23266
- * @version 197.0.0
23300
+ * @version 199.0.0
23267
23301
  */
23268
23302
 
23269
23303
  /**
@@ -23446,7 +23480,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23446
23480
  /**
23447
23481
  * Gamification service.
23448
23482
  * @module purecloud-platform-client-v2/api/GamificationApi
23449
- * @version 197.0.0
23483
+ * @version 199.0.0
23450
23484
  */
23451
23485
 
23452
23486
  /**
@@ -25532,7 +25566,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25532
25566
  /**
25533
25567
  * GeneralDataProtectionRegulation service.
25534
25568
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25535
- * @version 197.0.0
25569
+ * @version 199.0.0
25536
25570
  */
25537
25571
 
25538
25572
  /**
@@ -25662,7 +25696,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25662
25696
  /**
25663
25697
  * Geolocation service.
25664
25698
  * @module purecloud-platform-client-v2/api/GeolocationApi
25665
- * @version 197.0.0
25699
+ * @version 199.0.0
25666
25700
  */
25667
25701
 
25668
25702
  /**
@@ -25793,7 +25827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25793
25827
  /**
25794
25828
  * Greetings service.
25795
25829
  * @module purecloud-platform-client-v2/api/GreetingsApi
25796
- * @version 197.0.0
25830
+ * @version 199.0.0
25797
25831
  */
25798
25832
 
25799
25833
  /**
@@ -26248,7 +26282,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26248
26282
  /**
26249
26283
  * Groups service.
26250
26284
  * @module purecloud-platform-client-v2/api/GroupsApi
26251
- * @version 197.0.0
26285
+ * @version 199.0.0
26252
26286
  */
26253
26287
 
26254
26288
  /**
@@ -26767,7 +26801,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26767
26801
  /**
26768
26802
  * IdentityProvider service.
26769
26803
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26770
- * @version 197.0.0
26804
+ * @version 199.0.0
26771
26805
  */
26772
26806
 
26773
26807
  /**
@@ -27628,7 +27662,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27628
27662
  /**
27629
27663
  * InfrastructureAsCode service.
27630
27664
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27631
- * @version 197.0.0
27665
+ * @version 199.0.0
27632
27666
  */
27633
27667
 
27634
27668
  /**
@@ -27795,7 +27829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27795
27829
  /**
27796
27830
  * Integrations service.
27797
27831
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27798
- * @version 197.0.0
27832
+ * @version 199.0.0
27799
27833
  */
27800
27834
 
27801
27835
  /**
@@ -30147,7 +30181,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30147
30181
  /**
30148
30182
  * Journey service.
30149
30183
  * @module purecloud-platform-client-v2/api/JourneyApi
30150
- * @version 197.0.0
30184
+ * @version 199.0.0
30151
30185
  */
30152
30186
 
30153
30187
  /**
@@ -30892,7 +30926,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30892
30926
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
30893
30927
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
30894
30928
  * @param {Object} opts.eventType A comma separated list of journey event types to include in the results.
30895
- * getJourneySessionEvents is a preview method and is subject to both breaking and non-breaking changes at any time without notice
30896
30929
  */
30897
30930
  getJourneySessionEvents(sessionId, opts) {
30898
30931
  opts = opts || {};
@@ -31525,6 +31558,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31525
31558
  );
31526
31559
  }
31527
31560
 
31561
+ /**
31562
+ * Send a journey web event, used for tracking customer activity on a website.
31563
+ *
31564
+ * @param {String} deploymentId The ID of the deployment sending the web event.
31565
+ * @param {Object} opts Optional parameters
31566
+ * @param {Object} opts.body
31567
+ */
31568
+ postJourneyDeploymentWebevents(deploymentId, opts) {
31569
+ opts = opts || {};
31570
+
31571
+ // verify the required parameter 'deploymentId' is set
31572
+ if (deploymentId === undefined || deploymentId === null) {
31573
+ throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';
31574
+ }
31575
+
31576
+ return this.apiClient.callApi(
31577
+ '/api/v2/journey/deployments/{deploymentId}/webevents',
31578
+ 'POST',
31579
+ { 'deploymentId': deploymentId },
31580
+ { },
31581
+ { },
31582
+ { },
31583
+ opts['body'],
31584
+ ['PureCloud OAuth'],
31585
+ ['application/json'],
31586
+ ['application/json']
31587
+ );
31588
+ }
31589
+
31528
31590
  /**
31529
31591
  * Query for flow paths.
31530
31592
  *
@@ -31765,7 +31827,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31765
31827
  /**
31766
31828
  * Knowledge service.
31767
31829
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31768
- * @version 197.0.0
31830
+ * @version 199.0.0
31769
31831
  */
31770
31832
 
31771
31833
  /**
@@ -35009,7 +35071,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35009
35071
  /**
35010
35072
  * LanguageUnderstanding service.
35011
35073
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
35012
- * @version 197.0.0
35074
+ * @version 199.0.0
35013
35075
  */
35014
35076
 
35015
35077
  /**
@@ -36043,7 +36105,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36043
36105
  /**
36044
36106
  * Languages service.
36045
36107
  * @module purecloud-platform-client-v2/api/LanguagesApi
36046
- * @version 197.0.0
36108
+ * @version 199.0.0
36047
36109
  */
36048
36110
 
36049
36111
  /**
@@ -36265,7 +36327,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36265
36327
  /**
36266
36328
  * Learning service.
36267
36329
  * @module purecloud-platform-client-v2/api/LearningApi
36268
- * @version 197.0.0
36330
+ * @version 199.0.0
36269
36331
  */
36270
36332
 
36271
36333
  /**
@@ -37294,7 +37356,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37294
37356
  /**
37295
37357
  * License service.
37296
37358
  * @module purecloud-platform-client-v2/api/LicenseApi
37297
- * @version 197.0.0
37359
+ * @version 199.0.0
37298
37360
  */
37299
37361
 
37300
37362
  /**
@@ -37532,7 +37594,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37532
37594
  /**
37533
37595
  * Locations service.
37534
37596
  * @module purecloud-platform-client-v2/api/LocationsApi
37535
- * @version 197.0.0
37597
+ * @version 199.0.0
37536
37598
  */
37537
37599
 
37538
37600
  /**
@@ -37768,7 +37830,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37768
37830
  /**
37769
37831
  * LogCapture service.
37770
37832
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37771
- * @version 197.0.0
37833
+ * @version 199.0.0
37772
37834
  */
37773
37835
 
37774
37836
  /**
@@ -37968,7 +38030,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37968
38030
  /**
37969
38031
  * Messaging service.
37970
38032
  * @module purecloud-platform-client-v2/api/MessagingApi
37971
- * @version 197.0.0
38033
+ * @version 199.0.0
37972
38034
  */
37973
38035
 
37974
38036
  /**
@@ -38327,7 +38389,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38327
38389
  /**
38328
38390
  * MobileDevices service.
38329
38391
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
38330
- * @version 197.0.0
38392
+ * @version 199.0.0
38331
38393
  */
38332
38394
 
38333
38395
  /**
@@ -38478,7 +38540,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38478
38540
  /**
38479
38541
  * Notifications service.
38480
38542
  * @module purecloud-platform-client-v2/api/NotificationsApi
38481
- * @version 197.0.0
38543
+ * @version 199.0.0
38482
38544
  */
38483
38545
 
38484
38546
  /**
@@ -38711,7 +38773,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38711
38773
  /**
38712
38774
  * OAuth service.
38713
38775
  * @module purecloud-platform-client-v2/api/OAuthApi
38714
- * @version 197.0.0
38776
+ * @version 199.0.0
38715
38777
  */
38716
38778
 
38717
38779
  /**
@@ -39077,7 +39139,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39077
39139
  /**
39078
39140
  * Objects service.
39079
39141
  * @module purecloud-platform-client-v2/api/ObjectsApi
39080
- * @version 197.0.0
39142
+ * @version 199.0.0
39081
39143
  */
39082
39144
 
39083
39145
  /**
@@ -39347,7 +39409,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39347
39409
  /**
39348
39410
  * OperationalEvents service.
39349
39411
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
39350
- * @version 197.0.0
39412
+ * @version 199.0.0
39351
39413
  */
39352
39414
 
39353
39415
  /**
@@ -39413,7 +39475,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39413
39475
  /**
39414
39476
  * Organization service.
39415
39477
  * @module purecloud-platform-client-v2/api/OrganizationApi
39416
- * @version 197.0.0
39478
+ * @version 199.0.0
39417
39479
  */
39418
39480
 
39419
39481
  /**
@@ -39888,7 +39950,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39888
39950
  /**
39889
39951
  * OrganizationAuthorization service.
39890
39952
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39891
- * @version 197.0.0
39953
+ * @version 199.0.0
39892
39954
  */
39893
39955
 
39894
39956
  /**
@@ -41235,7 +41297,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41235
41297
  /**
41236
41298
  * Outbound service.
41237
41299
  * @module purecloud-platform-client-v2/api/OutboundApi
41238
- * @version 197.0.0
41300
+ * @version 199.0.0
41239
41301
  */
41240
41302
 
41241
41303
  /**
@@ -41849,7 +41911,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41849
41911
 
41850
41912
  /**
41851
41913
  * Reset messaging campaign progress and recycle the messaging campaign
41852
- *
41914
+ * Documented permissions are applicable based on campaign type.
41853
41915
  * @param {String} messagingCampaignId The Messaging Campaign ID
41854
41916
  */
41855
41917
  deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
@@ -45597,7 +45659,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45597
45659
  /**
45598
45660
  * Presence service.
45599
45661
  * @module purecloud-platform-client-v2/api/PresenceApi
45600
- * @version 197.0.0
45662
+ * @version 199.0.0
45601
45663
  */
45602
45664
 
45603
45665
  /**
@@ -46341,7 +46403,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46341
46403
  /**
46342
46404
  * ProcessAutomation service.
46343
46405
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
46344
- * @version 197.0.0
46406
+ * @version 199.0.0
46345
46407
  */
46346
46408
 
46347
46409
  /**
@@ -46580,7 +46642,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46580
46642
  /**
46581
46643
  * Quality service.
46582
46644
  * @module purecloud-platform-client-v2/api/QualityApi
46583
- * @version 197.0.0
46645
+ * @version 199.0.0
46584
46646
  */
46585
46647
 
46586
46648
  /**
@@ -48269,6 +48331,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48269
48331
  );
48270
48332
  }
48271
48333
 
48334
+ /**
48335
+ * Update the AI Scoring settings of an evaluation form.
48336
+ *
48337
+ * @param {String} formId Form ID
48338
+ * @param {Object} body AI Scoring Settings
48339
+ * putQualityFormsEvaluationAiscoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48340
+ */
48341
+ putQualityFormsEvaluationAiscoringSettings(formId, body) {
48342
+ // verify the required parameter 'formId' is set
48343
+ if (formId === undefined || formId === null) {
48344
+ throw 'Missing the required parameter "formId" when calling putQualityFormsEvaluationAiscoringSettings';
48345
+ }
48346
+ // verify the required parameter 'body' is set
48347
+ if (body === undefined || body === null) {
48348
+ throw 'Missing the required parameter "body" when calling putQualityFormsEvaluationAiscoringSettings';
48349
+ }
48350
+
48351
+ return this.apiClient.callApi(
48352
+ '/api/v2/quality/forms/evaluations/{formId}/aiscoring/settings',
48353
+ 'PUT',
48354
+ { 'formId': formId },
48355
+ { },
48356
+ { },
48357
+ { },
48358
+ body,
48359
+ ['PureCloud OAuth'],
48360
+ ['application/json'],
48361
+ ['application/json']
48362
+ );
48363
+ }
48364
+
48272
48365
  /**
48273
48366
  * Update a survey form.
48274
48367
  *
@@ -48335,7 +48428,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48335
48428
  /**
48336
48429
  * Recording service.
48337
48430
  * @module purecloud-platform-client-v2/api/RecordingApi
48338
- * @version 197.0.0
48431
+ * @version 199.0.0
48339
48432
  */
48340
48433
 
48341
48434
  /**
@@ -49993,7 +50086,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49993
50086
  /**
49994
50087
  * ResponseManagement service.
49995
50088
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
49996
- * @version 197.0.0
50089
+ * @version 199.0.0
49997
50090
  */
49998
50091
 
49999
50092
  /**
@@ -50503,7 +50596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50503
50596
  /**
50504
50597
  * Routing service.
50505
50598
  * @module purecloud-platform-client-v2/api/RoutingApi
50506
- * @version 197.0.0
50599
+ * @version 199.0.0
50507
50600
  */
50508
50601
 
50509
50602
  /**
@@ -54477,7 +54570,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54477
54570
  /**
54478
54571
  * SCIM service.
54479
54572
  * @module purecloud-platform-client-v2/api/SCIMApi
54480
- * @version 197.0.0
54573
+ * @version 199.0.0
54481
54574
  */
54482
54575
 
54483
54576
  /**
@@ -55354,7 +55447,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55354
55447
  /**
55355
55448
  * ScreenRecording service.
55356
55449
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
55357
- * @version 197.0.0
55450
+ * @version 199.0.0
55358
55451
  */
55359
55452
 
55360
55453
  /**
@@ -55399,7 +55492,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55399
55492
  /**
55400
55493
  * Scripts service.
55401
55494
  * @module purecloud-platform-client-v2/api/ScriptsApi
55402
- * @version 197.0.0
55495
+ * @version 199.0.0
55403
55496
  */
55404
55497
 
55405
55498
  /**
@@ -55843,7 +55936,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55843
55936
  /**
55844
55937
  * Search service.
55845
55938
  * @module purecloud-platform-client-v2/api/SearchApi
55846
- * @version 197.0.0
55939
+ * @version 199.0.0
55847
55940
  */
55848
55941
 
55849
55942
  /**
@@ -56532,7 +56625,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56532
56625
  /**
56533
56626
  * Settings service.
56534
56627
  * @module purecloud-platform-client-v2/api/SettingsApi
56535
- * @version 197.0.0
56628
+ * @version 199.0.0
56536
56629
  */
56537
56630
 
56538
56631
  /**
@@ -56754,7 +56847,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56754
56847
  /**
56755
56848
  * SpeechTextAnalytics service.
56756
56849
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
56757
- * @version 197.0.0
56850
+ * @version 199.0.0
56758
56851
  */
56759
56852
 
56760
56853
  /**
@@ -58032,7 +58125,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58032
58125
  /**
58033
58126
  * Stations service.
58034
58127
  * @module purecloud-platform-client-v2/api/StationsApi
58035
- * @version 197.0.0
58128
+ * @version 199.0.0
58036
58129
  */
58037
58130
 
58038
58131
  /**
@@ -58134,7 +58227,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58134
58227
  /**
58135
58228
  * Suggest service.
58136
58229
  * @module purecloud-platform-client-v2/api/SuggestApi
58137
- * @version 197.0.0
58230
+ * @version 199.0.0
58138
58231
  */
58139
58232
 
58140
58233
  /**
@@ -58273,7 +58366,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58273
58366
  /**
58274
58367
  * TaskManagement service.
58275
58368
  * @module purecloud-platform-client-v2/api/TaskManagementApi
58276
- * @version 197.0.0
58369
+ * @version 199.0.0
58277
58370
  */
58278
58371
 
58279
58372
  /**
@@ -58918,6 +59011,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58918
59011
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
58919
59012
  * @param {Number} opts.pageSize Limit the number of entities to return. It is not guaranteed that the requested number of entities will be filled in a single request. If an `after` key is returned as part of the response it is possible that more entities that match the filter criteria exist. Maximum of 200. (default to 25)
58920
59013
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
59014
+ * @param {Array.<String>} opts.fields Comma-separated list of fields. The response will contain only versions created as a result of changes to these fields.
58921
59015
  * getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58922
59016
  */
58923
59017
  getTaskmanagementWorktypeHistory(worktypeId, opts) {
@@ -58932,7 +59026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58932
59026
  '/api/v2/taskmanagement/worktypes/{worktypeId}/history',
58933
59027
  'GET',
58934
59028
  { 'worktypeId': worktypeId },
58935
- { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
59029
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
58936
59030
  { },
58937
59031
  { },
58938
59032
  null,
@@ -59621,7 +59715,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59621
59715
  /**
59622
59716
  * Teams service.
59623
59717
  * @module purecloud-platform-client-v2/api/TeamsApi
59624
- * @version 197.0.0
59718
+ * @version 199.0.0
59625
59719
  */
59626
59720
 
59627
59721
  /**
@@ -59922,7 +60016,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59922
60016
  /**
59923
60017
  * Telephony service.
59924
60018
  * @module purecloud-platform-client-v2/api/TelephonyApi
59925
- * @version 197.0.0
60019
+ * @version 199.0.0
59926
60020
  */
59927
60021
 
59928
60022
  /**
@@ -60104,7 +60198,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60104
60198
  /**
60105
60199
  * TelephonyProvidersEdge service.
60106
60200
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
60107
- * @version 197.0.0
60201
+ * @version 199.0.0
60108
60202
  */
60109
60203
 
60110
60204
  /**
@@ -63432,7 +63526,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63432
63526
  /**
63433
63527
  * Textbots service.
63434
63528
  * @module purecloud-platform-client-v2/api/TextbotsApi
63435
- * @version 197.0.0
63529
+ * @version 199.0.0
63436
63530
  */
63437
63531
 
63438
63532
  /**
@@ -63560,7 +63654,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63560
63654
  /**
63561
63655
  * Tokens service.
63562
63656
  * @module purecloud-platform-client-v2/api/TokensApi
63563
- * @version 197.0.0
63657
+ * @version 199.0.0
63564
63658
  */
63565
63659
 
63566
63660
  /**
@@ -63714,7 +63808,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63714
63808
  /**
63715
63809
  * Uploads service.
63716
63810
  * @module purecloud-platform-client-v2/api/UploadsApi
63717
- * @version 197.0.0
63811
+ * @version 199.0.0
63718
63812
  */
63719
63813
 
63720
63814
  /**
@@ -63983,7 +64077,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63983
64077
  /**
63984
64078
  * Usage service.
63985
64079
  * @module purecloud-platform-client-v2/api/UsageApi
63986
- * @version 197.0.0
64080
+ * @version 199.0.0
63987
64081
  */
63988
64082
 
63989
64083
  /**
@@ -64198,7 +64292,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64198
64292
  /**
64199
64293
  * UserRecordings service.
64200
64294
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
64201
- * @version 197.0.0
64295
+ * @version 199.0.0
64202
64296
  */
64203
64297
 
64204
64298
  /**
@@ -64383,7 +64477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64383
64477
  /**
64384
64478
  * Users service.
64385
64479
  * @module purecloud-platform-client-v2/api/UsersApi
64386
- * @version 197.0.0
64480
+ * @version 199.0.0
64387
64481
  */
64388
64482
 
64389
64483
  /**
@@ -65015,7 +65109,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65015
65109
  *
65016
65110
  * @param {String} userId User ID
65017
65111
  * @param {Object} opts Optional parameters
65018
- * @param {Array.<String>} opts.expand Which fields, if any, to expand
65112
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
65019
65113
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
65020
65114
  * @param {Object} opts.state Search for a user with this state (default to active)
65021
65115
  */
@@ -65586,7 +65680,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65586
65680
  * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
65587
65681
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
65588
65682
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
65589
- * @param {Array.<String>} opts.expand Which fields, if any, to expand
65683
+ * @param {Array.<String>} opts.expand Which fields, if any, to expand. Note, expand parameters are resolved with a best effort approach and not guaranteed to be returned. If requested expand information is absolutely required, it's recommended to use specific API requests instead.
65590
65684
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for users instead of their defaults. This parameter will only be used when presence is provided as an expand. When using this parameter the maximum number of users that can be returned is 100.
65591
65685
  * @param {Object} opts.state Only list users of this state (default to active)
65592
65686
  */
@@ -67041,7 +67135,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67041
67135
  /**
67042
67136
  * Utilities service.
67043
67137
  * @module purecloud-platform-client-v2/api/UtilitiesApi
67044
- * @version 197.0.0
67138
+ * @version 199.0.0
67045
67139
  */
67046
67140
 
67047
67141
  /**
@@ -67152,7 +67246,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67152
67246
  /**
67153
67247
  * Voicemail service.
67154
67248
  * @module purecloud-platform-client-v2/api/VoicemailApi
67155
- * @version 197.0.0
67249
+ * @version 199.0.0
67156
67250
  */
67157
67251
 
67158
67252
  /**
@@ -67819,7 +67913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67819
67913
  /**
67820
67914
  * WebChat service.
67821
67915
  * @module purecloud-platform-client-v2/api/WebChatApi
67822
- * @version 197.0.0
67916
+ * @version 199.0.0
67823
67917
  */
67824
67918
 
67825
67919
  /**
@@ -68370,7 +68464,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68370
68464
  /**
68371
68465
  * WebDeployments service.
68372
68466
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
68373
- * @version 197.0.0
68467
+ * @version 199.0.0
68374
68468
  */
68375
68469
 
68376
68470
  /**
@@ -68897,7 +68991,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68897
68991
  /**
68898
68992
  * WebMessaging service.
68899
68993
  * @module purecloud-platform-client-v2/api/WebMessagingApi
68900
- * @version 197.0.0
68994
+ * @version 199.0.0
68901
68995
  */
68902
68996
 
68903
68997
  /**
@@ -68943,7 +69037,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68943
69037
  /**
68944
69038
  * Widgets service.
68945
69039
  * @module purecloud-platform-client-v2/api/WidgetsApi
68946
- * @version 197.0.0
69040
+ * @version 199.0.0
68947
69041
  */
68948
69042
 
68949
69043
  /**
@@ -69089,7 +69183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69089
69183
  /**
69090
69184
  * WorkforceManagement service.
69091
69185
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
69092
- * @version 197.0.0
69186
+ * @version 199.0.0
69093
69187
  */
69094
69188
 
69095
69189
  /**
@@ -69699,32 +69793,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69699
69793
  );
69700
69794
  }
69701
69795
 
69702
- /**
69703
- * To get status of the modeling job.
69704
- * This Endpoint is Deprecated, and not recommended to be used.
69705
- * @param {String} jobId The id of the modeling job
69706
- * @deprecated
69707
- */
69708
- getWorkforcemanagementAdhocmodelingjob(jobId) {
69709
- // verify the required parameter 'jobId' is set
69710
- if (jobId === undefined || jobId === null) {
69711
- throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementAdhocmodelingjob';
69712
- }
69713
-
69714
- return this.apiClient.callApi(
69715
- '/api/v2/workforcemanagement/adhocmodelingjobs/{jobId}',
69716
- 'GET',
69717
- { 'jobId': jobId },
69718
- { },
69719
- { },
69720
- { },
69721
- null,
69722
- ['PureCloud OAuth'],
69723
- ['application/json'],
69724
- ['application/json']
69725
- );
69726
- }
69727
-
69728
69796
  /**
69729
69797
  * Get an adherence explanation
69730
69798
  *
@@ -69888,6 +69956,129 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69888
69956
  );
69889
69957
  }
69890
69958
 
69959
+ /**
69960
+ * Get an activity plan
69961
+ *
69962
+ * @param {String} businessUnitId The ID of the business unit
69963
+ * @param {String} activityPlanId The ID of the activity plan to fetch
69964
+ * getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69965
+ */
69966
+ getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
69967
+ // verify the required parameter 'businessUnitId' is set
69968
+ if (businessUnitId === undefined || businessUnitId === null) {
69969
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';
69970
+ }
69971
+ // verify the required parameter 'activityPlanId' is set
69972
+ if (activityPlanId === undefined || activityPlanId === null) {
69973
+ throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';
69974
+ }
69975
+
69976
+ return this.apiClient.callApi(
69977
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
69978
+ 'GET',
69979
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
69980
+ { },
69981
+ { },
69982
+ { },
69983
+ null,
69984
+ ['PureCloud OAuth'],
69985
+ ['application/json'],
69986
+ ['application/json']
69987
+ );
69988
+ }
69989
+
69990
+ /**
69991
+ * Gets an activity plan run job
69992
+ *
69993
+ * @param {String} businessUnitId The ID of the business unit
69994
+ * @param {String} activityPlanId The ID of the activity plan associated with the run job
69995
+ * @param {String} jobId The ID of the activity plan run job
69996
+ * getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69997
+ */
69998
+ getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
69999
+ // verify the required parameter 'businessUnitId' is set
70000
+ if (businessUnitId === undefined || businessUnitId === null) {
70001
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
70002
+ }
70003
+ // verify the required parameter 'activityPlanId' is set
70004
+ if (activityPlanId === undefined || activityPlanId === null) {
70005
+ throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
70006
+ }
70007
+ // verify the required parameter 'jobId' is set
70008
+ if (jobId === undefined || jobId === null) {
70009
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
70010
+ }
70011
+
70012
+ return this.apiClient.callApi(
70013
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}',
70014
+ 'GET',
70015
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId,'jobId': jobId },
70016
+ { },
70017
+ { },
70018
+ { },
70019
+ null,
70020
+ ['PureCloud OAuth'],
70021
+ ['application/json'],
70022
+ ['application/json']
70023
+ );
70024
+ }
70025
+
70026
+ /**
70027
+ * Get activity plans
70028
+ *
70029
+ * @param {String} businessUnitId The ID of the business unit
70030
+ * @param {Object} opts Optional parameters
70031
+ * @param {Object} opts.state Optionally filter by activity plan state
70032
+ * getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70033
+ */
70034
+ getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
70035
+ opts = opts || {};
70036
+
70037
+ // verify the required parameter 'businessUnitId' is set
70038
+ if (businessUnitId === undefined || businessUnitId === null) {
70039
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';
70040
+ }
70041
+
70042
+ return this.apiClient.callApi(
70043
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
70044
+ 'GET',
70045
+ { 'businessUnitId': businessUnitId },
70046
+ { 'state': opts['state'] },
70047
+ { },
70048
+ { },
70049
+ null,
70050
+ ['PureCloud OAuth'],
70051
+ ['application/json'],
70052
+ ['application/json']
70053
+ );
70054
+ }
70055
+
70056
+ /**
70057
+ * Gets the latest job for all activity plans in the business unit
70058
+ *
70059
+ * @param {String} businessUnitId The ID of the business unit
70060
+ * getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70061
+ */
70062
+ getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
70063
+ // verify the required parameter 'businessUnitId' is set
70064
+ if (businessUnitId === undefined || businessUnitId === null) {
70065
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';
70066
+ }
70067
+
70068
+ return this.apiClient.callApi(
70069
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs',
70070
+ 'GET',
70071
+ { 'businessUnitId': businessUnitId },
70072
+ { },
70073
+ { },
70074
+ { },
70075
+ null,
70076
+ ['PureCloud OAuth'],
70077
+ ['application/json'],
70078
+ ['application/json']
70079
+ );
70080
+ }
70081
+
69891
70082
  /**
69892
70083
  * Get intraday planning groups for the given date
69893
70084
  *
@@ -72051,6 +72242,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72051
72242
  );
72052
72243
  }
72053
72244
 
72245
+ /**
72246
+ * Update an activity plan
72247
+ * If a job associated with the activity plan is in Processing state the activity plan cannot be updated
72248
+ * @param {String} businessUnitId The ID of the business unit
72249
+ * @param {String} activityPlanId The ID of the activity plan to update
72250
+ * @param {Object} body body
72251
+ * patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
72252
+ */
72253
+ patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
72254
+ // verify the required parameter 'businessUnitId' is set
72255
+ if (businessUnitId === undefined || businessUnitId === null) {
72256
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';
72257
+ }
72258
+ // verify the required parameter 'activityPlanId' is set
72259
+ if (activityPlanId === undefined || activityPlanId === null) {
72260
+ throw 'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';
72261
+ }
72262
+ // verify the required parameter 'body' is set
72263
+ if (body === undefined || body === null) {
72264
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
72265
+ }
72266
+
72267
+ return this.apiClient.callApi(
72268
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
72269
+ 'PATCH',
72270
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
72271
+ { },
72272
+ { },
72273
+ { },
72274
+ body,
72275
+ ['PureCloud OAuth'],
72276
+ ['application/json'],
72277
+ ['application/json']
72278
+ );
72279
+ }
72280
+
72054
72281
  /**
72055
72282
  * Updates the planning group
72056
72283
  *
@@ -72858,6 +73085,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72858
73085
  );
72859
73086
  }
72860
73087
 
73088
+ /**
73089
+ * Run an activity plan manually
73090
+ * Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
73091
+ * @param {String} businessUnitId The ID of the business unit
73092
+ * @param {String} activityPlanId The ID of the activity plan to run
73093
+ * postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
73094
+ */
73095
+ postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
73096
+ // verify the required parameter 'businessUnitId' is set
73097
+ if (businessUnitId === undefined || businessUnitId === null) {
73098
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
73099
+ }
73100
+ // verify the required parameter 'activityPlanId' is set
73101
+ if (activityPlanId === undefined || activityPlanId === null) {
73102
+ throw 'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
73103
+ }
73104
+
73105
+ return this.apiClient.callApi(
73106
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs',
73107
+ 'POST',
73108
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
73109
+ { },
73110
+ { },
73111
+ { },
73112
+ null,
73113
+ ['PureCloud OAuth'],
73114
+ ['application/json'],
73115
+ ['application/json']
73116
+ );
73117
+ }
73118
+
73119
+ /**
73120
+ * Create an activity plan
73121
+ *
73122
+ * @param {String} businessUnitId The ID of the business unit
73123
+ * @param {Object} body body
73124
+ * postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
73125
+ */
73126
+ postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
73127
+ // verify the required parameter 'businessUnitId' is set
73128
+ if (businessUnitId === undefined || businessUnitId === null) {
73129
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';
73130
+ }
73131
+ // verify the required parameter 'body' is set
73132
+ if (body === undefined || body === null) {
73133
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';
73134
+ }
73135
+
73136
+ return this.apiClient.callApi(
73137
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
73138
+ 'POST',
73139
+ { 'businessUnitId': businessUnitId },
73140
+ { },
73141
+ { },
73142
+ { },
73143
+ body,
73144
+ ['PureCloud OAuth'],
73145
+ ['application/json'],
73146
+ ['application/json']
73147
+ );
73148
+ }
73149
+
72861
73150
  /**
72862
73151
  * Query adherence explanations across an entire business unit for the requested period
72863
73152
  *
@@ -75002,7 +75291,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
75002
75291
  * </pre>
75003
75292
  * </p>
75004
75293
  * @module purecloud-platform-client-v2/index
75005
- * @version 197.0.0
75294
+ * @version 199.0.0
75006
75295
  */
75007
75296
  class platformClient {
75008
75297
  constructor() {