purecloud-platform-client-v2 197.0.0 → 198.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 -110
  3. package/dist/web-amd/purecloud-platform-client-v2.js +401 -110
  4. package/dist/web-amd/purecloud-platform-client-v2.min.js +1 -1
  5. package/dist/web-cjs/bundle.js +167 -90
  6. package/dist/web-cjs/purecloud-platform-client-v2.js +170 -91
  7. package/dist/web-cjs/purecloud-platform-client-v2.min.js +1 -1
  8. package/index.d.ts +520 -29
  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 -1
  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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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 198.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
  *
@@ -20636,7 +20672,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20636
20672
  /**
20637
20673
  * DataExtensions service.
20638
20674
  * @module purecloud-platform-client-v2/api/DataExtensionsApi
20639
- * @version 197.0.0
20675
+ * @version 198.0.0
20640
20676
  */
20641
20677
 
20642
20678
  /**
@@ -20722,7 +20758,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20722
20758
  /**
20723
20759
  * Downloads service.
20724
20760
  * @module purecloud-platform-client-v2/api/DownloadsApi
20725
- * @version 197.0.0
20761
+ * @version 198.0.0
20726
20762
  */
20727
20763
 
20728
20764
  /**
@@ -20774,7 +20810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20774
20810
  /**
20775
20811
  * Emails service.
20776
20812
  * @module purecloud-platform-client-v2/api/EmailsApi
20777
- * @version 197.0.0
20813
+ * @version 198.0.0
20778
20814
  */
20779
20815
 
20780
20816
  /**
@@ -20839,7 +20875,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20839
20875
  /**
20840
20876
  * EmployeeEngagement service.
20841
20877
  * @module purecloud-platform-client-v2/api/EmployeeEngagementApi
20842
- * @version 197.0.0
20878
+ * @version 198.0.0
20843
20879
  */
20844
20880
 
20845
20881
  /**
@@ -20990,7 +21026,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
20990
21026
  /**
20991
21027
  * Events service.
20992
21028
  * @module purecloud-platform-client-v2/api/EventsApi
20993
- * @version 197.0.0
21029
+ * @version 198.0.0
20994
21030
  */
20995
21031
 
20996
21032
  /**
@@ -21086,7 +21122,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21086
21122
  /**
21087
21123
  * ExternalContacts service.
21088
21124
  * @module purecloud-platform-client-v2/api/ExternalContactsApi
21089
- * @version 197.0.0
21125
+ * @version 198.0.0
21090
21126
  */
21091
21127
 
21092
21128
  /**
@@ -21442,7 +21478,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
21442
21478
  *
21443
21479
  * @param {String} contactId ExternalContact ID
21444
21480
  * @param {Object} opts Optional parameters
21445
- * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources)
21481
+ * @param {Array.<String>} opts.expand which fields, if any, to expand (externalOrganization,externalDataSources,identifiers)
21446
21482
  */
21447
21483
  getExternalcontactsContactUnresolved(contactId, opts) {
21448
21484
  opts = opts || {};
@@ -23048,7 +23084,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23048
23084
  /**
23049
23085
  * Fax service.
23050
23086
  * @module purecloud-platform-client-v2/api/FaxApi
23051
- * @version 197.0.0
23087
+ * @version 198.0.0
23052
23088
  */
23053
23089
 
23054
23090
  /**
@@ -23263,7 +23299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23263
23299
  /**
23264
23300
  * Flows service.
23265
23301
  * @module purecloud-platform-client-v2/api/FlowsApi
23266
- * @version 197.0.0
23302
+ * @version 198.0.0
23267
23303
  */
23268
23304
 
23269
23305
  /**
@@ -23446,7 +23482,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
23446
23482
  /**
23447
23483
  * Gamification service.
23448
23484
  * @module purecloud-platform-client-v2/api/GamificationApi
23449
- * @version 197.0.0
23485
+ * @version 198.0.0
23450
23486
  */
23451
23487
 
23452
23488
  /**
@@ -25532,7 +25568,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25532
25568
  /**
25533
25569
  * GeneralDataProtectionRegulation service.
25534
25570
  * @module purecloud-platform-client-v2/api/GeneralDataProtectionRegulationApi
25535
- * @version 197.0.0
25571
+ * @version 198.0.0
25536
25572
  */
25537
25573
 
25538
25574
  /**
@@ -25662,7 +25698,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25662
25698
  /**
25663
25699
  * Geolocation service.
25664
25700
  * @module purecloud-platform-client-v2/api/GeolocationApi
25665
- * @version 197.0.0
25701
+ * @version 198.0.0
25666
25702
  */
25667
25703
 
25668
25704
  /**
@@ -25793,7 +25829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
25793
25829
  /**
25794
25830
  * Greetings service.
25795
25831
  * @module purecloud-platform-client-v2/api/GreetingsApi
25796
- * @version 197.0.0
25832
+ * @version 198.0.0
25797
25833
  */
25798
25834
 
25799
25835
  /**
@@ -26248,7 +26284,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26248
26284
  /**
26249
26285
  * Groups service.
26250
26286
  * @module purecloud-platform-client-v2/api/GroupsApi
26251
- * @version 197.0.0
26287
+ * @version 198.0.0
26252
26288
  */
26253
26289
 
26254
26290
  /**
@@ -26767,7 +26803,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
26767
26803
  /**
26768
26804
  * IdentityProvider service.
26769
26805
  * @module purecloud-platform-client-v2/api/IdentityProviderApi
26770
- * @version 197.0.0
26806
+ * @version 198.0.0
26771
26807
  */
26772
26808
 
26773
26809
  /**
@@ -27628,7 +27664,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27628
27664
  /**
27629
27665
  * InfrastructureAsCode service.
27630
27666
  * @module purecloud-platform-client-v2/api/InfrastructureAsCodeApi
27631
- * @version 197.0.0
27667
+ * @version 198.0.0
27632
27668
  */
27633
27669
 
27634
27670
  /**
@@ -27795,7 +27831,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
27795
27831
  /**
27796
27832
  * Integrations service.
27797
27833
  * @module purecloud-platform-client-v2/api/IntegrationsApi
27798
- * @version 197.0.0
27834
+ * @version 198.0.0
27799
27835
  */
27800
27836
 
27801
27837
  /**
@@ -30147,7 +30183,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30147
30183
  /**
30148
30184
  * Journey service.
30149
30185
  * @module purecloud-platform-client-v2/api/JourneyApi
30150
- * @version 197.0.0
30186
+ * @version 198.0.0
30151
30187
  */
30152
30188
 
30153
30189
  /**
@@ -30892,7 +30928,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
30892
30928
  * @param {String} opts.pageSize Number of entities to return. Maximum of 200.
30893
30929
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
30894
30930
  * @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
30931
  */
30897
30932
  getJourneySessionEvents(sessionId, opts) {
30898
30933
  opts = opts || {};
@@ -31525,6 +31560,35 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31525
31560
  );
31526
31561
  }
31527
31562
 
31563
+ /**
31564
+ * Send a journey web event, used for tracking customer activity on a website.
31565
+ *
31566
+ * @param {String} deploymentId The ID of the deployment sending the web event.
31567
+ * @param {Object} opts Optional parameters
31568
+ * @param {Object} opts.body
31569
+ */
31570
+ postJourneyDeploymentWebevents(deploymentId, opts) {
31571
+ opts = opts || {};
31572
+
31573
+ // verify the required parameter 'deploymentId' is set
31574
+ if (deploymentId === undefined || deploymentId === null) {
31575
+ throw 'Missing the required parameter "deploymentId" when calling postJourneyDeploymentWebevents';
31576
+ }
31577
+
31578
+ return this.apiClient.callApi(
31579
+ '/api/v2/journey/deployments/{deploymentId}/webevents',
31580
+ 'POST',
31581
+ { 'deploymentId': deploymentId },
31582
+ { },
31583
+ { },
31584
+ { },
31585
+ opts['body'],
31586
+ ['PureCloud OAuth'],
31587
+ ['application/json'],
31588
+ ['application/json']
31589
+ );
31590
+ }
31591
+
31528
31592
  /**
31529
31593
  * Query for flow paths.
31530
31594
  *
@@ -31765,7 +31829,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
31765
31829
  /**
31766
31830
  * Knowledge service.
31767
31831
  * @module purecloud-platform-client-v2/api/KnowledgeApi
31768
- * @version 197.0.0
31832
+ * @version 198.0.0
31769
31833
  */
31770
31834
 
31771
31835
  /**
@@ -35009,7 +35073,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
35009
35073
  /**
35010
35074
  * LanguageUnderstanding service.
35011
35075
  * @module purecloud-platform-client-v2/api/LanguageUnderstandingApi
35012
- * @version 197.0.0
35076
+ * @version 198.0.0
35013
35077
  */
35014
35078
 
35015
35079
  /**
@@ -36043,7 +36107,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36043
36107
  /**
36044
36108
  * Languages service.
36045
36109
  * @module purecloud-platform-client-v2/api/LanguagesApi
36046
- * @version 197.0.0
36110
+ * @version 198.0.0
36047
36111
  */
36048
36112
 
36049
36113
  /**
@@ -36265,7 +36329,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
36265
36329
  /**
36266
36330
  * Learning service.
36267
36331
  * @module purecloud-platform-client-v2/api/LearningApi
36268
- * @version 197.0.0
36332
+ * @version 198.0.0
36269
36333
  */
36270
36334
 
36271
36335
  /**
@@ -37294,7 +37358,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37294
37358
  /**
37295
37359
  * License service.
37296
37360
  * @module purecloud-platform-client-v2/api/LicenseApi
37297
- * @version 197.0.0
37361
+ * @version 198.0.0
37298
37362
  */
37299
37363
 
37300
37364
  /**
@@ -37532,7 +37596,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37532
37596
  /**
37533
37597
  * Locations service.
37534
37598
  * @module purecloud-platform-client-v2/api/LocationsApi
37535
- * @version 197.0.0
37599
+ * @version 198.0.0
37536
37600
  */
37537
37601
 
37538
37602
  /**
@@ -37768,7 +37832,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37768
37832
  /**
37769
37833
  * LogCapture service.
37770
37834
  * @module purecloud-platform-client-v2/api/LogCaptureApi
37771
- * @version 197.0.0
37835
+ * @version 198.0.0
37772
37836
  */
37773
37837
 
37774
37838
  /**
@@ -37968,7 +38032,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
37968
38032
  /**
37969
38033
  * Messaging service.
37970
38034
  * @module purecloud-platform-client-v2/api/MessagingApi
37971
- * @version 197.0.0
38035
+ * @version 198.0.0
37972
38036
  */
37973
38037
 
37974
38038
  /**
@@ -38327,7 +38391,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38327
38391
  /**
38328
38392
  * MobileDevices service.
38329
38393
  * @module purecloud-platform-client-v2/api/MobileDevicesApi
38330
- * @version 197.0.0
38394
+ * @version 198.0.0
38331
38395
  */
38332
38396
 
38333
38397
  /**
@@ -38478,7 +38542,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38478
38542
  /**
38479
38543
  * Notifications service.
38480
38544
  * @module purecloud-platform-client-v2/api/NotificationsApi
38481
- * @version 197.0.0
38545
+ * @version 198.0.0
38482
38546
  */
38483
38547
 
38484
38548
  /**
@@ -38711,7 +38775,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
38711
38775
  /**
38712
38776
  * OAuth service.
38713
38777
  * @module purecloud-platform-client-v2/api/OAuthApi
38714
- * @version 197.0.0
38778
+ * @version 198.0.0
38715
38779
  */
38716
38780
 
38717
38781
  /**
@@ -39077,7 +39141,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39077
39141
  /**
39078
39142
  * Objects service.
39079
39143
  * @module purecloud-platform-client-v2/api/ObjectsApi
39080
- * @version 197.0.0
39144
+ * @version 198.0.0
39081
39145
  */
39082
39146
 
39083
39147
  /**
@@ -39347,7 +39411,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39347
39411
  /**
39348
39412
  * OperationalEvents service.
39349
39413
  * @module purecloud-platform-client-v2/api/OperationalEventsApi
39350
- * @version 197.0.0
39414
+ * @version 198.0.0
39351
39415
  */
39352
39416
 
39353
39417
  /**
@@ -39413,7 +39477,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39413
39477
  /**
39414
39478
  * Organization service.
39415
39479
  * @module purecloud-platform-client-v2/api/OrganizationApi
39416
- * @version 197.0.0
39480
+ * @version 198.0.0
39417
39481
  */
39418
39482
 
39419
39483
  /**
@@ -39888,7 +39952,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
39888
39952
  /**
39889
39953
  * OrganizationAuthorization service.
39890
39954
  * @module purecloud-platform-client-v2/api/OrganizationAuthorizationApi
39891
- * @version 197.0.0
39955
+ * @version 198.0.0
39892
39956
  */
39893
39957
 
39894
39958
  /**
@@ -41235,7 +41299,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41235
41299
  /**
41236
41300
  * Outbound service.
41237
41301
  * @module purecloud-platform-client-v2/api/OutboundApi
41238
- * @version 197.0.0
41302
+ * @version 198.0.0
41239
41303
  */
41240
41304
 
41241
41305
  /**
@@ -41849,7 +41913,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
41849
41913
 
41850
41914
  /**
41851
41915
  * Reset messaging campaign progress and recycle the messaging campaign
41852
- *
41916
+ * Documented permissions are applicable based on campaign type.
41853
41917
  * @param {String} messagingCampaignId The Messaging Campaign ID
41854
41918
  */
41855
41919
  deleteOutboundMessagingcampaignProgress(messagingCampaignId) {
@@ -45597,7 +45661,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
45597
45661
  /**
45598
45662
  * Presence service.
45599
45663
  * @module purecloud-platform-client-v2/api/PresenceApi
45600
- * @version 197.0.0
45664
+ * @version 198.0.0
45601
45665
  */
45602
45666
 
45603
45667
  /**
@@ -46341,7 +46405,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46341
46405
  /**
46342
46406
  * ProcessAutomation service.
46343
46407
  * @module purecloud-platform-client-v2/api/ProcessAutomationApi
46344
- * @version 197.0.0
46408
+ * @version 198.0.0
46345
46409
  */
46346
46410
 
46347
46411
  /**
@@ -46580,7 +46644,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
46580
46644
  /**
46581
46645
  * Quality service.
46582
46646
  * @module purecloud-platform-client-v2/api/QualityApi
46583
- * @version 197.0.0
46647
+ * @version 198.0.0
46584
46648
  */
46585
46649
 
46586
46650
  /**
@@ -48269,6 +48333,37 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48269
48333
  );
48270
48334
  }
48271
48335
 
48336
+ /**
48337
+ * Update the Predictive Scoring settings of an evaluation form.
48338
+ *
48339
+ * @param {String} formId Form ID
48340
+ * @param {Object} body Predictive Scoring Settings
48341
+ * putQualityFormsEvaluationPredictivescoringSettings is a preview method and is subject to both breaking and non-breaking changes at any time without notice
48342
+ */
48343
+ putQualityFormsEvaluationPredictivescoringSettings(formId, body) {
48344
+ // verify the required parameter 'formId' is set
48345
+ if (formId === undefined || formId === null) {
48346
+ throw 'Missing the required parameter "formId" when calling putQualityFormsEvaluationPredictivescoringSettings';
48347
+ }
48348
+ // verify the required parameter 'body' is set
48349
+ if (body === undefined || body === null) {
48350
+ throw 'Missing the required parameter "body" when calling putQualityFormsEvaluationPredictivescoringSettings';
48351
+ }
48352
+
48353
+ return this.apiClient.callApi(
48354
+ '/api/v2/quality/forms/evaluations/{formId}/predictivescoring/settings',
48355
+ 'PUT',
48356
+ { 'formId': formId },
48357
+ { },
48358
+ { },
48359
+ { },
48360
+ body,
48361
+ ['PureCloud OAuth'],
48362
+ ['application/json'],
48363
+ ['application/json']
48364
+ );
48365
+ }
48366
+
48272
48367
  /**
48273
48368
  * Update a survey form.
48274
48369
  *
@@ -48335,7 +48430,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
48335
48430
  /**
48336
48431
  * Recording service.
48337
48432
  * @module purecloud-platform-client-v2/api/RecordingApi
48338
- * @version 197.0.0
48433
+ * @version 198.0.0
48339
48434
  */
48340
48435
 
48341
48436
  /**
@@ -49993,7 +50088,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
49993
50088
  /**
49994
50089
  * ResponseManagement service.
49995
50090
  * @module purecloud-platform-client-v2/api/ResponseManagementApi
49996
- * @version 197.0.0
50091
+ * @version 198.0.0
49997
50092
  */
49998
50093
 
49999
50094
  /**
@@ -50503,7 +50598,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
50503
50598
  /**
50504
50599
  * Routing service.
50505
50600
  * @module purecloud-platform-client-v2/api/RoutingApi
50506
- * @version 197.0.0
50601
+ * @version 198.0.0
50507
50602
  */
50508
50603
 
50509
50604
  /**
@@ -54477,7 +54572,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
54477
54572
  /**
54478
54573
  * SCIM service.
54479
54574
  * @module purecloud-platform-client-v2/api/SCIMApi
54480
- * @version 197.0.0
54575
+ * @version 198.0.0
54481
54576
  */
54482
54577
 
54483
54578
  /**
@@ -55354,7 +55449,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55354
55449
  /**
55355
55450
  * ScreenRecording service.
55356
55451
  * @module purecloud-platform-client-v2/api/ScreenRecordingApi
55357
- * @version 197.0.0
55452
+ * @version 198.0.0
55358
55453
  */
55359
55454
 
55360
55455
  /**
@@ -55399,7 +55494,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55399
55494
  /**
55400
55495
  * Scripts service.
55401
55496
  * @module purecloud-platform-client-v2/api/ScriptsApi
55402
- * @version 197.0.0
55497
+ * @version 198.0.0
55403
55498
  */
55404
55499
 
55405
55500
  /**
@@ -55843,7 +55938,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
55843
55938
  /**
55844
55939
  * Search service.
55845
55940
  * @module purecloud-platform-client-v2/api/SearchApi
55846
- * @version 197.0.0
55941
+ * @version 198.0.0
55847
55942
  */
55848
55943
 
55849
55944
  /**
@@ -56532,7 +56627,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56532
56627
  /**
56533
56628
  * Settings service.
56534
56629
  * @module purecloud-platform-client-v2/api/SettingsApi
56535
- * @version 197.0.0
56630
+ * @version 198.0.0
56536
56631
  */
56537
56632
 
56538
56633
  /**
@@ -56754,7 +56849,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
56754
56849
  /**
56755
56850
  * SpeechTextAnalytics service.
56756
56851
  * @module purecloud-platform-client-v2/api/SpeechTextAnalyticsApi
56757
- * @version 197.0.0
56852
+ * @version 198.0.0
56758
56853
  */
56759
56854
 
56760
56855
  /**
@@ -58032,7 +58127,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58032
58127
  /**
58033
58128
  * Stations service.
58034
58129
  * @module purecloud-platform-client-v2/api/StationsApi
58035
- * @version 197.0.0
58130
+ * @version 198.0.0
58036
58131
  */
58037
58132
 
58038
58133
  /**
@@ -58134,7 +58229,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58134
58229
  /**
58135
58230
  * Suggest service.
58136
58231
  * @module purecloud-platform-client-v2/api/SuggestApi
58137
- * @version 197.0.0
58232
+ * @version 198.0.0
58138
58233
  */
58139
58234
 
58140
58235
  /**
@@ -58273,7 +58368,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58273
58368
  /**
58274
58369
  * TaskManagement service.
58275
58370
  * @module purecloud-platform-client-v2/api/TaskManagementApi
58276
- * @version 197.0.0
58371
+ * @version 198.0.0
58277
58372
  */
58278
58373
 
58279
58374
  /**
@@ -58918,6 +59013,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58918
59013
  * @param {String} opts.after The cursor that points to the end of the set of entities that has been returned.
58919
59014
  * @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
59015
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to descending)
59016
+ * @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
59017
  * getTaskmanagementWorktypeHistory is a preview method and is subject to both breaking and non-breaking changes at any time without notice
58922
59018
  */
58923
59019
  getTaskmanagementWorktypeHistory(worktypeId, opts) {
@@ -58932,7 +59028,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
58932
59028
  '/api/v2/taskmanagement/worktypes/{worktypeId}/history',
58933
59029
  'GET',
58934
59030
  { 'worktypeId': worktypeId },
58935
- { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'] },
59031
+ { 'after': opts['after'],'pageSize': opts['pageSize'],'sortOrder': opts['sortOrder'],'fields': this.apiClient.buildCollectionParam(opts['fields'], 'multi') },
58936
59032
  { },
58937
59033
  { },
58938
59034
  null,
@@ -59621,7 +59717,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59621
59717
  /**
59622
59718
  * Teams service.
59623
59719
  * @module purecloud-platform-client-v2/api/TeamsApi
59624
- * @version 197.0.0
59720
+ * @version 198.0.0
59625
59721
  */
59626
59722
 
59627
59723
  /**
@@ -59922,7 +60018,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
59922
60018
  /**
59923
60019
  * Telephony service.
59924
60020
  * @module purecloud-platform-client-v2/api/TelephonyApi
59925
- * @version 197.0.0
60021
+ * @version 198.0.0
59926
60022
  */
59927
60023
 
59928
60024
  /**
@@ -60104,7 +60200,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
60104
60200
  /**
60105
60201
  * TelephonyProvidersEdge service.
60106
60202
  * @module purecloud-platform-client-v2/api/TelephonyProvidersEdgeApi
60107
- * @version 197.0.0
60203
+ * @version 198.0.0
60108
60204
  */
60109
60205
 
60110
60206
  /**
@@ -63432,7 +63528,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63432
63528
  /**
63433
63529
  * Textbots service.
63434
63530
  * @module purecloud-platform-client-v2/api/TextbotsApi
63435
- * @version 197.0.0
63531
+ * @version 198.0.0
63436
63532
  */
63437
63533
 
63438
63534
  /**
@@ -63560,7 +63656,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63560
63656
  /**
63561
63657
  * Tokens service.
63562
63658
  * @module purecloud-platform-client-v2/api/TokensApi
63563
- * @version 197.0.0
63659
+ * @version 198.0.0
63564
63660
  */
63565
63661
 
63566
63662
  /**
@@ -63714,7 +63810,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63714
63810
  /**
63715
63811
  * Uploads service.
63716
63812
  * @module purecloud-platform-client-v2/api/UploadsApi
63717
- * @version 197.0.0
63813
+ * @version 198.0.0
63718
63814
  */
63719
63815
 
63720
63816
  /**
@@ -63983,7 +64079,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
63983
64079
  /**
63984
64080
  * Usage service.
63985
64081
  * @module purecloud-platform-client-v2/api/UsageApi
63986
- * @version 197.0.0
64082
+ * @version 198.0.0
63987
64083
  */
63988
64084
 
63989
64085
  /**
@@ -64198,7 +64294,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64198
64294
  /**
64199
64295
  * UserRecordings service.
64200
64296
  * @module purecloud-platform-client-v2/api/UserRecordingsApi
64201
- * @version 197.0.0
64297
+ * @version 198.0.0
64202
64298
  */
64203
64299
 
64204
64300
  /**
@@ -64383,7 +64479,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
64383
64479
  /**
64384
64480
  * Users service.
64385
64481
  * @module purecloud-platform-client-v2/api/UsersApi
64386
- * @version 197.0.0
64482
+ * @version 198.0.0
64387
64483
  */
64388
64484
 
64389
64485
  /**
@@ -65015,7 +65111,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65015
65111
  *
65016
65112
  * @param {String} userId User ID
65017
65113
  * @param {Object} opts Optional parameters
65018
- * @param {Array.<String>} opts.expand Which fields, if any, to expand
65114
+ * @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
65115
  * @param {Object} opts.integrationPresenceSource Gets an integration presence for a user instead of their default.
65020
65116
  * @param {Object} opts.state Search for a user with this state (default to active)
65021
65117
  */
@@ -65586,7 +65682,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
65586
65682
  * @param {Array.<String>} opts.id A list of user IDs to fetch by bulk
65587
65683
  * @param {Array.<String>} opts.jabberId A list of jabberIds to fetch by bulk (cannot be used with the id parameter)
65588
65684
  * @param {Object} opts.sortOrder Ascending or descending sort order (default to ASC)
65589
- * @param {Array.<String>} opts.expand Which fields, if any, to expand
65685
+ * @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
65686
  * @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
65687
  * @param {Object} opts.state Only list users of this state (default to active)
65592
65688
  */
@@ -67041,7 +67137,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67041
67137
  /**
67042
67138
  * Utilities service.
67043
67139
  * @module purecloud-platform-client-v2/api/UtilitiesApi
67044
- * @version 197.0.0
67140
+ * @version 198.0.0
67045
67141
  */
67046
67142
 
67047
67143
  /**
@@ -67152,7 +67248,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67152
67248
  /**
67153
67249
  * Voicemail service.
67154
67250
  * @module purecloud-platform-client-v2/api/VoicemailApi
67155
- * @version 197.0.0
67251
+ * @version 198.0.0
67156
67252
  */
67157
67253
 
67158
67254
  /**
@@ -67819,7 +67915,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
67819
67915
  /**
67820
67916
  * WebChat service.
67821
67917
  * @module purecloud-platform-client-v2/api/WebChatApi
67822
- * @version 197.0.0
67918
+ * @version 198.0.0
67823
67919
  */
67824
67920
 
67825
67921
  /**
@@ -68370,7 +68466,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68370
68466
  /**
68371
68467
  * WebDeployments service.
68372
68468
  * @module purecloud-platform-client-v2/api/WebDeploymentsApi
68373
- * @version 197.0.0
68469
+ * @version 198.0.0
68374
68470
  */
68375
68471
 
68376
68472
  /**
@@ -68897,7 +68993,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68897
68993
  /**
68898
68994
  * WebMessaging service.
68899
68995
  * @module purecloud-platform-client-v2/api/WebMessagingApi
68900
- * @version 197.0.0
68996
+ * @version 198.0.0
68901
68997
  */
68902
68998
 
68903
68999
  /**
@@ -68943,7 +69039,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
68943
69039
  /**
68944
69040
  * Widgets service.
68945
69041
  * @module purecloud-platform-client-v2/api/WidgetsApi
68946
- * @version 197.0.0
69042
+ * @version 198.0.0
68947
69043
  */
68948
69044
 
68949
69045
  /**
@@ -69089,7 +69185,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69089
69185
  /**
69090
69186
  * WorkforceManagement service.
69091
69187
  * @module purecloud-platform-client-v2/api/WorkforceManagementApi
69092
- * @version 197.0.0
69188
+ * @version 198.0.0
69093
69189
  */
69094
69190
 
69095
69191
  /**
@@ -69699,32 +69795,6 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69699
69795
  );
69700
69796
  }
69701
69797
 
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
69798
  /**
69729
69799
  * Get an adherence explanation
69730
69800
  *
@@ -69888,6 +69958,129 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
69888
69958
  );
69889
69959
  }
69890
69960
 
69961
+ /**
69962
+ * Get an activity plan
69963
+ *
69964
+ * @param {String} businessUnitId The ID of the business unit
69965
+ * @param {String} activityPlanId The ID of the activity plan to fetch
69966
+ * getWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69967
+ */
69968
+ getWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId) {
69969
+ // verify the required parameter 'businessUnitId' is set
69970
+ if (businessUnitId === undefined || businessUnitId === null) {
69971
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplan';
69972
+ }
69973
+ // verify the required parameter 'activityPlanId' is set
69974
+ if (activityPlanId === undefined || activityPlanId === null) {
69975
+ throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplan';
69976
+ }
69977
+
69978
+ return this.apiClient.callApi(
69979
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
69980
+ 'GET',
69981
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
69982
+ { },
69983
+ { },
69984
+ { },
69985
+ null,
69986
+ ['PureCloud OAuth'],
69987
+ ['application/json'],
69988
+ ['application/json']
69989
+ );
69990
+ }
69991
+
69992
+ /**
69993
+ * Gets an activity plan run job
69994
+ *
69995
+ * @param {String} businessUnitId The ID of the business unit
69996
+ * @param {String} activityPlanId The ID of the activity plan associated with the run job
69997
+ * @param {String} jobId The ID of the activity plan run job
69998
+ * getWorkforcemanagementBusinessunitActivityplanRunsJob is a preview method and is subject to both breaking and non-breaking changes at any time without notice
69999
+ */
70000
+ getWorkforcemanagementBusinessunitActivityplanRunsJob(businessUnitId, activityPlanId, jobId) {
70001
+ // verify the required parameter 'businessUnitId' is set
70002
+ if (businessUnitId === undefined || businessUnitId === null) {
70003
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
70004
+ }
70005
+ // verify the required parameter 'activityPlanId' is set
70006
+ if (activityPlanId === undefined || activityPlanId === null) {
70007
+ throw 'Missing the required parameter "activityPlanId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
70008
+ }
70009
+ // verify the required parameter 'jobId' is set
70010
+ if (jobId === undefined || jobId === null) {
70011
+ throw 'Missing the required parameter "jobId" when calling getWorkforcemanagementBusinessunitActivityplanRunsJob';
70012
+ }
70013
+
70014
+ return this.apiClient.callApi(
70015
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs/{jobId}',
70016
+ 'GET',
70017
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId,'jobId': jobId },
70018
+ { },
70019
+ { },
70020
+ { },
70021
+ null,
70022
+ ['PureCloud OAuth'],
70023
+ ['application/json'],
70024
+ ['application/json']
70025
+ );
70026
+ }
70027
+
70028
+ /**
70029
+ * Get activity plans
70030
+ *
70031
+ * @param {String} businessUnitId The ID of the business unit
70032
+ * @param {Object} opts Optional parameters
70033
+ * @param {Object} opts.state Optionally filter by activity plan state
70034
+ * getWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70035
+ */
70036
+ getWorkforcemanagementBusinessunitActivityplans(businessUnitId, opts) {
70037
+ opts = opts || {};
70038
+
70039
+ // verify the required parameter 'businessUnitId' is set
70040
+ if (businessUnitId === undefined || businessUnitId === null) {
70041
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplans';
70042
+ }
70043
+
70044
+ return this.apiClient.callApi(
70045
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
70046
+ 'GET',
70047
+ { 'businessUnitId': businessUnitId },
70048
+ { 'state': opts['state'] },
70049
+ { },
70050
+ { },
70051
+ null,
70052
+ ['PureCloud OAuth'],
70053
+ ['application/json'],
70054
+ ['application/json']
70055
+ );
70056
+ }
70057
+
70058
+ /**
70059
+ * Gets the latest job for all activity plans in the business unit
70060
+ *
70061
+ * @param {String} businessUnitId The ID of the business unit
70062
+ * getWorkforcemanagementBusinessunitActivityplansJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
70063
+ */
70064
+ getWorkforcemanagementBusinessunitActivityplansJobs(businessUnitId) {
70065
+ // verify the required parameter 'businessUnitId' is set
70066
+ if (businessUnitId === undefined || businessUnitId === null) {
70067
+ throw 'Missing the required parameter "businessUnitId" when calling getWorkforcemanagementBusinessunitActivityplansJobs';
70068
+ }
70069
+
70070
+ return this.apiClient.callApi(
70071
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/jobs',
70072
+ 'GET',
70073
+ { 'businessUnitId': businessUnitId },
70074
+ { },
70075
+ { },
70076
+ { },
70077
+ null,
70078
+ ['PureCloud OAuth'],
70079
+ ['application/json'],
70080
+ ['application/json']
70081
+ );
70082
+ }
70083
+
69891
70084
  /**
69892
70085
  * Get intraday planning groups for the given date
69893
70086
  *
@@ -72051,6 +72244,42 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72051
72244
  );
72052
72245
  }
72053
72246
 
72247
+ /**
72248
+ * Update an activity plan
72249
+ * If a job associated with the activity plan is in Processing state the activity plan cannot be updated
72250
+ * @param {String} businessUnitId The ID of the business unit
72251
+ * @param {String} activityPlanId The ID of the activity plan to update
72252
+ * @param {Object} body body
72253
+ * patchWorkforcemanagementBusinessunitActivityplan is a preview method and is subject to both breaking and non-breaking changes at any time without notice
72254
+ */
72255
+ patchWorkforcemanagementBusinessunitActivityplan(businessUnitId, activityPlanId, body) {
72256
+ // verify the required parameter 'businessUnitId' is set
72257
+ if (businessUnitId === undefined || businessUnitId === null) {
72258
+ throw 'Missing the required parameter "businessUnitId" when calling patchWorkforcemanagementBusinessunitActivityplan';
72259
+ }
72260
+ // verify the required parameter 'activityPlanId' is set
72261
+ if (activityPlanId === undefined || activityPlanId === null) {
72262
+ throw 'Missing the required parameter "activityPlanId" when calling patchWorkforcemanagementBusinessunitActivityplan';
72263
+ }
72264
+ // verify the required parameter 'body' is set
72265
+ if (body === undefined || body === null) {
72266
+ throw 'Missing the required parameter "body" when calling patchWorkforcemanagementBusinessunitActivityplan';
72267
+ }
72268
+
72269
+ return this.apiClient.callApi(
72270
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}',
72271
+ 'PATCH',
72272
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
72273
+ { },
72274
+ { },
72275
+ { },
72276
+ body,
72277
+ ['PureCloud OAuth'],
72278
+ ['application/json'],
72279
+ ['application/json']
72280
+ );
72281
+ }
72282
+
72054
72283
  /**
72055
72284
  * Updates the planning group
72056
72285
  *
@@ -72858,6 +73087,68 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
72858
73087
  );
72859
73088
  }
72860
73089
 
73090
+ /**
73091
+ * Run an activity plan manually
73092
+ * Triggers a job running the activity plan. The activity plan cannot be updated until the job completes
73093
+ * @param {String} businessUnitId The ID of the business unit
73094
+ * @param {String} activityPlanId The ID of the activity plan to run
73095
+ * postWorkforcemanagementBusinessunitActivityplanRunsJobs is a preview method and is subject to both breaking and non-breaking changes at any time without notice
73096
+ */
73097
+ postWorkforcemanagementBusinessunitActivityplanRunsJobs(businessUnitId, activityPlanId) {
73098
+ // verify the required parameter 'businessUnitId' is set
73099
+ if (businessUnitId === undefined || businessUnitId === null) {
73100
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
73101
+ }
73102
+ // verify the required parameter 'activityPlanId' is set
73103
+ if (activityPlanId === undefined || activityPlanId === null) {
73104
+ throw 'Missing the required parameter "activityPlanId" when calling postWorkforcemanagementBusinessunitActivityplanRunsJobs';
73105
+ }
73106
+
73107
+ return this.apiClient.callApi(
73108
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans/{activityPlanId}/runs/jobs',
73109
+ 'POST',
73110
+ { 'businessUnitId': businessUnitId,'activityPlanId': activityPlanId },
73111
+ { },
73112
+ { },
73113
+ { },
73114
+ null,
73115
+ ['PureCloud OAuth'],
73116
+ ['application/json'],
73117
+ ['application/json']
73118
+ );
73119
+ }
73120
+
73121
+ /**
73122
+ * Create an activity plan
73123
+ *
73124
+ * @param {String} businessUnitId The ID of the business unit
73125
+ * @param {Object} body body
73126
+ * postWorkforcemanagementBusinessunitActivityplans is a preview method and is subject to both breaking and non-breaking changes at any time without notice
73127
+ */
73128
+ postWorkforcemanagementBusinessunitActivityplans(businessUnitId, body) {
73129
+ // verify the required parameter 'businessUnitId' is set
73130
+ if (businessUnitId === undefined || businessUnitId === null) {
73131
+ throw 'Missing the required parameter "businessUnitId" when calling postWorkforcemanagementBusinessunitActivityplans';
73132
+ }
73133
+ // verify the required parameter 'body' is set
73134
+ if (body === undefined || body === null) {
73135
+ throw 'Missing the required parameter "body" when calling postWorkforcemanagementBusinessunitActivityplans';
73136
+ }
73137
+
73138
+ return this.apiClient.callApi(
73139
+ '/api/v2/workforcemanagement/businessunits/{businessUnitId}/activityplans',
73140
+ 'POST',
73141
+ { 'businessUnitId': businessUnitId },
73142
+ { },
73143
+ { },
73144
+ { },
73145
+ body,
73146
+ ['PureCloud OAuth'],
73147
+ ['application/json'],
73148
+ ['application/json']
73149
+ );
73150
+ }
73151
+
72861
73152
  /**
72862
73153
  * Query adherence explanations across an entire business unit for the requested period
72863
73154
  *
@@ -75002,7 +75293,7 @@ ${this.formatValue('Status', statusCode)}${this.formatValue('Headers', this.form
75002
75293
  * </pre>
75003
75294
  * </p>
75004
75295
  * @module purecloud-platform-client-v2/index
75005
- * @version 197.0.0
75296
+ * @version 198.0.0
75006
75297
  */
75007
75298
  class platformClient {
75008
75299
  constructor() {